cmDocumentVariables.cxx 76 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653
  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.",false,
  342. "Variables that Provide Information");
  343. cm->DefineProperty
  344. ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE,
  345. "Source directory for project.",
  346. "This is the top level source directory for the project. "
  347. "It corresponds to the source directory given to "
  348. "cmake-gui or ccmake.",false,
  349. "Variables that Provide Information");
  350. cm->DefineProperty
  351. ("CMAKE_STANDARD_LIBRARIES", cmProperty::VARIABLE,
  352. "Libraries linked into every executable and shared library.",
  353. "This is the list of libraries that are linked "
  354. "into all executables and libraries.",false,
  355. "Variables that Provide Information");
  356. cm->DefineProperty
  357. ("CMAKE_USING_VC_FREE_TOOLS", cmProperty::VARIABLE,
  358. "True if free visual studio tools being used.",
  359. "This is set to true if the compiler is Visual "
  360. "Studio free tools.",false,
  361. "Variables that Provide Information");
  362. cm->DefineProperty
  363. ("CMAKE_VERBOSE_MAKEFILE", cmProperty::VARIABLE,
  364. "Create verbose makefiles if on.",
  365. "This variable defaults to false. You can set "
  366. "this variable to true to make CMake produce verbose "
  367. "makefiles that show each command line as it is used.",false,
  368. "Variables that Provide Information");
  369. cm->DefineProperty
  370. ("PROJECT_BINARY_DIR", cmProperty::VARIABLE,
  371. "Full path to build directory for project.",
  372. "This is the binary directory of the most recent "
  373. "PROJECT command.",false,"Variables that Provide Information");
  374. cm->DefineProperty
  375. ("PROJECT_NAME", cmProperty::VARIABLE,
  376. "Name of the project given to the project command.",
  377. "This is the name given to the most "
  378. "recent PROJECT command. ",false,
  379. "Variables that Provide Information");
  380. cm->DefineProperty
  381. ("PROJECT_SOURCE_DIR", cmProperty::VARIABLE,
  382. "Top level source directory for the current project.",
  383. "This is the source directory of the most recent "
  384. "PROJECT command.",false,
  385. "Variables that Provide Information");
  386. cm->DefineProperty
  387. ("[Project name]_BINARY_DIR", cmProperty::VARIABLE,
  388. "Top level binary directory for the named project.",
  389. "A variable is created with the name used in the PROJECT "
  390. "command, and is the binary directory for the project. "
  391. " This can be useful when SUBDIR is used to connect "
  392. "several projects.",false,
  393. "Variables that Provide Information");
  394. cm->DefineProperty
  395. ("[Project name]_SOURCE_DIR", cmProperty::VARIABLE,
  396. "Top level source directory for the named project.",
  397. "A variable is created with the name used in the PROJECT "
  398. "command, and is the source directory for the project."
  399. " This can be useful when add_subdirectory "
  400. "is used to connect several projects.",false,
  401. "Variables that Provide Information");
  402. cm->DefineProperty
  403. ("CMAKE_IMPORT_LIBRARY_PREFIX", cmProperty::VARIABLE,
  404. "The prefix for import libraries that you link to.",
  405. "The prefix to use for the name of an import library if used "
  406. "on this platform."
  407. "\n"
  408. "CMAKE_IMPORT_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>."
  409. ,false, "Variables that Provide Information");
  410. cm->DefineProperty
  411. ("CMAKE_IMPORT_LIBRARY_SUFFIX", cmProperty::VARIABLE,
  412. "The suffix for import libraries that you link to.",
  413. "The suffix to use for the end of an import library if used "
  414. "on this platform."
  415. "\n"
  416. "CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>."
  417. ,false, "Variables that Provide Information");
  418. cm->DefineProperty
  419. ("CMAKE_SHARED_LIBRARY_PREFIX", cmProperty::VARIABLE,
  420. "The prefix for shared libraries that you link to.",
  421. "The prefix to use for the name of a shared library, lib on UNIX."
  422. "\n"
  423. "CMAKE_SHARED_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>."
  424. ,false, "Variables that Provide Information");
  425. cm->DefineProperty
  426. ("CMAKE_SHARED_LIBRARY_SUFFIX", cmProperty::VARIABLE,
  427. "The suffix for shared libraries that you link to.",
  428. "The suffix to use for the end of a shared library, .dll on Windows."
  429. "\n"
  430. "CMAKE_SHARED_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>."
  431. ,false, "Variables that Provide Information");
  432. cm->DefineProperty
  433. ("CMAKE_SHARED_MODULE_PREFIX", cmProperty::VARIABLE,
  434. "The prefix for loadable modules that you link to.",
  435. "The prefix to use for the name of a loadable module on this platform."
  436. "\n"
  437. "CMAKE_SHARED_MODULE_PREFIX_<LANG> overrides this for language <LANG>."
  438. ,false, "Variables that Provide Information");
  439. cm->DefineProperty
  440. ("CMAKE_SHARED_MODULE_SUFFIX", cmProperty::VARIABLE,
  441. "The suffix for shared libraries that you link to.",
  442. "The suffix to use for the end of a loadable module on this platform"
  443. "\n"
  444. "CMAKE_SHARED_MODULE_SUFFIX_<LANG> overrides this for language <LANG>."
  445. ,false, "Variables that Provide Information");
  446. cm->DefineProperty
  447. ("CMAKE_STATIC_LIBRARY_PREFIX", cmProperty::VARIABLE,
  448. "The prefix for static libraries that you link to.",
  449. "The prefix to use for the name of a static library, lib on UNIX."
  450. "\n"
  451. "CMAKE_STATIC_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>."
  452. ,false, "Variables that Provide Information");
  453. cm->DefineProperty
  454. ("CMAKE_STATIC_LIBRARY_SUFFIX", cmProperty::VARIABLE,
  455. "The suffix for static libraries that you link to.",
  456. "The suffix to use for the end of a static library, .lib on Windows."
  457. "\n"
  458. "CMAKE_STATIC_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>."
  459. ,false, "Variables that Provide Information");
  460. cm->DefineProperty
  461. ("CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES", cmProperty::VARIABLE,
  462. "Additional suffixes for shared libraries.",
  463. "Extensions for shared libraries other than that specified by "
  464. "CMAKE_SHARED_LIBRARY_SUFFIX, if any. "
  465. "CMake uses this to recognize external shared library files during "
  466. "analysis of libraries linked by a target.",
  467. false,
  468. "Variables that Provide Information");
  469. // Variables defined by cmake, that change the behavior
  470. // of cmake
  471. cm->DefineProperty
  472. ("CMAKE_POLICY_DEFAULT_CMP<NNNN>", cmProperty::VARIABLE,
  473. "Default for CMake Policy CMP<NNNN> when it is otherwise left unset.",
  474. "Commands cmake_minimum_required(VERSION) and cmake_policy(VERSION) "
  475. "by default leave policies introduced after the given version unset. "
  476. "Set CMAKE_POLICY_DEFAULT_CMP<NNNN> to OLD or NEW to specify the "
  477. "default for policy CMP<NNNN>, where <NNNN> is the policy number."
  478. "\n"
  479. "This variable should not be set by a project in CMake code; "
  480. "use cmake_policy(SET) instead. "
  481. "Users running CMake may set this variable in the cache "
  482. "(e.g. -DCMAKE_POLICY_DEFAULT_CMP<NNNN>=<OLD|NEW>) "
  483. "to set a policy not otherwise set by the project. "
  484. "Set to OLD to quiet a policy warning while using old behavior "
  485. "or to NEW to try building the project with new behavior.",
  486. false,
  487. "Variables That Change Behavior");
  488. cm->DefineProperty
  489. ("CMAKE_AUTOMOC_RELAXED_MODE", cmProperty::VARIABLE,
  490. "Switch between strict and relaxed automoc mode.",
  491. "By default, automoc behaves exactly as described in the documentation "
  492. "of the AUTOMOC target property. "
  493. "When set to TRUE, it accepts more input and tries to find the correct "
  494. "input file for moc even if it differs from the documented behaviour. "
  495. "In this mode it e.g. also checks whether a header file is intended to "
  496. "be processed by moc when a \"foo.moc\" file has been included.\n"
  497. "Relaxed mode has to be enabled for KDE4 compatibility.",
  498. false,
  499. "Variables That Change Behavior");
  500. cm->DefineProperty
  501. ("CMAKE_FIND_LIBRARY_PREFIXES", cmProperty::VARIABLE,
  502. "Prefixes to prepend when looking for libraries.",
  503. "This specifies what prefixes to add to library names when "
  504. "the find_library command looks for libraries. On UNIX "
  505. "systems this is typically lib, meaning that when trying "
  506. "to find the foo library it will look for libfoo.",
  507. false,
  508. "Variables That Change Behavior");
  509. cm->DefineProperty
  510. ("CMAKE_FIND_LIBRARY_SUFFIXES", cmProperty::VARIABLE,
  511. "Suffixes to append when looking for libraries.",
  512. "This specifies what suffixes to add to library names when "
  513. "the find_library command looks for libraries. On Windows "
  514. "systems this is typically .lib and .dll, meaning that when trying "
  515. "to find the foo library it will look for foo.dll etc.",
  516. false,
  517. "Variables That Change Behavior");
  518. cm->DefineProperty
  519. ("CMAKE_CONFIGURATION_TYPES", cmProperty::VARIABLE,
  520. "Specifies the available build types.",
  521. "This specifies what build types will be available such as "
  522. "Debug, Release, RelWithDebInfo etc. This has reasonable defaults "
  523. "on most platforms. But can be extended to provide other "
  524. "build types. See also CMAKE_BUILD_TYPE.",
  525. false,
  526. "Variables That Change Behavior");
  527. cm->DefineProperty
  528. ("CMAKE_BUILD_TYPE", cmProperty::VARIABLE,
  529. "Specifies the build type for make based generators.",
  530. "This specifies what build type will be built in this tree. "
  531. " Possible values are empty, Debug, Release, RelWithDebInfo"
  532. " and MinSizeRel. This variable is only supported for "
  533. "make based generators. If this variable is supported, "
  534. "then CMake will also provide initial values for the "
  535. "variables with the name "
  536. " CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]."
  537. " For example, if CMAKE_BUILD_TYPE is Debug, then "
  538. "CMAKE_C_FLAGS_DEBUG will be added to the CMAKE_C_FLAGS.",false,
  539. "Variables That Change Behavior");
  540. cm->DefineProperty
  541. ("CMAKE_BACKWARDS_COMPATIBILITY", cmProperty::VARIABLE,
  542. "Version of cmake required to build project",
  543. "From the point of view of backwards compatibility, this "
  544. "specifies what version of CMake should be supported. By "
  545. "default this value is the version number of CMake that "
  546. "you are running. You can set this to an older version of"
  547. " CMake to support deprecated commands of CMake in projects"
  548. " that were written to use older versions of CMake. This "
  549. "can be set by the user or set at the beginning of a "
  550. "CMakeLists file.",false,
  551. "Variables That Change Behavior");
  552. cm->DefineProperty
  553. ("CMAKE_INSTALL_PREFIX", cmProperty::VARIABLE,
  554. "Install directory used by install.",
  555. "If \"make install\" is invoked or INSTALL is built"
  556. ", this directory is pre-pended onto all install "
  557. "directories. This variable defaults to /usr/local"
  558. " on UNIX and c:/Program Files on Windows.",false,
  559. "Variables That Change Behavior");
  560. cm->DefineProperty
  561. ("CMAKE_SKIP_INSTALL_ALL_DEPENDENCY", cmProperty::VARIABLE,
  562. "Don't make the install target depend on the all target.",
  563. "By default, the \"install\" target depends on the \"all\" target. "
  564. "This has the effect, that when \"make install\" is invoked or INSTALL "
  565. "is built, first the \"all\" target is built, then the installation "
  566. "starts. "
  567. "If CMAKE_SKIP_INSTALL_ALL_DEPENDENCY is set to TRUE, this dependency "
  568. "is not created, so the installation process will start immediately, "
  569. "independent from whether the project has been completely built or not."
  570. ,false,
  571. "Variables That Change Behavior");
  572. cm->DefineProperty
  573. ("CMAKE_MODULE_PATH", cmProperty::VARIABLE,
  574. "List of directories to search for CMake modules.",
  575. "Commands like include() and find_package() search for files in "
  576. "directories listed by this variable before checking the default "
  577. "modules that come with CMake.",
  578. false,
  579. "Variables That Change Behavior");
  580. cm->DefineProperty
  581. ("CMAKE_PREFIX_PATH", cmProperty::VARIABLE,
  582. "Path used for searching by FIND_XXX(), with appropriate suffixes added.",
  583. "Specifies a path which will be used by the FIND_XXX() commands. It "
  584. "contains the \"base\" directories, the FIND_XXX() commands append "
  585. "appropriate subdirectories to the base directories. So FIND_PROGRAM() "
  586. "adds /bin to each of the directories in the path, FIND_LIBRARY() "
  587. "appends /lib to each of the directories, and FIND_PATH() and "
  588. "FIND_FILE() append /include . By default it is empty, it is intended "
  589. "to be set by the project. See also CMAKE_SYSTEM_PREFIX_PATH, "
  590. "CMAKE_INCLUDE_PATH, CMAKE_LIBRARY_PATH, CMAKE_PROGRAM_PATH.", false,
  591. "Variables That Change Behavior");
  592. cm->DefineProperty
  593. ("CMAKE_INCLUDE_PATH", cmProperty::VARIABLE,
  594. "Path used for searching by FIND_FILE() and FIND_PATH().",
  595. "Specifies a path which will be used both by FIND_FILE() and "
  596. "FIND_PATH(). Both commands will check each of the contained directories "
  597. "for the existence of the file which is currently searched. By default "
  598. "it is empty, it is intended to be set by the project. See also "
  599. "CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_PREFIX_PATH.", false,
  600. "Variables That Change Behavior");
  601. cm->DefineProperty
  602. ("CMAKE_LIBRARY_PATH", cmProperty::VARIABLE,
  603. "Path used for searching by FIND_LIBRARY().",
  604. "Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() "
  605. "will check each of the contained directories for the existence of the "
  606. "library which is currently searched. By default it is empty, it is "
  607. "intended to be set by the project. See also CMAKE_SYSTEM_LIBRARY_PATH, "
  608. "CMAKE_PREFIX_PATH.", false,
  609. "Variables That Change Behavior");
  610. cm->DefineProperty
  611. ("CMAKE_PROGRAM_PATH", cmProperty::VARIABLE,
  612. "Path used for searching by FIND_PROGRAM().",
  613. "Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() "
  614. "will check each of the contained directories for the existence of the "
  615. "program which is currently searched. By default it is empty, it is "
  616. "intended to be set by the project. See also CMAKE_SYSTEM_PROGRAM_PATH, "
  617. " CMAKE_PREFIX_PATH.", false,
  618. "Variables That Change Behavior");
  619. cm->DefineProperty
  620. ("CMAKE_SYSTEM_PREFIX_PATH", cmProperty::VARIABLE,
  621. "Path used for searching by FIND_XXX(), with appropriate suffixes added.",
  622. "Specifies a path which will be used by the FIND_XXX() commands. It "
  623. "contains the \"base\" directories, the FIND_XXX() commands append "
  624. "appropriate subdirectories to the base directories. So FIND_PROGRAM() "
  625. "adds /bin to each of the directories in the path, FIND_LIBRARY() "
  626. "appends /lib to each of the directories, and FIND_PATH() and "
  627. "FIND_FILE() append /include . By default this contains the standard "
  628. "directories for the current system. It is NOT intended "
  629. "to be modified by the project, use CMAKE_PREFIX_PATH for this. See also "
  630. "CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_SYSTEM_LIBRARY_PATH, "
  631. "CMAKE_SYSTEM_PROGRAM_PATH, and CMAKE_SYSTEM_IGNORE_PATH.", false,
  632. "Variables That Change Behavior");
  633. cm->DefineProperty
  634. ("CMAKE_SYSTEM_IGNORE_PATH", cmProperty::VARIABLE,
  635. "Path to be ignored by FIND_XXX() commands.",
  636. "Specifies directories to be ignored by searches in FIND_XXX() commands "
  637. "This is useful in cross-compiled environments where some system "
  638. "directories contain incompatible but possibly linkable libraries. For "
  639. "example, on cross-compiled cluster environments, this allows a user to "
  640. "ignore directories containing libraries meant for the front-end "
  641. "machine that modules like FindX11 (and others) would normally search. "
  642. "By default this contains a list of directories containing incompatible "
  643. "binaries for the host system. "
  644. "See also CMAKE_SYSTEM_PREFIX_PATH, CMAKE_SYSTEM_LIBRARY_PATH, "
  645. "CMAKE_SYSTEM_INCLUDE_PATH, and CMAKE_SYSTEM_PROGRAM_PATH.", false,
  646. "Variables That Change Behavior");
  647. cm->DefineProperty
  648. ("CMAKE_IGNORE_PATH", cmProperty::VARIABLE,
  649. "Path to be ignored by FIND_XXX() commands.",
  650. "Specifies directories to be ignored by searches in FIND_XXX() commands "
  651. "This is useful in cross-compiled environments where some system "
  652. "directories contain incompatible but possibly linkable libraries. For "
  653. "example, on cross-compiled cluster environments, this allows a user to "
  654. "ignore directories containing libraries meant for the front-end "
  655. "machine that modules like FindX11 (and others) would normally search. "
  656. "By default this is empty; it is intended to be set by the project. "
  657. "Note that CMAKE_IGNORE_PATH takes a list of directory names, NOT a "
  658. "list of prefixes. If you want to ignore paths under prefixes (bin, "
  659. "include, lib, etc.), you'll need to specify them explicitly. "
  660. "See also CMAKE_PREFIX_PATH, CMAKE_LIBRARY_PATH, CMAKE_INCLUDE_PATH, "
  661. "CMAKE_PROGRAM_PATH.", false,
  662. "Variables That Change Behavior");
  663. cm->DefineProperty
  664. ("CMAKE_SYSTEM_INCLUDE_PATH", cmProperty::VARIABLE,
  665. "Path used for searching by FIND_FILE() and FIND_PATH().",
  666. "Specifies a path which will be used both by FIND_FILE() and "
  667. "FIND_PATH(). Both commands will check each of the contained directories "
  668. "for the existence of the file which is currently searched. By default "
  669. "it contains the standard directories for the current system. It is "
  670. "NOT intended to be modified by the project, use CMAKE_INCLUDE_PATH "
  671. "for this. See also CMAKE_SYSTEM_PREFIX_PATH.", false,
  672. "Variables That Change Behavior");
  673. cm->DefineProperty
  674. ("CMAKE_SYSTEM_LIBRARY_PATH", cmProperty::VARIABLE,
  675. "Path used for searching by FIND_LIBRARY().",
  676. "Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() "
  677. "will check each of the contained directories for the existence of the "
  678. "library which is currently searched. By default it contains the "
  679. "standard directories for the current system. It is NOT intended to be "
  680. "modified by the project, use CMAKE_LIBRARY_PATH for this. See "
  681. "also CMAKE_SYSTEM_PREFIX_PATH.", false,
  682. "Variables That Change Behavior");
  683. cm->DefineProperty
  684. ("CMAKE_SYSTEM_PROGRAM_PATH", cmProperty::VARIABLE,
  685. "Path used for searching by FIND_PROGRAM().",
  686. "Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() "
  687. "will check each of the contained directories for the existence of the "
  688. "program which is currently searched. By default it contains the "
  689. "standard directories for the current system. It is NOT intended to be "
  690. "modified by the project, use CMAKE_PROGRAM_PATH for this. See also "
  691. "CMAKE_SYSTEM_PREFIX_PATH.", false,
  692. "Variables That Change Behavior");
  693. cm->DefineProperty
  694. ("CMAKE_DISABLE_FIND_PACKAGE_<PackageName>", cmProperty::VARIABLE,
  695. "Variable for disabling find_package() calls.",
  696. "Every non-REQUIRED find_package() call in a project can be disabled "
  697. "by setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to "
  698. "TRUE. This can be used to build a project without an optional package, "
  699. "although that package is installed.\n"
  700. "This switch should be used during the initial CMake run. Otherwise if "
  701. "the package has already been found in a previous CMake run, the "
  702. "variables which have been stored in the cache will still be there. "
  703. "In the case it is recommended to remove the cache variables for "
  704. "this package from the cache using the cache editor or cmake -U", false,
  705. "Variables That Change Behavior");
  706. cm->DefineProperty
  707. ("CMAKE_USER_MAKE_RULES_OVERRIDE", cmProperty::VARIABLE,
  708. "Specify a CMake file that overrides platform information.",
  709. "CMake loads the specified file while enabling support for each "
  710. "language from either the project() or enable_language() commands. "
  711. "It is loaded after CMake's builtin compiler and platform information "
  712. "modules have been loaded but before the information is used. "
  713. "The file may set platform information variables to override CMake's "
  714. "defaults."
  715. "\n"
  716. "This feature is intended for use only in overriding information "
  717. "variables that must be set before CMake builds its first test "
  718. "project to check that the compiler for a language works. "
  719. "It should not be used to load a file in cases that a normal include() "
  720. "will work. "
  721. "Use it only as a last resort for behavior that cannot be achieved "
  722. "any other way. "
  723. "For example, one may set CMAKE_C_FLAGS_INIT to change the default "
  724. "value used to initialize CMAKE_C_FLAGS before it is cached. "
  725. "The override file should NOT be used to set anything that could "
  726. "be set after languages are enabled, such as variables like "
  727. "CMAKE_RUNTIME_OUTPUT_DIRECTORY that affect the placement of binaries. "
  728. "Information set in the file will be used for try_compile and try_run "
  729. "builds too."
  730. ,false,
  731. "Variables That Change Behavior");
  732. cm->DefineProperty
  733. ("BUILD_SHARED_LIBS", cmProperty::VARIABLE,
  734. "Global flag to cause add_library to create shared libraries if on.",
  735. "If present and true, this will cause all libraries to be "
  736. "built shared unless the library was explicitly added as a "
  737. "static library. This variable is often added to projects "
  738. "as an OPTION so that each user of a project can decide if "
  739. "they want to build the project using shared or static "
  740. "libraries.",false,
  741. "Variables That Change Behavior");
  742. cm->DefineProperty
  743. ("CMAKE_NOT_USING_CONFIG_FLAGS", cmProperty::VARIABLE,
  744. "Skip _BUILD_TYPE flags if true.",
  745. "This is an internal flag used by the generators in "
  746. "CMake to tell CMake to skip the _BUILD_TYPE flags.",false,
  747. "Variables That Change Behavior");
  748. cm->DefineProperty
  749. ("CMAKE_MFC_FLAG", cmProperty::VARIABLE,
  750. "Tell cmake to use MFC for an executable or dll.",
  751. "This can be set in a CMakeLists.txt file and will "
  752. "enable MFC in the application. It should be set "
  753. "to 1 for static the static MFC library, and 2 for "
  754. "the shared MFC library. This is used in visual "
  755. "studio 6 and 7 project files. The CMakeSetup "
  756. "dialog used MFC and the CMakeLists.txt looks like this:\n"
  757. "add_definitions(-D_AFXDLL)\n"
  758. "set(CMAKE_MFC_FLAG 2)\n"
  759. "add_executable(CMakeSetup WIN32 ${SRCS})\n",false,
  760. "Variables That Change Behavior");
  761. cm->DefineProperty
  762. ("CMAKE_COLOR_MAKEFILE", cmProperty::VARIABLE,
  763. "Enables color output when using the Makefile generator.",
  764. "When enabled, the generated Makefiles will produce colored output. "
  765. "Default is ON.",false,
  766. "Variables That Change Behavior");
  767. // Variables defined by CMake that describe the system
  768. cm->DefineProperty
  769. ("CMAKE_SYSTEM", cmProperty::VARIABLE,
  770. "Name of system cmake is compiling for.",
  771. "This variable is the composite of CMAKE_SYSTEM_NAME "
  772. "and CMAKE_SYSTEM_VERSION, like this "
  773. "${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}. "
  774. "If CMAKE_SYSTEM_VERSION is not set, then "
  775. "CMAKE_SYSTEM is the same as CMAKE_SYSTEM_NAME.",false,
  776. "Variables That Describe the System");
  777. cm->DefineProperty
  778. ("CMAKE_SYSTEM_NAME", cmProperty::VARIABLE,
  779. "Name of the OS CMake is building for.",
  780. "This is the name of the operating system on "
  781. "which CMake is targeting. On systems that "
  782. "have the uname command, this variable is set "
  783. "to the output of uname -s. Linux, Windows, "
  784. " and Darwin for Mac OSX are the values found "
  785. " on the big three operating systems." ,false,
  786. "Variables That Describe the System");
  787. cm->DefineProperty
  788. ("CMAKE_SYSTEM_PROCESSOR", cmProperty::VARIABLE,
  789. "The name of the CPU CMake is building for.",
  790. "On systems that support uname, this variable is "
  791. "set to the output of uname -p, on windows it is "
  792. "set to the value of the environment variable "
  793. "PROCESSOR_ARCHITECTURE",false,
  794. "Variables That Describe the System");
  795. cm->DefineProperty
  796. ("CMAKE_SYSTEM_VERSION", cmProperty::VARIABLE,
  797. "OS version CMake is building for.",
  798. "A numeric version string for the system, on "
  799. "systems that support uname, this variable is "
  800. "set to the output of uname -r. On other "
  801. "systems this is set to major-minor version numbers.",false,
  802. "Variables That Describe the System");
  803. cm->DefineProperty
  804. ("CMAKE_LIBRARY_ARCHITECTURE", cmProperty::VARIABLE,
  805. "Target architecture library directory name, if detected.",
  806. "This is the value of CMAKE_<lang>_LIBRARY_ARCHITECTURE as "
  807. "detected for one of the enabled languages.",false,
  808. "Variables That Describe the System");
  809. cm->DefineProperty
  810. ("CMAKE_LIBRARY_ARCHITECTURE_REGEX", cmProperty::VARIABLE,
  811. "Regex matching possible target architecture library directory names.",
  812. "This is used to detect CMAKE_<lang>_LIBRARY_ARCHITECTURE from the "
  813. "implicit linker search path by matching the <arch> name.",false,
  814. "Variables That Describe the System");
  815. cm->DefineProperty
  816. ("CMAKE_HOST_SYSTEM", cmProperty::VARIABLE,
  817. "Name of system cmake is being run on.",
  818. "The same as CMAKE_SYSTEM but for the host system instead "
  819. "of the target system when cross compiling.",false,
  820. "Variables That Describe the System");
  821. cm->DefineProperty
  822. ("CMAKE_HOST_SYSTEM_NAME", cmProperty::VARIABLE,
  823. "Name of the OS CMake is running on.",
  824. "The same as CMAKE_SYSTEM_NAME but for the host system instead "
  825. "of the target system when cross compiling.",false,
  826. "Variables That Describe the System");
  827. cm->DefineProperty
  828. ("CMAKE_HOST_SYSTEM_PROCESSOR", cmProperty::VARIABLE,
  829. "The name of the CPU CMake is running on.",
  830. "The same as CMAKE_SYSTEM_PROCESSOR but for the host system instead "
  831. "of the target system when cross compiling.",false,
  832. "Variables That Describe the System");
  833. cm->DefineProperty
  834. ("CMAKE_HOST_SYSTEM_VERSION", cmProperty::VARIABLE,
  835. "OS version CMake is running on.",
  836. "The same as CMAKE_SYSTEM_VERSION but for the host system instead "
  837. "of the target system when cross compiling.",false,
  838. "Variables That Describe the System");
  839. cm->DefineProperty
  840. ("APPLE", cmProperty::VARIABLE,
  841. "True if running on Mac OSX.",
  842. "Set to true on Mac OSX.",false,
  843. "Variables That Describe the System");
  844. cm->DefineProperty
  845. ("BORLAND", cmProperty::VARIABLE,
  846. "True if the borland compiler is being used.",
  847. "This is set to true if the Borland compiler is being used.",false,
  848. "Variables That Describe the System");
  849. cm->DefineProperty
  850. ("CYGWIN", cmProperty::VARIABLE,
  851. "True for cygwin.",
  852. "Set to true when using CYGWIN.",false,
  853. "Variables That Describe the System");
  854. cm->DefineProperty
  855. ("MSVC", cmProperty::VARIABLE,
  856. "True when using Microsoft Visual C",
  857. "Set to true when the compiler is some version of Microsoft Visual C.",
  858. false,
  859. "Variables That Describe the System");
  860. cm->DefineProperty
  861. ("MSVC80", cmProperty::VARIABLE,
  862. "True when using Microsoft Visual C 8.0",
  863. "Set to true when the compiler is version 8.0 of Microsoft Visual C.",
  864. false,
  865. "Variables That Describe the System");
  866. cm->DefineProperty
  867. ("MSVC_IDE", cmProperty::VARIABLE,
  868. "True when using the Microsoft Visual C IDE",
  869. "Set to true when the target platform is the Microsoft Visual C IDE, "
  870. "as opposed to the command line compiler.",
  871. false,
  872. "Variables That Describe the System");
  873. cm->DefineProperty
  874. ("MSVC_VERSION", cmProperty::VARIABLE,
  875. "The version of Microsoft Visual C/C++ being used if any.",
  876. "Known version numbers are:\n"
  877. " 1200 = VS 6.0\n"
  878. " 1300 = VS 7.0\n"
  879. " 1310 = VS 7.1\n"
  880. " 1400 = VS 8.0\n"
  881. " 1500 = VS 9.0\n"
  882. " 1600 = VS 10.0\n"
  883. "",
  884. false,
  885. "Variables That Describe the System");
  886. cm->DefineProperty
  887. ("CMAKE_CL_64", cmProperty::VARIABLE,
  888. "Using the 64 bit compiler from Microsoft",
  889. "Set to true when using the 64 bit cl compiler from Microsoft.",
  890. false,
  891. "Variables That Describe the System");
  892. cm->DefineProperty
  893. ("CMAKE_COMPILER_2005", cmProperty::VARIABLE,
  894. "Using the Visual Studio 2005 compiler from Microsoft",
  895. "Set to true when using the Visual Studio 2005 compiler "
  896. "from Microsoft.",
  897. false,
  898. "Variables That Describe the System");
  899. cm->DefineProperty
  900. ("UNIX", cmProperty::VARIABLE,
  901. "True for UNIX and UNIX like operating systems.",
  902. "Set to true when the target system is UNIX or UNIX like "
  903. "(i.e. APPLE and CYGWIN).",false,
  904. "Variables That Describe the System");
  905. cm->DefineProperty
  906. ("WIN32", cmProperty::VARIABLE,
  907. "True on windows systems, including win64.",
  908. "Set to true when the target system is Windows.",false,
  909. "Variables That Describe the System");
  910. cm->DefineProperty
  911. ("XCODE_VERSION", cmProperty::VARIABLE,
  912. "Version of Xcode (Xcode generator only).",
  913. "Under the Xcode generator, this is the version of Xcode as specified in "
  914. "\"Xcode.app/Contents/version.plist\" (such as \"3.1.2\").",false,
  915. "Variables That Describe the System");
  916. cm->DefineProperty
  917. ("CMAKE_HOST_APPLE", cmProperty::VARIABLE,
  918. "True for Apple OSXoperating systems.",
  919. "Set to true when the host system is Apple OSX.",
  920. false,
  921. "Variables That Describe the System");
  922. cm->DefineProperty
  923. ("CMAKE_HOST_UNIX", cmProperty::VARIABLE,
  924. "True for UNIX and UNIX like operating systems.",
  925. "Set to true when the host system is UNIX or UNIX like "
  926. "(i.e. APPLE and CYGWIN).",false,
  927. "Variables That Describe the System");
  928. cm->DefineProperty
  929. ("CMAKE_HOST_WIN32", cmProperty::VARIABLE,
  930. "True on windows systems, including win64.",
  931. "Set to true when the host system is Windows and on cygwin.",false,
  932. "Variables That Describe the System");
  933. cm->DefineProperty
  934. ("CMAKE_OBJECT_PATH_MAX", cmProperty::VARIABLE,
  935. "Maximum object file full-path length allowed by native build tools.",
  936. "CMake computes for every source file an object file name that is "
  937. "unique to the source file and deterministic with respect to the "
  938. "full path to the source file. "
  939. "This allows multiple source files in a target to share the same name "
  940. "if they lie in different directories without rebuilding when one is "
  941. "added or removed. "
  942. "However, it can produce long full paths in a few cases, so CMake "
  943. "shortens the path using a hashing scheme when the full path to an "
  944. "object file exceeds a limit. "
  945. "CMake has a built-in limit for each platform that is sufficient for "
  946. "common tools, but some native tools may have a lower limit. "
  947. "This variable may be set to specify the limit explicitly. "
  948. "The value must be an integer no less than 128.",false,
  949. "Variables That Describe the System");
  950. // Variables that affect the building of object files and
  951. // targets.
  952. //
  953. cm->DefineProperty
  954. ("CMAKE_INCLUDE_CURRENT_DIR", cmProperty::VARIABLE,
  955. "Automatically add the current source- and build directories "
  956. "to the include path.",
  957. "If this variable is enabled, CMake automatically adds in each "
  958. "directory ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} "
  959. "to the include path for this directory. These additional include "
  960. "directories do not propagate down to subdirectories. This is useful "
  961. "mainly for out-of-source builds, where files generated into the "
  962. "build tree are included by files located in the source tree.\n"
  963. "By default CMAKE_INCLUDE_CURRENT_DIR is OFF.",
  964. false,
  965. "Variables that Control the Build");
  966. cm->DefineProperty
  967. ("CMAKE_INSTALL_RPATH", cmProperty::VARIABLE,
  968. "The rpath to use for installed targets.",
  969. "A semicolon-separated list specifying the rpath "
  970. "to use in installed targets (for platforms that support it). "
  971. "This is used to initialize the target property "
  972. "INSTALL_RPATH for all targets.",
  973. false,
  974. "Variables that Control the Build");
  975. cm->DefineProperty
  976. ("CMAKE_INSTALL_RPATH_USE_LINK_PATH", cmProperty::VARIABLE,
  977. "Add paths to linker search and installed rpath.",
  978. "CMAKE_INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true "
  979. "will append directories in the linker search path and outside the "
  980. "project to the INSTALL_RPATH. "
  981. "This is used to initialize the target property "
  982. "INSTALL_RPATH_USE_LINK_PATH for all targets.",
  983. false,
  984. "Variables that Control the Build");
  985. cm->DefineProperty
  986. ("CMAKE_INSTALL_NAME_DIR", cmProperty::VARIABLE,
  987. "Mac OSX directory name for installed targets.",
  988. "CMAKE_INSTALL_NAME_DIR is used to initialize the "
  989. "INSTALL_NAME_DIR property on all targets. See that target "
  990. "property for more information.",
  991. false,
  992. "Variables that Control the Build");
  993. cm->DefineProperty
  994. ("CMAKE_Fortran_FORMAT", cmProperty::VARIABLE,
  995. "Set to FIXED or FREE to indicate the Fortran source layout.",
  996. "This variable is used to initialize the Fortran_FORMAT "
  997. "property on all the targets. "
  998. "See that target property for additional information.",
  999. false,
  1000. "Variables that Control the Build");
  1001. cm->DefineProperty
  1002. ("CMAKE_Fortran_MODULE_DIRECTORY", cmProperty::VARIABLE,
  1003. "Fortran module output directory.",
  1004. "This variable is used to initialize the "
  1005. "Fortran_MODULE_DIRECTORY property on all the targets. "
  1006. "See that target property for additional information.",
  1007. false,
  1008. "Variables that Control the Build");
  1009. cm->DefineProperty
  1010. ("CMAKE_LIBRARY_OUTPUT_DIRECTORY", cmProperty::VARIABLE,
  1011. "Where to put all the LIBRARY targets when built.",
  1012. "This variable is used to initialize the "
  1013. "LIBRARY_OUTPUT_DIRECTORY property on all the targets. "
  1014. "See that target property for additional information.",
  1015. false,
  1016. "Variables that Control the Build");
  1017. cm->DefineProperty
  1018. ("CMAKE_ARCHIVE_OUTPUT_DIRECTORY", cmProperty::VARIABLE,
  1019. "Where to put all the ARCHIVE targets when built.",
  1020. "This variable is used to initialize the "
  1021. "ARCHIVE_OUTPUT_DIRECTORY property on all the targets. "
  1022. "See that target property for additional information.",
  1023. false,
  1024. "Variables that Control the Build");
  1025. cm->DefineProperty
  1026. ("CMAKE_RUNTIME_OUTPUT_DIRECTORY", cmProperty::VARIABLE,
  1027. "Where to put all the RUNTIME targets when built.",
  1028. "This variable is used to initialize the "
  1029. "RUNTIME_OUTPUT_DIRECTORY property on all the targets. "
  1030. "See that target property for additional information.",
  1031. false,
  1032. "Variables that Control the Build");
  1033. cm->DefineProperty
  1034. ("CMAKE_AUTOMOC", cmProperty::VARIABLE,
  1035. "Whether to handle moc automatically for Qt targets.",
  1036. "This variable is used to initialize the "
  1037. "AUTOMOC property on all the targets. "
  1038. "See that target property for additional information.",
  1039. false,
  1040. "Variables that Control the Build");
  1041. cm->DefineProperty
  1042. ("CMAKE_AUTOMOC_MOC_OPTIONS", cmProperty::VARIABLE,
  1043. "Additional options for moc when using automoc (see CMAKE_AUTOMOC).",
  1044. "This variable is used to initialize the "
  1045. "AUTOMOC_MOC_OPTIONS property on all the targets. "
  1046. "See that target property for additional information.",
  1047. false,
  1048. "Variables that Control the Build");
  1049. cm->DefineProperty
  1050. ("CMAKE_GNUtoMS", cmProperty::VARIABLE,
  1051. "Convert GNU import libraries (.dll.a) to MS format (.lib).",
  1052. "This variable is used to initialize the GNUtoMS property on targets "
  1053. "when they are created. "
  1054. "See that target property for additional information.",
  1055. false,
  1056. "Variables that Control the Build");
  1057. cm->DefineProperty
  1058. ("CMAKE_DEBUG_POSTFIX", cmProperty::VARIABLE,
  1059. "See variable CMAKE_<CONFIG>_POSTFIX.",
  1060. "This variable is a special case of the more-general "
  1061. "CMAKE_<CONFIG>_POSTFIX variable for the DEBUG configuration.",
  1062. false,
  1063. "Variables that Control the Build");
  1064. cm->DefineProperty
  1065. ("CMAKE_<CONFIG>_POSTFIX", cmProperty::VARIABLE,
  1066. "Default filename postfix for libraries under configuration <CONFIG>.",
  1067. "When a non-executable target is created its <CONFIG>_POSTFIX "
  1068. "target property is initialized with the value of this variable "
  1069. "if it is set.",
  1070. false,
  1071. "Variables that Control the Build");
  1072. cm->DefineProperty
  1073. ("CMAKE_BUILD_WITH_INSTALL_RPATH", cmProperty::VARIABLE,
  1074. "Use the install path for the RPATH",
  1075. "Normally CMake uses the build tree for the RPATH when building "
  1076. "executables etc on systems that use RPATH. When the software "
  1077. "is installed the executables etc are relinked by CMake to have "
  1078. "the install RPATH. If this variable is set to true then the software "
  1079. "is always built with the install path for the RPATH and does not "
  1080. "need to be relinked when installed.",false,
  1081. "Variables that Control the Build");
  1082. cm->DefineProperty
  1083. ("CMAKE_NO_BUILTIN_CHRPATH", cmProperty::VARIABLE,
  1084. "Do not use the builtin ELF editor to fix RPATHs on installation.",
  1085. "When an ELF binary needs to have a different RPATH after installation "
  1086. "than it does in the build tree, CMake uses a builtin editor to change "
  1087. "the RPATH in the installed copy. "
  1088. "If this variable is set to true then CMake will relink the binary "
  1089. "before installation instead of using its builtin editor.",false,
  1090. "Variables that Control the Build");
  1091. cm->DefineProperty
  1092. ("CMAKE_SKIP_BUILD_RPATH", cmProperty::VARIABLE,
  1093. "Do not include RPATHs in the build tree.",
  1094. "Normally CMake uses the build tree for the RPATH when building "
  1095. "executables etc on systems that use RPATH. When the software "
  1096. "is installed the executables etc are relinked by CMake to have "
  1097. "the install RPATH. If this variable is set to true then the software "
  1098. "is always built with no RPATH.",false,
  1099. "Variables that Control the Build");
  1100. cm->DefineProperty
  1101. ("CMAKE_EXE_LINKER_FLAGS", cmProperty::VARIABLE,
  1102. "Linker flags used to create executables.",
  1103. "Flags used by the linker when creating an executable.",false,
  1104. "Variables that Control the Build");
  1105. cm->DefineProperty
  1106. ("CMAKE_EXE_LINKER_FLAGS_[CMAKE_BUILD_TYPE]", cmProperty::VARIABLE,
  1107. "Flag used when linking an executable.",
  1108. "Same as CMAKE_C_FLAGS_* but used by the linker "
  1109. "when creating executables.",false,
  1110. "Variables that Control the Build");
  1111. cm->DefineProperty
  1112. ("CMAKE_LIBRARY_PATH_FLAG", cmProperty::VARIABLE,
  1113. "The flag used to add a library search path to a compiler.",
  1114. "The flag used to specify a library directory to the compiler. "
  1115. "On most compilers this is \"-L\".",false,
  1116. "Variables that Control the Build");
  1117. cm->DefineProperty
  1118. ("CMAKE_LINK_DEF_FILE_FLAG ", cmProperty::VARIABLE,
  1119. "Linker flag used to specify a .def file for dll creation.",
  1120. "The flag used to add a .def file when creating "
  1121. "a dll on Windows, this is only defined on Windows.",false,
  1122. "Variables that Control the Build");
  1123. cm->DefineProperty
  1124. ("CMAKE_LINK_LIBRARY_FLAG", cmProperty::VARIABLE,
  1125. "Flag used to link a library into an executable.",
  1126. "The flag used to specify a library to link to an executable. "
  1127. "On most compilers this is \"-l\".",false,
  1128. "Variables that Control the Build");
  1129. cm->DefineProperty
  1130. ("CMAKE_LINK_LIBRARY_FILE_FLAG", cmProperty::VARIABLE,
  1131. "Flag used to link a library specified by a path to its file.",
  1132. "The flag used before a library file path is given to the linker. "
  1133. "This is needed only on very few platforms.", false,
  1134. "Variables that Control the Build");
  1135. cm->DefineProperty
  1136. ("CMAKE_USE_RELATIVE_PATHS", cmProperty::VARIABLE,
  1137. "Use relative paths (May not work!).",
  1138. "If this is set to TRUE, then the CMake will use "
  1139. "relative paths between the source and binary tree. "
  1140. "This option does not work for more complicated "
  1141. "projects, and relative paths are used when possible. "
  1142. "In general, it is not possible to move CMake generated"
  1143. " makefiles to a different location regardless "
  1144. "of the value of this variable.",false,
  1145. "Variables that Control the Build");
  1146. cm->DefineProperty
  1147. ("EXECUTABLE_OUTPUT_PATH", cmProperty::VARIABLE,
  1148. "Old executable location variable.",
  1149. "The target property RUNTIME_OUTPUT_DIRECTORY supercedes "
  1150. "this variable for a target if it is set. "
  1151. "Executable targets are otherwise placed in this directory.",false,
  1152. "Variables that Control the Build");
  1153. cm->DefineProperty
  1154. ("LIBRARY_OUTPUT_PATH", cmProperty::VARIABLE,
  1155. "Old library location variable.",
  1156. "The target properties ARCHIVE_OUTPUT_DIRECTORY, "
  1157. "LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY supercede "
  1158. "this variable for a target if they are set. "
  1159. "Library targets are otherwise placed in this directory.",false,
  1160. "Variables that Control the Build");
  1161. cm->DefineProperty
  1162. ("CMAKE_TRY_COMPILE_CONFIGURATION", cmProperty::VARIABLE,
  1163. "Build configuration used for try_compile and try_run projects.",
  1164. "Projects built by try_compile and try_run are built "
  1165. "synchronously during the CMake configuration step. "
  1166. "Therefore a specific build configuration must be chosen even "
  1167. "if the generated build system supports multiple configurations.",false,
  1168. "Variables that Control the Build");
  1169. cm->DefineProperty
  1170. ("CMAKE_LINK_INTERFACE_LIBRARIES", cmProperty::VARIABLE,
  1171. "Default value for LINK_INTERFACE_LIBRARIES of targets.",
  1172. "This variable is used to initialize the "
  1173. "LINK_INTERFACE_LIBRARIES property on all the targets. "
  1174. "See that target property for additional information.",
  1175. false,
  1176. "Variables that Control the Build");
  1177. // Variables defined when the a language is enabled These variables will
  1178. // also be defined whenever CMake has loaded its support for compiling (LANG)
  1179. // programs. This support will be loaded whenever CMake is used to compile
  1180. // (LANG) files. C and CXX are examples of the most common values for (LANG).
  1181. cm->DefineProperty
  1182. ("CMAKE_USER_MAKE_RULES_OVERRIDE_<LANG>", cmProperty::VARIABLE,
  1183. "Specify a CMake file that overrides platform information for <LANG>.",
  1184. "This is a language-specific version of "
  1185. "CMAKE_USER_MAKE_RULES_OVERRIDE loaded only when enabling "
  1186. "language <LANG>.",false,
  1187. "Variables for Languages");
  1188. cm->DefineProperty
  1189. ("CMAKE_<LANG>_COMPILER", cmProperty::VARIABLE,
  1190. "The full path to the compiler for LANG.",
  1191. "This is the command that will be used as the <LANG> compiler. "
  1192. "Once set, you can not change this variable.",false,
  1193. "Variables for Languages");
  1194. cm->DefineProperty
  1195. ("CMAKE_<LANG>_COMPILER_ID", cmProperty::VARIABLE,
  1196. "An internal variable subject to change.",
  1197. "This is used in determining the compiler and is subject to change.",
  1198. false,
  1199. "Variables for Languages");
  1200. cm->DefineProperty
  1201. ("CMAKE_<LANG>_PLATFORM_ID", cmProperty::VARIABLE,
  1202. "An internal variable subject to change.",
  1203. "This is used in determining the platform and is subject to change.",
  1204. false,
  1205. "Variables for Languages");
  1206. cm->DefineProperty
  1207. ("CMAKE_<LANG>_COMPILER_ABI", cmProperty::VARIABLE,
  1208. "An internal variable subject to change.",
  1209. "This is used in determining the compiler ABI and is subject to change.",
  1210. false,
  1211. "Variables for Languages");
  1212. cm->DefineProperty
  1213. ("CMAKE_<LANG>_COMPILER_VERSION", cmProperty::VARIABLE,
  1214. "An internal variable subject to change.",
  1215. "Compiler version in major[.minor[.patch[.tweak]]] format. "
  1216. "This variable is reserved for internal use by CMake and is not "
  1217. "guaranteed to be set.",
  1218. false,
  1219. "Variables for Languages");
  1220. cm->DefineProperty
  1221. ("CMAKE_INTERNAL_PLATFORM_ABI", cmProperty::VARIABLE,
  1222. "An internal variable subject to change.",
  1223. "This is used in determining the compiler ABI and is subject to change.",
  1224. false,
  1225. "Variables for Languages");
  1226. cm->DefineProperty
  1227. ("CMAKE_<LANG>_SIZEOF_DATA_PTR", cmProperty::VARIABLE,
  1228. "Size of pointer-to-data types for language <LANG>.",
  1229. "This holds the size (in bytes) of pointer-to-data types in the target "
  1230. "platform ABI. "
  1231. "It is defined for languages C and CXX (C++).",
  1232. false,
  1233. "Variables for Languages");
  1234. cm->DefineProperty
  1235. ("CMAKE_COMPILER_IS_GNU<LANG>", cmProperty::VARIABLE,
  1236. "True if the compiler is GNU.",
  1237. "If the selected <LANG> compiler is the GNU "
  1238. "compiler then this is TRUE, if not it is FALSE.",false,
  1239. "Variables for Languages");
  1240. cm->DefineProperty
  1241. ("CMAKE_<LANG>_FLAGS_DEBUG", cmProperty::VARIABLE,
  1242. "Flags for Debug build type or configuration.",
  1243. "<LANG> flags used when CMAKE_BUILD_TYPE is Debug.",false,
  1244. "Variables for Languages");
  1245. cm->DefineProperty
  1246. ("CMAKE_<LANG>_FLAGS_MINSIZEREL", cmProperty::VARIABLE,
  1247. "Flags for MinSizeRel build type or configuration.",
  1248. "<LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel."
  1249. "Short for minimum size release.",false,
  1250. "Variables for Languages");
  1251. cm->DefineProperty
  1252. ("CMAKE_<LANG>_FLAGS_RELEASE", cmProperty::VARIABLE,
  1253. "Flags for Release build type or configuration.",
  1254. "<LANG> flags used when CMAKE_BUILD_TYPE is Release",false,
  1255. "Variables for Languages");
  1256. cm->DefineProperty
  1257. ("CMAKE_<LANG>_FLAGS_RELWITHDEBINFO", cmProperty::VARIABLE,
  1258. "Flags for RelWithDebInfo type or configuration.",
  1259. "<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo. "
  1260. "Short for Release With Debug Information.",false,
  1261. "Variables for Languages");
  1262. cm->DefineProperty
  1263. ("CMAKE_<LANG>_COMPILE_OBJECT", cmProperty::VARIABLE,
  1264. "Rule variable to compile a single object file.",
  1265. "This is a rule variable that tells CMake how to "
  1266. "compile a single object file for for the language <LANG>.",false,
  1267. "Variables for Languages");
  1268. cm->DefineProperty
  1269. ("CMAKE_<LANG>_CREATE_SHARED_LIBRARY", cmProperty::VARIABLE,
  1270. "Rule variable to create a shared library.",
  1271. "This is a rule variable that tells CMake how to "
  1272. "create a shared library for the language <LANG>.",false,
  1273. "Variables for Languages");
  1274. cm->DefineProperty
  1275. ("CMAKE_<LANG>_CREATE_SHARED_MODULE", cmProperty::VARIABLE,
  1276. "Rule variable to create a shared module.",
  1277. "This is a rule variable that tells CMake how to "
  1278. "create a shared library for the language <LANG>.",false,
  1279. "Variables for Languages");
  1280. cm->DefineProperty
  1281. ("CMAKE_<LANG>_CREATE_STATIC_LIBRARY", cmProperty::VARIABLE,
  1282. "Rule variable to create a static library.",
  1283. "This is a rule variable that tells CMake how "
  1284. "to create a static library for the language <LANG>.",false,
  1285. "Variables for Languages");
  1286. cm->DefineProperty
  1287. ("CMAKE_<LANG>_ARCHIVE_CREATE", cmProperty::VARIABLE,
  1288. "Rule variable to create a new static archive.",
  1289. "This is a rule variable that tells CMake how to create a static "
  1290. "archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY "
  1291. "on some platforms in order to support large object counts. "
  1292. "See also CMAKE_<LANG>_ARCHIVE_APPEND and CMAKE_<LANG>_ARCHIVE_FINISH.",
  1293. false, "Variables for Languages");
  1294. cm->DefineProperty
  1295. ("CMAKE_<LANG>_ARCHIVE_APPEND", cmProperty::VARIABLE,
  1296. "Rule variable to append to a static archive.",
  1297. "This is a rule variable that tells CMake how to append to a static "
  1298. "archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY "
  1299. "on some platforms in order to support large object counts. "
  1300. "See also CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_FINISH.",
  1301. false, "Variables for Languages");
  1302. cm->DefineProperty
  1303. ("CMAKE_<LANG>_ARCHIVE_FINISH", cmProperty::VARIABLE,
  1304. "Rule variable to finish an existing static archive.",
  1305. "This is a rule variable that tells CMake how to finish a static "
  1306. "archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY "
  1307. "on some platforms in order to support large object counts. "
  1308. "See also CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_APPEND.",
  1309. false, "Variables for Languages");
  1310. cm->DefineProperty
  1311. ("CMAKE_<LANG>_IGNORE_EXTENSIONS", cmProperty::VARIABLE,
  1312. "File extensions that should be ignored by the build.",
  1313. "This is a list of file extensions that may be "
  1314. "part of a project for a given language but are not compiled. ",false,
  1315. "Variables for Languages");
  1316. cm->DefineProperty
  1317. ("CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES", cmProperty::VARIABLE,
  1318. "Directories implicitly searched by the compiler for header files.",
  1319. "CMake does not explicitly specify these directories on compiler "
  1320. "command lines for language <LANG>. "
  1321. "This prevents system include directories from being treated as user "
  1322. "include directories on some compilers.", false,
  1323. "Variables for Languages");
  1324. cm->DefineProperty
  1325. ("CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES", cmProperty::VARIABLE,
  1326. "Implicit linker search path detected for language <LANG>.",
  1327. "Compilers typically pass directories containing language runtime "
  1328. "libraries and default library search paths when they invoke a linker. "
  1329. "These paths are implicit linker search directories for the compiler's "
  1330. "language. "
  1331. "CMake automatically detects these directories for each language and "
  1332. "reports the results in this variable.", false,
  1333. "Variables for Languages");
  1334. cm->DefineProperty
  1335. ("CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES", cmProperty::VARIABLE,
  1336. "Implicit link libraries and flags detected for language <LANG>.",
  1337. "Compilers typically pass language runtime library names and "
  1338. "other flags when they invoke a linker. "
  1339. "These flags are implicit link options for the compiler's language. "
  1340. "CMake automatically detects these libraries and flags for each "
  1341. "language and reports the results in this variable.", false,
  1342. "Variables for Languages");
  1343. cm->DefineProperty
  1344. ("CMAKE_<LANG>_LIBRARY_ARCHITECTURE", cmProperty::VARIABLE,
  1345. "Target architecture library directory name detected for <lang>.",
  1346. "If the <lang> compiler passes to the linker an architecture-specific "
  1347. "system library search directory such as <prefix>/lib/<arch> this "
  1348. "variable contains the <arch> name if/as detected by CMake.",false,
  1349. "Variables for Languages");
  1350. cm->DefineProperty
  1351. ("CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES", cmProperty::VARIABLE,
  1352. "True if CMAKE_<LANG>_LINKER_PREFERENCE propagates across targets.",
  1353. "This is used when CMake selects a linker language for a target. "
  1354. "Languages compiled directly into the target are always considered. "
  1355. "A language compiled into static libraries linked by the target is "
  1356. "considered if this variable is true.", false,
  1357. "Variables for Languages");
  1358. cm->DefineProperty
  1359. ("CMAKE_<LANG>_LINKER_PREFERENCE", cmProperty::VARIABLE,
  1360. "Preference value for linker language selection.",
  1361. "The \"linker language\" for executable, shared library, and module "
  1362. "targets is the language whose compiler will invoke the linker. "
  1363. "The LINKER_LANGUAGE target property sets the language explicitly. "
  1364. "Otherwise, the linker language is that whose linker preference value "
  1365. "is highest among languages compiled and linked into the target. "
  1366. "See also the CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES variable.",
  1367. false,
  1368. "Variables for Languages");
  1369. cm->DefineProperty
  1370. ("CMAKE_<LANG>_LINK_EXECUTABLE ", cmProperty::VARIABLE,
  1371. "Rule variable to link and executable.",
  1372. "Rule variable to link and executable for the given language.",false,
  1373. "Variables for Languages");
  1374. cm->DefineProperty
  1375. ("CMAKE_<LANG>_OUTPUT_EXTENSION", cmProperty::VARIABLE,
  1376. "Extension for the output of a compile for a single file.",
  1377. "This is the extension for an object file for "
  1378. "the given <LANG>. For example .obj for C on Windows.",false,
  1379. "Variables for Languages");
  1380. cm->DefineProperty
  1381. ("CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS", cmProperty::VARIABLE,
  1382. "Extensions of source files for the given language.",
  1383. "This is the list of extensions for a "
  1384. "given languages source files.",false,"Variables for Languages");
  1385. cm->DefineProperty(
  1386. "CMAKE_<LANG>_COMPILER_LOADED", cmProperty::VARIABLE,
  1387. "Defined to true if the language is enabled.",
  1388. "When language <LANG> is enabled by project() or enable_language() "
  1389. "this variable is defined to 1.",
  1390. false,"Variables for Languages");
  1391. cm->DefineProperty(
  1392. "CMAKE_Fortran_MODDIR_FLAG", cmProperty::VARIABLE,
  1393. "Fortran flag for module output directory.",
  1394. "This stores the flag needed to pass the value of the "
  1395. "Fortran_MODULE_DIRECTORY target property to the compiler.",
  1396. false,"Variables for Languages");
  1397. cm->DefineProperty(
  1398. "CMAKE_Fortran_MODDIR_DEFAULT", cmProperty::VARIABLE,
  1399. "Fortran default module output directory.",
  1400. "Most Fortran compilers write .mod files to the current working "
  1401. "directory. "
  1402. "For those that do not, this is set to \".\" and used when the "
  1403. "Fortran_MODULE_DIRECTORY target property is not set.",
  1404. false,"Variables for Languages");
  1405. cm->DefineProperty(
  1406. "CMAKE_Fortran_MODOUT_FLAG", cmProperty::VARIABLE,
  1407. "Fortran flag to enable module output.",
  1408. "Most Fortran compilers write .mod files out by default. "
  1409. "For others, this stores the flag needed to enable module output.",
  1410. false,"Variables for Languages");
  1411. // variables that are used by cmake but not to be documented
  1412. cm->DefineProperty("CMAKE_MATCH_0", cmProperty::VARIABLE,0,0);
  1413. cm->DefineProperty("CMAKE_MATCH_1", cmProperty::VARIABLE,0,0);
  1414. cm->DefineProperty("CMAKE_MATCH_2", cmProperty::VARIABLE,0,0);
  1415. cm->DefineProperty("CMAKE_MATCH_3", cmProperty::VARIABLE,0,0);
  1416. cm->DefineProperty("CMAKE_MATCH_4", cmProperty::VARIABLE,0,0);
  1417. cm->DefineProperty("CMAKE_MATCH_5", cmProperty::VARIABLE,0,0);
  1418. cm->DefineProperty("CMAKE_MATCH_6", cmProperty::VARIABLE,0,0);
  1419. cm->DefineProperty("CMAKE_MATCH_7", cmProperty::VARIABLE,0,0);
  1420. cm->DefineProperty("CMAKE_MATCH_8", cmProperty::VARIABLE,0,0);
  1421. cm->DefineProperty("CMAKE_MATCH_9", cmProperty::VARIABLE,0,0);
  1422. cm->DefineProperty("CMAKE_<LANG>_COMPILER_ARG1",
  1423. cmProperty::VARIABLE,0,0);
  1424. cm->DefineProperty("CMAKE_<LANG>_COMPILER_ENV_VAR",
  1425. cmProperty::VARIABLE,0,0);
  1426. cm->DefineProperty("CMAKE_<LANG>_COMPILER_ID_RUN",
  1427. cmProperty::VARIABLE,0,0);
  1428. cm->DefineProperty("CMAKE_<LANG>_ABI_FILES",
  1429. cmProperty::VARIABLE,0,0);
  1430. cm->DefineProperty("CMAKE_<LANG>_CREATE_ASSEMBLY_SOURCE",
  1431. cmProperty::VARIABLE,0,0);
  1432. cm->DefineProperty("CMAKE_<LANG>_CREATE_PREPROCESSED_SOURCE",
  1433. cmProperty::VARIABLE,0,0);
  1434. cm->DefineProperty("CMAKE_<LANG>_FLAGS",
  1435. cmProperty::VARIABLE,0,0);
  1436. cm->DefineProperty("CMAKE_<LANG>_FLAGS_DEBUG_INIT",
  1437. cmProperty::VARIABLE,0,0);
  1438. cm->DefineProperty("CMAKE_<LANG>_FLAGS_INIT",
  1439. cmProperty::VARIABLE,0,0);
  1440. cm->DefineProperty("CMAKE_<LANG>_FLAGS_MINSIZEREL_INIT",
  1441. cmProperty::VARIABLE,0,0);
  1442. cm->DefineProperty("CMAKE_<LANG>_FLAGS_RELEASE_INIT",
  1443. cmProperty::VARIABLE,0,0);
  1444. cm->DefineProperty("CMAKE_<LANG>_FLAGS_RELWITHDEBINFO_INIT",
  1445. cmProperty::VARIABLE,0,0);
  1446. cm->DefineProperty("CMAKE_<LANG>_INFORMATION_LOADED",
  1447. cmProperty::VARIABLE,0,0);
  1448. cm->DefineProperty("CMAKE_<LANG>_LINK_EXECUTABLE",
  1449. cmProperty::VARIABLE,0,0);
  1450. cm->DefineProperty("CMAKE_<LANG>_LINK_FLAGS",
  1451. cmProperty::VARIABLE,0,0);
  1452. cm->DefineProperty("CMAKE_<LANG>_RESPONSE_FILE_LINK_FLAG",
  1453. cmProperty::VARIABLE,0,0);
  1454. cm->DefineProperty("CMAKE_<LANG>_STANDARD_LIBRARIES",
  1455. cmProperty::VARIABLE,0,0);
  1456. cm->DefineProperty("CMAKE_<LANG>_STANDARD_LIBRARIES_INIT",
  1457. cmProperty::VARIABLE,0,0);
  1458. cm->DefineProperty("CMAKE_<LANG>_USE_RESPONSE_FILE_FOR_INCLUDES",
  1459. cmProperty::VARIABLE,0,0);
  1460. cm->DefineProperty("CMAKE_<LANG>_USE_RESPONSE_FILE_FOR_OBJECTS",
  1461. cmProperty::VARIABLE,0,0);
  1462. cm->DefineProperty("CMAKE_EXECUTABLE_SUFFIX_<LANG>",
  1463. cmProperty::VARIABLE,0,0);
  1464. cm->DefineProperty("CMAKE_EXE_LINK_DYNAMIC_<LANG>_FLAGS",
  1465. cmProperty::VARIABLE,0,0);
  1466. cm->DefineProperty("CMAKE_EXE_LINK_STATIC_<LANG>_FLAGS",
  1467. cmProperty::VARIABLE,0,0);
  1468. cm->DefineProperty("CMAKE_GENERATOR_<LANG>",
  1469. cmProperty::VARIABLE,0,0);
  1470. cm->DefineProperty("CMAKE_IMPORT_LIBRARY_PREFIX_<LANG>",
  1471. cmProperty::VARIABLE,0,0);
  1472. cm->DefineProperty("CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG>",
  1473. cmProperty::VARIABLE,0,0);
  1474. cm->DefineProperty("CMAKE_INCLUDE_FLAG_<LANG>",
  1475. cmProperty::VARIABLE,0,0);
  1476. cm->DefineProperty("CMAKE_INCLUDE_FLAG_SEP_<LANG>",
  1477. cmProperty::VARIABLE,0,0);
  1478. cm->DefineProperty("CMAKE_INCLUDE_SYSTEM_FLAG_<LANG>",
  1479. cmProperty::VARIABLE,0,0);
  1480. cm->DefineProperty("CMAKE_NEEDS_REQUIRES_STEP_<LANG>_FLAG",
  1481. cmProperty::VARIABLE,0,0);
  1482. cm->DefineProperty("CMAKE_SHARED_LIBRARY_CREATE_<LANG>_FLAGS",
  1483. cmProperty::VARIABLE,0,0);
  1484. cm->DefineProperty("CMAKE_SHARED_LIBRARY_<LANG>_FLAGS",
  1485. cmProperty::VARIABLE,0,0);
  1486. cm->DefineProperty("CMAKE_SHARED_LIBRARY_LINK_<LANG>_FLAGS",
  1487. cmProperty::VARIABLE,0,0);
  1488. cm->DefineProperty("CMAKE_SHARED_LIBRARY_LINK_DYNAMIC_<LANG>_FLAGS",
  1489. cmProperty::VARIABLE,0,0);
  1490. cm->DefineProperty("CMAKE_SHARED_LIBRARY_LINK_STATIC_<LANG>_FLAGS",
  1491. cmProperty::VARIABLE,0,0);
  1492. cm->DefineProperty("CMAKE_SHARED_LIBRARY_PREFIX_<LANG>",
  1493. cmProperty::VARIABLE,0,0);
  1494. cm->DefineProperty("CMAKE_SHARED_LIBRARY_SUFFIX_<LANG>",
  1495. cmProperty::VARIABLE,0,0);
  1496. cm->DefineProperty("CMAKE_SHARED_LIBRARY_RUNTIME_<LANG>_FLAG",
  1497. cmProperty::VARIABLE,0,0);
  1498. cm->DefineProperty("CMAKE_SHARED_LIBRARY_RUNTIME_<LANG>_FLAG_SEP",
  1499. cmProperty::VARIABLE,0,0);
  1500. cm->DefineProperty("CMAKE_SHARED_LIBRARY_RPATH_LINK_<LANG>_FLAG",
  1501. cmProperty::VARIABLE,0,0);
  1502. cm->DefineProperty("CMAKE_EXECUTABLE_RUNTIME_<LANG>_FLAG",
  1503. cmProperty::VARIABLE,0,0);
  1504. cm->DefineProperty("CMAKE_EXECUTABLE_RUNTIME_<LANG>_FLAG_SEP",
  1505. cmProperty::VARIABLE,0,0);
  1506. cm->DefineProperty("CMAKE_EXECUTABLE_RPATH_LINK_<LANG>_FLAG",
  1507. cmProperty::VARIABLE,0,0);
  1508. cm->DefineProperty("CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH",
  1509. cmProperty::VARIABLE,0,0);
  1510. cm->DefineProperty("CMAKE_SHARED_MODULE_CREATE_<LANG>_FLAGS",
  1511. cmProperty::VARIABLE,0,0);
  1512. cm->DefineProperty("CMAKE_SHARED_MODULE_<LANG>_FLAGS",
  1513. cmProperty::VARIABLE,0,0);
  1514. cm->DefineProperty("CMAKE_SHARED_MODULE_LINK_DYNAMIC_<LANG>_FLAGS",
  1515. cmProperty::VARIABLE,0,0);
  1516. cm->DefineProperty("CMAKE_SHARED_MODULE_LINK_STATIC_<LANG>_FLAGS",
  1517. cmProperty::VARIABLE,0,0);
  1518. cm->DefineProperty("CMAKE_SHARED_MODULE_PREFIX_<LANG>",
  1519. cmProperty::VARIABLE,0,0);
  1520. cm->DefineProperty("CMAKE_SHARED_MODULE_SUFFIX_<LANG>",
  1521. cmProperty::VARIABLE,0,0);
  1522. cm->DefineProperty("CMAKE_STATIC_LIBRARY_PREFIX_<LANG>",
  1523. cmProperty::VARIABLE,0,0);
  1524. cm->DefineProperty("CMAKE_STATIC_LIBRARY_SUFFIX_<LANG>",
  1525. cmProperty::VARIABLE,0,0);
  1526. cm->DefineProperty("CMAKE_LINK_DEPENDENT_LIBRARY_FILES",
  1527. cmProperty::VARIABLE,0,0);
  1528. cm->DefineProperty("CMAKE_LINK_DEPENDENT_LIBRARY_DIRS",
  1529. cmProperty::VARIABLE,0,0);
  1530. cm->DefineProperty("CMAKE_MAKE_INCLUDE_FROM_ROOT",
  1531. cmProperty::VARIABLE,0,0);
  1532. }