This commit is contained in:
kleuter
2023-11-01 22:26:17 +01:00
parent 94b1c5907b
commit 860ee1cc77
3387 changed files with 257471 additions and 0 deletions

View File

@ -0,0 +1,7 @@
ANDROID
-------
.. versionadded:: 3.7
Set to ``1`` when the target system (:variable:`CMAKE_SYSTEM_NAME`) is
``Android``.

View File

@ -0,0 +1,5 @@
APPLE
-----
Set to ``True`` when the target system is an Apple platform
(macOS, iOS, tvOS or watchOS).

View File

@ -0,0 +1,6 @@
BORLAND
-------
``True`` if the Borland compiler is being used.
This is set to ``true`` if the Borland compiler is being used.

View File

@ -0,0 +1,7 @@
BSD
---
.. versionadded:: 3.25
Set to a string value when the target system is BSD. This value can be one of
the following: DragonFlyBSD, FreeBSD, OpenBSD, or NetBSD.

View File

@ -0,0 +1,10 @@
BUILD_SHARED_LIBS
-----------------
Global flag to cause :command:`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 :command:`option` so that each user
of a project can decide if they want to build the project using shared or
static libraries.

View File

@ -0,0 +1,20 @@
CACHE
-----
.. versionadded:: 3.13
Operator to read cache variables.
Use the syntax ``$CACHE{VAR}`` to read cache entry ``VAR``.
See the :ref:`cmake-language(7) variables <CMake Language Variables>`
documentation for more complete documentation of the interaction of
normal variables and cache entries.
When evaluating :ref:`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 :command:`set` and :command:`unset` commands to see how to
write or remove cache variables.

View File

@ -0,0 +1,9 @@
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).

View File

@ -0,0 +1,13 @@
CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY
----------------------------------------------
.. versionadded:: 3.27
Whether to enable the ``DEPENDS_EXPLICIT_ONLY`` option by default in
:command:`add_custom_command`.
This variable affects the default behavior of the :command:`add_custom_command`
command. Setting this variable to ``ON`` is equivalent to using the
``DEPENDS_EXPLICIT_ONLY`` option in all uses of that command.
See also :variable:`CMAKE_OPTIMIZE_DEPENDENCIES`.

View File

@ -0,0 +1,11 @@
CMAKE_ADSP_ROOT
---------------
.. versionadded:: 3.24
When :ref:`Cross Compiling for ADSP SHARC/Blackfin`,
this variable holds the absolute path to the latest CCES or VDSP++ install.
The directory is expected to contain the ``cc21k.exe`` and ``ccblkfn.exe`` compilers.
This will be set automatically if a default install of CCES or VDSP++ can be found.
See also the :envvar:`ADSP_ROOT` environment variable.

View File

@ -0,0 +1,8 @@
CMAKE_AIX_EXPORT_ALL_SYMBOLS
----------------------------
.. versionadded:: 3.17
Default value for :prop_tgt:`AIX_EXPORT_ALL_SYMBOLS` target property.
This variable is used to initialize the property on each target as it is
created.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS
------------------------------------
.. versionadded:: 3.4
Default value for the :prop_tgt:`ANDROID_ANT_ADDITIONAL_OPTIONS` target property.
See that target property for additional information.

View File

@ -0,0 +1,14 @@
CMAKE_ANDROID_API
-----------------
.. versionadded:: 3.1
When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio
Edition`, this variable may be set to specify the default value for the
:prop_tgt:`ANDROID_API` target property. See that target property for
additional information.
When :ref:`Cross Compiling for Android`, the :variable:`CMAKE_SYSTEM_VERSION`
variable represents the Android API version number targeted. For historical
reasons, if a toolchain file sets ``CMAKE_ANDROID_API``, but not
``CMAKE_SYSTEM_VERSION``, the latter will be initialized using the former.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_API_MIN
---------------------
.. versionadded:: 3.2
Default value for the :prop_tgt:`ANDROID_API_MIN` target property.
See that target property for additional information.

View File

@ -0,0 +1,21 @@
CMAKE_ANDROID_ARCH
------------------
.. versionadded:: 3.4
When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio
Edition`, this variable may be set to specify the default value for the
:prop_tgt:`ANDROID_ARCH` target property. See that target property for
additional information.
Otherwise, when :ref:`Cross Compiling for Android`, this variable provides
the name of the Android architecture corresponding to the value of the
:variable:`CMAKE_ANDROID_ARCH_ABI` variable. The architecture name
may be one of:
* ``arm``
* ``arm64``
* ``mips``
* ``mips64``
* ``x86``
* ``x86_64``

