CMAKE_ARGC¶

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¶

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_AR¶

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

CMAKE_BINARY_DIR¶

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¶

CMAKE_CACHEFILE_DIR¶

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

CMAKE_CACHE_MAJOR_VERSION¶

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¶

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¶

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

CMAKE_CFG_INTDIR¶

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 7, 8, 9
$(Configuration)     = Visual Studio 10
$(CONFIGURATION)     = Xcode
.                    = Make-based tools

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

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

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

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

CMAKE_COMMAND¶

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

CMAKE_CROSSCOMPILING¶

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

CMAKE_CROSSCOMPILING_EMULATOR¶

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¶

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¶

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

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

CMAKE_CURRENT_LIST_DIR¶

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.

See also CMAKE_CURRENT_LIST_FILE.

CMAKE_CURRENT_LIST_FILE¶

As CMake processes the listfiles in your project this variable will always be set to the one currently being processed. The value has dynamic scope. When CMake starts processing commands in a source file it sets this variable to the location of the file. 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 file invoking the bottom-most entry on the call stack, not the file containing the macro or function definition.

See also CMAKE_PARENT_LIST_FILE.

CMAKE_CURRENT_LIST_LINE¶

This is the line number of the file currently being processed by cmake.

CMAKE_CURRENT_SOURCE_DIR¶

This the full path to the source directory that is currently being processed by cmake.

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_DL_LIBS¶

The name of the library that has dlopen and dlclose in it, usually -ldl on most UNIX machines.

CMAKE_EDIT_COMMAND¶

This is the full path to the CMake executable that can graphically edit the cache. For example, cmake-gui(1) or ccmake(1).

CMAKE_EXECUTABLE_SUFFIX¶

The suffix to use for the end of an executable filename if any, .exe on Windows.

CMAKE_EXECUTABLE_SUFFIX_<LANG> overrides this for language <LANG>.

CMAKE_EXTRA_GENERATOR¶

When using the Eclipse, CodeBlocks or KDevelop generators, CMake generates Makefiles (CMAKE_GENERATOR) and additionally project files for the respective IDE. This IDE project file generator is stored in CMAKE_EXTRA_GENERATOR (e.g. Eclipse CDT4).

CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES¶

Extensions for shared libraries other than that specified by CMAKE_SHARED_LIBRARY_SUFFIX, if any. CMake uses this to recognize external shared library files during analysis of libraries linked by a target.

CMAKE_FIND_PACKAGE_NAME¶

CMAKE_FIND_PACKAGE_SORT_DIRECTION¶

If CMAKE_FIND_PACKAGE_SORT_ORDER is not set or is set to NONE this variable has no effect.

CMAKE_FIND_PACKAGE_SORT_ORDER¶

Natural sorting can be employed to return the highest version when multiple versions of the same library are found by find_package(). For example suppose that the following libraries have been found:

By setting NATURAL order we can select the one with the highest version number libX-1.2.10.

set(CMAKE_FIND_PACKAGE_SORT_ORDER NATURAL)
find_package(libX CONFIG)

The sort direction can be controlled using the CMAKE_FIND_PACKAGE_SORT_DIRECTION variable (by default decrescent, e.g. lib-B will be tested before lib-A).

CMAKE_GENERATOR¶

The name of the generator that is being used to generate the build files. (e.g. Unix Makefiles, Ninja, etc.)

CMAKE_GENERATOR_PLATFORM¶

Some CMake generators support a target platform name to be given to the native build system to choose a compiler toolchain. If the user specifies a platform name (e.g. via the cmake(1) -A option) the value will be available in this variable.

The value of this variable should never be modified by project code. A toolchain file specified by the CMAKE_TOOLCHAIN_FILE variable may initialize CMAKE_GENERATOR_PLATFORM. Once a given build tree has been initialized with a particular value for this variable, changing the value has undefined behavior.

CMAKE_GENERATOR_TOOLSET¶

Some CMake generators support a toolset name to be given to the native build system to choose a compiler. If the user specifies a toolset name (e.g. via the cmake(1) -T option) the value will be available in this variable.

The value of this variable should never be modified by project code. A toolchain file specified by the CMAKE_TOOLCHAIN_FILE variable may initialize CMAKE_GENERATOR_TOOLSET. Once a given build tree has been initialized with a particular value for this variable, changing the value has undefined behavior.

CMAKE_HOME_DIRECTORY¶

This is the path to the top level of the source tree.

CMAKE_IMPORT_LIBRARY_PREFIX¶

The prefix to use for the name of an import library if used on this platform.

CMAKE_IMPORT_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>.

CMAKE_IMPORT_LIBRARY_SUFFIX¶

The suffix to use for the end of an import library filename if used on this platform.

CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>.

CMAKE_JOB_POOL_COMPILE¶

CMAKE_JOB_POOL_LINK¶

CMAKE_LINK_LIBRARY_SUFFIX¶

The suffix to use for the end of a library filename, .lib on Windows.

CMAKE_LINK_SEARCH_END_STATIC¶

Some linkers support switches such as -Bstatic and -Bdynamic to determine whether to use static or shared libraries for -lXXX options. CMake uses these options to set the link type for libraries whose full paths are not known or (in some cases) are in implicit link directories for the platform. By default CMake adds an option at the end of the library list (if necessary) to set the linker search type back to its starting type. This property switches the final linker search type to -Bstatic regardless of how it started.

