Ubuntu Manpage: cmake-variables - CMake Variables Reference

Provided by: cmake-data_3.10.2-1ubuntu2.18.04.2_all

NAME

       cmake-variables - CMake Variables Reference

VARIABLES THAT PROVIDE INFORMATION

CMAKE_AR
Name of archiving tool for static libraries.

This specifies the name of the program that creates archive or static libraries.

CMAKE_ARGC
Number of command line arguments passed to CMake in script mode.

When run in -P script mode, CMake sets this variable to the number of command line
arguments. See also CMAKE_ARGV0, 1, 2 …

CMAKE_ARGV0
Command line argument passed to CMake in script mode.

When run in -P script mode, CMake sets this variable to the first command line argument.
It then also sets CMAKE_ARGV1, CMAKE_ARGV2, … and so on, up to the number of command line
arguments given. See also CMAKE_ARGC.

CMAKE_BINARY_DIR
The path to the top level of the build tree.

This is the full path to the top level of the current CMake build tree. For an in-source
build, this would be the same as CMAKE_SOURCE_DIR.

When run in -P script mode, CMake sets the variables CMAKE_BINARY_DIR, CMAKE_SOURCE_DIR,
CMAKE_CURRENT_BINARY_DIR and CMAKE_CURRENT_SOURCE_DIR to the current working directory.

CMAKE_BUILD_TOOL
This variable exists only for backwards compatibility. It contains the same value as
CMAKE_MAKE_PROGRAM. Use that variable instead.

CMAKE_CACHEFILE_DIR
The directory with the CMakeCache.txt file.

This is the full path to the directory that has the CMakeCache.txt file in it. This is
the same as CMAKE_BINARY_DIR.

CMAKE_CACHE_MAJOR_VERSION
Major version of CMake used to create the CMakeCache.txt file

This stores the major version of CMake used to write a CMake cache file. It is only
different when a different version of CMake is run on a previously created cache file.

CMAKE_CACHE_MINOR_VERSION
Minor version of CMake used to create the CMakeCache.txt file

This stores the minor version of CMake used to write a CMake cache file. It is only
different when a different version of CMake is run on a previously created cache file.

CMAKE_CACHE_PATCH_VERSION
Patch version of CMake used to create the CMakeCache.txt file

This stores the patch version of CMake used to write a CMake cache file. It is only
different when a different version of CMake is run on a previously created cache file.

CMAKE_CFG_INTDIR
Build-time reference to per-configuration output subdirectory.

For native build systems supporting multiple configurations in the build tree (such as
Visual Studio Generators and Xcode), the value is a reference to a build-time variable
specifying the name of the per-configuration output subdirectory. On Makefile Generators
this evaluates to . because there is only one configuration in a build tree. Example
values:

$(ConfigurationName) = Visual Studio 8, 9
$(Configuration) = Visual Studio 10
$(CONFIGURATION) = Xcode
. = Make-based tools

Since these values are evaluated by the native build system, this variable is suitable
only for use in command lines that will be evaluated at build time. Example of intended
usage:

add_executable(mytool mytool.c)
add_custom_command(
OUTPUT out.txt
COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool
${CMAKE_CURRENT_SOURCE_DIR}/in.txt out.txt
DEPENDS mytool in.txt
)
add_custom_target(drive ALL DEPENDS out.txt)

Note that CMAKE_CFG_INTDIR is no longer necessary for this purpose but has been left for
compatibility with existing projects. Instead add_custom_command() recognizes executable
target names in its COMMAND option, so
${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool can be replaced by just mytool.

This variable is read-only. Setting it is undefined behavior. In multi-configuration
build systems the value of this variable is passed as the value of preprocessor symbol
CMAKE_INTDIR to the compilation of all source files.

CMAKE_COMMAND
The full path to the cmake(1) executable.

This is the full path to the CMake executable cmake(1) which is useful from custom
commands that want to use the cmake -E option for portable system commands. (e.g.
/usr/local/bin/cmake)

CMAKE_CROSSCOMPILING
Is CMake currently cross compiling.

This variable will be set to true by CMake if CMake is cross compiling. Specifically if
the build platform is different from the target platform.

CMAKE_CROSSCOMPILING_EMULATOR
This variable is only used when CMAKE_CROSSCOMPILING is on. It should point to a command
on the host system that can run executable built for the target system.

The command will be used to run try_run() generated executables, which avoids manual
population of the TryRunResults.cmake file.

It is also used as the default value for the CROSSCOMPILING_EMULATOR target property of
executables.

CMAKE_CTEST_COMMAND
Full path to ctest(1) command installed with CMake.

This is the full path to the CTest executable ctest(1) which is useful from custom
commands that want to use the cmake(1) -E option for portable system commands.

CMAKE_CURRENT_BINARY_DIR
The path to the binary directory currently being processed.

This the full path to the build directory that is currently being processed by cmake.
Each directory added by add_subdirectory() will create a binary directory in the build
tree, and as it is being processed this variable will be set. For in-source builds this
is the current source directory being processed.

When run in -P script mode, CMake sets the variables CMAKE_BINARY_DIR, CMAKE_SOURCE_DIR,
CMAKE_CURRENT_BINARY_DIR and CMAKE_CURRENT_SOURCE_DIR to the current working directory.

CMAKE_CURRENT_LIST_DIR
Full directory of the listfile currently being processed.

As CMake processes the listfiles in your project this variable will always be set to the
directory where the listfile which is currently being processed (CMAKE_CURRENT_LIST_FILE)
is located. The value has dynamic scope. When CMake starts processing commands in a
source file it sets this variable to the directory where this file is located. When CMake
finishes processing commands from the file it restores the previous value. Therefore the
value of the variable inside a macro or function is the directory of the file invoking the
bottom-most entry on the call stack, not the directory of the file containing the macro or
function definition.

VARIABLES THAT CHANGE BEHAVIOR

BUILD_SHARED_LIBS
Global flag to cause add_library() to create shared libraries if on.

If present and true, this will cause all libraries to be built shared unless the library
was explicitly added as a static library. This variable is often added to projects as an
option() so that each user of a project can decide if they want to build the project using
shared or static libraries.

CMAKE_ABSOLUTE_DESTINATION_FILES
List of files which have been installed using an ABSOLUTE DESTINATION path.

This variable is defined by CMake-generated cmake_install.cmake scripts. It can be used
(read-only) by programs or scripts that source those install scripts. This is used by
some CPack generators (e.g. RPM).

CMAKE_APPBUNDLE_PATH
;-list of directories specifying a search path for OS X application bundles used by the
find_program(), and find_package() commands.

CMAKE_AUTOMOC_RELAXED_MODE
Switch between strict and relaxed automoc mode.

By default, AUTOMOC behaves exactly as described in the documentation of the AUTOMOC
target property. When set to TRUE, it accepts more input and tries to find the correct
input file for moc even if it differs from the documented behaviour. In this mode it e.g.
also checks whether a header file is intended to be processed by moc when a "foo.moc" file
has been included.

Relaxed mode has to be enabled for KDE4 compatibility.

CMAKE_BACKWARDS_COMPATIBILITY
Deprecated. See CMake Policy CMP0001 documentation.

CMAKE_BUILD_TYPE
Specifies the build type on single-configuration generators.

This statically specifies what build type (configuration) will be built in this build
tree. Possible values are empty, Debug, Release, RelWithDebInfo and MinSizeRel. This
variable is only meaningful to single-configuration generators (such as Makefile
Generators and Ninja) i.e. those which choose a single configuration when CMake runs to
generate a build tree as opposed to multi-configuration generators which offer selection
of the build configuration within the generated build environment. There are many
per-config properties and variables (usually following clean SOME_VAR_<CONFIG> order
conventions), such as CMAKE_C_FLAGS_<CONFIG>, specified as uppercase:
CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]. For example, in a build tree
configured to build type Debug, CMake will see to having CMAKE_C_FLAGS_DEBUG settings get
added to the CMAKE_C_FLAGS settings. See also CMAKE_CONFIGURATION_TYPES.

CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES
Change the way the CodeBlocks generator creates project files.

If this variable evaluates to ON the generator excludes from the project file any files
that are located outside the project root.

CMAKE_CODELITE_USE_TARGETS
Change the way the CodeLite generator creates projectfiles.

If this variable evaluates to ON at the end of the top-level CMakeLists.txt file, the
generator creates projectfiles based on targets rather than projects.

CMAKE_COLOR_MAKEFILE
Enables color output when using the Makefile Generators.

When enabled, the generated Makefiles will produce colored output. Default is ON.

CMAKE_CONFIGURATION_TYPES
Specifies the available build types on multi-config generators.

This specifies what build types (configurations) will be available such as Debug, Release,
RelWithDebInfo etc. This has reasonable defaults on most platforms, but can be extended
to provide other build types. See also CMAKE_BUILD_TYPE for details of managing
configuration data, and CMAKE_CFG_INTDIR.

CMAKE_DEBUG_TARGET_PROPERTIES
Enables tracing output for target properties.

This variable can be populated with a list of properties to generate debug output for when
evaluating target properties. Currently it can only be used when evaluating the
INCLUDE_DIRECTORIES, COMPILE_DEFINITIONS, COMPILE_OPTIONS, AUTOUIC_OPTIONS, SOURCES,
COMPILE_FEATURES, POSITION_INDEPENDENT_CODE target properties and any other property
listed in COMPATIBLE_INTERFACE_STRING and other COMPATIBLE_INTERFACE_ properties. It
outputs an origin for each entry in the target property. Default is unset.

CMAKE_DEPENDS_IN_PROJECT_ONLY
When set to TRUE in a directory, the build system produced by the Makefile Generators is
set up to only consider dependencies on source files that appear either in the source or
in the binary directories. Changes to source files outside of these directories will not
cause rebuilds.

This should be used carefully in cases where some source files are picked up through
external headers during the build.

CMAKE_DISABLE_FIND_PACKAGE_<PackageName>
Variable for disabling find_package() calls.

Every non-REQUIRED find_package() call in a project can be disabled by setting the
variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to TRUE. This can be used to build a
project without an optional package, although that package is installed.

This switch should be used during the initial CMake run. Otherwise if the package has
already been found in a previous CMake run, the variables which have been stored in the
cache will still be there. In that case it is recommended to remove the cache variables
for this package from the cache using the cache editor or cmake(1) -U

CMAKE_ECLIPSE_GENERATE_LINKED_RESOURCES
This cache variable is used by the Eclipse project generator. See cmake-generators(7).

The Eclipse project generator generates so-called linked resources e.g. to the subproject
root dirs in the source tree or to the source files of targets. This can be disabled by
setting this variable to FALSE.

CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT
This cache variable is used by the Eclipse project generator. See cmake-generators(7).

If this variable is set to TRUE, the Eclipse project generator will generate an Eclipse
project in CMAKE_SOURCE_DIR . This project can then be used in Eclipse e.g. for the
version control functionality. CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT defaults to FALSE;
so nothing is written into the source directory.

CMAKE_ECLIPSE_MAKE_ARGUMENTS
This cache variable is used by the Eclipse project generator. See cmake-generators(7).

This variable holds arguments which are used when Eclipse invokes the make tool. By
default it is initialized to hold flags to enable parallel builds (using -j typically).

