Ringbuffer rework.
[obnox/wireshark/wip.git] / doc / tethereal.pod.template
1
2 =head1 NAME
3
4 tethereal - Dump and analyze network traffic
5
6 =head1 SYNOPSYS
7
8 B<tethereal>
9 S<[ B<-a> capture autostop condition ] ...>
10 S<[ B<-b> number of ring buffer files [:duration] ]>
11 S<[ B<-c> count ]>
12 S<[ B<-d> <layer type>==<selector>,<decode-as protocol> ]>
13 S<[ B<-D> ]>
14 S<[ B<-f> capture filter expression ]>
15 S<[ B<-F> file format ]>
16 S<[ B<-h> ]>
17 S<[ B<-i> interface ]> 
18 S<[ B<-l> ]>
19 S<[ B<-n> ]>
20 S<[ B<-N> resolving flags ]>
21 S<[ B<-o> preference setting ] ...>
22 S<[ B<-p> ]>
23 S<[ B<-q> ]>
24 S<[ B<-r> infile ]>
25 S<[ B<-R> display filter expression ]>
26 S<[ B<-s> snaplen ]>
27 S<[ B<-S> ]>
28 S<[ B<-t> time stamp format ]>
29 S<[ B<-v> ]>
30 S<[ B<-V> ]>
31 S<[ B<-w> savefile ]>
32 S<[ B<-x> ]>
33 S<[ B<-z> statistics-string ]>
34 S<[ filter expression ]>
35
36 =head1 DESCRIPTION
37
38 B<Tethereal> is a network protocol analyzer.  It lets you capture packet
39 data from a live network, or read packets from a previously saved
40 capture file, either printing a decoded form of those packets to the
41 standard output or writing the packets to a file.  B<Tethereal>'s native
42 capture file format is B<libpcap> format, which is also the format used
43 by B<tcpdump> and various other tools.  In addition, B<Tethereal> can
44 read capture files from B<snoop> and B<atmsnoop>, Shomiti/Finisar
45 B<Surveyor>, Novell B<LANalyzer>, Network General/Network Associates
46 DOS-based B<Sniffer> (compressed or uncompressed), Microsoft B<Network
47 Monitor>, AIX's B<iptrace>, Cinco Networks B<NetXRay>, Network
48 Associates Windows-based B<Sniffer>, AG Group/WildPackets
49 B<EtherPeek>/B<TokenPeek>/B<AiroPeek>, B<RADCOM>'s WAN/LAN analyzer,
50 B<Lucent/Ascend> router debug output, HP-UX's B<nettl>, the dump output
51 from B<Toshiba's> ISDN routers, the output from B<i4btrace> from the
52 ISDN4BSD project, the output in B<IPLog> format from the Cisco Secure
53 Intrusion Detection System, B<pppd logs> (pppdump format), the output
54 from VMS's B<TCPIPtrace>/B<TCPtrace>/B<UCX$TRACE> utilities, the text
55 output from the B<DBS Etherwatch> VMS utility, traffic capture files
56 from Visual Networks' Visual UpTime, and the output from B<CoSine> L2
57 debug.  There is no need to tell B<Tethereal> what type of file you are
58 reading; it will determine the file type by itself.  B<Tethereal> is
59 also capable of reading any of these file formats if they are compressed
60 using gzip.  B<Tethereal> recognizes this directly from the file; the
61 '.gz' extension is not required for this purpose.
62
63 If the B<-w> flag is not specified, B<Tethereal> prints a decoded form
64 of the packets it captures or reads; otherwise, it writes those packets
65 to the file specified by that flag.
66
67 When printing a decoded form of packets, B<Tethereal> prints, by
68 default, a summary line containing the fields specified by the
69 preferences file (which are also the fields displayed in the packet list
70 pane in B<Ethereal>), although if it's printing packets as it captures
71 them, rather than printing packets from a saved capture file, it won't
72 print the "frame number" field.  If the B<-V> flag is specified, it
73 prints intead a protocol tree, showing all the fields of all protocols
74 in the packet.
75
76 When writing packets to a file, B<Tethereal>, by default, writes the
77 file in B<libpcap> format, and writes all of the packets it sees to the
78 output file.  The B<-F> flag can be used to specify the format in which
79 to write the file.  The following formats are supported:
80
81 =over 8
82
83 =item B<libpcap> - libpcap (tcpdump, Ethereal, etc.)
84
85 =item B<rh6_1libpcap> - Red Hat Linux 6.1 libpcap (tcpdump)
86
87 =item B<suse6_3libpcap> - SuSE Linux 6.3 libpcap (tcpdump)
88
89 =item B<modlibpcap> - modified libpcap (tcpdump)
90
91 =item B<nokialibpcap> - Nokia libpcap (tcpdump)
92
93 =item B<lanalyzer> - Novell LANalyzer
94
95 =item B<ngsniffer> - Network Associates Sniffer (DOS-based)
96
97 =item B<snoop> - Sun snoop
98
99 =item B<netmon1> - Microsoft Network Monitor 1.x
100
101 =item B<netmon2> - Microsoft Network Monitor 2.x
102
103 =item B<ngwsniffer_1_1> - Network Associates Sniffer (Windows-based) 1.1
104
105 =item B<ngwsniffer_2_0> - Network Associates Sniffer (Windows-based) 2.00x
106
107 =item B<visual> - Visual Networks traffic capture
108
109 =back
110
111 This list is also displayed by the B<-h> flag.
112
113 Read filters in B<Tethereal>, which allow you to select which packets
114 are to be decoded or written to a file, are very powerful; more fields
115 are filterable in B<Tethereal> than in other protocol analyzers, and the
116 syntax you can use to create your filters is richer.  As B<Tethereal>
117 progresses, expect more and more protocol fields to be allowed in read
118 filters.
119
120 Packet capturing is performed with the pcap library.  The capture filter
121 syntax follows the rules of the pcap library.  This syntax is different
122 from the read filter syntax.  A read filter can also be specified when
123 capturing, and only packets that pass the read filter will be displayed
124 or saved to the output file; note, however, that capture filters are much
125 more efficient than read filters, and it may be more difficult for
126 B<Tethereal> to keep up with a busy network if a read filter is
127 specified for a live capture.
128
129 Compressed file support uses (and therefore requires) the zlib library. 
130 If the zlib library is not present, B<Tethereal> will compile, but will
131 be unable to read compressed files.
132
133 A capture or read filter can either be specified with the B<-f> or B<-R>
134 option, respectively, in which case the entire filter expression must be
135 specified as a single argument (which means that if it contains spaces,
136 it must be quoted), or can be specified with command-line arguments
137 after the option arguments, in which case all the arguments after the
138 filter arguments are treated as a filter expression.  If the filter is
139 specified with command-line arguments after the option arguments, it's a
140 capture filter if a capture is being done (i.e., if no B<-r> flag was
141 specified) and a read filter if a capture file is being read (i.e., if a
142 B<-r> flag was specified).
143
144 =head1 OPTIONS
145
146 =over 4
147
148 =item -a
149
150 Specify a criterion that specifies when B<Tethereal> is to stop writing
151 to a capture file.  The criterion is of the form I<test>B<:>I<value>,
152 where I<test> is one of:
153
154 =for man .RS
155
156 =for html <P><DL>
157
158 =item duration
159
160 Stop writing to a capture file after I<value> seconds have elapsed.
161
162 =item filesize
163
164 Stop writing to a capture file after it reaches a size of I<value>
165 kilobytes (where a kilobyte is 1000 bytes, not 1024 bytes).
166
167 =for man .RE
168
169 =for html </DL>
170
171 =item -b
172
173 If a maximum capture file size was specified, cause B<Tethereal> to run
174 in "ring buffer" mode, with the specified number of files.  In "ring
175 buffer" mode, B<Tethereal> will write to several capture files. 
176 Their name is based on the number of the file and on the creation date 
177 and time.
178
179 When the first capture file fills up, B<Tethereal> will switch to writing
180 to the next file, until it fills up the last file, at which point it'll
181 discard the data in the first file (unless 0 is specified, in which case,
182 the number of files is unlimited) and start writing to that file and so on.
183
184 If the optional duration is specified, B<Tethereal> will switch also 
185 to the next file when the specified number of seconds has elapsed even
186 if the current file is not completely fills up.
187
188 You can only save files in B<libpcap> format when using a ring buffer.
189
190 =item -c
191
192 Set the default number of packets to read when capturing live
193 data.
194
195 =item -d
196
197 Specify that if the layer type in question (for example, B<tcp.port> or
198 B<udp.port> for a TCP or UDP port number) has the specified selector
199 value, packets should be dissected as the specified protocol.
200
201 =item -D
202
203 Print a list of the interfaces on which B<Tethereal> can capture, and
204 exit.  Note that "can capture" means that B<Tethereal> was able to open
205 that device to do a live capture; if, on your system, a program doing a
206 network capture must be run from an account with special privileges (for
207 example, as root), then, if B<Tethereal> is run with the B<-D> flag and
208 is not run from such an account, it will not list any interfaces.
209
210 =item -f
211
212 Set the capture filter expression.
213
214 =item -F
215
216 Set the file format of the output capture file.
217
218 =item -h
219
220 Print the version and options and exits.
221
222 =item -i
223
224 Set the name of the network interface or pipe to use for live packet
225 capture. 
226
227 Network interface names should match one of the names listed in
228 "B<tethereal -D>" (described above).  If you're using Unix, "B<netstat
229 -i>" or "B<ifconfig -a>" might also work to list interface names,
230 although not all versions of Unix support the B<-a> flag to B<ifconfig>.
231 If no interface is specified, B<Tethereal> searches the list of
232 interfaces, choosing the first non-loopback interface if there are any
233 non-loopback interfaces, and choosing the first loopback interface if
234 there are no non-loopback interfaces; if there are no interfaces,
235 B<Tethereal> reports an error and doesn't start the capture.
236
237 Pipe names should be either the name of a FIFO (named pipe) or ``-'' to
238 read data from the standard input.  Data read from pipes must be in
239 standard libpcap format.
240
241 =item -l
242
243 Flush the standard output after the information for each packet is
244 printed.  (This is not, strictly speaking, line-buffered if B<-V>
245 was specified; however, it is the same as line-buffered if B<-V> wasn't
246 specified, as only one line is printed for each packet, and, as B<-l> is
247 normally used when piping a live capture to a program or script, so that
248 output for a packet shows up as soon as the packet is seen and
249 dissected, it should work just as well as true line-buffering.  We do
250 this as a workaround for a deficiency in the Microsoft Visual C++ C
251 library.)
252
253 This may be useful when piping the output of B<Tethereal> to another
254 program, as it means that the program to which the output is piped will
255 see the dissected data for a packet as soon as B<Tethereal> sees the
256 packet and generates that output, rather than seeing it only when the
257 standard output buffer containing that data fills up.
258
259 =item -n
260
261 Disable network object name resolution (such as hostname, TCP and UDP port
262 names).
263
264 =item -N
265
266 Turn on name resolving for particular types of addresses and port
267 numbers, with name resolving for other types of addresses and port
268 numbers turned off; the argument is a string that may contain the
269 letters B<m> to enable MAC address resolution, B<n> to enable network
270 address resolution, and B<t> to enable transport-layer port number
271 resolution.  This overrides B<-n> if both B<-N> and B<-n> are present.
272
273 =item -o
274
275 Set a preference value, overriding the default value and any value read
276 from a preference file.  The argument to the flag is a string of the
277 form I<prefname>B<:>I<value>, where I<prefname> is the name of the
278 preference (which is the same name that would appear in the preference
279 file), and I<value> is the value to which it should be set.
280
281 =item -p
282
283 I<Don't> put the interface into promiscuous mode.  Note that the
284 interface might be in promiscuous mode for some other reason; hence,
285 B<-p> cannot be used to ensure that the only traffic that is captured is
286 traffic sent to or from the machine on which B<Tethereal> is running,
287 broadcast traffic, and multicast traffic to addresses received by that
288 machine.
289
290 =item -q
291
292 Don't display the continuous count of packets captured that is normally
293 shown when saving a capture to a file; instead, just display, at the end
294 of the capture, a count of packets captured.  On systems that support
295 the SIGINFO signal, such as various BSDs, typing your "status" character
296 (typically control-T) will cause the current count to be displayed.
297
298 =item -r
299
300 Read packet data from I<infile>.
301
302 =item -R
303
304 Cause the specified filter (which uses the syntax of read filters,
305 rather than that of capture filters) to be applied before printing a
306 decoded form of packets or writing packets to a file; packets not
307 matching the filter are discarded rather than being printed or written.
308
309 =item -s
310
311 Set the default snapshot length to use when capturing live data. 
312 No more than I<snaplen> bytes of each network packet will be read into
313 memory, or saved to disk.
314
315 =item -S
316
317 Decode and display packets even while writing to file.
318
319 =item -t
320
321 Set the format of the packet timestamp printed in summary lines.  The
322 format can be one of 'r' (relative), 'a' (absolute), 'ad' (absolute with
323 date), or 'd' (delta).  The relative time is the time elapsed between
324 the first packet and the current packet.  The absolute time is the
325 actual time the packet was captured, with no date displayed; the
326 absolute date and time is the actual time and date the packet was
327 captured.  The delta time is the time since the previous packet was
328 captured.  The default is relative.
329
330 =item -v
331
332 Print the version and exit.
333
334 =item -V
335
336 Cause B<Tethereal> to print a protocol tree for each packet rather than
337 a one-line summary of the packet.
338
339 =item -w
340
341 Write packet data to I<savefile> or to the standard output if
342 I<savefile> is "-".
343
344 =item -x
345
346 Cause B<Tethereal> to print a hex and ASCII dump of the packet data
347 after printing the summary or protocol tree.
348
349 =item -z
350
351 Get B<Tethereal> to collect various types of statistics and display the result
352 after finishing reading the capture file.
353 Currently implemented statistics are:
354
355 B<-z> dcerpc,rtt,I<uuid>,I<major>.I<minor>[,I<filter>]
356
357 Collect call/reply RTT data for DCERPC interface I<uuid>, 
358 version I<major>.I<minor>.
359 Data collected is number of calls for each procedure, MinRTT, MaxRTT 
360 and AvgRTT. 
361 Example: use B<-z dcerpc,rtt,12345778-1234-abcd-ef00-0123456789ac,1.0> to collect data for CIFS SAMR Interface.  
362 This option can be used multiple times on the command line. 
363
364 If the optional filterstring is provided, the stats will only be calculated
365 on those calls that match that filter.
366 Example: use B<-z dcerpc,rtt,12345778-1234-abcd-ef00-0123456789ac,1.0,ip.addr==1.2.3.4> to collect SAMR
367 RTT statistics for a specific host.
368
369
370 B<-z> io,phs[,I<filter>]
371
372 Create Protocol Hierarchy Statistics listing both number of frames and bytes.
373 If no I<filter> is specified the statistics will be calculated for all frames.
374 If a I<filters> is specified statistics will be only calculated for those
375 packets that match the filter.
376
377 This option can be used multiple times on the command line. 
378
379
380 B<-z> io,stat,I<interval>[,I<filter>][,I<filter>][,I<filter>]...
381
382 Collect frame/bytes statistics for the capture in intervals of I<interval> 
383 seconds. I<Intervals> can be specified either as whole or fractional seconds.
384 Interval can be specified in ms resolution.
385
386 If no I<filter> is specified the statistics will be calculated for all frames.
387 If one or more I<filters> are specified statistics will be calculated for
388 all filters and presented with one column of statistics for each filter.
389
390 This option can be used multiple times on the command line. 
391
392
393 Example: B<-z io,stat,1,ip.addr==1.2.3.4> to generate 1 second
394 statistics for all traffic to/from host 1.2.3.4.
395
396 Example: B<-z "io,stat,0.001,smb&&ip.addr==1.2.3.4"> to generate 1ms
397 statistics for all SMB frames to/from host 1.2.3.4.
398
399 The examples above all use the standard syntax for generating statistics
400 which only calculates the number of frames and bytes in each interval.
401
402
403 io,stat can also do much more statistics and calculate COUNT() SUM() MIN() 
404 MAX() and AVG() using a slightly filter syntax:
405   [COUNT|SUM|MIN|MAX|AVG](<field>)<filter>
406 One important thing to note here is that the field that the calculation is 
407 based on MUST also be part of the filter string or else the calculation will
408 fail.
409
410 So: B<-z io,stat,0.010,AVG(smb.time)> does not work.  Use B<-z
411 io,stat,0.010,AVG(smb.time)smb.time> instead.  Also be aware that a field
412 can exist multiple times inside the same packet and will then be counted
413 multiple times in those packets. 
414
415
416 COUNT(<field>) can be used on any type which has a display filter name. 
417 It will count how many times this particular field is encountered in the
418 filtered packet list.
419
420 Example: B<-z io,stat,0.010,COUNT(smb.sid)smb.sid>
421 This will count the total number of SIDs seen in each 10ms interval.
422
423 SUM(<field>) can only be used on named fields of integer type.
424 This will sum together every occurence of this fields value for each interval.
425
426 Example: B<-z io,stat,0.010,SUM(frame.pkt_len)frame.pkt_len>
427 This will report the total number of bytes seen in all the frames within
428 an interval.
429
430 MIN/MAX/AVG(<field>) can only be used on named fields that are either
431 integers or relative time fields.  This will calculate maximum/minimum
432 or average seen in each interval.  If the field is a relative time field
433 the output will be presented in seconds and three digits after the
434 decimal point.  The resolution for time calculations is 1ms and anything
435 smaller will be truncated.
436
437 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">
438
439 This will calculate statistics for all smb response times we see to/from
440 host 1.1.1.1 in 10ms intervals.  The output will be displayed in 4
441 columns; number of frames/bytes, minimum response time, maximum response
442 time and average response time.
443
444
445
446 B<-z> io,users,I<type>[,I<filter>]
447
448 Create a table that lists all conversations that could be seen in the capture.
449 I<type> specifies which type of conversation we want to generate the 
450 statistics for, currently the supported ones are
451   "eth"   Ethernet
452   "ip"    IP addresses
453   "tcpip" TCP/IP socketpairs
454   "tr"    TokenRing
455   "udpip" UDP/IP socketpairs
456
457 If the optional filter string is specified, only those packets that match the
458 filter will be used in the calculations.
459
460 The table is presented with one line for each conversation and displays
461 number of frames/bytes in each direction as well as total number of 
462 frames/bytes.
463 The table is sorted according to total number of bytes.
464
465
466 B<-z> proto,colinfo,I<filter>,I<field>
467
468 Append all I<field> values for the packet to the COL_INFO information line.
469 This feature can be used to append arbitrary fields to the COL_INFO line
470 in addition to the normal content of the COL_INFO line.
471 I<field> is the display-filter name of a field which value should be placed
472 on the COL_INFO line.
473 I<filter> is a filter string that controls for which packets the field value
474 will be presented on COL_INFO line. I<field> will only be presented on the
475 COL_INFO line for the packets which match I<filter>.
476
477 NOTE: In order for B<Tethereal> to be able to extract the I<field> value
478 from the packet, I<field> MUST be part of the I<filter> string.  If not,
479 B<Tethereal> will not be able to extract its value.
480
481 For a simple example to add the "nfs.fh.hash" field to COL_INFO for all
482 packets containing the "nfs.fh.hash" field, use
483
484 B<-z proto,colinfo,nfs.fh.hash,nfs.fh.hash>
485
486
487 To put "nfs.fh.hash" on COL_INFO but only for packets coming from host 1.2.3.4
488 use :
489
490 B<-z "proto,colinfo,nfs.fh.hash && ip.src==1.2.3.4,nfs.fh.hash">
491
492 This option can be used multiple times on the command line. 
493
494
495 B<-z> rpc,rtt,I<program>,I<version>[,I<filter>]
496
497 Collect call/reply RTT data for I<program>/I<version>.  Data collected
498 is number of calls for each procedure, MinRTT, MaxRTT and AvgRTT. 
499 Example: use B<-z rpc,rtt,100003,3> to collect data for NFS v3.  This
500 option can be used multiple times on the command line. 
501
502 If the optional filterstring is provided, the stats will only be calculated
503 on those calls that match that filter.
504 Example: use B<-z rpc,rtt,100003,3,nfs.fh.hash==0x12345678> to collect NFS v3
505 RTT statistics for a specific file.
506
507
508 B<-z> rpc,programs
509
510 Collect call/reply RTT data for all known ONC-RPC programs/versions.  
511 Data collected is number of calls for each protocol/version, MinRTT, 
512 MaxRTT and AvgRTT. 
513 This option can only be used once on the command line.
514
515 B<-z> smb,rtt[,I<filter>]
516
517 Collect call/reply RTT data for SMB.  Data collected
518 is number of calls for each SMB command, MinRTT, MaxRTT and AvgRTT. 
519 Example: use B<-z smb,rtt>.
520 The data will be presented as separate tables for all normal SMB commands,
521 all Transaction2 commands and all NT Transaction commands.
522 Only those commands that are seen in the capture will have its stats
523 displayed.
524 Only the first command in a xAndX command chain will be used in the
525 calculation.  So for common SessionSetupAndX + TreeConnectAndX chains,
526 only the SessionSetupAndX call will be used in the statistics.
527 This is a flaw that might be fixed in the future.
528
529 This option can be used multiple times on the command line. 
530
531 If the optional filterstring is provided, the stats will only be calculated
532 on those calls that match that filter.
533 Example: use B<-z "smb,rtt,ip.addr==1.2.3.4"> to only collect stats for
534 SMB packets echanged by the host at IP address 1.2.3.4 .
535
536 B<-z> smb,sids
537
538 When this feature is used B<Tethereal> will print a report with all the
539 discovered SID and account name mappings.  Only those SIDs where the
540 account name is known will be presented in the table.
541
542 For this feature to work you will need to either to enable
543 "Edit/Preferences/Protocols/SMB/Snoop SID to name mappings" in the
544 preferences or you can override the preferences by specifying
545 B<-o "smb.sid_name_snooping:TRUE"> on the B<Tethereal> command line.
546
547 The current methods used by B<Tethereal> to find the SID->name mapping
548 is relatively restricted but is hoped to be expanded in the future.
549
550 B<-z> mgcp,rtd[I<,filter>]
551
552 Collect requests/response RTD (Response Time Delay) data for MGCP. 
553 This is similar to B<-z smb,rtt>). Data collected is number of calls
554 for each known MGCP Type, MinRTD, MaxRTD and AvgRTD.
555 Additionally you get the number of duplicate requests/responses, 
556 unresponded requests, responses ,which don't match with
557 any request. 
558 Example: use B<-z mgcp,rtd>.
559
560 This option can be used multiple times on the command line. 
561
562 If the optional filterstring is provided, the stats will only be calculated
563 on those calls that match that filter.
564 Example: use B<-z "mgcp,rtd,ip.addr==1.2.3.4"> to only collect stats for
565 MGCP packets exchanged by the host at IP address 1.2.3.4 .
566
567 =back
568
569 =head1 CAPTURE FILTER SYNTAX
570
571 See manual page of tcpdump(8).
572
573 =head1 READ FILTER SYNTAX
574
575 Read filters help you remove the noise from a packet trace and let you
576 see only the packets that interest you.  If a packet meets the
577 requirements expressed in your read filter, then it is printed.  Read
578 filters let you compare the fields within a protocol against a specific
579 value, compare fields against fields, and to check the existence of
580 specified fields or protocols.
581
582 The simplest read filter allows you to check for the existence of a
583 protocol or field.  If you want to see all packets which contain the IPX
584 protocol, the filter would be "ipx".  (Without the quotation marks) To
585 see all packets that contain a Token-Ring RIF field, use "tr.rif".
586
587 Fields can also be compared against values.  The comparison operators
588 can be expressed either through C-like symbols, or through English-like
589 abbreviations:
590
591     eq, ==    Equal
592     ne, !=    Not equal
593     gt, >     Greater than
594     lt, <     Less Than
595     ge, >=    Greater than or Equal to
596     le, <=    Less than or Equal to
597
598 Furthermore, each protocol field is typed. The types are:
599
600     Unsigned integer (either 8-bit, 16-bit, 24-bit, or 32-bit)
601     Signed integer (either 8-bit, 16-bit, 24-bit, or 32-bit)
602     Boolean
603     Ethernet address (6 bytes)
604     Byte string (n-number of bytes)
605     IPv4 address
606     IPv6 address
607     IPX network number
608     String (text)
609     Double-precision floating point number
610
611 An integer may be expressed in decimal, octal, or hexadecimal notation. 
612 The following three read filters are equivalent:
613
614     frame.pkt_len > 10
615     frame.pkt_len > 012
616     frame.pkt_len > 0xa
617
618 Boolean values are either true or false.  In a read filter expression
619 testing the value of a Boolean field, "true" is expressed as 1 or any
620 other non-zero value, and "false" is expressed as zero.  For example, a
621 token-ring packet's source route field is boolean.  To find any
622 source-routed packets, a read filter would be:
623
624     tr.sr == 1
625
626 Non source-routed packets can be found with:
627
628     tr.sr == 0
629
630 Ethernet addresses, as well as a string of bytes, are represented in hex
631 digits.  The hex digits may be separated by colons, periods, or hyphens:
632
633     fddi.dst eq ff:ff:ff:ff:ff:ff
634     ipx.srcnode == 0.0.0.0.0.1
635     eth.src == aa-aa-aa-aa-aa-aa
636
637 If a string of bytes contains only one byte, then it is represented as
638 an unsigned integer.  That is, if you are testing for hex value 'ff' in
639 a one-byte byte-string, you must compare it agains '0xff' and not 'ff'. 
640
641 IPv4 addresses can be represented in either dotted decimal notation, or
642 by using the hostname:
643
644     ip.dst eq www.mit.edu
645     ip.src == 192.168.1.1
646
647 IPv4 addresses can be compared with the same logical relations as numbers:
648 eq, ne, gt, ge, lt, and le.  The IPv4 address is stored in host order,
649 so you do not have to worry about how the endianness of an IPv4 address
650 when using it in a read filter.
651
652 Classless InterDomain Routing (CIDR) notation can be used to test if an
653 IPv4 address is in a certain subnet.  For example, this display filter
654 will find all packets in the 129.111 Class-B network:
655
656     ip.addr == 129.111.0.0/16
657
658 Remember, the number after the slash represents the number of bits used
659 to represent the network.  CIDR notation can also be used with
660 hostnames, in this example of finding IP addresses on the same Class C
661 network as 'sneezy':
662
663     ip.addr eq sneezy/24
664
665 The CIDR notation can only be used on IP addresses or hostnames, not in
666 variable names.  So, a display filter like "ip.src/24 == ip.dst/24" is
667 not valid.  (yet)
668
669 IPX networks are represented by unsigned 32-bit integers.  Most likely
670 you will be using hexadecimal when testing for IPX network values:
671
672     ipx.srcnet == 0xc0a82c00
673
674 A slice operator also exists.  You can check the substring
675 (byte-string) of any protocol or field.  For example, you can filter on
676 the vendor portion of an ethernet address (the first three bytes) like
677 this:
678
679     eth.src[0:3] == 00:00:83
680
681 If the length of your byte-slice is only one byte, then it is still
682 represented in hex, but without the preceding "0x": 
683
684     llc[3] == aa
685
686 You can use the slice operator on a protocol name, too.  And
687 remember, the "frame" protocol encompasses the entire packet, allowing
688 you to look at the nth byte of a packet regardless of its frame type
689 (Ethernet, token-ring, etc.).
690
691     token[0:5] ne 0.0.0.1.1
692     ipx[0:2] == ff:ff
693     llc[3:1] eq 0xaa
694
695 The following syntax governs slices:
696
697         [i:j]   i = start_offset, j = length
698         [i-j]   i = start_offset, j = end_offset, inclusive.
699         [i]     i = start_offset, length = 1
700         [:j]    start_offset = 0, length = j
701         [i:]    start_offset = i, end_offset = end_of_field
702
703 Offsets and lengths can be negative, in which case they indicate the
704 offset from the B<end> of the field.  Here's how to check the last 4
705 bytes of a frame:
706
707     frame[-4:4] == 0.1.2.3
708
709 or
710
711     frame[-4:] == 0.1.2.3
712
713 You can create complex concatenations of slices using the comma operator:
714
715         field[1,3-5,9:] == 01:03:04:05:09:0a:0b
716
717 All the above tests can be combined together with logical expressions. 
718 These too are expressable in C-like syntax or with English-like
719 abbreviations:
720
721     and, &&   Logical AND
722     or, ||    Logical OR
723     not, !    Logical NOT
724
725 Expressions can be grouped by parentheses as well.  The following are
726 all valid read filter expression:
727
728     tcp.port == 80 and ip.src == 192.168.2.1
729     not llc
730     (ipx.srcnet == 0xbad && ipx.srnode == 0.0.0.0.0.1) || ip
731     tr.dst[0:3] == 0.6.29 xor tr.src[0:3] == 0.6.29
732
733 A special caveat must be given regarding fields that occur more than
734 once per packet.  "ip.addr" occurs twice per IP packet, once for the
735 source address, and once for the destination address.  Likewise,
736 tr.rif.ring fields can occur more than once per packet.  The following
737 two expressions are not equivalent:
738
739         ip.addr ne 192.168.4.1
740     not ip.addr eq 192.168.4.1
741
742 The first filter says "show me IP packets where an ip.addr exists that
743 does not equal 192.168.4.1".  That is, as long as one ip.addr in the
744 packet does not equal 192.168.44.1, the packet passes the read
745 filter.  The second filter "don't show me any packets that have at least
746 one ip.addr field equal to 192.168.4.1".  If one ip.addr is 192.168.4.1,
747 the packet does not pass.  If B<neither> ip.addr fields is 192.168.4.1,
748 then the packet passes.
749
750 It is easy to think of the 'ne' and 'eq' operators as having an implict
751 "exists" modifier when dealing with multiply-recurring fields.  "ip.addr
752 ne 192.168.4.1" can be thought of as "there exists an ip.addr that does
753 not equal 192.168.4.1".
754
755 Be careful with multiply-recurring fields; they can be confusing.
756
757 Care must also be taken when using the read filter to remove noise
758 from the packet trace. If you want to e.g. filter out all IP multicast
759 packets to address 224.1.2.3, then using:
760
761     ip.dst ne 224.1.2.3
762
763 may be too restrictive. Filtering with "ip.dst" selects only those
764 B<IP> packets that satisfy the rule. Any other packets, including all
765 non-IP packets, will not be printed. For printing also the non-IP
766 packets, you can use one of the following two expressions:
767
768     not ip or ip.dst ne 224.1.2.3
769     not ip.addr eq 224.1.2.3
770
771 The first filter uses "not ip" to include all non-IP packets and then
772 lets "ip.dst ne 224.1.2.3" to filter out the unwanted IP packets. The
773 second filter has already been explained above where filtering with
774 multiply occuring fields was discussed.
775
776 The following is a table of protocol and protocol fields that are
777 filterable in B<Tethereal>.  The abbreviation of the protocol or field is
778 given.  This abbreviation is what you use in the read filter.  The
779 type of the field is also given.
780
781 =insert_dfilter_table
782
783 =head1 FILES
784
785 The F<ethereal.conf> file, which is installed in the F<etc> directory
786 under the main installation directory (for example, F</usr/local/etc>)
787 on UNIX-compatible systems, and in the main installation directory (for
788 example, F<C:\Program Files\Ethereal>) on Windows systems, and the
789 personal preferences file, which is F<$HOME/.ethereal/preferences> on
790 UNIX-compatible systems and F<%APPDATA%\Ethereal\preferences> (or, if
791 %APPDATA% isn't defined,
792 F<%USERPROFILE%\Application Data\Ethereal\preferences>) on
793 Windows systems, contain system-wide and personal preference settings,
794 respectively.  The file contains preference settings of the form
795 I<prefname>B<:>I<value>, one per line, where I<prefname> is the name of
796 the preference (which is the same name that would appear in the
797 preference file), and I<value> is the value to which it should be set;
798 white space is allowed between B<:> and I<value>.  A preference setting
799 can be continued on subsequent lines by indenting the continuation lines
800 with white space.  A B<#> character starts a comment that runs to the
801 end of the line.
802
803 The system-wide preference file is read first, if it exists, overriding
804 B<Tethereal>'s default values; the personal preferences file is then
805 read, if it exists, overriding default values and values read from the
806 system-wide preference file.
807
808 The F<ethers> file, which is found in the F</etc> directory on
809 UNIX-compatible systems, and in the main installation directory (for
810 example, F<C:\Program Files\Ethereal>) on Windows systems, is consulted
811 to correlate 6-byte hardware addresses to names.  If an address is not
812 found in the F<ethers> file, the F<$HOME/.ethereal/ethers> file on
813 UNIX-compatible systems, and the F<%APPDATA%\Ethereal\ethers> file (or, if
814 %APPDATA% isn't defined, the
815 F<%USERPROFILE%\Application Data\Ethereal\ethers> file) on Windows
816 systems is consulted next.  Each line contains one hardware
817 address and name, separated by whitespace.  The digits of the hardware
818 address are separated by either a colon (:), a dash (-), or a period
819 (.).  The following three lines are valid lines of an ethers file:
820
821   ff:ff:ff:ff:ff:ff          Broadcast
822   c0-00-ff-ff-ff-ff          TR_broadcast
823   00.00.00.00.00.00          Zero_broadcast
824
825 The F<manuf> file, which is installed in the F<etc> directory under the
826 main installation directory (for example, F</usr/local/etc>) on
827 UNIX-compatible systems, and in the main installation directory (for
828 example, F<C:\Program Files\Ethereal>) on Windows systems, matches the
829 3-byte vendor portion of a 6-byte hardware address with the
830 manufacturer's name; it can also contain well-known MAC addresses and
831 address ranges specified with a netmask.  The format of the file is the
832 same as the F<ethers> file, except that entries of the form
833
834   00:00:0C      Cisco
835
836 can be provided, with the 3-byte OUI and the name for a vendor, and
837 entries of the form
838
839   00-00-0C-07-AC/40     All-HSRP-routers
840
841 can be specified, with a MAC address and a mask indicating how many bits
842 of the address must match.  Trailing zero bytes can be omitted from
843 address ranges.  That entry, for example, will match addresses from
844 00-00-0C-07-AC-00 through 00-00-0C-07-AC-FF.  The mask need not be a
845 multiple of 8.
846
847 The F<ipxnets> file, which is found in the F</etc> directory on
848 UNIX-compatible systems, and in the main installation directory (for
849 example, F<C:\Program Files\Ethereal>) on Windows systems, correlates
850 4-byte IPX network numbers to names.  If a network number is not found
851 in the F<ipxnets> file, the F<$HOME/.ethereal/ipxnets> file on
852 UNIX-compatible systems, and the F<%APPDATA%\Ethereal\ipxnets> file (or,
853 if %APPDATA% isn't defined, the
854 F<%USERPROFILE%\Application Data\Ethereal\ipxnets> file)
855 on Windows systems, is consulted next.  The format is the same as the
856 F<ethers> file, except that each address if four bytes instead of six. 
857 Additionally, the address can be represented a single hexadecimal
858 number, as is more common in the IPX world, rather than four hex octets. 
859 For example, these four lines are valid lines of an ipxnets file.
860
861   C0.A8.2C.00              HR
862   c0-a8-1c-00              CEO
863   00:00:BE:EF              IT_Server1
864   110f                     FileServer3
865
866 =head1 SEE ALSO
867
868 I<ethereal(1)>, I<editcap(1)>, I<tcpdump(8)>, I<pcap(3)>
869
870 =head1 NOTES
871
872 B<Tethereal> is part of the B<Ethereal> distribution.  The latest version
873 of B<Ethereal> can be found at B<http://www.ethereal.com>.
874
875 =head1 AUTHORS
876
877 B<Tethereal> uses the same packet dissection code that B<Ethereal> does,
878 as well as using many other modules from B<Ethereal>; see the list of
879 authors in the B<Ethereal> man page for a list of authors of that code.