kernel - Implement spectre mitigations part 1
[dragonfly.git] / contrib / libpcap / pcap_create.3pcap
blob153f9fd696aed319c99c900326f2642bd9eb92e8
1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_create.3pcap,v 1.1 2008-04-06 02:53:21 guy 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_CREATE 3PCAP "5 April 2008"
23 .SH NAME
24 pcap_create \- create a live capture handle
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 pcap_t *pcap_create(const char *source, char *errbuf);
38 .ft
39 .fi
40 .SH DESCRIPTION
41 .B pcap_create()
42 is used to create a packet capture handle to look
43 at packets on the network.
44 .I source
45 is a string that specifies the network device to open; on Linux systems
46 with 2.2 or later kernels, a
47 .I source
48 argument of "any" or
49 .B NULL
50 can be used to capture packets from all interfaces.
51 .PP
52 The returned handle must be activated with
53 .B pcap_activate()
54 before packets can be captured
55 with it; options for the capture, such as promiscuous mode, can be set
56 on the handle before activating it.
57 .SH RETURN VALUE
58 .B pcap_create()
59 returns a
60 .I pcap_t *
61 on success and
62 .B NULL
63 on failure.
65 .B NULL
66 is returned,
67 .I errbuf
68 is filled in with an appropriate error message.
69 .I errbuf
70 is assumed to be able to hold at least
71 .B PCAP_ERRBUF_SIZE
72 chars.
73 .SH SEE ALSO
74 pcap(3PCAP), pcap_activate(3PCAP)