-C <initial-cache>
Pre-load a script to populate the cache.
When cmake is first run in an empty build tree, it creates a CMakeCache.txt file and populates it
with customizable settings for the project. This option may be used to specify a file from which
to load cache entries before the first pass through the project's cmake listfiles. The loaded
entries take priority over the project's default values. The given file should be a CMake script
containing SET commands that use the CACHE option, not a cache-format file.
|
-D <var>:<type>=<value>
Create a cmake cache entry.
When cmake is first run in an empty build tree, it creates a CMakeCache.txt file and populates it
with customizable settings for the project. This option may be used to specify a setting that
takes priority over the project's default value. The option may be repeated for as many cache
entries as desired.
|
-U <globbing_expr>
Remove matching entries from CMake cache.
This option may be used to remove one or more variables from the CMakeCache.txt file, globbing
expressions using * and ? are supported. The option may be repeated for as many cache entries as
desired.
Use with care, you can make your CMakeCache.txt non-working.
|
-G <generator-name>
Specify a makefile generator.
CMake may support multiple native build systems on certain platforms. A makefile generator is
responsible for generating a particular build system. Possible generator names are specified in
the Generators section.
|
-Wno-dev
Suppress developer warnings.
Suppress warnings that are meant for the author of the CMakeLists.txt files.
|
-Wdev Enable developer warnings.
Enable warnings that are meant for the author of the CMakeLists.txt files.
|
-E CMake command mode.
For true platform independence, CMake provides a list of commands that can be used on all systems.
Run with -E help for the usage information. Commands available are: chdir, compare_files, copy,
copy_directory, copy_if_different, echo, echo_append, environment, make_directory, md5sum, remove,
remove_directory, rename, tar, time, touch, touch_nocreate. In addition, some platform specific
commands are available. On Windows: comspec, delete_regv, write_regv. On UNIX: create_symlink.
|
-i Run in wizard mode.
Wizard mode runs cmake interactively without a GUI. The user is prompted to answer questions
about the project configuration. The answers are used to set cmake cache values.
|
--build <dir>
Build a CMake-generated project binary tree.
This abstracts a native build tool's command-line interface with the following options:
|
-P <file>
Process script mode.
Process the given cmake file as a script written in the CMake language. No configure or generate
step is performed and the cache is not modified. If variables are defined using -D, this must be
done before the -P argument.
|
--find-package
Run in pkg-config like mode.
Search a package using find_package() and print the resulting flags to stdout. This can be used to
use cmake instead of pkg-config to find installed libraries in plain Makefile-based projects or in
autoconf-based projects (via share/aclocal/cmake.m4).
|
--graphviz=[file]
Generate graphviz of dependencies.
Generate a graphviz input file that will contain all the library and executable dependencies in
the project.
|
--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.
|
--debug-trycompile
Do not delete the try_compile build tree. Only useful on one try_compile at a time.
Do not delete the files and directories created for try_compile calls. This is useful in debugging
failed try_compiles. It may however change the results of the try-compiles as old junk from a
previous try-compile may cause a different test to either pass or fail incorrectly. This option
is best used for one try-compile at a time, and only when debugging.
|
--debug-output
Put cmake in a debug mode.
Print extra stuff during the cmake run like stack traces with message(send_error ) calls.
|
--trace
Put cmake in trace mode.
Print a trace of all calls made and from where with message(send_error ) calls.
|
--warn-uninitialized
Warn about uninitialized values.
Print a warning when an uninitialized variable is used.
|
--warn-unused-vars
Warn about unused variables.
Find variables that are declared or set, but not used.
|
--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
Find problems with variable usage in system files.
Normally, unused and uninitialized variables are searched for only in CMAKE_SOURCE_DIR and
CMAKE_BINARY_DIR. This flag tells CMake to warn about other files as well.
|
--help-command cmd [file]
Print help for a single command and exit.
Full documentation specific to the given command is displayed. If a file is specified, the
documentation is written into and the output format is determined depending on the filename
suffix. Supported are man page, HTML, DocBook and plain text.
|
--help-command-list [file]
List available listfile commands and exit.
The list contains all commands for which help may be obtained by using the --help-command argument
followed by a command name. If a file is specified, the documentation is written into and the
output format is determined depending on the filename suffix. Supported are man page, HTML,
DocBook and plain text.
|
--help-commands [file]
Print help for all commands and exit.
Full documentation specific for all current command is displayed.If a file is specified, the
documentation is written into and the output format is determined depending on the filename
suffix. Supported are man page, HTML, DocBook and plain text.
|
--help-compatcommands [file]
Print help for compatibility commands.
Full documentation specific for all compatibility commands is displayed.If a file is specified,
the documentation is written into and the output format is determined depending on the filename
suffix. Supported are man page, HTML, DocBook and plain text.
|
--help-module module [file]
Print help for a single module and exit.
Full documentation specific to the given module is displayed.If a file is specified, the
documentation is written into and the output format is determined depending on the filename
suffix. Supported are man page, HTML, DocBook and plain text.
|
--help-module-list [file]
List available modules and exit.
|
--help-modules [file]
Print help for all modules and exit.
Full documentation for all modules is displayed. If a file is specified, the documentation is
written into and the output format is determined depending on the filename suffix. Supported are
man page, HTML, DocBook and plain text.
|
--help-custom-modules [file]
Print help for all custom modules and exit.
Full documentation for all custom modules is displayed. If a file is specified, the documentation
is written into and the output format is determined depending on the filename suffix. Supported
are man page, HTML, DocBook and plain text.
|
--help-policy cmp [file]
Print help for a single policy and exit.
Full documentation specific to the given policy is displayed.If a file is specified, the
documentation is written into and the output format is determined depending on the filename
suffix. Supported are man page, HTML, DocBook and plain text.
|
--help-policies [file]
Print help for all policies and exit.
Full documentation for all policies is displayed.If a file is specified, the documentation is
written into and the output format is determined depending on the filename suffix. Supported are
man page, HTML, DocBook and plain text.
|
--help-property prop [file]
Print help for a single property and exit.
Full documentation specific to the given property is displayed.If a file is specified, the
documentation is written into and the output format is determined depending on the filename
suffix. Supported are man page, HTML, DocBook and plain text.
|
--help-property-list [file]
List available properties and exit.
The list contains all properties for which help may be obtained by using the --help-property
argument followed by a property name. If a file is specified, the help is written into it.If a
file is specified, the documentation is written into and the output format is determined depending
on the filename suffix. Supported are man page, HTML, DocBook and plain text.
|
--help-properties [file]
Print help for all properties and exit.
Full documentation for all properties is displayed.If a file is specified, the documentation is
written into and the output format is determined depending on the filename suffix. Supported are
man page, HTML, DocBook and plain text.
|
--help-variable var [file]
Print help for a single variable and exit.
Full documentation specific to the given variable is displayed.If a file is specified, the
documentation is written into and the output format is determined depending on the filename
suffix. Supported are man page, HTML, DocBook and plain text.
|
--help-variable-list [file]
List documented variables and exit.
|
--help-variables [file]
Print help for all variables and exit.
Full documentation for all variables is displayed.If a file is specified, the documentation is
written into and the output format is determined depending on the filename suffix. Supported are
man page, HTML, DocBook and plain text.
|
--copyright [file]
Print the CMake copyright and exit.
If a file is specified, the copyright is written into it.
|
--help,-help,-usage,-h,-H,/?
Print usage information and exit.
Usage describes the basic command line interface and its options.
|
--help-full [file]
Print full help and exit.
Full help displays most of the documentation provided by the UNIX man page. It is provided for
use on non-UNIX platforms, but is also convenient if the man page is not installed. If a file is
specified, the help is written into it.
|
--help-html [file]
Print full help in HTML format.
This option is used by CMake authors to help produce web pages. If a file is specified, the help
is written into it.
|
--help-man [file]
Print full help as a UNIX man page and exit.
This option is used by the cmake build to generate the UNIX man page. If a file is specified, the
help is written into it.
|
--version,-version,/V [file]
Show program name/version banner and exit.
|