contrib/libpcap/pcap_create.3pcap

   1 .\" Copyright (c) 1994, 1996, 1997
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that: (1) source code distributions
   6 .\" retain the above copyright notice and this paragraph in its entirety, (2)
   7 .\" distributions including binary code include the above copyright notice and
   8 .\" this paragraph in its entirety in the documentation or other materials
   9 .\" provided with the distribution, and (3) all advertising materials mentioning
  10 .\" features or use of this software display the following acknowledgement:
  11 .\" ``This product includes software developed by the University of California,
  12 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  13 .\" the University nor the names of its contributors may be used to endorse
  14 .\" or promote products derived from this software without specific prior
  15 .\" written permission.
  16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  17 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  18 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  19 .\"
  20 .TH PCAP_CREATE 3PCAP "3 January 2014"
  21 .SH NAME
  22 pcap_create \- create a live capture handle
  23 .SH SYNOPSIS
  24 .nf
  25 .ft B
  26 #include <pcap/pcap.h>
  27 .ft
  28 .LP
  29 .nf
  30 .ft B
  31 char errbuf[PCAP_ERRBUF_SIZE];
  32 .ft
  33 .LP
  34 .ft B
  35 pcap_t *pcap_create(const char *source, char *errbuf);
  36 .ft
  37 .fi
  38 .SH DESCRIPTION
  39 .B pcap_create()
  40 is used to create a packet capture handle to look
  41 at packets on the network.
  42 .I source
  43 is a string that specifies the network device to open; on Linux systems
  44 with 2.2 or later kernels, a
  45 .I source
  46 argument of "any" or
  47 .B NULL
  48 can be used to capture packets from all interfaces.
  49 .PP
  50 The returned handle must be activated with
  51 .B pcap_activate()
  52 before packets can be captured
  53 with it; options for the capture, such as promiscuous mode, can be set
  54 on the handle before activating it.
  55 .SH RETURN VALUE
  56 .B pcap_create()
  57 returns a
  58 .I pcap_t *
  59 on success and
  60 .B NULL
  61 on failure.
  62 If
  63 .B NULL
  64 is returned,
  65 .I errbuf
  66 is filled in with an appropriate error message.
  67 .I errbuf
  68 is assumed to be able to hold at least
  69 .B PCAP_ERRBUF_SIZE
  70 chars.
  71 .SH SEE ALSO
  72 pcap(3PCAP), pcap_activate(3PCAP)