mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-04-30 11:10:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

Help: Use option directive for the executables manual pages

Browse Source 
It'll allow to refer to a particular option of any executable.

There are two "fake" programs added for the CMake script mode (`cmake_P`)
and CMake CLI Tool mode (`cmake_E`).
This commit is contained in:
Alex Turbov
2022-08-04 10:04:36 +04:00
parent 57fb264085
commit 8ffc5e1bbb
7 changed files with 443 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/manual/OPTIONS_BUILD.txt
+36 -18
View File
@@ -1,12 +1,15 @@
``-S <path-to-source>``
.. option:: -S <path-to-source>
Path to root directory of the CMake project to build.
``-B <path-to-build>``
.. option:: -B <path-to-build>
Path to directory which CMake will use as the root of build directory.
If the directory doesn't already exist CMake will make it.
``-C <initial-cache>``
.. option:: -C <initial-cache>
Pre-load a script to populate the cache.
When CMake is first run in an empty build tree, it creates a
@@ -21,7 +24,8 @@
References to :variable:`CMAKE_SOURCE_DIR` and :variable:`CMAKE_BINARY_DIR`
within the script evaluate to the top-level source and build tree.
``-D <var>:<type>=<value>, -D <var>=<value>``
.. option:: -D <var>:<type>=<value>, -D <var>=<value>
Create or update a CMake ``CACHE`` entry.
When CMake is first run in an empty build tree, it creates a
@@ -41,7 +45,8 @@
This option may also be given as a single argument:
``-D<var>:<type>=<value>`` or ``-D<var>=<value>``.
``-U <globbing_expr>``
.. option:: -U <globbing_expr>
Remove matching entries from CMake ``CACHE``.
This option may be used to remove one or more variables from the
@@ -51,7 +56,8 @@
Use with care, you can make your ``CMakeCache.txt`` non-working.
``-G <generator-name>``
.. option:: -G <generator-name>
Specify a build system generator.
CMake may support multiple native build systems on certain
@@ -62,72 +68,84 @@
If not specified, CMake checks the :envvar:`CMAKE_GENERATOR` environment
variable and otherwise falls back to a builtin default selection.
``-T <toolset-spec>``
.. option:: -T <toolset-spec>
Toolset specification for the generator, if supported.
Some CMake generators support a toolset specification to tell
the native build system how to choose a compiler. See the
:variable:`CMAKE_GENERATOR_TOOLSET` variable for details.
``-A <platform-name>``
.. option:: -A <platform-name>
Specify platform name if supported by generator.
Some CMake generators support a platform name to be given to the
native build system to choose a compiler or SDK. See the
:variable:`CMAKE_GENERATOR_PLATFORM` variable for details.
``--toolchain <path-to-file>``
.. option:: --toolchain <path-to-file>
Specify the cross compiling toolchain file, equivalent to setting
:variable:`CMAKE_TOOLCHAIN_FILE` variable.
``--install-prefix <directory>``
.. option:: --install-prefix <directory>
Specify the installation directory, used by the
:variable:`CMAKE_INSTALL_PREFIX` variable. Must be an absolute path.
``-Wno-dev``
.. option:: -Wno-dev
Suppress developer warnings.
Suppress warnings that are meant for the author of the
``CMakeLists.txt`` files. By default this will also turn off
deprecation warnings.
``-Wdev``
.. option:: -Wdev
Enable developer warnings.
Enable warnings that are meant for the author of the ``CMakeLists.txt``
files. By default this will also turn on deprecation warnings.
``-Werror=dev``
.. option:: -Werror=dev
Make developer warnings errors.
Make warnings that are meant for the author of the ``CMakeLists.txt`` files
errors. By default this will also turn on deprecated warnings as errors.
``-Wno-error=dev``
.. option:: -Wno-error=dev
Make developer warnings not errors.
Make warnings that are meant for the author of the ``CMakeLists.txt`` files not
errors. By default this will also turn off deprecated warnings as errors.
``-Wdeprecated``
.. option:: -Wdeprecated
Enable deprecated functionality warnings.
Enable warnings for usage of deprecated functionality, that are meant
for the author of the ``CMakeLists.txt`` files.
``-Wno-deprecated``
.. option:: -Wno-deprecated
Suppress deprecated functionality warnings.
Suppress warnings for usage of deprecated functionality, that are meant
for the author of the ``CMakeLists.txt`` files.
``-Werror=deprecated``
.. option:: -Werror=deprecated
Make deprecated macro and function warnings errors.
Make warnings for usage of deprecated macros and functions, that are meant
for the author of the ``CMakeLists.txt`` files, errors.
``-Wno-error=deprecated``
.. option:: -Wno-error=deprecated
Make deprecated macro and function warnings not errors.
Make warnings for usage of deprecated macros and functions, that are meant
Help/manual/OPTIONS_HELP.txt
+40 -20
View File
@@ -1,134 +1,154 @@
.. |file| replace:: The help is printed to a named <f>ile if given.
``--help,-help,-usage,-h,-H,/?``
.. option:: --help, -help, -usage, -h, -H, /?
Print usage information and exit.
Usage describes the basic command line interface and its options.
``--version,-version,/V [<f>]``
.. option:: --version, -version, /V [<f>]
Show program name/version banner and exit.
If a file is specified, the version is written into it.
|file|
``--help-full [<f>]``
.. option:: --help-full [<f>]
Print all help manuals and exit.
All manuals are printed in a human-readable text format.
|file|
``--help-manual <man> [<f>]``
.. option:: --help-manual <man> [<f>]
Print one help manual and exit.
The specified manual is printed in a human-readable text format.
|file|
``--help-manual-list [<f>]``
.. option:: --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|
``--help-command <cmd> [<f>]``
.. option:: --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|
``--help-command-list [<f>]``
.. option:: --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|
``--help-commands [<f>]``
.. option:: --help-commands [<f>]
Print cmake-commands manual and exit.
The :manual:`cmake-commands(7)` manual is printed in a
human-readable text format.
|file|
``--help-module <mod> [<f>]``
.. option:: --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|
``--help-module-list [<f>]``
.. option:: --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|
``--help-modules [<f>]``
.. option:: --help-modules [<f>]
Print cmake-modules manual and exit.
The :manual:`cmake-modules(7)` manual is printed in a human-readable
text format.
|file|
``--help-policy <cmp> [<f>]``
.. option:: --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|
``--help-policy-list [<f>]``
.. option:: --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|
``--help-policies [<f>]``
.. option:: --help-policies [<f>]
Print cmake-policies manual and exit.
The :manual:`cmake-policies(7)` manual is printed in a
human-readable text format.
|file|
``--help-property <prop> [<f>]``
.. option:: --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|
``--help-property-list [<f>]``
.. option:: --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|
``--help-properties [<f>]``
.. option:: --help-properties [<f>]
Print cmake-properties manual and exit.
The :manual:`cmake-properties(7)` manual is printed in a
human-readable text format.
|file|
``--help-variable <var> [<f>]``
.. option:: --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|
``--help-variable-list [<f>]``
.. option:: --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|
``--help-variables [<f>]``
.. option:: --help-variables [<f>]
Print cmake-variables manual and exit.
The :manual:`cmake-variables(7)` manual is printed in a
Help/manual/ccmake.1.rst
+2
View File
@@ -27,6 +27,8 @@ native tool on their platform.
Options
=======
.. program:: ccmake
.. include:: OPTIONS_BUILD.txt
.. include:: OPTIONS_HELP.txt
Help/manual/cmake-gui.1.rst
+10 -4
View File
@@ -29,19 +29,25 @@ native tool on their platform.
Options
=======
``-S <path-to-source>``
.. program:: cmake-gui
.. option:: -S <path-to-source>
Path to root directory of the CMake project to build.
``-B <path-to-build>``
.. option:: -B <path-to-build>
Path to directory which CMake will use as the root of build directory.
If the directory doesn't already exist CMake will make it.
``--preset=<preset-name>``
.. option:: --preset=<preset-name>
Name of the preset to use from the project's
:manual:`presets <cmake-presets(7)>` files, if it has them.
``--browse-manual``
.. option:: --browse-manual
Open the CMake reference manual in a browser and immediately exit.
.. include:: OPTIONS_HELP.txt
Help/manual/cmake.1.rst
+180 -87
View File
@@ -195,16 +195,20 @@ automatically choosing and invoking the appropriate native build tool.
Options
-------
.. program:: cmake
.. include:: OPTIONS_BUILD.txt
``--fresh``
.. option:: --fresh
.. versionadded:: 3.24
Perform a fresh configuration of the build tree.
This removes any existing ``CMakeCache.txt`` file and associated
``CMakeFiles/`` directory, and recreates them from scratch.
``-L[A][H]``
.. option:: -L[A][H]
List non-advanced cached variables.
List ``CACHE`` variables will run CMake and list all the variables from
@@ -215,27 +219,31 @@ Options
display also advanced variables. If ``H`` is specified, it will also
display help for each variable.
``-N``
.. option:: -N
View mode only.
Only load the cache. Do not actually run configure and generate
steps.
``--graphviz=[file]``
.. option:: --graphviz=[file]
Generate graphviz of dependencies, see :module:`CMakeGraphVizOptions` for more.
Generate a graphviz input file that will contain all the library and
executable dependencies in the project. See the documentation for
:module:`CMakeGraphVizOptions` for more details.
``--system-information [file]``
.. option:: --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.
``--log-level=<ERROR|WARNING|NOTICE|STATUS|VERBOSE|DEBUG|TRACE>``
.. option:: --log-level=<ERROR|WARNING|NOTICE|STATUS|VERBOSE|DEBUG|TRACE>
Set the log level.
The :command:`message` command will only output messages of the specified
@@ -250,11 +258,11 @@ Options
synonym for this option.
.. versionadded:: 3.25
See the :command:`cmake_language`
:ref:`cmake_language <query_message_log_level>` command for a way to query
the current message logging level.
See the :command:`cmake_language` command for a way to
:ref:`query the current message logging level <query_message_log_level>`.
.. option:: --log-context
``--log-context``
Enable the :command:`message` command outputting context attached to each
message.
@@ -264,7 +272,8 @@ Options
When this command line option is given, :variable:`CMAKE_MESSAGE_CONTEXT_SHOW`
is ignored.
``--debug-trycompile``
.. option:: --debug-trycompile
Do not delete the :command:`try_compile` build tree.
Only useful on one :command:`try_compile` at a time.
@@ -275,13 +284,15 @@ Options
fail incorrectly. This option is best used for one try-compile at a
time, and only when debugging.
``--debug-output``
.. option:: --debug-output
Put cmake in a debug mode.
Print extra information during the cmake run like stack traces with
:command:`message(SEND_ERROR)` calls.
``--debug-find``
.. option:: --debug-find
Put cmake find commands in a debug mode.
Print extra find call information during the cmake run to standard
@@ -289,7 +300,8 @@ Options
See also the :variable:`CMAKE_FIND_DEBUG_MODE` variable for debugging
a more local part of the project.
``--debug-find-pkg=<pkg>[,...]``
.. option:: --debug-find-pkg=<pkg>[,...]
Put cmake find commands in a debug mode when running under calls
to :command:`find_package(\<pkg\>) <find_package>`, where ``<pkg>``
is an entry in the given comma-separated list of case-sensitive package
@@ -297,24 +309,28 @@ Options
Like ``--debug-find``, but limiting scope to the specified packages.
``--debug-find-var=<var>[,...]``
.. option:: --debug-find-var=<var>[,...]
Put cmake find commands in a debug mode when called with ``<var>``
as the result variable, where ``<var>`` is an entry in the given
comma-separated list.
Like ``--debug-find``, but limiting scope to the specified variable names.
``--trace``
.. option:: --trace
Put cmake in trace mode.
Print a trace of all calls made and from where.
``--trace-expand``
.. option:: --trace-expand
Put cmake in trace mode.
Like ``--trace``, but with variables expanded.
``--trace-format=<format>``
.. option:: --trace-format=<format>
Put cmake in trace mode and sets the trace output format.
``<format>`` can be one of the following values.
@@ -400,46 +416,55 @@ Options
Indicates the version of the JSON format. The version has a
major and minor components following semantic version conventions.
``--trace-source=<file>``
.. option:: --trace-source=<file>
Put cmake in trace mode, but output only lines of a specified file.
Multiple options are allowed.
``--trace-redirect=<file>``
.. option:: --trace-redirect=<file>
Put cmake in trace mode and redirect trace output to a file instead of stderr.
``--warn-uninitialized``
.. option:: --warn-uninitialized
Warn about uninitialized values.
Print a warning when an uninitialized variable is used.
``--warn-unused-vars``
.. option:: --warn-unused-vars
Does nothing. In CMake versions 3.2 and below this enabled warnings about
unused variables. In CMake versions 3.3 through 3.18 the option was broken.
In CMake 3.19 and above the option has been removed.
``--no-warn-unused-cli``
.. option:: --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.
``--check-system-vars``
.. option:: --check-system-vars
Find problems with variable usage in system files.
Normally, unused and uninitialized variables are searched for only
in :variable:`CMAKE_SOURCE_DIR` and :variable:`CMAKE_BINARY_DIR`.
This flag tells CMake to warn about other files as well.
``--compile-no-warning-as-error``
.. option:: --compile-no-warning-as-error
Ignore target property :prop_tgt:`COMPILE_WARNING_AS_ERROR` and variable
:variable:`CMAKE_COMPILE_WARNING_AS_ERROR`, preventing warnings from being
treated as errors on compile.
``--profiling-output=<path>``
.. option:: --profiling-output=<path>
Used in conjunction with ``--profiling-format`` to output to a given path.
``--profiling-format=<file>``
.. option:: --profiling-format=<file>
Enable the output of profiling data of CMake script in the given format.
This can aid performance analysis of CMake scripts executed. Third party
@@ -450,7 +475,8 @@ Options
about:tracing tab of Google Chrome or using a plugin for a tool like Trace
Compass.
``--preset <preset>``, ``--preset=<preset>``
.. option:: --preset <preset>, --preset=<preset>
Reads a :manual:`preset <cmake-presets(7)>` from
``<path-to-source>/CMakePresets.json`` and
``<path-to-source>/CMakeUserPresets.json``. The preset may specify the
@@ -466,7 +492,8 @@ Options
a variable called ``MYVAR`` to ``1``, but the user sets it to ``2`` with a
``-D`` argument, the value ``2`` is preferred.
``--list-presets, --list-presets=<[configure | build | test | all]>``
.. option:: --list-presets, --list-presets=<[configure | build | test | all]>
Lists the available presets. If no option is specified only configure presets
will be listed. The current working directory must contain CMake preset files.
@@ -486,21 +513,25 @@ project binary tree:
This abstracts a native build tool's command-line interface with the
following options:
``--build <dir>``
.. option:: --build <dir>
Project binary directory to be built. This is required (unless a preset
is specified) and must be first.
``--preset <preset>``, ``--preset=<preset>``
.. option:: --preset <preset>, --preset=<preset>
Use a build preset to specify build options. The project binary directory
is inferred from the ``configurePreset`` key. The current working directory
must contain CMake preset files.
See :manual:`preset <cmake-presets(7)>` for more details.
``--list-presets``
.. option:: --list-presets
Lists the available build presets. The current working directory must
contain CMake preset files.
``--parallel [<jobs>], -j [<jobs>]``
.. option:: --parallel [<jobs>], -j [<jobs>]
The maximum number of concurrent processes to use when building.
If ``<jobs>`` is omitted the native build tool's default number is used.
@@ -510,18 +541,22 @@ following options:
Some native build tools always build in parallel. The use of ``<jobs>``
value of ``1`` can be used to limit to a single job.
``--target <tgt>..., -t <tgt>...``
.. option:: --target <tgt>..., -t <tgt>...
Build ``<tgt>`` instead of the default target. Multiple targets may be
given, separated by spaces.
``--config <cfg>``
.. option:: --config <cfg>
For multi-configuration tools, choose configuration ``<cfg>``.
``--clean-first``
.. option:: --clean-first
Build target ``clean`` first, then build.
(To clean only, use ``--target clean``.)
``--resolve-package-references=<on|off|only>``
.. option:: --resolve-package-references=<on|off|only>
.. versionadded:: 3.23
Resolve remote package references from external package managers (e.g. NuGet)
@@ -544,10 +579,12 @@ following options:
are restored using NuGet. It can be disabled by setting the
``CMAKE_VS_NUGET_PACKAGE_RESTORE`` variable to ``OFF``.
``--use-stderr``
.. option:: --use-stderr
Ignored. Behavior is default in CMake >= 3.0.
``--verbose, -v``
.. option:: --verbose, -v
Enable verbose output - if supported - including the build commands to be
executed.
@@ -555,7 +592,8 @@ following options:
:variable:`CMAKE_VERBOSE_MAKEFILE` cached variable is set.
``--``
.. option:: --
Pass remaining options to the native tool.
Run ``cmake --build`` with no options for quick help.
@@ -574,25 +612,32 @@ This may be used after building a project to run installation without
using the generated build system or the native build tool.
The options are:
``--install <dir>``
.. option:: --install <dir>
Project binary directory to install. This is required and must be first.
``--config <cfg>``
.. option:: --config <cfg>
For multi-configuration generators, choose configuration ``<cfg>``.
``--component <comp>``
.. option:: --component <comp>
Component-based install. Only install component ``<comp>``.
``--default-directory-permissions <permissions>``
.. option:: --default-directory-permissions <permissions>
Default directory install permissions. Permissions in format ``<u=rwx,g=rx,o=rx>``.
``--prefix <prefix>``
.. option:: --prefix <prefix>
Override the installation prefix, :variable:`CMAKE_INSTALL_PREFIX`.
``--strip``
.. option:: --strip
Strip before installing.
``-v, --verbose``
.. option:: -v, --verbose
Enable verbose output.
This option can be omitted if :envvar:`VERBOSE` environment variable is set.
@@ -615,14 +660,22 @@ supported by some generators.
Run a Script
============
.. program:: cmake_P
.. code-block:: shell
cmake [{-D <var>=<value>}...] -P <cmake-script-file> [-- <unparsed-options>...]
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.
.. option:: -D <var>=<value>
Define a variable for script mode.
.. option:: -P <cmake-script-file>
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.
Any options after ``--`` are not parsed by CMake, but they are still included
in the set of :variable:`CMAKE_ARGV<n> <CMAKE_ARGV0>` variables passed to the
@@ -634,6 +687,8 @@ script (including the ``--`` itself).
Run a Command-Line Tool
=======================
.. program:: cmake_E
CMake provides builtin command-line tools through the signature
.. code-block:: shell
@@ -643,7 +698,8 @@ CMake provides builtin command-line tools through the signature
Run ``cmake -E`` or ``cmake -E help`` for a summary of commands.
Available commands are:
``capabilities``
.. option:: capabilities
.. versionadded:: 3.7
Report cmake capabilities in JSON format. The output is a JSON object
@@ -705,7 +761,8 @@ Available commands are:
``true`` if cmake supports server-mode and ``false`` otherwise.
Always false since CMake 3.20.
``cat [--] <files>...``
.. option:: cat [--] <files>...
.. versionadded:: 3.18
Concatenate files and print on the standard output.
@@ -716,10 +773,12 @@ Available commands are:
``-`` will result in an error. Use ``--`` to indicate the end of options, in
case a file starts with ``-``.
``chdir <dir> <cmd> [<arg>...]``
.. option:: chdir <dir> <cmd> [<arg>...]
Change the current working directory and run a command.
``compare_files [--ignore-eol] <file1> <file2>``
.. option:: compare_files [--ignore-eol] <file1> <file2>
Check if ``<file1>`` is same as ``<file2>``. If files are the same,
then returns ``0``, if not it returns ``1``. In case of invalid
arguments, it returns 2.
@@ -728,7 +787,8 @@ Available commands are:
The ``--ignore-eol`` option implies line-wise comparison and ignores
LF/CRLF differences.
``copy <file>... <destination>``
.. option:: copy <file>... <destination>
Copy files to ``<destination>`` (either file or directory).
If multiple files are specified, the ``<destination>`` must be
directory and it must exist. Wildcards are not supported.
@@ -738,7 +798,8 @@ Available commands are:
.. versionadded:: 3.5
Support for multiple input files.
``copy_directory <dir>... <destination>``
.. option:: copy_directory <dir>... <destination>
Copy content of ``<dir>...`` directories to ``<destination>`` directory.
If ``<destination>`` directory does not exist it will be created.
``copy_directory`` does follow symlinks.
@@ -750,7 +811,8 @@ Available commands are:
The command now fails when the source directory does not exist.
Previously it succeeded by creating an empty destination directory.
``copy_if_different <file>... <destination>``
.. option:: copy_if_different <file>... <destination>
Copy files to ``<destination>`` (either file or directory) if
they have changed.
If multiple files are specified, the ``<destination>`` must be
@@ -760,7 +822,8 @@ Available commands are:
.. versionadded:: 3.5
Support for multiple input files.
``create_symlink <old> <new>``
.. option:: create_symlink <old> <new>
Create a symbolic link ``<new>`` naming ``<old>``.
.. versionadded:: 3.13
@@ -769,7 +832,8 @@ Available commands are:
.. note::
Path to where ``<new>`` symbolic link will be created has to exist beforehand.
``create_hardlink <old> <new>``
.. option:: create_hardlink <old> <new>
.. versionadded:: 3.19
Create a hard link ``<new>`` naming ``<old>``.
@@ -778,13 +842,16 @@ Available commands are:
Path to where ``<new>`` hard link will be created has to exist beforehand.
``<old>`` has to exist beforehand.
``echo [<string>...]``
.. option:: echo [<string>...]
Displays arguments as text.
``echo_append [<string>...]``
.. option:: echo_append [<string>...]
Displays arguments as text but no new line.
``env [--unset=NAME ...] [NAME=VALUE ...] [--] <command> [<arg>...]``
.. option:: env [--unset=NAME ...] [NAME=VALUE ...] [--] <command> [<arg>...]
.. versionadded:: 3.1
Run command in a modified environment.
@@ -794,15 +861,18 @@ Available commands are:
interpreting options/environment variables and treat the next argument as
the command, even if it start with ``-`` or contains a ``=``.
``environment``
.. option:: environment
Display the current environment variables.
``false``
.. option:: false
.. versionadded:: 3.16
Do nothing, with an exit code of 1.
``make_directory <dir>...``
.. option:: make_directory <dir>...
Create ``<dir>`` directories. If necessary, create parent
directories too. If a directory already exists it will be
silently ignored.
@@ -810,13 +880,15 @@ Available commands are:
.. versionadded:: 3.5
Support for multiple input directories.
``md5sum <file>...``
.. option:: md5sum <file>...
Create MD5 checksum of files in ``md5sum`` compatible format::
351abe79cd3800b38cdfb25d45015a15 file1.txt
052f86c15bbde68af55c7f7b340ab639 file2.txt
``sha1sum <file>...``
.. option:: sha1sum <file>...
.. versionadded:: 3.10
Create SHA1 checksum of files in ``sha1sum`` compatible format::
@@ -824,7 +896,8 @@ Available commands are:
4bb7932a29e6f73c97bb9272f2bdc393122f86e0 file1.txt
1df4c8f318665f9a5f2ed38f55adadb7ef9f559c file2.txt
``sha224sum <file>...``
.. option:: sha224sum <file>...
.. versionadded:: 3.10
Create SHA224 checksum of files in ``sha224sum`` compatible format::
@@ -832,7 +905,8 @@ Available commands are:
b9b9346bc8437bbda630b0b7ddfc5ea9ca157546dbbf4c613192f930 file1.txt
6dfbe55f4d2edc5fe5c9197bca51ceaaf824e48eba0cc453088aee24 file2.txt
``sha256sum <file>...``
.. option:: sha256sum <file>...
.. versionadded:: 3.10
Create SHA256 checksum of files in ``sha256sum`` compatible format::
@@ -840,7 +914,8 @@ Available commands are:
76713b23615d31680afeb0e9efe94d47d3d4229191198bb46d7485f9cb191acc file1.txt
15b682ead6c12dedb1baf91231e1e89cfc7974b3787c1e2e01b986bffadae0ea file2.txt
``sha384sum <file>...``
.. option:: sha384sum <file>...
.. versionadded:: 3.10
Create SHA384 checksum of files in ``sha384sum`` compatible format::
@@ -848,7 +923,8 @@ Available commands are:
acc049fedc091a22f5f2ce39a43b9057fd93c910e9afd76a6411a28a8f2b8a12c73d7129e292f94fc0329c309df49434 file1.txt
668ddeb108710d271ee21c0f3acbd6a7517e2b78f9181c6a2ff3b8943af92b0195dcb7cce48aa3e17893173c0a39e23d file2.txt
``sha512sum <file>...``
.. option:: sha512sum <file>...
.. versionadded:: 3.10
Create SHA512 checksum of files in ``sha512sum`` compatible format::
@@ -856,7 +932,8 @@ Available commands are:
2a78d7a6c5328cfb1467c63beac8ff21794213901eaadafd48e7800289afbc08e5fb3e86aa31116c945ee3d7bf2a6194489ec6101051083d1108defc8e1dba89 file1.txt
7a0b54896fe5e70cca6dd643ad6f672614b189bf26f8153061c4d219474b05dad08c4e729af9f4b009f1a1a280cb625454bf587c690f4617c27e3aebdf3b7a2d file2.txt
``remove [-f] <file>...``
.. option:: remove [-f] <file>...
.. deprecated:: 3.17
Remove the file(s). The planned behavior was that if any of the
@@ -869,7 +946,8 @@ Available commands are:
The implementation was buggy and always returned 0. It cannot be fixed without
breaking backwards compatibility. Use ``rm`` instead.
``remove_directory <dir>...``
.. option:: remove_directory <dir>...
.. deprecated:: 3.17
Remove ``<dir>`` directories and their contents. If a directory does
@@ -882,11 +960,13 @@ Available commands are:
.. versionadded:: 3.16
If ``<dir>`` is a symlink to a directory, just the symlink will be removed.
``rename <oldname> <newname>``
.. option:: rename <oldname> <newname>
Rename a file or directory (on one volume). If file with the ``<newname>`` name
already exists, then it will be silently replaced.
``rm [-rRf] [--] <file|dir>...``
.. option:: rm [-rRf] [--] <file|dir>...
.. versionadded:: 3.17
Remove the files ``<file>`` or directories ``<dir>``.
@@ -897,15 +977,18 @@ Available commands are:
situations instead. Use ``--`` to stop interpreting options and treat all
remaining arguments as paths, even if they start with ``-``.
``server``
.. option:: server
Launch :manual:`cmake-server(7)` mode.
``sleep <number>...``
.. option:: sleep <number>...
.. versionadded:: 3.0
Sleep for given number of seconds.
``tar [cxt][vf][zjJ] file.tar [<options>] [--] [<pathname>...]``
.. option:: tar [cxt][vf][zjJ] file.tar [<options>] [--] [<pathname>...]
Create or extract a tar or zip archive. Options are:
``c``
@@ -988,7 +1071,8 @@ Available commands are:
``tar`` tool. The command now also parses all flags, and if an invalid flag
was provided, a warning is issued.
``time <command> [<args>...]``
.. option:: time <command> [<args>...]
Run command and display elapsed time.
.. versionadded:: 3.5
@@ -996,15 +1080,18 @@ Available commands are:
through to the child process. This may break scripts that worked around the
bug with their own extra quoting or escaping.
``touch <file>...``
.. option:: touch <file>...
Creates ``<file>`` if file do not exist.
If ``<file>`` exists, it is changing ``<file>`` access and modification times.
``touch_nocreate <file>...``
.. option:: touch_nocreate <file>...
Touch a file if it exists but do not create it. If a file does
not exist it will be silently ignored.
``true``
.. option:: true
.. versionadded:: 3.16
Do nothing, with an exit code of 0.
@@ -1014,22 +1101,26 @@ Windows-specific Command-Line Tools
The following ``cmake -E`` commands are available only on Windows:
``delete_regv <key>``
.. option:: delete_regv <key>
Delete Windows registry value.
``env_vs8_wince <sdkname>``
.. option:: env_vs8_wince <sdkname>
.. versionadded:: 3.2
Displays a batch file which sets the environment for the provided
Windows CE SDK installed in VS2005.
``env_vs9_wince <sdkname>``
.. option:: env_vs9_wince <sdkname>
.. versionadded:: 3.2
Displays a batch file which sets the environment for the provided
Windows CE SDK installed in VS2008.
``write_regv <key> <value>``
.. option:: write_regv <key> <value>
Write Windows registry value.
@@ -1063,6 +1154,8 @@ To print selected pages from the CMake documentation, use
with one of the following options:
.. program:: cmake
.. include:: OPTIONS_HELP.txt
To view the presets available for a project, use
Help/manual/cpack.1.rst
+26 -12
View File
@@ -40,7 +40,10 @@ module is included by the project's ``CMakeLists.txt`` file.
Options
=======
``-G <generators>``
.. program:: cpack
.. option:: -G <generators>
``<generators>`` is a :ref:`semicolon-separated list <CMake Language Lists>`
of generator names. ``cpack`` will iterate through this list and produce
package(s) in that generator's format according to the details provided in
@@ -48,7 +51,8 @@ Options
the :variable:`CPACK_GENERATOR` variable determines the default set of
generators that will be used.
``-C <configs>``
.. option:: -C <configs>
Specify the project configuration(s) to be packaged (e.g. ``Debug``,
``Release``, etc.), where ``<configs>`` is a
:ref:`semicolon-separated list <CMake Language Lists>`.
@@ -58,36 +62,44 @@ Options
The user is responsible for ensuring that the configuration(s) listed
have already been built before invoking ``cpack``.
``-D <var>=<value>``
.. option:: -D <var>=<value>
Set a CPack variable. This will override any value set for ``<var>`` in the
input file read by ``cpack``.
``--config <configFile>``
.. option:: --config <configFile>
Specify the configuration file read by ``cpack`` to provide the packaging
details. By default, ``CPackConfig.cmake`` in the current directory will
be used.
``--verbose, -V``
.. option:: --verbose, -V
Run ``cpack`` with verbose output. This can be used to show more details
from the package generation tools and is suitable for project developers.
``--debug``
.. option:: --debug
Run ``cpack`` with debug output. This option is intended mainly for the
developers of ``cpack`` itself and is not normally needed by project
developers.
``--trace``
.. option:: --trace
Put the underlying cmake scripts in trace mode.
``--trace-expand``
.. option:: --trace-expand
Put the underlying cmake scripts in expanded trace mode.
``-P <packageName>``
.. option:: -P <packageName>
Override/define the value of the :variable:`CPACK_PACKAGE_NAME` variable used
for packaging. Any value set for this variable in the ``CPackConfig.cmake``
file will then be ignored.
``-R <packageVersion>``
.. option:: -R <packageVersion>
Override/define the value of the :variable:`CPACK_PACKAGE_VERSION`
variable used for packaging. It will override a value set in the
``CPackConfig.cmake`` file or one automatically computed from
@@ -95,14 +107,16 @@ Options
:variable:`CPACK_PACKAGE_VERSION_MINOR` and
:variable:`CPACK_PACKAGE_VERSION_PATCH`.
``-B <packageDirectory>``
.. option:: -B <packageDirectory>
Override/define :variable:`CPACK_PACKAGE_DIRECTORY`, which controls the
directory where CPack will perform its packaging work. The resultant
package(s) will be created at this location by default and a
``_CPack_Packages`` subdirectory will also be created below this directory to
use as a working area during package creation.
``--vendor <vendorName>``
.. option:: --vendor <vendorName>
Override/define :variable:`CPACK_PACKAGE_VENDOR`.
.. include:: OPTIONS_HELP.txt
Help/manual/ctest.1.rst
+149 -75
View File
@@ -30,17 +30,23 @@ This program will run the tests and report results.
Options
=======
``--preset <preset>``, ``--preset=<preset>``
.. program:: ctest
.. option:: --preset <preset>, --preset=<preset>
Use a test preset to specify test options. The project binary directory
is inferred from the ``configurePreset`` key. The current working directory
must contain CMake preset files.
See :manual:`preset <cmake-presets(7)>` for more details.
``--list-presets``
.. option:: --list-presets
Lists the available test presets. The current working directory must contain
CMake preset files.
``-C <cfg>, --build-config <cfg>``
.. option:: -C <cfg>, --build-config <cfg>
Choose configuration to test.
Some CMake-generated build trees can have multiple build
@@ -48,7 +54,8 @@ Options
which one should be tested. Example configurations are ``Debug`` and
``Release``.
``--progress``
.. option:: --progress
Enable short progress output from tests.
When the output of **ctest** is being sent directly to a terminal, the
@@ -61,40 +68,46 @@ Options
This option can also be enabled by setting the environment variable
:envvar:`CTEST_PROGRESS_OUTPUT`.
``-V,--verbose``
.. option:: -V, --verbose
Enable verbose output from tests.
Test output is normally suppressed and only summary information is
displayed. This option will show all test output.
``-VV,--extra-verbose``
.. option:: -VV, --extra-verbose
Enable more verbose output from tests.
Test output is normally suppressed and only summary information is
displayed. This option will show even more test output.
``--debug``
.. option:: --debug
Displaying more verbose internals of CTest.
This feature will result in a large number of output that is mostly
useful for debugging dashboard problems.
``--output-on-failure``
.. option:: --output-on-failure
Output anything outputted by the test program if the test should fail.
This option can also be enabled by setting the
:envvar:`CTEST_OUTPUT_ON_FAILURE` environment variable
``--stop-on-failure``
.. option:: --stop-on-failure
Stop running the tests when the first failure happens.
``-F``
.. option:: -F
Enable failover.
This option allows CTest to resume a test set execution that was
previously interrupted. If no interruption occurred, the ``-F`` option
will have no effect.
``-j <jobs>, --parallel <jobs>``
.. option:: -j <jobs>, --parallel <jobs>
Run the tests in parallel using the given number of jobs.
This option tells CTest to run the tests in parallel using given
@@ -105,7 +118,8 @@ Options
See `Label and Subproject Summary`_.
``--resource-spec-file <file>``
.. option:: --resource-spec-file <file>
Run CTest with :ref:`resource allocation <ctest-resource-allocation>` enabled,
using the
:ref:`resource specification file <ctest-resource-specification-file>`
@@ -114,14 +128,15 @@ Options
When ``ctest`` is run as a `Dashboard Client`_ this sets the
``ResourceSpecFile`` option of the `CTest Test Step`_.
``--test-load <level>``
.. option:: --test-load <level>
While running tests in parallel (e.g. with ``-j``), try not to start
tests when they may cause the CPU load to pass above a given threshold.
When ``ctest`` is run as a `Dashboard Client`_ this sets the
``TestLoad`` option of the `CTest Test Step`_.
``-Q,--quiet``
.. option:: -Q, --quiet
Make CTest quiet.
This option will suppress all the output. The output log file will
@@ -129,12 +144,14 @@ Options
as ``--verbose``, ``--extra-verbose``, and ``--debug`` are ignored
if ``--quiet`` is specified.
``-O <file>, --output-log <file>``
.. option:: -O <file>, --output-log <file>
Output to log file.
This option tells CTest to write all its output to a ``<file>`` log file.
``--output-junit <file>``
.. option:: --output-junit <file>
Write test results in JUnit format.
This option tells CTest to write test results to ``<file>`` in JUnit XML
@@ -142,7 +159,8 @@ Options
``-S`` option to run a dashboard script, use the ``OUTPUT_JUNIT`` keyword
with the :command:`ctest_test` command instead.
``-N,--show-only[=<format>]``
.. option:: -N, --show-only[=<format>]
Disable actual execution of tests.
This option tells CTest to list the tests that would be run but not
@@ -159,7 +177,8 @@ Options
Dump the test information in JSON format.
See `Show as JSON Object Model`_.
``-L <regex>, --label-regex <regex>``
.. option:: -L <regex>, --label-regex <regex>
Run tests with labels matching regular expression as described under
:ref:`string(REGEX) <Regex Specification>`.
@@ -169,19 +188,22 @@ Options
of the test's labels (i.e. the multiple ``-L`` labels form an ``AND``
relationship). See `Label Matching`_.
``-R <regex>, --tests-regex <regex>``
.. option:: -R <regex>, --tests-regex <regex>
Run tests matching regular expression.
This option tells CTest to run only the tests whose names match the
given regular expression.
``-E <regex>, --exclude-regex <regex>``
.. option:: -E <regex>, --exclude-regex <regex>
Exclude tests matching regular expression.
This option tells CTest to NOT run the tests whose names match the
given regular expression.
``-LE <regex>, --label-exclude <regex>``
.. option:: -LE <regex>, --label-exclude <regex>
Exclude tests with labels matching regular expression.
This option tells CTest to NOT run the tests whose labels match the
@@ -190,7 +212,8 @@ Options
of the test's labels (i.e. the multiple ``-LE`` labels form an ``AND``
relationship). See `Label Matching`_.
``-FA <regex>, --fixture-exclude-any <regex>``
.. option:: -FA <regex>, --fixture-exclude-any <regex>
Exclude fixtures matching ``<regex>`` from automatically adding any tests to
the test set.
@@ -201,13 +224,16 @@ Options
including test dependencies and skipping tests that have fixture setup tests
that fail.
``-FS <regex>, --fixture-exclude-setup <regex>``
.. option:: -FS <regex>, --fixture-exclude-setup <regex>
Same as ``-FA`` except only matching setup tests are excluded.
``-FC <regex>, --fixture-exclude-cleanup <regex>``
.. option:: -FC <regex>, --fixture-exclude-cleanup <regex>
Same as ``-FA`` except only matching cleanup tests are excluded.
``-D <dashboard>, --dashboard <dashboard>``
.. option:: -D <dashboard>, --dashboard <dashboard>
Execute dashboard test.
This option tells CTest to act as a CDash client and perform a
@@ -218,7 +244,8 @@ Options
See `Dashboard Client`_.
``-D <var>:<type>=<value>``
.. option:: -D <var>:<type>=<value>
Define a variable for script mode.
Pass in variable values on the command line. Use in conjunction
@@ -226,7 +253,8 @@ Options
arguments as variable values is only attempted if the value
following ``-D`` does not match any of the known dashboard types.
``-M <model>, --test-model <model>``
.. option:: -M <model>, --test-model <model>
Sets the model for a dashboard.
This option tells CTest to act as a CDash client where the ``<model>``
@@ -235,7 +263,8 @@ Options
See `Dashboard Client`_.
``-T <action>, --test-action <action>``
.. option:: -T <action>, --test-action <action>
Sets the dashboard action to perform.
This option tells CTest to act as a CDash client and perform some
@@ -245,18 +274,20 @@ Options
See `Dashboard Client`_.
``-S <script>, --script <script>``
.. option:: -S <script>, --script <script>
Execute a dashboard for a configuration.
This option tells CTest to load in a configuration script which sets
a number of parameters such as the binary and source directories.
Then CTest will do what is required to create and run a dashboard.
This option basically sets up a dashboard and then runs ``ctest -D``
This option basically sets up a dashboard and then runs :option:`ctest -D`
with the appropriate options.
See `Dashboard Client`_.
``-SP <script>, --script-new-process <script>``
.. option:: -SP <script>, --script-new-process <script>
Execute a dashboard for a configuration.
This option does the same operations as ``-S`` but it will do them in a
@@ -266,7 +297,8 @@ Options
See `Dashboard Client`_.
``-I [Start,End,Stride,test#,test#|Test file], --tests-information``
.. option:: -I [Start,End,Stride,test#,test#|Test file], --tests-information
Run a specific number of tests by number.
This option causes CTest to run tests starting at number ``Start``,
@@ -275,13 +307,15 @@ Options
``End``, or ``Stride`` can be empty. Optionally a file can be given that
contains the same syntax as the command line.
``-U, --union``
.. option:: -U, --union
Take the Union of ``-I`` and ``-R``.
When both ``-R`` and ``-I`` are specified by default the intersection of
tests are run. By specifying ``-U`` the union of tests is run instead.
``--rerun-failed``
.. option:: --rerun-failed
Run only the tests that failed previously.
This option tells CTest to perform only the tests that failed during
@@ -291,7 +325,8 @@ Options
fail, subsequent calls to CTest with the ``--rerun-failed`` option will run
the set of tests that most recently failed (if any).
``--repeat <mode>:<n>``
.. option:: --repeat <mode>:<n>
Run tests repeatedly based on the given ``<mode>`` up to ``<n>`` times.
The modes are:
@@ -310,17 +345,20 @@ Options
This is useful in tolerating sporadic timeouts in test cases
on busy machines.
``--repeat-until-fail <n>``
.. option:: --repeat-until-fail <n>
Equivalent to ``--repeat until-fail:<n>``.
``--max-width <width>``
.. option:: --max-width <width>
Set the max width for a test name to output.
Set the maximum width for each test name to show in the output.
This allows the user to widen the output to avoid clipping the test
name which can be very annoying.
``--interactive-debug-mode [0|1]``
.. option:: --interactive-debug-mode [0|1]
Set the interactive mode to ``0`` or ``1``.
This option causes CTest to run tests in either an interactive mode
@@ -332,7 +370,8 @@ Options
popup windows to appear. Now, due to CTest's use of ``libuv`` to launch
test processes, all system debug popup windows are always blocked.
``--no-label-summary``
.. option:: --no-label-summary
Disable timing summary information for labels.
This option tells CTest not to print summary information for each
@@ -341,7 +380,8 @@ Options
See `Label and Subproject Summary`_.
``--no-subproject-summary``
.. option:: --no-subproject-summary
Disable timing summary information for subprojects.
This option tells CTest not to print summary information for each
@@ -350,72 +390,85 @@ Options
See `Label and Subproject Summary`_.
``--build-and-test``
See `Build and Test Mode`_.
.. option:: --build-and-test
See `Build and Test Mode`_.
.. option:: --test-dir <dir>
``--test-dir <dir>``
Specify the directory in which to look for tests.
``--test-output-size-passed <size>``
.. option:: --test-output-size-passed <size>
.. versionadded:: 3.4
Limit the output for passed tests to ``<size>`` bytes.
``--test-output-size-failed <size>``
.. option:: --test-output-size-failed <size>
.. versionadded:: 3.4
Limit the output for failed tests to ``<size>`` bytes.
``--test-output-truncation <mode>``
.. option:: --test-output-truncation <mode>
.. versionadded:: 3.24
Truncate ``tail`` (default), ``middle`` or ``head`` of test output once
maximum output size is reached.
``--overwrite``
.. option:: --overwrite
Overwrite CTest configuration option.
By default CTest uses configuration options from configuration file.
This option will overwrite the configuration option.
``--force-new-ctest-process``
.. option:: --force-new-ctest-process
Run child CTest instances as new processes.
By default CTest will run child CTest instances within the same
process. If this behavior is not desired, this argument will
enforce new processes for child CTest processes.
``--schedule-random``
.. option:: --schedule-random
Use a random order for scheduling tests.
This option will run the tests in a random order. It is commonly
used to detect implicit dependencies in a test suite.
``--submit-index``
.. option:: --submit-index
Legacy option for old Dart2 dashboard server feature.
Do not use.
``--timeout <seconds>``
.. option:: --timeout <seconds>
Set the default test timeout.
This option effectively sets a timeout on all tests that do not
already have a timeout set on them via the :prop_test:`TIMEOUT`
property.
``--stop-time <time>``
.. option:: --stop-time <time>
Set a time at which all tests should stop running.
Set a real time of day at which all tests should timeout. Example:
``7:00:00 -0400``. Any time format understood by the curl date parser
is accepted. Local time is assumed if no timezone is specified.
``--print-labels``
.. option:: --print-labels
Print all available test labels.
This option will not run any tests, it will simply print the list of
all labels associated with the test set.
``--no-tests=<[error|ignore]>``
.. option:: --no-tests=<[error|ignore]>
Regard no tests found either as error or ignore it.
If no tests were found, the default behavior of CTest is to always log an
@@ -532,62 +585,77 @@ be provided to use ``--build-and-test``. If ``--test-command`` is specified
then that will be run after the build is complete. Other options that affect
this mode include:
``--build-target``
.. option:: --build-target
Specify a specific target to build.
If left out the ``all`` target is built.
``--build-nocmake``
.. option:: --build-nocmake
Run the build without running cmake first.
Skip the cmake step.
``--build-run-dir``
.. option:: --build-run-dir
Specify directory to run programs from.
Directory where programs will be after it has been compiled.
``--build-two-config``
.. option:: --build-two-config
Run CMake twice.
``--build-exe-dir``
.. option:: --build-exe-dir
Specify the directory for the executable.
``--build-generator``
.. option:: --build-generator
Specify the generator to use. See the :manual:`cmake-generators(7)` manual.
``--build-generator-platform``
.. option:: --build-generator-platform
Specify the generator-specific platform.
``--build-generator-toolset``
.. option:: --build-generator-toolset
Specify the generator-specific toolset.
``--build-project``
.. option:: --build-project
Specify the name of the project to build.
``--build-makeprogram``
.. option:: --build-makeprogram
Specify the explicit make program to be used by CMake when configuring and
building the project. Only applicable for Make and Ninja based generators.
``--build-noclean``
.. option:: --build-noclean
Skip the make clean step.
``--build-config-sample``
.. option:: --build-config-sample
A sample executable to use to determine the configuration that
should be used. e.g. ``Debug``, ``Release`` etc.
``--build-options``
.. option:: --build-options
Additional options for configuring the build (i.e. for CMake, not for
the build tool). Note that if this is specified, the ``--build-options``
keyword and its arguments must be the last option given on the command
line, with the possible exception of ``--test-command``.
``--test-command``
.. option:: --test-command
The command to run as the test step with the ``--build-and-test`` option.
All arguments following this keyword will be assumed to be part of the
test command line, so it must be the last option given.
``--test-timeout``
.. option:: --test-timeout
The time limit in seconds
.. _`Dashboard Client`:
@@ -605,7 +673,8 @@ a `CDash`_ server. The command-line signature used to submit to `CDash`_ is::
Options for Dashboard Client include:
``--group <group>``
.. option:: --group <group>
Specify what group you'd like to submit results to
Submit dashboard to specified group instead of default one. By
@@ -616,29 +685,34 @@ Options for Dashboard Client include:
This replaces the deprecated option ``--track``.
Despite the name change its behavior is unchanged.
``-A <file>, --add-notes <file>``
.. option:: -A <file>, --add-notes <file>
Add a notes file with submission.
This option tells CTest to include a notes file when submitting
dashboard.
``--tomorrow-tag``
.. option:: --tomorrow-tag
``Nightly`` or ``Experimental`` starts with next day tag.
This is useful if the build will not finish in one day.
``--extra-submit <file>[;<file>]``
.. option:: --extra-submit <file>[;<file>]
Submit extra files to the dashboard.
This option will submit extra files to the dashboard.
``--http1.0``
.. option:: --http1.0
Submit using `HTTP 1.0`.
This option will force CTest to use `HTTP 1.0` to submit files to the
dashboard, instead of `HTTP 1.1`.
``--no-compress-output``
.. option:: --no-compress-output
Do not compress test output when submitting.
This flag will turn off automatic compression of test output. Use