View File

@ -0,0 +1,19 @@
CMAKE_ANDROID_ARCH_ABI
----------------------
.. versionadded:: 3.7
When :ref:`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 :variable:`CMAKE_ANDROID_ARM_MODE` and
:variable:`CMAKE_ANDROID_ARM_NEON` variables.

View File

@ -0,0 +1,9 @@
CMAKE_ANDROID_ARM_MODE
----------------------
.. versionadded:: 3.7
When :ref:`Cross Compiling for Android` and :variable:`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``).

View File

@ -0,0 +1,8 @@
CMAKE_ANDROID_ARM_NEON
----------------------
.. versionadded:: 3.7
When :ref:`Cross Compiling for Android` and :variable:`CMAKE_ANDROID_ARCH_ABI`
is set to ``armeabi-v7a`` set ``CMAKE_ANDROID_ARM_NEON`` to ``ON`` to target
ARM NEON devices.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_ASSETS_DIRECTORIES
--------------------------------
.. versionadded:: 3.4
Default value for the :prop_tgt:`ANDROID_ASSETS_DIRECTORIES` target property.
See that target property for additional information.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_EXCEPTIONS
------------------------
.. versionadded:: 3.20
When :ref:`Cross Compiling for Android with the NDK`, this variable may be set
to specify whether exceptions are enabled.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_GUI
-----------------
.. versionadded:: 3.1
Default value for the :prop_tgt:`ANDROID_GUI` target property of
executables. See that target property for additional information.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_JAR_DEPENDENCIES
------------------------------
.. versionadded:: 3.4
Default value for the :prop_tgt:`ANDROID_JAR_DEPENDENCIES` target property.
See that target property for additional information.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_JAR_DIRECTORIES
-----------------------------
.. versionadded:: 3.4
Default value for the :prop_tgt:`ANDROID_JAR_DIRECTORIES` target property.
See that target property for additional information.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_JAVA_SOURCE_DIR
-----------------------------
.. versionadded:: 3.4
Default value for the :prop_tgt:`ANDROID_JAVA_SOURCE_DIR` target property.
See that target property for additional information.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES
-------------------------------------
.. versionadded:: 3.4
Default value for the :prop_tgt:`ANDROID_NATIVE_LIB_DEPENDENCIES` target
property. See that target property for additional information.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES
------------------------------------
.. versionadded:: 3.4
Default value for the :prop_tgt:`ANDROID_NATIVE_LIB_DIRECTORIES` target
property. See that target property for additional information.

View File

@ -0,0 +1,9 @@
CMAKE_ANDROID_NDK
-----------------
.. versionadded:: 3.7
When :ref:`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.

View File

@ -0,0 +1,11 @@
CMAKE_ANDROID_NDK_DEPRECATED_HEADERS
------------------------------------
.. versionadded:: 3.9
When :ref:`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.

View File

@ -0,0 +1,8 @@
CMAKE_ANDROID_NDK_TOOLCHAIN_HOST_TAG
------------------------------------
.. versionadded:: 3.7.1
When :ref:`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.

View File

@ -0,0 +1,22 @@
CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION
-----------------------------------
.. versionadded:: 3.7
When :ref:`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 :variable:`CMAKE_ANDROID_ARCH_ABI` variable.
If not specified, the default will be a value that selects the latest
available GCC toolchain.

View File

@ -0,0 +1,8 @@
CMAKE_ANDROID_NDK_VERSION
-------------------------
.. versionadded:: 3.20
When :ref:`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.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_PROCESS_MAX
-------------------------
.. versionadded:: 3.4
Default value for the :prop_tgt:`ANDROID_PROCESS_MAX` target property.
See that target property for additional information.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_PROGUARD
----------------------
.. versionadded:: 3.4
Default value for the :prop_tgt:`ANDROID_PROGUARD` target property.
See that target property for additional information.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_PROGUARD_CONFIG_PATH
----------------------------------
.. versionadded:: 3.4
Default value for the :prop_tgt:`ANDROID_PROGUARD_CONFIG_PATH` target property.
See that target property for additional information.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_RTTI
------------------
.. versionadded:: 3.20
When :ref:`Cross Compiling for Android with the NDK`, this variable may be set
to specify whether RTTI is enabled.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_SECURE_PROPS_PATH
-------------------------------
.. versionadded:: 3.4
Default value for the :prop_tgt:`ANDROID_SECURE_PROPS_PATH` target property.
See that target property for additional information.

View File

@ -0,0 +1,7 @@
CMAKE_ANDROID_SKIP_ANT_STEP
---------------------------
.. versionadded:: 3.4
Default value for the :prop_tgt:`ANDROID_SKIP_ANT_STEP` target property.
See that target property for additional information.

View File

@ -0,0 +1,8 @@
CMAKE_ANDROID_STANDALONE_TOOLCHAIN
----------------------------------
.. versionadded:: 3.7
When :ref:`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.

View File

@ -0,0 +1,39 @@
CMAKE_ANDROID_STL_TYPE
----------------------
.. versionadded:: 3.4
When :ref:`Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio
Edition`, this variable may be set to specify the default value for the
:prop_tgt:`ANDROID_STL_TYPE` target property. See that target property
for additional information.
When :ref:`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.

View File

@ -0,0 +1,9 @@
CMAKE_APPBUNDLE_PATH
--------------------
:ref:`Semicolon-separated list <CMake Language Lists>` of directories specifying a search path
for macOS application bundles used by the :command:`find_program`, and
:command:`find_package` commands.
There is also an environment variable :envvar:`CMAKE_APPBUNDLE_PATH`, which is used
as an additional list of search directories.

View File

@ -0,0 +1,14 @@
CMAKE_APPLE_SILICON_PROCESSOR
-----------------------------
.. versionadded:: 3.19.2
On Apple Silicon hosts running macOS, set this variable to tell
CMake what architecture to use for :variable:`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 :envvar:`CMAKE_APPLE_SILICON_PROCESSOR` environment variable.

View File

@ -0,0 +1,7 @@
CMAKE_AR
--------
Name of archiving tool for static libraries.
This specifies the name of the program that creates archive or static
libraries.

View File

@ -0,0 +1,9 @@
CMAKE_ARCHIVE_OUTPUT_DIRECTORY
------------------------------
Where to put all the :ref:`ARCHIVE <Archive Output Artifacts>`
target files when built.
This variable is used to initialize the :prop_tgt:`ARCHIVE_OUTPUT_DIRECTORY`
property on all the targets. See that target property for additional
information.

View File

@ -0,0 +1,11 @@
CMAKE_ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>
---------------------------------------
.. versionadded:: 3.3
Where to put all the :ref:`ARCHIVE <Archive Output Artifacts>`
target files when built for a specific configuration.
This variable is used to initialize the
:prop_tgt:`ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>` property on all the targets.
See that target property for additional information.

View File

@ -0,0 +1,8 @@
CMAKE_ARGC
----------
Number of command line arguments passed to CMake in script mode.
When run in :ref:`-P <Script Processing Mode>` script mode, CMake sets this
variable to the number of command line arguments. See also
:variable:`CMAKE_ARGV0`, ``1``, ``2`` ...

View File

@ -0,0 +1,9 @@
CMAKE_ARGV0
-----------
Command line argument passed to CMake in script mode.
When run in :ref:`-P <Script Processing Mode>` 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 :variable:`CMAKE_ARGC`.

