Commit 3442f2bc authored by Kitware Robot's avatar Kitware Robot Committed by Brad King
Browse files

Help: Format manual/*.1.rst options as definition lists

Convert the command-line option documentation formatting from bullet
lists to definition lists.
parent d592fc48
The following resources are available to get help using CMake:
* ``Home Page``: http://www.cmake.org
Home Page
http://www.cmake.org
The primary starting point for learning about CMake.
The primary starting point for learning about CMake.
* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ
Frequently Asked Questions
http://www.cmake.org/Wiki/CMake_FAQ
A Wiki is provided containing answers to frequently asked questions.
A Wiki is provided containing answers to frequently asked questions.
* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html
Online Documentation
http://www.cmake.org/HTML/Documentation.html
Links to available documentation may be found on this web page.
Links to available documentation may be found on this web page.
* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html
Mailing List
http://www.cmake.org/HTML/MailingLists.html
For help and discussion about using cmake, a mailing list is
provided at cmake@cmake.org. The list is member-post-only but one
may sign up on the CMake web page. Please first read the full
documentation at http://www.cmake.org before posting questions to
the list.
For help and discussion about using cmake, a mailing list is
provided at cmake@cmake.org. The list is member-post-only but one
may sign up on the CMake web page. Please first read the full
documentation at http://www.cmake.org before posting questions to
the list.
* ``-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.
.. |file| replace:: The help is printed to a named <f>ile if given.
* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit.
``--help,-help,-usage,-h,-H,/?``
Print usage information and exit.
Usage describes the basic command line interface and its options.
Usage describes the basic command line interface and its options.
* ``--version,-version,/V [<f>]``: Show program name/version banner and exit.
``--version,-version,/V [<f>]``
Show program name/version banner and exit.
If a file is specified, the version is written into it.
|file|
If a file is specified, the version is written into it.
|file|
* ``--help-manual <man> [<f>]``: Print one help manual and exit.
``--help-manual <man> [<f>]``
Print one help manual and exit.
The specified manual is printed in a human-readable text format.
|file|
The specified manual is printed in a human-readable text format.
|file|
* ``--help-manual-list [<f>]``: List help manuals available and exit.
``--help-manual-list [<f>]``
List help manuals available and exit.
The list contains all manuals for which help may be obtained by
using the ``--help-manual`` option followed by a manual name.
|file|
The list contains all manuals for which help may be obtained by
using the ``--help-manual`` option followed by a manual name.
|file|
* ``--help-command <cmd> [<f>]``: Print help for one command and exit.
``--help-command <cmd> [<f>]``
Print help for one command and exit.
The :manual:`cmake-commands(7)` manual entry for ``<cmd>`` is
printed in a human-readable text format.
|file|
The :manual:`cmake-commands(7)` manual entry for ``<cmd>`` is
printed in a human-readable text format.
|file|
* ``--help-command-list [<f>]``: List commands with help available and exit.
``--help-command-list [<f>]``
List commands with help available and exit.
The list contains all commands for which help may be obtained by
using the ``--help-command`` option followed by a command name.
|file|
The list contains all commands for which help may be obtained by
using the ``--help-command`` option followed by a command name.
|file|
* ``--help-commands [<f>]``: Print cmake-commands manual and exit.
``--help-commands [<f>]``
Print cmake-commands manual and exit.
The :manual:`cmake-commands(7)` manual is printed in a
human-readable text format.
|file|
The :manual:`cmake-commands(7)` manual is printed in a
human-readable text format.
|file|
* ``--help-module <mod> [<f>]``: Print help for one module and exit.
``--help-module <mod> [<f>]``
Print help for one module and exit.
The :manual:`cmake-modules(7)` manual entry for ``<mod>`` is printed
in a human-readable text format.
|file|
The :manual:`cmake-modules(7)` manual entry for ``<mod>`` is printed
in a human-readable text format.
|file|
* ``--help-module-list [<f>]``: List modules with help available and exit.
``--help-module-list [<f>]``
List modules with help available and exit.
The list contains all modules for which help may be obtained by
using the ``--help-module`` option followed by a module name.
|file|
The list contains all modules for which help may be obtained by
using the ``--help-module`` option followed by a module name.
|file|
* ``--help-modules [<f>]``: Print cmake-modules manual and exit.
``--help-modules [<f>]``
Print cmake-modules manual and exit.
The :manual:`cmake-modules(7)` manual is printed in a human-readable
text format.
|file|
The :manual:`cmake-modules(7)` manual is printed in a human-readable
text format.
|file|
* ``--help-policy <cmp> [<f>]``: Print help for one policy and exit.
``--help-policy <cmp> [<f>]``
Print help for one policy and exit.
The :manual:`cmake-policies(7)` manual entry for ``<cmp>`` is
printed in a human-readable text format.
|file|
The :manual:`cmake-policies(7)` manual entry for ``<cmp>`` is
printed in a human-readable text format.
|file|
* ``--help-policy-list [<f>]``: List policies with help available and exit.
``--help-policy-list [<f>]``
List policies with help available and exit.
The list contains all policies for which help may be obtained by
using the ``--help-policy`` option followed by a policy name.
|file|
The list contains all policies for which help may be obtained by
using the ``--help-policy`` option followed by a policy name.
|file|
* ``--help-policies [<f>]``: Print cmake-policies manual and exit.
``--help-policies [<f>]``
Print cmake-policies manual and exit.
The :manual:`cmake-policies(7)` manual is printed in a
human-readable text format.
|file|
The :manual:`cmake-policies(7)` manual is printed in a
human-readable text format.
|file|
* ``--help-property <prop> [<f>]``: Print help for one property and exit.
``--help-property <prop> [<f>]``
Print help for one property and exit.
The :manual:`cmake-properties(7)` manual entries for ``<prop>`` are
printed in a human-readable text format.
|file|
The :manual:`cmake-properties(7)` manual entries for ``<prop>`` are
printed in a human-readable text format.
|file|
* ``--help-property-list [<f>]``: List properties with help available and exit.
``--help-property-list [<f>]``
List properties with help available and exit.
The list contains all properties for which help may be obtained by
using the ``--help-property`` option followed by a property name.
|file|
The list contains all properties for which help may be obtained by
using the ``--help-property`` option followed by a property name.
|file|
* ``--help-properties [<f>]``: Print cmake-properties manual and exit.
``--help-properties [<f>]``
Print cmake-properties manual and exit.
The :manual:`cmake-properties(7)` manual is printed in a
human-readable text format.
|file|
The :manual:`cmake-properties(7)` manual is printed in a
human-readable text format.
|file|
* ``--help-variable <var> [<f>]``: Print help for one variable and exit.
``--help-variable <var> [<f>]``
Print help for one variable and exit.
The :manual:`cmake-variables(7)` manual entry for ``<var>`` is
printed in a human-readable text format.
|file|
The :manual:`cmake-variables(7)` manual entry for ``<var>`` is
printed in a human-readable text format.
|file|
* ``--help-variable-list [<f>]``: List variables with help available and exit.
``--help-variable-list [<f>]``
List variables with help available and exit.
The list contains all variables for which help may be obtained by
using the ``--help-variable`` option followed by a variable name.
|file|
The list contains all variables for which help may be obtained by
using the ``--help-variable`` option followed by a variable name.
|file|
* ``--help-variables [<f>]``: Print cmake-variables manual and exit.
``--help-variables [<f>]``
Print cmake-variables manual and exit.
The :manual:`cmake-variables(7)` manual is printed in a
human-readable text format.
|file|
The :manual:`cmake-variables(7)` manual is printed in a
human-readable text format.
|file|
......@@ -32,112 +32,127 @@ Options
.. include:: OPTIONS_BUILD.txt
* ``-E``: CMake command mode.
``-E``
CMake command mode.
For true platform independence, CMake provides a list of commands
that can be used on all systems. Run with -E help for the usage
information. Commands available are: chdir, compare_files, copy,
copy_directory, copy_if_different, echo, echo_append, environment,
make_directory, md5sum, remove, remove_directory, rename, tar, time,
touch, touch_nocreate. In addition, some platform specific commands
are available. On Windows: delete_regv, write_regv. On
UNIX: create_symlink.
For true platform independence, CMake provides a list of commands
that can be used on all systems. Run with -E help for the usage
information. Commands available are: chdir, compare_files, copy,
copy_directory, copy_if_different, echo, echo_append, environment,
make_directory, md5sum, remove, remove_directory, rename, tar, time,
touch, touch_nocreate. In addition, some platform specific commands
are available. On Windows: delete_regv, write_regv. On
UNIX: create_symlink.
* ``-L[A][H]``: List non-advanced cached variables.
``-L[A][H]``
List non-advanced cached variables.
List cache variables will run CMake and list all the variables from
the CMake cache that are not marked as INTERNAL or ADVANCED. This
will effectively display current CMake settings, which can then be
changed with -D option. Changing some of the variables may result
in more variables being created. If A is specified, then it will
display also advanced variables. If H is specified, it will also
display help for each variable.
List cache variables will run CMake and list all the variables from
the CMake cache that are not marked as INTERNAL or ADVANCED. This
will effectively display current CMake settings, which can then be
changed with -D option. Changing some of the variables may result
in more variables being created. If A is specified, then it will
display also advanced variables. If H is specified, it will also
display help for each variable.
* ``--build <dir>``: Build a CMake-generated project binary tree.
``--build <dir>``
Build a CMake-generated project binary tree.
This abstracts a native build tool's command-line interface with the
following options:
This abstracts a native build tool's command-line interface with the
following options:
::
::
<dir> = Project binary directory to be built.
--target <tgt> = Build <tgt> instead of default targets.
--config <cfg> = For multi-configuration tools, choose <cfg>.
--clean-first = Build target 'clean' first, then build.
(To clean only, use --target 'clean'.)
--use-stderr = Ignored. Behavior is default in CMake >= 3.0.
-- = Pass remaining options to the native tool.
<dir> = Project binary directory to be built.
--target <tgt> = Build <tgt> instead of default targets.
--config <cfg> = For multi-configuration tools, choose <cfg>.
--clean-first = Build target 'clean' first, then build.
(To clean only, use --target 'clean'.)
--use-stderr = Ignored. Behavior is default in CMake >= 3.0.
-- = Pass remaining options to the native tool.
Run cmake --build with no options for quick help.
Run cmake --build with no options for quick help.
* ``-N``: View mode only.
``-N``
View mode only.
Only load the cache. Do not actually run configure and generate
steps.
Only load the cache. Do not actually run configure and generate
steps.
* ``-P <file>``: Process script mode.
``-P <file>``
Process script mode.
Process the given cmake file as a script written in the CMake
language. No configure or generate step is performed and the cache
is not modified. If variables are defined using -D, this must be
done before the -P argument.
Process the given cmake file as a script written in the CMake
language. No configure or generate step is performed and the cache
is not modified. If variables are defined using -D, this must be
done before the -P argument.
* ``--find-package``: Run in pkg-config like mode.
``--find-package``
Run in pkg-config like mode.
Search a package using find_package() and print the resulting flags
to stdout. This can be used to use cmake instead of pkg-config to
find installed libraries in plain Makefile-based projects or in
autoconf-based projects (via share/aclocal/cmake.m4).
Search a package using find_package() and print the resulting flags
to stdout. This can be used to use cmake instead of pkg-config to
find installed libraries in plain Makefile-based projects or in
autoconf-based projects (via share/aclocal/cmake.m4).
* ``--graphviz=[file]``: Generate graphviz of dependencies, see CMakeGraphVizOptions.cmake for more.
``--graphviz=[file]``
Generate graphviz of dependencies, see CMakeGraphVizOptions.cmake for more.
Generate a graphviz input file that will contain all the library and
executable dependencies in the project. See the documentation for
CMakeGraphVizOptions.cmake for more details.
Generate a graphviz input file that will contain all the library and
executable dependencies in the project. See the documentation for
CMakeGraphVizOptions.cmake for more details.
* ``--system-information [file]``: Dump information about this system.
``--system-information [file]``
Dump information about this system.
Dump a wide range of information about the current system. If run
from the top of a binary tree for a CMake project it will dump
additional information such as the cache, log files etc.
Dump a wide range of information about the current system. If run
from the top of a binary tree for a CMake project it will dump
additional information such as the cache, log files etc.
* ``--debug-trycompile``: Do not delete the try_compile build tree. Only useful on one try_compile at a time.
``--debug-trycompile``
Do not delete the try_compile build tree. Only useful on one try_compile at a time.
Do not delete the files and directories created for try_compile
calls. This is useful in debugging failed try_compiles. It may
however change the results of the try-compiles as old junk from a
previous try-compile may cause a different test to either pass or
fail incorrectly. This option is best used for one try-compile at a
time, and only when debugging.
Do not delete the files and directories created for try_compile
calls. This is useful in debugging failed try_compiles. It may
however change the results of the try-compiles as old junk from a
previous try-compile may cause a different test to either pass or
fail incorrectly. This option is best used for one try-compile at a
time, and only when debugging.
* ``--debug-output``: Put cmake in a debug mode.
``--debug-output``
Put cmake in a debug mode.
Print extra stuff during the cmake run like stack traces with
message(send_error ) calls.
Print extra stuff during the cmake run like stack traces with
message(send_error ) calls.
* ``--trace``: Put cmake in trace mode.
``--trace``
Put cmake in trace mode.
Print a trace of all calls made and from where with
message(send_error ) calls.
Print a trace of all calls made and from where with
message(send_error ) calls.
* ``--warn-uninitialized``: Warn about uninitialized values.
``--warn-uninitialized``
Warn about uninitialized values.
Print a warning when an uninitialized variable is used.
Print a warning when an uninitialized variable is used.
* ``--warn-unused-vars``: Warn about unused variables.
``--warn-unused-vars``
Warn about unused variables.
Find variables that are declared or set, but not used.
Find variables that are declared or set, but not used.
* ``--no-warn-unused-cli``: Don't warn about command line options.
``--no-warn-unused-cli``
Don't warn about command line options.
Don't find variables that are declared on the command line, but not
used.
Don't find variables that are declared on the command line, but not
used.
* ``--check-system-vars``: Find problems with variable usage in system files.
``--check-system-vars``
Find problems with variable usage in system files.
Normally, unused and uninitialized variables are searched for only
in CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR. This flag tells CMake to
warn about other files as well.
Normally, unused and uninitialized variables are searched for only
in CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR. This flag tells CMake to
warn about other files as well.
.. include:: OPTIONS_HELP.txt
......
......@@ -27,57 +27,67 @@ native tool on their platform.
Options
=======
* ``-G <generator>``: Use the specified generator to generate package.
``-G <generator>``
Use the specified generator to generate package.
CPack may support multiple native packaging systems on certain
platforms. A generator is responsible for generating input files
for particular system and invoking that systems. Possible generator
names are specified in the Generators section.
CPack may support multiple native packaging systems on certain
platforms. A generator is responsible for generating input files
for particular system and invoking that systems. Possible generator
names are specified in the Generators section.
* ``-C <Configuration>``: Specify the project configuration
``-C <Configuration>``
Specify the project configuration
This option specifies the configuration that the project was build
with, for example 'Debug', 'Release'.
This option specifies the configuration that the project was build
with, for example 'Debug', 'Release'.
* ``-D <var>=<value>``: Set a CPack variable.
``-D <var>=<value>``
Set a CPack variable.
Set a variable that can be used by the generator.
Set a variable that can be used by the generator.
* ``--config <config file>``: Specify the config file.
``--config <config file>``
Specify the config file.
Specify the config file to use to create the package. By default
CPackConfig.cmake in the current directory will be used.
Specify the config file to use to create the package. By default
CPackConfig.cmake in the current directory will be used.
* ``--verbose,-V``: enable verbose output
``--verbose,-V``
enable verbose output
Run cpack with verbose output.
Run cpack with verbose output.
* ``--debug``: enable debug output (for CPack developers)
``--debug``
enable debug output (for CPack developers)
Run cpack with debug output (for CPack developers).
Run cpack with debug output (for CPack developers).
* ``-P <package name>``: override/define CPACK_PACKAGE_NAME
``-P <package name>``
override/define CPACK_PACKAGE_NAME
If the package name is not specified on cpack commmand line
thenCPack.cmake defines it as CMAKE_PROJECT_NAME
If the package name is not specified on cpack commmand line
thenCPack.cmake defines it as CMAKE_PROJECT_NAME
* ``-R <package version>``: override/define CPACK_PACKAGE_VERSION
``-R <package version>``
override/define CPACK_PACKAGE_VERSION
If version is not specified on cpack command line thenCPack.cmake
defines it from CPACK_PACKAGE_VERSION_[MAJOR|MINOR|PATCH]look into
CPack.cmake for detail
If version is not specified on cpack command line thenCPack.cmake
defines it from CPACK_PACKAGE_VERSION_[MAJOR|MINOR|PATCH]look into
CPack.cmake for detail
* ``-B <package directory>``: override/define CPACK_PACKAGE_DIRECTORY
``-B <package directory>``
override/define CPACK_PACKAGE_DIRECTORY
The directory where CPack will be doing its packaging work.The
resulting package will be found there. Inside this directoryCPack
creates '_CPack_Packages' sub-directory which is theCPack temporary
directory.
The directory where CPack will be doing its packaging work.The
resulting package will be found there. Inside this directoryCPack
creates '_CPack_Packages' sub-directory which is theCPack temporary
directory.
* ``--vendor <vendor name>``: override/define CPACK_PACKAGE_VENDOR
``--vendor <vendor name>``
override/define CPACK_PACKAGE_VENDOR
If vendor is not specified on cpack command line (or inside
CMakeLists.txt) thenCPack.cmake defines it with a default value
If vendor is not specified on cpack command line (or inside
CMakeLists.txt) thenCPack.cmake defines it with a default value