Imported Upstream version 3.25.0
[platform/upstream/cmake.git] / Help / manual / cmake-env-variables.7.rst
1 .. cmake-manual-description: CMake Environment Variables Reference
2
3 cmake-env-variables(7)
4 **********************
5
6 .. only:: html
7
8    .. contents::
9
10 This page lists environment variables that have special
11 meaning to CMake.
12
13 For general information on environment variables, see the
14 :ref:`Environment Variables <CMake Language Environment Variables>`
15 section in the cmake-language manual.
16
17 Environment Variables that Change Behavior
18 ==========================================
19
20 .. toctree::
21    :maxdepth: 1
22
23    /envvar/CMAKE_PREFIX_PATH
24    /envvar/SSL_CERT_DIR
25    /envvar/SSL_CERT_FILE
26
27 Environment Variables that Control the Build
28 ============================================
29
30 .. toctree::
31    :maxdepth: 1
32
33    /envvar/ADSP_ROOT
34    /envvar/CMAKE_APPLE_SILICON_PROCESSOR
35    /envvar/CMAKE_BUILD_PARALLEL_LEVEL
36    /envvar/CMAKE_BUILD_TYPE
37    /envvar/CMAKE_COLOR_DIAGNOSTICS
38    /envvar/CMAKE_CONFIGURATION_TYPES
39    /envvar/CMAKE_CONFIG_TYPE
40    /envvar/CMAKE_EXPORT_COMPILE_COMMANDS
41    /envvar/CMAKE_GENERATOR
42    /envvar/CMAKE_GENERATOR_INSTANCE
43    /envvar/CMAKE_GENERATOR_PLATFORM
44    /envvar/CMAKE_GENERATOR_TOOLSET
45    /envvar/CMAKE_INSTALL_MODE
46    /envvar/CMAKE_LANG_COMPILER_LAUNCHER
47    /envvar/CMAKE_LANG_LINKER_LAUNCHER
48    /envvar/CMAKE_MSVCIDE_RUN_PATH
49    /envvar/CMAKE_NO_VERBOSE
50    /envvar/CMAKE_OSX_ARCHITECTURES
51    /envvar/CMAKE_TOOLCHAIN_FILE
52    /envvar/DESTDIR
53    /envvar/LDFLAGS
54    /envvar/MACOSX_DEPLOYMENT_TARGET
55    /envvar/PackageName_ROOT
56    /envvar/VERBOSE
57
58 Environment Variables for Languages
59 ===================================
60
61 .. toctree::
62    :maxdepth: 1
63
64    /envvar/ASM_DIALECT
65    /envvar/ASM_DIALECTFLAGS
66    /envvar/CC
67    /envvar/CFLAGS
68    /envvar/CSFLAGS
69    /envvar/CUDAARCHS
70    /envvar/CUDACXX
71    /envvar/CUDAFLAGS
72    /envvar/CUDAHOSTCXX
73    /envvar/CXX
74    /envvar/CXXFLAGS
75    /envvar/FC
76    /envvar/FFLAGS
77    /envvar/HIPCXX
78    /envvar/HIPFLAGS
79    /envvar/ISPC
80    /envvar/ISPCFLAGS
81    /envvar/OBJC
82    /envvar/OBJCXX
83    /envvar/RC
84    /envvar/RCFLAGS
85    /envvar/SWIFTC
86
87 Environment Variables for CTest
88 ===============================
89
90 .. toctree::
91    :maxdepth: 1
92
93    /envvar/CMAKE_CONFIG_TYPE
94    /envvar/CTEST_INTERACTIVE_DEBUG_MODE
95    /envvar/CTEST_OUTPUT_ON_FAILURE
96    /envvar/CTEST_PARALLEL_LEVEL
97    /envvar/CTEST_PROGRESS_OUTPUT
98    /envvar/CTEST_USE_LAUNCHERS_DEFAULT
99    /envvar/DASHBOARD_TEST_FROM_CTEST
100
101 Environment Variables for the CMake curses interface
102 ====================================================
103
104 .. toctree::
105    :maxdepth: 1
106
107    /envvar/CCMAKE_COLORS