forked from osmocom/wireshark
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.
This commit is contained in:
Gerald Combs
Wireshark GitLab Utility
parent
ce22d958a8
commit
cfc3212ae2
|
|
@ -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}
|
||||
.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").
|
||||
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"
|
||||
For example:
|
||||
"Android Logcat Main unknown MSM7627A"
|
||||
|
||||
"Android Logcat Main" - user-friendly type of interface
|
||||
"unknown" - name of Android Device
|
||||
"MSM7627A" - device ID
|
||||
"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}
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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}
|
||||
|
|
|
|||
|
|
@ -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}
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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}
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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}
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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}
|
||||
|
||||
|
|
|
|||
|
|
@ -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}
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
Loading…
Reference in New Issue