aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2021-09-27 14:37:10 -0700
committerWireshark GitLab Utility <gerald+gitlab-utility@wireshark.org>2021-09-28 16:41:32 +0000
commit440bbd37a0ac91ce1303b31adb4afd300838036c (patch)
tree992d135cf01093dd7611378d90498d8e6222a6f4 /doc
parenta156d7d05d9247d05fa10094c2bd0f68d29116db (diff)
Docs: More POD markup cleanup.
Diffstat (limited to 'doc')
-rw-r--r--doc/dumpcap.pod4
-rw-r--r--doc/rawshark.pod6
-rw-r--r--doc/tshark.pod14
-rw-r--r--doc/wireshark-filter.pod4
-rw-r--r--doc/wireshark.pod14
5 files changed, 18 insertions, 24 deletions
diff --git a/doc/dumpcap.pod b/doc/dumpcap.pod
index c67a0a70f3..29ca7a8ff2 100644
--- a/doc/dumpcap.pod
+++ b/doc/dumpcap.pod
@@ -71,7 +71,7 @@ syntax follows the rules of the pcap library.
=item -a|--autostop E<lt>capture autostop conditionE<gt>
Specify a criterion that specifies when B<Dumpcap> is to stop writing
-to a capture file. The criterion is of the form I<test>B<:>I<value>,
+to a capture file. The criterion is of the form I<test:value>,
where I<test> is one of:
B<duration>:I<value> Stop writing to a capture file after I<value> seconds have
@@ -105,7 +105,7 @@ writing to that file and so on. If the I<files> option is not set,
new files filled up until one of the capture stop conditions match (or
until the disk is full).
-The criterion is of the form I<key>B<:>I<value>,
+The criterion is of the form I<key:value>,
where I<key> is one of:
B<duration>:I<value> switch to the next file after I<value> seconds have
diff --git a/doc/rawshark.pod b/doc/rawshark.pod
index bd81e37143..525df2ac7b 100644
--- a/doc/rawshark.pod
+++ b/doc/rawshark.pod
@@ -108,7 +108,7 @@ fields might be displayed.
=item -d E<lt>encapsulationE<gt>
Specify how the packet data should be dissected. The encapsulation is of the
-form I<type>B<:>I<value>, where I<type> is one of:
+form I<type:value>, where I<type> is one of:
B<encap>:I<name> Packet data should be dissected using the
libpcap/Npcap/WinPcap data link type (DLT) I<name>, e.g. B<encap:EN10MB> for
@@ -189,7 +189,7 @@ B<v> to enable VLAN IDs to names resolution
Set a preference value, overriding the default value and any value read
from a preference file. The argument to the option is a string of the
-form I<prefname>B<:>I<value>, where I<prefname> is the name of the
+form I<prefname:value>, where I<prefname> is the name of the
preference (which is the same name that would appear in the preference
file), and I<value> is the value to which it should be set.
@@ -299,7 +299,7 @@ file exists, it is read next, overriding any previous values. Note: If
the command line option B<-o> is used (possibly more than once), it will
in turn override values from the preferences files.
-The preferences settings are in the form I<prefname>B<:>I<value>,
+The preferences settings are in the form I<prefname:value>,
one per line,
where I<prefname> is the name of the preference
and I<value> is the value to
diff --git a/doc/tshark.pod b/doc/tshark.pod
index 4f5cfca077..a0e04a9535 100644
--- a/doc/tshark.pod
+++ b/doc/tshark.pod
@@ -161,7 +161,7 @@ frame dependencies to be calculated correctly.
=item -a|--autostop E<lt>capture autostop conditionE<gt>
Specify a criterion that specifies when B<TShark> is to stop writing
-to a capture file. The criterion is of the form I<test>B<:>I<value>,
+to a capture file. The criterion is of the form I<test:value>,
where I<test> is one of:
B<duration>:I<value> Stop writing to a capture file after I<value> seconds
@@ -205,7 +205,7 @@ writing to that file and so on. If the I<files> option is not set,
new files filled up until one of the capture stop conditions match (or
until the disk is full).
-The criterion is of the form I<key>B<:>I<value>,
+The criterion is of the form I<key:value>,
where I<key> is one of:
B<duration>:I<value> switch to the next file after I<value> seconds have
@@ -657,7 +657,7 @@ B<v> to enable VLAN IDs to names resolution
Set a preference value, overriding the default value and any value read
from a preference file. The argument to the option is a string of the
-form I<prefname>B<:>I<value>, where I<prefname> is the name of the
+form I<prefname:value>, where I<prefname> is the name of the
preference (which is the same name that would appear in the preference
file), and I<value> is the value to which it should be set.
@@ -930,7 +930,7 @@ after printing the summary and/or details, if either are also being displayed.
=item -X E<lt>eXtension optionsE<gt>
Specify an option to be passed to a B<TShark> module. The eXtension option
-is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
+is in the form I<extension_key:value>, where I<extension_key> can be:
B<lua_script>:I<lua_script_filename> tells B<TShark> to load the given script in
addition to the default Lua scripts.
@@ -1546,7 +1546,7 @@ This option can be used multiple times on the command line.
If the optional I<filter> is provided, the stats will only be calculated
for those frames that match that filter.
-Example: B<-z "mac-lte,stat,mac-lte.rnti>3000"> will only collect stats for
+Example: B<-z "mac-lte,stat,mac-lte.rntiE<gt>3000"> will only collect stats for
UEs with an assigned RNTI whose value is more than 3000.
=item B<-z> megaco,rtd[I<,filter>]
@@ -1628,7 +1628,7 @@ This option can be used multiple times on the command line.
If the optional I<filter> is provided, the stats will only be calculated
for those frames that match that filter.
-Example: B<-z "rlc-lte,stat,rlc-lte.ueid>3000"> will only collect stats for
+Example: B<-z "rlc-lte,stat,rlc-lte.ueidE<gt>3000"> will only collect stats for
UEs with a UEId of more than 3000.
=item B<-z> rpc,programs
@@ -1829,7 +1829,7 @@ file exists, it is read next, overriding any previous values. Note: If
the command line option B<-o> is used (possibly more than once), it will
in turn override values from the preferences files.
-The preferences settings are in the form I<prefname>B<:>I<value>,
+The preferences settings are in the form I<prefname:value>,
one per line,
where I<prefname> is the name of the preference
and I<value> is the value to
diff --git a/doc/wireshark-filter.pod b/doc/wireshark-filter.pod
index 32f7abc4c6..4571f0daeb 100644
--- a/doc/wireshark-filter.pod
+++ b/doc/wireshark-filter.pod
@@ -445,19 +445,15 @@ can find references and examples at the following locations:
=over 4
=item *
-
The online Display Filter Reference: L<https://www.wireshark.org/docs/dfref/>
=item *
-
I<View:Internals:Supported Protocols> in Wireshark
=item *
-
C<tshark -G fields> on the command line
=item *
-
The Wireshark wiki: L<https://gitlab.com/wireshark/wireshark/-/wikis/DisplayFilters>
=back
diff --git a/doc/wireshark.pod b/doc/wireshark.pod
index fb81f463e2..cf6ad7fa97 100644
--- a/doc/wireshark.pod
+++ b/doc/wireshark.pod
@@ -224,7 +224,7 @@ it from the menus instead. Those users may just skip this section.
=item -a|--autostop E<lt>capture autostop conditionE<gt>
Specify a criterion that specifies when B<Wireshark> is to stop writing
-to a capture file. The criterion is of the form I<test>B<:>I<value>,
+to a capture file. The criterion is of the form I<test:value>,
where I<test> is one of:
B<duration>:I<value> Stop writing to a capture file after I<value> seconds have
@@ -259,7 +259,7 @@ writing to that file and so on. If the I<files> option is not set,
new files filled up until one of the capture stop conditions match (or
until the disk is full).
-The criterion is of the form I<key>B<:>I<value>,
+The criterion is of the form I<key:value>,
where I<key> is one of:
B<duration>:I<value> switch to the next file after I<value> seconds have
@@ -531,7 +531,7 @@ B<v> to enable VLAN IDs to names resolution
Set a preference or recent value, overriding the default value and any value
read from a preference/recent file. The argument to the flag is a string of
-the form I<prefname>B<:>I<value>, where I<prefname> is the name of the
+the form I<prefname:value>, where I<prefname> is the name of the
preference/recent value (which is the same name that would appear in the
preference/recent file), and I<value> is the value to which it should be set.
Since B<Ethereal> 0.10.12, the recent settings replaces the formerly used
@@ -566,7 +566,7 @@ promiscuous mode.
Special path settings usually detected automatically. This is used for
special cases, e.g. starting Wireshark from a known location on an USB stick.
-The criterion is of the form I<key>B<:>I<path>, where I<key> is one of:
+The criterion is of the form I<key:path>, where I<key> is one of:
B<persconf>:I<path> path of personal configuration files, like the
preferences files.
@@ -664,7 +664,7 @@ Set the default capture file name, or '-' for standard output.
=item -X E<lt>eXtension optionsE<gt>
Specify an option to be passed to an B<Wireshark> module. The eXtension option
-is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
+is in the form I<extension_key:value>, where I<extension_key> can be:
B<lua_script>:I<lua_script_filename> tells B<Wireshark> to load the given script in addition to the
default Lua scripts.
@@ -1452,12 +1452,10 @@ The window in which the data stream is displayed lets you select:
=over 8
=item *
-
whether to display the entire conversation, or one or the other side of
it;
=item *
-
whether the data being displayed is to be treated as ASCII or EBCDIC
text or as raw hex data;
@@ -2574,7 +2572,7 @@ file exists, it is read next, overriding any previous values. Note: If
the command line flag B<-o> is used (possibly more than once), it will
in turn override values from the preferences files.
-The preferences settings are in the form I<prefname>B<:>I<value>,
+The preferences settings are in the form I<prefname:value>,
one per line,
where I<prefname> is the name of the preference
and I<value> is the value to