aboutsummaryrefslogtreecommitdiffstats
path: root/docbook
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2018-03-16 10:33:58 -0700
committerGerald Combs <gerald@wireshark.org>2018-03-16 17:35:47 +0000
commit475daf767f96dae856c568870990b55f4481df75 (patch)
treeac29b31b6b56eb506b01a393f07f0ec8d952a2b9 /docbook
parent507d8211e9c5744caf4198274a724b8bdd0ee12e (diff)
More CMake documentation updates.
Change-Id: Ia568e0f46e7a38007bb9b8ea3d6c92233921cc46 Reviewed-on: https://code.wireshark.org/review/26504 Reviewed-by: Gerald Combs <gerald@wireshark.org>
Diffstat (limited to 'docbook')
-rw-r--r--docbook/wsdg_src/WSDG_chapter_tools.asciidoc18
1 files changed, 12 insertions, 6 deletions
diff --git a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
index f8e1891d4b..953e58dc29 100644
--- a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
+++ b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc
@@ -194,30 +194,36 @@ Using CMake on Windows is described further in <<ChWin32Generate>>.
Along with specifying a generator with the `-G` flag you can set variables
using the `-D` flag. Useful variables and generators include the following:
+-DBUILD_wireshark=OFF:: Don't build the Wireshark GUI application.
+Each command line utility has its own BUILD_xxx flag as well. For
+example, you can use -DBUILD_mmdbresolve=OFF to disable mmdbresolve.
+
-DENABLE_CAP=OFF:: Disable the POSIX capabilities check
-DCMAKE_BUILD_TYPE=Debug:: Enable debugging symbols
--DENABLE_GTK3=ON:: Enable GTK+ 3
+-DCARES_INCLUDE_DIR=/your/custom/cares/include, -DCARES_LIBRARY=/your/custom/cares/lib/libcares.so::
+Let you set the path to a locally-compiled version of c-ares. Most
+optional libraries have xxx_INCLUDE_DIR and xxx_LIB flags that let you
+control their discovery.
-+++-DCMAKE_C_FLAGS='-Qunused-arguments'+++:: Make ccache and clang work together
-DPYTHON_EXECUTABLE=c:/Python27/python:: Force the Python path. Useful on Windows since Cygwin’s /usrbin/python is a symlink.
-DENABLE_APPLICATION_BUNDLE=OFF:: Disable building an application bundle (Wireshark.app) on macOS
-You can list all build variables (with help) by running *`cmake -LH [options]
-../<Name_of_WS_source_dir>`*. This lists the cache of build variables
+You can list all build variables (with help) by running `cmake -LH [options]
+../<Name_of_WS_source_dir>`. This lists the cache of build variables
after the cmake run. To only view the current cache, add option `-N`.
-After running cmake, you can always run *`make help`* to see a list of all possible make targets.
+After running cmake, you can always run `make help` to see a list of all possible make targets.
Note that CMake honors user umask for creating directories as of now. You should set
the umask explicitly before running the `install` target.
CMake links:
-The home page of the CMake project: http://www.cmake.org/
+The home page of the CMake project: https://cmake.org/
Official documentation: https://cmake.org/documentation/