README.win32

   1 $Id: README.win32,v 1.28 2001/10/18 15:44:36 gerald 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 As of WinPcap 2.1, all the WinPcap libraries have been released as DLLs.
  37 This means that Ethereal can detect the presence of WinPcap at run time,
  38 which means that only one version of the Ethereal binaries needs to be
  39 shipped.
  40
  41 If you don't want to capture packets, just install the Ethereal
  42 package. If you do want to capture packets, install Ethereal *and*
  43 install the latest non-beta version of WinPcap, available from:
  44
  45         http://netgroup-serv.polito.it/winpcap/
  46
  47 and mirrored at
  48
  49         http://netgroup-mirror.ethereal.com/winpcap/
  50
  51 and
  52
  53         http://www.wiretapped.net/security/packet-capture/winpcap/default.htm
  54
  55 If you already have an earlier version of WinPcap installed, you need to
  56 un-install it and install the latest version.  If the older version is
  57 WinPcap 2.0 or 2.02, and you have other applications that use the older
  58 version , you will have to decide which applications to keep, since
  59 WinPcap 2.0/2.02 and later versions cannot be installed on the same
  60 system at the same time.
  61
  62 If Ethereal is not capturing packets and you have WinPcap installed, you
  63 can test your WinPcap installation by installing WinDump (tcpdump for
  64 Windows) ported by the same folks who make WinPcap.  It's at:
  65
  66         http://netgroup-serv.polito.it/windump/
  67
  68 and mirrored at
  69
  70         http://www.wiretapped.net/security/packet-capture/windump/default.htm
  71
  72 They also make Analyzer, a GUI sniffer for Win32:
  73
  74         http://netgroup-serv.polito.it/analyzer/
  75
  76 The rest of this documentation is only interesting if
  77 you want to compile Ethereal yourself.
  78
  79
  80 Running Ethereal, Tethereal, and Editcap on Win32
  81 =================================================
  82 You need the glib and gtk libraries for running Ethereal.
  83
  84 These packages for win32 can be found at:
  85
  86         http://www.ethereal.com/distribution/win32
  87
  88 and at the home page for the GTK+ for Win32 project:
  89
  90         http://www.gimp.org/~tml/gimp/win32
  91
  92 or
  93         http://www.iki.fi/tml/gimp/win32/
  94
  95 (the mirror nearer to you may be faster).
  96
  97 Plugins (gryphon.dll and mgcp.dll) can go in:
  98         C:\Program Files\Ethereal\plugins\<version>
  99         C:\Ethereal\plugins\<version>
 100
 101 Where <version> is the version number, without brackets.
 102 For example, C:\Ethereal\plugins\0.8.16
 103
 104 Yes, the location of plugins needs to be more flexible.
 105
 106 Make sure the glib and gtk DLL's are in your path - i.e., that your path
 107 includes the directory (folder) or directories (folders) in which those
 108 DLLs are found - when you run Ethereal.  This includes gtk-*.dll,
 109 glib-*.dll, gmodule-*.dll, gdk-*.dll, gnu-intl.dll, and iconv-*.dll.
 110 As of the 20000805 GTK+/GLIB distribution, gthread-*.dll is no longer needed.
 111
 112 The Win32 Binary distribution, available from
 113
 114         http://www.ethereal.com/distribution/win32
 115
 116 used different version of the GTK+/GLIB libraries at different points
 117 in time:
 118
 119 Ethereal Version                GTK+/GLIB version
 120 ----------------                -----------------
 121 0.8.16 and after                20001226
 122 0.8.11 - 0.8.15                 20000805
 123 0.8.9 - 0.8.10                  20000416
 124 0.8.8 and before                19990828
 125
 126
 127 Capturing Packets
 128 -----------------
 129 In order to capture with Win32, you need to install the NDIS
 130 packet capture driver for your particular Win32 OS; drivers for Windows
 131 9x, Windows NT 4.0, and Windows 2000 can be downloaded from the
 132 WinPcap home page:
 133
 134         http://netgroup-serv.polito.it/winpcap/
 135
 136 or the mirror site at
 137
 138         http://www.wiretapped.net/security/packet-capture/winpcap/default.htm
 139
 140 Compiling the Ethereal distribution from source
 141 ===============================================
 142 You'll need the development package for GLIB, GTK+, and WinPcap.
 143 Those versions are available from the respctive home pages for
 144 each project (the same URLs as listed above). The development
 145 packages contain header files and stub libaries to link against.
 146
 147 The use of an SNMP library has not been made to work yet in
 148 Ethereal/Win32, but a binary distribution of the UCD SNMP package,
 149 including header files and a DLL of the UCD SNMP library, can be had
 150 from:
 151
 152         ftp://ftp.revelstone.com/snmp/binaries/
 153
 154 The file will probably be called "ucd-snmp-X.X-x86-win32.zip", where
 155 "X.X" is the version number of the UCD SNMP library.
 156
 157 Instructions for MS Visual C
 158 ----------------------------
 159 Modify the config.nmake file in the top directory of the Ethereal
 160 source tree to work for your local configuration. You should not
 161 have to modify any other Makefile.
 162
 163 In order to compile, at least with the default settings, you
 164 also need zlib, which is provided as an archive library, not
 165 a DLL. The pre-compiled zlib which comes with the "extralibs"
 166 package from Gimp/Win32 is faulty; a working version can be
 167 downloaded from:
 168
 169         http://www.ethereal.com/distribution/win32/zlib-1.1.3-fixed.zip
 170
 171 Be sure that your command-line environment is set up to compile
 172 and link with MSVC. When installing MSVC, you can have your
 173 system's environment set up to always allow compiling from the
 174 command line, or you can invoke the vcvars32.bat script.
 175
 176 The first time you build Ethereal, run the script "cleanbld.bat" to make
 177 sure that the "config.h" files will be reconstructed from the
 178 "config.h.win32" files.  (If, for example, you have "config.h" files
 179 left over from a Unix build, a Windows build will fail.)
 180
 181 In the ethereal directory, type "nmake -f makefile.nmake". It will
 182 recurse into the subdirectories as appropriate.
 183
 184 Some generated source is created by traditionally "Unix-ish" tools.
 185 If you are building from an official distribution, these files are
 186 already generated, so you have nothing to worry about unless you
 187 modify the source. If building from a CVS image, you'll need the tools
 188 to generate C source. The "special" files and their requisite tools are:
 189
 190 Source                          Output                  Tool
 191 ------                          ------                  ----
 192 config.h.win32                  config.h                sed
 193 epan/config.h.win32             epan/config.h           sed
 194 image/ethereal.rc.in            image/ethereal.rc       sed
 195 image/tethereal.rc.in           image/tethereal.rc      sed
 196 image/editcap.rc.in             image/editcap.rc        sed
 197 image/mergecap.rc.in            image/mergecap.rc       sed
 198 image/text2pcap.rc.in           image/text2pcap.rc      sed
 199 packaging/nsis/ethereal.nsi.in  packaging/ethereal.nsi  sed
 200 wiretap/config.h.win32          wiretap/config.h        sed
 201 epan/dfilter/dfilter-scanner.l  epan/dfilter/*.c        Flex
 202 text2pcap-scanner.l             *.c                     Flex
 203 wiretap/ascend-scanner.l        *.c                     Flex
 204 wiretap/ascend-grammar.y        *.c,*.h                 Bison/Yacc
 205 ncp2222.py                      packet-ncp2222.c        Python
 206
 207 make-reg-dotc, packet*.c        register.c              Bash + grep + sed
 208 or
 209 make-reg-dotc.py, packet*.c     register.c              Python
 210
 211 The Makefile.nmake supplied with the Ethereal distribution will
 212 attempt to make register.c with Python, since it is much much much
 213 faster than the shell version. The reason it is faster is because
 214 the shell version launches multiple processes (grep, sed) for each
 215 source file, multiple times. The Python script is one process. This
 216 matters a lot on Win32. If for some reason you want to build register.c
 217 with the shell script, uncomment out the action line for the register.c
 218 target in Makefile.nmake.
 219
 220 If you have a Unix system handy, you can first build on Unix to create
 221 most of the source files that these tools make, then run the build on
 222 Windows.  That will avoid the need for these tools on your Windows
 223 computer.  (This won't work for the files in the "image" directory,
 224 however, as those aren't built on Unix - they're only for Windows
 225 builds.  It also won't work for the "config.h" files; whilst those are
 226 built for Unix, they're specific to the platform on which you're
 227 building, and the "config.h" files constructed for a Unix build will not
 228 work with a Windows build.)
 229
 230 If you don't have a Unix system handy, most of those tools are available for
 231 Win32 systems as part of the Cygwin package:
 232
 233         http://sourceware.cygnus.com/cygwin/
 234
 235 After installing them, you will probably have to modify the config.nmake
 236 file to specify where the Cygwin binaries are installed.
 237
 238 Python for Win32 is available from
 239
 240         http://www.python.org/
 241
 242
 243 Instructions for Cygwin
 244 -----------------------
 245 No one has ever compiled Ethereal entirely with Cygwin.  It should not
 246 be difficult, however.  This spot is reserved for your instructions on
 247 how to compile Ethereal with Cygwin.