Add Flow Graph functionality to TShark

[metze/wireshark/wip.git] / doc / tshark.pod

=head1 NAME

tshark - Dump and analyze network traffic

=head1 SYNOPSIS

B<tshark>
S<[ B<-2> ]>
S<[ B<-a> E<lt>capture autostop conditionE<gt> ] ...>
S<[ B<-b> E<lt>capture ring buffer optionE<gt>] ...>
S<[ B<-B> E<lt>capture buffer sizeE<gt> ] >
S<[ B<-c> E<lt>capture packet countE<gt> ]>
S<[ B<-C> E<lt>configuration profileE<gt> ]>
S<[ B<-d> E<lt>layer typeE<gt>==E<lt>selectorE<gt>,E<lt>decode-as protocolE<gt> ]>
S<[ B<-D> ]>
S<[ B<-e> E<lt>fieldE<gt> ]>
S<[ B<-E> E<lt>field print optionE<gt> ]>
S<[ B<-f> E<lt>capture filterE<gt> ]>
S<[ B<-F> E<lt>file formatE<gt> ]>
S<[ B<-g> ]>
S<[ B<-h> ]>
S<[ B<-H> E<lt>input hosts fileE<gt> ]>
S<[ B<-i> E<lt>capture interfaceE<gt>|- ]>
S<[ B<-j> E<lt>protocol match filterE<gt> ]>
S<[ B<-I> ]>
S<[ B<-K> E<lt>keytabE<gt> ]>
S<[ B<-l> ]>
S<[ B<-L> ]>
S<[ B<-n> ]>
S<[ B<-N> E<lt>name resolving flagsE<gt> ]>
S<[ B<-o> E<lt>preference settingE<gt> ] ...>
S<[ B<-O> E<lt>protocolsE<gt> ]>
S<[ B<-p> ]>
S<[ B<-P> ]>
S<[ B<-q> ]>
S<[ B<-Q> ]>
S<[ B<-r> E<lt>infileE<gt> ]>
S<[ B<-R> E<lt>Read filterE<gt> ]>
S<[ B<-s> E<lt>capture snaplenE<gt> ]>
S<[ B<-S> E<lt>separatorE<gt> ]>
S<[ B<-t> a|ad|adoy|d|dd|e|r|u|ud|udoy ]>
S<[ B<-T> ek|fields|json|pdml|ps|psml|tabs|text ]>
S<[ B<-u> E<lt>seconds typeE<gt>]>
S<[ B<-U> E<lt>tap_nameE<gt>]>
S<[ B<-v> ]>
S<[ B<-V> ]>
S<[ B<-w> E<lt>outfileE<gt>|- ]>
S<[ B<-W> E<lt>file format optionE<gt>]>
S<[ B<-x> ]>
S<[ B<-X> E<lt>eXtension optionE<gt>]>
S<[ B<-y> E<lt>capture link typeE<gt> ]>
S<[ B<-Y> E<lt>displaY filterE<gt> ]>
S<[ B<-M> E<lt>auto session resetE<gt> ]>
S<[ B<-z> E<lt>statisticsE<gt> ]>
S<[ B<--capture-comment> E<lt>commentE<gt> ]>
S<[ B<--list-time-stamp-types> ]>
S<[ B<--time-stamp-type> E<lt>typeE<gt> ]>
S<[ B<--color> ]>
S<[ B<--no-duplicate-keys> ]>
S<[ B<--export-objects> E<lt>protocolE<gt>,E<lt>destdirE<gt> ]>
S<[ B<--enable-protocol> E<lt>proto_nameE<gt> ]>
S<[ B<--disable-protocol> E<lt>proto_nameE<gt> ]>
S<[ B<--enable-heuristic> E<lt>short_nameE<gt> ]>
S<[ B<--disable-heuristic> E<lt>short_nameE<gt> ]>
S<[ E<lt>capture filterE<gt> ]>

B<tshark>
B<-G> [ E<lt>report typeE<gt> ]

=head1 DESCRIPTION

B<TShark> is a network protocol analyzer.  It lets you capture packet
data from a live network, or read packets from a previously saved
capture file, either printing a decoded form of those packets to the
standard output or writing the packets to a file.  B<TShark>'s native
capture file format is B<pcap> format, which is also the format used
by B<tcpdump> and various other tools.

Without any options set, B<TShark> will work much like B<tcpdump>.  It will
use the pcap library to capture traffic from the first available network
interface and displays a summary line on stdout for each received packet.

B<TShark> is able to detect, read and write the same capture files that
are supported by B<Wireshark>.
The input file doesn't need a specific filename extension; the file
format and an optional gzip compression will be automatically detected.
Near the beginning of the DESCRIPTION section of wireshark(1) or
L<https://www.wireshark.org/docs/man-pages/wireshark.html>
is a detailed description of the way B<Wireshark> handles this, which is
the same way B<Tshark> handles this.

Compressed file support uses (and therefore requires) the zlib library.
If the zlib library is not present, B<TShark> will compile, but will
be unable to read compressed files.

If the B<-w> option is not specified, B<TShark> writes to the standard
output the text of a decoded form of the packets it captures or reads.
If the B<-w> option is specified, B<TShark> writes to the file
specified by that option the raw data of the packets, along with the
packets' time stamps.

When writing a decoded form of packets, B<TShark> writes, by
default, a summary line containing the fields specified by the
preferences file (which are also the fields displayed in the packet list
pane in B<Wireshark>), although if it's writing packets as it captures
them, rather than writing packets from a saved capture file, it won't
show the "frame number" field.  If the B<-V> option is specified, it
writes instead a view of the details of the packet, showing all the
fields of all protocols in the packet.  If the B<-O> option is specified,
it will only show the full protocols specified.  Use the output of
"B<tshark -G protocols>" to find the abbreviations of the protocols you can
specify.

If you want to write the decoded form of packets to a file, run
B<TShark> without the B<-w> option, and redirect its standard output to
the file (do I<not> use the B<-w> option).

When writing packets to a file, B<TShark>, by default, writes the
file in B<pcap> format, and writes all of the packets it sees to the
output file.  The B<-F> option can be used to specify the format in which
to write the file.  This list of available file formats is displayed by
the B<-F> flag without a value.  However, you can't specify a file format
for a live capture.

Read filters in B<TShark>, which allow you to select which packets
are to be decoded or written to a file, are very powerful; more fields
are filterable in B<TShark> than in other protocol analyzers, and the
syntax you can use to create your filters is richer.  As B<TShark>
progresses, expect more and more protocol fields to be allowed in read
filters.

Packet capturing is performed with the pcap library.  The capture filter
syntax follows the rules of the pcap library.  This syntax is different
from the read filter syntax.  A read filter can also be specified when
capturing, and only packets that pass the read filter will be displayed
or saved to the output file; note, however, that capture filters are much
more efficient than read filters, and it may be more difficult for
B<TShark> to keep up with a busy network if a read filter is
specified for a live capture.

A capture or read filter can either be specified with the B<-f> or B<-R>
option, respectively, in which case the entire filter expression must be
specified as a single argument (which means that if it contains spaces,
it must be quoted), or can be specified with command-line arguments
after the option arguments, in which case all the arguments after the
filter arguments are treated as a filter expression.  Capture filters
are supported only when doing a live capture; read filters are supported
when doing a live capture and when reading a capture file, but require
TShark to do more work when filtering, so you might be more likely to
lose packets under heavy load if you're using a read filter.  If the
filter is specified with command-line arguments after the option
arguments, it's a capture filter if a capture is being done (i.e., if no
B<-r> option was specified) and a read filter if a capture file is being
read (i.e., if a B<-r> option was specified).

The B<-G> option is a special mode that simply causes B<Tshark>
to dump one of several types of internal glossaries and then exit.

=head1 OPTIONS

=over 4

=item -2

Perform a two-pass analysis. This causes tshark to buffer output until the
entire first pass is done, but allows it to fill in fields that require future
knowledge, such as 'response in frame #' fields. Also permits reassembly
frame dependencies to be calculated correctly.

=item -a  E<lt>capture autostop conditionE<gt>

Specify a criterion that specifies when B<TShark> is to stop writing
to a capture file.  The criterion is of the form I<test>B<:>I<value>,
where I<test> is one of:

B<duration>:I<value> Stop writing to a capture file after I<value> seconds
have elapsed.

B<filesize>:I<value> Stop writing to a capture file after it reaches a size of
I<value> kB.  If this option is used together with the -b option, B<TShark>
will stop writing to the current capture file and switch to the next one if
filesize is reached.  When reading a capture file, B<TShark> will stop reading
the file after the number of bytes read exceeds this number (the complete
packet  will be read, so more bytes than this number may be read).  Note that
the filesize is limited to a maximum value of 2 GiB.

B<files>:I<value> Stop writing to capture files after I<value> number of files
were written.

=item -b  E<lt>capture ring buffer optionE<gt>

Cause B<TShark> to run in "multiple files" mode.  In "multiple files" mode,
B<TShark> will write to several capture files.  When the first capture file
fills up, B<TShark> will switch writing to the next file and so on.

The created filenames are based on the filename given with the B<-w> option,
the number of the file and on the creation date and time,
e.g. outfile_00001_20050604120117.pcap, outfile_00002_20050604120523.pcap, ...

