75e7674b48919ccecabfa82fb4e2b4b2b8d33a9b
[metze/wireshark/wip.git] / docbook / wsdg_src / WSDG_chapter_quick_setup.asciidoc
1 // WSDG Chapter Setup
2
3 [[ChapterSetup]]
4
5 == Quick Setup
6
7 [[ChSetupUNIX]]
8
9 === UNIX: Installation
10
11 All the tools required are usually installed on a UNIX developer machine.
12
13 If a tool is not already installed on your system, you can usually install it
14 using the package in your distribution: aptitude, yum, Synaptic, etc.
15
16 If an install package is not available or you have a
17 reason not to use it (maybe because it’s simply too old), you
18 can install that tool from source code. The following sections
19 will provide you with the webpage addresses where you can get
20 these sources.
21
22 [[ChSetupWin32]]
23
24 === Win32/64: Step-by-Step Guide
25
26 A quick setup guide for Win32 and Win64 with recommended
27 configuration.
28
29 [WARNING]
30 ====
31 Unless you know exactly what you are doing, you
32 should strictly follow the recommendations below. They are known to work
33 and if the build breaks, please re-read this guide carefully.
34
35 Known traps are:
36
37 . Not using the correct (x86 or x64) version of the Visual Studio command prompt.
38
39 . Not copying/downloading the correct version of vcredist_xYY.exe.
40
41 ====
42
43 [[ChSetupChocolatey]]
44
45 ==== Optional: Install Chocolatey
46
47 https://chocolatey.org/[Chocolatey] is a native package manager for Windows.
48 There are https://chocolatey.org/packages[packages] for most of the software
49 listed below. Along with traditional Windows packages it supports Cygwin and
50 the Python Package Index.
51
52 // ...such as:
53 // - Active Perl and/or StrawberryPerl
54 // - Devbox-UnZip and/or 7zip and/or peazip
55 // - Wget
56 // - Git (a native win32 (MSYS) version)
57
58 [[ChSetupMSVC]]
59
60 ==== Install Microsoft C compiler and SDK
61
62 You need to install, in exactly this order:
63
64 . C compiler:
65 https://go.microsoft.com/fwlink/?LinkId=532606&clcid=0x409[Download]
66 and install ``Microsoft Visual Studio 2015 Community Edition.'' This is a small
67 download that then downloads all the other required parts (which are quite large).
68
69 Select the "Custom" install and then uncheck all the optional components other
70 than "Common Tools for Visual C++ 2015" (unless you want to use them for purposes
71 other than Wireshark).
72
73 You can use Chocolatey to install Visual Studio, to correctly configure the
74 installation, copy the deployment XML file https://code.wireshark.org/review/gitweb?p=wireshark.git;a=blob_plain;f=tools/msvc2015AdminDeployment.xml;hb=HEAD[msvc2015AdminDeployment.xml] from the source code tools directory
75 and pass the path the file to the chocolatey install command:
76
77 ----
78 PS$>choco install VisualStudio2015Community --timeout 0 -package-parameters "--AdminFile path\to\msvc2015AdminDeployment.xml"
79 ----
80
81 You can use other Microsoft C compiler variants, but VS2015 is used to
82 build the development releases and is the preferred option. It’s
83 possible to compile Wireshark with a wide range of Microsoft C compiler
84 variants. For details see <<ChToolsMSChain>>.
85
86 You may have to do this as Administrator.
87
88 Compiling with gcc or Clang is not recommended and will
89 certainly not work (at least not without a lot of advanced
90 tweaking). For further details on this topic, see
91 <<ChToolsGNUChain>>. This may change in future as releases
92 of Visual Studio add more cross-platform support.
93
94 // XXX - mention the compiler and PSDK web installers -
95 // which significantly reduce download size - and find out the
96 // required components
97
98 Why is this recommended? While this is a huge download,
99 Visual Studio 2015 Community Edition is the only free (as in beer)
100 versions that includes the Visual Studio integrated
101 debugger. Visual Studio 2015 is also used to create official
102 Wireshark builds, so it will likely have fewer development-related
103 problems.
104
105 [[ChSetupQt]]
106
107 ==== Install Qt
108
109 The main Wireshark application uses the Qt windowing toolkit. To install
110 Qt download the *Qt Online Installer for Windows* from the Qt Project
111 https://www.qt.io/download-open-source/["Download Open Source" page] and
112 select a component that matches your target system and compiler. For
113 example, the ``msvc2015 64-bit'' component is used to build the official
114 64-bit packages.  You can deselect all the Qt xxxx (e.g. Qt Charts)
115 components as they aren't required.
116
117 Note that installation of separate Qt components are required for 32 bit
118 and 64 bit builds, e.g. ``msvc2015 32-bit'' and ``msvc2015 64-bit''. The
119 environment variable `QT5_BASE_DIR` should be set as appropriate for your
120 environment and should point to the Qt directory that contains the bin
121 directory, e.g. _C:\Qt\5.9.1\msvc2015_64_
122
123 The Qt maintenance tool (_C:\Qt\MaintenanceTool.exe_) can be used to
124 upgrade Qt to newer versions.
125
126 [[ChSetupCygwin]]
127
128 ==== Install Cygwin
129
130 On 32-bit Windows, http://www.cygwin.com/setup-x86.exe[download the
131 32-bit Cygwin installer] and start it. On 64-bit Windows,
132 http://www.cygwin.com/setup-x86_64.exe[download the 64-bit Cygwin
133 installer] and start it.
134
135 At the "Select Packages" page, you'll need to select
136 some additional packages which are not installed by default.
137 Navigate to the required Category/Package row and, if the package
138 has a "Skip" item in the "New" column, click on the "Skip" item
139 so it shows a version number for:
140
141 * Devel/bison (or install Win flex-bison - see Chocolatey below)
142
143 * Devel/flex (or install Win flex-bison - see Chocolatey below)
144
145 * Devel/git (recommended - see discussion about using Git below)
146
147 * Interpreters/perl
148
149 * Utils/patch (only if needed) (may be Devel/patch instead)
150
151 * Web/wget (not needed if using CMake)
152
153 * Text/docbook-xml45
154
155 // Also need: bash/sh, sed
156
157 You might also have to install
158
159 * Interpreters/m4
160
161 if installing Devel/bison doesn't provide a working version of Bison. If
162 m4 is missing bison will fail.
163
164 After clicking the btn:[Next] button several times, the setup
165 will then download and install the selected packages (this
166 may take a while).
167
168 Alternatively you can install Cygwin and its packages using Chocolatey:
169
170 ----
171 PS$>choco install cygwin
172 PS$>choco install cyg-get
173 ----
174 //PS$>choco install sed [...] -source cygwin
175
176 Chocolatey installs Cygwin in _C:\tools\cygwin_ by default.
177
178 You can directly download packages via `cyg-get`
179
180 ----
181 PS$>cyg-get docbook-xml45 [...]
182 ----
183
184 You can use Chocolatey’s Win flex-bison packages rather than the Cygwin
185 Bison and Flex package:
186
187 ----
188 PS$>choco install winflexbison
189 ----
190
191 [[ChSetupPython]]
192
193 ==== Install Python
194
195 Get the Python 3.5 or 2.7 installer from http://python.org/download/[] and
196 install Python into the default location (_C:\Python35_ or _C:\Python27_).
197
198 Why is this recommended? Cygwin’s _/usr/bin/python_ is a Cygwin-specific
199 symbolic link which cannot be run from Windows. The native package is faster
200 as well.
201
202 Alternatively you can install Python using Chocolatey:
203
204 ----
205 PS$>choco install python3
206 ----
207
208 or
209
210 ----
211 PS$>choco install python2
212 ----
213
214 Chocolatey installs Python in _C:\tools\python3_ and _C:\tools\python2_ by default.
215
216 [[ChSetupGit]]
217
218 ==== Install Git
219
220 Please note that the following is not required to build Wireshark but can be
221 quite helpful when working with the sources.
222
223 Working with the Git source repositories is highly recommended, see
224 <<ChSrcObtain>>. It is much easier to update a personal source tree (local repository) with Git
225 rather than downloading a zip file and merging new sources into a personal
226 source tree by hand. It also makes first-time setup easy and enables the
227 Wireshark build process to determine your current source code revision.
228
229 There are several ways in which Git can be installed. Most packages are
230 available at the URLs below or via https://chocolatey.org/[Chocolatey].
231 Note that many of the GUI interfaces depend on the command line version.
232
233 If installing the Windows version of git select the
234 _Use Git from the Windows Command Prompt_ (in chocolatey the _/GitOnlyOnPath_
235 option).  Do *not* select the _Use Git and optional Unix tools from the Windows Command Prompt_
236 option (in chocolatey the _/GitAndUnixToolsOnPath_ option).
237
238 ===== The Official Windows Installer
239
240 The official command-line installer is available at https://git-scm.com/download/win.
241
242 ===== Git Extensions
243
244 Git Extensions is a native Windows graphical Git client for
245 Windows.  You can download the installer from
246 https://github.com/gitextensions/gitextensions/releases/latest.
247
248 ===== TortoiseGit
249
250 TortoiseGit is a native Windows graphical Git
251 similar to TortoiseSVN. You can download the installer from
252 https://tortoisegit.org/download/.
253
254 ===== Command Line client via Chocolatey
255
256 The command line client can be installed (and updated) using Chocolatey:
257 ----
258 PS$> choco install git
259 ----
260
261 ===== Others
262
263 A list of other GUI interfaces for Git can be found at
264 https://git-scm.com/downloads/guis
265
266
267 [[ChSetupCMake]]
268
269 ==== Install CMake
270
271 Get the CMake installer from https://cmake.org/download/[] and install CMake into
272 the default location.  Ensure the directory containing cmake.exe is added to your path.
273
274 Alternatively you can install CMake using Chocolatey:
275
276 ----
277 PS$>choco install cmake.portable
278 ----
279
280 Chocolatey ensures cmake.exe is on your path.
281
282 [[ChSetupAsciidoctor]]
283
284 ==== Install Asciidoctor
285
286 http://asciidoctor.org/[Asciidoctor] can be run directly as a Ruby
287 script or via a Java wrapper (AsciidoctorJ). The easiest way to install
288 it on Windows is via Chocolatey:
289
290 ----
291 PS$>choco install asciidoctorj
292 ----
293
294 Chocolatey ensures that asciidoctorj.exe is on your path.
295
296 ==== Install and Prepare Sources
297
298 [TIP]
299 .Make sure everything works
300 ====
301 It’s a good idea to make sure Wireshark compiles and runs at least once before
302 you start hacking the Wireshark sources for your own project. This example uses
303 Git Extensions but any other Git client should work as well.
304 ====
305
306 // XXX -
307
308 *Download sources* Download Wireshark sources into
309 _C:\Development\wireshark_ using either the command line or Git Extensions:
310
311 Using the command line:
312
313 ----
314 >cd C:\Development
315 >git clone https://code.wireshark.org/review/wireshark
316 ----
317
318 Using Git extensions:
319
320 . Open the Git Extensions application. By default Git Extensions
321    will show a validation checklist at startup. If anything needs to
322    be fixed do so now. You can bring up the checklist at any time
323    via menu:Tools[Settings].
324
325 . In the main screen select _Clone repository_. Fill in the following:
326 +
327 Repository to clone: *`https://code.wireshark.org/review/wireshark`*
328 +
329 Destination: Your top-level development directory, e.g. _C:\Development_.
330 +
331 Subdirectory to create: Anything you’d like. Usually _wireshark_.
332 +
333 [TIP]
334 .Check your paths
335 ====
336 Make sure your repository path doesn't contain spaces.
337 ====
338
339 . Click the btn:[Clone] button. Git Extensions should start cloning the
340   Wireshark repository.
341
342 [[ChSetupPrepareCommandCom]]
343
344 ==== Open a Visual Studio Command Prompt
345
346 From the Start Menu (or Start Screen), navigate to the `Visual Studio
347 2015' folder and choose the Command Prompt appropriate for
348 the build you wish to make, e.g. `VS2015 x64 Native Tools Command
349 Prompt' for a 64-bit version or `VS2015 x86 Native Tools Command Prompt'
350 for a 32-bit version. Depending on your version of Windows the Command
351 Prompt list might be directly under `Visual Studio 2015' or you might
352 have to dig for it under multiple folders, e.g. `Visual Studio 2015 ->
353 Visual Studio Tools -> Windows Desktop Command Prompts'.
354
355 [TIP]
356 .Pin the items to the Task Bar
357 ====
358 Pin the Command Prompt you use to the Task Bar for easy access.
359 ====
360
361 All subsequent operations take place in this Command Prompt window.
362
363 . Set environment variables to control the build.
364 +
365 --
366 Set the following environment variables, using paths and values suitable for your installation:
367
368 ----
369 > rem Let CMake determine the library download directory name under
370 > rem WIRESHARK_BASE_DIR or set it explicitly by using WIRESHARK_LIB_DIR.
371 > rem Set *one* of these.
372 > set WIRESHARK_BASE_DIR=C:\Development
373 > rem set WIRESHARK_LIB_DIR=c:\wireshark-win64-libs
374 > rem Set the Qt installation directory
375 > set QT5_BASE_DIR=C:\Qt\5.9.1\msvc2015_64
376 > rem Append a custom string to the package version. Optional.
377 > set WIRESHARK_VERSION_EXTRA=-YourExtraVersionInfo
378 ----
379
380 If your Cygwin installation path is not automatically detected by CMake,
381 you can explicitly specify it with the following environment variable:
382
383 ----
384 > rem Chocolatey installs Cygwin in an odd location
385 > set WIRESHARK_CYGWIN_INSTALL_PATH=C:\ProgramData\chocolatey\lib\Cygwin\tools\cygwin
386 ----
387
388 If you are using a version of Visual Studio earlier than VS2012 then you must set an additional env var,
389 e.g. for VS2010 set the following:
390 ----
391 > set VisualStudioVersion=10.0
392 ----
393
394 Setting these variables could be added to a batch file to be run after you open
395 the Visual Studio Tools Command Prompt.
396
397 [TIP]
398 ====
399 Qt 5.9 is a "long term support" branch of Qt5. We recommend using it to
400 compile Wireshark on Windows.
401 ====
402
403 --
404
405 . Create and change to the correct build directory.  CMake is best used in an out-of-tree build configuration
406 where the build is done in a separate directory to the source tree, leaving the source tree in a pristine
407 state.  32 and 64 bit builds require a separate build directory.  Create (if required) and change to the appropriate
408 build directory.
409 +
410 --
411 ----
412 > mkdir C:\Development\wsbuild32
413 > cd C:\Development\wsbuild32
414 ----
415 to create and jump into the build directory.
416
417 The build directory can be deleted at any time and the build files regenerated as detailed in <<ChWin32Generate>>.
418 --
419
420 [[ChWin32Generate]]
421
422 ==== Generate the build files
423
424 CMake is used to process the CMakeLists.txt files in the source tree and produce build files appropriate
425 for your system.
426
427 You can generate Visual Studio solution files to build either from within Visual Studio, or from the command
428 line with MSBuild.  CMake can also generate other build types but they aren't supported.
429
430 The initial generation step is only required the first time a build directory is created.  Subsequent
431 builds will regenerate the build files as required.
432
433 If you've closed the Visual Studio Command Prompt <<ChSetupPrepareCommandCom,prepare>> it again.
434
435 To generate the build files enter the following at the Visual Studio command prompt:
436 ----
437 > cmake -G "Visual Studio 14 2015" ..\wireshark
438 ----
439
440 Adjusting the paths as required to Python and the wireshark source tree.
441 To use a different generator modify the `-G` parameter. `cmake -G` lists
442 all the CMake supported generators, but only Visual Studio is supported
443 for Wireshark builds.
444
445 To build an x64 version, the `-G` parameter must have a Win64 suffix,
446 e.g. `-G "Visual Studio 14 2015 Win64"`:
447
448 ----
449 > cmake -DENABLE_CHM_GUIDES=on -G "Visual Studio 14 2015 Win64" ..\wireshark
450 ----
451
452 The CMake generation process will download the required 3rd party libraries (apart from Qt)
453 as required, then test each library for usability before generating the build files.
454
455 At the end of the CMake generation process the following should be displayed:
456 ----
457 -- Configuring done
458 -- Generating done
459 -- Build files have been written to: C:/Development/wsbuild32
460 ----
461
462 If you get any other output, there is an issue in your envirnment that must be rectified before building.
463 Check the parameters passed to CMake, especially the `-G` option and the path to the Wireshark sources and
464 the environment variables `WIRESHARK_BASE_DIR` and `QT5_BASE_DIR`.
465
466 [[ChWin32Build]]
467
468 ==== Build Wireshark
469
470 Now it’s time to build Wireshark!
471
472 . If you've closed the Visual Studio Command Prompt <<ChSetupPrepareCommandCom,prepare>> it again.
473
474 . Run
475 +
476 --
477 ----
478 > msbuild /m /p:Configuration=RelWithDebInfo Wireshark.sln
479 ----
480 to build Wireshark.
481 --
482
483 . Wait for Wireshark to compile. This will take a while, and there will be a lot of text output in the command prompt window
484
485 . Run *`C:\Development\wsbuild32\run\RelWithDebInfo\Wireshark.exe`* and make sure it starts.
486
487 . Open menu:Help[About]. If it shows your "private" program
488 version, e.g.: Version {wireshark-version}-myprotocol123
489 congratulations! You have compiled your own version of Wireshark!
490
491 You may also open the Wireshark solution file (_Wireshark.sln_) in the Visual Studio IDE and build there.
492
493 TIP: If compilation fails for suspicious reasons after you changed some source
494 files try to clean the build files by running *`msbuild /m /p:Configuration=RelWithDebInfo Wireshark.sln /t:Clean`*
495 and then building the solution again.
496
497 The build files produced by CMake will regenerate themselves if required by changes in the source tree.
498
499 ==== Debug Environment Setup
500
501 You can debug using the Visual Studio Debugger or WinDbg.  See the section
502 on using the <<ChToolsDebugger, Debugger Tools>>.
503
504 ==== Optional: Create User’s and Developer’s Guide
505
506 Detailed information to build these guides can be found in the file
507 _docbook\README.adoc_ in the Wireshark sources.
508
509 ==== Optional: Create a Wireshark Installer
510
511 Note: You should have successfully built Wireshark
512 before doing the following.
513
514 If you want to build your own
515 _Wireshark-win32-{wireshark-version}-myprotocol123.exe_,
516 you'll need NSIS.
517
518 . NSIS:
519 http://nsis.sourceforge.net[Download] and install NSIS
520 +
521 Note that the 32-bit version of NSIS will work for both 32-bit and
522 64-bit versions of Wireshark. NSIS v3 is recommended and may be required
523 in the future.
524
525 Note: If you do not yet have a copy of vcredist_x86.exe or vcredist_x64.exe in _./wireshark-win**XX**-libs_ (where *_XX_* is 32 or 64) you will need to download the appropriate file and place it in _./wireshark-win**XX**-libs_ before starting this step.
526
527 If building an x86 version using a Visual Studio "Express" edition or an x64 version with any edition, then you must have the appropriate vcredist file for your compiler in the support libraries directory (_vcredist_x86.exe_ in _wireshark-32-libs_ or _vcredist_x64.exe_ in _wireshark-win64-libs_).
528
529 The files can be located in the Visual Studio install directory for non-Express edition builds, or downloaded from Microsoft for Expresss edition builds.
530
531 Note you must use the correct version of vcredist for your compiler, unfortunately they all have the same name (_vcredist_x86.exe_ or _vcredist_x64.exe_).  You can use Windows Explorer and examine the `Properties -> Details' tab for a vcredist file to determine which compiler version the file is for use with.
532
533 . If you've closed the Visual Studio Command Prompt <<ChSetupPrepareCommandCom,prepare>> it again.
534
535 . Run
536 +
537 --
538 ----
539 > msbuild /m /p:Configuration=RelWithDebInfo nsis_package_prep.vcxproj
540 > msbuild /m /p:Configuration=RelWithDebInfo nsis_package.vcxproj
541 ----
542 to build a Wireshark installer.
543 --
544
545 . Run
546 +
547 --
548 ----
549 > C:\Development\wireshark\packaging\nsis\wireshark-win32-{wireshark-version}-myprotocol123.exe
550 ----
551 to test your new installer. It’s a good idea to test on a different machine
552 than the developer machine. Note that if you've built an x64 version, the installer will be named accordingly.
553 --