This variable is used to initialize the target property LINK_SEARCH_END_STATIC for all targets. If set, it's value is also used by the try_compile() command.

See also CMAKE_LINK_SEARCH_START_STATIC.

CMAKE_LINK_SEARCH_START_STATIC¶

Some linkers support switches such as -Bstatic and -Bdynamic to determine whether to use static or shared libraries for -lXXX options. CMake uses these options to set the link type for libraries whose full paths are not known or (in some cases) are in implicit link directories for the platform. By default the linker search type is assumed to be -Bdynamic at the beginning of the library list. This property switches the assumption to -Bstatic. It is intended for use when linking an executable statically (e.g. with the GNU -static option).

This variable is used to initialize the target property LINK_SEARCH_START_STATIC for all targets. If set, it's value is also used by the try_compile() command.

See also CMAKE_LINK_SEARCH_END_STATIC.

CMAKE_MAJOR_VERSION¶

CMAKE_MAKE_PROGRAM¶

The tool selected depends on the CMAKE_GENERATOR used to configure the project:

The CMAKE_MAKE_PROGRAM variable is set for use by project code. The value is also used by the cmake(1) --build and ctest(1) --build-and-test tools to launch the native build process.

CMAKE_MATCH_COUNT¶

When a regular expression match is used, CMake fills in CMAKE_MATCH_<n> variables with the match contents. The CMAKE_MATCH_COUNT variable holds the number of match expressions when these are filled.

CMAKE_MINIMUM_REQUIRED_VERSION¶

Variable containing the VERSION component specified in the cmake_minimum_required() command.

CMAKE_MINOR_VERSION¶

CMAKE_PARENT_LIST_FILE¶

While processing a CMake file loaded by include() or find_package() this variable contains the full path to the file including it. The top of the include stack is always the CMakeLists.txt for the current directory. See also CMAKE_CURRENT_LIST_FILE.

CMAKE_PATCH_VERSION¶

CMAKE_PROJECT_NAME¶

This specifies name of the current project from the closest inherited project() command.

CMAKE_RANLIB¶

This specifies name of the program that randomizes libraries on UNIX, not used on Windows, but may be present.

CMAKE_ROOT¶

This is the install root for the running CMake and the Modules directory can be found here. This is commonly used in this format: ${CMAKE_ROOT}/Modules

CMAKE_SCRIPT_MODE_FILE¶

When run in cmake(1) -P script mode, CMake sets this variable to the full path of the script file. When run to configure a CMakeLists.txt file, this variable is not set.

CMAKE_SHARED_LIBRARY_PREFIX¶

The prefix to use for the name of a shared library, lib on UNIX.

CMAKE_SHARED_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>.

CMAKE_SHARED_LIBRARY_SUFFIX¶

The suffix to use for the end of a shared library filename, .dll on Windows.

CMAKE_SHARED_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>.

CMAKE_SHARED_MODULE_PREFIX¶

The prefix to use for the name of a loadable module on this platform.

CMAKE_SHARED_MODULE_PREFIX_<LANG> overrides this for language <LANG>.

CMAKE_SHARED_MODULE_SUFFIX¶

The suffix to use for the end of a loadable module filename on this platform

CMAKE_SHARED_MODULE_SUFFIX_<LANG> overrides this for language <LANG>.

CMAKE_SIZEOF_VOID_P¶

This is set to the size of a pointer on the target machine, and is determined by a try compile. If a 64-bit size is found, then the library search path is modified to look for 64-bit libraries first.

CMAKE_SKIP_INSTALL_RULES¶

If TRUE, cmake will neither generate installaton rules nor will it generate cmake_install.cmake files. This variable is FALSE by default.

CMAKE_SKIP_RPATH¶

If this is set to TRUE, then the rpath information is not added to compiled executables. The default is to add rpath information if the platform supports it. This allows for easy running from the build tree. To omit RPATH in the install step, but not the build step, use CMAKE_SKIP_INSTALL_RPATH instead.

CMAKE_SOURCE_DIR¶

This is the full path to the top level of the current CMake source tree. For an in-source build, this would be the same as CMAKE_BINARY_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_STATIC_LIBRARY_PREFIX¶

The prefix to use for the name of a static library, lib on UNIX.

CMAKE_STATIC_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>.

CMAKE_STATIC_LIBRARY_SUFFIX¶

The suffix to use for the end of a static library filename, .lib on Windows.

CMAKE_STATIC_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>.

CMAKE_TOOLCHAIN_FILE¶

This variable is specified on the command line when cross-compiling with CMake. It is the path to a file which is read early in the CMake run and which specifies locations for compilers and toolchain utilities, and other target platform and compiler related information.

CMAKE_TWEAK_VERSION¶

NOTE:

CMAKE_VERBOSE_MAKEFILE¶

This variable is a cache entry initialized (to FALSE) by the project() command. Users may enable the option in their local build tree to get more verbose output from Makefile builds and show each command line as it is launched.

CMAKE_VERSION¶

Release versions and release candidate versions of CMake use the format:

<major>.<minor>.<patch>[-rc<n>]

where the <patch> component is less than 20000000. Development versions of CMake use the format:

<major>.<minor>.<date>[-<id>]

where the <date> component is of format CCYYMMDD and <id> may contain arbitrary text. This represents development as of a particular date following the <major>.<minor> feature release.

Individual component values are also available in variables:

Use the if() command VERSION_LESS, VERSION_GREATER, VERSION_EQUAL, VERSION_LESS_EQUAL, or VERSION_GREATER_EQUAL operators to compare version string values against CMAKE_VERSION using a component-wise test. Version component values may be 10 or larger so do not attempt to compare version strings as floating-point numbers.

NOTE:

CMAKE_VS_DEVENV_COMMAND¶

This variable is not defined by other generators even if devenv.com is installed on the computer.

The CMAKE_VS_MSBUILD_COMMAND is also provided for Visual Studio 10 2010 and above. See also the CMAKE_MAKE_PROGRAM variable.

CMAKE_VS_INTEL_Fortran_PROJECT_VERSION¶

CMAKE_VS_MSBUILD_COMMAND¶

This variable is not defined by other generators even if MSBuild.exe is installed on the computer.

The CMAKE_VS_DEVENV_COMMAND is also provided for the non-Express editions of Visual Studio. See also the CMAKE_MAKE_PROGRAM variable.

CMAKE_VS_NsightTegra_VERSION¶

CMAKE_VS_PLATFORM_NAME¶

VS 8 and above allow project files to specify a target platform. CMake provides the name of the chosen platform in this variable.

CMAKE_VS_PLATFORM_TOOLSET¶

VS 10 and above use MSBuild under the hood and support multiple compiler toolchains. CMake may specify a toolset explicitly, such as v110 for VS 11 or Windows7.1SDK for 64-bit support in VS 10 Express. CMake provides the name of the chosen toolset in this variable.

CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION¶

When targeting Windows 10 and above Visual Studio 2015 and above support specification of a target Windows version to select a corresponding SDK. The CMAKE_SYSTEM_VERSION variable may be set to specify a version. Otherwise CMake computes a default version based on the Windows SDK versions available. The chosen Windows target version number is provided in CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION. If no Windows 10 SDK is available this value will be empty.

CMAKE_XCODE_PLATFORM_TOOLSET¶

Xcode supports selection of a compiler from one of the installed toolsets. CMake provides the name of the chosen toolset in this variable, if any is explicitly selected (e.g. via the cmake(1) -T option).

PROJECT_BINARY_DIR¶

This is the binary directory of the most recent project() command.

<PROJECT-NAME>_BINARY_DIR¶

A variable is created with the name used in the project() command, and is the binary directory for the project. This can be useful when add_subdirectory() is used to connect several projects.

PROJECT_NAME¶

This is the name given to the most recent project() command.

<PROJECT-NAME>_SOURCE_DIR¶

A variable is created with the name used in the project() command, and is the source directory for the project. This can be useful when add_subdirectory() is used to connect several projects.

<PROJECT-NAME>_VERSION¶

See also the component-wise version variables <PROJECT-NAME>_VERSION_MAJOR, <PROJECT-NAME>_VERSION_MINOR, <PROJECT-NAME>_VERSION_PATCH, and <PROJECT-NAME>_VERSION_TWEAK.

<PROJECT-NAME>_VERSION_MAJOR¶

<PROJECT-NAME>_VERSION_MINOR¶

<PROJECT-NAME>_VERSION_PATCH¶

<PROJECT-NAME>_VERSION_TWEAK¶

PROJECT_SOURCE_DIR¶

This is the source directory of the most recent project() command.

PROJECT_VERSION¶

See also the component-wise version variables PROJECT_VERSION_MAJOR, PROJECT_VERSION_MINOR, PROJECT_VERSION_PATCH, and PROJECT_VERSION_TWEAK.

PROJECT_VERSION_MAJOR¶

PROJECT_VERSION_MINOR¶

PROJECT_VERSION_PATCH¶

PROJECT_VERSION_TWEAK¶

BUILD_SHARED_LIBS¶

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¶

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¶

CMAKE_AUTOMOC_RELAXED_MODE¶

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

Relaxed mode has to be enabled for KDE4 compatibility.

CMAKE_BACKWARDS_COMPATIBILITY¶

CMAKE_BUILD_TYPE¶

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

CMAKE_CODELITE_USE_TARGETS¶

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¶

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

CMAKE_CONFIGURATION_TYPES¶

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

CMAKE_DEBUG_TARGET_PROPERTIES¶

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

CMAKE_DEPENDS_IN_PROJECT_ONLY¶

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>¶

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

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

CMAKE_ECLIPSE_GENERATE_LINKED_RESOURCES¶

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¶

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

CMAKE_ECLIPSE_MAKE_ARGUMENTS¶

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

CMAKE_ECLIPSE_VERSION¶

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¶

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¶

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

CMAKE_EXPORT_COMPILE_COMMANDS¶

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

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

NOTE:

CMAKE_EXPORT_NO_PACKAGE_REGISTRY¶

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

See also Disabling the Package Registry.

CMAKE_SYSROOT¶

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.

CMAKE_FIND_APPBUNDLE¶

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

CMAKE_FIND_FRAMEWORK¶

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

CMAKE_FIND_LIBRARY_PREFIXES¶

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¶

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

CMAKE_FIND_NO_INSTALL_PREFIX¶

CMake adds the CMAKE_INSTALL_PREFIX and the CMAKE_STAGING_PREFIX variable to the CMAKE_SYSTEM_PREFIX_PATH by default. This variable may be set on the command line to control that behavior.

Set CMAKE_FIND_NO_INSTALL_PREFIX to TRUE to tell find_package() not to search in the CMAKE_INSTALL_PREFIX or CMAKE_STAGING_PREFIX by default. Note that the prefix 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¶

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

