1272 lines
38 KiB
Groff
1272 lines
38 KiB
Groff
.\" Man page generated from reStructuredText.
|
||
.
|
||
.TH "CMAKE" "1" "Aug 20, 2020" "3.18.2" "CMake"
|
||
.SH NAME
|
||
cmake \- CMake Command-Line Reference
|
||
.
|
||
.nr rst2man-indent-level 0
|
||
.
|
||
.de1 rstReportMargin
|
||
\\$1 \\n[an-margin]
|
||
level \\n[rst2man-indent-level]
|
||
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||
-
|
||
\\n[rst2man-indent0]
|
||
\\n[rst2man-indent1]
|
||
\\n[rst2man-indent2]
|
||
..
|
||
.de1 INDENT
|
||
.\" .rstReportMargin pre:
|
||
. RS \\$1
|
||
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
||
. nr rst2man-indent-level +1
|
||
.\" .rstReportMargin post:
|
||
..
|
||
.de UNINDENT
|
||
. RE
|
||
.\" indent \\n[an-margin]
|
||
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||
.nr rst2man-indent-level -1
|
||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||
..
|
||
.SH SYNOPSIS
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
\fI\%Generate a Project Buildsystem\fP
|
||
cmake [<options>] <path\-to\-source>
|
||
cmake [<options>] <path\-to\-existing\-build>
|
||
cmake [<options>] \-S <path\-to\-source> \-B <path\-to\-build>
|
||
|
||
\fI\%Build a Project\fP
|
||
cmake \-\-build <dir> [<options>] [\-\- <build\-tool\-options>]
|
||
|
||
\fI\%Install a Project\fP
|
||
cmake \-\-install <dir> [<options>]
|
||
|
||
\fI\%Open a Project\fP
|
||
cmake \-\-open <dir>
|
||
|
||
\fI\%Run a Script\fP
|
||
cmake [{\-D <var>=<value>}...] \-P <cmake\-script\-file>
|
||
|
||
\fI\%Run a Command\-Line Tool\fP
|
||
cmake \-E <command> [<options>]
|
||
|
||
\fI\%Run the Find\-Package Tool\fP
|
||
cmake \-\-find\-package [<options>]
|
||
|
||
\fI\%View Help\fP
|
||
cmake \-\-help[\-<topic>]
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.SH DESCRIPTION
|
||
.sp
|
||
The \fBcmake\fP executable is the command\-line interface of the cross\-platform
|
||
buildsystem generator CMake. The above \fI\%Synopsis\fP lists various actions
|
||
the tool can perform as described in sections below.
|
||
.sp
|
||
To build a software project with CMake, \fI\%Generate a Project Buildsystem\fP\&.
|
||
Optionally use \fBcmake\fP to \fI\%Build a Project\fP, \fI\%Install a Project\fP or just
|
||
run the corresponding build tool (e.g. \fBmake\fP) directly. \fBcmake\fP can also
|
||
be used to \fI\%View Help\fP\&.
|
||
.sp
|
||
The other actions are meant for use by software developers writing
|
||
scripts in the \fBCMake language\fP to support
|
||
their builds.
|
||
.sp
|
||
For graphical user interfaces that may be used in place of \fBcmake\fP,
|
||
see \fBccmake\fP and \fBcmake\-gui\fP\&.
|
||
For command\-line interfaces to the CMake testing and packaging facilities,
|
||
see \fBctest\fP and \fBcpack\fP\&.
|
||
.sp
|
||
For more information on CMake at large, \fI\%see also\fP the links at the end
|
||
of this manual.
|
||
.SH INTRODUCTION TO CMAKE BUILDSYSTEMS
|
||
.sp
|
||
A \fIbuildsystem\fP describes how to build a project’s executables and libraries
|
||
from its source code using a \fIbuild tool\fP to automate the process. For
|
||
example, a buildsystem may be a \fBMakefile\fP for use with a command\-line
|
||
\fBmake\fP tool or a project file for an Integrated Development Environment
|
||
(IDE). In order to avoid maintaining multiple such buildsystems, a project
|
||
may specify its buildsystem abstractly using files written in the
|
||
\fBCMake language\fP\&. From these files CMake
|
||
generates a preferred buildsystem locally for each user through a backend
|
||
called a \fIgenerator\fP\&.
|
||
.sp
|
||
To generate a buildsystem with CMake, the following must be selected:
|
||
.INDENT 0.0
|
||
.TP
|
||
.B Source Tree
|
||
The top\-level directory containing source files provided by the project.
|
||
The project specifies its buildsystem using files as described in the
|
||
\fBcmake\-language(7)\fP manual, starting with a top\-level file named
|
||
\fBCMakeLists.txt\fP\&. These files specify build targets and their
|
||
dependencies as described in the \fBcmake\-buildsystem(7)\fP manual.
|
||
.TP
|
||
.B Build Tree
|
||
The top\-level directory in which buildsystem files and build output
|
||
artifacts (e.g. executables and libraries) are to be stored.
|
||
CMake will write a \fBCMakeCache.txt\fP file to identify the directory
|
||
as a build tree and store persistent information such as buildsystem
|
||
configuration options.
|
||
.sp
|
||
To maintain a pristine source tree, perform an \fIout\-of\-source\fP build
|
||
by using a separate dedicated build tree. An \fIin\-source\fP build in
|
||
which the build tree is placed in the same directory as the source
|
||
tree is also supported, but discouraged.
|
||
.TP
|
||
.B Generator
|
||
This chooses the kind of buildsystem to generate. See the
|
||
\fBcmake\-generators(7)\fP manual for documentation of all generators.
|
||
Run \fBcmake \-\-help\fP to see a list of generators available locally.
|
||
Optionally use the \fB\-G\fP option below to specify a generator, or simply
|
||
accept the default CMake chooses for the current platform.
|
||
.sp
|
||
When using one of the Command\-Line Build Tool Generators
|
||
CMake expects that the environment needed by the compiler toolchain
|
||
is already configured in the shell. When using one of the
|
||
IDE Build Tool Generators, no particular environment is needed.
|
||
.UNINDENT
|
||
.SH GENERATE A PROJECT BUILDSYSTEM
|
||
.sp
|
||
Run CMake with one of the following command signatures to specify the
|
||
source and build trees and generate a buildsystem:
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \fBcmake [<options>] <path\-to\-source>\fP
|
||
Uses the current working directory as the build tree, and
|
||
\fB<path\-to\-source>\fP as the source tree. The specified path may
|
||
be absolute or relative to the current working directory.
|
||
The source tree must contain a \fBCMakeLists.txt\fP file and must
|
||
\fInot\fP contain a \fBCMakeCache.txt\fP file because the latter
|
||
identifies an existing build tree. For example:
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
$ mkdir build ; cd build
|
||
$ cmake ../src
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBcmake [<options>] <path\-to\-existing\-build>\fP
|
||
Uses \fB<path\-to\-existing\-build>\fP as the build tree, and loads the
|
||
path to the source tree from its \fBCMakeCache.txt\fP file, which must
|
||
have already been generated by a previous run of CMake. The specified
|
||
path may be absolute or relative to the current working directory.
|
||
For example:
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
$ cd build
|
||
$ cmake .
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBcmake [<options>] \-S <path\-to\-source> \-B <path\-to\-build>\fP
|
||
Uses \fB<path\-to\-build>\fP as the build tree and \fB<path\-to\-source>\fP
|
||
as the source tree. The specified paths may be absolute or relative
|
||
to the current working directory. The source tree must contain a
|
||
\fBCMakeLists.txt\fP file. The build tree will be created automatically
|
||
if it does not already exist. For example:
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
$ cmake \-S src \-B build
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
In all cases the \fB<options>\fP may be zero or more of the \fI\%Options\fP below.
|
||
.sp
|
||
After generating a buildsystem one may use the corresponding native
|
||
build tool to build the project. For example, after using the
|
||
\fBUnix Makefiles\fP generator one may run \fBmake\fP directly:
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
$ make
|
||
$ make install
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
Alternatively, one may use \fBcmake\fP to \fI\%Build a Project\fP by
|
||
automatically choosing and invoking the appropriate native build tool.
|
||
.SS Options
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \fB\-S <path\-to\-source>\fP
|
||
Path to root directory of the CMake project to build.
|
||
.TP
|
||
.B \fB\-B <path\-to\-build>\fP
|
||
Path to directory which CMake will use as the root of build directory.
|
||
.sp
|
||
If the directory doesn’t already exist CMake will make it.
|
||
.TP
|
||
.B \fB\-C <initial\-cache>\fP
|
||
Pre\-load a script to populate the cache.
|
||
.sp
|
||
When CMake is first run in an empty build tree, it creates a
|
||
\fBCMakeCache.txt\fP 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 \fBset()\fP commands that use the \fBCACHE\fP option, not a
|
||
cache\-format file.
|
||
.sp
|
||
References to \fBCMAKE_SOURCE_DIR\fP and \fBCMAKE_BINARY_DIR\fP
|
||
within the script evaluate to the top\-level source and build tree.
|
||
.TP
|
||
.B \fB\-D <var>:<type>=<value>, \-D <var>=<value>\fP
|
||
Create or update a CMake \fBCACHE\fP entry.
|
||
.sp
|
||
When CMake is first run in an empty build tree, it creates a
|
||
\fBCMakeCache.txt\fP 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 \fBCACHE\fP entries as desired.
|
||
.sp
|
||
If the \fB:<type>\fP portion is given it must be one of the types
|
||
specified by the \fBset()\fP command documentation for its
|
||
\fBCACHE\fP signature.
|
||
If the \fB:<type>\fP portion is omitted the entry will be created
|
||
with no type if it does not exist with a type already. If a
|
||
command in the project sets the type to \fBPATH\fP or \fBFILEPATH\fP
|
||
then the \fB<value>\fP will be converted to an absolute path.
|
||
.sp
|
||
This option may also be given as a single argument:
|
||
\fB\-D<var>:<type>=<value>\fP or \fB\-D<var>=<value>\fP\&.
|
||
.TP
|
||
.B \fB\-U <globbing_expr>\fP
|
||
Remove matching entries from CMake \fBCACHE\fP\&.
|
||
.sp
|
||
This option may be used to remove one or more variables from the
|
||
\fBCMakeCache.txt\fP file, globbing expressions using \fB*\fP and \fB?\fP are
|
||
supported. The option may be repeated for as many \fBCACHE\fP entries as
|
||
desired.
|
||
.sp
|
||
Use with care, you can make your \fBCMakeCache.txt\fP non\-working.
|
||
.TP
|
||
.B \fB\-G <generator\-name>\fP
|
||
Specify a build system generator.
|
||
.sp
|
||
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
|
||
\fBcmake\-generators(7)\fP manual.
|
||
.sp
|
||
If not specified, CMake checks the \fBCMAKE_GENERATOR\fP environment
|
||
variable and otherwise falls back to a builtin default selection.
|
||
.TP
|
||
.B \fB\-T <toolset\-spec>\fP
|
||
Toolset specification for the generator, if supported.
|
||
.sp
|
||
Some CMake generators support a toolset specification to tell
|
||
the native build system how to choose a compiler. See the
|
||
\fBCMAKE_GENERATOR_TOOLSET\fP variable for details.
|
||
.TP
|
||
.B \fB\-A <platform\-name>\fP
|
||
Specify platform name if supported by generator.
|
||
.sp
|
||
Some CMake generators support a platform name to be given to the
|
||
native build system to choose a compiler or SDK. See the
|
||
\fBCMAKE_GENERATOR_PLATFORM\fP variable for details.
|
||
.TP
|
||
.B \fB\-Wno\-dev\fP
|
||
Suppress developer warnings.
|
||
.sp
|
||
Suppress warnings that are meant for the author of the
|
||
\fBCMakeLists.txt\fP files. By default this will also turn off
|
||
deprecation warnings.
|
||
.TP
|
||
.B \fB\-Wdev\fP
|
||
Enable developer warnings.
|
||
.sp
|
||
Enable warnings that are meant for the author of the \fBCMakeLists.txt\fP
|
||
files. By default this will also turn on deprecation warnings.
|
||
.TP
|
||
.B \fB\-Werror=dev\fP
|
||
Make developer warnings errors.
|
||
.sp
|
||
Make warnings that are meant for the author of the \fBCMakeLists.txt\fP files
|
||
errors. By default this will also turn on deprecated warnings as errors.
|
||
.TP
|
||
.B \fB\-Wno\-error=dev\fP
|
||
Make developer warnings not errors.
|
||
.sp
|
||
Make warnings that are meant for the author of the \fBCMakeLists.txt\fP files not
|
||
errors. By default this will also turn off deprecated warnings as errors.
|
||
.TP
|
||
.B \fB\-Wdeprecated\fP
|
||
Enable deprecated functionality warnings.
|
||
.sp
|
||
Enable warnings for usage of deprecated functionality, that are meant
|
||
for the author of the \fBCMakeLists.txt\fP files.
|
||
.TP
|
||
.B \fB\-Wno\-deprecated\fP
|
||
Suppress deprecated functionality warnings.
|
||
.sp
|
||
Suppress warnings for usage of deprecated functionality, that are meant
|
||
for the author of the \fBCMakeLists.txt\fP files.
|
||
.TP
|
||
.B \fB\-Werror=deprecated\fP
|
||
Make deprecated macro and function warnings errors.
|
||
.sp
|
||
Make warnings for usage of deprecated macros and functions, that are meant
|
||
for the author of the \fBCMakeLists.txt\fP files, errors.
|
||
.TP
|
||
.B \fB\-Wno\-error=deprecated\fP
|
||
Make deprecated macro and function warnings not errors.
|
||
.sp
|
||
Make warnings for usage of deprecated macros and functions, that are meant
|
||
for the author of the \fBCMakeLists.txt\fP files, not errors.
|
||
.TP
|
||
.B \fB\-L[A][H]\fP
|
||
List non\-advanced cached variables.
|
||
.sp
|
||
List \fBCACHE\fP variables will run CMake and list all the variables from
|
||
the CMake \fBCACHE\fP that are not marked as \fBINTERNAL\fP or \fBADVANCED\fP\&.
|
||
This will effectively display current CMake settings, which can then be
|
||
changed with \fB\-D\fP option. Changing some of the variables may result
|
||
in more variables being created. If \fBA\fP is specified, then it will
|
||
display also advanced variables. If \fBH\fP is specified, it will also
|
||
display help for each variable.
|
||
.TP
|
||
.B \fB\-N\fP
|
||
View mode only.
|
||
.sp
|
||
Only load the cache. Do not actually run configure and generate
|
||
steps.
|
||
.TP
|
||
.B \fB\-\-graphviz=[file]\fP
|
||
Generate graphviz of dependencies, see \fBCMakeGraphVizOptions\fP for more.
|
||
.sp
|
||
Generate a graphviz input file that will contain all the library and
|
||
executable dependencies in the project. See the documentation for
|
||
\fBCMakeGraphVizOptions\fP for more details.
|
||
.TP
|
||
.B \fB\-\-system\-information [file]\fP
|
||
Dump information about this system.
|
||
.sp
|
||
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.
|
||
.TP
|
||
.B \fB\-\-log\-level=<ERROR|WARNING|NOTICE|STATUS|VERBOSE|DEBUG|TRACE>\fP
|
||
Set the log level.
|
||
.sp
|
||
The \fBmessage()\fP command will only output messages of the specified
|
||
log level or higher. The default log level is \fBSTATUS\fP\&.
|
||
.sp
|
||
To make a log level persist between CMake runs, set
|
||
\fBCMAKE_MESSAGE_LOG_LEVEL\fP as a cache variable instead.
|
||
If both the command line option and the variable are given, the command line
|
||
option takes precedence.
|
||
.sp
|
||
For backward compatibility reasons, \fB\-\-loglevel\fP is also accepted as a
|
||
synonym for this option.
|
||
.TP
|
||
.B \fB\-\-log\-context\fP
|
||
Enable the \fBmessage()\fP command outputting context attached to each
|
||
message.
|
||
.sp
|
||
This option turns on showing context for the current CMake run only.
|
||
To make showing the context persistent for all subsequent CMake runs, set
|
||
\fBCMAKE_MESSAGE_CONTEXT_SHOW\fP as a cache variable instead.
|
||
When this command line option is given, \fBCMAKE_MESSAGE_CONTEXT_SHOW\fP
|
||
is ignored.
|
||
.TP
|
||
.B \fB\-\-debug\-trycompile\fP
|
||
Do not delete the \fBtry_compile()\fP build tree.
|
||
Only useful on one \fBtry_compile()\fP at a time.
|
||
.sp
|
||
Do not delete the files and directories created for \fBtry_compile()\fP
|
||
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.
|
||
.TP
|
||
.B \fB\-\-debug\-output\fP
|
||
Put cmake in a debug mode.
|
||
.sp
|
||
Print extra information during the cmake run like stack traces with
|
||
\fBmessage(SEND_ERROR)\fP calls.
|
||
.TP
|
||
.B \fB\-\-debug\-find\fP
|
||
Put cmake find commands in a debug mode.
|
||
.sp
|
||
Print extra find call information during the cmake run to standard
|
||
error. Output is designed for human consumption and not for parsing.
|
||
See also the \fBCMAKE_FIND_DEBUG_MODE\fP variable for debugging
|
||
a more local part of the project.
|
||
.TP
|
||
.B \fB\-\-trace\fP
|
||
Put cmake in trace mode.
|
||
.sp
|
||
Print a trace of all calls made and from where.
|
||
.TP
|
||
.B \fB\-\-trace\-expand\fP
|
||
Put cmake in trace mode.
|
||
.sp
|
||
Like \fB\-\-trace\fP, but with variables expanded.
|
||
.TP
|
||
.B \fB\-\-trace\-format=<format>\fP
|
||
Put cmake in trace mode and sets the trace output format.
|
||
.sp
|
||
\fB<format>\fP can be one of the following values.
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \fBhuman\fP
|
||
Prints each trace line in a human\-readable format. This is the
|
||
default format.
|
||
.TP
|
||
.B \fBjson\-v1\fP
|
||
Prints each line as a separate JSON document. Each document is
|
||
separated by a newline ( \fB\en\fP ). It is guaranteed that no
|
||
newline characters will be present inside a JSON document.
|
||
.sp
|
||
JSON trace format:
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
{
|
||
"file": "/full/path/to/the/CMake/file.txt",
|
||
"line": 0,
|
||
"cmd": "add_executable",
|
||
"args": ["foo", "bar"],
|
||
"time": 1579512535.9687231,
|
||
"frame": 2
|
||
}
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
The members are:
|
||
.INDENT 7.0
|
||
.TP
|
||
.B \fBfile\fP
|
||
The full path to the CMake source file where the function
|
||
was called.
|
||
.TP
|
||
.B \fBline\fP
|
||
The line in \fBfile\fP of the function call.
|
||
.TP
|
||
.B \fBcmd\fP
|
||
The name of the function that was called.
|
||
.TP
|
||
.B \fBargs\fP
|
||
A string list of all function parameters.
|
||
.TP
|
||
.B \fBtime\fP
|
||
Timestamp (seconds since epoch) of the function call.
|
||
.TP
|
||
.B \fBframe\fP
|
||
Stack frame depth of the function that was called.
|
||
.UNINDENT
|
||
.sp
|
||
Additionally, the first JSON document outputted contains the
|
||
\fBversion\fP key for the current major and minor version of the
|
||
.sp
|
||
JSON trace format:
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
{
|
||
"version": {
|
||
"major": 1,
|
||
"minor": 0
|
||
}
|
||
}
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
The members are:
|
||
.INDENT 7.0
|
||
.TP
|
||
.B \fBversion\fP
|
||
Indicates the version of the JSON format. The version has a
|
||
major and minor components following semantic version conventions.
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.TP
|
||
.B \fB\-\-trace\-source=<file>\fP
|
||
Put cmake in trace mode, but output only lines of a specified file.
|
||
.sp
|
||
Multiple options are allowed.
|
||
.TP
|
||
.B \fB\-\-trace\-redirect=<file>\fP
|
||
Put cmake in trace mode and redirect trace output to a file instead of stderr.
|
||
.TP
|
||
.B \fB\-\-warn\-uninitialized\fP
|
||
Warn about uninitialized values.
|
||
.sp
|
||
Print a warning when an uninitialized variable is used.
|
||
.TP
|
||
.B \fB\-\-warn\-unused\-vars\fP
|
||
Warn about unused variables.
|
||
.sp
|
||
Find variables that are declared or set, but not used.
|
||
.TP
|
||
.B \fB\-\-no\-warn\-unused\-cli\fP
|
||
Don’t warn about command line options.
|
||
.sp
|
||
Don’t find variables that are declared on the command line, but not
|
||
used.
|
||
.TP
|
||
.B \fB\-\-check\-system\-vars\fP
|
||
Find problems with variable usage in system files.
|
||
.sp
|
||
Normally, unused and uninitialized variables are searched for only
|
||
in \fBCMAKE_SOURCE_DIR\fP and \fBCMAKE_BINARY_DIR\fP\&.
|
||
This flag tells CMake to warn about other files as well.
|
||
.TP
|
||
.B \fB\-\-profiling\-output=<path>\fP
|
||
Used in conjuction with \fB\-\-profiling\-format\fP to output to a given path.
|
||
.TP
|
||
.B \fB\-\-profiling\-format=<file>\fP
|
||
Enable the output of profiling data of CMake script in the given format.
|
||
.sp
|
||
This can aid performance analysis of CMake scripts executed. Third party
|
||
applications should be used to process the output into human readable format.
|
||
.sp
|
||
Currently supported values are:
|
||
\fBgoogle\-trace\fP Outputs in Google Trace Format, which can be parsed by the
|
||
\fI\%about:tracing\fP tab of Google Chrome or using a plugin for a tool like Trace
|
||
Compass.
|
||
.UNINDENT
|
||
.SH BUILD A PROJECT
|
||
.sp
|
||
CMake provides a command\-line signature to build an already\-generated
|
||
project binary tree:
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
cmake \-\-build <dir> [<options>] [\-\- <build\-tool\-options>]
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
This abstracts a native build tool’s command\-line interface with the
|
||
following options:
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \fB\-\-build <dir>\fP
|
||
Project binary directory to be built. This is required and must be first.
|
||
.TP
|
||
.B \fB\-\-parallel [<jobs>], \-j [<jobs>]\fP
|
||
The maximum number of concurrent processes to use when building.
|
||
If \fB<jobs>\fP is omitted the native build tool’s default number is used.
|
||
.sp
|
||
The \fBCMAKE_BUILD_PARALLEL_LEVEL\fP environment variable, if set,
|
||
specifies a default parallel level when this option is not given.
|
||
.sp
|
||
Some native build tools always build in parallel. The use of \fB<jobs>\fP
|
||
value of \fB1\fP can be used to limit to a single job.
|
||
.TP
|
||
.B \fB\-\-target <tgt>..., \-t <tgt>...\fP
|
||
Build \fB<tgt>\fP instead of the default target. Multiple targets may be
|
||
given, separated by spaces.
|
||
.TP
|
||
.B \fB\-\-config <cfg>\fP
|
||
For multi\-configuration tools, choose configuration \fB<cfg>\fP\&.
|
||
.TP
|
||
.B \fB\-\-clean\-first\fP
|
||
Build target \fBclean\fP first, then build.
|
||
(To clean only, use \fB\-\-target clean\fP\&.)
|
||
.TP
|
||
.B \fB\-\-use\-stderr\fP
|
||
Ignored. Behavior is default in CMake >= 3.0.
|
||
.TP
|
||
.B \fB\-\-verbose, \-v\fP
|
||
Enable verbose output \- if supported \- including the build commands to be
|
||
executed.
|
||
.sp
|
||
This option can be omitted if \fBVERBOSE\fP environment variable or
|
||
\fBCMAKE_VERBOSE_MAKEFILE\fP cached variable is set.
|
||
.TP
|
||
.B \fB\-\-\fP
|
||
Pass remaining options to the native tool.
|
||
.UNINDENT
|
||
.sp
|
||
Run \fBcmake \-\-build\fP with no options for quick help.
|
||
.SH INSTALL A PROJECT
|
||
.sp
|
||
CMake provides a command\-line signature to install an already\-generated
|
||
project binary tree:
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
cmake \-\-install <dir> [<options>]
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
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:
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \fB\-\-install <dir>\fP
|
||
Project binary directory to install. This is required and must be first.
|
||
.TP
|
||
.B \fB\-\-config <cfg>\fP
|
||
For multi\-configuration generators, choose configuration \fB<cfg>\fP\&.
|
||
.TP
|
||
.B \fB\-\-component <comp>\fP
|
||
Component\-based install. Only install component \fB<comp>\fP\&.
|
||
.TP
|
||
.B \fB\-\-prefix <prefix>\fP
|
||
Override the installation prefix, \fBCMAKE_INSTALL_PREFIX\fP\&.
|
||
.TP
|
||
.B \fB\-\-strip\fP
|
||
Strip before installing.
|
||
.TP
|
||
.B \fB\-v, \-\-verbose\fP
|
||
Enable verbose output.
|
||
.sp
|
||
This option can be omitted if \fBVERBOSE\fP environment variable is set.
|
||
.UNINDENT
|
||
.sp
|
||
Run \fBcmake \-\-install\fP with no options for quick help.
|
||
.SH OPEN A PROJECT
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
cmake \-\-open <dir>
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
Open the generated project in the associated application. This is only
|
||
supported by some generators.
|
||
.SH RUN A SCRIPT
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
cmake [{\-D <var>=<value>}...] \-P <cmake\-script\-file> [\-\- <unparsed\-options>...]
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
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 \fB\-D\fP, this must be
|
||
done before the \fB\-P\fP argument.
|
||
.sp
|
||
Any options after \fB\-\-\fP are not parsed by CMake, but they are still included
|
||
in the set of \fBCMAKE_ARGV<n>\fP variables passed to the
|
||
script (including the \fB\-\-\fP itself).
|
||
.SH RUN A COMMAND-LINE TOOL
|
||
.sp
|
||
CMake provides builtin command\-line tools through the signature
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
cmake \-E <command> [<options>]
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
Run \fBcmake \-E\fP or \fBcmake \-E help\fP for a summary of commands.
|
||
Available commands are:
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \fBcapabilities\fP
|
||
Report cmake capabilities in JSON format. The output is a JSON object
|
||
with the following keys:
|
||
.INDENT 7.0
|
||
.TP
|
||
.B \fBversion\fP
|
||
A JSON object with version information. Keys are:
|
||
.INDENT 7.0
|
||
.TP
|
||
.B \fBstring\fP
|
||
The full version string as displayed by cmake \fB\-\-version\fP\&.
|
||
.TP
|
||
.B \fBmajor\fP
|
||
The major version number in integer form.
|
||
.TP
|
||
.B \fBminor\fP
|
||
The minor version number in integer form.
|
||
.TP
|
||
.B \fBpatch\fP
|
||
The patch level in integer form.
|
||
.TP
|
||
.B \fBsuffix\fP
|
||
The cmake version suffix string.
|
||
.TP
|
||
.B \fBisDirty\fP
|
||
A bool that is set if the cmake build is from a dirty tree.
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBgenerators\fP
|
||
A list available generators. Each generator is a JSON object with the
|
||
following keys:
|
||
.INDENT 7.0
|
||
.TP
|
||
.B \fBname\fP
|
||
A string containing the name of the generator.
|
||
.TP
|
||
.B \fBtoolsetSupport\fP
|
||
\fBtrue\fP if the generator supports toolsets and \fBfalse\fP otherwise.
|
||
.TP
|
||
.B \fBplatformSupport\fP
|
||
\fBtrue\fP if the generator supports platforms and \fBfalse\fP otherwise.
|
||
.TP
|
||
.B \fBextraGenerators\fP
|
||
A list of strings with all the extra generators compatible with
|
||
the generator.
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBfileApi\fP
|
||
Optional member that is present when the \fBcmake\-file\-api(7)\fP
|
||
is available. The value is a JSON object with one member:
|
||
.INDENT 7.0
|
||
.TP
|
||
.B \fBrequests\fP
|
||
A JSON array containing zero or more supported file\-api requests.
|
||
Each request is a JSON object with members:
|
||
.INDENT 7.0
|
||
.TP
|
||
.B \fBkind\fP
|
||
Specifies one of the supported file\-api object kinds\&.
|
||
.TP
|
||
.B \fBversion\fP
|
||
A JSON array whose elements are each a JSON object containing
|
||
\fBmajor\fP and \fBminor\fP members specifying non\-negative integer
|
||
version components.
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBserverMode\fP
|
||
\fBtrue\fP if cmake supports server\-mode and \fBfalse\fP otherwise.
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBcat <files>...\fP
|
||
Concatenate files and print on the standard output.
|
||
.TP
|
||
.B \fBchdir <dir> <cmd> [<arg>...]\fP
|
||
Change the current working directory and run a command.
|
||
.TP
|
||
.B \fBcompare_files [\-\-ignore\-eol] <file1> <file2>\fP
|
||
Check if \fB<file1>\fP is same as \fB<file2>\fP\&. If files are the same,
|
||
then returns \fB0\fP, if not it returns \fB1\fP\&. The \fB\-\-ignore\-eol\fP option
|
||
implies line\-wise comparison and ignores LF/CRLF differences.
|
||
.TP
|
||
.B \fBcopy <file>... <destination>\fP
|
||
Copy files to \fB<destination>\fP (either file or directory).
|
||
If multiple files are specified, the \fB<destination>\fP must be
|
||
directory and it must exist. Wildcards are not supported.
|
||
\fBcopy\fP does follow symlinks. That means it does not copy symlinks,
|
||
but the files or directories it point to.
|
||
.TP
|
||
.B \fBcopy_directory <dir>... <destination>\fP
|
||
Copy content of \fB<dir>...\fP directories to \fB<destination>\fP directory.
|
||
If \fB<destination>\fP directory does not exist it will be created.
|
||
\fBcopy_directory\fP does follow symlinks.
|
||
.TP
|
||
.B \fBcopy_if_different <file>... <destination>\fP
|
||
Copy files to \fB<destination>\fP (either file or directory) if
|
||
they have changed.
|
||
If multiple files are specified, the \fB<destination>\fP must be
|
||
directory and it must exist.
|
||
\fBcopy_if_different\fP does follow symlinks.
|
||
.TP
|
||
.B \fBcreate_symlink <old> <new>\fP
|
||
Create a symbolic link \fB<new>\fP naming \fB<old>\fP\&.
|
||
.sp
|
||
\fBNOTE:\fP
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
Path to where \fB<new>\fP symbolic link will be created has to exist beforehand.
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBecho [<string>...]\fP
|
||
Displays arguments as text.
|
||
.TP
|
||
.B \fBecho_append [<string>...]\fP
|
||
Displays arguments as text but no new line.
|
||
.TP
|
||
.B \fBenv [\-\-unset=NAME]... [NAME=VALUE]... COMMAND [ARG]...\fP
|
||
Run command in a modified environment.
|
||
.TP
|
||
.B \fBenvironment\fP
|
||
Display the current environment variables.
|
||
.TP
|
||
.B \fBfalse\fP
|
||
Do nothing, with an exit code of 1.
|
||
.TP
|
||
.B \fBmake_directory <dir>...\fP
|
||
Create \fB<dir>\fP directories. If necessary, create parent
|
||
directories too. If a directory already exists it will be
|
||
silently ignored.
|
||
.TP
|
||
.B \fBmd5sum <file>...\fP
|
||
Create MD5 checksum of files in \fBmd5sum\fP compatible format:
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
351abe79cd3800b38cdfb25d45015a15 file1.txt
|
||
052f86c15bbde68af55c7f7b340ab639 file2.txt
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBsha1sum <file>...\fP
|
||
Create SHA1 checksum of files in \fBsha1sum\fP compatible format:
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
4bb7932a29e6f73c97bb9272f2bdc393122f86e0 file1.txt
|
||
1df4c8f318665f9a5f2ed38f55adadb7ef9f559c file2.txt
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBsha224sum <file>...\fP
|
||
Create SHA224 checksum of files in \fBsha224sum\fP compatible format:
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
b9b9346bc8437bbda630b0b7ddfc5ea9ca157546dbbf4c613192f930 file1.txt
|
||
6dfbe55f4d2edc5fe5c9197bca51ceaaf824e48eba0cc453088aee24 file2.txt
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBsha256sum <file>...\fP
|
||
Create SHA256 checksum of files in \fBsha256sum\fP compatible format:
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
76713b23615d31680afeb0e9efe94d47d3d4229191198bb46d7485f9cb191acc file1.txt
|
||
15b682ead6c12dedb1baf91231e1e89cfc7974b3787c1e2e01b986bffadae0ea file2.txt
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBsha384sum <file>...\fP
|
||
Create SHA384 checksum of files in \fBsha384sum\fP compatible format:
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
acc049fedc091a22f5f2ce39a43b9057fd93c910e9afd76a6411a28a8f2b8a12c73d7129e292f94fc0329c309df49434 file1.txt
|
||
668ddeb108710d271ee21c0f3acbd6a7517e2b78f9181c6a2ff3b8943af92b0195dcb7cce48aa3e17893173c0a39e23d file2.txt
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBsha512sum <file>...\fP
|
||
Create SHA512 checksum of files in \fBsha512sum\fP compatible format:
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
2a78d7a6c5328cfb1467c63beac8ff21794213901eaadafd48e7800289afbc08e5fb3e86aa31116c945ee3d7bf2a6194489ec6101051083d1108defc8e1dba89 file1.txt
|
||
7a0b54896fe5e70cca6dd643ad6f672614b189bf26f8153061c4d219474b05dad08c4e729af9f4b009f1a1a280cb625454bf587c690f4617c27e3aebdf3b7a2d file2.txt
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBremove [\-f] <file>...\fP
|
||
Deprecated since version 3.17.
|
||
|
||
.sp
|
||
Remove the file(s). The planned behaviour was that if any of the
|
||
listed files already do not exist, the command returns a non\-zero exit code,
|
||
but no message is logged. The \fB\-f\fP option changes the behavior to return a
|
||
zero exit code (i.e. success) in such situations instead.
|
||
\fBremove\fP does not follow symlinks. That means it remove only symlinks
|
||
and not files it point to.
|
||
.sp
|
||
The implementation was buggy and always returned 0. It cannot be fixed without
|
||
breaking backwards compatibility. Use \fBrm\fP instead.
|
||
.TP
|
||
.B \fBremove_directory <dir>...\fP
|
||
Deprecated since version 3.17.
|
||
|
||
.sp
|
||
Remove \fB<dir>\fP directories and their contents. If a directory does
|
||
not exist it will be silently ignored. If \fB<dir>\fP is a symlink to
|
||
a directory, just the symlink will be removed.
|
||
Use \fBrm\fP instead.
|
||
.TP
|
||
.B \fBrename <oldname> <newname>\fP
|
||
Rename a file or directory (on one volume). If file with the \fB<newname>\fP name
|
||
already exists, then it will be silently replaced.
|
||
.TP
|
||
.B \fBrm [\-rRf] <file> <dir>...\fP
|
||
Remove the files \fB<file>\fP or directories \fBdir\fP\&.
|
||
Use \fB\-r\fP or \fB\-R\fP to remove directories and their contents recursively.
|
||
If any of the listed files/directories do not exist, the command returns a
|
||
non\-zero exit code, but no message is logged. The \fB\-f\fP option changes
|
||
the behavior to return a zero exit code (i.e. success) in such
|
||
situations instead.
|
||
.TP
|
||
.B \fBserver\fP
|
||
Launch \fBcmake\-server(7)\fP mode.
|
||
.TP
|
||
.B \fBsleep <number>...\fP
|
||
Sleep for given number of seconds.
|
||
.TP
|
||
.B \fBtar [cxt][vf][zjJ] file.tar [<options>] [\-\-] [<pathname>...]\fP
|
||
Create or extract a tar or zip archive. Options are:
|
||
.INDENT 7.0
|
||
.TP
|
||
.B \fBc\fP
|
||
Create a new archive containing the specified files.
|
||
If used, the \fB<pathname>...\fP argument is mandatory.
|
||
.TP
|
||
.B \fBx\fP
|
||
Extract to disk from the archive.
|
||
The \fB<pathname>...\fP argument could be used to extract only selected files
|
||
or directories.
|
||
When extracting selected files or directories, you must provide their exact
|
||
names including the path, as printed by list (\fB\-t\fP).
|
||
.TP
|
||
.B \fBt\fP
|
||
List archive contents.
|
||
The \fB<pathname>...\fP argument could be used to list only selected files
|
||
or directories.
|
||
.TP
|
||
.B \fBv\fP
|
||
Produce verbose output.
|
||
.TP
|
||
.B \fBz\fP
|
||
Compress the resulting archive with gzip.
|
||
.TP
|
||
.B \fBj\fP
|
||
Compress the resulting archive with bzip2.
|
||
.TP
|
||
.B \fBJ\fP
|
||
Compress the resulting archive with XZ.
|
||
.TP
|
||
.B \fB\-\-zstd\fP
|
||
Compress the resulting archive with Zstandard.
|
||
.TP
|
||
.B \fB\-\-files\-from=<file>\fP
|
||
Read file names from the given file, one per line.
|
||
Blank lines are ignored. Lines may not start in \fB\-\fP
|
||
except for \fB\-\-add\-file=<name>\fP to add files whose
|
||
names start in \fB\-\fP\&.
|
||
.TP
|
||
.B \fB\-\-format=<format>\fP
|
||
Specify the format of the archive to be created.
|
||
Supported formats are: \fB7zip\fP, \fBgnutar\fP, \fBpax\fP,
|
||
\fBpaxr\fP (restricted pax, default), and \fBzip\fP\&.
|
||
.TP
|
||
.B \fB\-\-mtime=<date>\fP
|
||
Specify modification time recorded in tarball entries.
|
||
.TP
|
||
.B \fB\-\-\fP
|
||
Stop interpreting options and treat all remaining arguments
|
||
as file names, even if they start with \fB\-\fP\&.
|
||
.UNINDENT
|
||
.TP
|
||
.B \fBtime <command> [<args>...]\fP
|
||
Run command and display elapsed time.
|
||
.TP
|
||
.B \fBtouch <file>...\fP
|
||
Creates \fB<file>\fP if file do not exist.
|
||
If \fB<file>\fP exists, it is changing \fB<file>\fP access and modification times.
|
||
.TP
|
||
.B \fBtouch_nocreate <file>...\fP
|
||
Touch a file if it exists but do not create it. If a file does
|
||
not exist it will be silently ignored.
|
||
.TP
|
||
.B \fBtrue\fP
|
||
Do nothing, with an exit code of 0.
|
||
.UNINDENT
|
||
.SS Windows\-specific Command\-Line Tools
|
||
.sp
|
||
The following \fBcmake \-E\fP commands are available only on Windows:
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \fBdelete_regv <key>\fP
|
||
Delete Windows registry value.
|
||
.TP
|
||
.B \fBenv_vs8_wince <sdkname>\fP
|
||
Displays a batch file which sets the environment for the provided
|
||
Windows CE SDK installed in VS2005.
|
||
.TP
|
||
.B \fBenv_vs9_wince <sdkname>\fP
|
||
Displays a batch file which sets the environment for the provided
|
||
Windows CE SDK installed in VS2008.
|
||
.TP
|
||
.B \fBwrite_regv <key> <value>\fP
|
||
Write Windows registry value.
|
||
.UNINDENT
|
||
.SH RUN THE FIND-PACKAGE TOOL
|
||
.sp
|
||
CMake provides a pkg\-config like helper for Makefile\-based projects:
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
cmake \-\-find\-package [<options>]
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
It searches a package using \fBfind_package()\fP and prints the
|
||
resulting flags to stdout. This can be used instead of pkg\-config
|
||
to find installed libraries in plain Makefile\-based projects or in
|
||
autoconf\-based projects (via \fBshare/aclocal/cmake.m4\fP).
|
||
.sp
|
||
\fBNOTE:\fP
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
This mode is not well\-supported due to some technical limitations.
|
||
It is kept for compatibility but should not be used in new projects.
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.SH VIEW HELP
|
||
.sp
|
||
To print selected pages from the CMake documentation, use
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
cmake \-\-help[\-<topic>]
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
with one of the following options:
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \fB\-\-help,\-help,\-usage,\-h,\-H,/?\fP
|
||
Print usage information and exit.
|
||
.sp
|
||
Usage describes the basic command line interface and its options.
|
||
.TP
|
||
.B \fB\-\-version,\-version,/V [<f>]\fP
|
||
Show program name/version banner and exit.
|
||
.sp
|
||
If a file is specified, the version is written into it.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-full [<f>]\fP
|
||
Print all help manuals and exit.
|
||
.sp
|
||
All manuals are printed in a human\-readable text format.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-manual <man> [<f>]\fP
|
||
Print one help manual and exit.
|
||
.sp
|
||
The specified manual is printed in a human\-readable text format.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-manual\-list [<f>]\fP
|
||
List help manuals available and exit.
|
||
.sp
|
||
The list contains all manuals for which help may be obtained by
|
||
using the \fB\-\-help\-manual\fP option followed by a manual name.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-command <cmd> [<f>]\fP
|
||
Print help for one command and exit.
|
||
.sp
|
||
The \fBcmake\-commands(7)\fP manual entry for \fB<cmd>\fP is
|
||
printed in a human\-readable text format.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-command\-list [<f>]\fP
|
||
List commands with help available and exit.
|
||
.sp
|
||
The list contains all commands for which help may be obtained by
|
||
using the \fB\-\-help\-command\fP option followed by a command name.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-commands [<f>]\fP
|
||
Print cmake\-commands manual and exit.
|
||
.sp
|
||
The \fBcmake\-commands(7)\fP manual is printed in a
|
||
human\-readable text format.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-module <mod> [<f>]\fP
|
||
Print help for one module and exit.
|
||
.sp
|
||
The \fBcmake\-modules(7)\fP manual entry for \fB<mod>\fP is printed
|
||
in a human\-readable text format.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-module\-list [<f>]\fP
|
||
List modules with help available and exit.
|
||
.sp
|
||
The list contains all modules for which help may be obtained by
|
||
using the \fB\-\-help\-module\fP option followed by a module name.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-modules [<f>]\fP
|
||
Print cmake\-modules manual and exit.
|
||
.sp
|
||
The \fBcmake\-modules(7)\fP manual is printed in a human\-readable
|
||
text format.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-policy <cmp> [<f>]\fP
|
||
Print help for one policy and exit.
|
||
.sp
|
||
The \fBcmake\-policies(7)\fP manual entry for \fB<cmp>\fP is
|
||
printed in a human\-readable text format.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-policy\-list [<f>]\fP
|
||
List policies with help available and exit.
|
||
.sp
|
||
The list contains all policies for which help may be obtained by
|
||
using the \fB\-\-help\-policy\fP option followed by a policy name.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-policies [<f>]\fP
|
||
Print cmake\-policies manual and exit.
|
||
.sp
|
||
The \fBcmake\-policies(7)\fP manual is printed in a
|
||
human\-readable text format.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-property <prop> [<f>]\fP
|
||
Print help for one property and exit.
|
||
.sp
|
||
The \fBcmake\-properties(7)\fP manual entries for \fB<prop>\fP are
|
||
printed in a human\-readable text format.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-property\-list [<f>]\fP
|
||
List properties with help available and exit.
|
||
.sp
|
||
The list contains all properties for which help may be obtained by
|
||
using the \fB\-\-help\-property\fP option followed by a property name.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-properties [<f>]\fP
|
||
Print cmake\-properties manual and exit.
|
||
.sp
|
||
The \fBcmake\-properties(7)\fP manual is printed in a
|
||
human\-readable text format.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-variable <var> [<f>]\fP
|
||
Print help for one variable and exit.
|
||
.sp
|
||
The \fBcmake\-variables(7)\fP manual entry for \fB<var>\fP is
|
||
printed in a human\-readable text format.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-variable\-list [<f>]\fP
|
||
List variables with help available and exit.
|
||
.sp
|
||
The list contains all variables for which help may be obtained by
|
||
using the \fB\-\-help\-variable\fP option followed by a variable name.
|
||
The help is printed to a named <f>ile if given.
|
||
.TP
|
||
.B \fB\-\-help\-variables [<f>]\fP
|
||
Print cmake\-variables manual and exit.
|
||
.sp
|
||
The \fBcmake\-variables(7)\fP manual is printed in a
|
||
human\-readable text format.
|
||
The help is printed to a named <f>ile if given.
|
||
.UNINDENT
|
||
.SH SEE ALSO
|
||
.sp
|
||
The following resources are available to get help using CMake:
|
||
.INDENT 0.0
|
||
.TP
|
||
.B Home Page
|
||
\fI\%https://cmake.org\fP
|
||
.sp
|
||
The primary starting point for learning about CMake.
|
||
.TP
|
||
.B Online Documentation and Community Resources
|
||
\fI\%https://cmake.org/documentation\fP
|
||
.sp
|
||
Links to available documentation and community resources may be
|
||
found on this web page.
|
||
.TP
|
||
.B Discourse Forum
|
||
\fI\%https://discourse.cmake.org\fP
|
||
.sp
|
||
The Discourse Forum hosts discussion and questions about CMake.
|
||
.UNINDENT
|
||
.SH COPYRIGHT
|
||
2000-2020 Kitware, Inc. and Contributors
|
||
.\" Generated by docutils manpage writer.
|
||
.
|