View File

@ -0,0 +1,13 @@
CMAKE_AUTOGEN_ORIGIN_DEPENDS
----------------------------
.. versionadded:: 3.14
Switch for forwarding origin target dependencies to the corresponding
``_autogen`` targets.
This variable is used to initialize the :prop_tgt:`AUTOGEN_ORIGIN_DEPENDS`
property on all the targets. See that target property for additional
information.
By default ``CMAKE_AUTOGEN_ORIGIN_DEPENDS`` is ``ON``.

View File

@ -0,0 +1,12 @@
CMAKE_AUTOGEN_PARALLEL
----------------------
.. versionadded:: 3.11
Number of parallel ``moc`` or ``uic`` processes to start when using
:prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`.
This variable is used to initialize the :prop_tgt:`AUTOGEN_PARALLEL` property
on all the targets. See that target property for additional information.
By default ``CMAKE_AUTOGEN_PARALLEL`` is unset.

View File

@ -0,0 +1,10 @@
CMAKE_AUTOGEN_USE_SYSTEM_INCLUDE
--------------------------------
.. versionadded:: 3.27
This variable is used to initialize the :prop_tgt:`AUTOGEN_USE_SYSTEM_INCLUDE`
property on all targets as they are created. See that target property for
additional information.
By default ``CMAKE_AUTOGEN_USE_SYSTEM_INCLUDE`` is unset.

View File

@ -0,0 +1,15 @@
CMAKE_AUTOGEN_VERBOSE
---------------------
.. versionadded:: 3.13
Sets the verbosity of :prop_tgt:`AUTOMOC`, :prop_tgt:`AUTOUIC` and
:prop_tgt:`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.

View File

@ -0,0 +1,7 @@
CMAKE_AUTOMOC
-------------
Whether to handle ``moc`` automatically for Qt targets.
This variable is used to initialize the :prop_tgt:`AUTOMOC` property on all the
targets. See that target property for additional information.

View File

@ -0,0 +1,10 @@
CMAKE_AUTOMOC_COMPILER_PREDEFINES
---------------------------------
.. versionadded:: 3.10
This variable is used to initialize the :prop_tgt:`AUTOMOC_COMPILER_PREDEFINES`
property on all the targets. See that target property for additional
information.
By default it is ON.

View File

@ -0,0 +1,14 @@
CMAKE_AUTOMOC_DEPEND_FILTERS
----------------------------
.. versionadded:: 3.9
Filter definitions used by :variable:`CMAKE_AUTOMOC`
to extract file names from source code as additional dependencies
for the ``moc`` file.
This variable is used to initialize the :prop_tgt:`AUTOMOC_DEPEND_FILTERS`
property on all the targets. See that target property for additional
information.
By default it is empty.

View File

@ -0,0 +1,10 @@
CMAKE_AUTOMOC_EXECUTABLE
------------------------
.. versionadded:: 3.27
This variable is used to initialize the :prop_tgt:`AUTOMOC_EXECUTABLE`
property on all the targets. See that target property for additional
information.
By default it is empty.

View File

@ -0,0 +1,22 @@
CMAKE_AUTOMOC_MACRO_NAMES
----------------------------
.. versionadded:: 3.10
:ref:`Semicolon-separated list <CMake Language Lists>` list of macro names used by
:variable:`CMAKE_AUTOMOC` to determine if a C++ file needs to be
processed by ``moc``.
This variable is used to initialize the :prop_tgt:`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")

View File

@ -0,0 +1,7 @@
CMAKE_AUTOMOC_MOC_OPTIONS
-------------------------
Additional options for ``moc`` when using :variable:`CMAKE_AUTOMOC`.
This variable is used to initialize the :prop_tgt:`AUTOMOC_MOC_OPTIONS` property
on all the targets. See that target property for additional information.

View File

@ -0,0 +1,13 @@
CMAKE_AUTOMOC_PATH_PREFIX
-------------------------
.. versionadded:: 3.16
Whether to generate the ``-p`` path prefix option for ``moc`` on
:prop_tgt:`AUTOMOC` enabled Qt targets.
This variable is used to initialize the :prop_tgt:`AUTOMOC_PATH_PREFIX`
property on all the targets. See that target property for additional
information.
The default value is ``OFF``.

View File

@ -0,0 +1,15 @@
CMAKE_AUTOMOC_RELAXED_MODE
--------------------------
.. deprecated:: 3.15
Switch between strict and relaxed automoc mode.
By default, :prop_tgt:`AUTOMOC` behaves exactly as described in the
documentation of the :prop_tgt:`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.

