README

   1 General Information
   2 ------- -----------
   3
   4 Wireshark 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 Wireshark distribution also comes with TShark, which is a
   9 line-oriented sniffer (similar to Sun's snoop, or tcpdump) that uses the
  10 same dissection, capture-file reading and writing, and packet filtering
  11 code as Wireshark, and with editcap, which is a program to read capture
  12 files and write the packets from that capture file, possibly in a
  13 different capture file format, and with some packets possibly removed
  14 from the capture.
  15
  16 The official home of Wireshark is
  17
  18     http://www.wireshark.org
  19
  20 The latest distribution can be found in the subdirectory
  21
  22     http://www.wireshark.org/download
  23
  24
  25 Installation
  26 ------------
  27
  28 Wireshark is known to compile and run on the following systems:
  29
  30   - Linux (2.0 and later kernels, various distributions)
  31   - Solaris (2.5.1 and later)
  32   - FreeBSD (2.2.5 and later)
  33   - NetBSD
  34   - OpenBSD
  35   - Mac OS X (10.2 and later)
  36   - HP-UX (10.20, 11.00, 11.11)
  37   - Sequent PTX v4.4.5  (Nick Williams <njw@sequent.com>)
  38   - Tru64 UNIX (formerly Digital UNIX) (3.2 and later)
  39   - Irix (6.5)
  40   - AIX (4.3.2, with a bit of work)
  41   - Windows (2003, XP, Vista, 7)
  42
  43 and possibly on other versions of those OSes.  It should run on other
  44 Unix-ish systems without too much trouble.
  45
  46 If you have an older version of the operating systems listed above, it
  47 might be supported by an older version of Wireshark. In particular,
  48 Windows 2000 is supported by Wireshark 1.2.x, Windows NT 4.0 is supported by
  49 Wireshark 0.99.4, and Windows 95, 98, and ME are supported by Ethereal 0.99.0.
  50
  51 NOTE: the Makefile appears to depend on GNU "make"; it doesn't appear to
  52 work with the "make" that comes with Solaris 7 nor the BSD "make".
  53 Perl is also needed to create the man page.
  54
  55 If you decide to modify the yacc grammar or lex scanner, then
  56 you need "flex" - it cannot be built with vanilla "lex" -
  57 and either "bison" or the Berkeley "yacc". Your flex
  58 version must be 2.5.1 or greater. Check this with 'flex -V'.
  59
  60 If you decide to modify the NetWare Core Protocol dissector, you
  61 will need python, as the data for packet types is stored in a python
  62 script, ncp2222.py.
  63
  64 You must therefore install Perl, GNU "make", "flex", and either "bison" or
  65 Berkeley "yacc" on systems that lack them.
  66
  67 Full installation instructions can be found in the INSTALL file.
  68
  69 See also the appropriate README.<OS> files for OS-specific installation
  70 instructions.
  71
  72 Usage
  73 -----
  74
  75 In order to capture packets from the network, you need to make the
  76 dumpcap program set-UID to root, or you need to have access to the
  77 appropriate entry under /dev if your system is so inclined (BSD-derived
  78 systems, and systems such as Solaris and HP-UX that support DLPI,
  79 typically fall into this category).  Although it might be tempting to
  80 make the Wireshark and TShark executables setuid root, or to run them as
  81 root please don't.  The capture process has been isolated in dumpcap;
  82 this simple program is less likely to contain security holes, and thus
  83 safer to run as root.
  84
  85 Please consult the man page for a description of each command-line
  86 option and interface feature.
  87
  88
  89 Multiple File Types
  90 -------------------
  91
  92 The wiretap library is a packet-capture library currently under
  93 development parallel to wireshark.  In the future it is hoped that
  94 wiretap will have more features than libpcap, but wiretap is still in
  95 its infancy. However, wiretap is used in wireshark for its ability
  96 to read multiple file types.  See the Wireshark man page or the
  97 Wireshark User's Guide for a list of supported file formats.
  98
  99 In addition, it can read gzipped versions of any of those files
 100 automatically, if you have the zlib library available when compiling
 101 Wireshark. Wireshark needs a modern version of zlib to be able to use
 102 zlib to read gzipped files; version 1.1.3 is known to work.  Versions
 103 prior to 1.0.9 are missing some functions that Wireshark needs and won't
 104 work.  "./configure" should detect if you have the proper zlib version
 105 available and, if you don't, should disable zlib support. You can always
 106 use "./configure --disable-zlib" to explicitly disable zlib support.
 107
 108 Although Wireshark can read AIX iptrace files, the documentation on
 109 AIX's iptrace packet-trace command is sparse.  The 'iptrace' command
 110 starts a daemon which you must kill in order to stop the trace. Through
 111 experimentation it appears that sending a HUP signal to that iptrace
 112 daemon causes a graceful shutdown and a complete packet is written
 113 to the trace file. If a partial packet is saved at the end, Wireshark
 114 will complain when reading that file, but you will be able to read all
 115 other packets.  If this occurs, please let the Wireshark developers know
 116 at wireshark-dev@wireshark.org, and be sure to send us a copy of that trace
 117 file if it's small and contains non-sensitive data.
 118
 119 Support for Lucent/Ascend products is limited to the debug trace output
 120 generated by the MAX and Pipline series of products.  Wireshark can read
 121 the output of the "wandsession" "wandisplay", "wannext", and "wdd"
 122 commands.
 123
 124 Wireshark can also read dump trace output from the Toshiba "Compact Router"
 125 line of ISDN routers (TR-600 and TR-650). You can telnet to the router
 126 and start a dump session with "snoop dump".
 127
 128 CoSine L2 debug output can also be read by Wireshark. To get the L2
 129 debug output, get in the diags mode first and then use
 130 "create-pkt-log-profile" and "apply-pkt-log-profile" commands under
 131 layer-2 category. For more detail how to use these commands, you
 132 should examine the help command by "layer-2 create ?" or "layer-2 apply ?".
 133
 134 To use the Lucent/Ascend, Toshiba and CoSine traces with Wireshark, you must
 135 capture the trace output to a file on disk.  The trace is happening inside
 136 the router and the router has no way of saving the trace to a file for you.
 137 An easy way of doing this under Unix is to run "telnet <ascend> | tee <outfile>".
 138 Or, if your system has the "script" command installed, you can save
 139 a shell session, including telnet to a file. For example, to a file named
 140 tracefile.out:
 141
 142 $ script tracefile.out
 143 Script started on <date/time>
 144 $ telnet router
 145 ..... do your trace, then exit from the router's telnet session.
 146 $ exit
 147 Script done on <date/time>
 148
 149
 150
 151 IPv6
 152 ----
 153 If your operating system includes IPv6 support, wireshark will attempt to
 154 use reverse name resolution capabilities when decoding IPv6 packets.
 155
 156 If you want to turn off name resolution while using wireshark, start
 157 wireshark with the "-n" option to turn off all name resolution (including
 158 resolution of MAC addresses and TCP/UDP/SMTP port numbers to names), or
 159 with the "-N mt" option to turn off name resolution for all
 160 network-layer addresses (IPv4, IPv6, IPX).
 161
 162 You can make that the default setting by opening the Preferences dialog
 163 box using the Preferences item in the Edit menu, selecting "Name
 164 resolution", turning off the appropriate name resolution options,
 165 clicking "Save", and clicking "OK".
 166
 167 If you would like to compile wireshark without support for IPv6 name
 168 resolution, use the "--disable-ipv6" option with "./configure".  If you
 169 compile wireshark without IPv6 name resolution, you will still be able to
 170 decode IPv6 packets, but you'll only see IPv6 addresses, not host names.
 171
 172
 173 SNMP
 174 ----
 175 Wireshark can do some basic decoding of SNMP packets; it can also use
 176 the libsmi library to do more sophisticated decoding, by reading MIB
 177 files and using the information in those files to display OIDs and
 178 variable binding values in a friendlier fashion.  The configure script
 179 will automatically determine whether you have the libsmi library on
 180 your system.  If you have the libsmi library but _do not_ want to have
 181 Wireshark use it, you can run configure with the "--without-libsmi"
 182 option.
 183
 184 How to Report a Bug
 185 -------------------
 186 Wireshark is still under constant development, so it is possible that you will
 187 encounter a bug while using it. Please report bugs at http://bugs.wireshark.org.
 188 Be sure you enter into the bug:
 189
 190         1) the complete build information from the "About Wireshark"
 191            item in the Help menu or the output of "wireshark -v" for
 192            Wireshark bugs and the output of "tshark -v" for TShark bugs;
 193
 194         2) if the bug happened on Linux, the Linux distribution you were
 195            using, and the version of that distribution;
 196
 197         3) the command you used to invoke Wireshark, if you ran
 198            Wireshark from the command line, or TShark, if you ran
 199            TShark, and the sequence of operations you performed that
 200            caused the bug to appear.
 201
 202 If the bug is produced by a particular trace file, please be sure to
 203 attach to the bug a trace file along with your bug description.  If the
 204 trace file contains sensitive information (e.g., passwords), then please
 205 do not send it.
 206
 207 If Wireshark died on you with a 'segmentation violation', 'bus error',
 208 'abort', or other error that produces a UNIX core dump file, you can
 209 help the developers a lot if you have a debugger installed.  A stack
 210 trace can be obtained by using your debugger ('gdb' in this example),
 211 the wireshark binary, and the resulting core file.  Here's an example of
 212 how to use the gdb command 'backtrace' to do so.
 213
 214 $ gdb wireshark core
 215 (gdb) backtrace
 216 ..... prints the stack trace
 217 (gdb) quit
 218 $
 219
 220 The core dump file may be named "wireshark.core" rather than "core" on
 221 some platforms (e.g., BSD systems).  If you got a core dump with
 222 TShark rather than Wireshark, use "tshark" as the first argument to
 223 the debugger; the core dump may be named "tshark.core".
 224
 225 Disclaimer
 226 ----------
 227
 228 There is no warranty, expressed or implied, associated with this product.
 229 Use at your own risk.
 230
 231
 232 Gerald Combs <gerald@wireshark.org>
 233 Gilbert Ramirez <gram@alumni.rice.edu>
 234 Guy Harris <guy@alum.mit.edu>