cmake-variables.7.rst 12 KB

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