Ubuntu Manpage: cmake-variables - CMake Variables Reference

name
variables that provide information
variables that change behavior
variables that describe the system
variables that control the build
variables for languages
variables for ctest
variables for cpack
variable expansion operators
internal variables
copyright

Provided by: cmake-data_3.22.1-1ubuntu1.22.04.2_all

NAME

       cmake-variables - CMake Variables Reference

       This  page  documents  variables  that are provided by CMake or have meaning to CMake when set by project
       code.

       For general information on variables, see the Variables section in the cmake-language manual.

       NOTE:
          CMake reserves identifiers that:

          • begin with CMAKE_ (upper-, lower-, or mixed-case), or

          • begin with _CMAKE_ (upper-, lower-, or mixed-case), or

          • begin with _ followed by the name of any CMake Command.

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_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_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_CFG_INTDIR
Deprecated since version 3.21: This variable has poor support on Ninja Multi-Config, and predates the
existence of the $<CONFIG> generator expression. Use $<CONFIG> instead.

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 9
$(Configuration) = Visual Studio 10
$(CONFIGURATION) = Xcode
. = Make-based tools
. = Ninja
${CONFIGURATION} = Ninja Multi-Config

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_CPACK_COMMAND
New in version 3.13.

Full path to cpack(1) command installed with CMake.

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

CMAKE_CROSSCOMPILING
Intended to indicate whether CMake is cross compiling, but note limitations discussed below.

This variable will be set to true by CMake if the CMAKE_SYSTEM_NAME variable has been set manually (i.e.
in a toolchain file or as a cache entry from the cmake command line). In most cases, manually setting
CMAKE_SYSTEM_NAME will only be done when cross compiling, since it will otherwise be given the same value
as CMAKE_HOST_SYSTEM_NAME if not manually set, which is correct for the non-cross-compiling case. In the
event that CMAKE_SYSTEM_NAME is manually set to the same value as CMAKE_HOST_SYSTEM_NAME, then
CMAKE_CROSSCOMPILING will still be set to true.

Another case to be aware of is that builds targeting Apple platforms other than macOS are handled
differently to other cross compiling scenarios. Rather than relying on CMAKE_SYSTEM_NAME to select the
target platform, Apple device builds use CMAKE_OSX_SYSROOT to select the appropriate SDK, which
indirectly determines the target platform. Furthermore, when using the Xcode generator, developers can
switch between device and simulator builds at build time rather than having a single choice at configure
time, so the concept of whether the build is cross compiling or not is more complex. Therefore, the use
of CMAKE_CROSSCOMPILING is not recommended for projects targeting Apple devices.

CMAKE_CROSSCOMPILING_EMULATOR
New in version 3.3.

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.

If this variable contains a semicolon-separated list, then the first value is the command and remaining
values are its arguments.

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_FUNCTION
New in version 3.17.

When executing code inside a function(), this variable contains the name of the current function. It can
be useful for diagnostic or debug messages.

See also CMAKE_CURRENT_FUNCTION_LIST_DIR, CMAKE_CURRENT_FUNCTION_LIST_FILE and
CMAKE_CURRENT_FUNCTION_LIST_LINE.

CMAKE_CURRENT_FUNCTION_LIST_DIR
New in version 3.17.

When executing code inside a function(), this variable contains the full directory of the listfile that
defined the current function.

It is quite common practice in CMake for modules to use some additional files, such as templates to be
copied in after substituting CMake variables. In such cases, a function needs to know where to locate
those files in a way that doesn't depend on where the function is called. Without
CMAKE_CURRENT_FUNCTION_LIST_DIR, the code to do that would typically use the following pattern:

set(_THIS_MODULE_BASE_DIR "${CMAKE_CURRENT_LIST_DIR}")

function(foo)
configure_file(
"${_THIS_MODULE_BASE_DIR}/some.template.in"
some.output
)
endfunction()

Using CMAKE_CURRENT_FUNCTION_LIST_DIR inside the function instead eliminates the need for the extra
variable which would otherwise be visible outside the function's scope. The above example can be written
in the more concise and more robust form:

function(foo)
configure_file(
"${CMAKE_CURRENT_FUNCTION_LIST_DIR}/some.template.in"
some.output
)
endfunction()

See also CMAKE_CURRENT_FUNCTION, CMAKE_CURRENT_FUNCTION_LIST_FILE and CMAKE_CURRENT_FUNCTION_LIST_LINE.

CMAKE_CURRENT_FUNCTION_LIST_FILE
New in version 3.17.

When executing code inside a function(), this variable contains the full path to the listfile that
defined the current function.

See also CMAKE_CURRENT_FUNCTION, CMAKE_CURRENT_FUNCTION_LIST_DIR and CMAKE_CURRENT_FUNCTION_LIST_LINE.

CMAKE_CURRENT_FUNCTION_LIST_LINE
New in version 3.17.

When executing code inside a function(), this variable contains the line number in the listfile where the
current function was defined.

See also CMAKE_CURRENT_FUNCTION, CMAKE_CURRENT_FUNCTION_LIST_DIR and CMAKE_CURRENT_FUNCTION_LIST_FILE.

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
Semicolon-separated list of directories specifying a search path for macOS application bundles used by
the find_program(), and find_package() commands.

CMAKE_AUTOMOC_RELAXED_MODE
Deprecated since version 3.15.

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 behavior. 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 (e.g. Makefile Generators or Ninja).
Typical values include Debug, Release, RelWithDebInfo and MinSizeRel, but custom build types can also be
defined.

This variable is initialized by the first project() or enable_language() command called in a project when
a new build tree is first created. If the CMAKE_BUILD_TYPE environment variable is set, its value is
used. Otherwise, a toolchain-specific default is chosen when a language is enabled. The default value
is often an empty string, but this is usually not desirable and one of the other standard build types is
usually more appropriate.

Depending on the situation, the value of this variable may be treated case-sensitively or
case-insensitively. See Build Configurations for discussion of this and other related topics.

For multi-config generators, see CMAKE_CONFIGURATION_TYPES.

CMAKE_CLANG_VFS_OVERLAY
New in version 3.19.

When cross compiling for windows with clang-cl, this variable can be an absolute path pointing to a clang
virtual file system yaml file, which will enable clang-cl to resolve windows header names on a case
sensitive file system.

CMAKE_CODEBLOCKS_COMPILER_ID
New in version 3.11.

Change the compiler id in the generated CodeBlocks project files.

CodeBlocks uses its own compiler id string which differs from CMAKE_<LANG>_COMPILER_ID. If this variable
is left empty, CMake tries to recognize the CodeBlocks compiler id automatically. Otherwise the
specified string is used in the CodeBlocks project file. See the CodeBlocks documentation for valid
compiler id strings.

Other IDEs like QtCreator that also use the CodeBlocks generator may ignore this setting.

CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES
New in version 3.10.

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
New in version 3.7.

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 (configurations) on multi-config generators (e.g. Visual Studio,
Xcode, or Ninja Multi-Config). Typical values include Debug, Release, RelWithDebInfo and MinSizeRel, but
custom build types can also be defined.

This variable is initialized by the first project() or enable_language() command called in a project when
a new build tree is first created. If the CMAKE_CONFIGURATION_TYPES environment variable is set, its
value is used. Otherwise, the default value is generator-specific.

Depending on the situation, the values in this variable may be treated case-sensitively or
case-insensitively. See Build Configurations for discussion of this and other related topics.

For single-config generators, see CMAKE_BUILD_TYPE.

CMAKE_DEPENDS_IN_PROJECT_ONLY
New in version 3.6.

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

See also the CMAKE_REQUIRE_FIND_PACKAGE_<PackageName> variable.

CMAKE_ECLIPSE_GENERATE_LINKED_RESOURCES
New in version 3.6.

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
New in version 3.6.

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
New in version 3.6.

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_RESOURCE_ENCODING
New in version 3.16.

This cache variable tells the Eclipse CDT4 project generator to set the resource encoding to the given
value in generated project files. If no value is given, no encoding will be set.

