Modification of version resource.
[obnox/wireshark/wip.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index a155d0d5195e14630a916bb8f4bbb2f84da60d9a..7cd2896d60e6e15fcdf3d8cea0345f8c296c9a99 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,3 +1,9 @@
+NOTE: this document applies to the Wireshark source releases.  It also
+applies to buildbot source tarballs, but it does not apply to source
+code checked out directly from Subversion, as files such as the
+configuration script are not checked into Subversion, but need to be
+generated from the autoconf and automake files.
+
 Installation
 ============
 
@@ -6,55 +12,63 @@ that can run the "configure" script in this same directory. These
 are not the installation instructions for Windows systems; see
 README.win32 for those instructions.
 
-0. This is alpha software.  Beware.
+0. This is beta software.  Beware.
 
-1. If you wish to build Ethereal, make sure you have GTK+ and GLIB
-    installed. Try running 'gtk-config --version' and
-    'glib-config --version' to see if you have them installed.
-    Ethereal needs versions 1.2.0 or above of both these packages.
-    If you need to install or re-install GTK+ or GLIB, you can find
-    the packages at:
+1. If you wish to build Wireshark, make sure you have GTK+ and GLib
+   installed. Try running 'pkg-config glib-2.0 --modversion' to see if
+   you have GLib 2.x installed and, if that fails, try running
+   'glib-config --version' to see if you have GLib 1.2[.x] installed. 
+   Then try running 'pkg-config gtk+-2.0 --modversion' to see if you
+   have GTK+ 2.x installed and, if that fails, try running
+   'gtk-config --version' to see if you have GTK+ 1.2[.x] installed.
+   Wireshark needs versions 1.2.0 or above of both these packages.
+   If you need to install or re-install GTK+ or GLIB, you can find
+   the packages at:
 
         http://www.gtk.org
 
-    If you installed GTK+ from a binary package, you may have to
-    install a "development" package; there may be separate "user's"
-    and "developer's" packages, with the former not including
-    header files and the like.  For example, Red Hat users will
-    need to install a "gtk-devel" .rpm.
+   If you installed GTK+ from a binary package, you may have to
+   install a "development" package; there may be separate "user's"
+   and "developer's" packages, with the former not including
+   header files and the like.  For example, Red Hat users will
+   need to install a "gtk-devel" .rpm.
+
+   Note also that Wireshark configuration defaults to using GTK+ and
+   GLib 2.x; you need to configure with --disable-gtk2 to use GTK+
+   1.2[.x].
 
-2. If you wish to build Tethereal, the line-mode version of Ethereal,
-    make sure you have GLIB installed.  See note #1 above for instructions
-    on checking if you have GLIB installed. You can download GLIB from
-    the same site as GTK.
+2. If you wish to build TShark, the line-mode version of Wireshark,
+   make sure you have GLIB installed.  See note #1 above for instructions
+   on checking if you have GLIB installed. You can download GLIB from
+   the same site as GTK.
 
 3. If you want to capture packets, make sure you have libpcap
-    installed.  The latest "official" version can be found at
-
-    http://www.tcpdump.org .
-
-    If you've downloaded the 0.5.2 version, make sure you install
-    the headers ('make install-incl') when you install the library.
-    The CVS snapshots will install the headers if you do 'make
-    install', and have no 'install-incl' target.
-
-    If you installed libpcap from a binary package, you may have to
-    install a "development" package; for example, there's
-    apparently a "libpcap0" Debian package, but it just includes a
-    shared library, a copyright notice, changelog files, and a
-    README file - you also need to install a "libpcap-dev" package
-    to get header files, a non-shared library, and the man page.
-    Similarly, Red Hat 5.x users will need to install a "libpcap-devel"
-    .rpm to go along with the "libpcap" .rpm.
-
-4. Run './configure' in the Ethereal distribution directory.
-    Running './configure --help' displays a list of options.
-    The file 'INSTALL.configure' contains general instructions for
-    using 'configure' and 'make'. Ethereal has some
-    non-generic configure options:
+   installed.  The latest "official" version can be found at
+
+        http://www.tcpdump.org .
+
+   If you've downloaded the 0.5.2 version, make sure you install
+   the headers ('make install-incl') when you install the library.
+   The CVS snapshots will install the headers if you do 'make
+   install', and have no 'install-incl' target.
+
+   If you installed libpcap from a binary package, you may have to
+   install a "development" package; for example, there's
+   apparently a "libpcap0" Debian package, but it just includes a
+   shared library, a copyright notice, changelog files, and a
+   README file - you also need to install a "libpcap-dev" package
+   to get header files, a non-shared library, and the man page.
+   Similarly, Red Hat 5.x users will need to install a "libpcap-devel"
+   .rpm to go along with the "libpcap" .rpm.
+
+4. Run './configure' in the Wireshark distribution directory.
+   Running './configure --help' displays a list of options.
+   The file 'INSTALL.configure' contains general instructions for
+   using 'configure' and 'make'. Wireshark has some non-generic configure 
+   options:
 
     --sysconfdir=DIR
-        Ethereal installs a support file (manuf) in ${PREFIX}/etc by
+        Wireshark installs a support file (manuf) in ${PREFIX}/etc by
         default, where ${PREFIX} comes from --prefix=DIR. If you do not
         specify any --prefix option, ${PREFIX} is "/usr/local".
         You can change the location of the manuf file with the --sysconfdir
@@ -65,13 +79,16 @@ README.win32 for those instructions.
         additional header files and libraries. Using this switch keeps
         'configure' from looking there
 
-    --disable-ethereal
+    --disable-wireshark
         By default, if 'configure' finds the GTK+ libraries, the Makefile
-        build Ethereal, the GUI packet analyzer. You can disable the
-        build of the GUI version of Ethereal with this switch.
+        build Wireshark, the GUI packet analyzer. You can disable the
+        build of the GUI version of Wireshark with this switch.
+
+    --disable-gtk2
+        Build Glib/Gtk+ 1.2[.x]-based wireshark.
 
-    --disable-tethereal
-        By default the line-mode packet analyzer, Tethereal, is built.
+    --disable-tshark
+        By default the line-mode packet analyzer, TShark, is built.
         Use this switch to avoid building it.
 
     --disable-editcap
@@ -86,8 +103,8 @@ README.win32 for those instructions.
         By default the hex-dump-to-capture file conversion program
         is built. Use this switch to avoid building it.
 
-    --disable-idl2eth
-        By default the IDL-to-ethereal-dissector-source-code converter
+    --disable-idl2wrs
+        By default the IDL-to-wireshark-dissector-source-code converter
         is built. Use this switch to avoid building it.
 
     --enable-dftest
@@ -99,23 +116,30 @@ README.win32 for those instructions.
         is not built. Use this switch to build it.
 
     --without-pcap
-        If you chose to build a packet analyzer that can analyze
+        If you choose to build a packet analyzer that can analyze
         capture files but cannot capture packets on its own, but you
-        *do* have libpcap installed, use --without-pcap to avoid
-        using libpcap.
+        *do* have libpcap installed, or if you are trying to build
+        Wireshark on a system that doesn't have libpcap installed (in
+        which case you have no choice but to build a version that can
+        analyze capture files but cannot capture packets on its own),
+        use --without-pcap to avoid using libpcap.
 
     --with-pcap=DIR
