1CMAKE-ENV-VARIABLES(7)               CMake              CMAKE-ENV-VARIABLES(7)
2
3
4

NAME

6       cmake-env-variables - CMake Environment Variables Reference
7
8       This  page  lists  environment  variables  that have special meaning to
9       CMake.
10
11       For general information on environment variables, see  the  Environment
12       Variables section in the cmake-language manual.
13

ENVIRONMENT VARIABLES THAT CHANGE BEHAVIOR

15   CMAKE_PREFIX_PATH
16       This  is  a CMake Environment Variable. Its initial value is taken from
17       the calling process environment.
18
19       The CMAKE_PREFIX_PATH environment variable may be set to a list of  di‐
20       rectories  specifying  installation  prefixes  to  be  searched  by the
21       find_package(),  find_program(),   find_library(),   find_file(),   and
22       find_path() commands.  Each command will add appropriate subdirectories
23       (like bin, lib, or include) as specified in its own documentation.
24
25       This variable may hold a single prefix or a list of prefixes  separated
26       by : on UNIX or ; on Windows (the same as the PATH environment variable
27       convention on those platforms).
28
29       See also the CMAKE_PREFIX_PATH CMake variable.
30

ENVIRONMENT VARIABLES THAT CONTROL THE BUILD

32   CMAKE_APPLE_SILICON_PROCESSOR
33       New in version 3.19.2.
34
35
36       This is a CMake Environment Variable. Its initial value is  taken  from
37       the calling process environment.
38
39       On  Apple Silicon hosts running macOS, set this environment variable to
40       tell CMake what architecture to  use  for  CMAKE_HOST_SYSTEM_PROCESSOR.
41       The value must be either arm64 or x86_64.
42
43       The  CMAKE_APPLE_SILICON_PROCESSOR  normal  variable, if set, overrides
44       this environment variable.
45
46   CMAKE_BUILD_PARALLEL_LEVEL
47       New in version 3.12.
48
49
50       This is a CMake Environment Variable. Its initial value is  taken  from
51       the calling process environment.
52
53       Specifies the maximum number of concurrent processes to use when build‐
54       ing using the cmake --build command line Build Tool Mode.
55
56       If this variable is defined empty the native build tool's default  num‐
57       ber is used.
58
59   CMAKE_BUILD_TYPE
60       New in version 3.22.
61
62
63       This  is  a CMake Environment Variable. Its initial value is taken from
64       the calling process environment.
65
66       The CMAKE_BUILD_TYPE environment variable specifies a default value for
67       the  CMAKE_BUILD_TYPE  variable when there is no explicit configuration
68       given on the first run while creating a new build tree.
69
70   CMAKE_CONFIGURATION_TYPES
71       New in version 3.22.
72
73
74       This is a CMake Environment Variable. Its initial value is  taken  from
75       the calling process environment.
76
77       The  CMAKE_CONFIGURATION_TYPES environment variable specifies a default
78       value for the CMAKE_CONFIGURATION_TYPES variable when there is  no  ex‐
79       plicit  configuration given on the first run while creating a new build
80       tree.
81
82   CMAKE_CONFIG_TYPE
83       This is a CMake Environment Variable. Its initial value is  taken  from
84       the calling process environment.
85
86       The  default  build  configuration  for Build Tool Mode and ctest build
87       handler when there is no explicit configuration given.
88
89   CMAKE_EXPORT_COMPILE_COMMANDS
90       New in version 3.17.
91
92
93       This is a CMake Environment Variable. Its initial value is  taken  from
94       the calling process environment.
95
96       The  default  value  for CMAKE_EXPORT_COMPILE_COMMANDS when there is no
97       explicit configuration given on the first  run  while  creating  a  new
98       build tree.  On later runs in an existing build tree the value persists
99       in the cache as CMAKE_EXPORT_COMPILE_COMMANDS.
100
101   CMAKE_GENERATOR
102       New in version 3.15.
103
104
105       This is a CMake Environment Variable. Its initial value is  taken  from
106       the calling process environment.
107
108       Specifies  the CMake default generator to use when no generator is sup‐
109       plied with -G. If the provided value doesn't name a generator known  by
110       CMake,  the internal default is used.  Either way the resulting genera‐
111       tor selection is stored in the CMAKE_GENERATOR variable.
112
113       Some generators may be additionally configured  using  the  environment
114       variables:
115
116CMAKE_GENERATOR_PLATFORM
117
118CMAKE_GENERATOR_TOOLSET
119
120CMAKE_GENERATOR_INSTANCE
121
122   CMAKE_GENERATOR_INSTANCE
123       New in version 3.15.
124
125
126       This  is  a CMake Environment Variable. Its initial value is taken from
127       the calling process environment.
128
129       Default  value  for  CMAKE_GENERATOR_INSTANCE  if  no  Cache  entry  is
130       present. This value is only applied if CMAKE_GENERATOR is set.
131
132   CMAKE_GENERATOR_PLATFORM
133       New in version 3.15.
134
135
136       This  is  a CMake Environment Variable. Its initial value is taken from
137       the calling process environment.
138
139       Default value for CMAKE_GENERATOR_PLATFORM if no Cache entry is present
140       and  no  value  is specified by cmake(1) -A option.  This value is only
141       applied if CMAKE_GENERATOR is set.
142
143   CMAKE_GENERATOR_TOOLSET
144       New in version 3.15.
145
146
147       This is a CMake Environment Variable. Its initial value is  taken  from
148       the calling process environment.
149
150       Default  value for CMAKE_GENERATOR_TOOLSET if no Cache entry is present
151       and no value is specified by cmake(1) -T option.  This  value  is  only
152       applied if CMAKE_GENERATOR is set.
153
154   CMAKE_INSTALL_MODE
155       New in version 3.22.
156
157
158       This  is  a CMake Environment Variable. Its initial value is taken from
159       the calling process environment.
160
161       The CMAKE_INSTALL_MODE environment variable  allows  users  to  operate
162       CMake in an alternate mode of file(INSTALL) and install().
163
164       The  default behavior for an installation is to copy a source file from
165       a source directory into a destination directory. This environment vari‐
166       able  however  allows the user to override this behavior, causing CMake
167       to create symbolic links instead.
168
169       NOTE:
170          A symbolic link consists of a reference file path rather  than  con‐
171          tents  of its own, hence there are two ways to express the relation,
172          either by a relative or an absolute path.
173
174       The following values are allowed for CMAKE_INSTALL_MODE:
175
176       • empty, unset or COPY: default behavior, duplicate  the  file  at  its
177         destination
178
179ABS_SYMLINK:  create  an absolute symbolic link to the source file at
180         the destination or fail
181
182ABS_SYMLINK_OR_COPY: like ABS_SYMLINK but silently copy on error
183
184REL_SYMLINK: create an relative symbolic link to the source  file  at
185         the destination or fail
186
187REL_SYMLINK_OR_COPY: like REL_SYMLINK but silently copy on error
188
189SYMLINK:  try  as if through REL_SYMLINK and fall back to ABS_SYMLINK
190         if the referenced file cannot be expressed  using  a  relative  path.
191         Fail on error.
192
193SYMLINK_OR_COPY: like SYMLINK but silently copy on error
194
195       Installing  symbolic  links rather than copying files can help conserve
196       storage space because files do not have to be duplicated on disk.  How‐
197       ever,  modifications applied to the source immediately affects the sym‐
198       bolic link and vice versa. Use with caution.
199
200       NOTE:
201          CMAKE_INSTALL_MODE only affects files, not directories.
202
203       NOTE:
204          Symbolic links are not available on all platforms.
205
206   CMAKE_<LANG>_COMPILER_LAUNCHER
207       New in version 3.17.
208
209
210       This is a CMake Environment Variable. Its initial value is  taken  from
211       the calling process environment.
212
213       Default  compiler launcher to use for the specified language. Will only
214       be used by CMake to initialize the variable on the first configuration.
215       Afterwards,  it  is available through the cache setting of the variable
216       of the same name. For any configuration run (including the first),  the
217       environment   variable   will   be  ignored  if  the  CMAKE_<LANG>_COM‐
218       PILER_LAUNCHER variable is defined.
219
220   CMAKE_<LANG>_LINKER_LAUNCHER
221       New in version 3.21.
222
223
224       This is a CMake Environment Variable. Its initial value is  taken  from
225       the calling process environment.
226
227       Default  launcher  to  use  when linking a target of the specified lan‐
228       guage. Will only be used by CMake to initialize  the  variable  on  the
229       first  configuration.   Afterwards,  it  is available through the cache
230       setting of the variable of the same name.  For  any  configuration  run
231       (including  the first), the environment variable will be ignored if the
232       CMAKE_<LANG>_LINKER_LAUNCHER variable is defined.
233
234   CMAKE_MSVCIDE_RUN_PATH
235       This is a CMake Environment Variable. Its initial value is  taken  from
236       the calling process environment.
237
238       Extra  PATH  locations  for  custom commands when using Visual Studio 9
239       2008 (or above) generators.
240
241       The CMAKE_MSVCIDE_RUN_PATH environment variable sets the default  value
242       for the CMAKE_MSVCIDE_RUN_PATH variable if not already explicitly set.
243
244   CMAKE_NO_VERBOSE
245       New in version 3.14.
246
247
248       Disables verbose output from CMake when VERBOSE environment variable is
249       set.
250
251       Only your build tool of choice will still print verbose output when you
252       start to actually build your project.
253
254   CMAKE_OSX_ARCHITECTURES
255       This  is  a CMake Environment Variable. Its initial value is taken from
256       the calling process environment.
257
258       Target specific architectures for macOS.
259
260       The CMAKE_OSX_ARCHITECTURES environment variable sets the default value
261       for  the  CMAKE_OSX_ARCHITECTURES  variable.  See OSX_ARCHITECTURES for
262       more information.
263
264   CMAKE_TOOLCHAIN_FILE
265       New in version 3.21.
266
267
268       This is a CMake Environment Variable. Its initial value is  taken  from
269       the calling process environment.
270
271       The CMAKE_TOOLCHAIN_FILE environment variable specifies a default value
272       for the CMAKE_TOOLCHAIN_FILE variable when there is no explicit config‐
273       uration  given  on  the  first run while creating a new build tree.  On
274       later runs in an existing build tree the value persists in the cache as
275       CMAKE_TOOLCHAIN_FILE.
276
277   DESTDIR
278       This  is  a CMake Environment Variable. Its initial value is taken from
279       the calling process environment.
280
281       On UNIX one can use the DESTDIR mechanism  in  order  to  relocate  the
282       whole  installation.   DESTDIR means DESTination DIRectory.  It is com‐
283       monly used by makefile users in order to install  software  at  non-de‐
284       fault location.  It is usually invoked like this:
285
286          make DESTDIR=/home/john install
287
288       which  will  install the concerned software using the installation pre‐
289       fix, e.g.  /usr/local prepended with the DESTDIR  value  which  finally
290       gives /home/john/usr/local.
291
292       WARNING: DESTDIR may not be used on Windows because installation prefix
293       usually contains a drive letter like in C:/Program Files  which  cannot
294       be prepended with some other prefix.
295
296   LDFLAGS
297       This  is  a CMake Environment Variable. Its initial value is taken from
298       the calling process environment.
299
300       Will only be used by CMake on the first configuration to determine  the
301       default  linker  flags,  after which the value for LDFLAGS is stored in
302       the           cache           as           CMAKE_EXE_LINKER_FLAGS_INIT,
303       CMAKE_SHARED_LINKER_FLAGS_INIT, and CMAKE_MODULE_LINKER_FLAGS_INIT. For
304       any configuration run (including the first), the  environment  variable
305       will be ignored if the equivalent  CMAKE_<TYPE>_LINKER_FLAGS_INIT vari‐
306       able is defined.
307
308   MACOSX_DEPLOYMENT_TARGET
309       This is a CMake Environment Variable. Its initial value is  taken  from
310       the calling process environment.
311
312       Specify  the  minimum version of macOS on which the target binaries are
313       to be deployed.
314
315       The MACOSX_DEPLOYMENT_TARGET  environment  variable  sets  the  default
316       value for the CMAKE_OSX_DEPLOYMENT_TARGET variable.
317
318   <PackageName>_ROOT
319       New in version 3.12.
320
321
322       This  is  a CMake Environment Variable. Its initial value is taken from
323       the calling process environment.
324
325       Calls to find_package(<PackageName>) will search in prefixes  specified
326       by  the <PackageName>_ROOT environment variable, where <PackageName> is
327       the name given to the find_package() call and _ROOT  is  literal.   For
328       example,  find_package(Foo)  will  search  prefixes  specified  in  the
329       Foo_ROOT environment variable (if set).  See policy CMP0074.
330
331       This variable may hold a single prefix or a list of prefixes  separated
332       by : on UNIX or ; on Windows (the same as the PATH environment variable
333       convention on those platforms).
334
335       See also the <PackageName>_ROOT CMake variable.
336
337   VERBOSE
338       New in version 3.14.
339
340
341       Activates verbose output from CMake and your build tools of choice when
342       you start to actually build your project.
343
344       Note that any given value is ignored. It's just checked for existence.
345
346       See also Build Tool Mode and CMAKE_NO_VERBOSE environment variable
347

