+$Id: README,v 1.55 2002/03/11 02:12:41 guy Exp $
+
General Information
------- -----------
Unix-like operating systems. It uses GTK+, a graphical user interface
library, and libpcap, a packet capture and filtering library.
+The Ethereal distribution also comes with Tethereal, which is a
+line-oriented sniffer (similar to Sun's snoop, or tcpdump) that uses the
+same dissection, capture-file reading and writing, and packet filtering
+code as Ethereal, and with editcap, which is a program to read capture
+files and write the packets from that capture file, possibly in a
+different capture file format, and with some packets possibly removed
+from the capture.
+
The official home of Ethereal is
- http://ethereal.zing.org
+ http://www.ethereal.com
The latest distribution can be found in the subdirectory
- http://ethereal.zing.org/distribution
+ http://www.ethereal.com/distribution
Installation
Ethereal is known to compile and run on the following systems:
- - Linux (2.0.x, 2.1.x, 2.2.x)
- - Solaris (2.5.1, 2.6)
- - FreeBSD (2.2.5, 2.2.6)
+ - Linux (2.0.x, 2.1.x, 2.2.x, 2.3.x, 2.4.x)
+ - Solaris (2.5.1, 2.6, 7)
+ - FreeBSD (2.2.5, 2.2.6, 3.1, 3.2, 3.3)
- Sequent PTX v4.4.5 (Nick Williams <njw@sequent.com>)
- Tru64 UNIX (formerly Digital UNIX) (3.2, 4.0)
- - Irix (version?)
+ - Irix (6.5)
- AIX (4.3.2, with a bit of work)
+ - Win32 (NT, 98)
-It should run on other systems without too much trouble.
+It should run on other Unix-ish systems without too much trouble.
NOTE: the Makefile appears to depend on GNU "make"; it doesn't appear to
work with the "make" that comes with Solaris 7 nor the BSD "make".
and either "bison" or the Berkeley "yacc". Your flex
version must be 2.5.1 or greater. Check this with 'flex -V'.
+If you decide to modify the NetWare Core Protocol dissector, you
+will need python, as the data for packet types is stored in a python
+script, ncp2222.py.
+
You must therefore install Perl, GNU "make", "flex", and either "bison" or
Berkeley "yacc" on systems that lack them.
Usage
-----
-In order to capture packets from the network, you need to be running
-as root, or have access to the appropriate entry under /dev if your
-system is so inclined (BSD-derived systems and Solaris typically fall
-into this category. Although it might be tempting to make the
-Ethereal executable setuid root, please don't - alpha code is by nature
-not very robust, and liable to contain security holes.
+In order to capture packets from the network, you need to be running as
+root, or have access to the appropriate entry under /dev if your system
+is so inclined (BSD-derived systems, and systems such as Solaris and
+HP-UX that support DLPI, typically fall into this category). Although
+it might be tempting to make the Ethereal executable setuid root, please
+don't - alpha code is by nature not very robust, and liable to contain
+security holes.
Please consult the man page for a description of each command-line
option and interface feature.
wiretap will have more features than libpcap, but wiretap is still in
its infancy. However, wiretap is used in ethereal for its ability
to read multiple file types. You can read the following file
-formats, and create display filters for them as well:
-
-libpcap (tcpdump -w), Sniffer (uncompressed), NetXray, Sniffer Pro,
-snoop, Shomiti, LANalyzer, Network Monitor, AIX's iptrace,
-RADCOM's WAN/LAN Analyzer, Lucent/Ascend access products, HP-UX's nettl,
-and Toshiba's ISDN routers.
-
-In addition, it can read gzipped versions of any of these files,
+formats:
+
+libpcap (tcpdump -w, etc.) - this is Ethereal's native format
+snoop and atmsnoop
+Shomiti/Finisar Surveyor
+Novell LANalyzer
+Network General/Network Associates DOS-based Sniffer (compressed and
+ uncompressed)
+Microsoft Network Monitor
+AIX's iptrace
+Cinco Networks NetXRray
+Network Associates Windows-based Sniffer
+AG Group/WildPackets EtherPeek/TokenPeek/AiroPeek
+RADCOM's WAN/LAN Analyzer
+Lucent/Ascend access products
+HP-UX's nettl
+Toshiba's ISDN routers
+ISDN4BSD "i4btrace" utility
+Cisco Secure Intrustion Detection System iplogging facility
+pppd logs (pppdump-format files)
+VMS's TCPIPtrace utility
+DBS Etherwatch for VMS
+Traffic captures from Visual Networks' Visual UpTime
+
+In addition, it can read gzipped versions of any of these files
automatically, if you have the zlib library available when compiling
Ethereal. Ethereal needs a modern version of zlib to be able to use
zlib to read gzipped files; version 1.1.3 is known to work. Versions
to the trace file. If a partial packet is saved at the end, Ethereal
will complain when reading that file, but you will be able to read all
other packets. If this occurs, please let the Ethereal developers know
-at ethereal-dev@zing.org, and be sure to send us a copy of that trace
+at ethereal-dev@ethereal.com, and be sure to send us a copy of that trace
file if it's small and contains non-sensitive data.
Support for Lucent/Ascend products is limited to the debug trace output
you will still be able to decode IPv6 packets, but you'll only see IPv6
addresses, not host names.
-The "Follow TCP Stream" feature only supports TCP over IPv4. Support for TCP
-over IPv6 is planned.
+
+NetWare Core Protocol
+---------------------
+There are over 400 different NCP packet types. The NCP dissector does
+not understand all of these; support is being added little by little. If
+you have some NCP packets that are not dissected by Ethereal, send
+a trace file to ethereal-dev@ethereal.com and if possible, we will add support
+for those packets types.
SNMP
----
-Ethereal can do some basic decoding of SNMP packets, but it relies on an
-external SNMP library to do this. You can use either the UCD or the CMU
-SNMP libraries. The configure script will automatically determine which
-library you have on your system and will use it. If you have an SNMP
-library but _do not_ want to have ethereal use it, you can run configure
-with the "--disable-snmp" option. No SNMP support will be compiled into
-ethereal with this option.
+Ethereal can do some basic decoding of SNMP packets; it can also use the
+UCD SNMP library, version 4.2.2 or later, to do more sophisticated
+decoding, by reading MIB files and using the information in those files
+to display OIDs and variable binding values in a friendlier fashion The
+configure script will automatically determine whether you have the UCD
+SNMP library on your system, and will use it if it's version 4.2.2 or
+later. If you have an SNMP library but _do not_ want to have ethereal
+use it, you can run configure with the "--disable-snmp" option. (If you
+have an earlier version of the UCD SNMP library on your system, the
+configure script will stop, reporting that it can't find the
+"sprint_realloc_objid()" routine; you should either upgrade to version
+4.2.4, as that version fixes some potential buffer overflow problems, or
+should configure with "--disable-snmp".)
How to Report a Bug
-------------------
Ethereal is still under constant development, so it is possible that you will
-encounter a bug while using it. Please report bugs to ethereal-dev@zing.org.
+encounter a bug while using it. Please report bugs to ethereal-dev@ethereal.com.
Be sure you tell us:
1) Operating System and version (the command 'uname -sr' may
greater than 1 MB when compressed. If the trace file contains sensitive
information (e.g., passwords), then please do not send it.
-If Ethereal died on you with a 'segmentation violation', you can help the
-developers a lot if you have a debugger installed. A stack trace can be
-obtained by using your debugger ('gdb' in this example), the ethereal binary,
-and the resulting core file. Here's an example of how to use the gdb
-command 'backtrace' to do so.
+If Ethereal died on you with a 'segmentation violation', 'bus error',
+'abort', or other error that produces a UNIX core dump file, you can
+help the developers a lot if you have a debugger installed. A stack
+trace can be obtained by using your debugger ('gdb' in this example),
+the ethereal binary, and the resulting core file. Here's an example of
+how to use the gdb command 'backtrace' to do so.
$ gdb ethereal core
(gdb) backtrace
(gdb) quit
$
+The core dump file may be named "ethereal.core" rather than "core" on
+some platforms (e.g., BSD systems). If you got a core dump with
+Tethereal rather than Ethereal, use "tethereal" as the first argument to
+the debugger; the core dump may be named "tethereal.core".
+
Disclaimer
----------
Use at your own risk.
-Gerald Combs <gerald@zing.org>
-Gilbert Ramirez <gram@xiexie.org>
+Gerald Combs <gerald@ethereal.com>
+Gilbert Ramirez <gram@alumni.rice.edu>
+Guy Harris <guy@alum.mit.edu>
git.samba.org / obnox / wireshark / wip.git / blobdiff