cmDocumentVariables.cxx 70 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534
  1. #include "cmDocumentVariables.h"
  2. #include "cmake.h"
  3. void cmDocumentVariables::DefineVariables(cmake* cm)
  4. {
  5. // Subsection: variables defined by cmake, that give
  6. // information about the project, and cmake
  7. cm->DefineProperty
  8. ("CMAKE_AR", cmProperty::VARIABLE,
  9. "Name of archiving tool for static libraries.",
  10. "This specifies name of the program that creates archive "
  11. "or static libraries.",false,
  12. "Variables that Provide Information");
  13. cm->DefineProperty
  14. ("CMAKE_COMMAND", cmProperty::VARIABLE,
  15. "The full path to the cmake executable.",
  16. "This is the full path to the CMake executable cmake which is "
  17. "useful from custom commands that want to use the cmake -E "
  18. "option for portable system commands. "
  19. "(e.g. /usr/local/bin/cmake", false,
  20. "Variables that Provide Information");
  21. cm->DefineProperty
  22. ("CMAKE_BINARY_DIR", cmProperty::VARIABLE,
  23. "The path to the top level of the build tree.",
  24. "This is the full path to the top level of the current CMake "
  25. "build tree. For an in-source build, this would be the same "
  26. "as CMAKE_SOURCE_DIR. ", false,
  27. "Variables that Provide Information");
  28. cm->DefineProperty
  29. ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE,
  30. "The path to the top level of the source tree.",
  31. "This is the full path to the top level of the current CMake "
  32. "source tree. For an in-source build, this would be the same "
  33. "as CMAKE_BINARY_DIR. ", false,
  34. "Variables that Provide Information");
  35. cm->DefineProperty
  36. ("CMAKE_CURRENT_BINARY_DIR", cmProperty::VARIABLE,
  37. "The path to the binary directory currently being processed.",
  38. "This the full path to the build directory that is currently "
  39. "being processed by cmake. Each directory added by "
  40. "add_subdirectory will create a binary directory in the build "
  41. "tree, and as it is being processed this variable will be set. "
  42. "For in-source builds this is the current source directory "
  43. "being processed.", false,
  44. "Variables that Provide Information");
  45. cm->DefineProperty
  46. ("CMAKE_CURRENT_SOURCE_DIR", cmProperty::VARIABLE,
  47. "The path to the source directory currently being processed.",
  48. "This the full path to the source directory that is currently "
  49. "being processed by cmake. ", false,
  50. "Variables that Provide Information");
  51. cm->DefineProperty
  52. ("CMAKE_CURRENT_LIST_FILE", cmProperty::VARIABLE,
  53. "Full path to the listfile currently being processed.",
  54. "As CMake processes the listfiles in your project this "
  55. "variable will always be set to the one currently being "
  56. "processed. "
  57. "The value has dynamic scope. "
  58. "When CMake starts processing commands in a source file "
  59. "it sets this variable to the location of the file. "
  60. "When CMake finishes processing commands from the file it "
  61. "restores the previous value. "
  62. "Therefore the value of the variable inside a macro or "
  63. "function is the file invoking the bottom-most entry on "
  64. "the call stack, not the file containing the macro or "
  65. "function definition."
  66. "\n"
  67. "See also CMAKE_PARENT_LIST_FILE.",false,
  68. "Variables that Provide Information");
  69. cm->DefineProperty
  70. ("CMAKE_CURRENT_LIST_LINE", cmProperty::VARIABLE,
  71. "The line number of the current file being processed.",
  72. "This is the line number of the file currently being"
  73. " processed by cmake.", false,
  74. "Variables that Provide Information");
  75. cm->DefineProperty
  76. ("CMAKE_CURRENT_LIST_DIR", cmProperty::VARIABLE,
  77. "Full directory of the listfile currently being processed.",
  78. "As CMake processes the listfiles in your project this "
  79. "variable will always be set to the directory where the listfile which "
  80. "is currently being processed (CMAKE_CURRENT_LIST_FILE) is located. "
  81. "The value has dynamic scope. "
  82. "When CMake starts processing commands in a source file "
  83. "it sets this variable to the directory where this file is located. "
  84. "When CMake finishes processing commands from the file it "
  85. "restores the previous value. "
  86. "Therefore the value of the variable inside a macro or "
  87. "function is the directory of the file invoking the bottom-most entry on "
  88. "the call stack, not the directory of the file containing the macro or "
  89. "function definition."
  90. "\n"
  91. "See also CMAKE_CURRENT_LIST_FILE.",false,
  92. "Variables that Provide Information");
  93. cm->DefineProperty
  94. ("CMAKE_SCRIPT_MODE_FILE", cmProperty::VARIABLE,
  95. "Full path to the -P script file currently being processed. ",
  96. "When run in -P script mode, CMake sets this variable to the full "
  97. "path of the script file. When run to configure a CMakeLists.txt "
  98. "file, this variable is not set.", false,
  99. "Variables that Provide Information");
  100. cm->DefineProperty
  101. ("CMAKE_BUILD_TOOL", cmProperty::VARIABLE,
  102. "Tool used for the actual build process.",
  103. "This variable is set to the program that will be"
  104. " needed to build the output of CMake. If the "
  105. "generator selected was Visual Studio 6, the "
  106. "CMAKE_MAKE_PROGRAM will be set to msdev, for "
  107. "Unix makefiles it will be set to make or gmake, "
  108. "and for Visual Studio 7 it set to devenv. For "
  109. "Nmake Makefiles the value is nmake. This can be "
  110. "useful for adding special flags and commands based"
  111. " on the final build environment. ", false,
  112. "Variables that Provide Information");
  113. cm->DefineProperty
  114. ("CMAKE_CROSSCOMPILING", cmProperty::VARIABLE,
  115. "Is CMake currently cross compiling.",
  116. "This variable will be set to true by CMake if CMake is cross "
  117. "compiling. Specifically if the build platform is different "
  118. "from the target platform.", false,
  119. "Variables that Provide Information");
  120. cm->DefineProperty
  121. ("CMAKE_CACHEFILE_DIR", cmProperty::VARIABLE,
  122. "The directory with the CMakeCache.txt file.",
  123. "This is the full path to the directory that has the "
  124. "CMakeCache.txt file in it. This is the same as "
  125. "CMAKE_BINARY_DIR.", false,
  126. "Variables that Provide Information");
  127. cm->DefineProperty
  128. ("CMAKE_CACHE_MAJOR_VERSION", cmProperty::VARIABLE,
  129. "Major version of CMake used to create the CMakeCache.txt file",
  130. "This is stores the major version of CMake used to "
  131. "write a CMake cache file. It is only different when "
  132. "a different version of CMake is run on a previously "
  133. "created cache file.", false,
  134. "Variables that Provide Information");
  135. cm->DefineProperty
  136. ("CMAKE_CACHE_MINOR_VERSION", cmProperty::VARIABLE,
  137. "Minor version of CMake used to create the CMakeCache.txt file",
  138. "This is stores the minor version of CMake used to "
  139. "write a CMake cache file. It is only different when "
  140. "a different version of CMake is run on a previously "
  141. "created cache file.", false,
  142. "Variables that Provide Information");
  143. cm->DefineProperty
  144. ("CMAKE_CACHE_PATCH_VERSION", cmProperty::VARIABLE,
  145. "Patch version of CMake used to create the CMakeCache.txt file",
  146. "This is stores the patch version of CMake used to "
  147. "write a CMake cache file. It is only different when "
  148. "a different version of CMake is run on a previously "
  149. "created cache file.", false,
  150. "Variables that Provide Information");
  151. cm->DefineProperty
  152. ("CMAKE_CFG_INTDIR", cmProperty::VARIABLE,
  153. "Build-time reference to per-configuration output subdirectory.",
  154. "For native build systems supporting multiple configurations "
  155. "in the build tree (such as Visual Studio and Xcode), "
  156. "the value is a reference to a build-time variable specifying "
  157. "the name of the per-configuration output subdirectory. "
  158. "On Makefile generators this evaluates to \".\" because there "
  159. "is only one configuration in a build tree. "
  160. "Example values:\n"
  161. " $(IntDir) = Visual Studio 6\n"
  162. " $(OutDir) = Visual Studio 7, 8, 9\n"
  163. " $(Configuration) = Visual Studio 10\n"
  164. " $(CONFIGURATION) = Xcode\n"
  165. " . = Make-based tools\n"
  166. "Since these values are evaluated by the native build system, this "
  167. "variable is suitable only for use in command lines that will be "
  168. "evaluated at build time. "
  169. "Example of intended usage:\n"
  170. " add_executable(mytool mytool.c)\n"
  171. " add_custom_command(\n"
  172. " OUTPUT out.txt\n"
  173. " COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool\n"
  174. " ${CMAKE_CURRENT_SOURCE_DIR}/in.txt out.txt\n"
  175. " DEPENDS mytool in.txt\n"
  176. " )\n"
  177. " add_custom_target(drive ALL DEPENDS out.txt)\n"
  178. "Note that CMAKE_CFG_INTDIR is no longer necessary for this purpose "
  179. "but has been left for compatibility with existing projects. "
  180. "Instead add_custom_command() recognizes executable target names in "
  181. "its COMMAND option, so "
  182. "\"${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool\" can be "
  183. "replaced by just \"mytool\"."
  184. "\n"
  185. "This variable is read-only. Setting it is undefined behavior. "
  186. "In multi-configuration build systems the value of this variable "
  187. "is passed as the value of preprocessor symbol \"CMAKE_INTDIR\" to "
  188. "the compilation of all source files.",false,
  189. "Variables that Provide Information");
  190. cm->DefineProperty
  191. ("CMAKE_CTEST_COMMAND", cmProperty::VARIABLE,
  192. "Full path to ctest command installed with cmake.",
  193. "This is the full path to the CTest executable ctest "
  194. "which is useful from custom commands that want "
  195. " to use the cmake -E option for portable system "
  196. "commands.",false,
  197. "Variables that Provide Information");
  198. cm->DefineProperty
  199. ("CMAKE_DL_LIBS", cmProperty::VARIABLE,
  200. "Name of library containing dlopen and dlcose.",
  201. "The name of the library that has dlopen and "
  202. "dlclose in it, usually -ldl on most UNIX machines.",false,
  203. "Variables that Provide Information");
  204. cm->DefineProperty
  205. ("CMAKE_EDIT_COMMAND", cmProperty::VARIABLE,
  206. "Full path to cmake-gui or ccmake.",
  207. "This is the full path to the CMake executable "
  208. "that can graphically edit the cache. For example,"
  209. " cmake-gui, ccmake, or cmake -i.",false,
  210. "Variables that Provide Information");
  211. cm->DefineProperty
  212. ("CMAKE_GENERATOR", cmProperty::VARIABLE,
  213. "The generator used to build the project.",
  214. "The name of the generator that is being used to generate the "
  215. "build files. (e.g. \"Unix Makefiles\", "
  216. "\"Visual Studio 6\", etc.)",false,
  217. "Variables that Provide Information");
  218. cm->DefineProperty
  219. ("CMAKE_EXTRA_GENERATOR", cmProperty::VARIABLE,
  220. "The extra generator used to build the project.",
  221. "When using the Eclipse, CodeBlocks or KDevelop generators, CMake "
  222. "generates Makefiles (CMAKE_GENERATOR) and additionally project files "
  223. "for the respective IDE. This IDE project file generator is stored in "
  224. "CMAKE_EXTRA_GENERATOR (e.g. \"Eclipse CDT4\").",false,
  225. "Variables that Provide Information");
  226. cm->DefineProperty
  227. ("CMAKE_HOME_DIRECTORY", cmProperty::VARIABLE,
  228. "Path to top of source tree.",
  229. "This is the path to the top level of the source tree.",false,
  230. "Variables that Provide Information");
  231. cm->DefineProperty
  232. ("CMAKE_LINK_LIBRARY_SUFFIX", cmProperty::VARIABLE,
  233. "The suffix for libraries that you link to.",
  234. "The suffix to use for the end of a library, .lib on Windows.",false,
  235. "Variables that Provide Information");
  236. cm->DefineProperty
  237. ("CMAKE_EXECUTABLE_SUFFIX", cmProperty::VARIABLE,
  238. "The suffix for executables on this platform.",
  239. "The suffix to use for the end of an executable if any, "
  240. ".exe on Windows."
  241. "\n"
  242. "CMAKE_EXECUTABLE_SUFFIX_<LANG> overrides this for language <LANG>."
  243. ,false, "Variables that Provide Information");
  244. cm->DefineProperty
  245. ("CMAKE_MAJOR_VERSION", cmProperty::VARIABLE,
  246. "The Major version of cmake (i.e. the 2 in 2.X.X)",
  247. "This specifies the major version of the CMake executable"
  248. " being run.",false,
  249. "Variables that Provide Information");
  250. cm->DefineProperty
  251. ("CMAKE_MAKE_PROGRAM", cmProperty::VARIABLE,
  252. "See CMAKE_BUILD_TOOL.",
  253. "This variable is around for backwards compatibility, "
  254. "see CMAKE_BUILD_TOOL.",false,
  255. "Variables that Provide Information");
  256. cm->DefineProperty
  257. ("CMAKE_MINOR_VERSION", cmProperty::VARIABLE,
  258. "The Minor version of cmake (i.e. the 4 in X.4.X).",
  259. "This specifies the minor version of the CMake"
  260. " executable being run.",false,
  261. "Variables that Provide Information");
  262. cm->DefineProperty
  263. ("CMAKE_PATCH_VERSION", cmProperty::VARIABLE,
  264. "The patch version of cmake (i.e. the 3 in X.X.3).",
  265. "This specifies the patch version of the CMake"
  266. " executable being run.",false,
  267. "Variables that Provide Information");
  268. cm->DefineProperty
  269. ("CMAKE_TWEAK_VERSION", cmProperty::VARIABLE,
  270. "The tweak version of cmake (i.e. the 1 in X.X.X.1).",
  271. "This specifies the tweak version of the CMake executable being run. "
  272. "Releases use tweak < 20000000 and development versions use the date "
  273. "format CCYYMMDD for the tweak level."
  274. ,false, "Variables that Provide Information");
  275. cm->DefineProperty
  276. ("CMAKE_VERSION", cmProperty::VARIABLE,
  277. "The full version of cmake in major.minor.patch[.tweak[-id]] format.",
  278. "This specifies the full version of the CMake executable being run. "
  279. "This variable is defined by versions 2.6.3 and higher. "
  280. "See variables CMAKE_MAJOR_VERSION, CMAKE_MINOR_VERSION, "
  281. "CMAKE_PATCH_VERSION, and CMAKE_TWEAK_VERSION "
  282. "for individual version components. "
  283. "The [-id] component appears in non-release versions "
  284. "and may be arbitrary text.", false,
  285. "Variables that Provide Information");
  286. cm->DefineProperty
  287. ("CMAKE_PARENT_LIST_FILE", cmProperty::VARIABLE,
  288. "Full path to the parent listfile of the one currently being processed.",
  289. "As CMake processes the listfiles in your project this "
  290. "variable will always be set to the listfile that included "
  291. "or somehow invoked the one currently being "
  292. "processed. See also CMAKE_CURRENT_LIST_FILE.",false,
  293. "Variables that Provide Information");
  294. cm->DefineProperty
  295. ("CMAKE_PROJECT_NAME", cmProperty::VARIABLE,
  296. "The name of the current project.",
  297. "This specifies name of the current project from"
  298. " the closest inherited PROJECT command.",false,
  299. "Variables that Provide Information");
  300. cm->DefineProperty
  301. ("CMAKE_RANLIB", cmProperty::VARIABLE,
  302. "Name of randomizing tool for static libraries.",
  303. "This specifies name of the program that randomizes "
  304. "libraries on UNIX, not used on Windows, but may be present.",false,
  305. "Variables that Provide Information");
  306. cm->DefineProperty
  307. ("CMAKE_ROOT", cmProperty::VARIABLE,
  308. "Install directory for running cmake.",
  309. "This is the install root for the running CMake and"
  310. " the Modules directory can be found here. This is"
  311. " commonly used in this format: ${CMAKE_ROOT}/Modules",false,
  312. "Variables that Provide Information");
  313. cm->DefineProperty
  314. ("CMAKE_SIZEOF_VOID_P", cmProperty::VARIABLE,
  315. "Size of a void pointer.",
  316. "This is set to the size of a pointer on the machine, "
  317. "and is determined by a try compile. If a 64 bit size "
  318. "is found, then the library search path is modified to "
  319. "look for 64 bit libraries first.",false,
  320. "Variables that Provide Information");
  321. cm->DefineProperty
  322. ("CMAKE_SKIP_RPATH", cmProperty::VARIABLE,
  323. "If true, do not add run time path information.",
  324. "If this is set to TRUE, then the rpath information "
  325. "is not added to compiled executables. The default "
  326. "is to add rpath information if the platform supports it."
  327. "This allows for easy running from the build tree.",false,
  328. "Variables that Provide Information");
  329. cm->DefineProperty
  330. ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE,
  331. "Source directory for project.",
  332. "This is the top level source directory for the project. "
  333. "It corresponds to the source directory given to "
  334. "cmake-gui or ccmake.",false,
  335. "Variables that Provide Information");
  336. cm->DefineProperty
  337. ("CMAKE_STANDARD_LIBRARIES", cmProperty::VARIABLE,
  338. "Libraries linked into every executable and shared library.",
  339. "This is the list of libraries that are linked "
  340. "into all executables and libraries.",false,
  341. "Variables that Provide Information");
  342. cm->DefineProperty
  343. ("CMAKE_USING_VC_FREE_TOOLS", cmProperty::VARIABLE,
  344. "True if free visual studio tools being used.",
  345. "This is set to true if the compiler is Visual "
  346. "Studio free tools.",false,
  347. "Variables that Provide Information");
  348. cm->DefineProperty
  349. ("CMAKE_VERBOSE_MAKEFILE", cmProperty::VARIABLE,
  350. "Create verbose makefiles if on.",
  351. "This variable defaults to false. You can set "
  352. "this variable to true to make CMake produce verbose "
  353. "makefiles that show each command line as it is used.",false,
  354. "Variables that Provide Information");
  355. cm->DefineProperty
  356. ("PROJECT_BINARY_DIR", cmProperty::VARIABLE,
  357. "Full path to build directory for project.",
  358. "This is the binary directory of the most recent "
  359. "PROJECT command.",false,"Variables that Provide Information");
  360. cm->DefineProperty
  361. ("PROJECT_NAME", cmProperty::VARIABLE,
  362. "Name of the project given to the project command.",
  363. "This is the name given to the most "
  364. "recent PROJECT command. ",false,
  365. "Variables that Provide Information");
  366. cm->DefineProperty
  367. ("PROJECT_SOURCE_DIR", cmProperty::VARIABLE,
  368. "Top level source directory for the current project.",
  369. "This is the source directory of the most recent "
  370. "PROJECT command.",false,
  371. "Variables that Provide Information");
  372. cm->DefineProperty
  373. ("[Project name]_BINARY_DIR", cmProperty::VARIABLE,
  374. "Top level binary directory for the named project.",
  375. "A variable is created with the name used in the PROJECT "
  376. "command, and is the binary directory for the project. "
  377. " This can be useful when SUBDIR is used to connect "
  378. "several projects.",false,
  379. "Variables that Provide Information");
  380. cm->DefineProperty
  381. ("[Project name]_SOURCE_DIR", cmProperty::VARIABLE,
  382. "Top level source directory for the named project.",
  383. "A variable is created with the name used in the PROJECT "
  384. "command, and is the source directory for the project."
  385. " This can be useful when add_subdirectory "
  386. "is used to connect several projects.",false,
  387. "Variables that Provide Information");
  388. cm->DefineProperty
  389. ("CMAKE_IMPORT_LIBRARY_PREFIX", cmProperty::VARIABLE,
  390. "The prefix for import libraries that you link to.",
  391. "The prefix to use for the name of an import library if used "
  392. "on this platform."
  393. "\n"
  394. "CMAKE_IMPORT_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>."
  395. ,false, "Variables that Provide Information");
  396. cm->DefineProperty
  397. ("CMAKE_IMPORT_LIBRARY_SUFFIX", cmProperty::VARIABLE,
  398. "The suffix for import libraries that you link to.",
  399. "The suffix to use for the end of an import library if used "
  400. "on this platform."
  401. "\n"
  402. "CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>."
  403. ,false, "Variables that Provide Information");
  404. cm->DefineProperty
  405. ("CMAKE_SHARED_LIBRARY_PREFIX", cmProperty::VARIABLE,
  406. "The prefix for shared libraries that you link to.",
  407. "The prefix to use for the name of a shared library, lib on UNIX."
  408. "\n"
  409. "CMAKE_SHARED_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>."
  410. ,false, "Variables that Provide Information");
  411. cm->DefineProperty
  412. ("CMAKE_SHARED_LIBRARY_SUFFIX", cmProperty::VARIABLE,
  413. "The suffix for shared libraries that you link to.",
  414. "The suffix to use for the end of a shared library, .dll on Windows."
  415. "\n"
  416. "CMAKE_SHARED_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>."
  417. ,false, "Variables that Provide Information");
  418. cm->DefineProperty
  419. ("CMAKE_SHARED_MODULE_PREFIX", cmProperty::VARIABLE,
  420. "The prefix for loadable modules that you link to.",
  421. "The prefix to use for the name of a loadable module on this platform."
  422. "\n"
  423. "CMAKE_SHARED_MODULE_PREFIX_<LANG> overrides this for language <LANG>."
  424. ,false, "Variables that Provide Information");
  425. cm->DefineProperty
  426. ("CMAKE_SHARED_MODULE_SUFFIX", cmProperty::VARIABLE,
  427. "The suffix for shared libraries that you link to.",
  428. "The suffix to use for the end of a loadable module on this platform"
  429. "\n"
  430. "CMAKE_SHARED_MODULE_SUFFIX_<LANG> overrides this for language <LANG>."
  431. ,false, "Variables that Provide Information");
  432. cm->DefineProperty
  433. ("CMAKE_STATIC_LIBRARY_PREFIX", cmProperty::VARIABLE,
  434. "The prefix for static libraries that you link to.",
  435. "The prefix to use for the name of a static library, lib on UNIX."
  436. "\n"
  437. "CMAKE_STATIC_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>."
  438. ,false, "Variables that Provide Information");
  439. cm->DefineProperty
  440. ("CMAKE_STATIC_LIBRARY_SUFFIX", cmProperty::VARIABLE,
  441. "The suffix for static libraries that you link to.",
  442. "The suffix to use for the end of a static library, .lib on Windows."
  443. "\n"
  444. "CMAKE_STATIC_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>."
  445. ,false, "Variables that Provide Information");
  446. cm->DefineProperty
  447. ("CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES", cmProperty::VARIABLE,
  448. "Additional suffixes for shared libraries.",
  449. "Extensions for shared libraries other than that specified by "
  450. "CMAKE_SHARED_LIBRARY_SUFFIX, if any. "
  451. "CMake uses this to recognize external shared library files during "
  452. "analysis of libraries linked by a target.",
  453. false,
  454. "Variables that Provide Information");
  455. // Variables defined by cmake, that change the behavior
  456. // of cmake
  457. cm->DefineProperty
  458. ("CMAKE_POLICY_DEFAULT_CMP<NNNN>", cmProperty::VARIABLE,
  459. "Default for CMake Policy CMP<NNNN> when it is otherwise left unset.",
  460. "Commands cmake_minimum_required(VERSION) and cmake_policy(VERSION) "
  461. "by default leave policies introduced after the given version unset. "
  462. "Set CMAKE_POLICY_DEFAULT_CMP<NNNN> to OLD or NEW to specify the "
  463. "default for policy CMP<NNNN>, where <NNNN> is the policy number."
  464. "\n"
  465. "This variable should not be set by a project in CMake code; "
  466. "use cmake_policy(SET) instead. "
  467. "Users running CMake may set this variable in the cache "
  468. "(e.g. -DCMAKE_POLICY_DEFAULT_CMP<NNNN>=<OLD|NEW>) "
  469. "to set a policy not otherwise set by the project. "
  470. "Set to OLD to quiet a policy warning while using old behavior "
  471. "or to NEW to try building the project with new behavior.",
  472. false,
  473. "Variables That Change Behavior");
  474. cm->DefineProperty
  475. ("CMAKE_FIND_LIBRARY_PREFIXES", cmProperty::VARIABLE,
  476. "Prefixes to prepend when looking for libraries.",
  477. "This specifies what prefixes to add to library names when "
  478. "the find_library command looks for libraries. On UNIX "
  479. "systems this is typically lib, meaning that when trying "
  480. "to find the foo library it will look for libfoo.",
  481. false,
  482. "Variables That Change Behavior");
  483. cm->DefineProperty
  484. ("CMAKE_FIND_LIBRARY_SUFFIXES", cmProperty::VARIABLE,
  485. "Suffixes to append when looking for libraries.",
  486. "This specifies what suffixes to add to library names when "
  487. "the find_library command looks for libraries. On Windows "
  488. "systems this is typically .lib and .dll, meaning that when trying "
  489. "to find the foo library it will look for foo.dll etc.",
  490. false,
  491. "Variables That Change Behavior");
  492. cm->DefineProperty
  493. ("CMAKE_CONFIGURATION_TYPES", cmProperty::VARIABLE,
  494. "Specifies the available build types.",
  495. "This specifies what build types will be available such as "
  496. "Debug, Release, RelWithDebInfo etc. This has reasonable defaults "
  497. "on most platforms. But can be extended to provide other "
  498. "build types. See also CMAKE_BUILD_TYPE.",
  499. false,
  500. "Variables That Change Behavior");
  501. cm->DefineProperty
  502. ("CMAKE_BUILD_TYPE", cmProperty::VARIABLE,
  503. "Specifies the build type for make based generators.",
  504. "This specifies what build type will be built in this tree. "
  505. " Possible values are empty, Debug, Release, RelWithDebInfo"
  506. " and MinSizeRel. This variable is only supported for "
  507. "make based generators. If this variable is supported, "
  508. "then CMake will also provide initial values for the "
  509. "variables with the name "
  510. " CMAKE_C_FLAGS_[Debug|Release|RelWithDebInfo|MinSizeRel]."
  511. " For example, if CMAKE_BUILD_TYPE is Debug, then "
  512. "CMAKE_C_FLAGS_DEBUG will be added to the CMAKE_C_FLAGS.",false,
  513. "Variables That Change Behavior");
  514. cm->DefineProperty
  515. ("CMAKE_BACKWARDS_COMPATIBILITY", cmProperty::VARIABLE,
  516. "Version of cmake required to build project",
  517. "From the point of view of backwards compatibility, this "
  518. "specifies what version of CMake should be supported. By "
  519. "default this value is the version number of CMake that "
  520. "you are running. You can set this to an older version of"
  521. " CMake to support deprecated commands of CMake in projects"
  522. " that were written to use older versions of CMake. This "
  523. "can be set by the user or set at the beginning of a "
  524. "CMakeLists file.",false,
  525. "Variables That Change Behavior");
  526. cm->DefineProperty
  527. ("CMAKE_INSTALL_PREFIX", cmProperty::VARIABLE,
  528. "Install directory used by install.",
  529. "If \"make install\" is invoked or INSTALL is built"
  530. ", this directory is pre-pended onto all install "
  531. "directories. This variable defaults to /usr/local"
  532. " on UNIX and c:/Program Files on Windows.",false,
  533. "Variables That Change Behavior");
  534. cm->DefineProperty
  535. ("CMAKE_SKIP_INSTALL_ALL_DEPENDENCY", cmProperty::VARIABLE,
  536. "Don't make the install target depend on the all target.",
  537. "By default, the \"install\" target depends on the \"all\" target. "
  538. "This has the effect, that when \"make install\" is invoked or INSTALL "
  539. "is built, first the \"all\" target is built, then the installation "
  540. "starts. "
  541. "If CMAKE_SKIP_INSTALL_ALL_DEPENDENCY is set to TRUE, this dependency "
  542. "is not created, so the installation process will start immediately, "
  543. "independent from whether the project has been completely built or not."
  544. ,false,
  545. "Variables That Change Behavior");
  546. cm->DefineProperty
  547. ("CMAKE_MODULE_PATH", cmProperty::VARIABLE,
  548. "List of directories to search for CMake modules.",
  549. "Commands like include() and find_package() search for files in "
  550. "directories listed by this variable before checking the default "
  551. "modules that come with CMake.",
  552. false,
  553. "Variables That Change Behavior");
  554. cm->DefineProperty
  555. ("CMAKE_PREFIX_PATH", cmProperty::VARIABLE,
  556. "Path used for searching by FIND_XXX(), with appropriate suffixes added.",
  557. "Specifies a path which will be used by the FIND_XXX() commands. It "
  558. "contains the \"base\" directories, the FIND_XXX() commands append "
  559. "appropriate subdirectories to the base directories. So FIND_PROGRAM() "
  560. "adds /bin to each of the directories in the path, FIND_LIBRARY() "
  561. "appends /lib to each of the directories, and FIND_PATH() and "
  562. "FIND_FILE() append /include . By default it is empty, it is intended "
  563. "to be set by the project. See also CMAKE_SYSTEM_PREFIX_PATH, "
  564. "CMAKE_INCLUDE_PATH, CMAKE_LIBRARY_PATH, CMAKE_PROGRAM_PATH.", false,
  565. "Variables That Change Behavior");
  566. cm->DefineProperty
  567. ("CMAKE_INCLUDE_PATH", cmProperty::VARIABLE,
  568. "Path used for searching by FIND_FILE() and FIND_PATH().",
  569. "Specifies a path which will be used both by FIND_FILE() and "
  570. "FIND_PATH(). Both commands will check each of the contained directories "
  571. "for the existence of the file which is currently searched. By default "
  572. "it is empty, it is intended to be set by the project. See also "
  573. "CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_PREFIX_PATH.", false,
  574. "Variables That Change Behavior");
  575. cm->DefineProperty
  576. ("CMAKE_LIBRARY_PATH", cmProperty::VARIABLE,
  577. "Path used for searching by FIND_LIBRARY().",
  578. "Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() "
  579. "will check each of the contained directories for the existence of the "
  580. "library which is currently searched. By default it is empty, it is "
  581. "intended to be set by the project. See also CMAKE_SYSTEM_LIBRARY_PATH, "
  582. "CMAKE_PREFIX_PATH.", false,
  583. "Variables That Change Behavior");
  584. cm->DefineProperty
  585. ("CMAKE_PROGRAM_PATH", cmProperty::VARIABLE,
  586. "Path used for searching by FIND_PROGRAM().",
  587. "Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() "
  588. "will check each of the contained directories for the existence of the "
  589. "program which is currently searched. By default it is empty, it is "
  590. "intended to be set by the project. See also CMAKE_SYSTEM_PROGRAM_PATH, "
  591. " CMAKE_PREFIX_PATH.", false,
  592. "Variables That Change Behavior");
  593. cm->DefineProperty
  594. ("CMAKE_SYSTEM_PREFIX_PATH", cmProperty::VARIABLE,
  595. "Path used for searching by FIND_XXX(), with appropriate suffixes added.",
  596. "Specifies a path which will be used by the FIND_XXX() commands. It "
  597. "contains the \"base\" directories, the FIND_XXX() commands append "
  598. "appropriate subdirectories to the base directories. So FIND_PROGRAM() "
  599. "adds /bin to each of the directories in the path, FIND_LIBRARY() "
  600. "appends /lib to each of the directories, and FIND_PATH() and "
  601. "FIND_FILE() append /include . By default this contains the standard "
  602. "directories for the current system. It is NOT intended "
  603. "to be modified by the project, use CMAKE_PREFIX_PATH for this. See also "
  604. "CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_SYSTEM_LIBRARY_PATH, "
  605. "CMAKE_SYSTEM_PROGRAM_PATH, and CMAKE_SYSTEM_IGNORE_PATH.", false,
  606. "Variables That Change Behavior");
  607. cm->DefineProperty
  608. ("CMAKE_SYSTEM_IGNORE_PATH", cmProperty::VARIABLE,
  609. "Path to be ignored by FIND_XXX() commands.",
  610. "Specifies directories to be ignored by searches in FIND_XXX() commands "
  611. "This is useful in cross-compiled environments where some system "
  612. "directories contain incompatible but possibly linkable libraries. For "
  613. "example, on cross-compiled cluster environments, this allows a user to "
  614. "ignore directories containing libraries meant for the front-end "
  615. "machine that modules like FindX11 (and others) would normally search. "
  616. "By default this contains a list of directories containing incompatible "
  617. "binaries for the host system. "
  618. "See also CMAKE_SYSTEM_PREFIX_PATH, CMAKE_SYSTEM_LIBRARY_PATH, "
  619. "CMAKE_SYSTEM_INCLUDE_PATH, and CMAKE_SYSTEM_PROGRAM_PATH.", false,
  620. "Variables That Change Behavior");
  621. cm->DefineProperty
  622. ("CMAKE_IGNORE_PATH", cmProperty::VARIABLE,
  623. "Path to be ignored by FIND_XXX() commands.",
  624. "Specifies directories to be ignored by searches in FIND_XXX() commands "
  625. "This is useful in cross-compiled environments where some system "
  626. "directories contain incompatible but possibly linkable libraries. For "
  627. "example, on cross-compiled cluster environments, this allows a user to "
  628. "ignore directories containing libraries meant for the front-end "
  629. "machine that modules like FindX11 (and others) would normally search. "
  630. "By default this is empty; it is intended to be set by the project. "
  631. "Note that CMAKE_IGNORE_PATH takes a list of directory names, NOT a "
  632. "list of prefixes. If you want to ignore paths under prefixes (bin, "
  633. "include, lib, etc.), you'll need to specify them explicitly. "
  634. "See also CMAKE_PREFIX_PATH, CMAKE_LIBRARY_PATH, CMAKE_INCLUDE_PATH, "
  635. "CMAKE_PROGRAM_PATH.", false,
  636. "Variables That Change Behavior");
  637. cm->DefineProperty
  638. ("CMAKE_SYSTEM_INCLUDE_PATH", cmProperty::VARIABLE,
  639. "Path used for searching by FIND_FILE() and FIND_PATH().",
  640. "Specifies a path which will be used both by FIND_FILE() and "
  641. "FIND_PATH(). Both commands will check each of the contained directories "
  642. "for the existence of the file which is currently searched. By default "
  643. "it contains the standard directories for the current system. It is "
  644. "NOT intended to be modified by the project, use CMAKE_INCLUDE_PATH "
  645. "for this. See also CMAKE_SYSTEM_PREFIX_PATH.", false,
  646. "Variables That Change Behavior");
  647. cm->DefineProperty
  648. ("CMAKE_SYSTEM_LIBRARY_PATH", cmProperty::VARIABLE,
  649. "Path used for searching by FIND_LIBRARY().",
  650. "Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() "
  651. "will check each of the contained directories for the existence of the "
  652. "library which is currently searched. By default it contains the "
  653. "standard directories for the current system. It is NOT intended to be "
  654. "modified by the project, use CMAKE_LIBRARY_PATH for this. See "
  655. "also CMAKE_SYSTEM_PREFIX_PATH.", false,
  656. "Variables That Change Behavior");
  657. cm->DefineProperty
  658. ("CMAKE_SYSTEM_PROGRAM_PATH", cmProperty::VARIABLE,
  659. "Path used for searching by FIND_PROGRAM().",
  660. "Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() "
  661. "will check each of the contained directories for the existence of the "
  662. "program which is currently searched. By default it contains the "
  663. "standard directories for the current system. It is NOT intended to be "
  664. "modified by the project, use CMAKE_PROGRAM_PATH for this. See also "
  665. "CMAKE_SYSTEM_PREFIX_PATH.", false,
  666. "Variables That Change Behavior");
  667. cm->DefineProperty
  668. ("CMAKE_USER_MAKE_RULES_OVERRIDE", cmProperty::VARIABLE,
  669. "Specify a CMake file that overrides platform information.",
  670. "CMake loads the specified file while enabling support for each "
  671. "language from either the project() or enable_language() commands. "
  672. "It is loaded after CMake's builtin compiler and platform information "
  673. "modules have been loaded but before the information is used. "
  674. "The file may set platform information variables to override CMake's "
  675. "defaults."
  676. "\n"
  677. "This feature is intended for use only in overriding information "
  678. "variables that must be set before CMake builds its first test "
  679. "project to check that the compiler for a language works. "
  680. "It should not be used to load a file in cases that a normal include() "
  681. "will work. "
  682. "Use it only as a last resort for behavior that cannot be achieved "
  683. "any other way. "
  684. "For example, one may set CMAKE_C_FLAGS_INIT to change the default "
  685. "value used to initialize CMAKE_C_FLAGS before it is cached. "
  686. "The override file should NOT be used to set anything that could "
  687. "be set after languages are enabled, such as variables like "
  688. "CMAKE_RUNTIME_OUTPUT_DIRECTORY that affect the placement of binaries. "
  689. "Information set in the file will be used for try_compile and try_run "
  690. "builds too."
  691. ,false,
  692. "Variables That Change Behavior");
  693. cm->DefineProperty
  694. ("BUILD_SHARED_LIBS", cmProperty::VARIABLE,
  695. "Global flag to cause add_library to create shared libraries if on.",
  696. "If present and true, this will cause all libraries to be "
  697. "built shared unless the library was explicitly added as a "
  698. "static library. This variable is often added to projects "
  699. "as an OPTION so that each user of a project can decide if "
  700. "they want to build the project using shared or static "
  701. "libraries.",false,
  702. "Variables That Change Behavior");
  703. cm->DefineProperty
  704. ("CMAKE_NOT_USING_CONFIG_FLAGS", cmProperty::VARIABLE,
  705. "Skip _BUILD_TYPE flags if true.",
  706. "This is an internal flag used by the generators in "
  707. "CMake to tell CMake to skip the _BUILD_TYPE flags.",false,
  708. "Variables That Change Behavior");
  709. cm->DefineProperty
  710. ("CMAKE_MFC_FLAG", cmProperty::VARIABLE,
  711. "Tell cmake to use MFC for an executable or dll.",
  712. "This can be set in a CMakeLists.txt file and will "
  713. "enable MFC in the application. It should be set "
  714. "to 1 for static the static MFC library, and 2 for "
  715. "the shared MFC library. This is used in visual "
  716. "studio 6 and 7 project files. The CMakeSetup "
  717. "dialog used MFC and the CMakeLists.txt looks like this:\n"
  718. "add_definitions(-D_AFXDLL)\n"
  719. "set(CMAKE_MFC_FLAG 2)\n"
  720. "add_executable(CMakeSetup WIN32 ${SRCS})\n",false,
  721. "Variables That Change Behavior");
  722. cm->DefineProperty
  723. ("CMAKE_COLOR_MAKEFILE", cmProperty::VARIABLE,
  724. "Enables color output when using the Makefile generator.",
  725. "When enabled, the generated Makefiles will produce colored output. "
  726. "Default is ON.",false,
  727. "Variables That Change Behavior");
  728. // Variables defined by CMake that describe the system
  729. cm->DefineProperty
  730. ("CMAKE_SYSTEM", cmProperty::VARIABLE,
  731. "Name of system cmake is compiling for.",
  732. "This variable is the composite of CMAKE_SYSTEM_NAME "
  733. "and CMAKE_SYSTEM_VERSION, like this "
  734. "${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}. "
  735. "If CMAKE_SYSTEM_VERSION is not set, then "
  736. "CMAKE_SYSTEM is the same as CMAKE_SYSTEM_NAME.",false,
  737. "Variables That Describe the System");
  738. cm->DefineProperty
  739. ("CMAKE_SYSTEM_NAME", cmProperty::VARIABLE,
  740. "Name of the OS CMake is building for.",
  741. "This is the name of the operating system on "
  742. "which CMake is targeting. On systems that "
  743. "have the uname command, this variable is set "
  744. "to the output of uname -s. Linux, Windows, "
  745. " and Darwin for Mac OSX are the values found "
  746. " on the big three operating systems." ,false,
  747. "Variables That Describe the System");
  748. cm->DefineProperty
  749. ("CMAKE_SYSTEM_PROCESSOR", cmProperty::VARIABLE,
  750. "The name of the CPU CMake is building for.",
  751. "On systems that support uname, this variable is "
  752. "set to the output of uname -p, on windows it is "
  753. "set to the value of the environment variable "
  754. "PROCESSOR_ARCHITECTURE",false,
  755. "Variables That Describe the System");
  756. cm->DefineProperty
  757. ("CMAKE_SYSTEM_VERSION", cmProperty::VARIABLE,
  758. "OS version CMake is building for.",
  759. "A numeric version string for the system, on "
  760. "systems that support uname, this variable is "
  761. "set to the output of uname -r. On other "
  762. "systems this is set to major-minor version numbers.",false,
  763. "Variables That Describe the System");
  764. cm->DefineProperty
  765. ("CMAKE_HOST_SYSTEM", cmProperty::VARIABLE,
  766. "Name of system cmake is being run on.",
  767. "The same as CMAKE_SYSTEM but for the host system instead "
  768. "of the target system when cross compiling.",false,
  769. "Variables That Describe the System");
  770. cm->DefineProperty
  771. ("CMAKE_HOST_SYSTEM_NAME", cmProperty::VARIABLE,
  772. "Name of the OS CMake is running on.",
  773. "The same as CMAKE_SYSTEM_NAME but for the host system instead "
  774. "of the target system when cross compiling.",false,
  775. "Variables That Describe the System");
  776. cm->DefineProperty
  777. ("CMAKE_HOST_SYSTEM_PROCESSOR", cmProperty::VARIABLE,
  778. "The name of the CPU CMake is running on.",
  779. "The same as CMAKE_SYSTEM_PROCESSOR but for the host system instead "
  780. "of the target system when cross compiling.",false,
  781. "Variables That Describe the System");
  782. cm->DefineProperty
  783. ("CMAKE_HOST_SYSTEM_VERSION", cmProperty::VARIABLE,
  784. "OS version CMake is running on.",
  785. "The same as CMAKE_SYSTEM_VERSION but for the host system instead "
  786. "of the target system when cross compiling.",false,
  787. "Variables That Describe the System");
  788. cm->DefineProperty
  789. ("APPLE", cmProperty::VARIABLE,
  790. "True if running on Mac OSX.",
  791. "Set to true on Mac OSX.",false,
  792. "Variables That Describe the System");
  793. cm->DefineProperty
  794. ("BORLAND", cmProperty::VARIABLE,
  795. "True of the borland compiler is being used.",
  796. "This is set to true if the Borland compiler is being used.",false,
  797. "Variables That Describe the System");
  798. cm->DefineProperty
  799. ("CYGWIN", cmProperty::VARIABLE,
  800. "True for cygwin.",
  801. "Set to true when using CYGWIN.",false,
  802. "Variables That Describe the System");
  803. cm->DefineProperty
  804. ("MSVC", cmProperty::VARIABLE,
  805. "True when using Microsoft Visual C",
  806. "Set to true when the compiler is some version of Microsoft Visual C.",
  807. false,
  808. "Variables That Describe the System");
  809. cm->DefineProperty
  810. ("MSVC80", cmProperty::VARIABLE,
  811. "True when using Microsoft Visual C 8.0",
  812. "Set to true when the compiler is version 8.0 of Microsoft Visual C.",
  813. false,
  814. "Variables That Describe the System");
  815. cm->DefineProperty
  816. ("MSVC_IDE", cmProperty::VARIABLE,
  817. "True when using the Microsoft Visual C IDE",
  818. "Set to true when the target platform is the Microsoft Visual C IDE, "
  819. "as opposed to the command line compiler.",
  820. false,
  821. "Variables That Describe the System");
  822. cm->DefineProperty
  823. ("MSVC_VERSION", cmProperty::VARIABLE,
  824. "The version of Microsoft Visual C/C++ being used if any.",
  825. "Known version numbers are:\n"
  826. " 1200 = VS 6.0\n"
  827. " 1300 = VS 7.0\n"
  828. " 1310 = VS 7.1\n"
  829. " 1400 = VS 8.0\n"
  830. " 1500 = VS 9.0\n"
  831. " 1600 = VS 10.0\n"
  832. "",
  833. false,
  834. "Variables That Describe the System");
  835. cm->DefineProperty
  836. ("CMAKE_CL_64", cmProperty::VARIABLE,
  837. "Using the 64 bit compiler from Microsoft",
  838. "Set to true when using the 64 bit cl compiler from Microsoft.",
  839. false,
  840. "Variables That Describe the System");
  841. cm->DefineProperty
  842. ("CMAKE_COMPILER_2005", cmProperty::VARIABLE,
  843. "Using the Visual Studio 2005 compiler from Microsoft",
  844. "Set to true when using the Visual Studio 2005 compiler "
  845. "from Microsoft.",
  846. false,
  847. "Variables That Describe the System");
  848. cm->DefineProperty
  849. ("UNIX", cmProperty::VARIABLE,
  850. "True for UNIX and UNIX like operating systems.",
  851. "Set to true when the target system is UNIX or UNIX like "
  852. "(i.e. APPLE and CYGWIN).",false,
  853. "Variables That Describe the System");
  854. cm->DefineProperty
  855. ("WIN32", cmProperty::VARIABLE,
  856. "True on windows systems, including win64.",
  857. "Set to true when the target system is Windows and on cygwin.",false,
  858. "Variables That Describe the System");
  859. cm->DefineProperty
  860. ("XCODE_VERSION", cmProperty::VARIABLE,
  861. "Version of Xcode (Xcode generator only).",
  862. "Under the Xcode generator, this is the version of Xcode as specified in "
  863. "\"Xcode.app/Contents/version.plist\" (such as \"3.1.2\").",false,
  864. "Variables That Describe the System");
  865. cm->DefineProperty
  866. ("CMAKE_HOST_APPLE", cmProperty::VARIABLE,
  867. "True for Apple OSXoperating systems.",
  868. "Set to true when the host system is Apple OSX.",
  869. false,
  870. "Variables That Describe the System");
  871. cm->DefineProperty
  872. ("CMAKE_HOST_UNIX", cmProperty::VARIABLE,
  873. "True for UNIX and UNIX like operating systems.",
  874. "Set to true when the host system is UNIX or UNIX like "
  875. "(i.e. APPLE and CYGWIN).",false,
  876. "Variables That Describe the System");
  877. cm->DefineProperty
  878. ("CMAKE_HOST_WIN32", cmProperty::VARIABLE,
  879. "True on windows systems, including win64.",
  880. "Set to true when the host system is Windows and on cygwin.",false,
  881. "Variables That Describe the System");
  882. cm->DefineProperty
  883. ("CMAKE_OBJECT_PATH_MAX", cmProperty::VARIABLE,
  884. "Maximum object file full-path length allowed by native build tools.",
  885. "CMake computes for every source file an object file name that is "
  886. "unique to the source file and deterministic with respect to the "
  887. "full path to the source file. "
  888. "This allows multiple source files in a target to share the same name "
  889. "if they lie in different directories without rebuilding when one is "
  890. "added or removed. "
  891. "However, it can produce long full paths in a few cases, so CMake "
  892. "shortens the path using a hashing scheme when the full path to an "
  893. "object file exceeds a limit. "
  894. "CMake has a built-in limit for each platform that is sufficient for "
  895. "common tools, but some native tools may have a lower limit. "
  896. "This variable may be set to specify the limit explicitly. "
  897. "The value must be an integer no less than 128.",false,
  898. "Variables That Describe the System");
  899. // Variables that affect the building of object files and
  900. // targets.
  901. //
  902. cm->DefineProperty
  903. ("CMAKE_INCLUDE_CURRENT_DIR", cmProperty::VARIABLE,
  904. "Automatically add the current source- and build directories "
  905. "to the include path.",
  906. "If this variable is enabled, CMake automatically adds in each "
  907. "directory ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} "
  908. "to the include path for this directory. These additional include "
  909. "directories do not propagate down to subdirectories. This is useful "
  910. "mainly for out-of-source builds, where files generated into the "
  911. "build tree are included by files located in the source tree.\n"
  912. "By default CMAKE_INCLUDE_CURRENT_DIR is OFF.",
  913. false,
  914. "Variables that Control the Build");
  915. cm->DefineProperty
  916. ("CMAKE_INSTALL_RPATH", cmProperty::VARIABLE,
  917. "The rpath to use for installed targets.",
  918. "A semicolon-separated list specifying the rpath "
  919. "to use in installed targets (for platforms that support it). "
  920. "This is used to initialize the target property "
  921. "INSTALL_RPATH for all targets.",
  922. false,
  923. "Variables that Control the Build");
  924. cm->DefineProperty
  925. ("CMAKE_INSTALL_RPATH_USE_LINK_PATH", cmProperty::VARIABLE,
  926. "Add paths to linker search and installed rpath.",
  927. "CMAKE_INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true "
  928. "will append directories in the linker search path and outside the "
  929. "project to the INSTALL_RPATH. "
  930. "This is used to initialize the target property "
  931. "INSTALL_RPATH_USE_LINK_PATH for all targets.",
  932. false,
  933. "Variables that Control the Build");
  934. cm->DefineProperty
  935. ("CMAKE_INSTALL_NAME_DIR", cmProperty::VARIABLE,
  936. "Mac OSX directory name for installed targets.",
  937. "CMAKE_INSTALL_NAME_DIR is used to initialize the "
  938. "INSTALL_NAME_DIR property on all targets. See that target "
  939. "property for more information.",
  940. false,
  941. "Variables that Control the Build");
  942. cm->DefineProperty
  943. ("CMAKE_Fortran_MODULE_DIRECTORY", cmProperty::VARIABLE,
  944. "Fortran module output directory.",
  945. "This variable is used to initialize the "
  946. "Fortran_MODULE_DIRECTORY property on all the targets. "
  947. "See that target property for additional information.",
  948. false,
  949. "Variables that Control the Build");
  950. cm->DefineProperty
  951. ("CMAKE_LIBRARY_OUTPUT_DIRECTORY", cmProperty::VARIABLE,
  952. "Where to put all the LIBRARY targets when built.",
  953. "This variable is used to initialize the "
  954. "LIBRARY_OUTPUT_DIRECTORY property on all the targets. "
  955. "See that target property for additional information.",
  956. false,
  957. "Variables that Control the Build");
  958. cm->DefineProperty
  959. ("CMAKE_ARCHIVE_OUTPUT_DIRECTORY", cmProperty::VARIABLE,
  960. "Where to put all the ARCHIVE targets when built.",
  961. "This variable is used to initialize the "
  962. "ARCHIVE_OUTPUT_DIRECTORY property on all the targets. "
  963. "See that target property for additional information.",
  964. false,
  965. "Variables that Control the Build");
  966. cm->DefineProperty
  967. ("CMAKE_RUNTIME_OUTPUT_DIRECTORY", cmProperty::VARIABLE,
  968. "Where to put all the RUNTIME targets when built.",
  969. "This variable is used to initialize the "
  970. "RUNTIME_OUTPUT_DIRECTORY property on all the targets. "
  971. "See that target property for additional information.",
  972. false,
  973. "Variables that Control the Build");
  974. cm->DefineProperty
  975. ("CMAKE_DEBUG_POSTFIX", cmProperty::VARIABLE,
  976. "See variable CMAKE_<CONFIG>_POSTFIX.",
  977. "This variable is a special case of the more-general "
  978. "CMAKE_<CONFIG>_POSTFIX variable for the DEBUG configuration.",
  979. false,
  980. "Variables that Control the Build");
  981. cm->DefineProperty
  982. ("CMAKE_<CONFIG>_POSTFIX", cmProperty::VARIABLE,
  983. "Default filename postfix for libraries under configuration <CONFIG>.",
  984. "When a non-executable target is created its <CONFIG>_POSTFIX "
  985. "target property is initialized with the value of this variable "
  986. "if it is set.",
  987. false,
  988. "Variables that Control the Build");
  989. cm->DefineProperty
  990. ("CMAKE_BUILD_WITH_INSTALL_RPATH", cmProperty::VARIABLE,
  991. "Use the install path for the RPATH",
  992. "Normally CMake uses the build tree for the RPATH when building "
  993. "executables etc on systems that use RPATH. When the software "
  994. "is installed the executables etc are relinked by CMake to have "
  995. "the install RPATH. If this variable is set to true then the software "
  996. "is always built with the install path for the RPATH and does not "
  997. "need to be relinked when installed.",false,
  998. "Variables that Control the Build");
  999. cm->DefineProperty
  1000. ("CMAKE_NO_BUILTIN_CHRPATH", cmProperty::VARIABLE,
  1001. "Do not use the builtin ELF editor to fix RPATHs on installation.",
  1002. "When an ELF binary needs to have a different RPATH after installation "
  1003. "than it does in the build tree, CMake uses a builtin editor to change "
  1004. "the RPATH in the installed copy. "
  1005. "If this variable is set to true then CMake will relink the binary "
  1006. "before installation instead of using its builtin editor.",false,
  1007. "Variables that Control the Build");
  1008. cm->DefineProperty
  1009. ("CMAKE_SKIP_BUILD_RPATH", cmProperty::VARIABLE,
  1010. "Do not include RPATHs in the build tree.",
  1011. "Normally CMake uses the build tree for the RPATH when building "
  1012. "executables etc on systems that use RPATH. When the software "
  1013. "is installed the executables etc are relinked by CMake to have "
  1014. "the install RPATH. If this variable is set to true then the software "
  1015. "is always built with no RPATH.",false,
  1016. "Variables that Control the Build");
  1017. cm->DefineProperty
  1018. ("CMAKE_EXE_LINKER_FLAGS", cmProperty::VARIABLE,
  1019. "Linker flags used to create executables.",
  1020. "Flags used by the linker when creating an executable.",false,
  1021. "Variables that Control the Build");
  1022. cm->DefineProperty
  1023. ("CMAKE_EXE_LINKER_FLAGS_[CMAKE_BUILD_TYPE]", cmProperty::VARIABLE,
  1024. "Flag used when linking an executable.",
  1025. "Same as CMAKE_C_FLAGS_* but used by the linker "
  1026. "when creating executables.",false,
  1027. "Variables that Control the Build");
  1028. cm->DefineProperty
  1029. ("CMAKE_LIBRARY_PATH_FLAG", cmProperty::VARIABLE,
  1030. "The flag used to add a library search path to a compiler.",
  1031. "The flag used to specify a library directory to the compiler. "
  1032. "On most compilers this is \"-L\".",false,
  1033. "Variables that Control the Build");
  1034. cm->DefineProperty
  1035. ("CMAKE_LINK_DEF_FILE_FLAG ", cmProperty::VARIABLE,
  1036. "Linker flag used to specify a .def file for dll creation.",
  1037. "The flag used to add a .def file when creating "
  1038. "a dll on Windows, this is only defined on Windows.",false,
  1039. "Variables that Control the Build");
  1040. cm->DefineProperty
  1041. ("CMAKE_LINK_LIBRARY_FLAG", cmProperty::VARIABLE,
  1042. "Flag used to link a library into an executable.",
  1043. "The flag used to specify a library to link to an executable. "
  1044. "On most compilers this is \"-l\".",false,
  1045. "Variables that Control the Build");
  1046. cm->DefineProperty
  1047. ("CMAKE_LINK_LIBRARY_FILE_FLAG", cmProperty::VARIABLE,
  1048. "Flag used to link a library specified by a path to its file.",
  1049. "The flag used before a library file path is given to the linker. "
  1050. "This is needed only on very few platforms.", false,
  1051. "Variables that Control the Build");
  1052. cm->DefineProperty
  1053. ("CMAKE_USE_RELATIVE_PATHS", cmProperty::VARIABLE,
  1054. "Use relative paths (May not work!).",
  1055. "If this is set to TRUE, then the CMake will use "
  1056. "relative paths between the source and binary tree. "
  1057. "This option does not work for more complicated "
  1058. "projects, and relative paths are used when possible. "
  1059. "In general, it is not possible to move CMake generated"
  1060. " makefiles to a different location regardless "
  1061. "of the value of this variable.",false,
  1062. "Variables that Control the Build");
  1063. cm->DefineProperty
  1064. ("EXECUTABLE_OUTPUT_PATH", cmProperty::VARIABLE,
  1065. "Old executable location variable.",
  1066. "The target property RUNTIME_OUTPUT_DIRECTORY supercedes "
  1067. "this variable for a target if it is set. "
  1068. "Executable targets are otherwise placed in this directory.",false,
  1069. "Variables that Control the Build");
  1070. cm->DefineProperty
  1071. ("LIBRARY_OUTPUT_PATH", cmProperty::VARIABLE,
  1072. "Old library location variable.",
  1073. "The target properties ARCHIVE_OUTPUT_DIRECTORY, "
  1074. "LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY supercede "
  1075. "this variable for a target if they are set. "
  1076. "Library targets are otherwise placed in this directory.",false,
  1077. "Variables that Control the Build");
  1078. cm->DefineProperty
  1079. ("CMAKE_TRY_COMPILE_CONFIGURATION", cmProperty::VARIABLE,
  1080. "Build configuration used for try_compile and try_run projects.",
  1081. "Projects built by try_compile and try_run are built "
  1082. "synchronously during the CMake configuration step. "
  1083. "Therefore a specific build configuration must be chosen even "
  1084. "if the generated build system supports multiple configurations.",false,
  1085. "Variables that Control the Build");
  1086. // Variables defined when the a language is enabled These variables will
  1087. // also be defined whenever CMake has loaded its support for compiling (LANG)
  1088. // programs. This support will be loaded whenever CMake is used to compile
  1089. // (LANG) files. C and CXX are examples of the most common values for (LANG).
  1090. cm->DefineProperty
  1091. ("CMAKE_USER_MAKE_RULES_OVERRIDE_<LANG>", cmProperty::VARIABLE,
  1092. "Specify a CMake file that overrides platform information for <LANG>.",
  1093. "This is a language-specific version of "
  1094. "CMAKE_USER_MAKE_RULES_OVERRIDE loaded only when enabling "
  1095. "language <LANG>.",false,
  1096. "Variables for Languages");
  1097. cm->DefineProperty
  1098. ("CMAKE_<LANG>_COMPILER", cmProperty::VARIABLE,
  1099. "The full path to the compiler for LANG.",
  1100. "This is the command that will be used as the <LANG> compiler. "
  1101. "Once set, you can not change this variable.",false,
  1102. "Variables for Languages");
  1103. cm->DefineProperty
  1104. ("CMAKE_<LANG>_COMPILER_ID", cmProperty::VARIABLE,
  1105. "An internal variable subject to change.",
  1106. "This is used in determining the compiler and is subject to change.",
  1107. false,
  1108. "Variables for Languages");
  1109. cm->DefineProperty
  1110. ("CMAKE_<LANG>_PLATFORM_ID", cmProperty::VARIABLE,
  1111. "An internal variable subject to change.",
  1112. "This is used in determining the platform and is subject to change.",
  1113. false,
  1114. "Variables for Languages");
  1115. cm->DefineProperty
  1116. ("CMAKE_<LANG>_COMPILER_ABI", cmProperty::VARIABLE,
  1117. "An internal variable subject to change.",
  1118. "This is used in determining the compiler ABI and is subject to change.",
  1119. false,
  1120. "Variables for Languages");
  1121. cm->DefineProperty
  1122. ("CMAKE_INTERNAL_PLATFORM_ABI", cmProperty::VARIABLE,
  1123. "An internal variable subject to change.",
  1124. "This is used in determining the compiler ABI and is subject to change.",
  1125. false,
  1126. "Variables for Languages");
  1127. cm->DefineProperty
  1128. ("CMAKE_<LANG>_SIZEOF_DATA_PTR", cmProperty::VARIABLE,
  1129. "Size of pointer-to-data types for language <LANG>.",
  1130. "This holds the size (in bytes) of pointer-to-data types in the target "
  1131. "platform ABI. "
  1132. "It is defined for languages C and CXX (C++).",
  1133. false,
  1134. "Variables for Languages");
  1135. cm->DefineProperty
  1136. ("CMAKE_COMPILER_IS_GNU<LANG>", cmProperty::VARIABLE,
  1137. "True if the compiler is GNU.",
  1138. "If the selected <LANG> compiler is the GNU "
  1139. "compiler then this is TRUE, if not it is FALSE.",false,
  1140. "Variables for Languages");
  1141. cm->DefineProperty
  1142. ("CMAKE_<LANG>_FLAGS_DEBUG", cmProperty::VARIABLE,
  1143. "Flags for Debug build type or configuration.",
  1144. "<LANG> flags used when CMAKE_BUILD_TYPE is Debug.",false,
  1145. "Variables for Languages");
  1146. cm->DefineProperty
  1147. ("CMAKE_<LANG>_FLAGS_MINSIZEREL", cmProperty::VARIABLE,
  1148. "Flags for MinSizeRel build type or configuration.",
  1149. "<LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel."
  1150. "Short for minimum size release.",false,
  1151. "Variables for Languages");
  1152. cm->DefineProperty
  1153. ("CMAKE_<LANG>_FLAGS_RELEASE", cmProperty::VARIABLE,
  1154. "Flags for Release build type or configuration.",
  1155. "<LANG> flags used when CMAKE_BUILD_TYPE is Release",false,
  1156. "Variables for Languages");
  1157. cm->DefineProperty
  1158. ("CMAKE_<LANG>_FLAGS_RELWITHDEBINFO", cmProperty::VARIABLE,
  1159. "Flags for RelWithDebInfo type or configuration.",
  1160. "<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo. "
  1161. "Short for Release With Debug Information.",false,
  1162. "Variables for Languages");
  1163. cm->DefineProperty
  1164. ("CMAKE_<LANG>_COMPILE_OBJECT", cmProperty::VARIABLE,
  1165. "Rule variable to compile a single object file.",
  1166. "This is a rule variable that tells CMake how to "
  1167. "compile a single object file for for the language <LANG>.",false,
  1168. "Variables for Languages");
  1169. cm->DefineProperty
  1170. ("CMAKE_<LANG>_CREATE_SHARED_LIBRARY", cmProperty::VARIABLE,
  1171. "Rule variable to create a shared library.",
  1172. "This is a rule variable that tells CMake how to "
  1173. "create a shared library for the language <LANG>.",false,
  1174. "Variables for Languages");
  1175. cm->DefineProperty
  1176. ("CMAKE_<LANG>_CREATE_SHARED_MODULE", cmProperty::VARIABLE,
  1177. "Rule variable to create a shared module.",
  1178. "This is a rule variable that tells CMake how to "
  1179. "create a shared library for the language <LANG>.",false,
  1180. "Variables for Languages");
  1181. cm->DefineProperty
  1182. ("CMAKE_<LANG>_CREATE_STATIC_LIBRARY", cmProperty::VARIABLE,
  1183. "Rule variable to create a static library.",
  1184. "This is a rule variable that tells CMake how "
  1185. "to create a static library for the language <LANG>.",false,
  1186. "Variables for Languages");
  1187. cm->DefineProperty
  1188. ("CMAKE_<LANG>_ARCHIVE_CREATE", cmProperty::VARIABLE,
  1189. "Rule variable to create a new static archive.",
  1190. "This is a rule variable that tells CMake how to create a static "
  1191. "archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY "
  1192. "on some platforms in order to support large object counts. "
  1193. "See also CMAKE_<LANG>_ARCHIVE_APPEND and CMAKE_<LANG>_ARCHIVE_FINISH.",
  1194. false, "Variables for Languages");
  1195. cm->DefineProperty
  1196. ("CMAKE_<LANG>_ARCHIVE_APPEND", cmProperty::VARIABLE,
  1197. "Rule variable to append to a static archive.",
  1198. "This is a rule variable that tells CMake how to append to a static "
  1199. "archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY "
  1200. "on some platforms in order to support large object counts. "
  1201. "See also CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_FINISH.",
  1202. false, "Variables for Languages");
  1203. cm->DefineProperty
  1204. ("CMAKE_<LANG>_ARCHIVE_FINISH", cmProperty::VARIABLE,
  1205. "Rule variable to finish an existing static archive.",
  1206. "This is a rule variable that tells CMake how to finish a static "
  1207. "archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY "
  1208. "on some platforms in order to support large object counts. "
  1209. "See also CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_APPEND.",
  1210. false, "Variables for Languages");
  1211. cm->DefineProperty
  1212. ("CMAKE_<LANG>_IGNORE_EXTENSIONS", cmProperty::VARIABLE,
  1213. "File extensions that should be ignored by the build.",
  1214. "This is a list of file extensions that may be "
  1215. "part of a project for a given language but are not compiled. ",false,
  1216. "Variables for Languages");
  1217. cm->DefineProperty
  1218. ("CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES", cmProperty::VARIABLE,
  1219. "Directories implicitly searched by the compiler for header files.",
  1220. "CMake does not explicitly specify these directories on compiler "
  1221. "command lines for language <LANG>. "
  1222. "This prevents system include directories from being treated as user "
  1223. "include directories on some compilers.", false,
  1224. "Variables for Languages");
  1225. cm->DefineProperty
  1226. ("CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES", cmProperty::VARIABLE,
  1227. "Implicit linker search path detected for language <LANG>.",
  1228. "Compilers typically pass directories containing language runtime "
  1229. "libraries and default library search paths when they invoke a linker. "
  1230. "These paths are implicit linker search directories for the compiler's "
  1231. "language. "
  1232. "CMake automatically detects these directories for each language and "
  1233. "reports the results in this variable.", false,
  1234. "Variables for Languages");
  1235. cm->DefineProperty
  1236. ("CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES", cmProperty::VARIABLE,
  1237. "Implicit link libraries and flags detected for language <LANG>.",
  1238. "Compilers typically pass language runtime library names and "
  1239. "other flags when they invoke a linker. "
  1240. "These flags are implicit link options for the compiler's language. "
  1241. "CMake automatically detects these libraries and flags for each "
  1242. "language and reports the results in this variable.", false,
  1243. "Variables for Languages");
  1244. cm->DefineProperty
  1245. ("CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES", cmProperty::VARIABLE,
  1246. "True if CMAKE_<LANG>_LINKER_PREFERENCE propagates across targets.",
  1247. "This is used when CMake selects a linker language for a target. "
  1248. "Languages compiled directly into the target are always considered. "
  1249. "A language compiled into static libraries linked by the target is "
  1250. "considered if this variable is true.", false,
  1251. "Variables for Languages");
  1252. cm->DefineProperty
  1253. ("CMAKE_<LANG>_LINKER_PREFERENCE", cmProperty::VARIABLE,
  1254. "Preference value for linker language selection.",
  1255. "The \"linker language\" for executable, shared library, and module "
  1256. "targets is the language whose compiler will invoke the linker. "
  1257. "The LINKER_LANGUAGE target property sets the language explicitly. "
  1258. "Otherwise, the linker language is that whose linker preference value "
  1259. "is highest among languages compiled and linked into the target. "
  1260. "See also the CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES variable.",
  1261. false,
  1262. "Variables for Languages");
  1263. cm->DefineProperty
  1264. ("CMAKE_<LANG>_LINK_EXECUTABLE ", cmProperty::VARIABLE,
  1265. "Rule variable to link and executable.",
  1266. "Rule variable to link and executable for the given language.",false,
  1267. "Variables for Languages");
  1268. cm->DefineProperty
  1269. ("CMAKE_<LANG>_OUTPUT_EXTENSION", cmProperty::VARIABLE,
  1270. "Extension for the output of a compile for a single file.",
  1271. "This is the extension for an object file for "
  1272. "the given <LANG>. For example .obj for C on Windows.",false,
  1273. "Variables for Languages");
  1274. cm->DefineProperty
  1275. ("CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS", cmProperty::VARIABLE,
  1276. "Extensions of source files for the given language.",
  1277. "This is the list of extensions for a "
  1278. "given languages source files.",false,"Variables for Languages");
  1279. cm->DefineProperty(
  1280. "CMAKE_<LANG>_COMPILER_LOADED", cmProperty::VARIABLE,
  1281. "Defined to true if the language is enabled.",
  1282. "When language <LANG> is enabled by project() or enable_language() "
  1283. "this variable is defined to 1.",
  1284. false,"Variables for Languages");
  1285. cm->DefineProperty(
  1286. "CMAKE_Fortran_MODDIR_FLAG", cmProperty::VARIABLE,
  1287. "Fortran flag for module output directory.",
  1288. "This stores the flag needed to pass the value of the "
  1289. "Fortran_MODULE_DIRECTORY target property to the compiler.",
  1290. false,"Variables for Languages");
  1291. cm->DefineProperty(
  1292. "CMAKE_Fortran_MODDIR_DEFAULT", cmProperty::VARIABLE,
  1293. "Fortran default module output directory.",
  1294. "Most Fortran compilers write .mod files to the current working "
  1295. "directory. "
  1296. "For those that do not, this is set to \".\" and used when the "
  1297. "Fortran_MODULE_DIRECTORY target property is not set.",
  1298. false,"Variables for Languages");
  1299. cm->DefineProperty(
  1300. "CMAKE_Fortran_MODOUT_FLAG", cmProperty::VARIABLE,
  1301. "Fortran flag to enable module output.",
  1302. "Most Fortran compilers write .mod files out by default. "
  1303. "For others, this stores the flag needed to enable module output.",
  1304. false,"Variables for Languages");
  1305. // variables that are used by cmake but not to be documented
  1306. cm->DefineProperty("CMAKE_MATCH_0", cmProperty::VARIABLE,0,0);
  1307. cm->DefineProperty("CMAKE_MATCH_1", cmProperty::VARIABLE,0,0);
  1308. cm->DefineProperty("CMAKE_MATCH_2", cmProperty::VARIABLE,0,0);
  1309. cm->DefineProperty("CMAKE_MATCH_3", cmProperty::VARIABLE,0,0);
  1310. cm->DefineProperty("CMAKE_MATCH_4", cmProperty::VARIABLE,0,0);
  1311. cm->DefineProperty("CMAKE_MATCH_5", cmProperty::VARIABLE,0,0);
  1312. cm->DefineProperty("CMAKE_MATCH_6", cmProperty::VARIABLE,0,0);
  1313. cm->DefineProperty("CMAKE_MATCH_7", cmProperty::VARIABLE,0,0);
  1314. cm->DefineProperty("CMAKE_MATCH_8", cmProperty::VARIABLE,0,0);
  1315. cm->DefineProperty("CMAKE_MATCH_9", cmProperty::VARIABLE,0,0);
  1316. cm->DefineProperty("CMAKE_<LANG>_COMPILER_ARG1",
  1317. cmProperty::VARIABLE,0,0);
  1318. cm->DefineProperty("CMAKE_<LANG>_COMPILER_ENV_VAR",
  1319. cmProperty::VARIABLE,0,0);
  1320. cm->DefineProperty("CMAKE_<LANG>_COMPILER_ID_RUN",
  1321. cmProperty::VARIABLE,0,0);
  1322. cm->DefineProperty("CMAKE_<LANG>_CREATE_ASSEMBLY_SOURCE",
  1323. cmProperty::VARIABLE,0,0);
  1324. cm->DefineProperty("CMAKE_<LANG>_CREATE_PREPROCESSED_SOURCE",
  1325. cmProperty::VARIABLE,0,0);
  1326. cm->DefineProperty("CMAKE_<LANG>_FLAGS",
  1327. cmProperty::VARIABLE,0,0);
  1328. cm->DefineProperty("CMAKE_<LANG>_FLAGS_DEBUG_INIT",
  1329. cmProperty::VARIABLE,0,0);
  1330. cm->DefineProperty("CMAKE_<LANG>_FLAGS_INIT",
  1331. cmProperty::VARIABLE,0,0);
  1332. cm->DefineProperty("CMAKE_<LANG>_FLAGS_MINSIZEREL_INIT",
  1333. cmProperty::VARIABLE,0,0);
  1334. cm->DefineProperty("CMAKE_<LANG>_FLAGS_RELEASE_INIT",
  1335. cmProperty::VARIABLE,0,0);
  1336. cm->DefineProperty("CMAKE_<LANG>_FLAGS_RELWITHDEBINFO_INIT",
  1337. cmProperty::VARIABLE,0,0);
  1338. cm->DefineProperty("CMAKE_<LANG>_INFORMATION_LOADED",
  1339. cmProperty::VARIABLE,0,0);
  1340. cm->DefineProperty("CMAKE_<LANG>_LINK_EXECUTABLE",
  1341. cmProperty::VARIABLE,0,0);
  1342. cm->DefineProperty("CMAKE_<LANG>_LINK_FLAGS",
  1343. cmProperty::VARIABLE,0,0);
  1344. cm->DefineProperty("CMAKE_<LANG>_RESPONSE_FILE_LINK_FLAG",
  1345. cmProperty::VARIABLE,0,0);
  1346. cm->DefineProperty("CMAKE_<LANG>_STANDARD_LIBRARIES",
  1347. cmProperty::VARIABLE,0,0);
  1348. cm->DefineProperty("CMAKE_<LANG>_STANDARD_LIBRARIES_INIT",
  1349. cmProperty::VARIABLE,0,0);
  1350. cm->DefineProperty("CMAKE_<LANG>_USE_RESPONSE_FILE_FOR_OBJECTS",
  1351. cmProperty::VARIABLE,0,0);
  1352. cm->DefineProperty("CMAKE_EXECUTABLE_SUFFIX_<LANG>",
  1353. cmProperty::VARIABLE,0,0);
  1354. cm->DefineProperty("CMAKE_EXE_LINK_DYNAMIC_<LANG>_FLAGS",
  1355. cmProperty::VARIABLE,0,0);
  1356. cm->DefineProperty("CMAKE_EXE_LINK_STATIC_<LANG>_FLAGS",
  1357. cmProperty::VARIABLE,0,0);
  1358. cm->DefineProperty("CMAKE_GENERATOR_<LANG>",
  1359. cmProperty::VARIABLE,0,0);
  1360. cm->DefineProperty("CMAKE_IMPORT_LIBRARY_PREFIX_<LANG>",
  1361. cmProperty::VARIABLE,0,0);
  1362. cm->DefineProperty("CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG>",
  1363. cmProperty::VARIABLE,0,0);
  1364. cm->DefineProperty("CMAKE_INCLUDE_FLAG_<LANG>",
  1365. cmProperty::VARIABLE,0,0);
  1366. cm->DefineProperty("CMAKE_INCLUDE_FLAG_SEP_<LANG>",
  1367. cmProperty::VARIABLE,0,0);
  1368. cm->DefineProperty("CMAKE_INCLUDE_SYSTEM_FLAG_<LANG>",
  1369. cmProperty::VARIABLE,0,0);
  1370. cm->DefineProperty("CMAKE_NEEDS_REQUIRES_STEP_<LANG>_FLAG",
  1371. cmProperty::VARIABLE,0,0);
  1372. cm->DefineProperty("CMAKE_SHARED_LIBRARY_CREATE_<LANG>_FLAGS",
  1373. cmProperty::VARIABLE,0,0);
  1374. cm->DefineProperty("CMAKE_SHARED_LIBRARY_<LANG>_FLAGS",
  1375. cmProperty::VARIABLE,0,0);
  1376. cm->DefineProperty("CMAKE_SHARED_LIBRARY_LINK_<LANG>_FLAGS",
  1377. cmProperty::VARIABLE,0,0);
  1378. cm->DefineProperty("CMAKE_SHARED_LIBRARY_LINK_DYNAMIC_<LANG>_FLAGS",
  1379. cmProperty::VARIABLE,0,0);
  1380. cm->DefineProperty("CMAKE_SHARED_LIBRARY_LINK_STATIC_<LANG>_FLAGS",
  1381. cmProperty::VARIABLE,0,0);
  1382. cm->DefineProperty("CMAKE_SHARED_LIBRARY_PREFIX_<LANG>",
  1383. cmProperty::VARIABLE,0,0);
  1384. cm->DefineProperty("CMAKE_SHARED_LIBRARY_SUFFIX_<LANG>",
  1385. cmProperty::VARIABLE,0,0);
  1386. cm->DefineProperty("CMAKE_SHARED_LIBRARY_RUNTIME_<LANG>_FLAG",
  1387. cmProperty::VARIABLE,0,0);
  1388. cm->DefineProperty("CMAKE_SHARED_LIBRARY_RUNTIME_<LANG>_FLAG_SEP",
  1389. cmProperty::VARIABLE,0,0);
  1390. cm->DefineProperty("CMAKE_SHARED_LIBRARY_RPATH_LINK_<LANG>_FLAG",
  1391. cmProperty::VARIABLE,0,0);
  1392. cm->DefineProperty("CMAKE_EXECUTABLE_RUNTIME_<LANG>_FLAG",
  1393. cmProperty::VARIABLE,0,0);
  1394. cm->DefineProperty("CMAKE_EXECUTABLE_RUNTIME_<LANG>_FLAG_SEP",
  1395. cmProperty::VARIABLE,0,0);
  1396. cm->DefineProperty("CMAKE_EXECUTABLE_RPATH_LINK_<LANG>_FLAG",
  1397. cmProperty::VARIABLE,0,0);
  1398. cm->DefineProperty("CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH",
  1399. cmProperty::VARIABLE,0,0);
  1400. cm->DefineProperty("CMAKE_SHARED_MODULE_CREATE_<LANG>_FLAGS",
  1401. cmProperty::VARIABLE,0,0);
  1402. cm->DefineProperty("CMAKE_SHARED_MODULE_<LANG>_FLAGS",
  1403. cmProperty::VARIABLE,0,0);
  1404. cm->DefineProperty("CMAKE_SHARED_MODULE_LINK_DYNAMIC_<LANG>_FLAGS",
  1405. cmProperty::VARIABLE,0,0);
  1406. cm->DefineProperty("CMAKE_SHARED_MODULE_LINK_STATIC_<LANG>_FLAGS",
  1407. cmProperty::VARIABLE,0,0);
  1408. cm->DefineProperty("CMAKE_SHARED_MODULE_PREFIX_<LANG>",
  1409. cmProperty::VARIABLE,0,0);
  1410. cm->DefineProperty("CMAKE_SHARED_MODULE_SUFFIX_<LANG>",
  1411. cmProperty::VARIABLE,0,0);
  1412. cm->DefineProperty("CMAKE_STATIC_LIBRARY_PREFIX_<LANG>",
  1413. cmProperty::VARIABLE,0,0);
  1414. cm->DefineProperty("CMAKE_STATIC_LIBRARY_SUFFIX_<LANG>",
  1415. cmProperty::VARIABLE,0,0);
  1416. cm->DefineProperty("CMAKE_LINK_DEPENDENT_LIBRARY_FILES",
  1417. cmProperty::VARIABLE,0,0);
  1418. cm->DefineProperty("CMAKE_LINK_DEPENDENT_LIBRARY_DIRS",
  1419. cmProperty::VARIABLE,0,0);
  1420. cm->DefineProperty("CMAKE_MAKE_INCLUDE_FROM_ROOT",
  1421. cmProperty::VARIABLE,0,0);
  1422. }