ENVIRONMENT VARIABLES FOR LANGUAGES

349   ASM<DIALECT>
350       This  is  a CMake Environment Variable. Its initial value is taken from
351       the calling process environment.
352
353       Preferred executable for compiling a specific dialect of assembly  lan‐
354       guage  files.  ASM<DIALECT>  can  be ASM, ASM_NASM (Netwide Assembler),
355       ASM_MASM (Microsoft Assembler) or ASM-ATT (Assembler AT&T).  Will  only
356       be  used  by CMake on the first configuration to determine ASM<DIALECT>
357       compiler, after which the value for ASM<DIALECT> is stored in the cache
358       as  CMAKE_ASM<DIALECT>_COMPILER. For subsequent configuration runs, the
359       environment  variable  will  be  ignored  in  favor  of   CMAKE_ASM<DI‐
360       ALECT>_COMPILER.
361
362       NOTE:
363          Options that are required to make the compiler work correctly can be
364          included; they can not be changed.
365
366          $ export ASM="custom-compiler --arg1 --arg2"
367
368   ASM<DIALECT>FLAGS
369       This is a CMake Environment Variable. Its initial value is  taken  from
370       the calling process environment.
371
372       Default  compilation flags to be used when compiling a specific dialect
373       of an assembly language. ASM<DIALECT>FLAGS can be  ASMFLAGS,  ASM_NASM‐
374       FLAGS, ASM_MASMFLAGS or ASM-ATTFLAGS. Will only be used by CMake on the
375       first configuration  to  determine  ASM_<DIALECT>  default  compilation
376       flags,  after  which  the  value for ASM<DIALECT>FLAGS is stored in the
377       cache as CMAKE_ASM<DIALECT>_FLAGS <CMAKE_<LANG>_FLAGS>.  For  any  con‐
378       figuration  run (including the first), the environment variable will be
379       ignored, if the CMAKE_ASM<DIALECT>_FLAGS <CMAKE_<LANG>_FLAGS>  variable
380       is defined.
381
382       See also CMAKE_ASM<DIALECT>_FLAGS_INIT.
383
384   CC
385       This  is  a CMake Environment Variable. Its initial value is taken from
386       the calling process environment.
387
388       Preferred executable for compiling C language files. Will only be  used
389       by  CMake  on  the  first  configuration to determine C compiler, after
390       which the value for CC is stored in the cache as CMAKE_C_COMPILER.  For
391       any  configuration  run (including the first), the environment variable
392       will be ignored if the CMAKE_C_COMPILER variable is defined.
393
394       NOTE:
395          Options that are required to make the compiler work correctly can be
396          included; they can not be changed.
397
398          $ export CC="custom-compiler --arg1 --arg2"
399
400   CFLAGS
401       This  is  a CMake Environment Variable. Its initial value is taken from
402       the calling process environment.
403
404       Default compilation flags to be used when compiling C files. Will  only
405       be  used  by  CMake  on the first configuration to determine CC default
406       compilation flags, after which the value for CFLAGS is  stored  in  the
407       cache  as  CMAKE_C_FLAGS.  For  any  configuration  run  (including the
408       first), the environment variable will be ignored if  the  CMAKE_C_FLAGS
409       variable is defined.
410
411       See also CMAKE_C_FLAGS_INIT.
412
413   CSFLAGS
414       New in version 3.9.2.
415
416
417       This  is  a CMake Environment Variable. Its initial value is taken from
418       the calling process environment.
419
420       Default compilation flags to be used when compiling CSharp files.  Will
421       only  be  used  by CMake on the first configuration to determine CSharp
422       default compilation flags, after which the value for CSFLAGS is  stored
423       in  the cache as CMAKE_CSharp_FLAGS. For any configuration run (includ‐
424       ing the first),  the  environment  variable  will  be  ignored  if  the
425       CMAKE_CSharp_FLAGS variable is defined.
426
427       See also CMAKE_CSharp_FLAGS_INIT.
428
429   CUDAARCHS
430       New in version 3.20.
431
432
433       This  is  a CMake Environment Variable. Its initial value is taken from
434       the calling process environment.
435
436       Value used to initialize CMAKE_CUDA_ARCHITECTURES on the first configu‐
437       ration  if it's not already defined. Subsequent runs will use the value
438       stored in the cache.
439
440       This is a semicolon-separated list of  architectures  as  described  in
441       CUDA_ARCHITECTURES.
442
443   CUDACXX
444       New in version 3.8.
445
446
447       This  is  a CMake Environment Variable. Its initial value is taken from
448       the calling process environment.
449
450       Preferred executable for compiling CUDA language files.  Will  only  be
451       used  by  CMake  on the first configuration to determine CUDA compiler,
452       after  which  the  value  for  CUDA  is  stored   in   the   cache   as
453       CMAKE_CUDA_COMPILER.  For  any configuration run (including the first),
454       the environment variable will be  ignored  if  the  CMAKE_CUDA_COMPILER
455       variable is defined.
456
457       NOTE:
458          Options that are required to make the compiler work correctly can be
459          included; they can not be changed.
460
461          $ export CUDACXX="custom-compiler --arg1 --arg2"
462
463   CUDAFLAGS
464       New in version 3.8.
465
466
467       This is a CMake Environment Variable. Its initial value is  taken  from
468       the calling process environment.
469
470       Default  compilation  flags  to be used when compiling CUDA files. Will
471       only be used by CMake on the first configuration to determine CUDA  de‐
472       fault  compilation flags, after which the value for CUDAFLAGS is stored
473       in the cache as CMAKE_CUDA_FLAGS. For any configuration run  (including
474       the   first),   the   environment  variable  will  be  ignored  if  the
475       CMAKE_CUDA_FLAGS variable is defined.
476
477       See also CMAKE_CUDA_FLAGS_INIT.
478
479   CUDAHOSTCXX
480       New in version 3.8.
481
482
483       This is a CMake Environment Variable. Its initial value is  taken  from
484       the calling process environment.
485
486       Preferred  executable  for compiling host code when compiling CUDA lan‐
487       guage files. Will only be used by CMake on the first  configuration  to
488       determine  CUDA host compiler, after which the value for CUDAHOSTCXX is
489       stored in the cache as CMAKE_CUDA_HOST_COMPILER. For any  configuration
490       run  (including the first), the environment variable will be ignored if
491       the CMAKE_CUDA_HOST_COMPILER variable is defined.
492
493       This environment variable is primarily meant for use with projects that
494       enable CUDA as a first-class language.
495
496       NOTE:
497          Ignored when using Visual Studio Generators.
498
499       New in version 3.13: The FindCUDA module will use this variable to ini‐
500       tialize its CUDA_HOST_COMPILER setting.
501
502
503   CXX
504       This is a CMake Environment Variable. Its initial value is  taken  from
505       the calling process environment.
506
507       Preferred  executable  for  compiling  CXX language files. Will only be
508       used by CMake on the first configuration to determine CXX compiler, af‐
509       ter  which  the  value for CXX is stored in the cache as CMAKE_CXX_COM‐
510       PILER. For any configuration run (including the first), the environment
511       variable will be ignored if the CMAKE_CXX_COMPILER variable is defined.
512
513       NOTE:
514          Options that are required to make the compiler work correctly can be
515          included; they can not be changed.
516
517          $ export CXX="custom-compiler --arg1 --arg2"
518
519   CXXFLAGS
520       This is a CMake Environment Variable. Its initial value is  taken  from
521       the calling process environment.
522
523       Default  compilation  flags  to be used when compiling CXX (C++) files.
524       Will only be used by CMake on the first configuration to determine  CXX
525       default compilation flags, after which the value for CXXFLAGS is stored
526       in the cache as CMAKE_CXX_FLAGS. For any configuration run (  including
527       the   first),   the   environment  variable  will  be  ignored  if  the
528       CMAKE_CXX_FLAGS variable is defined.
529
530       See also CMAKE_CXX_FLAGS_INIT.
531
532   FC
533       This is a CMake Environment Variable. Its initial value is  taken  from
534       the calling process environment.
535
536       Preferred executable for compiling Fortran language files. Will only be
537       used by CMake on the first configuration to determine Fortran compiler,
538       after  which the value for Fortran is stored in the cache as CMAKE_For‐
539       tran_COMPILER. For any configuration run (including the first), the en‐
540       vironment  variable will be ignored if the CMAKE_Fortran_COMPILER vari‐
541       able is defined.
542
543       NOTE:
544          Options that are required to make the compiler work correctly can be
545          included; they can not be changed.
546
547          $ export FC="custom-compiler --arg1 --arg2"
548
549   FFLAGS
550       This  is  a CMake Environment Variable. Its initial value is taken from
551       the calling process environment.
552
553       Default compilation flags to be used when compiling Fortran files. Will
554       only  be  used by CMake on the first configuration to determine Fortran
555       default compilation flags, after which the value for FFLAGS  is  stored
556       in the cache as CMAKE_Fortran_FLAGS. For any configuration run (includ‐
557       ing the first),  the  environment  variable  will  be  ignored  if  the
558       CMAKE_Fortran_FLAGS variable is defined.
559
560       See also CMAKE_Fortran_FLAGS_INIT.
561
562   HIPCXX
563       New in version 3.21.
564
565
566       This  is  a CMake Environment Variable. Its initial value is taken from
567       the calling process environment.
568
569       Preferred executable for compiling HIP language  files.  Will  only  be
570       used by CMake on the first configuration to determine HIP compiler, af‐
571       ter which the value for HIP is stored in the  cache  as  CMAKE_HIP_COM‐
572       PILER. For any configuration run (including the first), the environment
573       variable will be ignored if the CMAKE_HIP_COMPILER variable is defined.
574
575   HIPFLAGS
576       New in version 3.21.
577
578
579       This is a CMake Environment Variable. Its initial value is  taken  from
580       the calling process environment.
581
582       Default  compilation  flags  to  be used when compiling HIP files. Will
583       only be used by CMake on the first configuration to determine  HIP  de‐
584       fault  compilation  flags, after which the value for HIPFLAGS is stored
585       in the cache as CMAKE_HIP_FLAGS. For any configuration  run  (including
586       the   first),   the   environment  variable  will  be  ignored  if  the
587       CMAKE_HIP_FLAGS variable is defined.
588
589       See also CMAKE_HIP_FLAGS_INIT.
590
591   ISPC
592       New in version 3.19.
593
594
595       This is a CMake Environment Variable. Its initial value is  taken  from
596       the calling process environment.
597
598       Preferred  executable  for  compiling ISPC language files. Will only be
599       used by CMake on the first configuration to  determine  ISPC  compiler,
600       after   which   the   value   for  ISPC  is  stored  in  the  cache  as
601       CMAKE_ISPC_COMPILER. For any configuration run (including  the  first),
602       the  environment  variable  will  be ignored if the CMAKE_ISPC_COMPILER
603       variable is defined.
604
605   ISPCFLAGS
606       New in version 3.19.
607
608
609       This is a CMake Environment Variable. Its initial value is  taken  from
610       the calling process environment.
611
612       Default  compilation  flags  to be used when compiling ISPC files. Will
613       only be used by CMake on the first configuration to determine ISPC  de‐
614       fault  compilation flags, after which the value for ISPCFLAGS is stored
615       in the cache as CMAKE_ISPC_FLAGS. For any configuration run  (including
616       the   first),   the   environment  variable  will  be  ignored  if  the
617       CMAKE_ISPC_FLAGS variable is defined.
618
619       See also CMAKE_ISPC_FLAGS_INIT.
620
621   OBJC
622       New in version 3.16.7.
623
624
625       This is a CMake Environment Variable. Its initial value is  taken  from
626       the calling process environment.
627
628       Preferred  executable  for  compiling OBJC language files. Will only be
629       used by CMake on the first configuration to  determine  OBJC  compiler,
630       after   which   the   value   for  OBJC  is  stored  in  the  cache  as
631       CMAKE_OBJC_COMPILER. For any configuration run (including  the  first),
632       the  environment  variable  will  be ignored if the CMAKE_OBJC_COMPILER
633       variable is defined.
634
635       If OBJC is not defined, the CC environment variable will be checked in‐
636       stead.
637
638   OBJCXX
639       New in version 3.16.7.
640
641
642       This  is  a CMake Environment Variable. Its initial value is taken from
643       the calling process environment.
644
645       Preferred executable for compiling OBJCXX language files. Will only  be
646       used  by CMake on the first configuration to determine OBJCXX compiler,
647       after which the value for OBJCXX is stored in the  cache  as  CMAKE_OB‐
648       JCXX_COMPILER. For any configuration run (including the first), the en‐
649       vironment variable will be ignored if the  CMAKE_OBJCXX_COMPILER  vari‐
650       able is defined.
651
652       If  OBJCXX is not defined, the CXX environment variable will be checked
653       instead.
654
655   RC
656       This is a CMake Environment Variable. Its initial value is  taken  from
657       the calling process environment.
658
659       Preferred executable for compiling resource files. Will only be used by
660       CMake on the first configuration to determine resource compiler,  after
661       which the value for RC is stored in the cache as CMAKE_RC_COMPILER. For
662       any configuration run (including the first), the  environment  variable
663       will be ignored if the CMAKE_RC_COMPILER variable is defined.
664
665       NOTE:
666          Options that are required to make the compiler work correctly can be
667          included; they can not be changed.
668
669          $ export RC="custom-compiler --arg1 --arg2"
670
671   RCFLAGS
672       This is a CMake Environment Variable. Its initial value is  taken  from
673       the calling process environment.
674
675       Default  compilation  flags  to  be used when compiling resource files.
676       Will only be used by CMake on the first configuration to determine  re‐
677       source  default compilation flags, after which the value for RCFLAGS is
678       stored in the cache as CMAKE_RC_FLAGS. For any configuration  run  (in‐
679       cluding  the  first),  the  environment variable will be ignored if the
680       CMAKE_RC_FLAGS variable is defined.
681
682       See also CMAKE_RC_FLAGS_INIT.
683
684   SWIFTC
685       New in version 3.15.
686
687
688       This is a CMake Environment Variable. Its initial value is  taken  from
689       the calling process environment.
690
691       Preferred  executable  for compiling Swift language files. Will only be
692       used by CMake on the first configuration to determine  Swift  compiler,
693       after   which   the  value  for  SWIFTC  is  stored  in  the  cache  as
694       CMAKE_Swift_COMPILER. For any configuration run (including the  first),
695       the  environment  variable  will be ignored if the CMAKE_Swift_COMPILER
696       variable is defined.
697
698       NOTE:
699          Options that are required to make the compiler work correctly can be
700          included; they can not be changed.
701
702          $ export SWIFTC="custom-compiler --arg1 --arg2"
703