CMAKE_ECLIPSE_VERSION
New in version 3.6.

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_EXECUTE_PROCESS_COMMAND_ECHO
New in version 3.15.

If this variable is set to STDERR, STDOUT or NONE then commands in execute_process() calls will be
printed to either stderr or stdout or not at all.

CMAKE_EXPORT_COMPILE_COMMANDS
New in version 3.5.

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"
}
]

This is initialized by the CMAKE_EXPORT_COMPILE_COMMANDS environment variable, and initializes the
EXPORT_COMPILE_COMMANDS target property for all targets.

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

This option currently does not work well in combination with the UNITY_BUILD target property or the
CMAKE_UNITY_BUILD variable.

CMAKE_EXPORT_PACKAGE_REGISTRY
New in version 3.15.

Enables the export(PACKAGE) command when CMP0090 is set to NEW.

The export(PACKAGE) command does nothing by default. In some cases it is desirable to write to the user
package registry, so the CMAKE_EXPORT_PACKAGE_REGISTRY variable may be set to enable it.

If CMP0090 is not set to NEW this variable does nothing, and the CMAKE_EXPORT_NO_PACKAGE_REGISTRY
variable controls the behavior instead.

See also Disabling the Package Registry.

CMAKE_EXPORT_NO_PACKAGE_REGISTRY
New in version 3.1.

Disable the export(PACKAGE) command when CMP0090 is not set to NEW.

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.

If CMP0090 is set to NEW this variable does nothing, and the CMAKE_EXPORT_PACKAGE_REGISTRY variable
controls the behavior instead.

See also Disabling the Package Registry.

CMAKE_FIND_APPBUNDLE
New in version 3.4.

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

On Darwin or systems supporting macOS 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
New in version 3.4.

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

On Darwin or systems supporting macOS 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
New in version 3.9.

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, depending on the compiler, .dll.a, .a (e.g. GCC and
Clang), so when it tries to find the foo library, it will look for [<prefix>]foo.lib and/or
[<prefix>]foo[.dll].a, depending on the compiler used and the <prefix> specified in the
CMAKE_FIND_LIBRARY_PREFIXES.

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
New in version 3.1.

Deprecated since version 3.16: Use the CMAKE_FIND_USE_PACKAGE_REGISTRY variable instead.

By default this variable is not set. If neither CMAKE_FIND_USE_PACKAGE_REGISTRY nor
CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY is set, then find_package() will use the User Package Registry
unless the NO_CMAKE_PACKAGE_REGISTRY option is provided.

CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY is ignored if CMAKE_FIND_USE_PACKAGE_REGISTRY is set.

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
TRUE, 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
New in version 3.1.

Deprecated since version 3.16: Use the CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY variable instead.

By default this variable is not set. If neither CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY nor
CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY is set, then find_package() will use the System Package
Registry unless the NO_CMAKE_SYSTEM_PACKAGE_REGISTRY option is provided.

CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY is ignored if CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY is
set.

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 TRUE, 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_PREFER_CONFIG
New in version 3.15.

Tell find_package() to try "Config" mode before "Module" mode if no mode was specified.

The command find_package() operates without an explicit mode when the reduced signature is used without
the MODULE option. In this case, by default, CMake first tries Module mode by searching for a
Find<pkg>.cmake module. If it fails, CMake then searches for the package using Config mode.

Set CMAKE_FIND_PACKAGE_PREFER_CONFIG to TRUE to tell find_package() to first search using Config mode
before falling back to Module mode.

This variable may be useful when a developer has compiled a custom version of a common library and wishes
to link it to a dependent project. If this variable is set to TRUE, it would prevent a dependent
project's call to find_package() from selecting the default library located by the system's
Find<pkg>.cmake module before finding the developer's custom built library.

Once this variable is set, it is the responsibility of the exported <pkg>Config.cmake files to provide
the same result variables as the Find<pkg>.cmake modules so that dependent projects can use them
interchangeably.

CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS
New in version 3.14.

Set to TRUE to tell find_package() calls to resolve symbolic links in the value of <PackageName>_DIR.

This is helpful in use cases where the package search path points at a proxy directory in which symlinks
to the real package locations appear. This is not enabled by default because there are also common use
cases in which the symlinks should be preserved.

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.

This variable has no effect if CMAKE_FIND_PACKAGE_PREFER_CONFIG is set to TRUE.

CMAKE_FIND_ROOT_PATH
Semicolon-separated 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_FIND_USE_CMAKE_ENVIRONMENT_PATH
New in version 3.16.

Controls the default behavior of the following commands for whether or not to search paths provided by
cmake-specific environment variables:

• find_program()

• find_library()

• find_file()

• find_path()

• find_package()

This is useful in cross-compiling environments.

By default this variable is not set, which is equivalent to it having a value of TRUE. Explicit options
given to the above commands take precedence over this variable.

See also the CMAKE_FIND_USE_CMAKE_PATH, CMAKE_FIND_USE_CMAKE_SYSTEM_PATH,
CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH, CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY,
CMAKE_FIND_USE_PACKAGE_REGISTRY, and CMAKE_FIND_USE_PACKAGE_ROOT_PATH variables.

CMAKE_FIND_USE_CMAKE_PATH
New in version 3.16.

Controls the default behavior of the following commands for whether or not to search paths provided by
cmake-specific cache variables:

• find_program()

• find_library()

• find_file()

• find_path()

• find_package()

This is useful in cross-compiling environments.

By default this variable is not set, which is equivalent to it having a value of TRUE. Explicit options
given to the above commands take precedence over this variable.

See also the CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH, CMAKE_FIND_USE_CMAKE_SYSTEM_PATH,
CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH, CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY,
CMAKE_FIND_USE_PACKAGE_REGISTRY, and CMAKE_FIND_USE_PACKAGE_ROOT_PATH variables.

CMAKE_FIND_USE_CMAKE_SYSTEM_PATH
New in version 3.16.

Controls the default behavior of the following commands for whether or not to search paths provided by
platform-specific cmake variables:

• find_program()

• find_library()

• find_file()

• find_path()

• find_package()

This is useful in cross-compiling environments.

By default this variable is not set, which is equivalent to it having a value of TRUE. Explicit options
given to the above commands take precedence over this variable.

See also the CMAKE_FIND_USE_CMAKE_PATH, CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH,
CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH, CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY,
CMAKE_FIND_USE_PACKAGE_REGISTRY, and CMAKE_FIND_USE_PACKAGE_ROOT_PATH variables.

CMAKE_FIND_USE_PACKAGE_REGISTRY
New in version 3.16.

Controls the default behavior of the find_package() command for whether or not to search paths provided
by the User Package Registry.

By default this variable is not set and the behavior will fall back to that determined by the deprecated
CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY variable. If that is also not set, then find_package() will use
the User Package Registry unless the NO_CMAKE_PACKAGE_REGISTRY option is provided.

This variable takes precedence over CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY when both are set.

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_USE_PACKAGE_REGISTRY variable is FALSE,
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 and the CMAKE_FIND_USE_CMAKE_PATH,
CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH, CMAKE_FIND_USE_CMAKE_SYSTEM_PATH,
CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH, CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY, and
CMAKE_FIND_USE_PACKAGE_ROOT_PATH variables.

CMAKE_FIND_USE_PACKAGE_ROOT_PATH
New in version 3.16.

Controls the default behavior of the following commands for whether or not to search paths provided by
<PackageName>_ROOT variables:

• find_program()

• find_library()

• find_file()

• find_path()

• find_package()

By default this variable is not set, which is equivalent to it having a value of TRUE. Explicit options
given to the above commands take precedence over this variable.

See also the CMAKE_FIND_USE_CMAKE_PATH, CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH,
CMAKE_FIND_USE_CMAKE_SYSTEM_PATH, CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH,
CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY, and CMAKE_FIND_USE_PACKAGE_REGISTRY variables.

CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH
New in version 3.16.

Controls the default behavior of the following commands for whether or not to search paths provided by
standard system environment variables:

• find_program()

• find_library()

• find_file()

• find_path()

• find_package()

This is useful in cross-compiling environments.

By default this variable is not set, which is equivalent to it having a value of TRUE. Explicit options
given to the above commands take precedence over this variable.

See also the CMAKE_FIND_USE_CMAKE_PATH, CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH,
CMAKE_FIND_USE_CMAKE_SYSTEM_PATH, CMAKE_FIND_USE_PACKAGE_REGISTRY, CMAKE_FIND_USE_PACKAGE_ROOT_PATH, and
CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY variables.

CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY
New in version 3.16.

Controls searching the System Package Registry by the find_package() command.

By default this variable is not set and the behavior will fall back to that determined by the deprecated
CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY variable. If that is also not set, then find_package()
will use the System Package Registry unless the NO_CMAKE_SYSTEM_PACKAGE_REGISTRY option is provided.

This variable takes precedence over CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY when both are set.

In some cases, for example to locate only user specific installations, it is not desirable to use the
System Package Registry when searching for packages. If the CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY
variable is FALSE, 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.

See also the CMAKE_FIND_USE_CMAKE_PATH, CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH,
CMAKE_FIND_USE_CMAKE_SYSTEM_PATH, CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH,
CMAKE_FIND_USE_PACKAGE_REGISTRY, and CMAKE_FIND_USE_PACKAGE_ROOT_PATH variables.

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

CMAKE_IGNORE_PATH
Semicolon-separated 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
Semicolon-separated 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_DEFAULT_DIRECTORY_PERMISSIONS
New in version 3.11.

Default permissions for directories created implicitly during installation of files by install() and
file(INSTALL).

If make install is invoked and directories are implicitly created they get permissions set by
CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS variable or platform specific default permissions if the
variable is not set.

Implicitly created directories are created if they are not explicitly installed by install() command but
are needed to install a file on a certain path. Example of such locations are directories created due to
the setting of CMAKE_INSTALL_PREFIX.

Expected content of the CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS variable is a list of permissions
that can be used by install() command PERMISSIONS section.

Example usage:

set(CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS
OWNER_READ
OWNER_WRITE
OWNER_EXECUTE
GROUP_READ
)

CMAKE_INSTALL_MESSAGE
New in version 3.1.

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. See DESTDIR for
more information.

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
New in version 3.7.1.

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
Semicolon-separated 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_LINK_DIRECTORIES_BEFORE
New in version 3.13.

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

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

CMAKE_MFC_FLAG
Use the MFC library for an executable or dll.

Enables the use of the Microsoft Foundation Classes (MFC). 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.

Usage example:

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

Contents of CMAKE_MFC_FLAG may use generator expressions.

CMAKE_MAXIMUM_RECURSION_DEPTH
New in version 3.14.

Maximum recursion depth for CMake scripts. It is intended to be set on the command line with
-DCMAKE_MAXIMUM_RECURSION_DEPTH=<x>, or within CMakeLists.txt by projects that require a large recursion
depth. Projects that set this variable should provide the user with a way to override it. For example:

# About to perform deeply recursive actions
if(NOT CMAKE_MAXIMUM_RECURSION_DEPTH)
set(CMAKE_MAXIMUM_RECURSION_DEPTH 2000)
endif()

If it is not set, or is set to a non-integer value, a sensible default limit is used. If the recursion
limit is reached, the script terminates immediately with a fatal error.

Calling any of the following commands increases the recursion depth:

• include()

• find_package()

• add_subdirectory()

• try_compile()

• ctest_read_custom_files()

• ctest_run_script() (unless NEW_PROCESS is specified)

• User-defined function()'s and macro()'s (note that function() and macro() themselves don't increase
recursion depth)

• Reading or writing variables that are being watched by a variable_watch()

CMAKE_MESSAGE_CONTEXT
New in version 3.17.

When enabled by the cmake --log-context command line option or the CMAKE_MESSAGE_CONTEXT_SHOW variable,
the message() command converts the CMAKE_MESSAGE_CONTEXT list into a dot-separated string surrounded by
square brackets and prepends it to each line for messages of log levels NOTICE and below.

For logging contexts to work effectively, projects should generally APPEND and POP_BACK an item to the
current value of CMAKE_MESSAGE_CONTEXT rather than replace it. Projects should not assume the message
context at the top of the source tree is empty, as there are scenarios where the context might have
already been set (e.g. hierarchical projects).

WARNING:
Valid context names are restricted to anything that could be used as a CMake variable name. All names
that begin with an underscore or the string cmake_ are also reserved for use by CMake and should not
be used by projects.

Example:

function(bar)
list(APPEND CMAKE_MESSAGE_CONTEXT "bar")
message(VERBOSE "bar VERBOSE message")
endfunction()

function(baz)
list(APPEND CMAKE_MESSAGE_CONTEXT "baz")
message(DEBUG "baz DEBUG message")
endfunction()

function(foo)
list(APPEND CMAKE_MESSAGE_CONTEXT "foo")
bar()
message(TRACE "foo TRACE message")
baz()
endfunction()

list(APPEND CMAKE_MESSAGE_CONTEXT "top")

message(VERBOSE "Before `foo`")
foo()
message(VERBOSE "After `foo`")

list(POP_BACK CMAKE_MESSAGE_CONTEXT)

Which results in the following output:

-- [top] Before `foo`
-- [top.foo.bar] bar VERBOSE message
-- [top.foo] foo TRACE message
-- [top.foo.baz] baz DEBUG message
-- [top] After `foo`

CMAKE_MESSAGE_CONTEXT_SHOW
New in version 3.17.

Setting this variable to true enables showing a context with each line logged by the message() command
(see CMAKE_MESSAGE_CONTEXT for how the context itself is specified).

This variable is an alternative to providing the --log-context option on the cmake command line. Whereas
the command line option will apply only to that one CMake run, setting CMAKE_MESSAGE_CONTEXT_SHOW to true
as a cache variable will ensure that subsequent CMake runs will continue to show the message context.

Projects should not set CMAKE_MESSAGE_CONTEXT_SHOW. It is intended for users so that they may control
whether or not to include context with messages.

CMAKE_MESSAGE_INDENT
New in version 3.16.

The message() command joins the strings from this list and for log levels of NOTICE and below, it
prepends the resultant string to each line of the message.

Example:

list(APPEND listVar one two three)

message(VERBOSE [[Collected items in the "listVar":]])
list(APPEND CMAKE_MESSAGE_INDENT " ")

foreach(item IN LISTS listVar)
message(VERBOSE ${item})
endforeach()

list(POP_BACK CMAKE_MESSAGE_INDENT)
message(VERBOSE "No more indent")

Which results in the following output:

-- Collected items in the "listVar":
-- one
-- two
-- three
-- No more indent

CMAKE_MESSAGE_LOG_LEVEL
New in version 3.17.

When set, this variable specifies the logging level used by the message() command. Valid values are the
same as those for the --log-level command line option of the cmake(1) program. If this variable is set
and the --log-level command line option is given, the command line option takes precedence.

The main advantage to using this variable is to make a log level persist between CMake runs. Setting it
as a cache variable will ensure that subsequent CMake runs will continue to use the chosen log level.

Projects should not set this variable, it is intended for users so that they may control the log level
according to their own needs.

CMAKE_MODULE_PATH
Semicolon-separated list of directories specifying a search path for CMake modules to be loaded by 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_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 as a way to set its own policies; use
cmake_policy(SET) instead. This variable is meant to externally set policies for which a project has not
itself been updated:

• Users running CMake may set this variable in the cache (e.g.
-DCMAKE_POLICY_DEFAULT_CMP<NNNN>=<OLD|NEW>). Set it to OLD to quiet a policy warning while using old
behavior or to NEW to try building the project with new behavior.

• Projects may set this variable before a call to add_subdirectory() that adds a third-party project in
order to set its policies without modifying third-party code.