CMAKE_ECLIPSE_VERSION
This cache variable is used by the Eclipse project generator. See cmake-generators(7).

When using the Eclipse project generator, CMake tries to find the Eclipse executable and
detect the version of it. Depending on the version it finds, some features are enabled or
disabled. If CMake doesn’t find Eclipse, it assumes the oldest supported version, Eclipse
Callisto (3.2).

CMAKE_ERROR_DEPRECATED
Whether to issue errors for deprecated functionality.

If TRUE, use of deprecated functionality will issue fatal errors. If this variable is not
set, CMake behaves as if it were set to FALSE.

CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION
Ask cmake_install.cmake script to error out as soon as a file with absolute INSTALL
DESTINATION is encountered.

The fatal error is emitted before the installation of the offending file takes place.
This variable is used by CMake-generated cmake_install.cmake scripts. If one sets this
variable to ON while running the script, it may get fatal error messages from the script.

CMAKE_EXPORT_COMPILE_COMMANDS
Enable/Disable output of compile commands during generation.

If enabled, generates a compile_commands.json file containing the exact compiler calls for
all translation units of the project in machine-readable form. The format of the JSON
file looks like:

[
{
"directory": "/home/user/development/project",
"command": "/usr/bin/c++ ... -c ../foo/foo.cc",
"file": "../foo/foo.cc"
},

...

{
"directory": "/home/user/development/project",
"command": "/usr/bin/c++ ... -c ../foo/bar.cc",
"file": "../foo/bar.cc"
}
]

NOTE:
This option is implemented only by Makefile Generators and the Ninja. It is ignored on
other generators.

CMAKE_EXPORT_NO_PACKAGE_REGISTRY
Disable the export(PACKAGE) command.

In some cases, for example for packaging and for system wide installations, it is not
desirable to write the user package registry. If the CMAKE_EXPORT_NO_PACKAGE_REGISTRY
variable is enabled, the export(PACKAGE) command will do nothing.

See also Disabling the Package Registry.

CMAKE_FIND_APPBUNDLE
This variable affects how find_* commands choose between OS X Application Bundles and
unix-style package components.

On Darwin or systems supporting OS X Application Bundles, the CMAKE_FIND_APPBUNDLE
variable can be set to empty or one of the following:

FIRST Try to find application bundles before standard programs. This is the default on
Darwin.

LAST Try to find application bundles after standard programs.

ONLY Only try to find application bundles.

NEVER Never try to find application bundles.

CMAKE_FIND_FRAMEWORK
This variable affects how find_* commands choose between OS X Frameworks and unix-style
package components.

On Darwin or systems supporting OS X Frameworks, the CMAKE_FIND_FRAMEWORK variable can be
set to empty or one of the following:

FIRST Try to find frameworks before standard libraries or headers. This is the default
on Darwin.

LAST Try to find frameworks after standard libraries or headers.

ONLY Only try to find frameworks.

NEVER Never try to find frameworks.

CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX
Specify a <suffix> to tell the find_library() command to search in a lib<suffix> directory
before each lib directory that would normally be searched.

This overrides the behavior of related global properties:

• FIND_LIBRARY_USE_LIB32_PATHS

• FIND_LIBRARY_USE_LIB64_PATHS

• FIND_LIBRARY_USE_LIBX32_PATHS

CMAKE_FIND_LIBRARY_PREFIXES
Prefixes to prepend when looking for libraries.

This specifies what prefixes to add to library names when the find_library() command looks
for libraries. On UNIX systems this is typically lib, meaning that when trying to find
the foo library it will look for libfoo.

CMAKE_FIND_LIBRARY_SUFFIXES
Suffixes to append when looking for libraries.

This specifies what suffixes to add to library names when the find_library() command looks
for libraries. On Windows systems this is typically .lib and .dll, meaning that when
trying to find the foo library it will look for foo.dll etc.

CMAKE_FIND_NO_INSTALL_PREFIX
Exclude the values of the CMAKE_INSTALL_PREFIX and CMAKE_STAGING_PREFIX variables from
CMAKE_SYSTEM_PREFIX_PATH. CMake adds these project-destination prefixes to
CMAKE_SYSTEM_PREFIX_PATH by default in order to support building a series of dependent
packages and installing them into a common prefix. Set CMAKE_FIND_NO_INSTALL_PREFIX to
TRUE to suppress this behavior.

The CMAKE_SYSTEM_PREFIX_PATH is initialized on the first call to a project() or
enable_language() command. Therefore one must set CMAKE_FIND_NO_INSTALL_PREFIX before
this in order to take effect. A user may set the variable as a cache entry on the command
line to achieve this.

Note that the prefix(es) may still be searched for other reasons, such as being the same
prefix as the CMake installation, or for being a built-in system prefix.

CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY
Skip User Package Registry in find_package() calls.

In some cases, for example to locate only system wide installations, it is not desirable
to use the User Package Registry when searching for packages. If the
CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY variable is enabled, all the find_package()
commands will skip the User Package Registry as if they were called with the
NO_CMAKE_PACKAGE_REGISTRY argument.

See also Disabling the Package Registry.

CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY
Skip System Package Registry in find_package() calls.

In some cases, it is not desirable to use the System Package Registry when searching for
packages. If the CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY variable is enabled, all
the find_package() commands will skip the System Package Registry as if they were called
with the NO_CMAKE_SYSTEM_PACKAGE_REGISTRY argument.

See also Disabling the Package Registry.

CMAKE_FIND_PACKAGE_WARN_NO_MODULE
Tell find_package() to warn if called without an explicit mode.

If find_package() is called without an explicit mode option (MODULE, CONFIG, or NO_MODULE)
and no Find<pkg>.cmake module is in CMAKE_MODULE_PATH then CMake implicitly assumes that
the caller intends to search for a package configuration file. If no package
configuration file is found then the wording of the failure message must account for both
the case that the package is really missing and the case that the project has a bug and
failed to provide the intended Find module. If instead the caller specifies an explicit
mode option then the failure message can be more specific.

Set CMAKE_FIND_PACKAGE_WARN_NO_MODULE to TRUE to tell find_package() to warn when it
implicitly assumes Config mode. This helps developers enforce use of an explicit mode in
all calls to find_package() within a project.

CMAKE_FIND_ROOT_PATH
;-list of root paths to search on the filesystem.

This variable is most useful when cross-compiling. CMake uses the paths in this list as
alternative roots to find filesystem items with find_package(), find_library() etc.

CMAKE_FIND_ROOT_PATH_MODE_INCLUDE
This variable controls whether the CMAKE_FIND_ROOT_PATH and CMAKE_SYSROOT are used by
find_file() and find_path().

If set to ONLY, then only the roots in CMAKE_FIND_ROOT_PATH will be searched. If set to
NEVER, then the roots in CMAKE_FIND_ROOT_PATH will be ignored and only the host system
root will be used. If set to BOTH, then the host system paths and the paths in
CMAKE_FIND_ROOT_PATH will be searched.

CMAKE_FIND_ROOT_PATH_MODE_LIBRARY
This variable controls whether the CMAKE_FIND_ROOT_PATH and CMAKE_SYSROOT are used by
find_library().

CMAKE_FIND_ROOT_PATH_MODE_PACKAGE
This variable controls whether the CMAKE_FIND_ROOT_PATH and CMAKE_SYSROOT are used by
find_package().

CMAKE_FIND_ROOT_PATH_MODE_PROGRAM
This variable controls whether the CMAKE_FIND_ROOT_PATH and CMAKE_SYSROOT are used by
find_program().

CMAKE_FRAMEWORK_PATH
;-list of directories specifying a search path for OS X frameworks used by the
find_library(), find_package(), find_path(), and find_file() commands.

CMAKE_IGNORE_PATH
;-list of directories to be ignored by the find_program(), find_library(), find_file(),
and find_path() commands. This is useful in cross-compiling environments where some
system directories contain incompatible but possibly linkable libraries. For example, on
cross-compiled cluster environments, this allows a user to ignore directories containing
libraries meant for the front-end machine.

By default this is empty; it is intended to be set by the project. Note that
CMAKE_IGNORE_PATH takes a list of directory names, not a list of prefixes. To ignore
paths under prefixes (bin, include, lib, etc.), specify them explicitly.

See also the CMAKE_PREFIX_PATH, CMAKE_LIBRARY_PATH, CMAKE_INCLUDE_PATH, and
CMAKE_PROGRAM_PATH variables.

CMAKE_INCLUDE_DIRECTORIES_BEFORE
Whether to append or prepend directories by default in include_directories().

This variable affects the default behavior of the include_directories() command. Setting
this variable to ON is equivalent to using the BEFORE option in all uses of that command.

CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE
Whether to force prepending of project include directories.

This variable affects the order of include directories generated in compiler command
lines. If set to ON, it causes the CMAKE_SOURCE_DIR and the CMAKE_BINARY_DIR to appear
first.

CMAKE_INCLUDE_PATH
;-list of directories specifying a search path for the find_file() and find_path()
commands. By default it is empty, it is intended to be set by the project. See also
CMAKE_SYSTEM_INCLUDE_PATH and CMAKE_PREFIX_PATH.

CMAKE_INSTALL_DEFAULT_COMPONENT_NAME
Default component used in install() commands.

If an install() command is used without the COMPONENT argument, these files will be
grouped into a default component. The name of this default install component will be
taken from this variable. It defaults to Unspecified.

CMAKE_INSTALL_MESSAGE
Specify verbosity of installation script code generated by the install() command (using
the file(INSTALL) command). For paths that are newly installed or updated, installation
may print lines like:

-- Installing: /some/destination/path

For paths that are already up to date, installation may print lines like:

-- Up-to-date: /some/destination/path

The CMAKE_INSTALL_MESSAGE variable may be set to control which messages are printed:

ALWAYS Print both Installing and Up-to-date messages.

LAZY Print Installing but not Up-to-date messages.

NEVER Print neither Installing nor Up-to-date messages.

Other values have undefined behavior and may not be diagnosed.

If this variable is not set, the default behavior is ALWAYS.

CMAKE_INSTALL_PREFIX
Install directory used by install().

If make install is invoked or INSTALL is built, this directory is prepended onto all
install directories. This variable defaults to /usr/local on UNIX and c:/Program
Files/${PROJECT_NAME} on Windows. See CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT for how
a project might choose its own default.

On UNIX one can use the DESTDIR mechanism in order to relocate the whole installation.
DESTDIR means DESTination DIRectory. It is commonly used by makefile users in order to
install software at non-default location. It is usually invoked like this:

make DESTDIR=/home/john install

which will install the concerned software using the installation prefix, e.g. /usr/local
prepended with the DESTDIR value which finally gives /home/john/usr/local.

WARNING: DESTDIR may not be used on Windows because installation prefix usually contains a
drive letter like in C:/Program Files which cannot be prepended with some other prefix.

The installation prefix is also added to CMAKE_SYSTEM_PREFIX_PATH so that find_package(),
find_program(), find_library(), find_path(), and find_file() will search the prefix for
other software.

NOTE:
Use the GNUInstallDirs module to provide GNU-style options for the layout of
directories within the installation.

CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT
CMake sets this variable to a TRUE value when the CMAKE_INSTALL_PREFIX has just been
initialized to its default value, typically on the first run of CMake within a new build
tree. This can be used by project code to change the default without overriding a
user-provided value:

if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
set(CMAKE_INSTALL_PREFIX "/my/default" CACHE PATH "..." FORCE)
endif()

CMAKE_LIBRARY_PATH
;-list of directories specifying a search path for the find_library() command. By default
it is empty, it is intended to be set by the project. See also CMAKE_SYSTEM_LIBRARY_PATH
and CMAKE_PREFIX_PATH.

CMAKE_MFC_FLAG
Tell cmake to use MFC for an executable or dll.

This can be set in a CMakeLists.txt file and will enable MFC in the application. It
should be set to 1 for the static MFC library, and 2 for the shared MFC library. This is
used in Visual Studio project files. The CMakeSetup dialog used MFC and the
CMakeLists.txt looks like this:

add_definitions(-D_AFXDLL)
set(CMAKE_MFC_FLAG 2)
add_executable(CMakeSetup WIN32 ${SRCS})

CMAKE_MODULE_PATH
;-list of directories specifying a search path for CMake modules to be loaded by the the
include() or find_package() commands before checking the default modules that come with
CMake. By default it is empty, it is intended to be set by the project.

CMAKE_NOT_USING_CONFIG_FLAGS
Skip _BUILD_TYPE flags if true.

This is an internal flag used by the generators in CMake to tell CMake to skip the
_BUILD_TYPE flags.

CMAKE_POLICY_DEFAULT_CMP<NNNN>
Default for CMake Policy CMP<NNNN> when it is otherwise left unset.

Commands cmake_minimum_required(VERSION) and cmake_policy(VERSION) by default leave
policies introduced after the given version unset. Set CMAKE_POLICY_DEFAULT_CMP<NNNN> to
OLD or NEW to specify the default for policy CMP<NNNN>, where <NNNN> is the policy number.

This variable should not be set by a project in CMake code; use cmake_policy(SET) instead.
Users running CMake may set this variable in the cache (e.g.
-DCMAKE_POLICY_DEFAULT_CMP<NNNN>=<OLD|NEW>) to set a policy not otherwise set by the
project. Set to OLD to quiet a policy warning while using old behavior or to NEW to try
building the project with new behavior.

CMAKE_POLICY_WARNING_CMP<NNNN>
Explicitly enable or disable the warning when CMake Policy CMP<NNNN> is not set. This is
meaningful only for the few policies that do not warn by default:

• CMAKE_POLICY_WARNING_CMP0025 controls the warning for policy CMP0025.

• CMAKE_POLICY_WARNING_CMP0047 controls the warning for policy CMP0047.

• CMAKE_POLICY_WARNING_CMP0056 controls the warning for policy CMP0056.

• CMAKE_POLICY_WARNING_CMP0060 controls the warning for policy CMP0060.

• CMAKE_POLICY_WARNING_CMP0065 controls the warning for policy CMP0065.

• CMAKE_POLICY_WARNING_CMP0066 controls the warning for policy CMP0066.

• CMAKE_POLICY_WARNING_CMP0067 controls the warning for policy CMP0067.

This variable should not be set by a project in CMake code. Project developers running
CMake may set this variable in their cache to enable the warning (e.g.
-DCMAKE_POLICY_WARNING_CMP<NNNN>=ON). Alternatively, running cmake(1) with the
--debug-output, --trace, or --trace-expand option will also enable the warning.

CMAKE_PREFIX_PATH
;-list of directories specifying installation prefixes to be searched by the
find_package(), find_program(), find_library(), find_file(), and find_path() commands.
Each command will add appropriate subdirectories (like bin, lib, or include) as specified
in its own documentation.

By default this is empty. It is intended to be set by the project.

See also CMAKE_SYSTEM_PREFIX_PATH, CMAKE_INCLUDE_PATH, CMAKE_LIBRARY_PATH,
CMAKE_PROGRAM_PATH, and CMAKE_IGNORE_PATH.

CMAKE_PROGRAM_PATH
;-list of directories specifying a search path for the find_program() command. By default
it is empty, it is intended to be set by the project. See also CMAKE_SYSTEM_PROGRAM_PATH
and CMAKE_PREFIX_PATH.

CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE
A CMake language file or module to be included by the project() command. This is is
intended for injecting custom code into project builds without modifying their source.

CMAKE_SKIP_INSTALL_ALL_DEPENDENCY
Don’t make the install target depend on the all target.

By default, the install target depends on the all target. This has the effect, that when
make install is invoked or INSTALL is built, first the all target is built, then the
installation starts. If CMAKE_SKIP_INSTALL_ALL_DEPENDENCY is set to TRUE, this dependency
is not created, so the installation process will start immediately, independent from
whether the project has been completely built or not.

CMAKE_STAGING_PREFIX
This variable may be set to a path to install to when cross-compiling. This can be useful
if the path in CMAKE_SYSROOT is read-only, or otherwise should remain pristine.

The CMAKE_STAGING_PREFIX location is also used as a search prefix by the find_* commands.
This can be controlled by setting the CMAKE_FIND_NO_INSTALL_PREFIX variable.

If any RPATH/RUNPATH entries passed to the linker contain the CMAKE_STAGING_PREFIX, the
matching path fragments are replaced with the CMAKE_INSTALL_PREFIX.

CMAKE_SUBLIME_TEXT_2_ENV_SETTINGS
This variable contains a list of env vars as a list of tokens with the syntax var=value.

Example:

set(CMAKE_SUBLIME_TEXT_2_ENV_SETTINGS
"FOO=FOO1\;FOO2\;FOON"
"BAR=BAR1\;BAR2\;BARN"
"BAZ=BAZ1\;BAZ2\;BAZN"
"FOOBAR=FOOBAR1\;FOOBAR2\;FOOBARN"
"VALID="
)

In case of malformed variables CMake will fail:

set(CMAKE_SUBLIME_TEXT_2_ENV_SETTINGS
"THIS_IS_NOT_VALID"
)

CMAKE_SUBLIME_TEXT_2_EXCLUDE_BUILD_TREE
If this variable evaluates to ON at the end of the top-level CMakeLists.txt file, the
Sublime Text 2 extra generator excludes the build tree from the .sublime-project if it is
inside the source tree.

CMAKE_SYSROOT
Path to pass to the compiler in the --sysroot flag.

The CMAKE_SYSROOT content is passed to the compiler in the --sysroot flag, if supported.
The path is also stripped from the RPATH/RUNPATH if necessary on installation. The
CMAKE_SYSROOT is also used to prefix paths searched by the find_* commands.

This variable may only be set in a toolchain file specified by the CMAKE_TOOLCHAIN_FILE
variable.

See also the CMAKE_SYSROOT_COMPILE and CMAKE_SYSROOT_LINK variables.

CMAKE_SYSROOT_COMPILE
Path to pass to the compiler in the --sysroot flag when compiling source files. This is
the same as CMAKE_SYSROOT but is used only for compiling sources and not linking.

This variable may only be set in a toolchain file specified by the CMAKE_TOOLCHAIN_FILE
variable.

CMAKE_SYSROOT_LINK
Path to pass to the compiler in the --sysroot flag when linking. This is the same as
CMAKE_SYSROOT but is used only for linking and not compiling sources.

This variable may only be set in a toolchain file specified by the CMAKE_TOOLCHAIN_FILE
variable.

CMAKE_SYSTEM_APPBUNDLE_PATH
Search path for OS X application bundles used by the find_program(), and find_package()
commands. By default it contains the standard directories for the current system. It is
not intended to be modified by the project, use CMAKE_APPBUNDLE_PATH for this.

CMAKE_SYSTEM_FRAMEWORK_PATH
Search path for OS X frameworks used by the find_library(), find_package(), find_path(),
and find_file() commands. By default it contains the standard directories for the current
system. It is not intended to be modified by the project, use CMAKE_FRAMEWORK_PATH for
this.

CMAKE_SYSTEM_IGNORE_PATH
;-list of directories to be ignored by the find_program(), find_library(), find_file(),
and find_path() commands. This is useful in cross-compiling environments where some
system directories contain incompatible but possibly linkable libraries. For example, on
cross-compiled cluster environments, this allows a user to ignore directories containing
libraries meant for the front-end machine.

By default this contains a list of directories containing incompatible binaries for the
host system. See the CMAKE_IGNORE_PATH variable that is intended to be set by the
project.

See also the CMAKE_SYSTEM_PREFIX_PATH, CMAKE_SYSTEM_LIBRARY_PATH,
CMAKE_SYSTEM_INCLUDE_PATH, and CMAKE_SYSTEM_PROGRAM_PATH variables.

CMAKE_SYSTEM_INCLUDE_PATH
;-list of directories specifying a search path for the find_file() and find_path()
commands. By default this contains the standard directories for the current system. It
is not intended to be modified by the project; use CMAKE_INCLUDE_PATH for this. See also
CMAKE_SYSTEM_PREFIX_PATH.

CMAKE_SYSTEM_LIBRARY_PATH
;-list of directories specifying a search path for the find_library() command. By default
this contains the standard directories for the current system. It is not intended to be
modified by the project; use CMAKE_LIBRARY_PATH for this. See also
CMAKE_SYSTEM_PREFIX_PATH.

CMAKE_SYSTEM_PREFIX_PATH
;-list of directories specifying installation prefixes to be searched by the
find_package(), find_program(), find_library(), find_file(), and find_path() commands.
Each command will add appropriate subdirectories (like bin, lib, or include) as specified
in its own documentation.

By default this contains the standard directories for the current system, the
CMAKE_INSTALL_PREFIX, and the CMAKE_STAGING_PREFIX. The installation and staging prefixes
may be excluded by setting the CMAKE_FIND_NO_INSTALL_PREFIX variable.

CMAKE_SYSTEM_PREFIX_PATH is not intended to be modified by the project; use
CMAKE_PREFIX_PATH for this.

See also CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_SYSTEM_LIBRARY_PATH, CMAKE_SYSTEM_PROGRAM_PATH,
and CMAKE_SYSTEM_IGNORE_PATH.

CMAKE_SYSTEM_PROGRAM_PATH
;-list of directories specifying a search path for the find_program() command. By default
this contains the standard directories for the current system. It is not intended to be
modified by the project; use CMAKE_PROGRAM_PATH for this. See also
CMAKE_SYSTEM_PREFIX_PATH.

CMAKE_USER_MAKE_RULES_OVERRIDE
Specify a CMake file that overrides platform information.

CMake loads the specified file while enabling support for each language from either the
project() or enable_language() commands. It is loaded after CMake’s builtin compiler and
platform information modules have been loaded but before the information is used. The
file may set platform information variables to override CMake’s defaults.

This feature is intended for use only in overriding information variables that must be set
before CMake builds its first test project to check that the compiler for a language
works. It should not be used to load a file in cases that a normal include() will work.
Use it only as a last resort for behavior that cannot be achieved any other way. For
example, one may set the CMAKE_C_FLAGS_INIT variable to change the default value used to
initialize the CMAKE_C_FLAGS variable before it is cached. The override file should NOT
be used to set anything that could be set after languages are enabled, such as variables
like CMAKE_RUNTIME_OUTPUT_DIRECTORY that affect the placement of binaries. Information
set in the file will be used for try_compile() and try_run() builds too.

CMAKE_WARN_DEPRECATED
Whether to issue warnings for deprecated functionality.

If not FALSE, use of deprecated functionality will issue warnings. If this variable is
not set, CMake behaves as if it were set to TRUE.

When running cmake(1), this option can be enabled with the -Wdeprecated option, or
disabled with the -Wno-deprecated option.

CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION
Ask cmake_install.cmake script to warn each time a file with absolute INSTALL DESTINATION
is encountered.

This variable is used by CMake-generated cmake_install.cmake scripts. If one sets this
variable to ON while running the script, it may get warning messages from the script.

VARIABLES THAT DESCRIBE THE SYSTEM

ANDROID
Set to 1 when the target system (CMAKE_SYSTEM_NAME) is Android.

APPLE
Set to True when the target system is an Apple platform (macOS, iOS, tvOS or watchOS).

BORLAND
True if the Borland compiler is being used.

This is set to true if the Borland compiler is being used.

CMAKE_CL_64
Discouraged. Use CMAKE_SIZEOF_VOID_P instead.

Set to a true value when using a Microsoft Visual Studio cl compiler that targets a 64-bit
architecture.

CMAKE_COMPILER_2005
Using the Visual Studio 2005 compiler from Microsoft

Set to true when using the Visual Studio 2005 compiler from Microsoft.

CMAKE_HOST_APPLE
True for Apple OS X operating systems.

Set to true when the host system is Apple OS X.

CMAKE_HOST_SOLARIS
True for Oracle Solaris operating systems.

Set to true when the host system is Oracle Solaris.

CMAKE_HOST_SYSTEM
Composit Name of OS CMake is being run on.

This variable is the composite of CMAKE_HOST_SYSTEM_NAME and CMAKE_HOST_SYSTEM_VERSION,
e.g. ${CMAKE_HOST_SYSTEM_NAME}-${CMAKE_HOST_SYSTEM_VERSION}. If
CMAKE_HOST_SYSTEM_VERSION is not set, then this variable is the same as
CMAKE_HOST_SYSTEM_NAME.

CMAKE_HOST_SYSTEM_NAME
Name of the OS CMake is running on.

On systems that have the uname command, this variable is set to the output of uname -s.
Linux, Windows, and Darwin for OS X are the values found on the big three operating
systems.

CMAKE_HOST_SYSTEM_PROCESSOR
The name of the CPU CMake is running on.

On systems that support uname, this variable is set to the output of uname -p. On Windows
it is set to the value of the environment variable PROCESSOR_ARCHITECTURE.

CMAKE_HOST_SYSTEM_VERSION
The OS version CMake is running on.

A numeric version string for the system. On systems that support uname, this variable is
set to the output of uname -r. On other systems this is set to major-minor version
numbers.

CMAKE_HOST_UNIX
True for UNIX and UNIX like operating systems.

Set to true when the host system is UNIX or UNIX like (i.e. APPLE and CYGWIN).

CMAKE_HOST_WIN32
True if the host system is running Windows, including Windows 64-bit and MSYS.

Set to false on Cygwin.

CMAKE_LIBRARY_ARCHITECTURE
Target architecture library directory name, if detected.

This is the value of CMAKE_<LANG>_LIBRARY_ARCHITECTURE as detected for one of the enabled
languages.

CMAKE_LIBRARY_ARCHITECTURE_REGEX
Regex matching possible target architecture library directory names.

This is used to detect CMAKE_<LANG>_LIBRARY_ARCHITECTURE from the implicit linker search
path by matching the <arch> name.

CMAKE_OBJECT_PATH_MAX
Maximum object file full-path length allowed by native build tools.

CMake computes for every source file an object file name that is unique to the source file
and deterministic with respect to the full path to the source file. This allows multiple
source files in a target to share the same name if they lie in different directories
without rebuilding when one is added or removed. However, it can produce long full paths
in a few cases, so CMake shortens the path using a hashing scheme when the full path to an
object file exceeds a limit. CMake has a built-in limit for each platform that is
sufficient for common tools, but some native tools may have a lower limit. This variable
may be set to specify the limit explicitly. The value must be an integer no less than
128.

CMAKE_SYSTEM
Composite name of operating system CMake is compiling for.

This variable is the composite of CMAKE_SYSTEM_NAME and CMAKE_SYSTEM_VERSION, e.g.
${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}. If CMAKE_SYSTEM_VERSION is not set, then
this variable is the same as CMAKE_SYSTEM_NAME.

CMAKE_SYSTEM_NAME
The name of the operating system for which CMake is to build. See the
CMAKE_SYSTEM_VERSION variable for the OS version.

System Name for Host Builds
CMAKE_SYSTEM_NAME is by default set to the same value as the CMAKE_HOST_SYSTEM_NAME
variable so that the build targets the host system.

System Name for Cross Compiling
CMAKE_SYSTEM_NAME may be set explicitly when first configuring a new build tree in order
to enable cross compiling. In this case the CMAKE_SYSTEM_VERSION variable must also be
set explicitly.

CMAKE_SYSTEM_PROCESSOR
The name of the CPU CMake is building for.

This variable is the same as CMAKE_HOST_SYSTEM_PROCESSOR if you build for the host system
instead of the target system when cross compiling.

• The Green Hills MULTI generator sets this to ARM by default.

CMAKE_SYSTEM_VERSION
The version of the operating system for which CMake is to build. See the
CMAKE_SYSTEM_NAME variable for the OS name.

System Version for Host Builds
When the CMAKE_SYSTEM_NAME variable takes its default value then CMAKE_SYSTEM_VERSION is
by default set to the same value as the CMAKE_HOST_SYSTEM_VERSION variable so that the
build targets the host system version.

In the case of a host build then CMAKE_SYSTEM_VERSION may be set explicitly when first
configuring a new build tree in order to enable targeting the build for a different
version of the host operating system than is actually running on the host. This is
allowed and not considered cross compiling so long as the binaries built for the specified
OS version can still run on the host.

System Version for Cross Compiling
When the CMAKE_SYSTEM_NAME variable is set explicitly to enable cross compiling then the
value of CMAKE_SYSTEM_VERSION must also be set explicitly to specify the target system
version.

CYGWIN
True for Cygwin.

Set to true when using Cygwin.

ENV
Access environment variables.

Use the syntax $ENV{VAR} to read environment variable VAR. See also the set() command to
set ENV{VAR}.

GHS-MULTI
True when using Green Hills MULTI

MINGW
True when using MinGW

Set to true when the compiler is some version of MinGW.

MSVC
True when using Microsoft Visual C++.

Set to true when the compiler is some version of Microsoft Visual C++.

VARIABLES THAT CONTROL THE BUILD

CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS
Default value for the ANDROID_ANT_ADDITIONAL_OPTIONS target property. See that target
property for additional information.

CMAKE_ANDROID_API
When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this
variable may be set to specify the default value for the ANDROID_API target property. See
that target property for additional information.

Otherwise, when Cross Compiling for Android, this variable provides the Android API
version number targeted. This will be the same value as the CMAKE_SYSTEM_VERSION variable
for Android platforms.

CMAKE_ANDROID_API_MIN
Default value for the ANDROID_API_MIN target property. See that target property for
additional information.

CMAKE_ANDROID_ARCH
When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this
variable may be set to specify the default value for the ANDROID_ARCH target property.
See that target property for additional information.

Otherwise, when Cross Compiling for Android, this variable provides the name of the
Android architecture corresponding to the value of the CMAKE_ANDROID_ARCH_ABI variable.
The architecture name may be one of:

• arm

• arm64

• mips

• mips64

• x86

• x86_64

CMAKE_ANDROID_ARCH_ABI
When Cross Compiling for Android, this variable specifies the target architecture and ABI
to be used. Valid values are:

• arm64-v8a

• armeabi-v7a

• armeabi-v6

• armeabi

• mips

• mips64

• x86

• x86_64

See also the CMAKE_ANDROID_ARM_MODE and CMAKE_ANDROID_ARM_NEON variables.

CMAKE_ANDROID_ARM_MODE
When Cross Compiling for Android and CMAKE_ANDROID_ARCH_ABI is set to one of the armeabi
architectures, set CMAKE_ANDROID_ARM_MODE to ON to target 32-bit ARM processors (-marm).
Otherwise, the default is to target the 16-bit Thumb processors (-mthumb).

CMAKE_ANDROID_ARM_NEON
When Cross Compiling for Android and CMAKE_ANDROID_ARCH_ABI is set to armeabi-v7a set
CMAKE_ANDROID_ARM_NEON to ON to target ARM NEON devices.

CMAKE_ANDROID_ASSETS_DIRECTORIES
Default value for the ANDROID_ASSETS_DIRECTORIES target property. See that target
property for additional information.

CMAKE_ANDROID_GUI
Default value for the ANDROID_GUI target property of executables. See that target
property for additional information.

CMAKE_ANDROID_JAR_DEPENDENCIES
Default value for the ANDROID_JAR_DEPENDENCIES target property. See that target property
for additional information.

CMAKE_ANDROID_JAR_DIRECTORIES
Default value for the ANDROID_JAR_DIRECTORIES target property. See that target property
for additional information.

CMAKE_ANDROID_JAVA_SOURCE_DIR
Default value for the ANDROID_JAVA_SOURCE_DIR target property. See that target property
for additional information.

CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES
Default value for the ANDROID_NATIVE_LIB_DEPENDENCIES target property. See that target
property for additional information.

CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES
Default value for the ANDROID_NATIVE_LIB_DIRECTORIES target property. See that target
property for additional information.

CMAKE_ANDROID_NDK
When Cross Compiling for Android with the NDK, this variable holds the absolute path to
the root directory of the NDK. The directory must contain a platforms subdirectory
holding the android-<api> directories.

CMAKE_ANDROID_NDK_DEPRECATED_HEADERS
When Cross Compiling for Android with the NDK, this variable may be set to specify whether
to use the deprecated per-api-level headers instead of the unified headers.

If not specified, the default will be false if using a NDK version that provides the
unified headers and true otherwise.

CMAKE_ANDROID_NDK_TOOLCHAIN_HOST_TAG
When Cross Compiling for Android with the NDK, this variable provides the NDK’s “host tag”
used to construct the path to prebuilt toolchains that run on the host.

CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION
When Cross Compiling for Android with the NDK, this variable may be set to specify the
version of the toolchain to be used as the compiler. The variable must be set to one of
these forms:

• <major>.<minor>: GCC of specified version

• clang<major>.<minor>: Clang of specified version

• clang: Clang of most recent available version

A toolchain of the requested version will be selected automatically to match the ABI named
in the CMAKE_ANDROID_ARCH_ABI variable.

If not specified, the default will be a value that selects the latest available GCC
toolchain.

CMAKE_ANDROID_PROCESS_MAX
Default value for the ANDROID_PROCESS_MAX target property. See that target property for
additional information.

CMAKE_ANDROID_PROGUARD
Default value for the ANDROID_PROGUARD target property. See that target property for
additional information.

CMAKE_ANDROID_PROGUARD_CONFIG_PATH
Default value for the ANDROID_PROGUARD_CONFIG_PATH target property. See that target
property for additional information.

CMAKE_ANDROID_SECURE_PROPS_PATH
Default value for the ANDROID_SECURE_PROPS_PATH target property. See that target property
for additional information.

CMAKE_ANDROID_SKIP_ANT_STEP
Default value for the ANDROID_SKIP_ANT_STEP target property. See that target property for
additional information.

CMAKE_ANDROID_STANDALONE_TOOLCHAIN
When Cross Compiling for Android with a Standalone Toolchain, this variable holds the
absolute path to the root directory of the toolchain. The specified directory must
contain a sysroot subdirectory.

CMAKE_ANDROID_STL_TYPE
When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this
variable may be set to specify the default value for the ANDROID_STL_TYPE target property.
See that target property for additional information.

When Cross Compiling for Android with the NDK, this variable may be set to specify the STL
variant to be used. The value may be one of:

none No C++ Support

system Minimal C++ without STL

gabi++_static
GAbi++ Static

gabi++_shared
GAbi++ Shared

gnustl_static
GNU libstdc++ Static

gnustl_shared
GNU libstdc++ Shared

c++_static
LLVM libc++ Static

c++_shared
LLVM libc++ Shared

stlport_static
STLport Static

stlport_shared
STLport Shared

The default value is gnustl_static. Note that this default differs from the native NDK
build system because CMake may be used to build projects for Android that are not natively
implemented for it and use the C++ standard library.

CMAKE_ARCHIVE_OUTPUT_DIRECTORY
Where to put all the ARCHIVE target files when built.

This variable is used to initialize the ARCHIVE_OUTPUT_DIRECTORY property on all the
targets. See that target property for additional information.

CMAKE_ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>
Where to put all the ARCHIVE target files when built for a specific configuration.

This variable is used to initialize the ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> property on all
the targets. See that target property for additional information.

CMAKE_AUTOMOC
Whether to handle moc automatically for Qt targets.

This variable is used to initialize the AUTOMOC property on all the targets. See that
target property for additional information.

CMAKE_AUTOMOC_COMPILER_PREDEFINES
This variable is used to initialize the AUTOMOC_COMPILER_PREDEFINES property on all the
targets. See that target property for additional information.

By default it is ON.

CMAKE_AUTOMOC_DEPEND_FILTERS
Filter definitions used by CMAKE_AUTOMOC to extract file names from source code as
additional dependencies for the moc file.

This variable is used to initialize the AUTOMOC_DEPEND_FILTERS property on all the
targets. See that target property for additional information.

By default it is empty.

CMAKE_AUTOMOC_MACRO_NAMES
A ;-list list of macro names used by CMAKE_AUTOMOC to determine if a C++ file needs to be
processed by moc.

This variable is used to initialize the AUTOMOC_MACRO_NAMES property on all the targets.
See that target property for additional information.

The default value is Q_OBJECT;Q_GADGET;Q_NAMESPACE.

Example
Let CMake know that source files that contain CUSTOM_MACRO must be moc processed as well:

set(CMAKE_AUTOMOC ON)
list(APPEND CMAKE_AUTOMOC_MACRO_NAMES "CUSTOM_MACRO")

CMAKE_AUTOMOC_MOC_OPTIONS
Additional options for moc when using CMAKE_AUTOMOC.

This variable is used to initialize the AUTOMOC_MOC_OPTIONS property on all the targets.
See that target property for additional information.

CMAKE_AUTORCC
Whether to handle rcc automatically for Qt targets.

This variable is used to initialize the AUTORCC property on all the targets. See that
target property for additional information.

CMAKE_AUTORCC_OPTIONS
Additional options for rcc when using CMAKE_AUTORCC.

This variable is used to initialize the AUTORCC_OPTIONS property on all the targets. See
that target property for additional information.

EXAMPLE
# ...
set(CMAKE_AUTORCC_OPTIONS "--compress;9")
# ...

CMAKE_AUTOUIC
Whether to handle uic automatically for Qt targets.

This variable is used to initialize the AUTOUIC property on all the targets. See that
target property for additional information.

CMAKE_AUTOUIC_OPTIONS
Additional options for uic when using CMAKE_AUTOUIC.

This variable is used to initialize the AUTOUIC_OPTIONS property on all the targets. See
that target property for additional information.

EXAMPLE
# ...
set_property(CMAKE_AUTOUIC_OPTIONS "--no-protection")
# ...

CMAKE_AUTOUIC_SEARCH_PATHS
Search path list used by CMAKE_AUTOUIC to find included .ui files.

This variable is used to initialize the AUTOUIC_SEARCH_PATHS property on all the targets.
See that target property for additional information.

By default it is empty.

CMAKE_BUILD_RPATH
A ;-list specifying runtime path (RPATH) entries to add to binaries linked in the build
tree (for platforms that support it). The entries will not be used for binaries in the
install tree. See also the CMAKE_INSTALL_RPATH variable.

This is used to initialize the BUILD_RPATH target property for all targets.

CMAKE_BUILD_WITH_INSTALL_NAME_DIR
Whether to use INSTALL_NAME_DIR on targets in the build tree.

This variable is used to initialize the BUILD_WITH_INSTALL_NAME_DIR property on all
targets.

CMAKE_BUILD_WITH_INSTALL_RPATH
Use the install path for the RPATH.

CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY
Output directory for MS debug symbol .pdb files generated by the compiler while building
source files.

This variable is used to initialize the COMPILE_PDB_OUTPUT_DIRECTORY property on all the
targets.

CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG>
Per-configuration output directory for MS debug symbol .pdb files generated by the
compiler while building source files.

This is a per-configuration version of CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY. This variable
is used to initialize the COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG> property on all the
targets.

CMAKE_<CONFIG>_POSTFIX
Default filename postfix for libraries under configuration <CONFIG>.

When a non-executable target is created its <CONFIG>_POSTFIX target property is
initialized with the value of this variable if it is set.

CMAKE_DEBUG_POSTFIX
See variable CMAKE_<CONFIG>_POSTFIX.

This variable is a special case of the more-general CMAKE_<CONFIG>_POSTFIX variable for
the DEBUG configuration.

CMAKE_ENABLE_EXPORTS
Specify whether an executable exports symbols for loadable modules.

Normally an executable does not export any symbols because it is the final program. It is
possible for an executable to export symbols to be used by loadable modules. When this
property is set to true CMake will allow other targets to link to the executable with the
TARGET_LINK_LIBRARIES() command. On all platforms a target-level dependency on the
executable is created for targets that link to it. For DLL platforms an import library
will be created for the exported symbols and then used for linking. All Windows-based
systems including Cygwin are DLL platforms. For non-DLL platforms that require all
symbols to be resolved at link time, such as OS X, the module will link to the executable
using a flag like -bundle_loader. For other non-DLL platforms the link rule is simply
ignored since the dynamic loader will automatically bind symbols when the module is
loaded.

This variable is used to initialize the target property ENABLE_EXPORTS for executable
targets.

CMAKE_EXE_LINKER_FLAGS
Linker flags to be used to create executables.

These flags will be used by the linker when creating an executable.

CMAKE_EXE_LINKER_FLAGS_<CONFIG>
Flags to be used when linking an executable.

Same as CMAKE_C_FLAGS_* but used by the linker when creating executables.

CMAKE_EXE_LINKER_FLAGS_<CONFIG>_INIT
Value used to initialize the CMAKE_EXE_LINKER_FLAGS_<CONFIG> cache entry the first time a
build tree is configured. This variable is meant to be set by a toolchain file. CMake
may prepend or append content to the value based on the environment and target platform.

VARIABLES FOR LANGUAGES

   CMAKE_COMPILER_IS_GNUCC
       True if the C compiler is GNU.  Use CMAKE_C_COMPILER_ID instead.

   CMAKE_COMPILER_IS_GNUCXX
       True if the C++ (CXX) compiler is GNU.  Use CMAKE_CXX_COMPILER_ID instead.

   CMAKE_COMPILER_IS_GNUG77
       True if the Fortran compiler is GNU.  Use CMAKE_Fortran_COMPILER_ID instead.

   CMAKE_CUDA_HOST_COMPILER
       Executable to use when compiling host code when compiling CUDA language files. Maps to the
       nvcc -ccbin option.  Will only be used by CMake on the first configuration to determine  a
       valid  host  compiler  for CUDA. After a valid host compiler has been found, this value is
       read-only.

   CMAKE_CUDA_EXTENSIONS
       Default value for CUDA_EXTENSIONS property of targets.

       This variable is used to initialize the CUDA_EXTENSIONS property on all targets.  See that
       target property for additional information.

       See the cmake-compile-features(7) manual for information on compile features and a list of
       supported compilers.

   CMAKE_CUDA_STANDARD
       Default value for CUDA_STANDARD property of targets.

       This variable is used to initialize the CUDA_STANDARD property on all targets.   See  that
       target property for additional information.

       See the cmake-compile-features(7) manual for information on compile features and a list of
       supported compilers.

   CMAKE_CUDA_STANDARD_REQUIRED
       Default value for CUDA_STANDARD_REQUIRED property of targets.

       This variable is used to initialize the CUDA_STANDARD_REQUIRED property  on  all  targets.
       See that target property for additional information.

       See the cmake-compile-features(7) manual for information on compile features and a list of
       supported compilers.

   CMAKE_CUDA_TOOLKIT_INCLUDE_DIRECTORIES
       When the CUDA language has been enabled, this provides a  ;-list  of  include  directories
       provided  by  the  CUDA  Toolkit.  The value may be useful for C++ source files to include
       CUDA headers.

   CMAKE_CXX_COMPILE_FEATURES
       List of features known to the C++ compiler

       These features are known to be available for use with the C++ compiler.  This  list  is  a
       subset of the features listed in the CMAKE_CXX_KNOWN_FEATURES global property.

       See the cmake-compile-features(7) manual for information on compile features and a list of
       supported compilers.

   CMAKE_CXX_EXTENSIONS
       Default value for CXX_EXTENSIONS property of targets.

       This variable is used to initialize the CXX_EXTENSIONS property on all targets.  See  that
       target property for additional information.

       See the cmake-compile-features(7) manual for information on compile features and a list of
       supported compilers.

   CMAKE_CXX_STANDARD
       Default value for CXX_STANDARD property of targets.

       This variable is used to initialize the CXX_STANDARD property on all  targets.   See  that
       target property for additional information.

       See the cmake-compile-features(7) manual for information on compile features and a list of
       supported compilers.

   CMAKE_CXX_STANDARD_REQUIRED
       Default value for CXX_STANDARD_REQUIRED property of targets.

       This variable is used to initialize the CXX_STANDARD_REQUIRED  property  on  all  targets.
       See that target property for additional information.

       See the cmake-compile-features(7) manual for information on compile features and a list of
       supported compilers.

   CMAKE_C_COMPILE_FEATURES
       List of features known to the C compiler

       These features are known to be available for use with the  C  compiler.  This  list  is  a
       subset of the features listed in the CMAKE_C_KNOWN_FEATURES global property.

       See the cmake-compile-features(7) manual for information on compile features and a list of
       supported compilers.

   CMAKE_C_EXTENSIONS
       Default value for C_EXTENSIONS property of targets.

       This variable is used to initialize the C_EXTENSIONS property on all  targets.   See  that
       target property for additional information.

       See the cmake-compile-features(7) manual for information on compile features and a list of
       supported compilers.

   CMAKE_C_STANDARD
       Default value for C_STANDARD property of targets.

       This variable is used to initialize the C_STANDARD property  on  all  targets.   See  that
       target property for additional information.

       See the cmake-compile-features(7) manual for information on compile features and a list of
       supported compilers.

   CMAKE_C_STANDARD_REQUIRED
       Default value for C_STANDARD_REQUIRED property of targets.

       This variable is used to initialize the C_STANDARD_REQUIRED property on all targets.   See
       that target property for additional information.

       See the cmake-compile-features(7) manual for information on compile features and a list of
       supported compilers.

   CMAKE_Fortran_MODDIR_DEFAULT
       Fortran default module output directory.

       Most Fortran compilers write .mod files to the current working directory.  For those  that
       do not, this is set to . and used when the Fortran_MODULE_DIRECTORY target property is not
       set.

   CMAKE_Fortran_MODDIR_FLAG
       Fortran flag for module output directory.

       This stores the flag needed to pass  the  value  of  the  Fortran_MODULE_DIRECTORY  target
       property to the compiler.

   CMAKE_Fortran_MODOUT_FLAG
       Fortran flag to enable module output.

       Most  Fortran compilers write .mod files out by default.  For others, this stores the flag
       needed to enable module output.

   CMAKE_INTERNAL_PLATFORM_ABI
       An internal variable subject to change.

       This is used in determining the compiler ABI and is subject to change.

   CMAKE_<LANG>_ANDROID_TOOLCHAIN_MACHINE
       When Cross Compiling for Android this variable contains  the  toolchain  binutils  machine
       name  (e.g.  gcc  -dumpmachine).  The binutils typically have a <machine>- prefix on their
       name.

       See also CMAKE_<LANG>_ANDROID_TOOLCHAIN_PREFIX and CMAKE_<LANG>_ANDROID_TOOLCHAIN_SUFFIX.

   CMAKE_<LANG>_ANDROID_TOOLCHAIN_PREFIX
       When Cross Compiling for Android this variable contains the absolute  path  prefixing  the
       toolchain GNU compiler and its binutils.

       See also CMAKE_<LANG>_ANDROID_TOOLCHAIN_SUFFIX and CMAKE_<LANG>_ANDROID_TOOLCHAIN_MACHINE.

       For example, the path to the linker is:

          ${CMAKE_CXX_ANDROID_TOOLCHAIN_PREFIX}ld${CMAKE_CXX_ANDROID_TOOLCHAIN_SUFFIX}

   CMAKE_<LANG>_ANDROID_TOOLCHAIN_SUFFIX
       When  Cross  Compiling  for Android this variable contains the host platform suffix of the
       toolchain GNU compiler and its binutils.

       See also CMAKE_<LANG>_ANDROID_TOOLCHAIN_PREFIX and CMAKE_<LANG>_ANDROID_TOOLCHAIN_MACHINE.

   CMAKE_<LANG>_ARCHIVE_APPEND
       Rule variable to append to a static archive.

       This is a rule variable that tells CMake how to append to a static archive.  It is used in
       place  of  CMAKE_<LANG>_CREATE_STATIC_LIBRARY  on some platforms in order to support large
       object counts.  See also CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_FINISH.

   CMAKE_<LANG>_ARCHIVE_CREATE
       Rule variable to create a new static archive.

       This is a rule variable that tells CMake how to create a static archive.  It  is  used  in
       place  of  CMAKE_<LANG>_CREATE_STATIC_LIBRARY  on some platforms in order to support large
       object counts.  See also CMAKE_<LANG>_ARCHIVE_APPEND and CMAKE_<LANG>_ARCHIVE_FINISH.

   CMAKE_<LANG>_ARCHIVE_FINISH
       Rule variable to finish an existing static archive.

       This is a rule variable that tells CMake how to finish a static archive.  It  is  used  in
       place  of  CMAKE_<LANG>_CREATE_STATIC_LIBRARY  on some platforms in order to support large
       object counts.  See also CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_APPEND.

   CMAKE_<LANG>_COMPILER
       The full path to the compiler for LANG.

       This is the command that will be used as the <LANG>  compiler.   Once  set,  you  can  not
       change this variable.

   CMAKE_<LANG>_COMPILER_ABI
       An internal variable subject to change.

       This is used in determining the compiler ABI and is subject to change.

   CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID
       An internal variable subject to change.

       This  is used to identify the variant of a compiler based on its target architecture.  For
       some compilers this is needed to determine the correct usage.

   CMAKE_<LANG>_COMPILER_EXTERNAL_TOOLCHAIN
       The external toolchain for cross-compiling, if supported.

       Some compiler toolchains do not ship their own auxiliary utilities such as  archivers  and
       linkers.   The compiler driver may support a command-line argument to specify the location
       of such tools.  CMAKE_<LANG>_COMPILER_EXTERNAL_TOOLCHAIN may be set to a path to a path to
       the external toolchain and will be passed to the compiler driver if supported.

       This  variable  may  only be set in a toolchain file specified by the CMAKE_TOOLCHAIN_FILE
       variable.

   CMAKE_<LANG>_COMPILER_ID
       Compiler identification string.

       A short string unique to the compiler vendor.  Possible values include:

          Absoft = Absoft Fortran (absoft.com)
          ADSP = Analog VisualDSP++ (analog.com)
          AppleClang = Apple Clang (apple.com)
          ARMCC = ARM Compiler (arm.com)
          Bruce = Bruce C Compiler
          CCur = Concurrent Fortran (ccur.com)
          Clang = LLVM Clang (clang.llvm.org)
          Cray = Cray Compiler (cray.com)
          Embarcadero, Borland = Embarcadero (embarcadero.com)
          G95 = G95 Fortran (g95.org)
          GNU = GNU Compiler Collection (gcc.gnu.org)
          HP = Hewlett-Packard Compiler (hp.com)
          IAR = IAR Systems (iar.com)
          Intel = Intel Compiler (intel.com)
          MIPSpro = SGI MIPSpro (sgi.com)
          MSVC = Microsoft Visual Studio (microsoft.com)
          NVIDIA = NVIDIA CUDA Compiler (nvidia.com)
          OpenWatcom = Open Watcom (openwatcom.org)
          PGI = The Portland Group (pgroup.com)
          Flang = Flang Fortran Compiler
          PathScale = PathScale (pathscale.com)
          SDCC = Small Device C Compiler (sdcc.sourceforge.net)
          SunPro = Oracle Solaris Studio (oracle.com)
          TI = Texas Instruments (ti.com)
          TinyCC = Tiny C Compiler (tinycc.org)
          XL, VisualAge, zOS = IBM XL (ibm.com)

       This variable is not guaranteed to be defined for all compilers or languages.

   CMAKE_<LANG>_COMPILER_LOADED
       Defined to true if the language is enabled.

       When language <LANG> is enabled by project() or enable_language() this variable is defined
       to 1.

   CMAKE_<LANG>_COMPILER_PREDEFINES_COMMAND
       Command that outputs the compiler pre definitions.

       See   AUTOMOC   which   uses   CMAKE_CXX_COMPILER_PREDEFINES_COMMAND   to   generate   the
       AUTOMOC_COMPILER_PREDEFINES.

   CMAKE_<LANG>_COMPILER_TARGET
       The target for cross-compiling, if supported.

       Some compiler drivers are inherently cross-compilers, such as clang  and  QNX  qcc.  These
       compiler  drivers  support  a command-line argument to specify the target to cross-compile
       for.

       This variable may only be set in a toolchain file specified  by  the  CMAKE_TOOLCHAIN_FILE
       variable.

   CMAKE_<LANG>_COMPILER_VERSION
       Compiler version string.

       Compiler version in major[.minor[.patch[.tweak]]] format.  This variable is not guaranteed
       to be defined for all compilers or languages.

       For example CMAKE_C_COMPILER_VERSION and  CMAKE_CXX_COMPILER_VERSION  might  indicate  the
       respective C and C++ compiler version.

   CMAKE_<LANG>_COMPILER_VERSION_INTERNAL
       An internal variable subject to change.

       This  is  used  to identify the variant of a compiler based on an internal version number.
       For some compilers this is needed to determine the correct usage.

   CMAKE_<LANG>_COMPILE_OBJECT
       Rule variable to compile a single object file.

       This is a rule variable that tells CMake how to compile  a  single  object  file  for  the
       language <LANG>.

   CMAKE_<LANG>_CREATE_SHARED_LIBRARY
       Rule variable to create a shared library.

       This  is  a rule variable that tells CMake how to create a shared library for the language
       <LANG>.

   CMAKE_<LANG>_CREATE_SHARED_MODULE
       Rule variable to create a shared module.

       This is a rule variable that tells CMake how to create a shared library for  the  language
       <LANG>.

   CMAKE_<LANG>_CREATE_STATIC_LIBRARY
       Rule variable to create a static library.

       This  is  a rule variable that tells CMake how to create a static library for the language
       <LANG>.

   CMAKE_<LANG>_FLAGS
       Flags for all build types.

       <LANG> flags used regardless of the value of CMAKE_BUILD_TYPE.

   CMAKE_<LANG>_FLAGS_DEBUG
       Flags for Debug build type or configuration.

       <LANG> flags used when CMAKE_BUILD_TYPE is Debug.

   CMAKE_<LANG>_FLAGS_DEBUG_INIT
       Value used to initialize the CMAKE_<LANG>_FLAGS_DEBUG cache entry the first time  a  build
       tree  is  configured for language <LANG>.  This variable is meant to be set by a toolchain
       file.  CMake may prepend or append content to the  value  based  on  the  environment  and
       target platform.

       See also CMAKE_<LANG>_FLAGS_INIT.

   CMAKE_<LANG>_FLAGS_INIT
       Value used to initialize the CMAKE_<LANG>_FLAGS cache entry the first time a build tree is
       configured for language <LANG>.  This variable is meant to be set  by  a  toolchain  file.
       CMake  may  prepend  or  append  content  to the value based on the environment and target
       platform.

       See also the configuration-specific variables:

       • CMAKE_<LANG>_FLAGS_DEBUG_INIT

       • CMAKE_<LANG>_FLAGS_RELEASE_INIT

       • CMAKE_<LANG>_FLAGS_MINSIZEREL_INIT

       • CMAKE_<LANG>_FLAGS_RELWITHDEBINFO_INIT

   CMAKE_<LANG>_FLAGS_MINSIZEREL
       Flags for MinSizeRel build type or configuration.

       <LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel (short for minimum size release).

   CMAKE_<LANG>_FLAGS_MINSIZEREL_INIT
       Value used to initialize the CMAKE_<LANG>_FLAGS_MINSIZEREL cache entry the  first  time  a
       build  tree  is  configured  for  language  <LANG>.  This variable is meant to be set by a
       toolchain file.  CMake may prepend or append content to the value based on the environment
       and target platform.

       See also CMAKE_<LANG>_FLAGS_INIT.

   CMAKE_<LANG>_FLAGS_RELEASE
       Flags for Release build type or configuration.

       <LANG> flags used when CMAKE_BUILD_TYPE is Release.

   CMAKE_<LANG>_FLAGS_RELEASE_INIT
       Value used to initialize the CMAKE_<LANG>_FLAGS_RELEASE cache entry the first time a build
       tree is configured for language <LANG>.  This variable is meant to be set by  a  toolchain
       file.   CMake  may  prepend  or  append  content to the value based on the environment and
       target platform.

       See also CMAKE_<LANG>_FLAGS_INIT.

   CMAKE_<LANG>_FLAGS_RELWITHDEBINFO
       Flags for RelWithDebInfo type or configuration.

       <LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo (short for  Release  With  Debug
       Information).

   CMAKE_<LANG>_FLAGS_RELWITHDEBINFO_INIT
       Value  used to initialize the CMAKE_<LANG>_FLAGS_RELWITHDEBINFO cache entry the first time
       a build tree is configured for language <LANG>.  This variable is meant to  be  set  by  a
       toolchain file.  CMake may prepend or append content to the value based on the environment
       and target platform.

       See also CMAKE_<LANG>_FLAGS_INIT.

   CMAKE_<LANG>_GHS_KERNEL_FLAGS_DEBUG
       GHS kernel flags for Debug build type or configuration.

       <LANG> flags used when CMAKE_BUILD_TYPE is Debug.

   CMAKE_<LANG>_GHS_KERNEL_FLAGS_MINSIZEREL
       GHS kernel flags for MinSizeRel build type or configuration.

       <LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel (short for minimum size release).

   CMAKE_<LANG>_GHS_KERNEL_FLAGS_RELEASE
       GHS kernel flags for Release build type or configuration.

       <LANG> flags used when CMAKE_BUILD_TYPE is Release.

   CMAKE_<LANG>_GHS_KERNEL_FLAGS_RELWITHDEBINFO
       GHS kernel flags for RelWithDebInfo type or configuration.

       <LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo (short for  Release  With  Debug
       Information).

   CMAKE_<LANG>_IGNORE_EXTENSIONS
       File extensions that should be ignored by the build.

       This  is  a list of file extensions that may be part of a project for a given language but
       are not compiled.

   CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES
       Directories implicitly searched by the compiler for header files.

       CMake does not explicitly specify these directories on compiler command lines for language
       <LANG>.   This  prevents  system  include  directories  from being treated as user include
       directories on some compilers.

   CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES
       Implicit linker search path detected for language <LANG>.

       Compilers typically pass directories containing language  runtime  libraries  and  default
       library  search  paths  when they invoke a linker.  These paths are implicit linker search
       directories for the compiler’s language.  CMake automatically  detects  these  directories
       for each language and reports the results in this variable.

       When   a   library   in   one   of   these   directories   is   given   by  full  path  to
       target_link_libraries() CMake will generate the -l<name> form on link lines to ensure  the
       linker  searches its implicit directories for the library.  Note that some toolchains read
       implicit directories from an environment variable such as LIBRARY_PATH so keep  its  value
       consistent when operating in a given build tree.

   CMAKE_<LANG>_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES
       Implicit linker framework search path detected for language <LANG>.

       These  paths are implicit linker framework search directories for the compiler’s language.
       CMake automatically detects these directories for each language and reports the results in
       this variable.

   CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES
       Implicit link libraries and flags detected for language <LANG>.

       Compilers typically pass language runtime library names and other flags when they invoke a
       linker.  These flags are  implicit  link  options  for  the  compiler’s  language.   CMake
       automatically  detects these libraries and flags for each language and reports the results
       in this variable.

   CMAKE_<LANG>_LIBRARY_ARCHITECTURE
       Target architecture library directory name detected for <LANG>.

       If the <LANG> compiler passes to the linker an architecture-specific system library search
       directory  such  as  <prefix>/lib/<arch>  this  variable  contains  the  <arch> name if/as
       detected by CMake.

   CMAKE_<LANG>_LINKER_PREFERENCE
       Preference value for linker language selection.

       The “linker language” for executable, shared library, and module targets is  the  language
       whose  compiler  will  invoke  the  linker.   The LINKER_LANGUAGE target property sets the
       language explicitly.  Otherwise, the linker language is that whose linker preference value
       is   highest  among  languages  compiled  and  linked  into  the  target.   See  also  the
       CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES variable.

   CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES
       True if CMAKE_<LANG>_LINKER_PREFERENCE propagates across targets.

       This is used when CMake selects a  linker  language  for  a  target.   Languages  compiled
       directly into the target are always considered.  A language compiled into static libraries
       linked by the target is considered if this variable is true.

   CMAKE_<LANG>_LINK_EXECUTABLE
       Rule variable to link an executable.

       Rule variable to link an executable for the given language.

   CMAKE_<LANG>_OUTPUT_EXTENSION
       Extension for the output of a compile for a single file.

       This is the extension for an object file for the given <LANG>.  For example .obj for C  on
       Windows.

   CMAKE_<LANG>_PLATFORM_ID
       An internal variable subject to change.

       This is used in determining the platform and is subject to change.

   CMAKE_<LANG>_SIMULATE_ID
       Identification string of “simulated” compiler.

       Some  compilers  simulate  other  compilers  to serve as drop-in replacements.  When CMake
       detects  such  a  compiler  it  sets  this  variable  to  what   would   have   been   the
       CMAKE_<LANG>_COMPILER_ID for the simulated compiler.

   CMAKE_<LANG>_SIMULATE_VERSION
       Version string of “simulated” compiler.

       Some  compilers  simulate  other  compilers  to serve as drop-in replacements.  When CMake
       detects  such  a  compiler  it  sets  this  variable  to  what   would   have   been   the
       CMAKE_<LANG>_COMPILER_VERSION for the simulated compiler.

   CMAKE_<LANG>_SIZEOF_DATA_PTR
       Size of pointer-to-data types for language <LANG>.

       This holds the size (in bytes) of pointer-to-data types in the target platform ABI.  It is
       defined for languages C and CXX (C++).

   CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS
       Extensions of source files for the given language.

       This is the list of extensions for a given language’s source files.

   CMAKE_<LANG>_STANDARD_INCLUDE_DIRECTORIES
       Include directories to be used for every source file compiled with  the  <LANG>  compiler.
       This  is  meant for specification of system include directories needed by the language for
       the current platform.  The directories always appear at the end of the include path passed
       to the compiler.

       This  variable  should  not  be  set  by  project  code.  It is meant to be set by CMake’s
       platform information modules for the current toolchain, or by a toolchain file  when  used
       with CMAKE_TOOLCHAIN_FILE.

       See also CMAKE_<LANG>_STANDARD_LIBRARIES.

   CMAKE_<LANG>_STANDARD_LIBRARIES
       Libraries  linked  into  every  executable  and shared library linked for language <LANG>.
       This is meant for specification of system libraries needed by the language for the current
       platform.

       This  variable  should  not  be  set  by  project  code.  It is meant to be set by CMake’s
       platform information modules for the current toolchain, or by a toolchain file  when  used
       with CMAKE_TOOLCHAIN_FILE.

       See also CMAKE_<LANG>_STANDARD_INCLUDE_DIRECTORIES.

   CMAKE_Swift_LANGUAGE_VERSION
       Set  to  the  Swift  language  version  number.   If  not set, the legacy “2.3” version is
       assumed.

   CMAKE_USER_MAKE_RULES_OVERRIDE_<LANG>
       Specify a CMake file that overrides platform information for <LANG>.

       This is a language-specific version of  CMAKE_USER_MAKE_RULES_OVERRIDE  loaded  only  when
       enabling language <LANG>.

VARIABLES FOR CTEST

   CTEST_BINARY_DIRECTORY
       Specify the CTest BuildDirectory setting in a ctest(1) dashboard client script.

   CTEST_BUILD_COMMAND
       Specify the CTest MakeCommand setting in a ctest(1) dashboard client script.

   CTEST_BUILD_NAME
       Specify the CTest BuildName setting in a ctest(1) dashboard client script.

   CTEST_BZR_COMMAND
       Specify the CTest BZRCommand setting in a ctest(1) dashboard client script.

   CTEST_BZR_UPDATE_OPTIONS
       Specify the CTest BZRUpdateOptions setting in a ctest(1) dashboard client script.

   CTEST_CHANGE_ID
       Specify the CTest ChangeId setting in a ctest(1) dashboard client script.

       This setting allows CTest to pass arbitrary information about this build up to CDash.  One
       use of this feature is to allow CDash to post comments on your pull  request  if  anything
       goes wrong with your build.

   CTEST_CHECKOUT_COMMAND
       Tell  the  ctest_start()  command  how to checkout or initialize the source directory in a
       ctest(1) dashboard client script.

   CTEST_CONFIGURATION_TYPE
       Specify the CTest DefaultCTestConfigurationType setting in  a  ctest(1)  dashboard  client
       script.

   CTEST_CONFIGURE_COMMAND
       Specify the CTest ConfigureCommand setting in a ctest(1) dashboard client script.

   CTEST_COVERAGE_COMMAND
       Specify the CTest CoverageCommand setting in a ctest(1) dashboard client script.

   Cobertura
       Using  Cobertura  as  the  coverage  generation  within your multi-module Java project can
       generate a series of XML files.

       The Cobertura Coverage parser expects to read the coverage data from  a  single  XML  file
       which  contains  the  coverage  data  for  all  modules.  Cobertura has a program with the
       ability to merge given cobertura.ser files and then another program to generate a combined
       XML  file  from  the  previous merged file.  For command line testing, this can be done by
       hand prior  to  CTest  looking  for  the  coverage  files.  For  script  builds,  set  the
       CTEST_COVERAGE_COMMAND  variable  to  point to a file which will perform these same steps,
       such as a .sh or .bat file.

          set(CTEST_COVERAGE_COMMAND .../run-coverage-and-consolidate.sh)

       where   the   run-coverage-and-consolidate.sh   script   is   perhaps   created   by   the
       configure_file() command and might contain the following code:

          #!/usr/bin/env bash
          CoberturaFiles="$(find "/path/to/source" -name "cobertura.ser")"
          SourceDirs="$(find "/path/to/source" -name "java" -type d)"
          cobertura-merge --datafile coberturamerge.ser $CoberturaFiles
          cobertura-report --datafile coberturamerge.ser --destination . \
                           --format xml $SourceDirs

       The  script  uses  find to capture the paths to all of the cobertura.ser files found below
       the project’s source directory.  It keeps the list of files and supplies it as an argument
       to  the cobertura-merge program. The --datafile argument signifies where the result of the
       merge will be kept.

       The combined coberturamerge.ser file is then used to generate the  XML  report  using  the
       cobertura-report  program.   The  call to the cobertura-report program requires some named
       arguments.

       --datafila
              path to the merged .ser file

       --destination
              path to put the output files(s)

       --format
              file format to write output in: xml or html

       The rest of the supplied arguments  consist  of  the  full  paths  to  the  /src/main/java
       directories of each module within the source tree. These directories are needed and should
       not be forgotten.

   CTEST_COVERAGE_EXTRA_FLAGS
       Specify the CTest CoverageExtraFlags setting in a ctest(1) dashboard client script.

   CTEST_CURL_OPTIONS
       Specify the CTest CurlOptions setting in a ctest(1) dashboard client script.

   CTEST_CUSTOM_COVERAGE_EXCLUDE
       A list of regular expressions which will be used to  exclude  files  by  their  path  from
       coverage output by the ctest_coverage() command.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_ERROR_EXCEPTION
       A list of regular expressions which will be used to exclude when detecting error  messages
       in build outputs by the ctest_test() command.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_ERROR_MATCH
       A list of regular expressions which will be used to detect error messages in build outputs
       by the ctest_test() command.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_ERROR_POST_CONTEXT
       The number of  lines  to  include  as  context  which  follow  an  error  message  by  the
       ctest_test() command. The default is 10.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_ERROR_PRE_CONTEXT
       The number of lines  to  include  as  context  which  precede  an  error  message  by  the
       ctest_test() command. The default is 10.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE
       When saving a failing test’s output, this is the maximum size,  in  bytes,  that  will  be
       collected by the ctest_test() command. Defaults to 307200 (300 KiB).

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS
       The maximum number of errors in a single build step which will be detected.   After  this,
       the ctest_test() command will truncate the output.  Defaults to 50.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS
       The maximum number of warnings in a single build step which will be detected.  After this,
       the ctest_test() command will truncate the output.  Defaults to 50.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE
       When saving a passing test’s output, this is the maximum size,  in  bytes,  that  will  be
       collected by the ctest_test() command. Defaults to 1024 (1 KiB).

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_MEMCHECK_IGNORE
       A list of regular expressions to use to exclude tests during the ctest_memcheck() command.

       It  is  initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom   file.   See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_POST_MEMCHECK
       A list of commands to run at the end of the ctest_memcheck() command.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_POST_TEST
       A list of commands to run at the end of the ctest_test() command.

       It  is  initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom   file.   See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_PRE_MEMCHECK
       A list of commands to run at the start of the ctest_memcheck() command.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_PRE_TEST
       A list of commands to run at the start of the ctest_test() command.

       It  is  initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom   file.   See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_TEST_IGNORE
       A list of regular expressions to use to exclude tests during the ctest_test() command.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_WARNING_EXCEPTION
       A list of regular expressions which  will  be  used  to  exclude  when  detecting  warning
       messages in build outputs by the ctest_test() command.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CUSTOM_WARNING_MATCH
       A list of regular expressions which will be used  to  detect  warning  messages  in  build
       outputs by the ctest_test() command.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_CVS_CHECKOUT
       Deprecated.  Use CTEST_CHECKOUT_COMMAND instead.

   CTEST_CVS_COMMAND
       Specify the CTest CVSCommand setting in a ctest(1) dashboard client script.

   CTEST_CVS_UPDATE_OPTIONS
       Specify the CTest CVSUpdateOptions setting in a ctest(1) dashboard client script.

   CTEST_DROP_LOCATION
       Specify the CTest DropLocation setting in a ctest(1) dashboard client script.

   CTEST_DROP_METHOD
       Specify the CTest DropMethod setting in a ctest(1) dashboard client script.

   CTEST_DROP_SITE
       Specify the CTest DropSite setting in a ctest(1) dashboard client script.

   CTEST_DROP_SITE_CDASH
       Specify the CTest IsCDash setting in a ctest(1) dashboard client script.

   CTEST_DROP_SITE_PASSWORD
       Specify the CTest DropSitePassword setting in a ctest(1) dashboard client script.

   CTEST_DROP_SITE_USER
       Specify the CTest DropSiteUser setting in a ctest(1) dashboard client script.

   CTEST_EXTRA_COVERAGE_GLOB
       A list of regular expressions which will be used to find files which should be covered  by
       the ctest_coverage() command.

       It   is   initialized  by  ctest(1),  but  may  be  edited  in  a  CTestCustom  file.  See
       ctest_read_custom_files() documentation.

   CTEST_GIT_COMMAND
       Specify the CTest GITCommand setting in a ctest(1) dashboard client script.

   CTEST_GIT_INIT_SUBMODULES
       Specify the CTest GITInitSubmodules setting in a ctest(1) dashboard client script.

   CTEST_GIT_UPDATE_CUSTOM
       Specify the CTest GITUpdateCustom setting in a ctest(1) dashboard client script.

   CTEST_GIT_UPDATE_OPTIONS
       Specify the CTest GITUpdateOptions setting in a ctest(1) dashboard client script.

   CTEST_HG_COMMAND
       Specify the CTest HGCommand setting in a ctest(1) dashboard client script.

   CTEST_HG_UPDATE_OPTIONS
       Specify the CTest HGUpdateOptions setting in a ctest(1) dashboard client script.

   CTEST_LABELS_FOR_SUBPROJECTS
       Specify the CTest LabelsForSubprojects setting in a ctest(1) dashboard client script.

   CTEST_MEMORYCHECK_COMMAND
       Specify the CTest MemoryCheckCommand setting in a ctest(1) dashboard client script.

   CTEST_MEMORYCHECK_COMMAND_OPTIONS
       Specify the CTest MemoryCheckCommandOptions setting in a ctest(1) dashboard client script.

   CTEST_MEMORYCHECK_SANITIZER_OPTIONS
       Specify the CTest MemoryCheckSanitizerOptions  setting  in  a  ctest(1)  dashboard  client
       script.

   CTEST_MEMORYCHECK_SUPPRESSIONS_FILE
       Specify  the  CTest  MemoryCheckSuppressionFile  setting  in  a  ctest(1) dashboard client
       script.

   CTEST_MEMORYCHECK_TYPE
       Specify the CTest MemoryCheckType setting in a ctest(1) dashboard  client  script.   Valid
       values   are  Valgrind,  Purify,  BoundsChecker,  and  ThreadSanitizer,  AddressSanitizer,
       LeakSanitizer, MemorySanitizer, and UndefinedBehaviorSanitizer.

   CTEST_NIGHTLY_START_TIME
       Specify the CTest NightlyStartTime setting in a ctest(1) dashboard client script.

   CTEST_P4_CLIENT
       Specify the CTest P4Client setting in a ctest(1) dashboard client script.

   CTEST_P4_COMMAND
       Specify the CTest P4Command setting in a ctest(1) dashboard client script.

   CTEST_P4_OPTIONS
       Specify the CTest P4Options setting in a ctest(1) dashboard client script.

   CTEST_P4_UPDATE_OPTIONS
       Specify the CTest P4UpdateOptions setting in a ctest(1) dashboard client script.

   CTEST_SCP_COMMAND
       Specify the CTest SCPCommand setting in a ctest(1) dashboard client script.

   CTEST_SITE
       Specify the CTest Site setting in a ctest(1) dashboard client script.

   CTEST_SOURCE_DIRECTORY
       Specify the CTest SourceDirectory setting in a ctest(1) dashboard client script.

   CTEST_SVN_COMMAND
       Specify the CTest SVNCommand setting in a ctest(1) dashboard client script.

   CTEST_SVN_OPTIONS
       Specify the CTest SVNOptions setting in a ctest(1) dashboard client script.

   CTEST_SVN_UPDATE_OPTIONS
       Specify the CTest SVNUpdateOptions setting in a ctest(1) dashboard client script.

   CTEST_TEST_LOAD
       Specify the TestLoad setting in the CTest Test Step of a ctest(1) dashboard client script.
       This sets the default value for the TEST_LOAD option of the ctest_test() command.

   CTEST_TEST_TIMEOUT
       Specify the CTest TimeOut setting in a ctest(1) dashboard client script.

   CTEST_TRIGGER_SITE
       Specify the CTest TriggerSite setting in a ctest(1) dashboard client script.

   CTEST_UPDATE_COMMAND
       Specify the CTest UpdateCommand setting in a ctest(1) dashboard client script.

   CTEST_UPDATE_OPTIONS
       Specify the CTest UpdateOptions setting in a ctest(1) dashboard client script.

   CTEST_UPDATE_VERSION_ONLY
       Specify the CTest UpdateVersionOnly setting in a ctest(1) dashboard client script.

   CTEST_USE_LAUNCHERS
       Specify the CTest UseLaunchers setting in a ctest(1) dashboard client script.

VARIABLES FOR CPACK

CPACK_ABSOLUTE_DESTINATION_FILES
List of files which have been installed using an ABSOLUTE DESTINATION path.

This variable is a Read-Only variable which is set internally by CPack during installation
and before packaging using CMAKE_ABSOLUTE_DESTINATION_FILES defined in cmake_install.cmake
scripts. The value can be used within CPack project configuration file and/or
CPack<GEN>.cmake file of <GEN> generator.

CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY
Boolean toggle to include/exclude top level directory (component case).

Similar usage as CPACK_INCLUDE_TOPLEVEL_DIRECTORY but for the component case. See
CPACK_INCLUDE_TOPLEVEL_DIRECTORY documentation for the detail.

CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION
Ask CPack to error out as soon as a file with absolute INSTALL DESTINATION is encountered.

The fatal error is emitted before the installation of the offending file takes place.
Some CPack generators, like NSIS, enforce this internally. This variable triggers the
definition of CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION when CPack runs.

CPACK_INCLUDE_TOPLEVEL_DIRECTORY
Boolean toggle to include/exclude top level directory.

When preparing a package CPack installs the item under the so-called top level directory.
The purpose of is to include (set to 1 or ON or TRUE) the top level directory in the
package or not (set to 0 or OFF or FALSE).

Each CPack generator has a built-in default value for this variable. E.g. Archive
generators (ZIP, TGZ, …) includes the top level whereas RPM or DEB don’t. The user may
override the default value by setting this variable.

There is a similar variable CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY which may be used
to override the behavior for the component packaging case which may have different default
value for historical (now backward compatibility) reason.

CPACK_INSTALL_SCRIPT
Extra CMake script provided by the user.

If set this CMake script will be executed by CPack during its local [CPack-private]
installation which is done right before packaging the files. The script is not called by
e.g.: make install.

CPACK_PACKAGING_INSTALL_PREFIX
The prefix used in the built package.

Each CPack generator has a default value (like /usr). This default value may be
overwritten from the CMakeLists.txt or the cpack(1) command line by setting an alternative
value. Example:

set(CPACK_PACKAGING_INSTALL_PREFIX "/opt")

This is not the same purpose as CMAKE_INSTALL_PREFIX which is used when installing from
the build tree without building a package.

CPACK_SET_DESTDIR
Boolean toggle to make CPack use DESTDIR mechanism when packaging.

DESTDIR means DESTination DIRectory. It is commonly used by makefile users in order to
install software at non-default location. It is a basic relocation mechanism that should
not be used on Windows (see CMAKE_INSTALL_PREFIX documentation). It is usually invoked
like this:

make DESTDIR=/home/john install

which will install the concerned software using the installation prefix, e.g. /usr/local
prepended with the DESTDIR value which finally gives /home/john/usr/local. When preparing
a package, CPack first installs the items to be packaged in a local (to the build tree)
directory by using the same DESTDIR mechanism. Nevertheless, if CPACK_SET_DESTDIR is set
then CPack will set DESTDIR before doing the local install. The most noticeable
difference is that without CPACK_SET_DESTDIR, CPack uses CPACK_PACKAGING_INSTALL_PREFIX as
a prefix whereas with CPACK_SET_DESTDIR set, CPack will use CMAKE_INSTALL_PREFIX as a
prefix.

Manually setting CPACK_SET_DESTDIR may help (or simply be necessary) if some install rules
uses absolute DESTINATION (see CMake install() command). However, starting with
CPack/CMake 2.8.3 RPM and DEB installers tries to handle DESTDIR automatically so that it
is seldom necessary for the user to set it.

CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION
Ask CPack to warn each time a file with absolute INSTALL DESTINATION is encountered.

This variable triggers the definition of CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION when
CPack runs cmake_install.cmake scripts.

COPYRIGHT

       2000-2021 Kitware, Inc. and Contributors