ENVIRONMENT VARIABLES FOR CTEST

705   CTEST_INTERACTIVE_DEBUG_MODE
706       This  is  a CMake Environment Variable. Its initial value is taken from
707       the calling process environment.
708
709       Environment variable that will exist and be set to 1 when a  test  exe‐
710       cuted by ctest(1) is run in interactive mode.
711
712   CTEST_OUTPUT_ON_FAILURE
713       This  is  a CMake Environment Variable. Its initial value is taken from
714       the calling process environment.
715
716       Boolean environment variable that controls  if  the  output  should  be
717       logged for failed tests. Set the value to 1, True, or ON to enable out‐
718       put on failure.  See ctest(1) for more information on controlling  out‐
719       put of failed tests.
720
721   CTEST_PARALLEL_LEVEL
722       This  is  a CMake Environment Variable. Its initial value is taken from
723       the calling process environment.
724
725       Specify the number of tests for CTest to run in parallel. See  ctest(1)
726       for more information on parallel test execution.
727
728   CTEST_PROGRESS_OUTPUT
729       New in version 3.13.
730
731
732       This  is  a CMake Environment Variable. Its initial value is taken from
733       the calling process environment.
734
735       Boolean environment variable that affects how ctest command output  re‐
736       ports  overall progress.  When set to 1, TRUE, ON or anything else that
737       evaluates to boolean true, progress is reported by repeatedly  updating
738       the same line.  This greatly reduces the overall verbosity, but is only
739       supported when output is sent directly to a terminal.  If the  environ‐
740       ment variable is not set or has a value that evaluates to false, output
741       is reported normally with each test having its own start and end  lines
742       logged to the output.
743
744       The  --progress  option to ctest overrides this environment variable if
745       both are given.
746
747   CTEST_USE_LAUNCHERS_DEFAULT
748       This is a CMake Environment Variable. Its initial value is  taken  from
749       the calling process environment.
750
751       Initializes the CTEST_USE_LAUNCHERS variable if not already defined.
752
753   DASHBOARD_TEST_FROM_CTEST
754       This  is  a CMake Environment Variable. Its initial value is taken from
755       the calling process environment.
756
757       Environment variable that will exist when a test executed  by  ctest(1)
758       is  run in non-interactive mode.  The value will be equal to CMAKE_VER‐
759       SION.
760

