-Basic Installation
-==================
-
- These are generic installation instructions.
-
- The `configure' shell script attempts to guess correct values for
-various system-dependent variables used during compilation. It uses
-those values to create a `Makefile' in each directory of the package.
-It may also create one or more `.h' files containing system-dependent
-definitions. Finally, it creates a shell script `config.status' that
-you can run in the future to recreate the current configuration, a file
-`config.cache' that saves the results of its tests to speed up
-reconfiguring, and a file `config.log' containing compiler output
-(useful mainly for debugging `configure').
-
- If you need to do unusual things to compile the package, please try
-to figure out how `configure' could check whether to do them, and mail
-diffs or instructions to the address given in the `README' so they can
-be considered for the next release. If at some point `config.cache'
-contains results you don't want to keep, you may remove or edit it.
-
- The file `configure.in' is used to create `configure' by a program
-called `autoconf'. You only need `configure.in' if you want to change
-it or regenerate `configure' using a newer version of `autoconf'.
-
-The simplest way to compile this package is:
-
- 1. `cd' to the directory containing the package's source code and type
- `./configure' to configure the package for your system. If you're
- using `csh' on an old version of System V, you might need to type
- `sh ./configure' instead to prevent `csh' from trying to execute
- `configure' itself.
-
- Running `configure' takes awhile. While running, it prints some
- messages telling which features it is checking for.
-
- 2. Type `make' to compile the package.
-
- 3. Optionally, type `make check' to run any self-tests that come with
- the package.
-
- 4. Type `make install' to install the programs and any data files and
- documentation.
-
- 5. You can remove the program binaries and object files from the
- source code directory by typing `make clean'. To also remove the
- files that `configure' created (so you can compile the package for
- a different kind of computer), type `make distclean'. There is
- also a `make maintainer-clean' target, but that is intended mainly
- for the package's developers. If you use it, you may have to get
- all sorts of other programs in order to regenerate files that came
- with the distribution.
-
-Compilers and Options
-=====================
-
- Some systems require unusual options for compilation or linking that
-the `configure' script does not know about. You can give `configure'
-initial values for variables by setting them in the environment. Using
-a Bourne-compatible shell, you can do that on the command line like
-this:
- CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
-
-Or on systems that have the `env' program, you can do it like this:
- env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
-
-Compiling For Multiple Architectures
-====================================
-
- You can compile the package for more than one kind of computer at the
-same time, by placing the object files for each architecture in their
-own directory. To do this, you must use a version of `make' that
-supports the `VPATH' variable, such as GNU `make'. `cd' to the
-directory where you want the object files and executables to go and run
-the `configure' script. `configure' automatically checks for the
-source code in the directory that `configure' is in and in `..'.
-
- If you have to use a `make' that does not supports the `VPATH'
-variable, you have to compile the package for one architecture at a time
-in the source code directory. After you have installed the package for
-one architecture, use `make distclean' before reconfiguring for another
-architecture.
-
-Installation Names
-==================
-
- By default, `make install' will install the package's files in
-`/usr/local/bin', `/usr/local/man', etc. You can specify an
-installation prefix other than `/usr/local' by giving `configure' the
-option `--prefix=PATH'.
-
- You can specify separate installation prefixes for
-architecture-specific files and architecture-independent files. If you
-give `configure' the option `--exec-prefix=PATH', the package will use
-PATH as the prefix for installing programs and libraries.
-Documentation and other data files will still use the regular prefix.
-
- In addition, if you use an unusual directory layout you can give
-options like `--bindir=PATH' to specify different values for particular
-kinds of files. Run `configure --help' for a list of the directories
-you can set and what kinds of files go in them.
-
- If the package supports it, you can cause programs to be installed
-with an extra prefix or suffix on their names by giving `configure' the
-option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
-
-Optional Features
-=================
-
- Some packages pay attention to `--enable-FEATURE' options to
-`configure', where FEATURE indicates an optional part of the package.
-They may also pay attention to `--with-PACKAGE' options, where PACKAGE
-is something like `gnu-as' or `x' (for the X Window System). The
-`README' should mention any `--enable-' and `--with-' options that the
-package recognizes.
-
- For packages that use the X Window System, `configure' can usually
-find the X include and library files automatically, but if it doesn't,
-you can use the `configure' options `--x-includes=DIR' and
-`--x-libraries=DIR' to specify their locations.
-
-Specifying the System Type
-==========================
-
- There may be some features `configure' can not figure out
-automatically, but needs to determine by the type of host the package
-will run on. Usually `configure' can figure that out, but if it prints
-a message saying it can not guess the host type, give it the
-`--host=TYPE' option. TYPE can either be a short name for the system
-type, such as `sun4', or a canonical name with three fields:
- CPU-COMPANY-SYSTEM
-
-See the file `config.sub' for the possible values of each field. If
-`config.sub' isn't included in this package, then this package doesn't
-need to know the host type.
-
- If you are building compiler tools for cross-compiling, you can also
-use the `--target=TYPE' option to select the type of system they will
-produce code for and the `--build=TYPE' option to select the type of
-system on which you are compiling the package.
-
-Sharing Defaults
-================
-
- If you want to set default values for `configure' scripts to share,
-you can create a site shell script called `config.site' that gives
-default values for variables like `CC', `cache_file', and `prefix'.
-`configure' looks for `PREFIX/share/config.site' if it exists, then
-`PREFIX/etc/config.site' if it exists. Or, you can set the
-`CONFIG_SITE' environment variable to the location of the site script.
-A warning: not all `configure' scripts look for a site script.
-
-Operation Controls
-==================
-
- `configure' recognizes the following options to control how it
-operates.
-
-`--cache-file=FILE'
- Use and save the results of the tests in FILE instead of
- `./config.cache'. Set FILE to `/dev/null' to disable caching, for
- debugging `configure'.
-
-`--help'
- Print a summary of the options to `configure', and exit.
-
-`--quiet'
-`--silent'
-`-q'
- Do not print messages saying which checks are being made. To
- suppress all normal output, redirect it to `/dev/null' (any error
- messages will still be shown).
-
-`--srcdir=DIR'
- Look for the package's source code in directory DIR. Usually
- `configure' can determine that directory automatically.
-
-`--version'
- Print the version of Autoconf used to generate the `configure'
- script, and exit.
-
-`configure' also accepts some other, not widely useful, options.
+$Id$
+
+NOTE: this document applies to the Wireshark source releases and
+buildbot source tarballs. 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.
+See http://wiki.wireshark.org/Development if you would like to build
+the source code checked out directly from Subversion.
+
+Installation
+============
+
+These are installation instructions for Unix and Unix-like systems
+that can run the "configure" script in this same directory. These
+are not the installation instructions for Windows systems; see
+README.windows for those instructions.
+
+0. This is software. Beware.
+
+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.
+
+ 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].
+
+ Please also note that GTK+ 1.2[.x] is only supported up to
+ Wireshark 1.0.x. From Wireshark 1.1.x onwards only GTK+ 2.x
+ is supported.
+
+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. Building Wireshark requires Perl (specifically the pod2man program)
+ so that the documentation can be built.
+
+5. Run './configure' in the Wireshark distribution directory.
+ Running './configure --help' displays a complete list of options.
+ The file 'INSTALL.configure' contains general instructions for
+ using 'configure' and 'make'. Some of the Wireshark non-generic
+ configure options are as follows:
+
+ --sysconfdir=DIR
+ 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
+ option.
+
+ --disable-usr-local
+ By default 'configure' will look in /usr/local/{include,lib} for
+ additional header files and libraries. Using this switch keeps
+ 'configure' from looking there
+
+ --disable-wireshark
+ By default, if 'configure' finds the GTK+ libraries, the Makefile
+ builds 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.
+ Note: not supported from Wireshark 1.1.x onwards
+
+ --disable-tshark
+ By default the line-mode packet analyzer, TShark, is built.
+ Use this switch to avoid building it.
+
+ --disable-editcap
+ By default the capture-file editing program is built.
+ Use this switch to avoid building it.
+
+ --disable-capinfos
+ By default the capture-file statistics reporting pogram
+ is built. Use this switch to avoid building it.
+
+ --disable-mergecap
+ By default the capture-file merging program is built.
+ Use this switch to avoid building it.
+
+ --disable-text2pcap
+ By default the hex-dump-to-capture file conversion program
+ is built. Use this switch to avoid building it.
+
+ --disable-idl2wrs
+ By default the IDL-to-wireshark-dissector-source-code converter
+ is built. Use this switch to avoid building it.
+
+ --disable-dftest
+ By default the display-filter-compiler test program is built.
+ Use this switch to avoid building it.
+
+ --disable-randpkt
+ By default the program which creates random packet-capture files
+ is built. Use this switch to avoid building it.
+
+ --disable-dumpcap
+ By default the network traffic capture program is built.
+ Use this switch to avoid building it.
+
+ --disable-rawshark
+ By default the program used to dump and analyze raw libpcap data
+ is built. Use this switch to avoid building it.
+
+ --disable-ipv6
+ If 'configure' finds support for IPv6 name resolution on
+ your system, the packet analyzers will make use of it.
+ To avoid using IPv6 name resolution if you have the support for it,
+ use this switch.
+
+ --enable-setuid-install
+ Wireshark and TShark rely on dumpcap for packet capture. Setting this
+ flag installs dumpcap with setuid root permissions, which lets any user
+ on the system capture live traffic. If this is not desired, you can
+ restrict dumpcap's permissions so that only a single user or group can
+ run it. This can be used in conjunction with --with-libcap described
+ below.
+
+ Running Wireshark or TShark as root is not recommended.
+
+ --without-libcap
+ By default, if 'configure' finds libcap (the POSIX capabilities
+ library) dumpcap will be built so that if it is installed setuid
+ root, it will attempt to retain CAP_NET_RAW and CAP_NET_ADMIN
+ before dropping root privileges. Use this option to disable this
+ behavior.
+
+ --with-libcap=DIR
+ Use this option to tell 'configure' where libcap is installed,
+ if it is installed in a non-standard location. Note that libcap
+ (the POSIX capabilities library, sans "p") and libpcap (the
+ packet capture library, avec "p") are two very different things.
+
+ --without-pcap
+ 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, 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 to tell Wireshark where you have libpcap installed, if
+ it is installed in a non-standard location.
+
+ --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 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.
+
+ --without-plugins
+ By default, if your system can support run-time loadable modules,
+ the packet analyzers are build with support for plugins.
+ Use this switch to build packet analyzers without plugin support.
+
+ --with-plugins=DIR
+ By default, plugins are installed in
+ ${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}
+ ${VERSION} is the Wireshark version.
+
+ Use this switch to change the location where plugins
+ are installed.
+
+6. 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.
+
+7. Run 'make'. Hopefully, you won't run into any problems.
+
+8. Run './wireshark' or './tshark' or ./dumpcap, and make sure things are
+ working. You must have root privileges in order to capture live data.
+
+9. Run 'make install'. If you're running a system that supports
+ the Apt, RPM, OSX, 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 binary package using pkgmk
+ make solaris-package # Same as "make svr4-package"
+ make osx-package # Builds a binary package for OSX
+
+ to make an installable package for your system.
+
+If you have trouble with the build or installation process, you can
+find assistance on the wireshark-users and wireshark-dev mailing lists.
+See http://www.wireshark.org/lists/ for details.