View File

@ -0,0 +1,7 @@
CMAKE_AUTORCC
-------------
Whether to handle ``rcc`` automatically for Qt targets.
This variable is used to initialize the :prop_tgt:`AUTORCC` property on all
the targets. See that target property for additional information.

View File

@ -0,0 +1,10 @@
CMAKE_AUTORCC_EXECUTABLE
------------------------
.. versionadded:: 3.27
This variable is used to initialize the :prop_tgt:`AUTORCC_EXECUTABLE`
property on all the targets. See that target property for additional
information.
By default it is empty.

View File

@ -0,0 +1,16 @@
CMAKE_AUTORCC_OPTIONS
---------------------
Additional options for ``rcc`` when using :variable:`CMAKE_AUTORCC`.
This variable is used to initialize the :prop_tgt:`AUTORCC_OPTIONS` property on
all the targets. See that target property for additional information.
EXAMPLE
^^^^^^^
.. code-block:: cmake
# ...
set(CMAKE_AUTORCC_OPTIONS "--compress;9")
# ...

View File

@ -0,0 +1,7 @@
CMAKE_AUTOUIC
-------------
Whether to handle ``uic`` automatically for Qt targets.
This variable is used to initialize the :prop_tgt:`AUTOUIC` property on all
the targets. See that target property for additional information.

View File

@ -0,0 +1,10 @@
CMAKE_AUTOUIC_EXECUTABLE
------------------------
.. versionadded:: 3.27
This variable is used to initialize the :prop_tgt:`AUTOUIC_EXECUTABLE`
property on all the targets. See that target property for additional
information.
By default it is empty.

View File

@ -0,0 +1,16 @@
CMAKE_AUTOUIC_OPTIONS
---------------------
Additional options for ``uic`` when using :variable:`CMAKE_AUTOUIC`.
This variable is used to initialize the :prop_tgt:`AUTOUIC_OPTIONS` property on
all the targets. See that target property for additional information.
EXAMPLE
^^^^^^^
.. code-block:: cmake
# ...
set_property(CMAKE_AUTOUIC_OPTIONS "--no-protection")
# ...

View File

@ -0,0 +1,13 @@
CMAKE_AUTOUIC_SEARCH_PATHS
--------------------------
.. versionadded:: 3.9
Search path list used by :variable:`CMAKE_AUTOUIC` to find included
``.ui`` files.
This variable is used to initialize the :prop_tgt:`AUTOUIC_SEARCH_PATHS`
property on all the targets. See that target property for additional
information.
By default it is empty.

View File

@ -0,0 +1,4 @@
CMAKE_BACKWARDS_COMPATIBILITY
-----------------------------
Deprecated. See CMake Policy :policy:`CMP0001` documentation.

View File

@ -0,0 +1,13 @@
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
:variable:`CMAKE_SOURCE_DIR`.
When run in :option:`cmake -P` script mode, CMake sets the variables
``CMAKE_BINARY_DIR``, :variable:`CMAKE_SOURCE_DIR`,
:variable:`CMAKE_CURRENT_BINARY_DIR` and
:variable:`CMAKE_CURRENT_SOURCE_DIR` to the current working directory.

View File

@ -0,0 +1,12 @@
CMAKE_BUILD_RPATH
-----------------
.. versionadded:: 3.8
:ref:`Semicolon-separated list <CMake Language Lists>` 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 :variable:`CMAKE_INSTALL_RPATH` variable.
This is used to initialize the :prop_tgt:`BUILD_RPATH` target property
for all targets.