CMAKE_POLICY_WARNING_CMP<NNNN>
Explicitly enable or disable the warning when CMake Policy CMP<NNNN> has not been set explicitly by
cmake_policy() or implicitly by cmake_minimum_required(). This is meaningful only for the 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.

• CMAKE_POLICY_WARNING_CMP0082 controls the warning for policy CMP0082.

• CMAKE_POLICY_WARNING_CMP0089 controls the warning for policy CMP0089.

• CMAKE_POLICY_WARNING_CMP0102 controls the warning for policy CMP0102.

• CMAKE_POLICY_WARNING_CMP0112 controls the warning for policy CMP0112.

• CMAKE_POLICY_WARNING_CMP0116 controls the warning for policy CMP0116.

• CMAKE_POLICY_WARNING_CMP0126 controls the warning for policy CMP0126.

• CMAKE_POLICY_WARNING_CMP0128 controls the warning for policy CMP0128.

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
Semicolon-separated 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
Semicolon-separated 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_INCLUDE
New in version 3.15.

A CMake language file or module to be included as the last step of all project() command calls. This is
intended for injecting custom code into project builds without modifying their source.

See also the CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE, CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE and
CMAKE_PROJECT_INCLUDE_BEFORE variables.

CMAKE_PROJECT_INCLUDE_BEFORE
New in version 3.15.

A CMake language file or module to be included as the first step of all project() command calls. This is
intended for injecting custom code into project builds without modifying their source.

See also the CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE, CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE and
CMAKE_PROJECT_INCLUDE variables.

CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE
A CMake language file or module to be included as the last step of any project() command calls that
specify <PROJECT-NAME> as the project name. This is intended for injecting custom code into project
builds without modifying their source.

See also the CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE, CMAKE_PROJECT_INCLUDE and
CMAKE_PROJECT_INCLUDE_BEFORE variables.

CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE
New in version 3.17.

A CMake language file or module to be included as the first step of any project() command calls that
specify <PROJECT-NAME> as the project name. This is intended for injecting custom code into project
builds without modifying their source.

See also the CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE, CMAKE_PROJECT_INCLUDE and CMAKE_PROJECT_INCLUDE_BEFORE
variables.

CMAKE_REQUIRE_FIND_PACKAGE_<PackageName>
New in version 3.22.

Variable for making find_package() call REQUIRED.

Every non-REQUIRED find_package() call in a project can be turned into REQUIRED by setting the variable
CMAKE_REQUIRE_FIND_PACKAGE_<PackageName> to TRUE. This can be used to assert assumptions about build
environment and to ensure the build will fail early if they do not hold.

See also the CMAKE_DISABLE_FIND_PACKAGE_<PackageName> variable.

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
New in version 3.8.

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
New in version 3.8.

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_SUPPRESS_REGENERATION
New in version 3.12.

If CMAKE_SUPPRESS_REGENERATION is OFF, which is default, then CMake adds a special target on which all
other targets depend that checks the build system and optionally re-runs CMake to regenerate the build
system when the target specification source changes.

If this variable evaluates to ON at the end of the top-level CMakeLists.txt file, CMake will not add the
regeneration target to the build system or perform any build system checks.

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
New in version 3.9.

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
New in version 3.9.

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
New in version 3.4.

Search path for macOS 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
New in version 3.4.

Search path for macOS 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
Semicolon-separated 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
Semicolon-separated 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
Semicolon-separated 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
Semicolon-separated 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 system 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.

The system directories that are contained in CMAKE_SYSTEM_PREFIX_PATH are locations that typically
include installed software. An example being /usr/local for UNIX based platforms. In addition to standard
platform locations, CMake will also add values to CMAKE_SYSTEM_PREFIX_PATH based on environment
variables. The environment variables and search locations that CMake uses may evolve over time, as
platforms and their conventions also evolve. The following provides an indicative list of environment
variables and locations that CMake searches, but they are subject to change:

CrayLinuxEnvironment:

• ENV{SYSROOT_DIR}/

• ENV{SYSROOT_DIR}/usr

• ENV{SYSROOT_DIR}/usr/local

Darwin:

• ENV{SDKROOT}/usr When CMAKE_OSX_SYSROOT is not explicitly specified.

OpenBSD:

• ENV{LOCALBASE}

Unix:

• ENV{CONDA_PREFIX} when using a conda compiler

Windows:

• ENV{ProgramW6432}

• ENV{ProgramFiles}

• ENV{ProgramFiles(x86)}

• ENV{SystemDrive}/Program Files

• ENV{SystemDrive}/Program Files (x86)

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
Semicolon-separated 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_TLS_CAINFO
Specify the default value for the file(DOWNLOAD) and file(UPLOAD) commands' TLS_CAINFO options. It is
unset by default.

This variable is also used by the ExternalProject and FetchContent modules for internal calls to
file(DOWNLOAD).

CMAKE_TLS_VERIFY
Specify the default value for the file(DOWNLOAD) and file(UPLOAD) commands' TLS_VERIFY options. If not
set, the default is off.

This variable is also used by the ExternalProject and FetchContent modules for internal calls to
file(DOWNLOAD).

TLS verification can help provide confidence that one is connecting to the desired server. When
downloading known content, one should also use file hashes to verify it.

set(CMAKE_TLS_VERIFY TRUE)

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.

CMAKE_XCODE_GENERATE_SCHEME
New in version 3.9.

If enabled, the Xcode generator will generate schema files. These are useful to invoke analyze, archive,
build-for-testing and test actions from the command line.

This variable initializes the XCODE_GENERATE_SCHEME target property on all targets.

CMAKE_XCODE_GENERATE_TOP_LEVEL_PROJECT_ONLY
New in version 3.11.

If enabled, the Xcode generator will generate only a single Xcode project file for the topmost project()
command instead of generating one for every project() command.

This could be useful to speed up the CMake generation step for large projects and to work-around a bug in
the ZERO_CHECK logic.

CMAKE_XCODE_LINK_BUILD_PHASE_MODE
New in version 3.19.

This variable is used to initialize the XCODE_LINK_BUILD_PHASE_MODE property on targets. It affects the
methods that the Xcode generator uses to link different kinds of libraries. Its default value is NONE.

CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER
New in version 3.13.

Whether to enable Address Sanitizer in the Diagnostics section of the generated Xcode scheme.

This variable initializes the XCODE_SCHEME_ADDRESS_SANITIZER property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN
New in version 3.13.

Whether to enable Detect use of stack after return in the Diagnostics section of the generated Xcode
scheme.

This variable initializes the XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING
New in version 3.16.

Whether to enable Allow debugging when using document Versions Browser in the Options section of the
generated Xcode scheme.

This variable initializes the XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER
New in version 3.13.

Whether to disable the Main Thread Checker in the Diagnostics section of the generated Xcode scheme.

This variable initializes the XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS
New in version 3.13.

Whether to enable Dynamic Library Loads in the Diagnostics section of the generated Xcode scheme.

This variable initializes the XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE
New in version 3.13.

Whether to enable Dynamic Linker API usage in the Diagnostics section of the generated Xcode scheme.

This variable initializes the XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_ENVIRONMENT
New in version 3.17.

Specify environment variables that should be added to the Arguments section of the generated Xcode
scheme.

If set to a list of environment variables and values of the form MYVAR=value those environment variables
will be added to the scheme.

This variable initializes the XCODE_SCHEME_ENVIRONMENT property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_GUARD_MALLOC
New in version 3.13.

Whether to enable Guard Malloc in the Diagnostics section of the generated Xcode scheme.

This variable initializes the XCODE_SCHEME_GUARD_MALLOC property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP
New in version 3.13.

Whether to enable the Main Thread Checker option Pause on issues in the Diagnostics section of the
generated Xcode scheme.

This variable initializes the XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_MALLOC_GUARD_EDGES
New in version 3.13.

Whether to enable Malloc Guard Edges in the Diagnostics section of the generated Xcode scheme.

This variable initializes the XCODE_SCHEME_MALLOC_GUARD_EDGES property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_MALLOC_SCRIBBLE
New in version 3.13.

