pinfo->private_data was a quite subptimal idea
[obnox/wireshark/wip.git] / README
diff --git a/README b/README
index 23b436c33480ec691690921f08b736e36d82e585..4616c620cd1dcbbb43b0a1ba22a009fefbb77aee 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-$Id: README,v 1.47 2001/01/10 10:06:16 guy Exp $
+$Id$
 
 General Information
 ------- -----------
@@ -29,16 +29,21 @@ Installation
 
 Ethereal is known to compile and run on the following systems:
 
-  - 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)
+  - Linux (2.0 and later kernels, various distributions)
+  - Solaris (2.5.1 and later)
+  - FreeBSD (2.2.5 and later)
+  - NetBSD
+  - OpenBSD
+  - Mac OS X (10.2 and later)
+  - HP-UX (10.20, 11.00, 11.11)
   - Sequent PTX v4.4.5  (Nick Williams <njw@sequent.com>)
-  - Tru64 UNIX (formerly Digital UNIX) (3.2, 4.0)
+  - Tru64 UNIX (formerly Digital UNIX) (3.2 and later)
   - Irix (6.5)
   - AIX (4.3.2, with a bit of work)
-  - Win32 (NT, 98)
+  - Win32 (98, NT, 2000, XP)
 
-It should run on other Unix-ish systems without too much trouble.
+and possibly on other versions of those OSes.  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".
@@ -86,16 +91,17 @@ its infancy. However, wiretap is used in ethereal for its ability
 to read multiple file types. You can read the following file
 formats:
 
-libpcap (tcpdump -w, Ethereal)
-Sniffer (compressed and uncompressed)
-NetXray
-Sniffer Pro
-snoop
-atmsnoop
-Shomiti
-LANalyzer
+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/EtherHelp
 RADCOM's WAN/LAN Analyzer
 Lucent/Ascend access products
 HP-UX's nettl
@@ -103,6 +109,15 @@ 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
+CoSine L2 debug output
+Output from Accellent's 5Views LAN agents
+Endace Measurement Systems' ERF format
+Linux Bluez Bluetooth stack "hcidump -w" traces
+Network Instruments Observer version 9
+Trace files for the EyeSDN USB S0
 
 In addition, it can read gzipped versions of any of these files
 automatically, if you have the zlib library available when compiling
@@ -143,9 +158,15 @@ Ethereal can also read dump trace output from the Toshiba "Compact Router"
 line of ISDN routers (TR-600 and TR-650). You can telnet to the router
 and start a dump session with "snoop dump".
 
-To use the Lucent/Ascend and Toshiba traces with Ethereal, you must capture
-the trace output to a file on disk.  The trace is happening inside the router
-and the router has no way of saving the trace to a file for you.
+CoSine L2 debug output can also be read by Ethereal. To get the L2
+debug output, get in the diags mode first and then use
+"create-pkt-log-profile" and "apply-pkt-log-profile" commands under
+layer-2 category. For more detail how to use these commands, you
+should examine the help command by "layer-2 create ?" or "layer-2 apply ?".
+
+To use the Lucent/Ascend, Toshiba and CoSine traces with Ethereal, you must 
+capture the trace output to a file on disk.  The trace is happening inside 
+the router and the router has no way of saving the trace to a file for you.
 An easy way of doing this under Unix is to run "telnet <ascend> | tee <outfile>".
 Or, if your system has the "script" command installed, you can save
 a shell session, including telnet to a file. For example, to a file named
@@ -163,32 +184,42 @@ Script done on <date/time>
 IPv6
 ----
 If your operating system includes IPv6 support, ethereal will attempt to
-use reverse name resolution capabilities when decoding IPv6 packets. If
-you want to turn off name resolution while using ethereal, start ethereal
-with the "-n" option. If you would like to compile ethereal without
-support for IPv6 name resolution, use the "--disable-ipv6" option with
-"./configure". If you compile ethereal without IPv6 name resolution,
-you will still be able to decode IPv6 packets, but you'll only see IPv6
-addresses, not host names.
+use reverse name resolution capabilities when decoding IPv6 packets.
+
+If you want to turn off name resolution while using ethereal, start
+ethereal with the "-n" option to turn off all name resolution (including
+resolution of MAC addresses and TCP/UDP/SMTP port numbers to names), or
+with the "-N mt" option to turn off name resolution for all
+network-layer addresses (IPv4, IPv6, IPX).
 
+You can make that the default setting by opening the Preferences dialog
+box using the Preferences item in the Edit menu, selecting "Name
+resolution", turning off the appropriate name resolution options,
+clicking "Save", and clicking "OK".
 
-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.
+If you would like to compile ethereal without support for IPv6 name
+resolution, use the "--disable-ipv6" option with "./configure".  If you
+compile ethereal without IPv6 name resolution, you will still be able to
+decode IPv6 packets, but you'll only see IPv6 addresses, not host names.
 
 
 SNMP
 ----
-Ethereal can do some basic decoding of SNMP packets; it can also use an
-external SNMP library to do more sophisticated decoding..  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. 
+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 "--without-ucd-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 or later, as UCD SNMP 4.2.4 fixes some potential buffer overflow
+problems, or should configure with "--without-ucd-snmp".
 
 
 How to Report a Bug
@@ -242,5 +273,5 @@ Use at your own risk.
 
 
 Gerald Combs <gerald@ethereal.com>
-Gilbert Ramirez <gram@xiexie.org>
+Gilbert Ramirez <gram@alumni.rice.edu>
 Guy Harris <guy@alum.mit.edu>