See also Disabling the Package Registry.

CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY¶

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

See also Disabling the Package Registry.

CMAKE_FIND_PACKAGE_WARN_NO_MODULE¶

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

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

CMAKE_FIND_ROOT_PATH¶

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¶

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¶

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_PACKAGE¶

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_PROGRAM¶

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_FRAMEWORK_PATH¶

CMAKE_IGNORE_PATH¶

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_PATH¶

CMAKE_INCLUDE_DIRECTORIES_BEFORE¶

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¶

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_INSTALL_DEFAULT_COMPONENT_NAME¶

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

CMAKE_INSTALL_MESSAGE¶

-- 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:

Other values have undefined behavior and may not be diagnosed.

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

CMAKE_INSTALL_PREFIX¶

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

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

make DESTDIR=/home/john install

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

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

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

NOTE:

CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT¶

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

CMAKE_LIBRARY_PATH¶

CMAKE_MFC_FLAG¶

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

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

CMAKE_MODULE_PATH¶

CMAKE_NOT_USING_CONFIG_FLAGS¶

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

CMAKE_POLICY_DEFAULT_CMP<NNNN>¶

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

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

CMAKE_POLICY_WARNING_CMP<NNNN>¶

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¶

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¶

CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE¶

CMAKE_SKIP_INSTALL_ALL_DEPENDENCY¶

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¶

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_SYSTEM_APPBUNDLE_PATH¶

CMAKE_SYSTEM_FRAMEWORK_PATH¶

CMAKE_SYSTEM_IGNORE_PATH¶

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¶

CMAKE_SYSTEM_LIBRARY_PATH¶

CMAKE_SYSTEM_PREFIX_PATH¶

By default this contains the standard directories for the current system, the CMAKE_INSTALL_PREFIX, and the CMAKE_STAGING_PREFIX. It 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¶

CMAKE_USER_MAKE_RULES_OVERRIDE¶

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¶

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¶

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.

ANDROID¶

APPLE¶

Set to true on OS X.

BORLAND¶

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

CMAKE_CL_64¶

Set to true when using the 64-bit cl compiler from Microsoft.

CMAKE_COMPILER_2005¶

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

CMAKE_HOST_APPLE¶

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

CMAKE_HOST_SOLARIS¶

Set to true when the host system is Oracle Solaris.

CMAKE_HOST_SYSTEM_NAME¶

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

CMAKE_HOST_SYSTEM_PROCESSOR¶

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

CMAKE_HOST_SYSTEM¶

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_VERSION¶

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¶

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

CMAKE_HOST_WIN32¶

Set to true when the host system is Windows and on Cygwin.

CMAKE_LIBRARY_ARCHITECTURE_REGEX¶

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

CMAKE_LIBRARY_ARCHITECTURE¶

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

CMAKE_OBJECT_PATH_MAX¶

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_NAME¶

System Name for Host Builds¶

System Name for Cross Compiling¶

CMAKE_SYSTEM_PROCESSOR¶

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

CMAKE_SYSTEM¶

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_VERSION¶

System Version for Host Builds¶

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¶

CYGWIN¶

Set to true when using Cygwin.

ENV¶

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

GHS-MULTI¶

MINGW¶

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

MSVC10¶

MSVC11¶

MSVC12¶

MSVC14¶

MSVC60¶

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

MSVC70¶

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

MSVC71¶

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

MSVC80¶

MSVC90¶

MSVC_IDE¶

Set to true when the target platform is the Microsoft Visual C++ IDE, as opposed to the command line compiler.

MSVC¶

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

MSVC_VERSION¶

Known version numbers are:

1200 = VS  6.0
1300 = VS  7.0
1310 = VS  7.1
1400 = VS  8.0
1500 = VS  9.0
1600 = VS 10.0
1700 = VS 11.0
1800 = VS 12.0
1900 = VS 14.0, 15.0

UNIX¶

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

WIN32¶

Set to true when the target system is Windows.

WINCE¶

WINDOWS_PHONE¶

WINDOWS_STORE¶

XCODE¶

XCODE_VERSION¶

Under the Xcode generator, this is the version of Xcode as specified in Xcode.app/Contents/version.plist (such as 3.1.2).

CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS¶

CMAKE_ANDROID_API¶

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¶

CMAKE_ANDROID_ARCH¶

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:

CMAKE_ANDROID_ARCH_ABI¶

See also the CMAKE_ANDROID_ARM_MODE and CMAKE_ANDROID_ARM_NEON variables.

CMAKE_ANDROID_ARM_MODE¶

CMAKE_ANDROID_ARM_NEON¶

CMAKE_ANDROID_ASSETS_DIRECTORIES¶

CMAKE_ANDROID_GUI¶

CMAKE_ANDROID_JAR_DEPENDENCIES¶

CMAKE_ANDROID_JAR_DIRECTORIES¶

CMAKE_ANDROID_JAVA_SOURCE_DIR¶

CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES¶

CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES¶

CMAKE_ANDROID_NDK¶

CMAKE_ANDROID_NDK_TOOLCHAIN_HOST_TAG¶

CMAKE_ANDROID_NDK_TOOLCHAIN_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¶

CMAKE_ANDROID_PROGUARD¶

CMAKE_ANDROID_PROGUARD_CONFIG_PATH¶

CMAKE_ANDROID_SECURE_PROPS_PATH¶

CMAKE_ANDROID_SKIP_ANT_STEP¶

