README.win32

   1 $Id: README.win32,v 1.23 2001/04/10 12:29:22 gram Exp $
   2
   3 Installing Ethereal, Tethereal, and Editcap on Win32
   4 ====================================================
   5 These are the instructions for installing Ethereal
   6 from the installation executable that is provided on
   7 the Ethereal website and any of its mirrors.
   8
   9 The installation package allows you to install:
  10
  11         o Ethereal - the GUI version
  12         o Tethereal - the console, line-mode version
  13         o Editcap - a console, line-mode utility to convert
  14                 capture files from one format to another.
  15                 (The same functions are available in Ethereal)
  16
  17 Additionally, the installation package contains a "plugins"
  18 option, which installs the Gryphon and MGCP dissector plugins
  19 for use with Ethereal and Tethereal.
  20
  21 The "Debug PDB Files" are useful to install if you are experiencing
  22 a crash when running and Ethereal. Dr. Watson or your debugger
  23 can use the information in these files to provide useful information
  24 to the Ethereal developers that will help them pinpoint the problem.
  25 However, for general usage of Ethereal, these files are not
  26 necessary. In the future, we may package them separately from
  27 Ethereal.
  28
  29 In the past, two versions of Ethereal binaries were published -- a
  30 version that could capture packets and a version which could not.
  31 The latter is useful if you're only reading files produced by
  32 another product (e.g., a sniffer, firewall, or intrustion detection system)
  33 and did not wish to install WinPcap, the library Ethereal uses
  34 to capture packets on Win32 platforms.
  35
  36 Now that WinPcap 2.1 has been released as a DLL, Ethereal can
  37 detect its presence at run time. Thus, only one version of
  38 the Ethereal binaries need to be shipped.
  39
  40 If you don't want to capture packets, just install the Ethereal
  41 package. If you do want to capture packets, install Ethereal *and*
  42 install WinPcap 2.1, available from:
  43
  44         http://netgroup-serv.polito.it/winpcap/
  45
  46 If you already have WinPcap 2.0 installed, you need to un-install
  47 it and install WinPcap 2.1.  If you use other applications
  48 that use WinPcap 2.0, you will have to decide which applications
  49 to keep, since WinPcap 2.0 and WinPcap 2.1 cannot be installed
  50 on the same system at the same time.
  51
  52 If Ethereal is not capturing packets and you have WinPcap installed,
  53 you can test your WinPcap installation by installing WinDump
  54 (TCPdump for Windows) ported by the same folks who make WinPcap. It's at:
  55
  56         http://netgroup-serv.polito.it/windump/
  57
  58 They also make Analyzer, a GUI sniffer for Win32:
  59
  60         http://netgroup-serv.polito.it/analyzer/
  61
  62 The rest of this documentation is only interesting if
  63 you want to compile Ethereal yourself.
  64
  65
  66 Running Ethereal, Tethereal, and Editcap on Win32
  67 =================================================
  68 You need the glib and gtk libraries for running Ethereal.
  69
  70 These packages for win32 can be found at:
  71
  72         http://www.ethereal.com/distribution/win32
  73
  74 and at the home page for the GTK+ for Win32 project:
  75
  76         http://www.gimp.org/~tml/gimp/win32
  77
  78 or
  79         http://www.iki.fi/tml/gimp/win32/
  80
  81 (the mirror nearer to you may be faster).
  82
  83 Plugins (gryphon.dll and mgcp.dll) can go in:
  84         C:\Program Files\Ethereal\plugins\<version>
  85         C:\Ethereal\plugins\<version>
  86
  87 Where <version> is the version number, without brackets.
  88 For example, C:\Ethereal\plugins\0.8.16
  89
  90 Yes, the location of plugins needs to be more flexible.
  91
  92 Make sure the glib and gtk DLL's are in your path - i.e., that your path
  93 includes the directory (folder) or directories (folders) in which those
  94 DLLs are found - when you run Ethereal.  This includes gtk-*.dll,
  95 glib-*.dll, gmodule-*.dll, gdk-*.dll, gnu-intl.dll, and iconv-*.dll.
  96 As of the 20000805 GTK+/GLIB distribution, gthread-*.dll is no longer needed.
  97
  98 The Win32 Binary distribution, available from
  99
 100         http://www.ethereal.com/distribution/win32
 101
 102 used different version of the GTK+/GLIB libraries at different points
 103 in time:
 104
 105 Ethereal Version                GTK+/GLIB version
 106 ----------------                -----------------
 107 0.8.16 and after                20001226
 108 0.8.11 - 0.8.15                 20000805
 109 0.8.9 - 0.8.10                  20000416
 110 0.8.8 and before                19990828
 111
 112
 113 Capturing Packets
 114 -----------------
 115 In order to capture with Win32, you need to install the NDIS
 116 packet capture driver for your particular Win32 OS; drivers for Windows
 117 9x, Windows NT 4.0, and Windows 2000 can be downloaded from the
 118 WinPcap home page:
 119
 120         http://netgroup-serv.polito.it/winpcap/
 121
 122
 123 Compiling the Ethereal distribution from source
 124 ===============================================
 125 You'll need the development package for GLIB, GTK+, and WinPcap.
 126 Those versions are available from the respctive home pages for
 127 each project (the same URLs as listed above). The development
 128 packages contain header files and stub libaries to link against.
 129
 130 The use of an SNMP library has not been made to work yet in
 131 Ethereal/Win32, but a binary distribution of the UCD SNMP package,
 132 including header files and a DLL of the UCD SNMP library, can be had
 133 from:
 134
 135         ftp://ftp.revelstone.com/snmp/binaries/
 136
 137 The file will probably be called "ucd-snmp-X.X-x86-win32.zip", where
 138 "X.X" is the version number of the UCD SNMP library.
 139
 140 Instructions for MS Visual C
 141 ----------------------------
 142 Modify the config.nmake file in the top directory of the Ethereal
 143 source tree to work for your local configuration. You should not
 144 have to modify any other Makefile.
 145
 146 In order to compile, at least with the default settings, you
 147 also need zlib, which is provided as an archive library, not
 148 a DLL. The pre-compiled zlib which comes with the "extralibs"
 149 package from Gimp/Win32 is faulty; a working version can be
 150 downloaded from:
 151
 152         http://www.ethereal.com/distribution/win32/zlib-1.1.3-fixed.zip
 153
 154 Be sure that your command-line environment is set up to compile
 155 and link with MSVC. When installing MSVC, you can have your
 156 system's environment set up to always allow compiling from the
 157 command line, or you can invoke the vcvars32.bat script.
 158
 159 In the ethereal directory, type "nmake -f makefile.nmake". It will
 160 recurse into the subdirectories as appropriate.
 161
 162 Some generated source is created by traditionally "Unix-ish" tools.
 163 If you are building from an official distribution, these files are
 164 already generated, so you have nothing to worry about unless you
 165 modify the source. If building from a CVS image, you'll need the tools
 166 to generate C source. The "special" files and their requisite tools are:
 167
 168 Source                          Output                  Tool
 169 ------                          ------                  ----
 170 config.h.in                     config.h                sed
 171 dfilter-scanner.l               *.c                     Flex
 172 wiretap/ascend-scanner.l        *.c                     Flex
 173 wiretap/ascend-grammar.y        *.c,*.h                 Bison/Yacc
 174 ncp2222.py                      packet-ncp2222.c        Python
 175
 176 make-reg-dotc, packet*.c        register.c              Bash + grep + sed
 177 or
 178 make-reg-dotc.py, packet*.c     register.c              Python
 179
 180 The Makefile.nmake supplied with the Ethereal distribution will
 181 attempt to make register.c with Python, since it is much much much
 182 faster than the shell version. The reason it is faster is because
 183 the shell version launches multiple processes (grep, sed) for each
 184 source file, multiple times. The Python script is one process. This
 185 matters a lot on Win32. If for some reason you want to build register.c
 186 with the shell script, uncomment out the action line for the register.c
 187 target in Makefile.nmake.
 188
 189 If you have a Unix system handy, you can first build on Unix
 190 to create the source files that these tools make, then run the build
 191 on Windows.  That will avoid the need for these tools on your Windows
 192 computer.
 193
 194 If you don't have a Unix system handy, most of those tools are available for
 195 Win32 systems as part of the Cygwin package:
 196
 197         http://sourceware.cygnus.com/cygwin/
 198
 199 After installing them, you will probably have to modify the config.nmake
 200 file to specify where the Cygwin binaries are installed.
 201
 202 Python for Win32 is available from
 203
 204         http://www.python.org/
 205
 206
 207 Instructions for Cygwin
 208 -----------------------
 209 No one has ever compiled Ethereal entirely with Cygwin.  It should not
 210 be difficult, however.  This spot is reserved for your instructions on
 211 how to compile Ethereal with Cygwin.