cmake-variables.7.rst 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
  1. .. cmake-manual-description: CMake Variables Reference
  2. cmake-variables(7)
  3. ******************
  4. .. only:: html
  5. .. contents::
  6. Variables that Provide Information
  7. ==================================
  8. .. toctree::
  9. :maxdepth: 1
  10. /variable/CMAKE_ARGC
  11. /variable/CMAKE_ARGV0
  12. /variable/CMAKE_AR
  13. /variable/CMAKE_BINARY_DIR
  14. /variable/CMAKE_BUILD_TOOL
  15. /variable/CMAKE_CACHEFILE_DIR
  16. /variable/CMAKE_CACHE_MAJOR_VERSION
  17. /variable/CMAKE_CACHE_MINOR_VERSION
  18. /variable/CMAKE_CACHE_PATCH_VERSION
  19. /variable/CMAKE_CFG_INTDIR
  20. /variable/CMAKE_COMMAND
  21. /variable/CMAKE_CROSSCOMPILING
  22. /variable/CMAKE_CTEST_COMMAND
  23. /variable/CMAKE_CURRENT_BINARY_DIR
  24. /variable/CMAKE_CURRENT_LIST_DIR
  25. /variable/CMAKE_CURRENT_LIST_FILE
  26. /variable/CMAKE_CURRENT_LIST_LINE
  27. /variable/CMAKE_CURRENT_SOURCE_DIR
  28. /variable/CMAKE_DL_LIBS
  29. /variable/CMAKE_EDIT_COMMAND
  30. /variable/CMAKE_EXECUTABLE_SUFFIX
  31. /variable/CMAKE_EXTRA_GENERATOR
  32. /variable/CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES
  33. /variable/CMAKE_FIND_PACKAGE_NAME
  34. /variable/CMAKE_GENERATOR
  35. /variable/CMAKE_GENERATOR_PLATFORM
  36. /variable/CMAKE_GENERATOR_TOOLSET
  37. /variable/CMAKE_HOME_DIRECTORY
  38. /variable/CMAKE_IMPORT_LIBRARY_PREFIX
  39. /variable/CMAKE_IMPORT_LIBRARY_SUFFIX
  40. /variable/CMAKE_JOB_POOL_COMPILE
  41. /variable/CMAKE_JOB_POOL_LINK
  42. /variable/CMAKE_LINK_LIBRARY_SUFFIX
  43. /variable/CMAKE_MAJOR_VERSION
  44. /variable/CMAKE_MAKE_PROGRAM
  45. /variable/CMAKE_MATCH_COUNT
  46. /variable/CMAKE_MINIMUM_REQUIRED_VERSION
  47. /variable/CMAKE_MINOR_VERSION
  48. /variable/CMAKE_PARENT_LIST_FILE
  49. /variable/CMAKE_PATCH_VERSION
  50. /variable/CMAKE_PROJECT_NAME
  51. /variable/CMAKE_RANLIB
  52. /variable/CMAKE_ROOT
  53. /variable/CMAKE_SCRIPT_MODE_FILE
  54. /variable/CMAKE_SHARED_LIBRARY_PREFIX
  55. /variable/CMAKE_SHARED_LIBRARY_SUFFIX
  56. /variable/CMAKE_SHARED_MODULE_PREFIX
  57. /variable/CMAKE_SHARED_MODULE_SUFFIX
  58. /variable/CMAKE_SIZEOF_VOID_P
  59. /variable/CMAKE_SKIP_INSTALL_RULES
  60. /variable/CMAKE_SKIP_RPATH
  61. /variable/CMAKE_SOURCE_DIR
  62. /variable/CMAKE_STANDARD_LIBRARIES
  63. /variable/CMAKE_STATIC_LIBRARY_PREFIX
  64. /variable/CMAKE_STATIC_LIBRARY_SUFFIX
  65. /variable/CMAKE_TOOLCHAIN_FILE
  66. /variable/CMAKE_TWEAK_VERSION
  67. /variable/CMAKE_VERBOSE_MAKEFILE
  68. /variable/CMAKE_VERSION
  69. /variable/CMAKE_VS_DEVENV_COMMAND
  70. /variable/CMAKE_VS_INTEL_Fortran_PROJECT_VERSION
  71. /variable/CMAKE_VS_MSBUILD_COMMAND
  72. /variable/CMAKE_VS_MSDEV_COMMAND
  73. /variable/CMAKE_VS_NsightTegra_VERSION
  74. /variable/CMAKE_VS_PLATFORM_NAME
  75. /variable/CMAKE_VS_PLATFORM_TOOLSET
  76. /variable/CMAKE_XCODE_PLATFORM_TOOLSET
  77. /variable/PROJECT_BINARY_DIR
  78. /variable/PROJECT-NAME_BINARY_DIR
  79. /variable/PROJECT_NAME
  80. /variable/PROJECT-NAME_SOURCE_DIR
  81. /variable/PROJECT-NAME_VERSION
  82. /variable/PROJECT-NAME_VERSION_MAJOR
  83. /variable/PROJECT-NAME_VERSION_MINOR
  84. /variable/PROJECT-NAME_VERSION_PATCH
  85. /variable/PROJECT-NAME_VERSION_TWEAK
  86. /variable/PROJECT_SOURCE_DIR
  87. /variable/PROJECT_VERSION
  88. /variable/PROJECT_VERSION_MAJOR
  89. /variable/PROJECT_VERSION_MINOR
  90. /variable/PROJECT_VERSION_PATCH
  91. /variable/PROJECT_VERSION_TWEAK
  92. Variables that Change Behavior
  93. ==============================
  94. .. toctree::
  95. :maxdepth: 1
  96. /variable/BUILD_SHARED_LIBS
  97. /variable/CMAKE_ABSOLUTE_DESTINATION_FILES
  98. /variable/CMAKE_APPBUNDLE_PATH
  99. /variable/CMAKE_AUTOMOC_RELAXED_MODE
  100. /variable/CMAKE_BACKWARDS_COMPATIBILITY
  101. /variable/CMAKE_BUILD_TYPE
  102. /variable/CMAKE_COLOR_MAKEFILE
  103. /variable/CMAKE_CONFIGURATION_TYPES
  104. /variable/CMAKE_DEBUG_TARGET_PROPERTIES
  105. /variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName
  106. /variable/CMAKE_ERROR_DEPRECATED
  107. /variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION
  108. /variable/CMAKE_EXPORT_NO_PACKAGE_REGISTRY
  109. /variable/CMAKE_SYSROOT
  110. /variable/CMAKE_FIND_LIBRARY_PREFIXES
  111. /variable/CMAKE_FIND_LIBRARY_SUFFIXES
  112. /variable/CMAKE_FIND_NO_INSTALL_PREFIX
  113. /variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY
  114. /variable/CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY
  115. /variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE
  116. /variable/CMAKE_FIND_ROOT_PATH
  117. /variable/CMAKE_FIND_ROOT_PATH_MODE_INCLUDE
  118. /variable/CMAKE_FIND_ROOT_PATH_MODE_LIBRARY
  119. /variable/CMAKE_FIND_ROOT_PATH_MODE_PACKAGE
  120. /variable/CMAKE_FIND_ROOT_PATH_MODE_PROGRAM
  121. /variable/CMAKE_FRAMEWORK_PATH
  122. /variable/CMAKE_IGNORE_PATH
  123. /variable/CMAKE_INCLUDE_PATH
  124. /variable/CMAKE_INCLUDE_DIRECTORIES_BEFORE
  125. /variable/CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE
  126. /variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME
  127. /variable/CMAKE_INSTALL_MESSAGE
  128. /variable/CMAKE_INSTALL_PREFIX
  129. /variable/CMAKE_LIBRARY_PATH
  130. /variable/CMAKE_MFC_FLAG
  131. /variable/CMAKE_MODULE_PATH
  132. /variable/CMAKE_NOT_USING_CONFIG_FLAGS
  133. /variable/CMAKE_POLICY_DEFAULT_CMPNNNN
  134. /variable/CMAKE_POLICY_WARNING_CMPNNNN
  135. /variable/CMAKE_PREFIX_PATH
  136. /variable/CMAKE_PROGRAM_PATH
  137. /variable/CMAKE_PROJECT_PROJECT-NAME_INCLUDE
  138. /variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY
  139. /variable/CMAKE_STAGING_PREFIX
  140. /variable/CMAKE_SYSTEM_IGNORE_PATH
  141. /variable/CMAKE_SYSTEM_INCLUDE_PATH
  142. /variable/CMAKE_SYSTEM_LIBRARY_PATH
  143. /variable/CMAKE_SYSTEM_PREFIX_PATH
  144. /variable/CMAKE_SYSTEM_PROGRAM_PATH
  145. /variable/CMAKE_USER_MAKE_RULES_OVERRIDE
  146. /variable/CMAKE_WARN_DEPRECATED
  147. /variable/CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION
  148. Variables that Describe the System
  149. ==================================
  150. .. toctree::
  151. :maxdepth: 1
  152. /variable/APPLE
  153. /variable/BORLAND
  154. /variable/CMAKE_CL_64
  155. /variable/CMAKE_COMPILER_2005
  156. /variable/CMAKE_HOST_APPLE
  157. /variable/CMAKE_HOST_SYSTEM_NAME
  158. /variable/CMAKE_HOST_SYSTEM_PROCESSOR
  159. /variable/CMAKE_HOST_SYSTEM
  160. /variable/CMAKE_HOST_SYSTEM_VERSION
  161. /variable/CMAKE_HOST_UNIX
  162. /variable/CMAKE_HOST_WIN32
  163. /variable/CMAKE_LIBRARY_ARCHITECTURE_REGEX
  164. /variable/CMAKE_LIBRARY_ARCHITECTURE
  165. /variable/CMAKE_OBJECT_PATH_MAX
  166. /variable/CMAKE_SYSTEM_NAME
  167. /variable/CMAKE_SYSTEM_PROCESSOR
  168. /variable/CMAKE_SYSTEM
  169. /variable/CMAKE_SYSTEM_VERSION
  170. /variable/CYGWIN
  171. /variable/ENV
  172. /variable/MSVC10
  173. /variable/MSVC11
  174. /variable/MSVC12
  175. /variable/MSVC14
  176. /variable/MSVC60
  177. /variable/MSVC70
  178. /variable/MSVC71
  179. /variable/MSVC80
  180. /variable/MSVC90
  181. /variable/MSVC_IDE
  182. /variable/MSVC
  183. /variable/MSVC_VERSION
  184. /variable/UNIX
  185. /variable/WIN32
  186. /variable/WINCE
  187. /variable/WINDOWS_PHONE
  188. /variable/WINDOWS_STORE
  189. /variable/XCODE_VERSION
  190. Variables that Control the Build
  191. ================================
  192. .. toctree::
  193. :maxdepth: 1
  194. /variable/CMAKE_ANDROID_API
  195. /variable/CMAKE_ANDROID_API_MIN
  196. /variable/CMAKE_ANDROID_GUI
  197. /variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY
  198. /variable/CMAKE_AUTOMOC_MOC_OPTIONS
  199. /variable/CMAKE_AUTOMOC
  200. /variable/CMAKE_AUTORCC
  201. /variable/CMAKE_AUTORCC_OPTIONS
  202. /variable/CMAKE_AUTOUIC
  203. /variable/CMAKE_AUTOUIC_OPTIONS
  204. /variable/CMAKE_BUILD_WITH_INSTALL_RPATH
  205. /variable/CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY
  206. /variable/CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG
  207. /variable/CMAKE_CONFIG_POSTFIX
  208. /variable/CMAKE_DEBUG_POSTFIX
  209. /variable/CMAKE_EXE_LINKER_FLAGS_CONFIG
  210. /variable/CMAKE_EXE_LINKER_FLAGS
  211. /variable/CMAKE_Fortran_FORMAT
  212. /variable/CMAKE_Fortran_MODULE_DIRECTORY
  213. /variable/CMAKE_GNUtoMS
  214. /variable/CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE
  215. /variable/CMAKE_INCLUDE_CURRENT_DIR
  216. /variable/CMAKE_INSTALL_NAME_DIR
  217. /variable/CMAKE_INSTALL_RPATH
  218. /variable/CMAKE_INSTALL_RPATH_USE_LINK_PATH
  219. /variable/CMAKE_LANG_VISIBILITY_PRESET
  220. /variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY
  221. /variable/CMAKE_LIBRARY_PATH_FLAG
  222. /variable/CMAKE_LINK_DEF_FILE_FLAG
  223. /variable/CMAKE_LINK_DEPENDS_NO_SHARED
  224. /variable/CMAKE_LINK_INTERFACE_LIBRARIES
  225. /variable/CMAKE_LINK_LIBRARY_FILE_FLAG
  226. /variable/CMAKE_LINK_LIBRARY_FLAG
  227. /variable/CMAKE_MACOSX_BUNDLE
  228. /variable/CMAKE_MACOSX_RPATH
  229. /variable/CMAKE_MAP_IMPORTED_CONFIG_CONFIG
  230. /variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG
  231. /variable/CMAKE_MODULE_LINKER_FLAGS
  232. /variable/CMAKE_NO_BUILTIN_CHRPATH
  233. /variable/CMAKE_NO_SYSTEM_FROM_IMPORTED
  234. /variable/CMAKE_OSX_ARCHITECTURES
  235. /variable/CMAKE_OSX_DEPLOYMENT_TARGET
  236. /variable/CMAKE_OSX_SYSROOT
  237. /variable/CMAKE_PDB_OUTPUT_DIRECTORY
  238. /variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG
  239. /variable/CMAKE_POSITION_INDEPENDENT_CODE
  240. /variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY
  241. /variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG
  242. /variable/CMAKE_SHARED_LINKER_FLAGS
  243. /variable/CMAKE_SKIP_BUILD_RPATH
  244. /variable/CMAKE_SKIP_INSTALL_RPATH
  245. /variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG
  246. /variable/CMAKE_STATIC_LINKER_FLAGS
  247. /variable/CMAKE_TRY_COMPILE_CONFIGURATION
  248. /variable/CMAKE_USE_RELATIVE_PATHS
  249. /variable/CMAKE_VISIBILITY_INLINES_HIDDEN
  250. /variable/CMAKE_WIN32_EXECUTABLE
  251. /variable/CMAKE_XCODE_ATTRIBUTE_an-attribute
  252. /variable/EXECUTABLE_OUTPUT_PATH
  253. /variable/LIBRARY_OUTPUT_PATH
  254. Variables for Languages
  255. =======================
  256. .. toctree::
  257. :maxdepth: 1
  258. /variable/CMAKE_COMPILER_IS_GNULANG
  259. /variable/CMAKE_C_COMPILE_FEATURES
  260. /variable/CMAKE_C_EXTENSIONS
  261. /variable/CMAKE_C_STANDARD
  262. /variable/CMAKE_C_STANDARD_REQUIRED
  263. /variable/CMAKE_CXX_COMPILE_FEATURES
  264. /variable/CMAKE_CXX_EXTENSIONS
  265. /variable/CMAKE_CXX_STANDARD
  266. /variable/CMAKE_CXX_STANDARD_REQUIRED
  267. /variable/CMAKE_Fortran_MODDIR_DEFAULT
  268. /variable/CMAKE_Fortran_MODDIR_FLAG
  269. /variable/CMAKE_Fortran_MODOUT_FLAG
  270. /variable/CMAKE_INTERNAL_PLATFORM_ABI
  271. /variable/CMAKE_LANG_ARCHIVE_APPEND
  272. /variable/CMAKE_LANG_ARCHIVE_CREATE
  273. /variable/CMAKE_LANG_ARCHIVE_FINISH
  274. /variable/CMAKE_LANG_COMPILE_OBJECT
  275. /variable/CMAKE_LANG_COMPILER_ABI
  276. /variable/CMAKE_LANG_COMPILER_ID
  277. /variable/CMAKE_LANG_COMPILER_LOADED
  278. /variable/CMAKE_LANG_COMPILER
  279. /variable/CMAKE_LANG_COMPILER_EXTERNAL_TOOLCHAIN
  280. /variable/CMAKE_LANG_COMPILER_TARGET
  281. /variable/CMAKE_LANG_COMPILER_VERSION
  282. /variable/CMAKE_LANG_CREATE_SHARED_LIBRARY
  283. /variable/CMAKE_LANG_CREATE_SHARED_MODULE
  284. /variable/CMAKE_LANG_CREATE_STATIC_LIBRARY
  285. /variable/CMAKE_LANG_FLAGS_DEBUG
  286. /variable/CMAKE_LANG_FLAGS_MINSIZEREL
  287. /variable/CMAKE_LANG_FLAGS_RELEASE
  288. /variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO
  289. /variable/CMAKE_LANG_FLAGS
  290. /variable/CMAKE_LANG_IGNORE_EXTENSIONS
  291. /variable/CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES
  292. /variable/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES
  293. /variable/CMAKE_LANG_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES
  294. /variable/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES
  295. /variable/CMAKE_LANG_LIBRARY_ARCHITECTURE
  296. /variable/CMAKE_LANG_LINKER_PREFERENCE_PROPAGATES
  297. /variable/CMAKE_LANG_LINKER_PREFERENCE
  298. /variable/CMAKE_LANG_LINK_EXECUTABLE
  299. /variable/CMAKE_LANG_OUTPUT_EXTENSION
  300. /variable/CMAKE_LANG_PLATFORM_ID
  301. /variable/CMAKE_LANG_SIMULATE_ID
  302. /variable/CMAKE_LANG_SIMULATE_VERSION
  303. /variable/CMAKE_LANG_SIZEOF_DATA_PTR
  304. /variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS
  305. /variable/CMAKE_USER_MAKE_RULES_OVERRIDE_LANG
  306. Variables for CTest
  307. ===================
  308. .. toctree::
  309. :maxdepth: 1
  310. /variable/CTEST_BINARY_DIRECTORY
  311. /variable/CTEST_BUILD_COMMAND
  312. /variable/CTEST_BUILD_NAME
  313. /variable/CTEST_BZR_COMMAND
  314. /variable/CTEST_BZR_UPDATE_OPTIONS
  315. /variable/CTEST_CHECKOUT_COMMAND
  316. /variable/CTEST_CONFIGURATION_TYPE
  317. /variable/CTEST_CONFIGURE_COMMAND
  318. /variable/CTEST_COVERAGE_COMMAND
  319. /variable/CTEST_COVERAGE_EXTRA_FLAGS
  320. /variable/CTEST_CURL_OPTIONS
  321. /variable/CTEST_CVS_CHECKOUT
  322. /variable/CTEST_CVS_COMMAND
  323. /variable/CTEST_CVS_UPDATE_OPTIONS
  324. /variable/CTEST_DROP_LOCATION
  325. /variable/CTEST_DROP_METHOD
  326. /variable/CTEST_DROP_SITE
  327. /variable/CTEST_DROP_SITE_CDASH
  328. /variable/CTEST_DROP_SITE_PASSWORD
  329. /variable/CTEST_DROP_SITE_USER
  330. /variable/CTEST_GIT_COMMAND
  331. /variable/CTEST_GIT_UPDATE_CUSTOM
  332. /variable/CTEST_GIT_UPDATE_OPTIONS
  333. /variable/CTEST_HG_COMMAND
  334. /variable/CTEST_HG_UPDATE_OPTIONS
  335. /variable/CTEST_MEMORYCHECK_COMMAND
  336. /variable/CTEST_MEMORYCHECK_COMMAND_OPTIONS
  337. /variable/CTEST_MEMORYCHECK_SANITIZER_OPTIONS
  338. /variable/CTEST_MEMORYCHECK_SUPPRESSIONS_FILE
  339. /variable/CTEST_MEMORYCHECK_TYPE
  340. /variable/CTEST_NIGHTLY_START_TIME
  341. /variable/CTEST_P4_CLIENT
  342. /variable/CTEST_P4_COMMAND
  343. /variable/CTEST_P4_OPTIONS
  344. /variable/CTEST_P4_UPDATE_OPTIONS
  345. /variable/CTEST_SCP_COMMAND
  346. /variable/CTEST_SITE
  347. /variable/CTEST_SOURCE_DIRECTORY
  348. /variable/CTEST_SVN_COMMAND
  349. /variable/CTEST_SVN_OPTIONS
  350. /variable/CTEST_SVN_UPDATE_OPTIONS
  351. /variable/CTEST_TEST_TIMEOUT
  352. /variable/CTEST_TRIGGER_SITE
  353. /variable/CTEST_UPDATE_COMMAND
  354. /variable/CTEST_UPDATE_OPTIONS
  355. /variable/CTEST_UPDATE_VERSION_ONLY
  356. /variable/CTEST_USE_LAUNCHERS
  357. Variables for CPack
  358. ===================
  359. .. toctree::
  360. :maxdepth: 1
  361. /variable/CPACK_ABSOLUTE_DESTINATION_FILES
  362. /variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY
  363. /variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION
  364. /variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY
  365. /variable/CPACK_INSTALL_SCRIPT
  366. /variable/CPACK_PACKAGING_INSTALL_PREFIX
  367. /variable/CPACK_SET_DESTDIR
  368. /variable/CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION