summaryrefslogtreecommitdiff
path: root/pcap_get_selectable_fd.3pcap
diff options
context:
space:
mode:
authorDaniel Miller <dmiller@nmap.org>2018-08-24 23:55:03 -0500
committerDaniel Miller <dmiller@nmap.org>2018-08-24 23:55:03 -0500
commitabf508853752e3a79b8a99bdfeb929b94a490dce (patch)
tree46da4bad2573c967fa515c72a7d4e45fea6c9957 /pcap_get_selectable_fd.3pcap
parenta1da610c66cf72e0b66483aabee4687a2d8c166f (diff)
downloadlibpcap-abf508853752e3a79b8a99bdfeb929b94a490dce.tar.gz
Fix manpage reference formatting to be consistent.
All manpage references such as pcap_create(3PCAP) will now be formatted with the identifier (e.g. "pcap_create") in **bold** and the section name (e.g. "(3PCAP)") in roman (default) face. This is how most manpages seem to be formatted and makes things more consistent.
Diffstat (limited to 'pcap_get_selectable_fd.3pcap')
-rw-r--r--pcap_get_selectable_fd.3pcap19
1 files changed, 10 insertions, 9 deletions
diff --git a/pcap_get_selectable_fd.3pcap b/pcap_get_selectable_fd.3pcap
index 7f43db39..cc2515cd 100644
--- a/pcap_get_selectable_fd.3pcap
+++ b/pcap_get_selectable_fd.3pcap
@@ -36,10 +36,10 @@ int pcap_get_selectable_fd(pcap_t *p);
returns, on UNIX, a file descriptor number for a file descriptor on
which one can
do a
-.BR select(2) ,
-.BR poll(2) ,
-.BR epoll_wait(2) ,
-.BR kevent() ,
+.BR select (2),
+.BR poll (2),
+.BR epoll_wait (2),
+.BR kevent (2),
or other such call
to wait for it to be possible to read packets without blocking, if such
a descriptor exists, or
@@ -47,7 +47,7 @@ a descriptor exists, or
if no such descriptor exists.
.PP
Some network devices opened with
-.B pcap_create(3PCAP)
+.BR pcap_create (3PCAP)
and
.BR pcap_activate(3PCAP) ,
or with
@@ -58,7 +58,7 @@ FreeBSD 4.3 and 4.4, and Endace DAG devices), so
is returned for
those devices. In that case, those calls must be given a timeout less
than or equal to the timeout returned by
-.B pcap_get_required_select_timeout(3PCAP)
+.BR pcap_get_required_select_timeout (3PCAP)
for the device for which
.B pcap_get_selectable_fd()
returned
@@ -76,9 +76,9 @@ event loop.
Note that a device on which a read can be done without blocking may,
on some platforms, not have any packets to read if the packet buffer
timeout has expired. A call to
-.B pcap_dispatch(3PCAP)
+.BR pcap_dispatch (3PCAP)
or
-.B pcap_next_ex(3PCAP)
+.BR pcap_next_ex (3PCAP)
will return 0 in this case, but will not block.
.PP
Note that in:
@@ -148,4 +148,5 @@ A selectable file descriptor is returned if one exists; otherwise,
.B PCAP_ERROR
is returned.
.SH SEE ALSO
-pcap(3PCAP), kqueue(2)
+.BR pcap (3PCAP),
+.BR kqueue (2)