4 tshark - Dump and analyze network traffic
9 S<[ B<-a> E<lt>capture autostop conditionE<gt> ] ...>
10 S<[ B<-b> E<lt>capture ring buffer optionE<gt>] ...>
11 S<[ B<-B> E<lt>capture buffer sizeE<gt> ] >
12 S<[ B<-c> E<lt>capture packet countE<gt> ]>
13 S<[ B<-C> E<lt>configuration profileE<gt> ]>
14 S<[ B<-d> E<lt>layer typeE<gt>==E<lt>selectorE<gt>,E<lt>decode-as protocolE<gt> ]>
16 S<[ B<-e> E<lt>fieldE<gt> ]>
17 S<[ B<-E> E<lt>field print optionE<gt> ]>
18 S<[ B<-f> E<lt>capture filterE<gt> ]>
19 S<[ B<-F> E<lt>file formatE<gt> ]>
21 S<[ B<-i> E<lt>capture interfaceE<gt>|- ]>
23 S<[ B<-K> E<lt>keytabE<gt> ]>
27 S<[ B<-N> E<lt>name resolving flagsE<gt> ]>
28 S<[ B<-o> E<lt>preference settingE<gt> ] ...>
31 S<[ B<-r> E<lt>infileE<gt> ]>
32 S<[ B<-R> E<lt>read (display) filterE<gt> ]>
33 S<[ B<-s> E<lt>capture snaplenE<gt> ]>
35 S<[ B<-t> ad|a|r|d|dd|e ]>
36 S<[ B<-T> pdml|psml|ps|text|fields ]>
39 S<[ B<-w> E<lt>outfileE<gt>|- ]>
41 S<[ B<-X> E<lt>eXtension optionE<gt>]>
42 S<[ B<-y> E<lt>capture link typeE<gt> ]>
43 S<[ B<-z> E<lt>statisticsE<gt> ]>
44 S<[ E<lt>capture filterE<gt> ]>
47 B<-G> [fields|fields2|fields3|protocols|values|decodes|defaultprefs|currentprefs]
51 B<TShark> is a network protocol analyzer. It lets you capture packet
52 data from a live network, or read packets from a previously saved
53 capture file, either printing a decoded form of those packets to the
54 standard output or writing the packets to a file. B<TShark>'s native
55 capture file format is B<libpcap> format, which is also the format used
56 by B<tcpdump> and various other tools.
58 Without any options set, B<TShark> will work much like B<tcpdump>. It will
59 use the pcap library to capture traffic from the first available network
60 interface and displays a summary line on stdout for each received packet.
62 B<TShark> is able to detect, read and write the same capture files that
63 are supported by B<Wireshark>.
64 The input file doesn't need a specific filename extension; the file
65 format and an optional gzip compression will be automatically detected.
66 Near the beginning of the DESCRIPTION section of wireshark(1) or
67 L<http://www.wireshark.org/docs/man-pages/wireshark.html>
68 is a detailed description of the way B<Wireshark> handles this, which is
69 the same way B<Tshark> handles this.
71 Compressed file support uses (and therefore requires) the zlib library.
72 If the zlib library is not present, B<TShark> will compile, but will
73 be unable to read compressed files.
75 If the B<-w> option is not specified, B<TShark> writes to the standard
76 output the text of a decoded form of the packets it captures or reads.
77 If the B<-w> option is specified, B<TShark> writes to the file
78 specified by that option the raw data of the packets, along with the
81 When writing a decoded form of packets, B<TShark> writes, by
82 default, a summary line containing the fields specified by the
83 preferences file (which are also the fields displayed in the packet list
84 pane in B<Wireshark>), although if it's writing packets as it captures
85 them, rather than writing packets from a saved capture file, it won't
86 show the "frame number" field. If the B<-V> option is specified, it
87 writes instead a view of the details of the packet, showing all the
88 fields of all protocols in the packet.
90 If you want to write the decoded form of packets to a file, run
91 B<TShark> without the B<-w> option, and redirect its standard output to
92 the file (do I<not> use the B<-w> option).
94 When writing packets to a file, B<TShark>, by default, writes the
95 file in B<libpcap> format, and writes all of the packets it sees to the
96 output file. The B<-F> option can be used to specify the format in which
97 to write the file. This list of available file formats is displayed by
98 the B<-F> flag without a value. However, you can't specify a file format
101 Read filters in B<TShark>, which allow you to select which packets
102 are to be decoded or written to a file, are very powerful; more fields
103 are filterable in B<TShark> than in other protocol analyzers, and the
104 syntax you can use to create your filters is richer. As B<TShark>
105 progresses, expect more and more protocol fields to be allowed in read
108 Packet capturing is performed with the pcap library. The capture filter
109 syntax follows the rules of the pcap library. This syntax is different
110 from the read filter syntax. A read filter can also be specified when
111 capturing, and only packets that pass the read filter will be displayed
112 or saved to the output file; note, however, that capture filters are much
113 more efficient than read filters, and it may be more difficult for
114 B<TShark> to keep up with a busy network if a read filter is
115 specified for a live capture.
117 A capture or read filter can either be specified with the B<-f> or B<-R>
118 option, respectively, in which case the entire filter expression must be
119 specified as a single argument (which means that if it contains spaces,
120 it must be quoted), or can be specified with command-line arguments
121 after the option arguments, in which case all the arguments after the
122 filter arguments are treated as a filter expression. Capture filters
123 are supported only when doing a live capture; read filters are supported
124 when doing a live capture and when reading a capture file, but require
125 TShark to do more work when filtering, so you might be more likely to
126 lose packets under heavy load if you're using a read filter. If the
127 filter is specified with command-line arguments after the option
128 arguments, it's a capture filter if a capture is being done (i.e., if no
129 B<-r> option was specified) and a read filter if a capture file is being
130 read (i.e., if a B<-r> option was specified).
132 The B<-G> option is a special mode that simply causes B<Tshark>
133 to dump one of several types of internal glossaries and then exit.
139 =item -a E<lt>capture autostop conditionE<gt>
141 Specify a criterion that specifies when B<TShark> is to stop writing
142 to a capture file. The criterion is of the form I<test>B<:>I<value>,
143 where I<test> is one of:
145 B<duration>:I<value> Stop writing to a capture file after I<value> seconds
148 B<filesize>:I<value> Stop writing to a capture file after it reaches a size of
149 I<value> kilobytes (where a kilobyte is 1024 bytes). If this option is used
150 together with the -b option, B<TShark> will stop writing to the current
151 capture file and switch to the next one if filesize is reached. When reading a
152 capture file, B<TShark> will stop reading the file after the number of bytes
153 read exceeds this number (the complete packet will be read, so more bytes than
154 this number may be read).
156 B<files>:I<value> Stop writing to capture files after I<value> number of files
159 =item -b E<lt>capture ring buffer optionE<gt>
161 Cause B<TShark> to run in "multiple files" mode. In "multiple files" mode,
162 B<TShark> will write to several capture files. When the first capture file
163 fills up, B<TShark> will switch writing to the next file and so on.
165 The created filenames are based on the filename given with the B<-w> option,
166 the number of the file and on the creation date and time,
167 e.g. outfile_00001_20050604120117.pcap, outfile_00002_20050604120523.pcap, ...
169 With the I<files> option it's also possible to form a "ring buffer".
170 This will fill up new files until the number of files specified,
171 at which point B<TShark> will discard the data in the first file and start
172 writing to that file and so on. If the I<files> option is not set,
173 new files filled up until one of the capture stop conditions match (or
174 until the disk is full).
176 The criterion is of the form I<key>B<:>I<value>,
177 where I<key> is one of:
179 B<duration>:I<value> switch to the next file after I<value> seconds have
180 elapsed, even if the current file is not completely filled up.
182 B<filesize>:I<value> switch to the next file after it reaches a size of
183 I<value> kilobytes (where a kilobyte is 1024 bytes).
185 B<files>:I<value> begin again with the first file after I<value> number of
186 files were written (form a ring buffer). This value must be less than 100000.
187 Caution should be used when using large numbers of files: some filesystems do
188 not handle many files in a single directory well. The B<files> criterion
189 requires either B<duration> or B<filesize> to be specified to control when to
190 go to the next file. It should be noted that each B<-b> parameter takes exactly
191 one criterion; to specify two criterion, each must be preceded by the B<-b>
194 Example: B<-b filesize:1024 -b files:5> results in a ring buffer of five files
195 of size one megabyte.
197 =item -B E<lt>capture buffer sizeE<gt>
199 Set capture buffer size (in MB, default is 1MB). This is used by the
200 the capture driver to buffer packet data until that data can be written
201 to disk. If you encounter packet drops while capturing, try to increase
202 this size. Note that, while B<Tshark> attempts to set the buffer size
203 to 1MB by default, and can be told to set it to a larger value, the
204 system or interface on which you're capturing might silently limit the
205 capture buffer size to a lower value or raise it to a higher value.
207 This is available on UNIX systems with libpcap 1.0.0 or later and on
208 Windows. It is not available on UNIX systems with earlier versions of
211 =item -c E<lt>capture packet countE<gt>
213 Set the maximum number of packets to read when capturing live
214 data. If reading a capture file, set the maximum number of packets to read.
216 =item -C E<lt>configuration profileE<gt>
218 Run with the given configuration profile.
220 =item -d E<lt>layer typeE<gt>==E<lt>selectorE<gt>,E<lt>decode-as protocolE<gt>
222 Like Wireshark's B<Decode As...> feature, this lets you specify how a
223 layer type should be dissected. If the layer type in question (for example,
224 B<tcp.port> or B<udp.port> for a TCP or UDP port number) has the specified
225 selector value, packets should be dissected as the specified protocol.
227 Example: B<-d tcp.port==8888,http> will decode any traffic running over
228 TCP port 8888 as HTTP.
230 Using an invalid selector or protocol will print out a list of valid selectors
231 and protocol names, respectively.
233 Example: B<-d .> is a quick way to get a list of valid selectors.
235 Example: B<-d ethertype==0x0800.> is a quick way to get a list of protocols that can be
236 selected with an ethertype.
240 Print a list of the interfaces on which B<TShark> can capture, and
241 exit. For each network interface, a number and an
242 interface name, possibly followed by a text description of the
243 interface, is printed. The interface name or the number can be supplied
244 to the B<-i> option to specify an interface on which to capture.
246 This can be useful on systems that don't have a command to list them
247 (e.g., Windows systems, or UNIX systems lacking B<ifconfig -a>);
248 the number can be useful on Windows 2000 and later systems, where the
249 interface name is a somewhat complex string.
251 Note that "can capture" means that B<TShark> was able to open that
252 device to do a live capture. Depending on your system you may need to
253 run tshark from an account with special privileges (for example, as
254 root) to be able to capture network traffic. If B<TShark -D> is not run
255 from such an account, it will not list any interfaces.
257 =item -e E<lt>fieldE<gt>
259 Add a field to the list of fields to display if B<-T fields> is
260 selected. This option can be used multiple times on the command line.
261 At least one field must be provided if the B<-T fields> option is
264 Example: B<-e frame.number -e ip.addr -e udp>
266 Giving a protocol rather than a single field will print multiple items
267 of data about the protocol as a single field. Fields are separated by
268 tab characters by default. B<-E> controls the format of the printed
271 =item -E E<lt>field print optionE<gt>
273 Set an option controlling the printing of fields when B<-T fields> is
278 B<header=y|n> If B<y>, print a list of the field names given using B<-e>
279 as the first line of the output; the field name will be separated using
280 the same character as the field values. Defaults to B<n>.
282 B<separator=/t|/s|>E<lt>characterE<gt> Set the separator character to
283 use for fields. If B</t> tab will be used (this is the default), if
284 B</s>, a single space will be used. Otherwise any character that can be
285 accepted by the command line as part of the option may be used.
287 B<occurrence=f|l|a> Select which occurrence to use for fields that have
288 multiple occurrences. If B<f> the first occurrence will be used, if B<l>
289 the last occurrence will be used and if B<a> all occurrences will be used
290 (this is the default).
292 B<aggregator=,|/s|>E<lt>characterE<gt> Set the aggregator character to
293 use for fields that have multiple occurrences. If B<,> a comma will be used
294 (this is the default), if B</s>, a single space will be used. Otherwise
295 any character that can be accepted by the command line as part of the
298 B<quote=d|s|n> Set the quote character to use to surround fields. B<d>
299 uses double-quotes, B<s> single-quotes, B<n> no quotes (the default).
301 =item -f E<lt>capture filterE<gt>
303 Set the capture filter expression.
305 =item -F E<lt>file formatE<gt>
307 Set the file format of the output capture file written using the B<-w>
308 option. The output written with the B<-w> option is raw packet data, not
309 text, so there is no B<-F> option to request text output. The option B<-F>
310 without a value will list the available formats.
312 =item -G [fields|fields2|fields3|protocols|values|decodes|defaultprefs|currentprefs]
314 The B<-G> option will cause B<Tshark> to dump one of several types of glossaries
315 and then exit. If no specific glossary type is specified, then the B<fields> report will be generated by default.
317 The available report types include:
319 B<fields> Dumps the contents of the registration database to
320 stdout. An independent program can take this output and format it into nice
321 tables or HTML or whatever. There is one record per line. Each record is
322 either a protocol or a header field, differentiated by the first field.
323 The fields are tab-delimited.
328 * Field 2 = descriptive protocol name
329 * Field 3 = protocol abbreviation
334 * Field 2 = descriptive field name
335 * Field 3 = field abbreviation
336 * Field 4 = type ( textual representation of the ftenum type )
337 * Field 5 = parent protocol abbreviation
338 * Field 6 = blurb describing field
340 B<fields2> Same as the B<fields> report but includes two additional columns.
342 * Field 7 = base for display (for integer types); "parent bitfield width" for FT_BOOLEAN
343 * Field 8 = blurb describing field (yes, apparently we repeated this accidentally)
345 B<fields3> Same as the B<fields> report but includes two additional columns.
347 * Field 7 = base for display (for integer types); "parent bitfield width" for FT_BOOLEAN
348 * Field 8 = bitmask: format: hex: 0x....
350 B<protocols> Dumps the protocols in the registration database to stdout.
351 An independent program can take this output and format it into nice tables
352 or HTML or whatever. There is one record per line. The fields are tab-delimited.
354 * Field 1 = protocol name
355 * Field 2 = protocol short name
356 * Field 3 = protocol filter name
358 B<values> Dumps the value_strings, range_strings or true/false strings
359 for fields that have them. There is one record per line. Fields are
360 tab-delimited. There are three types of records: Value String, Range
361 String and True/False String. The first field, 'V', 'R' or 'T', indicates
367 * Field 2 = field abbreviation to which this value string corresponds
368 * Field 3 = Integer value
374 * Field 2 = field abbreviation to which this range string corresponds
375 * Field 3 = Integer value: lower bound
376 * Field 4 = Integer value: upper bound
382 * Field 2 = field abbreviation to which this true/false string corresponds
383 * Field 3 = True String
384 * Field 4 = False String
386 B<decodes> Dumps the "layer type"/"decode as" associations to stdout.
387 There is one record per line. The fields are tab-delimited.
389 * Field 1 = layer type, e.g. "tcp.port"
390 * Field 2 = selector in decimal
391 * Field 3 = "decode as" name, e.g. "http"
393 B<defaultprefs> Dumps a default preferences file to stdout.
395 B<currentprefs> Dumps a copy of the current preferences file to stdout.
399 Print the version and options and exits.
401 =item -i E<lt>capture interfaceE<gt> | -
403 Set the name of the network interface or pipe to use for live packet
406 Network interface names should match one of the names listed in
407 "B<tshark -D>" (described above); a number, as reported by
408 "B<tshark -D>", can also be used. If you're using UNIX, "B<netstat
409 -i>" or "B<ifconfig -a>" might also work to list interface names,
410 although not all versions of UNIX support the B<-a> option to B<ifconfig>.
412 If no interface is specified, B<TShark> searches the list of
413 interfaces, choosing the first non-loopback interface if there are any
414 non-loopback interfaces, and choosing the first loopback interface if
415 there are no non-loopback interfaces. If there are no interfaces at all,
416 B<TShark> reports an error and doesn't start the capture.
418 Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
419 read data from the standard input. Data read from pipes must be in
420 standard libpcap format.
422 Note: the Win32 version of B<TShark> doesn't support capturing from
427 Put the interface in "monitor mode"; this is supported only on IEEE
428 802.11 Wi-Fi interfaces, and supported only on some operating systems.
430 Note that in monitor mode the adapter might disassociate from the
431 network with which it's associated, so that you will not be able to use
432 any wireless networks with that adapter. This could prevent accessing
433 files on a network server, or resolving host names or network addresses,
434 if you are capturing in monitor mode and are not connected to another
435 network with another adapter.
437 =item -K E<lt>keytabE<gt>
439 Load kerberos crypto keys from the specified keytab file.
440 This option can be used multiple times to load keys from several files.
442 Example: B<-K krb5.keytab>
446 Flush the standard output after the information for each packet is
447 printed. (This is not, strictly speaking, line-buffered if B<-V>
448 was specified; however, it is the same as line-buffered if B<-V> wasn't
449 specified, as only one line is printed for each packet, and, as B<-l> is
450 normally used when piping a live capture to a program or script, so that
451 output for a packet shows up as soon as the packet is seen and
452 dissected, it should work just as well as true line-buffering. We do
453 this as a workaround for a deficiency in the Microsoft Visual C++ C
456 This may be useful when piping the output of B<TShark> to another
457 program, as it means that the program to which the output is piped will
458 see the dissected data for a packet as soon as B<TShark> sees the
459 packet and generates that output, rather than seeing it only when the
460 standard output buffer containing that data fills up.
464 List the data link types supported by the interface and exit. The reported
465 link types can be used for the B<-y> option.
469 Disable network object name resolution (such as hostname, TCP and UDP port
470 names); the B<-N> flag might override this one.
472 =item -N E<lt>name resolving flagsE<gt>
474 Turn on name resolving only for particular types of addresses and port
475 numbers, with name resolving for other types of addresses and port
476 numbers turned off. This flag overrides B<-n> if both B<-N> and B<-n> are
477 present. If both B<-N> and B<-n> flags are not present, all name resolutions are
480 The argument is a string that may contain the letters:
482 B<m> to enable MAC address resolution
484 B<n> to enable network address resolution
486 B<t> to enable transport-layer port number resolution
488 B<C> to enable concurrent (asynchronous) DNS lookups
490 =item -o E<lt>preferenceE<gt>:E<lt>valueE<gt>
492 Set a preference value, overriding the default value and any value read
493 from a preference file. The argument to the option is a string of the
494 form I<prefname>B<:>I<value>, where I<prefname> is the name of the
495 preference (which is the same name that would appear in the preference
496 file), and I<value> is the value to which it should be set.
500 I<Don't> put the interface into promiscuous mode. Note that the
501 interface might be in promiscuous mode for some other reason; hence,
502 B<-p> cannot be used to ensure that the only traffic that is captured is
503 traffic sent to or from the machine on which B<TShark> is running,
504 broadcast traffic, and multicast traffic to addresses received by that
509 When capturing packets, don't display the continuous count of packets
510 captured that is normally shown when saving a capture to a file;
511 instead, just display, at the end of the capture, a count of packets
512 captured. On systems that support the SIGINFO signal, such as various
513 BSDs, you can cause the current count to be displayed by typing your
514 "status" character (typically control-T, although it
515 might be set to "disabled" by default on at least some BSDs, so you'd
516 have to explicitly set it to use it).
518 When reading a capture file, or when capturing and not saving to a file,
519 don't print packet information; this is useful if you're using a B<-z>
520 option to calculate statistics and don't want the packet information
521 printed, just the statistics.
523 =item -r E<lt>infileE<gt>
525 Read packet data from I<infile>, can be any supported capture file format
526 (including gzipped files). It's B<not> possible to use named pipes
529 =item -R E<lt>read (display) filterE<gt>
531 Cause the specified filter (which uses the syntax of read/display filters,
532 rather than that of capture filters) to be applied before printing a
533 decoded form of packets or writing packets to a file; packets not
534 matching the filter are discarded rather than being printed or written.
536 =item -s E<lt>capture snaplenE<gt>
538 Set the default snapshot length to use when capturing live data.
539 No more than I<snaplen> bytes of each network packet will be read into
540 memory, or saved to disk. A value of 0 specifies a snapshot length of
541 65535, so that the full packet is captured; this is the default.
545 Decode and display packets even while writing raw packet data using the
548 =item -t ad|a|r|d|dd|e
550 Set the format of the packet timestamp printed in summary lines.
551 The format can be one of:
553 B<ad> absolute with date: The absolute date and time is the actual time and
554 date the packet was captured
556 B<a> absolute: The absolute time is the actual time the packet was captured,
557 with no date displayed
559 B<r> relative: The relative time is the time elapsed between the first packet
560 and the current packet
562 B<d> delta: The delta time is the time since the previous packet was
565 B<dd> delta_displayed: The delta_displayed time is the time since the
566 previous displayed packet was captured
568 B<e> epoch: The time in seconds since epoch (Jan 1, 1970 00:00:00)
570 The default format is relative.
572 =item -T pdml|psml|ps|text|fields
574 Set the format of the output when viewing decoded packet data. The
577 B<pdml> Packet Details Markup Language, an XML-based format for the details of
578 a decoded packet. This information is equivalent to the packet details
579 printed with the B<-V> flag.
581 B<psml> Packet Summary Markup Language, an XML-based format for the summary
582 information of a decoded packet. This information is equivalent to the
583 information shown in the one-line summary printed by default.
585 B<ps> PostScript for a human-readable one-line summary of each of the packets,
586 or a multi-line view of the details of each of the packets, depending on
587 whether the B<-V> flag was specified.
589 B<text> Text of a human-readable one-line summary of each of the packets, or a
590 multi-line view of the details of each of the packets, depending on
591 whether the B<-V> flag was specified. This is the default.
593 B<fields> The values of fields specified with the B<-e> option, in a
594 form specified by the B<-E> option. For example,
596 -T fields -E separator=, -E quote=d
598 would generate comma-separated values (CSV) output suitable for importing
599 into your favorite spreadsheet program.
604 Print the version and exit.
608 Cause B<TShark> to print a view of the packet details rather
609 than a one-line summary of the packet.
611 =item -w E<lt>outfileE<gt> | -
613 Write raw packet data to I<outfile> or to the standard output if
616 NOTE: -w provides raw packet data, not text. If you want text output
617 you need to redirect stdout (e.g. using '>'), don't use the B<-w>
622 Cause B<TShark> to print a hex and ASCII dump of the packet data
623 after printing the summary or details.
625 =item -X E<lt>eXtension optionsE<gt>
627 Specify an option to be passed to a B<TShark> module. The eXtension option
628 is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
630 B<lua_script>:I<lua_script_filename> tells B<Wireshark> to load the given script in addition to the
633 =item -y E<lt>capture link typeE<gt>
635 Set the data link type to use while capturing packets. The values
636 reported by B<-L> are the values that can be used.
638 =item -z E<lt>statisticsE<gt>
640 Get B<TShark> to collect various types of statistics and display the result
641 after finishing reading the capture file. Use the B<-q> flag if you're
642 reading a capture file and only want the statistics printed, not any
643 per-packet information.
645 Note that the B<-z proto> option is different - it doesn't cause
646 statistics to be gathered and printed when the capture is complete, it
647 modifies the regular packet summary output to include the values of
648 fields specified with the option. Therefore you must not use the B<-q>
649 option, as that option would suppress the printing of the regular packet
650 summary output, and must also not use the B<-V> option, as that would
651 cause packet detail information rather than packet summary information
654 Currently implemented statistics are:
658 =item B<-z> dcerpc,rtt,I<uuid>,I<major>.I<minor>[,I<filter>]
660 Collect call/reply RTT data for DCERPC interface I<uuid>,
661 version I<major>.I<minor>.
662 Data collected is the number of calls for each procedure, MinRTT, MaxRTT
665 Example: S<B<-z dcerpc,rtt,12345778-1234-abcd-ef00-0123456789ac,1.0>> will collect data for the CIFS SAMR Interface.
667 If the optional I<filter> is provided, the stats will only be calculated
668 on those calls that match that filter.
670 Example: S<B<-z dcerpc,rtt,12345778-1234-abcd-ef00-0123456789ac,1.0,ip.addr==1.2.3.4>>
671 will collect SAMR RTT statistics for a specific host.
673 This option can be used multiple times on the command line.
675 =item B<-z> io,phs[,I<filter>]
677 Create Protocol Hierarchy Statistics listing both number of packets and bytes.
678 If no I<filter> is specified the statistics will be calculated for all packets.
679 If a I<filter> is specified statistics will be only calculated for those
680 packets that match the filter.
682 This option can be used multiple times on the command line.
684 =item B<-z> io,stat,I<interval>[,I<filter>][,I<filter>][,I<filter>]...
686 Collect packet/bytes statistics for the capture in intervals of
687 I<interval> seconds. I<Interval> can be specified either as a whole or
688 fractional second and can be specified with ms resolution.
689 If I<interval> is 0, the statistics will be calculated over all packets.
691 If no I<filter> is specified the statistics will be calculated for all packets.
692 If one or more I<filters> are specified statistics will be calculated for
693 all filters and presented with one column of statistics for each filter.
695 This option can be used multiple times on the command line.
697 Example: B<-z io,stat,1,ip.addr==1.2.3.4> will generate 1 second
698 statistics for all traffic to/from host 1.2.3.4.
700 Example: B<-z "io,stat,0.001,smb&&ip.addr==1.2.3.4"> will generate 1ms
701 statistics for all SMB packets to/from host 1.2.3.4.
703 The examples above all use the standard syntax for generating statistics
704 which only calculates the number of packets and bytes in each interval.
706 B<io,stat> can also do much more statistics and calculate COUNT(), SUM(),
707 MIN(), MAX(), and AVG() using a slightly different filter syntax:
709 [COUNT|SUM|MIN|MAX|AVG](<field>)<filter>
711 NOTE: One important thing to note here is that the field that the
712 calculation is based on MUST also be part of the filter string or
713 else the calculation will fail.
715 So: B<-z io,stat,0.010,AVG(smb.time)> does not work. Use B<-z
716 io,stat,0.010,AVG(smb.time)smb.time> instead. Also be aware that a field
717 can exist multiple times inside the same packet and will then be counted
718 multiple times in those packets.
720 NOTE: A second important thing to note is that the system setting for
721 decimal separator is set to "."! If it is set to "," the statistics
722 will not be displayed per filter.
724 COUNT(<field>) can be used on any type which has a display filter name.
725 It will count how many times this particular field is encountered in the
726 filtered packet list.
728 Example: B<-z io,stat,0.010,COUNT(smb.sid)smb.sid>
730 This will count the total number of SIDs seen in each 10ms interval.
732 SUM(<field>) can only be used on named fields of integer type.
733 This will sum together every occurrence of this field's value for each interval.
735 Example: B<-z io,stat,0.010,SUM(frame.pkt_len)frame.pkt_len>
737 This will report the total number of bytes seen in all the packets within
740 MIN/MAX/AVG(<field>) can only be used on named fields that are either
741 integers or relative time fields. This will calculate maximum/minimum
742 or average seen in each interval. If the field is a relative time field
743 the output will be presented in seconds and three digits after the
744 decimal point. The resolution for time calculations is 1ms and anything
745 smaller will be truncated.
747 Example: B<-z "io,stat,0.010,smb.time&&ip.addr==1.1.1.1,MIN(smb.time)smb.time&&ip.addr==1.1.1.1,MAX(smb.time)smb.time&&ip.addr==1.1.1.1,MAX(smb.time)smb.time&&ip.addr==1.1.1.1">
749 This will calculate statistics for all smb response times we see to/from
750 host 1.1.1.1 in 10ms intervals. The output will be displayed in 4
751 columns; number of packets/bytes, minimum response time, maximum response
752 time and average response time.
754 =item B<-z> conv,I<type>[,I<filter>]
756 Create a table that lists all conversations that could be seen in the
757 capture. I<type> specifies the conversation endpoint types for which we
758 want to generate the statistics; currently the supported ones are:
760 "eth" Ethernet addresses
761 "fc" Fibre Channel addresses
762 "fddi" FDDI addresses
764 "ipv6" IPv6 addresses
766 "tcp" TCP/IP socket pairs Both IPv4 and IPv6 are supported
767 "tr" Token Ring addresses
768 "udp" UDP/IP socket pairs Both IPv4 and IPv6 are supported
770 If the optional I<filter> is specified, only those packets that match the
771 filter will be used in the calculations.
773 The table is presented with one line for each conversation and displays
774 the number of packets/bytes in each direction as well as the total
775 number of packets/bytes. The table is sorted according to the total
778 =item B<-z> proto,colinfo,I<filter>,I<field>
780 Append all I<field> values for the packet to the Info column of the
781 one-line summary output.
782 This feature can be used to append arbitrary fields to the Info column
783 in addition to the normal content of that column.
784 I<field> is the display-filter name of a field which value should be placed
786 I<filter> is a filter string that controls for which packets the field value
787 will be presented in the info column. I<field> will only be presented in the
788 Info column for the packets which match I<filter>.
790 NOTE: In order for B<TShark> to be able to extract the I<field> value
791 from the packet, I<field> MUST be part of the I<filter> string. If not,
792 B<TShark> will not be able to extract its value.
794 For a simple example to add the "nfs.fh.hash" field to the Info column
795 for all packets containing the "nfs.fh.hash" field, use
797 B<-z proto,colinfo,nfs.fh.hash,nfs.fh.hash>
799 To put "nfs.fh.hash" in the Info column but only for packets coming from
802 B<-z "proto,colinfo,nfs.fh.hash && ip.src==1.2.3.4,nfs.fh.hash">
804 This option can be used multiple times on the command line.
806 =item B<-z> diameter,avp[,I<cmd.code>,I<field>,I<field>,I<...>]
808 This option enables extraction of most important diameter fields from large capture files.
809 Exactly one text line for each diameter message with matched B<diameter.cmd.code> will be printed.
811 Empty diameter command code or '*' can be specified to mach any B<diameter.cmd.code>
813 Example: B<-z diameter,avp> extract default field set from diameter messages.
815 Example: B<-z diameter,avp,280> extract default field set from diameter DWR messages.
817 Example: B<-z diameter,avp,272> extract default field set from diameter CC messages.
819 Extract most important fields from diameter CC messages:
821 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>
823 Following fields will be printed out for each diameter message:
825 "frame" Frame number.
826 "time" Unix time of the frame arrival.
827 "src" Source address.
828 "srcport" Source port.
829 "dst" Destination address.
830 "dstport" Destination port.
831 "proto" Constant string 'diameter', which can be used for post processing of tshark output. e.g. grep/sed/awk.
832 "msgnr" seq. number of diameter message within the frame. E.g. '2' for the third diameter message in the same frame.
833 "is_request" '0' if message is a request, '1' if message is an answer.
834 "cmd" diameter.cmd_code, E.g. '272' for credit control messages.
835 "req_frame" Number of frame where matched request was found or '0'.
836 "ans_frame" Number of frame where matched answer was found or '0'.
837 "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.
839 B<-z diameter,avp> option is much faster than B<-V -T text> or B<-T pdml> options.
841 B<-z diameter,avp> option is more powerful than B<-T field> and B<-z proto,colinfo> options.
843 Multiple diameter messages in one frame are supported.
845 Several fields with same name within one diameter message are supported, e.g. I<diameter.Subscription-Id-Data> or I<diameter.Rating-Group>.
847 Note: B<tshark -q> option is recommended to suppress default B<tshark> output.
849 =item B<-z> rpc,rtt,I<program>,I<version>[,I<filter>]
851 Collect call/reply RTT data for I<program>/I<version>. Data collected
852 is number of calls for each procedure, MinRTT, MaxRTT and AvgRTT.
853 Example: B<-z rpc,rtt,100003,3> will collect data for NFS v3.
855 If the optional I<filter> is provided, the stats will only be calculated
856 on those calls that match that filter.
858 Example: B<-z rpc,rtt,100003,3,nfs.fh.hash==0x12345678> will collect NFS v3
859 RTT statistics for a specific file.
861 This option can be used multiple times on the command line.
863 =item B<-z> rpc,programs
865 Collect call/reply RTT data for all known ONC-RPC programs/versions.
866 Data collected is number of calls for each protocol/version, MinRTT,
868 This option can only be used once on the command line.
870 =item B<-z> rtp,streams
872 Collect statistics for all RTP streams and calculate max. delta, max. and
873 mean jitter and packet loss percentages.
875 =item B<-z> smb,rtt[,I<filter>]
877 Collect call/reply RTT data for SMB. Data collected
878 is number of calls for each SMB command, MinRTT, MaxRTT and AvgRTT.
879 Example: B<-z smb,rtt>.
880 The data will be presented as separate tables for all normal SMB commands,
881 all Transaction2 commands and all NT Transaction commands.
882 Only those commands that are seen in the capture will have its stats
884 Only the first command in a xAndX command chain will be used in the
885 calculation. So for common SessionSetupAndX + TreeConnectAndX chains,
886 only the SessionSetupAndX call will be used in the statistics.
887 This is a flaw that might be fixed in the future.
889 This option can be used multiple times on the command line.
891 If the optional I<filter> is provided, the stats will only be calculated
892 on those calls that match that filter.
894 Example: B<-z "smb,rtt,ip.addr==1.2.3.4"> will only collect stats for
895 SMB packets exchanged by the host at IP address 1.2.3.4 .
899 When this feature is used B<TShark> will print a report with all the
900 discovered SID and account name mappings. Only those SIDs where the
901 account name is known will be presented in the table.
903 For this feature to work you will need to either to enable
904 "Edit/Preferences/Protocols/SMB/Snoop SID to name mappings" in the
905 preferences or you can override the preferences by specifying
906 S<B<-o "smb.sid_name_snooping:TRUE">> on the B<TShark> command line.
908 The current method used by B<TShark> to find the SID->name mapping
909 is relatively restricted with a hope of future expansion.
911 =item B<-z> mgcp,rtd[I<,filter>]
913 Collect requests/response RTD (Response Time Delay) data for MGCP.
914 (This is similar to B<-z smb,rtt>). Data collected is the number of calls
915 for each known MGCP Type, MinRTD, MaxRTD and AvgRTD.
916 Additionally you get the number of duplicate requests/responses,
917 unresponded requests, responses, which don't match with any request.
918 Example: B<-z mgcp,rtd>.
920 This option can be used multiple times on the command line.
922 If the optional I<filter> is provided, the stats will only be calculated
923 on those calls that match that filter.
924 Example: B<-z "mgcp,rtd,ip.addr==1.2.3.4"> will only collect stats for
925 MGCP packets exchanged by the host at IP address 1.2.3.4 .
927 =item B<-z> megaco,rtd[I<,filter>]
929 Collect requests/response RTD (Response Time Delay) data for MEGACO.
930 (This is similar to B<-z smb,rtt>). Data collected is the number of calls
931 for each known MEGACO Type, MinRTD, MaxRTD and AvgRTD.
932 Additionally you get the number of duplicate requests/responses,
933 unresponded requests, responses, which don't match with any request.
934 Example: B<-z megaco,rtd>.
936 If the optional I<filter> is provided, the stats will only be calculated
937 on those calls that match that filter.
938 Example: B<-z "megaco,rtd,ip.addr==1.2.3.4"> will only collect stats for
939 MEGACO packets exchanged by the host at IP address 1.2.3.4 .
941 This option can be used multiple times on the command line.
943 =item B<-z> h225,counter[I<,filter>]
945 Count ITU-T H.225 messages and their reasons. In the first column you get a
946 list of H.225 messages and H.225 message reasons, which occur in the current
947 capture file. The number of occurrences of each message or reason is displayed
948 in the second column.
950 Example: B<-z h225,counter>.
952 If the optional I<filter> is provided, the stats will only be calculated
953 on those calls that match that filter.
954 Example: use B<-z "h225,counter,ip.addr==1.2.3.4"> to only collect stats for
955 H.225 packets exchanged by the host at IP address 1.2.3.4 .
957 This option can be used multiple times on the command line.
959 =item B<-z> h225,srt[I<,filter>]
961 Collect requests/response SRT (Service Response Time) data for ITU-T H.225 RAS.
962 Data collected is number of calls of each ITU-T H.225 RAS Message Type,
963 Minimum SRT, Maximum SRT, Average SRT, Minimum in Frame, and Maximum in Frame.
964 You will also get the number of Open Requests (Unresponded Requests),
965 Discarded Responses (Responses without matching request) and Duplicate Messages.
966 Example: B<-z h225,srt>.
968 If the optional I<filter> is provided, the stats will only be calculated
969 on those calls that match that filter.
970 Example: B<-z "h225,srt,ip.addr==1.2.3.4"> will only collect stats for
971 ITU-T H.225 RAS packets exchanged by the host at IP address 1.2.3.4 .
973 This option can be used multiple times on the command line.
975 =item B<-z> sip,stat[I<,filter>]
977 This option will activate a counter for SIP messages. You will get the number
978 of occurrences of each SIP Method and of each SIP Status-Code. Additionally you
979 also get the number of resent SIP Messages (only for SIP over UDP).
981 Example: B<-z sip,stat>.
983 This option can be used multiple times on the command line.
985 If the optional I<filter> is provided, the stats will only be calculated
986 on those calls that match that filter.
987 Example: B<-z "sip,stat,ip.addr==1.2.3.4"> will only collect stats for
988 SIP packets exchanged by the host at IP address 1.2.3.4 .
994 =head1 CAPTURE FILTER SYNTAX
996 See the manual page of pcap-filter(4) or, if that doesn't exist, tcpdump(8),
997 or, if that doesn't exist, L<http://wiki.wireshark.org/CaptureFilters>.
999 =head1 READ FILTER SYNTAX
1001 For a complete table of protocol and protocol fields that are filterable
1002 in B<TShark> see the wireshark-filter(4) manual page.
1006 These files contains various B<Wireshark> configuration values.
1012 The F<preferences> files contain global (system-wide) and personal
1013 preference settings. If the system-wide preference file exists, it is
1014 read first, overriding the default settings. If the personal preferences
1015 file exists, it is read next, overriding any previous values. Note: If
1016 the command line option B<-o> is used (possibly more than once), it will
1017 in turn override values from the preferences files.
1019 The preferences settings are in the form I<prefname>B<:>I<value>,
1021 where I<prefname> is the name of the preference
1022 and I<value> is the value to
1023 which it should be set; white space is allowed between B<:> and
1024 I<value>. A preference setting can be continued on subsequent lines by
1025 indenting the continuation lines with white space. A B<#> character
1026 starts a comment that runs to the end of the line:
1028 # Capture in promiscuous mode?
1029 # TRUE or FALSE (case-insensitive).
1030 capture.prom_mode: TRUE
1032 The global preferences file is looked for in the F<wireshark> directory
1033 under the F<share> subdirectory of the main installation directory (for
1034 example, F</usr/local/share/wireshark/preferences>) on UNIX-compatible
1035 systems, and in the main installation directory (for example,
1036 F<C:\Program Files\Wireshark\preferences>) on Windows systems.
1038 The personal preferences file is looked for in
1039 F<$HOME/.wireshark/preferences> on
1040 UNIX-compatible systems and F<%APPDATA%\Wireshark\preferences> (or, if
1041 %APPDATA% isn't defined, F<%USERPROFILE%\Application
1042 Data\Wireshark\preferences>) on Windows systems.
1044 =item Disabled (Enabled) Protocols
1046 The F<disabled_protos> files contain system-wide and personal lists of
1047 protocols that have been disabled, so that their dissectors are never
1048 called. The files contain protocol names, one per line, where the
1049 protocol name is the same name that would be used in a display filter
1055 The global F<disabled_protos> file uses the same directory as the global
1058 The personal F<disabled_protos> file uses the same directory as the
1059 personal preferences file.
1061 =item Name Resolution (hosts)
1063 If the personal F<hosts> file exists, it is
1064 used to resolve IPv4 and IPv6 addresses before any other
1065 attempts are made to resolve them. The file has the standard F<hosts>
1066 file syntax; each line contains one IP address and name, separated by
1067 whitespace. The same directory as for the personal preferences file is
1070 Capture filter name resolution is handled by libpcap on UNIX-compatible
1071 systems and WinPCAP on Windows. As such the Wireshark personal F<hosts> file
1072 will not be consulted for capture filter name resolution.
1074 =item Name Resolution (ethers)
1076 The F<ethers> files are consulted to correlate 6-byte hardware addresses to
1077 names. First the personal F<ethers> file is tried and if an address is not
1078 found there the global F<ethers> file is tried next.
1080 Each line contains one hardware address and name, separated by
1081 whitespace. The digits of the hardware address are separated by colons
1082 (:), dashes (-) or periods (.). The same separator character must be
1083 used consistently in an address. The following three lines are valid
1084 lines of an F<ethers> file:
1086 ff:ff:ff:ff:ff:ff Broadcast
1087 c0-00-ff-ff-ff-ff TR_broadcast
1088 00.00.00.00.00.00 Zero_broadcast
1090 The global F<ethers> file is looked for in the F</etc> directory on
1091 UNIX-compatible systems, and in the main installation directory (for
1092 example, F<C:\Program Files\Wireshark>) on Windows systems.
1094 The personal F<ethers> file is looked for in the same directory as the personal
1097 Capture filter name resolution is handled by libpcap on UNIX-compatible
1098 systems and WinPCAP on Windows. As such the Wireshark personal F<ethers> file
1099 will not be consulted for capture filter name resolution.
1101 =item Name Resolution (manuf)
1103 The F<manuf> file is used to match the 3-byte vendor portion of a 6-byte
1104 hardware address with the manufacturer's name; it can also contain well-known
1105 MAC addresses and address ranges specified with a netmask. The format of the
1106 file is the same as the F<ethers> files, except that entries of the form:
1110 can be provided, with the 3-byte OUI and the name for a vendor, and
1113 00-00-0C-07-AC/40 All-HSRP-routers
1115 can be specified, with a MAC address and a mask indicating how many bits
1116 of the address must match. The above entry, for example, has 40
1117 significant bits, or 5 bytes, and would match addresses from
1118 00-00-0C-07-AC-00 through 00-00-0C-07-AC-FF. The mask need not be a
1121 The F<manuf> file is looked for in the same directory as the global
1124 =item Name Resolution (ipxnets)
1126 The F<ipxnets> files are used to correlate 4-byte IPX network numbers to
1127 names. First the global F<ipxnets> file is tried and if that address is not
1128 found there the personal one is tried next.
1130 The format is the same as the F<ethers>
1131 file, except that each address is four bytes instead of six.
1132 Additionally, the address can be represented as a single hexadecimal
1133 number, as is more common in the IPX world, rather than four hex octets.
1134 For example, these four lines are valid lines of an F<ipxnets> file:
1138 00:00:BE:EF IT_Server1
1141 The global F<ipxnets> file is looked for in the F</etc> directory on
1142 UNIX-compatible systems, and in the main installation directory (for
1143 example, F<C:\Program Files\Wireshark>) on Windows systems.
1145 The personal F<ipxnets> file is looked for in the same directory as the
1146 personal preferences file.
1150 =head1 ENVIRONMENT VARIABLES
1154 =item WIRESHARK_DEBUG_EP_NO_CHUNKS
1156 Normally per-packet memory is allocated in large "chunks." This behavior
1157 doesn't work well with debugging tools such as Valgrind or ElectricFence.
1158 Export this environment variable to force individual allocations.
1159 Note: disabling chunks also disables canaries (see below).
1161 =item WIRESHARK_DEBUG_SE_NO_CHUNKS
1163 Normally per-file memory is allocated in large "chunks." This behavior
1164 doesn't work well with debugging tools such as Valgrind or ElectricFence.
1165 Export this environment variable to force individual allocations.
1166 Note: disabling chunks also disables canaries (see below).
1168 =item WIRESHARK_DEBUG_EP_NO_CANARY
1170 Normally per-packet memory allocations are separated by "canaries" which
1171 allow detection of memory overruns. This comes at the expense of some extra
1172 memory usage. Exporting this environment variable disables these canaries.
1174 =item WIRESHARK_DEBUG_SE_USE_CANARY
1176 Exporting this environment variable causes per-file memory allocations to be
1177 protected with "canaries" which allow for detection of memory overruns.
1178 This comes at the expense of significant extra memory usage.
1180 =item WIRESHARK_DEBUG_SCRUB_MEMORY
1182 If this environment variable is exported, the contents of per-packet and
1183 per-file memory is initialized to 0xBADDCAFE when the memory is allocated
1184 and is reset to 0xDEADBEEF when the memory is freed. This functionality is
1185 useful mainly to developers looking for bugs in the way memory is handled.
1187 =item WIRESHARK_RUN_FROM_BUILD_DIRECTORY
1189 This environment variable causes the plugins and other data files to be loaded
1190 from the build directory (where the program was compiled) rather than from the
1191 standard locations. It has no effect when the program in question is running
1192 with root (or setuid) permissions on *NIX.
1194 =item WIRESHARK_DATA_DIR
1196 This environment variable causes the various data files to be loaded from
1197 a directory other than the standard locations. It has no effect when the
1198 program in question is running with root (or setuid) permissions on *NIX.
1200 =item WIRESHARK_PYTHON_DIR
1202 This environment variable points to an alternate location for Python.
1203 It has no effect when the program in question is running with root (or setuid)
1204 permissions on *NIX.
1206 =item ERF_RECORDS_TO_CHECK
1208 This environment variable controls the number of ERF records checked when
1209 deciding if a file really is in the ERF format. Setting this environment
1210 variable a number higher than the default (20) would make false positives
1213 =item IPFIX_RECORDS_TO_CHECK
1215 This environment variable controls the number of IPFIX records checked when
1216 deciding if a file really is in the IPFIX format. Setting this environment
1217 variable a number higher than the default (20) would make false positives
1220 =item WIRESHARK_ABORT_ON_DISSECTOR_BUG
1222 If this environment variable is set, B<TShark> will call abort(3)
1223 when a dissector bug is encountered. abort(3) will cause the program to
1224 exit abnormally; if you are running B<TShark> in a debugger, it
1225 should halt in the debugger and allow inspection of the process, and, if
1226 you are not running it in a debugger, it will, on some OSes, assuming
1227 your environment is configured correctly, generate a core dump file.
1228 This can be useful to developers attempting to troubleshoot a problem
1229 with a protocol dissector.
1231 =item WIRESHARK_EP_VERIFY_POINTERS
1233 This environment variable, if exported, causes certain uses of pointers to be
1234 audited to ensure they do not point to memory that is deallocated after each
1235 packet has been fully dissected. This can be useful to developers writing or
1238 =item WIRESHARK_SE_VERIFY_POINTERS
1240 This environment variable, if exported, causes certain uses of pointers to be
1241 audited to ensure they do not point to memory that is deallocated after when
1242 a capture file is closed. This can be useful to developers writing or
1249 wireshark-filter(4), wireshark(1), editcap(1), pcap-filter(4), tcpdump(8),
1250 pcap(3), dumpcap(1), text2pcap(1), mergecap(1)
1254 B<TShark> is part of the B<Wireshark> distribution. The latest version
1255 of B<Wireshark> can be found at L<http://www.wireshark.org>.
1257 HTML versions of the Wireshark project man pages are available at:
1258 L<http://www.wireshark.org/docs/man-pages>.
1262 B<TShark> uses the same packet dissection code that B<Wireshark> does,
1263 as well as using many other modules from B<Wireshark>; see the list of
1264 authors in the B<Wireshark> man page for a list of authors of that code.