Skip to content

Commit

Permalink
improve some man pages formatting
Browse files Browse the repository at this point in the history
In some man pages the roff processor hyphenated function names in the
"SEE ALSO" section, add markup to prevent that. Also disable line
adjustment in pcap-tstamp.manmisc to suppress the warning:

<standard input>:171: warning [p 2, 11.0i]: cannot adjust line
  • Loading branch information
infrastation committed Jan 25, 2017
1 parent 69bed0e commit bf5d5eb
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 7 deletions.
6 changes: 4 additions & 2 deletions pcap-tstamp.manmisc.in
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,13 @@ 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)
\%pcap_fopen_offline_with_tstamp_precision(3PCAP),
\%pcap_get_tstamp_precision(3PCAP)
.ad
4 changes: 2 additions & 2 deletions pcap_dump_open.3pcap.in
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,6 @@ is returned,
can be used to get the error text.
.SH SEE ALSO
pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
pcap_open_offline(3PCAP), pcap_open_live(3PCAP), pcap_open_dead(3PCAP),
\%pcap_open_offline(3PCAP), pcap_open_live(3PCAP), pcap_open_dead(3PCAP),
pcap_dump(3PCAP), pcap_dump_close(3PCAP), pcap_geterr(3PCAP),
pcap-savefile(@MAN_FILE_FORMATS@)
\%pcap-savefile(@MAN_FILE_FORMATS@)
2 changes: 1 addition & 1 deletion pcap_fileno.3pcap
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ it returns \-1.
.SH SEE ALSO
pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
pcap_open_live(3PCAP), pcap_open_offline(3PCAP),
pcap_fopen_offline(3PCAP), pcap_open_dead(3PCAP)
\%pcap_fopen_offline(3PCAP), pcap_open_dead(3PCAP)
2 changes: 1 addition & 1 deletion pcap_open_dead.3pcap.in
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,4 @@ seconds and nanoseconds. Its value does not affect
.BR pcap_compile() .
.SH SEE ALSO
pcap(3PCAP), pcap_compile(3PCAP), pcap_dump_open(3PCAP),
pcap-linktype(@MAN_MISC_INFO@)
\%pcap-linktype(@MAN_MISC_INFO@)
2 changes: 1 addition & 1 deletion pcap_set_timeout.3pcap
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ returns 0 on success or
if called on a capture handle that has been activated.
.SH SEE ALSO
pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
pcap_set_immediate_mode(3PCAP)
\%pcap_set_immediate_mode(3PCAP)

0 comments on commit bf5d5eb

Please sign in to comment.