external/bsd/libpcap/dist/pcap_lookupdev.3pcap

   1 .\"     $NetBSD: pcap_lookupdev.3pcap,v 1.2 2014/11/19 19:33:30 christos Exp $
   2 .\"
   3 .\" Copyright (c) 1994, 1996, 1997
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that: (1) source code distributions
   8 .\" retain the above copyright notice and this paragraph in its entirety, (2)
   9 .\" distributions including binary code include the above copyright notice and
  10 .\" this paragraph in its entirety in the documentation or other materials
  11 .\" provided with the distribution, and (3) all advertising materials mentioning
  12 .\" features or use of this software display the following acknowledgement:
  13 .\" ``This product includes software developed by the University of California,
  14 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  15 .\" the University nor the names of its contributors may be used to endorse
  16 .\" or promote products derived from this software without specific prior
  17 .\" written permission.
  18 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  19 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  20 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  21 .\"
  22 .TH PCAP_LOOKUPDEV 3PCAP "5 April 2008"
  23 .SH NAME
  24 pcap_lookupdev \- find the default device on which to capture
  25 .SH SYNOPSIS
  26 .nf
  27 .ft B
  28 #include <pcap/pcap.h>
  29 .ft
  30 .LP
  31 .nf
  32 .ft B
  33 char errbuf[PCAP_ERRBUF_SIZE];
  34 .ft
  35 .LP
  36 .ft B
  37 char *pcap_lookupdev(char *errbuf);
  38 .ft
  39 .fi
  40 .SH DESCRIPTION
  41 .B pcap_lookupdev()
  42 returns a pointer to a string giving the name of a network device
  43 suitable for use with
  44 .B pcap_create()
  45 and
  46 .BR pcap_activate() ,
  47 or with
  48 .BR pcap_open_live() ,
  49 and with
  50 .BR pcap_lookupnet() .
  51 If there is an error,
  52 .B NULL
  53 is returned and
  54 .I errbuf
  55 is filled in with an appropriate error message.
  56 .I errbuf
  57 is assumed to be able to hold at least
  58 .B PCAP_ERRBUF_SIZE
  59 chars.
  60 .SH SEE ALSO
  61 pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
  62 pcap_open_live(3PCAP), pcap_lookupnet(3PCAP)