5b69b4ed71f9c13a85ee450ad1b4be7d3f34cb33
[metze/wireshark/wip.git] / doc / tshark.pod
1 =begin man
2
3 =encoding utf8
4
5 =end man
6
7 =head1 NAME
8
9 tshark - Dump and analyze network traffic
10
11 =head1 SYNOPSIS
12
13 B<tshark>
14 S<[ B<-2> ]>
15 S<[ B<-a> E<lt>capture autostop conditionE<gt> ] ...>
16 S<[ B<-b> E<lt>capture ring buffer optionE<gt>] ...>
17 S<[ B<-B> E<lt>capture buffer sizeE<gt> ] >
18 S<[ B<-c> E<lt>capture packet countE<gt> ]>
19 S<[ B<-C> E<lt>configuration profileE<gt> ]>
20 S<[ B<-d> E<lt>layer typeE<gt>==E<lt>selectorE<gt>,E<lt>decode-as protocolE<gt> ]>
21 S<[ B<-D> ]>
22 S<[ B<-e> E<lt>fieldE<gt> ]>
23 S<[ B<-E> E<lt>field print optionE<gt> ]>
24 S<[ B<-f> E<lt>capture filterE<gt> ]>
25 S<[ B<-F> E<lt>file formatE<gt> ]>
26 S<[ B<-g> ]>
27 S<[ B<-h> ]>
28 S<[ B<-H> E<lt>input hosts fileE<gt> ]>
29 S<[ B<-i> E<lt>capture interfaceE<gt>|- ]>
30 S<[ B<-j> E<lt>protocol match filterE<gt> ]>
31 S<[ B<-I> ]>
32 S<[ B<-K> E<lt>keytabE<gt> ]>
33 S<[ B<-l> ]>
34 S<[ B<-L> ]>
35 S<[ B<-n> ]>
36 S<[ B<-N> E<lt>name resolving flagsE<gt> ]>
37 S<[ B<-o> E<lt>preference settingE<gt> ] ...>
38 S<[ B<-O> E<lt>protocolsE<gt> ]>
39 S<[ B<-p> ]>
40 S<[ B<-P> ]>
41 S<[ B<-q> ]>
42 S<[ B<-Q> ]>
43 S<[ B<-r> E<lt>infileE<gt> ]>
44 S<[ B<-R> E<lt>Read filterE<gt> ]>
45 S<[ B<-s> E<lt>capture snaplenE<gt> ]>
46 S<[ B<-S> E<lt>separatorE<gt> ]>
47 S<[ B<-t> a|ad|adoy|d|dd|e|r|u|ud|udoy ]>
48 S<[ B<-T> ek|fields|json|pdml|ps|psml|tabs|text ]>
49 S<[ B<-u> E<lt>seconds typeE<gt>]>
50 S<[ B<-U> E<lt>tap_nameE<gt>]>
51 S<[ B<-v> ]>
52 S<[ B<-V> ]>
53 S<[ B<-w> E<lt>outfileE<gt>|- ]>
54 S<[ B<-W> E<lt>file format optionE<gt>]>
55 S<[ B<-x> ]>
56 S<[ B<-X> E<lt>eXtension optionE<gt>]>
57 S<[ B<-y> E<lt>capture link typeE<gt> ]>
58 S<[ B<-Y> E<lt>displaY filterE<gt> ]>
59 S<[ B<-M> E<lt>auto session resetE<gt> ]>
60 S<[ B<-z> E<lt>statisticsE<gt> ]>
61 S<[ B<--capture-comment> E<lt>commentE<gt> ]>
62 S<[ B<--list-time-stamp-types> ]>
63 S<[ B<--time-stamp-type> E<lt>typeE<gt> ]>
64 S<[ B<--color> ]>
65 S<[ B<--no-duplicate-keys> ]>
66 S<[ B<--export-objects> E<lt>protocolE<gt>,E<lt>destdirE<gt> ]>
67 S<[ B<--enable-protocol> E<lt>proto_nameE<gt> ]>
68 S<[ B<--disable-protocol> E<lt>proto_nameE<gt> ]>
69 S<[ B<--enable-heuristic> E<lt>short_nameE<gt> ]>
70 S<[ B<--disable-heuristic> E<lt>short_nameE<gt> ]>
71 S<[ E<lt>capture filterE<gt> ]>
72
73 B<tshark>
74 B<-G> [ E<lt>report typeE<gt> ] [ --elastic-mapping-filter E<lt>protocolsE<gt> ]
75
76 =head1 DESCRIPTION
77
78 B<TShark> is a network protocol analyzer.  It lets you capture packet
79 data from a live network, or read packets from a previously saved
80 capture file, either printing a decoded form of those packets to the
81 standard output or writing the packets to a file.  B<TShark>'s native
82 capture file format is B<pcap> format, which is also the format used
83 by B<tcpdump> and various other tools.
84
85 Without any options set, B<TShark> will work much like B<tcpdump>.  It
86 will use the pcap library to capture traffic from the first available
87 network interface and displays a summary line on the standard output for
88 each received packet.
89
90 When run with the B<-r> option, specifying a capture file from which to
91 read, B<TShark> will again work much like B<tcpdump>, reading packets
92 from the file and displaying a summary line on the standard output for
93 each packet read.  B<TShark> is able to detect, read and write the same
94 capture files that are supported by B<Wireshark>.  The input file
95 doesn't need a specific filename extension; the file format and an
96 optional gzip compression will be automatically detected.  Near the
97 beginning of the DESCRIPTION section of wireshark(1) or
98 L<https://www.wireshark.org/docs/man-pages/wireshark.html> is a detailed
99 description of the way B<Wireshark> handles this, which is the same way
100 B<Tshark> handles this.
101
102 Compressed file support uses (and therefore requires) the zlib library.
103 If the zlib library is not present when compiling B<TShark>, it will be
104 possible to compile it, but the resulting program will be unable to read
105 compressed files.
106
107 When displaying packets on the standard output, B<TShark> writes, by
108 default, a summary line containing the fields specified by the
109 preferences file (which are also the fields displayed in the packet list
110 pane in B<Wireshark>), although if it's writing packets as it captures
111 them, rather than writing packets from a saved capture file, it won't
112 show the "frame number" field.  If the B<-V> option is specified, it
113 instead writes a view of the details of the packet, showing all the
114 fields of all protocols in the packet.  If the B<-O> option is
115 specified, it will only show the full details for the protocols
116 specified, and show only the top-level detail line for all other
117 protocols.  Use the output of "B<tshark -G protocols>" to find the
118 abbreviations of the protocols you can specify.  If the B<-P> option is
119 specified with either the B<-V> or B<-O> options, both the summary line
120 for the entire packet and the details will be displayed.
121
122 Packet capturing is performed with the pcap library.  That library
123 supports specifying a filter expression; packets that don't match that
124 filter are discarded.  The B<-f> option is used to specify a capture
125 filter.  The syntax of a capture filter is defined by the pcap library;
126 this syntax is different from the read filter syntax described below,
127 and the filtering mechanism is limited in its abilities.
128
129 Read filters in B<TShark>, which allow you to select which packets are
130 to be decoded or written to a file, are very powerful; more fields are
131 filterable in B<TShark> than in other protocol analyzers, and the syntax
132 you can use to create your filters is richer.  As B<TShark> progresses,
133 expect more and more protocol fields to be allowed in read filters.
134 Read filters use the same syntax as display and color filters in
135 B<Wireshark>; a read filter is specified with the B<-R> option.
136
137 Read filters can be specified when capturing or when reading from a
138 capture file.  Note that that capture filters are much more efficient
139 than read filters, and it may be more difficult for B<TShark> to keep up
140 with a busy network if a read filter is specified for a live capture, so
141 you might be more likely to lose packets if you're using a read filter.
142
143 A capture or read filter can either be specified with the B<-f> or B<-R>
144 option, respectively, in which case the entire filter expression must be
145 specified as a single argument (which means that if it contains spaces,
146 it must be quoted), or can be specified with command-line arguments
147 after the option arguments, in which case all the arguments after the
148 filter arguments are treated as a filter expression.  If the filter is
149 specified with command-line arguments after the option arguments, it's a
150 capture filter if a capture is being done (i.e., if no B<-r> option was
151 specified) and a read filter if a capture file is being read (i.e., if a
152 B<-r> option was specified).
153
154 If the B<-w> option is specified when capturing packets or reading from
155 a capture file, B<TShark> does not display packets on the standard
156 output.  Instead, it writes the packets to a capture file with the name
157 specified by the B<-w> option.
158
159 If you want to write the decoded form of packets to a file, run
160 B<TShark> without the B<-w> option, and redirect its standard output to
161 the file (do I<not> use the B<-w> option).
162
163 If you want the packets to be displayed to the standard output and also
164 saved to a file, specify the B<-P> option in addition to the B<-w>
165 option to have the summary line displayed, specify the B<-V> option
166 in addition to the B<-w> option to have the details of the packet
167 displayed, and specify the B<-O> option, with a list of protocols, to
168 have the full details of the specified protocols and the top-level
169 detail line for all other protocols to be displayed.  If the B<-P>
170 option is used together with the B<-V> or B<-O> option, the summary line
171 will be displayed along with the detail lines.
172
173 When writing packets to a file, B<TShark>, by default, writes the file
174 in B<pcapng> format, and writes all of the packets it sees to the output
175 file.  The B<-F> option can be used to specify the format in which to
176 write the file.  This list of available file formats is displayed by the
177 B<-F> option without a value.  However, you can't specify a file format
178 for a live capture.
179
180 When capturing packets, B<TShark> writes to the standard error an
181 initial line listing the interfaces from which packets are being
182 captured and, if packet information isn't being displayed to the
183 terminal, writes a continuous count of packets captured to the standard
184 output.  If the B<-q> option is specified, neither the continuous count
185 nor the packet information will be displayed; instead, at the end of the
186 capture, a count of packets captured will be displayed.  If the B<-Q>
187 option is specified, neither the initial line, nor the packet
188 information, nor any packet counts will be displayed.  If the B<-q> or
189 B<-Q> option is used, the B<-P>, B<-V>, or B<-O> option can be used to
190 cause the corresponding output to be displayed even though other output
191 is suppressed.
192
193 When reading packets, the B<-q> and B<-Q> option will suppress the
194 display of the packet summary or details; this would be used if B<-z>
195 options are specified in order to display statistics, so that only the
196 statistics, not the packet information, is displayed.
197
198 The B<-G> option is a special mode that simply causes B<Tshark>
199 to dump one of several types of internal glossaries and then exit.
200
201 =head1 OPTIONS
202
203 =over 4
204
205 =item -2
206
207 Perform a two-pass analysis. This causes tshark to buffer output until the
208 entire first pass is done, but allows it to fill in fields that require future
209 knowledge, such as 'response in frame #' fields. Also permits reassembly
210 frame dependencies to be calculated correctly.
211
212 =item -a  E<lt>capture autostop conditionE<gt>
213
214 Specify a criterion that specifies when B<TShark> is to stop writing
215 to a capture file.  The criterion is of the form I<test>B<:>I<value>,
216 where I<test> is one of:
217
218 B<duration>:I<value> Stop writing to a capture file after I<value> seconds
219 have elapsed. Floating point values (e.g. 0.5) are allowed.
220
221 B<files>:I<value> Stop writing to capture files after I<value> number of files
222 were written.
223
224 B<filesize>:I<value> Stop writing to a capture file after it reaches a size of
225 I<value> kB.  If this option is used together with the -b option, B<TShark>
226 will stop writing to the current capture file and switch to the next one if
227 filesize is reached.  When reading a capture file, B<TShark> will stop reading
228 the file after the number of bytes read exceeds this number (the complete
229 packet  will be read, so more bytes than this number may be read).  Note that
230 the filesize is limited to a maximum value of 2 GiB.
231
232 B<packets>:I<value> switch to the next file after it contains I<value>
233 packets. Same as B<-c>E<lt>capture packet countE<gt>.
234
235 =item -b  E<lt>capture ring buffer optionE<gt>
236
237 Cause B<TShark> to run in "multiple files" mode.  In "multiple files" mode,
238 B<TShark> will write to several capture files.  When the first capture file
239 fills up, B<TShark> will switch writing to the next file and so on.
240
241 The created filenames are based on the filename given with the B<-w> option,
242 the number of the file and on the creation date and time,
243 e.g. outfile_00001_20180714120117.pcap, outfile_00002_20180714120523.pcap, ...
244
245 With the I<files> option it's also possible to form a "ring buffer".
246 This will fill up new files until the number of files specified,
247 at which point B<TShark> will discard the data in the first file and start
248 writing to that file and so on.  If the I<files> option is not set,
249 new files filled up until one of the capture stop conditions match (or
250 until the disk is full).
251
252 The criterion is of the form I<key>B<:>I<value>,
253 where I<key> is one of:
254
255 B<duration>:I<value> switch to the next file after I<value> seconds have
256 elapsed, even if the current file is not completely filled up. Floating
257 point values (e.g. 0.5) are allowed.
258
259 B<files>:I<value> begin again with the first file after I<value> number of
260 files were written (form a ring buffer).  This value must be less than 100000.
261 Caution should be used when using large numbers of files: some filesystems do
262 not handle many files in a single directory well.  The B<files> criterion
263 requires either B<duration>, B<interval> or B<filesize> to be specified to
264 control when to go to the next file.  It should be noted that each B<-b>
265 parameter takes exactly one criterion; to specify two criterion, each must be
266 preceded by the B<-b> option.
267
268 B<filesize>:I<value> switch to the next file after it reaches a size of
269 I<value> kB.  Note that the filesize is limited to a maximum value of 2 GiB.
270
271 B<interval>:I<value> switch to the next file when the time is an exact
272 multiple of I<value> seconds
273
274 B<packets>:I<value> switch to the next file after it contains I<value>
275 packets.
276
277 Example: B<tshark -b filesize:1000 -b files:5> results in a ring buffer of five files
278 of size one megabyte each.
279
280 =item -B  E<lt>capture buffer sizeE<gt>
281
282 Set capture buffer size (in MiB, default is 2 MiB).  This is used by
283 the capture driver to buffer packet data until that data can be written
284 to disk.  If you encounter packet drops while capturing, try to increase
285 this size.  Note that, while B<Tshark> attempts to set the buffer size
286 to 2 MiB by default, and can be told to set it to a larger value, the
287 system or interface on which you're capturing might silently limit the
288 capture buffer size to a lower value or raise it to a higher value.
289
290 This is available on UNIX systems with libpcap 1.0.0 or later and on
291 Windows.  It is not available on UNIX systems with earlier versions of
292 libpcap.
293
294 This option can occur multiple times.  If used before the first
295 occurrence of the B<-i> option, it sets the default capture buffer size.
296 If used after an B<-i> option, it sets the capture buffer size for
297 the interface specified by the last B<-i> option occurring before
298 this option.  If the capture buffer size is not set specifically,
299 the default capture buffer size is used instead.
300
301 =item -c  E<lt>capture packet countE<gt>
302
303 Set the maximum number of packets to read when capturing live
304 data. Same as B<-a packets:>E<lt>capture packet countE<gt>.
305 If reading a capture file, set the maximum number of packets to read.
306
307 =item -C  E<lt>configuration profileE<gt>
308
309 Run with the given configuration profile.
310
311 =item -d  E<lt>layer typeE<gt>==E<lt>selectorE<gt>,E<lt>decode-as protocolE<gt>
312
313 Like Wireshark's B<Decode As...> feature, this lets you specify how a
314 layer type should be dissected.  If the layer type in question (for example,
315 B<tcp.port> or B<udp.port> for a TCP or UDP port number) has the specified
316 selector value, packets should be dissected as the specified protocol.
317
318 Example: B<tshark -d tcp.port==8888,http> will decode any traffic running over
319 TCP port 8888 as HTTP.
320
321 Example: B<tshark -d tcp.port==8888:3,http> will decode any traffic running over
322 TCP ports 8888, 8889 or 8890 as HTTP.
323
324 Example: B<tshark -d tcp.port==8888-8890,http> will decode any traffic running over
325 TCP ports 8888, 8889 or 8890 as HTTP.
326
327 Using an invalid selector or protocol will print out a list of valid selectors
328 and protocol names, respectively.
329
330 Example: B<tshark -d .> is a quick way to get a list of valid selectors.
331
332 Example: B<tshark -d ethertype==0x0800.> is a quick way to get a list of protocols that can be
333 selected with an ethertype.
334
335 =item -D
336
337 Print a list of the interfaces on which B<TShark> can capture, and
338 exit.  For each network interface, a number and an
339 interface name, possibly followed by a text description of the
340 interface, is printed.  The interface name or the number can be supplied
341 to the B<-i> option to specify an interface on which to capture.
342
343 This can be useful on systems that don't have a command to list them
344 (UNIX systems lacking B<ifconfig -a> or Linux systems lacking
345 B<ip link show>). The number can be useful on Windows systems, where
346 the interface name might be a long name or a GUID.
347
348 Note that "can capture" means that B<TShark> was able to open that
349 device to do a live capture.  Depending on your system you may need to
350 run tshark from an account with special privileges (for example, as
351 root) to be able to capture network traffic.  If B<tshark -D> is not run
352 from such an account, it will not list any interfaces.
353
354 =item -e  E<lt>fieldE<gt>
355
356 Add a field to the list of fields to display if B<-T ek|fields|json|pdml>
357 is selected.  This option can be used multiple times on the command line.
358 At least one field must be provided if the B<-T fields> option is
359 selected. Column names may be used prefixed with "_ws.col."
360
361 Example: B<tshark -e frame.number -e ip.addr -e udp -e _ws.col.Info>
362
363 Giving a protocol rather than a single field will print multiple items
364 of data about the protocol as a single field.  Fields are separated by
365 tab characters by default.  B<-E> controls the format of the printed
366 fields.
367
368 =item -E  E<lt>field print optionE<gt>
369
370 Set an option controlling the printing of fields when B<-T fields> is
371 selected.
372
373 Options are:
374
375 B<bom=y|n> If B<y>, prepend output with the UTF-8 byte order mark
376 (hexadecimal ef, bb, bf). Defaults to B<n>.
377
378 B<header=y|n> If B<y>, print a list of the field names given using B<-e>
379 as the first line of the output; the field name will be separated using
380 the same character as the field values.  Defaults to B<n>.
381
382 B<separator=/t|/s|>E<lt>characterE<gt> Set the separator character to
383 use for fields.  If B</t> tab will be used (this is the default), if
384 B</s>, a single space will be used.  Otherwise any character that can be
385 accepted by the command line as part of the option may be used.
386
387 B<occurrence=f|l|a> Select which occurrence to use for fields that have
388 multiple occurrences.  If B<f> the first occurrence will be used, if B<l>
389 the last occurrence will be used and if B<a> all occurrences will be used
390 (this is the default).
391
392 B<aggregator=,|/s|>E<lt>characterE<gt> Set the aggregator character to
393 use for fields that have multiple occurrences.  If B<,> a comma will be used
394 (this is the default), if B</s>, a single space will be used.  Otherwise
395 any character that can be accepted by the command line as part of the
396 option may be used.
397
398 B<quote=d|s|n> Set the quote character to use to surround fields.  B<d>
399 uses double-quotes, B<s> single-quotes, B<n> no quotes (the default).
400
401 =item -f  E<lt>capture filterE<gt>
402
403 Set the capture filter expression.
404
405 This option can occur multiple times.  If used before the first
406 occurrence of the B<-i> option, it sets the default capture filter expression.
407 If used after an B<-i> option, it sets the capture filter expression for
408 the interface specified by the last B<-i> option occurring before
409 this option.  If the capture filter expression is not set specifically,
410 the default capture filter expression is used if provided.
411
412 Pre-defined capture filter names, as shown in the GUI menu item Capture->Capture Filters,
413 can be used by prefixing the argument with "predef:".
414 Example: B<tshark -f "predef:MyPredefinedHostOnlyFilter">
415
416 =item -F  E<lt>file formatE<gt>
417
418 Set the file format of the output capture file written using the B<-w>
419 option.  The output written with the B<-w> option is raw packet data, not
420 text, so there is no B<-F> option to request text output.  The option B<-F>
421 without a value will list the available formats.
422
423 =item -g
424
425 This option causes the output file(s) to be created with group-read permission
426 (meaning that the output file(s) can be read by other members of the calling
427 user's group).
428
429 =item -G  [ E<lt>report typeE<gt> ]
430
431 The B<-G> option will cause B<Tshark> to dump one of several types of glossaries
432 and then exit.  If no specific glossary type is specified, then the B<fields> report will be generated by default.
433 Using the report type of B<help> lists all the current report types.
434
435 The available report types include:
436
437 B<column-formats> Dumps the column formats understood by tshark.
438 There is one record per line.  The fields are tab-delimited.
439
440  * Field 1 = format string (e.g. "%rD")
441  * Field 2 = text description of format string (e.g. "Dest port (resolved)")
442
443 B<currentprefs>  Dumps a copy of the current preferences file to stdout.
444
445 B<decodes> Dumps the "layer type"/"decode as" associations to stdout.
446 There is one record per line.  The fields are tab-delimited.
447
448  * Field 1 = layer type, e.g. "tcp.port"
449  * Field 2 = selector in decimal
450  * Field 3 = "decode as" name, e.g. "http"
451
452 B<defaultprefs>  Dumps a default preferences file to stdout.
453
454 B<dissector-tables>  Dumps a list of dissector tables to stdout.  There
455 is one record per line.  The fields are tab-delimited.
456
457  * Field 1 = dissector table name, e.g. "tcp.port"
458  * Field 2 = name used for the dissector table in the GUI
459  * Field 3 = type (textual representation of the ftenum type)
460  * Field 4 = base for display (for integer types)
461  * Field 5 = protocol name
462  * Field 6 = "decode as" support
463
464 B<elastic-mapping>  Dumps the ElasticSearch mapping file to stdout.
465
466 B<fieldcount>  Dumps the number of header fields to stdout.
467
468 B<fields>  Dumps the contents of the registration database to
469 stdout.  An independent program can take this output and format it into nice
470 tables or HTML or whatever.  There is one record per line.  Each record is
471 either a protocol or a header field, differentiated by the first field.
472 The fields are tab-delimited.
473
474  * Protocols
475  * ---------
476  * Field 1 = 'P'
477  * Field 2 = descriptive protocol name
478  * Field 3 = protocol abbreviation
479  *
480  * Header Fields
481  * -------------
482  * Field 1 = 'F'
483  * Field 2 = descriptive field name
484  * Field 3 = field abbreviation
485  * Field 4 = type (textual representation of the ftenum type)
486  * Field 5 = parent protocol abbreviation
487  * Field 6 = base for display (for integer types); "parent bitfield width" for FT_BOOLEAN
488  * Field 7 = bitmask: format: hex: 0x....
489  * Field 8 = blurb describing field
490
491 B<folders> Dumps various folders used by tshark.  This is essentially the
492 same data reported in Wireshark's About | Folders tab.
493 There is one record per line.  The fields are tab-delimited.
494
495  * Field 1 = Folder type (e.g "Personal configuration:")
496  * Field 2 = Folder location (e.g. "/home/vagrant/.config/wireshark/")
497
498 B<ftypes> Dumps the "ftypes" (fundamental types) understood by tshark.
499 There is one record per line.  The fields are tab-delimited.
500
501  * Field 1 = FTYPE (e.g "FT_IPv6")
502  * Field 2 = text description of type (e.g. "IPv6 address")
503
504 B<heuristic-decodes> Dumps the heuristic decodes currently installed.
505 There is one record per line.  The fields are tab-delimited.
506
507  * Field 1 = underlying dissector (e.g. "tcp")
508  * Field 2 = name of heuristic decoder (e.g. ucp")
509  * Field 3 = heuristic enabled (e.g. "T" or "F")
510
511 B<help> Displays the available report types.
512
513 B<plugins> Dumps the plugins currently installed.
514 There is one record per line.  The fields are tab-delimited.
515
516  * Field 1 = plugin library (e.g. "gryphon.so")
517  * Field 2 = plugin version (e.g. 0.0.4)
518  * Field 3 = plugin type (e.g. "dissector" or "tap")
519  * Field 4 = full path to plugin file
520
521 B<protocols> Dumps the protocols in the registration database to stdout.
522 An independent program can take this output and format it into nice tables
523 or HTML or whatever.  There is one record per line.  The fields are tab-delimited.
524
525  * Field 1 = protocol name
526  * Field 2 = protocol short name
527  * Field 3 = protocol filter name
528
529 B<values> Dumps the value_strings, range_strings or true/false strings
530 for fields that have them.  There is one record per line.  Fields are
531 tab-delimited.  There are three types of records: Value String, Range
532 String and True/False String.  The first field, 'V', 'R' or 'T', indicates
533 the type of record.
534
535  * Value Strings
536  * -------------
537  * Field 1 = 'V'
538  * Field 2 = field abbreviation to which this value string corresponds
539  * Field 3 = Integer value
540  * Field 4 = String
541  *
542  * Range Strings
543  * -------------
544  * Field 1 = 'R'
545  * Field 2 = field abbreviation to which this range string corresponds
546  * Field 3 = Integer value: lower bound
547  * Field 4 = Integer value: upper bound
548  * Field 5 = String
549  *
550  * True/False Strings
551  * ------------------
552  * Field 1 = 'T'
553  * Field 2 = field abbreviation to which this true/false string corresponds
554  * Field 3 = True String
555  * Field 4 = False String
556
557 =item -h
558
559 =item --help
560
561 Print the version and options and exit.
562
563 =item -H  E<lt>input hosts fileE<gt>
564
565 Read a list of entries from a "hosts" file, which will then be written
566 to a capture file.  Implies B<-W n>. Can be called multiple times.
567
568 The "hosts" file format is documented at
569 L<http://en.wikipedia.org/wiki/Hosts_(file)>.
570
571 =item -i  E<lt>capture interfaceE<gt> | -
572
573 Set the name of the network interface or pipe to use for live packet
574 capture.
575
576 Network interface names should match one of the names listed in
577 "B<tshark -D>" (described above); a number, as reported by
578 "B<tshark -D>", can also be used.  If you're using UNIX, "B<netstat
579 -i>", "B<ifconfig -a>" or "B<ip link>" might also work to list interface names,
580 although not all versions of UNIX support the B<-a> option to B<ifconfig>.
581
582 If no interface is specified, B<TShark> searches the list of
583 interfaces, choosing the first non-loopback interface if there are any
584 non-loopback interfaces, and choosing the first loopback interface if
585 there are no non-loopback interfaces.  If there are no interfaces at all,
586 B<TShark> reports an error and doesn't start the capture.
587
588 Pipe names should be either the name of a FIFO (named pipe) or "-" to
589 read data from the standard input.  On Windows systems, pipe names must be
590 of the form "\\pipe\.\B<pipename>".  Data read from pipes must be in
591 standard pcapng or pcap format. Pcapng data must have the same
592 endianness as the capturing host.
593
594 This option can occur multiple times. When capturing from multiple
595 interfaces, the capture file will be saved in pcapng format.
596
597 =item -I
598
599 Put the interface in "monitor mode"; this is supported only on IEEE
600 802.11 Wi-Fi interfaces, and supported only on some operating systems.
601
602 Note that in monitor mode the adapter might disassociate from the
603 network with which it's associated, so that you will not be able to use
604 any wireless networks with that adapter.  This could prevent accessing
605 files on a network server, or resolving host names or network addresses,
606 if you are capturing in monitor mode and are not connected to another
607 network with another adapter.
608
609 This option can occur multiple times.  If used before the first
610 occurrence of the B<-i> option, it enables the monitor mode for all interfaces.
611 If used after an B<-i> option, it enables the monitor mode for
612 the interface specified by the last B<-i> option occurring before
613 this option.
614
615 =item -j  E<lt>protocol match filterE<gt>
616
617 Protocol match filter used for ek|json|jsonraw|pdml output file types.
618 Parent node containing multiple child nodes is only included,
619 if the name is found in the filter.
620
621 Example: B<tshark -j "ip ip.flags text">
622
623 =item -J  E<lt>protocol match filterE<gt>
624
625 Protocol top level filter used for ek|json|jsonraw|pdml output file types.
626 Parent node containing multiple child nodes is included with all children.
627
628 Example: B<tshark -J "http tcp">
629
630 =item -K  E<lt>keytabE<gt>
631
632 Load kerberos crypto keys from the specified keytab file.
633 This option can be used multiple times to load keys from several files.
634
635 Example: B<tshark -K krb5.keytab>
636
637 =item -l
638
639 Flush the standard output after the information for each packet is
640 printed.  (This is not, strictly speaking, line-buffered if B<-V>
641 was specified; however, it is the same as line-buffered if B<-V> wasn't
642 specified, as only one line is printed for each packet, and, as B<-l> is
643 normally used when piping a live capture to a program or script, so that
644 output for a packet shows up as soon as the packet is seen and
645 dissected, it should work just as well as true line-buffering.  We do
646 this as a workaround for a deficiency in the Microsoft Visual C++ C
647 library.)
648
649 This may be useful when piping the output of B<TShark> to another
650 program, as it means that the program to which the output is piped will
651 see the dissected data for a packet as soon as B<TShark> sees the
652 packet and generates that output, rather than seeing it only when the
653 standard output buffer containing that data fills up.
654
655 =item -L
656
657 List the data link types supported by the interface and exit.  The reported
658 link types can be used for the B<-y> option.
659
660 =item -n
661
662 Disable network object name resolution (such as hostname, TCP and UDP port
663 names); the B<-N> option might override this one.
664
665 =item -N  E<lt>name resolving flagsE<gt>
666
667 Turn on name resolving only for particular types of addresses and port
668 numbers, with name resolving for other types of addresses and port
669 numbers turned off.  This option overrides B<-n> if both B<-N> and B<-n>
670 are present.  If both B<-N> and B<-n> options are not present, all name
671 resolutions are turned on.
672
673 The argument is a string that may contain the letters:
674
675 B<d> to enable resolution from captured DNS packets
676
677 B<m> to enable MAC address resolution
678
679 B<n> to enable network address resolution
680
681 B<N> to enable using external resolvers (e.g., DNS) for network address
682 resolution
683
684 B<t> to enable transport-layer port number resolution
685
686 B<v> to enable VLAN IDs to names resolution
687
688 =item -o  E<lt>preferenceE<gt>:E<lt>valueE<gt>
689
690 Set a preference value, overriding the default value and any value read
691 from a preference file.  The argument to the option is a string of the
692 form I<prefname>B<:>I<value>, where I<prefname> is the name of the
693 preference (which is the same name that would appear in the preference
694 file), and I<value> is the value to which it should be set.
695
696 =item -O  E<lt>protocolsE<gt>
697
698 Similar to the B<-V> option, but causes B<TShark> to only show a
699 detailed view of the comma-separated list of I<protocols> specified, and
700 show only the top-level detail line for all other protocols, rather than
701 a detailed view of all protocols.  Use the output of "B<tshark -G
702 protocols>" to find the abbreviations of the protocols you can specify.
703
704 =item -p
705
706 I<Don't> put the interface into promiscuous mode.  Note that the
707 interface might be in promiscuous mode for some other reason; hence,
708 B<-p> cannot be used to ensure that the only traffic that is captured is
709 traffic sent to or from the machine on which B<TShark> is running,
710 broadcast traffic, and multicast traffic to addresses received by that
711 machine.
712
713 This option can occur multiple times.  If used before the first
714 occurrence of the B<-i> option, no interface will be put into the
715 promiscuous mode.
716 If used after an B<-i> option, the interface specified by the last B<-i>
717 option occurring before this option will not be put into the
718 promiscuous mode.
719
720 =item -P
721
722 =item --print
723
724 Decode and display the packet summary or details, even if writing raw
725 packet data using the B<-w> option, and even if packet output is
726 otherwise suppressed with B<-Q>.
727
728 =item -q
729
730 When capturing packets, don't display the continuous count of packets
731 captured that is normally shown when saving a capture to a file;
732 instead, just display, at the end of the capture, a count of packets
733 captured.  On systems that support the SIGINFO signal, such as various
734 BSDs, you can cause the current count to be displayed by typing your
735 "status" character (typically control-T, although it
736 might be set to "disabled" by default on at least some BSDs, so you'd
737 have to explicitly set it to use it).
738
739 When reading a capture file, or when capturing and not saving to a file,
740 don't print packet information; this is useful if you're using a B<-z>
741 option to calculate statistics and don't want the packet information
742 printed, just the statistics.
743
744 =item -Q
745
746 When capturing packets, don't display, on the standard error, the
747 initial message indicating on which interfaces the capture is being
748 done, the continuous count of packets captured shown when saving a
749 capture to a file, and the final message giving the count of packets
750 captured.  Only true errors are displayed on the standard error.
751
752 only display true errors; don't display the
753 initial message indicating the.  This outputs less
754 than the B<-q> option, so the interface name and total packet
755 count and the end of a capture are not sent to stderr.
756
757 When reading a capture file, or when capturing and not saving to a file,
758 don't print packet information; this is useful if you're using a B<-z>
759 option to calculate statistics and don't want the packet information
760 printed, just the statistics.
761
762 =item -r  E<lt>infileE<gt>
763
764 Read packet data from I<infile>, can be any supported capture file format
765 (including gzipped files).  It is possible to use named pipes or stdin (-)
766 here but only with certain (not compressed) capture file formats (in
767 particular: those that can be read without seeking backwards).
768
769 =item -R  E<lt>Read filterE<gt>
770
771 Cause the specified filter (which uses the syntax of read/display filters,
772 rather than that of capture filters) to be applied during the first pass of
773 analysis. Packets not matching the filter are not considered for future
774 passes. Only makes sense with multiple passes, see -2. For regular filtering
775 on single-pass dissect see -Y instead.
776
777 Note that forward-looking fields such as 'response in frame #' cannot be used
778 with this filter, since they will not have been calculate when this filter is
779 applied.
780
781 =item -s  E<lt>capture snaplenE<gt>
782
783 Set the default snapshot length to use when capturing live data.
784 No more than I<snaplen> bytes of each network packet will be read into
785 memory, or saved to disk.  A value of 0 specifies a snapshot length of
786 262144, so that the full packet is captured; this is the default.
787
788 This option can occur multiple times.  If used before the first
789 occurrence of the B<-i> option, it sets the default snapshot length.
790 If used after an B<-i> option, it sets the snapshot length for
791 the interface specified by the last B<-i> option occurring before
792 this option.  If the snapshot length is not set specifically,
793 the default snapshot length is used if provided.
794
795 =item -S  E<lt>separatorE<gt>
796
797 Set the line separator to be printed between packets.
798
799 =item -t  a|ad|adoy|d|dd|e|r|u|ud|udoy
800
801 Set the format of the packet timestamp printed in summary lines.
802 The format can be one of:
803
804 B<a> absolute: The absolute time, as local time in your time zone,
805 is the actual time the packet was captured, with no date displayed
806
807 B<ad> absolute with date: The absolute date, displayed as YYYY-MM-DD,
808 and time, as local time in your time zone, is the actual time and date
809 the packet was captured
810
811 B<adoy> absolute with date using day of year: The absolute date,
812 displayed as YYYY/DOY, and time, as local time in your time zone,
813 is the actual time and date the packet was captured
814
815 B<d> delta: The delta time is the time since the previous packet was
816 captured
817
818 B<dd> delta_displayed: The delta_displayed time is the time since the
819 previous displayed packet was captured
820
821 B<e> epoch: The time in seconds since epoch (Jan 1, 1970 00:00:00)
822
823 B<r> relative: The relative time is the time elapsed between the first packet
824 and the current packet
825
826 B<u> UTC: The absolute time, as UTC, is the actual time the packet was
827 captured, with no date displayed
828
829 B<ud> UTC with date: The absolute date, displayed as YYYY-MM-DD,
830 and time, as UTC, is the actual time and date the packet was captured
831
832 B<udoy> UTC with date using day of year: The absolute date, displayed
833 as YYYY/DOY, and time, as UTC, is the actual time and date the packet
834 was captured
835
836 The default format is relative.
837
838 =item -T  ek|fields|json|jsonraw|pdml|ps|psml|tabs|text
839
840 Set the format of the output when viewing decoded packet data.  The
841 options are one of:
842
843 B<ek> Newline delimited JSON format for bulk import into Elasticsearch.
844 It can be used with B<-j> or B<-J> including the JSON filter or with
845 B<-x> to include raw hex-encoded packet data.
846 If B<-P> is specified it will print the packet summary only, with both
847 B<-P> and B<-V> it will print the packet summary and packet details.
848 If neither B<-P> or B<-V> are used it will print the packet details only.
849 Example of usage to import data into Elasticsearch:
850
851   tshark -T ek -j "http tcp ip" -P -V -x -r file.pcap > file.json
852   curl -H "Content-Type: application/x-ndjson" -XPOST http://elasticsearch:9200/_bulk --data-binary "@file.json"
853
854 Elastic requires a mapping file to be loaded as template for packets-*
855 index in order to convert wireshark types to elastic types. This file
856 can be auto-generated with the command "tshark -G elastic-mapping". Since
857 the mapping file can be huge, protocols can be selected by using the option
858 --elastic-mapping-filter:
859
860   tshark -G elastic-mapping --elastic-mapping-filter ip,udp,dns
861
862
863 B<fields> The values of fields specified with the B<-e> option, in a
864 form specified by the B<-E> option.  For example,
865
866   tshark -T fields -E separator=, -E quote=d
867
868 would generate comma-separated values (CSV) output suitable for importing
869 into your favorite spreadsheet program.
870
871 B<json> JSON file format.  It can be used with B<-j> or B<-J> including
872 the JSON filter or with B<-x> option to include raw hex-encoded packet
873 data.  Example of usage:
874
875   tshark -T json -r file.pcap
876   tshark -T json -j "http tcp ip" -x -r file.pcap
877
878 B<jsonraw> JSON file format including only raw hex-encoded packet data.
879 It can be used with B<-j> including or B<-J> the JSON filter option.
880 Example of usage:
881
882   tshark -T jsonraw -r file.pcap
883   tshark -T jsonraw -j "http tcp ip" -x -r file.pcap
884
885 B<pdml> Packet Details Markup Language, an XML-based format for the
886 details of a decoded packet.  This information is equivalent to the
887 packet details printed with the B<-V> option.  Using the --color option
888 will add color attributes to B<pdml> output.  These attributes are
889 nonstandard.
890
891 B<ps> PostScript for a human-readable one-line summary of each of the
892 packets, or a multi-line view of the details of each of the packets,
893 depending on whether the B<-V> option was specified.
894
895 B<psml> Packet Summary Markup Language, an XML-based format for the summary
896 information of a decoded packet.  This information is equivalent to the
897 information shown in the one-line summary printed by default.
898 Using the --color option will add color attributes to B<pdml> output. These
899 attributes are nonstandard.
900
901 B<tabs> Similar to the default B<text> report except the human-readable one-line
902 summary of each packet will include an ASCII horizontal tab (0x09) character
903 as a delimiter between each column.
904
905 B<text> Text of a human-readable one-line summary of each of the packets, or a
906 multi-line view of the details of each of the packets, depending on
907 whether the B<-V> option was specified.  This is the default.
908
909 =item -u E<lt>seconds typeE<gt>
910
911 Specifies the seconds type.  Valid choices are:
912
913 B<s> for seconds
914
915 B<hms> for hours, minutes and seconds
916
917 =item -U E<lt>tap nameE<gt>
918
919 PDUs export, exports PDUs from infile to outfile according to the tap name given. Use -Y to filter.
920
921 Enter an empty tap name "" to get a list of available names.
922
923 =item -v
924
925 =item --version
926
927 Print the version and exit.
928
929 =item -V
930
931 Cause B<TShark> to print a view of the packet details.
932
933 =item -w  E<lt>outfileE<gt> | -
934
935 Write raw packet data to I<outfile> or to the standard output if
936 I<outfile> is '-'.
937
938 NOTE: -w provides raw packet data, not text.  If you want text output
939 you need to redirect stdout (e.g. using '>'), don't use the B<-w>
940 option for this.
941
942 =item -W  E<lt>file format optionE<gt>
943
944 Save extra information in the file if the format supports it.  For
945 example,
946
947   tshark -F pcapng -W n
948
949 will save host name resolution records along with captured packets.
950
951 Future versions of Wireshark may automatically change the capture format to
952 B<pcapng> as needed.
953
954 The argument is a string that may contain the following letter:
955
956 B<n> write network address resolution information (pcapng only)
957
958 =item -x
959
960 Cause B<TShark> to print a hex and ASCII dump of the packet data
961 after printing the summary and/or details, if either are also being displayed.
962
963 =item -X E<lt>eXtension optionsE<gt>
964
965 Specify an option to be passed to a B<TShark> module.  The eXtension option
966 is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
967
968 B<lua_script>:I<lua_script_filename> tells B<TShark> to load the given script in addition to the
969 default Lua scripts.
970
971 B<lua_script>I<num>:I<argument> tells B<TShark> to pass the given argument
972 to the lua script identified by 'num', which is the number indexed order of the 'lua_script' command.
973 For example, if only one script was loaded with '-X lua_script:my.lua', then '-X lua_script1:foo'
974 will pass the string 'foo' to the 'my.lua' script.  If two scripts were loaded, such as '-X lua_script:my.lua'
975 and '-X lua_script:other.lua' in that order, then a '-X lua_script2:bar' would pass the string 'bar' to the second lua
976 script, namely 'other.lua'.
977
978 B<read_format>:I<file_format> tells B<TShark> to use the given file format to read in the
979 file (the file given in the B<-r> command option). Providing no I<file_format> argument, or
980 an invalid one, will produce a file of available file formats to use.
981
982 =item -y  E<lt>capture link typeE<gt>
983
984 Set the data link type to use while capturing packets.  The values
985 reported by B<-L> are the values that can be used.
986
987 This option can occur multiple times.  If used before the first
988 occurrence of the B<-i> option, it sets the default capture link type.
989 If used after an B<-i> option, it sets the capture link type for
990 the interface specified by the last B<-i> option occurring before
991 this option.  If the capture link type is not set specifically,
992 the default capture link type is used if provided.
993
994 =item -Y  E<lt>displaY filterE<gt>
995
996 Cause the specified filter (which uses the syntax of read/display filters,
997 rather than that of capture filters) to be applied before printing a
998 decoded form of packets or writing packets to a file.  Packets matching the
999 filter are printed or written to file; packets that the matching packets
1000 depend upon (e.g., fragments), are not printed but are written to file;
1001 packets not matching the filter nor depended upon are discarded rather
1002 than being printed or written.
1003
1004 Use this instead of -R for filtering using single-pass analysis. If doing
1005 two-pass analysis (see -2) then only packets matching the read filter (if there
1006 is one) will be checked against this filter.
1007
1008 =item -M  E<lt>auto session resetE<gt>
1009
1010 Automatically reset internal session when reached to specified number of packets.
1011 for example,
1012
1013     tshark -M 100000
1014
1015 will reset session every 100000 packets.
1016
1017 This feature does not support -2 two-pass analysis
1018
1019 =item -z  E<lt>statisticsE<gt>
1020
1021 Get B<TShark> to collect various types of statistics and display the
1022 result after finishing reading the capture file.  Use the B<-q> option
1023 if you're reading a capture file and only want the statistics printed,
1024 not any per-packet information.
1025
1026 Note that the B<-z proto> option is different - it doesn't cause
1027 statistics to be gathered and printed when the capture is complete, it
1028 modifies the regular packet summary output to include the values of
1029 fields specified with the option.  Therefore you must not use the B<-q>
1030 option, as that option would suppress the printing of the regular packet
1031 summary output, and must also not use the B<-V> option, as that would
1032 cause packet detail information rather than packet summary information
1033 to be printed.
1034
1035 Currently implemented statistics are:
1036
1037 =over 4
1038
1039 =item B<-z help>
1040
1041 Display all possible values for B<-z>.
1042
1043 =item B<-z> afp,srt[,I<filter>]
1044
1045 Show Apple Filing Protocol service response time statistics.
1046
1047 =item B<-z> camel,srt
1048
1049 =item B<-z> conv,I<type>[,I<filter>]
1050
1051 Create a table that lists all conversations that could be seen in the
1052 capture.  I<type> specifies the conversation endpoint types for which we
1053 want to generate the statistics; currently the supported ones are:
1054
1055   "bluetooth"  Bluetooth addresses
1056   "eth"   Ethernet addresses
1057   "fc"    Fibre Channel addresses
1058   "fddi"  FDDI addresses
1059   "ip"    IPv4 addresses
1060   "ipv6"  IPv6 addresses
1061   "ipx"   IPX addresses
1062   "jxta"  JXTA message addresses
1063   "ncp"   NCP connections
1064   "rsvp"  RSVP connections
1065   "sctp"  SCTP addresses
1066   "tcp"   TCP/IP socket pairs  Both IPv4 and IPv6 are supported
1067   "tr"    Token Ring addresses
1068   "usb"   USB addresses
1069   "udp"   UDP/IP socket pairs  Both IPv4 and IPv6 are supported
1070   "wlan"  IEEE 802.11 addresses
1071
1072 If the optional I<filter> is specified, only those packets that match the
1073 filter will be used in the calculations.
1074
1075 The table is presented with one line for each conversation and displays
1076 the number of packets/bytes in each direction as well as the total
1077 number of packets/bytes.  The table is sorted according to the total
1078 number of frames.
1079
1080 =item B<-z> dcerpc,srt,I<uuid>,I<major>.I<minor>[,I<filter>]
1081
1082 Collect call/reply SRT (Service Response Time) data for DCERPC interface I<uuid>,
1083 version I<major>.I<minor>.
1084 Data collected is the number of calls for each procedure, MinSRT, MaxSRT
1085 and AvgSRT.
1086
1087 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0>> will collect data for the CIFS SAMR Interface.
1088
1089 This option can be used multiple times on the command line.
1090
1091 If the optional I<filter> is provided, the stats will only be calculated
1092 on those calls that match that filter.
1093
1094 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0,ip.addr==1.2.3.4>> will collect SAMR
1095 SRT statistics for a specific host.
1096
1097 =item B<-z> bootp,stat[,I<filter>]
1098
1099 Show DHCP (BOOTP) statistics.
1100
1101 =item B<-z> diameter,avp[,I<cmd.code>,I<field>,I<field>,I<...>]
1102
1103 This option enables extraction of most important diameter fields from large capture files.
1104 Exactly one text line for each diameter message with matched B<diameter.cmd.code> will be printed.
1105
1106 Empty diameter command code or '*' can be specified to mach any B<diameter.cmd.code>
1107
1108 Example: B<-z diameter,avp>  extract default field set from diameter messages.
1109
1110 Example: B<-z diameter,avp,280>  extract default field set from diameter DWR messages.
1111
1112 Example: B<-z diameter,avp,272>  extract default field set from diameter CC messages.
1113
1114 Extract most important fields from diameter CC messages:
1115
1116 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>
1117
1118 Following fields will be printed out for each diameter message:
1119
1120   "frame"        Frame number.
1121   "time"         Unix time of the frame arrival.
1122   "src"          Source address.
1123   "srcport"      Source port.
1124   "dst"          Destination address.
1125   "dstport"      Destination port.
1126   "proto"        Constant string 'diameter', which can be used for post processing of tshark output.  E.g. grep/sed/awk.
1127   "msgnr"        seq. number of diameter message within the frame.  E.g. '2' for the third diameter message in the same frame.
1128   "is_request"   '0' if message is a request, '1' if message is an answer.
1129   "cmd"          diameter.cmd_code, E.g. '272' for credit control messages.
1130   "req_frame"    Number of frame where matched request was found or '0'.
1131   "ans_frame"    Number of frame where matched answer was found or '0'.
1132   "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.
1133
1134 B<-z diameter,avp> option is much faster than B<-V -T text> or B<-T pdml> options.
1135
1136 B<-z diameter,avp> option is more powerful than B<-T field> and B<-z proto,colinfo> options.
1137
1138 Multiple diameter messages in one frame are supported.
1139
1140 Several fields with same name within one diameter message are supported, e.g. I<diameter.Subscription-Id-Data> or I<diameter.Rating-Group>.
1141
1142 Note: B<tshark -q> option is recommended to suppress default B<tshark> output.
1143
1144 =item B<-z> dns,tree[,I<filter>]
1145
1146 Create a summary of the captured DNS packets. General information are collected such as qtype and qclass distribution.
1147 For some data (as qname length or DNS payload) max, min and average values are also displayed.
1148
1149 =item B<-z> endpoints,I<type>[,I<filter>]
1150
1151 Create a table that lists all endpoints that could be seen in the
1152 capture.  I<type> specifies the endpoint types for which we
1153 want to generate the statistics; currently the supported ones are:
1154
1155   "bluetooth"  Bluetooth addresses
1156   "eth"   Ethernet addresses
1157   "fc"    Fibre Channel addresses
1158   "fddi"  FDDI addresses
1159   "ip"    IPv4 addresses
1160   "ipv6"  IPv6 addresses
1161   "ipx"   IPX addresses
1162   "jxta"  JXTA message addresses
1163   "ncp"   NCP connections
1164   "rsvp"  RSVP connections
1165   "sctp"  SCTP addresses
1166   "tcp"   TCP/IP socket pairs  Both IPv4 and IPv6 are supported
1167   "tr"    Token Ring addresses
1168   "usb"   USB addresses
1169   "udp"   UDP/IP socket pairs  Both IPv4 and IPv6 are supported
1170   "wlan"  IEEE 802.11 addresses
1171
1172 If the optional I<filter> is specified, only those packets that match the
1173 filter will be used in the calculations.
1174
1175 The table is presented with one line for each conversation and displays
1176 the number of packets/bytes in each direction as well as the total
1177 number of packets/bytes.  The table is sorted according to the total
1178 number of frames.
1179
1180 =item B<-z> expert[I<,error|,warn|,note|,chat|,comment>][I<,filter>]
1181
1182 Collects information about all expert info, and will display them in order,
1183 grouped by severity.
1184
1185 Example: B<-z expert,sip> will show expert items of all severity for frames that
1186 match the sip protocol.
1187
1188 This option can be used multiple times on the command line.
1189
1190 If the optional I<filter> is provided, the stats will only be calculated
1191 on those calls that match that filter.
1192
1193 Example: B<-z "expert,note,tcp"> will only collect expert items for frames that
1194 include the tcp protocol, with a severity of note or higher.
1195
1196 =item B<-z> flow,I<name>,I<mode>,[I<filter>]
1197
1198 Displays the flow of data between two nodes. Output is the same as ASCII format
1199 saved from GUI.
1200
1201 I<name> specifies the flow name.  It can be one of:
1202
1203   any      All frames
1204   icmp     ICMP
1205   icmpv6   ICMPv6
1206   lbm_uim  UIM
1207   tcp      TCP
1208
1209 I<mode> specifies the address type.  It can be one of:
1210
1211   standard   Any address
1212   network    Network address
1213
1214 Example: B<-z flow,tcp,network> will show data flow for all TCP frames
1215
1216 =item B<-z> follow,I<prot>,I<mode>,I<filter>[I<,range>]
1217
1218 Displays the contents of a TCP or UDP stream between two nodes.  The data
1219 sent by the second node is prefixed with a tab to differentiate it from the
1220 data sent by the first node.
1221
1222 I<prot> specifies the transport protocol.  It can be one of:
1223
1224   tcp   TCP
1225   udp   UDP
1226   tls   TLS or SSL
1227
1228 I<mode> specifies the output mode.  It can be one of:
1229
1230   ascii  ASCII output with dots for non-printable characters
1231   ebcdic EBCDIC output with dots for non-printable characters
1232   hex    Hexadecimal and ASCII data with offsets
1233   raw    Hexadecimal data
1234
1235 Since the output in B<ascii> or B<ebcdic> mode may contain newlines, the length
1236 of each section of output plus a newline precedes each section of output.
1237
1238 I<filter> specifies the stream to be displayed. UDP/TCP streams are selected
1239 with either the stream index or IP address plus port pairs. TLS streams are
1240 selected with the stream index. For example:
1241
1242   ip-addr0:port0,ip-addr1:port1
1243   stream-index
1244
1245 I<range> optionally specifies which "chunks" of the stream should be displayed.
1246
1247 Example: B<-z "follow,tcp,hex,1"> will display the contents of the second TCP
1248 stream (the first is stream 0) in "hex" format.
1249
1250   ===================================================================
1251   Follow: tcp,hex
1252   Filter: tcp.stream eq 1
1253   Node 0: 200.57.7.197:32891
1254   Node 1: 200.57.7.198:2906
1255   00000000  00 00 00 22 00 00 00 07  00 0a 85 02 07 e9 00 02  ...".... ........
1256   00000010  07 e9 06 0f 00 0d 00 04  00 00 00 01 00 03 00 06  ........ ........
1257   00000020  1f 00 06 04 00 00                                 ......
1258   00000000  00 01 00 00                                       ....
1259   00000026  00 02 00 00
1260
1261 Example: B<-z "follow,tcp,ascii,200.57.7.197:32891,200.57.7.198:2906"> will
1262 display the contents of a TCP stream between 200.57.7.197 port 32891 and
1263 200.57.7.98 port 2906.
1264
1265   ===================================================================
1266   Follow: tcp,ascii
1267   Filter: (omitted for readability)
1268   Node 0: 200.57.7.197:32891
1269   Node 1: 200.57.7.198:2906
1270   38
1271   ...".....
1272   ................
1273   4
1274   ....
1275
1276 =item B<-z> h225,counter[I<,filter>]
1277
1278 Count ITU-T H.225 messages and their reasons.  In the first column you get a
1279 list of H.225 messages and H.225 message reasons, which occur in the current
1280 capture file.  The number of occurrences of each message or reason is displayed
1281 in the second column.
1282
1283 Example: B<-z h225,counter>.
1284
1285 If the optional I<filter> is provided, the stats will only be calculated
1286 on those calls that match that filter.
1287 Example: use B<-z "h225,counter,ip.addr==1.2.3.4"> to only collect stats for
1288 H.225 packets exchanged by the host at IP address 1.2.3.4 .
1289
1290 This option can be used multiple times on the command line.
1291
1292 =item B<-z> h225,srt[I<,filter>]
1293
1294 Collect requests/response SRT (Service Response Time) data for ITU-T H.225 RAS.
1295 Data collected is number of calls of each ITU-T H.225 RAS Message Type,
1296 Minimum SRT, Maximum SRT, Average SRT, Minimum in Packet, and Maximum in Packet.
1297 You will also get the number of Open Requests (Unresponded Requests),
1298 Discarded Responses (Responses without matching request) and Duplicate Messages.
1299
1300 Example: B<tshark -z h225,srt>
1301
1302 This option can be used multiple times on the command line.
1303
1304 If the optional I<filter> is provided, the stats will only be calculated
1305 on those calls that match that filter.
1306
1307 Example: B<-z "h225,srt,ip.addr==1.2.3.4"> will only collect stats for
1308 ITU-T H.225 RAS packets exchanged by the host at IP address 1.2.3.4 .
1309
1310 =item B<-z> hosts[,ipv4][,ipv6]
1311
1312 Dump any collected IPv4 and/or IPv6 addresses in "hosts" format.  Both IPv4
1313 and IPv6 addresses are dumped by default.
1314
1315 Addresses are collected from a number of sources, including standard "hosts"
1316 files and captured traffic.
1317
1318 =item B<-z> hpfeeds,tree[,I<filter>]
1319
1320 Calculate statistics for HPFEEDS traffic such as publish per channel, and opcode
1321 distribution.
1322
1323 =item B<-z> http,stat,
1324
1325 Calculate the HTTP statistics distribution. Displayed values are
1326 the HTTP status codes and the HTTP request methods.
1327
1328 =item B<-z> http,tree
1329
1330 Calculate the HTTP packet distribution. Displayed values are the
1331 HTTP request modes and the HTTP status codes.
1332
1333 =item B<-z> http_ref,tree
1334
1335 Calculate the HTTP requests by referer. Displayed values are the
1336 referring URI.
1337
1338 =item B<-z> http_req,tree
1339
1340 Calculate the HTTP requests by server. Displayed values are the
1341 server name and the URI path.
1342
1343 =item B<-z> http_srv,tree
1344
1345 Calculate the HTTP requests and responses by server. For the HTTP
1346 requests, displayed values are the server IP address and server
1347 hostname. For the HTTP responses, displayed values are the server
1348 IP address and status.
1349
1350 =item B<-z> icmp,srt[,I<filter>]
1351
1352 Compute total ICMP echo requests, replies, loss, and percent loss, as well as
1353 minimum, maximum, mean, median and sample standard deviation SRT statistics
1354 typical of what ping provides.
1355
1356 Example: S<B<-z icmp,srt,ip.src==1.2.3.4>> will collect ICMP SRT statistics
1357 for ICMP echo request packets originating from a specific host.
1358
1359 This option can be used multiple times on the command line.
1360
1361 =item B<-z> icmpv6,srt[,I<filter>]
1362
1363 Compute total ICMPv6 echo requests, replies, loss, and percent loss, as well as
1364 minimum, maximum, mean, median and sample standard deviation SRT statistics
1365 typical of what ping provides.
1366
1367 Example: S<B<-z icmpv6,srt,ipv6.src==fe80::1>> will collect ICMPv6 SRT statistics
1368 for ICMPv6 echo request packets originating from a specific host.
1369
1370 This option can be used multiple times on the command line.
1371
1372 =item B<-z> io,phs[,I<filter>]
1373
1374 Create Protocol Hierarchy Statistics listing both number of packets and bytes.
1375 If no I<filter> is specified the statistics will be calculated for all packets.
1376 If a I<filter> is specified statistics will only be calculated for those
1377 packets that match the filter.
1378
1379 This option can be used multiple times on the command line.
1380
1381 =item B<-z> io,stat,I<interval>[,I<filter>][,I<filter>][,I<filter>]...
1382
1383 Collect packet/bytes statistics for the capture in intervals of
1384 I<interval> seconds.  I<Interval> can be specified either as a whole or
1385 fractional second and can be specified with microsecond (us) resolution.
1386 If I<interval> is 0, the statistics will be calculated over all packets.
1387
1388 If no I<filter> is specified the statistics will be calculated for all packets.
1389 If one or more I<filters> are specified statistics will be calculated for
1390 all filters and presented with one column of statistics for each filter.
1391
1392 This option can be used multiple times on the command line.
1393
1394 Example: B<-z io,stat,1,ip.addr==1.2.3.4> will generate 1 second
1395 statistics for all traffic to/from host 1.2.3.4.
1396
1397 Example: B<-z "io,stat,0.001,smb&&ip.addr==1.2.3.4"> will generate 1ms
1398 statistics for all SMB packets to/from host 1.2.3.4.
1399
1400 The examples above all use the standard syntax for generating statistics
1401 which only calculates the number of packets and bytes in each interval.
1402
1403 B<io,stat> can also do much more statistics and calculate COUNT(), SUM(),
1404 MIN(), MAX(), AVG() and LOAD() using a slightly different filter syntax:
1405
1406 =item -z io,stat,I<interval>,E<34>[COUNT|SUM|MIN|MAX|AVG|LOAD](I<field>)I<filter>E<34>
1407
1408 NOTE: One important thing to note here is that the filter is not optional
1409 and that the field that the calculation is based on MUST be part of the filter
1410 string or the calculation will fail.
1411
1412 So: B<-z io,stat,0.010,AVG(smb.time)> does not work.  Use B<-z
1413 io,stat,0.010,AVG(smb.time)smb.time> instead.  Also be aware that a field
1414 can exist multiple times inside the same packet and will then be counted
1415 multiple times in those packets.
1416
1417 NOTE: A second important thing to note is that the system setting for
1418 decimal separator must be set to "."! If it is set to "," the statistics
1419 will not be displayed per filter.
1420
1421 B<COUNT(I<field>)I<filter>> - Calculates the number of times that the
1422 field I<name> (not its value) appears per interval in the filtered packet list.
1423 ''I<field>'' can be any display filter name.
1424
1425 Example: B<-z io,stat,0.010,E<34>COUNT(smb.sid)smb.sidE<34>>
1426
1427 This will count the total number of SIDs seen in each 10ms interval.
1428
1429 B<SUM(I<field>)I<filter>> - Unlike COUNT, the I<values> of the
1430 specified field are summed per time interval.
1431 ''I<field>'' can only be a named integer, float, double or relative time field.
1432
1433 Example: B<tshark -z io,stat,0.010,E<34>SUM(frame.len)frame.lenE<34>>
1434
1435 Reports the total number of bytes that were transmitted bidirectionally in
1436 all the packets within a 10 millisecond interval.
1437
1438 B<MIN/MAX/AVG(I<field>)I<filter>> - The minimum, maximum, or average field value
1439 in each interval is calculated.  The specified field must be a named integer,
1440 float, double or relative time field.  For relative time fields, the output is presented in
1441 seconds with six decimal digits of precision rounded to the nearest microsecond.
1442
1443 In the following example, the time of the first Read_AndX call, the last Read_AndX
1444 response values are displayed and the minimum, maximum, and average Read response times
1445 (SRTs) are calculated.  NOTE: If the DOS command shell line continuation character, ''^''
1446 is used, each line cannot end in a comma so it is placed at the beginning of each
1447 continuation line:
1448
1449   tshark -o tcp.desegment_tcp_streams:FALSE -n -q -r smb_reads.cap -z io,stat,0,
1450   "MIN(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==0",
1451   "MAX(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==1",
1452   "MIN(smb.time)smb.time and smb.cmd==0x2e",
1453   "MAX(smb.time)smb.time and smb.cmd==0x2e",
1454   "AVG(smb.time)smb.time and smb.cmd==0x2e"
1455
1456
1457   ======================================================================================================
1458   IO Statistics
1459   Column #0: MIN(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==0
1460   Column #1: MAX(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==1
1461   Column #2: MIN(smb.time)smb.time and smb.cmd==0x2e
1462   Column #3: MAX(smb.time)smb.time and smb.cmd==0x2e
1463   Column #4: AVG(smb.time)smb.time and smb.cmd==0x2e
1464                   |    Column #0   |    Column #1   |    Column #2   |    Column #3   |    Column #4   |
1465   Time            |       MIN      |       MAX      |       MIN      |       MAX      |       AVG      |
1466   000.000-                 0.000000         7.704054         0.000072         0.005539         0.000295
1467   ======================================================================================================
1468
1469 The following command displays the average SMB Read response PDU size, the
1470 total number of read PDU bytes, the average SMB Write request PDU size, and
1471 the total number of bytes transferred in SMB Write PDUs:
1472
1473   tshark -n -q -r smb_reads_writes.cap -z io,stat,0,
1474   "AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to",
1475   "SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to",
1476   "AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to",
1477   "SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to"
1478
1479   =====================================================================================
1480   IO Statistics
1481   Column #0: AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to
1482   Column #1: SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to
1483   Column #2: AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to
1484   Column #3: SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to
1485                   |    Column #0   |    Column #1   |    Column #2   |    Column #3   |
1486   Time            |       AVG      |       SUM      |       AVG      |       SUM      |
1487   000.000-                    30018         28067522               72             3240
1488   =====================================================================================
1489
1490 B<LOAD(I<field>)I<filter>> - The LOAD/Queue-Depth
1491 in each interval is calculated.  The specified field must be a relative time field that represents a response time.  For example smb.time.
1492 For each interval the Queue-Depth for the specified protocol is calculated.
1493
1494 The following command displays the average SMB LOAD.
1495 A value of 1.0 represents one I/O in flight.
1496
1497   tshark -n -q -r smb_reads_writes.cap
1498   -z "io,stat,0.001,LOAD(smb.time)smb.time"
1499
1500   ============================================================================
1501   IO Statistics
1502   Interval:   0.001000 secs
1503   Column #0: LOAD(smb.time)smb.time
1504                           |    Column #0   |
1505   Time                    |       LOAD     |
1506   0000.000000-0000.001000         1.000000
1507   0000.001000-0000.002000         0.741000
1508   0000.002000-0000.003000         0.000000
1509   0000.003000-0000.004000         1.000000
1510
1511
1512
1513 B<FRAMES | BYTES[()I<filter>]> - Displays the total number of frames or bytes.
1514 The filter field is optional but if included it must be prepended with ''()''.
1515
1516 The following command displays five columns: the total number of frames and bytes
1517 (transferred bidirectionally) using a single comma, the same two stats using the FRAMES and BYTES
1518 subcommands, the total number of frames containing at least one SMB Read response, and
1519 the total number of bytes transmitted to the client (unidirectionally) at IP address 10.1.0.64.
1520
1521   tshark -o tcp.desegment_tcp_streams:FALSE -n -q -r smb_reads.cap -z io,stat,0,,FRAMES,BYTES,
1522   "FRAMES()smb.cmd==0x2e and smb.response_to","BYTES()ip.dst==10.1.0.64"
1523
1524   =======================================================================================================================
1525   IO Statistics
1526   Column #0:
1527   Column #1: FRAMES
1528   Column #2: BYTES
1529   Column #3: FRAMES()smb.cmd==0x2e and smb.response_to
1530   Column #4: BYTES()ip.dst==10.1.0.64
1531                   |            Column #0            |    Column #1   |    Column #2   |    Column #3   |    Column #4   |
1532   Time            |     Frames     |      Bytes     |     FRAMES     |     BYTES      |     FRAMES     |     BYTES      |
1533   000.000-                    33576         29721685            33576         29721685              870         29004801
1534   =======================================================================================================================
1535
1536 =item B<-z> mac-lte,stat[I<,filter>]
1537
1538 This option will activate a counter for LTE MAC messages.  You will get
1539 information about the maximum number of UEs/TTI, common messages and
1540 various counters for each UE that appears in the log.
1541
1542 Example: B<tshark -z mac-lte,stat>.
1543
1544 This option can be used multiple times on the command line.
1545
1546 If the optional I<filter> is provided, the stats will only be calculated
1547 for those frames that match that filter.
1548 Example: B<-z "mac-lte,stat,mac-lte.rnti>3000"> will only collect stats for
1549 UEs with an assigned RNTI whose value is more than 3000.
1550
1551 =item B<-z> megaco,rtd[I<,filter>]
1552
1553 Collect requests/response RTD (Response Time Delay) data for MEGACO.
1554 (This is similar to B<-z smb,srt>).  Data collected is the number of calls
1555 for each known MEGACO Type, MinRTD, MaxRTD and AvgRTD.
1556 Additionally you get the number of duplicate requests/responses,
1557 unresponded requests, responses, which don't match with any request.
1558 Example: B<-z megaco,rtd>.
1559
1560 If the optional I<filter> is provided, the stats will only be calculated
1561 on those calls that match that filter.
1562 Example: B<-z "megaco,rtd,ip.addr==1.2.3.4"> will only collect stats for
1563 MEGACO packets exchanged by the host at IP address 1.2.3.4 .
1564
1565 This option can be used multiple times on the command line.
1566
1567 =item B<-z> mgcp,rtd[I<,filter>]
1568
1569 Collect requests/response RTD (Response Time Delay) data for MGCP.
1570 (This is similar to B<-z smb,srt>).  Data collected is the number of calls
1571 for each known MGCP Type, MinRTD, MaxRTD and AvgRTD.
1572 Additionally you get the number of duplicate requests/responses,
1573 unresponded requests, responses, which don't match with any request.
1574 Example: B<-z mgcp,rtd>.
1575
1576 This option can be used multiple times on the command line.
1577
1578 If the optional I<filter> is provided, the stats will only be calculated
1579 on those calls that match that filter.
1580 Example: B<-z "mgcp,rtd,ip.addr==1.2.3.4"> will only collect stats for
1581 MGCP packets exchanged by the host at IP address 1.2.3.4 .
1582
1583 =item B<-z> proto,colinfo,I<filter>,I<field>
1584
1585 Append all I<field> values for the packet to the Info column of the
1586 one-line summary output.
1587 This feature can be used to append arbitrary fields to the Info column
1588 in addition to the normal content of that column.
1589 I<field> is the display-filter name of a field which value should be placed
1590 in the Info column.
1591 I<filter> is a filter string that controls for which packets the field value
1592 will be presented in the info column.  I<field> will only be presented in the
1593 Info column for the packets which match I<filter>.
1594
1595 NOTE: In order for B<TShark> to be able to extract the I<field> value
1596 from the packet, I<field> MUST be part of the I<filter> string.  If not,
1597 B<TShark> will not be able to extract its value.
1598
1599 For a simple example to add the "nfs.fh.hash" field to the Info column
1600 for all packets containing the "nfs.fh.hash" field, use
1601
1602 B<-z proto,colinfo,nfs.fh.hash,nfs.fh.hash>
1603
1604 To put "nfs.fh.hash" in the Info column but only for packets coming from
1605 host 1.2.3.4 use:
1606
1607 B<-z "proto,colinfo,nfs.fh.hash && ip.src==1.2.3.4,nfs.fh.hash">
1608
1609 This option can be used multiple times on the command line.
1610
1611 =item B<-z> rlc-lte,stat[I<,filter>]
1612
1613 This option will activate a counter for LTE RLC messages.  You will get
1614 information about common messages and various counters for each UE that appears
1615 in the log.
1616
1617 Example: B<tshark -z rlc-lte,stat>.
1618
1619 This option can be used multiple times on the command line.
1620
1621 If the optional I<filter> is provided, the stats will only be calculated
1622 for those frames that match that filter.
1623 Example: B<-z "rlc-lte,stat,rlc-lte.ueid>3000"> will only collect stats for
1624 UEs with a UEId of more than 3000.
1625
1626 =item B<-z> rpc,programs
1627
1628 Collect call/reply SRT data for all known ONC-RPC programs/versions.
1629 Data collected is number of calls for each protocol/version, MinSRT,
1630 MaxSRT and AvgSRT.
1631 This option can only be used once on the command line.
1632
1633 =item B<-z> rpc,srt,I<program>,I<version>[,I<filter>]
1634
1635 Collect call/reply SRT (Service Response Time) data for I<program>/I<version>.
1636 Data collected is the number of calls for each procedure, MinSRT, MaxSRT,
1637 AvgSRT, and the total time taken for each procedure.
1638
1639
1640 Example: B<tshark -z rpc,srt,100003,3> will collect data for NFS v3.
1641
1642 This option can be used multiple times on the command line.
1643
1644 If the optional I<filter> is provided, the stats will only be calculated
1645 on those calls that match that filter.
1646
1647 Example: B<-z rpc,srt,100003,3,nfs.fh.hash==0x12345678> will collect NFS v3
1648 SRT statistics for a specific file.
1649
1650 =item B<-z> rtp,streams
1651
1652 Collect statistics for all RTP streams and calculate max. delta, max. and
1653 mean jitter and packet loss percentages.
1654
1655 =item B<-z> scsi,srt,I<cmdset>[,I<filter>]
1656
1657 Collect call/reply SRT (Service Response Time) data for SCSI commandset I<cmdset>.
1658
1659 Commandsets are 0:SBC   1:SSC  5:MMC
1660
1661 Data collected
1662 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
1663
1664 Example: B<-z scsi,srt,0> will collect data for SCSI BLOCK COMMANDS (SBC).
1665
1666 This option can be used multiple times on the command line.
1667
1668 If the optional I<filter> is provided, the stats will only be calculated
1669 on those calls that match that filter.
1670
1671 Example: B<-z scsi,srt,0,ip.addr==1.2.3.4> will collect SCSI SBC
1672 SRT statistics for a specific iscsi/ifcp/fcip host.
1673
1674 =item B<-z> sip,stat[I<,filter>]
1675
1676 This option will activate a counter for SIP messages.  You will get the number
1677 of occurrences of each SIP Method and of each SIP Status-Code.  Additionally
1678 you also get the number of resent SIP Messages (only for SIP over UDP).
1679
1680 Example: B<-z sip,stat>.
1681
1682 This option can be used multiple times on the command line.
1683
1684 If the optional I<filter> is provided, the stats will only be calculated
1685 on those calls that match that filter.
1686 Example: B<-z "sip,stat,ip.addr==1.2.3.4"> will only collect stats for
1687 SIP packets exchanged by the host at IP address 1.2.3.4 .
1688
1689 =item B<-z> smb,sids
1690
1691 When this feature is used B<TShark> will print a report with all the
1692 discovered SID and account name mappings.  Only those SIDs where the
1693 account name is known will be presented in the table.
1694
1695 For this feature to work you will need to either to enable
1696 "Edit/Preferences/Protocols/SMB/Snoop SID to name mappings" in the
1697 preferences or you can override the preferences by specifying
1698 S<B<-o "smb.sid_name_snooping:TRUE">> on the B<TShark> command line.
1699
1700 The current method used by B<TShark> to find the SID->name mapping
1701 is relatively restricted with a hope of future expansion.
1702
1703 =item B<-z> smb,srt[,I<filter>]
1704
1705 Collect call/reply SRT (Service Response Time) data for SMB.  Data collected
1706 is number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
1707
1708 Example: B<-z smb,srt>
1709
1710 The data will be presented as separate tables for all normal SMB commands,
1711 all Transaction2 commands and all NT Transaction commands.
1712 Only those commands that are seen in the capture will have its stats
1713 displayed.
1714 Only the first command in a xAndX command chain will be used in the
1715 calculation.  So for common SessionSetupAndX + TreeConnectAndX chains,
1716 only the SessionSetupAndX call will be used in the statistics.
1717 This is a flaw that might be fixed in the future.
1718
1719 This option can be used multiple times on the command line.
1720
1721 If the optional I<filter> is provided, the stats will only be calculated
1722 on those calls that match that filter.
1723
1724 Example: B<-z "smb,srt,ip.addr==1.2.3.4"> will only collect stats for
1725 SMB packets exchanged by the host at IP address 1.2.3.4 .
1726
1727 =back
1728
1729 =item --capture-comment E<lt>commentE<gt>
1730
1731 Add a capture comment to the output file.
1732
1733 This option is only available if a new output file in pcapng format is
1734 created. Only one capture comment may be set per output file.
1735
1736 =item --list-time-stamp-types
1737
1738 List time stamp types supported for the interface. If no time stamp type can be
1739 set, no time stamp types are listed.
1740
1741 =item --time-stamp-type E<lt>typeE<gt>
1742
1743 Change the interface's timestamp method.
1744
1745 =item --color
1746
1747 Enable coloring of packets according to standard Wireshark color
1748 filters. On Windows colors are limited to the standard console
1749 character attribute colors. Other platforms require a terminal that
1750 handles 24-bit "true color" terminal escape sequences. See
1751 L<https://wiki.wireshark.org/ColoringRules> for more information on
1752 configuring color filters.
1753
1754 =item --no-duplicate-keys
1755
1756 If a key appears multiple times in an object, only write it a single time with
1757 as value a json array containing all the separate values. (Only works with
1758 -T json)
1759
1760 =item --elastic-mapping-filter E<lt>protocolE<gt>,E<lt>protocolE<gt>,...
1761
1762 When generating the ElasticSearch mapping file, only put the specified protocols
1763 in it, to avoid a huge mapping file that can choke some software (such as Kibana).
1764 The option takes a list of wanted protocol abbreviations, separated by comma.
1765
1766 Example: ip,udp,dns puts only those three protocols in the mapping file.
1767
1768 =item --export-objects E<lt>protocolE<gt>,E<lt>destdirE<gt>
1769
1770 Export all objects within a protocol into directory B<destdir>. The available
1771 values for B<protocol> can be listed with B<--export-objects help>.
1772
1773 The objects are directly saved in the given directory. Filenames are dependent
1774 on the dissector, but typically it is named after the basename of a file.
1775 Duplicate files are not overwritten, instead an increasing number is appended
1776 before the file extension.
1777
1778 This interface is subject to change, adding the possibility to filter on files.
1779
1780 =item --enable-protocol E<lt>proto_nameE<gt>
1781
1782 Enable dissection of proto_name.
1783
1784 =item --disable-protocol E<lt>proto_nameE<gt>
1785
1786 Disable dissection of proto_name.
1787
1788 =item --enable-heuristic E<lt>short_nameE<gt>
1789
1790 Enable dissection of heuristic protocol.
1791
1792 =item --disable-heuristic E<lt>short_nameE<gt>
1793
1794 Disable dissection of heuristic protocol.
1795
1796 =back
1797
1798 =head1 CAPTURE FILTER SYNTAX
1799
1800 See the manual page of pcap-filter(7) or, if that doesn't exist, tcpdump(8),
1801 or, if that doesn't exist, L<https://wiki.wireshark.org/CaptureFilters>.
1802
1803 =head1 READ FILTER SYNTAX
1804
1805 For a complete table of protocol and protocol fields that are filterable
1806 in B<TShark> see the wireshark-filter(4) manual page.
1807
1808 =head1 FILES
1809
1810 These files contains various B<Wireshark> configuration values.
1811
1812 =over 4
1813
1814 =item Preferences
1815
1816 The F<preferences> files contain global (system-wide) and personal
1817 preference settings.  If the system-wide preference file exists, it is
1818 read first, overriding the default settings.  If the personal preferences
1819 file exists, it is read next, overriding any previous values.  Note: If
1820 the command line option B<-o> is used (possibly more than once), it will
1821 in turn override values from the preferences files.
1822
1823 The preferences settings are in the form I<prefname>B<:>I<value>,
1824 one per line,
1825 where I<prefname> is the name of the preference
1826 and I<value> is the value to
1827 which it should be set; white space is allowed between B<:> and
1828 I<value>.  A preference setting can be continued on subsequent lines by
1829 indenting the continuation lines with white space.  A B<#> character
1830 starts a comment that runs to the end of the line:
1831
1832   # Capture in promiscuous mode?
1833   # TRUE or FALSE (case-insensitive).
1834   capture.prom_mode: TRUE
1835
1836 The global preferences file is looked for in the F<wireshark> directory
1837 under the F<share> subdirectory of the main installation directory (for
1838 example, F</usr/local/share/wireshark/preferences>) on UNIX-compatible
1839 systems, and in the main installation directory (for example,
1840 F<C:\Program Files\Wireshark\preferences>) on Windows systems.
1841
1842 The personal preferences file is looked for in
1843 F<$XDG_CONFIG_HOME/wireshark/preferences>
1844 (or, if F<$XDG_CONFIG_HOME/wireshark> does not exist while F<$HOME/.wireshark>
1845 is present, F<$HOME/.wireshark/preferences>) on
1846 UNIX-compatible systems and F<%APPDATA%\Wireshark\preferences> (or, if
1847 %APPDATA% isn't defined, F<%USERPROFILE%\Application
1848 Data\Wireshark\preferences>) on Windows systems.
1849
1850 =item Disabled (Enabled) Protocols
1851
1852 The F<disabled_protos> files contain system-wide and personal lists of
1853 protocols that have been disabled, so that their dissectors are never
1854 called.  The files contain protocol names, one per line, where the
1855 protocol name is the same name that would be used in a display filter
1856 for the protocol:
1857
1858   http
1859   tcp     # a comment
1860
1861 The global F<disabled_protos> file uses the same directory as the global
1862 preferences file.
1863
1864 The personal F<disabled_protos> file uses the same directory as the
1865 personal preferences file.
1866
1867 =item Name Resolution (hosts)
1868
1869 If the personal F<hosts> file exists, it is
1870 used to resolve IPv4 and IPv6 addresses before any other
1871 attempts are made to resolve them.  The file has the standard F<hosts>
1872 file syntax; each line contains one IP address and name, separated by
1873 whitespace.  The same directory as for the personal preferences file is
1874 used.
1875
1876 Capture filter name resolution is handled by libpcap on UNIX-compatible
1877 systems and WinPcap on Windows.  As such the Wireshark personal F<hosts> file
1878 will not be consulted for capture filter name resolution.
1879
1880 =item Name Resolution (subnets)
1881
1882 If an IPv4 address cannot be translated via name resolution (no exact
1883 match is found) then a partial match is attempted via the F<subnets> file.
1884
1885 Each line of this file consists of an IPv4 address, a subnet mask length
1886 separated only by a / and a name separated by whitespace. While the address
1887 must be a full IPv4 address, any values beyond the mask length are subsequently
1888 ignored.
1889
1890 An example is:
1891
1892 # Comments must be prepended by the # sign!
1893 192.168.0.0/24 ws_test_network
1894
1895 A partially matched name will be printed as "subnet-name.remaining-address".
1896 For example, "192.168.0.1" under the subnet above would be printed as
1897 "ws_test_network.1"; if the mask length above had been 16 rather than 24, the
1898 printed address would be ``ws_test_network.0.1".
1899
1900 =item Name Resolution (ethers)
1901
1902 The F<ethers> files are consulted to correlate 6-byte hardware addresses to
1903 names.  First the personal F<ethers> file is tried and if an address is not
1904 found there the global F<ethers> file is tried next.
1905
1906 Each line contains one hardware address and name, separated by
1907 whitespace.  The digits of the hardware address are separated by colons
1908 (:), dashes (-) or periods (.).  The same separator character must be
1909 used consistently in an address.  The following three lines are valid
1910 lines of an F<ethers> file:
1911
1912   ff:ff:ff:ff:ff:ff          Broadcast
1913   c0-00-ff-ff-ff-ff          TR_broadcast
1914   00.00.00.00.00.00          Zero_broadcast
1915
1916 The global F<ethers> file is looked for in the F</etc> directory on
1917 UNIX-compatible systems, and in the main installation directory (for
1918 example, F<C:\Program Files\Wireshark>) on Windows systems.
1919
1920 The personal F<ethers> file is looked for in the same directory as the personal
1921 preferences file.
1922
1923 Capture filter name resolution is handled by libpcap on UNIX-compatible
1924 systems and WinPcap on Windows.  As such the Wireshark personal F<ethers> file
1925 will not be consulted for capture filter name resolution.
1926
1927 =item Name Resolution (manuf)
1928
1929 The F<manuf> file is used to match the 3-byte vendor portion of a 6-byte
1930 hardware address with the manufacturer's name; it can also contain well-known
1931 MAC addresses and address ranges specified with a netmask.  The format of the
1932 file is the same as the F<ethers> files, except that entries of the form:
1933
1934   00:00:0C      Cisco
1935
1936 can be provided, with the 3-byte OUI and the name for a vendor, and
1937 entries such as:
1938
1939   00-00-0C-07-AC/40     All-HSRP-routers
1940
1941 can be specified, with a MAC address and a mask indicating how many bits
1942 of the address must match.  The above entry, for example, has 40
1943 significant bits, or 5 bytes, and would match addresses from
1944 00-00-0C-07-AC-00 through 00-00-0C-07-AC-FF.  The mask need not be a
1945 multiple of 8.
1946
1947 The F<manuf> file is looked for in the same directory as the global
1948 preferences file.
1949
1950 =item Name Resolution (services)
1951
1952 The F<services> file is used to translate port numbers into names.
1953
1954 The file has the standard F<services> file syntax; each line contains one
1955 (service) name and one transport identifier separated by white space.  The
1956 transport identifier includes one port number and one transport protocol name
1957 (typically tcp, udp, or sctp) separated by a /.
1958
1959 An example is:
1960
1961 mydns       5045/udp     # My own Domain Name Server
1962 mydns       5045/tcp     # My own Domain Name Server
1963
1964 =item Name Resolution (ipxnets)
1965
1966 The F<ipxnets> files are used to correlate 4-byte IPX network numbers to
1967 names.  First the global F<ipxnets> file is tried and if that address is not
1968 found there the personal one is tried next.
1969
1970 The format is the same as the F<ethers>
1971 file, except that each address is four bytes instead of six.
1972 Additionally, the address can be represented as a single hexadecimal
1973 number, as is more common in the IPX world, rather than four hex octets.
1974 For example, these four lines are valid lines of an F<ipxnets> file:
1975
1976   C0.A8.2C.00              HR
1977   c0-a8-1c-00              CEO
1978   00:00:BE:EF              IT_Server1
1979   110f                     FileServer3
1980
1981 The global F<ipxnets> file is looked for in the F</etc> directory on
1982 UNIX-compatible systems, and in the main installation directory (for
1983 example, F<C:\Program Files\Wireshark>) on Windows systems.
1984
1985 The personal F<ipxnets> file is looked for in the same directory as the
1986 personal preferences file.
1987
1988 =back
1989
1990 =head1 OUTPUT
1991
1992 B<TShark> uses UTF-8 to represent strings internally. In some cases the
1993 output might not be valid. For example, a dissector might generate
1994 invalid UTF-8 character sequences. Programs reading B<TShark> output
1995 should expect UTF-8 and be prepared for invalid output.
1996
1997 If B<TShark> detects that it is writing to a TTY on UNIX or Linux and
1998 the locale does not support UTF-8, output will be re-encoded to match the
1999 current locale.
2000
2001 If B<TShark> detects that it is writing to a TTY on Windows, output will be
2002 encoded as UTF-16LE.
2003
2004 =head1 ENVIRONMENT VARIABLES
2005
2006 =over 4
2007
2008 =item WIRESHARK_APPDATA
2009
2010 On Windows, Wireshark normally stores all application data in %APPDATA% or
2011 %USERPROFILE%.  You can override the default location by exporting this
2012 environment variable to specify an alternate location.
2013
2014 =item WIRESHARK_DEBUG_WMEM_OVERRIDE
2015
2016 Setting this environment variable forces the wmem framework to use the
2017 specified allocator backend for *all* allocations, regardless of which
2018 backend is normally specified by the code. This is mainly useful to developers
2019 when testing or debugging. See I<README.wmem> in the source distribution for
2020 details.
2021
2022 =item WIRESHARK_RUN_FROM_BUILD_DIRECTORY
2023
2024 This environment variable causes the plugins and other data files to be loaded
2025 from the build directory (where the program was compiled) rather than from the
2026 standard locations.  It has no effect when the program in question is running
2027 with root (or setuid) permissions on *NIX.
2028
2029 =item WIRESHARK_DATA_DIR
2030
2031 This environment variable causes the various data files to be loaded from
2032 a directory other than the standard locations.  It has no effect when the
2033 program in question is running with root (or setuid) permissions on *NIX.
2034
2035 =item ERF_RECORDS_TO_CHECK
2036
2037 This environment variable controls the number of ERF records checked when
2038 deciding if a file really is in the ERF format.  Setting this environment
2039 variable a number higher than the default (20) would make false positives
2040 less likely.
2041
2042 =item IPFIX_RECORDS_TO_CHECK
2043
2044 This environment variable controls the number of IPFIX records checked when
2045 deciding if a file really is in the IPFIX format.  Setting this environment
2046 variable a number higher than the default (20) would make false positives
2047 less likely.
2048
2049 =item WIRESHARK_ABORT_ON_DISSECTOR_BUG
2050
2051 If this environment variable is set, B<TShark> will call abort(3)
2052 when a dissector bug is encountered.  abort(3) will cause the program to
2053 exit abnormally; if you are running B<TShark> in a debugger, it
2054 should halt in the debugger and allow inspection of the process, and, if
2055 you are not running it in a debugger, it will, on some OSes, assuming
2056 your environment is configured correctly, generate a core dump file.
2057 This can be useful to developers attempting to troubleshoot a problem
2058 with a protocol dissector.
2059
2060 =item WIRESHARK_ABORT_ON_TOO_MANY_ITEMS
2061
2062 If this environment variable is set, B<TShark> will call abort(3)
2063 if a dissector tries to add too many items to a tree (generally this
2064 is an indication of the dissector not breaking out of a loop soon enough).
2065 abort(3) will cause the program to exit abnormally; if you are running
2066 B<TShark> in a debugger, it should halt in the debugger and allow
2067 inspection of the process, and, if you are not running it in a debugger,
2068 it will, on some OSes, assuming your environment is configured correctly,
2069 generate a core dump file.  This can be useful to developers attempting to
2070 troubleshoot a problem with a protocol dissector.
2071
2072 =back
2073
2074 =head1 SEE ALSO
2075
2076 wireshark-filter(4), wireshark(1), editcap(1), pcap(3), dumpcap(1),
2077 text2pcap(1), mergecap(1), pcap-filter(7) or tcpdump(8)
2078
2079 =head1 NOTES
2080
2081 B<TShark> is part of the B<Wireshark> distribution.  The latest version
2082 of B<Wireshark> can be found at L<https://www.wireshark.org>.
2083
2084 HTML versions of the Wireshark project man pages are available at:
2085 L<https://www.wireshark.org/docs/man-pages>.
2086
2087 =head1 AUTHORS
2088
2089 B<TShark> uses the same packet dissection code that B<Wireshark> does,
2090 as well as using many other modules from B<Wireshark>; see the list of
2091 authors in the B<Wireshark> man page for a list of authors of that code.