Fix a typo, and just say that "ethereal -v" indicates the versions of
[metze/wireshark/wip.git] / README
1 General Information
2 ------- -----------
3
4 Ethereal is a network traffic analyzer, or "sniffer", for Unix and
5 Unix-like operating systems.  It uses GTK+, a graphical user interface
6 library, 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   - Tru64 UNIX (formerly Digital UNIX) (3.2, 4.0)
31   - Irix (version?)
32   - AIX (4.3.2, with a bit of work)
33
34 It should run on other systems without too much trouble.
35
36 NOTE: the Makefile appears to depend on GNU "make"; it doesn't appear to
37 work with the "make" that comes with Solaris 7 nor the BSD "make".
38 Perl is also needed to create the man page.
39
40 If you decide to modify the yacc grammar or lex scanner, then
41 you need "flex" - it cannot be built with vanilla "lex" -
42 and either "bison" or the Berkeley "yacc". Your flex
43 version must be 2.5.1 or greater. Check this with 'flex -V'.
44
45 You must therefore install Perl, GNU "make", "flex", and either "bison" or
46 Berkeley "yacc" on systems that lack them.
47
48 Full installation instructions can be found in the INSTALL file.
49          
50 See also the appropriate README.<OS> files for OS-specific installation
51 instructions.
52
53 Usage
54 -----          
55
56 In order to capture packets from the network, you need to be running
57 as root, or have access to the appropriate entry under /dev if your
58 system is so inclined (BSD-derived systems and Solaris typically fall
59 into this category.  Although it might be tempting to make the
60 Ethereal executable setuid root, please don't - alpha code is by nature
61 not very robust, and liable to contain security holes.
62
63 Please consult the man page for a description of each command-line
64 option and interface feature.
65
66
67 Multiple File Types
68 -------------------
69
70 The wiretap library is a packet-capture library currently under
71 development parallel to ethereal.  In the future it is hoped that
72 wiretap will have more features than libpcap, but wiretap is still in
73 its infancy. However, wiretap is used in ethereal for its ability
74 to read multiple file types. You can read the following file
75 formats, and create display filters for them as well:
76
77 libpcap (tcpdump -w), Sniffer (uncompressed), NetXray, Sniffer Pro,
78 snoop, Shomiti, LANalyzer, Network Monitor, AIX's iptrace,
79 RADCOM's WAN/LAN Analyzer, Lucent/Ascend access products, HP-UX's nettl,
80 and Toshiba's ISDN routers.
81
82 In addition, it can read gzipped versions of any of these files,
83 automatically, if you have the zlib library available when compiling
84 Ethereal. Ethereal needs a modern version of zlib to work; version
85 1.1.3 is known to work.  Earlier versions are missing some functions
86 that Ethereal needs and won't work. "./configure" should detect if you
87 have the proper zlib version available. You can always use
88 "./configure --disable-zlib" to explicitly disable zlib support.
89
90 Although Ethereal can read AIX iptrace files, the documentation on
91 AIX's iptrace packet-trace command is sparse.  The 'iptrace' command
92 starts a daemon which you must kill in order to stop the trace. Through
93 experimentation it appears that sending a HUP signal to that iptrace
94 daemon causes a graceful shutdown and a complete packet is written
95 to the trace file. If a partial packet is saved at the end, Ethereal
96 will complain when reading that file, but you will be able to read all
97 other packets.  If this occurs, please let the Ethereal developers know
98 at ethereal-dev@zing.org, and be sure to send us a copy of that trace
99 file if it's small and contains non-sensitive data.
100
101 Support for Lucent/Ascend products is limited to the debug trace output
102 generated by the MAX and Pipline series of products.  Ethereal can read
103 the output of the "wandsession" "wandisplay", "wannext", and "wdd"
104 commands.  For detailed information on use of these commands, please refer
105 the following pages:
106
107 "wandsession", "wandisplay", and "wannext" on the Pipeline series:
108   http://aos.ascend.com/aos:/gennavviewer.html?doc_id=0900253d80006c79
109
110 "wandsession", "wandisplay", and "wannext" on the MAX series:
111   http://aos.ascend.com/aos:/gennavviewer.html?doc_id=0900253d80006972
112
113 "wdd" on the Pipeline series:
114   http://aos.ascend.com/aos:/gennavviewer.html?doc_id=0900253d80006877
115
116 Ethereal can also read dump trace output from the Toshiba "Compact Router"
117 line of ISDN routers (TR-600 and TR-650). You can telnet to the router
118 and start a dump session with "snoop dump".
119
120 To use the Lucent/Ascend and Toshiba traces with Ethereal, you must capture
121 the trace output to a file on disk.  The trace is happening inside the router
122 and the router has no way of saving the trace to a file for you.
123 An easy way of doing this under Unix is to run "telnet <ascend> | tee <outfile>".
124 Or, if your system has the "script" command installed, you can save
125 a shell session, including telnet to a file. For example, to a file named
126 tracefile.out:
127
128 $ script tracefile.out
129 Script started on <date/time>
130 $ telnet router
131 ..... do your trace, then exit from the router's telnet session.
132 $ exit
133 Script done on <date/time>
134
135
136
137 IPv6
138 ----
139 If your operating system includes IPv6 support, ethereal will attempt to
140 use reverse name resolution capabilities when decoding IPv6 packets. If
141 you want to turn off name resolution while using ethereal, start ethereal
142 with the "-n" option. If you would like to compile ethereal without
143 support for IPv6 name resolution, use the "--disable-ipv6" option with
144 "./configure". If you compile ethereal without IPv6 name resolution,
145 you will still be able to decode IPv6 packets, but you'll only see IPv6
146 addresses, not host names.
147
148 The "Follow TCP Stream" feature only supports TCP over IPv4. Support for TCP
149 over IPv6 is planned.
150
151
152 SNMP
153 ----
154 Ethereal can do some basic decoding of SNMP packets, but it relies on an
155 external SNMP library to do this. You can use either the UCD or the CMU
156 SNMP libraries. The configure script will automatically determine which
157 library you have on your system and will use it. If you have an SNMP
158 library but _do not_ want to have ethereal use it, you can run configure
159 with the "--disable-snmp" option. No SNMP support will be compiled into
160 ethereal with this option.
161
162
163 How to Report a Bug
164 -------------------
165 Ethereal is still under constant development, so it is possible that you will
166 encounter a bug while using it. Please report bugs to ethereal-dev@zing.org.
167 Be sure you tell us:
168
169         1) Operating System and version (the command 'uname -sr' may
170            tell you this, although on Linux systems it will probably
171            tell you only the version number of the Linux kernel, not of
172            the distribution as a whole; on Linux systems, please tell us
173            both the version number of the kernel, and which version of
174            which distribution you're running)
175         2) Version of GTK+ (the command 'gtk-config --version' will tell you)
176         3) Version of Ethereal (the command 'ethereal -v' will tell you,
177            unless the bug is so severe as to prevent that from working,
178            and should also tell you the versions of libraries with which
179            it was built)
180         4) The command you used to invoke Ethereal, and the sequence of
181            operations you performed that caused the bug to appear
182
183 If the bug is produced by a particular trace file, please be sure to send
184 a trace file along with your bug description. Please don't send a trace file
185 greater than 1 MB when compressed. If the trace file contains sensitive
186 information (e.g., passwords), then please do not send it.
187
188 If Ethereal died on you with a 'segmentation violation', you can help the
189 developers a lot if you have a debugger installed. A stack trace can be
190 obtained by using your debugger ('gdb' in this example), the ethereal binary,
191 and the resulting core file. Here's an example of how to use the gdb
192 command 'backtrace' to do so.
193
194 $ gdb ethereal core
195 (gdb) backtrace
196 ..... prints the stack trace
197 (gdb) quit
198 $
199
200 Disclaimer
201 ----------
202
203 There is no warranty, expressed or implied, associated with this product.
204 Use at your own risk.
205
206
207 Gerald Combs <gerald@zing.org>
208 Gilbert Ramirez <gram@xiexie.org>