randpktdump.html 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  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>randpktdump(1)</title>
  9. <link rel="stylesheet" href="./ws.css">
  10. </head>
  11. <body class="manpage">
  12. <div id="header">
  13. <h1>randpktdump(1) Manual Page</h1>
  14. <h2 id="_name">NAME</h2>
  15. <div class="sectionbody">
  16. <p>randpktdump - Provide an interface to generate random captures using randpkt</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>randpktdump</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>--maxbytes</strong>=&lt;bytes&gt; ]</span>
  34. <span class="nowrap">[ <strong>--count</strong>=&lt;num&gt; ]</span>
  35. <span class="nowrap">[ <strong>--delay</strong>=&lt;ms&gt; ]</span>
  36. <span class="nowrap">[ <strong>--random-type</strong>=&lt;true|false&gt; ]</span>
  37. <span class="nowrap">[ <strong>--all-random</strong>=&lt;true|false&gt; ]</span>
  38. <span class="nowrap">[ <strong>--type</strong>=&lt;packet type&gt; ]</span></p>
  39. </div>
  40. </div>
  41. </div>
  42. <div class="sect1">
  43. <h2 id="_description">DESCRIPTION</h2>
  44. <div class="sectionbody">
  45. <div class="paragraph">
  46. <p><strong>randpktdump</strong> is a extcap tool that provides access to the random
  47. packet generator (randpkt). It is mainly used for testing and
  48. educational purpose.</p>
  49. </div>
  50. </div>
  51. </div>
  52. <div class="sect1">
  53. <h2 id="_options">OPTIONS</h2>
  54. <div class="sectionbody">
  55. <div class="dlist">
  56. <dl>
  57. <dt class="hdlist1">--help</dt>
  58. <dd>
  59. <div class="openblock">
  60. <div class="content">
  61. <div class="paragraph">
  62. <p>Print program arguments.</p>
  63. </div>
  64. </div>
  65. </div>
  66. </dd>
  67. <dt class="hdlist1">--version</dt>
  68. <dd>
  69. <div class="openblock">
  70. <div class="content">
  71. <div class="paragraph">
  72. <p>Print program version.</p>
  73. </div>
  74. </div>
  75. </div>
  76. </dd>
  77. <dt class="hdlist1">--extcap-interfaces</dt>
  78. <dd>
  79. <div class="openblock">
  80. <div class="content">
  81. <div class="paragraph">
  82. <p>List available interfaces.</p>
  83. </div>
  84. </div>
  85. </div>
  86. </dd>
  87. <dt class="hdlist1">--extcap-interface=&lt;interface&gt;</dt>
  88. <dd>
  89. <div class="openblock">
  90. <div class="content">
  91. <div class="paragraph">
  92. <p>Use specified interfaces.</p>
  93. </div>
  94. </div>
  95. </div>
  96. </dd>
  97. <dt class="hdlist1">--extcap-dlts</dt>
  98. <dd>
  99. <div class="openblock">
  100. <div class="content">
  101. <div class="paragraph">
  102. <p>List DLTs of specified interface.</p>
  103. </div>
  104. </div>
  105. </div>
  106. </dd>
  107. <dt class="hdlist1">--extcap-config</dt>
  108. <dd>
  109. <div class="openblock">
  110. <div class="content">
  111. <div class="paragraph">
  112. <p>List configuration options of specified interface.</p>
  113. </div>
  114. </div>
  115. </div>
  116. </dd>
  117. <dt class="hdlist1">--capture</dt>
  118. <dd>
  119. <div class="openblock">
  120. <div class="content">
  121. <div class="paragraph">
  122. <p>Start capturing from specified interface save saved it in place specified by --fifo.</p>
  123. </div>
  124. </div>
  125. </div>
  126. </dd>
  127. <dt class="hdlist1">--fifo=&lt;path to file or pipe&gt;</dt>
  128. <dd>
  129. <div class="openblock">
  130. <div class="content">
  131. <div class="paragraph">
  132. <p>Save captured packet to file or send it through pipe.</p>
  133. </div>
  134. </div>
  135. </div>
  136. </dd>
  137. <dt class="hdlist1">--maxbytes=&lt;bytes&gt;</dt>
  138. <dd>
  139. <div class="openblock">
  140. <div class="content">
  141. <div class="paragraph">
  142. <p>Set the max number of bytes per packet.</p>
  143. </div>
  144. </div>
  145. </div>
  146. </dd>
  147. <dt class="hdlist1">--count=&lt;num&gt;</dt>
  148. <dd>
  149. <div class="openblock">
  150. <div class="content">
  151. <div class="paragraph">
  152. <p>Number of packets to generate (-1 for infinite).</p>
  153. </div>
  154. </div>
  155. </div>
  156. </dd>
  157. <dt class="hdlist1">--delay=&lt;ms&gt;</dt>
  158. <dd>
  159. <div class="openblock">
  160. <div class="content">
  161. <div class="paragraph">
  162. <p>Wait a number of milliseconds after writing each packet.</p>
  163. </div>
  164. </div>
  165. </div>
  166. </dd>
  167. <dt class="hdlist1">--random-type</dt>
  168. <dd>
  169. <div class="openblock">
  170. <div class="content">
  171. <div class="paragraph">
  172. <p>Choose a random packet type for all packets if set to true.</p>
  173. </div>
  174. </div>
  175. </div>
  176. </dd>
  177. <dt class="hdlist1">--all-random</dt>
  178. <dd>
  179. <div class="openblock">
  180. <div class="content">
  181. <div class="paragraph">
  182. <p>Choose a different random packet type for each packet if set to true.</p>
  183. </div>
  184. </div>
  185. </div>
  186. </dd>
  187. <dt class="hdlist1">--type=&lt;packet type&gt;</dt>
  188. <dd>
  189. <div class="openblock">
  190. <div class="content">
  191. <div class="paragraph">
  192. <p>Use the selected packet type. To list all the available packet type, run randpktdump --help.</p>
  193. </div>
  194. </div>
  195. </div>
  196. </dd>
  197. </dl>
  198. </div>
  199. </div>
  200. </div>
  201. <div class="sect1">
  202. <h2 id="_examples">EXAMPLES</h2>
  203. <div class="sectionbody">
  204. <div class="paragraph">
  205. <p>To see program arguments:</p>
  206. </div>
  207. <div class="literalblock">
  208. <div class="content">
  209. <pre>randpktdump --help</pre>
  210. </div>
  211. </div>
  212. <div class="paragraph">
  213. <p>To see program version:</p>
  214. </div>
  215. <div class="literalblock">
  216. <div class="content">
  217. <pre>randpktdump --version</pre>
  218. </div>
  219. </div>
  220. <div class="paragraph">
  221. <p>To see interfaces:</p>
  222. </div>
  223. <div class="literalblock">
  224. <div class="content">
  225. <pre>randpktdump --extcap-interfaces</pre>
  226. </div>
  227. </div>
  228. <div class="literalblock">
  229. <div class="title">Example output</div>
  230. <div class="content">
  231. <pre>interface {value=randpkt}{display=Random packet generator}</pre>
  232. </div>
  233. </div>
  234. <div class="paragraph">
  235. <p>To see interface DLTs:</p>
  236. </div>
  237. <div class="literalblock">
  238. <div class="content">
  239. <pre>randpktdump --extcap-interface=randpkt --extcap-dlts</pre>
  240. </div>
  241. </div>
  242. <div class="literalblock">
  243. <div class="title">Example output</div>
  244. <div class="content">
  245. <pre>dlt {number=1}{name=randpkt}{display=Ethernet}</pre>
  246. </div>
  247. </div>
  248. <div class="paragraph">
  249. <p>To see interface configuration options:</p>
  250. </div>
  251. <div class="literalblock">
  252. <div class="content">
  253. <pre>randpktdump --extcap-interface=randpkt --extcap-config</pre>
  254. </div>
  255. </div>
  256. <div class="literalblock">
  257. <div class="title">Example output</div>
  258. <div class="content">
  259. <pre>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}
  260. arg {number=1}{call=--count}{display=Number of packets}{type=long}{default=1000}{tooltip=Number of packets to generate (-1 for infinite)}
  261. arg {number=2}{call=--delay}{display=Packet delay (ms)}{type=long}{default=0}{tooltip=Milliseconds to wait after writing each packet}
  262. arg {number=3}{call=--random-type}{display=Random type}{type=boolflag}{default=false}{tooltip=The packets type is randomly chosen}
  263. arg {number=4}{call=--all-random}{display=All random packets}{type=boolflag}{default=false}{tooltip=Packet type for each packet is randomly chosen}
  264. arg {number=5}{call=--type}{display=Type of packet}{type=selector}{tooltip=Type of packet to generate}
  265. value {arg=5}{value=arp}{display=Address Resolution Protocol}
  266. [...]
  267. value {arg=5}{value=usb-linux}{display=Universal Serial Bus with Linux specific header}</pre>
  268. </div>
  269. </div>
  270. <div class="paragraph">
  271. <p>To capture:</p>
  272. </div>
  273. <div class="literalblock">
  274. <div class="content">
  275. <pre>randpktdump --extcap-interface=randpkt --fifo=/tmp/randpkt.pcapng --capture</pre>
  276. </div>
  277. </div>
  278. <div class="admonitionblock note">
  279. <table>
  280. <tr>
  281. <td class="icon">
  282. <div class="title">Note</div>
  283. </td>
  284. <td class="content">
  285. To stop capturing CTRL+C/kill/terminate the application.
  286. </td>
  287. </tr>
  288. </table>
  289. </div>
  290. </div>
  291. </div>
  292. <div class="sect1">
  293. <h2 id="_see_also">SEE ALSO</h2>
  294. <div class="sectionbody">
  295. <div class="paragraph">
  296. <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), <a href="randpkt.html">randpkt</a>(1)</p>
  297. </div>
  298. </div>
  299. </div>
  300. <div class="sect1">
  301. <h2 id="_notes">NOTES</h2>
  302. <div class="sectionbody">
  303. <div class="paragraph">
  304. <p><strong>randpktdump</strong> is part of the <strong>Wireshark</strong> distribution. The latest version
  305. of <strong>Wireshark</strong> can be found at <a href="https://www.wireshark.org" class="bare">https://www.wireshark.org</a>.</p>
  306. </div>
  307. <div class="paragraph">
  308. <p>HTML versions of the Wireshark project man pages are available at
  309. <a href="https://www.wireshark.org/docs/man-pages" class="bare">https://www.wireshark.org/docs/man-pages</a>.</p>
  310. </div>
  311. </div>
  312. </div>
  313. <div class="sect1">
  314. <h2 id="_authors">AUTHORS</h2>
  315. <div class="sectionbody">
  316. <div class="paragraph">
  317. <div class="title">Original Author</div>
  318. <p>Dario Lombardo &lt;lomato[AT]gmail.com&gt;</p>
  319. </div>
  320. </div>
  321. </div>
  322. </div>
  323. </body>
  324. </html>