summaryrefslogtreecommitdiffstats
path: root/Help/manual/OPTIONS_BUILD.txt
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-10-16 15:24:16 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-16 20:24:51 (GMT)
commit5dde65ac5b1ecdcc5b47bdba1b806a25fe6d3402 (patch)
treeeeb705bbe9915d14aa7d1d3337f6ea14b23bf7ec /Help/manual/OPTIONS_BUILD.txt
parentae944d176ee77611bb492d5977b7c51c4ab9720f (diff)
downloadCMake-5dde65ac5b1ecdcc5b47bdba1b806a25fe6d3402.zip
CMake-5dde65ac5b1ecdcc5b47bdba1b806a25fe6d3402.tar.gz
CMake-5dde65ac5b1ecdcc5b47bdba1b806a25fe6d3402.tar.bz2
Help: De-duplicate manual/(cmake|ccmake).1.rst build options
Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
Diffstat (limited to 'Help/manual/OPTIONS_BUILD.txt')
-rw-r--r--Help/manual/OPTIONS_BUILD.txt57
1 files changed, 57 insertions, 0 deletions
diff --git a/Help/manual/OPTIONS_BUILD.txt b/Help/manual/OPTIONS_BUILD.txt
new file mode 100644
index 0000000..3aded5c
--- /dev/null
+++ b/Help/manual/OPTIONS_BUILD.txt
@@ -0,0 +1,57 @@
+* ``-C <initial-cache>``: Pre-load a script to populate the cache.
+
+ When cmake is first run in an empty build tree, it creates a
+ CMakeCache.txt file and populates it with customizable settings for
+ the project. This option may be used to specify a file from which
+ to load cache entries before the first pass through the project's
+ cmake listfiles. The loaded entries take priority over the
+ project's default values. The given file should be a CMake script
+ containing SET commands that use the CACHE option, not a
+ cache-format file.
+
+* ``-D <var>:<type>=<value>``: Create a cmake cache entry.
+
+ When cmake is first run in an empty build tree, it creates a
+ CMakeCache.txt file and populates it with customizable settings for
+ the project. This option may be used to specify a setting that
+ takes priority over the project's default value. The option may be
+ repeated for as many cache entries as desired.
+
+* ``-U <globbing_expr>``: Remove matching entries from CMake cache.
+
+ This option may be used to remove one or more variables from the
+ CMakeCache.txt file, globbing expressions using * and ? are
+ supported. The option may be repeated for as many cache entries as
+ desired.
+
+ Use with care, you can make your CMakeCache.txt non-working.
+
+* ``-G <generator-name>``: Specify a build system generator.
+
+ CMake may support multiple native build systems on certain
+ platforms. A generator is responsible for generating a particular
+ build system. Possible generator names are specified in the
+ Generators section.
+
+* ``-T <toolset-name>``: Specify toolset name if supported by generator.
+
+ Some CMake generators support a toolset name to be given to the
+ native build system to choose a compiler. This is supported only on
+ specific generators:
+
+ ::
+
+ Visual Studio >= 10
+ Xcode >= 3.0
+
+ See native build system documentation for allowed toolset names.
+
+* ``-Wno-dev``: Suppress developer warnings.
+
+ Suppress warnings that are meant for the author of the
+ CMakeLists.txt files.
+
+* ``-Wdev``: Enable developer warnings.
+
+ Enable warnings that are meant for the author of the CMakeLists.txt
+ files.