CMAKE_ANDROID_STANDALONE_TOOLCHAIN¶

CMAKE_ANDROID_STL_TYPE¶

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:

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

CMAKE_ARCHIVE_OUTPUT_DIRECTORY¶

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>¶

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

CMAKE_AUTOMOC_MOC_OPTIONS¶

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

CMAKE_AUTOMOC¶

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

CMAKE_AUTORCC¶

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

CMAKE_AUTORCC_OPTIONS¶

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

CMAKE_AUTOUIC¶

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

CMAKE_AUTOUIC_OPTIONS¶

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

CMAKE_BUILD_WITH_INSTALL_RPATH¶

Normally CMake uses the build tree for the RPATH when building executables etc on systems that use RPATH. When the software is installed the executables etc are relinked by CMake to have the install RPATH. If this variable is set to true then the software is always built with the install path for the RPATH and does not need to be relinked when installed.

CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY¶

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

CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG>¶

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¶

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

CMAKE_DEBUG_POSTFIX¶

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

CMAKE_ENABLE_EXPORTS¶

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

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

CMAKE_EXE_LINKER_FLAGS_<CONFIG>¶

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

CMAKE_EXE_LINKER_FLAGS_<CONFIG>_INIT¶

See also CMAKE_EXE_LINKER_FLAGS_INIT.

CMAKE_EXE_LINKER_FLAGS¶

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

CMAKE_EXE_LINKER_FLAGS_INIT¶

See also the configuration-specific variable CMAKE_EXE_LINKER_FLAGS_<CONFIG>_INIT.

CMAKE_Fortran_FORMAT¶

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

CMAKE_Fortran_MODULE_DIRECTORY¶

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

CMAKE_GNUtoMS¶

This variable is used to initialize the GNUtoMS property on targets when they are created. See that target property for additional information.

CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE¶

If this variable is enabled, CMake automatically adds for each shared library target, static library target, module target and executable target, CMAKE_CURRENT_SOURCE_DIR and CMAKE_CURRENT_BINARY_DIR to the INTERFACE_INCLUDE_DIRECTORIES target property. By default CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE is OFF.

CMAKE_INCLUDE_CURRENT_DIR¶

If this variable is enabled, CMake automatically adds CMAKE_CURRENT_SOURCE_DIR and CMAKE_CURRENT_BINARY_DIR to the include path for each directory. These additional include directories do not propagate down to subdirectories. This is useful mainly for out-of-source builds, where files generated into the build tree are included by files located in the source tree.

By default CMAKE_INCLUDE_CURRENT_DIR is OFF.

CMAKE_INSTALL_NAME_DIR¶

CMAKE_INSTALL_NAME_DIR is used to initialize the INSTALL_NAME_DIR property on all targets. See that target property for more information.

CMAKE_INSTALL_RPATH¶

A semicolon-separated list specifying the rpath to use in installed targets (for platforms that support it). This is used to initialize the target property INSTALL_RPATH for all targets.

CMAKE_INSTALL_RPATH_USE_LINK_PATH¶

CMAKE_INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true will append directories in the linker search path and outside the project to the INSTALL_RPATH. This is used to initialize the target property INSTALL_RPATH_USE_LINK_PATH for all targets.

CMAKE_IOS_INSTALL_COMBINED¶

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

CMAKE_<LANG>_CLANG_TIDY¶

CMAKE_<LANG>_COMPILER_LAUNCHER¶

CMAKE_<LANG>_INCLUDE_WHAT_YOU_USE¶

CMAKE_<LANG>_VISIBILITY_PRESET¶

CMAKE_LIBRARY_OUTPUT_DIRECTORY¶

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

CMAKE_LIBRARY_OUTPUT_DIRECTORY_<CONFIG>¶

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

CMAKE_LIBRARY_PATH_FLAG¶

The flag will be used to specify a library directory to the compiler. On most compilers this is -L.

CMAKE_LINK_DEF_FILE_FLAG¶

The flag will be used to add a .def file when creating a dll on Windows; this is only defined on Windows.

CMAKE_LINK_DEPENDS_NO_SHARED¶

This variable initializes the LINK_DEPENDS_NO_SHARED property on targets when they are created. See that target property for additional information.

CMAKE_LINK_INTERFACE_LIBRARIES¶

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

CMAKE_LINK_LIBRARY_FILE_FLAG¶

The flag will be used before a library file path is given to the linker. This is needed only on very few platforms.

CMAKE_LINK_LIBRARY_FLAG¶

The flag will be used to specify a library to link to an executable. On most compilers this is -l.

CMAKE_LINK_WHAT_YOU_USE¶

CMAKE_MACOSX_BUNDLE¶

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

CMAKE_MACOSX_RPATH¶

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

CMAKE_MAP_IMPORTED_CONFIG_<CONFIG>¶

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

CMAKE_MODULE_LINKER_FLAGS_<CONFIG>¶

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

CMAKE_MODULE_LINKER_FLAGS_<CONFIG>_INIT¶

See also CMAKE_MODULE_LINKER_FLAGS_INIT.

CMAKE_MODULE_LINKER_FLAGS¶

These flags will be used by the linker when creating a module.

CMAKE_MODULE_LINKER_FLAGS_INIT¶

See also the configuration-specific variable CMAKE_MODULE_LINKER_FLAGS_<CONFIG>_INIT.

CMAKE_NINJA_OUTPUT_PATH_PREFIX¶