ENVIRONMENT VARIABLES FOR THE CMAKE CURSES INTERFACE

762   CCMAKE_COLORS
763       New in version 3.18.
764
765
766       Determines what colors are used by the CMake curses interface, when run
767       on  a  terminal that supports colors.  The syntax follows the same con‐
768       ventions as LS_COLORS; that is, a list of key/value pairs separated  by
769       :.
770
771       Keys are a single letter corresponding to a CMake cache variable type:
772
773s: A STRING.
774
775p: A FILEPATH.
776
777c: A value which has an associated list of choices.
778
779y: A BOOL which has a true-like value (e.g. ON, YES).
780
781n: A BOOL which has a false-like value (e.g. OFF, NO).
782
783       Values  are  an  integer number that specifies what color to use.  0 is
784       black (you probably don't want to use that).  Others are determined  by
785       your  terminal's color support.  Most (color) terminals will support at
786       least 8 or 16 colors.  Some will support up to 256 colors.  The  colors
787       will  likely  match  this chart, although the first 16 colors may match
788       the original CGA color palette.  (Many modern terminal  emulators  also
789       allow their color palette, at least for the first 16 colors, to be con‐
790       figured by the user.)
791
792       Note that fairly minimal checking is done for bad  colors  (although  a
793       value  higher  than what curses believes your terminal supports will be
794       silently ignored) or bad syntax.
795
796       For example:
797
798          CCMAKE_COLORS='s=39:p=220:c=207:n=196:y=46'
799
801       2000-2021 Kitware, Inc. and Contributors
802
803
804
805
8063.22.0                           Dec 02, 2021           CMAKE-ENV-VARIABLES(7)
Impressum