aboutsummaryrefslogtreecommitdiff
path: root/pcap_findalldevs.3pcap
diff options
context:
space:
mode:
authorTreehugger Robot <treehugger-gerrit@google.com>2021-01-06 20:22:57 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2021-01-06 20:22:57 +0000
commitd452836f1bb93431e3acfcbcff1fb0737c85e369 (patch)
tree6258b7da515b2a7661114322d98216708d2134a9 /pcap_findalldevs.3pcap
parent8ac014d123247fcc8bbdd3e4129169a65efb0c39 (diff)
parent42cd90cfc1dd3fd2dac2d86723d3713105108194 (diff)
downloadlibpcap-d452836f1bb93431e3acfcbcff1fb0737c85e369.tar.gz
Merge "Upgrade libpcap to libpcap-1.10.0" am: c1cf421806 am: 56dae89b50 am: 42cd90cfc1
Original change: https://android-review.googlesource.com/c/platform/external/libpcap/+/1541006 MUST ONLY BE SUBMITTED BY AUTOMERGER Change-Id: I2c702c8ad27745cbd3d1b75a3f66e2a496158ede
Diffstat (limited to 'pcap_findalldevs.3pcap')
-rw-r--r--pcap_findalldevs.3pcap26
1 files changed, 14 insertions, 12 deletions
diff --git a/pcap_findalldevs.3pcap b/pcap_findalldevs.3pcap
index 712e255a..41c98fe1 100644
--- a/pcap_findalldevs.3pcap
+++ b/pcap_findalldevs.3pcap
@@ -17,7 +17,7 @@
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
-.TH PCAP_FINDALLDEVS 3PCAP "22 August 2018"
+.TH PCAP_FINDALLDEVS 3PCAP "23 August 2018"
.SH NAME
pcap_findalldevs, pcap_freealldevs \- get a list of capture devices, and
free that list
@@ -38,21 +38,21 @@ void pcap_freealldevs(pcap_if_t *alldevs);
.ft
.fi
.SH DESCRIPTION
-.B pcap_findalldevs()
+.BR pcap_findalldevs ()
constructs a list of network devices that can be opened with
-.B pcap_create(3PCAP)
+.BR pcap_create (3PCAP)
and
-.B pcap_activate(3PCAP)
+.BR pcap_activate (3PCAP)
or with
-.BR pcap_open_live(3PCAP) .
+.BR pcap_open_live (3PCAP).
(Note that there may be network devices that cannot be opened by the
process calling
-.BR pcap_findalldevs() ,
+.BR pcap_findalldevs (),
because, for example, that process does not have sufficient privileges
to open them for capturing; if so, those devices will not appear on the
list.)
If
-.B pcap_findalldevs()
+.BR pcap_findalldevs ()
succeeds, the pointer pointed to by
.I alldevsp
is set to point to the first element of the list, or to
@@ -72,7 +72,7 @@ for the last element of the list
.TP
.B name
a pointer to a string giving a name for the device to pass to
-.B pcap_open_live()
+.BR pcap_open_live ()
.TP
.B description
if not
@@ -194,12 +194,14 @@ for IPv6 addresses, it can be interpreted as if it pointed to a
.BR "struct sockaddr_in6".
.PP
The list of devices must be freed with
-.BR pcap_freealldevs(3PCAP) ,
+.BR pcap_freealldevs (3PCAP),
which frees the list pointed to by
.IR alldevs .
.SH RETURN VALUE
-.B pcap_findalldevs()
-returns 0 on success and
+.BR pcap_findalldevs ()
+returns
+.B 0
+on success and
.B PCAP_ERROR
on failure; as indicated, finding no
devices is considered success, rather than failure, so 0 will be
@@ -228,4 +230,4 @@ and
.B PCAP_IF_CONNECTION_STATUS_NOT_APPLICABLE
constants became available in libpcap release 1.9.0.
.SH SEE ALSO
-pcap(3PCAP)
+.BR pcap (3PCAP)