ethereal->wireshark
[obnox/wireshark/wip.git] / doc / tethereal.pod
1
2 =head1 NAME
3
4 tethereal - Dump and analyze network traffic
5
6 =head1 SYNOPSYS
7
8 B<tethereal>
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 size (Win32 only)E<gt> ] >
12 S<[ B<-c> E<lt>capture packet countE<gt> ]>
13 S<[ B<-d> E<lt>layer typeE<gt>==E<lt>selectorE<gt>,E<lt>decode-as protocolE<gt> ]>
14 S<[ B<-D> ]>
15 S<[ B<-f> E<lt>capture filterE<gt> ]>
16 S<[ B<-F> E<lt>file formatE<gt> ]>
17 S<[ B<-h> ]>
18 S<[ B<-i> E<lt>capture interfaceE<gt>|- ]> 
19 S<[ B<-l> ]>
20 S<[ B<-L> ]>
21 S<[ B<-n> ]>
22 S<[ B<-N> E<lt>name resolving flagsE<gt> ]>
23 S<[ B<-o> E<lt>preference settingE<gt> ] ...>
24 S<[ B<-p> ]>
25 S<[ B<-q> ]>
26 S<[ B<-r> E<lt>infileE<gt> ]>
27 S<[ B<-R> E<lt>read (display) filterE<gt> ]>
28 S<[ B<-s> E<lt>capture snaplenE<gt> ]>
29 S<[ B<-S> ]>
30 S<[ B<-t> ad|a|r|d ]>
31 S<[ B<-T> pdml|psml|ps|text ]>
32 S<[ B<-v> ]>
33 S<[ B<-V> ]>
34 S<[ B<-w> E<lt>outfileE<gt>|- ]>
35 S<[ B<-x> ]>
36 S<[ B<-X> E<lt>eXtension optionE<gt>]>
37 S<[ B<-y> E<lt>capture link typeE<gt> ]>
38 S<[ B<-z> E<lt>statisticsE<gt> ]>
39
40 =head1 DESCRIPTION
41
42 B<Tethereal> is a network protocol analyzer.  It lets you capture packet
43 data from a live network, or read packets from a previously saved
44 capture file, either printing a decoded form of those packets to the
45 standard output or writing the packets to a file.  B<Tethereal>'s native
46 capture file format is B<libpcap> format, which is also the format used
47 by B<tcpdump> and various other tools.  
48
49 Without any options set, B<Tethereal> will work much like B<tcpdump>. It will 
50 use the pcap library to capture traffic from the first available network 
51 interface and displays a summary line on stdout for each received packet. 
52
53 B<Tethereal> is able to detect, read and write the same capture files that 
54 are supported by B<Ethereal>.
55 The input file doesn't need a specific filename extension, the file 
56 format and an optional gzip compression will be automatically detected.
57 The I<capture file format> section of I<ethereal(1)> or
58 I<http://www.ethereal.com/docs/man-pages/ethereal.1.html>
59 provides a detailed description.
60
61 Compressed file support uses (and therefore requires) the zlib library. 
62 If the zlib library is not present, B<Tethereal> will compile, but will
63 be unable to read compressed files.
64
65 If the B<-w> option is not specified, B<Tethereal> writes to the standard
66 output the text of a decoded form of the packets it captures or reads. 
67 If the B<-w> option is specified, B<Tethereal> writes to the file
68 specified by that option the raw data of the packets, along with the
69 packets' time stamps.
70
71 When writing a decoded form of packets, B<Tethereal> writes, by
72 default, a summary line containing the fields specified by the
73 preferences file (which are also the fields displayed in the packet list
74 pane in B<Ethereal>), although if it's writing packets as it captures
75 them, rather than writting packets from a saved capture file, it won't
76 show the "frame number" field.  If the B<-V> option is specified, it
77 writes instead a view of the details of the packet, showing all the
78 fields of all protocols in the packet.
79
80 If you want to write the decoded form of packets to a file, run
81 B<Tethereal> without the B<-w> option, and redirect its standard output to
82 the file (do I<not> use the B<-w> option).
83
84 When writing packets to a file, B<Tethereal>, by default, writes the
85 file in B<libpcap> format, and writes all of the packets it sees to the
86 output file.  The B<-F> option can be used to specify the format in which
87 to write the file. This list of available file formats is displayed by 
88 the B<-h> flag.
89
90 Read filters in B<Tethereal>, which allow you to select which packets
91 are to be decoded or written to a file, are very powerful; more fields
92 are filterable in B<Tethereal> than in other protocol analyzers, and the
93 syntax you can use to create your filters is richer.  As B<Tethereal>
94 progresses, expect more and more protocol fields to be allowed in read
95 filters.
96
97 Packet capturing is performed with the pcap library.  The capture filter
98 syntax follows the rules of the pcap library.  This syntax is different
99 from the read filter syntax.  A read filter can also be specified when
100 capturing, and only packets that pass the read filter will be displayed
101 or saved to the output file; note, however, that capture filters are much
102 more efficient than read filters, and it may be more difficult for
103 B<Tethereal> to keep up with a busy network if a read filter is
104 specified for a live capture.
105
106 A capture or read filter can either be specified with the B<-f> or B<-R>
107 option, respectively, in which case the entire filter expression must be
108 specified as a single argument (which means that if it contains spaces,
109 it must be quoted), or can be specified with command-line arguments
110 after the option arguments, in which case all the arguments after the
111 filter arguments are treated as a filter expression.  Capture filters
112 are supported only when doing a live capture; read filters are supported
113 when doing a live capture and when reading a capture file, but require
114 Tethereal to do more work when filtering, so you might be more likely to
115 lose packets under heavy load if you're using a read filter.  If the
116 filter is specified with command-line arguments after the option
117 arguments, it's a capture filter if a capture is being done (i.e., if no
118 B<-r> option was specified) and a read filter if a capture file is being
119 read (i.e., if a B<-r> option was specified).
120
121 =head1 OPTIONS
122
123 =over 4
124
125 =item -a  E<lt>capture autostop conditionE<gt>
126
127 Specify a criterion that specifies when B<Tethereal> is to stop writing
128 to a capture file.  The criterion is of the form I<test>B<:>I<value>,
129 where I<test> is one of:
130
131 B<duration>:I<value> Stop writing to a capture file after I<value> seconds have elapsed.
132
133 B<filesize>:I<value> Stop writing to a capture file after it reaches a size of I<value>
134 kilobytes (where a kilobyte is 1024 bytes). If this option 
135 is used together with the -b option, Ethereal will stop writing to the 
136 current capture file and switch to the next one if filesize is reached.
137
138 B<files>:I<value> Stop writing to capture files after I<value> number of files were written.
139
140 =item -b  E<lt>capture ring buffer optionE<gt>
141
142 Cause B<Tethereal> to run in "multiple files" mode.  In "multiple files" mode, 
143 B<Tethereal> will write to several capture files. When the first capture file 
144 fills up, B<Tethereal> will switch writing to the next file and so on.
145
146 The created filenames are based on the filename given with the B<-w> option, the number of 
147 the file and on the creation date and time, 
148 e.g. outfile_00001_20050604120117.pcap, outfile_00001_20050604120523.pcap, ...
149
150 With the I<files> option it's also possible to form a "ring buffer". 
151 This will fill up new files until the number of files specified, 
152 at which point B<Tethereal> will discard the data in the first file and start 
153 writing to that file and so on. If the I<files> option is not set,
154 new files filled up until one of the capture stop conditions match (or 
155 until the disk if full).
156
157 The criterion is of the form I<key>B<:>I<value>,
158 where I<key> is one of:
159
160 B<duration>:I<value> switch to the next file after I<value> seconds have 
161 elapsed, even if the current file is not completely filled up.
162
163 B<filesize>:I<value> switch to the next file after it reaches a size of 
164 I<value> kilobytes (where a kilobyte is 1024 bytes). 
165
166 B<files>:I<value> begin again with the first file after I<value> number of 
167 files were written (form a ring buffer).
168
169 =item -B  E<lt>capture buffer size (Win32 only)E<gt>
170
171 Win32 only: set capture buffer size (in MB, default is 1MB). This is used by the
172 the capture driver to buffer packet data until that data can be written to 
173 disk. If you encounter packet drops while capturing, try to increase this size.
174
175 =item -c  E<lt>capture packet countE<gt>
176
177 Set the maximum number of packets to read when capturing live
178 data.
179
180 =item -d  E<lt>layer typeE<gt>==E<lt>selectorE<gt>,E<lt>decode-as protocolE<gt>
181
182 Specify that if the layer type in question (for example, B<tcp.port> or
183 B<udp.port> for a TCP or UDP port number) has the specified selector
184 value, packets should be dissected as the specified protocol.
185
186 Example: B<-d tcp.port==8888,http> will decode any traffic running over
187 TCP port 8888 as HTTP.
188
189 =item -D
190
191 Print a list of the interfaces on which B<Tethereal> can capture, and
192 exit.  For each network interface, a number and an
193 interface name, possibly followed by a text description of the
194 interface, is printed.  The interface name or the number can be supplied
195 to the B<-i> option to specify an interface on which to capture.
196
197 This can be useful on systems that don't have a command to list them  
198 (e.g., Windows systems, or UNIX systems lacking B<ifconfig -a>);
199 the number can be useful on Windows 2000 and later systems, where the
200 interface name is a somewhat complex string.
201
202 Note that "can capture" means that B<Tethereal> was able to open
203 that device to do a live capture. Depending on your system you may need to run tethereal from an account 
204 with special privileges (for example, as root) to be able to capture 
205 network traffic.
206 If B<Tethereal -D> is not run from such an account, it will not list 
207 any interfaces.
208
209 =item -f  E<lt>capture filterE<gt>
210
211 Set the capture filter expression.
212
213 =item -F  E<lt>file formatE<gt>
214
215 Set the file format of the output capture file written using the B<-w>
216 option.  The output written with the B<-w> option is raw packet data, not
217 text, so there is no B<-F> option to request text output.
218
219 =item -h
220
221 Print the version and options and exits.
222
223 =item -i  E<lt>capture interfaceE<gt>|-
224
225 Set the name of the network interface or pipe to use for live packet
226 capture. 
227
228 Network interface names should match one of the names listed in
229 "B<tethereal -D>" (described above); a number, as reported by
230 "B<tethereal -D>", can also be used.  If you're using UNIX, "B<netstat
231 -i>" or "B<ifconfig -a>" might also work to list interface names,
232 although not all versions of UNIX support the B<-a> option to B<ifconfig>.
233
234 If no interface is specified, B<Tethereal> searches the list of
235 interfaces, choosing the first non-loopback interface if there are any
236 non-loopback interfaces, and choosing the first loopback interface if
237 there are no non-loopback interfaces. If there are no interfaces at all,
238 B<Tethereal> reports an error and doesn't start the capture.
239
240 Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
241 read data from the standard input.  Data read from pipes must be in
242 standard libpcap format.
243
244 Note: the Win32 version of B<Tethereal> doesn't support capturing from
245 pipes or stdin!
246
247 =item -l
248
249 Flush the standard output after the information for each packet is
250 printed.  (This is not, strictly speaking, line-buffered if B<-V>
251 was specified; however, it is the same as line-buffered if B<-V> wasn't
252 specified, as only one line is printed for each packet, and, as B<-l> is
253 normally used when piping a live capture to a program or script, so that
254 output for a packet shows up as soon as the packet is seen and
255 dissected, it should work just as well as true line-buffering.  We do
256 this as a workaround for a deficiency in the Microsoft Visual C++ C
257 library.)
258
259 This may be useful when piping the output of B<Tethereal> to another
260 program, as it means that the program to which the output is piped will
261 see the dissected data for a packet as soon as B<Tethereal> sees the
262 packet and generates that output, rather than seeing it only when the
263 standard output buffer containing that data fills up.
264
265 =item -L
266
267 List the data link types supported by the interface and exit. The reported
268 link types can be used for the B<-y> option.
269
270 =item -n
271
272 Disable network object name resolution (such as hostname, TCP and UDP port
273 names), the B<-N> flag might override this one.
274
275 =item -N  E<lt>name resolving flagsE<gt>
276
277 Turn on name resolving only for particular types of addresses and port
278 numbers, with name resolving for other types of addresses and port
279 numbers turned off. This flag overrides B<-n> if both B<-N> and B<-n> are 
280 present. If both B<-N> and B<-n> flags are not present, all name resolutions are 
281 turned on.
282
283 The argument is a string that may contain the letters:
284
285 B<m> to enable MAC address resolution
286
287 B<n> to enable network address resolution
288
289 B<t> to enable transport-layer port number resolution
290
291 B<C> to enable concurrent (asynchronous) DNS lookups
292
293 =item -o  E<lt>preferenceE<gt>:E<lt>valueE<gt>
294
295 Set a preference value, overriding the default value and any value read
296 from a preference file.  The argument to the option is a string of the
297 form I<prefname>B<:>I<value>, where I<prefname> is the name of the
298 preference (which is the same name that would appear in the preference
299 file), and I<value> is the value to which it should be set.
300
301 =item -p
302
303 I<Don't> put the interface into promiscuous mode.  Note that the
304 interface might be in promiscuous mode for some other reason; hence,
305 B<-p> cannot be used to ensure that the only traffic that is captured is
306 traffic sent to or from the machine on which B<Tethereal> is running,
307 broadcast traffic, and multicast traffic to addresses received by that
308 machine.
309
310 =item -q
311
312 When capturing packets, don't display the continuous count of packets
313 captured that is normally shown when saving a capture to a file;
314 instead, just display, at the end of the capture, a count of packets
315 captured.  On systems that support the SIGINFO signal, such as various
316 BSDs, you can cause the current count to be displayed by typing your 
317 "status" character (typically control-T, although it
318 might be set to "disabled" by default on at least some BSDs, so you'd
319 have to explicitly set it to use it).
320
321 When reading a capture file, or when capturing and not saving to a file,
322 don't print packet information; this is useful if you're using a B<-z>
323 option to calculate statistics and don't want the packet information
324 printed, just the statistics.
325
326 =item -r  E<lt>infileE<gt>
327
328 Read packet data from I<infile>, can be any supported capture file format 
329 (including gzipped files). It's B<not> possible to use named pipes 
330 or stdin here!
331
332 =item -R  E<lt>read (display) filterE<gt>
333
334 Cause the specified filter (which uses the syntax of read/display filters,
335 rather than that of capture filters) to be applied before printing a
336 decoded form of packets or writing packets to a file; packets not
337 matching the filter are discarded rather than being printed or written.
338
339 =item -s  E<lt>capture snaplenE<gt>
340
341 Set the default snapshot length to use when capturing live data. 
342 No more than I<snaplen> bytes of each network packet will be read into
343 memory, or saved to disk.
344
345 =item -S
346
347 Decode and display packets even while writing raw packet data using the
348 B<-w> option.
349
350 =item -t  ad|a|r|d
351
352 Set the format of the packet timestamp printed in summary lines, the default 
353 is relative. The format can be one of:
354
355 B<ad> absolute with date: The absolute date and time is the actual time and 
356 date the packet was captured
357
358 B<a> absolute: The absolute time is the actual time the packet was captured, 
359 with no date displayed
360
361 B<r> relative: The relative time is the time elapsed between the first packet 
362 and the current packet
363
364 B<d> delta: The delta time is the time since the previous packet was
365 captured
366
367 =item -T  pdml|psml|ps|text
368
369 Set the format of the output when viewing decoded packet data.  The
370 options are one of:
371
372 B<pdml> Packet Details Markup Language, an XML-based format for the details of
373 a decoded packet.  This information is equivalent to the packet details
374 printed with the B<-V> flag.
375
376 B<psml> Packet Summary Markup Language, an XML-based format for the summary
377 information of a decoded packet.  This information is equivalent to the
378 information shown in the one-line summary printed by default.
379
380 B<ps> PostScript for a human-readable one-line summary of each of the packets,
381 or a multi-line view of the details of each of the packets, depending on
382 whether the B<-V> flag was specified.
383
384 B<text> Text of a human-readable one-line summary of each of the packets, or a
385 multi-line view of the details of each of the packets, depending on
386 whether the B<-V> flag was specified.  This is the default.
387
388 =item -v
389
390 Print the version and exit.
391
392 =item -V
393
394 Cause B<Tethereal> to print a view of the packet details rather
395 than a one-line summary of the packet.
396
397 =item -w  E<lt>outfileE<gt>|-
398
399 Write raw packet data to I<outfile> or to the standard output if
400 I<outfile> is '-'.  
401
402 NOTE: -w provides raw packet data, not text. If you want text output 
403 you need to redirect stdout (e.g. using '>'), don't use the B<-w> 
404 option for this.
405
406 =item -x
407
408 Cause B<Tethereal> to print a hex and ASCII dump of the packet data
409 after printing the summary or details.
410
411
412 =item -X E<lt>eXtension optionsE<gt>
413
414 Specify an option to be passed to a B<Tethereal> module. The eXtension option
415 is in the form I<extension_key>B<:>I<value>, where I<extension_key> can be:
416
417 B<lua_script>:I<lua_script_filename> tells B<Ethereal> to load the given script in addition to the
418 default Lua scripts.
419
420
421 =item -y  E<lt>capture link typeE<gt>
422
423 Set the data link type to use while capturing packets.  The values
424 reported by B<-L> are the values that can be used.
425
426 =item -z  E<lt>statisticsE<gt>
427
428 Get B<Tethereal> to collect various types of statistics and display the result
429 after finishing reading the capture file.  Use the B<-q> flag if you're
430 reading a capture file and only want the statistics printed, not any
431 per-packet information.
432
433 Note that the B<-z proto> option is different - it doesn't cause
434 statistics to be gathered and printed when the capture is complete, it
435 modifies the regular packet summary output to include the values of
436 fields specified with the option.  Therefore you must not use the B<-q>
437 option, as that option would suppress the printing of the regular packet
438 summary output, and must also not use the B<-V> option, as that would
439 cause packet detail information rather than packet summary information
440 to be printed.
441
442 Currently implemented statistics are:
443
444 B<-z> dcerpc,rtt,I<uuid>,I<major>.I<minor>[,I<filter>]
445
446 Collect call/reply RTT data for DCERPC interface I<uuid>, 
447 version I<major>.I<minor>.
448 Data collected is number of calls for each procedure, MinRTT, MaxRTT 
449 and AvgRTT. 
450 Example: use B<-z dcerpc,rtt,12345778-1234-abcd-ef00-0123456789ac,1.0> to collect data for CIFS SAMR Interface.  
451 This option can be used multiple times on the command line. 
452
453 If the optional filterstring is provided, the stats will only be calculated
454 on those calls that match that filter.
455 Example: use B<-z dcerpc,rtt,12345778-1234-abcd-ef00-0123456789ac,1.0,ip.addr==1.2.3.4> to collect SAMR
456 RTT statistics for a specific host.
457
458
459 B<-z> io,phs[,I<filter>]
460
461 Create Protocol Hierarchy Statistics listing both number of packets and bytes.
462 If no I<filter> is specified the statistics will be calculated for all packets.
463 If a I<filters> is specified statistics will be only calculated for those
464 packets that match the filter.
465
466 This option can be used multiple times on the command line. 
467
468
469 B<-z> io,stat,I<interval>[,I<filter>][,I<filter>][,I<filter>]...
470
471 Collect packet/bytes statistics for the capture in intervals of
472 I<interval> seconds.  I<Intervals> can be specified either as whole or
473 fractional seconds.  Interval can be specified in ms resolution.
474
475 If no I<filter> is specified the statistics will be calculated for all packets.
476 If one or more I<filters> are specified statistics will be calculated for
477 all filters and presented with one column of statistics for each filter.
478
479 This option can be used multiple times on the command line. 
480
481
482 Example: B<-z io,stat,1,ip.addr==1.2.3.4> to generate 1 second
483 statistics for all traffic to/from host 1.2.3.4.
484
485 Example: B<-z "io,stat,0.001,smb&&ip.addr==1.2.3.4"> to generate 1ms
486 statistics for all SMB packets to/from host 1.2.3.4.
487
488 The examples above all use the standard syntax for generating statistics
489 which only calculates the number of packets and bytes in each interval.
490
491 B<io,stat> can also do much more statistics and calculate COUNT(), SUM(),
492 MIN(), MAX(), and AVG() using a slightly different filter syntax:
493
494   [COUNT|SUM|MIN|MAX|AVG](<field>)<filter>
495
496 One important thing to note here is that the field that the calculation is 
497 based on MUST also be part of the filter string or else the calculation will
498 fail.
499
500 So: B<-z io,stat,0.010,AVG(smb.time)> does not work.  Use B<-z
501 io,stat,0.010,AVG(smb.time)smb.time> instead.  Also be aware that a field
502 can exist multiple times inside the same packet and will then be counted
503 multiple times in those packets. 
504
505
506 COUNT(<field>) can be used on any type which has a display filter name. 
507 It will count how many times this particular field is encountered in the
508 filtered packet list.
509
510 Example: B<-z io,stat,0.010,COUNT(smb.sid)smb.sid>
511 This will count the total number of SIDs seen in each 10ms interval.
512
513 SUM(<field>) can only be used on named fields of integer type.
514 This will sum together every occurence of this fields value for each interval.
515
516 Example: B<-z io,stat,0.010,SUM(frame.pkt_len)frame.pkt_len>
517 This will report the total number of bytes seen in all the packets within
518 an interval.
519
520 MIN/MAX/AVG(<field>) can only be used on named fields that are either
521 integers or relative time fields.  This will calculate maximum/minimum
522 or average seen in each interval.  If the field is a relative time field
523 the output will be presented in seconds and three digits after the
524 decimal point.  The resolution for time calculations is 1ms and anything
525 smaller will be truncated.
526
527 Example:  B<-z "io,stat,0.010,smb.time&&ip.addr==1.1.1.1,MIN(smb.time)smb.time&&ip.addr==1.1.1.1,MAX(smb.time)smb.time&&ip.addr==1.1.1.1,MAX(smb.time)smb.time&&ip.addr==1.1.1.1">
528
529 This will calculate statistics for all smb response times we see to/from
530 host 1.1.1.1 in 10ms intervals.  The output will be displayed in 4
531 columns; number of packets/bytes, minimum response time, maximum response
532 time and average response time.
533
534
535
536 B<-z> conv,I<type>[,I<filter>]
537
538 Create a table that lists all conversations that could be seen in the capture.
539 I<type> specifies which type of conversation we want to generate the 
540 statistics for; currently the supported ones are
541
542   "eth"   Ethernet
543   "fc"    Fibre Channel
544   "fddi"  FDDI
545   "ip"    IP addresses
546   "ipx"   IPX addresses
547   "tcp"   TCP/IP socket pairs  Both IPv4 and IPv6 are supported
548   "tr"    Token Ring
549   "udp"   UDP/IP socket pairs  Both IPv4 and IPv6 are supported
550
551 If the optional filter string is specified, only those packets that match the
552 filter will be used in the calculations.
553
554 The table is presented with one line for each conversation and displays
555 number of packets/bytes in each direction as well as total number of 
556 packets/bytes.
557 The table is sorted according to total number of bytes.
558
559
560 B<-z> proto,colinfo,I<filter>,I<field>
561
562 Append all I<field> values for the packet to the Info column of the
563 one-line summary output.
564 This feature can be used to append arbitrary fields to the Info column
565 in addition to the normal content of that column.
566 I<field> is the display-filter name of a field which value should be placed
567 in the Info column.
568 I<filter> is a filter string that controls for which packets the field value
569 will be presented in the info column. I<field> will only be presented in the
570 Info column for the packets which match I<filter>.
571
572 NOTE: In order for B<Tethereal> to be able to extract the I<field> value
573 from the packet, I<field> MUST be part of the I<filter> string.  If not,
574 B<Tethereal> will not be able to extract its value.
575
576 For a simple example to add the "nfs.fh.hash" field to the Info column
577 for all packets containing the "nfs.fh.hash" field, use
578
579 B<-z proto,colinfo,nfs.fh.hash,nfs.fh.hash>
580
581
582 To put "nfs.fh.hash" in the Info column but only for packets coming from
583 host 1.2.3.4 use:
584
585 B<-z "proto,colinfo,nfs.fh.hash && ip.src==1.2.3.4,nfs.fh.hash">
586
587 This option can be used multiple times on the command line. 
588
589
590 B<-z> rpc,rtt,I<program>,I<version>[,I<filter>]
591
592 Collect call/reply RTT data for I<program>/I<version>.  Data collected
593 is number of calls for each procedure, MinRTT, MaxRTT and AvgRTT. 
594 Example: use B<-z rpc,rtt,100003,3> to collect data for NFS v3.  This
595 option can be used multiple times on the command line. 
596
597 If the optional filterstring is provided, the stats will only be calculated
598 on those calls that match that filter.
599 Example: use B<-z rpc,rtt,100003,3,nfs.fh.hash==0x12345678> to collect NFS v3
600 RTT statistics for a specific file.
601
602
603 B<-z> rpc,programs
604
605 Collect call/reply RTT data for all known ONC-RPC programs/versions.  
606 Data collected is number of calls for each protocol/version, MinRTT, 
607 MaxRTT and AvgRTT. 
608 This option can only be used once on the command line.
609
610 B<-z> smb,rtt[,I<filter>]
611
612 Collect call/reply RTT data for SMB.  Data collected
613 is number of calls for each SMB command, MinRTT, MaxRTT and AvgRTT. 
614 Example: use B<-z smb,rtt>.
615 The data will be presented as separate tables for all normal SMB commands,
616 all Transaction2 commands and all NT Transaction commands.
617 Only those commands that are seen in the capture will have its stats
618 displayed.
619 Only the first command in a xAndX command chain will be used in the
620 calculation.  So for common SessionSetupAndX + TreeConnectAndX chains,
621 only the SessionSetupAndX call will be used in the statistics.
622 This is a flaw that might be fixed in the future.
623
624 This option can be used multiple times on the command line. 
625
626 If the optional filterstring is provided, the stats will only be calculated
627 on those calls that match that filter.
628 Example: use B<-z "smb,rtt,ip.addr==1.2.3.4"> to only collect stats for
629 SMB packets echanged by the host at IP address 1.2.3.4 .
630
631 B<-z> smb,sids
632
633 When this feature is used B<Tethereal> will print a report with all the
634 discovered SID and account name mappings.  Only those SIDs where the
635 account name is known will be presented in the table.
636
637 For this feature to work you will need to either to enable
638 "Edit/Preferences/Protocols/SMB/Snoop SID to name mappings" in the
639 preferences or you can override the preferences by specifying
640 B<-o "smb.sid_name_snooping:TRUE"> on the B<Tethereal> command line.
641
642 The current methods used by B<Tethereal> to find the SID->name mapping
643 is relatively restricted but is hoped to be expanded in the future.
644
645 B<-z> mgcp,rtd[I<,filter>]
646
647 Collect requests/response RTD (Response Time Delay) data for MGCP. 
648 This is similar to B<-z smb,rtt>). Data collected is number of calls
649 for each known MGCP Type, MinRTD, MaxRTD and AvgRTD.
650 Additionally you get the number of duplicate requests/responses, 
651 unresponded requests, responses ,which don't match with
652 any request. 
653 Example: use B<-z mgcp,rtd>.
654
655 This option can be used multiple times on the command line. 
656
657 If the optional filterstring is provided, the stats will only be calculated
658 on those calls that match that filter.
659 Example: use B<-z "mgcp,rtd,ip.addr==1.2.3.4"> to only collect stats for
660 MGCP packets exchanged by the host at IP address 1.2.3.4 .
661
662 B<-z> h225,counter[I<,filter>]
663
664 Count ITU-T H.225 messages and their reasons. In the first column you get a 
665 list of H.225 messages and H.225 message reasons, which occur in the current
666 capture file. The number of occurences of each message or reason is displayed 
667 in the second column.
668
669 Example: use B<-z h225,counter>.
670
671 This option can be used multiple times on the command line. 
672
673 If the optional filterstring is provided, the stats will only be calculated
674 on those calls that match that filter.
675 Example: use B<-z "h225,counter,ip.addr==1.2.3.4"> to only collect stats for
676 H.225 packets exchanged by the host at IP address 1.2.3.4 .
677
678 B<-z> h225,srt[I<,filter>]
679
680 Collect requests/response SRT (Service Response Time) data for ITU-T H.225 RAS. 
681 Data collected is number of calls of each ITU-T H.225 RAS Message Type,
682 Minimum SRT, Maximum SRT, Average SRT, Minimum in Frame, and Maximum in Frame. 
683 You will also get the number of Open Requests (Unresponded Requests), 
684 Discarded Responses (Responses without matching request) and Duplicate Messages.
685 Example: use B<-z h225,srt>.
686
687 This option can be used multiple times on the command line. 
688
689 If the optional filterstring is provided, the stats will only be calculated
690 on those calls that match that filter.
691 Example: use B<-z "h225,srt,ip.addr==1.2.3.4"> to only collect stats for
692 ITU-T H.225 RAS packets exchanged by the host at IP address 1.2.3.4 .
693
694 B<-z> sip,stat[I<,filter>]
695
696 This option will activate a counter for SIP messages. You will get the number 
697 of occurences of each SIP Method and of each SIP Status-Code. Additionally you 
698 also get the number of resent SIP Messages (only for SIP over UDP).  
699
700 Example: use B<-z sip,stat>.
701
702 This option can be used multiple times on the command line. 
703
704 If the optional filter string is provided, the stats will only be calculated
705 on those calls that match that filter.
706 Example: use B<-z "sip,stat,ip.addr==1.2.3.4"> to only collect stats for
707 SIP packets exchanged by the host at IP address 1.2.3.4 .
708
709 =back
710
711 =head1 CAPTURE FILTER SYNTAX
712
713 See the manual page of I<tcpdump(8)>.
714
715 =head1 READ FILTER SYNTAX
716
717 For a complete table of protocol and protocol fields that are filterable
718 in B<Tethereal> see the I<ethereal-filter(4)> manual page.
719
720 =head1 FILES
721
722 These files contains various B<Ethereal> configuration values.
723
724 =over 4
725
726 =item Preferences
727
728 The F<preferences> files contain global (system-wide) and personal
729 preference settings. If the system-wide preference file exists, it is
730 read first, overriding the default settings. If the personal preferences
731 file exists, it is read next, overriding any previous values. Note: If
732 the command line option B<-o> is used (possibly more than once), it will
733 in turn override values from the preferences files.
734
735 The preferences settings are in the form I<prefname>B<:>I<value>,
736 one per line,
737 where I<prefname> is the name of the preference
738 and I<value> is the value to
739 which it should be set; white space is allowed between B<:> and
740 I<value>.  A preference setting can be continued on subsequent lines by
741 indenting the continuation lines with white space.  A B<#> character
742 starts a comment that runs to the end of the line:
743
744   # Capture in promiscuous mode?
745   # TRUE or FALSE (case-insensitive).
746   capture.prom_mode: TRUE
747
748 The global preferences file is looked for in the F<ethereal> directory
749 under the F<share> subdirectory of the main installation directory (for
750 example, F</usr/local/share/ethereal/preferences>) on UNIX-compatible
751 systems, and in the main installation directory (for example,
752 F<C:\Program Files\Ethereal\preferences>) on Windows systems.
753
754 The personal preferences file is looked for in
755 F<$HOME/.ethereal/preferences> on
756 UNIX-compatible systems and F<%APPDATA%\Ethereal\preferences> (or, if
757 %APPDATA% isn't defined, F<%USERPROFILE%\Application
758 Data\Ethereal\preferences>) on Windows systems.
759
760 =item Disabled (Enabled) Protocols
761
762 The F<disabled_protos> files contain system-wide and personal lists of
763 protocols that have been disabled, so that their dissectors are never
764 called.  The files contain protocol names, one per line, where the
765 protocol name is the same name that would be used in a display filter
766 for the protocol:
767
768   http
769   tcp     # a comment
770
771 The global F<disabled_protos> file uses the same directory as the global
772 preferences file.
773
774 The personal F<disabled_protos> file uses the same directory as the
775 personal preferences file.
776
777 =item Name Resolution (hosts)
778
779 If the personal F<hosts> file exists, it is
780 used to resolve IPv4 and IPv6 addresses before any other
781 attempts are made to resolve them.  The file has the standard F<hosts>
782 file syntax; each line contains one IP address and name, separated by
783 whitespace. The same directory as for the personal preferences file is
784 used.
785
786 =item Name Resolution (ethers)
787
788 The F<ethers> files are consulted to correlate 6-byte hardware addresses to
789 names. First the personal F<ethers> file is tried and if an address is not
790 found there the global F<ethers> file is tried next.
791
792 Each line contains one hardware address and name, separated by
793 whitespace.  The digits of the hardware address are separated by colons
794 (:), dashes (-) or periods (.).  The same separator character must be
795 used consistently in an address. The following three lines are valid
796 lines of an F<ethers> file:
797
798   ff:ff:ff:ff:ff:ff          Broadcast
799   c0-00-ff-ff-ff-ff          TR_broadcast
800   00.00.00.00.00.00          Zero_broadcast
801
802 The global F<ethers> file is looked for in the F</etc> directory on
803 UNIX-compatible systems, and in the main installation directory (for
804 example, F<C:\Program Files\Ethereal>) on Windows systems.
805
806 The personal F<ethers> file is looked for in the same directory as the personal
807 preferences file.
808
809 =item Name Resolution (manuf)
810
811 The F<manuf> file is used to match the 3-byte vendor portion of a 6-byte 
812 hardware address with the manufacturer's name; it can also contain well-known 
813 MAC addresses and address ranges specified with a netmask.  The format of the 
814 file is the same as the F<ethers> files, except that entries of the form:
815
816   00:00:0C      Cisco
817
818 can be provided, with the 3-byte OUI and the name for a vendor, and
819 entries such as:
820
821   00-00-0C-07-AC/40     All-HSRP-routers
822
823 can be specified, with a MAC address and a mask indicating how many bits
824 of the address must match. The above entry, for example, has 40
825 significant bits, or 5 bytes, and would match addresses from
826 00-00-0C-07-AC-00 through 00-00-0C-07-AC-FF. The mask need not be a
827 multiple of 8.
828
829 The F<manuf> file is looked for in the same directory as the global
830 preferences file.
831
832 =item Name Resolution (ipxnets)
833
834 The F<ipxnets> files are used to correlate 4-byte IPX network numbers to 
835 names. First the global F<ipxnets> file is tried and if that address is not 
836 found there the personal one is tried next.
837
838 The format is the same as the F<ethers>
839 file, except that each address is four bytes instead of six.
840 Additionally, the address can be represented as a single hexadecimal
841 number, as is more common in the IPX world, rather than four hex octets.
842 For example, these four lines are valid lines of an F<ipxnets> file:
843
844   C0.A8.2C.00              HR
845   c0-a8-1c-00              CEO
846   00:00:BE:EF              IT_Server1
847   110f                     FileServer3
848
849 The global F<ipxnets> file is looked for in the F</etc> directory on
850 UNIX-compatible systems, and in the main installation directory (for
851 example, F<C:\Program Files\Ethereal>) on Windows systems.
852
853 The personal F<ipxnets> file is looked for in the same directory as the
854 personal preferences file.
855
856 =back
857
858 =head1 SEE ALSO
859
860 I<ethereal-filter(4)> I<ethereal(1)>, I<editcap(1)>, I<tcpdump(8)>, I<pcap(3)>
861
862 =head1 NOTES
863
864 B<Tethereal> is part of the B<Ethereal> distribution.  The latest version
865 of B<Ethereal> can be found at B<http://www.ethereal.com>.
866
867 HTML versions of the Wireshark project man pages are available at:
868 http://www.ethereal.com/docs/man-pages
869
870 =head1 AUTHORS
871
872 B<Tethereal> uses the same packet dissection code that B<Ethereal> does,
873 as well as using many other modules from B<Ethereal>; see the list of
874 authors in the B<Ethereal> man page for a list of authors of that code.