-        Use this tell Ethereal where you have libpcap installed, if in a
-        non-standard location.
+        Use this to tell Wireshark where you have libpcap installed, if
+        it is installed in a non-standard location.
 
-    --disable-zlib
+    --without-zlib
         By default, if 'configure' finds zlib (a.k.a, libz), the
         wiretap library will be built so that it can read compressed
         capture files. If you have zlib but do not wish to build
-        it into the wiretap library, used by Ethereal, Tethereal, and
+        it into the wiretap library, used by Wireshark, TShark, and
         the capture-file utilities that come in this package, use
         this switch.
 
+    --with-zlib=DIR
+        Use this to tell Wireshark where you have zlib installed, if it
+        is installed in a non-standard location.
+
     --disable-ipv6
         If 'configure' finds support for IPv6 name resolution on
         your system, the packet analyzers will make use of it.
@@ -124,23 +148,26 @@ README.win32 for those instructions.
 
     --enable-setuid-install
         Use this switch to install the packet analyzers as setuid.
-        Installating Ethereal and Tethereal as setuid 'root' is
-        dangerous. Repeat: IT'S DANGEROUS. Don't do it.
+        Installing Wireshark and TShark as setuid 'root' is
+        dangerous. Repeat: IT'S DANGEROUS. Don't do it.  (In fact,
+       applications using GTK+ 2.x will refuse to run setuid at
+       all, so Wireshark might not even run setuid.)
 
     --with-ssl=DIR
         If your SNMP library needs the SSL library, and your
         SSL library is installed in a non-standard location,
         you can specify where your SSL library is with this switch.
 
