doc/man_pages/randpktdump.adoc

   1 include::../attributes.adoc[]
   2 = randpktdump(1)
   3 :doctype: manpage
   4 :stylesheet: ws.css
   5 :linkcss:
   6 :copycss: {css_dir}/{stylesheet}
   7
   8 == NAME
   9
  10 randpktdump - Provide an interface to generate random captures using randpkt
  11
  12 == SYNOPSIS
  13
  14 [manarg]
  15 *randpktdump*
  16 [ *--help* ]
  17 [ *--version* ]
  18 [ *--extcap-interfaces* ]
  19 [ *--extcap-dlts* ]
  20 [ *--extcap-interface*=<interface> ]
  21 [ *--extcap-config* ]
  22 [ *--capture* ]
  23 [ *--fifo*=<path to file or pipe> ]
  24 [ *--maxbytes*=<bytes> ]
  25 [ *--count*=<num> ]
  26 [ *--delay*=<ms> ]
  27 [ *--random-type*=<true|false> ]
  28 [ *--all-random*=<true|false> ]
  29 [ *--type*=<packet type> ]
  30
  31 == DESCRIPTION
  32
  33 *randpktdump* is a extcap tool that provides access to the random
  34 packet generator (randpkt). It is mainly used for testing and
  35 educational purpose.
  36
  37 == OPTIONS
  38
  39 --help::
  40 Print program arguments.
  41
  42 --version::
  43 Print program version.
  44
  45 --extcap-interfaces::
  46 List available interfaces.
  47
  48 --extcap-interface=<interface>::
  49 Use specified interfaces.
  50
  51 --extcap-dlts::
  52 List DLTs of specified interface.
  53
  54 --extcap-config::
  55 List configuration options of specified interface.
  56
  57 --capture::
  58 Start capturing from specified interface save saved it in place specified by --fifo.
  59
  60 --fifo=<path to file or pipe>::
  61 Save captured packet to file or send it through pipe.
  62
  63 --maxbytes=<bytes>::
  64 Set the max number of bytes per packet.
  65
  66 --count=<num>::
  67 Number of packets to generate (-1 for infinite).
  68
  69 --delay=<ms>::
  70 Wait a number of milliseconds after writing each packet.
  71
  72 --random-type::
  73 Choose a random packet type for all packets if set to true.
  74
  75 --all-random::
  76 Choose a different random packet type for each packet if set to true.
  77
  78 --type=<packet type>::
  79 Use the selected packet type. To list all the available packet type, run randpktdump --help.
  80
  81 == EXAMPLES
  82
  83 To see program arguments:
  84
  85     randpktdump --help
  86
  87 To see program version:
  88
  89     randpktdump --version
  90
  91 To see interfaces:
  92
  93     randpktdump --extcap-interfaces
  94
  95 .Example output
  96     interface {value=randpkt}{display=Random packet generator}
  97
  98 To see interface DLTs:
  99
 100     randpktdump --extcap-interface=randpkt --extcap-dlts
 101
 102 .Example output
 103     dlt {number=1}{name=randpkt}{display=Ethernet}
 104
 105 To see interface configuration options:
 106
 107     randpktdump --extcap-interface=randpkt --extcap-config
 108
 109 .Example output
 110     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}
 111     arg {number=1}{call=--count}{display=Number of packets}{type=long}{default=1000}{tooltip=Number of packets to generate (-1 for infinite)}
 112     arg {number=2}{call=--delay}{display=Packet delay (ms)}{type=long}{default=0}{tooltip=Milliseconds to wait after writing each packet}
 113     arg {number=3}{call=--random-type}{display=Random type}{type=boolflag}{default=false}{tooltip=The packets type is randomly chosen}
 114     arg {number=4}{call=--all-random}{display=All random packets}{type=boolflag}{default=false}{tooltip=Packet type for each packet is randomly chosen}
 115     arg {number=5}{call=--type}{display=Type of packet}{type=selector}{tooltip=Type of packet to generate}
 116     value {arg=5}{value=arp}{display=Address Resolution Protocol}
 117     [...]
 118     value {arg=5}{value=usb-linux}{display=Universal Serial Bus with Linux specific header}
 119
 120 To capture:
 121
 122     randpktdump --extcap-interface=randpkt --fifo=/tmp/randpkt.pcapng --capture
 123
 124 NOTE: To stop capturing CTRL+C/kill/terminate the application.
 125
 126 == SEE ALSO
 127
 128 xref:wireshark.html[wireshark](1), xref:tshark.html[tshark](1), xref:dumpcap.html[dumpcap](1), xref:extcap.html[extcap](4), xref:randpkt.html[randpkt](1)
 129
 130 == NOTES
 131
 132 *randpktdump* is part of the *Wireshark* distribution.  The latest version
 133 of *Wireshark* can be found at https://www.wireshark.org.
 134
 135 HTML versions of the Wireshark project man pages are available at
 136 https://www.wireshark.org/docs/man-pages.
 137
 138 == AUTHORS
 139
 140 .Original Author
 141 [%hardbreaks]
 142 Dario Lombardo <lomato[AT]gmail.com>