cmDocumentVariables.cxx 81 KB

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