cmake-variables.7.rst 23 KB

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