Whether to enable Malloc Scribble in the Diagnostics section of the generated Xcode scheme.

This variable initializes the XCODE_SCHEME_MALLOC_SCRIBBLE property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_MALLOC_STACK
New in version 3.13.

Whether to enable Malloc Stack in the Diagnostics section of the generated Xcode scheme.

This variable initializes the XCODE_SCHEME_MALLOC_STACK property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_THREAD_SANITIZER
New in version 3.13.

Whether to enable Thread Sanitizer in the Diagnostics section of the generated Xcode scheme.

This variable initializes the XCODE_SCHEME_THREAD_SANITIZER property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_THREAD_SANITIZER_STOP
New in version 3.13.

Whether to enable Thread Sanitizer - Pause on issues in the Diagnostics section of the generated Xcode
scheme.

This variable initializes the XCODE_SCHEME_THREAD_SANITIZER_STOP property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER
New in version 3.13.

Whether to enable Undefined Behavior Sanitizer in the Diagnostics section of the generated Xcode scheme.

This variable initializes the XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP
New in version 3.13.

Whether to enable Undefined Behavior Sanitizer option Pause on issues in the Diagnostics section of the
generated Xcode scheme.

This variable initializes the XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_WORKING_DIRECTORY
New in version 3.17.

Specify the Working Directory of the Run and Profile actions in the generated Xcode scheme.

This variable initializes the XCODE_SCHEME_WORKING_DIRECTORY property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

CMAKE_XCODE_SCHEME_ZOMBIE_OBJECTS
New in version 3.13.

Whether to enable Zombie Objects in the Diagnostics section of the generated Xcode scheme.

This variable initializes the XCODE_SCHEME_ZOMBIE_OBJECTS property on all targets.

Please refer to the XCODE_GENERATE_SCHEME target property documentation to see all Xcode schema related
properties.

<PackageName>_ROOT
New in version 3.12.

Calls to find_package(<PackageName>) will search in prefixes specified by the <PackageName>_ROOT CMake
variable, where <PackageName> is the name given to the find_package() call and _ROOT is literal. For
example, find_package(Foo) will search prefixes specified in the Foo_ROOT CMake variable (if set). See
policy CMP0074.

This variable may hold a single prefix or a semicolon-separated list of multiple prefixes.

See also the <PackageName>_ROOT environment variable.

VARIABLES THAT DESCRIBE THE SYSTEM

ANDROID
New in version 3.7.

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_ANDROID_NDK_VERSION
New in version 3.20.

When Cross Compiling for Android with the NDK and using an Android NDK version 11 or higher, this
variable is provided by CMake to report the NDK version number.

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 macOS operating systems.

Set to true when the host system is Apple macOS.

CMAKE_HOST_SOLARIS
New in version 3.6.

True for Oracle Solaris operating systems.

Set to true when the host system is Oracle Solaris.

CMAKE_HOST_SYSTEM
Composite 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 macOS are the values found on the big three operating systems.

CMAKE_HOST_SYSTEM_PROCESSOR
The name of the CPU CMake is running on.

Windows Platforms
On Windows, this variable is set to the value of the environment variable PROCESSOR_ARCHITECTURE.

Unix Platforms
On systems that support uname, this variable is set to the output of:

• uname -m on GNU, Linux, Cygwin, Android, or

• arch on OpenBSD, or

• on other systems,

• uname -p if its exit code is nonzero, or

• uname -m otherwise.

macOS Platforms
The value of uname -m is used by default.

On Apple Silicon hosts, the architecture printed by uname -m may vary based on CMake's own architecture
and that of the invoking process tree.

New in version 3.19.2: On Apple Silicon hosts:

• The CMAKE_APPLE_SILICON_PROCESSOR variable or the CMAKE_APPLE_SILICON_PROCESSOR environment variable
may be set to specify the host architecture explicitly.

• If CMAKE_OSX_ARCHITECTURES is not set, CMake adds explicit flags to tell the compiler to build for the
host architecture so the toolchain does not have to guess based on the process tree's 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.

Note that CMAKE_SYSTEM_NAME is not set to anything by default when running in script mode, since it's not
building anything.

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
When not cross-compiling, this variable has the same value as the CMAKE_HOST_SYSTEM_PROCESSOR variable.
In many cases, this will correspond to the target architecture for the build, but this is not guaranteed.
(E.g. on Windows, the host may be AMD64 even when using a MSVC cl compiler with a 32-bit target.)

When cross-compiling, a CMAKE_TOOLCHAIN_FILE should set the CMAKE_SYSTEM_PROCESSOR variable to match
target architecture that it specifies (via CMAKE_<LANG>_COMPILER and perhaps
CMAKE_<LANG>_COMPILER_TARGET).

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.

GHS-MULTI
New in version 3.3.

True when using Green Hills MULTI generator.

IOS
New in version 3.14.

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

MINGW
New in version 3.2.

True when using MinGW

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

MSVC
Set to true when the compiler is some version of Microsoft Visual C++ or another compiler simulating the
Visual C++ cl command-line syntax.

VARIABLES THAT CONTROL THE BUILD

CMAKE_AIX_EXPORT_ALL_SYMBOLS
New in version 3.17.

Default value for AIX_EXPORT_ALL_SYMBOLS target property. This variable is used to initialize the
property on each target as it is created.

CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS
New in version 3.4.

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

CMAKE_ANDROID_API
New in version 3.1.

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
New in version 3.2.

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

CMAKE_ANDROID_ARCH
New in version 3.4.

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
New in version 3.7.

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
New in version 3.7.

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
New in version 3.7.

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
New in version 3.4.

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

CMAKE_ANDROID_EXCEPTIONS
New in version 3.20.

When Cross Compiling for Android with the NDK, this variable may be set to specify whether exceptions are
enabled.

CMAKE_ANDROID_GUI
New in version 3.1.

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

CMAKE_ANDROID_JAR_DEPENDENCIES
New in version 3.4.

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

CMAKE_ANDROID_JAR_DIRECTORIES
New in version 3.4.

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

CMAKE_ANDROID_JAVA_SOURCE_DIR
New in version 3.4.

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

CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES
New in version 3.4.

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

CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES
New in version 3.4.

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

CMAKE_ANDROID_NDK
New in version 3.7.

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
New in version 3.9.

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
New in version 3.7.1.

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
New in version 3.7.

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.

On NDK r19 or above, this variable must be unset or set to clang.

On NDK r18 or below, this 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
New in version 3.4.

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

CMAKE_ANDROID_PROGUARD
New in version 3.4.

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

CMAKE_ANDROID_PROGUARD_CONFIG_PATH
New in version 3.4.

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

CMAKE_ANDROID_RTTI
New in version 3.20.

When Cross Compiling for Android with the NDK, this variable may be set to specify whether RTTI is
enabled.

CMAKE_ANDROID_SECURE_PROPS_PATH
New in version 3.4.

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

CMAKE_ANDROID_SKIP_ANT_STEP
New in version 3.4.

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

CMAKE_ANDROID_STANDALONE_TOOLCHAIN
New in version 3.7.

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
New in version 3.4.

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 on NDK versions that provide it and otherwise c++_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_APPLE_SILICON_PROCESSOR
New in version 3.19.2.

On Apple Silicon hosts running macOS, set this variable to tell CMake what architecture to use for
CMAKE_HOST_SYSTEM_PROCESSOR. The value must be either arm64 or x86_64.

The value of this variable should never be modified by project code. It is meant to be set as a cache
entry provided by the user, e.g. via -DCMAKE_APPLE_SILICON_PROCESSOR=....

See also the CMAKE_APPLE_SILICON_PROCESSOR environment variable.

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>
New in version 3.3.

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_AUTOGEN_ORIGIN_DEPENDS
New in version 3.14.

Switch for forwarding origin target dependencies to the corresponding _autogen targets.

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

By default CMAKE_AUTOGEN_ORIGIN_DEPENDS is ON.

CMAKE_AUTOGEN_PARALLEL
New in version 3.11.

Number of parallel moc or uic processes to start when using AUTOMOC and AUTOUIC.

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

