summaryrefslogtreecommitdiff
path: root/pcap-tstamp.manmisc.in
diff options
context:
space:
mode:
authorDenis Ovsienko <denis@ovsienko.info>2018-07-17 12:57:49 +0000
committerDenis Ovsienko <denis@ovsienko.info>2018-07-17 13:06:12 +0000
commita710ddc83c9ec174d417c695d5f0ada310ff9660 (patch)
treedd398bc774192de423f3bc8e97ab00936a98afa3 /pcap-tstamp.manmisc.in
parent04b703adb76af5bade242f22c2b2c557c6ab1161 (diff)
downloadlibpcap-a710ddc83c9ec174d417c695d5f0ada310ff9660.tar.gz
Refine references in some man pages, round 1.
When a man page text for the first time refers to a libpcap function that is not a topic of the man page, make sure it points to the 3PCAP section. This way the reference becomes a hyperlink in the HTML version and the web-site cohesion improves. Make sure the SEE ALSO section does not list references already present in the main text. This way the references that appear only in SEE ALSO are much easier to notice, and cohesion remains the same. [skip ci]
Diffstat (limited to 'pcap-tstamp.manmisc.in')
-rw-r--r--pcap-tstamp.manmisc.in19
1 files changed, 4 insertions, 15 deletions
diff --git a/pcap-tstamp.manmisc.in b/pcap-tstamp.manmisc.in
index 38c56518..12405c83 100644
--- a/pcap-tstamp.manmisc.in
+++ b/pcap-tstamp.manmisc.in
@@ -93,9 +93,9 @@ call and before a
call to specify the type of time stamp to be used on the device.
The time stamp types are listed here; the first value is the #define to
use in code, the second value is the value returned by
-.B pcap_tstamp_type_val_to_name()
+.B pcap_tstamp_type_val_to_name(3PCAP)
and accepted by
-.BR pcap_tstamp_type_name_to_val() .
+.BR pcap_tstamp_type_name_to_val(3PCAP) .
.RS 5
.TP 5
.BR PCAP_TSTAMP_HOST " - " host
@@ -149,9 +149,9 @@ call will fail, and the time stamps supplied after the
call will have microsecond resolution.
.LP
When opening a savefile, the
-.BR pcap_open_offline_with_tstamp_precision (3PCAP)
+.BR \%pcap_open_offline_with_tstamp_precision (3PCAP)
and
-.BR pcap_fopen_offline_with_tstamp_precision (3PCAP)
+.BR \%pcap_fopen_offline_with_tstamp_precision (3PCAP)
routines can be used to specify the resolution of time stamps to be read
from the file; if the time stamps in the file have a lower resolution,
the fraction-of-a-second portion of the time stamps will be scaled to
@@ -164,14 +164,3 @@ when capturing packets, this does not reflect the actual precision of
the time stamp supplied by the hardware or operating system and, when
reading a savefile, this does not indicate the actual precision of time
stamps in the file.
-.SH SEE ALSO
-.na
-pcap_set_tstamp_type(3PCAP),
-pcap_list_tstamp_types(3PCAP),
-pcap_tstamp_type_val_to_name(3PCAP),
-pcap_tstamp_type_name_to_val(3PCAP),
-pcap_set_tstamp_precision(3PCAP),
-pcap_open_offline_with_tstamp_precision(3PCAP),
-\%pcap_fopen_offline_with_tstamp_precision(3PCAP),
-\%pcap_get_tstamp_precision(3PCAP)
-.ad