Every output files listed in the generated build.ninja will be prefixed by the contents of this variable (a trailing slash is appended if missing). This is useful when the generated ninja file is meant to be embedded as a subninja file into a super ninja project. For example, a ninja build file generated with a command like:

cd top-build-dir/sub &&
cmake -G Ninja -DCMAKE_NINJA_OUTPUT_PATH_PREFIX=sub/ path/to/source

can be embedded in top-build-dir/build.ninja with a directive like this:

subninja sub/build.ninja

The auto-regeneration rule in top-build-dir/build.ninja must have an order-only dependency on sub/build.ninja.

NOTE:

CMAKE_NO_BUILTIN_CHRPATH¶

When an ELF binary needs to have a different RPATH after installation than it does in the build tree, CMake uses a builtin editor to change the RPATH in the installed copy. If this variable is set to true then CMake will relink the binary before installation instead of using its builtin editor.

CMAKE_NO_SYSTEM_FROM_IMPORTED¶

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

CMAKE_OSX_ARCHITECTURES¶

This variable is used to initialize the OSX_ARCHITECTURES property on each target as it is creaed. See that target property for additional information.

The value of this variable should be set prior to the first project() or enable_language() command invocation because it may influence configuration of the toolchain and flags. It is intended to be set locally by the user creating a build tree.

This variable is ignored on platforms other than OS X.

CMAKE_OSX_DEPLOYMENT_TARGET¶

If not set explicitly the value is initialized by the MACOSX_DEPLOYMENT_TARGET environment variable, if set, and otherwise computed based on the host platform.

The value of this variable should be set prior to the first project() or enable_language() command invocation because it may influence configuration of the toolchain and flags. It is intended to be set locally by the user creating a build tree.

This variable is ignored on platforms other than OS X.

CMAKE_OSX_SYSROOT¶

If not set explicitly the value is initialized by the SDKROOT environment variable, if set, and otherwise computed based on the CMAKE_OSX_DEPLOYMENT_TARGET or the host platform.

The value of this variable should be set prior to the first project() or enable_language() command invocation because it may influence configuration of the toolchain and flags. It is intended to be set locally by the user creating a build tree.

This variable is ignored on platforms other than OS X.

CMAKE_PDB_OUTPUT_DIRECTORY¶

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

CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG>¶

This is a per-configuration version of CMAKE_PDB_OUTPUT_DIRECTORY. This variable is used to initialize the PDB_OUTPUT_DIRECTORY_<CONFIG> property on all the targets. See that target property for additional information.

CMAKE_POSITION_INDEPENDENT_CODE¶

This variable is used to initialize the POSITION_INDEPENDENT_CODE property on all the targets. See that target property for additional information. If set, it's value is also used by the try_compile() command.

CMAKE_RUNTIME_OUTPUT_DIRECTORY¶

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

CMAKE_RUNTIME_OUTPUT_DIRECTORY_<CONFIG>¶

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

CMAKE_SHARED_LINKER_FLAGS_<CONFIG>¶

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

CMAKE_SHARED_LINKER_FLAGS_<CONFIG>_INIT¶

See also CMAKE_SHARED_LINKER_FLAGS_INIT.

CMAKE_SHARED_LINKER_FLAGS¶

These flags will be used by the linker when creating a shared library.

CMAKE_SHARED_LINKER_FLAGS_INIT¶

See also the configuration-specific variable CMAKE_SHARED_LINKER_FLAGS_<CONFIG>_INIT.

CMAKE_SKIP_BUILD_RPATH¶

Normally CMake uses the build tree for the RPATH when building executables etc on systems that use RPATH. When the software is installed the executables etc are relinked by CMake to have the install RPATH. If this variable is set to true then the software is always built with no RPATH.

CMAKE_SKIP_INSTALL_RPATH¶

Normally CMake uses the build tree for the RPATH when building executables etc on systems that use RPATH. When the software is installed the executables etc are relinked by CMake to have the install RPATH. If this variable is set to true then the software is always installed without RPATH, even if RPATH is enabled when building. This can be useful for example to allow running tests from the build directory with RPATH enabled before the installation step. To omit RPATH in both the build and install steps, use CMAKE_SKIP_RPATH instead.

CMAKE_STATIC_LINKER_FLAGS_<CONFIG>¶

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

CMAKE_STATIC_LINKER_FLAGS_<CONFIG>_INIT¶

See also CMAKE_STATIC_LINKER_FLAGS_INIT.

CMAKE_STATIC_LINKER_FLAGS¶

These flags will be used by the linker when creating a static library.

CMAKE_STATIC_LINKER_FLAGS_INIT¶

See also the configuration-specific variable CMAKE_STATIC_LINKER_FLAGS_<CONFIG>_INIT.

CMAKE_TRY_COMPILE_CONFIGURATION¶

Projects built by try_compile() and try_run() are built synchronously during the CMake configuration step. Therefore a specific build configuration must be chosen even if the generated build system supports multiple configurations.

CMAKE_TRY_COMPILE_PLATFORM_VARIABLES¶

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

Variables meaningful to CMake, such as CMAKE_<LANG>_FLAGS, are propagated automatically. The CMAKE_TRY_COMPILE_PLATFORM_VARIABLES variable may be set to pass custom variables meaningful to a toolchain file. For example, a toolchain file may contain:

set(CMAKE_SYSTEM_NAME ...)
set(CMAKE_TRY_COMPILE_PLATFORM_VARIABLES MY_CUSTOM_VARIABLE)
# ... use MY_CUSTOM_VARIABLE ...