By default CMAKE_AUTOGEN_PARALLEL is unset.

CMAKE_AUTOGEN_VERBOSE
New in version 3.13.

Sets the verbosity of AUTOMOC, AUTOUIC and AUTORCC. A positive integer value or a true boolean value
lets the AUTO* generators output additional processing information.

Setting CMAKE_AUTOGEN_VERBOSE has the same effect as setting the VERBOSE environment variable during
generation (e.g. by calling make VERBOSE=1). The extra verbosity is limited to the AUTO* generators
though.

By default CMAKE_AUTOGEN_VERBOSE is unset.

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
New in version 3.10.

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
New in version 3.9.

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
New in version 3.10.

Semicolon-separated 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;Q_NAMESPACE_EXPORT.

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_AUTOMOC_PATH_PREFIX
New in version 3.16.

Whether to generate the -p path prefix option for moc on AUTOMOC enabled Qt targets.

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

The default value is OFF.

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
New in version 3.9.

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
New in version 3.8.

Semicolon-separated 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_RPATH_USE_ORIGIN
New in version 3.14.

Whether to use relative paths for the build RPATH.

This is used to initialize the BUILD_RPATH_USE_ORIGIN target property for all targets, see that property
for more details.

CMAKE_BUILD_WITH_INSTALL_NAME_DIR
New in version 3.9.

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
New in version 3.1.

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>
New in version 3.1.

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_CROSS_CONFIGS
New in version 3.17.

Specifies a semicolon-separated list of configurations available from all build-<Config>.ninja files in
the Ninja Multi-Config generator. This variable activates cross-config mode. Targets from each config
specified in this variable can be built from any build-<Config>.ninja file. Custom commands will use the
configuration native to build-<Config>.ninja. If it is set to all, all configurations from
CMAKE_CONFIGURATION_TYPES are cross-configs. If it is not specified, or empty, each build-<Config>.ninja
file will only contain build rules for its own configuration.

The value of this variable must be a subset of CMAKE_CONFIGURATION_TYPES.

CMAKE_CTEST_ARGUMENTS
New in version 3.17.

Set this to a semicolon-separated list of command-line arguments to pass to ctest(1) when running tests
through the test (or RUN_TESTS) target of the generated build system.

CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS
New in version 3.16.

Default value for CUDA_RESOLVE_DEVICE_SYMBOLS target property. This variable is used to initialize the
property on each target as it is created.

CMAKE_CUDA_RUNTIME_LIBRARY
New in version 3.17.

Select the CUDA runtime library for use when compiling and linking CUDA. This variable is used to
initialize the CUDA_RUNTIME_LIBRARY property on all targets as they are created.

The allowed case insensitive values are:

None Link with -cudart=none or equivalent flag(s) to use no CUDA runtime library.

Shared Link with -cudart=shared or equivalent flag(s) to use a dynamically-linked CUDA runtime library.

Static Link with -cudart=static or equivalent flag(s) to use a statically-linked CUDA runtime library.

Contents of CMAKE_CUDA_RUNTIME_LIBRARY may use generator expressions.

If this variable is not set then the CUDA_RUNTIME_LIBRARY target property will not be set automatically.
If that property is not set then CMake uses an appropriate default value based on the compiler to select
the CUDA runtime library.

NOTE:
This property has effect only when the CUDA language is enabled. To control the CUDA runtime linking
when only using the CUDA SDK with the C or C++ language we recommend using the FindCUDAToolkit module.

CMAKE_CUDA_SEPARABLE_COMPILATION
New in version 3.11.

Default value for CUDA_SEPARABLE_COMPILATION target property. This variable is used to initialize the
property on each target as it is created.

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_DEFAULT_BUILD_TYPE
New in version 3.17.

Specifies the configuration to use by default in a build.ninja file in the Ninja Multi-Config generator.
If this variable is specified, build.ninja uses build rules from build-<Config>.ninja by default. All
custom commands are executed with this configuration. If the variable is not specified, the first item
from CMAKE_CONFIGURATION_TYPES is used instead.

The value of this variable must be one of the items from CMAKE_CONFIGURATION_TYPES.

CMAKE_DEFAULT_CONFIGS
New in version 3.17.

Specifies a semicolon-separated list of configurations to build for a target in build.ninja if no
:<Config> suffix is specified in the Ninja Multi-Config generator. If it is set to all, all
configurations from CMAKE_CROSS_CONFIGS are used. If it is not specified, it defaults to
CMAKE_DEFAULT_BUILD_TYPE.

For example, if you set CMAKE_DEFAULT_BUILD_TYPE to Release, but set CMAKE_DEFAULT_CONFIGS to Debug or
all, all <target> aliases in build.ninja will resolve to <target>:Debug or <target>:all, but custom
commands will still use the Release configuration.

The value of this variable must be a subset of CMAKE_CROSS_CONFIGS or be the same as
CMAKE_DEFAULT_BUILD_TYPE. It must not be specified if CMAKE_DEFAULT_BUILD_TYPE or CMAKE_CROSS_CONFIGS is
not used.

CMAKE_DISABLE_PRECOMPILE_HEADERS
New in version 3.16.

Default value for DISABLE_PRECOMPILE_HEADERS of targets.

By default CMAKE_DISABLE_PRECOMPILE_HEADERS is OFF.

CMAKE_DEPENDS_USE_COMPILER
New in version 3.20.

For the Makefile Generators, source dependencies are now, for a selection of compilers, generated by the
compiler itself. By defining this variable with value FALSE, you can restore the legacy behavior (i.e.
using CMake for dependencies discovery).

CMAKE_ENABLE_EXPORTS
New in version 3.4.

Specify whether executables export symbols for loadable modules.

This variable is used to initialize the ENABLE_EXPORTS target property for executable targets when they
are created by calls to the add_executable() command. See the property documentation for details.

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
New in version 3.7.

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
New in version 3.7.

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

CMAKE_COMPILER_IS_GNUCXX
New in version 3.7.

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

CMAKE_COMPILER_IS_GNUG77
New in version 3.7.

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

CMAKE_CUDA_ARCHITECTURES
New in version 3.18.

Default value for CUDA_ARCHITECTURES property of targets.

Initialized by the CUDAARCHS environment variable if set. Otherwise as follows depending on
CMAKE_CUDA_COMPILER_ID:

• For Clang: the oldest architecture that works.

• For NVIDIA: the default architecture chosen by the compiler. See policy CMP0104.

Users are encouraged to override this, as the default varies across compilers and compiler versions.

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

Examples
cmake_minimum_required(VERSION)

