4 tshark - Dump and analyze network traffic
9 S<[ B<-a> E<lt>capture autostop conditionE<gt> ] ...>
10 S<[ B<-b> E<lt>capture ring buffer optionE<gt>] ...>
11 S<[ B<-B> E<lt>capture buffer sizeE<gt> ] >
12 S<[ B<-c> E<lt>capture packet countE<gt> ]>
13 S<[ B<-C> E<lt>configuration profileE<gt> ]>
14 S<[ B<-d> E<lt>layer typeE<gt>==E<lt>selectorE<gt>,E<lt>decode-as protocolE<gt> ]>
16 S<[ B<-e> E<lt>fieldE<gt> ]>
17 S<[ B<-E> E<lt>field print optionE<gt> ]>
18 S<[ B<-f> E<lt>capture filterE<gt> ]>
19 S<[ B<-F> E<lt>file formatE<gt> ]>
21 S<[ B<-H> E<lt>input hosts fileE<gt> ]>
22 S<[ B<-i> E<lt>capture interfaceE<gt>|- ]>
24 S<[ B<-K> E<lt>keytabE<gt> ]>
28 S<[ B<-N> E<lt>name resolving flagsE<gt> ]>
29 S<[ B<-o> E<lt>preference settingE<gt> ] ...>
32 S<[ B<-r> E<lt>infileE<gt> ]>
33 S<[ B<-R> E<lt>read (display) filterE<gt> ]>
34 S<[ B<-s> E<lt>capture snaplenE<gt> ]>
36 S<[ B<-t> ad|a|r|d|dd|e ]>
37 S<[ B<-T> pdml|psml|ps|text|fields ]>
40 S<[ B<-O> E<lt>protocolsE<gt> ]>
41 S<[ B<-w> E<lt>outfileE<gt>|- ]>
42 S<[ B<-W> E<lt>file format optionE<gt>]>
44 S<[ B<-X> E<lt>eXtension optionE<gt>]>
45 S<[ B<-y> E<lt>capture link typeE<gt> ]>
46 S<[ B<-z> E<lt>statisticsE<gt> ]>
47 S<[ E<lt>capture filterE<gt> ]>
50 B<-G> [fields|fields2|fields3|protocols|values|decodes|defaultprefs|currentprefs]
54 B<TShark> is a network protocol analyzer. It lets you capture packet
55 data from a live network, or read packets from a previously saved
56 capture file, either printing a decoded form of those packets to the
57 standard output or writing the packets to a file. B<TShark>'s native
58 capture file format is B<libpcap> format, which is also the format used
59 by B<tcpdump> and various other tools.
61 Without any options set, B<TShark> will work much like B<tcpdump>. It will
62 use the pcap library to capture traffic from the first available network
63 interface and displays a summary line on stdout for each received packet.
65 B<TShark> is able to detect, read and write the same capture files that
66 are supported by B<Wireshark>.
67 The input file doesn't need a specific filename extension; the file
68 format and an optional gzip compression will be automatically detected.
69 Near the beginning of the DESCRIPTION section of wireshark(1) or
70 L<http://www.wireshark.org/docs/man-pages/wireshark.html>
71 is a detailed description of the way B<Wireshark> handles this, which is
72 the same way B<Tshark> handles this.
74 Compressed file support uses (and therefore requires) the zlib library.
75 If the zlib library is not present, B<TShark> will compile, but will
76 be unable to read compressed files.
78 If the B<-w> option is not specified, B<TShark> writes to the standard
79 output the text of a decoded form of the packets it captures or reads.
80 If the B<-w> option is specified, B<TShark> writes to the file
81 specified by that option the raw data of the packets, along with the
84 When writing a decoded form of packets, B<TShark> writes, by
85 default, a summary line containing the fields specified by the
86 preferences file (which are also the fields displayed in the packet list
87 pane in B<Wireshark>), although if it's writing packets as it captures
88 them, rather than writing packets from a saved capture file, it won't
89 show the "frame number" field. If the B<-V> option is specified, it
90 writes instead a view of the details of the packet, showing all the
91 fields of all protocols in the packet. If the B<-O> option is
92 specified in combination with B<-V>, it will only show the full
93 protocols specified. Use the output of "tshark -G protocols" to
94 find the abbrevations of the protocols you can specify.
96 If you want to write the decoded form of packets to a file, run
97 B<TShark> without the B<-w> option, and redirect its standard output to
98 the file (do I<not> use the B<-w> option).
100 When writing packets to a file, B<TShark>, by default, writes the
101 file in B<libpcap> format, and writes all of the packets it sees to the
102 output file. The B<-F> option can be used to specify the format in which
103 to write the file. This list of available file formats is displayed by
104 the B<-F> flag without a value. However, you can't specify a file format
107 Read filters in B<TShark>, which allow you to select which packets
108 are to be decoded or written to a file, are very powerful; more fields
109 are filterable in B<TShark> than in other protocol analyzers, and the
110 syntax you can use to create your filters is richer. As B<TShark>
111 progresses, expect more and more protocol fields to be allowed in read
114 Packet capturing is performed with the pcap library. The capture filter
115 syntax follows the rules of the pcap library. This syntax is different
116 from the read filter syntax. A read filter can also be specified when
117 capturing, and only packets that pass the read filter will be displayed
118 or saved to the output file; note, however, that capture filters are much
119 more efficient than read filters, and it may be more difficult for
120 B<TShark> to keep up with a busy network if a read filter is
121 specified for a live capture.
123 A capture or read filter can either be specified with the B<-f> or B<-R>
124 option, respectively, in which case the entire filter expression must be
125 specified as a single argument (which means that if it contains spaces,
126 it must be quoted), or can be specified with command-line arguments
127 after the option arguments, in which case all the arguments after the
128 filter arguments are treated as a filter expression. Capture filters
129 are supported only when doing a live capture; read filters are supported
130 when doing a live capture and when reading a capture file, but require
131 TShark to do more work when filtering, so you might be more likely to
132 lose packets under heavy load if you're using a read filter. If the
133 filter is specified with command-line arguments after the option
134 arguments, it's a capture filter if a capture is being done (i.e., if no
135 B<-r> option was specified) and a read filter if a capture file is being
136 read (i.e., if a B<-r> option was specified).
138 The B<-G> option is a special mode that simply causes B<Tshark>
139 to dump one of several types of internal glossaries and then exit.
145 =item -a E<lt>capture autostop conditionE<gt>
147 Specify a criterion that specifies when B<TShark> is to stop writing
148 to a capture file. The criterion is of the form I<test>B<:>I<value>,
149 where I<test> is one of:
151 B<duration>:I<value> Stop writing to a capture file after I<value> seconds
154 B<filesize>:I<value> Stop writing to a capture file after it reaches a size of
155 I<value> kilobytes (where a kilobyte is 1024 bytes). If this option is used
156 together with the -b option, B<TShark> will stop writing to the current
157 capture file and switch to the next one if filesize is reached. When reading a
158 capture file, B<TShark> will stop reading the file after the number of bytes
159 read exceeds this number (the complete packet will be read, so more bytes than
160 this number may be read).
162 B<files>:I<value> Stop writing to capture files after I<value> number of files
165 =item -b E<lt>capture ring buffer optionE<gt>
167 Cause B<TShark> to run in "multiple files" mode. In "multiple files" mode,
168 B<TShark> will write to several capture files. When the first capture file
169 fills up, B<TShark> will switch writing to the next file and so on.
171 The created filenames are based on the filename given with the B<-w> option,
172 the number of the file and on the creation date and time,
173 e.g. outfile_00001_20050604120117.pcap, outfile_00002_20050604120523.pcap, ...
175 With the I<files> option it's also possible to form a "ring buffer".
176 This will fill up new files until the number of files specified,
177 at which point B<TShark> will discard the data in the first file and start
178 writing to that file and so on. If the I<files> option is not set,
179 new files filled up until one of the capture stop conditions match (or
180 until the disk is full).
182 The criterion is of the form I<key>B<:>I<value>,
183 where I<key> is one of:
185 B<duration>:I<value> switch to the next file after I<value> seconds have
186 elapsed, even if the current file is not completely filled up.
188 B<filesize>:I<value> switch to the next file after it reaches a size of
189 I<value> kilobytes (where a kilobyte is 1024 bytes).
191 B<files>:I<value> begin again with the first file after I<value> number of
192 files were written (form a ring buffer). This value must be less than 100000.
193 Caution should be used when using large numbers of files: some filesystems do
194 not handle many files in a single directory well. The B<files> criterion
195 requires either B<duration> or B<filesize> to be specified to control when to
196 go to the next file. It should be noted that each B<-b> parameter takes exactly
197 one criterion; to specify two criterion, each must be preceded by the B<-b>
200 Example: B<-b filesize:1024 -b files:5> results in a ring buffer of five files
201 of size one megabyte.
203 =item -B E<lt>capture buffer sizeE<gt>
205 Set capture buffer size (in MB, default is 1MB). This is used by the
206 the capture driver to buffer packet data until that data can be written
207 to disk. If you encounter packet drops while capturing, try to increase
208 this size. Note that, while B<Tshark> attempts to set the buffer size
209 to 1MB by default, and can be told to set it to a larger value, the
210 system or interface on which you're capturing might silently limit the
211 capture buffer size to a lower value or raise it to a higher value.
213 This is available on UNIX systems with libpcap 1.0.0 or later and on
214 Windows. It is not available on UNIX systems with earlier versions of
217 =item -c E<lt>capture packet countE<gt>
219 Set the maximum number of packets to read when capturing live
220 data. If reading a capture file, set the maximum number of packets to read.
222 =item -C E<lt>configuration profileE<gt>
224 Run with the given configuration profile.
226 =item -d E<lt>layer typeE<gt>==E<lt>selectorE<gt>,E<lt>decode-as protocolE<gt>
228 Like Wireshark's B<Decode As...> feature, this lets you specify how a
229 layer type should be dissected. If the layer type in question (for example,
230 B<tcp.port> or B<udp.port> for a TCP or UDP port number) has the specified
231 selector value, packets should be dissected as the specified protocol.
233 Example: B<-d tcp.port==8888,http> will decode any traffic running over
234 TCP port 8888 as HTTP.
236 Using an invalid selector or protocol will print out a list of valid selectors
237 and protocol names, respectively.
239 Example: B<-d .> is a quick way to get a list of valid selectors.
241 Example: B<-d ethertype==0x0800.> is a quick way to get a list of protocols that can be
242 selected with an ethertype.
246 Print a list of the interfaces on which B<TShark> can capture, and
247 exit. For each network interface, a number and an
248 interface name, possibly followed by a text description of the
249 interface, is printed. The interface name or the number can be supplied
250 to the B<-i> option to specify an interface on which to capture.
252 This can be useful on systems that don't have a command to list them
253 (e.g., Windows systems, or UNIX systems lacking B<ifconfig -a>);
254 the number can be useful on Windows 2000 and later systems, where the
255 interface name is a somewhat complex string.
257 Note that "can capture" means that B<TShark> was able to open that
258 device to do a live capture. Depending on your system you may need to
259 run tshark from an account with special privileges (for example, as
260 root) to be able to capture network traffic. If B<TShark -D> is not run
261 from such an account, it will not list any interfaces.
263 =item -e E<lt>fieldE<gt>
265 Add a field to the list of fields to display if B<-T fields> is
266 selected. This option can be used multiple times on the command line.
267 At least one field must be provided if the B<-T fields> option is
270 Example: B<-e frame.number -e ip.addr -e udp>
272 Giving a protocol rather than a single field will print multiple items
273 of data about the protocol as a single field. Fields are separated by
274 tab characters by default. B<-E> controls the format of the printed
277 =item -E E<lt>field print optionE<gt>
279 Set an option controlling the printing of fields when B<-T fields> is
284 B<header=y|n> If B<y>, print a list of the field names given using B<-e>
285 as the first line of the output; the field name will be separated using
286 the same character as the field values. Defaults to B<n>.
288 B<separator=/t|/s|>E<lt>characterE<gt> Set the separator character to
289 use for fields. If B</t> tab will be used (this is the default), if
290 B</s>, a single space will be used. Otherwise any character that can be
291 accepted by the command line as part of the option may be used.
293 B<occurrence=f|l|a> Select which occurrence to use for fields that have
294 multiple occurrences. If B<f> the first occurrence will be used, if B<l>
295 the last occurrence will be used and if B<a> all occurrences will be used
296 (this is the default).
298 B<aggregator=,|/s|>E<lt>characterE<gt> Set the aggregator character to
299 use for fields that have multiple occurrences. If B<,> a comma will be used
300 (this is the default), if B</s>, a single space will be used. Otherwise
301 any character that can be accepted by the command line as part of the
304 B<quote=d|s|n> Set the quote character to use to surround fields. B<d>
305 uses double-quotes, B<s> single-quotes, B<n> no quotes (the default).
307 =item -f E<lt>capture filterE<gt>
309 Set the capture filter expression.
311 =item -F E<lt>file formatE<gt>
313 Set the file format of the output capture file written using the B<-w>
314 option. The output written with the B<-w> option is raw packet data, not
315 text, so there is no B<-F> option to request text output. The option B<-F>
316 without a value will list the available formats.
318 =item -G [fields|fields2|fields3|protocols|values|decodes|defaultprefs|currentprefs]
320 The B<-G> option will cause B<Tshark> to dump one of several types of glossaries
321 and then exit. If no specific glossary type is specified, then the B<fields> report will be generated by default.
323 The available report types include:
325 B<fields> Dumps the contents of the registration database to
326 stdout. An independent program can take this output and format it into nice
327 tables or HTML or whatever. There is one record per line. Each record is
328 either a protocol or a header field, differentiated by the first field.
329 The fields are tab-delimited.
334 * Field 2 = descriptive protocol name
335 * Field 3 = protocol abbreviation
340 * Field 2 = descriptive field name
341 * Field 3 = field abbreviation
342 * Field 4 = type ( textual representation of the ftenum type )
343 * Field 5 = parent protocol abbreviation
344 * Field 6 = blurb describing field
346 B<fields2> Same as the B<fields> report but includes two additional columns.
348 * Field 7 = base for display (for integer types); "parent bitfield width" for FT_BOOLEAN
349 * Field 8 = blurb describing field (yes, apparently we repeated this accidentally)
351 B<fields3> Same as the B<fields> report but includes two additional columns.
353 * Field 7 = base for display (for integer types); "parent bitfield width" for FT_BOOLEAN
354 * Field 8 = bitmask: format: hex: 0x....
356 B<protocols> Dumps the protocols in the registration database to stdout.
357 An independent program can take this output and format it into nice tables
358 or HTML or whatever. There is one record per line. The fields are tab-delimited.
360 * Field 1 = protocol name
361 * Field 2 = protocol short name
362 * Field 3 = protocol filter name
364 B<values> Dumps the value_strings, range_strings or true/false strings
365 for fields that have them. There is one record per line. Fields are
366 tab-delimited. There are three types of records: Value String, Range
367 String and True/False String. The first field, 'V', 'R' or 'T', indicates
373 * Field 2 = field abbreviation to which this value string corresponds
374 * Field 3 = Integer value
380 * Field 2 = field abbreviation to which this range string corresponds
381 * Field 3 = Integer value: lower bound
382 * Field 4 = Integer value: upper bound
388 * Field 2 = field abbreviation to which this true/false string corresponds
389 * Field 3 = True String
390 * Field 4 = False String
392 B<decodes> Dumps the "layer type"/"decode as" associations to stdout.
393 There is one record per line. The fields are tab-delimited.
395 * Field 1 = layer type, e.g. "tcp.port"
396 * Field 2 = selector in decimal
397 * Field 3 = "decode as" name, e.g. "http"
399 B<defaultprefs> Dumps a default preferences file to stdout.
401 B<currentprefs> Dumps a copy of the current preferences file to stdout.
405 Print the version and options and exits.
407 =item -H E<lt>input hosts fileE<gt>
409 Read a list of entries from a "hosts" file, which will then be written
410 to a capture file. Implies B<-W n>.
412 The "hosts" file format is documented at
413 L<http://en.wikipedia.org/wiki/Hosts_(file)>.
415 =item -i E<lt>capture interfaceE<gt> | -
417 Set the name of the network interface or pipe to use for live packet
420 Network interface names should match one of the names listed in
421 "B<tshark -D>" (described above); a number, as reported by
422 "B<tshark -D>", can also be used. If you're using UNIX, "B<netstat
423 -i>" or "B<ifconfig -a>" might also work to list interface names,
424 although not all versions of UNIX support the B<-a> option to B<ifconfig>.
426 If no interface is specified, B<TShark> searches the list of
427 interfaces, choosing the first non-loopback interface if there are any
428 non-loopback interfaces, and choosing the first loopback interface if
429 there are no non-loopback interfaces. If there are no interfaces at all,
430 B<TShark> reports an error and doesn't start the capture.
432 Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
433 read data from the standard input. Data read from pipes must be in
434 standard libpcap format.
436 Note: the Win32 version of B<TShark> doesn't support capturing from
441 Put the interface in "monitor mode"; this is supported only on IEEE
442 802.11 Wi-Fi interfaces, and supported only on some operating systems.
444 Note that in monitor mode the adapter might disassociate from the
445 network with which it's associated, so that you will not be able to use
446 any wireless networks with that adapter. This could prevent accessing
447 files on a network server, or resolving host names or network addresses,
448 if you are capturing in monitor mode and are not connected to another
449 network with another adapter.
451 =item -K E<lt>keytabE<gt>
453 Load kerberos crypto keys from the specified keytab file.
454 This option can be used multiple times to load keys from several files.
456 Example: B<-K krb5.keytab>
460 Flush the standard output after the information for each packet is
461 printed. (This is not, strictly speaking, line-buffered if B<-V>
462 was specified; however, it is the same as line-buffered if B<-V> wasn't
463 specified, as only one line is printed for each packet, and, as B<-l> is
464 normally used when piping a live capture to a program or script, so that
465 output for a packet shows up as soon as the packet is seen and
466 dissected, it should work just as well as true line-buffering. We do
467 this as a workaround for a deficiency in the Microsoft Visual C++ C
470 This may be useful when piping the output of B<TShark> to another
471 program, as it means that the program to which the output is piped will
472 see the dissected data for a packet as soon as B<TShark> sees the
473 packet and generates that output, rather than seeing it only when the
474 standard output buffer containing that data fills up.
478 List the data link types supported by the interface and exit. The reported
479 link types can be used for the B<-y> option.
483 Disable network object name resolution (such as hostname, TCP and UDP port
484 names); the B<-N> flag might override this one.
486 =item -N E<lt>name resolving flagsE<gt>
488 Turn on name resolving only for particular types of addresses and port
489 numbers, with name resolving for other types of addresses and port
490 numbers turned off. This flag overrides B<-n> if both B<-N> and B<-n> are
491 present. If both B<-N> and B<-n> flags are not present, all name resolutions are
494 The argument is a string that may contain the letters:
496 B<m> to enable MAC address resolution
498 B<n> to enable network address resolution
500 B<t> to enable transport-layer port number resolution
502 B<C> to enable concurrent (asynchronous) DNS lookups
504 =item -o E<lt>preferenceE<gt>:E<lt>valueE<gt>
506 Set a preference value, overriding the default value and any value read
507 from a preference file. The argument to the option is a string of the
508 form I<prefname>B<:>I<value>, where I<prefname> is the name of the
509 preference (which is the same name that would appear in the preference
510 file), and I<value> is the value to which it should be set.
514 I<Don't> put the interface into promiscuous mode. Note that the
515 interface might be in promiscuous mode for some other reason; hence,
516 B<-p> cannot be used to ensure that the only traffic that is captured is
517 traffic sent to or from the machine on which B<TShark> is running,
518 broadcast traffic, and multicast traffic to addresses received by that
523 When capturing packets, don't display the continuous count of packets
524 captured that is normally shown when saving a capture to a file;
525 instead, just display, at the end of the capture, a count of packets
526 captured. On systems that support the SIGINFO signal, such as various
527 BSDs, you can cause the current count to be displayed by typing your
528 "status" character (typically control-T, although it
529 might be set to "disabled" by default on at least some BSDs, so you'd
530 have to explicitly set it to use it).
532 When reading a capture file, or when capturing and not saving to a file,
533 don't print packet information; this is useful if you're using a B<-z>
534 option to calculate statistics and don't want the packet information
535 printed, just the statistics.
537 =item -r E<lt>infileE<gt>
539 Read packet data from I<infile>, can be any supported capture file format
540 (including gzipped files). It's B<not> possible to use named pipes
543 =item -R E<lt>read (display) filterE<gt>
545 Cause the specified filter (which uses the syntax of read/display filters,
546 rather than that of capture filters) to be applied before printing a
547 decoded form of packets or writing packets to a file; packets not
548 matching the filter are discarded rather than being printed or written.
550 =item -s E<lt>capture snaplenE<gt>
552 Set the default snapshot length to use when capturing live data.
553 No more than I<snaplen> bytes of each network packet will be read into
554 memory, or saved to disk. A value of 0 specifies a snapshot length of
555 65535, so that the full packet is captured; this is the default.
559 Decode and display packets even while writing raw packet data using the
562 =item -t ad|a|r|d|dd|e
564 Set the format of the packet timestamp printed in summary lines.
565 The format can be one of:
567 B<ad> absolute with date: The absolute date and time is the actual time and
568 date the packet was captured
570 B<a> absolute: The absolute time is the actual time the packet was captured,
571 with no date displayed
573 B<r> relative: The relative time is the time elapsed between the first packet
574 and the current packet
576 B<d> delta: The delta time is the time since the previous packet was
579 B<dd> delta_displayed: The delta_displayed time is the time since the
580 previous displayed packet was captured
582 B<e> epoch: The time in seconds since epoch (Jan 1, 1970 00:00:00)
584 The default format is relative.
586 =item -T pdml|psml|ps|text|fields
588 Set the format of the output when viewing decoded packet data. The
591 B<pdml> Packet Details Markup Language, an XML-based format for the details of
592 a decoded packet. This information is equivalent to the packet details
593 printed with the B<-V> flag.
595 B<psml> Packet Summary Markup Language, an XML-based format for the summary
596 information of a decoded packet. This information is equivalent to the
597 information shown in the one-line summary printed by default.
599 B<ps> PostScript for a human-readable one-line summary of each of the packets,
600 or a multi-line view of the details of each of the packets, depending on
601 whether the B<-V> flag was specified.
603 B<text> Text of a human-readable one-line summary of each of the packets, or a
604 multi-line view of the details of each of the packets, depending on
605 whether the B<-V> flag was specified. This is the default.
607 B<fields> The values of fields specified with the B<-e> option, in a
608 form specified by the B<-E> option. For example,
610 -T fields -E separator=, -E quote=d
612 would generate comma-separated values (CSV) output suitable for importing
613 into your favorite spreadsheet program.
618 Print the version and exit.
622 Cause B<TShark> to print a view of the packet details rather
623 than a one-line summary of the packet.
625 =item -w E<lt>outfileE<gt> | -
627 Write raw packet data to I<outfile> or to the standard output if
630 NOTE: -w provides raw packet data, not text. If you want text output
631 you need to redirect stdout (e.g. using '>'), don't use the B<-w>
634 =item -W E<lt>file format optionE<gt>
636 Save extra information in the file if the format supports it. For
641 will save host name resolution records along with captured packets.
643 Future versions of Wireshark may automatically change the capture format to
646 The argument is a string that may contain the following letter:
648 B<n> write network address resolution information (pcapng only)
652 Cause B<TShark> to print a hex and ASCII dump of the packet data
653 after printing the summary or details.
655 =item -X E<lt>eXtension optionsE<gt>
657 Specify an option to be passed to a B<TShark> module. The eXtension option
658 is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
660 B<lua_script>:I<lua_script_filename> tells B<Wireshark> to load the given script in addition to the
663 =item -y E<lt>capture link typeE<gt>
665 Set the data link type to use while capturing packets. The values
666 reported by B<-L> are the values that can be used.
668 =item -z E<lt>statisticsE<gt>
670 Get B<TShark> to collect various types of statistics and display the result
671 after finishing reading the capture file. Use the B<-q> flag if you're
672 reading a capture file and only want the statistics printed, not any
673 per-packet information.
675 Note that the B<-z proto> option is different - it doesn't cause
676 statistics to be gathered and printed when the capture is complete, it
677 modifies the regular packet summary output to include the values of
678 fields specified with the option. Therefore you must not use the B<-q>
679 option, as that option would suppress the printing of the regular packet
680 summary output, and must also not use the B<-V> option, as that would
681 cause packet detail information rather than packet summary information
684 Currently implemented statistics are:
688 =item B<-z> afp,srt[,I<filter>]
690 =item B<-z> camel,srt
692 =item B<-z> dcerpc,srt,I<uuid>,I<major>.I<minor>[,I<filter>]
694 Collect call/reply SRT (Service Response Time) data for DCERPC interface I<uuid>,
695 version I<major>.I<minor>.
696 Data collected is the number of calls for each procedure, MinSRT, MaxSRT
699 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0>> will collect data for the CIFS SAMR Interface.
701 This option can be used multiple times on the command line.
703 If the optional I<filter> is provided, the stats will only be calculated
704 on those calls that match that filter.
706 Example: S<B<-z dcerpc,srt,12345778-1234-abcd-ef00-0123456789ac,1.0,ip.addr==1.2.3.4>> will collect SAMR
707 SRT statistics for a specific host.
709 =item B<-z> hosts[,ipv4][,ipv6]
711 Dump any collected IPv4 and/or IPv6 addresses in "hosts" format. Both IPv4
712 and IPv6 addresses are dumped by default.
714 Addresses are collected from a number of sources, including standard "hosts"
715 files and captured traffic.
717 =item B<-z> icmp,srt[,I<filter>]
719 Compute total ICMP echo requests, replies, loss, and percent loss, as well as
720 minimum, maximum, mean, median and sample standard deviation SRT statistics
721 typical of what ping provides.
723 Example: S<B<-z icmp,srt,ip.src==1.2.3.4>> will collect ICMP SRT statistics
724 for ICMP echo request packets originating from a specific host.
726 This option can be used multiple times on the command line.
728 =item B<-z> icmpv6,srt[,I<filter>]
730 Compute total ICMPv6 echo requests, replies, loss, and percent loss, as well as
731 minimum, maximum, mean, median and sample standard deviation SRT statistics
732 typical of what ping provides.
734 Example: S<B<-z icmpv6,srt,ipv6.src==fe80::1>> will collect ICMPv6 SRT statistics
735 for ICMPv6 echo request packets originating from a specific host.
737 This option can be used multiple times on the command line.
739 =item B<-z> io,phs[,I<filter>]
741 Create Protocol Hierarchy Statistics listing both number of packets and bytes.
742 If no I<filter> is specified the statistics will be calculated for all packets.
743 If a I<filter> is specified statistics will be only calculated for those
744 packets that match the filter.
746 This option can be used multiple times on the command line.
748 =item B<-z> io,stat,I<interval>[,I<filter>][,I<filter>][,I<filter>]...
750 Collect packet/bytes statistics for the capture in intervals of
751 I<interval> seconds. I<Interval> can be specified either as a whole or
752 fractional second and can be specified with microsecond (us) resolution.
753 If I<interval> is 0, the statistics will be calculated over all packets.
755 If no I<filter> is specified the statistics will be calculated for all packets.
756 If one or more I<filters> are specified statistics will be calculated for
757 all filters and presented with one column of statistics for each filter.
759 This option can be used multiple times on the command line.
761 Example: B<-z io,stat,1,ip.addr==1.2.3.4> will generate 1 second
762 statistics for all traffic to/from host 1.2.3.4.
764 Example: B<-z "io,stat,0.001,smb&&ip.addr==1.2.3.4"> will generate 1ms
765 statistics for all SMB packets to/from host 1.2.3.4.
767 The examples above all use the standard syntax for generating statistics
768 which only calculates the number of packets and bytes in each interval.
770 B<io,stat> can also do much more statistics and calculate COUNT(), SUM(),
771 MIN(), MAX(), AVG() and LOAD() using a slightly different filter syntax:
773 =item -z io,stat,E<34>[COUNT|SUM|MIN|MAX|AVG|LOAD](I<field>)I<field> [and I<filter>]E<34>
775 NOTE: One important thing to note here is that the field that the
776 calculation is based on MUST also be part of the filter string or
777 else the calculation will fail.
779 So: B<-z io,stat,0.010,AVG(smb.time)> does not work. Use B<-z
780 io,stat,0.010,AVG(smb.time)smb.time> instead. Also be aware that a field
781 can exist multiple times inside the same packet and will then be counted
782 multiple times in those packets.
784 NOTE: A second important thing to note is that the system setting for
785 decimal separator is set to "."! If it is set to "," the statistics
786 will not be displayed per filter.
788 B<COUNT(I<field>)I<field> [and I<filter>]> - Calculates the number of times that the
789 field I<name> (not its value) appears per interval in the filtered packet list.
790 ''I<field>'' can be any display filter name.
792 Example: B<-z io,stat,0.010,E<34>COUNT(smb.sid)smb.sidE<34>>
794 This will count the total number of SIDs seen in each 10ms interval.
796 B<SUM(I<field>)I<field> [and I<filter>]> - Unlike COUNT, the I<values> of the
797 specified field are summed per time interval.
798 ''I<field>'' can only be a named integer or relative time field.
800 Example: B<-z io,stat,0.010,E<34>SUM(frame.len)frame.lenE<34>>
802 Reports the total number of bytes that were transmitted bidirectionally in
803 all the packets within a 10 millisecond interval.
805 B<MIN/MAX/AVG(I<field>)I<field> [and I<filter>]> - The minimum, maximum, or average field value
806 in each interval is calculated. The specified field must be a named integer
807 or relative time field. For relative time fields, the output is presented in
808 seconds with six decimal digits of precision rounded to the nearest microsecond.
810 In the following example, The time of the first Read_AndX call, the last Read_AndX
811 response values are displayed and the minimum, maximum, and average Read response times
812 (SRTs) are calculated. NOTE: If the DOS command shell line continuation character, ''^''
813 is used, each line cannot end in a comma so it is placed at the beginning of each
816 tshark -o tcp.desegment_tcp_streams:FALSE -n -q -r smb_reads.cap -z io,stat,0,
817 "MIN(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==0",
818 "MAX(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==1",
819 "MIN(smb.time)smb.time and smb.cmd==0x2e",
820 "MAX(smb.time)smb.time and smb.cmd==0x2e",
821 "AVG(smb.time)smb.time and smb.cmd==0x2e"
824 ======================================================================================================
826 Column #0: MIN(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==0
827 Column #1: MAX(frame.time_relative)frame.time_relative and smb.cmd==0x2e and smb.flags.response==1
828 Column #2: MIN(smb.time)smb.time and smb.cmd==0x2e
829 Column #3: MAX(smb.time)smb.time and smb.cmd==0x2e
830 Column #4: AVG(smb.time)smb.time and smb.cmd==0x2e
831 | Column #0 | Column #1 | Column #2 | Column #3 | Column #4 |
832 Time | MIN | MAX | MIN | MAX | AVG |
833 000.000- 0.000000 7.704054 0.000072 0.005539 0.000295
834 ======================================================================================================
836 The following command displays the average SMB Read response PDU size, the
837 total number of read PDU bytes, the average SMB Write request PDU size, and
838 the total number of bytes transferred in SMB Write PDUs:
840 tshark -n -q -r smb_reads_writes.cap -z io,stat,0,
841 "AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to",
842 "SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to",
843 "AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to",
844 "SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to"
846 =====================================================================================
848 Column #0: AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to
849 Column #1: SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2e and smb.response_to
850 Column #2: AVG(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to
851 Column #3: SUM(smb.file.rw.length)smb.file.rw.length and smb.cmd==0x2f and not smb.response_to
852 | Column #0 | Column #1 | Column #2 | Column #3 |
853 Time | AVG | SUM | AVG | SUM |
854 000.000- 30018 28067522 72 3240
855 =====================================================================================
857 B<LOAD(I<field>)I<field> [and I<filter>]> - The LOAD/Queue-Depth
858 in each interval is calculated. The specified field must be a relative-time filed that represents a response time. For example smb.time.
859 For each interval the Queue-Depth for the specified protocol is calculated.
861 The following command displays the average SMB LOAD.
862 A value of 1.0 represents one I/O in flight.
864 tshark -n -q -r smb_reads_writes.cap
865 -z "io,stat,0.001,LOAD(smb.time)smb.time"
867 ============================================================================
869 Interval: 0.001000 secs
870 Column #0: LOAD(smb.time)smb.time
873 0000.000000-0000.001000 1.000000
874 0000.001000-0000.002000 0.741000
875 0000.002000-0000.003000 0.000000
876 0000.003000-0000.004000 1.000000
880 B<FRAMES | BYTES[()I<filter>]> - Displays the total number of frames or bytes.
881 The filter field is optional but if included it must be prepended with ''()''.
883 The following command displays five columns: the total number of frames and bytes
884 (transferred bidirectionally) using a single comma, the same two stats using the FRAMES and BYTES
885 subcommands, the total number of frames containing at least one SMB Read response, and
886 the total number of bytes transmitted to the client (unidirectionally) at IP address 10.1.0.64.
888 tshark -o tcp.desegment_tcp_streams:FALSE -n -q -r smb_reads.cap -z io,stat,0,,FRAMES,BYTES,
889 "FRAMES()smb.cmd==0x2e and smb.response_to","BYTES()ip.dst==10.1.0.64"
891 =======================================================================================================================
896 Column #3: FRAMES()smb.cmd==0x2e and smb.response_to
897 Column #4: BYTES()ip.dst==10.1.0.64
898 | Column #0 | Column #1 | Column #2 | Column #3 | Column #4 |
899 Time | Frames | Bytes | FRAMES | BYTES | FRAMES | BYTES |
900 000.000- 33576 29721685 33576 29721685 870 29004801
901 =======================================================================================================================
903 =item B<-z> conv,I<type>[,I<filter>]
905 Create a table that lists all conversations that could be seen in the
906 capture. I<type> specifies the conversation endpoint types for which we
907 want to generate the statistics; currently the supported ones are:
909 "eth" Ethernet addresses
910 "fc" Fibre Channel addresses
911 "fddi" FDDI addresses
913 "ipv6" IPv6 addresses
915 "tcp" TCP/IP socket pairs Both IPv4 and IPv6 are supported
916 "tr" Token Ring addresses
917 "udp" UDP/IP socket pairs Both IPv4 and IPv6 are supported
919 If the optional I<filter> is specified, only those packets that match the
920 filter will be used in the calculations.
922 The table is presented with one line for each conversation and displays
923 the number of packets/bytes in each direction as well as the total
924 number of packets/bytes. The table is sorted according to the total
927 =item B<-z> proto,colinfo,I<filter>,I<field>
929 Append all I<field> values for the packet to the Info column of the
930 one-line summary output.
931 This feature can be used to append arbitrary fields to the Info column
932 in addition to the normal content of that column.
933 I<field> is the display-filter name of a field which value should be placed
935 I<filter> is a filter string that controls for which packets the field value
936 will be presented in the info column. I<field> will only be presented in the
937 Info column for the packets which match I<filter>.
939 NOTE: In order for B<TShark> to be able to extract the I<field> value
940 from the packet, I<field> MUST be part of the I<filter> string. If not,
941 B<TShark> will not be able to extract its value.
943 For a simple example to add the "nfs.fh.hash" field to the Info column
944 for all packets containing the "nfs.fh.hash" field, use
946 B<-z proto,colinfo,nfs.fh.hash,nfs.fh.hash>
948 To put "nfs.fh.hash" in the Info column but only for packets coming from
951 B<-z "proto,colinfo,nfs.fh.hash && ip.src==1.2.3.4,nfs.fh.hash">
953 This option can be used multiple times on the command line.
955 =item B<-z> diameter,avp[,I<cmd.code>,I<field>,I<field>,I<...>]
957 This option enables extraction of most important diameter fields from large capture files.
958 Exactly one text line for each diameter message with matched B<diameter.cmd.code> will be printed.
960 Empty diameter command code or '*' can be specified to mach any B<diameter.cmd.code>
962 Example: B<-z diameter,avp> extract default field set from diameter messages.
964 Example: B<-z diameter,avp,280> extract default field set from diameter DWR messages.
966 Example: B<-z diameter,avp,272> extract default field set from diameter CC messages.
968 Extract most important fields from diameter CC messages:
970 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>
972 Following fields will be printed out for each diameter message:
974 "frame" Frame number.
975 "time" Unix time of the frame arrival.
976 "src" Source address.
977 "srcport" Source port.
978 "dst" Destination address.
979 "dstport" Destination port.
980 "proto" Constant string 'diameter', which can be used for post processing of tshark output. e.g. grep/sed/awk.
981 "msgnr" seq. number of diameter message within the frame. E.g. '2' for the third diameter message in the same frame.
982 "is_request" '0' if message is a request, '1' if message is an answer.
983 "cmd" diameter.cmd_code, E.g. '272' for credit control messages.
984 "req_frame" Number of frame where matched request was found or '0'.
985 "ans_frame" Number of frame where matched answer was found or '0'.
986 "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.
988 B<-z diameter,avp> option is much faster than B<-V -T text> or B<-T pdml> options.
990 B<-z diameter,avp> option is more powerful than B<-T field> and B<-z proto,colinfo> options.
992 Multiple diameter messages in one frame are supported.
994 Several fields with same name within one diameter message are supported, e.g. I<diameter.Subscription-Id-Data> or I<diameter.Rating-Group>.
996 Note: B<tshark -q> option is recommended to suppress default B<tshark> output.
998 =item B<-z> rpc,srt,I<program>,I<version>[,I<filter>]
1000 Collect call/reply SRT (Service Response Time) data for I<program>/I<version>. Data collected
1001 is number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
1003 Example: B<-z rpc,srt,100003,3> will collect data for NFS v3.
1005 This option can be used multiple times on the command line.
1007 If the optional I<filter> is provided, the stats will only be calculated
1008 on those calls that match that filter.
1010 Example: B<-z rpc,srt,100003,3,nfs.fh.hash==0x12345678> will collect NFS v3
1011 SRT statistics for a specific file.
1013 =item B<-z> rpc,programs
1015 Collect call/reply SRT data for all known ONC-RPC programs/versions.
1016 Data collected is number of calls for each protocol/version, MinSRT,
1018 This option can only be used once on the command line.
1020 =item B<-z> rtp,streams
1022 Collect statistics for all RTP streams and calculate max. delta, max. and
1023 mean jitter and packet loss percentages.
1025 =item B<-z> scsi,srt,I<cmdset>[,<filter>]
1027 Collect call/reply SRT (Service Response Time) data for SCSI commandset <cmdset>.
1029 Commandsets are 0:SBC 1:SSC 5:MMC
1032 is the number of calls for each procedure, MinSRT, MaxSRT and AvgSRT.
1034 Example: B<-z scsi,srt,0> will collect data for SCSI BLOCK COMMANDS (SBC).
1036 This option can be used multiple times on the command line.
1038 If the optional I<filter> is provided, the stats will only be calculated
1039 on those calls that match that filter.
1041 Example: B<-z scsi,srt,0,ip.addr==1.2.3.4> will collect SCSI SBC
1042 SRT statistics for a specific iscsi/ifcp/fcip host.
1044 =item B<-z> smb,srt[,I<filter>]
1046 Collect call/reply SRT (Service Response Time) data for SMB. Data collected
1047 is number of calls for each SMB command, MinSRT, MaxSRT and AvgSRT.
1049 Example: B<-z smb,srt>
1051 The data will be presented as separate tables for all normal SMB commands,
1052 all Transaction2 commands and all NT Transaction commands.
1053 Only those commands that are seen in the capture will have its stats
1055 Only the first command in a xAndX command chain will be used in the
1056 calculation. So for common SessionSetupAndX + TreeConnectAndX chains,
1057 only the SessionSetupAndX call will be used in the statistics.
1058 This is a flaw that might be fixed in the future.
1060 This option can be used multiple times on the command line.
1062 If the optional I<filter> is provided, the stats will only be calculated
1063 on those calls that match that filter.
1065 Example: B<-z "smb,srt,ip.addr==1.2.3.4"> will only collect stats for
1066 SMB packets exchanged by the host at IP address 1.2.3.4 .
1068 =item B<-z> smb,sids
1070 When this feature is used B<TShark> will print a report with all the
1071 discovered SID and account name mappings. Only those SIDs where the
1072 account name is known will be presented in the table.
1074 For this feature to work you will need to either to enable
1075 "Edit/Preferences/Protocols/SMB/Snoop SID to name mappings" in the
1076 preferences or you can override the preferences by specifying
1077 S<B<-o "smb.sid_name_snooping:TRUE">> on the B<TShark> command line.
1079 The current method used by B<TShark> to find the SID->name mapping
1080 is relatively restricted with a hope of future expansion.
1082 =item B<-z> mgcp,rtd[I<,filter>]
1084 Collect requests/response RTD (Response Time Delay) data for MGCP.
1085 (This is similar to B<-z smb,srt>). Data collected is the number of calls
1086 for each known MGCP Type, MinRTD, MaxRTD and AvgRTD.
1087 Additionally you get the number of duplicate requests/responses,
1088 unresponded requests, responses, which don't match with any request.
1089 Example: B<-z mgcp,rtd>.
1091 This option can be used multiple times on the command line.
1093 If the optional I<filter> is provided, the stats will only be calculated
1094 on those calls that match that filter.
1095 Example: B<-z "mgcp,rtd,ip.addr==1.2.3.4"> will only collect stats for
1096 MGCP packets exchanged by the host at IP address 1.2.3.4 .
1098 =item B<-z> megaco,rtd[I<,filter>]
1100 Collect requests/response RTD (Response Time Delay) data for MEGACO.
1101 (This is similar to B<-z smb,srt>). Data collected is the number of calls
1102 for each known MEGACO Type, MinRTD, MaxRTD and AvgRTD.
1103 Additionally you get the number of duplicate requests/responses,
1104 unresponded requests, responses, which don't match with any request.
1105 Example: B<-z megaco,rtd>.
1107 If the optional I<filter> is provided, the stats will only be calculated
1108 on those calls that match that filter.
1109 Example: B<-z "megaco,rtd,ip.addr==1.2.3.4"> will only collect stats for
1110 MEGACO packets exchanged by the host at IP address 1.2.3.4 .
1112 This option can be used multiple times on the command line.
1114 =item B<-z> h225,counter[I<,filter>]
1116 Count ITU-T H.225 messages and their reasons. In the first column you get a
1117 list of H.225 messages and H.225 message reasons, which occur in the current
1118 capture file. The number of occurrences of each message or reason is displayed
1119 in the second column.
1121 Example: B<-z h225,counter>.
1123 If the optional I<filter> is provided, the stats will only be calculated
1124 on those calls that match that filter.
1125 Example: use B<-z "h225,counter,ip.addr==1.2.3.4"> to only collect stats for
1126 H.225 packets exchanged by the host at IP address 1.2.3.4 .
1128 This option can be used multiple times on the command line.
1130 =item B<-z> h225,srt[I<,filter>]
1132 Collect requests/response SRT (Service Response Time) data for ITU-T H.225 RAS.
1133 Data collected is number of calls of each ITU-T H.225 RAS Message Type,
1134 Minimum SRT, Maximum SRT, Average SRT, Minimum in Packet, and Maximum in Packet.
1135 You will also get the number of Open Requests (Unresponded Requests),
1136 Discarded Responses (Responses without matching request) and Duplicate Messages.
1138 Example: B<-z h225,srt>
1140 This option can be used multiple times on the command line.
1142 If the optional I<filter> is provided, the stats will only be calculated
1143 on those calls that match that filter.
1145 Example: B<-z "h225,srt,ip.addr==1.2.3.4"> will only collect stats for
1146 ITU-T H.225 RAS packets exchanged by the host at IP address 1.2.3.4 .
1148 =item B<-z> sip,stat[I<,filter>]
1150 This option will activate a counter for SIP messages. You will get the number
1151 of occurrences of each SIP Method and of each SIP Status-Code. Additionally you
1152 also get the number of resent SIP Messages (only for SIP over UDP).
1154 Example: B<-z sip,stat>.
1156 This option can be used multiple times on the command line.
1158 If the optional I<filter> is provided, the stats will only be calculated
1159 on those calls that match that filter.
1160 Example: B<-z "sip,stat,ip.addr==1.2.3.4"> will only collect stats for
1161 SIP packets exchanged by the host at IP address 1.2.3.4 .
1167 =head1 CAPTURE FILTER SYNTAX
1169 See the manual page of pcap-filter(4) or, if that doesn't exist, tcpdump(8),
1170 or, if that doesn't exist, L<http://wiki.wireshark.org/CaptureFilters>.
1172 =head1 READ FILTER SYNTAX
1174 For a complete table of protocol and protocol fields that are filterable
1175 in B<TShark> see the wireshark-filter(4) manual page.
1179 These files contains various B<Wireshark> configuration values.
1185 The F<preferences> files contain global (system-wide) and personal
1186 preference settings. If the system-wide preference file exists, it is
1187 read first, overriding the default settings. If the personal preferences
1188 file exists, it is read next, overriding any previous values. Note: If
1189 the command line option B<-o> is used (possibly more than once), it will
1190 in turn override values from the preferences files.
1192 The preferences settings are in the form I<prefname>B<:>I<value>,
1194 where I<prefname> is the name of the preference
1195 and I<value> is the value to
1196 which it should be set; white space is allowed between B<:> and
1197 I<value>. A preference setting can be continued on subsequent lines by
1198 indenting the continuation lines with white space. A B<#> character
1199 starts a comment that runs to the end of the line:
1201 # Capture in promiscuous mode?
1202 # TRUE or FALSE (case-insensitive).
1203 capture.prom_mode: TRUE
1205 The global preferences file is looked for in the F<wireshark> directory
1206 under the F<share> subdirectory of the main installation directory (for
1207 example, F</usr/local/share/wireshark/preferences>) on UNIX-compatible
1208 systems, and in the main installation directory (for example,
1209 F<C:\Program Files\Wireshark\preferences>) on Windows systems.
1211 The personal preferences file is looked for in
1212 F<$HOME/.wireshark/preferences> on
1213 UNIX-compatible systems and F<%APPDATA%\Wireshark\preferences> (or, if
1214 %APPDATA% isn't defined, F<%USERPROFILE%\Application
1215 Data\Wireshark\preferences>) on Windows systems.
1217 =item Disabled (Enabled) Protocols
1219 The F<disabled_protos> files contain system-wide and personal lists of
1220 protocols that have been disabled, so that their dissectors are never
1221 called. The files contain protocol names, one per line, where the
1222 protocol name is the same name that would be used in a display filter
1228 The global F<disabled_protos> file uses the same directory as the global
1231 The personal F<disabled_protos> file uses the same directory as the
1232 personal preferences file.
1234 =item Name Resolution (hosts)
1236 If the personal F<hosts> file exists, it is
1237 used to resolve IPv4 and IPv6 addresses before any other
1238 attempts are made to resolve them. The file has the standard F<hosts>
1239 file syntax; each line contains one IP address and name, separated by
1240 whitespace. The same directory as for the personal preferences file is
1243 Capture filter name resolution is handled by libpcap on UNIX-compatible
1244 systems and WinPCAP on Windows. As such the Wireshark personal F<hosts> file
1245 will not be consulted for capture filter name resolution.
1247 =item Name Resolution (ethers)
1249 The F<ethers> files are consulted to correlate 6-byte hardware addresses to
1250 names. First the personal F<ethers> file is tried and if an address is not
1251 found there the global F<ethers> file is tried next.
1253 Each line contains one hardware address and name, separated by
1254 whitespace. The digits of the hardware address are separated by colons
1255 (:), dashes (-) or periods (.). The same separator character must be
1256 used consistently in an address. The following three lines are valid
1257 lines of an F<ethers> file:
1259 ff:ff:ff:ff:ff:ff Broadcast
1260 c0-00-ff-ff-ff-ff TR_broadcast
1261 00.00.00.00.00.00 Zero_broadcast
1263 The global F<ethers> file is looked for in the F</etc> directory on
1264 UNIX-compatible systems, and in the main installation directory (for
1265 example, F<C:\Program Files\Wireshark>) on Windows systems.
1267 The personal F<ethers> file is looked for in the same directory as the personal
1270 Capture filter name resolution is handled by libpcap on UNIX-compatible
1271 systems and WinPCAP on Windows. As such the Wireshark personal F<ethers> file
1272 will not be consulted for capture filter name resolution.
1274 =item Name Resolution (manuf)
1276 The F<manuf> file is used to match the 3-byte vendor portion of a 6-byte
1277 hardware address with the manufacturer's name; it can also contain well-known
1278 MAC addresses and address ranges specified with a netmask. The format of the
1279 file is the same as the F<ethers> files, except that entries of the form:
1283 can be provided, with the 3-byte OUI and the name for a vendor, and
1286 00-00-0C-07-AC/40 All-HSRP-routers
1288 can be specified, with a MAC address and a mask indicating how many bits
1289 of the address must match. The above entry, for example, has 40
1290 significant bits, or 5 bytes, and would match addresses from
1291 00-00-0C-07-AC-00 through 00-00-0C-07-AC-FF. The mask need not be a
1294 The F<manuf> file is looked for in the same directory as the global
1297 =item Name Resolution (ipxnets)
1299 The F<ipxnets> files are used to correlate 4-byte IPX network numbers to
1300 names. First the global F<ipxnets> file is tried and if that address is not
1301 found there the personal one is tried next.
1303 The format is the same as the F<ethers>
1304 file, except that each address is four bytes instead of six.
1305 Additionally, the address can be represented as a single hexadecimal
1306 number, as is more common in the IPX world, rather than four hex octets.
1307 For example, these four lines are valid lines of an F<ipxnets> file:
1311 00:00:BE:EF IT_Server1
1314 The global F<ipxnets> file is looked for in the F</etc> directory on
1315 UNIX-compatible systems, and in the main installation directory (for
1316 example, F<C:\Program Files\Wireshark>) on Windows systems.
1318 The personal F<ipxnets> file is looked for in the same directory as the
1319 personal preferences file.
1323 =head1 ENVIRONMENT VARIABLES
1327 =item WIRESHARK_DEBUG_EP_NO_CHUNKS
1329 Normally per-packet memory is allocated in large "chunks." This behavior
1330 doesn't work well with debugging tools such as Valgrind or ElectricFence.
1331 Export this environment variable to force individual allocations.
1332 Note: disabling chunks also disables canaries (see below).
1334 =item WIRESHARK_DEBUG_SE_NO_CHUNKS
1336 Normally per-file memory is allocated in large "chunks." This behavior
1337 doesn't work well with debugging tools such as Valgrind or ElectricFence.
1338 Export this environment variable to force individual allocations.
1339 Note: disabling chunks also disables canaries (see below).
1341 =item WIRESHARK_DEBUG_EP_NO_CANARY
1343 Normally per-packet memory allocations are separated by "canaries" which
1344 allow detection of memory overruns. This comes at the expense of some extra
1345 memory usage. Exporting this environment variable disables these canaries.
1347 =item WIRESHARK_DEBUG_SE_USE_CANARY
1349 Exporting this environment variable causes per-file memory allocations to be
1350 protected with "canaries" which allow for detection of memory overruns.
1351 This comes at the expense of significant extra memory usage.
1353 =item WIRESHARK_DEBUG_SCRUB_MEMORY
1355 If this environment variable is exported, the contents of per-packet and
1356 per-file memory is initialized to 0xBADDCAFE when the memory is allocated
1357 and is reset to 0xDEADBEEF when the memory is freed. This functionality is
1358 useful mainly to developers looking for bugs in the way memory is handled.
1360 =item WIRESHARK_RUN_FROM_BUILD_DIRECTORY
1362 This environment variable causes the plugins and other data files to be loaded
1363 from the build directory (where the program was compiled) rather than from the
1364 standard locations. It has no effect when the program in question is running
1365 with root (or setuid) permissions on *NIX.
1367 =item WIRESHARK_DATA_DIR
1369 This environment variable causes the various data files to be loaded from
1370 a directory other than the standard locations. It has no effect when the
1371 program in question is running with root (or setuid) permissions on *NIX.
1373 =item WIRESHARK_PYTHON_DIR
1375 This environment variable points to an alternate location for Python.
1376 It has no effect when the program in question is running with root (or setuid)
1377 permissions on *NIX.
1379 =item ERF_RECORDS_TO_CHECK
1381 This environment variable controls the number of ERF records checked when
1382 deciding if a file really is in the ERF format. Setting this environment
1383 variable a number higher than the default (20) would make false positives
1386 =item IPFIX_RECORDS_TO_CHECK
1388 This environment variable controls the number of IPFIX records checked when
1389 deciding if a file really is in the IPFIX format. Setting this environment
1390 variable a number higher than the default (20) would make false positives
1393 =item WIRESHARK_ABORT_ON_DISSECTOR_BUG
1395 If this environment variable is set, B<TShark> will call abort(3)
1396 when a dissector bug is encountered. abort(3) will cause the program to
1397 exit abnormally; if you are running B<TShark> in a debugger, it
1398 should halt in the debugger and allow inspection of the process, and, if
1399 you are not running it in a debugger, it will, on some OSes, assuming
1400 your environment is configured correctly, generate a core dump file.
1401 This can be useful to developers attempting to troubleshoot a problem
1402 with a protocol dissector.
1404 =item WIRESHARK_EP_VERIFY_POINTERS
1406 This environment variable, if exported, causes certain uses of pointers to be
1407 audited to ensure they do not point to memory that is deallocated after each
1408 packet has been fully dissected. This can be useful to developers writing or
1411 =item WIRESHARK_SE_VERIFY_POINTERS
1413 This environment variable, if exported, causes certain uses of pointers to be
1414 audited to ensure they do not point to memory that is deallocated after when
1415 a capture file is closed. This can be useful to developers writing or
1422 wireshark-filter(4), wireshark(1), editcap(1), pcap-filter(4), tcpdump(8),
1423 pcap(3), dumpcap(1), text2pcap(1), mergecap(1)
1427 B<TShark> is part of the B<Wireshark> distribution. The latest version
1428 of B<Wireshark> can be found at L<http://www.wireshark.org>.
1430 HTML versions of the Wireshark project man pages are available at:
1431 L<http://www.wireshark.org/docs/man-pages>.
1435 B<TShark> uses the same packet dissection code that B<Wireshark> does,
1436 as well as using many other modules from B<Wireshark>; see the list of
1437 authors in the B<Wireshark> man page for a list of authors of that code.