If a user passes -DMY_CUSTOM_VARIABLE=SomeValue to CMake then this setting will be made visible to the toolchain file both for the main project and for test projects generated by the try_compile() command source file signature.

CMAKE_TRY_COMPILE_TARGET_TYPE¶

CMAKE_USE_RELATIVE_PATHS¶

CMAKE_VISIBILITY_INLINES_HIDDEN¶

CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD¶

In Visual Studio solution, by default the INSTALL target will not be part of the default build. Setting this variable will enable the INSTALL target to be part of the default build.

CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS¶

CMAKE_WIN32_EXECUTABLE¶

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

CMAKE_XCODE_ATTRIBUTE_<an-attribute>¶

Tell the Xcode generator to set '<an-attribute>' to a given value in the generated Xcode project. Ignored on other generators.

See the XCODE_ATTRIBUTE_<an-attribute> target property to set attributes on a specific target.

Contents of CMAKE_XCODE_ATTRIBUTE_<an-attribute> may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

EXECUTABLE_OUTPUT_PATH¶

The target property RUNTIME_OUTPUT_DIRECTORY supercedes this variable for a target if it is set. Executable targets are otherwise placed in this directory.

LIBRARY_OUTPUT_PATH¶

The target properties ARCHIVE_OUTPUT_DIRECTORY, LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY supercede this variable for a target if they are set. Library targets are otherwise placed in this directory.

CMAKE_COMPILER_IS_GNUCC¶

CMAKE_COMPILER_IS_GNUCXX¶

CMAKE_COMPILER_IS_GNUG77¶

CMAKE_C_COMPILE_FEATURES¶

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¶

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

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

CMAKE_C_STANDARD¶

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

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

CMAKE_C_STANDARD_REQUIRED¶

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

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

CMAKE_CXX_COMPILE_FEATURES¶

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¶

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

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

CMAKE_CXX_STANDARD¶

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

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

CMAKE_CXX_STANDARD_REQUIRED¶

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

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

CMAKE_Fortran_MODDIR_DEFAULT¶

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¶

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

CMAKE_Fortran_MODOUT_FLAG¶

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

CMAKE_INTERNAL_PLATFORM_ABI¶

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

CMAKE_<LANG>_ANDROID_TOOLCHAIN_MACHINE¶

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

CMAKE_<LANG>_ANDROID_TOOLCHAIN_PREFIX¶

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¶

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

CMAKE_<LANG>_ARCHIVE_APPEND¶

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¶

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¶

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>_COMPILE_OBJECT¶

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

CMAKE_<LANG>_COMPILER_ABI¶

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

CMAKE_<LANG>_COMPILER_ID¶

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

Absoft = Absoft Fortran (absoft.com)
ADSP = Analog VisualDSP++ (analog.com)
AppleClang = Apple Clang (apple.com)
ARMCC = ARM Compiler (arm.com)
Bruce = Bruce C Compiler
CCur = Concurrent Fortran (ccur.com)
Clang = LLVM Clang (clang.llvm.org)
Cray = Cray Compiler (cray.com)
Embarcadero, Borland = Embarcadero (embarcadero.com)
G95 = G95 Fortran (g95.org)
GNU = GNU Compiler Collection (gcc.gnu.org)
HP = Hewlett-Packard Compiler (hp.com)
Intel = Intel Compiler (intel.com)
MIPSpro = SGI MIPSpro (sgi.com)
MSVC = Microsoft Visual Studio (microsoft.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)

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

CMAKE_<LANG>_COMPILER_LOADED¶

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

CMAKE_<LANG>_COMPILER¶

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

CMAKE_<LANG>_COMPILER_EXTERNAL_TOOLCHAIN¶

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

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

CMAKE_<LANG>_COMPILER_TARGET¶

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 in major[.minor[.patch[.tweak]]] format. This variable is not guaranteed to be defined for all compilers or languages.

CMAKE_<LANG>_CREATE_SHARED_LIBRARY¶

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

CMAKE_<LANG>_CREATE_SHARED_MODULE¶

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

CMAKE_<LANG>_CREATE_STATIC_LIBRARY¶

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

CMAKE_<LANG>_FLAGS_DEBUG¶

<LANG> flags used when CMAKE_BUILD_TYPE is Debug.

CMAKE_<LANG>_FLAGS_DEBUG_INIT¶

See also CMAKE_<LANG>_FLAGS_INIT.

CMAKE_<LANG>_FLAGS_MINSIZEREL¶

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

CMAKE_<LANG>_FLAGS_MINSIZEREL_INIT¶

See also CMAKE_<LANG>_FLAGS_INIT.

CMAKE_<LANG>_FLAGS_RELEASE¶

<LANG> flags used when CMAKE_BUILD_TYPE is Release.

CMAKE_<LANG>_FLAGS_RELEASE_INIT¶

See also CMAKE_<LANG>_FLAGS_INIT.

CMAKE_<LANG>_FLAGS_RELWITHDEBINFO¶

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

CMAKE_<LANG>_FLAGS_RELWITHDEBINFO_INIT¶

See also CMAKE_<LANG>_FLAGS_INIT.

CMAKE_<LANG>_FLAGS¶

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

CMAKE_<LANG>_FLAGS_INIT¶

See also the configuration-specific variables:

CMAKE_<LANG>_GHS_KERNEL_FLAGS_DEBUG¶

