737b22cdd4bba0886e509914020934803f09c6ab
[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
25 Environment Variables that Control the Build
26 ============================================
27
28 .. toctree::
29    :maxdepth: 1
30
31    /envvar/ADSP_ROOT
32    /envvar/CMAKE_APPLE_SILICON_PROCESSOR
33    /envvar/CMAKE_BUILD_PARALLEL_LEVEL
34    /envvar/CMAKE_BUILD_TYPE
35    /envvar/CMAKE_COLOR_DIAGNOSTICS
36    /envvar/CMAKE_CONFIGURATION_TYPES
37    /envvar/CMAKE_CONFIG_TYPE
38    /envvar/CMAKE_EXPORT_COMPILE_COMMANDS
39    /envvar/CMAKE_GENERATOR
40    /envvar/CMAKE_GENERATOR_INSTANCE
41    /envvar/CMAKE_GENERATOR_PLATFORM
42    /envvar/CMAKE_GENERATOR_TOOLSET
43    /envvar/CMAKE_INSTALL_MODE
44    /envvar/CMAKE_LANG_COMPILER_LAUNCHER
45    /envvar/CMAKE_LANG_LINKER_LAUNCHER
46    /envvar/CMAKE_MSVCIDE_RUN_PATH
47    /envvar/CMAKE_NO_VERBOSE
48    /envvar/CMAKE_OSX_ARCHITECTURES
49    /envvar/CMAKE_TOOLCHAIN_FILE
50    /envvar/DESTDIR
51    /envvar/LDFLAGS
52    /envvar/MACOSX_DEPLOYMENT_TARGET
53    /envvar/PackageName_ROOT
54    /envvar/VERBOSE
55
56 Environment Variables for Languages
57 ===================================
58
59 .. toctree::
60    :maxdepth: 1
61
62    /envvar/ASM_DIALECT
63    /envvar/ASM_DIALECTFLAGS
64    /envvar/CC
65    /envvar/CFLAGS
66    /envvar/CSFLAGS
67    /envvar/CUDAARCHS
68    /envvar/CUDACXX
69    /envvar/CUDAFLAGS
70    /envvar/CUDAHOSTCXX
71    /envvar/CXX
72    /envvar/CXXFLAGS
73    /envvar/FC
74    /envvar/FFLAGS
75    /envvar/HIPCXX
76    /envvar/HIPFLAGS
77    /envvar/ISPC
78    /envvar/ISPCFLAGS
79    /envvar/OBJC
80    /envvar/OBJCXX
81    /envvar/RC
82    /envvar/RCFLAGS
83    /envvar/SWIFTC
84
85 Environment Variables for CTest
86 ===============================
87
88 .. toctree::
89    :maxdepth: 1
90
91    /envvar/CMAKE_CONFIG_TYPE
92    /envvar/CTEST_INTERACTIVE_DEBUG_MODE
93    /envvar/CTEST_OUTPUT_ON_FAILURE
94    /envvar/CTEST_PARALLEL_LEVEL
95    /envvar/CTEST_PROGRESS_OUTPUT
96    /envvar/CTEST_USE_LAUNCHERS_DEFAULT
97    /envvar/DASHBOARD_TEST_FROM_CTEST
98
99 Environment Variables for the CMake curses interface
100 ====================================================
101
102 .. toctree::
103    :maxdepth: 1
104
105    /envvar/CCMAKE_COLORS