Docs updated for ethereal-0.6.0
[metze/wireshark/wip.git] / README
1 General Information
2 ------- -----------
3
4 Ethereal is a network traffic analyzer for Unix and Unix-like operating
5 systems.  It is based on GTK+, a graphical user interface library,
6 and libpcap, a packet capture and filtering library.
7
8 The official home of Ethereal is
9
10     http://ethereal.zing.org
11
12 The latest distribution can be found in the subdirectory
13
14     http://ethereal.zing.org/distribution
15
16 Interesting and exotic packet traces can be found at
17
18     http://ethereal.zing.org/~gram/sample.html
19
20
21 Installation
22 ------------
23
24 Ethereal is known to compile and run on the following systems:
25
26   - Linux (2.0.x, 2.1.x, 2.2.x)
27   - Solaris (2.5.1, 2.6)
28   - FreeBSD (2.2.5, 2.2.6)
29   - Sequent PTX v4.4.5  (Nick Williams <njw@sequent.com>)
30
31 It should run on other systems without too much trouble.
32
33
34 Full installation instructions can be found in the INSTALL file.
35          
36
37 Usage
38 -----          
39
40 In order to capture packets from the network, you need to be running
41 as root, or have access to the appropriate entry under /dev if your
42 system is so inclined (BSD-derived systems and Solaris typically fall
43 into this category.  Although it might be tempting to make the
44 Ethereal executable setuid root, please don't - alpha code is by nature
45 not very robust, and liable to contain security holes.
46
47 Please consult the man page for a description of each command-line
48 option and interface feature.
49
50
51 Multiple File Types
52 -------------------
53
54 The wiretap library is a packet-capture library currently under
55 development parallel to ethereal.  In the future it is hoped that
56 wiretap will have more features than libpcap, but wiretap is still in
57 its infancy.  You can compile ethereal with the wiretap library by using
58 './configure --with-wiretap'.  Using wiretap will allow you to read
59 libpcap, Sniffer, NetXray (and Sniffer Pro), Sun "snoop", LANalyzer,
60 Microsoft Network Monitor, and AIX "iptrace" 2.0 trace files. Some minimal
61 display filters now work. But because "Follow TCP Stream" relies on IP and TCP
62 display filtering, and those aren't yet available in wiretap's display filter
63 system, "Follow TCP Stream" is turned off when you compile --with-wiretap.
64
65 You can still capture packets from within ethereal using libpcap, and therefore
66 use libpcap-style capture filters, however.
67
68 If you want to add support for other packet-capture file formats, please
69 look at the wiretap source code in the wiretap directory.
70
71 Please report any problems that are wiretap related to
72 Gilbert Ramirez <gram@verdict.uthscsa.edu>.
73
74
75 IPv6
76 ----
77 If your operating system includes IPv6 support, ethereal will attempt to
78 use reverse name resolution capabilities when decoding IPv6 packets. If
79 you want to turn off name resolution while using ethereal, start ethereal
80 with the "-n" option. If you would like to compile ethereal without
81 support for IPv6 name resolution, use the "--disable-ipv6" option with
82 "./configure". If you compile ethereal without IPv6 name resolution,
83 you will still be able to decode IPv6 packets, but you'll only see IPv6
84 addresses, not host names.
85
86 The "Follow TCP Stream" feature only supports TCP over IPv4. Support for TCP
87 over IPv6 is planned.
88
89
90 Disclaimer
91 ----------
92
93 There is no warranty, expressed or implied, associated with this product.
94 Use at your own risk.
95
96
97 Gerald Combs <gerald@zing.org>
98 Gilbert Ramirez <gram@verdict.uthscsa.edu>