4 tshark - Dump and analyze network traffic
10 S<[ B<-a> E<lt>capture autostop conditionE<gt> ] ...>
11 S<[ B<-b> E<lt>capture ring buffer optionE<gt>] ...>
12 S<[ B<-B> E<lt>capture buffer sizeE<gt> ] >
13 S<[ B<-c> E<lt>capture packet countE<gt> ]>
14 S<[ B<-C> E<lt>configuration profileE<gt> ]>
15 S<[ B<-d> E<lt>layer typeE<gt>==E<lt>selectorE<gt>,E<lt>decode-as protocolE<gt> ]>
17 S<[ B<-e> E<lt>fieldE<gt> ]>
18 S<[ B<-E> E<lt>field print optionE<gt> ]>
19 S<[ B<-f> E<lt>capture filterE<gt> ]>
20 S<[ B<-F> E<lt>file formatE<gt> ]>
23 S<[ B<-H> E<lt>input hosts fileE<gt> ]>
24 S<[ B<-i> E<lt>capture interfaceE<gt>|- ]>
26 S<[ B<-K> E<lt>keytabE<gt> ]>
30 S<[ B<-N> E<lt>name resolving flagsE<gt> ]>
31 S<[ B<-o> E<lt>preference settingE<gt> ] ...>
32 S<[ B<-O> E<lt>protocolsE<gt> ]>
37 S<[ B<-r> E<lt>infileE<gt> ]>
38 S<[ B<-R> E<lt>Read filterE<gt> ]>
39 S<[ B<-s> E<lt>capture snaplenE<gt> ]>
40 S<[ B<-S> E<lt>separatorE<gt> ]>
41 S<[ B<-t> a|ad|adoy|d|dd|e|r|u|ud|udoy ]>
42 S<[ B<-T> fields|pdml|ps|psml|text ]>
43 S<[ B<-u> E<lt>seconds typeE<gt>]>
46 S<[ B<-w> E<lt>outfileE<gt>|- ]>
47 S<[ B<-W> E<lt>file format optionE<gt>]>
49 S<[ B<-X> E<lt>eXtension optionE<gt>]>
50 S<[ B<-y> E<lt>capture link typeE<gt> ]>
51 S<[ B<-Y> E<lt>displaY filterE<gt> ]>
52 S<[ B<-z> E<lt>statisticsE<gt> ]>
53 S<[ B<--capture-comment> E<lt>commentE<gt> ]>
54 S<[ E<lt>capture filterE<gt> ]>
57 B<-G> [column-formats|currentprefs|decodes|defaultprefs|fields|ftypes|heuristic-decodes|plugins|protocols|values]
61 B<TShark> is a network protocol analyzer. It lets you capture packet
62 data from a live network, or read packets from a previously saved
63 capture file, either printing a decoded form of those packets to the
64 standard output or writing the packets to a file. B<TShark>'s native
65 capture file format is B<pcap> format, which is also the format used
66 by B<tcpdump> and various other tools.
68 Without any options set, B<TShark> will work much like B<tcpdump>. It will
69 use the pcap library to capture traffic from the first available network
70 interface and displays a summary line on stdout for each received packet.
72 B<TShark> is able to detect, read and write the same capture files that
73 are supported by B<Wireshark>.
74 The input file doesn't need a specific filename extension; the file
75 format and an optional gzip compression will be automatically detected.
76 Near the beginning of the DESCRIPTION section of wireshark(1) or
77 L<http://www.wireshark.org/docs/man-pages/wireshark.html>
78 is a detailed description of the way B<Wireshark> handles this, which is
79 the same way B<Tshark> handles this.
81 Compressed file support uses (and therefore requires) the zlib library.
82 If the zlib library is not present, B<TShark> will compile, but will
83 be unable to read compressed files.
85 If the B<-w> option is not specified, B<TShark> writes to the standard
86 output the text of a decoded form of the packets it captures or reads.
87 If the B<-w> option is specified, B<TShark> writes to the file
88 specified by that option the raw data of the packets, along with the
91 When writing a decoded form of packets, B<TShark> writes, by
92 default, a summary line containing the fields specified by the
93 preferences file (which are also the fields displayed in the packet list
94 pane in B<Wireshark>), although if it's writing packets as it captures
95 them, rather than writing packets from a saved capture file, it won't
96 show the "frame number" field. If the B<-V> option is specified, it
97 writes instead a view of the details of the packet, showing all the
98 fields of all protocols in the packet. If the B<-O> option is specified,
99 it will only show the full protocols specified. Use the output of
100 "B<tshark -G protocols>" to find the abbreviations of the protocols you can
103 If you want to write the decoded form of packets to a file, run
104 B<TShark> without the B<-w> option, and redirect its standard output to
105 the file (do I<not> use the B<-w> option).
107 When writing packets to a file, B<TShark>, by default, writes the
108 file in B<pcap> format, and writes all of the packets it sees to the
109 output file. The B<-F> option can be used to specify the format in which
110 to write the file. This list of available file formats is displayed by
111 the B<-F> flag without a value. However, you can't specify a file format
114 Read filters in B<TShark>, which allow you to select which packets
115 are to be decoded or written to a file, are very powerful; more fields
116 are filterable in B<TShark> than in other protocol analyzers, and the
117 syntax you can use to create your filters is richer. As B<TShark>
118 progresses, expect more and more protocol fields to be allowed in read
121 Packet capturing is performed with the pcap library. The capture filter
122 syntax follows the rules of the pcap library. This syntax is different
123 from the read filter syntax. A read filter can also be specified when
124 capturing, and only packets that pass the read filter will be displayed
125 or saved to the output file; note, however, that capture filters are much
126 more efficient than read filters, and it may be more difficult for
127 B<TShark> to keep up with a busy network if a read filter is
128 specified for a live capture.
130 A capture or read filter can either be specified with the B<-f> or B<-R>
131 option, respectively, in which case the entire filter expression must be
132 specified as a single argument (which means that if it contains spaces,
133 it must be quoted), or can be specified with command-line arguments
134 after the option arguments, in which case all the arguments after the
135 filter arguments are treated as a filter expression. Capture filters
136 are supported only when doing a live capture; read filters are supported
137 when doing a live capture and when reading a capture file, but require
138 TShark to do more work when filtering, so you might be more likely to
139 lose packets under heavy load if you're using a read filter. If the
140 filter is specified with command-line arguments after the option
141 arguments, it's a capture filter if a capture is being done (i.e., if no
142 B<-r> option was specified) and a read filter if a capture file is being
143 read (i.e., if a B<-r> option was specified).
145 The B<-G> option is a special mode that simply causes B<Tshark>
146 to dump one of several types of internal glossaries and then exit.
154 Perform a two-pass analysis. This causes tshark to buffer output until the
155 entire first pass is done, but allows it to fill in fields that require future
156 knowledge, such as 'response in frame #' fields. Also permits reassembly
157 frame dependencies to be calculated correctly.
159 =item -a E<lt>capture autostop conditionE<gt>
161 Specify a criterion that specifies when B<TShark> is to stop writing
162 to a capture file. The criterion is of the form I<test>B<:>I<value>,
163 where I<test> is one of:
165 B<duration>:I<value> Stop writing to a capture file after I<value> seconds
168 B<filesize>:I<value> Stop writing to a capture file after it reaches a size of
169 I<value> kB. If this option is used together with the -b option, B<TShark>
170 will stop writing to the current capture file and switch to the next one if
171 filesize is reached. When reading a capture file, B<TShark> will stop reading
172 the file after the number of bytes read exceeds this number (the complete
173 packet will be read, so more bytes than this number may be read). Note that
174 the filesize is limited to a maximum value of 2 GiB.
176 B<files>:I<value> Stop writing to capture files after I<value> number of files
179 =item -b E<lt>capture ring buffer optionE<gt>
181 Cause B<TShark> to run in "multiple files" mode. In "multiple files" mode,
182 B<TShark> will write to several capture files. When the first capture file
183 fills up, B<TShark> will switch writing to the next file and so on.
185 The created filenames are based on the filename given with the B<-w> option,
186 the number of the file and on the creation date and time,
187 e.g. outfile_00001_20050604120117.pcap, outfile_00002_20050604120523.pcap, ...
189 With the I<files> option it's also possible to form a "ring buffer".
190 This will fill up new files until the number of files specified,
191 at which point B<TShark> will discard the data in the first file and start
192 writing to that file and so on. If the I<files> option is not set,
193 new files filled up until one of the capture stop conditions match (or
194 until the disk is full).
196 The criterion is of the form I<key>B<:>I<value>,
197 where I<key> is one of:
199 B<duration>:I<value> switch to the next file after I<value> seconds have
200 elapsed, even if the current file is not completely filled up.
202 B<filesize>:I<value> switch to the next file after it reaches a size of
203 I<value> kB. Note that the filesize is limited to a maximum value of 2 GiB.
205 B<files>:I<value> begin again with the first file after I<value> number of
206 files were written (form a ring buffer). This value must be less than 100000.
207 Caution should be used when using large numbers of files: some filesystems do
208 not handle many files in a single directory well. The B<files> criterion
209 requires either B<duration> or B<filesize> to be specified to control when to
210 go to the next file. It should be noted that each B<-b> parameter takes exactly
211 one criterion; to specify two criterion, each must be preceded by the B<-b>
214 Example: B<-b filesize:1000 -b files:5> results in a ring buffer of five files
215 of size one megabyte each.
217 =item -B E<lt>capture buffer sizeE<gt>
219 Set capture buffer size (in MiB, default is 2 MiB). This is used by
220 the capture driver to buffer packet data until that data can be written
221 to disk. If you encounter packet drops while capturing, try to increase
222 this size. Note that, while B<Tshark> attempts to set the buffer size
223 to 2 MiB by default, and can be told to set it to a larger value, the
224 system or interface on which you're capturing might silently limit the
225 capture buffer size to a lower value or raise it to a higher value.
227 This is available on UNIX systems with libpcap 1.0.0 or later and on
228 Windows. It is not available on UNIX systems with earlier versions of
231 This option can occur multiple times. If used before the first
232 occurrence of the B<-i> option, it sets the default capture buffer size.
233 If used after an B<-i> option, it sets the capture buffer size for
234 the interface specified by the last B<-i> option occurring before
235 this option. If the capture buffer size is not set specifically,
236 the default capture buffer size is used instead.
238 =item -c E<lt>capture packet countE<gt>
240 Set the maximum number of packets to read when capturing live
241 data. If reading a capture file, set the maximum number of packets to read.
243 =item -C E<lt>configuration profileE<gt>
245 Run with the given configuration profile.
247 =item -d E<lt>layer typeE<gt>==E<lt>selectorE<gt>,E<lt>decode-as protocolE<gt>
249 Like Wireshark's B<Decode As...> feature, this lets you specify how a
250 layer type should be dissected. If the layer type in question (for example,
251 B<tcp.port> or B<udp.port> for a TCP or UDP port number) has the specified
252 selector value, packets should be dissected as the specified protocol.
254 Example: B<-d tcp.port==8888,http> will decode any traffic running over
255 TCP port 8888 as HTTP.
257 Example: B<-d tcp.port==8888:3,http> will decode any traffic running over
258 TCP ports 8888, 8889 or 8890 as HTTP.
260 Example: B<-d tcp.port==8888-8890,http> will decode any traffic running over
261 TCP ports 8888, 8889 or 8890 as HTTP.
263 Using an invalid selector or protocol will print out a list of valid selectors
264 and protocol names, respectively.
266 Example: B<-d .> is a quick way to get a list of valid selectors.
268 Example: B<-d ethertype==0x0800.> is a quick way to get a list of protocols that can be
269 selected with an ethertype.
273 Print a list of the interfaces on which B<TShark> can capture, and
274 exit. For each network interface, a number and an
275 interface name, possibly followed by a text description of the
276 interface, is printed. The interface name or the number can be supplied
277 to the B<-i> option to specify an interface on which to capture.
279 This can be useful on systems that don't have a command to list them
280 (e.g., Windows systems, or UNIX systems lacking B<ifconfig -a>);
281 the number can be useful on Windows 2000 and later systems, where the
282 interface name is a somewhat complex string.
284 Note that "can capture" means that B<TShark> was able to open that
285 device to do a live capture. Depending on your system you may need to
286 run tshark from an account with special privileges (for example, as
287 root) to be able to capture network traffic. If B<TShark -D> is not run
288 from such an account, it will not list any interfaces.
290 =item -e E<lt>fieldE<gt>
292 Add a field to the list of fields to display if B<-T fields> is
293 selected. This option can be used multiple times on the command line.
294 At least one field must be provided if the B<-T fields> option is
295 selected. Column names may be used prefixed with "_ws.col."
297 Example: B<-e frame.number -e ip.addr -e udp -e _ws.col.info>
299 Giving a protocol rather than a single field will print multiple items
300 of data about the protocol as a single field. Fields are separated by
301 tab characters by default. B<-E> controls the format of the printed
304 =item -E E<lt>field print optionE<gt>
306 Set an option controlling the printing of fields when B<-T fields> is
311 B<header=y|n> If B<y>, print a list of the field names given using B<-e>
312 as the first line of the output; the field name will be separated using
313 the same character as the field values. Defaults to B<n>.
315 B<separator=/t|/s|>E<lt>characterE<gt> Set the separator character to
316 use for fields. If B</t> tab will be used (this is the default), if
317 B</s>, a single space will be used. Otherwise any character that can be
318 accepted by the command line as part of the option may be used.
320 B<occurrence=f|l|a> Select which occurrence to use for fields that have
321 multiple occurrences. If B<f> the first occurrence will be used, if B<l>
322 the last occurrence will be used and if B<a> all occurrences will be used
323 (this is the default).
325 B<aggregator=,|/s|>E<lt>characterE<gt> Set the aggregator character to
326 use for fields that have multiple occurrences. If B<,> a comma will be used
327 (this is the default), if B</s>, a single space will be used. Otherwise
328 any character that can be accepted by the command line as part of the
331 B<quote=d|s|n> Set the quote character to use to surround fields. B<d>
332 uses double-quotes, B<s> single-quotes, B<n> no quotes (the default).
334 =item -f E<lt>capture filterE<gt>
336 Set the capture filter expression.
338 This option can occur multiple times. If used before the first
339 occurrence of the B<-i> option, it sets the default capture filter expression.
340 If used after an B<-i> option, it sets the capture filter expression for
341 the interface specified by the last B<-i> option occurring before
342 this option. If the capture filter expression is not set specifically,
343 the default capture filter expression is used if provided.
345 =item -F E<lt>file formatE<gt>
347 Set the file format of the output capture file written using the B<-w>
348 option. The output written with the B<-w> option is raw packet data, not
349 text, so there is no B<-F> option to request text output. The option B<-F>
350 without a value will list the available formats.
354 This option causes the output file(s) to be created with group-read permission
355 (meaning that the output file(s) can be read by other members of the calling
358 =item -G [column-formats|currentprefs|decodes|defaultprefs|fields|ftypes|heuristic-decodes|plugins|protocols|values]
360 The B<-G> option will cause B<Tshark> to dump one of several types of glossaries
361 and then exit. If no specific glossary type is specified, then the B<fields> report will be generated by default.
363 The available report types include:
365 B<column-formats> Dumps the column formats understood by tshark.
366 There is one record per line. The fields are tab-delimited.
368 * Field 1 = format string (e.g. "%rD")
369 * Field 2 = text description of format string (e.g. "Dest port (resolved)")
371 B<currentprefs> Dumps a copy of the current preferences file to stdout.
373 B<decodes> Dumps the "layer type"/"decode as" associations to stdout.
374 There is one record per line. The fields are tab-delimited.
376 * Field 1 = layer type, e.g. "tcp.port"
377 * Field 2 = selector in decimal
378 * Field 3 = "decode as" name, e.g. "http"
380 B<defaultprefs> Dumps a default preferences file to stdout.
382 B<fields> Dumps the contents of the registration database to
383 stdout. An independent program can take this output and format it into nice
384 tables or HTML or whatever. There is one record per line. Each record is
385 either a protocol or a header field, differentiated by the first field.
386 The fields are tab-delimited.
391 * Field 2 = descriptive protocol name
392 * Field 3 = protocol abbreviation
397 * Field 2 = descriptive field name
398 * Field 3 = field abbreviation
399 * Field 4 = type ( textual representation of the ftenum type )
400 * Field 5 = parent protocol abbreviation
401 * Field 6 = base for display (for integer types); "parent bitfield width" for FT_BOOLEAN
402 * Field 7 = bitmask: format: hex: 0x....
403 * Field 8 = blurb describing field
405 B<ftypes> Dumps the "ftypes" (fundamental types) understood by tshark.
406 There is one record per line. The fields are tab-delimited.
408 * Field 1 = FTYPE (e.g "FT_IPv6")
409 * Field 2 = text description of type (e.g. "IPv6 address")
411 B<heuristic-decodes> Dumps the heuristic decodes currently installed.
412 There is one record per line. The fields are tab-delimited.
414 * Field 1 = underlying dissector (e.g. "tcp")
415 * Field 2 = name of heuristic decoder (e.g. ucp")
416 * Field 3 = heuristic enabled (e.g. "T" or "F")
418 B<plugins> Dumps the plugins currently installed.
419 There is one record per line. The fields are tab-delimited.
421 * Field 1 = plugin library (e.g. "gryphon.so")
422 * Field 2 = plugin version (e.g. 0.0.4)
423 * Field 3 = plugin type (e.g. "dissector" or "tap")
424 * Field 4 = full path to plugin file
426 B<protocols> Dumps the protocols in the registration database to stdout.
427 An independent program can take this output and format it into nice tables
428 or HTML or whatever. There is one record per line. The fields are tab-delimited.
430 * Field 1 = protocol name
431 * Field 2 = protocol short name
432 * Field 3 = protocol filter name
434 B<values> Dumps the value_strings, range_strings or true/false strings
435 for fields that have them. There is one record per line. Fields are
436 tab-delimited. There are three types of records: Value String, Range
437 String and True/False String. The first field, 'V', 'R' or 'T', indicates
443 * Field 2 = field abbreviation to which this value string corresponds
444 * Field 3 = Integer value
450 * Field 2 = field abbreviation to which this range string corresponds
451 * Field 3 = Integer value: lower bound
452 * Field 4 = Integer value: upper bound
458 * Field 2 = field abbreviation to which this true/false string corresponds
459 * Field 3 = True String
460 * Field 4 = False String
464 Print the version and options and exits.
466 =item -H E<lt>input hosts fileE<gt>
468 Read a list of entries from a "hosts" file, which will then be written
469 to a capture file. Implies B<-W n>. Can be called multiple times.
471 The "hosts" file format is documented at
472 L<http://en.wikipedia.org/wiki/Hosts_(file)>.
474 =item -i E<lt>capture interfaceE<gt> | -
476 Set the name of the network interface or pipe to use for live packet
479 Network interface names should match one of the names listed in
480 "B<tshark -D>" (described above); a number, as reported by
481 "B<tshark -D>", can also be used. If you're using UNIX, "B<netstat
482 -i>" or "B<ifconfig -a>" might also work to list interface names,
483 although not all versions of UNIX support the B<-a> option to B<ifconfig>.
485 If no interface is specified, B<TShark> searches the list of
486 interfaces, choosing the first non-loopback interface if there are any
487 non-loopback interfaces, and choosing the first loopback interface if
488 there are no non-loopback interfaces. If there are no interfaces at all,
489 B<TShark> reports an error and doesn't start the capture.
491 Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
492 read data from the standard input. Data read from pipes must be in
493 standard pcap format.
495 This option can occur multiple times. When capturing from multiple
496 interfaces, the capture file will be saved in pcap-ng format.
498 Note: the Win32 version of B<TShark> doesn't support capturing from
503 Put the interface in "monitor mode"; this is supported only on IEEE
504 802.11 Wi-Fi interfaces, and supported only on some operating systems.
506 Note that in monitor mode the adapter might disassociate from the
507 network with which it's associated, so that you will not be able to use
508 any wireless networks with that adapter. This could prevent accessing
509 files on a network server, or resolving host names or network addresses,
510 if you are capturing in monitor mode and are not connected to another
511 network with another adapter.
513 This option can occur multiple times. If used before the first
514 occurrence of the B<-i> option, it enables the monitor mode for all interfaces.
515 If used after an B<-i> option, it enables the monitor mode for
516 the interface specified by the last B<-i> option occurring before
519 =item -K E<lt>keytabE<gt>
521 Load kerberos crypto keys from the specified keytab file.
522 This option can be used multiple times to load keys from several files.
524 Example: B<-K krb5.keytab>
528 Flush the standard output after the information for each packet is
529 printed. (This is not, strictly speaking, line-buffered if B<-V>
530 was specified; however, it is the same as line-buffered if B<-V> wasn't
531 specified, as only one line is printed for each packet, and, as B<-l> is
532 normally used when piping a live capture to a program or script, so that
533 output for a packet shows up as soon as the packet is seen and
534 dissected, it should work just as well as true line-buffering. We do
535 this as a workaround for a deficiency in the Microsoft Visual C++ C
538 This may be useful when piping the output of B<TShark> to another
539 program, as it means that the program to which the output is piped will
540 see the dissected data for a packet as soon as B<TShark> sees the
541 packet and generates that output, rather than seeing it only when the
542 standard output buffer containing that data fills up.
546 List the data link types supported by the interface and exit. The reported
547 link types can be used for the B<-y> option.
551 Disable network object name resolution (such as hostname, TCP and UDP port
552 names); the B<-N> flag might override this one.
554 =item -N E<lt>name resolving flagsE<gt>
556 Turn on name resolving only for particular types of addresses and port
557 numbers, with name resolving for other types of addresses and port
558 numbers turned off. This flag overrides B<-n> if both B<-N> and B<-n> are
559 present. If both B<-N> and B<-n> flags are not present, all name resolutions
562 The argument is a string that may contain the letters:
564 B<C> to enable concurrent (asynchronous) DNS lookups
566 B<m> to enable MAC address resolution
568 B<n> to enable network address resolution
570 B<N> to enable using external resolvers (e.g., DNS) for network address
573 B<t> to enable transport-layer port number resolution
575 =item -o E<lt>preferenceE<gt>:E<lt>valueE<gt>
577 Set a preference value, overriding the default value and any value read
578 from a preference file. The argument to the option is a string of the
579 form I<prefname>B<:>I<value>, where I<prefname> is the name of the
580 preference (which is the same name that would appear in the preference
581 file), and I<value> is the value to which it should be set.
583 =item -O E<lt>protocolsE<gt>
585 Similar to the B<-V> option, but causes B<TShark> to only show a detailed view
586 of the comma-separated list of I<protocols> specified, rather than a detailed
587 view of all protocols. Use the output of "B<tshark -G protocols>" to find the
588 abbreviations of the protocols you can specify.
592 I<Don't> put the interface into promiscuous mode. Note that the
593 interface might be in promiscuous mode for some other reason; hence,
594 B<-p> cannot be used to ensure that the only traffic that is captured is
595 traffic sent to or from the machine on which B<TShark> is running,
596 broadcast traffic, and multicast traffic to addresses received by that
599 This option can occur multiple times. If used before the first
600 occurrence of the B<-i> option, no interface will be put into the
602 If used after an B<-i> option, the interface specified by the last B<-i>
603 option occurring before this option will not be put into the
608 Decode and display the packet summary, even if writing raw packet data using
613 When capturing packets, don't display the continuous count of packets
614 captured that is normally shown when saving a capture to a file;
615 instead, just display, at the end of the capture, a count of packets
616 captured. On systems that support the SIGINFO signal, such as various
617 BSDs, you can cause the current count to be displayed by typing your
618 "status" character (typically control-T, although it
619 might be set to "disabled" by default on at least some BSDs, so you'd
620 have to explicitly set it to use it).
622 When reading a capture file, or when capturing and not saving to a file,
623 don't print packet information; this is useful if you're using a B<-z>
624 option to calculate statistics and don't want the packet information
625 printed, just the statistics.
629 When capturing packets, only display true errors. This outputs less
630 than the B<-q> option, so the interface name and total packet
631 count and the end of a capture are not sent to stderr.
633 =item -r E<lt>infileE<gt>
635 Read packet data from I<infile>, can be any supported capture file format
636 (including gzipped files). It's B<not> possible to use named pipes
639 =item -R E<lt>Read filterE<gt>
641 Cause the specified filter (which uses the syntax of read/display filters,
642 rather than that of capture filters) to be applied during the first pass of
643 analysis. Packets not matching the filter are not considered for future
644 passes. Only makes sense with multiple passes, see -2. For regular filtering
645 on single-pass dissect see -Y instead.
647 Note that forward-looking fields such as 'response in frame #' cannot be used
648 with this filter, since they will not have been calculate when this filter is
651 =item -s E<lt>capture snaplenE<gt>
653 Set the default snapshot length to use when capturing live data.
654 No more than I<snaplen> bytes of each network packet will be read into
655 memory, or saved to disk. A value of 0 specifies a snapshot length of
656 65535, so that the full packet is captured; this is the default.
658 This option can occur multiple times. If used before the first
659 occurrence of the B<-i> option, it sets the default snapshot length.
660 If used after an B<-i> option, it sets the snapshot length for
661 the interface specified by the last B<-i> option occurring before
662 this option. If the snapshot length is not set specifically,
663 the default snapshot length is used if provided.
665 =item -S E<lt>separatorE<gt>
667 Set the line separator to be printed between packets.
669 =item -t a|ad|adoy|d|dd|e|r|u|ud|udoy
671 Set the format of the packet timestamp printed in summary lines.
672 The format can be one of:
674 B<a> absolute: The absolute time, as local time in your time zone,
675 is the actual time the packet was captured, with no date displayed
677 B<ad> absolute with date: The absolute date, displayed as YYYY-MM-DD,
678 and time, as local time in your time zone, is the actual time and date
679 the packet was captured
681 B<adoy> absolute with date using day of year: The absolute date,
682 displayed as YYYY/DOY, and time, as local time in your time zone,
683 is the actual time and date the packet was captured
685 B<d> delta: The delta time is the time since the previous packet was
688 B<dd> delta_displayed: The delta_displayed time is the time since the
689 previous displayed packet was captured
691 B<e> epoch: The time in seconds since epoch (Jan 1, 1970 00:00:00)
693 B<r> relative: The relative time is the time elapsed between the first packet
694 and the current packet
696 B<u> UTC: The absolute time, as UTC, is the actual time the packet was
697 captured, with no date displayed
699 B<ud> UTC with date: The absolute date, displayed as YYYY-MM-DD,
700 and time, as UTC, is the actual time and date the packet was captured
702 B<udoy> UTC with date using day of year: The absolute date, displayed
703 as YYYY/DOY, and time, as UTC, is the actual time and date the packet
706 The default format is relative.
708 =item -T fields|pdml|ps|psml|text
710 Set the format of the output when viewing decoded packet data. The
713 B<fields> The values of fields specified with the B<-e> option, in a
714 form specified by the B<-E> option. For example,
716 -T fields -E separator=, -E quote=d
718 would generate comma-separated values (CSV) output suitable for importing
719 into your favorite spreadsheet program.
721 B<pdml> Packet Details Markup Language, an XML-based format for the details of
722 a decoded packet. This information is equivalent to the packet details
723 printed with the B<-V> flag.
725 B<ps> PostScript for a human-readable one-line summary of each of the packets,
726 or a multi-line view of the details of each of the packets, depending on
727 whether the B<-V> flag was specified.
729 B<psml> Packet Summary Markup Language, an XML-based format for the summary
730 information of a decoded packet. This information is equivalent to the
731 information shown in the one-line summary printed by default.
733 B<text> Text of a human-readable one-line summary of each of the packets, or a
734 multi-line view of the details of each of the packets, depending on
735 whether the B<-V> flag was specified. This is the default.
737 =item -u E<lt>seconds typeE<gt>
739 Specifies the seconds type. Valid choices are:
743 B<hms> for hours, minutes and seconds
747 Print the version and exit.
751 Cause B<TShark> to print a view of the packet details.
753 =item -w E<lt>outfileE<gt> | -
755 Write raw packet data to I<outfile> or to the standard output if
758 NOTE: -w provides raw packet data, not text. If you want text output
759 you need to redirect stdout (e.g. using '>'), don't use the B<-w>
762 =item -W E<lt>file format optionE<gt>
764 Save extra information in the file if the format supports it. For
769 will save host name resolution records along with captured packets.
771 Future versions of Wireshark may automatically change the capture format to
774 The argument is a string that may contain the following letter:
776 B<n> write network address resolution information (pcapng only)
780 Cause B<TShark> to print a hex and ASCII dump of the packet data
781 after printing the summary and/or details, if either are also being displayed.
783 =item -X E<lt>eXtension optionsE<gt>
785 Specify an option to be passed to a B<TShark> module. The eXtension option
786 is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
788 B<lua_script>:I<lua_script_filename> tells B<Wireshark> to load the given script in addition to the
791 =item -y E<lt>capture link typeE<gt>
793 Set the data link type to use while capturing packets. The values
794 reported by B<-L> are the values that can be used.
796 This option can occur multiple times. If used before the first
797 occurrence of the B<-i> option, it sets the default capture link type.
798 If used after an B<-i> option, it sets the capture link type for
799 the interface specified by the last B<-i> option occurring before
800 this option. If the capture link type is not set specifically,
801 the default capture link type is used if provided.
803 =item -Y E<lt>displaY filterE<gt>
805 Cause the specified filter (which uses the syntax of read/display filters,
806 rather than that of capture filters) to be applied before printing a
807 decoded form of packets or writing packets to a file. Packets matching the
808 filter are printed or written to file; packets that the matching packets
809 depend upon (e.g., fragments), are not printed but are written to file;
810 packets not matching the filter nor depended upon are discarded rather
811 than being printed or written.
813 Use this instead of -R for filtering using single-pass analysis. If doing
814 two-pass analysis (see -2) then only packets matching the read filter (if there
815 is one) will be checked against this filter.
817 =item -z E<lt>statisticsE<gt>
819 Get B<TShark> to collect various types of statistics and display the result
820 after finishing reading the capture file. Use the B<-q> flag if you're
821 reading a capture file and only want the statistics printed, not any
822 per-packet information.
824 Note that the B<-z proto> option is different - it doesn't cause
825 statistics to be gathered and printed when the capture is complete, it
826 modifies the regular packet summary output to include the values of
827 fields specified with the option. Therefore you must not use the B<-q>
828 option, as that option would suppress the printing of the regular packet
829 summary output, and must also not use the B<-V> option, as that would
830 cause packet detail information rather than packet summary information
833 Currently implemented statistics are:
839 Display all possible values for B<-z>.
841 =item B<-z> afp,srt[,I<filter>]
843 =item B<-z> camel,srt
845 =item B<-z> compare,I<start>,I<stop>,I<ttl[0|1]>,I<order[0|1]>,I<variance>[,I<filter>]
847 If the optional I<filter> is specified, only those packets that match the
848 filter will be used in the calculations.
850 =item B<-z> conv,I<type>[,I<filter>]
852 Create a table that lists all conversations that could be seen in the
853 capture. I<type> specifies the conversation endpoint types for which we
854 want to generate the statistics; currently the supported ones are:
856 "eth" Ethernet addresses
857 "fc" Fibre Channel addresses
858 "fddi" FDDI addresses
860 "ipv6" IPv6 addresses
862 "tcp" TCP/IP socket pairs Both IPv4 and IPv6 are supported
863 "tr" Token Ring addresses
864 "udp" UDP/IP socket pairs Both IPv4 and IPv6 are supported
866 If the optional I<filter> is specified, only those packets that match the
867 filter will be used in the calculations.
869 The table is presented with one line for each conversation and displays
870 the number of packets/bytes in each direction as well as the total
871 number of packets/bytes. The table is sorted according to the total
874 =item B<-z> dcerpc,srt,I<uuid>,I<major>.I<minor>[,I<filter>]
876 Collect call/reply SRT (Service Response Time) data for DCERPC interface I<uuid>,
877 version I<major>.I<minor>.
878 Data collected is the number of calls for each procedure, MinSRT, MaxSRT
881 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0>> will collect data for the CIFS SAMR Interface.
883 This option can be used multiple times on the command line.
885 If the optional I<filter> is provided, the stats will only be calculated
886 on those calls that match that filter.
888 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0,ip.addr==1.2.3.4>> will collect SAMR
889 SRT statistics for a specific host.
891 =item B<-z> diameter,avp[,I<cmd.code>,I<field>,I<field>,I<...>]
893 This option enables extraction of most important diameter fields from large capture files.
894 Exactly one text line for each diameter message with matched B<diameter.cmd.code> will be printed.
896 Empty diameter command code or '*' can be specified to mach any B<diameter.cmd.code>
898 Example: B<-z diameter,avp> extract default field set from diameter messages.
900 Example: B<-z diameter,avp,280> extract default field set from diameter DWR messages.
902 Example: B<-z diameter,avp,272> extract default field set from diameter CC messages.
904 Extract most important fields from diameter CC messages:
906 B<tshark -r file.cap.gz -q -z diameter,avp,272,CC-Request-Type,CC-Request-Number,Session-Id,Subscription-Id-Data,Rating-Group,Result-Code>
908 Following fields will be printed out for each diameter message:
910 "frame" Frame number.
911 "time" Unix time of the frame arrival.
912 "src" Source address.
913 "srcport" Source port.
914 "dst" Destination address.
915 "dstport" Destination port.
916 "proto" Constant string 'diameter', which can be used for post processing of tshark output. E.g. grep/sed/awk.
917 "msgnr" seq. number of diameter message within the frame. E.g. '2' for the third diameter message in the same frame.
918 "is_request" '0' if message is a request, '1' if message is an answer.
919 "cmd" diameter.cmd_code, E.g. '272' for credit control messages.
920 "req_frame" Number of frame where matched request was found or '0'.
921 "ans_frame" Number of frame where matched answer was found or '0'.
922 "resp_time" response time in seconds, '0' in case if matched Request/Answer is not found in trace. E.g. in the begin or end of capture.
924 B<-z diameter,avp> option is much faster than B<-V -T text> or B<-T pdml> options.
926 B<-z diameter,avp> option is more powerful than B<-T field> and B<-z proto,colinfo> options.
928 Multiple diameter messages in one frame are supported.
930 Several fields with same name within one diameter message are supported, e.g. I<diameter.Subscription-Id-Data> or I<diameter.Rating-Group>.
932 Note: B<tshark -q> option is recommended to suppress default B<tshark> output.
934 =item B<-z> expert[I<,error|,warn|,note|,chat>][I<,filter>]
936 Collects information about all expert info, and will display them in order,
939 Example: B<-z expert,sip> will show expert items of all severity for frames that
940 match the sip protocol.
942 This option can be used multiple times on the command line.
944 If the optional I<filter> is provided, the stats will only be calculated
945 on those calls that match that filter.
947 Example: B<-z "expert,note,tcp"> will only collect expert items for frames that
948 include the tcp protocol, with a severity of note or higher.
950 =item B<-z> follow,I<prot>,I<mode>,I<filter>[I<,range>]
952 Displays the contents of a TCP or UDP stream between two nodes. The data
953 sent by the second node is prefixed with a tab to differentiate it from the
954 data sent by the first node.
956 I<prot> specifies the transport protocol. It can be one of:
961 I<mode> specifies the output mode. It can be one of:
962 B<ascii> ASCII output with dots for non-printable characters
963 B<hex> Hexadecimal and ASCII data with offsets
964 B<raw> Hexadecimal data
966 Since the output in B<ascii> mode may contain newlines, the length of each section
967 of output plus a newline precedes each section of output.
969 I<filter> specifies the stream to be displayed. UDP streams are selected with
970 IP address plus port pairs. TCP streams are selected with either the stream
971 index or IP address plus port pairs. For example:
972 B<ip-addr0>:B<port0>,B<ip-addr1>:B<port1>
975 I<range> optionally specifies which "chunks" of the stream should be displayed.
977 Example: B<-z "follow,tcp,hex,1"> will display the contents of the first TCP
978 stream in "hex" format.
980 ===================================================================
982 Filter: tcp.stream eq 1
983 Node 0: 200.57.7.197:32891
984 Node 1: 200.57.7.198:2906
985 00000000 00 00 00 22 00 00 00 07 00 0a 85 02 07 e9 00 02 ...".... ........
986 00000010 07 e9 06 0f 00 0d 00 04 00 00 00 01 00 03 00 06 ........ ........
987 00000020 1f 00 06 04 00 00 ......
988 00000000 00 01 00 00 ....
991 Example: B<-z "follow,tcp,ascii,200.57.7.197:32891,200.57.7.198:2906"> will
992 display the contents of a TCP stream between 200.57.7.197 port 32891 and
993 200.57.7.98 port 2906.
995 ===================================================================
997 Filter: (omitted for readability)
998 Node 0: 200.57.7.197:32891
999 Node 1: 200.57.7.198:2906
1006 =item B<-z> h225,counter[I<,filter>]
1008 Count ITU-T H.225 messages and their reasons. In the first column you get a
1009 list of H.225 messages and H.225 message reasons, which occur in the current
1010 capture file. The number of occurrences of each message or reason is displayed
1011 in the second column.
1013 Example: B<-z h225,counter>.
1015 If the optional I<filter> is provided, the stats will only be calculated
1016 on those calls that match that filter.
1017 Example: use B<-z "h225,counter,ip.addr==1.2.3.4"> to only collect stats for
1018 H.225 packets exchanged by the host at IP address 1.2.3.4 .
1020 This option can be used multiple times on the command line.
1022 =item B<-z> h225,srt[I<,filter>]
1024 Collect requests/response SRT (Service Response Time) data for ITU-T H.225 RAS.
1025 Data collected is number of calls of each ITU-T H.225 RAS Message Type,
1026 Minimum SRT, Maximum SRT, Average SRT, Minimum in Packet, and Maximum in Packet.
1027 You will also get the number of Open Requests (Unresponded Requests),
1028 Discarded Responses (Responses without matching request) and Duplicate Messages.
1030 Example: B<-z h225,srt>
1032 This option can be used multiple times on the command line.
1034 If the optional I<filter> is provided, the stats will only be calculated
1035 on those calls that match that filter.
1037 Example: B<-z "h225,srt,ip.addr==1.2.3.4"> will only collect stats for
1038 ITU-T H.225 RAS packets exchanged by the host at IP address 1.2.3.4 .
1040 =item B<-z> hosts[,ipv4][,ipv6]
1042 Dump any collected IPv4 and/or IPv6 addresses in "hosts" format. Both IPv4
1043 and IPv6 addresses are dumped by default.
1045 Addresses are collected from a number of sources, including standard "hosts"
1046 files and captured traffic.
1048 =item B<-z> http,stat,
1050 Calculate the HTTP statistics distribution. Displayed values are
1051 the HTTP status codes and the HTTP request methods.
1053 =item B<-z> http,tree
1055 Calculate the HTTP packet distribution. Displayed values are the
1056 HTTP request modes and the HTTP status codes.
1058 =item B<-z> http_req,tree
1060 Calculate the HTTP requests by server. Displayed values are the
1061 server name and the URI path.
1063 =item B<-z> http_srv,tree
1065 Calculate the HTTP requests and responses by server. For the HTTP
1066 requests, displayed values are the server IP address and server
1067 hostname. For the HTTP responses, displayed values are the server
1068 IP address and status.
1070 =item B<-z> icmp,srt[,I<filter>]
1072 Compute total ICMP echo requests, replies, loss, and percent loss, as well as
1073 minimum, maximum, mean, median and sample standard deviation SRT statistics
1074 typical of what ping provides.
1076 Example: S<B<-z icmp,srt,ip.src==1.2.3.4>> will collect ICMP SRT statistics
1077 for ICMP echo request packets originating from a specific host.
1079 This option can be used multiple times on the command line.
1081 =item B<-z> icmpv6,srt[,I<filter>]
1083 Compute total ICMPv6 echo requests, replies, loss, and percent loss, as well as
1084 minimum, maximum, mean, median and sample standard deviation SRT statistics
1085 typical of what ping provides.
1087 Example: S<B<-z icmpv6,srt,ipv6.src==fe80::1>> will collect ICMPv6 SRT statistics
1088 for ICMPv6 echo request packets originating from a specific host.
1090 This option can be used multiple times on the command line.
1092 =item B<-z> io,phs[,I<filter>]
1094 Create Protocol Hierarchy Statistics listing both number of packets and bytes.
1095 If no I<filter> is specified the statistics will be calculated for all packets.
1096 If a I<filter> is specified statistics will only be calculated for those
1097 packets that match the filter.
1099 This option can be used multiple times on the command line.
1101 =item B<-z> io,stat,I<interval>[,I<filter>][,I<filter>][,I<filter>]...
1103 Collect packet/bytes statistics for the capture in intervals of
1104 I<interval> seconds. I<Interval> can be specified either as a whole or
1105 fractional second and can be specified with microsecond (us) resolution.
1106 If I<interval> is 0, the statistics will be calculated over all packets.
1108 If no I<filter> is specified the statistics will be calculated for all packets.
1109 If one or more I<filters> are specified statistics will be calculated for
1110 all filters and presented with one column of statistics for each filter.
1112 This option can be used multiple times on the command line.
1114 Example: B<-z io,stat,1,ip.addr==1.2.3.4> will generate 1 second
1115 statistics for all traffic to/from host 1.2.3.4.
1117 Example: B<-z "io,stat,0.001,smb&&ip.addr==1.2.3.4"> will generate 1ms
1118 statistics for all SMB packets to/from host 1.2.3.4.
1120 The examples above all use the standard syntax for generating statistics
1121 which only calculates the number of packets and bytes in each interval.
1123 B<io,stat> can also do much more statistics and calculate COUNT(), SUM(),
1124 MIN(), MAX(), AVG() and LOAD() using a slightly different filter syntax:
1126 =item -z io,stat,I<interval>,E<34>[COUNT|SUM|MIN|MAX|AVG|LOAD](I<field>)I<filter>E<34>
1128 NOTE: One important thing to note here is that the filter is not optional
1129 and that the field that the calculation is based on MUST be part of the filter
1130 string or the calculation will fail.
1132 So: B<-z io,stat,0.010,AVG(smb.time)> does not work. Use B<-z
1133 io,stat,0.010,AVG(smb.time)smb.time> instead. Also be aware that a field
1134 can exist multiple times inside the same packet and will then be counted
1135 multiple times in those packets.
1137 NOTE: A second important thing to note is that the system setting for
1138 decimal separator must be set to "."! If it is set to "," the statistics
1139 will not be displayed per filter.
1141 B<COUNT(I<field>)I<filter>> - Calculates the number of times that the
1142 field I<name> (not its value) appears per interval in the filtered packet list.
1143 ''I<field>'' can be any display filter name.
1145 Example: B<-z io,stat,0.010,E<34>COUNT(smb.sid)smb.sidE<34>>
1147 This will count the total number of SIDs seen in each 10ms interval.
1149 B<SUM(I<field>)I<filter>> - Unlike COUNT, the I<values> of the
1150 specified field are summed per time interval.
1151 ''I<field>'' can only be a named integer, float, double or relative time field.
1153 Example: B<-z io,stat,0.010,E<34>SUM(frame.len)frame.lenE<34>>
1155 Reports the total number of bytes that were transmitted bidirectionally in
1156 all the packets within a 10 millisecond interval.
1158 B<MIN/MAX/AVG(I<field>)I<filter>> - The minimum, maximum, or average field value
1159 in each interval is calculated. The specified field must be a named integer,
1160 float, double or relative time field. For relative time fields, the output is presented in
1161 seconds with six decimal digits of precision rounded to the nearest microsecond.
1163 In the following example, the time of the first Read_AndX call, the last Read_AndX
1164 response values are displayed and the minimum, maximum, and average Read response times
1165 (SRTs) are calculated. NOTE: If the DOS command shell line continuation character, ''^''
1166 is used, each line cannot end in a comma so it is placed at the beginning of each
1169 tshark -o tcp.desegment_tcp_streams:FALSE -n -q -r smb_reads.cap -z io,stat,0,
1170 "MIN(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==0",
1171 "MAX(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==1",
1172 "MIN(smb.time)smb.time and smb.cmd==0x2e",
1173 "MAX(smb.time)smb.time and smb.cmd==0x2e",
1174 "AVG(smb.time)smb.time and smb.cmd==0x2e"
1177 ======================================================================================================
1179 Column #0: MIN(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==0
1180 Column #1: MAX(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==1
1181 Column #2: MIN(smb.time)smb.time and smb.cmd==0x2e
1182 Column #3: MAX(smb.time)smb.time and smb.cmd==0x2e
1183 Column #4: AVG(smb.time)smb.time and smb.cmd==0x2e
1184 | Column #0 | Column #1 | Column #2 | Column #3 | Column #4 |
1185 Time | MIN | MAX | MIN | MAX | AVG |
1186 000.000- 0.000000 7.704054 0.000072 0.005539 0.000295
1187 ======================================================================================================
1189 The following command displays the average SMB Read response PDU size, the
1190 total number of read PDU bytes, the average SMB Write request PDU size, and
1191 the total number of bytes transferred in SMB Write PDUs:
1193 tshark -n -q -r smb_reads_writes.cap -z io,stat,0,
1194 "AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to",
1195 "SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to",
1196 "AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to",
1197 "SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to"
1199 =====================================================================================
1201 Column #0: AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to
1202 Column #1: SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to
1203 Column #2: AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to
1204 Column #3: SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to
1205 | Column #0 | Column #1 | Column #2 | Column #3 |
1206 Time | AVG | SUM | AVG | SUM |
1207 000.000- 30018 28067522 72 3240
1208 =====================================================================================
1210 B<LOAD(I<field>)I<filter>> - The LOAD/Queue-Depth
1211 in each interval is calculated. The specified field must be a relative time field that represents a response time. For example smb.time.
1212 For each interval the Queue-Depth for the specified protocol is calculated.
1214 The following command displays the average SMB LOAD.
1215 A value of 1.0 represents one I/O in flight.
1217 tshark -n -q -r smb_reads_writes.cap
1218 -z "io,stat,0.001,LOAD(smb.time)smb.time"
1220 ============================================================================
1222 Interval: 0.001000 secs
1223 Column #0: LOAD(smb.time)smb.time
1226 0000.000000-0000.001000 1.000000
1227 0000.001000-0000.002000 0.741000
1228 0000.002000-0000.003000 0.000000
1229 0000.003000-0000.004000 1.000000
1233 B<FRAMES | BYTES[()I<filter>]> - Displays the total number of frames or bytes.
1234 The filter field is optional but if included it must be prepended with ''()''.
1236 The following command displays five columns: the total number of frames and bytes
1237 (transferred bidirectionally) using a single comma, the same two stats using the FRAMES and BYTES
1238 subcommands, the total number of frames containing at least one SMB Read response, and
1239 the total number of bytes transmitted to the client (unidirectionally) at IP address 10.1.0.64.
1241 tshark -o tcp.desegment_tcp_streams:FALSE -n -q -r smb_reads.cap -z io,stat,0,,FRAMES,BYTES,
1242 "FRAMES()smb.cmd==0x2e and smb.response_to","BYTES()ip.dst==10.1.0.64"
1244 =======================================================================================================================
1249 Column #3: FRAMES()smb.cmd==0x2e and smb.response_to
1250 Column #4: BYTES()ip.dst==10.1.0.64
1251 | Column #0 | Column #1 | Column #2 | Column #3 | Column #4 |
1252 Time | Frames | Bytes | FRAMES | BYTES | FRAMES | BYTES |
1253 000.000- 33576 29721685 33576 29721685 870 29004801
1254 =======================================================================================================================
1256 =item B<-z> mac-lte,stat[I<,filter>]
1258 This option will activate a counter for LTE MAC messages. You will get
1259 information about the maximum number of UEs/TTI, common messages and
1260 various counters for each UE that appears in the log.
1262 Example: B<-z mac-lte,stat>.
1264 This option can be used multiple times on the command line.
1266 If the optional I<filter> is provided, the stats will only be calculated
1267 for those frames that match that filter.
1268 Example: B<-z "mac-lte,stat,mac-lte.rnti>3000"> will only collect stats for
1269 UEs with an assigned RNTI whose value is more than 3000.
1271 =item B<-z> megaco,rtd[I<,filter>]
1273 Collect requests/response RTD (Response Time Delay) data for MEGACO.
1274 (This is similar to B<-z smb,srt>). Data collected is the number of calls
1275 for each known MEGACO Type, MinRTD, MaxRTD and AvgRTD.
1276 Additionally you get the number of duplicate requests/responses,
1277 unresponded requests, responses, which don't match with any request.
1278 Example: B<-z megaco,rtd>.
1280 If the optional I<filter> is provided, the stats will only be calculated
1281 on those calls that match that filter.
1282 Example: B<-z "megaco,rtd,ip.addr==1.2.3.4"> will only collect stats for
1283 MEGACO packets exchanged by the host at IP address 1.2.3.4 .
1285 This option can be used multiple times on the command line.
1287 =item B<-z> mgcp,rtd[I<,filter>]
1289 Collect requests/response RTD (Response Time Delay) data for MGCP.
1290 (This is similar to B<-z smb,srt>). Data collected is the number of calls
1291 for each known MGCP Type, MinRTD, MaxRTD and AvgRTD.
1292 Additionally you get the number of duplicate requests/responses,
1293 unresponded requests, responses, which don't match with any request.
1294 Example: B<-z mgcp,rtd>.
1296 This option can be used multiple times on the command line.
1298 If the optional I<filter> is provided, the stats will only be calculated
1299 on those calls that match that filter.
1300 Example: B<-z "mgcp,rtd,ip.addr==1.2.3.4"> will only collect stats for
1301 MGCP packets exchanged by the host at IP address 1.2.3.4 .
1303 =item B<-z> proto,colinfo,I<filter>,I<field>
1305 Append all I<field> values for the packet to the Info column of the
1306 one-line summary output.
1307 This feature can be used to append arbitrary fields to the Info column
1308 in addition to the normal content of that column.
1309 I<field> is the display-filter name of a field which value should be placed
1311 I<filter> is a filter string that controls for which packets the field value
1312 will be presented in the info column. I<field> will only be presented in the
1313 Info column for the packets which match I<filter>.
1315 NOTE: In order for B<TShark> to be able to extract the I<field> value
1316 from the packet, I<field> MUST be part of the I<filter> string. If not,
1317 B<TShark> will not be able to extract its value.
1319 For a simple example to add the "nfs.fh.hash" field to the Info column
1320 for all packets containing the "nfs.fh.hash" field, use
1322 B<-z proto,colinfo,nfs.fh.hash,nfs.fh.hash>
1324 To put "nfs.fh.hash" in the Info column but only for packets coming from
1327 B<-z "proto,colinfo,nfs.fh.hash && ip.src==1.2.3.4,nfs.fh.hash">
1329 This option can be used multiple times on the command line.
1331 =item B<-z> rlc-lte,stat[I<,filter>]
1333 This option will activate a counter for LTE RLC messages. You will get
1334 information about common messages and various counters for each UE that appears
1337 Example: B<-z rlc-lte,stat>.
1339 This option can be used multiple times on the command line.
1341 If the optional I<filter> is provided, the stats will only be calculated
1342 for those frames that match that filter.
1343 Example: B<-z "rlc-lte,stat,rlc-lte.ueid>3000"> will only collect stats for
1344 UEs with a UEId of more than 3000.
1346 =item B<-z> rpc,programs
1348 Collect call/reply SRT data for all known ONC-RPC programs/versions.
1349 Data collected is number of calls for each protocol/version, MinSRT,
1351 This option can only be used once on the command line.
1353 =item B<-z> rpc,srt,I<program>,I<version>[,I<filter>]
1355 Collect call/reply SRT (Service Response Time) data for I<program>/I<version>.
1356 Data collected is the number of calls for each procedure, MinSRT, MaxSRT,
1357 AvgSRT, and the total time taken for each procedure.
1360 Example: B<-z rpc,srt,100003,3> will collect data for NFS v3.
1362 This option can be used multiple times on the command line.
1364 If the optional I<filter> is provided, the stats will only be calculated
1365 on those calls that match that filter.
1367 Example: B<-z rpc,srt,100003,3,nfs.fh.hash==0x12345678> will collect NFS v3
1368 SRT statistics for a specific file.
1370 =item B<-z> rtp,streams
1372 Collect statistics for all RTP streams and calculate max. delta, max. and
1373 mean jitter and packet loss percentages.
1375 =item B<-z> scsi,srt,I<cmdset>[,I<filter>]
1377 Collect call/reply SRT (Service Response Time) data for SCSI commandset I<cmdset>.
1379 Commandsets are 0:SBC 1:SSC 5:MMC
1382 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
1384 Example: B<-z scsi,srt,0> will collect data for SCSI BLOCK COMMANDS (SBC).
1386 This option can be used multiple times on the command line.
1388 If the optional I<filter> is provided, the stats will only be calculated
1389 on those calls that match that filter.
1391 Example: B<-z scsi,srt,0,ip.addr==1.2.3.4> will collect SCSI SBC
1392 SRT statistics for a specific iscsi/ifcp/fcip host.
1394 =item B<-z> sip,stat[I<,filter>]
1396 This option will activate a counter for SIP messages. You will get the number
1397 of occurrences of each SIP Method and of each SIP Status-Code. Additionally
1398 you also get the number of resent SIP Messages (only for SIP over UDP).
1400 Example: B<-z sip,stat>.
1402 This option can be used multiple times on the command line.
1404 If the optional I<filter> is provided, the stats will only be calculated
1405 on those calls that match that filter.
1406 Example: B<-z "sip,stat,ip.addr==1.2.3.4"> will only collect stats for
1407 SIP packets exchanged by the host at IP address 1.2.3.4 .
1409 =item B<-z> smb,sids
1411 When this feature is used B<TShark> will print a report with all the
1412 discovered SID and account name mappings. Only those SIDs where the
1413 account name is known will be presented in the table.
1415 For this feature to work you will need to either to enable
1416 "Edit/Preferences/Protocols/SMB/Snoop SID to name mappings" in the
1417 preferences or you can override the preferences by specifying
1418 S<B<-o "smb.sid_name_snooping:TRUE">> on the B<TShark> command line.
1420 The current method used by B<TShark> to find the SID->name mapping
1421 is relatively restricted with a hope of future expansion.
1423 =item B<-z> smb,srt[,I<filter>]
1425 Collect call/reply SRT (Service Response Time) data for SMB. Data collected
1426 is number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
1428 Example: B<-z smb,srt>
1430 The data will be presented as separate tables for all normal SMB commands,
1431 all Transaction2 commands and all NT Transaction commands.
1432 Only those commands that are seen in the capture will have its stats
1434 Only the first command in a xAndX command chain will be used in the
1435 calculation. So for common SessionSetupAndX + TreeConnectAndX chains,
1436 only the SessionSetupAndX call will be used in the statistics.
1437 This is a flaw that might be fixed in the future.
1439 This option can be used multiple times on the command line.
1441 If the optional I<filter> is provided, the stats will only be calculated
1442 on those calls that match that filter.
1444 Example: B<-z "smb,srt,ip.addr==1.2.3.4"> will only collect stats for
1445 SMB packets exchanged by the host at IP address 1.2.3.4 .
1447 =item --capture-comment E<lt>commentE<gt>
1449 Add a capture comment to the output file.
1451 This option is only available if a new output file in pcapng format is
1452 created. Only one capture comment may be set per output file.
1458 =head1 CAPTURE FILTER SYNTAX
1460 See the manual page of pcap-filter(7) or, if that doesn't exist, tcpdump(8),
1461 or, if that doesn't exist, L<http://wiki.wireshark.org/CaptureFilters>.
1463 =head1 READ FILTER SYNTAX
1465 For a complete table of protocol and protocol fields that are filterable
1466 in B<TShark> see the wireshark-filter(4) manual page.
1470 These files contains various B<Wireshark> configuration values.
1476 The F<preferences> files contain global (system-wide) and personal
1477 preference settings. If the system-wide preference file exists, it is
1478 read first, overriding the default settings. If the personal preferences
1479 file exists, it is read next, overriding any previous values. Note: If
1480 the command line option B<-o> is used (possibly more than once), it will
1481 in turn override values from the preferences files.
1483 The preferences settings are in the form I<prefname>B<:>I<value>,
1485 where I<prefname> is the name of the preference
1486 and I<value> is the value to
1487 which it should be set; white space is allowed between B<:> and
1488 I<value>. A preference setting can be continued on subsequent lines by
1489 indenting the continuation lines with white space. A B<#> character
1490 starts a comment that runs to the end of the line:
1492 # Capture in promiscuous mode?
1493 # TRUE or FALSE (case-insensitive).
1494 capture.prom_mode: TRUE
1496 The global preferences file is looked for in the F<wireshark> directory
1497 under the F<share> subdirectory of the main installation directory (for
1498 example, F</usr/local/share/wireshark/preferences>) on UNIX-compatible
1499 systems, and in the main installation directory (for example,
1500 F<C:\Program Files\Wireshark\preferences>) on Windows systems.
1502 The personal preferences file is looked for in
1503 F<$HOME/.wireshark/preferences> on
1504 UNIX-compatible systems and F<%APPDATA%\Wireshark\preferences> (or, if
1505 %APPDATA% isn't defined, F<%USERPROFILE%\Application
1506 Data\Wireshark\preferences>) on Windows systems.
1508 =item Disabled (Enabled) Protocols
1510 The F<disabled_protos> files contain system-wide and personal lists of
1511 protocols that have been disabled, so that their dissectors are never
1512 called. The files contain protocol names, one per line, where the
1513 protocol name is the same name that would be used in a display filter
1519 The global F<disabled_protos> file uses the same directory as the global
1522 The personal F<disabled_protos> file uses the same directory as the
1523 personal preferences file.
1525 =item Name Resolution (hosts)
1527 If the personal F<hosts> file exists, it is
1528 used to resolve IPv4 and IPv6 addresses before any other
1529 attempts are made to resolve them. The file has the standard F<hosts>
1530 file syntax; each line contains one IP address and name, separated by
1531 whitespace. The same directory as for the personal preferences file is
1534 Capture filter name resolution is handled by libpcap on UNIX-compatible
1535 systems and WinPcap on Windows. As such the Wireshark personal F<hosts> file
1536 will not be consulted for capture filter name resolution.
1538 =item Name Resolution (ethers)
1540 The F<ethers> files are consulted to correlate 6-byte hardware addresses to
1541 names. First the personal F<ethers> file is tried and if an address is not
1542 found there the global F<ethers> file is tried next.
1544 Each line contains one hardware address and name, separated by
1545 whitespace. The digits of the hardware address are separated by colons
1546 (:), dashes (-) or periods (.). The same separator character must be
1547 used consistently in an address. The following three lines are valid
1548 lines of an F<ethers> file:
1550 ff:ff:ff:ff:ff:ff Broadcast
1551 c0-00-ff-ff-ff-ff TR_broadcast
1552 00.00.00.00.00.00 Zero_broadcast
1554 The global F<ethers> file is looked for in the F</etc> directory on
1555 UNIX-compatible systems, and in the main installation directory (for
1556 example, F<C:\Program Files\Wireshark>) on Windows systems.
1558 The personal F<ethers> file is looked for in the same directory as the personal
1561 Capture filter name resolution is handled by libpcap on UNIX-compatible
1562 systems and WinPcap on Windows. As such the Wireshark personal F<ethers> file
1563 will not be consulted for capture filter name resolution.
1565 =item Name Resolution (manuf)
1567 The F<manuf> file is used to match the 3-byte vendor portion of a 6-byte
1568 hardware address with the manufacturer's name; it can also contain well-known
1569 MAC addresses and address ranges specified with a netmask. The format of the
1570 file is the same as the F<ethers> files, except that entries of the form:
1574 can be provided, with the 3-byte OUI and the name for a vendor, and
1577 00-00-0C-07-AC/40 All-HSRP-routers
1579 can be specified, with a MAC address and a mask indicating how many bits
1580 of the address must match. The above entry, for example, has 40
1581 significant bits, or 5 bytes, and would match addresses from
1582 00-00-0C-07-AC-00 through 00-00-0C-07-AC-FF. The mask need not be a
1585 The F<manuf> file is looked for in the same directory as the global
1588 =item Name Resolution (ipxnets)
1590 The F<ipxnets> files are used to correlate 4-byte IPX network numbers to
1591 names. First the global F<ipxnets> file is tried and if that address is not
1592 found there the personal one is tried next.
1594 The format is the same as the F<ethers>
1595 file, except that each address is four bytes instead of six.
1596 Additionally, the address can be represented as a single hexadecimal
1597 number, as is more common in the IPX world, rather than four hex octets.
1598 For example, these four lines are valid lines of an F<ipxnets> file:
1602 00:00:BE:EF IT_Server1
1605 The global F<ipxnets> file is looked for in the F</etc> directory on
1606 UNIX-compatible systems, and in the main installation directory (for
1607 example, F<C:\Program Files\Wireshark>) on Windows systems.
1609 The personal F<ipxnets> file is looked for in the same directory as the
1610 personal preferences file.
1614 =head1 ENVIRONMENT VARIABLES
1618 =item WIRESHARK_APPDATA
1620 On Windows, Wireshark normally stores all application data in %APPDATA% or
1621 %USERPROFILE%. You can override the default location by exporting this
1622 environment variable to specify an alternate location.
1624 =item WIRESHARK_DEBUG_EP_NO_CHUNKS
1626 Normally per-packet memory is allocated in large "chunks." This behavior
1627 doesn't work well with debugging tools such as Valgrind or ElectricFence.
1628 Export this environment variable to force individual allocations.
1629 Note: disabling chunks also disables canaries (see below).
1631 =item WIRESHARK_DEBUG_SE_NO_CHUNKS
1633 Normally per-file memory is allocated in large "chunks." This behavior
1634 doesn't work well with debugging tools such as Valgrind or ElectricFence.
1635 Export this environment variable to force individual allocations.
1636 Note: disabling chunks also disables canaries (see below).
1638 =item WIRESHARK_DEBUG_EP_NO_CANARY
1640 Normally per-packet memory allocations are separated by "canaries" which
1641 allow detection of memory overruns. This comes at the expense of some extra
1642 memory usage. Exporting this environment variable disables these canaries.
1644 =item WIRESHARK_DEBUG_SE_USE_CANARY
1646 Exporting this environment variable causes per-file memory allocations to be
1647 protected with "canaries" which allow for detection of memory overruns.
1648 This comes at the expense of significant extra memory usage.
1650 =item WIRESHARK_DEBUG_SCRUB_MEMORY
1652 If this environment variable is set, the contents of per-packet and
1653 per-file memory is initialized to 0xBADDCAFE when the memory is allocated
1654 and is reset to 0xDEADBEEF when the memory is freed. This functionality is
1655 useful mainly to developers looking for bugs in the way memory is handled.
1657 =item WIRESHARK_DEBUG_WMEM_OVERRIDE
1659 Setting this environment variable forces the wmem framework to use the
1660 specified allocator backend for *all* allocations, regardless of which
1661 backend is normally specified by the code. This is mainly useful to developers
1662 when testing or debugging. See I<README.wmem> in the source distribution for
1665 =item WIRESHARK_RUN_FROM_BUILD_DIRECTORY
1667 This environment variable causes the plugins and other data files to be loaded
1668 from the build directory (where the program was compiled) rather than from the
1669 standard locations. It has no effect when the program in question is running
1670 with root (or setuid) permissions on *NIX.
1672 =item WIRESHARK_DATA_DIR
1674 This environment variable causes the various data files to be loaded from
1675 a directory other than the standard locations. It has no effect when the
1676 program in question is running with root (or setuid) permissions on *NIX.
1678 =item WIRESHARK_PYTHON_DIR
1680 This environment variable points to an alternate location for Python.
1681 It has no effect when the program in question is running with root (or setuid)
1682 permissions on *NIX.
1684 =item ERF_RECORDS_TO_CHECK
1686 This environment variable controls the number of ERF records checked when
1687 deciding if a file really is in the ERF format. Setting this environment
1688 variable a number higher than the default (20) would make false positives
1691 =item IPFIX_RECORDS_TO_CHECK
1693 This environment variable controls the number of IPFIX records checked when
1694 deciding if a file really is in the IPFIX format. Setting this environment
1695 variable a number higher than the default (20) would make false positives
1698 =item WIRESHARK_ABORT_ON_DISSECTOR_BUG
1700 If this environment variable is set, B<TShark> will call abort(3)
1701 when a dissector bug is encountered. abort(3) will cause the program to
1702 exit abnormally; if you are running B<TShark> in a debugger, it
1703 should halt in the debugger and allow inspection of the process, and, if
1704 you are not running it in a debugger, it will, on some OSes, assuming
1705 your environment is configured correctly, generate a core dump file.
1706 This can be useful to developers attempting to troubleshoot a problem
1707 with a protocol dissector.
1709 =item WIRESHARK_ABORT_ON_TOO_MANY_ITEMS
1711 If this environment variable is set, B<TShark> will call abort(3)
1712 if a dissector tries to add too many items to a tree (generally this
1713 is an indication of the dissector not breaking out of a loop soon enough).
1714 abort(3) will cause the program to exit abnormally; if you are running
1715 B<TShark> in a debugger, it should halt in the debugger and allow
1716 inspection of the process, and, if you are not running it in a debugger,
1717 it will, on some OSes, assuming your environment is configured correctly,
1718 generate a core dump file. This can be useful to developers attempting to
1719 troubleshoot a problem with a protocol dissector.
1721 =item WIRESHARK_EP_VERIFY_POINTERS
1723 This environment variable, if present, causes certain uses of pointers to be
1724 audited to ensure they do not point to memory that is deallocated after each
1725 packet has been fully dissected. This can be useful to developers writing or
1728 =item WIRESHARK_SE_VERIFY_POINTERS
1730 This environment variable, if present, causes certain uses of pointers to be
1731 audited to ensure they do not point to memory that is deallocated after when
1732 a capture file is closed. This can be useful to developers writing or
1735 =item WIRESHARK_ABORT_ON_OUT_OF_MEMORY
1737 This environment variable, if present, causes abort(3) to be called if certain
1738 out-of-memory conditions (which normally result in an exception and an
1739 explanatory error message) are experienced. This can be useful to developers
1740 debugging out-of-memory conditions.
1746 wireshark-filter(4), wireshark(1), editcap(1), pcap(3), dumpcap(1),
1747 text2pcap(1), mergecap(1), pcap-filter(7) or tcpdump(8)
1751 B<TShark> is part of the B<Wireshark> distribution. The latest version
1752 of B<Wireshark> can be found at L<http://www.wireshark.org>.
1754 HTML versions of the Wireshark project man pages are available at:
1755 L<http://www.wireshark.org/docs/man-pages>.
1759 B<TShark> uses the same packet dissection code that B<Wireshark> does,
1760 as well as using many other modules from B<Wireshark>; see the list of
1761 authors in the B<Wireshark> man page for a list of authors of that code.