cmake3(1)
NAME
cmake – CMake Command-Line Reference
SYNOPSIS
cmake3[<options>](<path - to - source> | <path - to - existing - build>)
cmake3[(-D < var >= <value>)...] -
P<cmake - script - file> cmake3-- build<dir>[<options>...][--<build - tool - options>...] cmake3 - E<command>[<options>...] cmake3-- find - package<options>...
DESCRIPTION
The "cmake3" executable is the CMake command-line interface. It may be used to configure projects in scripts. Project configuration settings may be specified on the command line with the -D option.
CMake is a cross-platform build system generator. Projects specify their build process with platform-independent CMake listfiles included in each directory of a source tree with the name CMakeLists.txt. Users build a project by using CMake to generate a build system for a native tool on their platform.
OPTIONS
-C <initial-cache>- Pre-load a script to populate the cache.
-D <var>:<type>=<value>, -D <var>=<value>- Create a cmake cache entry.
-U <globbing_expr>- Remove matching entries from CMake cache.
-G <generator-name>- Specify a build system generator.
-T <toolset-name>- Specify toolset name if supported by generator.
-A <platform-name>- Specify platform name if supported by generator.
-Wno-dev- Suppress developer warnings.
-Wdev- Enable developer warnings.
-Werror=dev- Make developer warnings errors.
-Wno-error=dev- Make developer warnings not errors.
-Wdeprecated- Enable deprecated functionality warnings.
-Wno-deprecated- Suppress deprecated functionality warnings.
-Werror=deprecated- Make deprecated macro and function warnings errors.
-Wno-error=deprecated- Make deprecated macro and function warnings not errors.
-E <command> [<options>…]- See Command-Line Tool Mode.
-L[A][H]- List non-advanced cached variables.
–build <dir>- See Build Tool Mode.
-N- View mode only.
-P <file>- Process script mode.
–find-package- See Find-Package Tool Mode.
–graphviz=[file]- Generate graphviz of dependencies, see CMakeGraphVizOptions.cmake for more.
–system-information [file]- Dump information about this system.
–debug-trycompile- Do not delete the try_compile build tree. Only useful on one try_compile at a time.
–debug-output- Put cmake in a debug mode.
–trace- Put cmake in trace mode.
–trace-expand- Put cmake in trace mode.
–warn-uninitialized- Warn about uninitialized values.
–warn-unused-vars- Warn about unused variables.
–no-warn-unused-cli- Don’t warn about command line options.
–check-system-vars- Find problems with variable usage in system files.
–help,-help,-usage,-h,-H,/?- Print usage information and exit.
–version,-version,/V [<f>]- Show program name/version banner and exit.
–help-full [<f>]- Print all help manuals and exit.
–help-manual <man> [<f>]- Print one help manual and exit.
–help-manual-list [<f>]- List help manuals available and exit.
–help-command <cmd> [<f>]- Print help for one command and exit.
–help-command-list [<f>]- List commands with help available and exit.
–help-commands [<f>]- Print cmake-commands manual and exit.
–help-module <mod> [<f>]- Print help for one module and exit.
–help-module-list [<f>]- List modules with help available and exit.
–help-modules [<f>]- Print cmake-modules manual and exit.
–help-policy <cmp> [<f>]- Print help for one policy and exit.
–help-policy-list [<f>]- List policies with help available and exit.
–help-policies [<f>]- Print cmake-policies manual and exit.
–help-property <prop> [<f>]- Print help for one property and exit.
–help-property-list [<f>]- List properties with help available and exit.
–help-properties [<f>]- Print cmake-properties manual and exit.
–help-variable <var> [<f>]- Print help for one variable and exit.
–help-variable-list [<f>]- List variables with help available and exit.
–help-variables [<f>]- Print cmake-variables manual and exit.
When cmake is first run in an empty build tree, it creates a CMakeCache.txt file and populates it with customizable settings for the project. This option may be used to specify a file from which to load cache entries before the first pass through the project’s cmake listfiles. The loaded entries take priority over the project’s default values. The given file should be a CMake script containing SET commands that use the CACHE option, not a cache-format file.
When cmake is first run in an empty build tree, it creates a CMakeCache.txt file and populates it with customizable settings for the project. This option may be used to specify a setting that takes priority over the project’s default value. The option may be repeated for as many cache entries as desired.
If the :<type> portion is given it must be one of the types specified by the set() command documentation for its CACHE signature. If the :<type> 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 PATH or FILEPATH then the <value> will be converted to an absolute path.
This option may also be given as a single argument: -D<var>:<type>=<value> or -D<var>=<value>.
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.
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 cmake-generators(7) manual.
Some CMake generators support a toolset name to be given to the native build system to choose a compiler. This is supported only on specific generators:
Visual Studio >= 10 Xcode >= 3.0
See native build system documentation for allowed toolset names.
Some CMake generators support a platform name to be given to the native build system to choose a compiler or SDK. This is supported only on specific generators:
Visual Studio >= 8
See native build system documentation for allowed platform names.
Suppress warnings that are meant for the author of the CMakeLists.txt files. By default this will also turn off deprecation warnings.
Enable warnings that are meant for the author of the CMakeLists.txt files. By default this will also turn on deprecation warnings.
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.
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.
Enable warnings for usage of deprecated functionality, that are meant for the author of the CMakeLists.txt files.
Suppress warnings for usage of deprecated functionality, that are meant for the author of the CMakeLists.txt files.
Make warnings for usage of deprecated macros and functions, that are meant for the author of the CMakeLists.txt files, errors.
Make warnings for usage of deprecated macros and functions, that are meant for the author of the CMakeLists.txt files, not errors.
List cache variables will run CMake and list all the variables from the CMake cache that are not marked as INTERNAL or ADVANCED. This will effectively display current CMake settings, which can then be changed with -D option. Changing some of the variables may result in more variables being created. If A is specified, then it will display also advanced variables. If H is specified, it will also display help for each variable.
Only load the cache. Do not actually run configure and generate steps.
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.
Generate a graphviz input file that will contain all the library and executable dependencies in the project. See the documentation for CMakeGraphVizOptions.cmake for more details.
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.
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.
Print extra information during the cmake run like stack traces with message(send_error ) calls.
Print a trace of all calls made and from where.
Like –trace, but with variables expanded.
Print a warning when an uninitialized variable is used.
Find variables that are declared or set, but not used.
Don’t find variables that are declared on the command line, but not used.
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.
Usage describes the basic command line interface and its options.
If a file is specified, the version is written into it. The help is printed to a named <f>ile if given.
All manuals are printed in a human-readable text format. The help is printed to a named <f>ile if given.
The specified manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The list contains all manuals for which help may be obtained by using the –help-manual option followed by a manual name. The help is printed to a named <f>ile if given.
The cmake-commands(7) manual entry for <cmd> is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The list contains all commands for which help may be obtained by using the –help-command option followed by a command name. The help is printed to a named <f>ile if given.
The cmake-commands(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The cmake-modules(7) manual entry for <mod> is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The list contains all modules for which help may be obtained by using the –help-module option followed by a module name. The help is printed to a named <f>ile if given.
The cmake-modules(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The cmake-policies(7) manual entry for <cmp> is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The list contains all policies for which help may be obtained by using the –help-policy option followed by a policy name. The help is printed to a named <f>ile if given.
The cmake-policies(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The cmake-properties(7) manual entries for <prop> are printed in a human-readable text format. The help is printed to a named <f>ile if given.
The list contains all properties for which help may be obtained by using the –help-property option followed by a property name. The help is printed to a named <f>ile if given.
The cmake-properties(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The cmake-variables(7) manual entry for <var> is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The list contains all variables for which help may be obtained by using the –help-variable option followed by a variable name. The help is printed to a named <f>ile if given.
The cmake-variables(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
BUILD TOOL MODE
CMake provides a command-line signature to build an already-generated project binary tree:
cmake3-- build<dir>[<options>...][--<build - tool - options>...]
This abstracts a native build tool’s command-line interface with the following options:
–build <dir>- Project binary directory to be built. This is required and must be first.
–target <tgt>- Build
<tgt>instead of default targets. May only be specified once. –config <cfg>- For multi-configuration tools, choose configuration
<cfg>. –clean-first- Build target
cleanfirst, then build. (To clean only, use–target clean.) –use-stderr- Ignored. Behavior is default in CMake >= 3.0.
—- Pass remaining options to the native tool.
Run cmake3 –build with no options for quick help.
COMMAND-LINE TOOL MODE
CMake provides builtin command-line tools through the signature:
cmake3 -E <command> [<options>...]
Run cmake3 -E or cmake3 -E help for a summary of commands. Available commands are:
chdir <dir> <cmd> [<arg>…]- Change the current working directory and run a command.
compare_files <file1> <file2>- Check if
<file1>is same as<file2>. If files are the same, then returns 0, if not it returns 1. 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. copy_directory <dir>… <destination>- Copy directories to
<destination>directory. If<destination>directory does not exist it will be created. 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 directory and it must exist. echo [<string>…]- Displays arguments as text.
echo_append [<string>…]- Displays arguments as text but no new line.
env [–unset=NAME]… [NAME=VALUE]… COMMAND [ARG]…- Run command in a modified environment.
environment- Display the current environment variables.
make_directory <dir>…- Create
<dir>directories. If necessary, create parent directories too. If a directory already exists it will be silently ignored. md5sum <file>…- Create MD5 checksum of files in
md5sumcompatible format: remove [-f] <file>…- Remove the file(s), use
-fto force it. If a file does not exist it will be silently ignored. remove_directory <dir>- Remove a directory and its contents. If a directory does not exist it will be silently ignored.
rename <oldname> <newname>- Rename a file or directory (on one volume).
sleep <number>…- Sleep for given number of seconds.
tar [cxt][vf][zjJ] file.tar [<options>…] [–] [<file>…]- Create or extract a tar or zip archive. Options are:
—- Stop interpreting options and treat all remaining arguments as file names even if they start in
–. –files-from=<file>- Read file names from the given file, one per line. Blank lines are ignored. Lines may not start in
–except for–add-file=<name>to add files whose names start in–. –mtime=<date>- Specify modification time recorded in tarball entries.
–format=<format>- Specify the format of the archive to be created. Supported formats are:
7zip,gnutar,pax,paxr(restricted pax, default), andzip. time <command> [<args>…]- Run command and return elapsed time.
touch <file>- Touch a file.
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.
351abe79cd3800b38cdfb25d45015a15 file1.txt 052f86c15bbde68af55c7f7b340ab639 file2.txt
UNIX-specific Command-Line Tools
The following cmake3 -E commands are available only on UNIX:
create_symlink <old> <new>- Create a symbolic link
<new>naming<old>.
Windows-specific Command-Line Tools
The following cmake3 -E commands are available only on Windows:
delete_regv <key>- Delete Windows registry value.
env_vs8_wince <sdkname>- Displays a batch file which sets the environment for the provided Windows CE SDK installed in VS2005.
env_vs9_wince <sdkname>- Displays a batch file which sets the environment for the provided Windows CE SDK installed in VS2008.
write_regv <key> <value>- Write Windows registry value.
FIND-PACKAGE TOOL MODE
CMake provides a helper for Makefile-based projects with the signature:
cmake3 --find-package <options>...
This runs in a 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/cmake3.m4).
NOTE: This mode is not well-supported due to some technical limitations. It is kept for compatibility but should not be used in new projects.
SEE ALSO
The following resources are available to get help using CMake:
Home Page- https://cmake.org
Frequently Asked Questions- https://cmake.org/Wiki/CMake_FAQ
Online Documentation- https://cmake.org/documentation
Mailing List- https://cmake.org/mailing-lists
The primary starting point for learning about CMake.
A Wiki is provided containing answers to frequently asked questions.
Links to available documentation may be found on this web page.
For help and discussion about using cmake, a mailing list is provided at cmake [at] cmake.org. The list is member-post-only but one may sign up on the CMake web page. Please first read the full documentation at https://cmake.org before posting questions to the list.
COPYRIGHT
2000-2016 Kitware, Inc.