cmake-variables.7.rst 24 KB

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