/usr/share/wireshark/dumpcap.html is in libwireshark-data 1.6.7-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 | <?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>dumpcap - The Wireshark Network Analyzer 1.6.7</title>
<link rel="stylesheet" href="../docbook/ws.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body>
<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>
<!--
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#options">OPTIONS</a></li>
<li><a href="#capture_filter_syntax">CAPTURE FILTER SYNTAX</a></li>
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#notes">NOTES</a></li>
<li><a href="#authors">AUTHORS</a></li>
</ul>
-->
</div>
<!-- INDEX END -->
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>dumpcap - Dump network traffic</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<p><strong>dumpcap</strong>
[ <strong>-a</strong> <capture autostop condition> ] ...
[ <strong>-b</strong> <capture ring buffer option>] ...
[ <strong>-B</strong> <capture buffer size> ]
[ <strong>-c</strong> <capture packet count> ]
[ <strong>-d</strong> ]
[ <strong>-D</strong> ]
[ <strong>-f</strong> <capture filter> ]
[ <strong>-h</strong> ]
[ <strong>-i</strong> <capture interface>|- ]
[ <strong>-I</strong> ]
[ <strong>-L</strong> ]
[ <strong>-n</strong> ]
[ <strong>-M</strong> ]
[ <strong>-p</strong> ]
[ <strong>-q</strong> ]
[ <strong>-s</strong> <capture snaplen> ]
[ <strong>-S</strong> ]
[ <strong>-v</strong> ]
[ <strong>-w</strong> <outfile> ]
[ <strong>-y</strong> <capture link type> ]</p>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p><strong>Dumpcap</strong> is a network traffic dump tool. It lets you capture packet
data from a live network and write the packets to a file. <strong>Dumpcap</strong>'s
native capture file format is <strong>libpcap</strong> format, which is also the format
used by <strong>Wireshark</strong>, <strong>tcpdump</strong> and various other tools.
When the <strong>-n</strong> option is specified, the output file is written in the
new <strong>pcapng</strong> format.</p>
<p>Without any options set it will
use the pcap library to capture traffic from the first available network
interface and writes the received raw packet data, along with the packets'
time stamps into a libpcap file.</p>
<p>If the <strong>-w</strong> option is not specified, <strong>Dumpcap</strong> writes to a newly
created libpcap file with a randomly chosen name.
If the <strong>-w</strong> option is specified, <strong>Dumpcap</strong> writes to the file
specified by that option.</p>
<p>Packet capturing is performed with the pcap library. The capture filter
syntax follows the rules of the pcap library.</p>
<p>
</p>
<hr />
<h1><a name="options">OPTIONS</a></h1>
<dl>
<dt><strong><a name="a_capture_autostop_condition" class="item">-a <capture autostop condition></a></strong></dt>
<dd>
<p>Specify a criterion that specifies when <strong>Dumpcap</strong> is to stop writing
to a capture file. The criterion is of the form <em>test</em><strong>:</strong><em>value</em>,
where <em>test</em> is one of:</p>
<p><strong>duration</strong>:<em>value</em> Stop writing to a capture file after <em>value</em> seconds have
elapsed.</p>
<p><strong>filesize</strong>:<em>value</em> Stop writing to a capture file after it reaches a size of
<em>value</em> kilobytes (where a kilobyte is 1024 bytes). If this option is used
together with the -b option, dumpcap will stop writing to the current capture
file and switch to the next one if filesize is reached.</p>
<p><strong>files</strong>:<em>value</em> Stop writing to capture files after <em>value</em> number of files
were written.</p>
</dd>
<dt><strong><a name="b_capture_ring_buffer_option" class="item">-b <capture ring buffer option></a></strong></dt>
<dd>
<p>Cause <strong>Dumpcap</strong> to run in "multiple files" mode. In "multiple files" mode,
<strong>Dumpcap</strong> will write to several capture files. When the first capture file
fills up, <strong>Dumpcap</strong> will switch writing to the next file and so on.</p>
<p>The created filenames are based on the filename given with the <strong>-w</strong> option,
the number of the file and on the creation date and time,
e.g. outfile_00001_20050604120117.pcap, outfile_00002_20050604120523.pcap, ...</p>
<p>With the <em>files</em> option it's also possible to form a "ring buffer".
This will fill up new files until the number of files specified,
at which point <strong>Dumpcap</strong> will discard the data in the first file and start
writing to that file and so on. If the <em>files</em> option is not set,
new files filled up until one of the capture stop conditions match (or
until the disk is full).</p>
<p>The criterion is of the form <em>key</em><strong>:</strong><em>value</em>,
where <em>key</em> is one of:</p>
<p><strong>duration</strong>:<em>value</em> switch to the next file after <em>value</em> seconds have
elapsed, even if the current file is not completely filled up.</p>
<p><strong>filesize</strong>:<em>value</em> switch to the next file after it reaches a size of
<em>value</em> kilobytes (where a kilobyte is 1024 bytes).</p>
<p><strong>files</strong>:<em>value</em> begin again with the first file after <em>value</em> number of
files were written (form a ring buffer). This value must be less than 100000.
Caution should be used when using large numbers of files: some filesystems do
not handle many files in a single directory well. The <strong>files</strong> criterion
requires either <strong>duration</strong> or <strong>filesize</strong> to be specified to control when to
go to the next file. It should be noted that each <strong>-b</strong> parameter takes exactly
one criterion; to specify two criterion, each must be preceded by the <strong>-b</strong>
option.</p>
<p>Example: <strong>-b filesize:1024 -b files:5</strong> results in a ring buffer of five files
of size one megabyte.</p>
</dd>
<dt><strong><a name="b_capture_buffer_size" class="item">-B <capture buffer size></a></strong></dt>
<dd>
<p>Set capture buffer size (in MB, default is 1MB). This is used by the
the capture driver to buffer packet data until that data can be written
to disk. If you encounter packet drops while capturing, try to increase
this size. Note that, while <strong>Dumpcap</strong> attempts to set the buffer size
to 1MB by default, and can be told to set it to a larger value, the
system or interface on which you're capturing might silently limit the
capture buffer size to a lower value or raise it to a higher value.</p>
<p>This is available on UNIX systems with libpcap 1.0.0 or later and on
Windows. It is not available on UNIX systems with earlier versions of
libpcap.</p>
</dd>
<dt><strong><a name="c_capture_packet_count" class="item">-c <capture packet count></a></strong></dt>
<dd>
<p>Set the maximum number of packets to read when capturing live
data.</p>
</dd>
<dt><strong><a name="d" class="item">-d</a></strong></dt>
<dd>
<p>Dump the code generated for the capture filter in a human-readable form,
and exit.</p>
</dd>
<dt><strong><a name="d" class="item">-D</a></strong></dt>
<dd>
<p>Print a list of the interfaces on which <strong>Dumpcap</strong> can capture, and
exit. For each network interface, a number and an
interface name, possibly followed by a text description of the
interface, is printed. The interface name or the number can be supplied
to the <strong>-i</strong> option to specify an interface on which to capture.</p>
<p>This can be useful on systems that don't have a command to list them
(e.g., Windows systems, or UNIX systems lacking <strong>ifconfig -a</strong>);
the number can be useful on Windows 2000 and later systems, where the
interface name is a somewhat complex string.</p>
<p>Note that "can capture" means that <strong>Dumpcap</strong> was able to open
that device to do a live capture. Depending on your system you may need to
run dumpcap from an account with special privileges (for example, as root)
to be able to capture network traffic.
If "<strong>dumpcap -D</strong>" is not run from such an account, it will not list
any interfaces.</p>
</dd>
<dt><strong><a name="f_capture_filter" class="item">-f <capture filter></a></strong></dt>
<dd>
<p>Set the capture filter expression.</p>
<p>The entire filter expression must be specified as a single argument (which means
that if it contains spaces, it must be quoted).</p>
</dd>
<dt><strong><a name="h" class="item">-h</a></strong></dt>
<dd>
<p>Print the version and options and exits.</p>
</dd>
<dt><strong><a name="i_capture_interface" class="item">-i <capture interface>|-</a></strong></dt>
<dd>
<p>Set the name of the network interface or pipe to use for live packet
capture.</p>
<p>Network interface names should match one of the names listed in
"<strong>dumpcap -D</strong>" (described above); a number, as reported by
"<strong>dumpcap -D</strong>", can also be used. If you're using UNIX, "<strong>netstat
-i</strong>" or "<strong>ifconfig -a</strong>" might also work to list interface names,
although not all versions of UNIX support the <strong>-a</strong> option to <strong>ifconfig</strong>.</p>
<p>If no interface is specified, <strong>Dumpcap</strong> searches the list of
interfaces, choosing the first non-loopback interface if there are any
non-loopback interfaces, and choosing the first loopback interface if
there are no non-loopback interfaces. If there are no interfaces at all,
<strong>Dumpcap</strong> reports an error and doesn't start the capture.</p>
<p>Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
read data from the standard input. Data read from pipes must be in
standard libpcap format.</p>
<p>Note: the Win32 version of <strong>Dumpcap</strong> doesn't support capturing from
pipes or stdin!</p>
</dd>
<dt><strong><a name="i" class="item">-I</a></strong></dt>
<dd>
<p>Put the interface in "monitor mode"; this is supported only on IEEE
802.11 Wi-Fi interfaces, and supported only on some operating systems.</p>
<p>Note that in monitor mode the adapter might disassociate from the
network with which it's associated, so that you will not be able to use
any wireless networks with that adapter. This could prevent accessing
files on a network server, or resolving host names or network addresses,
if you are capturing in monitor mode and are not connected to another
network with another adapter.</p>
</dd>
<dt><strong><a name="l" class="item">-L</a></strong></dt>
<dd>
<p>List the data link types supported by the interface and exit. The reported
link types can be used for the <strong>-y</strong> option.</p>
</dd>
<dt><strong><a name="m" class="item">-M</a></strong></dt>
<dd>
<p>When used with <strong>-D</strong>, <strong>-L</strong> and <strong>-S</strong>, print machine-readable output.
The machine-readable output is intended to be read by <strong>Wireshark</strong> and
<strong>TShark</strong>; its format is subject to change from release to release.</p>
</dd>
<dt><strong><a name="n" class="item">-n</a></strong></dt>
<dd>
<p>Write the output file in the pcap-ng format instead of the default pcap
format.</p>
</dd>
<dt><strong><a name="p" class="item">-p</a></strong></dt>
<dd>
<p><em>Don't</em> put the interface into promiscuous mode. Note that the
interface might be in promiscuous mode for some other reason; hence,
<strong>-p</strong> cannot be used to ensure that the only traffic that is captured is
traffic sent to or from the machine on which <strong>Dumpcap</strong> is running,
broadcast traffic, and multicast traffic to addresses received by that
machine.</p>
</dd>
<dt><strong><a name="q" class="item">-q</a></strong></dt>
<dd>
<p>When capturing packets, don't display the continuous count of packets
captured that is normally shown when saving a capture to a file;
instead, just display, at the end of the capture, a count of packets
captured. On systems that support the SIGINFO signal, such as various
BSDs, you can cause the current count to be displayed by typing your
"status" character (typically control-T, although it
might be set to "disabled" by default on at least some BSDs, so you'd
have to explicitly set it to use it).</p>
</dd>
<dt><strong><a name="s_capture_snaplen" class="item">-s <capture snaplen></a></strong></dt>
<dd>
<p>Set the default snapshot length to use when capturing live data.
No more than <em>snaplen</em> bytes of each network packet will be read into
memory, or saved to disk. A value of 0 specifies a snapshot length of
65535, so that the full packet is captured; this is the default.</p>
</dd>
<dt><strong><a name="s" class="item">-S</a></strong></dt>
<dd>
<p>Print statistics for each interface once every second.</p>
</dd>
<dt><strong><a name="v" class="item">-v</a></strong></dt>
<dd>
<p>Print the version and exit.</p>
</dd>
<dt><strong><a name="w_outfile" class="item">-w <outfile></a></strong></dt>
<dd>
<p>Write raw packet data to <em>outfile</em>.</p>
<p>NOTE: The usage of "-" for stdout is not allowed here!</p>
</dd>
<dt><strong><a name="y_capture_link_type" class="item">-y <capture link type></a></strong></dt>
<dd>
<p>Set the data link type to use while capturing packets. The values
reported by <strong>-L</strong> are the values that can be used.</p>
</dd>
</dl>
<p>
</p>
<hr />
<h1><a name="capture_filter_syntax">CAPTURE FILTER SYNTAX</a></h1>
<p>See the manual page of pcap-filter(4) or, if that doesn't exist, <code>tcpdump(8)</code>,
or, if that doesn't exist, <a href="http://wiki.wireshark.org/CaptureFilters">http://wiki.wireshark.org/CaptureFilters</a>.</p>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><code>wireshark(1)</code>, <code>tshark(1)</code>, <code>editcap(1)</code>, <code>mergecap(1)</code>, <code>capinfos(1)</code>, pcap-filter(4),
<code>tcpdump(8)</code>, <code>pcap(3)</code></p>
<p>
</p>
<hr />
<h1><a name="notes">NOTES</a></h1>
<p><strong>Dumpcap</strong> is part of the <strong>Wireshark</strong> distribution. The latest version
of <strong>Wireshark</strong> can be found at <a href="http://www.wireshark.org">http://www.wireshark.org</a>.</p>
<p>HTML versions of the Wireshark project man pages are available at:
<a href="http://www.wireshark.org/docs/man-pages">http://www.wireshark.org/docs/man-pages</a>.</p>
<p>
</p>
<hr />
<h1><a name="authors">AUTHORS</a></h1>
<p><strong>Dumpcap</strong> is derived from the <strong>Wireshark</strong> capturing engine code;
see the list of
authors in the <strong>Wireshark</strong> man page for a list of authors of that code.</p>
</body>
</html>
|