View File

@ -0,0 +1,9 @@
CMAKE_BUILD_RPATH_USE_ORIGIN
----------------------------
.. versionadded:: 3.14
Whether to use relative paths for the build ``RPATH``.
This is used to initialize the :prop_tgt:`BUILD_RPATH_USE_ORIGIN` target
property for all targets, see that property for more details.

View File

@ -0,0 +1,6 @@
CMAKE_BUILD_TOOL
----------------
This variable exists only for backwards compatibility.
It contains the same value as :variable:`CMAKE_MAKE_PROGRAM`.
Use that variable instead.

View File

@ -0,0 +1,21 @@
CMAKE_BUILD_TYPE
----------------
Specifies the build type on single-configuration generators (e.g.
:ref:`Makefile Generators` or :generator:`Ninja`). Typical values include
``Debug``, ``Release``, ``RelWithDebInfo`` and ``MinSizeRel``, but custom
build types can also be defined.
This variable is initialized by the first :command:`project` or
:command:`enable_language` command called in a project when a new build
tree is first created. If the :envvar:`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 :ref:`Build Configurations`
for discussion of this and other related topics.
For multi-config generators, see :variable:`CMAKE_CONFIGURATION_TYPES`.

View File

@ -0,0 +1,9 @@
CMAKE_BUILD_WITH_INSTALL_NAME_DIR
---------------------------------
.. versionadded:: 3.9
Whether to use :prop_tgt:`INSTALL_NAME_DIR` on targets in the build tree.
This variable is used to initialize the :prop_tgt:`BUILD_WITH_INSTALL_NAME_DIR`
property on all targets.

View File

@ -0,0 +1,14 @@
CMAKE_BUILD_WITH_INSTALL_RPATH
------------------------------
Use the install path for the ``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.
This is used to initialize the :prop_tgt:`BUILD_WITH_INSTALL_RPATH` target property
for all targets.

View File

@ -0,0 +1,6 @@
CMAKE_CACHEFILE_DIR
-------------------
This variable is used internally by CMake, and may not be set during
the first configuration of a build tree. When it is set, it has the
same value as :variable:`CMAKE_BINARY_DIR`. Use that variable instead.

View File

@ -0,0 +1,8 @@
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.

View File

@ -0,0 +1,8 @@
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.

View File

@ -0,0 +1,8 @@
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.

View File

@ -0,0 +1,53 @@
CMAKE_CFG_INTDIR
----------------
.. deprecated:: 3.21
This variable has poor support on :generator:`Ninja Multi-Config`, and
predates the existence of the :genex:`$<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 :ref:`Visual Studio Generators` and :generator:`Xcode`),
the value is a reference to a build-time variable specifying the name
of the per-configuration output subdirectory. On :ref:`Makefile Generators`
this evaluates to `.` because there is only one configuration in a build tree.
Example values:
::
$(ConfigurationName) = Visual Studio 9
$(Configuration) = Visual Studio 11 and above
$(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
:command:`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.

View File

@ -0,0 +1,9 @@
CMAKE_CLANG_VFS_OVERLAY
-----------------------
.. versionadded:: 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.

View File

@ -0,0 +1,7 @@
CMAKE_CL_64
-----------
Discouraged. Use :variable:`CMAKE_SIZEOF_VOID_P` instead.
Set to a true value when using a Microsoft Visual Studio ``cl`` compiler that
*targets* a 64-bit architecture.

View File

@ -0,0 +1,15 @@
CMAKE_CODEBLOCKS_COMPILER_ID
----------------------------
.. versionadded:: 3.11
Change the compiler id in the generated CodeBlocks project files.
CodeBlocks uses its own compiler id string which differs from
:variable:`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.

View File

@ -0,0 +1,9 @@
CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES
---------------------------------------
.. versionadded:: 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.

View File

@ -0,0 +1,10 @@
CMAKE_CODELITE_USE_TARGETS
--------------------------
.. versionadded:: 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.

View File

@ -0,0 +1,37 @@
CMAKE_COLOR_DIAGNOSTICS
-----------------------
.. versionadded:: 3.24
Enable color diagnostics throughout.
This variable uses three states: ``ON``, ``OFF`` and not defined.
When not defined:
* :ref:`Makefile Generators` initialize the :variable:`CMAKE_COLOR_MAKEFILE`
variable to ``ON``. It controls color buildsystem messages.
* GNU/Clang compilers are not invoked with any color diagnostics flag.
When ``ON``:
* :ref:`Makefile Generators` produce color buildsystem messages by default.
:variable:`CMAKE_COLOR_MAKEFILE` is not initialized, but may be
explicitly set to ``OFF`` to disable color buildsystem messages.
* GNU/Clang compilers are invoked with a flag enabling color diagnostics
(``-fcolor-diagnostics``).
When ``OFF``:
* :ref:`Makefile Generators` do not produce color buildsystem messages by
default. :variable:`CMAKE_COLOR_MAKEFILE` is not initialized, but may be
explicitly set to ``ON`` to enable color buildsystem messages.
* GNU/Clang compilers are invoked with a flag disabling color diagnostics
(``-fno-color-diagnostics``).
If the :envvar:`CMAKE_COLOR_DIAGNOSTICS` environment variable is set, its
value is used. Otherwise, ``CMAKE_COLOR_DIAGNOSTICS`` is not defined by
default.

View File

@ -0,0 +1,7 @@
CMAKE_COLOR_MAKEFILE
--------------------
Enables color output when using the :ref:`Makefile Generators`.
When enabled, the generated Makefiles will produce colored output.
Default is ``ON``.

View File

@ -0,0 +1,8 @@
CMAKE_COMMAND
-------------
The full path to the :manual:`cmake(1)` executable.
This is the full path to the CMake executable :manual:`cmake(1)` which is
useful from custom commands that want to use the :option:`cmake -E` option for
portable system commands. (e.g. ``/usr/local/bin/cmake``)

View File

@ -0,0 +1,6 @@
CMAKE_COMPILER_2005
-------------------
Using the Visual Studio 2005 compiler from Microsoft
Set to true when using the Visual Studio 2005 compiler from Microsoft.

View File

@ -0,0 +1,7 @@
CMAKE_COMPILER_IS_GNUCC
-----------------------
True if the ``C`` compiler is GNU.
This variable is deprecated. Use
:variable:`CMAKE_C_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` instead.

View File

@ -0,0 +1,7 @@
CMAKE_COMPILER_IS_GNUCXX
------------------------
True if the C++ (``CXX``) compiler is GNU.
This variable is deprecated. Use
:variable:`CMAKE_CXX_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` instead.

View File

@ -0,0 +1,7 @@
CMAKE_COMPILER_IS_GNUG77
------------------------
True if the ``Fortran`` compiler is GNU.
This variable is deprecated. Use
:variable:`CMAKE_Fortran_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` instead.

View File

@ -0,0 +1,10 @@
CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY
----------------------------------
.. versionadded:: 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
:prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY` property on all the targets.

View File

@ -0,0 +1,13 @@
CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG>
-------------------------------------------
.. versionadded:: 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
:variable:`CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY`.
This variable is used to initialize the
:prop_tgt:`COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG>`
property on all the targets.

View File

@ -0,0 +1,9 @@
CMAKE_COMPILE_WARNING_AS_ERROR
------------------------------
.. versionadded:: 3.24
Specify whether to treat warnings on compile as errors.
This variable is used to initialize the
:prop_tgt:`COMPILE_WARNING_AS_ERROR` property on all the targets.

View File

@ -0,0 +1,21 @@
CMAKE_CONFIGURATION_TYPES
-------------------------
Specifies the available build types (configurations) on multi-config
generators (e.g. :ref:`Visual Studio <Visual Studio Generators>`,
:generator:`Xcode`, or :generator:`Ninja Multi-Config`) as a
:ref:`semicolon-separated list <CMake Language Lists>`. Typical entries
include ``Debug``, ``Release``, ``RelWithDebInfo`` and ``MinSizeRel``,
but custom build types can also be defined.
This variable is initialized by the first :command:`project` or
:command:`enable_language` command called in a project when a new build
tree is first created. If the :envvar:`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 :ref:`Build Configurations`
for discussion of this and other related topics.
For single-config generators, see :variable:`CMAKE_BUILD_TYPE`.

View File

@ -0,0 +1,7 @@
CMAKE_<CONFIG>_POSTFIX
----------------------
Default filename postfix for libraries under configuration ``<CONFIG>``.
When a non-executable target is created its :prop_tgt:`<CONFIG>_POSTFIX`
target property is initialized with the value of this variable if it is set.

View File

@ -0,0 +1,10 @@
CMAKE_CPACK_COMMAND
-------------------
.. versionadded:: 3.13
Full path to :manual:`cpack(1)` command installed with CMake.
This is the full path to the CPack executable :manual:`cpack(1)`
that can be used for custom commands or tests to invoke
CPack commands.

View File

@ -0,0 +1,27 @@
CMAKE_CROSSCOMPILING
--------------------
This variable is set by CMake to indicate whether it is cross compiling,
but note limitations discussed below.
This variable will be set to true by CMake if the :variable:`CMAKE_SYSTEM_NAME`
variable has been set manually (i.e. in a toolchain file or as a cache entry
from the :manual:`cmake <cmake(1)>` command line). In most cases, manually
setting :variable:`CMAKE_SYSTEM_NAME` will only be done when cross compiling
since, if not manually set, it will be given the same value as
:variable:`CMAKE_HOST_SYSTEM_NAME`, which is correct for
the non-cross-compiling case. In the event that :variable:`CMAKE_SYSTEM_NAME`
is manually set to the same value as :variable:`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 :variable:`CMAKE_SYSTEM_NAME` to select the target platform, Apple
device builds use :variable:`CMAKE_OSX_SYSROOT` to select the appropriate SDK,
which indirectly determines the target platform. Furthermore, when using the
:generator:`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.

View File

@ -0,0 +1,19 @@
CMAKE_CROSSCOMPILING_EMULATOR
-----------------------------
.. versionadded:: 3.3
This variable is only used when :variable:`CMAKE_CROSSCOMPILING` is on. It
should point to a command on the host system that can run executable built
for the target system.
.. versionadded:: 3.15
If this variable contains a :ref:`semicolon-separated list <CMake Language
Lists>`, then the first value is the command and remaining values are its
arguments.
The command will be used to run :command:`try_run` generated executables,
which avoids manual population of the ``TryRunResults.cmake`` file.
It is also used as the default value for the
:prop_tgt:`CROSSCOMPILING_EMULATOR` target property of executables.

View File

@ -0,0 +1,17 @@
CMAKE_CROSS_CONFIGS
-------------------
.. versionadded:: 3.17
Specifies a :ref:`semicolon-separated list <CMake Language Lists>` of
configurations available from all ``build-<Config>.ninja`` files in the
:generator:`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 :variable:`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
:variable:`CMAKE_CONFIGURATION_TYPES`.

View File

@ -0,0 +1,8 @@
CMAKE_CTEST_ARGUMENTS
---------------------
.. versionadded:: 3.17
Set this to a :ref:`semicolon-separated list <CMake Language Lists>` of
command-line arguments to pass to :manual:`ctest(1)` when running tests
through the ``test`` (or ``RUN_TESTS``) target of the generated build system.

View File

@ -0,0 +1,8 @@
CMAKE_CTEST_COMMAND
-------------------
Full path to :manual:`ctest(1)` command installed with CMake.
This is the full path to the CTest executable :manual:`ctest(1)`
that can be used for custom commands or tests to invoke
CTest commands.

Some files were not shown because too many files have changed in this diff Show More