diff options
author | Gerald Combs <gerald@zing.org> | 2014-07-29 18:31:43 -0700 |
---|---|---|
committer | Gerald Combs <gerald@wireshark.org> | 2014-08-02 21:05:01 +0000 |
commit | a722f83ff1aa6cb53a0e581417b4ec88e9ba207c (patch) | |
tree | bb73848712d3f3922760bd64a92f6ea4b08e623f /docbook/wsug_src | |
parent | 50b67345b7eb35ae271b393b1e416f487338a1de (diff) |
Convert the build and install chapter to AsciiDoc.
Add OS X content. Remove GTK+ content. Update the names in the NSIS
package to match the documentation (untested).
Change-Id: Id8fd08982bc26871bb8a319b0319808bcdba878c
Reviewed-on: https://code.wireshark.org/review/3366
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Diffstat (limited to 'docbook/wsug_src')
-rw-r--r-- | docbook/wsug_src/WSUG_chapter_build_install.asciidoc | 418 | ||||
-rw-r--r-- | docbook/wsug_src/WSUG_chapter_build_install.xml | 780 |
2 files changed, 418 insertions, 780 deletions
diff --git a/docbook/wsug_src/WSUG_chapter_build_install.asciidoc b/docbook/wsug_src/WSUG_chapter_build_install.asciidoc new file mode 100644 index 0000000000..16736ab1ba --- /dev/null +++ b/docbook/wsug_src/WSUG_chapter_build_install.asciidoc @@ -0,0 +1,418 @@ +++++++++++++++++++++++++++++++++++++++ +<!-- WSUG Chapter BuildInstall --> +++++++++++++++++++++++++++++++++++++++ + +[[ChapterBuildInstall]] + +== Building and Installing Wireshark + +[[ChBuildInstallIntro]] + +=== Introduction + +As with all things there must be a beginning and so it is with Wireshark. To +use Wireshark you must first install it. If you are running Windows or Mac OS X +you can download an official release at wireshark-download-page:[], install it, +and skip the rest of this chapter. + +If you are running another operating system such as Linux or FreeBSD you might +want to install from source. Several Linux distributions offer Wireshark +packages but they commonly ship out-of-date versions. No other versions of UNIX +ship Wireshark so far. For that reason, you will need to know where to get the +latest version of Wireshark and how to install it. + +This chapter shows you how to obtain source and binary packages and how to +build Wireshark from source should you choose to do so. + +The following are the general steps you would use: + +. Download the relevant package for your needs, e.g. source or binary + distribution. + +. Compile the source into a binary if needed. + This may involve building and/or installing other necessary packages. + +. Install the binaries into their final destinations. + +[[ChBuildInstallDistro]] + +=== Obtaining the source and binary distributions + +You can obtain both source and binary distributions from the Wireshark web site: +wireshark-web-site:[]. Select the download link and then select the desired +binary or source package. + +[NOTE] +.Download all required files +==== +If you are building Wireshark from source you will +In general, unless you have already downloaded Wireshark before, you will most +likely need to download several source packages if you are building Wireshark +from source. This is covered in more detail below. + +++++++++++++++++++++++++++++++++++++++ +<!-- Make a ref --> +++++++++++++++++++++++++++++++++++++++ +==== + +Once you have downloaded the relevant files, you can go on to the next step. + +// +// Windows +// + +[[ChBuildInstallWinInstall]] + +=== Installing Wireshark under Windows + +Windows installers contain the platform and version, e.g. ++Wireshark-win__xx__-wireshark-major-minor-version:[]._x_.exe+. The Wireshark +installer includes WinPcap which is required for packet capture. + +Simply download the Wireshark installer from: wireshark-download-page:[] and +execute it. Official packages are signed by the *Wireshark Foundation*. You can +choose to install several optional components and select the location of the +installed package. The default settings are recommended for most users. + +[[ChBuildInstallWinComponents]] + +==== Installation Components + +On the _Choose Components_ page of the installer you can select from the following: + +* *Wireshark* - The network protocol analyzer that we all know and mostly love. + +* *TShark* - A command-line network protocol analyzer. If you haven't tried it + you should. + +* *Wireshark 1 Legacy* - The old (GTK+) user interface in case you need it. + +* *Plugins & Extensions* - Extras for the Wireshark and TShark dissection engines + + - *Dissector Plugins* - Plugins with some extended dissections. + + - *Tree Statistics Plugins* - Extended statistics. + + - *Mate - Meta Analysis and Tracing Engine* - User configurable extension(s) of the display filter engine, see wireshark-wiki-site:[]Mate for details. + + - *SNMP MIBs* - SNMP MIBs for a more detailed SNMP dissection. + +* *Tools* - Additional command line tools to work with capture files + + - *Editcap* - Reads a capture file and writes some or all of the packets into + another capture file. + + - *Text2Pcap* - Reads in an ASCII hex dump and writes the data into a + pcap capture file. + + - *Reordercap* - Reorders a capture file by timestamp. + + - *Mergecap* - Combines multiple saved capture files into a single output file. + + - *Capinfos* - Provides information on capture files. + + - *Rawshark* - Raw packet filter. + +* *User's Guide* - Local installation of the User's Guide. The Help buttons on + most dialogs will require an internet connection to show help pages if the + User's Guide is not installed locally. + +[[ChBuildInstallWinAdditionalTasks]] + +==== Additional Tasks + +* *Start Menu Shortcuts* - Add some start menu shortcuts. + +* *Desktop Icon* - Add a Wireshark icon to the desktop. + +* *Quick Launch Icon* - add a Wireshark icon to the Explorer quick launch toolbar. + +* *Associate file extensions to Wireshark* - Associate standard network trace files to Wireshark. + +[[ChBuildInstallWinLocation]] + +==== Install Location + +By default Wireshark installs into `%ProgramFiles%\Wireshark` on 32-bit Windows +and `%ProgramFiles64%\Wireshark` on 64-bit Windows. This expands to `C:\Program +Files\Wireshark` on most systems. + +[[ChBuildInstallWinPcap]] + +==== Installing WinPcap + +The Wireshark installer contains the latest WinPcap installer. + +If you don't have WinPcap installed you won't be able to capture live network +traffic but you will still be able to open saved capture files. By default the +latest version of WinPcap will be installed. If you don't wish to do this or if +you wish to reinstall WinPcap you can check the _Install WinPcap_ box as needed. + +For more information about WinPcap see winpcap-web-site:[] and +wireshark-wiki-site:[]WinPcap. + + +[[ChBuildInstallWinWiresharkCommandLine]] + +==== Windows installer command line options + +For special cases, there are some command line parameters available: + +* `/S` runs the installer or uninstaller silently with default values. The + silent installer *will not* install WinPCap. + +* `/desktopicon` installation of the desktop icon, `=yes` - force installation, + `=no` - don't install, otherwise use default settings. This option can be + useful for a silent installer. + +* `/quicklaunchicon` installation of the quick launch icon, `=yes` - force + installation, `=no` - don't install, otherwise use default settings. + +* `/D` sets the default installation directory ($INSTDIR), overriding InstallDir + and InstallDirRegKey. It must be the last parameter used in the command line + and must not contain any quotes even if the path contains spaces. + +* `/NCRC` disables the CRC check. We recommend against using this flag. + +Example: +---- +> Wireshark-win64-wireshark-2.0.5.exe /NCRC /S /desktopicon=yes /quicklaunchicon=no /D=C:\Program Files\Foo +---- + +Running the installer without any parameters shows the normal interactive installer. + +[[ChBuildInstallWinPcapManually]] + +==== Manual WinPcap Installation + +As mentioned above, the Wireshark installer takes care of installing WinPcap. +The following is only necessary if you want to use a different version than the +one included in the Wireshark installer, e.g. because a new WinPcap version was +released. + +Additional WinPcap versions (including newer alpha or beta releases) can be +downloaded from the main WinPcap site: winpcap-web-site:[]. The _Installer for +Windows_ supports modern Windows operating systems. + +[[ChBuildInstallWinWiresharkUpdate]] + +==== Update Wireshark + +By default the offical Windows package will check for new versions and notify +you when they are available. If you have the _Check for updates_ preference +disabled or if you run Wireshark in an isolated environment you should subcribe +to the _wireshark-announce_ mailing list. See <<ChIntroMailingLists>> for +details on subscribing to this list. + +New versions of Wireshark are usually released every four to six weeks. Updating +Wireshark is done the same way as installing it. Simply download and start the +installer exe. A reboot is usually not required and all your personal settings +remain unchanged. + +[[ChBuildInstallWinPcapUpdate]] + +==== Update WinPcap + +New versions of WinPcap are less frequently available. You will find WinPcap +update instructions the WinPcap web site at winpcap-web-site:[]. You may have to +reboot your machine after installing a new WinPcap version. + +[[ChBuildInstallWinUninstall]] + +==== Uninstall Wireshark + +You can uninstall Wireshark using the _Programs and Features_ control panel. +Select the "Wireshark" entry to start the uninstallation procedure. + +The Wireshark uninstaller provides several options for removal. The default is +to remove the core components but keep your personal settings and WinPcap. +WinPcap is left installed by default in case other programs need it. + +[[ChBuildInstallWinPcapUninstall]] + +==== Uninstall WinPcap + +You can uninstall WinPcap independently of Wireshark using the _WinPcap_ entry +in the _Programs and Features_ control panel. Remember that if you uninstall +WinPcap you won't be able to capture anything with Wireshark. + +// +// OS X +// + +[[ChBuildInstallOSXInstall]] + +=== Installing Wireshark under Mac OS X + +The official Mac OS X packages are distributed as disk images (.dmg) containing +the application installer. To install Wireshark simply open the disk image and +run the enclosed installer. + +The installer package includes Wireshark, its related command line utilities, +and a launch daemon that adjusts capture permissions at system startup. See the +included _Read me first_ file for more details. + +[[ChBuildInstallUnixBuild]] + +=== Building Wireshark from source under UNIX + +Building Wireshark requires the proper build environment including a compiler +and many supporting libraries. See the Developer's Guide at +wireshark-developers-guide-url:[] for more information. + +Use the following general steps to build Wireshark from source under UNIX or Linux: + +. Unpack the source from its compressed `tar` file. If you are using Linux or + your version of UNIX uses GNU `tar` you can use the following command: ++ +-- +---- +$ tar xaf wireshark-2.0.5.tar.bz2 +---- +In other cases you will have to use the following commands: +---- +$ bzip2 -d wireshark-2.0.5.tar.bz2 +$ tar xf wireshark-2.0.5.tar +---- +-- + +. Change directory to the Wireshark source directory. ++ +---- +$ cd wireshark-2.0.5 +---- + +. Configure your source so it will build correctly for your version of UNIX. You + can do this with the following command: ++ +---- +$ ./configure +---- ++ +If this step fails you will have to rectify the problems and rerun `configure`. +Troubleshooting hints are provided in <<ChBuildInstallUnixTrouble>>. + +. Build the sources. ++ +---- +$ make +---- + +. Install the software in its final destination. ++ +---- +$ make install +---- + +// XXX To do: CMake + +Once you have installed Wireshark with _make install_ above, you should be able +to run it by entering `wireshark`. + +[[ChBuildInstallUnixInstallBins]] + +=== Installing the binaries under UNIX + +In general installing the binary under your version of UNIX will be specific to +the installation methods used with your version of UNIX. For example, under AIX, +you would use _smit_ to install the Wireshark binary package, while under Tru64 +UNIX (formerly Digital UNIX) you would use _setld_. + +==== Installing from rpm's under Red Hat and alike + +Use the following command to install the Wireshark RPM that you have downloaded from the Wireshark web site: + +---- +rpm -ivh wireshark-2.0.5.i386.rpm +---- + +If the above step fails because of missing dependencies, install the +dependencies first, and then retry the step above. + +==== Installing from deb's under Debian, Ubuntu and other Debian derivatives + +If you can just install from the repository then use + +---- +$ aptitude install wireshark +---- + +Aptitude should take care of all of the dependency issues for you. + +Use the following command to install downloaded Wireshark deb's under Debian: + +---- +$ dpkg -i wireshark-common_2.0.5.0-1_i386.deb wireshark_wireshark-2.0.5.0-1_i386.deb +---- + +dpkg doesn't take care of all dependencies, but reports what's missing. + + +[NOTE] +.Capturing requires privileges +==== +By installing Wireshark packages non-root users won't gain rights automatically +to capture packets. To allow non-root users to capture packets follow the +procedure described in +file:///usr/share/doc/wireshark-common/README.Debian[/usr/share/doc/wireshark-common/README.Debian] +==== + +==== Installing from portage under Gentoo Linux + +Use the following command to install Wireshark under Gentoo Linux with all of +the extra features: + +---- +$ USE="adns gtk ipv6 portaudio snmp ssl kerberos threads selinux" emerge wireshark +---- + +==== Installing from packages under FreeBSD + +Use the following command to install Wireshark under FreeBSD: + +---- +$ pkg_add -r wireshark +---- + +pkg_add should take care of all of the dependency issues for you. + +[[ChBuildInstallUnixTrouble]] + +=== Troubleshooting during the install on Unix + +A number of errors can occur during the installation process. Some hints on +solving these are provided here. + +If the `configure` stage fails you will need to find out why. You can check the +file `config.log` in the source directory to find out what failed. The last few +lines of this file should help in determining the problem. + +The standard problems are that you do not have a required development package on +your system or that the development package isn't new enough. Note that +installing a library package isn't enough. You need to install its development +package as well. `configure` will also fail if you do not have libpcap (at least +the required include files) on your system. + +If you cannot determine what the problems are, send an email to the +_wireshark-dev_ mailing list explaining your problem. Include the output from +`config.log` and anything else you think is relevant such as a trace of the +`make` stage. + +[[ChBuildInstallWinBuild]] + +=== Building from source under Windows + +We strongly recommended that you use the binary installer for Windows unless you +want to start developing Wireshark on the Windows platform. + +For further information how to build Wireshark for Windows from the sources +see the Developer's Guide at wireshark-developers-guide-url:[] + +You may also want to have a look at the Development Wiki +(wireshark-wiki-site:[]Development) for the latest available development +documentation. + +++++++++++++++++++++++++++++++++++++++ +<!-- End of WSUG Chapter 2 --> +++++++++++++++++++++++++++++++++++++++ + diff --git a/docbook/wsug_src/WSUG_chapter_build_install.xml b/docbook/wsug_src/WSUG_chapter_build_install.xml deleted file mode 100644 index 3eb867376b..0000000000 --- a/docbook/wsug_src/WSUG_chapter_build_install.xml +++ /dev/null @@ -1,780 +0,0 @@ -<!-- WSUG Chapter BuildInstall --> - -<chapter id="ChapterBuildInstall"> - <title>Building and Installing Wireshark</title> - <section id="ChBuildInstallIntro"> - <title>Introduction</title> - <para> - As with all things, there must be a beginning, and so it is with - Wireshark. To use Wireshark, you must: - <itemizedlist> - <listitem> - <para> - Obtain a binary package for your operating system, or - </para> - </listitem> - <listitem> - <para> - Obtain the source and build Wireshark for your operating system. - </para> - </listitem> - </itemizedlist> - </para> - <para> - Currently, several Linux distributions ship Wireshark, but - they are commonly shipping an out-of-date version. No other versions - of UNIX ship Wireshark so far, and Microsoft does not ship it with any - version of Windows. For that reason, you will need to know where to - get the latest version of Wireshark and how to install it. - </para> - <para> - This chapter shows you how to obtain source and binary packages, - and how to build Wireshark from source, should you choose to do so. - </para> - <para> - The following are the general steps you would use: - <orderedlist> - <listitem> - <para> - Download the relevant package for your needs, e.g. source or - binary distribution. - </para> - </listitem> - <listitem> - <para> - Build the source into a binary, if you have downloaded the - source. - </para> - <para> - This may involve building and/or installing other necessary packages. - </para> - </listitem> - <listitem> - <para> - Install the binaries into their final destinations. - </para> - </listitem> - </orderedlist> - </para> - </section> - - <section id="ChBuildInstallDistro"> - <title>Obtaining the source and binary distributions</title> - <para> - You can obtain both source and binary distributions from the Wireshark - web site: <ulink url="&WiresharkWebSite;">&WiresharkWebSite;</ulink>. - Simply select the download link, and then select either the source - package or binary package of your choice from the mirror site closest - to you. - </para> - <note> - <title>Download all required files!</title> - <para> - In general, unless you have already downloaded Wireshark - before, you will most likely need to download several source - packages if you are building Wireshark from source. This is - covered in more detail below. <!-- Make a ref --> - </para> - </note> - <para> - Once you have downloaded the relevant files, you can go on to the - next step. - </para> - <note> - <title>Note!</title> - <para> - While you will find a number of binary packages available on the - Wireshark web site, you might not find one for your platform, and - they often tend to be several versions behind the current released - version, as they are contributed by people who have the platforms - they are built for. - </para> - <para> - For this reason, you might want to pull down the source distribution - and build it, as the process is relatively simple. - </para> - </note> - </section> - - <section id="ChBuildInstallBeforeBuild"> - <title>Before you build <application>Wireshark</application> under UNIX</title> - <para> - Before you build Wireshark from sources, or install a binary package, - you must ensure that you have the following other packages installed: - <itemizedlist> - <listitem> - <para>GTK+, The GIMP Tool Kit.</para> - <para> - You will also need Glib. Both can be obtained from - <ulink url="http://www.gtk.org">www.gtk.org</ulink> - </para> - </listitem> - <listitem> - <para> - libpcap, the packet capture software that Wireshark uses. - </para> - <para> - You can obtain libpcap from - <ulink url="&TcpdumpWebsite;">www.tcpdump.org</ulink> - </para> - </listitem> - </itemizedlist> - Depending on your system, you may be able to install these from - binaries, e.g. RPMs, or you may need to obtain them in source code - form and build them. - </para> - <para> - If you have downloaded the source for GTK+, the instructions shown - in <xref linkend="Ch02Ex1"/> may provide some help in building it: - <example id="Ch02Ex1"> - <title>Building GTK+ from source</title> - <programlisting> -gzip -dc gtk+-2.21.1.tar.gz | tar xvf - -<much output removed> -cd gtk+-2.21.1 -./configure -<much output removed> -make -<much output removed> -make install -<much output removed> - </programlisting> - </example> - <note> - <title>Note!</title> - <para> - You may need to change the version number of GTK+ in - <xref linkend="Ch02Ex1"/> to match the version of GTK+ you have - downloaded. The directory you change to will change if the - version of GTK+ changes, and in all cases, - <command>tar xvf -</command> will show you the name of the - directory you should change to. - </para> - </note> - <note> - <title>Note!</title> - <para> - If you use Linux, or have GNU <command>tar</command> installed, - you can use <command>tar zxvf gtk+-2.21.1.tar.gz</command>. It - is also possible to use <command>gunzip -c</command> or - <command>gzcat</command> rather than <command>gzip -dc</command> - on many UNIX systems. - </para> - </note> - <note> - <title>Note!</title> - <para> - If you downloaded GTK+ or any other tar file using Windows, - you may find your file called gtk+-2_21_1_tar.gz. - </para> - </note> - </para> - <para> - You should consult the GTK+ web site if any errors occur in carrying - out the instructions in <xref linkend="Ch02Ex1"/>. - </para> - <para> - If you have downloaded the source to libpcap, the general instructions - shown in <xref linkend="Ch2Ex2"/> will assist in building it. Also, - if your operating system does not support <command>tcpdump</command>, - you might also want to download it from the - <ulink url="&TcpdumpWebsite;">tcpdump</ulink> web site and - install it. - <example id="Ch2Ex2"> - <title>Building and installing libpcap</title> - <programlisting> -gzip -dc libpcap-1.0.0.tar.Z | tar xvf - -<much output removed> -cd libpcap-1.0.0 -./configure -<much output removed> -make -<much output removed> -make install -<much output removed> - </programlisting> - </example> - </para> - <note> - <title>Note!</title> - <para> - The directory you should change to will depend on the version of - libpcap you have downloaded. In all cases, - <command>tar xvf -</command> will show you the name of the - directory that has been unpacked. - </para> - </note> - <para> - Under Red Hat 6.x and beyond (and distributions based on it, like - Mandrake) you can simply install each of the packages you need from - RPMs. Most Linux systems will install GTK+ and GLib in any case, - however you will probably need to install the devel versions of - each of these packages. The commands shown in <xref linkend="Ch02Ex4"/> - will install all the needed RPMs if they are not already installed. - <example id="Ch02Ex4"> - <title> - Installing required RPMs under Red Hat Linux 6.2 and beyond - </title> - <programlisting> -cd /mnt/cdrom/RedHat/RPMS -rpm -ivh glib-1.2.6-3.i386.rpm -rpm -ivh glib-devel-1.2.6-3.i386.rpm -rpm -ivh gtk+-1.2.6-7.i386.rpm -rpm -ivh gtk+-devel-1.2.6-7.i386.rpm -rpm -ivh libpcap-0.4-19.i386.rpm - </programlisting> - </example> - </para> - <note> - <para> - If you are using a version of Red Hat later than 6.2, the required - RPMs have most likely changed. Simply use the correct RPMs from your - distribution. - </para> - </note> - <para> - Under Debian you can install Wireshark using aptitude. aptitude will - handle any dependency issues for you. <xref linkend="Ch02Ex5"/> shows - how to do this. - <example id="Ch02Ex5"> - <title>Installing debs under Debian, Ubuntu and other Debian derivatives</title> - <programlisting> -aptitude install wireshark-dev - </programlisting> - </example> - </para> - </section> - - <section id="ChBuildInstallUnixBuild"> - <title>Building Wireshark from source under UNIX</title> - <para> - Use the following general steps if you are building Wireshark from - source under a UNIX operating system: - <orderedlist> - <listitem> - <para> - Unpack the source from its <command>gzip</command>'d - <command>tar</command> file. If you are using Linux, or your - version of UNIX uses GNU <command>tar</command>, you can use the - following command: - <programlisting> -tar zxvf wireshark-&WiresharkCurrentVersion;-tar.gz - </programlisting> - </para> - <para> - For other versions of UNIX, you will want to use the following - commands: - <programlisting> -gzip -d wireshark-&WiresharkCurrentVersion;-tar.gz -tar xvf wireshark-&WiresharkCurrentVersion;-tar - </programlisting> - <note> - <title>Note!</title> - <para> - The pipeline - <command> - gzip -dc wireshark-&WiresharkCurrentVersion;-tar.gz | tar xvf - - </command> will work here as well. - </para> - </note> - <note> - <title>Note!</title> - <para> - If you have downloaded the Wireshark tarball under Windows, - you may find that your browser has created a file with - underscores rather than periods in its file name. - </para> - </note> - </para> - </listitem> - <listitem> - <para> - Change directory to the Wireshark source directory. - </para> - </listitem> - <listitem> - <para> - Configure your source so it will build correctly for your - version of UNIX. You can do this with the following command: - <programlisting> -./configure - </programlisting> - </para> - <para> - If this step fails, you will have to rectify the problems and - rerun <command>configure</command>. Troubleshooting hints are - provided in <xref linkend="ChBuildInstallUnixTrouble"/>. - </para> - </listitem> - <listitem> - <para> - Build the sources into a binary, with the <command>make</command> - command. For example: - <programlisting> -make - </programlisting> - </para> - </listitem> - <listitem> - <para> - Install the software in its final destination, using the command: - <programlisting> -make install - </programlisting> - </para> - </listitem> - </orderedlist> - </para> - <para> - Once you have installed Wireshark with <command>make install</command> - above, you should be able to run it by entering - <command>wireshark</command>. - </para> - </section> - - <section id="ChBuildInstallUnixInstallBins"> - <title>Installing the binaries under UNIX</title> - <para> - In general, installing the binary under your version of UNIX will be - specific to the installation methods used with your version of UNIX. - For example, under AIX, you would use <command>smit</command> to - install the Wireshark binary package, while under Tru64 UNIX - (formerly Digital UNIX) you would use <command>setld</command>. - </para> - - <section> - <title>Installing from rpm's under Red Hat and alike</title> - <para> - Use the following command to install the Wireshark RPM that you have - downloaded from the Wireshark web site: - <programlisting> -rpm -ivh wireshark-&WiresharkCurrentVersion;.i386.rpm - </programlisting> - If the above step fails because of missing dependencies, install the - dependencies first, and then retry the step above. See - <xref linkend="Ch02Ex4"/> for information on what RPMs you will need - to have installed. - </para> - </section> - - <section> - <title>Installing from deb's under Debian, Ubuntu and other Debian derivatives</title> - <para> - If you can just install from the repository then use: - <programlisting> -aptitude install wireshark - </programlisting> - aptitude should take care of all of the dependency issues for you. - </para> - <para> - Use the following command to install downloaded Wireshark deb's under - Debian: - <programlisting> -dpkg -i wireshark-common_&WiresharkCurrentVersion;.0-1_i386.deb wireshark_&WiresharkCurrentVersion;.0-1_i386.deb - </programlisting> - dpkg doesn't take care of all dependencies, but reports what's missing. - </para> - <note><title>Note!</title> - <para> - By installing Wireshark packages non-root users won't gain rights - automatically to capture packets. To allow non-root users to capture - packets follow the procedure described in - <ulink url="file:///usr/share/doc/wireshark-common/README.Debian">/usr/share/doc/wireshark-common/README.Debian</ulink> - </para> - </note> - </section> - - <section> - <title>Installing from portage under Gentoo Linux</title> - <para> - Use the following command to install Wireshark under Gentoo - Linux with all of the extra features: - <programlisting> -USE="adns gtk ipv6 portaudio snmp ssl kerberos threads selinux" emerge wireshark - </programlisting> - </para> - </section> - - <section> - <title>Installing from packages under FreeBSD</title> - <para> - Use the following command to install Wireshark under FreeBSD: - <programlisting> -pkg_add -r wireshark - </programlisting> - pkg_add should take care of all of the dependency issues for you. - </para> - </section> - </section> - - <section id="ChBuildInstallUnixTrouble"> - <title>Troubleshooting during the install on Unix</title> - <para> - A number of errors can occur during the installation process. - Some hints on solving these are provided here. - </para> - <para> - If the <command>configure</command> stage fails, you will need to find - out why. You can check the file <filename>config.log</filename> in the - source directory to find out what failed. The last few lines of this - file should help in determining the problem. - </para> - <para> - The standard problems are that you do not have GTK+ on your system, - or you do not have a recent enough version of GTK+. The - <command>configure</command> will also fail if you do not have libpcap - (at least the required include files) on your system. - </para> - <para> - Another common problem is for the final compile and link stage to - terminate with a complaint of: <errorname>Output too long.</errorname> - This is likely to be caused by an antiquated <command>sed</command> - (such as the one shipped with Solaris). Since <command>sed</command> is - used by the <command>libtool</command> script to construct the final - link command, this leads to mysterious problems. This can be - resolved by downloading a recent version of sed from - <ulink url="http://directory.fsf.org/project/sed/"/>. - </para> - <para> - If you cannot determine what the problems are, send an email to the - <command>wireshark-dev</command> mailing list explaining your problem, - and including the output from <filename>config.log</filename> and - anything else you think is relevant, like a trace of the - <command>make</command> stage. - </para> - </section> - - <section id="ChBuildInstallWinBuild"> - <title>Building from source under Windows</title> - <para> - It is recommended to use the binary installer for Windows, - until you want to start developing Wireshark on the Windows platform. - </para> - <para> - For further information how to build Wireshark for Windows from the - sources, have a look at the Developer's Guide on the - <ulink url="&WiresharkWebSite;/docs/">Documentation Page</ulink>. - </para> - <para> - You may also want to have a look at the Development Wiki: - <ulink url="&WiresharkWikiPage;/Development">&WiresharkWikiPage;/Development</ulink> - for the latest available development documentation. - </para> - </section> - - <section id="ChBuildInstallWinInstall"> - <title>Installing Wireshark under Windows</title> - <para> - In this section we explore installing Wireshark under Windows from the - binary packages. - </para> - <section id="ChBuildInstallWireshark"> - <title>Install Wireshark</title> - <para> - You may acquire a binary installer of Wireshark named something like: - <filename>wireshark-winxx-&WiresharkCurrentVersion;.x.exe</filename>. - The Wireshark installer includes WinPcap, so you don't need to download - and install two separate packages. - </para> - <para> - Simply download the Wireshark installer from: - <ulink url="&WiresharkBinariesPage;">&WiresharkBinariesPage;</ulink> - and execute it. - Beside the usual installer options like where to install the program, - there are several optional components. - </para> - <tip><title>Tip: Just keep the defaults!</title> - <para> - If you are unsure which settings to select, just keep the defaults. - </para> - </tip> - <section id="ChBuildInstallComponents"> - <title>"Choose Components" page</title> - <para> - <command>Wireshark</command> - <itemizedlist> - <listitem><para> - <command>Wireshark GTK</command> - Wireshark is a GUI network protocol - analyzer. - </para></listitem> - </itemizedlist> - </para> - <para> - <command>TShark</command> - TShark is a command-line based network - protocol analyzer. - </para> - <para> - <command>Plugins / Extensions</command> (for the Wireshark and TShark - dissection engines): - <itemizedlist> - <listitem><para> - <command>Dissector Plugins</command> - Plugins with some extended dissections. - </para></listitem> - <listitem><para> - <command>Tree Statistics Plugins</command> - Plugins with some extended statistics. - </para></listitem> - <listitem><para> - <command>Mate - Meta Analysis and Tracing Engine (experimental)</command> - - user configurable extension(s) of the display filter engine, see - <ulink url="&WiresharkWikiPage;/Mate">&WiresharkWikiPage;/Mate</ulink> - for details. - </para></listitem> - <listitem><para> - <command>SNMP MIBs</command> - SNMP MIBs for a more detailed SNMP - dissection. - </para></listitem> - </itemizedlist> - <command>Tools</command> (additional command line tools to work with - capture files): - <itemizedlist> - <listitem><para> - <command>Editcap</command> - Editcap is a program that reads a capture - file and writes some or all of the packets into another capture file. - </para></listitem> - <listitem><para> - <command>Text2Pcap</command> - Text2pcap is a program that reads in an - ASCII hex dump and writes the data into a libpcap-style capture file. - </para></listitem> - <listitem><para> - <command>Mergecap</command> - Mergecap is a program that combines multiple - saved capture files into a single output file. - </para></listitem> - <listitem><para> - <command>Capinfos</command> - Capinfos is a program that provides - information on capture files. - </para></listitem> - <listitem><para> - <command>Rawshark</command> - Rawshark is a raw packet filter. - </para></listitem> - </itemizedlist> - </para> - <para> - <command>User's Guide</command> - - Local installation of the User's Guide. The Help buttons on most dialogs - will require an internet connection to show help pages if the User's Guide - is not installed locally. - </para> - </section> - <section id="ChBuildInstallAdditionalTasks"> - <title>"Additional Tasks" page</title> - <para> - <itemizedlist> - <listitem><para> - <command>Start Menu Shortcuts</command> - add some start menu shortcuts. - </para></listitem> - <listitem><para> - <command>Desktop Icon</command> - add a Wireshark icon to the desktop. - </para></listitem> - <listitem><para> - <command>Quick Launch Icon</command> - add a Wireshark icon to the - Explorer quick launch toolbar. - </para></listitem> - <listitem><para> - <command>Associate file extensions to Wireshark</command> - Associate - standard network trace files to Wireshark. - </para></listitem> - </itemizedlist> - </para> - </section> - <section id="ChBuildInstallWinPcap"> - <title>"Install WinPcap?" page</title> - <para> - The Wireshark installer contains the latest released WinPcap installer. - </para> - <para> - If you don't have WinPcap installed, you won't be able to capture live - network traffic, but you will still be able to open saved capture files. - </para> - <para> - <itemizedlist> - <listitem><para> - <command>Currently installed WinPcap version</command> - the Wireshark - installer detects the currently installed WinPcap version. - </para></listitem> - <listitem><para> - <command>Install WinPcap x.x</command> - if the currently installed - version is older than the one which comes with the Wireshark installer - (or WinPcap is not installed at all), this will be selected by default. - </para></listitem> - <listitem><para> - <command>Start WinPcap service "NPF" at startup</command> - so users - without administrative privileges can capture. - </para></listitem> - </itemizedlist> - - </para> - <para> - More WinPcap info: - <itemizedlist> - <listitem><para> - Wireshark related: - <ulink url="&WiresharkWikiPage;/WinPcap">&WiresharkWikiPage;/WinPcap</ulink> - </para></listitem> - <listitem><para> - General WinPcap info: - <ulink url="&WinPcapWebsite;">&WinPcapWebsite;</ulink> - </para></listitem> - </itemizedlist> - </para> - </section> - <section id="ChBuildInstallWiresharkCommandLine"> - <title>Command line options</title> - <para> - You can simply start the Wireshark installer without any command line - parameters, it will show you the usual interactive installer. - </para> - <para> - For special cases, there are some command line parameters available: - </para> - <itemizedlist> - <listitem> - <para> - <command>/NCRC</command> disables the CRC check - </para> - </listitem> - <listitem> - <para> - <command>/S</command> runs the installer or uninstaller silently with - default values. Please note: The silent installer won't install WinPCap! - </para> - </listitem> - <listitem> - <para> - <command>/desktopicon</command> installation of the desktop icon, - <command>=yes</command> - force installation, <command>=no</command> - - don't install, otherwise use defaults / user settings. - This option can be useful for a silent installer. - </para> - </listitem> - <listitem> - <para> - <command>/quicklaunchicon</command> installation of the quick launch icon, - <command>=yes</command> - force installation, <command>=no</command> - - don't install, otherwise use defaults / user settings. - </para> - </listitem> - <listitem> - <para> - <command>/D</command> sets the default installation directory - ($INSTDIR), overriding - InstallDir and InstallDirRegKey. It must be the last parameter used in - the command line and must not contain any quotes, even if the path - contains spaces. - </para> - </listitem> - </itemizedlist> - <para> Example: - <programlisting> -wireshark-win32-&WiresharkCurrentVersion;.0.exe /NCRC /S /desktopicon=yes - /quicklaunchicon=no /D=C:\Program Files\Foo - </programlisting> - </para> - </section> - </section> - - <section id="ChBuildInstallWinPcapManually"> - <title>Manual WinPcap Installation</title> - <note><title>Note!</title> - <para> - <command>As mentioned above, the Wireshark installer - takes care of the installation of WinPcap, - so usually you don't have to worry about WinPcap at all!</command> - </para> - </note> - <para> - The following is only necessary if you want to - try a different version than the one included in the Wireshark installer, - e.g. because a new WinPcap (beta) version was released. - </para> - <para> - Additional WinPcap versions (including newer alpha or beta releases) - can be downloaded from the following locations: - <itemizedlist> - <listitem><para> - The main WinPcap site: - <ulink url="&WinPcapWebsite;">&WinPcapWebsite;</ulink> - </para></listitem> - <listitem><para> - The Wiretapped.net mirror: - <ulink url="http://www.mirrors.wiretapped.net/security/packet-capture/winpcap"> - http://www.mirrors.wiretapped.net/security/packet-capture/winpcap</ulink> - </para></listitem> - </itemizedlist> - </para> - <para> - At the download page you will find a single installer exe called something - like "auto-installer", which can be installed under various Windows - systems. - </para> - </section> - - <section id="ChBuildInstallWinWiresharkUpdate"> - <title>Update Wireshark</title> - <para> - From time to time you may want to update your installed Wireshark to a more - recent version. If you join Wireshark's announce mailing list, you will be - informed about new Wireshark versions, see <xref - linkend="ChIntroMailingLists"/> for details how to subscribe to this list. - </para> - <para> - New versions of Wireshark usually become available every 4 to 8 months. - Updating Wireshark is done the same way as installing it, you simply - download and start the installer exe. A reboot is usually not required and - all your personal settings remain unchanged. - </para> - </section> - - <section id="ChBuildInstallWinPcapUpdate"> - <title>Update WinPcap</title> - <para> - New versions of WinPcap are less frequently available, maybe only once in a - year. You will find WinPcap update instructions where you can download new - WinPcap versions. Usually you have to reboot the machine after installing - a new WinPcap version. - </para> - <warning><title>Warning!</title> - <para> - If you have an older version of WinPcap installed, you must uninstall it - before installing the current version. Recent versions of the WinPcap - installer will take care of this. - </para> - </warning> - </section> - - <section id="ChBuildInstallWinUninstall"> - <title>Uninstall Wireshark</title> - <para> - You can uninstall Wireshark the usual way, using the "Add or Remove - Programs" option inside the Control Panel. Select the "Wireshark" entry to - start the uninstallation procedure. - </para> - <para> - The Wireshark uninstaller will provide several options as to which things are to be - uninstalled; the default is to remove the core components but keep the personal - settings, WinPcap and alike. - </para> - <para> - WinPcap won't be uninstalled by default, as other programs than Wireshark - may use it as well. - </para> - </section> - - <section id="ChBuildInstallWinPcapUninstall"> - <title>Uninstall WinPcap</title> - <para> - You can uninstall WinPcap independently of Wireshark, using the "WinPcap" - entry in the "Add or Remove Programs" of the Control Panel. - </para> - <note><title>Note!</title> - <para> - After uninstallation of WinPcap you can't capture anything with Wireshark. - </para> - </note> - <para> - It might be a good idea to reboot Windows afterwards. - </para> - </section> - </section> - -</chapter> -<!-- End of WSUG Chapter 2 --> |