-NOTE: this document applies to the Ethereal 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.
+See also https://wiki.wireshark.org/Development.
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.win32 for those instructions.
+README.windows for those instructions.
-0. This is beta software. Beware.
+0. This is 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 the Qt and GLib
+ development packages installed. Try running
+ 'pkg-config glib-2.0 --modversion' to see if you have GLib 2.x
+ installed. Then try running 'pkg-config Qt5Widgets --modversion'
+ to see if you have Qt installed. Wireshark needs version 4.8 or above
+ of Qt, although 5.2 and above are strongly recommended. It needs
+ version 2.22.0 or above of glib-2.0. If you need to install or
+ re-install GLIB, you can find the packages at:
- http://www.gtk.org
+ https://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.
+ You can find Qt at:
- Note also that Ethereal configuration defaults to using GTK+ and
- GLib 2.x; you need to configure with --disable-gtk2 to use GTK+
- 1.2[.x].
+ https://www.qt.io/download
-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.
+ If you installed Qt or GLib from binary packages, you may have to
+ install corresponding "development" packages; 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 "glib2-devel" .rpm.
+
+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.
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:
-
- --sysconfdir=DIR
- Ethereal 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-ethereal
- 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.
-
- --disable-gtk2
- Build Glib/Gtk+ 1.2[.x]-based ethereal.
-
- --disable-tethereal
- By default the line-mode packet analyzer, Tethereal, is built.
+ installed. The latest "official" version can be found at
+
+ http://www.tcpdump.org .
+
+ 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.md 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 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. Building Wireshark requires Python.
+
+6. Create a build directory separate from the source directory. It can
+ be anywhere, but you might run into issues if the path contains
+ spaces.
+
+7. Run 'cmake <options> <path/to/the/wireshark/sources>' in your build
+ directory. Running 'cmake -LH <path/to/the/wireshark/sources>'
+ displays a complete list of options. The "Tool Reference" section of
+ Developer's Guide contains general instructions for using CMake. Some
+ of the Wireshark-specific options are as follows:
+
+ -G Ninja
+ CMake supports many different build systems, including UNIX
+ Make, MSBuild, and Ninja. UNIX Make is the default, but Ninja
+ tends to be faster.
+
+ -DBUILD_wireshark=OFF
+ By default CMake tries to find the Qt libraries so Wireshark,
+ the GUI packet analyzer, can be built. You can disable the
+ build of the GUI version of Wireshark with this switch.
+
+ -DBUILD_tshark=OFF
+ By default the line-mode packet analyzer, TShark, is built.
Use this switch to avoid building it.
- --disable-editcap
+ -DBUILD_editcap=OFF
By default the capture-file editing program is built.
Use this switch to avoid building it.
- --disable-mergecap
+ -DBUILD_capinfos=OFF
+ By default the capture-file statistics reporting pogram
+ is built. Use this switch to avoid building it.
+
+ -DBUILD_captype=OFF
+ By default the capture-type reporting pogram is built. Use this
+ switch to avoid building it.
+
+ -DBUILD_mergecap=OFF
By default the capture-file merging program is built.
Use this switch to avoid building it.
- --disable-text2pcap
+ -DBUILD_reordercap=OFF
+ By default the capture-file reordering program is built.
+ Use this switch to avoid building it.
+
+ -DBUILD_text2pcap=OFF
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
+ -DBUILD_dftest=OFF
+ By default the display-filter-compiler test program is built.
+ Use this switch to avoid building it.
+
+ -DBUILD_randpkt=OFF
+ By default the program which creates random packet-capture files
is built. Use this switch to avoid building it.
- --enable-dftest
- By default the display-filter-compiler test program is not built.
- Use this switch to build it.
+ -DBUILD_dumpcap=OFF
+ By default the network traffic capture program is built.
+ Use this switch to avoid building it.
- --enable-randpkt
- By default the program which creates random packet-capture files
- is not built. Use this switch to build it.
+ -DBUILD_rawshark=OFF
+ By default the program used to dump and analyze raw libpcap data
+ is built. Use this switch to avoid building it.
- --without-pcap
+ -DDUMPCAP_INSTALL_OPTION=suid
+ -DDUMPCAP_INSTALL_OPTION=capabilities
+ Wireshark and TShark rely on dumpcap for packet capture. Setting
+ this flag to "suid" 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 and
+ set the "capabilities" flag.
+
+ Running Wireshark or TShark as root is not recommended.
+
+ -DENABLE_CAP=OFF
+ By default, if 'cmake' 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.
+
+ -DENABLE_PCAP=OFF
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
- Ethereal on a system that doesn't have libpcap installed (in
+ 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 Ethereal where you have libpcap installed, if
- it is installed in a non-standard location.
+ use -DENABLE_PCAP=OFF to avoid using libpcap.
- --without-zlib
+ -DENABLE_ZLIB=OFF
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 Ethereal 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.
- To avoid using IPv6 name resolution if you have the support for it,
- use this switch.
-
- --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.
-
- --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.
-
- --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 that SNMP library. Use this switch to avoid
- using the NET SNMP library even if you have it installed.
-
- --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-ucd-snmp
- If 'configure' finds a supported version of the UCD SNMP library
- on your system, the SNMP dissector will be enhanced to use
- routines from that SNMP library. Use this switch to avoid
- using the UCD SNMP library even if you have it installed.
-
- --with-ucd-snmp=DIR
- Tell the 'configure' script where your UCD SNMP library
- is located, if not in a standard location.
-
- --without-plugins
+ -DENABLE_PLUGINS=OFF
By default, if your system can support run-time loadable modules,
the packet analyzers are build with support for plugins.
- Use this switcht to build packet analyzers without plugin support.
+ Use this switch to build packet analyzers without plugin support.
- --with-plugins=DIR
- By default, plugins are installed in
- ${LIBDIR}/ethereal/plugins/${VERSION}
+8. After running 'cmake', 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 'cmake' with new options.
- ${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 Etherael version.
+9. Run 'make', or 'ninja' if you chose to create Ninja build files.
+ Hopefully, you won't run into any problems.
- Use this switch to change the location where plugins
- are installed.
+10. Run './run/wireshark' or './run/tshark' or ./run/dumpcap, and make sure things are
+ working. You must have root privileges in order to capture live data.
-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.
+11./a. Run 'make install'. If you're running a system that supports
+ the RPM packaging systems you can run
-6. Run 'make'. Hopefully, you won't run into any problems.
+ make rpm-package
-7. Run './ethereal' or './tethereal', and make sure things are working.
- You must have root privileges in order to capture live data.
+ or
-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
+ ninja rpm-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. The installation path
+ defaults to /usr/local, so you'll probably want to pass
+ -DCMAKE_INSTALL_PREFIX=/usr to CMake.
- to make an installable package for your system.
+11/b. If you 're running a system that supports APT (Debian/Ubuntu/etc.)
+ run
-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.
+ dpkg-buildpackage -us -uc -rfakeroot
+
+ in the source directory right after extracting of checking out
+ Wireshark's source code. (You don't have to run configure/make/etc.
+ prior to running dpkg-buildpackage)
+
+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) or the Wireshark Q&A site:
+https://ask.wireshark.org .
git.samba.org / metze / wireshark / wip.git / blobdiff