-    --disable-snmp
-        If 'configure' finds a supported SNMP library on your system,
-        the SNMP dissector will be enhanced to use the SNMP library.
-        Use this switch to avoid using the SNMP library even if you
-        have it installed.
+    --without-net-snmp
+        If 'configure' finds a supported version of the Net-SNMP library
+        on your system,  the SNMP dissector will be enhanced to use
+        routines from the Net-SNMP library. Use this switch to avoid
+        using the Net-SNMP library even if you have it installed.
 
-    --with-ucdsnmp=DIR
-        Tell the 'configure' script where your UCD SNMP library
-        is located, if not in a standard location.
+    --with-net-snmp=PATH
+        Tell the 'configure' script where your net-snmp-config shell script 
+        that comes with the net-snmp package is located, if not in a standard 
+        location.
 
     --without-plugins
         By default, if your system can support run-time loadable modules,
@@ -149,7 +176,7 @@ README.win32 for those instructions.
 
     --with-plugins=DIR
         By default, plugins are installed in
-        ${LIBDIR}/ethereal/plugins/${VERSION}
+        ${LIBDIR}/wireshark/plugins/${VERSION}
 
         ${LIBDIR} can be set with --libdir, or defaults to ${EPREFIX/lib}
         ${EPREFIX} can be set with --exec-prefix, or defaults to ${PREFIX}
@@ -159,28 +186,27 @@ README.win32 for those instructions.
         are installed.
 
 5. After running './configure', you will see a summary of some
-    of the options you chose. Ensure that the summary reflects
-    what you want. If it doesn't, re-run './configure' with new options.
+   of the options you chose. Ensure that the summary reflects
+   what you want. If it doesn't, re-run './configure' with new options.
 
 6. Run 'make'.  Hopefully, you won't run into any problems.
 
-7. Run './ethereal' or './tethereal', and make sure things are working.
-    You must have root privileges in order to capture live data.
+7. Run './wireshark' or './tshark', and make sure things are working.
+   You must have root privileges in order to capture live data.
 
 8. Run 'make install'.  If you wish to install the man page, run
-    'make install-man'.  If you're running a system that supports
-    the Apt, RPM, or System V Release 4 packaging systems, you can
-    run one of
+   'make install-man'.  If you're running a system that supports
+   the Apt, RPM, or System V Release 4 packaging systems, you can
+   run one of
 
-    make debian-package        # Builds a binary package using dpkg
-    make rpm-package   # Builds a binary package using rpm
-    make srpm-package  # Builds a source package using rpm
-    make svr4-package  # Builds a source package using pkgmk
-    make solaris-package       # Same as "make svr4-package"
+        make debian-package    # Builds a binary package using dpkg
+        make rpm-package       # Builds a binary package using rpm
+        make srpm-package      # Builds a source package using rpm
+        make svr4-package      # Builds a source package using pkgmk
+        make solaris-package   # Same as "make svr4-package"
 
-    to make an installable package for your system.
+   to make an installable package for your system.
 
 If you have trouble with the build or installation process, you can
-find assistance on the ethereal-users and ethereal-dev mailing lists.
-See http://www.ethereal.com/lists/ for details.
-
+find assistance on the wireshark-users and wireshark-dev mailing lists.
+See http://www.wireshark.org/lists/ for details.