Made iptrace wiretap module return error on partial packets, instead of
[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 uses 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   - Tru64 UNIX (formerly Digital UNIX) (3.2, 4.0)
31
32 It should run on other systems without too much trouble.
33
34 NOTE: the Makefile appears to depend on GNU "make"; it doesn't appear to
35 work with the "make" that comes with Solaris 7 nor the BSD "make".
36
37 In addition, ethereal requires "flex" - it cannot be built
38 with vanilla "lex" - and either "bison" or the Berkeley "yacc". Your flex
39 version must be 2.5.1 or greater. Check this with 'flex -V'.
40
41 You must therefore install GNU "make", "flex", and either "bison" or
42 Berkeley "yacc" on systems that lack them.
43
44 Full installation instructions can be found in the INSTALL file.
45          
46 See also the appropriate README.<OS> files for OS-specific installation
47 instructions.
48
49 Usage
50 -----          
51
52 In order to capture packets from the network, you need to be running
53 as root, or have access to the appropriate entry under /dev if your
54 system is so inclined (BSD-derived systems and Solaris typically fall
55 into this category.  Although it might be tempting to make the
56 Ethereal executable setuid root, please don't - alpha code is by nature
57 not very robust, and liable to contain security holes.
58
59 Please consult the man page for a description of each command-line
60 option and interface feature.
61
62
63 Multiple File Types
64 -------------------
65
66 The wiretap library is a packet-capture library currently under
67 development parallel to ethereal.  In the future it is hoped that
68 wiretap will have more features than libpcap, but wiretap is still in
69 its infancy. However, wiretap is used in ethereal for its ability
70 to read multiple file types. You can read the following file
71 formats, and create display filters for them as well:
72
73 libpcap, Sniffer (uncompresed), NetXray, Sniffer Pro, snoop,
74 Shomiti, LANalyzer, Network Monitor, iptrace 2.0 (AIX), and
75 RADCOM's WAN/LAN Analyzer
76
77 Although Ethereal can read AIX iptrace files, the documentation on
78 AIX's iptrace packet-trace command is sparse.  The 'iptrace' command
79 starts a daemon which you must kill in order to stop the trace. Through
80 experimentation it appears that sending a HUP signal to that iptrace
81 daemon causes a graceful shutdown and a complete packet is written
82 to the trace file. If a partial packet is saved at the end, Ethereal
83 will complain when reading that file, but you will be able to read all
84 other packets.  If this occurs, please let the Ethereal developers know
85 at ethereal-dev@zing.org, and be sure to send us a copy of that trace
86 file if it's small and contains non-sensitive data.
87
88
89 IPv6
90 ----
91 If your operating system includes IPv6 support, ethereal will attempt to
92 use reverse name resolution capabilities when decoding IPv6 packets. If
93 you want to turn off name resolution while using ethereal, start ethereal
94 with the "-n" option. If you would like to compile ethereal without
95 support for IPv6 name resolution, use the "--disable-ipv6" option with
96 "./configure". If you compile ethereal without IPv6 name resolution,
97 you will still be able to decode IPv6 packets, but you'll only see IPv6
98 addresses, not host names.
99
100 The "Follow TCP Stream" feature only supports TCP over IPv4. Support for TCP
101 over IPv6 is planned.
102
103
104 SNMP
105 ----
106 Ethereal can do some basic decoding of SNMP packets, but it relies on an
107 external SNMP library to do this. You can use either the UCD or the CMU
108 SNMP libraries. The configure script will automatically determine which
109 library you have on your system and will use it. If you have an SNMP
110 library but _do not_ want to have ethereal use it, you can run configure
111 with the "--disable-snmp" option. No SNMP support will be compiled into
112 ethereal with this option.
113
114 How to Report a Bug
115 -------------------
116 Ethereal is still under constant development, so it is possible that you will
117 encounter a bug while using it. Please report bugs to ethereal-dev@zing.org.
118 Be sure you tell us:
119
120         1) Operating System and version
121         2) Version of GTK+ (the command 'gtk-config --version' will tell you)
122         3) The command you used to invoke Ethereal
123
124 If the bug is produced by a particular trace file, please be sure to send
125 a trace file along with your bug description. Please don't send a trace file
126 greather than 1MB when compressed. If the trace file contains sensitive
127 information (e.g., passwords), then please do not send it.
128
129 If Ethereal died on you with a 'segmentation violation', you can help the
130 developers a lot if you have your debugger installed. A stack trace using
131 your debugger ('gdb' in this example), the ethereal binary, and the
132 resulting core file can be obtained by starting the debugger and using
133 the 'backtrace' command.
134
135 $ gdb ethereal core
136 > backtrace
137 ..... prints the stack trace
138 > quit
139
140
141 Disclaimer
142 ----------
143
144 There is no warranty, expressed or implied, associated with this product.
145 Use at your own risk.
146
147
148 Gerald Combs <gerald@zing.org>
149 Gilbert Ramirez <gram@verdict.uthscsa.edu>