summaryrefslogtreecommitdiff
path: root/pcap_setnonblock.3pcap
diff options
context:
space:
mode:
authorDenis Ovsienko <denis@ovsienko.info>2020-08-21 19:54:55 +0100
committerDenis Ovsienko <denis@ovsienko.info>2020-08-21 19:54:55 +0100
commit011ac98ff8857872b6318b481e4081e8bf5493d5 (patch)
treedc601c66328ec21d9136459957267efa6845518e /pcap_setnonblock.3pcap
parentb21fe86991032e95d58de95f33354421d9858edb (diff)
downloadlibpcap-011ac98ff8857872b6318b481e4081e8bf5493d5.tar.gz
man: Format more special constants bold. [skip ci]
Some man pages used bold font for special meaning constants (e.g. -1 for infinity, 0 for false, 1 for true, NULL), but some didn't. Make the formatting consistently bold, but leave ordinary constants (number of packets in a buffer, a timeout, a buffer size) intact.
Diffstat (limited to 'pcap_setnonblock.3pcap')
-rw-r--r--pcap_setnonblock.3pcap16
1 files changed, 11 insertions, 5 deletions
diff --git a/pcap_setnonblock.3pcap b/pcap_setnonblock.3pcap
index a38ca0d7..65cfea28 100644
--- a/pcap_setnonblock.3pcap
+++ b/pcap_setnonblock.3pcap
@@ -47,8 +47,9 @@ If there is an error,
.B PCAP_ERROR
is returned and
.I errbuf
-is filled in with an appropriate error message; otherwise, 0 is
-returned.
+is filled in with an appropriate error message; otherwise,
+.B 0
+is returned.
.PP
In
``non-blocking'' mode, an attempt to read from the capture descriptor
@@ -56,7 +57,8 @@ with
.BR pcap_dispatch (3PCAP)
and
.BR pcap_next_ex (3PCAP)
-will, if no packets are currently available to be read, return 0
+will, if no packets are currently available to be read, return
+.B 0
immediately rather than blocking waiting for packets to arrive.
.PP
.BR pcap_loop (3PCAP)
@@ -65,7 +67,9 @@ available;
.BR pacp_dispatch ()
should be used instead.
.BR pcap_next (3PCAP)
-will return NULL if there are no packets currently available to read;
+will return
+.B NULL
+if there are no packets currently available to read;
this is indistinguishable from an error, so
.BR pcap_next_ex ()
should be used instead.
@@ -80,7 +84,9 @@ is required in order to put it into ``non-blocking'' mode.
.SH RETURN VALUE
.BR pcap_getnonblock ()
returns the current ``non-blocking'' state of the capture descriptor; it
-always returns 0 on ``savefiles''.
+always returns
+.B 0
+on ``savefiles''.
If there is an error,
.B PCAP_ERROR
is returned and