cmake-variables.7.rst 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696
  1. .. cmake-manual-description: CMake Variables Reference
  2. cmake-variables(7)
  3. ******************
  4. .. only:: html
  5. .. contents::
  6. This page documents variables that are provided by CMake
  7. or have meaning to CMake when set by project code.
  8. For general information on variables, see the
  9. :ref:`Variables <CMake Language Variables>`
  10. section in the cmake-language manual.
  11. .. include:: ID_RESERVE.txt
  12. Variables that Provide Information
  13. ==================================
  14. .. toctree::
  15. :maxdepth: 1
  16. /variable/CMAKE_AR
  17. /variable/CMAKE_ARGC
  18. /variable/CMAKE_ARGV0
  19. /variable/CMAKE_BINARY_DIR
  20. /variable/CMAKE_BUILD_TOOL
  21. /variable/CMAKE_CACHE_MAJOR_VERSION
  22. /variable/CMAKE_CACHE_MINOR_VERSION
  23. /variable/CMAKE_CACHE_PATCH_VERSION
  24. /variable/CMAKE_CACHEFILE_DIR
  25. /variable/CMAKE_CFG_INTDIR
  26. /variable/CMAKE_COMMAND
  27. /variable/CMAKE_CPACK_COMMAND
  28. /variable/CMAKE_CROSSCOMPILING
  29. /variable/CMAKE_CROSSCOMPILING_EMULATOR
  30. /variable/CMAKE_CTEST_COMMAND
  31. /variable/CMAKE_CURRENT_BINARY_DIR
  32. /variable/CMAKE_CURRENT_FUNCTION
  33. /variable/CMAKE_CURRENT_FUNCTION_LIST_DIR
  34. /variable/CMAKE_CURRENT_FUNCTION_LIST_FILE
  35. /variable/CMAKE_CURRENT_FUNCTION_LIST_LINE
  36. /variable/CMAKE_CURRENT_LIST_DIR
  37. /variable/CMAKE_CURRENT_LIST_FILE
  38. /variable/CMAKE_CURRENT_LIST_LINE
  39. /variable/CMAKE_CURRENT_SOURCE_DIR
  40. /variable/CMAKE_DEBUG_TARGET_PROPERTIES
  41. /variable/CMAKE_DIRECTORY_LABELS
  42. /variable/CMAKE_DL_LIBS
  43. /variable/CMAKE_DOTNET_TARGET_FRAMEWORK
  44. /variable/CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION
  45. /variable/CMAKE_EDIT_COMMAND
  46. /variable/CMAKE_EXECUTABLE_SUFFIX
  47. /variable/CMAKE_EXTRA_GENERATOR
  48. /variable/CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES
  49. /variable/CMAKE_FIND_DEBUG_MODE
  50. /variable/CMAKE_FIND_PACKAGE_NAME
  51. /variable/CMAKE_FIND_PACKAGE_SORT_DIRECTION
  52. /variable/CMAKE_FIND_PACKAGE_SORT_ORDER
  53. /variable/CMAKE_GENERATOR
  54. /variable/CMAKE_GENERATOR_INSTANCE
  55. /variable/CMAKE_GENERATOR_PLATFORM
  56. /variable/CMAKE_GENERATOR_TOOLSET
  57. /variable/CMAKE_IMPORT_LIBRARY_PREFIX
  58. /variable/CMAKE_IMPORT_LIBRARY_SUFFIX
  59. /variable/CMAKE_JOB_POOL_COMPILE
  60. /variable/CMAKE_JOB_POOL_LINK
  61. /variable/CMAKE_JOB_POOL_PRECOMPILE_HEADER
  62. /variable/CMAKE_JOB_POOLS
  63. /variable/CMAKE_LANG_COMPILER_AR
  64. /variable/CMAKE_LANG_COMPILER_RANLIB
  65. /variable/CMAKE_LANG_LINK_LIBRARY_SUFFIX
  66. /variable/CMAKE_LINK_LIBRARY_SUFFIX
  67. /variable/CMAKE_LINK_SEARCH_END_STATIC
  68. /variable/CMAKE_LINK_SEARCH_START_STATIC
  69. /variable/CMAKE_MAJOR_VERSION
  70. /variable/CMAKE_MAKE_PROGRAM
  71. /variable/CMAKE_MATCH_COUNT
  72. /variable/CMAKE_MATCH_n
  73. /variable/CMAKE_MINIMUM_REQUIRED_VERSION
  74. /variable/CMAKE_MINOR_VERSION
  75. /variable/CMAKE_NETRC
  76. /variable/CMAKE_NETRC_FILE
  77. /variable/CMAKE_PARENT_LIST_FILE
  78. /variable/CMAKE_PATCH_VERSION
  79. /variable/CMAKE_PROJECT_DESCRIPTION
  80. /variable/CMAKE_PROJECT_HOMEPAGE_URL
  81. /variable/CMAKE_PROJECT_NAME
  82. /variable/CMAKE_PROJECT_VERSION
  83. /variable/CMAKE_PROJECT_VERSION_MAJOR
  84. /variable/CMAKE_PROJECT_VERSION_MINOR
  85. /variable/CMAKE_PROJECT_VERSION_PATCH
  86. /variable/CMAKE_PROJECT_VERSION_TWEAK
  87. /variable/CMAKE_RANLIB
  88. /variable/CMAKE_ROOT
  89. /variable/CMAKE_RULE_MESSAGES
  90. /variable/CMAKE_SCRIPT_MODE_FILE
  91. /variable/CMAKE_SHARED_LIBRARY_PREFIX
  92. /variable/CMAKE_SHARED_LIBRARY_SUFFIX
  93. /variable/CMAKE_SHARED_MODULE_PREFIX
  94. /variable/CMAKE_SHARED_MODULE_SUFFIX
  95. /variable/CMAKE_SIZEOF_VOID_P
  96. /variable/CMAKE_SKIP_INSTALL_RULES
  97. /variable/CMAKE_SKIP_RPATH
  98. /variable/CMAKE_SOURCE_DIR
  99. /variable/CMAKE_STATIC_LIBRARY_PREFIX
  100. /variable/CMAKE_STATIC_LIBRARY_SUFFIX
  101. /variable/CMAKE_Swift_MODULE_DIRECTORY
  102. /variable/CMAKE_Swift_NUM_THREADS
  103. /variable/CMAKE_TOOLCHAIN_FILE
  104. /variable/CMAKE_TWEAK_VERSION
  105. /variable/CMAKE_VERBOSE_MAKEFILE
  106. /variable/CMAKE_VERSION
  107. /variable/CMAKE_VS_DEVENV_COMMAND
  108. /variable/CMAKE_VS_MSBUILD_COMMAND
  109. /variable/CMAKE_VS_NsightTegra_VERSION
  110. /variable/CMAKE_VS_PLATFORM_NAME
  111. /variable/CMAKE_VS_PLATFORM_NAME_DEFAULT
  112. /variable/CMAKE_VS_PLATFORM_TOOLSET
  113. /variable/CMAKE_VS_PLATFORM_TOOLSET_CUDA
  114. /variable/CMAKE_VS_PLATFORM_TOOLSET_CUDA_CUSTOM_DIR
  115. /variable/CMAKE_VS_PLATFORM_TOOLSET_HOST_ARCHITECTURE
  116. /variable/CMAKE_VS_PLATFORM_TOOLSET_VERSION
  117. /variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION
  118. /variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM
  119. /variable/CMAKE_XCODE_BUILD_SYSTEM
  120. /variable/CMAKE_XCODE_PLATFORM_TOOLSET
  121. /variable/PROJECT-NAME_BINARY_DIR
  122. /variable/PROJECT-NAME_DESCRIPTION
  123. /variable/PROJECT-NAME_HOMEPAGE_URL
  124. /variable/PROJECT-NAME_SOURCE_DIR
  125. /variable/PROJECT-NAME_VERSION
  126. /variable/PROJECT-NAME_VERSION_MAJOR
  127. /variable/PROJECT-NAME_VERSION_MINOR
  128. /variable/PROJECT-NAME_VERSION_PATCH
  129. /variable/PROJECT-NAME_VERSION_TWEAK
  130. /variable/PROJECT_BINARY_DIR
  131. /variable/PROJECT_DESCRIPTION
  132. /variable/PROJECT_HOMEPAGE_URL
  133. /variable/PROJECT_NAME
  134. /variable/PROJECT_SOURCE_DIR
  135. /variable/PROJECT_VERSION
  136. /variable/PROJECT_VERSION_MAJOR
  137. /variable/PROJECT_VERSION_MINOR
  138. /variable/PROJECT_VERSION_PATCH
  139. /variable/PROJECT_VERSION_TWEAK
  140. Variables that Change Behavior
  141. ==============================
  142. .. toctree::
  143. :maxdepth: 1
  144. /variable/BUILD_SHARED_LIBS
  145. /variable/CMAKE_ABSOLUTE_DESTINATION_FILES
  146. /variable/CMAKE_APPBUNDLE_PATH
  147. /variable/CMAKE_AUTOMOC_RELAXED_MODE
  148. /variable/CMAKE_BACKWARDS_COMPATIBILITY
  149. /variable/CMAKE_BUILD_TYPE
  150. /variable/CMAKE_CLANG_VFS_OVERLAY
  151. /variable/CMAKE_CODEBLOCKS_COMPILER_ID
  152. /variable/CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES
  153. /variable/CMAKE_CODELITE_USE_TARGETS
  154. /variable/CMAKE_COLOR_MAKEFILE
  155. /variable/CMAKE_CONFIGURATION_TYPES
  156. /variable/CMAKE_DEPENDS_IN_PROJECT_ONLY
  157. /variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName
  158. /variable/CMAKE_ECLIPSE_GENERATE_LINKED_RESOURCES
  159. /variable/CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT
  160. /variable/CMAKE_ECLIPSE_MAKE_ARGUMENTS
  161. /variable/CMAKE_ECLIPSE_RESOURCE_ENCODING
  162. /variable/CMAKE_ECLIPSE_VERSION
  163. /variable/CMAKE_ERROR_DEPRECATED
  164. /variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION
  165. /variable/CMAKE_EXECUTE_PROCESS_COMMAND_ECHO
  166. /variable/CMAKE_EXPORT_COMPILE_COMMANDS
  167. /variable/CMAKE_EXPORT_PACKAGE_REGISTRY
  168. /variable/CMAKE_EXPORT_NO_PACKAGE_REGISTRY
  169. /variable/CMAKE_FIND_APPBUNDLE
  170. /variable/CMAKE_FIND_FRAMEWORK
  171. /variable/CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX
  172. /variable/CMAKE_FIND_LIBRARY_PREFIXES
  173. /variable/CMAKE_FIND_LIBRARY_SUFFIXES
  174. /variable/CMAKE_FIND_NO_INSTALL_PREFIX
  175. /variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY
  176. /variable/CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY
  177. /variable/CMAKE_FIND_PACKAGE_PREFER_CONFIG
  178. /variable/CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS
  179. /variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE
  180. /variable/CMAKE_FIND_ROOT_PATH
  181. /variable/CMAKE_FIND_ROOT_PATH_MODE_INCLUDE
  182. /variable/CMAKE_FIND_ROOT_PATH_MODE_LIBRARY
  183. /variable/CMAKE_FIND_ROOT_PATH_MODE_PACKAGE
  184. /variable/CMAKE_FIND_ROOT_PATH_MODE_PROGRAM
  185. /variable/CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH
  186. /variable/CMAKE_FIND_USE_CMAKE_PATH
  187. /variable/CMAKE_FIND_USE_CMAKE_SYSTEM_PATH
  188. /variable/CMAKE_FIND_USE_PACKAGE_REGISTRY
  189. /variable/CMAKE_FIND_USE_PACKAGE_ROOT_PATH
  190. /variable/CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH
  191. /variable/CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY
  192. /variable/CMAKE_FRAMEWORK_PATH
  193. /variable/CMAKE_IGNORE_PATH
  194. /variable/CMAKE_INCLUDE_DIRECTORIES_BEFORE
  195. /variable/CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE
  196. /variable/CMAKE_INCLUDE_PATH
  197. /variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME
  198. /variable/CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS
  199. /variable/CMAKE_INSTALL_MESSAGE
  200. /variable/CMAKE_INSTALL_PREFIX
  201. /variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT
  202. /variable/CMAKE_LIBRARY_PATH
  203. /variable/CMAKE_LINK_DIRECTORIES_BEFORE
  204. /variable/CMAKE_MFC_FLAG
  205. /variable/CMAKE_MAXIMUM_RECURSION_DEPTH
  206. /variable/CMAKE_MESSAGE_CONTEXT
  207. /variable/CMAKE_MESSAGE_CONTEXT_SHOW
  208. /variable/CMAKE_MESSAGE_INDENT
  209. /variable/CMAKE_MESSAGE_LOG_LEVEL
  210. /variable/CMAKE_MODULE_PATH
  211. /variable/CMAKE_POLICY_DEFAULT_CMPNNNN
  212. /variable/CMAKE_POLICY_WARNING_CMPNNNN
  213. /variable/CMAKE_PREFIX_PATH
  214. /variable/CMAKE_PROGRAM_PATH
  215. /variable/CMAKE_PROJECT_INCLUDE
  216. /variable/CMAKE_PROJECT_INCLUDE_BEFORE
  217. /variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE
  218. /variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE_BEFORE
  219. /variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY
  220. /variable/CMAKE_STAGING_PREFIX
  221. /variable/CMAKE_SUBLIME_TEXT_2_ENV_SETTINGS
  222. /variable/CMAKE_SUBLIME_TEXT_2_EXCLUDE_BUILD_TREE
  223. /variable/CMAKE_SUPPRESS_REGENERATION
  224. /variable/CMAKE_SYSROOT
  225. /variable/CMAKE_SYSROOT_COMPILE
  226. /variable/CMAKE_SYSROOT_LINK
  227. /variable/CMAKE_SYSTEM_APPBUNDLE_PATH
  228. /variable/CMAKE_SYSTEM_FRAMEWORK_PATH
  229. /variable/CMAKE_SYSTEM_IGNORE_PATH
  230. /variable/CMAKE_SYSTEM_INCLUDE_PATH
  231. /variable/CMAKE_SYSTEM_LIBRARY_PATH
  232. /variable/CMAKE_SYSTEM_PREFIX_PATH
  233. /variable/CMAKE_SYSTEM_PROGRAM_PATH
  234. /variable/CMAKE_USER_MAKE_RULES_OVERRIDE
  235. /variable/CMAKE_WARN_DEPRECATED
  236. /variable/CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION
  237. /variable/CMAKE_XCODE_GENERATE_SCHEME
  238. /variable/CMAKE_XCODE_GENERATE_TOP_LEVEL_PROJECT_ONLY
  239. /variable/CMAKE_XCODE_LINK_BUILD_PHASE_MODE
  240. /variable/CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER
  241. /variable/CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN
  242. /variable/CMAKE_XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING
  243. /variable/CMAKE_XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER
  244. /variable/CMAKE_XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS
  245. /variable/CMAKE_XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE
  246. /variable/CMAKE_XCODE_SCHEME_ENVIRONMENT
  247. /variable/CMAKE_XCODE_SCHEME_GUARD_MALLOC
  248. /variable/CMAKE_XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP
  249. /variable/CMAKE_XCODE_SCHEME_MALLOC_GUARD_EDGES
  250. /variable/CMAKE_XCODE_SCHEME_MALLOC_SCRIBBLE
  251. /variable/CMAKE_XCODE_SCHEME_MALLOC_STACK
  252. /variable/CMAKE_XCODE_SCHEME_THREAD_SANITIZER
  253. /variable/CMAKE_XCODE_SCHEME_THREAD_SANITIZER_STOP
  254. /variable/CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER
  255. /variable/CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP
  256. /variable/CMAKE_XCODE_SCHEME_WORKING_DIRECTORY
  257. /variable/CMAKE_XCODE_SCHEME_ZOMBIE_OBJECTS
  258. /variable/PackageName_ROOT
  259. Variables that Describe the System
  260. ==================================
  261. .. toctree::
  262. :maxdepth: 1
  263. /variable/ANDROID
  264. /variable/APPLE
  265. /variable/BORLAND
  266. /variable/CMAKE_CL_64
  267. /variable/CMAKE_COMPILER_2005
  268. /variable/CMAKE_HOST_APPLE
  269. /variable/CMAKE_HOST_SOLARIS
  270. /variable/CMAKE_HOST_SYSTEM
  271. /variable/CMAKE_HOST_SYSTEM_NAME
  272. /variable/CMAKE_HOST_SYSTEM_PROCESSOR
  273. /variable/CMAKE_HOST_SYSTEM_VERSION
  274. /variable/CMAKE_HOST_UNIX
  275. /variable/CMAKE_HOST_WIN32
  276. /variable/CMAKE_LIBRARY_ARCHITECTURE
  277. /variable/CMAKE_LIBRARY_ARCHITECTURE_REGEX
  278. /variable/CMAKE_OBJECT_PATH_MAX
  279. /variable/CMAKE_SYSTEM
  280. /variable/CMAKE_SYSTEM_NAME
  281. /variable/CMAKE_SYSTEM_PROCESSOR
  282. /variable/CMAKE_SYSTEM_VERSION
  283. /variable/CYGWIN
  284. /variable/GHS-MULTI
  285. /variable/IOS
  286. /variable/MINGW
  287. /variable/MSVC
  288. /variable/MSVC10
  289. /variable/MSVC11
  290. /variable/MSVC12
  291. /variable/MSVC14
  292. /variable/MSVC60
  293. /variable/MSVC70
  294. /variable/MSVC71
  295. /variable/MSVC80
  296. /variable/MSVC90
  297. /variable/MSVC_IDE
  298. /variable/MSVC_TOOLSET_VERSION
  299. /variable/MSVC_VERSION
  300. /variable/MSYS
  301. /variable/UNIX
  302. /variable/WIN32
  303. /variable/WINCE
  304. /variable/WINDOWS_PHONE
  305. /variable/WINDOWS_STORE
  306. /variable/XCODE
  307. /variable/XCODE_VERSION
  308. Variables that Control the Build
  309. ================================
  310. .. toctree::
  311. :maxdepth: 1
  312. /variable/CMAKE_AIX_EXPORT_ALL_SYMBOLS
  313. /variable/CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS
  314. /variable/CMAKE_ANDROID_API
  315. /variable/CMAKE_ANDROID_API_MIN
  316. /variable/CMAKE_ANDROID_ARCH
  317. /variable/CMAKE_ANDROID_ARCH_ABI
  318. /variable/CMAKE_ANDROID_ARM_MODE
  319. /variable/CMAKE_ANDROID_ARM_NEON
  320. /variable/CMAKE_ANDROID_ASSETS_DIRECTORIES
  321. /variable/CMAKE_ANDROID_GUI
  322. /variable/CMAKE_ANDROID_JAR_DEPENDENCIES
  323. /variable/CMAKE_ANDROID_JAR_DIRECTORIES
  324. /variable/CMAKE_ANDROID_JAVA_SOURCE_DIR
  325. /variable/CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES
  326. /variable/CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES
  327. /variable/CMAKE_ANDROID_NDK
  328. /variable/CMAKE_ANDROID_NDK_DEPRECATED_HEADERS
  329. /variable/CMAKE_ANDROID_NDK_TOOLCHAIN_HOST_TAG
  330. /variable/CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION
  331. /variable/CMAKE_ANDROID_PROCESS_MAX
  332. /variable/CMAKE_ANDROID_PROGUARD
  333. /variable/CMAKE_ANDROID_PROGUARD_CONFIG_PATH
  334. /variable/CMAKE_ANDROID_SECURE_PROPS_PATH
  335. /variable/CMAKE_ANDROID_SKIP_ANT_STEP
  336. /variable/CMAKE_ANDROID_STANDALONE_TOOLCHAIN
  337. /variable/CMAKE_ANDROID_STL_TYPE
  338. /variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY
  339. /variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY_CONFIG
  340. /variable/CMAKE_AUTOGEN_ORIGIN_DEPENDS
  341. /variable/CMAKE_AUTOGEN_PARALLEL
  342. /variable/CMAKE_AUTOGEN_VERBOSE
  343. /variable/CMAKE_AUTOMOC
  344. /variable/CMAKE_AUTOMOC_COMPILER_PREDEFINES
  345. /variable/CMAKE_AUTOMOC_DEPEND_FILTERS
  346. /variable/CMAKE_AUTOMOC_MACRO_NAMES
  347. /variable/CMAKE_AUTOMOC_MOC_OPTIONS
  348. /variable/CMAKE_AUTOMOC_PATH_PREFIX
  349. /variable/CMAKE_AUTORCC
  350. /variable/CMAKE_AUTORCC_OPTIONS
  351. /variable/CMAKE_AUTOUIC
  352. /variable/CMAKE_AUTOUIC_OPTIONS
  353. /variable/CMAKE_AUTOUIC_SEARCH_PATHS
  354. /variable/CMAKE_BUILD_RPATH
  355. /variable/CMAKE_BUILD_RPATH_USE_ORIGIN
  356. /variable/CMAKE_BUILD_WITH_INSTALL_NAME_DIR
  357. /variable/CMAKE_BUILD_WITH_INSTALL_RPATH
  358. /variable/CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY
  359. /variable/CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG
  360. /variable/CMAKE_CONFIG_POSTFIX
  361. /variable/CMAKE_CROSS_CONFIGS
  362. /variable/CMAKE_CTEST_ARGUMENTS
  363. /variable/CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS
  364. /variable/CMAKE_CUDA_RUNTIME_LIBRARY
  365. /variable/CMAKE_CUDA_SEPARABLE_COMPILATION
  366. /variable/CMAKE_DEBUG_POSTFIX
  367. /variable/CMAKE_DEFAULT_BUILD_TYPE
  368. /variable/CMAKE_DEFAULT_CONFIGS
  369. /variable/CMAKE_DISABLE_PRECOMPILE_HEADERS
  370. /variable/CMAKE_ENABLE_EXPORTS
  371. /variable/CMAKE_EXE_LINKER_FLAGS
  372. /variable/CMAKE_EXE_LINKER_FLAGS_CONFIG
  373. /variable/CMAKE_EXE_LINKER_FLAGS_CONFIG_INIT
  374. /variable/CMAKE_EXE_LINKER_FLAGS_INIT
  375. /variable/CMAKE_FOLDER
  376. /variable/CMAKE_FRAMEWORK
  377. /variable/CMAKE_FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG
  378. /variable/CMAKE_Fortran_FORMAT
  379. /variable/CMAKE_Fortran_MODULE_DIRECTORY
  380. /variable/CMAKE_Fortran_PREPROCESS
  381. /variable/CMAKE_GHS_NO_SOURCE_GROUP_FILE
  382. /variable/CMAKE_GLOBAL_AUTOGEN_TARGET
  383. /variable/CMAKE_GLOBAL_AUTOGEN_TARGET_NAME
  384. /variable/CMAKE_GLOBAL_AUTORCC_TARGET
  385. /variable/CMAKE_GLOBAL_AUTORCC_TARGET_NAME
  386. /variable/CMAKE_GNUtoMS
  387. /variable/CMAKE_INCLUDE_CURRENT_DIR
  388. /variable/CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE
  389. /variable/CMAKE_INSTALL_NAME_DIR
  390. /variable/CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH
  391. /variable/CMAKE_INSTALL_RPATH
  392. /variable/CMAKE_INSTALL_RPATH_USE_LINK_PATH
  393. /variable/CMAKE_INTERPROCEDURAL_OPTIMIZATION
  394. /variable/CMAKE_INTERPROCEDURAL_OPTIMIZATION_CONFIG
  395. /variable/CMAKE_IOS_INSTALL_COMBINED
  396. /variable/CMAKE_LANG_CLANG_TIDY
  397. /variable/CMAKE_LANG_COMPILER_LAUNCHER
  398. /variable/CMAKE_LANG_CPPCHECK
  399. /variable/CMAKE_LANG_CPPLINT
  400. /variable/CMAKE_LANG_INCLUDE_WHAT_YOU_USE
  401. /variable/CMAKE_LANG_LINK_LIBRARY_FILE_FLAG
  402. /variable/CMAKE_LANG_LINK_LIBRARY_FLAG
  403. /variable/CMAKE_LANG_VISIBILITY_PRESET
  404. /variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY
  405. /variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY_CONFIG
  406. /variable/CMAKE_LIBRARY_PATH_FLAG
  407. /variable/CMAKE_LINK_DEF_FILE_FLAG
  408. /variable/CMAKE_LINK_DEPENDS_NO_SHARED
  409. /variable/CMAKE_LINK_INTERFACE_LIBRARIES
  410. /variable/CMAKE_LINK_LIBRARY_FILE_FLAG
  411. /variable/CMAKE_LINK_LIBRARY_FLAG
  412. /variable/CMAKE_LINK_WHAT_YOU_USE
  413. /variable/CMAKE_MACOSX_BUNDLE
  414. /variable/CMAKE_MACOSX_RPATH
  415. /variable/CMAKE_MAP_IMPORTED_CONFIG_CONFIG
  416. /variable/CMAKE_MODULE_LINKER_FLAGS
  417. /variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG
  418. /variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG_INIT
  419. /variable/CMAKE_MODULE_LINKER_FLAGS_INIT
  420. /variable/CMAKE_MSVCIDE_RUN_PATH
  421. /variable/CMAKE_MSVC_RUNTIME_LIBRARY
  422. /variable/CMAKE_NINJA_OUTPUT_PATH_PREFIX
  423. /variable/CMAKE_NO_BUILTIN_CHRPATH
  424. /variable/CMAKE_NO_SYSTEM_FROM_IMPORTED
  425. /variable/CMAKE_OPTIMIZE_DEPENDENCIES
  426. /variable/CMAKE_OSX_ARCHITECTURES
  427. /variable/CMAKE_OSX_DEPLOYMENT_TARGET
  428. /variable/CMAKE_OSX_SYSROOT
  429. /variable/CMAKE_PCH_WARN_INVALID
  430. /variable/CMAKE_PCH_INSTANTIATE_TEMPLATES
  431. /variable/CMAKE_PDB_OUTPUT_DIRECTORY
  432. /variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG
  433. /variable/CMAKE_POSITION_INDEPENDENT_CODE
  434. /variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY
  435. /variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY_CONFIG
  436. /variable/CMAKE_SHARED_LINKER_FLAGS
  437. /variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG
  438. /variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG_INIT
  439. /variable/CMAKE_SHARED_LINKER_FLAGS_INIT
  440. /variable/CMAKE_SKIP_BUILD_RPATH
  441. /variable/CMAKE_SKIP_INSTALL_RPATH
  442. /variable/CMAKE_STATIC_LINKER_FLAGS
  443. /variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG
  444. /variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG_INIT
  445. /variable/CMAKE_STATIC_LINKER_FLAGS_INIT
  446. /variable/CMAKE_TRY_COMPILE_CONFIGURATION
  447. /variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES
  448. /variable/CMAKE_TRY_COMPILE_TARGET_TYPE
  449. /variable/CMAKE_UNITY_BUILD
  450. /variable/CMAKE_UNITY_BUILD_BATCH_SIZE
  451. /variable/CMAKE_USE_RELATIVE_PATHS
  452. /variable/CMAKE_VISIBILITY_INLINES_HIDDEN
  453. /variable/CMAKE_VS_GLOBALS
  454. /variable/CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD
  455. /variable/CMAKE_VS_INCLUDE_PACKAGE_TO_DEFAULT_BUILD
  456. /variable/CMAKE_VS_JUST_MY_CODE_DEBUGGING
  457. /variable/CMAKE_VS_SDK_EXCLUDE_DIRECTORIES
  458. /variable/CMAKE_VS_SDK_EXECUTABLE_DIRECTORIES
  459. /variable/CMAKE_VS_SDK_INCLUDE_DIRECTORIES
  460. /variable/CMAKE_VS_SDK_LIBRARY_DIRECTORIES
  461. /variable/CMAKE_VS_SDK_LIBRARY_WINRT_DIRECTORIES
  462. /variable/CMAKE_VS_SDK_REFERENCE_DIRECTORIES
  463. /variable/CMAKE_VS_SDK_SOURCE_DIRECTORIES
  464. /variable/CMAKE_VS_WINRT_BY_DEFAULT
  465. /variable/CMAKE_WIN32_EXECUTABLE
  466. /variable/CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS
  467. /variable/CMAKE_XCODE_ATTRIBUTE_an-attribute
  468. /variable/EXECUTABLE_OUTPUT_PATH
  469. /variable/LIBRARY_OUTPUT_PATH
  470. Variables for Languages
  471. =======================
  472. .. toctree::
  473. :maxdepth: 1
  474. /variable/CMAKE_COMPILER_IS_GNUCC
  475. /variable/CMAKE_COMPILER_IS_GNUCXX
  476. /variable/CMAKE_COMPILER_IS_GNUG77
  477. /variable/CMAKE_CUDA_ARCHITECTURES
  478. /variable/CMAKE_CUDA_COMPILE_FEATURES
  479. /variable/CMAKE_CUDA_EXTENSIONS
  480. /variable/CMAKE_CUDA_HOST_COMPILER
  481. /variable/CMAKE_CUDA_STANDARD
  482. /variable/CMAKE_CUDA_STANDARD_REQUIRED
  483. /variable/CMAKE_CUDA_TOOLKIT_INCLUDE_DIRECTORIES
  484. /variable/CMAKE_CXX_COMPILE_FEATURES
  485. /variable/CMAKE_CXX_EXTENSIONS
  486. /variable/CMAKE_CXX_STANDARD
  487. /variable/CMAKE_CXX_STANDARD_REQUIRED
  488. /variable/CMAKE_C_COMPILE_FEATURES
  489. /variable/CMAKE_C_EXTENSIONS
  490. /variable/CMAKE_C_STANDARD
  491. /variable/CMAKE_C_STANDARD_REQUIRED
  492. /variable/CMAKE_Fortran_MODDIR_DEFAULT
  493. /variable/CMAKE_Fortran_MODDIR_FLAG
  494. /variable/CMAKE_Fortran_MODOUT_FLAG
  495. /variable/CMAKE_ISPC_HEADER_DIRECTORY
  496. /variable/CMAKE_ISPC_INSTRUCTION_SETS
  497. /variable/CMAKE_LANG_ANDROID_TOOLCHAIN_MACHINE
  498. /variable/CMAKE_LANG_ANDROID_TOOLCHAIN_PREFIX
  499. /variable/CMAKE_LANG_ANDROID_TOOLCHAIN_SUFFIX
  500. /variable/CMAKE_LANG_ARCHIVE_APPEND
  501. /variable/CMAKE_LANG_ARCHIVE_CREATE
  502. /variable/CMAKE_LANG_ARCHIVE_FINISH
  503. /variable/CMAKE_LANG_COMPILER
  504. /variable/CMAKE_LANG_COMPILER_EXTERNAL_TOOLCHAIN
  505. /variable/CMAKE_LANG_COMPILER_ID
  506. /variable/CMAKE_LANG_COMPILER_LOADED
  507. /variable/CMAKE_LANG_COMPILER_PREDEFINES_COMMAND
  508. /variable/CMAKE_LANG_COMPILER_TARGET
  509. /variable/CMAKE_LANG_COMPILER_VERSION
  510. /variable/CMAKE_LANG_COMPILE_OBJECT
  511. /variable/CMAKE_LANG_CREATE_SHARED_LIBRARY
  512. /variable/CMAKE_LANG_CREATE_SHARED_MODULE
  513. /variable/CMAKE_LANG_CREATE_STATIC_LIBRARY
  514. /variable/CMAKE_LANG_FLAGS
  515. /variable/CMAKE_LANG_FLAGS_CONFIG
  516. /variable/CMAKE_LANG_FLAGS_CONFIG_INIT
  517. /variable/CMAKE_LANG_FLAGS_DEBUG
  518. /variable/CMAKE_LANG_FLAGS_DEBUG_INIT
  519. /variable/CMAKE_LANG_FLAGS_INIT
  520. /variable/CMAKE_LANG_FLAGS_MINSIZEREL
  521. /variable/CMAKE_LANG_FLAGS_MINSIZEREL_INIT
  522. /variable/CMAKE_LANG_FLAGS_RELEASE
  523. /variable/CMAKE_LANG_FLAGS_RELEASE_INIT
  524. /variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO
  525. /variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO_INIT
  526. /variable/CMAKE_LANG_IGNORE_EXTENSIONS
  527. /variable/CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES
  528. /variable/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES
  529. /variable/CMAKE_LANG_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES
  530. /variable/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES
  531. /variable/CMAKE_LANG_LIBRARY_ARCHITECTURE
  532. /variable/CMAKE_LANG_LINK_EXECUTABLE
  533. /variable/CMAKE_LANG_LINKER_PREFERENCE
  534. /variable/CMAKE_LANG_LINKER_PREFERENCE_PROPAGATES
  535. /variable/CMAKE_LANG_LINKER_WRAPPER_FLAG
  536. /variable/CMAKE_LANG_LINKER_WRAPPER_FLAG_SEP
  537. /variable/CMAKE_LANG_OUTPUT_EXTENSION
  538. /variable/CMAKE_LANG_SIMULATE_ID
  539. /variable/CMAKE_LANG_SIMULATE_VERSION
  540. /variable/CMAKE_LANG_SIZEOF_DATA_PTR
  541. /variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS
  542. /variable/CMAKE_LANG_STANDARD_INCLUDE_DIRECTORIES
  543. /variable/CMAKE_LANG_STANDARD_LIBRARIES
  544. /variable/CMAKE_OBJC_EXTENSIONS
  545. /variable/CMAKE_OBJC_STANDARD
  546. /variable/CMAKE_OBJC_STANDARD_REQUIRED
  547. /variable/CMAKE_OBJCXX_EXTENSIONS
  548. /variable/CMAKE_OBJCXX_STANDARD
  549. /variable/CMAKE_OBJCXX_STANDARD_REQUIRED
  550. /variable/CMAKE_Swift_LANGUAGE_VERSION
  551. /variable/CMAKE_USER_MAKE_RULES_OVERRIDE_LANG
  552. Variables for CTest
  553. ===================
  554. .. toctree::
  555. :maxdepth: 1
  556. /variable/CTEST_BINARY_DIRECTORY
  557. /variable/CTEST_BUILD_COMMAND
  558. /variable/CTEST_BUILD_NAME
  559. /variable/CTEST_BZR_COMMAND
  560. /variable/CTEST_BZR_UPDATE_OPTIONS
  561. /variable/CTEST_CHANGE_ID
  562. /variable/CTEST_CHECKOUT_COMMAND
  563. /variable/CTEST_CONFIGURATION_TYPE
  564. /variable/CTEST_CONFIGURE_COMMAND
  565. /variable/CTEST_COVERAGE_COMMAND
  566. /variable/CTEST_COVERAGE_EXTRA_FLAGS
  567. /variable/CTEST_CURL_OPTIONS
  568. /variable/CTEST_CUSTOM_COVERAGE_EXCLUDE
  569. /variable/CTEST_CUSTOM_ERROR_EXCEPTION
  570. /variable/CTEST_CUSTOM_ERROR_MATCH
  571. /variable/CTEST_CUSTOM_ERROR_POST_CONTEXT
  572. /variable/CTEST_CUSTOM_ERROR_PRE_CONTEXT
  573. /variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE
  574. /variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_ERRORS
  575. /variable/CTEST_CUSTOM_MAXIMUM_NUMBER_OF_WARNINGS
  576. /variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE
  577. /variable/CTEST_CUSTOM_MEMCHECK_IGNORE
  578. /variable/CTEST_CUSTOM_POST_MEMCHECK
  579. /variable/CTEST_CUSTOM_POST_TEST
  580. /variable/CTEST_CUSTOM_PRE_MEMCHECK
  581. /variable/CTEST_CUSTOM_PRE_TEST
  582. /variable/CTEST_CUSTOM_TESTS_IGNORE
  583. /variable/CTEST_CUSTOM_WARNING_EXCEPTION
  584. /variable/CTEST_CUSTOM_WARNING_MATCH
  585. /variable/CTEST_CVS_CHECKOUT
  586. /variable/CTEST_CVS_COMMAND
  587. /variable/CTEST_CVS_UPDATE_OPTIONS
  588. /variable/CTEST_DROP_LOCATION
  589. /variable/CTEST_DROP_METHOD
  590. /variable/CTEST_DROP_SITE
  591. /variable/CTEST_DROP_SITE_CDASH
  592. /variable/CTEST_DROP_SITE_PASSWORD
  593. /variable/CTEST_DROP_SITE_USER
  594. /variable/CTEST_EXTRA_COVERAGE_GLOB
  595. /variable/CTEST_GIT_COMMAND
  596. /variable/CTEST_GIT_INIT_SUBMODULES
  597. /variable/CTEST_GIT_UPDATE_CUSTOM
  598. /variable/CTEST_GIT_UPDATE_OPTIONS
  599. /variable/CTEST_HG_COMMAND
  600. /variable/CTEST_HG_UPDATE_OPTIONS
  601. /variable/CTEST_LABELS_FOR_SUBPROJECTS
  602. /variable/CTEST_MEMORYCHECK_COMMAND
  603. /variable/CTEST_MEMORYCHECK_COMMAND_OPTIONS
  604. /variable/CTEST_MEMORYCHECK_SANITIZER_OPTIONS
  605. /variable/CTEST_MEMORYCHECK_SUPPRESSIONS_FILE
  606. /variable/CTEST_MEMORYCHECK_TYPE
  607. /variable/CTEST_NIGHTLY_START_TIME
  608. /variable/CTEST_P4_CLIENT
  609. /variable/CTEST_P4_COMMAND
  610. /variable/CTEST_P4_OPTIONS
  611. /variable/CTEST_P4_UPDATE_OPTIONS
  612. /variable/CTEST_RESOURCE_SPEC_FILE
  613. /variable/CTEST_RUN_CURRENT_SCRIPT
  614. /variable/CTEST_SCP_COMMAND
  615. /variable/CTEST_SITE
  616. /variable/CTEST_SUBMIT_URL
  617. /variable/CTEST_SOURCE_DIRECTORY
  618. /variable/CTEST_SVN_COMMAND
  619. /variable/CTEST_SVN_OPTIONS
  620. /variable/CTEST_SVN_UPDATE_OPTIONS
  621. /variable/CTEST_TEST_LOAD
  622. /variable/CTEST_TEST_TIMEOUT
  623. /variable/CTEST_TRIGGER_SITE
  624. /variable/CTEST_UPDATE_COMMAND
  625. /variable/CTEST_UPDATE_OPTIONS
  626. /variable/CTEST_UPDATE_VERSION_ONLY
  627. /variable/CTEST_UPDATE_VERSION_OVERRIDE
  628. /variable/CTEST_USE_LAUNCHERS
  629. Variables for CPack
  630. ===================
  631. .. toctree::
  632. :maxdepth: 1
  633. /variable/CPACK_ABSOLUTE_DESTINATION_FILES
  634. /variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY
  635. /variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION
  636. /variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY
  637. /variable/CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS
  638. /variable/CPACK_PACKAGING_INSTALL_PREFIX
  639. /variable/CPACK_SET_DESTDIR
  640. /variable/CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION
  641. Variable Expansion Operators
  642. ============================
  643. .. toctree::
  644. :maxdepth: 1
  645. /variable/CACHE
  646. /variable/ENV
  647. Internal Variables
  648. ==================
  649. CMake has many internal variables. Most of them are undocumented.
  650. Some of them, however, were at some point described as normal
  651. variables, and therefore may be encountered in legacy code. They
  652. are subject to change, and not recommended for use in project code.
  653. .. toctree::
  654. :maxdepth: 1
  655. /variable/CMAKE_HOME_DIRECTORY
  656. /variable/CMAKE_INTERNAL_PLATFORM_ABI
  657. /variable/CMAKE_LANG_COMPILER_ABI
  658. /variable/CMAKE_LANG_COMPILER_ARCHITECTURE_ID
  659. /variable/CMAKE_LANG_COMPILER_VERSION_INTERNAL
  660. /variable/CMAKE_LANG_PLATFORM_ID
  661. /variable/CMAKE_NOT_USING_CONFIG_FLAGS
  662. /variable/CMAKE_VS_INTEL_Fortran_PROJECT_VERSION