etwdump.html 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <meta name="generator" content="Asciidoctor 2.0.17">
  8. <title>etwdump(1)</title>
  9. <link rel="stylesheet" href="./ws.css">
  10. </head>
  11. <body class="manpage">
  12. <div id="header">
  13. <h1>etwdump(1) Manual Page</h1>
  14. <h2 id="_name">NAME</h2>
  15. <div class="sectionbody">
  16. <p>etwdump - Provide an interface to read Event Tracing for Windows (ETW)</p>
  17. </div>
  18. </div>
  19. <div id="content">
  20. <div class="sect1">
  21. <h2 id="_synopsis">SYNOPSIS</h2>
  22. <div class="sectionbody">
  23. <div class="paragraph">
  24. <p><span class="nowrap"><strong>etwdump</strong></span>
  25. <span class="nowrap">[ <strong>--help</strong> ]</span>
  26. <span class="nowrap">[ <strong>--version</strong> ]</span>
  27. <span class="nowrap">[ <strong>--extcap-interfaces</strong> ]</span>
  28. <span class="nowrap">[ <strong>--extcap-dlts</strong> ]</span>
  29. <span class="nowrap">[ <strong>--extcap-interface</strong>=&lt;interface&gt; ]</span>
  30. <span class="nowrap">[ <strong>--extcap-config</strong> ]</span>
  31. <span class="nowrap">[ <strong>--capture</strong> ]</span>
  32. <span class="nowrap">[ <strong>--fifo</strong>=&lt;path to file or pipe&gt; ]</span>
  33. <span class="nowrap">[ <strong>--iue</strong>=&lt;Should undecidable events be included&gt; ]</span>
  34. <span class="nowrap">[ <strong>--etlfile</strong>=&lt;etl file&gt; ]</span>
  35. <span class="nowrap">[ <strong>--params</strong>=&lt;filter parameters&gt; ]</span></p>
  36. </div>
  37. </div>
  38. </div>
  39. <div class="sect1">
  40. <h2 id="_description">DESCRIPTION</h2>
  41. <div class="sectionbody">
  42. <div class="paragraph">
  43. <p><strong>etwdump</strong> is a extcap tool that provides access to a event trace log file or an event trace live session.
  44. It is only used to display event trace on Windows that includes readable text message and different protocols (like MBIM and IP packets).</p>
  45. </div>
  46. </div>
  47. </div>
  48. <div class="sect1">
  49. <h2 id="_options">OPTIONS</h2>
  50. <div class="sectionbody">
  51. <div class="dlist">
  52. <dl>
  53. <dt class="hdlist1">--help</dt>
  54. <dd>
  55. <div class="openblock">
  56. <div class="content">
  57. <div class="paragraph">
  58. <p>Print program arguments.</p>
  59. </div>
  60. </div>
  61. </div>
  62. </dd>
  63. <dt class="hdlist1">--version</dt>
  64. <dd>
  65. <div class="openblock">
  66. <div class="content">
  67. <div class="paragraph">
  68. <p>Print program version.</p>
  69. </div>
  70. </div>
  71. </div>
  72. </dd>
  73. <dt class="hdlist1">--extcap-interfaces</dt>
  74. <dd>
  75. <div class="openblock">
  76. <div class="content">
  77. <div class="paragraph">
  78. <p>List available interfaces.</p>
  79. </div>
  80. </div>
  81. </div>
  82. </dd>
  83. <dt class="hdlist1">--extcap-interface=&lt;interface&gt;</dt>
  84. <dd>
  85. <div class="openblock">
  86. <div class="content">
  87. <div class="paragraph">
  88. <p>Use specified interfaces.</p>
  89. </div>
  90. </div>
  91. </div>
  92. </dd>
  93. <dt class="hdlist1">--extcap-dlts</dt>
  94. <dd>
  95. <div class="openblock">
  96. <div class="content">
  97. <div class="paragraph">
  98. <p>List DLTs of specified interface.</p>
  99. </div>
  100. </div>
  101. </div>
  102. </dd>
  103. <dt class="hdlist1">--extcap-config</dt>
  104. <dd>
  105. <div class="openblock">
  106. <div class="content">
  107. <div class="paragraph">
  108. <p>List configuration options of specified interface.</p>
  109. </div>
  110. </div>
  111. </div>
  112. </dd>
  113. <dt class="hdlist1">--capture</dt>
  114. <dd>
  115. <div class="openblock">
  116. <div class="content">
  117. <div class="paragraph">
  118. <p>Start capturing from specified interface save saved it in place specified by --fifo.</p>
  119. </div>
  120. </div>
  121. </div>
  122. </dd>
  123. <dt class="hdlist1">--fifo=&lt;path to file or pipe&gt;</dt>
  124. <dd>
  125. <div class="openblock">
  126. <div class="content">
  127. <div class="paragraph">
  128. <p>Save captured packet to file or send it through pipe.</p>
  129. </div>
  130. </div>
  131. </div>
  132. </dd>
  133. <dt class="hdlist1">--iue=&lt;Should undecidable events be included&gt;</dt>
  134. <dd>
  135. <div class="openblock">
  136. <div class="content">
  137. <div class="paragraph">
  138. <p>Choose if the undecidable event is included.</p>
  139. </div>
  140. </div>
  141. </div>
  142. </dd>
  143. <dt class="hdlist1">--etlfile=&lt;Etl file&gt;</dt>
  144. <dd>
  145. <div class="openblock">
  146. <div class="content">
  147. <div class="paragraph">
  148. <p>Select etl file to display in Wireshark.</p>
  149. </div>
  150. </div>
  151. </div>
  152. </dd>
  153. <dt class="hdlist1">--params=&lt;filter parameters&gt;</dt>
  154. <dd>
  155. <div class="openblock">
  156. <div class="content">
  157. <div class="paragraph">
  158. <p>Input providers, keyword and level filters for the etl file and live session.</p>
  159. </div>
  160. </div>
  161. </div>
  162. </dd>
  163. </dl>
  164. </div>
  165. </div>
  166. </div>
  167. <div class="sect1">
  168. <h2 id="_examples">EXAMPLES</h2>
  169. <div class="sectionbody">
  170. <div class="paragraph">
  171. <p>To see program arguments:</p>
  172. </div>
  173. <div class="literalblock">
  174. <div class="content">
  175. <pre>etwdump --help</pre>
  176. </div>
  177. </div>
  178. <div class="paragraph">
  179. <p>To see program version:</p>
  180. </div>
  181. <div class="literalblock">
  182. <div class="content">
  183. <pre>etwdump --version</pre>
  184. </div>
  185. </div>
  186. <div class="paragraph">
  187. <p>To see interfaces:</p>
  188. </div>
  189. <div class="literalblock">
  190. <div class="content">
  191. <pre>etwdump --extcap-interfaces</pre>
  192. </div>
  193. </div>
  194. <div class="literalblock">
  195. <div class="title">Example output</div>
  196. <div class="content">
  197. <pre>interface {value=etwdump}{display=ETW reader}</pre>
  198. </div>
  199. </div>
  200. <div class="paragraph">
  201. <p>To see interface DLTs:</p>
  202. </div>
  203. <div class="literalblock">
  204. <div class="content">
  205. <pre>etwdump --extcap-interface=etwdump --extcap-dlts</pre>
  206. </div>
  207. </div>
  208. <div class="literalblock">
  209. <div class="title">Example output</div>
  210. <div class="content">
  211. <pre>dlt {number=1}{name=etwdump}{display=DLT_ETW}</pre>
  212. </div>
  213. </div>
  214. <div class="paragraph">
  215. <p>To see interface configuration options:</p>
  216. </div>
  217. <div class="literalblock">
  218. <div class="content">
  219. <pre>etwdump --extcap-interface=etwdump --extcap-config</pre>
  220. </div>
  221. </div>
  222. <div class="literalblock">
  223. <div class="title">Example output</div>
  224. <div class="content">
  225. <pre>arg {number=0}{call=--etlfile}{display=etl file}{type=fileselect}{tooltip=Select etl file to display in Wireshark}{group=Capture}
  226. 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}
  227. 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}</pre>
  228. </div>
  229. </div>
  230. <div class="paragraph">
  231. <p>To capture:</p>
  232. </div>
  233. <div class="literalblock">
  234. <div class="content">
  235. <pre>etwdump --extcap-interface etwdump --fifo=/tmp/etw.pcapng --capture --params "--p=Microsoft-Windows-Wmbclass-Opn --p=Microsoft-Windows-wmbclass --k=0xff --l=4"
  236. etwdump --extcap-interface etwdump --fifo=/tmp/etw.pcapng --capture --params "--p=Microsoft-Windows-Wmbclass-Opn --p=Microsoft-Windows-NDIS-PacketCapture"</pre>
  237. </div>
  238. </div>
  239. <div class="admonitionblock note">
  240. <table>
  241. <tr>
  242. <td class="icon">
  243. <div class="title">Note</div>
  244. </td>
  245. <td class="content">
  246. To stop capturing CTRL+C/kill/terminate the application.
  247. </td>
  248. </tr>
  249. </table>
  250. </div>
  251. </div>
  252. </div>
  253. <div class="sect1">
  254. <h2 id="_see_also">SEE ALSO</h2>
  255. <div class="sectionbody">
  256. <div class="paragraph">
  257. <p><a href="wireshark.html">wireshark</a>(1), <a href="tshark.html">tshark</a>(1), <a href="dumpcap.html">dumpcap</a>(1), <a href="extcap.html">extcap</a>(4)</p>
  258. </div>
  259. </div>
  260. </div>
  261. <div class="sect1">
  262. <h2 id="_notes">NOTES</h2>
  263. <div class="sectionbody">
  264. <div class="paragraph">
  265. <p><strong>etwdump</strong> is part of the <strong>Wireshark</strong> distribution. The latest version
  266. of <strong>Wireshark</strong> can be found at <a href="https://www.wireshark.org" class="bare">https://www.wireshark.org</a>.</p>
  267. </div>
  268. <div class="paragraph">
  269. <p>HTML versions of the Wireshark project man pages are available at
  270. <a href="https://www.wireshark.org/docs/man-pages" class="bare">https://www.wireshark.org/docs/man-pages</a>.</p>
  271. </div>
  272. </div>
  273. </div>
  274. <div class="sect1">
  275. <h2 id="_authors">AUTHORS</h2>
  276. <div class="sectionbody">
  277. <div class="paragraph">
  278. <div class="title">Original Author</div>
  279. <p>Odysseus Yang &lt;<a href="mailto:wiresharkyyh@outlook.com">wiresharkyyh@outlook.com</a>&gt;</p>
  280. </div>
  281. </div>
  282. </div>
  283. </div>
  284. </body>
  285. </html>