| .\" Man page generated from reStructuredText. |
| . |
| . |
| .nr rst2man-indent-level 0 |
| . |
| .de1 rstReportMargin |
| \\$1 \\n[an-margin] |
| level \\n[rst2man-indent-level] |
| level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| - |
| \\n[rst2man-indent0] |
| \\n[rst2man-indent1] |
| \\n[rst2man-indent2] |
| .. |
| .de1 INDENT |
| .\" .rstReportMargin pre: |
| . RS \\$1 |
| . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] |
| . nr rst2man-indent-level +1 |
| .\" .rstReportMargin post: |
| .. |
| .de UNINDENT |
| . RE |
| .\" indent \\n[an-margin] |
| .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| .nr rst2man-indent-level -1 |
| .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| .in \\n[rst2man-indent\\n[rst2man-indent-level]]u |
| .. |
| .TH "CMAKE-ENV-VARIABLES" "7" "Jan 23, 2025" "3.31.5" "CMake" |
| .SH NAME |
| cmake-env-variables \- CMake Environment Variables Reference |
| .sp |
| This page lists environment variables that have special |
| meaning to CMake. |
| .sp |
| For general information on environment variables, see the |
| \X'tty: link |
| section in the cmake\-language manual. |
| .SH ENVIRONMENT VARIABLES THAT CHANGE BEHAVIOR |
| .SS CMAKE_APPBUNDLE_PATH |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The \fBCMAKE_APPBUNDLE_PATH\fP environment variable may be set to a list of |
| directories to be searched for macOS application bundles |
| by the \X'tty: link |
| .sp |
| This variable may hold a single directory or a list of directories separated |
| by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment |
| variable convention on those platforms). |
| .sp |
| See also the \X'tty: link |
| .SS CMAKE_FRAMEWORK_PATH |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The \fBCMAKE_FRAMEWORK_PATH\fP environment variable may be set to a list of |
| directories to be searched for macOS frameworks by the \X'tty: link |
| \X'tty: link |
| .sp |
| This variable may hold a single directory or a list of directories separated |
| by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment |
| variable convention on those platforms). |
| .sp |
| See also the \X'tty: link |
| .SS CMAKE_INCLUDE_PATH |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The \fBCMAKE_INCLUDE_PATH\fP environment variable may be set to a list of |
| directories to be searched by the \X'tty: link |
| .sp |
| This variable may hold a single directory or a list of directories separated |
| by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment |
| variable convention on those platforms). |
| .sp |
| See also the \X'tty: link |
| .SS CMAKE_LIBRARY_PATH |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The \fBCMAKE_LIBRARY_PATH\fP environment variable may be set to a list of |
| directories to be searched by the \X'tty: link |
| .sp |
| This variable may hold a single directory or a list of directories separated |
| by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment |
| variable convention on those platforms). |
| .sp |
| See also the \X'tty: link |
| .SS CMAKE_MAXIMUM_RECURSION_DEPTH |
| .sp |
| Added in version 3.27. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Maximum recursion depth for CMake scripts. This environment variable is |
| used if the \X'tty: link |
| See that variable\(aqs documentation for details. |
| .SS CMAKE_PREFIX_PATH |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The \fBCMAKE_PREFIX_PATH\fP environment variable may be set to a list of |
| directories specifying installation \fIprefixes\fP to be searched by the |
| \X'tty: link |
| \X'tty: link |
| add appropriate subdirectories (like \fBbin\fP, \fBlib\fP, or \fBinclude\fP) |
| as specified in its own documentation. |
| .sp |
| This variable may hold a single prefix or a list of prefixes separated |
| by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment |
| variable convention on those platforms). |
| .sp |
| See also the \X'tty: link |
| .SS CMAKE_PROGRAM_PATH |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The \fBCMAKE_PROGRAM_PATH\fP environment variable may be set to a list of |
| directories to be searched by the \X'tty: link |
| .sp |
| This variable may hold a single directory or a list of directories separated |
| by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment |
| variable convention on those platforms). |
| .sp |
| See also the \X'tty: link |
| .SS CMAKE_TLS_VERIFY |
| .sp |
| Added in version 3.30. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Specify the default value for the \X'tty: link |
| \X'tty: link |
| This environment variable is used if the option is not given |
| and the \X'tty: link |
| .sp |
| This variable is also used by the \X'tty: link |
| \X'tty: link |
| \X'tty: link |
| .SS CMAKE_TLS_VERSION |
| .sp |
| Added in version 3.30. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Specify the default value for the \X'tty: link |
| \X'tty: link |
| This environment variable is used if the option is not given |
| and the \X'tty: link |
| See that variable for allowed values. |
| .sp |
| This variable is also used by the \X'tty: link |
| \X'tty: link |
| \X'tty: link |
| .SS SSL_CERT_DIR |
| .sp |
| Added in version 3.25. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Specify default directory containing CA certificates. It overrides |
| the default CA directory used. |
| .SS SSL_CERT_FILE |
| .sp |
| Added in version 3.25. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Specify the file name containing CA certificates. It overrides the |
| default, os\-specific CA file used. |
| .SH ENVIRONMENT VARIABLES THAT CONTROL THE BUILD |
| .SS ADSP_ROOT |
| .sp |
| Added in version 3.24. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The \fBADSP_ROOT\fP environment variable specifies a default value |
| for the \X'tty: link |
| configuration given on the first run while creating a new build tree. |
| .SS CMAKE_APPLE_SILICON_PROCESSOR |
| .sp |
| Added in version 3.19.2. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| On Apple Silicon hosts running macOS, set this environment variable to tell |
| CMake what architecture to use for \X'tty: link |
| The value must be either \fBarm64\fP or \fBx86_64\fP\&. |
| .sp |
| The \X'tty: link |
| overrides this environment variable. |
| .SS CMAKE_BUILD_PARALLEL_LEVEL |
| .sp |
| Added in version 3.12. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Specifies the maximum number of concurrent processes to use when building |
| using the \fBcmake \-\-build\fP command line |
| \X'tty: link |
| For example, if \fBCMAKE_BUILD_PARALLEL_LEVEL\fP is set to 8, the |
| underlying build tool will execute up to 8 jobs concurrently as if |
| \fBcmake \-\-build\fP were invoked with the |
| \X'tty: link |
| .sp |
| If this variable is defined empty the native build tool\(aqs default number is |
| used. |
| .SS CMAKE_BUILD_TYPE |
| .sp |
| Added in version 3.22. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The \fBCMAKE_BUILD_TYPE\fP environment variable specifies a default value |
| for the \X'tty: link |
| configuration given on the first run while creating a new build tree. |
| .SS CMAKE_COLOR_DIAGNOSTICS |
| .sp |
| Added in version 3.24. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Specifies a default value for the \X'tty: link |
| when there is no explicit value given on the first run. |
| .SS CMAKE_CONFIG_DIR |
| .sp |
| Added in version 3.31. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Specify a CMake user\-wide configuration directory for |
| \X'tty: link |
| .sp |
| If this environment variable is not set, the default user\-wide |
| configuration directory is platform\-specific: |
| .INDENT 0.0 |
| .IP \(bu 2 |
| Windows: \fB%LOCALAPPDATA%\eCMake\fP |
| .IP \(bu 2 |
| macOS: \fB$XDG_CONFIG_HOME/CMake\fP if set, otherwise |
| \fB$HOME/Library/Application Support/CMake\fP |
| .IP \(bu 2 |
| Linux/Other: \fB$XDG_CONFIG_HOME/cmake\fP if set, otherwise |
| \fB$HOME/.config/cmake\fP |
| .UNINDENT |
| .SS CMAKE_CONFIG_TYPE |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The default build configuration for \X'tty: link |
| \fBctest\fP build handler when there is no explicit configuration given. |
| .SS CMAKE_CONFIGURATION_TYPES |
| .sp |
| Added in version 3.22. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The \fBCMAKE_CONFIGURATION_TYPES\fP environment variable specifies a |
| default value for the \X'tty: link |
| when there is no explicit configuration given on the first run while |
| creating a new build tree. |
| .SS CMAKE_CROSSCOMPILING_EMULATOR |
| .sp |
| Added in version 3.28. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The default value for \X'tty: link |
| is no explicit configuration given on the first run while creating a new |
| build tree. On later runs in an existing build tree the value persists in |
| the cache as \X'tty: link |
| .SS CMAKE_EXPORT_BUILD_DATABASE |
| .sp |
| Added in version 3.31. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The default value for \X'tty: link |
| explicit configuration given on the first run while creating a new build tree. |
| On later runs in an existing build tree the value persists in the cache as |
| \X'tty: link |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| This variable is meaningful only when experimental support for build |
| databases has been enabled by the |
| \fBCMAKE_EXPERIMENTAL_EXPORT_BUILD_DATABASE\fP gate. |
| .UNINDENT |
| .UNINDENT |
| .SS CMAKE_EXPORT_COMPILE_COMMANDS |
| .sp |
| Added in version 3.17. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The default value for \X'tty: link |
| is no explicit configuration given on the first run while creating a new |
| build tree. On later runs in an existing build tree the value persists in |
| the cache as \X'tty: link |
| .SS CMAKE_GENERATOR |
| .sp |
| Added in version 3.15. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Specifies the CMake default generator to use when no generator is supplied |
| with \X'tty: link |
| known by CMake, the internal default is used. Either way the resulting |
| generator selection is stored in the \X'tty: link |
| .sp |
| Some generators may be additionally configured using the environment |
| variables: |
| .INDENT 0.0 |
| .IP \(bu 2 |
| \X'tty: link |
| .IP \(bu 2 |
| \X'tty: link |
| .IP \(bu 2 |
| \X'tty: link |
| .UNINDENT |
| .SS CMAKE_GENERATOR_INSTANCE |
| .sp |
| Added in version 3.15. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Default value for \X'tty: link |
| present. This value is only applied if \X'tty: link |
| .SS CMAKE_GENERATOR_PLATFORM |
| .sp |
| Added in version 3.15. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Default value for \X'tty: link |
| is present and no value is specified by \X'tty: link |
| This value is only applied if \X'tty: link |
| .SS CMAKE_GENERATOR_TOOLSET |
| .sp |
| Added in version 3.15. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Default value for \X'tty: link |
| is present and no value is specified by \X'tty: link |
| This value is only applied if \X'tty: link |
| .SS CMAKE_INSTALL_MODE |
| .sp |
| Added in version 3.22. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The \fBCMAKE_INSTALL_MODE\fP environment variable allows users to operate |
| CMake in an alternate mode of \X'tty: link |
| .sp |
| The default behavior for an installation is to copy a source file from a |
| source directory into a destination directory. This environment variable |
| however allows the user to override this behavior, causing CMake to create |
| symbolic links instead. |
| .SS Usage Scenarios |
| .sp |
| Installing symbolic links rather than copying files can help in the following |
| ways: |
| .INDENT 0.0 |
| .IP \(bu 2 |
| Conserving storage space because files do not have to be duplicated on disk. |
| .IP \(bu 2 |
| Changes to the source of the symbolic link are seen at the install |
| destination without having to re\-run the install step. |
| .IP \(bu 2 |
| Editing through the link at the install destination will modify the source |
| of the link. This may be useful when dealing with CMake project hierarchies, |
| i.e. using \X'tty: link |
| refactoring is desired across projects. |
| .UNINDENT |
| .SS Allowed Values |
| .sp |
| The following values are allowed for \fBCMAKE_INSTALL_MODE\fP: |
| .INDENT 0.0 |
| .TP |
| .B \fBCOPY\fP, empty or unset |
| Duplicate the file at its destination. This is the default behavior. |
| .TP |
| .B \fBABS_SYMLINK\fP |
| Create an \fIabsolute\fP symbolic link to the source file at the destination. |
| Halt with an error if the link cannot be created. |
| .TP |
| .B \fBABS_SYMLINK_OR_COPY\fP |
| Like \fBABS_SYMLINK\fP but fall back to silently copying if the symlink |
| couldn\(aqt be created. |
| .TP |
| .B \fBREL_SYMLINK\fP |
| Create a \fIrelative\fP symbolic link to the source file at the destination. |
| Halt with an error if the link cannot be created. |
| .TP |
| .B \fBREL_SYMLINK_OR_COPY\fP |
| Like \fBREL_SYMLINK\fP but fall back to silently copying if the symlink |
| couldn\(aqt be created. |
| .TP |
| .B \fBSYMLINK\fP |
| Try as if through \fBREL_SYMLINK\fP and fall back to \fBABS_SYMLINK\fP if the |
| referenced file cannot be expressed using a relative path. |
| Halt with an error if the link cannot be created. |
| .TP |
| .B \fBSYMLINK_OR_COPY\fP |
| Like \fBSYMLINK\fP but fall back to silently copying if the symlink couldn\(aqt |
| be created. |
| .UNINDENT |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| A symbolic link consists of a reference file path rather than contents of its |
| own, hence there are two ways to express the relation, either by a \fIrelative\fP |
| or an \fIabsolute\fP path. |
| .UNINDENT |
| .UNINDENT |
| .SS When To Set The Environment Variable |
| .sp |
| For the environment variable to take effect, it must be set during the correct |
| build phase(s). |
| .INDENT 0.0 |
| .IP \(bu 2 |
| If the project calls \X'tty: link |
| variable must be set during the configuration phase. |
| .IP \(bu 2 |
| In order to apply to \X'tty: link |
| set during installation. This could be during a build if using the |
| \fBinstall\fP or \fBpackage\fP build targets, or separate from the build when |
| invoking an install or running \X'tty: link |
| line. |
| .IP \(bu 2 |
| When using \X'tty: link |
| phase, since the external project\(aqs own configure, build and install steps |
| will execute during the main project\(aqs build phase. |
| .UNINDENT |
| .sp |
| Given the above, it is recommended to set the environment variable consistently |
| across all phases (configure, build and install). |
| .SS Caveats |
| .sp |
| Use this environment variable with caution. The following highlights some |
| points to be considered: |
| .INDENT 0.0 |
| .IP \(bu 2 |
| \fBCMAKE_INSTALL_MODE\fP only affects files, not directories. |
| .IP \(bu 2 |
| Symbolic links are not available on all platforms. |
| .IP \(bu 2 |
| The way this environment variable interacts with the install step of |
| \X'tty: link |
| module\(aqs documentation. |
| .IP \(bu 2 |
| A symbolic link ties the destination to the source in a persistent way. |
| Writing to either of the two affects both file system objects. |
| This is in contrast to normal install behavior which only copies files as |
| they were at the time the install was performed, with no enduring |
| relationship between the source and destination of the install. |
| .IP \(bu 2 |
| Combining \fBCMAKE_INSTALL_MODE\fP with \X'tty: link |
| not supported. |
| .IP \(bu 2 |
| Changing \fBCMAKE_INSTALL_MODE\fP from what it was on a previous run can lead |
| to unexpected results. Moving from a non\-symlinking mode to a symlinking |
| mode will discard any previous file at the destination, but the reverse is |
| not true. Once a symlink exists at the destination, even if you switch to a |
| non\-symlink mode, the symlink will continue to exist at the destination and |
| will not be replaced by an actual file. |
| .UNINDENT |
| .SS CMAKE_INSTALL_PARALLEL_LEVEL |
| .sp |
| Added in version 3.31. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Specifies the default maximum number of concurrent processes to use when |
| installing using \fBcmake \-\-install\fP\&. |
| .sp |
| This has no impact unless \X'tty: link |
| .SS CMAKE_INSTALL_PREFIX |
| .sp |
| Added in version 3.29. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The \fBCMAKE_INSTALL_PREFIX\fP environment variable specifies a custom default |
| value for the \X'tty: link |
| default values specified by CMake itself. The value specified must be an |
| absolute path to a directory. |
| .SS CMAKE_<LANG>_COMPILER_LAUNCHER |
| .sp |
| Added in version 3.17. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Default compiler launcher to use for the specified language. Will only be used |
| by CMake to initialize the variable on the first configuration. Afterwards, it |
| is available through the cache setting of the variable of the same name. For |
| any configuration run (including the first), the environment variable will be |
| ignored if the \X'tty: link |
| .SS CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES_EXCLUDE |
| .sp |
| Added in version 3.27. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| A \X'tty: link |
| to exclude from the \X'tty: link |
| variable when it is automatically detected from the \fB<LANG>\fP compiler. |
| .sp |
| This may be used to work around misconfigured compiler drivers that pass |
| extraneous implicit link directories to their linker. |
| .SS CMAKE_<LANG>_LINKER_LAUNCHER |
| .sp |
| Added in version 3.21. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Default launcher to use when linking a target of the specified language. Will |
| only be used by CMake to initialize the variable on the first configuration. |
| Afterwards, it is available through the cache setting of the variable of the |
| same name. For any configuration run (including the first), the environment |
| variable will be ignored if the \X'tty: link |
| variable is defined. |
| .SS CMAKE_MSVCIDE_RUN_PATH |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Extra PATH locations for custom commands when using |
| \X'tty: link |
| .sp |
| The \fBCMAKE_MSVCIDE_RUN_PATH\fP environment variable sets the default value for |
| the \X'tty: link |
| .SS CMAKE_NO_VERBOSE |
| .sp |
| Added in version 3.14. |
|
|
| .sp |
| Disables verbose output from CMake when \X'tty: link |
| is set. |
| .sp |
| Only your build tool of choice will still print verbose output when you start |
| to actually build your project. |
| .SS CMAKE_OSX_ARCHITECTURES |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Target specific architectures for macOS. |
| .sp |
| The \fBCMAKE_OSX_ARCHITECTURES\fP environment variable sets the default value for |
| the \X'tty: link |
| \X'tty: link |
| .SS CMAKE_TEST_LAUNCHER |
| .sp |
| Added in version 3.29. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The default value for the \X'tty: link |
| is no explicit configuration given on the first run while creating a new |
| build tree. On later runs in an existing build tree the value persists in |
| the cache as \X'tty: link |
| .SS CMAKE_TOOLCHAIN_FILE |
| .sp |
| Added in version 3.21. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| The \fBCMAKE_TOOLCHAIN_FILE\fP environment variable specifies a default value |
| for the \X'tty: link |
| configuration given on the first run while creating a new build tree. |
| On later runs in an existing build tree the value persists in the cache |
| as \X'tty: link |
| .SS DESTDIR |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| On UNIX one can use the \fBDESTDIR\fP mechanism in order to relocate the |
| whole installation. \fBDESTDIR\fP means DESTination DIRectory. It is |
| commonly used by packagers to install software in a staging directory. |
| .sp |
| For example, running |
| .INDENT 0.0 |
| .INDENT 3.5 |
| .sp |
| .nf |
| .ft C |
| make DESTDIR=/package/stage install |
| .ft P |
| .fi |
| .UNINDENT |
| .UNINDENT |
| .sp |
| will install the software using the installation prefix, e.g. \fB/usr/local\fP, |
| prepended with the \fBDESTDIR\fP value which gives \fB/package/stage/usr/local\fP\&. |
| The packaging tool may then construct the package from the content of the |
| \fB/package/stage\fP directory. |
| .sp |
| See the \X'tty: link |
| installation prefix when configuring a build tree. Or, when using |
| the \X'tty: link |
| mode, one may specify a different prefix using the |
| \X'tty: link |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| \fBDESTDIR\fP may not be used on Windows because installation |
| prefix usually contains a drive letter like in \fBC:/Program Files\fP |
| which cannot be prepended with some other prefix. |
| .UNINDENT |
| .UNINDENT |
| .SS LDFLAGS |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Will only be used by CMake on the first configuration to determine the default |
| linker flags, after which the value for \fBLDFLAGS\fP is stored in the cache |
| as \X'tty: link |
| \X'tty: link |
| \X'tty: link |
| (including the first), the environment variable will be ignored if the |
| equivalent \fBCMAKE_<TYPE>_LINKER_FLAGS_INIT\fP variable is defined. |
| .SS MACOSX_DEPLOYMENT_TARGET |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Specify the minimum version of macOS on which the target binaries are |
| to be deployed. |
| .sp |
| The \fBMACOSX_DEPLOYMENT_TARGET\fP environment variable sets the default value for |
| the \X'tty: link |
| .SS <PackageName>_ROOT |
| .sp |
| Added in version 3.12. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Calls to \X'tty: link |
| specified by the \fB<PackageName>_ROOT\fP environment variable, where |
| \fB<PackageName>\fP is the (case\-preserved) name given to the |
| \X'tty: link |
| For example, \fBfind_package(Foo)\fP will search prefixes specified in the |
| \fBFoo_ROOT\fP environment variable (if set). See policy \X'tty: link |
| .sp |
| This variable may hold a single prefix or a list of prefixes separated |
| by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment |
| variable convention on those platforms). |
| .sp |
| See also the \X'tty: link |
| .INDENT 0.0 |
| .TP |
| .B <PACKAGENAME>_ROOT |
| Added in version 3.27. |
|
|
| .sp |
| Calls to \X'tty: link |
| prefixes specified by the upper\-case \fB<PACKAGENAME>_ROOT\fP environment |
| variable. See policy \X'tty: link |
| .UNINDENT |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| Note that the \fB<PackageName>_ROOT\fP and \fB<PACKAGENAME>_ROOT\fP |
| environment variables are distinct only on platforms that have |
| case\-sensitive environments. |
| .UNINDENT |
| .UNINDENT |
| .SS VERBOSE |
| .sp |
| Added in version 3.14. |
|
|
| .sp |
| Activates verbose output from CMake and your build tools of choice when |
| you start to actually build your project. |
| .sp |
| Note that any given value is ignored. It\(aqs just checked for existence. |
| .sp |
| See also \X'tty: link |
| \X'tty: link |
| .SH ENVIRONMENT VARIABLES FOR LANGUAGES |
| .SS ASM<DIALECT> |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling a specific dialect of assembly language |
| files. \fBASM<DIALECT>\fP can be one of: |
| .INDENT 0.0 |
| .IP \(bu 2 |
| \fBASM\fP |
| .IP \(bu 2 |
| \fBASM_NASM\fP (Netwide Assembler) |
| .IP \(bu 2 |
| \fBASM_MASM\fP (Microsoft Assembler) |
| .IP \(bu 2 |
| \fBASM_MARMASM\fP (Microsoft ARM Assembler) |
| .IP \(bu 2 |
| \fBASM\-ATT\fP (Assembler AT&T) |
| .UNINDENT |
| .sp |
| Will only be used by CMake on the first configuration to determine |
| \fBASM<DIALECT>\fP compiler, after which the value for \fBASM<DIALECT>\fP is stored |
| in the cache as |
| \X'tty: link |
| configuration runs, the environment variable will be ignored in favor of |
| \X'tty: link |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| Options that are required to make the compiler work correctly can be included; |
| they can not be changed. |
| .UNINDENT |
| .UNINDENT |
| .INDENT 0.0 |
| .INDENT 3.5 |
| .sp |
| .nf |
| .ft C |
| $ export ASM=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq |
| .ft P |
| .fi |
| .UNINDENT |
| .UNINDENT |
| .SS ASM<DIALECT>FLAGS |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Add default compilation flags to be used when compiling a specific dialect |
| of an assembly language. \fBASM<DIALECT>FLAGS\fP can be one of: |
| .INDENT 0.0 |
| .IP \(bu 2 |
| \fBASMFLAGS\fP |
| .IP \(bu 2 |
| \fBASM_NASMFLAGS\fP |
| .IP \(bu 2 |
| \fBASM_MASMFLAGS\fP |
| .IP \(bu 2 |
| \fBASM_MARMASMFLAGS\fP |
| .IP \(bu 2 |
| \fBASM\-ATTFLAGS\fP |
| .UNINDENT |
| .sp |
| CMake uses this environment variable value, in combination with its own |
| builtin default flags for the toolchain, to initialize and store the |
| \X'tty: link |
| This occurs the first time a build tree is configured for language \fBASM<DIALECT>\fP\&. |
| For any configuration run (including the first), the environment variable |
| will be ignored if the \X'tty: link |
| .sp |
| See also \X'tty: link |
| .SS CC |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling \fBC\fP language files. Will only be used by |
| CMake on the first configuration to determine \fBC\fP compiler, after which the |
| value for \fBCC\fP is stored in the cache as |
| \X'tty: link |
| (including the first), the environment variable will be ignored if the |
| \X'tty: link |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| Options that are required to make the compiler work correctly can be included; |
| they can not be changed. |
| .UNINDENT |
| .UNINDENT |
| .INDENT 0.0 |
| .INDENT 3.5 |
| .sp |
| .nf |
| .ft C |
| $ export CC=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq |
| .ft P |
| .fi |
| .UNINDENT |
| .UNINDENT |
| .SS CFLAGS |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Add default compilation flags to be used when compiling \fBC\fP files. |
| .sp |
| CMake uses this environment variable value, in combination with its own |
| builtin default flags for the toolchain, to initialize and store the |
| \X'tty: link |
| This occurs the first time a build tree is configured for language \fBC\fP\&. |
| For any configuration run (including the first), the environment variable |
| will be ignored if the \X'tty: link |
| .sp |
| See also \X'tty: link |
| .SS CSFLAGS |
| .sp |
| Added in version 3.9.2. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Add default compilation flags to be used when compiling \fBCSharp\fP files. |
| .sp |
| CMake uses this environment variable value, in combination with its own |
| builtin default flags for the toolchain, to initialize and store the |
| \X'tty: link |
| This occurs the first time a build tree is configured for language \fBCSharp\fP\&. |
| For any configuration run (including the first), the environment variable |
| will be ignored if the \X'tty: link |
| .sp |
| See also \X'tty: link |
| .SS CUDAARCHS |
| .sp |
| Added in version 3.20. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Value used to initialize \X'tty: link |
| configuration. Subsequent runs will use the value stored in the cache. |
| .sp |
| This is a semicolon\-separated list of architectures as described in |
| \X'tty: link |
| .SS CUDACXX |
| .sp |
| Added in version 3.8. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling \fBCUDA\fP language files. Will only be used by |
| CMake on the first configuration to determine \fBCUDA\fP compiler, after which the |
| value for \fBCUDA\fP is stored in the cache as |
| \X'tty: link |
| run (including the first), the environment variable will be ignored if the |
| \X'tty: link |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| Options that are required to make the compiler work correctly can be included; |
| they can not be changed. |
| .UNINDENT |
| .UNINDENT |
| .INDENT 0.0 |
| .INDENT 3.5 |
| .sp |
| .nf |
| .ft C |
| $ export CUDACXX=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq |
| .ft P |
| .fi |
| .UNINDENT |
| .UNINDENT |
| .SS CUDAFLAGS |
| .sp |
| Added in version 3.8. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Add default compilation flags to be used when compiling \fBCUDA\fP files. |
| .sp |
| CMake uses this environment variable value, in combination with its own |
| builtin default flags for the toolchain, to initialize and store the |
| \X'tty: link |
| This occurs the first time a build tree is configured for language \fBCUDA\fP\&. |
| For any configuration run (including the first), the environment variable |
| will be ignored if the \X'tty: link |
| .sp |
| See also \X'tty: link |
| .SS CUDAHOSTCXX |
| .sp |
| Added in version 3.8. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling host code when compiling \fBCUDA\fP |
| language files. Will only be used by CMake on the first configuration to |
| determine \fBCUDA\fP host compiler, after which the value for \fBCUDAHOSTCXX\fP is |
| stored in the cache as |
| \X'tty: link |
| This environment variable is preferred over |
| \X'tty: link |
| .sp |
| This environment variable is primarily meant for use with projects that |
| enable \fBCUDA\fP as a first\-class language. |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| Ignored when using \X'tty: link |
| .UNINDENT |
| .UNINDENT |
| .sp |
| Added in version 3.13: The \X'tty: link |
| module will use this variable to initialize its \fBCUDA_HOST_COMPILER\fP setting. |
|
|
| .SS CXX |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling \fBCXX\fP language files. Will only be used by |
| CMake on the first configuration to determine \fBCXX\fP compiler, after which the |
| value for \fBCXX\fP is stored in the cache as |
| \X'tty: link |
| run (including the first), the environment variable will be ignored if the |
| \X'tty: link |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| Options that are required to make the compiler work correctly can be included; |
| they can not be changed. |
| .UNINDENT |
| .UNINDENT |
| .INDENT 0.0 |
| .INDENT 3.5 |
| .sp |
| .nf |
| .ft C |
| $ export CXX=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq |
| .ft P |
| .fi |
| .UNINDENT |
| .UNINDENT |
| .SS CXXFLAGS |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Add default compilation flags to be used when compiling \fBCXX\fP (C++) files. |
| .sp |
| CMake uses this environment variable value, in combination with its own |
| builtin default flags for the toolchain, to initialize and store the |
| \X'tty: link |
| This occurs the first time a build tree is configured for language \fBCXX\fP\&. |
| For any configuration run (including the first), the environment variable |
| will be ignored if the \X'tty: link |
| .sp |
| See also \X'tty: link |
| .SS FC |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling \fBFortran\fP language files. Will only be used |
| by CMake on the first configuration to determine \fBFortran\fP compiler, after |
| which the value for \fBFortran\fP is stored in the cache as |
| \X'tty: link |
| configuration run (including the first), the environment variable will be |
| ignored if the \X'tty: link |
| variable is defined. |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| Options that are required to make the compiler work correctly can be included; |
| they can not be changed. |
| .UNINDENT |
| .UNINDENT |
| .INDENT 0.0 |
| .INDENT 3.5 |
| .sp |
| .nf |
| .ft C |
| $ export FC=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq |
| .ft P |
| .fi |
| .UNINDENT |
| .UNINDENT |
| .SS FFLAGS |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Add default compilation flags to be used when compiling \fBFortran\fP files. |
| .sp |
| CMake uses this environment variable value, in combination with its own |
| builtin default flags for the toolchain, to initialize and store the |
| \X'tty: link |
| This occurs the first time a build tree is configured for language \fBFortran\fP\&. |
| For any configuration run (including the first), the environment variable |
| will be ignored if the \X'tty: link |
| .sp |
| See also \X'tty: link |
| .SS HIPCXX |
| .sp |
| Added in version 3.21. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling \fBHIP\fP language files. Will only be used by |
| CMake on the first configuration to determine \fBHIP\fP compiler, after which the |
| value for \fBHIP\fP is stored in the cache as |
| \X'tty: link |
| run (including the first), the environment variable will be ignored if the |
| \X'tty: link |
| .SS HIPFLAGS |
| .sp |
| Added in version 3.21. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Add default compilation flags to be used when compiling \fBHIP\fP files. |
| .sp |
| CMake uses this environment variable value, in combination with its own |
| builtin default flags for the toolchain, to initialize and store the |
| \X'tty: link |
| This occurs the first time a build tree is configured for language \fBHIP\fP\&. |
| For any configuration run (including the first), the environment variable |
| will be ignored if the \X'tty: link |
| .sp |
| See also \X'tty: link |
| .SS HIPHOSTCXX |
| .sp |
| Added in version 3.28. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling host code when compiling \fBHIP\fP |
| language files with the NVIDIA CUDA Compiler. Will only be used by CMake |
| on the first configuration to determine \fBHIP\fP host compiler, after which |
| the value for \fBHIPHOSTCXX\fP is stored in the cache as |
| \X'tty: link |
| .sp |
| This environment variable is primarily meant for use with projects that |
| enable \fBHIP\fP as a first\-class language. |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| Ignored when using \X'tty: link |
| .UNINDENT |
| .UNINDENT |
| .SS ISPC |
| .sp |
| Added in version 3.19. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling \fBISPC\fP language files. Will only be used by |
| CMake on the first configuration to determine \fBISPC\fP compiler, after which the |
| value for \fBISPC\fP is stored in the cache as |
| \X'tty: link |
| run (including the first), the environment variable will be ignored if the |
| \X'tty: link |
| .SS ISPCFLAGS |
| .sp |
| Added in version 3.19. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Add default compilation flags to be used when compiling \fBISPC\fP files. |
| .sp |
| CMake uses this environment variable value, in combination with its own |
| builtin default flags for the toolchain, to initialize and store the |
| \X'tty: link |
| This occurs the first time a build tree is configured for language \fBISPC\fP\&. |
| For any configuration run (including the first), the environment variable |
| will be ignored if the \X'tty: link |
| .sp |
| See also \X'tty: link |
| .SS OBJC |
| .sp |
| Added in version 3.16.7. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling \fBOBJC\fP language files. Will only be used |
| by CMake on the first configuration to determine \fBOBJC\fP compiler, after |
| which the value for \fBOBJC\fP is stored in the cache as |
| \X'tty: link |
| run (including the first), the environment variable will be ignored if the |
| \X'tty: link |
| .sp |
| If \fBOBJC\fP is not defined, the \X'tty: link |
| be checked instead. |
| .SS OBJCFLAGS |
| .sp |
| Added in version 3.16. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Add default compilation flags to be used when compiling \fBObjective C\fP files. |
| .sp |
| CMake uses this environment variable value, in combination with its own |
| builtin default flags for the toolchain, to initialize and store the |
| \X'tty: link |
| This occurs the first time a build tree is configured for language \fBOBJC\fP\&. |
| For any configuration run (including the first), the environment variable |
| will be ignored if the \X'tty: link |
| .sp |
| See also \X'tty: link |
| .SS OBJCXX |
| .sp |
| Added in version 3.16.7. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling \fBOBJCXX\fP language files. Will only be used |
| by CMake on the first configuration to determine \fBOBJCXX\fP compiler, after |
| which the value for \fBOBJCXX\fP is stored in the cache as |
| \X'tty: link |
| run (including the first), the environment variable will be ignored if the |
| \X'tty: link |
| .sp |
| If \fBOBJCXX\fP is not defined, the \X'tty: link |
| be checked instead. |
| .SS OBJCXXFLAGS |
| .sp |
| Added in version 3.16. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Add default compilation flags to be used when compiling \fBObjective C++\fP (.mm) files. |
| .sp |
| CMake uses this environment variable value, in combination with its own |
| builtin default flags for the toolchain, to initialize and store the |
| \X'tty: link |
| This occurs the first time a build tree is configured for language \fBOBJCXX\fP\&. |
| For any configuration run (including the first), the environment variable |
| will be ignored if the \X'tty: link |
| .sp |
| See also \X'tty: link |
| .SS RC |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling \fBresource\fP files. Will only be used by CMake |
| on the first configuration to determine \fBresource\fP compiler, after which the |
| value for \fBRC\fP is stored in the cache as |
| \X'tty: link |
| (including the first), the environment variable will be ignored if the |
| \X'tty: link |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| Options that are required to make the compiler work correctly can be included; |
| they can not be changed. |
| .UNINDENT |
| .UNINDENT |
| .INDENT 0.0 |
| .INDENT 3.5 |
| .sp |
| .nf |
| .ft C |
| $ export RC=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq |
| .ft P |
| .fi |
| .UNINDENT |
| .UNINDENT |
| .SS RCFLAGS |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Add default compilation flags to be used when compiling \fBRC\fP (resource) files. |
| .sp |
| CMake uses this environment variable value, in combination with its own |
| builtin default flags for the toolchain, to initialize and store the |
| \X'tty: link |
| This occurs the first time a build tree is configured for language \fBRC\fP\&. |
| For any configuration run (including the first), the environment variable |
| will be ignored if the \X'tty: link |
| .sp |
| See also \X'tty: link |
| .SS SWIFTC |
| .sp |
| Added in version 3.15. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Preferred executable for compiling \fBSwift\fP language files. Will only be used by |
| CMake on the first configuration to determine \fBSwift\fP compiler, after which the |
| value for \fBSWIFTC\fP is stored in the cache as |
| \X'tty: link |
| (including the first), the environment variable will be ignored if the |
| \X'tty: link |
| .sp |
| \fBNOTE:\fP |
| .INDENT 0.0 |
| .INDENT 3.5 |
| Options that are required to make the compiler work correctly can be included; |
| they can not be changed. |
| .UNINDENT |
| .UNINDENT |
| .INDENT 0.0 |
| .INDENT 3.5 |
| .sp |
| .nf |
| .ft C |
| $ export SWIFTC=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq |
| .ft P |
| .fi |
| .UNINDENT |
| .UNINDENT |
| .SH ENVIRONMENT VARIABLES FOR CTEST |
| .SS CTEST_INTERACTIVE_DEBUG_MODE |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Environment variable that will exist and be set to \fB1\fP when a test executed |
| by \X'tty: link |
| .SS CTEST_NO_TESTS_ACTION |
| .sp |
| Added in version 3.26. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Environment variable that controls how \X'tty: link |
| cases when there are no tests to run. Possible values are: \fBerror\fP, |
| \fBignore\fP, empty or unset. |
| .sp |
| The \X'tty: link |
| \X'tty: link |
| are given. |
| .SS CTEST_OUTPUT_ON_FAILURE |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Boolean environment variable that controls if the output should be logged for |
| failed tests. Set the value to \fB1\fP, \fBTrue\fP, or \fBON\fP to enable output on failure. |
| See \X'tty: link |
| tests. |
| .SS CTEST_PARALLEL_LEVEL |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Specify the number of tests for CTest to run in parallel. |
| For example, if \fBCTEST_PARALLEL_LEVEL\fP is set to 8, CTest will run |
| up to 8 tests concurrently as if \fBctest\fP were invoked with the |
| \X'tty: link |
| .sp |
| Changed in version 3.29: The value may be empty, or \fB0\fP, to let ctest use a default level of |
| parallelism, or unbounded parallelism, respectively, as documented by |
| the \X'tty: link |
| .sp |
| On Windows, environment variables cannot be set to an empty string. |
| CTest will interpret a whitespace\-only string as empty. |
| .sp |
| In CMake 3.28 and earlier, an empty or \fB0\fP value was equivalent to \fB1\fP\&. |
|
|
| .sp |
| See \X'tty: link |
| .SS CTEST_PROGRESS_OUTPUT |
| .sp |
| Added in version 3.13. |
|
|
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Boolean environment variable that affects how \X'tty: link |
| command output reports overall progress. When set to \fB1\fP, \fBTRUE\fP, \fBON\fP or anything |
| else that evaluates to boolean true, progress is reported by repeatedly |
| updating the same line. This greatly reduces the overall verbosity, but is |
| only supported when output is sent directly to a terminal. If the environment |
| variable is not set or has a value that evaluates to false, output is reported |
| normally with each test having its own start and end lines logged to the |
| output. |
| .sp |
| The \X'tty: link |
| overrides this environment variable if both are given. |
| .SS CTEST_USE_LAUNCHERS_DEFAULT |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Initializes the \X'tty: link |
| .SS DASHBOARD_TEST_FROM_CTEST |
| .sp |
| This is a CMake \X'tty: link |
| the calling process environment. |
| .sp |
| Environment variable that will exist when a test executed by \X'tty: link |
| is run in non\-interactive mode. The value will be equal to |
| \X'tty: link |
| .SH ENVIRONMENT VARIABLES FOR THE CMAKE CURSES INTERFACE |
| .SS CCMAKE_COLORS |
| .sp |
| Added in version 3.18. |
|
|
| .sp |
| Determines what colors are used by the CMake curses interface, |
| when run on a terminal that supports colors. |
| The syntax follows the same conventions as \fBLS_COLORS\fP; |
| that is, a list of key/value pairs separated by \fB:\fP\&. |
| .sp |
| Keys are a single letter corresponding to a CMake cache variable type: |
| .INDENT 0.0 |
| .IP \(bu 2 |
| \fBs\fP: A \fBSTRING\fP\&. |
| .IP \(bu 2 |
| \fBp\fP: A \fBFILEPATH\fP\&. |
| .IP \(bu 2 |
| \fBc\fP: A value which has an associated list of choices. |
| .IP \(bu 2 |
| \fBy\fP: A \fBBOOL\fP which has a true\-like value (e.g. \fBON\fP, \fBYES\fP). |
| .IP \(bu 2 |
| \fBn\fP: A \fBBOOL\fP which has a false\-like value (e.g. \fBOFF\fP, \fBNO\fP). |
| .UNINDENT |
| .sp |
| Values are an integer number that specifies what color to use. |
| \fB0\fP is black (you probably don\(aqt want to use that). |
| Others are determined by your terminal\(aqs color support. |
| Most (color) terminals will support at least 8 or 16 colors. |
| Some will support up to 256 colors. The colors will likely match |
| \X'tty: link https://upload.wikimedia.org/wikipedia/commons/1/15/Xterm_256color_chart.svg'\fI\%this chart\fP\X'tty: link', |
| although the first 16 colors may match the original |
| \X'tty: link https://en.wikipedia.org/wiki/Color_Graphics_Adapter |
| (Many modern terminal emulators also allow their color palette, |
| at least for the first 16 colors, to be configured by the user.) |
| .sp |
| Note that fairly minimal checking is done for bad colors |
| (although a value higher than what curses believes your terminal supports |
| will be silently ignored) or bad syntax. |
| .sp |
| For example: |
| .INDENT 0.0 |
| .INDENT 3.5 |
| .sp |
| .nf |
| .ft C |
| CCMAKE_COLORS=\(aqs=39:p=220:c=207:n=196:y=46\(aq |
| .ft P |
| .fi |
| .UNINDENT |
| .UNINDENT |
| .SH COPYRIGHT |
| 2000-2024 Kitware, Inc. and Contributors |
| .\" Generated by docutils manpage writer. |
| . |
|
|
