Add a new "prefs_register_protocol()" routine, which is like
[obnox/wireshark/wip.git] / README.win32
index f3872e2b401613cd6175748fa4f6e1b0f140ea31..5c473d7a34694393f10f790a86276dcd63d610ff 100644 (file)
-$Id: README.win32,v 1.4 2000/01/25 02:11:30 guy Exp $
+$Id: README.win32,v 1.16 2000/11/06 09:49:43 guy Exp $
 
-Ethereal can be compiled on Win32 platforms. Some libraries are
-needed, however.
+Running Ethereal, Tethereal, and Editcap on Win32
+=================================================
+You need the glib and gtk libraries for running Ethereal. 
+
+These packages for win32 can be found at:
+
+       http://www.ethereal.com/distribution/win32
+
+and at the home page for the GTK+ for Win32 project:
 
-The glib, gtk, glib-dev, and gtk-dev packages for win32 can be found
-at
        http://www.gimp.org/~tml/gimp/win32
 
 or
-
        http://www.iki.fi/tml/gimp/win32/
 
 (the mirror nearer to you may be faster).
 
-You will definitely need these.  Download them and unpack them.  As of
-2000-01-24, at least in one test, some problems have been seen with the
-versions there; the page in question says
+Make sure the glib and gtk DLL's are in your path - i.e., that your path
+includes the directory (folder) or directories (folders) in which those
+DLLs are found - when you run Ethereal.  This includes gtk-*.dll,
+glib-*.dll, gmodule-*.dll, gdk-*.dll, and gnu-intl.dll.  As of the
+20000805 GTK+/GLIB distribution, gthread-*.dll is no longer needed.
 
-       The latest version of my port, 19991218, might be buggier than
-       the next-to-previous version, 1990828.  If you have problems
-       with the latest version, try the 19990828 version instead.
+The Win32 Binary distribution, available from
 
-and the problems seemed not to be present with the 19990828 version.  If
-you see problems (e.g., a mangled hex dump window), that version can be
-found at
+       http://www.ethereal.com/distribution/win32
 
-       http://www.gimp.org/~tml/gimp/win32/index-19990828.html
+used different version of the GTK+/GLIB libraries at different points
+in time:
 
-or
+Ethereal Version               GTK+/GLIB version
+----------------               -----------------
+0.8.11 and after               20000805
+0.8.9 - 0.8.10                 20000416
+0.8.8 and before               19990828
+
+
+Capturing Packets
+-----------------
+Remember, if using the the Win32 Binary distribution, available from
+
+       http://www.ethereal.com/distribution/win32
+
+there are two separate packages, one with non-capturing tools, and
+one with capturing tools. Install the appropriate package. The
+capturing version requires WinPcap, the non-capturing version does not.
+
+In order to capture with Win32, you need to install the NDIS
+packet capture driver for your particular Win32 OS; drivers for Windows
+9x, Windows NT 4.0, and Windows 2000 can be downlaoded from the
+WinPcap home page:
+
+       http://netgroup-serv.polito.it/winpcap/
+
+If Ethereal is not capturing packets, you can test your WinPcap
+installatino by installing WinDump (TCPdump for Windows) ported by the
+same folks who make WinPcap. It's at:
+
+       http://netgroup-serv.polito.it/windump/
+
+They also make Analyzer, a GUI sniffer for Win32:
+
+       http://netgroup-serv.polito.it/analyzer/
 
-       http://www.iki.fi/~tml/gimp/win32/index-19990828.html
+
+Compiling the Ethereal distribution from source
+===============================================
+You'll need the development package for GLIB, GTK+, and WinPcap.
+Those versions are available from the respctive home pages for
+each project (the same URLs as listed above). The development
+packages contain header files and stub libaries to link against.
+
+SNMP and ZLIB are not working yet in Ethereal/Win32, but the
+libraries can be had from these locations if you want to hack:
 
 The UCD SNMP library for win32 can be had from
-ftp://ftp.revelstone.com/pub/snmp/, but it has not been tested
-with Ethereal.
 
-The win32 versions of libpcap have not been integrated into
-Ethereal yet.
+       ftp://ftp.revelstone.com/pub/snmp/
+
 
 Zlib (or 'libz') is available for Win32 from
-http://www.winimage.com/zLibDll/
+
+       http://www.winimage.com/zLibDll/
+
+
 
 Instructions for MS Visual C
 ----------------------------
-Modify the top lines of Makefile.nmake, wiretap/Makefile.nmake, and
-gtk/Makefile.nmake to point to your glib and gtk directories.
+Modify the config.nmake file in the top directory of the Ethereal
+source tree to work for your local configuration. You should not
+have to modify any other Makefile.
 
 Be sure that your command-line environment is set up to compile
-and linke with MSVC. When installing MSVC, you can have your
+and link with MSVC. When installing MSVC, you can have your
 system's environment set up to always allow compiling from the
 command line, or you can invoke the vcvars32.bat script.
 
-In the wiretap directory, type "nmake -f makefile.nmake"
-In the gtk directory, type "nmake -f makefile.nmake"
-Then in the ethereal directory, type "nmake -f makefile.nmake"
+In the ethereal directory, type "nmake -f makefile.nmake". It will
+recurse into the subdirectories as appropriate.
 
-You must set your HOME environment variable for ethereal to work.
+Some generated source is created by traditionally "Unix-ish" tools.
+If you are building from an official distribution, these files are
+already generated, so you have nothing to worry about unless you
+modify the source. If building from a CVS image, you'll need the tools
+to generate C source. The "special" files and their requisite tools are:
 
-Make sure the glib and gtk DLL's are in your path when you run
-ethereal. This includes gtk-*.dll, glib-*.dll, gmodule-*.dll, gdk-*.dll,
-and gthread-*.dll
+Source                         Output                  Tool
+------                         ------                  ----
+dfilter-grammar.y              *.[ch]                  Bison or Yacc
+dfilter-scanner.l              *.c                     Flex
+wiretap/ascend-grammar.y       *.[ch]                  Bison or Yacc
+wiretap/ascend-scanner.l       *.c                     Flex
+make-reg-dotc, packet*.c       register.c              Bash
+ncp2222.py                     packet-ncp2222.c        Python
 
-Instructions for cygwin
------------------------
-No one has ever compiled ethereal with cygwin. It should not be difficult,
-however. This spot is reserverd for your instructions on how to compile
-ethereal with cygwin.
 
+However, if you have a Unix system handy, you can first build on Unix
+to create the source files that these tools make, then run the build
+on Windows.  That will avoid the need for these tools on your Windows
+computer.
+
+If you don't have a Unix system handy, most of those tools are available for
+Win32 systems as part of the Cygwin package:
+
+       http://sourceware.cygnus.com/cygwin/
+
+After installing them, you will probably have to modify the config.nmake
+file to specify where the Cygwin binaries are installed.
+
+Python for Win32 is available from
+
+       http://www.python.org/
+
+
+Instructions for Cygwin
+-----------------------
+No one has ever compiled Ethereal entirely with Cygwin.  It should not
+be difficult, however.  This spot is reserved for your instructions on
+how to compile Ethereal with Cygwin.