Blame pcap_create.3pcap

Packit 209cc3
.\" Copyright (c) 1994, 1996, 1997
Packit 209cc3
.\"	The Regents of the University of California.  All rights reserved.
Packit 209cc3
.\"
Packit 209cc3
.\" Redistribution and use in source and binary forms, with or without
Packit 209cc3
.\" modification, are permitted provided that: (1) source code distributions
Packit 209cc3
.\" retain the above copyright notice and this paragraph in its entirety, (2)
Packit 209cc3
.\" distributions including binary code include the above copyright notice and
Packit 209cc3
.\" this paragraph in its entirety in the documentation or other materials
Packit 209cc3
.\" provided with the distribution, and (3) all advertising materials mentioning
Packit 209cc3
.\" features or use of this software display the following acknowledgement:
Packit 209cc3
.\" ``This product includes software developed by the University of California,
Packit 209cc3
.\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
Packit 209cc3
.\" the University nor the names of its contributors may be used to endorse
Packit 209cc3
.\" or promote products derived from this software without specific prior
Packit 209cc3
.\" written permission.
Packit 209cc3
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
Packit 209cc3
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
Packit 209cc3
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Packit 209cc3
.\"
Packit 209cc3
.TH PCAP_CREATE 3PCAP "3 January 2014"
Packit 209cc3
.SH NAME
Packit 209cc3
pcap_create \- create a live capture handle
Packit 209cc3
.SH SYNOPSIS
Packit 209cc3
.nf
Packit 209cc3
.ft B
Packit 209cc3
#include <pcap/pcap.h>
Packit 209cc3
.ft
Packit 209cc3
.LP
Packit 209cc3
.nf
Packit 209cc3
.ft B
Packit 209cc3
char errbuf[PCAP_ERRBUF_SIZE];
Packit 209cc3
.ft
Packit 209cc3
.LP
Packit 209cc3
.ft B
Packit 209cc3
pcap_t *pcap_create(const char *source, char *errbuf);
Packit 209cc3
.ft
Packit 209cc3
.fi
Packit 209cc3
.SH DESCRIPTION
Packit 209cc3
.B pcap_create()
Packit 209cc3
is used to create a packet capture handle to look
Packit 209cc3
at packets on the network.
Packit 209cc3
.I source
Packit 209cc3
is a string that specifies the network device to open; on Linux systems
Packit 209cc3
with 2.2 or later kernels, a
Packit 209cc3
.I source
Packit 209cc3
argument of "any" or
Packit 209cc3
.B NULL
Packit 209cc3
can be used to capture packets from all interfaces.
Packit 209cc3
.PP
Packit 209cc3
The returned handle must be activated with
Packit 209cc3
.B pcap_activate(3PCAP)
Packit 209cc3
before packets can be captured
Packit 209cc3
with it; options for the capture, such as promiscuous mode, can be set
Packit 209cc3
on the handle before activating it.
Packit 209cc3
.SH RETURN VALUE
Packit 209cc3
.B pcap_create()
Packit 209cc3
returns a
Packit 209cc3
.I pcap_t *
Packit 209cc3
on success and
Packit 209cc3
.B NULL
Packit 209cc3
on failure.
Packit 209cc3
If
Packit 209cc3
.B NULL
Packit 209cc3
is returned,
Packit 209cc3
.I errbuf
Packit 209cc3
is filled in with an appropriate error message.
Packit 209cc3
.I errbuf
Packit 209cc3
is assumed to be able to hold at least
Packit 209cc3
.B PCAP_ERRBUF_SIZE
Packit 209cc3
chars.
Packit 209cc3
.SH SEE ALSO
Packit 209cc3
pcap(3PCAP)