Add a warning about the behavior if no timeout is set.

[libpcap] / pcap_set_timeout.3pcap

diff --git a/pcap_set_timeout.3pcap b/pcap_set_timeout.3pcap
index b7282037b3e7cf94e8434cdc3156e893154cdf92..a89327f2ebd29c38176e106b164609e90de593fe 100644 (file)
--- a/pcap_set_timeout.3pcap
+++ b/pcap_set_timeout.3pcap
@@ -17,7 +17,7 @@
 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 .\"
-.TH PCAP_SET_TIMEOUT 3PCAP "16 April 2014"
+.TH PCAP_SET_TIMEOUT 3PCAP "1 December 2015"
 .SH NAME
 pcap_set_timeout \- set the read timeout for a not-yet-activated
 capture handle
@@ -36,10 +36,15 @@ sets the read timeout that will be used on a capture handle when
 the handle is activated to
 .IR to_ms ,
 which is in units of milliseconds.
+.LP
+The behavior, if the timeout isn't specified, is undefined.  We
+recommend always setting the timeout to a non-zero value unless
+immediate mode is set, in which case the timeout has no effect.
 .SH RETURN VALUE
 .B pcap_set_timeout()
 returns 0 on success or
 .B PCAP_ERROR_ACTIVATED
 if called on a capture handle that has been activated.
 .SH SEE ALSO
-pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP)
+pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
+pcap_set_immediate_mode(3PCAP)