if(NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
set(CMAKE_CUDA_ARCHITECTURES 75)
endif()

project(example LANGUAGES CUDA)

CMAKE_CUDA_ARCHITECTURES will default to 75 unless overridden by the user.

CMAKE_CUDA_COMPILE_FEATURES
New in version 3.17.

List of features known to the CUDA compiler

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

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

CMAKE_CUDA_EXTENSIONS
New in version 3.8.

Default value for CUDA_EXTENSIONS target property if set when a target is created.

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

CMAKE_CUDA_HOST_COMPILER
New in version 3.10.

When CMAKE_CUDA_COMPILER_ID is NVIDIA, CMAKE_CUDA_HOST_COMPILER selects the compiler executable to use
when compiling host code for CUDA language files. This maps to the nvcc -ccbin option.

The CMAKE_CUDA_HOST_COMPILER variable may be set explicitly before CUDA is first enabled by a project()
or enable_language() command. This can be done via -DCMAKE_CUDA_HOST_COMPILER=... on the command line or
in a toolchain file. Or, one may set the CUDAHOSTCXX environment variable to provide a default value.

Once the CUDA language is enabled, the CMAKE_CUDA_HOST_COMPILER variable is read-only and changes to it
are undefined behavior.

NOTE:
Since CMAKE_CUDA_HOST_COMPILER is meaningful only when the CMAKE_CUDA_COMPILER_ID is NVIDIA, it does
not make sense to set CMAKE_CUDA_HOST_COMPILER without also setting CMAKE_CUDA_COMPILER to NVCC.

NOTE:
Ignored when using Visual Studio Generators.

CMAKE_CUDA_STANDARD
New in version 3.8.

Default value for CUDA_STANDARD target property if set when a target is created.

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

CMAKE_CUDA_STANDARD_REQUIRED
New in version 3.8.

Default value for CUDA_STANDARD_REQUIRED target property if set when a target is created.

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

CMAKE_CUDA_TOOLKIT_INCLUDE_DIRECTORIES
New in version 3.8.

When the CUDA language has been enabled, this provides a semicolon-separated 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
New in version 3.1.

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
New in version 3.1.

Default value for CXX_EXTENSIONS target property if set when a target is created.

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

CMAKE_CXX_STANDARD
New in version 3.1.

Default value for CXX_STANDARD target property if set when a target is created.

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

CMAKE_CXX_STANDARD_REQUIRED
New in version 3.1.

Default value for CXX_STANDARD_REQUIRED target property if set when a target is created.

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

CMAKE_C_COMPILE_FEATURES
New in version 3.1.

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
New in version 3.1.

Default value for C_EXTENSIONS target property if set when a target is created.

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

CMAKE_C_STANDARD
New in version 3.1.

Default value for C_STANDARD target property if set when a target is created.

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

CMAKE_C_STANDARD_REQUIRED
New in version 3.1.

Default value for C_STANDARD_REQUIRED target property if set when a target is created.

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_HIP_ARCHITECTURES
New in version 3.21.

Default value for HIP_ARCHITECTURES property of targets.

This is initialized to the architectures reported by rocm_agent_enumerator, if available, and otherwise
to the default chosen by the compiler.

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

CMAKE_HIP_EXTENSIONS
New in version 3.21.

Default value for HIP_EXTENSIONS target property if set when a target is created.

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

CMAKE_HIP_STANDARD
New in version 3.21.

Default value for HIP_STANDARD target property if set when a target is created.

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

CMAKE_HIP_STANDARD_REQUIRED
New in version 3.21.

Default value for HIP_STANDARD_REQUIRED target property if set when a target is created.

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

CMAKE_ISPC_HEADER_DIRECTORY
New in version 3.19.

ISPC generated header output directory.

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

CMAKE_ISPC_HEADER_SUFFIX
New in version 3.19.2.

Output suffix to be used for ISPC generated headers.

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

CMAKE_ISPC_INSTRUCTION_SETS
New in version 3.19.

Default value for ISPC_INSTRUCTION_SETS property of targets.

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

CMAKE_<LANG>_ANDROID_TOOLCHAIN_MACHINE
New in version 3.7.1.

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
New in version 3.7.

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
New in version 3.7.

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>_BYTE_ORDER
New in version 3.20.

Byte order of <LANG> compiler target architecture, if known. If defined and not empty, the value is one
of:

BIG_ENDIAN
The target architecture is Big Endian.

LITTLE_ENDIAN
The target architecture is Little Endian.

This is defined for languages C, CXX, OBJC, OBJCXX, and CUDA.

If CMAKE_OSX_ARCHITECTURES specifies multiple architectures, the value of CMAKE_<LANG>_BYTE_ORDER is
non-empty only if all architectures share the same byte order.

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.

Usage
This variable can be set by the user during the first time a build tree is configured.

If a non-full path value is supplied then CMake will resolve the full path of the compiler.

The variable could be set in a user supplied toolchain file or via -D on the command line.

NOTE:
Options that are required to make the compiler work correctly can be included as items in a list; they
can not be changed.

#set within user supplied toolchain file
set(CMAKE_C_COMPILER /full/path/to/qcc --arg1 --arg2)

$ cmake ... -DCMAKE_C_COMPILER='qcc;--arg1;--arg2'

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 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)
ARMClang = ARM Compiler based on Clang (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)
Flang = Flang LLVM Fortran Compiler
Fujitsu = Fujitsu HPC compiler (Trad mode)
FujitsuClang = Fujitsu HPC compiler (Clang mode)
G95 = G95 Fortran (g95.org)
GNU = GNU Compiler Collection (gcc.gnu.org)
GHS = Green Hills Software (www.ghs.com)
HP = Hewlett-Packard Compiler (hp.com)
IAR = IAR Systems (iar.com)
Intel = Intel Compiler (intel.com)
IntelLLVM = Intel LLVM-Based Compiler (intel.com)
MSVC = Microsoft Visual Studio (microsoft.com)
NVHPC = NVIDIA HPC SDK Compiler (nvidia.com)
NVIDIA = NVIDIA CUDA Compiler (nvidia.com)
OpenWatcom = Open Watcom (openwatcom.org)
PGI = The Portland Group (pgroup.com)
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)
XLClang = IBM Clang-based 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
New in version 3.10.

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>_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>. This
rule variable is a ; delimited list of commands to run to perform the linking step.

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>. This
rule variable is a ; delimited list of commands to run.

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>_EXTENSIONS
The variations are:

• CMAKE_C_EXTENSIONS

• CMAKE_CXX_EXTENSIONS

• CMAKE_CUDA_EXTENSIONS

• CMAKE_HIP_EXTENSIONS

• CMAKE_OBJC_EXTENSIONS

• CMAKE_OBJCXX_EXTENSIONS

Default values for <LANG>_EXTENSIONS target properties if set when a target is created. For the
compiler's default setting see CMAKE_<LANG>_EXTENSIONS_DEFAULT.

For supported CMake versions see the respective pages.

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

CMAKE_<LANG>_EXTENSIONS_DEFAULT
New in version 3.22.

Compiler's default extensions mode. Used as the default for the <LANG>_EXTENSIONS target property when
CMAKE_<LANG>_EXTENSIONS is not set (see CMP0128).

This variable is read-only. Modifying it is undefined behavior.

CMAKE_<LANG>_FLAGS
Flags for all build types.

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

This is initialized for each language from environment variables:

• CMAKE_C_FLAGS: Initialized by the CFLAGS environment variable.

• CMAKE_CXX_FLAGS: Initialized by the CXXFLAGS environment variable.

• CMAKE_CUDA_FLAGS: Initialized by the CUDAFLAGS environment variable.

• CMAKE_Fortran_FLAGS: Initialized by the FFLAGS environment variable.

This value is a command-line string fragment. Therefore, multiple options should be separated by spaces,
and options with spaces should be quoted.

The flags in this variable will be passed to the compiler before those in the per-configuration
CMAKE_<LANG>_FLAGS_<CONFIG> variant, and before flags added by the add_compile_options() or
target_compile_options() commands.

CMAKE_<LANG>_FLAGS_<CONFIG>
Flags for language <LANG> when building for the <CONFIG> configuration.

The flags in this variable will be passed to the compiler after those in the CMAKE_<LANG>_FLAGS variable,
but before flags added by the add_compile_options() or target_compile_options() commands.

CMAKE_<LANG>_FLAGS_<CONFIG>_INIT
New in version 3.11.

Value used to initialize the CMAKE_<LANG>_FLAGS_<CONFIG> 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.

VARIABLES FOR CTEST

CTEST_BINARY_DIRECTORY
New in version 3.1.

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

CTEST_BUILD_COMMAND
New in version 3.1.

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

CTEST_BUILD_NAME
New in version 3.1.

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

CTEST_BZR_COMMAND
New in version 3.1.

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

CTEST_BZR_UPDATE_OPTIONS
New in version 3.1.

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

CTEST_CHANGE_ID
New in version 3.4.

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
New in version 3.1.

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

CTEST_CONFIGURATION_TYPE
New in version 3.1.

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

If the configuration type is set via -C <cfg> from the command line then this variable is populated
accordingly.

CTEST_CONFIGURE_COMMAND
New in version 3.1.

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

CTEST_COVERAGE_COMMAND
New in version 3.1.

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
New in version 3.1.

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

CTEST_CURL_OPTIONS
New in version 3.1.

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).

If a test's output contains the literal string "CTEST_FULL_OUTPUT", the output will not be truncated and
may exceed the maximum size.

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

