summaryrefslogtreecommitdiffstats
path: root/Help/manual/OPTIONS_BUILD.txt
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-11-14 15:05:32 (GMT)
committerBrad King <brad.king@kitware.com>2013-11-14 15:05:32 (GMT)
commit3442f2bcc47ccce86124144423b416b98d589b20 (patch)
tree590e67c1e439cba91173865d8d649c525ba585af /Help/manual/OPTIONS_BUILD.txt
parentd592fc48cd24653ada365a3026e5d7f928955eb5 (diff)
downloadCMake-3442f2bcc47ccce86124144423b416b98d589b20.zip
CMake-3442f2bcc47ccce86124144423b416b98d589b20.tar.gz
CMake-3442f2bcc47ccce86124144423b416b98d589b20.tar.bz2
Help: Format manual/*.1.rst options as definition lists
Convert the command-line option documentation formatting from bullet lists to definition lists.
Diffstat (limited to 'Help/manual/OPTIONS_BUILD.txt')
-rw-r--r--Help/manual/OPTIONS_BUILD.txt87
1 files changed, 47 insertions, 40 deletions
diff --git a/Help/manual/OPTIONS_BUILD.txt b/Help/manual/OPTIONS_BUILD.txt
index 3aded5c..2079c44 100644
--- a/Help/manual/OPTIONS_BUILD.txt
+++ b/Help/manual/OPTIONS_BUILD.txt
@@ -1,57 +1,64 @@
-* ``-C <initial-cache>``: Pre-load a script to populate the cache.
+``-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.
+ 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.
+``-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.
+ 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.
+``-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.
+ 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.
+ Use with care, you can make your CMakeCache.txt non-working.
-* ``-G <generator-name>``: Specify a build system generator.
+``-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.
+ 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.
+``-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:
+ 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
+ Visual Studio >= 10
+ Xcode >= 3.0
- See native build system documentation for allowed toolset names.
+ See native build system documentation for allowed toolset names.
-* ``-Wno-dev``: Suppress developer warnings.
+``-Wno-dev``
+ Suppress developer warnings.
- Suppress warnings that are meant for the author of the
- CMakeLists.txt files.
+ Suppress warnings that are meant for the author of the
+ CMakeLists.txt files.
-* ``-Wdev``: Enable developer warnings.
+``-Wdev``
+ Enable developer warnings.
- Enable warnings that are meant for the author of the CMakeLists.txt
- files.
+ Enable warnings that are meant for the author of the CMakeLists.txt
+ files.