With the I<files> option it's also possible to form a "ring buffer".
This will fill up new files until the number of files specified,
at which point B<TShark> will discard the data in the first file and start
writing to that file and so on.  If the I<files> option is not set,
new files filled up until one of the capture stop conditions match (or
until the disk is full).

The criterion is of the form I<key>B<:>I<value>,
where I<key> is one of:

B<duration>:I<value> switch to the next file after I<value> seconds have
elapsed, even if the current file is not completely filled up.

B<interval>:I<value> switch to the next file when the time is an exact
multiple of I<value> seconds

B<filesize>:I<value> switch to the next file after it reaches a size of
I<value> kB.  Note that the filesize is limited to a maximum value of 2 GiB.

B<files>:I<value> begin again with the first file after I<value> number of
files were written (form a ring buffer).  This value must be less than 100000.
Caution should be used when using large numbers of files: some filesystems do
not handle many files in a single directory well.  The B<files> criterion
requires either B<duration>, B<interval> or B<filesize> to be specified to
control when to go to the next file.  It should be noted that each B<-b>
parameter takes exactly one criterion; to specify two criterion, each must be
preceded by the B<-b> option.

Example: B<-b filesize:1000 -b files:5> results in a ring buffer of five files
of size one megabyte each.

=item -B  E<lt>capture buffer sizeE<gt>

Set capture buffer size (in MiB, default is 2 MiB).  This is used by
the capture driver to buffer packet data until that data can be written
to disk.  If you encounter packet drops while capturing, try to increase
this size.  Note that, while B<Tshark> attempts to set the buffer size
to 2 MiB by default, and can be told to set it to a larger value, the
system or interface on which you're capturing might silently limit the
capture buffer size to a lower value or raise it to a higher value.

This is available on UNIX systems with libpcap 1.0.0 or later and on
Windows.  It is not available on UNIX systems with earlier versions of
libpcap.

This option can occur multiple times.  If used before the first
occurrence of the B<-i> option, it sets the default capture buffer size.
If used after an B<-i> option, it sets the capture buffer size for
the interface specified by the last B<-i> option occurring before
this option.  If the capture buffer size is not set specifically,
the default capture buffer size is used instead.

=item -c  E<lt>capture packet countE<gt>

Set the maximum number of packets to read when capturing live
data.  If reading a capture file, set the maximum number of packets to read.

=item -C  E<lt>configuration profileE<gt>

Run with the given configuration profile.

=item -d  E<lt>layer typeE<gt>==E<lt>selectorE<gt>,E<lt>decode-as protocolE<gt>

Like Wireshark's B<Decode As...> feature, this lets you specify how a
layer type should be dissected.  If the layer type in question (for example,
B<tcp.port> or B<udp.port> for a TCP or UDP port number) has the specified
selector value, packets should be dissected as the specified protocol.

Example: B<-d tcp.port==8888,http> will decode any traffic running over
TCP port 8888 as HTTP.

Example: B<-d tcp.port==8888:3,http> will decode any traffic running over
TCP ports 8888, 8889 or 8890 as HTTP.

Example: B<-d tcp.port==8888-8890,http> will decode any traffic running over
TCP ports 8888, 8889 or 8890 as HTTP.

Using an invalid selector or protocol will print out a list of valid selectors
and protocol names, respectively.

Example: B<-d .> is a quick way to get a list of valid selectors.

Example: B<-d ethertype==0x0800.> is a quick way to get a list of protocols that can be
selected with an ethertype.

=item -D

Print a list of the interfaces on which B<TShark> can capture, and
exit.  For each network interface, a number and an
interface name, possibly followed by a text description of the
interface, is printed.  The interface name or the number can be supplied
to the B<-i> option to specify an interface on which to capture.

This can be useful on systems that don't have a command to list them
(UNIX systems lacking B<ifconfig -a> or Linux systems lacking
B<ip link show>). The number can be useful on Windows systems, where
the interface name might be a long name or a GUID.

Note that "can capture" means that B<TShark> was able to open that
device to do a live capture.  Depending on your system you may need to
run tshark from an account with special privileges (for example, as
root) to be able to capture network traffic.  If B<TShark -D> is not run
from such an account, it will not list any interfaces.

=item -e  E<lt>fieldE<gt>

Add a field to the list of fields to display if B<-T ek|fields|json|pdml>
is selected.  This option can be used multiple times on the command line.
At least one field must be provided if the B<-T fields> option is
selected. Column names may be used prefixed with "_ws.col."

Example: B<-e frame.number -e ip.addr -e udp -e _ws.col.Info>

Giving a protocol rather than a single field will print multiple items
of data about the protocol as a single field.  Fields are separated by
tab characters by default.  B<-E> controls the format of the printed
fields.

=item -E  E<lt>field print optionE<gt>

Set an option controlling the printing of fields when B<-T fields> is
selected.

Options are:

B<bom=y|n> If B<y>, prepend output with the UTF-8 byte order mark
(hexadecimal ef, bb, bf). Defaults to B<n>.

B<header=y|n> If B<y>, print a list of the field names given using B<-e>
as the first line of the output; the field name will be separated using
the same character as the field values.  Defaults to B<n>.

B<separator=/t|/s|>E<lt>characterE<gt> Set the separator character to
use for fields.  If B</t> tab will be used (this is the default), if
B</s>, a single space will be used.  Otherwise any character that can be
accepted by the command line as part of the option may be used.

B<occurrence=f|l|a> Select which occurrence to use for fields that have
multiple occurrences.  If B<f> the first occurrence will be used, if B<l>
the last occurrence will be used and if B<a> all occurrences will be used
(this is the default).

B<aggregator=,|/s|>E<lt>characterE<gt> Set the aggregator character to
use for fields that have multiple occurrences.  If B<,> a comma will be used
(this is the default), if B</s>, a single space will be used.  Otherwise
any character that can be accepted by the command line as part of the
option may be used.

B<quote=d|s|n> Set the quote character to use to surround fields.  B<d>
uses double-quotes, B<s> single-quotes, B<n> no quotes (the default).

=item -f  E<lt>capture filterE<gt>

Set the capture filter expression.

This option can occur multiple times.  If used before the first
occurrence of the B<-i> option, it sets the default capture filter expression.
If used after an B<-i> option, it sets the capture filter expression for
the interface specified by the last B<-i> option occurring before
this option.  If the capture filter expression is not set specifically,
the default capture filter expression is used if provided.

Pre-defined capture filter names, as shown in the GUI menu item Capture->Capture Filters,
can be used by prefixing the argument with "predef:".
Example: B<-f "predef:MyPredefinedHostOnlyFilter">

=item -F  E<lt>file formatE<gt>

Set the file format of the output capture file written using the B<-w>
option.  The output written with the B<-w> option is raw packet data, not
text, so there is no B<-F> option to request text output.  The option B<-F>
without a value will list the available formats.

=item -g