For controlling the output collection of passing tests, see CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.

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).

If a test's output contains the literal string "CTEST_FULL_OUTPUT", the output will not be truncated and
may exceed the maximum size.

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

For controlling the output collection of failing tests, see CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.

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_TESTS_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_build() 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_build() command.

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

CTEST_CVS_CHECKOUT
New in version 3.1.

Deprecated. Use CTEST_CHECKOUT_COMMAND instead.

CTEST_CVS_COMMAND
New in version 3.1.

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

CTEST_CVS_UPDATE_OPTIONS
New in version 3.1.

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

CTEST_DROP_LOCATION
New in version 3.1.

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

CTEST_DROP_METHOD
New in version 3.1.

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

CTEST_DROP_SITE
New in version 3.1.

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

CTEST_DROP_SITE_CDASH
New in version 3.1.

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

CTEST_DROP_SITE_PASSWORD
New in version 3.1.

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

CTEST_DROP_SITE_USER
New in version 3.1.

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

CTEST_EXTRA_COVERAGE_GLOB
New in version 3.4.

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
New in version 3.1.

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

CTEST_GIT_INIT_SUBMODULES
New in version 3.6.

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

CTEST_GIT_UPDATE_CUSTOM
New in version 3.1.

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

CTEST_GIT_UPDATE_OPTIONS
New in version 3.1.

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

CTEST_HG_COMMAND
New in version 3.1.

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

CTEST_HG_UPDATE_OPTIONS
New in version 3.1.

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

CTEST_LABELS_FOR_SUBPROJECTS
New in version 3.10.

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

CTEST_MEMORYCHECK_COMMAND
New in version 3.1.

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

CTEST_MEMORYCHECK_COMMAND_OPTIONS
New in version 3.1.

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

CTEST_MEMORYCHECK_SANITIZER_OPTIONS
New in version 3.1.

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

CTest prepends correct sanitizer options *_OPTIONS environment variable to executed command. CTests adds
its own log_path to sanitizer options, don't provide your own log_path.

CTEST_MEMORYCHECK_SUPPRESSIONS_FILE
New in version 3.1.

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

CTEST_MEMORYCHECK_TYPE
New in version 3.1.

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

CTEST_NIGHTLY_START_TIME
New in version 3.1.

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

Note that this variable must always be set for a nightly build in a dashboard script. It is needed so
that nightly builds can be properly grouped together in CDash.

CTEST_P4_CLIENT
New in version 3.1.

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

CTEST_P4_COMMAND
New in version 3.1.

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

CTEST_P4_OPTIONS
New in version 3.1.

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

CTEST_P4_UPDATE_OPTIONS
New in version 3.1.

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

CTEST_RESOURCE_SPEC_FILE
New in version 3.18.

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

This can also be used to specify the resource spec file from a CMake build. If no RESOURCE_SPEC_FILE is
passed to ctest_test(), and CTEST_RESOURCE_SPEC_FILE is not specified in the dashboard script, the value
of this variable from the build is used.

CTEST_RUN_CURRENT_SCRIPT
New in version 3.11.

Setting this to 0 prevents ctest(1) from being run again when it reaches the end of a script run by
calling ctest -S.

CTEST_SCP_COMMAND
New in version 3.1.

Legacy option. Not used.

CTEST_SCRIPT_DIRECTORY
The directory containing the top-level CTest script. The concept is similar to CMAKE_SOURCE_DIR.

CTEST_SITE
New in version 3.1.

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

CTEST_SUBMIT_URL
New in version 3.14.

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

CTEST_SOURCE_DIRECTORY
New in version 3.1.

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

CTEST_SVN_COMMAND
New in version 3.1.

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

CTEST_SVN_OPTIONS
New in version 3.1.

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

CTEST_SVN_UPDATE_OPTIONS
New in version 3.1.

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

CTEST_TEST_LOAD
New in version 3.4.

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
New in version 3.1.

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

CTEST_TRIGGER_SITE
New in version 3.1.

Legacy option. Not used.

CTEST_UPDATE_COMMAND
New in version 3.1.

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

CTEST_UPDATE_OPTIONS
New in version 3.1.

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

CTEST_UPDATE_VERSION_ONLY
New in version 3.1.

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

CTEST_UPDATE_VERSION_OVERRIDE
New in version 3.15.

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

CTEST_USE_LAUNCHERS
New in version 3.1.

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_CUSTOM_INSTALL_VARIABLES
New in version 3.21.

CPack variables (set via e.g. cpack -D, CPackConfig.cmake or CPACK_PROJECT_CONFIG_FILE scripts) are not
directly visible in installation scripts. Instead, one can pass a list of varName=value pairs in the
CPACK_CUSTOM_INSTALL_VARIABLES variable. At install time, each list item will result in a variable of
the specified name (varName) being set to the given value. The = can be omitted for an empty value.

CPACK_CUSTOM_INSTALL_VARIABLES allows the packaging installation to be influenced by the user or driving
script at CPack runtime without having to regenerate the install scripts.

Example
install(FILES large.txt DESTINATION data)

install(CODE [[
if(ENABLE_COMPRESSION)
# "run-compressor" is a fictional tool that produces
# large.txt.xz from large.txt and then removes the input file
execute_process(COMMAND run-compressor $ENV{DESTDIR}${CMAKE_INSTALL_PREFIX}/large.txt)
endif()
]])

With the above example snippet, cpack will by default run the installation script with ENABLE_COMPRESSION
unset, resulting in a package containing the uncompressed large.txt. This can be overridden when
invoking cpack like so:

cpack -D "CPACK_CUSTOM_INSTALL_VARIABLES=ENABLE_COMPRESSION=TRUE"

The installation script will then run with ENABLE_COMPRESSION set to TRUE, resulting in a package
containing the compressed large.txt.xz instead.

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_DEFAULT_DIRECTORY_PERMISSIONS
New in version 3.11.

Default permissions for implicitly created directories during packaging.

This variable serves the same purpose during packaging as the CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS
variable serves during installation (e.g. make install).

If include(CPack) is used then by default this variable is set to the content of
CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS.

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.

VARIABLE EXPANSION OPERATORS

   CACHE
       New in version 3.13.

       Operator to read cache variables.

       Use the syntax $CACHE{VAR} to read cache entry VAR.  See the  cmake-language(7)  variables  documentation
       for more complete documentation of the interaction of normal variables and cache entries.

       When  evaluating  Variable References of the form ${VAR}, CMake first searches for a normal variable with
       that name, and if not found CMake will search for a cache entry with that name.  The  $CACHE{VAR}  syntax
       can be used to do direct cache lookup and ignore any existing normal variable.

       See the set() and unset() commands to see how to write or remove cache variables.

   ENV
       Operator to read environment variables.

       Use the syntax $ENV{VAR} to read environment variable VAR.

       To test whether an environment variable is defined, use the signature if(DEFINED ENV{<name>}) of the if()
       command.

       See the set() and unset() commands to see how to write or remove environment variables.

INTERNAL VARIABLES

CMake has many internal variables. Most of them are undocumented. Some of them, however, were at some
point described as normal variables, and therefore may be encountered in legacy code. They are subject to
change, and not recommended for use in project code.

CMAKE_HOME_DIRECTORY
Path to top of source tree. Same as CMAKE_SOURCE_DIR.

This is an internal cache entry used to locate the source directory when loading a CMakeCache.txt from a
build tree. It should not be used in project code. The variable CMAKE_SOURCE_DIR has the same value and
should be preferred.

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>_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
New in version 3.10.

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_VERSION_INTERNAL
New in version 3.10.

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>_PLATFORM_ID
An internal variable subject to change.

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

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_VS_INTEL_Fortran_PROJECT_VERSION
When generating for Visual Studio 9 2008 or greater with the Intel Fortran plugin installed, this
specifies the .vfproj project file format version. This is intended for internal use by CMake and should
not be used by project code.

COPYRIGHT

       2000-2024 Kitware, Inc. and Contributors