diff options
author | Guy Harris <guy@alum.mit.edu> | 2006-07-09 22:45:48 +0000 |
---|---|---|
committer | Guy Harris <guy@alum.mit.edu> | 2006-07-09 22:45:48 +0000 |
commit | d26ea2b24d7322a803a2d867b6ae958a7afa4c4d (patch) | |
tree | 9b4b4641f5357d228c4a7126f8cf147cf823713b /doc | |
parent | 8b315480f1df953751fda12c58ed891862e03edc (diff) | |
download | wireshark-d26ea2b24d7322a803a2d867b6ae958a7afa4c4d.tar.gz wireshark-d26ea2b24d7322a803a2d867b6ae958a7afa4c4d.tar.bz2 wireshark-d26ea2b24d7322a803a2d867b6ae958a7afa4c4d.zip |
Use L<> on all links.
Don't use anything on man page references - pod2man handles that.
Don't refer to "the capture file format section" of the Wireshark man
page, as there's no section explicitly labelled as such; just refer to
the beginning of the DESCRIPTION section.
svn path=/trunk/; revision=18694
Diffstat (limited to 'doc')
-rw-r--r-- | doc/capinfos.pod | 15 | ||||
-rw-r--r-- | doc/dumpcap.pod | 8 | ||||
-rw-r--r-- | doc/editcap.pod | 15 | ||||
-rw-r--r-- | doc/idl2wrs.pod | 8 | ||||
-rw-r--r-- | doc/mergecap.pod | 15 | ||||
-rw-r--r-- | doc/text2pcap.pod | 6 | ||||
-rw-r--r-- | doc/tshark.pod | 19 | ||||
-rw-r--r-- | doc/wireshark-filter.pod.template | 10 | ||||
-rw-r--r-- | doc/wireshark.pod | 14 |
9 files changed, 59 insertions, 51 deletions
diff --git a/doc/capinfos.pod b/doc/capinfos.pod index 01639f7499..d8c071fcf1 100644 --- a/doc/capinfos.pod +++ b/doc/capinfos.pod @@ -31,11 +31,12 @@ will report all statistics available. B<Capinfos> is able to detect and read the same capture files that are supported by B<Wireshark>. -The input files don't need a specific filename extension, the file +The input files don't need a specific filename extension; the file format and an optional gzip compression will be automatically detected. -The I<capture file format> section of I<wireshark(1)> or -I<http://www.wireshark.org/docs/man-pages/wireshark.1.html> -provides a detailed description. +Near the beginning of the DESCRIPTION section of wireshark(1) or +L<http://www.wireshark.org/docs/man-pages/wireshark.1.html> +is a detailed description of the way B<Wireshark> handles this, which is +the same way B<Capinfos> handles this. =head1 OPTIONS @@ -106,15 +107,15 @@ Prints the help listing and exits. =head1 SEE ALSO -I<tcpdump(8)>, I<pcap(3)>, I<wireshark(1)>, I<mergecap(1)>, I<editcap(1)>, I<tshark(1)> +tcpdump(8), pcap(3), wireshark(1)>, mergecap(1), editcap(1), tshark(1) =head1 NOTES B<Capinfos> is part of the B<Wireshark> distribution. The latest version -of B<Wireshark> can be found at B<http://www.wireshark.org>. +of B<Wireshark> can be found at L<http://www.wireshark.org>. HTML versions of the Wireshark project man pages are available at: -http://www.wireshark.org/docs/man-pages +L<http://www.wireshark.org/docs/man-pages>. =head1 AUTHORS diff --git a/doc/dumpcap.pod b/doc/dumpcap.pod index a5a48ddf49..721b2cf3b4 100644 --- a/doc/dumpcap.pod +++ b/doc/dumpcap.pod @@ -194,19 +194,19 @@ reported by B<-L> are the values that can be used. =head1 CAPTURE FILTER SYNTAX -See the manual page of I<tcpdump(8)>. +See the manual page of tcpdump(8). =head1 SEE ALSO -I<wireshark(1)>, I<tshark(1)>, I<editcap(1)>, I<tcpdump(8)>, I<pcap(3)> +wireshark(1), tshark(1), editcap(1), tcpdump(8), pcap(3) =head1 NOTES B<Dumpcap> is part of the B<Wireshark> distribution. The latest version -of B<Wireshark> can be found at B<http://www.wireshark.org>. +of B<Wireshark> can be found at L<http://www.wireshark.org>. HTML versions of the Wireshark project man pages are available at: -http://www.wireshark.org/docs/man-pages +L<http://www.wireshark.org/docs/man-pages>. =head1 AUTHORS diff --git a/doc/editcap.pod b/doc/editcap.pod index acf4732181..b361203382 100644 --- a/doc/editcap.pod +++ b/doc/editcap.pod @@ -41,11 +41,12 @@ in that case I<only> the selected packets will be written to the capture file. B<Editcap> is able to detect, read and write the same capture files that are supported by B<Wireshark>. -The input file doesn't need a specific filename extension, the file +The input file doesn't need a specific filename extension; the file format and an optional gzip compression will be automatically detected. -The I<capture file format> section of I<wireshark(1)> or -I<http://www.wireshark.org/docs/man-pages/wireshark.1.html> -provides a detailed description. +Near the beginning of the DESCRIPTION section of wireshark(1) or +L<http://www.wireshark.org/docs/man-pages/wireshark.1.html> +is a detailed description of the way B<Wireshark> handles this, which is +the same way B<Editcap> handles this. B<Editcap> can write the file in several output formats. The B<-F> flag can be used to specify the format in which to write the capture @@ -199,15 +200,15 @@ To introduce 5% random errors in a capture file use: =head1 SEE ALSO -I<tcpdump(8)>, I<pcap(3)>, I<wireshark(1)>, I<mergecap(1)> +tcpdump(8), pcap(3), wireshark(1), mergecap(1) =head1 NOTES B<Editcap> is part of the B<Wireshark> distribution. The latest version -of B<Wireshark> can be found at B<http://www.wireshark.org>. +of B<Wireshark> can be found at L<http://www.wireshark.org>. HTML versions of the Wireshark project man pages are available at: -http://www.wireshark.org/docs/man-pages +L<http://www.wireshark.org/docs/man-pages>. =head1 AUTHORS diff --git a/doc/idl2wrs.pod b/doc/idl2wrs.pod index fffedb25de..43078951bf 100644 --- a/doc/idl2wrs.pod +++ b/doc/idl2wrs.pod @@ -71,17 +71,17 @@ eg: PYTHONPATH=/usr/lib/python1.5/ =head1 SEE ALSO -I<wireshark(1)> +wireshark(1) =head1 NOTES B<idl2wrs> (including B<wireshark_be.py> and B<wireshark_gen.py>) are part of the B<Wireshark> distribution. The latest version of B<Wireshark> can -be found at B<http://www.wireshark.org>. +be found at L<http://www.wireshark.org>. -B<idl2wrs> uses B<omniidl>, and IDL parser, and can be found at -B<http://omniorb.sourceforge.net/> +B<idl2wrs> uses B<omniidl>, an IDL parser, and can be found at +L<http://omniorb.sourceforge.net/> =head1 TODO diff --git a/doc/mergecap.pod b/doc/mergecap.pod index 3709764571..f00c74370d 100644 --- a/doc/mergecap.pod +++ b/doc/mergecap.pod @@ -28,11 +28,12 @@ all of the packets in both input capture files to the output file. B<Mergecap> is able to detect, read and write the same capture files that are supported by B<Wireshark>. -The input files don't need a specific filename extension, the file +The input files don't need a specific filename extension; the file format and an optional gzip compression will be automatically detected. -The I<capture file format> section of I<wireshark(1)> or -I<http://www.wireshark.org/docs/man-pages/wireshark.1.html> -provides a detailed description. +Near the beginning of the DESCRIPTION section of wireshark(1) or +L<http://www.wireshark.org/docs/man-pages/wireshark.1.html> +is a detailed description of the way B<Wireshark> handles this, which is +the same way B<Mergecap> handles this. B<Mergecap> can write the file in several output formats. The B<-F> flag can be used to specify the format in which to write the @@ -120,7 +121,7 @@ fddi>' is specified). =head1 SEE ALSO -I<tcpdump(8)>, I<pcap(3)>, I<wireshark(1)>, I<editcap(1)> +tcpdump(8), pcap(3), wireshark(1), editcap(1) =head1 NOTES @@ -128,10 +129,10 @@ B<Mergecap> is based heavily upon B<editcap> by Richard Sharpe <sharpe[AT]ns.aus.com> and Guy Harris <guy[AT]alum.mit.edu>. B<Mergecap> is part of the B<Wireshark> distribution. The latest version -of B<Wireshark> can be found at B<http://www.wireshark.org>. +of B<Wireshark> can be found at L<http://www.wireshark.org>. HTML versions of the Wireshark project man pages are available at: -http://www.wireshark.org/docs/man-pages +L<http://www.wireshark.org/docs/man-pages>. =head1 AUTHORS diff --git a/doc/text2pcap.pod b/doc/text2pcap.pod index 585cf2f3f4..bb17f6c595 100644 --- a/doc/text2pcap.pod +++ b/doc/text2pcap.pod @@ -184,7 +184,7 @@ SCTP header. =item -t E<lt>timefmtE<gt> Treats the text before the packet as a date/time code; I<timefmt> is a -format string of the sort supported by B<strptime(3)>. +format string of the sort supported by strptime(3). Example: The time "10:15:14.5476" has the format code "%H:%M:%S." B<NOTE:> The subsecond component delimiter must be specified (.) but no @@ -195,12 +195,12 @@ a second. =head1 SEE ALSO -I<od(1)>, I<tcpdump(8)>, I<pcap(3)>, I<wireshark(1)>, I<editcap(1)>, I<strptime(3)>. +od(1), tcpdump(8), pcap(3), wireshark(1), editcap(1), strptime(3). =head1 NOTES B<Text2pcap> is part of the B<Wireshark> distribution. The latest version -of B<Wireshark> can be found at B<http://www.wireshark.org>. +of B<Wireshark> can be found at L<http://www.wireshark.org>. =head1 AUTHORS diff --git a/doc/tshark.pod b/doc/tshark.pod index 4c8f3ac087..8391b8b466 100644 --- a/doc/tshark.pod +++ b/doc/tshark.pod @@ -52,11 +52,12 @@ interface and displays a summary line on stdout for each received packet. B<TShark> is able to detect, read and write the same capture files that are supported by B<Wireshark>. -The input file doesn't need a specific filename extension, the file +The input file doesn't need a specific filename extension; the file format and an optional gzip compression will be automatically detected. -The I<capture file format> section of I<wireshark(1)> or -I<http://www.wireshark.org/docs/man-pages/wireshark.1.html> -provides a detailed description. +Near the beginning of the DESCRIPTION section of wireshark(1) or +L<http://www.wireshark.org/docs/man-pages/wireshark.1.html> +is a detailed description of the way B<Wireshark> handles this, which is +the same way B<Tshark> handles this. Compressed file support uses (and therefore requires) the zlib library. If the zlib library is not present, B<TShark> will compile, but will @@ -710,12 +711,12 @@ SIP packets exchanged by the host at IP address 1.2.3.4 . =head1 CAPTURE FILTER SYNTAX -See the manual page of I<tcpdump(8)>. +See the manual page of tcpdump(8). =head1 READ FILTER SYNTAX For a complete table of protocol and protocol fields that are filterable -in B<TShark> see the I<wireshark-filter(4)> manual page. +in B<TShark> see the wireshark-filter(4) manual page. =head1 FILES @@ -857,15 +858,15 @@ personal preferences file. =head1 SEE ALSO -I<wireshark-filter(4)> I<wireshark(1)>, I<editcap(1)>, I<tcpdump(8)>, I<pcap(3)> +wireshark-filter(4), wireshark(1), editcap(1), tcpdump(8), pcap(3) =head1 NOTES B<TShark> is part of the B<Wireshark> distribution. The latest version -of B<Wireshark> can be found at B<http://www.wireshark.org>. +of B<Wireshark> can be found at L<http://www.wireshark.org>. HTML versions of the Wireshark project man pages are available at: -http://www.wireshark.org/docs/man-pages +L<http://www.wireshark.org/docs/man-pages>. =head1 AUTHORS diff --git a/doc/wireshark-filter.pod.template b/doc/wireshark-filter.pod.template index 5e410bf375..020c02f3d1 100644 --- a/doc/wireshark-filter.pod.template +++ b/doc/wireshark-filter.pod.template @@ -83,7 +83,7 @@ This example shows an interesting PCRE feature: pattern match options have to be specified with the B<(?>optionB<)> construct. For instance, B<(?i)> performs a case-insensitive pattern match. More information on PCRE can be found in the pcrepattern(3) man page (Perl Regular Expressions are explained in -B<http://www.perldoc.com/perl5.8.0/pod/perlre.html>). +L<http://www.perldoc.com/perl5.8.0/pod/perlre.html>). Note: the "matches" operator is only available if B<Wireshark> or B<TShark> have been compiled with the PCRE library. This can be checked by running: @@ -380,7 +380,7 @@ field is also given. The B<wireshark-filters> manpage is part of the B<Wireshark> distribution. The latest version of B<Wireshark> can be found at -B<http://www.wireshark.org>. +L<http://www.wireshark.org>. Regular expressions in the "matches" operator are provided with B<libpcre>, the Perl-Compatible Regular Expressions library: see B<http://www.pcre.org/>. @@ -388,12 +388,12 @@ the Perl-Compatible Regular Expressions library: see B<http://www.pcre.org/>. This manpage does not describe the capture filter syntax, which is different. See the tcpdump(8) manpage for a description of capture filters. Microsoft Windows versions use WinPcap from -B<http://www.winpcap.org/> for which the capture filter syntax is described -in B<http://www.winpcap.org/docs/man/html/group__language.html>. +L<http://www.winpcap.org/> for which the capture filter syntax is described +in L<http://www.winpcap.org/docs/man/html/group__language.html>. =head1 SEE ALSO -I<wireshark(1)>, I<tshark(1)>, I<editcap(1)>, I<tcpdump(8)>, I<pcap(3)> +wireshark(1), tshark(1), editcap(1), tcpdump(8), pcap(3) =head1 AUTHORS diff --git a/doc/wireshark.pod b/doc/wireshark.pod index 0e68a3046e..30c9272b73 100644 --- a/doc/wireshark.pod +++ b/doc/wireshark.pod @@ -1373,7 +1373,8 @@ Display locally installed HTML versions of these manual pages in a web browser. =item Help:Wireshark Online -Various links to online resources to be open in a web browser, like http://www.wireshark.org. +Various links to online resources to be open in a web browser, like +L<http://www.wireshark.org>. =item Help:About Wireshark @@ -1954,12 +1955,12 @@ protocols built into Wireshark are. =head1 CAPTURE FILTER SYNTAX -See the manual page of I<tcpdump(8)>. +See the manual page of tcpdump(8). =head1 DISPLAY FILTER SYNTAX For a complete table of protocol and protocol fields that are filterable -in B<Wireshark> see the I<wireshark-filter(4)> manual page. +in B<Wireshark> see the wireshark-filter(4) manual page. =head1 FILES @@ -2204,12 +2205,15 @@ See above in the description of the About:Plugins page. =head1 SEE ALSO -I<wireshark-filter(4)> I<tshark(1)>, I<editcap(1)>, I<tcpdump(8)>, I<pcap(3)> +wireshark-filter(4), tshark(1), editcap(1), tcpdump(8), pcap(3) =head1 NOTES The latest version of B<Wireshark> can be found at -B<http://www.wireshark.org>. +L<http://www.wireshark.org>. + +HTML versions of the Wireshark project man pages are available at: +L<http://www.wireshark.org/docs/man-pages>. =head1 AUTHORS |