aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorOdysseus Yang <wiresharkyyh@outlook.com>2020-12-02 09:05:11 +0000
committerAndersBroman <a.broman58@gmail.com>2020-12-02 09:05:11 +0000
commit2a5b34d8b02b1663237490eec5dfd8652a9bdb51 (patch)
tree5acf1640ab708e32a172a00763145e41e19c5089 /doc
parentfe1f9475409f252b6ca2dccc71187868e168c74b (diff)
MBIM: Update dissector to support DLT_ETW
New link type DLT_ETW is added for write and read Event Trace on Windows. This change updates MBIM dissector to decode a MBIM message from a DLT_ETW packet.
Diffstat (limited to 'doc')
-rw-r--r--doc/CMakeLists.txt3
-rw-r--r--doc/etwdump.pod130
2 files changed, 133 insertions, 0 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 129adeaf62..5dd284936c 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -65,6 +65,7 @@ pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/editcap 1)
pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/mergecap 1)
pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/randpkt 1)
pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/randpktdump 1)
+pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/etwdump 1)
pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/rawshark 1)
pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/reordercap 1)
pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/sshdump 1)
@@ -107,6 +108,7 @@ set(MAN1_INSTALL_FILES
${CMAKE_CURRENT_BINARY_DIR}/mergecap.1
${CMAKE_CURRENT_BINARY_DIR}/randpkt.1
${CMAKE_CURRENT_BINARY_DIR}/randpktdump.1
+ ${CMAKE_CURRENT_BINARY_DIR}/etwdump.1
${CMAKE_CURRENT_BINARY_DIR}/rawshark.1
${CMAKE_CURRENT_BINARY_DIR}/reordercap.1
${CMAKE_CURRENT_BINARY_DIR}/sshdump.1
@@ -164,6 +166,7 @@ set(HTML_INSTALL_FILES
${CMAKE_CURRENT_BINARY_DIR}/mergecap.html
${CMAKE_CURRENT_BINARY_DIR}/randpkt.html
${CMAKE_CURRENT_BINARY_DIR}/randpktdump.html
+ ${CMAKE_CURRENT_BINARY_DIR}/etwdump.html
${CMAKE_CURRENT_BINARY_DIR}/rawshark.html
${CMAKE_CURRENT_BINARY_DIR}/reordercap.html
${CMAKE_CURRENT_BINARY_DIR}/sshdump.html
diff --git a/doc/etwdump.pod b/doc/etwdump.pod
new file mode 100644
index 0000000000..07ebdd85fc
--- /dev/null
+++ b/doc/etwdump.pod
@@ -0,0 +1,130 @@
+=begin man
+
+=encoding utf8
+
+=end man
+
+=head1 NAME
+
+etwdump - Provide an interface to read ETW
+
+=head1 SYNOPSIS
+
+B<etwdump>
+S<[ B<--help> ]>
+S<[ B<--version> ]>
+S<[ B<--extcap-interfaces> ]>
+S<[ B<--extcap-dlts> ]>
+S<[ B<--extcap-interface>=E<lt>interfaceE<gt> ]>
+S<[ B<--extcap-config> ]>
+S<[ B<--capture> ]>
+S<[ B<--fifo>=E<lt>path to file or pipeE<gt> ]>
+S<[ B<--iue>=E<lt>Should undecidable events be includedE<gt> ]>
+S<[ B<--etlfile>=E<lt>etl fileE<gt> ]>
+
+=head1 DESCRIPTION
+
+B<etwdump> is a extcap tool that provides access to a etl file.
+It is only used to display event trace on Windows.
+
+=head1 OPTIONS
+
+=over 4
+
+=item --help
+
+Print program arguments.
+
+=item --version
+
+Print program version.
+
+=item --extcap-interfaces
+
+List available interfaces.
+
+=item --extcap-interface=E<lt>interfaceE<gt>
+
+Use specified interfaces.
+
+=item --extcap-dlts
+
+List DLTs of specified interface.
+
+=item --extcap-config
+
+List configuration options of specified interface.
+
+=item --capture
+
+Start capturing from specified interface save saved it in place specified by --fifo.
+
+=item --fifo=E<lt>path to file or pipeE<gt>
+
+Save captured packet to file or send it through pipe.
+
+=item --iue=E<lt>Should undecidable events be includedE<gt>
+
+Choose if the undecidable event is included.
+
+=item --etlfile=E<lt>Etl fileE<gt>
+
+Select etl file to display in Wireshark.
+
+=back
+
+=head1 EXAMPLES
+
+To see program arguments:
+
+ etwdump --help
+
+To see program version:
+
+ etwdump --version
+
+To see interfaces:
+
+ etwdump --extcap-interfaces
+
+ Example output:
+ interface {value=etwdump}{display=ETW reader}
+
+To see interface DLTs:
+
+ etwdump --extcap-interface=etwdump --extcap-dlts
+
+ Example output:
+ dlt {number=1}{name=etwdump}{display=DLT_ETW}
+
+To see interface configuration options:
+
+ etwdump --extcap-interface=etwdump --extcap-config
+
+ Example output:
+ arg {number=0}{call=--iue}{display=Should undecidable events be included}{type=boolflag}{default=false}{tooltip=Choose if the undecidable event is included}{group=Capture}
+ arg {number=1}{call=--etlfile}{display=etl file}{type=fileselect}{tooltip=Select etl file to display in Wireshark}{required=true}{group=Capture}
+
+To capture:
+
+ etwdump --extcap-interface=etwdump --fifo=/tmp/etw.pcapng --capture
+
+NOTE: To stop capturing CTRL+C/kill/terminate application.
+
+=head1 SEE ALSO
+
+wireshark(1), tshark(1), dumpcap(1), extcap(4)
+
+=head1 NOTES
+
+B<etwdump> is part of the B<Wireshark> distribution. The latest version
+of B<Wireshark> can be found at L<https://www.wireshark.org>.
+
+HTML versions of the Wireshark project man pages are available at:
+L<https://www.wireshark.org/docs/man-pages>.
+
+=head1 AUTHORS
+
+ Original Author
+ ---------------
+ Odysseus Yang L<wiresharkyyh@outlook.com>