INSTALL

   1 Installation
   2 ============
   3
   4 These are installation instructions for Unix and Unix-like systems
   5 that can run the "configure" script in this same directory. These
   6 are not the installation instructions for Windows systems; see
   7 README.win32 for those instructions.
   8
   9 0. This is alpha software.  Beware.
  10
  11 1. If you wish to build Ethereal, make sure you have GTK+ and GLIB
  12     installed. Try running 'gtk-config --version' and
  13     'glib-config --version' to see if you have them installed.
  14     Ethereal needs versions 1.2.0 or above of both these packages.
  15     If you need to install or re-install GTK+ or GLIB, you can find
  16     the packages at:
  17
  18         http://www.gtk.org
  19
  20     If you installed GTK+ from a binary package, you may have to
  21     install a "development" package; there may be separate "user's"
  22     and "developer's" packages, with the former not including
  23     header files and the like.  For example, Red Hat users will
  24     need to install a "gtk-devel" .rpm.
  25
  26 2. If you wish to build Tethereal, the line-mode version of Ethereal,
  27     make sure you have GLIB installed.  See note #1 above for instructions
  28     on checking if you have GLIB installed. You can download GLIB from
  29     the same site as GTK.
  30
  31 3. If you want to capture packets, make sure you have libpcap
  32     installed.  The latest "official" version can be found at
  33
  34     http://www.tcpdump.org .
  35
  36     If you've downloaded the 0.5.2 version, make sure you install
  37     the headers ('make install-incl') when you install the library.
  38     The CVS snapshots will install the headers if you do 'make
  39     install', and have no 'install-incl' target.
  40
  41     If you installed libpcap from a binary package, you may have to
  42     install a "development" package; for example, there's
  43     apparently a "libpcap0" Debian package, but it just includes a
  44     shared library, a copyright notice, changelog files, and a
  45     README file - you also need to install a "libpcap-dev" package
  46     to get header files, a non-shared library, and the man page.
  47     Similarly, Red Hat 5.x users will need to install a "libpcap-devel"
  48     .rpm to go along with the "libpcap" .rpm.
  49
  50 4. Run './configure' in the Ethereal distribution directory.
  51     Running './configure --help' displays a list of options.
  52     The file 'INSTALL.configure' contains general instructions for
  53     using 'configure' and 'make'. Ethereal has some
  54     non-generic configure options:
  55
  56     --sysconfdir=DIR
  57         Ethereal installs a support file (manuf) in ${PREFIX}/etc by
  58         default, where ${PREFIX} comes from --prefix=DIR. If you do not
  59         specify any --prefix option, ${PREFIX} is "/usr/local".
  60         You can change the location of the manuf file with the --sysconfdir
  61         option.
  62
  63     --disable-usr-local
  64         By default 'configure' will look in /usr/local/{include,lib} for
  65         additional header files and libraries. Using this switch keeps
  66         'configure' from looking there
  67
  68     --disable-ethereal
  69         By default, if 'configure' finds the GTK+ libraries, the Makefile
  70         build Ethereal, the GUI packet analyzer. You can disable the
  71         build of the GUI version of Ethereal with this switch.
  72
  73     --disable-tethereal
  74         By default the line-mode packet analyzer, Tethereal, is built.
  75         Use this switch to avoid building it.
  76
  77     --disable-editcap
  78         By default the capture-file editing program is built.
  79         Use this switch to avoid building it.
  80
  81     --disable-mergecap
  82         By default the capture-file merging program is built.
  83         Use this switch to avoid building it.
  84
  85     --disable-text2pcap
  86         By default the hex-dump-to-capture file conversion program
  87         is built. Use this switch to avoid building it.
  88
  89     --disable-idl2eth
  90         By default the IDL-to-ethereal-dissector-source-code converter
  91         is built. Use this switch to avoid building it.
  92
  93     --enable-dftest
  94         By default the display-filter-compiler test program is not built.
  95         Use this switch to build it.
  96
  97     --enable-randpkt
  98         By default the program which creates random packet-capture files
  99         is not built. Use this switch to build it.
 100
 101     --without-pcap
 102         If you chose to build a packet analyzer that can analyze
 103         capture files but cannot capture packets on its own, but you
 104         *do* have libpcap installed, use --without-pcap to avoid
 105         using libpcap.
 106
 107     --with-pcap=DIR
 108         Use this tell Ethereal where you have libpcap installed, if in a
 109         non-standard location.
 110
 111     --disable-zlib
 112         By default, if 'configure' finds zlib (a.k.a, libz), the
 113         wiretap library will be built so that it can read compressed
 114         capture files. If you have zlib but do not wish to build
 115         it into the wiretap library, used by Ethereal, Tethereal, and
 116         the capture-file utilities that come in this package, use
 117         this switch.
 118
 119     --disable-ipv6
 120         If 'configure' finds support for IPv6 name resolution on
 121         your system, the packet analyzers will make use of it.
 122         To avoid using IPv6 name resolution if you have the support for it,
 123         use this switch.
 124
 125     --enable-setuid-install
 126         Use this switch to install the packet analyzers as setuid.
 127         Installating Ethereal and Tethereal as setuid 'root' is
 128         dangerous. Repeat: IT'S DANGEROUS. Don't do it.
 129
 130     --with-ssl=DIR
 131         If your SNMP library needs the SSL library, and your
 132         SSL library is installed in a non-standard location,
 133         you can specify where your SSL library is with this switch.
 134
 135     --disable-snmp
 136         If 'configure' finds a supported SNMP library on your system,
 137         the SNMP dissector will be enhanced to use the SNMP library.
 138         Use this switch to avoid using the SNMP library even if you
 139         have it installed.
 140
 141     --with-ucdsnmp=DIR
 142         Tell the 'configure' script where your UCD SNMP library
 143         is located, if not in a standard location.
 144
 145     --without-plugins
 146         By default, if your system can support run-time loadable modules,
 147         the packet analyzers are build with support for plugins.
 148         Use this switcht to build packet analyzers without plugin support.
 149
 150     --with-plugins=DIR
 151         By default, plugins are installed in
 152         ${LIBDIR}/ethereal/plugins/${VERSION}
 153
 154         ${LIBDIR} can be set with --libdir, or defaults to ${EPREFIX/lib}
 155         ${EPREFIX} can be set with --exec-prefix, or defaults to ${PREFIX}
 156         ${VERSION} is the Etherael version.
 157
 158         Use this switch to change the location where plugins
 159         are installed.
 160
 161 5. After running './configure', you will see a summary of some
 162     of the options you chose. Ensure that the summary reflects
 163     what you want. If it doesn't, re-run './configure' with new options.
 164
 165 6. Run 'make'.  Hopefully, you won't run into any problems.
 166
 167 7. Run './ethereal' or './tethereal', and make sure things are working.
 168     You must have root privileges in order to capture live data.
 169
 170 8. Run 'make install'.  If you wish to install the man page, run
 171     'make install-man'.  If you're running a system that supports
 172     the Apt, RPM, or System V Release 4 packaging systems, you can
 173     run one of
 174
 175     make debian-package # Builds a binary package using dpkg
 176     make rpm-package    # Builds a binary package using rpm
 177     make srpm-package   # Builds a source package using rpm
 178     make svr4-package   # Builds a source package using pkgmk
 179     make solaris-package        # Same as "make svr4-package"
 180
 181     to make an installable package for your system.
 182
 183 If you have trouble with the build or installation process, you can
 184 find assistance on the ethereal-users and ethereal-dev mailing lists.
 185 See http://www.ethereal.com/lists/ for details.
 186