This option causes the output file(s) to be created with group-read permission
(meaning that the output file(s) can be read by other members of the calling
user's group).

=item -G  [ E<lt>report typeE<gt> ]

The B<-G> option will cause B<Tshark> to dump one of several types of glossaries
and then exit.  If no specific glossary type is specified, then the B<fields> report will be generated by default.

The available report types include:

B<column-formats> Dumps the column formats understood by tshark.
There is one record per line.  The fields are tab-delimited.

 * Field 1 = format string (e.g. "%rD")
 * Field 2 = text description of format string (e.g. "Dest port (resolved)")

B<currentprefs>  Dumps a copy of the current preferences file to stdout.

B<decodes> Dumps the "layer type"/"decode as" associations to stdout.
There is one record per line.  The fields are tab-delimited.

 * Field 1 = layer type, e.g. "tcp.port"
 * Field 2 = selector in decimal
 * Field 3 = "decode as" name, e.g. "http"

B<defaultprefs>  Dumps a default preferences file to stdout.

B<dissector-tables>  Dumps a list of dissector tables to stdout.  There
is one record per line.  The fields are tab-delimited.

 * Field 1 = dissector table name, e.g. "tcp.port"
 * Field 2 = name used for the dissector table in the GUI
 * Field 3 = type (textual representation of the ftenum type)
 * Field 4 = base for display (for integer types)

B<fieldcount>  Dumps the number of header fields to stdout.

B<fields>  Dumps the contents of the registration database to
stdout.  An independent program can take this output and format it into nice
tables or HTML or whatever.  There is one record per line.  Each record is
either a protocol or a header field, differentiated by the first field.
The fields are tab-delimited.

 * Protocols
 * ---------
 * Field 1 = 'P'
 * Field 2 = descriptive protocol name
 * Field 3 = protocol abbreviation
 *
 * Header Fields
 * -------------
 * Field 1 = 'F'
 * Field 2 = descriptive field name
 * Field 3 = field abbreviation
 * Field 4 = type (textual representation of the ftenum type)
 * Field 5 = parent protocol abbreviation
 * Field 6 = base for display (for integer types); "parent bitfield width" for FT_BOOLEAN
 * Field 7 = bitmask: format: hex: 0x....
 * Field 8 = blurb describing field

B<folders> Dumps various folders used by tshark.  This is essentially the
same data reported in Wireshark's About | Folders tab.
There is one record per line.  The fields are tab-delimited.

 * Field 1 = Folder type (e.g "Personal configuration:")
 * Field 2 = Folder location (e.g. "/home/vagrant/.config/wireshark/")

B<ftypes> Dumps the "ftypes" (fundamental types) understood by tshark.
There is one record per line.  The fields are tab-delimited.

 * Field 1 = FTYPE (e.g "FT_IPv6")
 * Field 2 = text description of type (e.g. "IPv6 address")

B<heuristic-decodes> Dumps the heuristic decodes currently installed.
There is one record per line.  The fields are tab-delimited.

 * Field 1 = underlying dissector (e.g. "tcp")
 * Field 2 = name of heuristic decoder (e.g. ucp")
 * Field 3 = heuristic enabled (e.g. "T" or "F")

B<plugins> Dumps the plugins currently installed.
There is one record per line.  The fields are tab-delimited.

 * Field 1 = plugin library (e.g. "gryphon.so")
 * Field 2 = plugin version (e.g. 0.0.4)
 * Field 3 = plugin type (e.g. "dissector" or "tap")
 * Field 4 = full path to plugin file

B<protocols> Dumps the protocols in the registration database to stdout.
An independent program can take this output and format it into nice tables
or HTML or whatever.  There is one record per line.  The fields are tab-delimited.

 * Field 1 = protocol name
 * Field 2 = protocol short name
 * Field 3 = protocol filter name

B<values> Dumps the value_strings, range_strings or true/false strings
for fields that have them.  There is one record per line.  Fields are
tab-delimited.  There are three types of records: Value String, Range
String and True/False String.  The first field, 'V', 'R' or 'T', indicates
the type of record.

 * Value Strings
 * -------------
 * Field 1 = 'V'
 * Field 2 = field abbreviation to which this value string corresponds
 * Field 3 = Integer value
 * Field 4 = String
 *
 * Range Strings
 * -------------
 * Field 1 = 'R'
 * Field 2 = field abbreviation to which this range string corresponds
 * Field 3 = Integer value: lower bound
 * Field 4 = Integer value: upper bound
 * Field 5 = String
 *
 * True/False Strings
 * ------------------
 * Field 1 = 'T'
 * Field 2 = field abbreviation to which this true/false string corresponds
 * Field 3 = True String
 * Field 4 = False String

=item -h

Print the version and options and exits.

=item -H  E<lt>input hosts fileE<gt>

Read a list of entries from a "hosts" file, which will then be written
to a capture file.  Implies B<-W n>. Can be called multiple times.

The "hosts" file format is documented at
L<http://en.wikipedia.org/wiki/Hosts_(file)>.

=item -i  E<lt>capture interfaceE<gt> | -

Set the name of the network interface or pipe to use for live packet
capture.

Network interface names should match one of the names listed in
"B<tshark -D>" (described above); a number, as reported by
"B<tshark -D>", can also be used.  If you're using UNIX, "B<netstat
-i>" or "B<ifconfig -a>" might also work to list interface names,
although not all versions of UNIX support the B<-a> option to B<ifconfig>.

If no interface is specified, B<TShark> searches the list of
interfaces, choosing the first non-loopback interface if there are any
non-loopback interfaces, and choosing the first loopback interface if
there are no non-loopback interfaces.  If there are no interfaces at all,
B<TShark> reports an error and doesn't start the capture.

Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
read data from the standard input.  Data read from pipes must be in
standard pcap format.

This option can occur multiple times.  When capturing from multiple
interfaces, the capture file will be saved in pcap-ng format.

Note: the Win32 version of B<TShark> doesn't support capturing from
pipes!

=item -I

Put the interface in "monitor mode"; this is supported only on IEEE
802.11 Wi-Fi interfaces, and supported only on some operating systems.

Note that in monitor mode the adapter might disassociate from the
network with which it's associated, so that you will not be able to use
any wireless networks with that adapter.  This could prevent accessing
files on a network server, or resolving host names or network addresses,
if you are capturing in monitor mode and are not connected to another
network with another adapter.

This option can occur multiple times.  If used before the first
occurrence of the B<-i> option, it enables the monitor mode for all interfaces.
If used after an B<-i> option, it enables the monitor mode for
the interface specified by the last B<-i> option occurring before
this option.

=item -j  E<lt>protocol match filterE<gt>

Protocol match filter used for ek|json|jsonraw|pdml output file types.
Parent node containing multiple child nodes is only included,
if the name is found in the filter.

Example: B<-j "ip ip.flags text">

=item -J  E<lt>protocol match filterE<gt>

Protocol top level filter used for ek|json|jsonraw|pdml output file types.
Parent node containing multiple child nodes is included with all children.

Example: B<-J "http tcp">

=item -K  E<lt>keytabE<gt>

Load kerberos crypto keys from the specified keytab file.
This option can be used multiple times to load keys from several files.

Example: B<-K krb5.keytab>

=item -l

Flush the standard output after the information for each packet is
printed.  (This is not, strictly speaking, line-buffered if B<-V>
was specified; however, it is the same as line-buffered if B<-V> wasn't
specified, as only one line is printed for each packet, and, as B<-l> is
normally used when piping a live capture to a program or script, so that
output for a packet shows up as soon as the packet is seen and
dissected, it should work just as well as true line-buffering.  We do
this as a workaround for a deficiency in the Microsoft Visual C++ C
library.)

This may be useful when piping the output of B<TShark> to another
program, as it means that the program to which the output is piped will
see the dissected data for a packet as soon as B<TShark> sees the
packet and generates that output, rather than seeing it only when the
standard output buffer containing that data fills up.

=item -L

List the data link types supported by the interface and exit.  The reported
link types can be used for the B<-y> option.

=item -n

Disable network object name resolution (such as hostname, TCP and UDP port
names); the B<-N> flag might override this one.

=item -N  E<lt>name resolving flagsE<gt>

Turn on name resolving only for particular types of addresses and port
numbers, with name resolving for other types of addresses and port
numbers turned off.  This flag overrides B<-n> if both B<-N> and B<-n> are
present.  If both B<-N> and B<-n> flags are not present, all name resolutions
are turned on.

The argument is a string that may contain the letters:

B<d> to enable resolution from captured DNS packets

B<m> to enable MAC address resolution

B<n> to enable network address resolution

B<N> to enable using external resolvers (e.g., DNS) for network address
resolution

B<t> to enable transport-layer port number resolution

=item -o  E<lt>preferenceE<gt>:E<lt>valueE<gt>

Set a preference value, overriding the default value and any value read
from a preference file.  The argument to the option is a string of the
form I<prefname>B<:>I<value>, where I<prefname> is the name of the
preference (which is the same name that would appear in the preference
file), and I<value> is the value to which it should be set.

=item -O  E<lt>protocolsE<gt>

Similar to the B<-V> option, but causes B<TShark> to only show a detailed view
of the comma-separated list of I<protocols> specified, rather than a detailed
view of all protocols.  Use the output of "B<tshark -G protocols>" to find the
abbreviations of the protocols you can specify.

=item -p

I<Don't> put the interface into promiscuous mode.  Note that the
interface might be in promiscuous mode for some other reason; hence,
B<-p> cannot be used to ensure that the only traffic that is captured is
traffic sent to or from the machine on which B<TShark> is running,
broadcast traffic, and multicast traffic to addresses received by that
machine.

This option can occur multiple times.  If used before the first
occurrence of the B<-i> option, no interface will be put into the
promiscuous mode.
If used after an B<-i> option, the interface specified by the last B<-i>
option occurring before this option will not be put into the
promiscuous mode.

=item -P

Decode and display the packet summary, even if writing raw packet data using
the B<-w> option.

=item -q

When capturing packets, don't display the continuous count of packets
captured that is normally shown when saving a capture to a file;
instead, just display, at the end of the capture, a count of packets
captured.  On systems that support the SIGINFO signal, such as various
BSDs, you can cause the current count to be displayed by typing your
"status" character (typically control-T, although it
might be set to "disabled" by default on at least some BSDs, so you'd
have to explicitly set it to use it).

When reading a capture file, or when capturing and not saving to a file,
don't print packet information; this is useful if you're using a B<-z>
option to calculate statistics and don't want the packet information
printed, just the statistics.

=item -Q

When capturing packets, only display true errors.  This outputs less
than the B<-q> option, so the interface name and total packet
count and the end of a capture are not sent to stderr.

=item -r  E<lt>infileE<gt>

Read packet data from I<infile>, can be any supported capture file format
(including gzipped files).  It is possible to use named pipes or stdin (-)
here but only with certain (not compressed) capture file formats (in
particular: those that can be read without seeking backwards).

=item -R  E<lt>Read filterE<gt>

Cause the specified filter (which uses the syntax of read/display filters,
rather than that of capture filters) to be applied during the first pass of
analysis. Packets not matching the filter are not considered for future
passes. Only makes sense with multiple passes, see -2. For regular filtering
on single-pass dissect see -Y instead.

Note that forward-looking fields such as 'response in frame #' cannot be used
with this filter, since they will not have been calculate when this filter is
applied.

=item -s  E<lt>capture snaplenE<gt>

Set the default snapshot length to use when capturing live data.
No more than I<snaplen> bytes of each network packet will be read into
memory, or saved to disk.  A value of 0 specifies a snapshot length of
262144, so that the full packet is captured; this is the default.

This option can occur multiple times.  If used before the first
occurrence of the B<-i> option, it sets the default snapshot length.
If used after an B<-i> option, it sets the snapshot length for
the interface specified by the last B<-i> option occurring before
this option.  If the snapshot length is not set specifically,
the default snapshot length is used if provided.

=item -S  E<lt>separatorE<gt>

Set the line separator to be printed between packets.

=item -t  a|ad|adoy|d|dd|e|r|u|ud|udoy

Set the format of the packet timestamp printed in summary lines.
The format can be one of:

B<a> absolute: The absolute time, as local time in your time zone,
is the actual time the packet was captured, with no date displayed

B<ad> absolute with date: The absolute date, displayed as YYYY-MM-DD,
and time, as local time in your time zone, is the actual time and date
the packet was captured

B<adoy> absolute with date using day of year: The absolute date,
displayed as YYYY/DOY, and time, as local time in your time zone,
is the actual time and date the packet was captured

B<d> delta: The delta time is the time since the previous packet was
captured

B<dd> delta_displayed: The delta_displayed time is the time since the
previous displayed packet was captured

B<e> epoch: The time in seconds since epoch (Jan 1, 1970 00:00:00)

B<r> relative: The relative time is the time elapsed between the first packet
and the current packet

B<u> UTC: The absolute time, as UTC, is the actual time the packet was
captured, with no date displayed

B<ud> UTC with date: The absolute date, displayed as YYYY-MM-DD,
and time, as UTC, is the actual time and date the packet was captured

B<udoy> UTC with date using day of year: The absolute date, displayed
as YYYY/DOY, and time, as UTC, is the actual time and date the packet
was captured

The default format is relative.

=item -T  ek|fields|json|jsonraw|pdml|ps|psml|tabs|text

Set the format of the output when viewing decoded packet data.  The
options are one of:

B<ek> Newline delimited JSON format for bulk import into Elasticsearch.
It can be used with B<-j> or B<-J> including the JSON filter or with
B<-x> flag to include raw hex-encoded packet data.
Example of usage to import data into Elasticsearch:

  tshark -T ek -j "http tcp ip" -x -r file.pcap > file.json
  curl -XPUT http://elasticsearch:9200/_bulk --data-binary @file.json

B<fields> The values of fields specified with the B<-e> option, in a
form specified by the B<-E> option.  For example,

  -T fields -E separator=, -E quote=d

would generate comma-separated values (CSV) output suitable for importing
into your favorite spreadsheet program.

B<json> JSON file format. It can be used with B<-j> or B<-J> including
the JSON filter or with B<-x> flag to include raw hex-encoded packet data.
Example of usage:

  tshark -T json -r file.pcap
  tshark -T json -j "http tcp ip" -x -r file.pcap

B<jsonraw> JSON file format including only raw hex-encoded packet data.
It can be used with B<-j> including or B<-J >the JSON filter flag.
Example of usage:

  tshark -T jsonraw -r file.pcap
  tshark -T jsonraw -j "http tcp ip" -x -r file.pcap

B<pdml> Packet Details Markup Language, an XML-based format for the details of
a decoded packet.  This information is equivalent to the packet details
printed with the B<-V> flag.
Using the --color option will add color attributes to B<pdml> output. These
attributes are nonstandard.

B<ps> PostScript for a human-readable one-line summary of each of the packets,
or a multi-line view of the details of each of the packets, depending on
whether the B<-V> flag was specified.

B<psml> Packet Summary Markup Language, an XML-based format for the summary
information of a decoded packet.  This information is equivalent to the
information shown in the one-line summary printed by default.
Using the --color option will add color attributes to B<pdml> output. These
attributes are nonstandard.

B<tabs> Similar to the default B<text> report except the human-readable one-line
summary of each packet will include an ASCII horizontal tab (0x09) character
as a delimiter between each column.

B<text> Text of a human-readable one-line summary of each of the packets, or a
multi-line view of the details of each of the packets, depending on
whether the B<-V> flag was specified.  This is the default.

=item -u E<lt>seconds typeE<gt>

Specifies the seconds type.  Valid choices are:

B<s> for seconds

B<hms> for hours, minutes and seconds

=item -U E<lt>tap nameE<gt>

PDUs export, exports PDUs from infile to outfile according to the tap name given. Use -Y to filter.

Enter an empty tap name "" to get a list of available names.

=item -v

Print the version and exit.

=item -V

Cause B<TShark> to print a view of the packet details.

=item -w  E<lt>outfileE<gt> | -

Write raw packet data to I<outfile> or to the standard output if
I<outfile> is '-'.

NOTE: -w provides raw packet data, not text.  If you want text output
you need to redirect stdout (e.g. using '>'), don't use the B<-w>
option for this.

=item -W  E<lt>file format optionE<gt>

Save extra information in the file if the format supports it.  For
example,

  -F pcapng -W n

will save host name resolution records along with captured packets.

Future versions of Wireshark may automatically change the capture format to
B<pcapng> as needed.

The argument is a string that may contain the following letter:

B<n> write network address resolution information (pcapng only)

=item -x

Cause B<TShark> to print a hex and ASCII dump of the packet data
after printing the summary and/or details, if either are also being displayed.

=item -X E<lt>eXtension optionsE<gt>

Specify an option to be passed to a B<TShark> module.  The eXtension option
is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:

B<lua_script>:I<lua_script_filename> tells B<TShark> to load the given script in addition to the
default Lua scripts.

B<lua_script>I<num>:I<argument> tells B<TShark> to pass the given argument
to the lua script identified by 'num', which is the number indexed order of the 'lua_script' command.
For example, if only one script was loaded with '-X lua_script:my.lua', then '-X lua_script1:foo'
will pass the string 'foo' to the 'my.lua' script.  If two scripts were loaded, such as '-X lua_script:my.lua'
and '-X lua_script:other.lua' in that order, then a '-X lua_script2:bar' would pass the string 'bar' to the second lua
script, namely 'other.lua'.

B<read_format>:I<file_format> tells B<TShark> to use the given file format to read in the
file (the file given in the B<-r> command option). Providing no I<file_format> argument, or
an invalid one, will produce a file of available file formats to use.

=item -y  E<lt>capture link typeE<gt>

Set the data link type to use while capturing packets.  The values
reported by B<-L> are the values that can be used.

This option can occur multiple times.  If used before the first
occurrence of the B<-i> option, it sets the default capture link type.
If used after an B<-i> option, it sets the capture link type for
the interface specified by the last B<-i> option occurring before
this option.  If the capture link type is not set specifically,
the default capture link type is used if provided.

=item -Y  E<lt>displaY filterE<gt>

Cause the specified filter (which uses the syntax of read/display filters,
rather than that of capture filters) to be applied before printing a
decoded form of packets or writing packets to a file.  Packets matching the
filter are printed or written to file; packets that the matching packets
depend upon (e.g., fragments), are not printed but are written to file;
packets not matching the filter nor depended upon are discarded rather
than being printed or written.

Use this instead of -R for filtering using single-pass analysis. If doing
two-pass analysis (see -2) then only packets matching the read filter (if there
is one) will be checked against this filter.

=item -M  E<lt>auto session resetE<gt>

Automatically reset internal session when reached to specified number of packets.
for example,

    -M 100000

will reset session every 100000 packets.

This feature does not support -2 two-pass analysis

=item -z  E<lt>statisticsE<gt>

Get B<TShark> to collect various types of statistics and display the result
after finishing reading the capture file.  Use the B<-q> flag if you're
reading a capture file and only want the statistics printed, not any
per-packet information.

Note that the B<-z proto> option is different - it doesn't cause
statistics to be gathered and printed when the capture is complete, it
modifies the regular packet summary output to include the values of
fields specified with the option.  Therefore you must not use the B<-q>
option, as that option would suppress the printing of the regular packet
summary output, and must also not use the B<-V> option, as that would
cause packet detail information rather than packet summary information
to be printed.

Currently implemented statistics are:

=over 4

=item B<-z help>

Display all possible values for B<-z>.

=item B<-z> afp,srt[,I<filter>]

Show Apple Filing Protocol service response time statistics.

=item B<-z> camel,srt

=item B<-z> compare,I<start>,I<stop>,I<ttl[0|1]>,I<order[0|1]>,I<variance>[,I<filter>]

If the optional I<filter> is specified, only those packets that match the
filter will be used in the calculations.

=item B<-z> conv,I<type>[,I<filter>]

Create a table that lists all conversations that could be seen in the
capture.  I<type> specifies the conversation endpoint types for which we
want to generate the statistics; currently the supported ones are:

  "bluetooth"  Bluetooth addresses
  "eth"   Ethernet addresses
  "fc"    Fibre Channel addresses
  "fddi"  FDDI addresses
  "ip"    IPv4 addresses
  "ipv6"  IPv6 addresses
  "ipx"   IPX addresses
  "jxta"  JXTA message addresses
  "ncp"   NCP connections
  "rsvp"  RSVP connections
  "sctp"  SCTP addresses
  "tcp"   TCP/IP socket pairs  Both IPv4 and IPv6 are supported
  "tr"    Token Ring addresses
  "usb"   USB addresses
  "udp"   UDP/IP socket pairs  Both IPv4 and IPv6 are supported
  "wlan"  IEEE 802.11 addresses

If the optional I<filter> is specified, only those packets that match the
filter will be used in the calculations.

The table is presented with one line for each conversation and displays
the number of packets/bytes in each direction as well as the total
number of packets/bytes.  The table is sorted according to the total
number of frames.

=item B<-z> dcerpc,srt,I<uuid>,I<major>.I<minor>[,I<filter>]

Collect call/reply SRT (Service Response Time) data for DCERPC interface I<uuid>,
version I<major>.I<minor>.
Data collected is the number of calls for each procedure, MinSRT, MaxSRT
and AvgSRT.

Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0>> will collect data for the CIFS SAMR Interface.

This option can be used multiple times on the command line.

If the optional I<filter> is provided, the stats will only be calculated
on those calls that match that filter.

Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0,ip.addr==1.2.3.4>> will collect SAMR
SRT statistics for a specific host.

=item B<-z> bootp,stat[,I<filter>]

Show DHCP (BOOTP) statistics.

=item B<-z> diameter,avp[,I<cmd.code>,I<field>,I<field>,I<...>]

This option enables extraction of most important diameter fields from large capture files.
Exactly one text line for each diameter message with matched B<diameter.cmd.code> will be printed.

Empty diameter command code or '*' can be specified to mach any B<diameter.cmd.code>

Example: B<-z diameter,avp>  extract default field set from diameter messages.

Example: B<-z diameter,avp,280>  extract default field set from diameter DWR messages.

Example: B<-z diameter,avp,272>  extract default field set from diameter CC messages.

Extract most important fields from diameter CC messages:

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>

Following fields will be printed out for each diameter message:

  "frame"        Frame number.
  "time"         Unix time of the frame arrival.
  "src"          Source address.
  "srcport"      Source port.
  "dst"          Destination address.
  "dstport"      Destination port.
  "proto"        Constant string 'diameter', which can be used for post processing of tshark output.  E.g. grep/sed/awk.
  "msgnr"        seq. number of diameter message within the frame.  E.g. '2' for the third diameter message in the same frame.
  "is_request"   '0' if message is a request, '1' if message is an answer.
  "cmd"          diameter.cmd_code, E.g. '272' for credit control messages.
  "req_frame"    Number of frame where matched request was found or '0'.
  "ans_frame"    Number of frame where matched answer was found or '0'.
  "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.

B<-z diameter,avp> option is much faster than B<-V -T text> or B<-T pdml> options.

B<-z diameter,avp> option is more powerful than B<-T field> and B<-z proto,colinfo> options.

Multiple diameter messages in one frame are supported.

Several fields with same name within one diameter message are supported, e.g. I<diameter.Subscription-Id-Data> or I<diameter.Rating-Group>.

Note: B<tshark -q> option is recommended to suppress default B<tshark> output.

=item B<-z> dns,tree[,I<filter>]

Create a summary of the captured DNS packets. General information are collected such as qtype and qclass distribution.
For some data (as qname length or DNS payload) max, min and average values are also displayed.

=item B<-z> endpoints,I<type>[,I<filter>]

Create a table that lists all endpoints that could be seen in the
capture.  I<type> specifies the endpoint types for which we
want to generate the statistics; currently the supported ones are:

  "bluetooth"  Bluetooth addresses
  "eth"   Ethernet addresses
  "fc"    Fibre Channel addresses
  "fddi"  FDDI addresses
  "ip"    IPv4 addresses
  "ipv6"  IPv6 addresses
  "ipx"   IPX addresses
  "jxta"  JXTA message addresses
  "ncp"   NCP connections
  "rsvp"  RSVP connections
  "sctp"  SCTP addresses
  "tcp"   TCP/IP socket pairs  Both IPv4 and IPv6 are supported
  "tr"    Token Ring addresses
  "usb"   USB addresses
  "udp"   UDP/IP socket pairs  Both IPv4 and IPv6 are supported
  "wlan"  IEEE 802.11 addresses

If the optional I<filter> is specified, only those packets that match the
filter will be used in the calculations.

The table is presented with one line for each conversation and displays
the number of packets/bytes in each direction as well as the total
number of packets/bytes.  The table is sorted according to the total
number of frames.

=item B<-z> expert[I<,error|,warn|,note|,chat>][I<,filter>]

Collects information about all expert info, and will display them in order,
grouped by severity.

Example: B<-z expert,sip> will show expert items of all severity for frames that
match the sip protocol.

This option can be used multiple times on the command line.

If the optional I<filter> is provided, the stats will only be calculated
on those calls that match that filter.

Example: B<-z "expert,note,tcp"> will only collect expert items for frames that
include the tcp protocol, with a severity of note or higher.

=item B<-z> flow,I<name>,I<mode>,[I<filter>]

Displays the flow of data between two nodes. Output is the same as ASCII format
saved from GUI.

I<name> specifies the flow name.  It can be one of:

  any      All frames
  icmp     ICMP
  icmpv6   ICMPv6
  lbm_uim  UIM
  tcp      TCP

I<mode> specifies the address type.  It can be one of:

  standard   Any address
  network    Network address

Example: B<-z flow,tcp,network> will show data flow for all TCP frames

=item B<-z> follow,I<prot>,I<mode>,I<filter>[I<,range>]

Displays the contents of a TCP or UDP stream between two nodes.  The data
sent by the second node is prefixed with a tab to differentiate it from the
data sent by the first node.

I<prot> specifies the transport protocol.  It can be one of:

  tcp   TCP
  udp   UDP
  ssl   SSL

I<mode> specifies the output mode.  It can be one of:

  ascii  ASCII output with dots for non-printable characters
  ebcdic EBCDIC output with dots for non-printable characters
  hex    Hexadecimal and ASCII data with offsets
  raw    Hexadecimal data

Since the output in B<ascii> or B<ebcdic> mode may contain newlines, the length
of each section of output plus a newline precedes each section of output.

I<filter> specifies the stream to be displayed. UDP/TCP streams are selected
with either the stream index or IP address plus port pairs. SSL streams are
selected with the stream index. For example:

  ip-addr0:port0,ip-addr1:port1
  stream-index

I<range> optionally specifies which "chunks" of the stream should be displayed.

Example: B<-z "follow,tcp,hex,1"> will display the contents of the second TCP
stream (the first is stream 0) in "hex" format.

  ===================================================================
  Follow: tcp,hex
  Filter: tcp.stream eq 1
  Node 0: 200.57.7.197:32891
  Node 1: 200.57.7.198:2906
  00000000  00 00 00 22 00 00 00 07  00 0a 85 02 07 e9 00 02  ...".... ........
  00000010  07 e9 06 0f 00 0d 00 04  00 00 00 01 00 03 00 06  ........ ........
  00000020  1f 00 06 04 00 00                                 ......
  00000000  00 01 00 00                                       ....
  00000026  00 02 00 00

Example: B<-z "follow,tcp,ascii,200.57.7.197:32891,200.57.7.198:2906"> will
display the contents of a TCP stream between 200.57.7.197 port 32891 and
200.57.7.98 port 2906.

  ===================================================================
  Follow: tcp,ascii
  Filter: (omitted for readability)
  Node 0: 200.57.7.197:32891
  Node 1: 200.57.7.198:2906
  38
  ...".....
  ................
  4
  ....

=item B<-z> h225,counter[I<,filter>]

Count ITU-T H.225 messages and their reasons.  In the first column you get a
list of H.225 messages and H.225 message reasons, which occur in the current
capture file.  The number of occurrences of each message or reason is displayed
in the second column.

Example: B<-z h225,counter>.

If the optional I<filter> is provided, the stats will only be calculated
on those calls that match that filter.
Example: use B<-z "h225,counter,ip.addr==1.2.3.4"> to only collect stats for
H.225 packets exchanged by the host at IP address 1.2.3.4 .

This option can be used multiple times on the command line.

=item B<-z> h225,srt[I<,filter>]

Collect requests/response SRT (Service Response Time) data for ITU-T H.225 RAS.
Data collected is number of calls of each ITU-T H.225 RAS Message Type,
Minimum SRT, Maximum SRT, Average SRT, Minimum in Packet, and Maximum in Packet.
You will also get the number of Open Requests (Unresponded Requests),
Discarded Responses (Responses without matching request) and Duplicate Messages.

Example: B<-z h225,srt>

This option can be used multiple times on the command line.

If the optional I<filter> is provided, the stats will only be calculated
on those calls that match that filter.

Example: B<-z "h225,srt,ip.addr==1.2.3.4"> will only collect stats for
ITU-T H.225 RAS packets exchanged by the host at IP address 1.2.3.4 .

=item B<-z> hosts[,ipv4][,ipv6]

Dump any collected IPv4 and/or IPv6 addresses in "hosts" format.  Both IPv4
and IPv6 addresses are dumped by default.

Addresses are collected from a number of sources, including standard "hosts"
files and captured traffic.

=item B<-z> hpfeeds,tree[,I<filter>]

Calculate statistics for HPFEEDS traffic such as publish per channel, and opcode
distribution.

=item B<-z> http,stat,

Calculate the HTTP statistics distribution. Displayed values are
the HTTP status codes and the HTTP request methods.

=item B<-z> http,tree

Calculate the HTTP packet distribution. Displayed values are the
HTTP request modes and the HTTP status codes.

=item B<-z> http_req,tree

Calculate the HTTP requests by server. Displayed values are the
server name and the URI path.

=item B<-z> http_srv,tree

Calculate the HTTP requests and responses by server. For the HTTP
requests, displayed values are the server IP address and server
hostname. For the HTTP responses, displayed values are the server
IP address and status.

=item B<-z> icmp,srt[,I<filter>]

Compute total ICMP echo requests, replies, loss, and percent loss, as well as
minimum, maximum, mean, median and sample standard deviation SRT statistics
typical of what ping provides.

Example: S<B<-z icmp,srt,ip.src==1.2.3.4>> will collect ICMP SRT statistics
for ICMP echo request packets originating from a specific host.

This option can be used multiple times on the command line.

=item B<-z> icmpv6,srt[,I<filter>]

Compute total ICMPv6 echo requests, replies, loss, and percent loss, as well as
minimum, maximum, mean, median and sample standard deviation SRT statistics
typical of what ping provides.

Example: S<B<-z icmpv6,srt,ipv6.src==fe80::1>> will collect ICMPv6 SRT statistics
for ICMPv6 echo request packets originating from a specific host.

This option can be used multiple times on the command line.

=item B<-z> io,phs[,I<filter>]

Create Protocol Hierarchy Statistics listing both number of packets and bytes.
If no I<filter> is specified the statistics will be calculated for all packets.
If a I<filter> is specified statistics will only be calculated for those
packets that match the filter.

This option can be used multiple times on the command line.

=item B<-z> io,stat,I<interval>[,I<filter>][,I<filter>][,I<filter>]...

Collect packet/bytes statistics for the capture in intervals of
I<interval> seconds.  I<Interval> can be specified either as a whole or
fractional second and can be specified with microsecond (us) resolution.
If I<interval> is 0, the statistics will be calculated over all packets.

If no I<filter> is specified the statistics will be calculated for all packets.
If one or more I<filters> are specified statistics will be calculated for
all filters and presented with one column of statistics for each filter.

This option can be used multiple times on the command line.

Example: B<-z io,stat,1,ip.addr==1.2.3.4> will generate 1 second
statistics for all traffic to/from host 1.2.3.4.

Example: B<-z "io,stat,0.001,smb&&ip.addr==1.2.3.4"> will generate 1ms
statistics for all SMB packets to/from host 1.2.3.4.

The examples above all use the standard syntax for generating statistics
which only calculates the number of packets and bytes in each interval.

B<io,stat> can also do much more statistics and calculate COUNT(), SUM(),
MIN(), MAX(), AVG() and LOAD() using a slightly different filter syntax:

=item -z io,stat,I<interval>,E<34>[COUNT|SUM|MIN|MAX|AVG|LOAD](I<field>)I<filter>E<34>

NOTE: One important thing to note here is that the filter is not optional
and that the field that the calculation is based on MUST be part of the filter
string or the calculation will fail.

So: B<-z io,stat,0.010,AVG(smb.time)> does not work.  Use B<-z
io,stat,0.010,AVG(smb.time)smb.time> instead.  Also be aware that a field
can exist multiple times inside the same packet and will then be counted
multiple times in those packets.

NOTE: A second important thing to note is that the system setting for
decimal separator must be set to "."! If it is set to "," the statistics
will not be displayed per filter.

B<COUNT(I<field>)I<filter>> - Calculates the number of times that the
field I<name> (not its value) appears per interval in the filtered packet list.
''I<field>'' can be any display filter name.

Example: B<-z io,stat,0.010,E<34>COUNT(smb.sid)smb.sidE<34>>

This will count the total number of SIDs seen in each 10ms interval.

B<SUM(I<field>)I<filter>> - Unlike COUNT, the I<values> of the
specified field are summed per time interval.
''I<field>'' can only be a named integer, float, double or relative time field.

Example: B<-z io,stat,0.010,E<34>SUM(frame.len)frame.lenE<34>>

Reports the total number of bytes that were transmitted bidirectionally in
all the packets within a 10 millisecond interval.

B<MIN/MAX/AVG(I<field>)I<filter>> - The minimum, maximum, or average field value
in each interval is calculated.  The specified field must be a named integer,
float, double or relative time field.  For relative time fields, the output is presented in
seconds with six decimal digits of precision rounded to the nearest microsecond.

In the following example, the time of the first Read_AndX call, the last Read_AndX
response values are displayed and the minimum, maximum, and average Read response times
(SRTs) are calculated.  NOTE: If the DOS command shell line continuation character, ''^''
is used, each line cannot end in a comma so it is placed at the beginning of each
continuation line:

  tshark -o tcp.desegment_tcp_streams:FALSE -n -q -r smb_reads.cap -z io,stat,0,
  "MIN(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==0",
  "MAX(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==1",
  "MIN(smb.time)smb.time and smb.cmd==0x2e",
  "MAX(smb.time)smb.time and smb.cmd==0x2e",
  "AVG(smb.time)smb.time and smb.cmd==0x2e"


  ======================================================================================================
  IO Statistics
  Column #0: MIN(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==0
  Column #1: MAX(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==1
  Column #2: MIN(smb.time)smb.time and smb.cmd==0x2e
  Column #3: MAX(smb.time)smb.time and smb.cmd==0x2e
  Column #4: AVG(smb.time)smb.time and smb.cmd==0x2e
                  |    Column #0   |    Column #1   |    Column #2   |    Column #3   |    Column #4   |
  Time            |       MIN      |       MAX      |       MIN      |       MAX      |       AVG      |
  000.000-                 0.000000         7.704054         0.000072         0.005539         0.000295
  ======================================================================================================

The following command displays the average SMB Read response PDU size, the
total number of read PDU bytes, the average SMB Write request PDU size, and
the total number of bytes transferred in SMB Write PDUs:

  tshark -n -q -r smb_reads_writes.cap -z io,stat,0,
  "AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to",
  "SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to",
  "AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to",
  "SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to"

  =====================================================================================
  IO Statistics
  Column #0: AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to
  Column #1: SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to
  Column #2: AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to
  Column #3: SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to
                  |    Column #0   |    Column #1   |    Column #2   |    Column #3   |
  Time            |       AVG      |       SUM      |       AVG      |       SUM      |
  000.000-                    30018         28067522               72             3240
  =====================================================================================

B<LOAD(I<field>)I<filter>> - The LOAD/Queue-Depth
in each interval is calculated.  The specified field must be a relative time field that represents a response time.  For example smb.time.
For each interval the Queue-Depth for the specified protocol is calculated.

The following command displays the average SMB LOAD.
A value of 1.0 represents one I/O in flight.

  tshark -n -q -r smb_reads_writes.cap
  -z "io,stat,0.001,LOAD(smb.time)smb.time"

  ============================================================================
  IO Statistics
  Interval:   0.001000 secs
  Column #0: LOAD(smb.time)smb.time
                          |    Column #0   |
  Time                    |       LOAD     |
  0000.000000-0000.001000         1.000000
  0000.001000-0000.002000         0.741000
  0000.002000-0000.003000         0.000000
  0000.003000-0000.004000         1.000000



B<FRAMES | BYTES[()I<filter>]> - Displays the total number of frames or bytes.
The filter field is optional but if included it must be prepended with ''()''.

The following command displays five columns: the total number of frames and bytes
(transferred bidirectionally) using a single comma, the same two stats using the FRAMES and BYTES
subcommands, the total number of frames containing at least one SMB Read response, and
the total number of bytes transmitted to the client (unidirectionally) at IP address 10.1.0.64.

  tshark -o tcp.desegment_tcp_streams:FALSE -n -q -r smb_reads.cap -z io,stat,0,,FRAMES,BYTES,
  "FRAMES()smb.cmd==0x2e and smb.response_to","BYTES()ip.dst==10.1.0.64"

  =======================================================================================================================
  IO Statistics
  Column #0:
  Column #1: FRAMES
  Column #2: BYTES
  Column #3: FRAMES()smb.cmd==0x2e and smb.response_to
  Column #4: BYTES()ip.dst==10.1.0.64
                  |            Column #0            |    Column #1   |    Column #2   |    Column #3   |    Column #4   |
  Time            |     Frames     |      Bytes     |     FRAMES     |     BYTES      |     FRAMES     |     BYTES      |
  000.000-                    33576         29721685            33576         29721685              870         29004801
  =======================================================================================================================

=item B<-z> mac-lte,stat[I<,filter>]

This option will activate a counter for LTE MAC messages.  You will get
information about the maximum number of UEs/TTI, common messages and
various counters for each UE that appears in the log.

Example: B<-z mac-lte,stat>.

This option can be used multiple times on the command line.

If the optional I<filter> is provided, the stats will only be calculated
for those frames that match that filter.
Example: B<-z "mac-lte,stat,mac-lte.rnti>3000"> will only collect stats for
UEs with an assigned RNTI whose value is more than 3000.

=item B<-z> megaco,rtd[I<,filter>]

Collect requests/response RTD (Response Time Delay) data for MEGACO.
(This is similar to B<-z smb,srt>).  Data collected is the number of calls
for each known MEGACO Type, MinRTD, MaxRTD and AvgRTD.
Additionally you get the number of duplicate requests/responses,
unresponded requests, responses, which don't match with any request.
Example: B<-z megaco,rtd>.

If the optional I<filter> is provided, the stats will only be calculated
on those calls that match that filter.
Example: B<-z "megaco,rtd,ip.addr==1.2.3.4"> will only collect stats for
MEGACO packets exchanged by the host at IP address 1.2.3.4 .

This option can be used multiple times on the command line.

=item B<-z> mgcp,rtd[I<,filter>]

Collect requests/response RTD (Response Time Delay) data for MGCP.
(This is similar to B<-z smb,srt>).  Data collected is the number of calls
for each known MGCP Type, MinRTD, MaxRTD and AvgRTD.
Additionally you get the number of duplicate requests/responses,
unresponded requests, responses, which don't match with any request.
Example: B<-z mgcp,rtd>.

This option can be used multiple times on the command line.

If the optional I<filter> is provided, the stats will only be calculated
on those calls that match that filter.
Example: B<-z "mgcp,rtd,ip.addr==1.2.3.4"> will only collect stats for
MGCP packets exchanged by the host at IP address 1.2.3.4 .

=item B<-z> proto,colinfo,I<filter>,I<field>

Append all I<field> values for the packet to the Info column of the
one-line summary output.
This feature can be used to append arbitrary fields to the Info column
in addition to the normal content of that column.
I<field> is the display-filter name of a field which value should be placed
in the Info column.
I<filter> is a filter string that controls for which packets the field value
will be presented in the info column.  I<field> will only be presented in the
Info column for the packets which match I<filter>.

NOTE: In order for B<TShark> to be able to extract the I<field> value
from the packet, I<field> MUST be part of the I<filter> string.  If not,
B<TShark> will not be able to extract its value.

For a simple example to add the "nfs.fh.hash" field to the Info column
for all packets containing the "nfs.fh.hash" field, use

B<-z proto,colinfo,nfs.fh.hash,nfs.fh.hash>

To put "nfs.fh.hash" in the Info column but only for packets coming from
host 1.2.3.4 use:

B<-z "proto,colinfo,nfs.fh.hash && ip.src==1.2.3.4,nfs.fh.hash">

This option can be used multiple times on the command line.

=item B<-z> rlc-lte,stat[I<,filter>]

This option will activate a counter for LTE RLC messages.  You will get
information about common messages and various counters for each UE that appears
in the log.

Example: B<-z rlc-lte,stat>.

This option can be used multiple times on the command line.

If the optional I<filter> is provided, the stats will only be calculated
for those frames that match that filter.
Example: B<-z "rlc-lte,stat,rlc-lte.ueid>3000"> will only collect stats for
UEs with a UEId of more than 3000.

=item B<-z> rpc,programs

Collect call/reply SRT data for all known ONC-RPC programs/versions.
Data collected is number of calls for each protocol/version, MinSRT,
MaxSRT and AvgSRT.
This option can only be used once on the command line.

=item B<-z> rpc,srt,I<program>,I<version>[,I<filter>]

Collect call/reply SRT (Service Response Time) data for I<program>/I<version>.
Data collected is the number of calls for each procedure, MinSRT, MaxSRT,
AvgSRT, and the total time taken for each procedure.


Example: B<-z rpc,srt,100003,3> will collect data for NFS v3.

This option can be used multiple times on the command line.

If the optional I<filter> is provided, the stats will only be calculated
on those calls that match that filter.

Example: B<-z rpc,srt,100003,3,nfs.fh.hash==0x12345678> will collect NFS v3
SRT statistics for a specific file.

=item B<-z> rtp,streams

Collect statistics for all RTP streams and calculate max. delta, max. and
mean jitter and packet loss percentages.

=item B<-z> scsi,srt,I<cmdset>[,I<filter>]

Collect call/reply SRT (Service Response Time) data for SCSI commandset I<cmdset>.

Commandsets are 0:SBC   1:SSC  5:MMC

Data collected
is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.

Example: B<-z scsi,srt,0> will collect data for SCSI BLOCK COMMANDS (SBC).

This option can be used multiple times on the command line.

If the optional I<filter> is provided, the stats will only be calculated
on those calls that match that filter.

Example: B<-z scsi,srt,0,ip.addr==1.2.3.4> will collect SCSI SBC
SRT statistics for a specific iscsi/ifcp/fcip host.

=item B<-z> sip,stat[I<,filter>]

This option will activate a counter for SIP messages.  You will get the number
of occurrences of each SIP Method and of each SIP Status-Code.  Additionally
you also get the number of resent SIP Messages (only for SIP over UDP).

Example: B<-z sip,stat>.

This option can be used multiple times on the command line.

If the optional I<filter> is provided, the stats will only be calculated
on those calls that match that filter.
Example: B<-z "sip,stat,ip.addr==1.2.3.4"> will only collect stats for
SIP packets exchanged by the host at IP address 1.2.3.4 .

=item B<-z> smb,sids

When this feature is used B<TShark> will print a report with all the
discovered SID and account name mappings.  Only those SIDs where the
account name is known will be presented in the table.

For this feature to work you will need to either to enable
"Edit/Preferences/Protocols/SMB/Snoop SID to name mappings" in the
preferences or you can override the preferences by specifying
S<B<-o "smb.sid_name_snooping:TRUE">> on the B<TShark> command line.

The current method used by B<TShark> to find the SID->name mapping
is relatively restricted with a hope of future expansion.

=item B<-z> smb,srt[,I<filter>]

Collect call/reply SRT (Service Response Time) data for SMB.  Data collected
is number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.

Example: B<-z smb,srt>

The data will be presented as separate tables for all normal SMB commands,
all Transaction2 commands and all NT Transaction commands.
Only those commands that are seen in the capture will have its stats
displayed.
Only the first command in a xAndX command chain will be used in the
calculation.  So for common SessionSetupAndX + TreeConnectAndX chains,
only the SessionSetupAndX call will be used in the statistics.
This is a flaw that might be fixed in the future.

This option can be used multiple times on the command line.

If the optional I<filter> is provided, the stats will only be calculated
on those calls that match that filter.

Example: B<-z "smb,srt,ip.addr==1.2.3.4"> will only collect stats for
SMB packets exchanged by the host at IP address 1.2.3.4 .

=back

=item --capture-comment E<lt>commentE<gt>

Add a capture comment to the output file.

This option is only available if a new output file in pcapng format is
created. Only one capture comment may be set per output file.

=item --list-time-stamp-types

List time stamp types supported for the interface. If no time stamp type can be
set, no time stamp types are listed.

=item --time-stamp-type E<lt>typeE<gt>

Change the interface's timestamp method.

=item --color

Enable coloring of packets according to standard Wireshark color filters.  This
is currently implemented via 24-bit "true color" terminal escape sequences that
are not supported by all terminal emulators.  See
L<https://wiki.wireshark.org/ColoringRules> for more information on configuring
color filters.

=item --no-duplicate-keys

If a key appears multiple times in an object, only write it a single time with
as value a json array containing all the separate values. (Only works with
-T json)

=item --export-objects E<lt>protocolE<gt>,E<lt>destdirE<gt>

Export all objects within a protocol into directory B<destdir>. The available
values for B<protocol> can be listed with B<--export-objects help>.

The objects are directly saved in the given directory. Filenames are dependent
on the dissector, but typically it is named after the basename of a file.
Duplicate files are not overwritten, instead an increasing number is appended
before the file extension.

This interface is subject to change, adding the possibility to filter on files.

=item --enable-protocol E<lt>proto_nameE<gt>

Enable dissection of proto_name.

=item --disable-protocol E<lt>proto_nameE<gt>

Disable dissection of proto_name.

=item --enable-heuristic E<lt>short_nameE<gt>

Enable dissection of heuristic protocol.

=item --disable-heuristic E<lt>short_nameE<gt>

Disable dissection of heuristic protocol.

=back

=head1 CAPTURE FILTER SYNTAX

See the manual page of pcap-filter(7) or, if that doesn't exist, tcpdump(8),
or, if that doesn't exist, L<https://wiki.wireshark.org/CaptureFilters>.

=head1 READ FILTER SYNTAX

For a complete table of protocol and protocol fields that are filterable
in B<TShark> see the wireshark-filter(4) manual page.

=head1 FILES

These files contains various B<Wireshark> configuration values.

=over 4

=item Preferences

The F<preferences> files contain global (system-wide) and personal
preference settings.  If the system-wide preference file exists, it is
read first, overriding the default settings.  If the personal preferences
file exists, it is read next, overriding any previous values.  Note: If
the command line option B<-o> is used (possibly more than once), it will
in turn override values from the preferences files.

The preferences settings are in the form I<prefname>B<:>I<value>,
one per line,
where I<prefname> is the name of the preference
and I<value> is the value to
which it should be set; white space is allowed between B<:> and
I<value>.  A preference setting can be continued on subsequent lines by
indenting the continuation lines with white space.  A B<#> character
starts a comment that runs to the end of the line:

  # Capture in promiscuous mode?
  # TRUE or FALSE (case-insensitive).
  capture.prom_mode: TRUE

The global preferences file is looked for in the F<wireshark> directory
under the F<share> subdirectory of the main installation directory (for
example, F</usr/local/share/wireshark/preferences>) on UNIX-compatible
systems, and in the main installation directory (for example,
F<C:\Program Files\Wireshark\preferences>) on Windows systems.

The personal preferences file is looked for in
F<$XDG_CONFIG_HOME/wireshark/preferences>
(or, if F<$XDG_CONFIG_HOME/wireshark> does not exist while F<$HOME/.wireshark>
is present, F<$HOME/.wireshark/preferences>) on
UNIX-compatible systems and F<%APPDATA%\Wireshark\preferences> (or, if
%APPDATA% isn't defined, F<%USERPROFILE%\Application
Data\Wireshark\preferences>) on Windows systems.

=item Disabled (Enabled) Protocols

The F<disabled_protos> files contain system-wide and personal lists of
protocols that have been disabled, so that their dissectors are never
called.  The files contain protocol names, one per line, where the
protocol name is the same name that would be used in a display filter
for the protocol:

  http
  tcp     # a comment

The global F<disabled_protos> file uses the same directory as the global
preferences file.

The personal F<disabled_protos> file uses the same directory as the
personal preferences file.

=item Name Resolution (hosts)

If the personal F<hosts> file exists, it is
used to resolve IPv4 and IPv6 addresses before any other
attempts are made to resolve them.  The file has the standard F<hosts>
file syntax; each line contains one IP address and name, separated by
whitespace.  The same directory as for the personal preferences file is
used.

Capture filter name resolution is handled by libpcap on UNIX-compatible
systems and WinPcap on Windows.  As such the Wireshark personal F<hosts> file
will not be consulted for capture filter name resolution.

=item Name Resolution (subnets)

If an IPv4 address cannot be translated via name resolution (no exact
match is found) then a partial match is attempted via the F<subnets> file.

Each line of this file consists of an IPv4 address, a subnet mask length
separated only by a / and a name separated by whitespace. While the address
must be a full IPv4 address, any values beyond the mask length are subsequently
ignored.

An example is:

# Comments must be prepended by the # sign!
192.168.0.0/24 ws_test_network

A partially matched name will be printed as "subnet-name.remaining-address".
For example, "192.168.0.1" under the subnet above would be printed as
"ws_test_network.1"; if the mask length above had been 16 rather than 24, the
printed address would be ``ws_test_network.0.1".

=item Name Resolution (ethers)

The F<ethers> files are consulted to correlate 6-byte hardware addresses to
names.  First the personal F<ethers> file is tried and if an address is not
found there the global F<ethers> file is tried next.

Each line contains one hardware address and name, separated by
whitespace.  The digits of the hardware address are separated by colons
(:), dashes (-) or periods (.).  The same separator character must be
used consistently in an address.  The following three lines are valid
lines of an F<ethers> file:

  ff:ff:ff:ff:ff:ff          Broadcast
  c0-00-ff-ff-ff-ff          TR_broadcast
  00.00.00.00.00.00          Zero_broadcast

The global F<ethers> file is looked for in the F</etc> directory on
UNIX-compatible systems, and in the main installation directory (for
example, F<C:\Program Files\Wireshark>) on Windows systems.

The personal F<ethers> file is looked for in the same directory as the personal
preferences file.

Capture filter name resolution is handled by libpcap on UNIX-compatible
systems and WinPcap on Windows.  As such the Wireshark personal F<ethers> file
will not be consulted for capture filter name resolution.

=item Name Resolution (manuf)

The F<manuf> file is used to match the 3-byte vendor portion of a 6-byte
hardware address with the manufacturer's name; it can also contain well-known
MAC addresses and address ranges specified with a netmask.  The format of the
file is the same as the F<ethers> files, except that entries of the form:

  00:00:0C      Cisco

can be provided, with the 3-byte OUI and the name for a vendor, and
entries such as:

  00-00-0C-07-AC/40     All-HSRP-routers

can be specified, with a MAC address and a mask indicating how many bits
of the address must match.  The above entry, for example, has 40
significant bits, or 5 bytes, and would match addresses from
00-00-0C-07-AC-00 through 00-00-0C-07-AC-FF.  The mask need not be a
multiple of 8.

The F<manuf> file is looked for in the same directory as the global
preferences file.

=item Name Resolution (services)

The F<services> file is used to translate port numbers into names.

The file has the standard F<services> file syntax; each line contains one
(service) name and one transport identifier separated by white space.  The
transport identifier includes one port number and one transport protocol name
(typically tcp, udp, or sctp) separated by a /.

An example is:

mydns       5045/udp     # My own Domain Name Server
mydns       5045/tcp     # My own Domain Name Server

=item Name Resolution (ipxnets)

The F<ipxnets> files are used to correlate 4-byte IPX network numbers to
names.  First the global F<ipxnets> file is tried and if that address is not
found there the personal one is tried next.

The format is the same as the F<ethers>
file, except that each address is four bytes instead of six.
Additionally, the address can be represented as a single hexadecimal
number, as is more common in the IPX world, rather than four hex octets.
For example, these four lines are valid lines of an F<ipxnets> file:

  C0.A8.2C.00              HR
  c0-a8-1c-00              CEO
  00:00:BE:EF              IT_Server1
  110f                     FileServer3

The global F<ipxnets> file is looked for in the F</etc> directory on
UNIX-compatible systems, and in the main installation directory (for
example, F<C:\Program Files\Wireshark>) on Windows systems.

The personal F<ipxnets> file is looked for in the same directory as the
personal preferences file.

=back

=head1 OUTPUT

B<TShark> uses UTF-8 to represent strings internally. In some cases the
output might not be valid. For example, a dissector might generate
invalid UTF-8 character sequences. Programs reading B<TShark> output
should expect UTF-8 and be prepared for invalid output.

If B<TShark> detects that it is writing to a TTY on UNIX or Linux and
the locale does not support UTF-8, output will be re-encoded to match the
current locale.

If B<TShark> detects that it is writing to a TTY on Windows, output will be
encoded as UTF-16LE.

=head1 ENVIRONMENT VARIABLES

=over 4

=item WIRESHARK_APPDATA

On Windows, Wireshark normally stores all application data in %APPDATA% or
%USERPROFILE%.  You can override the default location by exporting this
environment variable to specify an alternate location.

=item WIRESHARK_DEBUG_WMEM_OVERRIDE

Setting this environment variable forces the wmem framework to use the
specified allocator backend for *all* allocations, regardless of which
backend is normally specified by the code. This is mainly useful to developers
when testing or debugging. See I<README.wmem> in the source distribution for
details.

=item WIRESHARK_RUN_FROM_BUILD_DIRECTORY

This environment variable causes the plugins and other data files to be loaded
from the build directory (where the program was compiled) rather than from the
standard locations.  It has no effect when the program in question is running
with root (or setuid) permissions on *NIX.

=item WIRESHARK_DATA_DIR

This environment variable causes the various data files to be loaded from
a directory other than the standard locations.  It has no effect when the
program in question is running with root (or setuid) permissions on *NIX.

=item ERF_RECORDS_TO_CHECK

This environment variable controls the number of ERF records checked when
deciding if a file really is in the ERF format.  Setting this environment
variable a number higher than the default (20) would make false positives
less likely.

=item IPFIX_RECORDS_TO_CHECK

This environment variable controls the number of IPFIX records checked when
deciding if a file really is in the IPFIX format.  Setting this environment
variable a number higher than the default (20) would make false positives
less likely.

=item WIRESHARK_ABORT_ON_DISSECTOR_BUG

If this environment variable is set, B<TShark> will call abort(3)
when a dissector bug is encountered.  abort(3) will cause the program to
exit abnormally; if you are running B<TShark> in a debugger, it
should halt in the debugger and allow inspection of the process, and, if
you are not running it in a debugger, it will, on some OSes, assuming
your environment is configured correctly, generate a core dump file.
This can be useful to developers attempting to troubleshoot a problem
with a protocol dissector.

=item WIRESHARK_ABORT_ON_TOO_MANY_ITEMS

If this environment variable is set, B<TShark> will call abort(3)
if a dissector tries to add too many items to a tree (generally this
is an indication of the dissector not breaking out of a loop soon enough).
abort(3) will cause the program to exit abnormally; if you are running
B<TShark> in a debugger, it should halt in the debugger and allow
inspection of the process, and, if you are not running it in a debugger,
it will, on some OSes, assuming your environment is configured correctly,
generate a core dump file.  This can be useful to developers attempting to
troubleshoot a problem with a protocol dissector.

=back

=head1 SEE ALSO

wireshark-filter(4), wireshark(1), editcap(1), pcap(3), dumpcap(1),
text2pcap(1), mergecap(1), pcap-filter(7) or tcpdump(8)

=head1 NOTES

B<TShark> is part of the B<Wireshark> distribution.  The latest version
of B<Wireshark> can be found at L<https://www.wireshark.org>.

HTML versions of the Wireshark project man pages are available at:
L<https://www.wireshark.org/docs/man-pages>.

=head1 AUTHORS

B<TShark> uses the same packet dissection code that B<Wireshark> does,
as well as using many other modules from B<Wireshark>; see the list of
authors in the B<Wireshark> man page for a list of authors of that code.