diff options
author | Gerald Combs <gerald@wireshark.org> | 2015-02-02 14:32:28 -0800 |
---|---|---|
committer | Gerald Combs <gerald@wireshark.org> | 2015-02-02 22:47:28 +0000 |
commit | 71fd34da6cb9e7a9f1a0f4c783b1b6811b1dc9ff (patch) | |
tree | a55c8a72810113f98385d4912638d4670495b5e5 /docbook | |
parent | 37a2cd0e847ee5921a00b494fd5d0563cef84b80 (diff) | |
download | wireshark-71fd34da6cb9e7a9f1a0f4c783b1b6811b1dc9ff.tar.gz wireshark-71fd34da6cb9e7a9f1a0f4c783b1b6811b1dc9ff.tar.bz2 wireshark-71fd34da6cb9e7a9f1a0f4c783b1b6811b1dc9ff.zip |
WSUG: Chocolatey updates.
Move PowerShell and Chocolatey to the top of the quick setup since most
of the instructions now have a "Chocolatey" example.
Use "choco install" instead of "cinst" to match the pages at
chocolatey.org/packages.
Show how to install Cygwin and Python using Chocolatey.
MAC = Media Access Control (among other things). Mac = Macintosh.
Change-Id: Ic6aabacdd3a86b4e8ca556cc6f3daa62c3e5986b
Reviewed-on: https://code.wireshark.org/review/6924
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Diffstat (limited to 'docbook')
-rw-r--r-- | docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc | 3 | ||||
-rw-r--r-- | docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc | 76 | ||||
-rw-r--r-- | docbook/wsdg_src/WSDG_chapter_sources.asciidoc | 16 | ||||
-rw-r--r-- | docbook/wsdg_src/WSDG_chapter_tools.asciidoc | 77 |
4 files changed, 121 insertions, 51 deletions
diff --git a/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc b/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc index 4768e8398a..3cf223c927 100644 --- a/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc @@ -228,7 +228,7 @@ for the following systems: obtains an .rpm file from which the package manager checks the dependencies and installs the software. -* MAC OS X (.dmg file). The typical MAC OS X end user is used to get a .dmg file +* Mac OS X (.dmg file). The typical Mac OS X end user is used to get a .dmg file which will install all the required things for him. The other requirement is to have the X11.app installed. @@ -583,4 +583,3 @@ corresponding "Wireshark-win__bits__-_x_._y_._z_.exe" installer packages. ++++++++++++++++++++++++++++++++++++++ <!-- End of WSDG Chapter Introduction --> ++++++++++++++++++++++++++++++++++++++ - diff --git a/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc b/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc index 4f51128055..7b487201ed 100644 --- a/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc @@ -34,6 +34,34 @@ Unless you know exactly what you are doing, you should strictly follow the recommendations below. ==== +[[ChSetupPowerShell]] + +==== Install PowerShell + +PowerShell 2.0 or later is required for building Wireshark and the NSIS package. +Windows 7 and later include compatible versions. It is also required by +Chocolatey. + +If you are running Windows Vista and have thus far managed to not install +PowerShell 2.0, either directly or via anything that requires it, you must now +install PowerShell 2.0. You can download it from +https://www.microsoft.com/powershell[] + +[[ChSetupChocolatey]] + +==== Optional: Install Chocolatey + +https://chocolatey.org/[Chocolatey] is a native package manager for Windows. +There are https://chocolatey.org/packages[packages] for most of the software +listed below. Along with traditional Windows packages it supports Cygwin and +and the Python Package Index. + +// ...such as: +// - Active Perl and/or StrawberryPerl +// - Devbox-UnZip and/or 7zip and/or peazip +// - Wget +// - Git (a native win32 (MSYS) version) + [[ChSetupMSVC]] ==== Install Microsoft C compiler and SDK @@ -49,7 +77,7 @@ Uncheck all the optional components (unless you want to use them for purposes ot You can use Chocolatey to install Visual Studio: ---- -PS$>cinst VisualStudioCommunity2013 +PS$>choco install VisualStudioCommunity2013 ---- [TIP] @@ -77,6 +105,8 @@ certainly not work (at least without a lot of advanced tweaking). For further details on this topic, see <<ChToolsGNUChain>>. ==== +// XXX This is changing in regard to Clang: +// http://llvm.org/docs/GettingStartedVS.html // XXX - mention the compiler and PSDK web installers - // which significantly reduce download size - and find out the @@ -128,7 +158,6 @@ sure it doesn't install Visual Studio 2010 SP1 out of order. [[ChSetupQt]] - ==== Install Qt The main Wireshark application uses the Qt windowing toolkit. To install Qt @@ -145,7 +174,7 @@ Wireshark project (uiqtWireshark.pro), however. You can also use Chocolatey to install Qt (there are packages for x86 & x64 and various MSVC compilers, e.g. ---- -PS$>cinst qt-sdk-windows-x86-msvc2013_opengl +PS$>choco install qt-sdk-windows-x86-msvc2013_opengl ---- [[ChSetupCygwin]] @@ -198,32 +227,15 @@ Why is this recommended? Cygwin's bash version is required, as no native Win32 version is available. As additional packages can easily be added, Perl and other packages are also used. -[[ChSetupPowerShell]] +Alternatively you can install Cygwin and its packages using Chocolatey: -==== Install PowerShell - -PowerShell 2.0 or later is required for building Wireshark and the NSIS package. -Windows 7 and later include compatible versions. - -If you are running Windows Vista and have thus far managed to not install -PowerShell 2.0, either directly or via anything that requires it, you must now -install PowerShell 2.0. You can download it from -https://www.microsoft.com/powershell[] - -[[ChSetupChocolatey]] - -==== Optional: Install Chocolatey - -As an alternative to Cygwin you can install some packages using -https://chocolatey.org/[Chocolatey], a native package manager for Windows. -Wireshark's build environment currently supports the _winflexbison_ package but -support for more packages should appear in the future. +---- +PS$>choco install cygwin +PS$>choco install cyg-get +PS$>choco install unzip wget asciidoc [...] -source cygwin +---- -// ...such as: -// - Active Perl and/or StrawberryPerl -// - Devbox-UnZip and/or 7zip and/or peazip -// - Wget -// - Git (a native win32 version) +Chocolatey installs Cygwin in 'C:\tools\cygwin' by default. [[ChSetupPython]] @@ -235,6 +247,14 @@ Python into the default location ('C:\Python27'). Why is this recommended? Cygwin's Python package doesn't work on some machines, so the Win32 native package is recommended (and it's faster). Note that Python 3.x isn't currently supported. +Alternatively you can install Python using Chocolatey: + +---- +PS$>choco install python2 +---- + +Chocolatey installs Python 2 in 'C:\tools\python2' by default. + [[ChSetupsubversion]] ==== Install Git @@ -272,7 +292,7 @@ http://code.google.com/p/tortoisegit/. The command line client can be installed (and updated) using Chocolatey: ---- -PS$> cinst git +PS$> choco install git ---- ===== Others diff --git a/docbook/wsdg_src/WSDG_chapter_sources.asciidoc b/docbook/wsdg_src/WSDG_chapter_sources.asciidoc index 1241735414..d57604eefd 100644 --- a/docbook/wsdg_src/WSDG_chapter_sources.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_sources.asciidoc @@ -162,6 +162,16 @@ upload a key for each computer that you use. in many Linux distributions. You can also install it as a https://pypi.python.org/pypi/git-review[Python package]. (This step isn't strictly necessary but it makes working with Gerrit much easier.) +To install it from Chocolatey run ++ +-- +---- +# Make sure "Scripts" is in our path +PS$>$env:path += ";C:\tools\python2\Scripts" +PS$>choco install pip +PS$>choco install git-review -source python +---- +-- . Now on to the command line. First, make sure `git` works: + @@ -1094,9 +1104,9 @@ installing the _qt-devel_ package. [[ChSrcOSX]] -==== MAC OS X: .dmg packages +==== Mac OS X: .dmg packages -The MAC OS X Package is built using OS X packaging tools, based on information +The Mac OS X Package is built using OS X packaging tools, based on information found in the source tree under 'packaging/macosx'. In the wireshark directory, type: @@ -1105,7 +1115,7 @@ In the wireshark directory, type: $ make osx-package ---- -to build the MAC OS X Package. +to build the Mac OS X Package. [[ChSrcNSIS]] diff --git a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc index 029d308c20..72eeb34cf9 100644 --- a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc @@ -103,8 +103,9 @@ systems such as NuGet and Chocolatey mature. Although Cygwin consists of several separate packages, the installation and update is done through a single utility, 'setup-x86.exe' or 'setup-x86_64.exe', which acts similarly to other web based installers. -All tools will be installed into one base folder. The default is -'C:\cygwin'. +Alternatively you can install Cygwin and its packages using Chocolatey. + +==== Installing Cygwin using the Cygwin installer You will find 'setup-x86.exe', for 32-bit systems, and 'setup-x86_64.exe', for 64-bit systems, at @@ -112,6 +113,9 @@ http://www.cygwin.com/install.html[]. Click on the link for the appropriate setup utility to download it. After the download completes, run it. +All tools will be installed into one base folder. The default is +'C:\cygwin'. + The setup utility will ask you for some settings. The defaults should usually work well, at least initially. @@ -156,6 +160,25 @@ between: * 'Reinstall.' Reinstall this package. +==== Installing Cygwin using Chocolatey + +Chocolatey supports Cygwin as an external package source. +To install Cygwin itself run + +---- +PS$>choco install cygwin +# You might also need to install cyg-get: +PS$>choco install cyg-get +---- + +Chocolatey installs Cygwin in 'C:\tools\cygwin' by default. + +One or more Cygwin packages can be installed using "-source cygwin": + +---- +PS$>choco install unzip wget asciidoc -source cygwin +---- + [[ChToolsGNUChain]] === GNU compiler toolchain (UNIX only) @@ -373,7 +396,7 @@ requires a a $$C++$$ redistributable You can use Chocolatey to install Visual Studio, e.g: ---- -PS:\> cinst VisualStudioCommunity2013 +PS:\> choco install VisualStudioCommunity2013 ---- ==== cl.exe (C Compiler) @@ -631,7 +654,7 @@ http://msdn.microsoft.com/en-us/library/windows/hardware/ff551063%28v=vs.85%29.a You can also use Chocolatey to install WinDbg: ---- -PS:\> cinst windbg +PS:\> choco install windbg ---- To debug Wireshark using WinDbg, open the built copy of Wireshark using @@ -700,10 +723,11 @@ a symbolic link, which causes confusion outside Cygwin. You can also use Chocolatey to install Python: ---- -PS:\> cinst Python2 +PS:\> choco install Python2 ---- -You can verify your Python version by running +Chocolatey installs Python 2 into 'C:\tools\python2' by default. You can +verify your Python version by running ---- $ python --version @@ -712,14 +736,19 @@ $ python --version on UNIX and Linux and ---- +rem Official package C:> cd python27 C:Python27> python --version + +rem Chocolatey +C:> cd \tools\python2 +C:\tools\python2> python --version ---- on Windows. You should see something like ---- -Python 2.7.3 +Python 2.7.9 ---- Your version string may vary of course. @@ -782,13 +811,13 @@ should be straightforward. You may also use Chocolatey to install either package: ---- -PS:\> cinst ActivePerl +PS:\> choco install ActivePerl ---- or ---- -PS:\> cinst StrawberryPerl +PS:\> choco install StrawberryPerl ---- After correct installation, typing at the command @@ -828,7 +857,13 @@ in various places. Sed is available for most of the UNIX-like platforms and as the sed package from the -<<ChToolsCygwin,Cygwin setup>>. +<<ChToolsCygwin,Cygwin setup>>. It is also available via Chocolatey: + +// XXX Is sed part of the base Cygwin install? + +---- +PS$>choco install sed -source cygwin +---- If sed isn't already installed or available as a package for your platform, you can get it at @@ -859,7 +894,8 @@ However, the version string may vary. A native Windows sed package can be obtained from http://gnuwin32.sourceforge.net/[]. The -installation should be straightforward. +installation should be straightforward. A Chocolatey package +(devbox-sed) is available but has not been tested. [[ChToolsBison]] @@ -948,7 +984,7 @@ https://chocolatey.org/[Chocolatey] package. Note that the executable is named `win_flex`. ---- -PS:\>cinst winflexbison +PS:\>choco install winflexbison ---- Native packages are available from other sources such as @@ -1009,7 +1045,7 @@ The Git command line tools for Windows can be found at http://git-scm.com/download/win[] and can also be installed using Chocolatey: ---- -PS:\> cinst git +PS:\> choco install git ---- After correct installation, typing at the command @@ -1036,7 +1072,7 @@ Poshgit provides git command completion and alters the prompt to indicate the lo copy status. You can install it using Chocolatey: ---- -PS:\>cinst poshgit +PS:\>choco install poshgit ---- [[ChToolsGitGUI]] @@ -1119,7 +1155,7 @@ GNU wget is available for most of the UNIX-like platforms and as the wget package from the <<ChToolsCygwin,Cygwin setup>> and also using Chocolatey: ---- -PS$> cinst Wget +PS$> choco install Wget ---- You will only need wget, if you want to use the Windows automated library @@ -1168,9 +1204,14 @@ The NSIS (Nullsoft Scriptable Install System) is used to generate needed to be installed, including all required DLLs, plugins, and supporting files. -To install it, simply download the latest released version (currently 2.46) -from http://nsis.sourceforge.net[] and start the downloaded installer. You will -need NSIS version 2. Version 3 is not yet supported. +To install it, download the latest released version (currently 2.46) from +http://nsis.sourceforge.net[] and start the downloaded installer. You will +need NSIS version 2. Version 3 is not yet supported. You can also install it +using Chocolatey: + +---- +PS$> choco install nsis +---- You can find more instructions on using NSIS in <<ChSrcNSIS>>. |