aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2021-10-01 16:36:17 -0700
committerWireshark GitLab Utility <gerald+gitlab-utility@wireshark.org>2021-10-01 23:57:21 +0000
commitcfc3212ae2f37f9fec73ccd0a3860f1f5ad018b5 (patch)
tree02d6694aca4fd06926cfa1df0a45fe21450a2649
parentce22d958a86de5a75239e3cb480ff50e37f92553 (diff)
Docs: Miscellaneous man page updates.
Add the program version to more commonly-used commands. We were labeling output with "Output" and "Example output". Use "Example output" everywhere. Other miscellaneous updates.
-rw-r--r--doc/androiddump.adoc66
-rw-r--r--doc/capinfos.adoc5
-rw-r--r--doc/ciscodump.adoc6
-rw-r--r--doc/dpauxmon.adoc6
-rw-r--r--doc/editcap.adoc5
-rw-r--r--doc/etwdump.adoc6
-rw-r--r--doc/mergecap.adoc5
-rw-r--r--doc/mmdbresolve.adoc3
-rw-r--r--doc/randpktdump.adoc6
-rw-r--r--doc/rawshark.adoc9
-rw-r--r--doc/reordercap.adoc8
-rw-r--r--doc/sdjournal.adoc7
-rw-r--r--doc/sshdump.adoc7
-rw-r--r--doc/text2pcap.adoc9
-rw-r--r--doc/udpdump.adoc6
15 files changed, 80 insertions, 74 deletions
diff --git a/doc/androiddump.adoc b/doc/androiddump.adoc
index cb44dd1f2c..12ffab6a6e 100644
--- a/doc/androiddump.adoc
+++ b/doc/androiddump.adoc
@@ -205,49 +205,51 @@ To see interfaces:
androiddump --extcap-interfaces
- Example output:
- interface {display=Android Logcat Main unknown MSM7627A}{value=android-logcat-main-MSM7627A}
- interface {display=Android Logcat System unknown MSM7627A}{value=android-logcat-system-MSM7627A}
- interface {display=Android Logcat Radio unknown MSM7627A}{value=android-logcat-radio-MSM7627A}
- interface {display=Android Logcat Events unknown MSM7627A}{value=android-logcat-events-MSM7627A}
- interface {display=Android Bluetooth Hcidump unknown MSM7627A}{value=android-bluetooth-hcidump-MSM7627A}
-
- Human-readable display name of interfaces contains interface type, one of:
- android-logcat-main (Android Logcat Main)
- android-logcat-system (Android Logcat System)
- android-logcat-radio (Android Logcat Radio)
- android-logcat-events (Android Logcat Events)
- android-logcat-text-main (Android Logcat Main)
- android-logcat-text-system (Android Logcat System)
- android-logcat-text-radio (Android Logcat Radio)
- android-logcat-text-events (Android Logcat Events)
- android-logcat-text-crash (Android Logcat Crash)
- android-bluetooth-hcidump (Android Bluetooth Hcidump)
- android-bluetooth-external-parser (Android Bluetooth External Parser)
- android-bluetooth-btsnoop-net (Android Bluetooth Btsnoop Net)
- android-wifi-tcpdump (Android WiFi)
- Then Android Device's name if available, otherwise "unknown".
- Last part of it is DeviceID - the identificator of the device provided by Android SDK (see "adb devices").
-
- For example:
- "Android Logcat Main unknown MSM7627A"
-
- "Android Logcat Main" - user-friendly type of interface
- "unknown" - name of Android Device
- "MSM7627A" - device ID
+.Example output
+----
+interface {display=Android Logcat Main unknown MSM7627A}{value=android-logcat-main-MSM7627A}
+interface {display=Android Logcat System unknown MSM7627A}{value=android-logcat-system-MSM7627A}
+interface {display=Android Logcat Radio unknown MSM7627A}{value=android-logcat-radio-MSM7627A}
+interface {display=Android Logcat Events unknown MSM7627A}{value=android-logcat-events-MSM7627A}
+interface {display=Android Bluetooth Hcidump unknown MSM7627A}{value=android-bluetooth-hcidump-MSM7627A}
+
+Human-readable display name of interfaces contains interface type, one of:
+ android-logcat-main (Android Logcat Main)
+ android-logcat-system (Android Logcat System)
+ android-logcat-radio (Android Logcat Radio)
+ android-logcat-events (Android Logcat Events)
+ android-logcat-text-main (Android Logcat Main)
+ android-logcat-text-system (Android Logcat System)
+ android-logcat-text-radio (Android Logcat Radio)
+ android-logcat-text-events (Android Logcat Events)
+ android-logcat-text-crash (Android Logcat Crash)
+ android-bluetooth-hcidump (Android Bluetooth Hcidump)
+ android-bluetooth-external-parser (Android Bluetooth External Parser)
+ android-bluetooth-btsnoop-net (Android Bluetooth Btsnoop Net)
+ android-wifi-tcpdump (Android WiFi)
+Then Android Device's name if available, otherwise "unknown".
+Last part of it is DeviceID - the identificator of the device provided by Android SDK (see "adb devices").
+
+For example:
+"Android Logcat Main unknown MSM7627A"
+
+"Android Logcat Main" - user-friendly type of interface
+"unknown" - name of Android Device
+"MSM7627A" - device ID
+----
To see interface DLTs:
androiddump --extcap-interface=android-bluetooth-hcidump-MSM7627A --extcap-dlts
- Example output:
+.Example output
dlt {number=99}{name=BluetoothH4}{display=Bluetooth HCI UART transport layer plus pseudo-header}
To see interface configuration options:
androiddump --extcap-interface=android-bluetooth-hcidump-MSM7627A --extcap-config
- Example output:
+.Example output
arg {number=0}{call=--adb-server-ip}{display=ADB Server IP Address}{type=string}{default=127.0.0.1}
arg {number=1}{call=--adb-server-tcp-port}{display=ADB Server TCP Port}{type=integer}{range=0,65535}{default=5037}
diff --git a/doc/capinfos.adoc b/doc/capinfos.adoc
index 0f604e0308..57bfde94fc 100644
--- a/doc/capinfos.adoc
+++ b/doc/capinfos.adoc
@@ -453,8 +453,9 @@ xref:dumpcap.html[dumpcap](1), xref:captype.html[captype](1), xref:https://www.t
== NOTES
-*Capinfos* is part of the *Wireshark* distribution. The latest version
-of *Wireshark* can be found at https://www.wireshark.org.
+This is the manual page for *Capinfos* {wireshark-version}.
+*Capinfos* is part of the *Wireshark* distribution.
+The latest version of *Wireshark* can be found at https://www.wireshark.org.
HTML versions of the Wireshark project man pages are available at
https://www.wireshark.org/docs/man-pages.
diff --git a/doc/ciscodump.adoc b/doc/ciscodump.adoc
index ddd8df4c65..beef506fb1 100644
--- a/doc/ciscodump.adoc
+++ b/doc/ciscodump.adoc
@@ -192,21 +192,21 @@ To see interfaces:
Only one interface (cisco) is supported.
- Output:
+.Example output
interface {value=cisco}{display=SSH remote capture}
To see interface DLTs:
ciscodump --extcap-interface=cisco --extcap-dlts
- Output:
+.Example output
dlt {number=147}{name=cisco}{display=Remote capture dependent DLT}
To see interface configuration options:
ciscodump --extcap-interface=cisco --extcap-config
- Output:
+.Example output
ciscodump --extcap-interface=cisco --extcap-config
arg {number=0}{call=--remote-host}{display=Remote SSH server address}
{type=string}{tooltip=The remote SSH host. It can be both an IP address or a hostname}
diff --git a/doc/dpauxmon.adoc b/doc/dpauxmon.adoc
index 0fc528b373..035eaf5b9b 100644
--- a/doc/dpauxmon.adoc
+++ b/doc/dpauxmon.adoc
@@ -126,21 +126,21 @@ To see interfaces:
Only one interface (dpauxmon) is supported.
- Output:
+.Example output
interface {value=dpauxmon}{display=DisplayPort AUX channel capture}
To see interface DLTs:
dpauxmon --extcap-interface=dpauxmon --extcap-dlts
- Output:
+.Example output
dlt {number=275}{name=dpauxmon}{display=DisplayPort AUX channel monitor DLT}
To see interface configuration options:
dpauxmon --extcap-interface=dpauxmon --extcap-config
- Output:
+.Example output
dpauxmon --extcap-interface=dpauxmon --extcap-config
arg {number=0}{call=--interface_id}{display=Interface Id}
{type=unsigned}{tooltip=The Interface Id}
diff --git a/doc/editcap.adoc b/doc/editcap.adoc
index e91dbf2ac4..d36e94193f 100644
--- a/doc/editcap.adoc
+++ b/doc/editcap.adoc
@@ -565,8 +565,9 @@ xref:text2pcap.html[text2pcap](1), xref:reordercap.html[reordercap](1), od(1), x
== NOTES
-*Editcap* is part of the *Wireshark* distribution. The latest version
-of *Wireshark* can be found at https://www.wireshark.org.
+This is the manual page for *Editcap* {wireshark-version}.
+*Editcap* is part of the *Wireshark* distribution.
+The latest version of *Wireshark* can be found at https://www.wireshark.org.
HTML versions of the Wireshark project man pages are available at
https://www.wireshark.org/docs/man-pages.
diff --git a/doc/etwdump.adoc b/doc/etwdump.adoc
index 732af71a66..0cdfe5691e 100644
--- a/doc/etwdump.adoc
+++ b/doc/etwdump.adoc
@@ -112,21 +112,21 @@ To see interfaces:
etwdump --extcap-interfaces
- Example output:
+.Example output
interface {value=etwdump}{display=ETW reader}
To see interface DLTs:
etwdump --extcap-interface=etwdump --extcap-dlts
- Example output:
+.Example output
dlt {number=1}{name=etwdump}{display=DLT_ETW}
To see interface configuration options:
etwdump --extcap-interface=etwdump --extcap-config
- Example output:
+.Example output
arg {number=0}{call=--etlfile}{display=etl file}{type=fileselect}{tooltip=Select etl file to display in Wireshark}{group=Capture}
arg {number=1}{call=--params}{display=filter parmeters}{type=string}{tooltip=Input providers, keyword and level filters for the etl file and live session}{group=Capture}
arg {number=2}{call=--iue}{display=Should undecidable events be included}{type=boolflag}{default=false}{tooltip=Choose if the undecidable event is included}{group=Capture}
diff --git a/doc/mergecap.adoc b/doc/mergecap.adoc
index 8d395b442c..11e88e00b3 100644
--- a/doc/mergecap.adoc
+++ b/doc/mergecap.adoc
@@ -190,8 +190,9 @@ xref:https://www.tcpdump.org/manpages/pcap-filter.7.html[pcap-filter](7) or xref
*Mergecap* is based heavily upon *editcap* by Richard Sharpe
<sharpe[AT]ns.aus.com> and Guy Harris <guy[AT]alum.mit.edu>.
-*Mergecap* is part of the *Wireshark* distribution. The latest version
-of *Wireshark* can be found at https://www.wireshark.org.
+This is the manual page for *Mergecap* {wireshark-version}.
+*Mergecap* is part of the *Wireshark* distribution.
+The latest version of *Wireshark* can be found at https://www.wireshark.org.
HTML versions of the Wireshark project man pages are available at
https://www.wireshark.org/docs/man-pages.
diff --git a/doc/mmdbresolve.adoc b/doc/mmdbresolve.adoc
index dbe0dd32d9..1fdbc03bb7 100644
--- a/doc/mmdbresolve.adoc
+++ b/doc/mmdbresolve.adoc
@@ -41,8 +41,7 @@ To resolve a single address:
echo 4.4.4.4 | mmdbresolve -f /usr/share/GeoIP/GeoLite2-City.mmdb
-Example output:
-
+.Example output
[init]
db.0.path: /usr/share/GeoIP/GeoLite2-City.mmdb
db.0.status: OK
diff --git a/doc/randpktdump.adoc b/doc/randpktdump.adoc
index a0631fe045..c7b80db052 100644
--- a/doc/randpktdump.adoc
+++ b/doc/randpktdump.adoc
@@ -134,21 +134,21 @@ To see interfaces:
randpktdump --extcap-interfaces
- Example output:
+.Example output
interface {value=randpkt}{display=Random packet generator}
To see interface DLTs:
randpktdump --extcap-interface=randpkt --extcap-dlts
- Example output:
+.Example output
dlt {number=1}{name=randpkt}{display=Ethernet}
To see interface configuration options:
randpktdump --extcap-interface=randpkt --extcap-config
- Example output:
+.Example output
arg {number=0}{call=--maxbytes}{display=Max bytes in a packet}{type=unsigned}{range=1,5000}{default=5000}{tooltip=The max number of bytes in a packet}
arg {number=1}{call=--count}{display=Number of packets}{type=long}{default=1000}{tooltip=Number of packets to generate (-1 for infinite)}
arg {number=2}{call=--delay}{display=Packet delay (ms)}{type=long}{default=0}{tooltip=Milliseconds to wait after writing each packet}
diff --git a/doc/rawshark.adoc b/doc/rawshark.adoc
index c6a97bd106..1ac415118e 100644
--- a/doc/rawshark.adoc
+++ b/doc/rawshark.adoc
@@ -476,8 +476,8 @@ transport identifier includes one port number and one transport protocol name
An example is:
-mydns 5045/udp # My own Domain Name Server
-mydns 5045/tcp # My own Domain Name Server
+ mydns 5045/udp # My own Domain Name Server
+ mydns 5045/tcp # My own Domain Name Server
--
Name Resolution (ipxnets)::
@@ -596,8 +596,9 @@ xref:text2pcap.html[text2pcap](1), xref:https://www.tcpdump.org/manpages/pcap-fi
== NOTES
-*Rawshark* is part of the *Wireshark* distribution. The latest version of
-*Wireshark* can be found at https://www.wireshark.org.
+This is the manual page for *Rawshark* {wireshark-version}.
+*Rawshark* is part of the *Wireshark* distribution.
+The latest version of *Wireshark* can be found at https://www.wireshark.org.
HTML versions of the Wireshark project man pages are available at
https://www.wireshark.org/docs/man-pages.
diff --git a/doc/reordercap.adoc b/doc/reordercap.adoc
index b59176dad6..3e865940dc 100644
--- a/doc/reordercap.adoc
+++ b/doc/reordercap.adoc
@@ -61,11 +61,11 @@ xref:text2pcap.html[text2pcap](1), xref:https://www.tcpdump.org/manpages/pcap-fi
== NOTES
-*Reordercap* is part of the *Wireshark* distribution. The latest version
-of *Wireshark* can be found at https://www.wireshark.org.
+This is the manual page for *Reordercap* {wireshark-version}.
+*Reordercap* is part of the *Wireshark* distribution.
+The latest version of *Wireshark* can be found at https://www.wireshark.org.
-It may make sense to move this functionality into *editcap*, or perhaps
-*mergecap*, in which case *reordercap* could be retired.
+It may make sense to move this functionality into *editcap*, or perhaps *mergecap*, in which case *reordercap* could be retired.
HTML versions of the Wireshark project man pages are available at
https://www.wireshark.org/docs/man-pages.
diff --git a/doc/sdjournal.adoc b/doc/sdjournal.adoc
index 772ebe9a4a..99023be6d8 100644
--- a/doc/sdjournal.adoc
+++ b/doc/sdjournal.adoc
@@ -109,22 +109,21 @@ To see interfaces:
Only one interface (sdjournal) is supported.
- Output:
+.Example output
interface {value=sdjournal}{display=systemd journal capture}
To see interface DLTs:
sdjournal --extcap-interface=sdjournal --extcap-dlts
- Output:
+.Example output
dlt {number=147}{name=sdjournal}{display=USER0}
To see interface configuration options:
sdjournal --extcap-interface=sdjournal --extcap-config
- Output:
-
+.Example output
arg {number=0}{call=--start-from}{display=Starting position}{type=string}
{tooltip=The journal starting position. Values with a leading "+" start from the beginning, similar to the "tail" command}
diff --git a/doc/sshdump.adoc b/doc/sshdump.adoc
index 626b9234ac..f72d7a9baa 100644
--- a/doc/sshdump.adoc
+++ b/doc/sshdump.adoc
@@ -216,22 +216,21 @@ To see interfaces:
Only one interface (sshdump) is supported.
- Output:
+.Example output
interface {value=sshdump}{display=SSH remote capture}
To see interface DLTs:
sshdump --extcap-interface=sshdump --extcap-dlts
- Output:
+.Example output
dlt {number=147}{name=sshdump}{display=Remote capture dependent DLT}
To see interface configuration options:
sshdump --extcap-interface=sshdump --extcap-config
- Output:
-
+.Example output
arg {number=0}{call=--remote-host}{display=Remote SSH server address}{type=string}
{tooltip=The remote SSH host. It can be both an IP address or a hostname}{required=true}{group=Server}
arg {number=1}{call=--remote-port}{display=Remote SSH server port}{type=unsigned}
diff --git a/doc/text2pcap.adoc b/doc/text2pcap.adoc
index 9d1c89ed83..f327b93f13 100644
--- a/doc/text2pcap.adoc
+++ b/doc/text2pcap.adoc
@@ -304,9 +304,12 @@ xref:editcap.html[editcap](1), strptime(3), xref:https://www.tcpdump.org/manpage
== NOTES
-*Text2pcap* is part of the *Wireshark* distribution. The latest version
-of *Wireshark* can be found at https://www.wireshark.org.
+This is the manual page for *Text2pcap* {wireshark-version}.
+*Text2pcap* is part of the *Wireshark* distribution.
+The latest version of *Wireshark* can be found at https://www.wireshark.org.
== AUTHORS
- Ashok Narayanan <ashokn[AT]cisco.com>
+.Original Author
+[%hardbreaks]
+Ashok Narayanan <ashokn[AT]cisco.com>
diff --git a/doc/udpdump.adoc b/doc/udpdump.adoc
index 81bb658841..30ea81b44f 100644
--- a/doc/udpdump.adoc
+++ b/doc/udpdump.adoc
@@ -109,21 +109,21 @@ To see interfaces:
udpdump --extcap-interfaces
- Example output:
+.Example output
interface {value=udpdump}{display=UDP Listener remote capture}
To see interface DLTs:
udpdump --extcap-interface=udpdump --extcap-dlts
- Example output:
+.Example output
dlt {number=252}{name=udpdump}{display=Exported PDUs}
To see interface configuration options:
udpdump --extcap-interface=udpdump --extcap-config
- Example output:
+.Example output
arg {number=0}{call=--port}{display=Listen port}{type=unsigned}{range=1,65535}{default=5555}{tooltip=The port the receiver listens on}
To capture: