36bd150fd217c1a1b702f7bff290da4ecddcfa1e
[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<-c> count ]>
10 S<[ B<-D> ]>
11 S<[ B<-f> capture filter expression ]>
12 S<[ B<-F> file format ]>
13 S<[ B<-h> ]>
14 S<[ B<-i> interface ]> 
15 S<[ B<-l> ]>
16 S<[ B<-n> ]>
17 S<[ B<-N> resolving flags ] ...>
18 S<[ B<-o> preference setting ] ...>
19 S<[ B<-p> ]>
20 S<[ B<-r> infile ]>
21 S<[ B<-R> display filter expression ]>
22 S<[ B<-s> snaplen ]>
23 S<[ B<-t> time stamp format ]>
24 S<[ B<-v> ]>
25 S<[ B<-V> ]>
26 S<[ B<-w> savefile ]>
27 S<[ B<-x> ]>
28 S<[ filter expression ]>
29
30 =head1 DESCRIPTION
31
32 B<Tethereal> is a network protocol analyzer.  It lets you capture packet
33 data from a live network, or read packets from a previously saved
34 capture file, either printing a decoded form of those packets to the
35 standard output or writing the packets to a file.  B<Tethereal> knows
36 how to read B<libpcap> capture files, including those of B<tcpdump>.  In
37 addition, B<Tethereal> can read capture files from B<snoop> (including
38 B<Shomiti>) and B<atmsnoop>, B<LanAlyzer>, B<Sniffer> (compressed or
39 uncompressed), Microsoft B<Network Monitor>, AIX's B<iptrace>,
40 B<NetXray>, B<Sniffer Pro>, B<Etherpeek>, B<RADCOM>'s WAN/LAN analyzer,
41 B<Lucent/Ascend> router debug output, HP-UX's B<nettl>, the dump output
42 from B<Toshiba's> ISDN routers, the output from B<i4btrace> from the
43 ISDN4BSD project, and output in IPLog format from the Cisco Secure
44 Intrusion Detection System.  There is no need to tell B<Tethereal> what
45 type of file you are reading; it will determine the file type by itself. 
46 B<Tethereal> is also capable of reading any of these file formats if
47 they are compressed using gzip.  B<Tethereal> recognizes this directly
48 from the file; the '.gz' extension is not required for this purpose.
49
50 If the B<-w> flag is not specified, B<Tethereal> prints a decoded form
51 of the packets it captures or reads; otherwise, it writes those packets
52 to the file specified by that flag.
53
54 When printing a decoded form of packets, B<Tethereal> prints, by
55 default, a summary line containing the fields specified by the
56 preferences file (which are also the fields displayed in the packet list
57 pane in B<Ethereal>), although if it's printing packets as it captures
58 them, rather than printing packets from a saved capture file, it won't
59 print the "frame number" field.  If the B<-V> flag is specified, it
60 prints intead a protocol tree, showing all the fields of all protocols
61 in the packet.
62
63 When writing packets to a file, B<Tethereal>, by default, writes the
64 file in B<libpcap> format, and writes all of the packets it sees to the
65 output file.  The B<-F> flag can be used to specify the format in which
66 to write the file; it can write the file in B<libpcap> format (standard
67 B<libpcap> format, a modified format used by some patched versions of
68 B<libpcap>, or the format used by Red Hat Linux 6.1), B<snoop> format,
69 uncompressed B<Sniffer> format, Microsoft B<Network Monitor> 1.x format,
70 and the format used by Windows-based versions of the B<Sniffer>
71 software.
72
73 Read filters in B<Tethereal>, which allow you to select which packets
74 are to be decoded or written to a file, are very powerful; more fields
75 are filterable in B<Tethereal> than in other protocol analyzers, and the
76 syntax you can use to create your filters is richer.  As B<Tethereal>
77 progresses, expect more and more protocol fields to be allowed in read
78 filters.
79
80 Packet capturing is performed with the pcap library.  The capture filter
81 syntax follows the rules of the pcap library.  This syntax is different
82 from the read filter syntax.  A read filter can also be specified when
83 capturing, and only packets that pass the read filter will be displayed
84 or saved to the output file; note, however, that capture filers are much
85 more efficient than read filters, and it may be more difficult for
86 B<Tethereal> to keep up with a busy network if a read filter is
87 specified for a live capture.
88
89 Compressed file support uses (and therefore requires) the zlib library. 
90 If the zlib library is not present, B<Tethereal> will compile, but will
91 be unable to read compressed files.
92
93 A capture or read filter can either be specified with the B<-f> or B<-R>
94 option, respectively, in which case the entire filter expression must be
95 specified as a single argument (which means that if it contains spaces,
96 it must be quoted), or can be specified with command-line arguments
97 after the option arguments, in which case all the arguments after the
98 filter arguments are treated as a filter expression.  If the filter is
99 specified with command-line arguments after the option arguments, it's a
100 capture filter if a capture is being done (i.e., if no B<-r> flag was
101 specified) and a read filter if a capture file is being read (i.e., if a
102 B<-r> flag was specified).
103
104 =head1 OPTIONS
105
106 =over 4
107
108 =item -c
109
110 Sets the default number of packets to read when capturing live
111 data.
112
113 =item -D
114
115 Prints a list of the interfaces on which B<Tethereal> can capture, and
116 exits.  Note that "can capture" means that B<Tethereal> was able to open
117 that device to do a live capture; if, on your system, a program doing a
118 network capture must be run from an account with special privileges (for
119 example, as root), then, if B<Tethereal> is run with the B<-D> flag and
120 is not run from such an account, it will not list any interfaces.
121
122 =item -f
123
124 Sets the capture filter expression.
125
126 =item -F
127
128 Sets the file format of the output capture file.
129
130 =item -h
131
132 Prints the version and options and exits.
133
134 =item -i
135
136 Sets the name of the network interface to use for live packet capture. 
137 It should match one of the names listed in "B<netstat -i>" or
138 "B<ifconfig -a>".  If no interface is specified, B<Tethereal> searches
139 the list of interfaces, choosing the first non-loopback interface if
140 there are any non-loopback interfaces, and choosing the first loopback
141 interface if there are no non-loopback interfaces; if there are no
142 interfaces, B<Tethereal> reports an error and doesn't start the capture.
143
144 =item -l
145
146 Flush the standard output after the information for each packet is
147 printed.  (This is not, strictly speaking, line-buffered if B<-V>
148 was specified; however, it is the same as line-buffered if B<-V> wasn't
149 specified, as only one line is printed for each packet, and, as B<-l> is
150 normally used when piping a live capture to a program or script, so that
151 output for a packet shows up as soon as the packet is seen and
152 dissected, it should work just as well as true line-buffering.  We do
153 this as a workaround for a deficiency in the Microsoft Visual C++ C
154 library.)
155
156 This may be useful when piping the output of B<Tethereal> to another
157 program, as it means that the program to which the output is piped will
158 see the dissected data for a packet as soon as B<Tethereal> sees the
159 packet and generates that output, rather than seeing it only when the
160 standard output buffer containing that data fills up.
161
162 =item -n
163
164 Disables network object name resolution (such as hostname, TCP and UDP port
165 names).
166
167 =item -N
168
169 Turns on name resolving for particular types of addresses and port
170 numbers; the argument is a string that may contain the letters B<m> to
171 enable MAC address resolution, B<n> to enable network address
172 resolution, and B<t> to enable transport-layer port number resolution. 
173 This overrides B<-n> if both B<-N> and B<-n> are present.
174
175 =item -o
176
177 Sets a preference value, overriding the default value and any value read
178 from a preference file.  The argument to the flag is a string of the
179 form I<prefname>B<:>I<value>, where I<prefname> is the name of the
180 preference (which is the same name that would appear in the preference
181 file), and I<value> is the value to which it should be set.
182
183 =item -p
184
185 I<Don't> put the interface into promiscuous mode.  Note that the
186 interface might be in promiscuous mode for some other reason; hence,
187 B<-p> cannot be used to ensure that the only traffic that is captured is
188 traffic sent to or from the machine on which B<Tethereal> is running,
189 broadcast traffic, and multicast traffic to addresses received by that
190 machine.
191
192 =item -r
193
194 Reads packet data from I<file>.
195
196 =item -R
197
198 Causes the specified filter (which uses the syntax of read filters,
199 rather than that of capture filters) to be applied before printing a
200 decoded form of packets or writing packets to a file; packets not
201 matching the filter are discarded rather than being printed or written.
202
203 =item -s
204
205 Sets the default snapshot length to use when capturing live data. 
206 No more than I<snaplen> bytes of each network packet will be read into
207 memory, or saved to disk.
208
209 =item -t
210
211 Sets the format of the packet timestamp printed in summary lines.  The
212 format can be one of 'r' (relative), 'a' (absolute), 'ad' (absolute with
213 date), or 'd' (delta).  The relative time is the time elapsed between
214 the first packet and the current packet.  The absolute time is the
215 actual time the packet was captured, with no date displayed; the
216 absolute date and time is the actual time and date the packet was
217 captured.  The delta time is the time since the previous packet was
218 captured.  The default is relative.
219
220 =item -v
221
222 Prints the version and exits.
223
224 =item -V
225
226 Causes B<Tethereal> to print a protocol tree for each packet rather than
227 a one-line summary of the packet.
228
229 =item -w
230
231 Writes packet data to I<savefile>.
232
233 =item -x
234
235 Causes B<Tethereal> to print a hex and ASCII dump of the packet data
236 after printing the summary or protocol tree.
237
238 =back
239
240 =head1 CAPTURE FILTER SYNTAX
241
242 See manual page of tcpdump(8).
243
244 =head1 READ FILTER SYNTAX
245
246 Read filters help you remove the noise from a packet trace and let you
247 see only the packets that interest you.  If a packet meets the
248 requirements expressed in your read filter, then it is printed.  Read
249 filters let you compare the fields within a protocol against a specific
250 value, compare fields against fields, and to check the existence of
251 specified fields or protocols.
252
253 The simplest read filter allows you to check for the existence of a
254 protocol or field.  If you want to see all packets which contain the IPX
255 protocol, the filter would be "ipx".  (Without the quotation marks) To
256 see all packets that contain a Token-Ring RIF field, use "tr.rif".
257
258 Fields can also be compared against values.  The comparison operators
259 can be expressed either through C-like symbols, or through English-like
260 abbreviations:
261
262     eq, ==    Equal
263     ne, !=    Not equal
264     gt, >     Greater than
265     lt, <     Less Than
266     ge, >=    Greater than or Equal to
267     le, <=    Less than or Equal to
268
269 Furthermore, each protocol field is typed. The types are:
270
271     Unsigned integer (either 8-bit, 16-bit, 24-bit, or 32-bit)
272     Signed integer (either 8-bit, 16-bit, 24-bit, or 32-bit)
273     Boolean
274     Ethernet address (6 bytes)
275     Byte string (n-number of bytes)
276     IPv4 address
277     IPv6 address
278     IPX network number
279     String (text)
280     Double-precision floating point number
281
282 An integer may be expressed in decimal, octal, or hexadecimal notation. 
283 The following three read filters are equivalent:
284
285     frame.pkt_len > 10
286     frame.pkt_len > 012
287     frame.pkt_len > 0xa
288
289 Boolean values are either true or false.  In a read filter expression
290 testing the value of a Boolean field, "true" is expressed as 1 or any
291 other non-zero value, and "false" is expressed as zero.  For example, a
292 token-ring packet's source route field is boolean.  To find any
293 source-routed packets, a read filter would be:
294
295     tr.sr == 1
296
297 Non source-routed packets can be found with:
298
299     tr.sr == 0
300
301 Ethernet addresses, as well as a string of bytes, are represented in hex
302 digits.  The hex digits may be separated by colons, periods, or hyphens:
303
304     fddi.dst eq ff:ff:ff:ff:ff:ff
305     ipx.srcnode == 0.0.0.0.0.1
306     eth.src == aa-aa-aa-aa-aa-aa
307
308 If a string of bytes contains only one byte, then it is represented as
309 an unsigned integer.  That is, if you are testing for hex value 'ff' in
310 a one-byte byte-string, you must compare it agains '0xff' and not 'ff'. 
311
312 IPv4 addresses can be represented in either dotted decimal notation, or
313 by using the hostname:
314
315     ip.dst eq www.mit.edu
316     ip.src == 192.168.1.1
317
318 IPv4 addresses can be compared with the same logical relations as numbers:
319 eq, ne, gt, ge, lt, and le.  The IPv4 address is stored in host order,
320 so you do not have to worry about how the endianness of an IPv4 address
321 when using it in a read filter.
322
323 Classless InterDomain Routing (CIDR) notation can be used to test if an
324 IPv4 address is in a certain subnet.  For example, this display filter
325 will find all packets in the 129.111 Class-B network:
326
327     ip.addr == 129.111.0.0/16
328
329 Remember, the number after the slash represents the number of bits used
330 to represent the network.  CIDR notation can also be used with
331 hostnames, in this example of finding IP addresses on the same Class C
332 network as 'sneezy':
333
334     ip.addr eq sneezy/24
335
336 The CIDR notation can only be used on IP addresses or hostnames, not in
337 variable names.  So, a display filter like "ip.src/24 == ip.dst/24" is
338 not valid.  (yet)
339
340 IPX networks are represented by unsigned 32-bit integers.  Most likely
341 you will be using hexadecimal when testing for IPX network values:
342
343     ipx.srcnet == 0xc0a82c00
344
345 A slice operator also exists.  You can check the substring
346 (byte-string) of any protocol or field.  For example, you can filter on
347 the vendor portion of an ethernet address (the first three bytes) like
348 this:
349
350     eth.src[0:3] == 00:00:83
351
352 If the length of your byte-slice is only one byte, then it is still
353 represented in hex, but without the preceding "0x": 
354
355     llc[3] == aa
356
357 You can use the slice operator on a protocol name, too.  And
358 remember, the "frame" protocol encompasses the entire packet, allowing
359 you to look at the nth byte of a packet regardless of its frame type
360 (Ethernet, token-ring, etc.).
361
362     token[0:5] ne 0.0.0.1.1
363     ipx[0:2] == ff:ff
364     llc[3:1] eq 0xaa
365
366 The following syntax governs slices:
367
368         [i:j]   i = start_offset, j = length
369         [i-j]   i = start_offet, j = end_offset, inclusive.
370         [i]     i = start_offset, length = 1
371         [:j]    start_offset = 0, length = j
372         [i:]    start_offset = i, end_offset = end_of_field
373
374 Offsets and lengths can be negative, in which case they indicate the
375 offset from the B<end> of the field.  Here's how to check the last 4
376 bytes of a frame:
377
378     frame[-4:4] == 0.1.2.3
379
380 or
381
382     frame[-4:] == 0.1.2.3
383
384 You can create complex concatenations of slices using the comma operator:
385
386         field[1,3-5,9:] == 01:03:04:05:09:0a:0b
387
388 All the above tests can be combined together with logical expressions. 
389 These too are expressable in C-like syntax or with English-like
390 abbreviations:
391
392     and, &&   Logical AND
393     or, ||    Logical OR
394     not, !    Logical NOT
395
396 Expressions can be grouped by parentheses as well.  The following are
397 all valid read filter expression:
398
399     tcp.port == 80 and ip.src == 192.168.2.1
400     not llc
401     (ipx.srcnet == 0xbad && ipx.srnode == 0.0.0.0.0.1) || ip
402     tr.dst[0:3] == 0.6.29 xor tr.src[0:3] == 0.6.29
403
404 A special caveat must be given regarding fields that occur more than
405 once per packet.  "ip.addr" occurs twice per IP packet, once for the
406 source address, and once for the destination address.  Likewise,
407 tr.rif.ring fields can occur more than once per packet.  The following
408 two expressions are not equivalent:
409
410         ip.addr ne 192.168.4.1
411     not ip.addr eq 192.168.4.1
412
413 The first filter says "show me all packets where an ip.addr exists that
414 does not equal 192.168.4.1".  That is, as long as one ip.addr in the
415 packet does not equal 192.168.44.1, the packet passes the display
416 filter.  The second filter "don't show me any packets that have at least
417 one ip.addr field equal to 192.168.4.1".  If one ip.addr is 192.168.4.1,
418 the packet does not pass.  If B<neither> ip.addr fields is 192.168.4.1,
419 then the packet passes.
420
421 It is easy to think of the 'ne' and 'eq' operators as having an implict
422 "exists" modifier when dealing with multiply-recurring fields.  "ip.addr
423 ne 192.168.4.1" can be thought of as "there exists an ip.addr that does
424 not equal 192.168.4.1".
425
426 Be careful with multiply-recurring fields; they can be confusing.
427
428 The following is a table of protocol and protocol fields that are
429 filterable in B<Tethereal>.  The abbreviation of the protocol or field is
430 given.  This abbreviation is what you use in the read filter.  The
431 type of the field is also given.
432
433 =insert_dfilter_table
434
435 =head1 FILES
436
437 F</usr/local/etc/ethereal.conf> and F<$HOME/.ethereal/preferences>
438 contain system-wide and personal preference settings, respectively.  The
439 file contains preference settings of the form I<prefname>B<:>I<value>,
440 one per line, where I<prefname> is the name of the preference (which is
441 the same name that would appear in the preference file), and I<value> is
442 the value to which it should be set; white space is allowed between B<:>
443 and I<value>.  A preference setting can be continued on subsequent lines
444 by indenting the continuation lines with white space.  A B<#> character
445 starts a comment that runs to the end of the line.
446
447 The system-wide preference file is read first, if it exists, overriding
448 B<Tethereal>'s default values; the personal preferences file is then
449 read, if it exists, overriding default values and values read from the
450 system-wide preference file.
451
452 F</etc/ethers> is consulted to correlate 6-byte hardware addresses to
453 names.  If an address is not found in F</etc/ethers>, the
454 F<$HOME/.ethereal/ethers> file is consulted next.  Each line contains
455 one hardware address and name, separated by whitespace.  The digits of
456 the hardware address are separated by either a colon (:), a dash (-), or
457 a period (.).  The following three lines are valid lines of an ethers
458 file:
459
460   ff:ff:ff:ff:ff:ff          Broadcast
461   c0-00-ff-ff-ff-ff          TR_broadcast
462   00.00.00.00.00.00          Zero_broadcast
463
464 F</usr/local/etc/manuf> matches the 3-byte vendor portion of a 6-byte
465 hardware address with the manufacturer's name.  The format of the file
466 is the same as the F</etc/ethers> file, except that each address is
467 three bytes instead of six.
468
469 F</etc/ipxnets> and F<$HOME/.ethereal/ipxnets> correlate 4-byte IPX
470 network numbers to names.  The format is the same as the F</etc/ethers>
471 file, except that each address if four bytes instead of six. 
472 Additionally, the address can be represented a single hexadecimal
473 number, as is more common in the IPX world, rather than four hex octets. 
474 For example, these four lines are valid lines of an ipxnets file.
475
476   C0.A8.2C.00              HR
477   c0-a8-1c-00              CEO
478   00:00:BE:EF              IT_Server1
479   110f                     FileServer3
480
481 =head1 SEE ALSO
482
483 L<ethereal(1)>, L<editcap(1)>, L<tcpdump(8)>, L<pcap(3)>
484
485 =head1 NOTES
486
487 B<Tethereal> is part of the B<Ethereal> distribution.  The latest version
488 of B<Ethereal> can be found at B<http://www.ethereal.com>.
489
490 =head1 AUTHORS
491
492 B<Tethereal> uses the same packet dissection code that B<Ethereal> does,
493 as well as using many other modules from B<Ethereal>; see the list of
494 authors in the B<Ethereal> man page for a list of authors of that code.