<LANG> flags used when CMAKE_BUILD_TYPE is Debug.

CMAKE_<LANG>_GHS_KERNEL_FLAGS_MINSIZEREL¶

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

CMAKE_<LANG>_GHS_KERNEL_FLAGS_RELEASE¶

<LANG> flags used when CMAKE_BUILD_TYPE is Release.

CMAKE_<LANG>_GHS_KERNEL_FLAGS_RELWITHDEBINFO¶

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

CMAKE_<LANG>_IGNORE_EXTENSIONS¶

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

CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES¶

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

CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES¶

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

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

CMAKE_<LANG>_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES¶

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

CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES¶

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

CMAKE_<LANG>_LIBRARY_ARCHITECTURE¶

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

CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES¶

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

CMAKE_<LANG>_LINKER_PREFERENCE¶

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

CMAKE_<LANG>_LINK_EXECUTABLE¶

Rule variable to link an executable for the given language.

CMAKE_<LANG>_OUTPUT_EXTENSION¶

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

CMAKE_<LANG>_PLATFORM_ID¶

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

CMAKE_<LANG>_SIMULATE_ID¶

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

CMAKE_<LANG>_SIMULATE_VERSION¶

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

CMAKE_<LANG>_SIZEOF_DATA_PTR¶

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

CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS¶

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

CMAKE_<LANG>_STANDARD_INCLUDE_DIRECTORIES¶

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

See also CMAKE_<LANG>_STANDARD_LIBRARIES.

CMAKE_<LANG>_STANDARD_LIBRARIES¶

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

See also CMAKE_<LANG>_STANDARD_INCLUDE_DIRECTORIES.

CMAKE_Swift_LANGUAGE_VERSION¶

CMAKE_USER_MAKE_RULES_OVERRIDE_<LANG>¶

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

CTEST_BINARY_DIRECTORY¶

CTEST_BUILD_COMMAND¶

CTEST_BUILD_NAME¶

CTEST_BZR_COMMAND¶

CTEST_BZR_UPDATE_OPTIONS¶

CTEST_CHANGE_ID¶

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¶

CTEST_CONFIGURATION_TYPE¶

CTEST_CONFIGURE_COMMAND¶

CTEST_COVERAGE_COMMAND¶

Cobertura¶

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.

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¶

CTEST_CURL_OPTIONS¶

CTEST_CUSTOM_COVERAGE_EXCLUDE¶

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

CTEST_CUSTOM_ERROR_EXCEPTION¶

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

CTEST_CUSTOM_ERROR_MATCH¶

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¶

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¶

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¶

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

CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS¶

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¶

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¶

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

CTEST_CUSTOM_MEMCHECK_IGNORE¶

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

CTEST_CUSTOM_POST_MEMCHECK¶

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

CTEST_CUSTOM_POST_TEST¶

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

CTEST_CUSTOM_PRE_MEMCHECK¶

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

CTEST_CUSTOM_PRE_TEST¶

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

CTEST_CUSTOM_TEST_IGNORE¶

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

CTEST_CUSTOM_WARNING_EXCEPTION¶

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

CTEST_CUSTOM_WARNING_MATCH¶

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

CTEST_CVS_CHECKOUT¶

CTEST_CVS_COMMAND¶

CTEST_CVS_UPDATE_OPTIONS¶

CTEST_DROP_LOCATION¶

CTEST_DROP_METHOD¶

CTEST_DROP_SITE¶

CTEST_DROP_SITE_CDASH¶

CTEST_DROP_SITE_PASSWORD¶

CTEST_DROP_SITE_USER¶

CTEST_EXTRA_COVERAGE_GLOB¶

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

CTEST_GIT_COMMAND¶

CTEST_GIT_INIT_SUBMODULES¶

CTEST_GIT_UPDATE_CUSTOM¶

CTEST_GIT_UPDATE_OPTIONS¶

CTEST_HG_COMMAND¶

CTEST_HG_UPDATE_OPTIONS¶

CTEST_MEMORYCHECK_COMMAND¶

CTEST_MEMORYCHECK_COMMAND_OPTIONS¶

CTEST_MEMORYCHECK_SANITIZER_OPTIONS¶

CTEST_MEMORYCHECK_SUPPRESSIONS_FILE¶

CTEST_MEMORYCHECK_TYPE¶

CTEST_NIGHTLY_START_TIME¶

CTEST_P4_CLIENT¶

CTEST_P4_COMMAND¶

CTEST_P4_OPTIONS¶

CTEST_P4_UPDATE_OPTIONS¶

CTEST_SCP_COMMAND¶

CTEST_SITE¶

CTEST_SOURCE_DIRECTORY¶

CTEST_SVN_COMMAND¶

CTEST_SVN_OPTIONS¶

CTEST_SVN_UPDATE_OPTIONS¶

CTEST_TEST_LOAD¶

CTEST_TEST_TIMEOUT¶

CTEST_TRIGGER_SITE¶

CTEST_UPDATE_COMMAND¶

CTEST_UPDATE_OPTIONS¶

CTEST_UPDATE_VERSION_ONLY¶

CTEST_USE_LAUNCHERS¶

CPACK_ABSOLUTE_DESTINATION_FILES¶

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¶

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

CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION¶

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¶

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

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

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

CPACK_INSTALL_SCRIPT¶

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

CPACK_PACKAGING_INSTALL_PREFIX¶

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¶

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¶

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