README.win32

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