diff options
| author | Kitware Robot <kwrobot@kitware.com> | 2013-10-15 15:17:36 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-10-15 18:12:03 (GMT) |
| commit | f051814ed0e63badbfd68049354f36259dbf4b49 (patch) | |
| tree | f4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help | |
| parent | e94958e99c4dec26c86ce8b76d744c04ba960675 (diff) | |
| download | CMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2 | |
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation:
./convert-help.bash "/path/to/CMake-build/bin"
Then remove it.
Diffstat (limited to 'Help')
824 files changed, 14087 insertions, 0 deletions
diff --git a/Help/command/add_compile_options.rst b/Help/command/add_compile_options.rst new file mode 100644 index 0000000..f086e57 --- /dev/null +++ b/Help/command/add_compile_options.rst @@ -0,0 +1,89 @@ +add_compile_options +------------------- + +Adds options to the compilation of source files. + +:: + + add_compile_options(<option> ...) + +Adds options to the compiler command line for sources in the current +directory and below. This command can be used to add any options, but +alternative commands exist to add preprocessor definitions or include +directories. See documentation of the directory and target +COMPILE_OPTIONS properties for details. Arguments to +add_compile_options may use "generator expressions" with the syntax +"$<...>". Generator expressions are evaluated during build system +generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/command/add_custom_command.rst b/Help/command/add_custom_command.rst new file mode 100644 index 0000000..cf1661f --- /dev/null +++ b/Help/command/add_custom_command.rst @@ -0,0 +1,206 @@ +add_custom_command +------------------ + +Add a custom build rule to the generated build system. + +There are two main signatures for add_custom_command The first +signature is for adding a custom command to produce an output. + +:: + + add_custom_command(OUTPUT output1 [output2 ...] + COMMAND command1 [ARGS] [args1...] + [COMMAND command2 [ARGS] [args2...] ...] + [MAIN_DEPENDENCY depend] + [DEPENDS [depends...]] + [IMPLICIT_DEPENDS <lang1> depend1 + [<lang2> depend2] ...] + [WORKING_DIRECTORY dir] + [COMMENT comment] [VERBATIM] [APPEND]) + +This defines a command to generate specified OUTPUT file(s). A target +created in the same directory (CMakeLists.txt file) that specifies any +output of the custom command as a source file is given a rule to +generate the file using the command at build time. Do not list the +output in more than one independent target that may build in parallel +or the two instances of the rule may conflict (instead use +add_custom_target to drive the command and make the other targets +depend on that one). If an output name is a relative path it will be +interpreted relative to the build tree directory corresponding to the +current source directory. Note that MAIN_DEPENDENCY is completely +optional and is used as a suggestion to visual studio about where to +hang the custom command. In makefile terms this creates a new target +in the following form: + +:: + + OUTPUT: MAIN_DEPENDENCY DEPENDS + COMMAND + +If more than one command is specified they will be executed in order. +The optional ARGS argument is for backward compatibility and will be +ignored. + +The second signature adds a custom command to a target such as a +library or executable. This is useful for performing an operation +before or after building the target. The command becomes part of the +target and will only execute when the target itself is built. If the +target is already built, the command will not execute. + +:: + + add_custom_command(TARGET target + PRE_BUILD | PRE_LINK | POST_BUILD + COMMAND command1 [ARGS] [args1...] + [COMMAND command2 [ARGS] [args2...] ...] + [WORKING_DIRECTORY dir] + [COMMENT comment] [VERBATIM]) + +This defines a new command that will be associated with building the +specified target. When the command will happen is determined by which +of the following is specified: + +:: + + PRE_BUILD - run before all other dependencies + PRE_LINK - run after other dependencies + POST_BUILD - run after the target has been built + +Note that the PRE_BUILD option is only supported on Visual Studio 7 or +later. For all other generators PRE_BUILD will be treated as +PRE_LINK. + +If WORKING_DIRECTORY is specified the command will be executed in the +directory given. If it is a relative path it will be interpreted +relative to the build tree directory corresponding to the current +source directory. If COMMENT is set, the value will be displayed as a +message before the commands are executed at build time. If APPEND is +specified the COMMAND and DEPENDS option values are appended to the +custom command for the first output specified. There must have +already been a previous call to this command with the same output. +The COMMENT, WORKING_DIRECTORY, and MAIN_DEPENDENCY options are +currently ignored when APPEND is given, but may be used in the future. + +If VERBATIM is given then all arguments to the commands will be +escaped properly for the build tool so that the invoked command +receives each argument unchanged. Note that one level of escapes is +still used by the CMake language processor before add_custom_command +even sees the arguments. Use of VERBATIM is recommended as it enables +correct behavior. When VERBATIM is not given the behavior is platform +specific because there is no protection of tool-specific special +characters. + +If the output of the custom command is not actually created as a file +on disk it should be marked as SYMBOLIC with +SET_SOURCE_FILES_PROPERTIES. + +The IMPLICIT_DEPENDS option requests scanning of implicit dependencies +of an input file. The language given specifies the programming +language whose corresponding dependency scanner should be used. +Currently only C and CXX language scanners are supported. The +language has to be specified for every file in the IMPLICIT_DEPENDS +list. Dependencies discovered from the scanning are added to those of +the custom command at build time. Note that the IMPLICIT_DEPENDS +option is currently supported only for Makefile generators and will be +ignored by other generators. + +If COMMAND specifies an executable target (created by ADD_EXECUTABLE) +it will automatically be replaced by the location of the executable +created at build time. Additionally a target-level dependency will be +added so that the executable target will be built before any target +using this custom command. However this does NOT add a file-level +dependency that would cause the custom command to re-run whenever the +executable is recompiled. + +Arguments to COMMAND may use "generator expressions" with the syntax +"$<...>". Generator expressions are evaluated during build system +generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. + +References to target names in generator expressions imply target-level +dependencies, but NOT file-level dependencies. List target names with +the DEPENDS option to add file dependencies. + +The DEPENDS option specifies files on which the command depends. If +any dependency is an OUTPUT of another custom command in the same +directory (CMakeLists.txt file) CMake automatically brings the other +custom command into the target in which this command is built. If +DEPENDS is not specified the command will run whenever the OUTPUT is +missing; if the command does not actually create the OUTPUT then the +rule will always run. If DEPENDS specifies any target (created by an +ADD_* command) a target-level dependency is created to make sure the +target is built before any target using this custom command. +Additionally, if the target is an executable or library a file-level +dependency is created to cause the custom command to re-run whenever +the target is recompiled. diff --git a/Help/command/add_custom_target.rst b/Help/command/add_custom_target.rst new file mode 100644 index 0000000..1bf70bf --- /dev/null +++ b/Help/command/add_custom_target.rst @@ -0,0 +1,45 @@ +add_custom_target +----------------- + +Add a target with no output so it will always be built. + +:: + + add_custom_target(Name [ALL] [command1 [args1...]] + [COMMAND command2 [args2...] ...] + [DEPENDS depend depend depend ... ] + [WORKING_DIRECTORY dir] + [COMMENT comment] [VERBATIM] + [SOURCES src1 [src2...]]) + +Adds a target with the given name that executes the given commands. +The target has no output file and is ALWAYS CONSIDERED OUT OF DATE +even if the commands try to create a file with the name of the target. +Use ADD_CUSTOM_COMMAND to generate a file with dependencies. By +default nothing depends on the custom target. Use ADD_DEPENDENCIES to +add dependencies to or from other targets. If the ALL option is +specified it indicates that this target should be added to the default +build target so that it will be run every time (the command cannot be +called ALL). The command and arguments are optional and if not +specified an empty target will be created. If WORKING_DIRECTORY is +set, then the command will be run in that directory. If it is a +relative path it will be interpreted relative to the build tree +directory corresponding to the current source directory. If COMMENT +is set, the value will be displayed as a message before the commands +are executed at build time. Dependencies listed with the DEPENDS +argument may reference files and outputs of custom commands created +with add_custom_command() in the same directory (CMakeLists.txt file). + +If VERBATIM is given then all arguments to the commands will be +escaped properly for the build tool so that the invoked command +receives each argument unchanged. Note that one level of escapes is +still used by the CMake language processor before add_custom_target +even sees the arguments. Use of VERBATIM is recommended as it enables +correct behavior. When VERBATIM is not given the behavior is platform +specific because there is no protection of tool-specific special +characters. + +The SOURCES option specifies additional source files to be included in +the custom target. Specified source files will be added to IDE +project files for convenience in editing even if they have not build +rules. diff --git a/Help/command/add_definitions.rst b/Help/command/add_definitions.rst new file mode 100644 index 0000000..4c72752 --- /dev/null +++ b/Help/command/add_definitions.rst @@ -0,0 +1,19 @@ +add_definitions +--------------- + +Adds -D define flags to the compilation of source files. + +:: + + add_definitions(-DFOO -DBAR ...) + +Adds flags to the compiler command line for sources in the current +directory and below. This command can be used to add any flags, but +it was originally intended to add preprocessor definitions. Flags +beginning in -D or /D that look like preprocessor definitions are +automatically added to the COMPILE_DEFINITIONS property for the +current directory. Definitions with non-trivial values may be left in +the set of flags instead of being converted for reasons of backwards +compatibility. See documentation of the directory, target, and source +file COMPILE_DEFINITIONS properties for details on adding preprocessor +definitions to specific scopes and configurations. diff --git a/Help/command/add_dependencies.rst b/Help/command/add_dependencies.rst new file mode 100644 index 0000000..10997ec --- /dev/null +++ b/Help/command/add_dependencies.rst @@ -0,0 +1,19 @@ +add_dependencies +---------------- + +Add a dependency between top-level targets. + +:: + + add_dependencies(<target> [<target-dependency>]...) + +Make a top-level <target> depend on other top-level targets to ensure +that they build before <target> does. A top-level target is one +created by ADD_EXECUTABLE, ADD_LIBRARY, or ADD_CUSTOM_TARGET. +Dependencies added to an IMPORTED target are followed transitively in +its place since the target itself does not build. + +See the DEPENDS option of ADD_CUSTOM_TARGET and ADD_CUSTOM_COMMAND for +adding file-level dependencies in custom rules. See the +OBJECT_DEPENDS option in SET_SOURCE_FILES_PROPERTIES to add file-level +dependencies to object files. diff --git a/Help/command/add_executable.rst b/Help/command/add_executable.rst new file mode 100644 index 0000000..656af7c --- /dev/null +++ b/Help/command/add_executable.rst @@ -0,0 +1,73 @@ +add_executable +-------------- + +Add an executable to the project using the specified source files. + +:: + + add_executable(<name> [WIN32] [MACOSX_BUNDLE] + [EXCLUDE_FROM_ALL] + source1 source2 ... sourceN) + +Adds an executable target called <name> to be built from the source +files listed in the command invocation. The <name> corresponds to the +logical target name and must be globally unique within a project. The +actual file name of the executable built is constructed based on +conventions of the native platform (such as <name>.exe or just +<name>). + +By default the executable file will be created in the build tree +directory corresponding to the source tree directory in which the +command was invoked. See documentation of the +RUNTIME_OUTPUT_DIRECTORY target property to change this location. See +documentation of the OUTPUT_NAME target property to change the <name> +part of the final file name. + +If WIN32 is given the property WIN32_EXECUTABLE will be set on the +target created. See documentation of that target property for +details. + +If MACOSX_BUNDLE is given the corresponding property will be set on +the created target. See documentation of the MACOSX_BUNDLE target +property for details. + +If EXCLUDE_FROM_ALL is given the corresponding property will be set on +the created target. See documentation of the EXCLUDE_FROM_ALL target +property for details. + +The add_executable command can also create IMPORTED executable targets +using this signature: + +:: + + add_executable(<name> IMPORTED [GLOBAL]) + +An IMPORTED executable target references an executable file located +outside the project. No rules are generated to build it. The target +name has scope in the directory in which it is created and below, but +the GLOBAL option extends visibility. It may be referenced like any +target built within the project. IMPORTED executables are useful for +convenient reference from commands like add_custom_command. Details +about the imported executable are specified by setting properties +whose names begin in "IMPORTED_". The most important such property is +IMPORTED_LOCATION (and its per-configuration version +IMPORTED_LOCATION_<CONFIG>) which specifies the location of the main +executable file on disk. See documentation of the IMPORTED_* +properties for more information. + +The signature + +:: + + add_executable(<name> ALIAS <target>) + +creates an alias, such that <name> can be used to refer to <target> in +subsequent commands. The <name> does not appear in the generated +buildsystem as a make target. The <target> may not be an IMPORTED +target or an ALIAS. Alias targets can be used as linkable targets, +targets to read properties from, executables for custom commands and +custom targets. They can also be tested for existance with the +regular if(TARGET) subcommand. The <name> may not be used to modify +properties of <target>, that is, it may not be used as the operand of +set_property, set_target_properties, target_link_libraries etc. An +ALIAS target may not be installed of exported. diff --git a/Help/command/add_library.rst b/Help/command/add_library.rst new file mode 100644 index 0000000..174f126 --- /dev/null +++ b/Help/command/add_library.rst @@ -0,0 +1,120 @@ +add_library +----------- + +Add a library to the project using the specified source files. + +:: + + add_library(<name> [STATIC | SHARED | MODULE] + [EXCLUDE_FROM_ALL] + source1 source2 ... sourceN) + +Adds a library target called <name> to be built from the source files +listed in the command invocation. The <name> corresponds to the +logical target name and must be globally unique within a project. The +actual file name of the library built is constructed based on +conventions of the native platform (such as lib<name>.a or +<name>.lib). + +STATIC, SHARED, or MODULE may be given to specify the type of library +to be created. STATIC libraries are archives of object files for use +when linking other targets. SHARED libraries are linked dynamically +and loaded at runtime. MODULE libraries are plugins that are not +linked into other targets but may be loaded dynamically at runtime +using dlopen-like functionality. If no type is given explicitly the +type is STATIC or SHARED based on whether the current value of the +variable BUILD_SHARED_LIBS is true. For SHARED and MODULE libraries +the POSITION_INDEPENDENT_CODE target property is set to TRUE +automatically. + +By default the library file will be created in the build tree +directory corresponding to the source tree directory in which the +command was invoked. See documentation of the +ARCHIVE_OUTPUT_DIRECTORY, LIBRARY_OUTPUT_DIRECTORY, and +RUNTIME_OUTPUT_DIRECTORY target properties to change this location. +See documentation of the OUTPUT_NAME target property to change the +<name> part of the final file name. + +If EXCLUDE_FROM_ALL is given the corresponding property will be set on +the created target. See documentation of the EXCLUDE_FROM_ALL target +property for details. + +The add_library command can also create IMPORTED library targets using +this signature: + +:: + + add_library(<name> <SHARED|STATIC|MODULE|UNKNOWN> IMPORTED + [GLOBAL]) + +An IMPORTED library target references a library file located outside +the project. No rules are generated to build it. The target name has +scope in the directory in which it is created and below, but the +GLOBAL option extends visibility. It may be referenced like any +target built within the project. IMPORTED libraries are useful for +convenient reference from commands like target_link_libraries. +Details about the imported library are specified by setting properties +whose names begin in "IMPORTED_". The most important such property is +IMPORTED_LOCATION (and its per-configuration version +IMPORTED_LOCATION_<CONFIG>) which specifies the location of the main +library file on disk. See documentation of the IMPORTED_* properties +for more information. + +The signature + +:: + + add_library(<name> OBJECT <src>...) + +creates a special "object library" target. An object library compiles +source files but does not archive or link their object files into a +library. Instead other targets created by add_library or +add_executable may reference the objects using an expression of the +form $<TARGET_OBJECTS:objlib> as a source, where "objlib" is the +object library name. For example: + +:: + + add_library(... $<TARGET_OBJECTS:objlib> ...) + add_executable(... $<TARGET_OBJECTS:objlib> ...) + +will include objlib's object files in a library and an executable +along with those compiled from their own sources. Object libraries +may contain only sources (and headers) that compile to object files. +They may contain custom commands generating such sources, but not +PRE_BUILD, PRE_LINK, or POST_BUILD commands. Object libraries cannot +be imported, exported, installed, or linked. Some native build +systems may not like targets that have only object files, so consider +adding at least one real source file to any target that references +$<TARGET_OBJECTS:objlib>. + +The signature + +:: + + add_library(<name> ALIAS <target>) + +creates an alias, such that <name> can be used to refer to <target> in +subsequent commands. The <name> does not appear in the generated +buildsystem as a make target. The <target> may not be an IMPORTED +target or an ALIAS. Alias targets can be used as linkable targets, +targets to read properties from. They can also be tested for +existance with the regular if(TARGET) subcommand. The <name> may not +be used to modify properties of <target>, that is, it may not be used +as the operand of set_property, set_target_properties, +target_link_libraries etc. An ALIAS target may not be installed of +exported. + +The signature + +:: + + add_library(<name> INTERFACE) + +creates an interface target. An interface target does not directly +create build output, though it may have properties set on it and it +may be installed, exported and imported. Typically the INTERFACE_* +properties are populated on the interface target using the +set_property(), target_link_libraries(), target_include_directories() +and target_compile_defintions() commands, and then it is used as an +argument to target_link_libraries() like any other target. diff --git a/Help/command/add_subdirectory.rst b/Help/command/add_subdirectory.rst new file mode 100644 index 0000000..29b5017 --- /dev/null +++ b/Help/command/add_subdirectory.rst @@ -0,0 +1,36 @@ +add_subdirectory +---------------- + +Add a subdirectory to the build. + +:: + + add_subdirectory(source_dir [binary_dir] + [EXCLUDE_FROM_ALL]) + +Add a subdirectory to the build. The source_dir specifies the +directory in which the source CMakeLists.txt and code files are +located. If it is a relative path it will be evaluated with respect +to the current directory (the typical usage), but it may also be an +absolute path. The binary_dir specifies the directory in which to +place the output files. If it is a relative path it will be evaluated +with respect to the current output directory, but it may also be an +absolute path. If binary_dir is not specified, the value of +source_dir, before expanding any relative path, will be used (the +typical usage). The CMakeLists.txt file in the specified source +directory will be processed immediately by CMake before processing in +the current input file continues beyond this command. + +If the EXCLUDE_FROM_ALL argument is provided then targets in the +subdirectory will not be included in the ALL target of the parent +directory by default, and will be excluded from IDE project files. +Users must explicitly build targets in the subdirectory. This is +meant for use when the subdirectory contains a separate part of the +project that is useful but not necessary, such as a set of examples. +Typically the subdirectory should contain its own project() command +invocation so that a full build system will be generated in the +subdirectory (such as a VS IDE solution file). Note that inter-target +dependencies supercede this exclusion. If a target built by the +parent project depends on a target in the subdirectory, the dependee +target will be included in the parent project build system to satisfy +the dependency. diff --git a/Help/command/add_test.rst b/Help/command/add_test.rst new file mode 100644 index 0000000..335db73 --- /dev/null +++ b/Help/command/add_test.rst @@ -0,0 +1,117 @@ +add_test +-------- + +Add a test to the project with the specified arguments. + +:: + + add_test(testname Exename arg1 arg2 ... ) + +If the ENABLE_TESTING command has been run, this command adds a test +target to the current directory. If ENABLE_TESTING has not been run, +this command does nothing. The tests are run by the testing subsystem +by executing Exename with the specified arguments. Exename can be +either an executable built by this project or an arbitrary executable +on the system (like tclsh). The test will be run with the current +working directory set to the CMakeList.txt files corresponding +directory in the binary tree. Tests added using this signature do not +support generator expressions. + + + +:: + + add_test(NAME <name> [CONFIGURATIONS [Debug|Release|...]] + [WORKING_DIRECTORY dir] + COMMAND <command> [arg1 [arg2 ...]]) + +Add a test called <name>. The test name may not contain spaces, +quotes, or other characters special in CMake syntax. If COMMAND +specifies an executable target (created by add_executable) it will +automatically be replaced by the location of the executable created at +build time. If a CONFIGURATIONS option is given then the test will be +executed only when testing under one of the named configurations. If +a WORKING_DIRECTORY option is given then the test will be executed in +the given directory. + +Arguments after COMMAND may use "generator expressions" with the +syntax "$<...>". Generator expressions are evaluated during build +system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Example usage: + +:: + + add_test(NAME mytest + COMMAND testDriver --config $<CONFIGURATION> + --exe $<TARGET_FILE:myexe>) + +This creates a test "mytest" whose command runs a testDriver tool +passing the configuration name and the full path to the executable +file produced by target "myexe". diff --git a/Help/command/aux_source_directory.rst b/Help/command/aux_source_directory.rst new file mode 100644 index 0000000..434d7a9 --- /dev/null +++ b/Help/command/aux_source_directory.rst @@ -0,0 +1,24 @@ +aux_source_directory +-------------------- + +Find all source files in a directory. + +:: + + aux_source_directory(<dir> <variable>) + +Collects the names of all the source files in the specified directory +and stores the list in the <variable> provided. This command is +intended to be used by projects that use explicit template +instantiation. Template instantiation files can be stored in a +"Templates" subdirectory and collected automatically using this +command to avoid manually listing all instantiations. + +It is tempting to use this command to avoid writing the list of source +files for a library or executable target. While this seems to work, +there is no way for CMake to generate a build system that knows when a +new source file has been added. Normally the generated build system +knows when it needs to rerun CMake because the CMakeLists.txt file is +modified to add a new source. When the source is just added to the +directory without modifying this file, one would have to manually +rerun CMake to generate a build system incorporating the new file. diff --git a/Help/command/break.rst b/Help/command/break.rst new file mode 100644 index 0000000..8f1067b --- /dev/null +++ b/Help/command/break.rst @@ -0,0 +1,10 @@ +break +----- + +Break from an enclosing foreach or while loop. + +:: + + break() + +Breaks from an enclosing foreach loop or while loop diff --git a/Help/command/build_command.rst b/Help/command/build_command.rst new file mode 100644 index 0000000..f4a56f0 --- /dev/null +++ b/Help/command/build_command.rst @@ -0,0 +1,37 @@ +build_command +------------- + +Get the command line to build this project. + +:: + + build_command(<variable> + [CONFIGURATION <config>] + [PROJECT_NAME <projname>] + [TARGET <target>]) + +Sets the given <variable> to a string containing the command line for +building one configuration of a target in a project using the build +tool appropriate for the current CMAKE_GENERATOR. + +If CONFIGURATION is omitted, CMake chooses a reasonable default value +for multi-configuration generators. CONFIGURATION is ignored for +single-configuration generators. + +If PROJECT_NAME is omitted, the resulting command line will build the +top level PROJECT in the current build tree. + +If TARGET is omitted, the resulting command line will build +everything, effectively using build target 'all' or 'ALL_BUILD'. + +:: + + build_command(<cachevariable> <makecommand>) + +This second signature is deprecated, but still available for backwards +compatibility. Use the first signature instead. + +Sets the given <cachevariable> to a string containing the command to +build this project from the root of the build tree using the build +tool given by <makecommand>. <makecommand> should be the full path to +msdev, devenv, nmake, make or one of the end user build tools. diff --git a/Help/command/build_name.rst b/Help/command/build_name.rst new file mode 100644 index 0000000..2148e49 --- /dev/null +++ b/Help/command/build_name.rst @@ -0,0 +1,12 @@ +build_name +---------- + +Deprecated. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead. + +:: + + build_name(variable) + +Sets the specified variable to a string representing the platform and +compiler settings. These values are now available through the +CMAKE_SYSTEM and CMAKE_CXX_COMPILER variables. diff --git a/Help/command/cmake_host_system_information.rst b/Help/command/cmake_host_system_information.rst new file mode 100644 index 0000000..ba545d5 --- /dev/null +++ b/Help/command/cmake_host_system_information.rst @@ -0,0 +1,25 @@ +cmake_host_system_information +----------------------------- + +Query host system specific information. + +:: + + cmake_host_system_information(RESULT <variable> QUERY <key> ...) + +Queries system information of the host system on which cmake runs. +One or more <key> can be provided to select the information to be +queried. The list of queried values is stored in <variable>. + +<key> can be one of the following values: + +:: + + NUMBER_OF_LOGICAL_CORES = Number of logical cores. + NUMBER_OF_PHYSICAL_CORES = Number of physical cores. + HOSTNAME = Hostname. + FQDN = Fully qualified domain name. + TOTAL_VIRTUAL_MEMORY = Total virtual memory in megabytes. + AVAILABLE_VIRTUAL_MEMORY = Available virtual memory in megabytes. + TOTAL_PHYSICAL_MEMORY = Total physical memory in megabytes. + AVAILABLE_PHYSICAL_MEMORY = Available physical memory in megabytes. diff --git a/Help/command/cmake_minimum_required.rst b/Help/command/cmake_minimum_required.rst new file mode 100644 index 0000000..1bdffa4 --- /dev/null +++ b/Help/command/cmake_minimum_required.rst @@ -0,0 +1,30 @@ +cmake_minimum_required +---------------------- + +Set the minimum required version of cmake for a project. + +:: + + cmake_minimum_required(VERSION major[.minor[.patch[.tweak]]] + [FATAL_ERROR]) + +If the current version of CMake is lower than that required it will +stop processing the project and report an error. When a version +higher than 2.4 is specified the command implicitly invokes + +:: + + cmake_policy(VERSION major[.minor[.patch[.tweak]]]) + +which sets the cmake policy version level to the version specified. +When version 2.4 or lower is given the command implicitly invokes + +:: + + cmake_policy(VERSION 2.4) + +which enables compatibility features for CMake 2.4 and lower. + +The FATAL_ERROR option is accepted but ignored by CMake 2.6 and +higher. It should be specified so CMake versions 2.4 and lower fail +with an error instead of just a warning. diff --git a/Help/command/cmake_policy.rst b/Help/command/cmake_policy.rst new file mode 100644 index 0000000..46db8d3 --- /dev/null +++ b/Help/command/cmake_policy.rst @@ -0,0 +1,78 @@ +cmake_policy +------------ + +Manage CMake Policy settings. + +As CMake evolves it is sometimes necessary to change existing behavior +in order to fix bugs or improve implementations of existing features. +The CMake Policy mechanism is designed to help keep existing projects +building as new versions of CMake introduce changes in behavior. Each +new policy (behavioral change) is given an identifier of the form +"CMP<NNNN>" where "<NNNN>" is an integer index. Documentation +associated with each policy describes the OLD and NEW behavior and the +reason the policy was introduced. Projects may set each policy to +select the desired behavior. When CMake needs to know which behavior +to use it checks for a setting specified by the project. If no +setting is available the OLD behavior is assumed and a warning is +produced requesting that the policy be set. + +The cmake_policy command is used to set policies to OLD or NEW +behavior. While setting policies individually is supported, we +encourage projects to set policies based on CMake versions. + +:: + + cmake_policy(VERSION major.minor[.patch[.tweak]]) + +Specify that the current CMake list file is written for the given +version of CMake. All policies introduced in the specified version or +earlier will be set to use NEW behavior. All policies introduced +after the specified version will be unset (unless variable +CMAKE_POLICY_DEFAULT_CMP<NNNN> sets a default). This effectively +requests behavior preferred as of a given CMake version and tells +newer CMake versions to warn about their new policies. The policy +version specified must be at least 2.4 or the command will report an +error. In order to get compatibility features supporting versions +earlier than 2.4 see documentation of policy CMP0001. + +:: + + cmake_policy(SET CMP<NNNN> NEW) + cmake_policy(SET CMP<NNNN> OLD) + +Tell CMake to use the OLD or NEW behavior for a given policy. +Projects depending on the old behavior of a given policy may silence a +policy warning by setting the policy state to OLD. Alternatively one +may fix the project to work with the new behavior and set the policy +state to NEW. + +:: + + cmake_policy(GET CMP<NNNN> <variable>) + +Check whether a given policy is set to OLD or NEW behavior. The +output variable value will be "OLD" or "NEW" if the policy is set, and +empty otherwise. + +CMake keeps policy settings on a stack, so changes made by the +cmake_policy command affect only the top of the stack. A new entry on +the policy stack is managed automatically for each subdirectory to +protect its parents and siblings. CMake also manages a new entry for +scripts loaded by include() and find_package() commands except when +invoked with the NO_POLICY_SCOPE option (see also policy CMP0011). +The cmake_policy command provides an interface to manage custom +entries on the policy stack: + +:: + + cmake_policy(PUSH) + cmake_policy(POP) + +Each PUSH must have a matching POP to erase any changes. This is +useful to make temporary changes to policy settings. + +Functions and macros record policy settings when they are created and +use the pre-record policies when they are invoked. If the function or +macro implementation sets policies, the changes automatically +propagate up through callers until they reach the closest nested +policy stack entry. diff --git a/Help/command/configure_file.rst b/Help/command/configure_file.rst new file mode 100644 index 0000000..5e5a33a --- /dev/null +++ b/Help/command/configure_file.rst @@ -0,0 +1,46 @@ +configure_file +-------------- + +Copy a file to another location and modify its contents. + +:: + + configure_file(<input> <output> + [COPYONLY] [ESCAPE_QUOTES] [@ONLY] + [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ]) + +Copies a file <input> to file <output> and substitutes variable values +referenced in the file content. If <input> is a relative path it is +evaluated with respect to the current source directory. The <input> +must be a file, not a directory. If <output> is a relative path it is +evaluated with respect to the current binary directory. If <output> +names an existing directory the input file is placed in that directory +with its original name. + +If the <input> file is modified the build system will re-run CMake to +re-configure the file and generate the build system again. + +This command replaces any variables in the input file referenced as +${VAR} or @VAR@ with their values as determined by CMake. If a +variable is not defined, it will be replaced with nothing. If +COPYONLY is specified, then no variable expansion will take place. If +ESCAPE_QUOTES is specified then any substituted quotes will be C-style +escaped. The file will be configured with the current values of CMake +variables. If @ONLY is specified, only variables of the form @VAR@ +will be replaced and ${VAR} will be ignored. This is useful for +configuring scripts that use ${VAR}. + +Input file lines of the form "#cmakedefine VAR ..." will be replaced +with either "#define VAR ..." or "/* #undef VAR */" depending on +whether VAR is set in CMake to any value not considered a false +constant by the if() command. (Content of "...", if any, is processed +as above.) Input file lines of the form "#cmakedefine01 VAR" will be +replaced with either "#define VAR 1" or "#define VAR 0" similarly. + +With NEWLINE_STYLE the line ending could be adjusted: + +:: + + 'UNIX' or 'LF' for \n, 'DOS', 'WIN32' or 'CRLF' for \r\n. + +COPYONLY must not be used with NEWLINE_STYLE. diff --git a/Help/command/create_test_sourcelist.rst b/Help/command/create_test_sourcelist.rst new file mode 100644 index 0000000..9addd67 --- /dev/null +++ b/Help/command/create_test_sourcelist.rst @@ -0,0 +1,30 @@ +create_test_sourcelist +---------------------- + +Create a test driver and source list for building test programs. + +:: + + create_test_sourcelist(sourceListName driverName + test1 test2 test3 + EXTRA_INCLUDE include.h + FUNCTION function) + +A test driver is a program that links together many small tests into a +single executable. This is useful when building static executables +with large libraries to shrink the total required size. The list of +source files needed to build the test driver will be in +sourceListName. DriverName is the name of the test driver program. +The rest of the arguments consist of a list of test source files, can +be semicolon separated. Each test source file should have a function +in it that is the same name as the file with no extension (foo.cxx +should have int foo(int, char*[]);) DriverName will be able to call +each of the tests by name on the command line. If EXTRA_INCLUDE is +specified, then the next argument is included into the generated file. +If FUNCTION is specified, then the next argument is taken as a +function name that is passed a pointer to ac and av. This can be used +to add extra command line processing to each test. The cmake variable +CMAKE_TESTDRIVER_BEFORE_TESTMAIN can be set to have code that will be +placed directly before calling the test main function. +CMAKE_TESTDRIVER_AFTER_TESTMAIN can be set to have code that will be +placed directly after the call to the test main function. diff --git a/Help/command/ctest_build.rst b/Help/command/ctest_build.rst new file mode 100644 index 0000000..ac2a0c1 --- /dev/null +++ b/Help/command/ctest_build.rst @@ -0,0 +1,24 @@ +ctest_build +----------- + +Build the project. + +:: + + ctest_build([BUILD build_dir] [TARGET target] [RETURN_VALUE res] + [APPEND][NUMBER_ERRORS val] [NUMBER_WARNINGS val]) + +Builds the given build directory and stores results in Build.xml. If +no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used. + +The TARGET variable can be used to specify a build target. If none is +specified, the "all" target will be built. + +The RETURN_VALUE option specifies a variable in which to store the +return value of the native build tool. The NUMBER_ERRORS and +NUMBER_WARNINGS options specify variables in which to store the number +of build errors and warnings detected. + +The APPEND option marks results for append to those previously +submitted to a dashboard server since the last ctest_start. Append +semantics are defined by the dashboard server in use. diff --git a/Help/command/ctest_configure.rst b/Help/command/ctest_configure.rst new file mode 100644 index 0000000..2c4e305 --- /dev/null +++ b/Help/command/ctest_configure.rst @@ -0,0 +1,21 @@ +ctest_configure +--------------- + +Configure the project build tree. + +:: + + ctest_configure([BUILD build_dir] [SOURCE source_dir] [APPEND] + [OPTIONS options] [RETURN_VALUE res]) + +Configures the given build directory and stores results in +Configure.xml. If no BUILD is given, the CTEST_BINARY_DIRECTORY +variable is used. If no SOURCE is given, the CTEST_SOURCE_DIRECTORY +variable is used. The OPTIONS argument specifies command line +arguments to pass to the configuration tool. The RETURN_VALUE option +specifies a variable in which to store the return value of the native +build tool. + +The APPEND option marks results for append to those previously +submitted to a dashboard server since the last ctest_start. Append +semantics are defined by the dashboard server in use. diff --git a/Help/command/ctest_coverage.rst b/Help/command/ctest_coverage.rst new file mode 100644 index 0000000..4c90f9c --- /dev/null +++ b/Help/command/ctest_coverage.rst @@ -0,0 +1,20 @@ +ctest_coverage +-------------- + +Collect coverage tool results. + +:: + + ctest_coverage([BUILD build_dir] [RETURN_VALUE res] [APPEND] + [LABELS label1 [label2 [...]]]) + +Perform the coverage of the given build directory and stores results +in Coverage.xml. The second argument is a variable that will hold +value. + +The LABELS option filters the coverage report to include only source +files labeled with at least one of the labels specified. + +The APPEND option marks results for append to those previously +submitted to a dashboard server since the last ctest_start. Append +semantics are defined by the dashboard server in use. diff --git a/Help/command/ctest_empty_binary_directory.rst b/Help/command/ctest_empty_binary_directory.rst new file mode 100644 index 0000000..7753667 --- /dev/null +++ b/Help/command/ctest_empty_binary_directory.rst @@ -0,0 +1,12 @@ +ctest_empty_binary_directory +---------------------------- + +empties the binary directory + +:: + + ctest_empty_binary_directory( directory ) + +Removes a binary directory. This command will perform some checks +prior to deleting the directory in an attempt to avoid malicious or +accidental directory deletion. diff --git a/Help/command/ctest_memcheck.rst b/Help/command/ctest_memcheck.rst new file mode 100644 index 0000000..ca47ed0 --- /dev/null +++ b/Help/command/ctest_memcheck.rst @@ -0,0 +1,28 @@ +ctest_memcheck +-------------- + +Run tests with a dynamic analysis tool. + +:: + + ctest_memcheck([BUILD build_dir] [RETURN_VALUE res] [APPEND] + [START start number] [END end number] + [STRIDE stride number] [EXCLUDE exclude regex ] + [INCLUDE include regex] + [EXCLUDE_LABEL exclude regex] + [INCLUDE_LABEL label regex] + [PARALLEL_LEVEL level] ) + +Tests the given build directory and stores results in MemCheck.xml. +The second argument is a variable that will hold value. Optionally, +you can specify the starting test number START, the ending test number +END, the number of tests to skip between each test STRIDE, a regular +expression for tests to run INCLUDE, or a regular expression for tests +not to run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular +expressions for tests to be included or excluded by the test property +LABEL. PARALLEL_LEVEL should be set to a positive number representing +the number of tests to be run in parallel. + +The APPEND option marks results for append to those previously +submitted to a dashboard server since the last ctest_start. Append +semantics are defined by the dashboard server in use. diff --git a/Help/command/ctest_read_custom_files.rst b/Help/command/ctest_read_custom_files.rst new file mode 100644 index 0000000..0bc57cd --- /dev/null +++ b/Help/command/ctest_read_custom_files.rst @@ -0,0 +1,11 @@ +ctest_read_custom_files +----------------------- + +read CTestCustom files. + +:: + + ctest_read_custom_files( directory ... ) + +Read all the CTestCustom.ctest or CTestCustom.cmake files from the +given directory. diff --git a/Help/command/ctest_run_script.rst b/Help/command/ctest_run_script.rst new file mode 100644 index 0000000..0f35019 --- /dev/null +++ b/Help/command/ctest_run_script.rst @@ -0,0 +1,15 @@ +ctest_run_script +---------------- + +runs a ctest -S script + +:: + + ctest_run_script([NEW_PROCESS] script_file_name script_file_name1 + script_file_name2 ... [RETURN_VALUE var]) + +Runs a script or scripts much like if it was run from ctest -S. If no +argument is provided then the current script is run using the current +settings of the variables. If NEW_PROCESS is specified then each +script will be run in a separate process.If RETURN_VALUE is specified +the return value of the last script run will be put into var. diff --git a/Help/command/ctest_sleep.rst b/Help/command/ctest_sleep.rst new file mode 100644 index 0000000..16a914c --- /dev/null +++ b/Help/command/ctest_sleep.rst @@ -0,0 +1,16 @@ +ctest_sleep +----------- + +sleeps for some amount of time + +:: + + ctest_sleep(<seconds>) + +Sleep for given number of seconds. + +:: + + ctest_sleep(<time1> <duration> <time2>) + +Sleep for t=(time1 + duration - time2) seconds if t > 0. diff --git a/Help/command/ctest_start.rst b/Help/command/ctest_start.rst new file mode 100644 index 0000000..f16142e --- /dev/null +++ b/Help/command/ctest_start.rst @@ -0,0 +1,16 @@ +ctest_start +----------- + +Starts the testing for a given model + +:: + + ctest_start(Model [TRACK <track>] [APPEND] [source [binary]]) + +Starts the testing for a given model. The command should be called +after the binary directory is initialized. If the 'source' and +'binary' directory are not specified, it reads the +CTEST_SOURCE_DIRECTORY and CTEST_BINARY_DIRECTORY. If the track is +specified, the submissions will go to the specified track. If APPEND +is used, the existing TAG is used rather than creating a new one based +on the current time stamp. diff --git a/Help/command/ctest_submit.rst b/Help/command/ctest_submit.rst new file mode 100644 index 0000000..29d2f5d --- /dev/null +++ b/Help/command/ctest_submit.rst @@ -0,0 +1,34 @@ +ctest_submit +------------ + +Submit results to a dashboard server. + +:: + + ctest_submit([PARTS ...] [FILES ...] [RETRY_COUNT count] [RETRY_DELAY delay][RETURN_VALUE res]) + +By default all available parts are submitted if no PARTS or FILES are +specified. The PARTS option lists a subset of parts to be submitted. +Valid part names are: + +:: + + Start = nothing + Update = ctest_update results, in Update.xml + Configure = ctest_configure results, in Configure.xml + Build = ctest_build results, in Build.xml + Test = ctest_test results, in Test.xml + Coverage = ctest_coverage results, in Coverage.xml + MemCheck = ctest_memcheck results, in DynamicAnalysis.xml + Notes = Files listed by CTEST_NOTES_FILES, in Notes.xml + ExtraFiles = Files listed by CTEST_EXTRA_SUBMIT_FILES + Submit = nothing + +The FILES option explicitly lists specific files to be submitted. +Each individual file must exist at the time of the call. + +The RETRY_DELAY option specifies how long in seconds to wait after a +timed-out submission before attempting to re-submit. + +The RETRY_COUNT option specifies how many times to retry a timed-out +submission. diff --git a/Help/command/ctest_test.rst b/Help/command/ctest_test.rst new file mode 100644 index 0000000..5f28083 --- /dev/null +++ b/Help/command/ctest_test.rst @@ -0,0 +1,33 @@ +ctest_test +---------- + +Run tests in the project build tree. + +:: + + ctest_test([BUILD build_dir] [APPEND] + [START start number] [END end number] + [STRIDE stride number] [EXCLUDE exclude regex ] + [INCLUDE include regex] [RETURN_VALUE res] + [EXCLUDE_LABEL exclude regex] + [INCLUDE_LABEL label regex] + [PARALLEL_LEVEL level] + [SCHEDULE_RANDOM on] + [STOP_TIME time of day]) + +Tests the given build directory and stores results in Test.xml. The +second argument is a variable that will hold value. Optionally, you +can specify the starting test number START, the ending test number +END, the number of tests to skip between each test STRIDE, a regular +expression for tests to run INCLUDE, or a regular expression for tests +to not run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular +expression for test to be included or excluded by the test property +LABEL. PARALLEL_LEVEL should be set to a positive number representing +the number of tests to be run in parallel. SCHEDULE_RANDOM will +launch tests in a random order, and is typically used to detect +implicit test dependencies. STOP_TIME is the time of day at which the +tests should all stop running. + +The APPEND option marks results for append to those previously +submitted to a dashboard server since the last ctest_start. Append +semantics are defined by the dashboard server in use. diff --git a/Help/command/ctest_update.rst b/Help/command/ctest_update.rst new file mode 100644 index 0000000..d34e192 --- /dev/null +++ b/Help/command/ctest_update.rst @@ -0,0 +1,13 @@ +ctest_update +------------ + +Update the work tree from version control. + +:: + + ctest_update([SOURCE source] [RETURN_VALUE res]) + +Updates the given source directory and stores results in Update.xml. +If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. +The RETURN_VALUE option specifies a variable in which to store the +result, which is the number of files updated or -1 on error. diff --git a/Help/command/ctest_upload.rst b/Help/command/ctest_upload.rst new file mode 100644 index 0000000..9156af5 --- /dev/null +++ b/Help/command/ctest_upload.rst @@ -0,0 +1,11 @@ +ctest_upload +------------ + +Upload files to a dashboard server. + +:: + + ctest_upload(FILES ...) + +Pass a list of files to be sent along with the build results to the +dashboard server. diff --git a/Help/command/define_property.rst b/Help/command/define_property.rst new file mode 100644 index 0000000..62bcd1b --- /dev/null +++ b/Help/command/define_property.rst @@ -0,0 +1,45 @@ +define_property +--------------- + +Define and document custom properties. + +:: + + define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE | + TEST | VARIABLE | CACHED_VARIABLE> + PROPERTY <name> [INHERITED] + BRIEF_DOCS <brief-doc> [docs...] + FULL_DOCS <full-doc> [docs...]) + +Define one property in a scope for use with the set_property and +get_property commands. This is primarily useful to associate +documentation with property names that may be retrieved with the +get_property command. The first argument determines the kind of scope +in which the property should be used. It must be one of the +following: + +:: + + GLOBAL = associated with the global namespace + DIRECTORY = associated with one directory + TARGET = associated with one target + SOURCE = associated with one source file + TEST = associated with a test named with add_test + VARIABLE = documents a CMake language variable + CACHED_VARIABLE = documents a CMake cache variable + +Note that unlike set_property and get_property no actual scope needs +to be given; only the kind of scope is important. + +The required PROPERTY option is immediately followed by the name of +the property being defined. + +If the INHERITED option then the get_property command will chain up to +the next higher scope when the requested property is not set in the +scope given to the command. DIRECTORY scope chains to GLOBAL. +TARGET, SOURCE, and TEST chain to DIRECTORY. + +The BRIEF_DOCS and FULL_DOCS options are followed by strings to be +associated with the property as its brief and full documentation. +Corresponding options to the get_property command will retrieve the +documentation. diff --git a/Help/command/else.rst b/Help/command/else.rst new file mode 100644 index 0000000..5eece95 --- /dev/null +++ b/Help/command/else.rst @@ -0,0 +1,10 @@ +else +---- + +Starts the else portion of an if block. + +:: + + else(expression) + +See the if command. diff --git a/Help/command/elseif.rst b/Help/command/elseif.rst new file mode 100644 index 0000000..96ee0e9 --- /dev/null +++ b/Help/command/elseif.rst @@ -0,0 +1,10 @@ +elseif +------ + +Starts the elseif portion of an if block. + +:: + + elseif(expression) + +See the if command. diff --git a/Help/command/enable_language.rst b/Help/command/enable_language.rst new file mode 100644 index 0000000..d46ff7e --- /dev/null +++ b/Help/command/enable_language.rst @@ -0,0 +1,22 @@ +enable_language +--------------- + +Enable a language (CXX/C/Fortran/etc) + +:: + + enable_language(<lang> [OPTIONAL] ) + +This command enables support for the named language in CMake. This is +the same as the project command but does not create any of the extra +variables that are created by the project command. Example languages +are CXX, C, Fortran. + +This command must be called in file scope, not in a function call. +Furthermore, it must be called in the highest directory common to all +targets using the named language directly for compiling sources or +indirectly through link dependencies. It is simplest to enable all +needed languages in the top-level directory of a project. + +The OPTIONAL keyword is a placeholder for future implementation and +does not currently work. diff --git a/Help/command/enable_testing.rst b/Help/command/enable_testing.rst new file mode 100644 index 0000000..41ecd5b --- /dev/null +++ b/Help/command/enable_testing.rst @@ -0,0 +1,13 @@ +enable_testing +-------------- + +Enable testing for current directory and below. + +:: + + enable_testing() + +Enables testing for this directory and below. See also the add_test +command. Note that ctest expects to find a test file in the build +directory root. Therefore, this command should be in the source +directory root. diff --git a/Help/command/endforeach.rst b/Help/command/endforeach.rst new file mode 100644 index 0000000..f23552d --- /dev/null +++ b/Help/command/endforeach.rst @@ -0,0 +1,10 @@ +endforeach +---------- + +Ends a list of commands in a FOREACH block. + +:: + + endforeach(expression) + +See the FOREACH command. diff --git a/Help/command/endfunction.rst b/Help/command/endfunction.rst new file mode 100644 index 0000000..63e70ba --- /dev/null +++ b/Help/command/endfunction.rst @@ -0,0 +1,10 @@ +endfunction +----------- + +Ends a list of commands in a function block. + +:: + + endfunction(expression) + +See the function command. diff --git a/Help/command/endif.rst b/Help/command/endif.rst new file mode 100644 index 0000000..4c9955c --- /dev/null +++ b/Help/command/endif.rst @@ -0,0 +1,10 @@ +endif +----- + +Ends a list of commands in an if block. + +:: + + endif(expression) + +See the if command. diff --git a/Help/command/endmacro.rst b/Help/command/endmacro.rst new file mode 100644 index 0000000..524fc80 --- /dev/null +++ b/Help/command/endmacro.rst @@ -0,0 +1,10 @@ +endmacro +-------- + +Ends a list of commands in a macro block. + +:: + + endmacro(expression) + +See the macro command. diff --git a/Help/command/endwhile.rst b/Help/command/endwhile.rst new file mode 100644 index 0000000..11fdc1b --- /dev/null +++ b/Help/command/endwhile.rst @@ -0,0 +1,10 @@ +endwhile +-------- + +Ends a list of commands in a while block. + +:: + + endwhile(expression) + +See the while command. diff --git a/Help/command/exec_program.rst b/Help/command/exec_program.rst new file mode 100644 index 0000000..aaa0dac --- /dev/null +++ b/Help/command/exec_program.rst @@ -0,0 +1,24 @@ +exec_program +------------ + +Deprecated. Use the execute_process() command instead. + +Run an executable program during the processing of the CMakeList.txt +file. + +:: + + exec_program(Executable [directory in which to run] + [ARGS <arguments to executable>] + [OUTPUT_VARIABLE <var>] + [RETURN_VALUE <var>]) + +The executable is run in the optionally specified directory. The +executable can include arguments if it is double quoted, but it is +better to use the optional ARGS argument to specify arguments to the +program. This is because cmake will then be able to escape spaces in +the executable path. An optional argument OUTPUT_VARIABLE specifies a +variable in which to store the output. To capture the return value of +the execution, provide a RETURN_VALUE. If OUTPUT_VARIABLE is +specified, then no output will go to the stdout/stderr of the console +running cmake. diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst new file mode 100644 index 0000000..3f0ccc2 --- /dev/null +++ b/Help/command/execute_process.rst @@ -0,0 +1,48 @@ +execute_process +--------------- + +Execute one or more child processes. + +:: + + execute_process(COMMAND <cmd1> [args1...]] + [COMMAND <cmd2> [args2...] [...]] + [WORKING_DIRECTORY <directory>] + [TIMEOUT <seconds>] + [RESULT_VARIABLE <variable>] + [OUTPUT_VARIABLE <variable>] + [ERROR_VARIABLE <variable>] + [INPUT_FILE <file>] + [OUTPUT_FILE <file>] + [ERROR_FILE <file>] + [OUTPUT_QUIET] + [ERROR_QUIET] + [OUTPUT_STRIP_TRAILING_WHITESPACE] + [ERROR_STRIP_TRAILING_WHITESPACE]) + +Runs the given sequence of one or more commands with the standard +output of each process piped to the standard input of the next. A +single standard error pipe is used for all processes. If +WORKING_DIRECTORY is given the named directory will be set as the +current working directory of the child processes. If TIMEOUT is given +the child processes will be terminated if they do not finish in the +specified number of seconds (fractions are allowed). If +RESULT_VARIABLE is given the variable will be set to contain the +result of running the processes. This will be an integer return code +from the last child or a string describing an error condition. If +OUTPUT_VARIABLE or ERROR_VARIABLE are given the variable named will be +set with the contents of the standard output and standard error pipes +respectively. If the same variable is named for both pipes their +output will be merged in the order produced. If INPUT_FILE, +OUTPUT_FILE, or ERROR_FILE is given the file named will be attached to +the standard input of the first process, standard output of the last +process, or standard error of all processes respectively. If +OUTPUT_QUIET or ERROR_QUIET is given then the standard output or +standard error results will be quietly ignored. If more than one +OUTPUT_* or ERROR_* option is given for the same pipe the precedence +is not specified. If no OUTPUT_* or ERROR_* options are given the +output will be shared with the corresponding pipes of the CMake +process itself. + +The execute_process command is a newer more powerful version of +exec_program, but the old command has been kept for compatibility. diff --git a/Help/command/export.rst b/Help/command/export.rst new file mode 100644 index 0000000..d9f63f0 --- /dev/null +++ b/Help/command/export.rst @@ -0,0 +1,44 @@ +export +------ + +Export targets from the build tree for use by outside projects. + +:: + + export(TARGETS [target1 [target2 [...]]] [NAMESPACE <namespace>] + [APPEND] FILE <filename> [EXPORT_LINK_INTERFACE_LIBRARIES]) + +Create a file <filename> that may be included by outside projects to +import targets from the current project's build tree. This is useful +during cross-compiling to build utility executables that can run on +the host platform in one project and then import them into another +project being compiled for the target platform. If the NAMESPACE +option is given the <namespace> string will be prepended to all target +names written to the file. If the APPEND option is given the +generated code will be appended to the file instead of overwriting it. +The EXPORT_LINK_INTERFACE_LIBRARIES keyword, if present, causes the +contents of the properties matching +(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)? to be exported, when +policy CMP0022 is NEW. If a library target is included in the export +but a target to which it links is not included the behavior is +unspecified. + +The file created by this command is specific to the build tree and +should never be installed. See the install(EXPORT) command to export +targets from an installation tree. + +The properties set on the generated IMPORTED targets will have the +same values as the final values of the input TARGETS. + +:: + + export(PACKAGE <name>) + +Store the current build directory in the CMake user package registry +for package <name>. The find_package command may consider the +directory while searching for package <name>. This helps dependent +projects find and use a package from the current project's build tree +without help from the user. Note that the entry in the package +registry that this command creates works only in conjunction with a +package configuration file (<name>Config.cmake) that works with the +build tree. diff --git a/Help/command/export_library_dependencies.rst b/Help/command/export_library_dependencies.rst new file mode 100644 index 0000000..c09f3d5 --- /dev/null +++ b/Help/command/export_library_dependencies.rst @@ -0,0 +1,26 @@ +export_library_dependencies +--------------------------- + +Deprecated. Use INSTALL(EXPORT) or EXPORT command. + +This command generates an old-style library dependencies file. +Projects requiring CMake 2.6 or later should not use the command. Use +instead the install(EXPORT) command to help export targets from an +installation tree and the export() command to export targets from a +build tree. + +The old-style library dependencies file does not take into account +per-configuration names of libraries or the LINK_INTERFACE_LIBRARIES +target property. + +:: + + export_library_dependencies(<file> [APPEND]) + +Create a file named <file> that can be included into a CMake listfile +with the INCLUDE command. The file will contain a number of SET +commands that will set all the variables needed for library dependency +information. This should be the last command in the top level +CMakeLists.txt file of the project. If the APPEND option is +specified, the SET commands will be appended to the given file instead +of replacing it. diff --git a/Help/command/file.rst b/Help/command/file.rst new file mode 100644 index 0000000..83ade1d --- /dev/null +++ b/Help/command/file.rst @@ -0,0 +1,213 @@ +file +---- + +File manipulation command. + +:: + + file(WRITE filename "message to write"... ) + file(APPEND filename "message to write"... ) + file(READ filename variable [LIMIT numBytes] [OFFSET offset] [HEX]) + file(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512> filename variable) + file(STRINGS filename variable [LIMIT_COUNT num] + [LIMIT_INPUT numBytes] [LIMIT_OUTPUT numBytes] + [LENGTH_MINIMUM numBytes] [LENGTH_MAXIMUM numBytes] + [NEWLINE_CONSUME] [REGEX regex] + [NO_HEX_CONVERSION]) + file(GLOB variable [RELATIVE path] [globbing expressions]...) + file(GLOB_RECURSE variable [RELATIVE path] + [FOLLOW_SYMLINKS] [globbing expressions]...) + file(RENAME <oldname> <newname>) + file(REMOVE [file1 ...]) + file(REMOVE_RECURSE [file1 ...]) + file(MAKE_DIRECTORY [directory1 directory2 ...]) + file(RELATIVE_PATH variable directory file) + file(TO_CMAKE_PATH path result) + file(TO_NATIVE_PATH path result) + file(DOWNLOAD url file [INACTIVITY_TIMEOUT timeout] + [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS] + [EXPECTED_HASH ALGO=value] [EXPECTED_MD5 sum] + [TLS_VERIFY on|off] [TLS_CAINFO file]) + file(UPLOAD filename url [INACTIVITY_TIMEOUT timeout] + [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS]) + file(TIMESTAMP filename variable [<format string>] [UTC]) + file(GENERATE OUTPUT output_file + <INPUT input_file|CONTENT input_content> + [CONDITION expression]) + +WRITE will write a message into a file called 'filename'. It +overwrites the file if it already exists, and creates the file if it +does not exist. (If the file is a build input, use configure_file to +update the file only when its content changes.) + +APPEND will write a message into a file same as WRITE, except it will +append it to the end of the file + +READ will read the content of a file and store it into the variable. +It will start at the given offset and read up to numBytes. If the +argument HEX is given, the binary data will be converted to +hexadecimal representation and this will be stored in the variable. + +MD5, SHA1, SHA224, SHA256, SHA384, and SHA512 will compute a +cryptographic hash of the content of a file. + +STRINGS will parse a list of ASCII strings from a file and store it in +a variable. Binary data in the file are ignored. Carriage return +(CR) characters are ignored. It works also for Intel Hex and Motorola +S-record files, which are automatically converted to binary format +when reading them. Disable this using NO_HEX_CONVERSION. + +LIMIT_COUNT sets the maximum number of strings to return. LIMIT_INPUT +sets the maximum number of bytes to read from the input file. +LIMIT_OUTPUT sets the maximum number of bytes to store in the output +variable. LENGTH_MINIMUM sets the minimum length of a string to +return. Shorter strings are ignored. LENGTH_MAXIMUM sets the maximum +length of a string to return. Longer strings are split into strings +no longer than the maximum length. NEWLINE_CONSUME allows newlines to +be included in strings instead of terminating them. + +REGEX specifies a regular expression that a string must match to be +returned. Typical usage + +:: + + file(STRINGS myfile.txt myfile) + +stores a list in the variable "myfile" in which each item is a line +from the input file. + +GLOB will generate a list of all files that match the globbing +expressions and store it into the variable. Globbing expressions are +similar to regular expressions, but much simpler. If RELATIVE flag is +specified for an expression, the results will be returned as a +relative path to the given path. (We do not recommend using GLOB to +collect a list of source files from your source tree. If no +CMakeLists.txt file changes when a source is added or removed then the +generated build system cannot know when to ask CMake to regenerate.) + +Examples of globbing expressions include: + +:: + + *.cxx - match all files with extension cxx + *.vt? - match all files with extension vta,...,vtz + f[3-5].txt - match files f3.txt, f4.txt, f5.txt + +GLOB_RECURSE will generate a list similar to the regular GLOB, except +it will traverse all the subdirectories of the matched directory and +match the files. Subdirectories that are symlinks are only traversed +if FOLLOW_SYMLINKS is given or cmake policy CMP0009 is not set to NEW. +See cmake --help-policy CMP0009 for more information. + +Examples of recursive globbing include: + +:: + + /dir/*.py - match all python files in /dir and subdirectories + +MAKE_DIRECTORY will create the given directories, also if their parent +directories don't exist yet + +RENAME moves a file or directory within a filesystem, replacing the +destination atomically. + +REMOVE will remove the given files, also in subdirectories + +REMOVE_RECURSE will remove the given files and directories, also +non-empty directories + +RELATIVE_PATH will determine relative path from directory to the given +file. + +TO_CMAKE_PATH will convert path into a cmake style path with unix /. +The input can be a single path or a system path like "$ENV{PATH}". +Note the double quotes around the ENV call TO_CMAKE_PATH only takes +one argument. This command will also convert the native list +delimiters for a list of paths like the PATH environment variable. + +TO_NATIVE_PATH works just like TO_CMAKE_PATH, but will convert from a +cmake style path into the native path style \ for windows and / for +UNIX. + +DOWNLOAD will download the given URL to the given file. If LOG var is +specified a log of the download will be put in var. If STATUS var is +specified the status of the operation will be put in var. The status +is returned in a list of length 2. The first element is the numeric +return value for the operation, and the second element is a string +value for the error. A 0 numeric error means no error in the +operation. If TIMEOUT time is specified, the operation will timeout +after time seconds, time should be specified as an integer. The +INACTIVITY_TIMEOUT specifies an integer number of seconds of +inactivity after which the operation should terminate. If +EXPECTED_HASH ALGO=value is specified, the operation will verify that +the downloaded file's actual hash matches the expected value, where +ALGO is one of MD5, SHA1, SHA224, SHA256, SHA384, or SHA512. If it +does not match, the operation fails with an error. ("EXPECTED_MD5 +sum" is short-hand for "EXPECTED_HASH MD5=sum".) If SHOW_PROGRESS is +specified, progress information will be printed as status messages +until the operation is complete. For https URLs CMake must be built +with OpenSSL. TLS/SSL certificates are not checked by default. Set +TLS_VERIFY to ON to check certificates and/or use EXPECTED_HASH to +verify downloaded content. Set TLS_CAINFO to specify a custom +Certificate Authority file. If either TLS option is not given CMake +will check variables CMAKE_TLS_VERIFY and CMAKE_TLS_CAINFO, +respectively. + +UPLOAD will upload the given file to the given URL. If LOG var is +specified a log of the upload will be put in var. If STATUS var is +specified the status of the operation will be put in var. The status +is returned in a list of length 2. The first element is the numeric +return value for the operation, and the second element is a string +value for the error. A 0 numeric error means no error in the +operation. If TIMEOUT time is specified, the operation will timeout +after time seconds, time should be specified as an integer. The +INACTIVITY_TIMEOUT specifies an integer number of seconds of +inactivity after which the operation should terminate. If +SHOW_PROGRESS is specified, progress information will be printed as +status messages until the operation is complete. + +TIMESTAMP will write a string representation of the modification time +of filename to variable. + +Should the command be unable to obtain a timestamp variable will be +set to the empty string "". + +See documentation of the string TIMESTAMP sub-command for more +details. + +The file() command also provides COPY and INSTALL signatures: + +:: + + file(<COPY|INSTALL> files... DESTINATION <dir> + [FILE_PERMISSIONS permissions...] + [DIRECTORY_PERMISSIONS permissions...] + [NO_SOURCE_PERMISSIONS] [USE_SOURCE_PERMISSIONS] + [FILES_MATCHING] + [[PATTERN <pattern> | REGEX <regex>] + [EXCLUDE] [PERMISSIONS permissions...]] [...]) + +The COPY signature copies files, directories, and symlinks to a +destination folder. Relative input paths are evaluated with respect +to the current source directory, and a relative destination is +evaluated with respect to the current build directory. Copying +preserves input file timestamps, and optimizes out a file if it exists +at the destination with the same timestamp. Copying preserves input +permissions unless explicit permissions or NO_SOURCE_PERMISSIONS are +given (default is USE_SOURCE_PERMISSIONS). See the install(DIRECTORY) +command for documentation of permissions, PATTERN, REGEX, and EXCLUDE +options. + +The INSTALL signature differs slightly from COPY: it prints status +messages, and NO_SOURCE_PERMISSIONS is default. Installation scripts +generated by the install() command use this signature (with some +undocumented options for internal use). + +GENERATE will write an <output_file> with content from an +<input_file>, or from <input_content>. The output is generated +conditionally based on the content of the <condition>. The file is +written at CMake generate-time and the input may contain generator +expressions. The <condition>, <output_file> and <input_file> may also +contain generator expressions. The <condition> must evaluate to +either '0' or '1'. The <output_file> must evaluate to a unique name +among all configurations and among all invocations of file(GENERATE). diff --git a/Help/command/find_file.rst b/Help/command/find_file.rst new file mode 100644 index 0000000..c5956f8 --- /dev/null +++ b/Help/command/find_file.rst @@ -0,0 +1,154 @@ +find_file +--------- + +Find the full path to a file. + +:: + + find_file(<VAR> name1 [path1 path2 ...]) + +This is the short-hand signature for the command that is sufficient in +many cases. It is the same as find_file(<VAR> name1 [PATHS path1 +path2 ...]) + +:: + + find_file( + <VAR> + name | NAMES name1 [name2 ...] + [HINTS path1 [path2 ... ENV var]] + [PATHS path1 [path2 ... ENV var]] + [PATH_SUFFIXES suffix1 [suffix2 ...]] + [DOC "cache documentation string"] + [NO_DEFAULT_PATH] + [NO_CMAKE_ENVIRONMENT_PATH] + [NO_CMAKE_PATH] + [NO_SYSTEM_ENVIRONMENT_PATH] + [NO_CMAKE_SYSTEM_PATH] + [CMAKE_FIND_ROOT_PATH_BOTH | + ONLY_CMAKE_FIND_ROOT_PATH | + NO_CMAKE_FIND_ROOT_PATH] + ) + +This command is used to find a full path to named file. A cache entry +named by <VAR> is created to store the result of this command. If the +full path to a file is found the result is stored in the variable and +the search will not be repeated unless the variable is cleared. If +nothing is found, the result will be <VAR>-NOTFOUND, and the search +will be attempted again the next time find_file is invoked with the +same variable. The name of the full path to a file that is searched +for is specified by the names listed after the NAMES argument. +Additional search locations can be specified after the PATHS argument. +If ENV var is found in the HINTS or PATHS section the environment +variable var will be read and converted from a system environment +variable to a cmake style list of paths. For example ENV PATH would +be a way to list the system path variable. The argument after DOC +will be used for the documentation string in the cache. PATH_SUFFIXES +specifies additional subdirectories to check below each search path. + +If NO_DEFAULT_PATH is specified, then no additional paths are added to +the search. If NO_DEFAULT_PATH is not specified, the search process +is as follows: + +1. Search paths specified in cmake-specific cache variables. These +are intended to be used on the command line with a -DVAR=value. This +can be skipped if NO_CMAKE_PATH is passed. + +:: + + <prefix>/include/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + <prefix>/include for each <prefix> in CMAKE_PREFIX_PATH + CMAKE_INCLUDE_PATH + CMAKE_FRAMEWORK_PATH + +2. Search paths specified in cmake-specific environment variables. +These are intended to be set in the user's shell configuration. This +can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed. + +:: + + <prefix>/include/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + <prefix>/include for each <prefix> in CMAKE_PREFIX_PATH + CMAKE_INCLUDE_PATH + CMAKE_FRAMEWORK_PATH + +3. Search the paths specified by the HINTS option. These should be +paths computed by system introspection, such as a hint provided by the +location of another item already found. Hard-coded guesses should be +specified with the PATHS option. + +4. Search the standard system environment variables. This can be +skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument. + +:: + + PATH + INCLUDE + +5. Search cmake variables defined in the Platform files for the +current system. This can be skipped if NO_CMAKE_SYSTEM_PATH is +passed. + +:: + + <prefix>/include/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + <prefix>/include for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH + CMAKE_SYSTEM_INCLUDE_PATH + CMAKE_SYSTEM_FRAMEWORK_PATH + +6. Search the paths specified by the PATHS option or in the +short-hand version of the command. These are typically hard-coded +guesses. + +On Darwin or systems supporting OS X Frameworks, the cmake variable +CMAKE_FIND_FRAMEWORK can be set to empty or one of the following: + +:: + + "FIRST" - Try to find frameworks before standard + libraries or headers. This is the default on Darwin. + "LAST" - Try to find frameworks after standard + libraries or headers. + "ONLY" - Only try to find frameworks. + "NEVER" - Never try to find frameworks. + +On Darwin or systems supporting OS X Application Bundles, the cmake +variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the +following: + +:: + + "FIRST" - Try to find application bundles before standard + programs. This is the default on Darwin. + "LAST" - Try to find application bundles after standard + programs. + "ONLY" - Only try to find application bundles. + "NEVER" - Never try to find application bundles. + +The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more +directories to be prepended to all other search directories. This +effectively "re-roots" the entire search under given locations. By +default it is empty. It is especially useful when cross-compiling to +point to the root directory of the target environment and CMake will +search there too. By default at first the directories listed in +CMAKE_FIND_ROOT_PATH and then the non-rooted directories will be +searched. The default behavior can be adjusted by setting +CMAKE_FIND_ROOT_PATH_MODE_INCLUDE. This behavior can be manually +overridden on a per-call basis. By using CMAKE_FIND_ROOT_PATH_BOTH +the search order will be as described above. If +NO_CMAKE_FIND_ROOT_PATH is used then CMAKE_FIND_ROOT_PATH will not be +used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted +directories will be searched. + +The default search order is designed to be most-specific to +least-specific for common use cases. Projects may override the order +by simply calling the command multiple times and using the NO_* +options: + +:: + + find_file(<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH) + find_file(<VAR> NAMES name) + +Once one of the calls succeeds the result variable will be set and +stored in the cache so that no call will search again. diff --git a/Help/command/find_library.rst b/Help/command/find_library.rst new file mode 100644 index 0000000..39ec4af --- /dev/null +++ b/Help/command/find_library.rst @@ -0,0 +1,171 @@ +find_library +------------ + +Find a library. + +:: + + find_library(<VAR> name1 [path1 path2 ...]) + +This is the short-hand signature for the command that is sufficient in +many cases. It is the same as find_library(<VAR> name1 [PATHS path1 +path2 ...]) + +:: + + find_library( + <VAR> + name | NAMES name1 [name2 ...] [NAMES_PER_DIR] + [HINTS path1 [path2 ... ENV var]] + [PATHS path1 [path2 ... ENV var]] + [PATH_SUFFIXES suffix1 [suffix2 ...]] + [DOC "cache documentation string"] + [NO_DEFAULT_PATH] + [NO_CMAKE_ENVIRONMENT_PATH] + [NO_CMAKE_PATH] + [NO_SYSTEM_ENVIRONMENT_PATH] + [NO_CMAKE_SYSTEM_PATH] + [CMAKE_FIND_ROOT_PATH_BOTH | + ONLY_CMAKE_FIND_ROOT_PATH | + NO_CMAKE_FIND_ROOT_PATH] + ) + +This command is used to find a library. A cache entry named by <VAR> +is created to store the result of this command. If the library is +found the result is stored in the variable and the search will not be +repeated unless the variable is cleared. If nothing is found, the +result will be <VAR>-NOTFOUND, and the search will be attempted again +the next time find_library is invoked with the same variable. The +name of the library that is searched for is specified by the names +listed after the NAMES argument. Additional search locations can be +specified after the PATHS argument. If ENV var is found in the HINTS +or PATHS section the environment variable var will be read and +converted from a system environment variable to a cmake style list of +paths. For example ENV PATH would be a way to list the system path +variable. The argument after DOC will be used for the documentation +string in the cache. PATH_SUFFIXES specifies additional +subdirectories to check below each search path. + +If NO_DEFAULT_PATH is specified, then no additional paths are added to +the search. If NO_DEFAULT_PATH is not specified, the search process +is as follows: + +1. Search paths specified in cmake-specific cache variables. These +are intended to be used on the command line with a -DVAR=value. This +can be skipped if NO_CMAKE_PATH is passed. + +:: + + <prefix>/lib/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + <prefix>/lib for each <prefix> in CMAKE_PREFIX_PATH + CMAKE_LIBRARY_PATH + CMAKE_FRAMEWORK_PATH + +2. Search paths specified in cmake-specific environment variables. +These are intended to be set in the user's shell configuration. This +can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed. + +:: + + <prefix>/lib/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + <prefix>/lib for each <prefix> in CMAKE_PREFIX_PATH + CMAKE_LIBRARY_PATH + CMAKE_FRAMEWORK_PATH + +3. Search the paths specified by the HINTS option. These should be +paths computed by system introspection, such as a hint provided by the +location of another item already found. Hard-coded guesses should be +specified with the PATHS option. + +4. Search the standard system environment variables. This can be +skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument. + +:: + + PATH + LIB + +5. Search cmake variables defined in the Platform files for the +current system. This can be skipped if NO_CMAKE_SYSTEM_PATH is +passed. + +:: + + <prefix>/lib/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + <prefix>/lib for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH + CMAKE_SYSTEM_LIBRARY_PATH + CMAKE_SYSTEM_FRAMEWORK_PATH + +6. Search the paths specified by the PATHS option or in the +short-hand version of the command. These are typically hard-coded +guesses. + +On Darwin or systems supporting OS X Frameworks, the cmake variable +CMAKE_FIND_FRAMEWORK can be set to empty or one of the following: + +:: + + "FIRST" - Try to find frameworks before standard + libraries or headers. This is the default on Darwin. + "LAST" - Try to find frameworks after standard + libraries or headers. + "ONLY" - Only try to find frameworks. + "NEVER" - Never try to find frameworks. + +On Darwin or systems supporting OS X Application Bundles, the cmake +variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the +following: + +:: + + "FIRST" - Try to find application bundles before standard + programs. This is the default on Darwin. + "LAST" - Try to find application bundles after standard + programs. + "ONLY" - Only try to find application bundles. + "NEVER" - Never try to find application bundles. + +The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more +directories to be prepended to all other search directories. This +effectively "re-roots" the entire search under given locations. By +default it is empty. It is especially useful when cross-compiling to +point to the root directory of the target environment and CMake will +search there too. By default at first the directories listed in +CMAKE_FIND_ROOT_PATH and then the non-rooted directories will be +searched. The default behavior can be adjusted by setting +CMAKE_FIND_ROOT_PATH_MODE_LIBRARY. This behavior can be manually +overridden on a per-call basis. By using CMAKE_FIND_ROOT_PATH_BOTH +the search order will be as described above. If +NO_CMAKE_FIND_ROOT_PATH is used then CMAKE_FIND_ROOT_PATH will not be +used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted +directories will be searched. + +The default search order is designed to be most-specific to +least-specific for common use cases. Projects may override the order +by simply calling the command multiple times and using the NO_* +options: + +:: + + find_library(<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH) + find_library(<VAR> NAMES name) + +Once one of the calls succeeds the result variable will be set and +stored in the cache so that no call will search again. + +When more than one value is given to the NAMES option this command by +default will consider one name at a time and search every directory +for it. The NAMES_PER_DIR option tells this command to consider one +directory at a time and search for all names in it. + +If the library found is a framework, then VAR will be set to the full +path to the framework <fullPath>/A.framework. When a full path to a +framework is used as a library, CMake will use a -framework A, and a +-F<fullPath> to link the framework to the target. + +If the global property FIND_LIBRARY_USE_LIB64_PATHS is set all search +paths will be tested as normal, with "64/" appended, and with all +matches of "lib/" replaced with "lib64/". This property is +automatically set for the platforms that are known to need it if at +least one of the languages supported by the PROJECT command is +enabled. diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst new file mode 100644 index 0000000..27d0ac7 --- /dev/null +++ b/Help/command/find_package.rst @@ -0,0 +1,406 @@ +find_package +------------ + +Load settings for an external project. + +:: + + find_package(<package> [version] [EXACT] [QUIET] [MODULE] + [REQUIRED] [[COMPONENTS] [components...]] + [OPTIONAL_COMPONENTS components...] + [NO_POLICY_SCOPE]) + +Finds and loads settings from an external project. <package>_FOUND +will be set to indicate whether the package was found. When the +package is found package-specific information is provided through +variables and imported targets documented by the package itself. The +QUIET option disables messages if the package cannot be found. The +MODULE option disables the second signature documented below. The +REQUIRED option stops processing with an error message if the package +cannot be found. + +A package-specific list of required components may be listed after the +COMPONENTS option (or after the REQUIRED option if present). +Additional optional components may be listed after +OPTIONAL_COMPONENTS. Available components and their influence on +whether a package is considered to be found are defined by the target +package. + +The [version] argument requests a version with which the package found +should be compatible (format is major[.minor[.patch[.tweak]]]). The +EXACT option requests that the version be matched exactly. If no +[version] and/or component list is given to a recursive invocation +inside a find-module, the corresponding arguments are forwarded +automatically from the outer call (including the EXACT flag for +[version]). Version support is currently provided only on a +package-by-package basis (details below). + +User code should generally look for packages using the above simple +signature. The remainder of this command documentation specifies the +full command signature and details of the search process. Project +maintainers wishing to provide a package to be found by this command +are encouraged to read on. + +The command has two modes by which it searches for packages: "Module" +mode and "Config" mode. Module mode is available when the command is +invoked with the above reduced signature. CMake searches for a file +called "Find<package>.cmake" in the CMAKE_MODULE_PATH followed by the +CMake installation. If the file is found, it is read and processed by +CMake. It is responsible for finding the package, checking the +version, and producing any needed messages. Many find-modules provide +limited or no support for versioning; check the module documentation. +If no module is found and the MODULE option is not given the command +proceeds to Config mode. + +The complete Config mode command signature is: + +:: + + find_package(<package> [version] [EXACT] [QUIET] + [REQUIRED] [[COMPONENTS] [components...]] + [CONFIG|NO_MODULE] + [NO_POLICY_SCOPE] + [NAMES name1 [name2 ...]] + [CONFIGS config1 [config2 ...]] + [HINTS path1 [path2 ... ]] + [PATHS path1 [path2 ... ]] + [PATH_SUFFIXES suffix1 [suffix2 ...]] + [NO_DEFAULT_PATH] + [NO_CMAKE_ENVIRONMENT_PATH] + [NO_CMAKE_PATH] + [NO_SYSTEM_ENVIRONMENT_PATH] + [NO_CMAKE_PACKAGE_REGISTRY] + [NO_CMAKE_BUILDS_PATH] + [NO_CMAKE_SYSTEM_PATH] + [NO_CMAKE_SYSTEM_PACKAGE_REGISTRY] + [CMAKE_FIND_ROOT_PATH_BOTH | + ONLY_CMAKE_FIND_ROOT_PATH | + NO_CMAKE_FIND_ROOT_PATH]) + +The CONFIG option may be used to skip Module mode explicitly and +switch to Config mode. It is synonymous to using NO_MODULE. Config +mode is also implied by use of options not specified in the reduced +signature. + +Config mode attempts to locate a configuration file provided by the +package to be found. A cache entry called <package>_DIR is created to +hold the directory containing the file. By default the command +searches for a package with the name <package>. If the NAMES option +is given the names following it are used instead of <package>. The +command searches for a file called "<name>Config.cmake" or +"<lower-case-name>-config.cmake" for each name specified. A +replacement set of possible configuration file names may be given +using the CONFIGS option. The search procedure is specified below. +Once found, the configuration file is read and processed by CMake. +Since the file is provided by the package it already knows the +location of package contents. The full path to the configuration file +is stored in the cmake variable <package>_CONFIG. + +All configuration files which have been considered by CMake while +searching for an installation of the package with an appropriate +version are stored in the cmake variable <package>_CONSIDERED_CONFIGS, +the associated versions in <package>_CONSIDERED_VERSIONS. + +If the package configuration file cannot be found CMake will generate +an error describing the problem unless the QUIET argument is +specified. If REQUIRED is specified and the package is not found a +fatal error is generated and the configure step stops executing. If +<package>_DIR has been set to a directory not containing a +configuration file CMake will ignore it and search from scratch. + +When the [version] argument is given Config mode will only find a +version of the package that claims compatibility with the requested +version (format is major[.minor[.patch[.tweak]]]). If the EXACT +option is given only a version of the package claiming an exact match +of the requested version may be found. CMake does not establish any +convention for the meaning of version numbers. Package version +numbers are checked by "version" files provided by the packages +themselves. For a candidate package configuration file +"<config-file>.cmake" the corresponding version file is located next +to it and named either "<config-file>-version.cmake" or +"<config-file>Version.cmake". If no such version file is available +then the configuration file is assumed to not be compatible with any +requested version. A basic version file containing generic version +matching code can be created using the macro +write_basic_package_version_file(), see its documentation for more +details. When a version file is found it is loaded to check the +requested version number. The version file is loaded in a nested +scope in which the following variables have been defined: + +:: + + PACKAGE_FIND_NAME = the <package> name + PACKAGE_FIND_VERSION = full requested version string + PACKAGE_FIND_VERSION_MAJOR = major version if requested, else 0 + PACKAGE_FIND_VERSION_MINOR = minor version if requested, else 0 + PACKAGE_FIND_VERSION_PATCH = patch version if requested, else 0 + PACKAGE_FIND_VERSION_TWEAK = tweak version if requested, else 0 + PACKAGE_FIND_VERSION_COUNT = number of version components, 0 to 4 + +The version file checks whether it satisfies the requested version and +sets these variables: + +:: + + PACKAGE_VERSION = full provided version string + PACKAGE_VERSION_EXACT = true if version is exact match + PACKAGE_VERSION_COMPATIBLE = true if version is compatible + PACKAGE_VERSION_UNSUITABLE = true if unsuitable as any version + +These variables are checked by the find_package command to determine +whether the configuration file provides an acceptable version. They +are not available after the find_package call returns. If the version +is acceptable the following variables are set: + +:: + + <package>_VERSION = full provided version string + <package>_VERSION_MAJOR = major version if provided, else 0 + <package>_VERSION_MINOR = minor version if provided, else 0 + <package>_VERSION_PATCH = patch version if provided, else 0 + <package>_VERSION_TWEAK = tweak version if provided, else 0 + <package>_VERSION_COUNT = number of version components, 0 to 4 + +and the corresponding package configuration file is loaded. When +multiple package configuration files are available whose version files +claim compatibility with the version requested it is unspecified which +one is chosen. No attempt is made to choose a highest or closest +version number. + +Config mode provides an elaborate interface and search procedure. +Much of the interface is provided for completeness and for use +internally by find-modules loaded by Module mode. Most user code +should simply call + +:: + + find_package(<package> [major[.minor]] [EXACT] [REQUIRED|QUIET]) + +in order to find a package. Package maintainers providing CMake +package configuration files are encouraged to name and install them +such that the procedure outlined below will find them without +requiring use of additional options. + +CMake constructs a set of possible installation prefixes for the +package. Under each prefix several directories are searched for a +configuration file. The tables below show the directories searched. +Each entry is meant for installation trees following Windows (W), UNIX +(U), or Apple (A) conventions. + +:: + + <prefix>/ (W) + <prefix>/(cmake|CMake)/ (W) + <prefix>/<name>*/ (W) + <prefix>/<name>*/(cmake|CMake)/ (W) + <prefix>/(lib/<arch>|lib|share)/cmake/<name>*/ (U) + <prefix>/(lib/<arch>|lib|share)/<name>*/ (U) + <prefix>/(lib/<arch>|lib|share)/<name>*/(cmake|CMake)/ (U) + +On systems supporting OS X Frameworks and Application Bundles the +following directories are searched for frameworks or bundles +containing a configuration file: + +:: + + <prefix>/<name>.framework/Resources/ (A) + <prefix>/<name>.framework/Resources/CMake/ (A) + <prefix>/<name>.framework/Versions/*/Resources/ (A) + <prefix>/<name>.framework/Versions/*/Resources/CMake/ (A) + <prefix>/<name>.app/Contents/Resources/ (A) + <prefix>/<name>.app/Contents/Resources/CMake/ (A) + +In all cases the <name> is treated as case-insensitive and corresponds +to any of the names specified (<package> or names given by NAMES). +Paths with lib/<arch> are enabled if CMAKE_LIBRARY_ARCHITECTURE is +set. If PATH_SUFFIXES is specified the suffixes are appended to each +(W) or (U) directory entry one-by-one. + +This set of directories is intended to work in cooperation with +projects that provide configuration files in their installation trees. +Directories above marked with (W) are intended for installations on +Windows where the prefix may point at the top of an application's +installation directory. Those marked with (U) are intended for +installations on UNIX platforms where the prefix is shared by multiple +packages. This is merely a convention, so all (W) and (U) directories +are still searched on all platforms. Directories marked with (A) are +intended for installations on Apple platforms. The cmake variables +CMAKE_FIND_FRAMEWORK and CMAKE_FIND_APPBUNDLE determine the order of +preference as specified below. + +The set of installation prefixes is constructed using the following +steps. If NO_DEFAULT_PATH is specified all NO_* options are enabled. + +1. Search paths specified in cmake-specific cache variables. These +are intended to be used on the command line with a -DVAR=value. This +can be skipped if NO_CMAKE_PATH is passed. + +:: + + CMAKE_PREFIX_PATH + CMAKE_FRAMEWORK_PATH + CMAKE_APPBUNDLE_PATH + +2. Search paths specified in cmake-specific environment variables. +These are intended to be set in the user's shell configuration. This +can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed. + +:: + + <package>_DIR + CMAKE_PREFIX_PATH + CMAKE_FRAMEWORK_PATH + CMAKE_APPBUNDLE_PATH + +3. Search paths specified by the HINTS option. These should be paths +computed by system introspection, such as a hint provided by the +location of another item already found. Hard-coded guesses should be +specified with the PATHS option. + +4. Search the standard system environment variables. This can be +skipped if NO_SYSTEM_ENVIRONMENT_PATH is passed. Path entries ending +in "/bin" or "/sbin" are automatically converted to their parent +directories. + +:: + + PATH + +5. Search project build trees recently configured in a CMake GUI. +This can be skipped if NO_CMAKE_BUILDS_PATH is passed. It is intended +for the case when a user is building multiple dependent projects one +after another. + +6. Search paths stored in the CMake user package registry. This can +be skipped if NO_CMAKE_PACKAGE_REGISTRY is passed. On Windows a +<package> may appear under registry key + +:: + + HKEY_CURRENT_USER\Software\Kitware\CMake\Packages\<package> + +as a REG_SZ value, with arbitrary name, that specifies the directory +containing the package configuration file. On UNIX platforms a +<package> may appear under the directory + +:: + + ~/.cmake/packages/<package> + +as a file, with arbitrary name, whose content specifies the directory +containing the package configuration file. See the export(PACKAGE) +command to create user package registry entries for project build +trees. + +7. Search cmake variables defined in the Platform files for the +current system. This can be skipped if NO_CMAKE_SYSTEM_PATH is +passed. + +:: + + CMAKE_SYSTEM_PREFIX_PATH + CMAKE_SYSTEM_FRAMEWORK_PATH + CMAKE_SYSTEM_APPBUNDLE_PATH + +8. Search paths stored in the CMake system package registry. This +can be skipped if NO_CMAKE_SYSTEM_PACKAGE_REGISTRY is passed. On +Windows a <package> may appear under registry key + +:: + + HKEY_LOCAL_MACHINE\Software\Kitware\CMake\Packages\<package> + +as a REG_SZ value, with arbitrary name, that specifies the directory +containing the package configuration file. There is no system package +registry on non-Windows platforms. + +9. Search paths specified by the PATHS option. These are typically +hard-coded guesses. + +On Darwin or systems supporting OS X Frameworks, the cmake variable +CMAKE_FIND_FRAMEWORK can be set to empty or one of the following: + +:: + + "FIRST" - Try to find frameworks before standard + libraries or headers. This is the default on Darwin. + "LAST" - Try to find frameworks after standard + libraries or headers. + "ONLY" - Only try to find frameworks. + "NEVER" - Never try to find frameworks. + +On Darwin or systems supporting OS X Application Bundles, the cmake +variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the +following: + +:: + + "FIRST" - Try to find application bundles before standard + programs. This is the default on Darwin. + "LAST" - Try to find application bundles after standard + programs. + "ONLY" - Only try to find application bundles. + "NEVER" - Never try to find application bundles. + +The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more +directories to be prepended to all other search directories. This +effectively "re-roots" the entire search under given locations. By +default it is empty. It is especially useful when cross-compiling to +point to the root directory of the target environment and CMake will +search there too. By default at first the directories listed in +CMAKE_FIND_ROOT_PATH and then the non-rooted directories will be +searched. The default behavior can be adjusted by setting +CMAKE_FIND_ROOT_PATH_MODE_PACKAGE. This behavior can be manually +overridden on a per-call basis. By using CMAKE_FIND_ROOT_PATH_BOTH +the search order will be as described above. If +NO_CMAKE_FIND_ROOT_PATH is used then CMAKE_FIND_ROOT_PATH will not be +used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted +directories will be searched. + +The default search order is designed to be most-specific to +least-specific for common use cases. Projects may override the order +by simply calling the command multiple times and using the NO_* +options: + +:: + + find_package(<package> PATHS paths... NO_DEFAULT_PATH) + find_package(<package>) + +Once one of the calls succeeds the result variable will be set and +stored in the cache so that no call will search again. + +Every non-REQUIRED find_package() call can be disabled by setting the +variable CMAKE_DISABLE_FIND_PACKAGE_<package> to TRUE. See the +documentation for the CMAKE_DISABLE_FIND_PACKAGE_<package> variable +for more information. + +When loading a find module or package configuration file find_package +defines variables to provide information about the call arguments (and +restores their original state before returning): + +:: + + <package>_FIND_REQUIRED = true if REQUIRED option was given + <package>_FIND_QUIETLY = true if QUIET option was given + <package>_FIND_VERSION = full requested version string + <package>_FIND_VERSION_MAJOR = major version if requested, else 0 + <package>_FIND_VERSION_MINOR = minor version if requested, else 0 + <package>_FIND_VERSION_PATCH = patch version if requested, else 0 + <package>_FIND_VERSION_TWEAK = tweak version if requested, else 0 + <package>_FIND_VERSION_COUNT = number of version components, 0 to 4 + <package>_FIND_VERSION_EXACT = true if EXACT option was given + <package>_FIND_COMPONENTS = list of requested components + <package>_FIND_REQUIRED_<c> = true if component <c> is required + false if component <c> is optional + +In Module mode the loaded find module is responsible to honor the +request detailed by these variables; see the find module for details. +In Config mode find_package handles REQUIRED, QUIET, and version +options automatically but leaves it to the package configuration file +to handle components in a way that makes sense for the package. The +package configuration file may set <package>_FOUND to false to tell +find_package that component requirements are not satisfied. + +See the cmake_policy() command documentation for discussion of the +NO_POLICY_SCOPE option. diff --git a/Help/command/find_path.rst b/Help/command/find_path.rst new file mode 100644 index 0000000..2ffe6aa --- /dev/null +++ b/Help/command/find_path.rst @@ -0,0 +1,160 @@ +find_path +--------- + +Find the directory containing a file. + +:: + + find_path(<VAR> name1 [path1 path2 ...]) + +This is the short-hand signature for the command that is sufficient in +many cases. It is the same as find_path(<VAR> name1 [PATHS path1 +path2 ...]) + +:: + + find_path( + <VAR> + name | NAMES name1 [name2 ...] + [HINTS path1 [path2 ... ENV var]] + [PATHS path1 [path2 ... ENV var]] + [PATH_SUFFIXES suffix1 [suffix2 ...]] + [DOC "cache documentation string"] + [NO_DEFAULT_PATH] + [NO_CMAKE_ENVIRONMENT_PATH] + [NO_CMAKE_PATH] + [NO_SYSTEM_ENVIRONMENT_PATH] + [NO_CMAKE_SYSTEM_PATH] + [CMAKE_FIND_ROOT_PATH_BOTH | + ONLY_CMAKE_FIND_ROOT_PATH | + NO_CMAKE_FIND_ROOT_PATH] + ) + +This command is used to find a directory containing the named file. A +cache entry named by <VAR> is created to store the result of this +command. If the file in a directory is found the result is stored in +the variable and the search will not be repeated unless the variable +is cleared. If nothing is found, the result will be <VAR>-NOTFOUND, +and the search will be attempted again the next time find_path is +invoked with the same variable. The name of the file in a directory +that is searched for is specified by the names listed after the NAMES +argument. Additional search locations can be specified after the +PATHS argument. If ENV var is found in the HINTS or PATHS section the +environment variable var will be read and converted from a system +environment variable to a cmake style list of paths. For example ENV +PATH would be a way to list the system path variable. The argument +after DOC will be used for the documentation string in the cache. +PATH_SUFFIXES specifies additional subdirectories to check below each +search path. + +If NO_DEFAULT_PATH is specified, then no additional paths are added to +the search. If NO_DEFAULT_PATH is not specified, the search process +is as follows: + +1. Search paths specified in cmake-specific cache variables. These +are intended to be used on the command line with a -DVAR=value. This +can be skipped if NO_CMAKE_PATH is passed. + +:: + + <prefix>/include/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + <prefix>/include for each <prefix> in CMAKE_PREFIX_PATH + CMAKE_INCLUDE_PATH + CMAKE_FRAMEWORK_PATH + +2. Search paths specified in cmake-specific environment variables. +These are intended to be set in the user's shell configuration. This +can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed. + +:: + + <prefix>/include/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + <prefix>/include for each <prefix> in CMAKE_PREFIX_PATH + CMAKE_INCLUDE_PATH + CMAKE_FRAMEWORK_PATH + +3. Search the paths specified by the HINTS option. These should be +paths computed by system introspection, such as a hint provided by the +location of another item already found. Hard-coded guesses should be +specified with the PATHS option. + +4. Search the standard system environment variables. This can be +skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument. + +:: + + PATH + INCLUDE + +5. Search cmake variables defined in the Platform files for the +current system. This can be skipped if NO_CMAKE_SYSTEM_PATH is +passed. + +:: + + <prefix>/include/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + <prefix>/include for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH + CMAKE_SYSTEM_INCLUDE_PATH + CMAKE_SYSTEM_FRAMEWORK_PATH + +6. Search the paths specified by the PATHS option or in the +short-hand version of the command. These are typically hard-coded +guesses. + +On Darwin or systems supporting OS X Frameworks, the cmake variable +CMAKE_FIND_FRAMEWORK can be set to empty or one of the following: + +:: + + "FIRST" - Try to find frameworks before standard + libraries or headers. This is the default on Darwin. + "LAST" - Try to find frameworks after standard + libraries or headers. + "ONLY" - Only try to find frameworks. + "NEVER" - Never try to find frameworks. + +On Darwin or systems supporting OS X Application Bundles, the cmake +variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the +following: + +:: + + "FIRST" - Try to find application bundles before standard + programs. This is the default on Darwin. + "LAST" - Try to find application bundles after standard + programs. + "ONLY" - Only try to find application bundles. + "NEVER" - Never try to find application bundles. + +The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more +directories to be prepended to all other search directories. This +effectively "re-roots" the entire search under given locations. By +default it is empty. It is especially useful when cross-compiling to +point to the root directory of the target environment and CMake will +search there too. By default at first the directories listed in +CMAKE_FIND_ROOT_PATH and then the non-rooted directories will be +searched. The default behavior can be adjusted by setting +CMAKE_FIND_ROOT_PATH_MODE_INCLUDE. This behavior can be manually +overridden on a per-call basis. By using CMAKE_FIND_ROOT_PATH_BOTH +the search order will be as described above. If +NO_CMAKE_FIND_ROOT_PATH is used then CMAKE_FIND_ROOT_PATH will not be +used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted +directories will be searched. + +The default search order is designed to be most-specific to +least-specific for common use cases. Projects may override the order +by simply calling the command multiple times and using the NO_* +options: + +:: + + find_path(<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH) + find_path(<VAR> NAMES name) + +Once one of the calls succeeds the result variable will be set and +stored in the cache so that no call will search again. + +When searching for frameworks, if the file is specified as A/b.h, then +the framework search will look for A.framework/Headers/b.h. If that +is found the path will be set to the path to the framework. CMake +will convert this to the correct -F option to include the file. diff --git a/Help/command/find_program.rst b/Help/command/find_program.rst new file mode 100644 index 0000000..656fbe5 --- /dev/null +++ b/Help/command/find_program.rst @@ -0,0 +1,151 @@ +find_program +------------ + +Find an executable program. + +:: + + find_program(<VAR> name1 [path1 path2 ...]) + +This is the short-hand signature for the command that is sufficient in +many cases. It is the same as find_program(<VAR> name1 [PATHS path1 +path2 ...]) + +:: + + find_program( + <VAR> + name | NAMES name1 [name2 ...] + [HINTS path1 [path2 ... ENV var]] + [PATHS path1 [path2 ... ENV var]] + [PATH_SUFFIXES suffix1 [suffix2 ...]] + [DOC "cache documentation string"] + [NO_DEFAULT_PATH] + [NO_CMAKE_ENVIRONMENT_PATH] + [NO_CMAKE_PATH] + [NO_SYSTEM_ENVIRONMENT_PATH] + [NO_CMAKE_SYSTEM_PATH] + [CMAKE_FIND_ROOT_PATH_BOTH | + ONLY_CMAKE_FIND_ROOT_PATH | + NO_CMAKE_FIND_ROOT_PATH] + ) + +This command is used to find a program. A cache entry named by <VAR> +is created to store the result of this command. If the program is +found the result is stored in the variable and the search will not be +repeated unless the variable is cleared. If nothing is found, the +result will be <VAR>-NOTFOUND, and the search will be attempted again +the next time find_program is invoked with the same variable. The +name of the program that is searched for is specified by the names +listed after the NAMES argument. Additional search locations can be +specified after the PATHS argument. If ENV var is found in the HINTS +or PATHS section the environment variable var will be read and +converted from a system environment variable to a cmake style list of +paths. For example ENV PATH would be a way to list the system path +variable. The argument after DOC will be used for the documentation +string in the cache. PATH_SUFFIXES specifies additional +subdirectories to check below each search path. + +If NO_DEFAULT_PATH is specified, then no additional paths are added to +the search. If NO_DEFAULT_PATH is not specified, the search process +is as follows: + +1. Search paths specified in cmake-specific cache variables. These +are intended to be used on the command line with a -DVAR=value. This +can be skipped if NO_CMAKE_PATH is passed. + +:: + + <prefix>/[s]bin for each <prefix> in CMAKE_PREFIX_PATH + CMAKE_PROGRAM_PATH + CMAKE_APPBUNDLE_PATH + +2. Search paths specified in cmake-specific environment variables. +These are intended to be set in the user's shell configuration. This +can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed. + +:: + + <prefix>/[s]bin for each <prefix> in CMAKE_PREFIX_PATH + CMAKE_PROGRAM_PATH + CMAKE_APPBUNDLE_PATH + +3. Search the paths specified by the HINTS option. These should be +paths computed by system introspection, such as a hint provided by the +location of another item already found. Hard-coded guesses should be +specified with the PATHS option. + +4. Search the standard system environment variables. This can be +skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument. + +:: + + PATH + + +5. Search cmake variables defined in the Platform files for the +current system. This can be skipped if NO_CMAKE_SYSTEM_PATH is +passed. + +:: + + <prefix>/[s]bin for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH + CMAKE_SYSTEM_PROGRAM_PATH + CMAKE_SYSTEM_APPBUNDLE_PATH + +6. Search the paths specified by the PATHS option or in the +short-hand version of the command. These are typically hard-coded +guesses. + +On Darwin or systems supporting OS X Frameworks, the cmake variable +CMAKE_FIND_FRAMEWORK can be set to empty or one of the following: + +:: + + "FIRST" - Try to find frameworks before standard + libraries or headers. This is the default on Darwin. + "LAST" - Try to find frameworks after standard + libraries or headers. + "ONLY" - Only try to find frameworks. + "NEVER" - Never try to find frameworks. + +On Darwin or systems supporting OS X Application Bundles, the cmake +variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the +following: + +:: + + "FIRST" - Try to find application bundles before standard + programs. This is the default on Darwin. + "LAST" - Try to find application bundles after standard + programs. + "ONLY" - Only try to find application bundles. + "NEVER" - Never try to find application bundles. + +The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more +directories to be prepended to all other search directories. This +effectively "re-roots" the entire search under given locations. By +default it is empty. It is especially useful when cross-compiling to +point to the root directory of the target environment and CMake will +search there too. By default at first the directories listed in +CMAKE_FIND_ROOT_PATH and then the non-rooted directories will be +searched. The default behavior can be adjusted by setting +CMAKE_FIND_ROOT_PATH_MODE_PROGRAM. This behavior can be manually +overridden on a per-call basis. By using CMAKE_FIND_ROOT_PATH_BOTH +the search order will be as described above. If +NO_CMAKE_FIND_ROOT_PATH is used then CMAKE_FIND_ROOT_PATH will not be +used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted +directories will be searched. + +The default search order is designed to be most-specific to +least-specific for common use cases. Projects may override the order +by simply calling the command multiple times and using the NO_* +options: + +:: + + find_program(<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH) + find_program(<VAR> NAMES name) + +Once one of the calls succeeds the result variable will be set and +stored in the cache so that no call will search again. diff --git a/Help/command/fltk_wrap_ui.rst b/Help/command/fltk_wrap_ui.rst new file mode 100644 index 0000000..448ae64 --- /dev/null +++ b/Help/command/fltk_wrap_ui.rst @@ -0,0 +1,14 @@ +fltk_wrap_ui +------------ + +Create FLTK user interfaces Wrappers. + +:: + + fltk_wrap_ui(resultingLibraryName source1 + source2 ... sourceN ) + +Produce .h and .cxx files for all the .fl and .fld files listed. The +resulting .h and .cxx files will be added to a variable named +resultingLibraryName_FLTK_UI_SRCS which should be added to your +library. diff --git a/Help/command/foreach.rst b/Help/command/foreach.rst new file mode 100644 index 0000000..9ac70b3 --- /dev/null +++ b/Help/command/foreach.rst @@ -0,0 +1,46 @@ +foreach +------- + +Evaluate a group of commands for each value in a list. + +:: + + foreach(loop_var arg1 arg2 ...) + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + endforeach(loop_var) + +All commands between foreach and the matching endforeach are recorded +without being invoked. Once the endforeach is evaluated, the recorded +list of commands is invoked once for each argument listed in the +original foreach command. Before each iteration of the loop +"${loop_var}" will be set as a variable with the current value in the +list. + +:: + + foreach(loop_var RANGE total) + foreach(loop_var RANGE start stop [step]) + +Foreach can also iterate over a generated range of numbers. There are +three types of this iteration: + +* When specifying single number, the range will have elements 0 to +"total". + +* When specifying two numbers, the range will have elements from the +first number to the second number. + +* The third optional number is the increment used to iterate from the +first number to the second number. + +:: + + foreach(loop_var IN [LISTS [list1 [...]]] + [ITEMS [item1 [...]]]) + +Iterates over a precise list of items. The LISTS option names +list-valued variables to be traversed, including empty elements (an +empty string is a zero-length list). The ITEMS option ends argument +parsing and includes all arguments following it in the iteration. diff --git a/Help/command/function.rst b/Help/command/function.rst new file mode 100644 index 0000000..b18e03c --- /dev/null +++ b/Help/command/function.rst @@ -0,0 +1,31 @@ +function +-------- + +Start recording a function for later invocation as a command. + +:: + + function(<name> [arg1 [arg2 [arg3 ...]]]) + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + endfunction(<name>) + +Define a function named <name> that takes arguments named arg1 arg2 +arg3 (...). Commands listed after function, but before the matching +endfunction, are not invoked until the function is invoked. When it +is invoked, the commands recorded in the function are first modified +by replacing formal parameters (${arg1}) with the arguments passed, +and then invoked as normal commands. In addition to referencing the +formal parameters you can reference the variable ARGC which will be +set to the number of arguments passed into the function as well as +ARGV0 ARGV1 ARGV2 ... which will have the actual values of the +arguments passed in. This facilitates creating functions with +optional arguments. Additionally ARGV holds the list of all arguments +given to the function and ARGN holds the list of arguments past the +last expected argument. + +A function opens a new scope: see set(var PARENT_SCOPE) for details. + +See the cmake_policy() command documentation for the behavior of +policies inside functions. diff --git a/Help/command/get_cmake_property.rst b/Help/command/get_cmake_property.rst new file mode 100644 index 0000000..bcfc5e8 --- /dev/null +++ b/Help/command/get_cmake_property.rst @@ -0,0 +1,15 @@ +get_cmake_property +------------------ + +Get a property of the CMake instance. + +:: + + get_cmake_property(VAR property) + +Get a property from the CMake instance. The value of the property is +stored in the variable VAR. If the property is not found, VAR will be +set to "NOTFOUND". Some supported properties include: VARIABLES, +CACHE_VARIABLES, COMMANDS, MACROS, and COMPONENTS. + +See also the more general get_property() command. diff --git a/Help/command/get_directory_property.rst b/Help/command/get_directory_property.rst new file mode 100644 index 0000000..f2a0a80 --- /dev/null +++ b/Help/command/get_directory_property.rst @@ -0,0 +1,24 @@ +get_directory_property +---------------------- + +Get a property of DIRECTORY scope. + +:: + + get_directory_property(<variable> [DIRECTORY <dir>] <prop-name>) + +Store a property of directory scope in the named variable. If the +property is not defined the empty-string is returned. The DIRECTORY +argument specifies another directory from which to retrieve the +property value. The specified directory must have already been +traversed by CMake. + +:: + + get_directory_property(<variable> [DIRECTORY <dir>] + DEFINITION <var-name>) + +Get a variable definition from a directory. This form is useful to +get a variable definition from another directory. + +See also the more general get_property() command. diff --git a/Help/command/get_filename_component.rst b/Help/command/get_filename_component.rst new file mode 100644 index 0000000..5eec792 --- /dev/null +++ b/Help/command/get_filename_component.rst @@ -0,0 +1,37 @@ +get_filename_component +---------------------- + +Get a specific component of a full filename. + +:: + + get_filename_component(<VAR> <FileName> <COMP> [CACHE]) + +Set <VAR> to a component of <FileName>, where <COMP> is one of: + +:: + + DIRECTORY = Directory without file name + NAME = File name without directory + EXT = File name longest extension (.b.c from d/a.b.c) + NAME_WE = File name without directory or longest extension + ABSOLUTE = Full path to file + REALPATH = Full path to existing file with symlinks resolved + PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11) + +Paths are returned with forward slashes and have no trailing slahes. +The longest file extension is always considered. If the optional +CACHE argument is specified, the result variable is added to the +cache. + +:: + + get_filename_component(<VAR> FileName + PROGRAM [PROGRAM_ARGS <ARG_VAR>] + [CACHE]) + +The program in FileName will be found in the system search path or +left as a full path. If PROGRAM_ARGS is present with PROGRAM, then +any command-line arguments present in the FileName string are split +from the program name and stored in <ARG_VAR>. This is used to +separate a program name from its arguments in a command line string. diff --git a/Help/command/get_property.rst b/Help/command/get_property.rst new file mode 100644 index 0000000..c2937be --- /dev/null +++ b/Help/command/get_property.rst @@ -0,0 +1,49 @@ +get_property +------------ + +Get a property. + +:: + + get_property(<variable> + <GLOBAL | + DIRECTORY [dir] | + TARGET <target> | + SOURCE <source> | + TEST <test> | + CACHE <entry> | + VARIABLE> + PROPERTY <name> + [SET | DEFINED | BRIEF_DOCS | FULL_DOCS]) + +Get one property from one object in a scope. The first argument +specifies the variable in which to store the result. The second +argument determines the scope from which to get the property. It must +be one of the following: + +GLOBAL scope is unique and does not accept a name. + +DIRECTORY scope defaults to the current directory but another +directory (already processed by CMake) may be named by full or +relative path. + +TARGET scope must name one existing target. + +SOURCE scope must name one source file. + +TEST scope must name one existing test. + +CACHE scope must name one cache entry. + +VARIABLE scope is unique and does not accept a name. + +The required PROPERTY option is immediately followed by the name of +the property to get. If the property is not set an empty value is +returned. If the SET option is given the variable is set to a boolean +value indicating whether the property has been set. If the DEFINED +option is given the variable is set to a boolean value indicating +whether the property has been defined such as with define_property. +If BRIEF_DOCS or FULL_DOCS is given then the variable is set to a +string containing documentation for the requested property. If +documentation is requested for a property that has not been defined +NOTFOUND is returned. diff --git a/Help/command/get_source_file_property.rst b/Help/command/get_source_file_property.rst new file mode 100644 index 0000000..80c512b --- /dev/null +++ b/Help/command/get_source_file_property.rst @@ -0,0 +1,16 @@ +get_source_file_property +------------------------ + +Get a property for a source file. + +:: + + get_source_file_property(VAR file property) + +Get a property from a source file. The value of the property is +stored in the variable VAR. If the property is not found, VAR will be +set to "NOTFOUND". Use set_source_files_properties to set property +values. Source file properties usually control how the file is built. +One property that is always there is LOCATION + +See also the more general get_property() command. diff --git a/Help/command/get_target_property.rst b/Help/command/get_target_property.rst new file mode 100644 index 0000000..4017d31 --- /dev/null +++ b/Help/command/get_target_property.rst @@ -0,0 +1,18 @@ +get_target_property +------------------- + +Get a property from a target. + +:: + + get_target_property(VAR target property) + +Get a property from a target. The value of the property is stored in +the variable VAR. If the property is not found, VAR will be set to +"NOTFOUND". Use set_target_properties to set property values. +Properties are usually used to control how a target is built, but some +query the target instead. This command can get properties for any +target so far created. The targets do not need to be in the current +CMakeLists.txt file. + +See also the more general get_property() command. diff --git a/Help/command/get_test_property.rst b/Help/command/get_test_property.rst new file mode 100644 index 0000000..2623755 --- /dev/null +++ b/Help/command/get_test_property.rst @@ -0,0 +1,15 @@ +get_test_property +----------------- + +Get a property of the test. + +:: + + get_test_property(test property VAR) + +Get a property from the Test. The value of the property is stored in +the variable VAR. If the property is not found, VAR will be set to +"NOTFOUND". For a list of standard properties you can type cmake +--help-property-list + +See also the more general get_property() command. diff --git a/Help/command/if.rst b/Help/command/if.rst new file mode 100644 index 0000000..b879ae1 --- /dev/null +++ b/Help/command/if.rst @@ -0,0 +1,238 @@ +if +-- + +Conditionally execute a group of commands. + +:: + + if(expression) + # then section. + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + elseif(expression2) + # elseif section. + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + else(expression) + # else section. + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + endif(expression) + +Evaluates the given expression. If the result is true, the commands +in the THEN section are invoked. Otherwise, the commands in the else +section are invoked. The elseif and else sections are optional. You +may have multiple elseif clauses. Note that the expression in the +else and endif clause is optional. Long expressions can be used and +there is a traditional order of precedence. Parenthetical expressions +are evaluated first followed by unary operators such as EXISTS, +COMMAND, and DEFINED. Then any EQUAL, LESS, GREATER, STRLESS, +STRGREATER, STREQUAL, MATCHES will be evaluated. Then NOT operators +and finally AND, OR operators will be evaluated. Possible expressions +are: + +:: + + if(<constant>) + +True if the constant is 1, ON, YES, TRUE, Y, or a non-zero number. +False if the constant is 0, OFF, NO, FALSE, N, IGNORE, NOTFOUND, '', +or ends in the suffix '-NOTFOUND'. Named boolean constants are +case-insensitive. If the argument is not one of these constants, it +is treated as a variable: + +:: + + if(<variable>) + +True if the variable is defined to a value that is not a false +constant. False otherwise. (Note macro arguments are not variables.) + +:: + + if(NOT <expression>) + +True if the expression is not true. + +:: + + if(<expr1> AND <expr2>) + +True if both expressions would be considered true individually. + +:: + + if(<expr1> OR <expr2>) + +True if either expression would be considered true individually. + +:: + + if(COMMAND command-name) + +True if the given name is a command, macro or function that can be +invoked. + +:: + + if(POLICY policy-id) + +True if the given name is an existing policy (of the form CMP<NNNN>). + +:: + + if(TARGET target-name) + +True if the given name is an existing target, built or imported. + +:: + + if(EXISTS file-name) + if(EXISTS directory-name) + +True if the named file or directory exists. Behavior is well-defined +only for full paths. + +:: + + if(file1 IS_NEWER_THAN file2) + +True if file1 is newer than file2 or if one of the two files doesn't +exist. Behavior is well-defined only for full paths. If the file +time stamps are exactly the same, an IS_NEWER_THAN comparison returns +true, so that any dependent build operations will occur in the event +of a tie. This includes the case of passing the same file name for +both file1 and file2. + +:: + + if(IS_DIRECTORY directory-name) + +True if the given name is a directory. Behavior is well-defined only +for full paths. + +:: + + if(IS_SYMLINK file-name) + +True if the given name is a symbolic link. Behavior is well-defined +only for full paths. + +:: + + if(IS_ABSOLUTE path) + +True if the given path is an absolute path. + +:: + + if(<variable|string> MATCHES regex) + +True if the given string or variable's value matches the given regular +expression. + +:: + + if(<variable|string> LESS <variable|string>) + if(<variable|string> GREATER <variable|string>) + if(<variable|string> EQUAL <variable|string>) + +True if the given string or variable's value is a valid number and the +inequality or equality is true. + +:: + + if(<variable|string> STRLESS <variable|string>) + if(<variable|string> STRGREATER <variable|string>) + if(<variable|string> STREQUAL <variable|string>) + +True if the given string or variable's value is lexicographically less +(or greater, or equal) than the string or variable on the right. + +:: + + if(<variable|string> VERSION_LESS <variable|string>) + if(<variable|string> VERSION_EQUAL <variable|string>) + if(<variable|string> VERSION_GREATER <variable|string>) + +Component-wise integer version number comparison (version format is +major[.minor[.patch[.tweak]]]). + +:: + + if(DEFINED <variable>) + +True if the given variable is defined. It does not matter if the +variable is true or false just if it has been set. + +:: + + if((expression) AND (expression OR (expression))) + +The expressions inside the parenthesis are evaluated first and then +the remaining expression is evaluated as in the previous examples. +Where there are nested parenthesis the innermost are evaluated as part +of evaluating the expression that contains them. + +The if command was written very early in CMake's history, predating +the ${} variable evaluation syntax, and for convenience evaluates +variables named by its arguments as shown in the above signatures. +Note that normal variable evaluation with ${} applies before the if +command even receives the arguments. Therefore code like + +:: + + set(var1 OFF) + set(var2 "var1") + if(${var2}) + +appears to the if command as + +:: + + if(var1) + +and is evaluated according to the if(<variable>) case documented +above. The result is OFF which is false. However, if we remove the +${} from the example then the command sees + +:: + + if(var2) + +which is true because var2 is defined to "var1" which is not a false +constant. + +Automatic evaluation applies in the other cases whenever the +above-documented signature accepts <variable|string>: + +1) The left hand argument to MATCHES is first checked to see if it is +a defined variable, if so the variable's value is used, otherwise the +original value is used. + +2) If the left hand argument to MATCHES is missing it returns false +without error + +3) Both left and right hand arguments to LESS GREATER EQUAL are +independently tested to see if they are defined variables, if so their +defined values are used otherwise the original value is used. + +4) Both left and right hand arguments to STRLESS STREQUAL STRGREATER +are independently tested to see if they are defined variables, if so +their defined values are used otherwise the original value is used. + +5) Both left and right hand argumemnts to VERSION_LESS VERSION_EQUAL +VERSION_GREATER are independently tested to see if they are defined +variables, if so their defined values are used otherwise the original +value is used. + +6) The right hand argument to NOT is tested to see if it is a boolean +constant, if so the value is used, otherwise it is assumed to be a +variable and it is dereferenced. + +7) The left and right hand arguments to AND OR are independently +tested to see if they are boolean constants, if so they are used as +such, otherwise they are assumed to be variables and are dereferenced. diff --git a/Help/command/include.rst b/Help/command/include.rst new file mode 100644 index 0000000..a9074c1 --- /dev/null +++ b/Help/command/include.rst @@ -0,0 +1,25 @@ +include +------- + +Load and run CMake code from a file or module. + +:: + + include(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR>] + [NO_POLICY_SCOPE]) + +Load and run CMake code from the file given. Variable reads and +writes access the scope of the caller (dynamic scoping). If OPTIONAL +is present, then no error is raised if the file does not exist. If +RESULT_VARIABLE is given the variable will be set to the full filename +which has been included or NOTFOUND if it failed. + +If a module is specified instead of a file, the file with name +<modulename>.cmake is searched first in CMAKE_MODULE_PATH, then in the +CMake module directory. There is one exception to this: if the file +which calls include() is located itself in the CMake module directory, +then first the CMake module directory is searched and +CMAKE_MODULE_PATH afterwards. See also policy CMP0017. + +See the cmake_policy() command documentation for discussion of the +NO_POLICY_SCOPE option. diff --git a/Help/command/include_directories.rst b/Help/command/include_directories.rst new file mode 100644 index 0000000..6744427 --- /dev/null +++ b/Help/command/include_directories.rst @@ -0,0 +1,30 @@ +include_directories +------------------- + +Add include directories to the build. + +:: + + include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...) + +Add the given directories to those the compiler uses to search for +include files. Relative paths are interpreted as relative to the +current source directory. + +The include directories are added to the directory property +INCLUDE_DIRECTORIES for the current CMakeLists file. They are also +added to the target property INCLUDE_DIRECTORIES for each target in +the current CMakeLists file. The target property values are the ones +used by the generators. + +By default the directories are appended onto the current list of +directories. This default behavior can be changed by setting +CMAKE_INCLUDE_DIRECTORIES_BEFORE to ON. By using AFTER or BEFORE +explicitly, you can select between appending and prepending, +independent of the default. + +If the SYSTEM option is given, the compiler will be told the +directories are meant as system include directories on some platforms +(signalling this setting might achieve effects such as the compiler +skipping warnings, or these fixed-install system files not being +considered in dependency calculations - see compiler docs). diff --git a/Help/command/include_external_msproject.rst b/Help/command/include_external_msproject.rst new file mode 100644 index 0000000..ba9a393 --- /dev/null +++ b/Help/command/include_external_msproject.rst @@ -0,0 +1,23 @@ +include_external_msproject +-------------------------- + +Include an external Microsoft project file in a workspace. + +:: + + include_external_msproject(projectname location + [TYPE projectTypeGUID] + [GUID projectGUID] + [PLATFORM platformName] + dep1 dep2 ...) + +Includes an external Microsoft project in the generated workspace +file. Currently does nothing on UNIX. This will create a target +named [projectname]. This can be used in the add_dependencies command +to make things depend on the external project. + +TYPE, GUID and PLATFORM are optional parameters that allow one to +specify the type of project, id (GUID) of the project and the name of +the target platform. This is useful for projects requiring values +other than the default (e.g. WIX projects). These options are not +supported by the Visual Studio 6 generator. diff --git a/Help/command/include_regular_expression.rst b/Help/command/include_regular_expression.rst new file mode 100644 index 0000000..dd887df --- /dev/null +++ b/Help/command/include_regular_expression.rst @@ -0,0 +1,18 @@ +include_regular_expression +-------------------------- + +Set the regular expression used for dependency checking. + +:: + + include_regular_expression(regex_match [regex_complain]) + +Set the regular expressions used in dependency checking. Only files +matching regex_match will be traced as dependencies. Only files +matching regex_complain will generate warnings if they cannot be found +(standard header paths are not searched). The defaults are: + +:: + + regex_match = "^.*$" (match everything) + regex_complain = "^$" (match empty string only) diff --git a/Help/command/install.rst b/Help/command/install.rst new file mode 100644 index 0000000..9b27cae --- /dev/null +++ b/Help/command/install.rst @@ -0,0 +1,316 @@ +install +------- + +Specify rules to run at install time. + +This command generates installation rules for a project. Rules +specified by calls to this command within a source directory are +executed in order during installation. The order across directories +is not defined. + +There are multiple signatures for this command. Some of them define +installation properties for files and targets. Properties common to +multiple signatures are covered here but they are valid only for +signatures that specify them. + +DESTINATION arguments specify the directory on disk to which a file +will be installed. If a full path (with a leading slash or drive +letter) is given it is used directly. If a relative path is given it +is interpreted relative to the value of CMAKE_INSTALL_PREFIX. The +prefix can be relocated at install time using DESTDIR mechanism +explained in the CMAKE_INSTALL_PREFIX variable documentation. + +PERMISSIONS arguments specify permissions for installed files. Valid +permissions are OWNER_READ, OWNER_WRITE, OWNER_EXECUTE, GROUP_READ, +GROUP_WRITE, GROUP_EXECUTE, WORLD_READ, WORLD_WRITE, WORLD_EXECUTE, +SETUID, and SETGID. Permissions that do not make sense on certain +platforms are ignored on those platforms. + +The CONFIGURATIONS argument specifies a list of build configurations +for which the install rule applies (Debug, Release, etc.). + +The COMPONENT argument specifies an installation component name with +which the install rule is associated, such as "runtime" or +"development". During component-specific installation only install +rules associated with the given component name will be executed. +During a full installation all components are installed. If COMPONENT +is not provided a default component "Unspecified" is created. The +default component name may be controlled with the +CMAKE_INSTALL_DEFAULT_COMPONENT_NAME variable. + +The RENAME argument specifies a name for an installed file that may be +different from the original file. Renaming is allowed only when a +single file is installed by the command. + +The OPTIONAL argument specifies that it is not an error if the file to +be installed does not exist. + +The TARGETS signature: + +:: + + install(TARGETS targets... [EXPORT <export-name>] + [[ARCHIVE|LIBRARY|RUNTIME|FRAMEWORK|BUNDLE| + PRIVATE_HEADER|PUBLIC_HEADER|RESOURCE] + [DESTINATION <dir>] + [INCLUDES DESTINATION [<dir> ...]] + [PERMISSIONS permissions...] + [CONFIGURATIONS [Debug|Release|...]] + [COMPONENT <component>] + [OPTIONAL] [NAMELINK_ONLY|NAMELINK_SKIP] + ] [...]) + +The TARGETS form specifies rules for installing targets from a +project. There are five kinds of target files that may be installed: +ARCHIVE, LIBRARY, RUNTIME, FRAMEWORK, and BUNDLE. Executables are +treated as RUNTIME targets, except that those marked with the +MACOSX_BUNDLE property are treated as BUNDLE targets on OS X. Static +libraries are always treated as ARCHIVE targets. Module libraries are +always treated as LIBRARY targets. For non-DLL platforms shared +libraries are treated as LIBRARY targets, except that those marked +with the FRAMEWORK property are treated as FRAMEWORK targets on OS X. +For DLL platforms the DLL part of a shared library is treated as a +RUNTIME target and the corresponding import library is treated as an +ARCHIVE target. All Windows-based systems including Cygwin are DLL +platforms. The ARCHIVE, LIBRARY, RUNTIME, and FRAMEWORK arguments +change the type of target to which the subsequent properties apply. +If none is given the installation properties apply to all target +types. If only one is given then only targets of that type will be +installed (which can be used to install just a DLL or just an import +library).The INCLUDES DESTINATION specifies a list of directories +which will be added to the INTERFACE_INCLUDE_DIRECTORIES of the +<targets> when exported by install(EXPORT). If a relative path is +specified, it is treated as relative to the $<INSTALL_PREFIX>. + +The PRIVATE_HEADER, PUBLIC_HEADER, and RESOURCE arguments cause +subsequent properties to be applied to installing a FRAMEWORK shared +library target's associated files on non-Apple platforms. Rules +defined by these arguments are ignored on Apple platforms because the +associated files are installed into the appropriate locations inside +the framework folder. See documentation of the PRIVATE_HEADER, +PUBLIC_HEADER, and RESOURCE target properties for details. + +Either NAMELINK_ONLY or NAMELINK_SKIP may be specified as a LIBRARY +option. On some platforms a versioned shared library has a symbolic +link such as + +:: + + lib<name>.so -> lib<name>.so.1 + +where "lib<name>.so.1" is the soname of the library and "lib<name>.so" +is a "namelink" allowing linkers to find the library when given +"-l<name>". The NAMELINK_ONLY option causes installation of only the +namelink when a library target is installed. The NAMELINK_SKIP option +causes installation of library files other than the namelink when a +library target is installed. When neither option is given both +portions are installed. On platforms where versioned shared libraries +do not have namelinks or when a library is not versioned the +NAMELINK_SKIP option installs the library and the NAMELINK_ONLY option +installs nothing. See the VERSION and SOVERSION target properties for +details on creating versioned shared libraries. + +One or more groups of properties may be specified in a single call to +the TARGETS form of this command. A target may be installed more than +once to different locations. Consider hypothetical targets "myExe", +"mySharedLib", and "myStaticLib". The code + +:: + + install(TARGETS myExe mySharedLib myStaticLib + RUNTIME DESTINATION bin + LIBRARY DESTINATION lib + ARCHIVE DESTINATION lib/static) + install(TARGETS mySharedLib DESTINATION /some/full/path) + +will install myExe to <prefix>/bin and myStaticLib to +<prefix>/lib/static. On non-DLL platforms mySharedLib will be +installed to <prefix>/lib and /some/full/path. On DLL platforms the +mySharedLib DLL will be installed to <prefix>/bin and /some/full/path +and its import library will be installed to <prefix>/lib/static and +/some/full/path. + +The EXPORT option associates the installed target files with an export +called <export-name>. It must appear before any RUNTIME, LIBRARY, or +ARCHIVE options. To actually install the export file itself, call +install(EXPORT). See documentation of the install(EXPORT ...) +signature below for details. + +Installing a target with EXCLUDE_FROM_ALL set to true has undefined +behavior. + +The FILES signature: + +:: + + install(FILES files... DESTINATION <dir> + [PERMISSIONS permissions...] + [CONFIGURATIONS [Debug|Release|...]] + [COMPONENT <component>] + [RENAME <name>] [OPTIONAL]) + +The FILES form specifies rules for installing files for a project. +File names given as relative paths are interpreted with respect to the +current source directory. Files installed by this form are by default +given permissions OWNER_WRITE, OWNER_READ, GROUP_READ, and WORLD_READ +if no PERMISSIONS argument is given. + +The PROGRAMS signature: + +:: + + install(PROGRAMS files... DESTINATION <dir> + [PERMISSIONS permissions...] + [CONFIGURATIONS [Debug|Release|...]] + [COMPONENT <component>] + [RENAME <name>] [OPTIONAL]) + +The PROGRAMS form is identical to the FILES form except that the +default permissions for the installed file also include OWNER_EXECUTE, +GROUP_EXECUTE, and WORLD_EXECUTE. This form is intended to install +programs that are not targets, such as shell scripts. Use the TARGETS +form to install targets built within the project. + +The DIRECTORY signature: + +:: + + install(DIRECTORY dirs... DESTINATION <dir> + [FILE_PERMISSIONS permissions...] + [DIRECTORY_PERMISSIONS permissions...] + [USE_SOURCE_PERMISSIONS] [OPTIONAL] + [CONFIGURATIONS [Debug|Release|...]] + [COMPONENT <component>] [FILES_MATCHING] + [[PATTERN <pattern> | REGEX <regex>] + [EXCLUDE] [PERMISSIONS permissions...]] [...]) + +The DIRECTORY form installs contents of one or more directories to a +given destination. The directory structure is copied verbatim to the +destination. The last component of each directory name is appended to +the destination directory but a trailing slash may be used to avoid +this because it leaves the last component empty. Directory names +given as relative paths are interpreted with respect to the current +source directory. If no input directory names are given the +destination directory will be created but nothing will be installed +into it. The FILE_PERMISSIONS and DIRECTORY_PERMISSIONS options +specify permissions given to files and directories in the destination. +If USE_SOURCE_PERMISSIONS is specified and FILE_PERMISSIONS is not, +file permissions will be copied from the source directory structure. +If no permissions are specified files will be given the default +permissions specified in the FILES form of the command, and the +directories will be given the default permissions specified in the +PROGRAMS form of the command. + +Installation of directories may be controlled with fine granularity +using the PATTERN or REGEX options. These "match" options specify a +globbing pattern or regular expression to match directories or files +encountered within input directories. They may be used to apply +certain options (see below) to a subset of the files and directories +encountered. The full path to each input file or directory (with +forward slashes) is matched against the expression. A PATTERN will +match only complete file names: the portion of the full path matching +the pattern must occur at the end of the file name and be preceded by +a slash. A REGEX will match any portion of the full path but it may +use '/' and '$' to simulate the PATTERN behavior. By default all +files and directories are installed whether or not they are matched. +The FILES_MATCHING option may be given before the first match option +to disable installation of files (but not directories) not matched by +any expression. For example, the code + +:: + + install(DIRECTORY src/ DESTINATION include/myproj + FILES_MATCHING PATTERN "*.h") + +will extract and install header files from a source tree. + +Some options may follow a PATTERN or REGEX expression and are applied +only to files or directories matching them. The EXCLUDE option will +skip the matched file or directory. The PERMISSIONS option overrides +the permissions setting for the matched file or directory. For +example the code + +:: + + install(DIRECTORY icons scripts/ DESTINATION share/myproj + PATTERN "CVS" EXCLUDE + PATTERN "scripts/*" + PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ + GROUP_EXECUTE GROUP_READ) + +will install the icons directory to share/myproj/icons and the scripts +directory to share/myproj. The icons will get default file +permissions, the scripts will be given specific permissions, and any +CVS directories will be excluded. + +The SCRIPT and CODE signature: + +:: + + install([[SCRIPT <file>] [CODE <code>]] [...]) + +The SCRIPT form will invoke the given CMake script files during +installation. If the script file name is a relative path it will be +interpreted with respect to the current source directory. The CODE +form will invoke the given CMake code during installation. Code is +specified as a single argument inside a double-quoted string. For +example, the code + +:: + + install(CODE "MESSAGE(\"Sample install message.\")") + +will print a message during installation. + +The EXPORT signature: + +:: + + install(EXPORT <export-name> DESTINATION <dir> + [NAMESPACE <namespace>] [FILE <name>.cmake] + [PERMISSIONS permissions...] + [CONFIGURATIONS [Debug|Release|...]] + [EXPORT_LINK_INTERFACE_LIBRARIES] + [COMPONENT <component>]) + +The EXPORT form generates and installs a CMake file containing code to +import targets from the installation tree into another project. +Target installations are associated with the export <export-name> +using the EXPORT option of the install(TARGETS ...) signature +documented above. The NAMESPACE option will prepend <namespace> to +the target names as they are written to the import file. By default +the generated file will be called <export-name>.cmake but the FILE +option may be used to specify a different name. The value given to +the FILE option must be a file name with the ".cmake" extension. If a +CONFIGURATIONS option is given then the file will only be installed +when one of the named configurations is installed. Additionally, the +generated import file will reference only the matching target +configurations. The EXPORT_LINK_INTERFACE_LIBRARIES keyword, if +present, causes the contents of the properties matching +(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)? to be exported, when +policy CMP0022 is NEW. If a COMPONENT option is specified that does +not match that given to the targets associated with <export-name> the +behavior is undefined. If a library target is included in the export +but a target to which it links is not included the behavior is +unspecified. + +The EXPORT form is useful to help outside projects use targets built +and installed by the current project. For example, the code + +:: + + install(TARGETS myexe EXPORT myproj DESTINATION bin) + install(EXPORT myproj NAMESPACE mp_ DESTINATION lib/myproj) + +will install the executable myexe to <prefix>/bin and code to import +it in the file "<prefix>/lib/myproj/myproj.cmake". An outside project +may load this file with the include command and reference the myexe +executable from the installation tree using the imported target name +mp_myexe as if the target were built in its own tree. + +NOTE: This command supercedes the INSTALL_TARGETS command and the +target properties PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT. It also +replaces the FILES forms of the INSTALL_FILES and INSTALL_PROGRAMS +commands. The processing order of these install rules relative to +those generated by INSTALL_TARGETS, INSTALL_FILES, and +INSTALL_PROGRAMS commands is not defined. diff --git a/Help/command/install_files.rst b/Help/command/install_files.rst new file mode 100644 index 0000000..7b6bd81 --- /dev/null +++ b/Help/command/install_files.rst @@ -0,0 +1,39 @@ +install_files +------------- + +Deprecated. Use the install(FILES ) command instead. + +This command has been superceded by the install command. It is +provided for compatibility with older CMake code. The FILES form is +directly replaced by the FILES form of the install command. The +regexp form can be expressed more clearly using the GLOB form of the +file command. + +:: + + install_files(<dir> extension file file ...) + +Create rules to install the listed files with the given extension into +the given directory. Only files existing in the current source tree +or its corresponding location in the binary tree may be listed. If a +file specified already has an extension, that extension will be +removed first. This is useful for providing lists of source files +such as foo.cxx when you want the corresponding foo.h to be installed. +A typical extension is '.h'. + +:: + + install_files(<dir> regexp) + +Any files in the current source directory that match the regular +expression will be installed. + +:: + + install_files(<dir> FILES file file ...) + +Any files listed after the FILES keyword will be installed explicitly +from the names given. Full paths are allowed in this form. + +The directory <dir> is relative to the installation prefix, which is +stored in the variable CMAKE_INSTALL_PREFIX. diff --git a/Help/command/install_programs.rst b/Help/command/install_programs.rst new file mode 100644 index 0000000..26789d8 --- /dev/null +++ b/Help/command/install_programs.rst @@ -0,0 +1,33 @@ +install_programs +---------------- + +Deprecated. Use the install(PROGRAMS ) command instead. + +This command has been superceded by the install command. It is +provided for compatibility with older CMake code. The FILES form is +directly replaced by the PROGRAMS form of the INSTALL command. The +regexp form can be expressed more clearly using the GLOB form of the +FILE command. + +:: + + install_programs(<dir> file1 file2 [file3 ...]) + install_programs(<dir> FILES file1 [file2 ...]) + +Create rules to install the listed programs into the given directory. +Use the FILES argument to guarantee that the file list version of the +command will be used even when there is only one argument. + +:: + + install_programs(<dir> regexp) + +In the second form any program in the current source directory that +matches the regular expression will be installed. + +This command is intended to install programs that are not built by +cmake, such as shell scripts. See the TARGETS form of the INSTALL +command to create installation rules for targets built by cmake. + +The directory <dir> is relative to the installation prefix, which is +stored in the variable CMAKE_INSTALL_PREFIX. diff --git a/Help/command/install_targets.rst b/Help/command/install_targets.rst new file mode 100644 index 0000000..caa933f --- /dev/null +++ b/Help/command/install_targets.rst @@ -0,0 +1,17 @@ +install_targets +--------------- + +Deprecated. Use the install(TARGETS ) command instead. + +This command has been superceded by the install command. It is +provided for compatibility with older CMake code. + +:: + + install_targets(<dir> [RUNTIME_DIRECTORY dir] target target) + +Create rules to install the listed targets into the given directory. +The directory <dir> is relative to the installation prefix, which is +stored in the variable CMAKE_INSTALL_PREFIX. If RUNTIME_DIRECTORY is +specified, then on systems with special runtime files (Windows DLL), +the files will be copied to that directory. diff --git a/Help/command/link_directories.rst b/Help/command/link_directories.rst new file mode 100644 index 0000000..bdc94cd --- /dev/null +++ b/Help/command/link_directories.rst @@ -0,0 +1,19 @@ +link_directories +---------------- + +Specify directories in which the linker will look for libraries. + +:: + + link_directories(directory1 directory2 ...) + +Specify the paths in which the linker should search for libraries. +The command will apply only to targets created after it is called. +Relative paths given to this command are interpreted as relative to +the current source directory, see CMP0015. + +Note that this command is rarely necessary. Library locations +returned by find_package() and find_library() are absolute paths. +Pass these absolute library file paths directly to the +target_link_libraries() command. CMake will ensure the linker finds +them. diff --git a/Help/command/link_libraries.rst b/Help/command/link_libraries.rst new file mode 100644 index 0000000..d690c9b --- /dev/null +++ b/Help/command/link_libraries.rst @@ -0,0 +1,16 @@ +link_libraries +-------------- + +Deprecated. Use the target_link_libraries() command instead. + +Link libraries to all targets added later. + +:: + + link_libraries(library1 <debug | optimized> library2 ...) + +Specify a list of libraries to be linked into any following targets +(typically added with the add_executable or add_library calls). This +command is passed down to all subdirectories. The debug and optimized +strings may be used to indicate that the next library listed is to be +used only for that specific type of build. diff --git a/Help/command/list.rst b/Help/command/list.rst new file mode 100644 index 0000000..f044dba --- /dev/null +++ b/Help/command/list.rst @@ -0,0 +1,60 @@ +list +---- + +List operations. + +:: + + list(LENGTH <list> <output variable>) + list(GET <list> <element index> [<element index> ...] + <output variable>) + list(APPEND <list> [<element> ...]) + list(FIND <list> <value> <output variable>) + list(INSERT <list> <element_index> <element> [<element> ...]) + list(REMOVE_ITEM <list> <value> [<value> ...]) + list(REMOVE_AT <list> <index> [<index> ...]) + list(REMOVE_DUPLICATES <list>) + list(REVERSE <list>) + list(SORT <list>) + +LENGTH will return a given list's length. + +GET will return list of elements specified by indices from the list. + +APPEND will append elements to the list. + +FIND will return the index of the element specified in the list or -1 +if it wasn't found. + +INSERT will insert elements to the list to the specified location. + +REMOVE_AT and REMOVE_ITEM will remove items from the list. The +difference is that REMOVE_ITEM will remove the given items, while +REMOVE_AT will remove the items at the given indices. + +REMOVE_DUPLICATES will remove duplicated items in the list. + +REVERSE reverses the contents of the list in-place. + +SORT sorts the list in-place alphabetically. + +The list subcommands APPEND, INSERT, REMOVE_AT, REMOVE_ITEM, +REMOVE_DUPLICATES, REVERSE and SORT may create new values for the list +within the current CMake variable scope. Similar to the SET command, +the LIST command creates new variable values in the current scope, +even if the list itself is actually defined in a parent scope. To +propagate the results of these operations upwards, use SET with +PARENT_SCOPE, SET with CACHE INTERNAL, or some other means of value +propagation. + +NOTES: A list in cmake is a ; separated group of strings. To create a +list the set command can be used. For example, set(var a b c d e) +creates a list with a;b;c;d;e, and set(var "a b c d e") creates a +string or a list with one item in it. + +When specifying index values, if <element index> is 0 or greater, it +is indexed from the beginning of the list, with 0 representing the +first list element. If <element index> is -1 or lesser, it is indexed +from the end of the list, with -1 representing the last list element. +Be careful when counting with negative indices: they do not start from +0. -0 is equivalent to 0, the first list element. diff --git a/Help/command/load_cache.rst b/Help/command/load_cache.rst new file mode 100644 index 0000000..b7484cb --- /dev/null +++ b/Help/command/load_cache.rst @@ -0,0 +1,27 @@ +load_cache +---------- + +Load in the values from another project's CMake cache. + +:: + + load_cache(pathToCacheFile READ_WITH_PREFIX + prefix entry1...) + +Read the cache and store the requested entries in variables with their +name prefixed with the given prefix. This only reads the values, and +does not create entries in the local project's cache. + +:: + + load_cache(pathToCacheFile [EXCLUDE entry1...] + [INCLUDE_INTERNALS entry1...]) + +Load in the values from another cache and store them in the local +project's cache as internal entries. This is useful for a project +that depends on another project built in a different tree. EXCLUDE +option can be used to provide a list of entries to be excluded. +INCLUDE_INTERNALS can be used to provide a list of internal entries to +be included. Normally, no internal entries are brought in. Use of +this form of the command is strongly discouraged, but it is provided +for backward compatibility. diff --git a/Help/command/load_command.rst b/Help/command/load_command.rst new file mode 100644 index 0000000..63f23be --- /dev/null +++ b/Help/command/load_command.rst @@ -0,0 +1,21 @@ +load_command +------------ + +Load a command into a running CMake. + +:: + + load_command(COMMAND_NAME <loc1> [loc2 ...]) + +The given locations are searched for a library whose name is +cmCOMMAND_NAME. If found, it is loaded as a module and the command is +added to the set of available CMake commands. Usually, TRY_COMPILE is +used before this command to compile the module. If the command is +successfully loaded a variable named + +:: + + CMAKE_LOADED_COMMAND_<COMMAND_NAME> + +will be set to the full path of the module that was loaded. Otherwise +the variable will not be set. diff --git a/Help/command/macro.rst b/Help/command/macro.rst new file mode 100644 index 0000000..aa16352 --- /dev/null +++ b/Help/command/macro.rst @@ -0,0 +1,33 @@ +macro +----- + +Start recording a macro for later invocation as a command. + +:: + + macro(<name> [arg1 [arg2 [arg3 ...]]]) + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + endmacro(<name>) + +Define a macro named <name> that takes arguments named arg1 arg2 arg3 +(...). Commands listed after macro, but before the matching endmacro, +are not invoked until the macro is invoked. When it is invoked, the +commands recorded in the macro are first modified by replacing formal +parameters (${arg1}) with the arguments passed, and then invoked as +normal commands. In addition to referencing the formal parameters you +can reference the values ${ARGC} which will be set to the number of +arguments passed into the function as well as ${ARGV0} ${ARGV1} +${ARGV2} ... which will have the actual values of the arguments +passed in. This facilitates creating macros with optional arguments. +Additionally ${ARGV} holds the list of all arguments given to the +macro and ${ARGN} holds the list of arguments past the last expected +argument. Note that the parameters to a macro and values such as ARGN +are not variables in the usual CMake sense. They are string +replacements much like the C preprocessor would do with a macro. If +you want true CMake variables and/or better CMake scope control you +should look at the function command. + +See the cmake_policy() command documentation for the behavior of +policies inside macros. diff --git a/Help/command/make_directory.rst b/Help/command/make_directory.rst new file mode 100644 index 0000000..44dbe97 --- /dev/null +++ b/Help/command/make_directory.rst @@ -0,0 +1,12 @@ +make_directory +-------------- + +Deprecated. Use the file(MAKE_DIRECTORY ) command instead. + +:: + + make_directory(directory) + +Creates the specified directory. Full paths should be given. Any +parent directories that do not exist will also be created. Use with +care. diff --git a/Help/command/mark_as_advanced.rst b/Help/command/mark_as_advanced.rst new file mode 100644 index 0000000..30b1289 --- /dev/null +++ b/Help/command/mark_as_advanced.rst @@ -0,0 +1,19 @@ +mark_as_advanced +---------------- + +Mark cmake cached variables as advanced. + +:: + + mark_as_advanced([CLEAR|FORCE] VAR [VAR2 ...]) + +Mark the named cached variables as advanced. An advanced variable +will not be displayed in any of the cmake GUIs unless the show +advanced option is on. If CLEAR is the first argument advanced +variables are changed back to unadvanced. If FORCE is the first +argument, then the variable is made advanced. If neither FORCE nor +CLEAR is specified, new values will be marked as advanced, but if the +variable already has an advanced/non-advanced state, it will not be +changed. + +It does nothing in script mode. diff --git a/Help/command/math.rst b/Help/command/math.rst new file mode 100644 index 0000000..38fde1d --- /dev/null +++ b/Help/command/math.rst @@ -0,0 +1,13 @@ +math +---- + +Mathematical expressions. + +:: + + math(EXPR <output variable> <math expression>) + +EXPR evaluates mathematical expression and returns result in the +output variable. Example mathematical expression is '5 * ( 10 + 13 +)'. Supported operators are + - * / % | & ^ ~ << >> * / %. They have +the same meaning as they do in C code. diff --git a/Help/command/message.rst b/Help/command/message.rst new file mode 100644 index 0000000..a20325a --- /dev/null +++ b/Help/command/message.rst @@ -0,0 +1,33 @@ +message +------- + +Display a message to the user. + +:: + + message([<mode>] "message to display" ...) + +The optional <mode> keyword determines the type of message: + +:: + + (none) = Important information + STATUS = Incidental information + WARNING = CMake Warning, continue processing + AUTHOR_WARNING = CMake Warning (dev), continue processing + SEND_ERROR = CMake Error, continue processing, + but skip generation + FATAL_ERROR = CMake Error, stop processing and generation + DEPRECATION = CMake Deprecation Error or Warning if variable + CMAKE_ERROR_DEPRECATED or CMAKE_WARN_DEPRECATED + is enabled, respectively, else no message. + +The CMake command-line tool displays STATUS messages on stdout and all +other message types on stderr. The CMake GUI displays all messages in +its log area. The interactive dialogs (ccmake and CMakeSetup) show +STATUS messages one at a time on a status line and other messages in +interactive pop-up boxes. + +CMake Warning and Error message text displays using a simple markup +language. Non-indented text is formatted in line-wrapped paragraphs +delimited by newlines. Indented text is considered pre-formatted. diff --git a/Help/command/option.rst b/Help/command/option.rst new file mode 100644 index 0000000..244ed07 --- /dev/null +++ b/Help/command/option.rst @@ -0,0 +1,15 @@ +option +------ + +Provides an option that the user can optionally select. + +:: + + option(<option_variable> "help string describing option" + [initial value]) + +Provide an option for the user to select as ON or OFF. If no initial +value is provided, OFF is used. + +If you have options that depend on the values of other options, see +the module help for CMakeDependentOption. diff --git a/Help/command/output_required_files.rst b/Help/command/output_required_files.rst new file mode 100644 index 0000000..d6bce13 --- /dev/null +++ b/Help/command/output_required_files.rst @@ -0,0 +1,17 @@ +output_required_files +--------------------- + +Deprecated. Approximate C preprocessor dependency scanning. + +This command exists only because ancient CMake versions provided it. +CMake handles preprocessor dependency scanning automatically using a +more advanced scanner. + +:: + + output_required_files(srcfile outputfile) + +Outputs a list of all the source files that are required by the +specified srcfile. This list is written into outputfile. This is +similar to writing out the dependencies for srcfile except that it +jumps from .h files into .cxx, .c and .cpp files if possible. diff --git a/Help/command/project.rst b/Help/command/project.rst new file mode 100644 index 0000000..9b9f93f --- /dev/null +++ b/Help/command/project.rst @@ -0,0 +1,27 @@ +project +------- + +Set a name for the entire project. + +:: + + project(<projectname> [languageName1 languageName2 ... ] ) + +Sets the name of the project. Additionally this sets the variables +<projectName>_BINARY_DIR and <projectName>_SOURCE_DIR to the +respective values. + +Optionally you can specify which languages your project supports. +Example languages are CXX (i.e. C++), C, Fortran, etc. By default C +and CXX are enabled. E.g. if you do not have a C++ compiler, you can +disable the check for it by explicitly listing the languages you want +to support, e.g. C. By using the special language "NONE" all checks +for any language can be disabled. If a variable exists called +CMAKE_PROJECT_<projectName>_INCLUDE, the file pointed to by that +variable will be included as the last step of the project command. + +The top-level CMakeLists.txt file for a project must contain a +literal, direct call to the project() command; loading one through the +include() command is not sufficient. If no such call exists CMake +will implicitly add one to the top that enables the default languages +(C and CXX). diff --git a/Help/command/qt_wrap_cpp.rst b/Help/command/qt_wrap_cpp.rst new file mode 100644 index 0000000..81bbc06 --- /dev/null +++ b/Help/command/qt_wrap_cpp.rst @@ -0,0 +1,12 @@ +qt_wrap_cpp +----------- + +Create Qt Wrappers. + +:: + + qt_wrap_cpp(resultingLibraryName DestName + SourceLists ...) + +Produce moc files for all the .h files listed in the SourceLists. The +moc files will be added to the library using the DestName source list. diff --git a/Help/command/qt_wrap_ui.rst b/Help/command/qt_wrap_ui.rst new file mode 100644 index 0000000..4e033a8 --- /dev/null +++ b/Help/command/qt_wrap_ui.rst @@ -0,0 +1,14 @@ +qt_wrap_ui +---------- + +Create Qt user interfaces Wrappers. + +:: + + qt_wrap_ui(resultingLibraryName HeadersDestName + SourcesDestName SourceLists ...) + +Produce .h and .cxx files for all the .ui files listed in the +SourceLists. The .h files will be added to the library using the +HeadersDestNamesource list. The .cxx files will be added to the +library using the SourcesDestNamesource list. diff --git a/Help/command/remove.rst b/Help/command/remove.rst new file mode 100644 index 0000000..ddf0e9a --- /dev/null +++ b/Help/command/remove.rst @@ -0,0 +1,12 @@ +remove +------ + +Deprecated. Use the list(REMOVE_ITEM ) command instead. + +:: + + remove(VAR VALUE VALUE ...) + +Removes VALUE from the variable VAR. This is typically used to remove +entries from a vector (e.g. semicolon separated list). VALUE is +expanded. diff --git a/Help/command/remove_definitions.rst b/Help/command/remove_definitions.rst new file mode 100644 index 0000000..566da6e --- /dev/null +++ b/Help/command/remove_definitions.rst @@ -0,0 +1,11 @@ +remove_definitions +------------------ + +Removes -D define flags added by add_definitions. + +:: + + remove_definitions(-DFOO -DBAR ...) + +Removes flags (added by add_definitions) from the compiler command +line for sources in the current directory and below. diff --git a/Help/command/return.rst b/Help/command/return.rst new file mode 100644 index 0000000..899470c --- /dev/null +++ b/Help/command/return.rst @@ -0,0 +1,18 @@ +return +------ + +Return from a file, directory or function. + +:: + + return() + +Returns from a file, directory or function. When this command is +encountered in an included file (via include() or find_package()), it +causes processing of the current file to stop and control is returned +to the including file. If it is encountered in a file which is not +included by another file, e.g. a CMakeLists.txt, control is returned +to the parent directory if there is one. If return is called in a +function, control is returned to the caller of the function. Note +that a macro is not a function and does not handle return like a +function does. diff --git a/Help/command/separate_arguments.rst b/Help/command/separate_arguments.rst new file mode 100644 index 0000000..a876595 --- /dev/null +++ b/Help/command/separate_arguments.rst @@ -0,0 +1,31 @@ +separate_arguments +------------------ + +Parse space-separated arguments into a semicolon-separated list. + +:: + + separate_arguments(<var> <UNIX|WINDOWS>_COMMAND "<args>") + +Parses a unix- or windows-style command-line string "<args>" and +stores a semicolon-separated list of the arguments in <var>. The +entire command line must be given in one "<args>" argument. + +The UNIX_COMMAND mode separates arguments by unquoted whitespace. It +recognizes both single-quote and double-quote pairs. A backslash +escapes the next literal character (\" is "); there are no special +escapes (\n is just n). + +The WINDOWS_COMMAND mode parses a windows command-line using the same +syntax the runtime library uses to construct argv at startup. It +separates arguments by whitespace that is not double-quoted. +Backslashes are literal unless they precede double-quotes. See the +MSDN article "Parsing C Command-Line Arguments" for details. + +:: + + separate_arguments(VARIABLE) + +Convert the value of VARIABLE to a semi-colon separated list. All +spaces are replaced with ';'. This helps with generating command +lines. diff --git a/Help/command/set.rst b/Help/command/set.rst new file mode 100644 index 0000000..7a59550 --- /dev/null +++ b/Help/command/set.rst @@ -0,0 +1,116 @@ +set +--- + +Set a CMake, cache or environment variable to a given value. + +:: + + set(<variable> <value> + [[CACHE <type> <docstring> [FORCE]] | PARENT_SCOPE]) + +Within CMake sets <variable> to the value <value>. <value> is +expanded before <variable> is set to it. Normally, set will set a +regular CMake variable. If CACHE is present, then the <variable> is +put in the cache instead, unless it is already in the cache. See +section 'Variable types in CMake' below for details of regular and +cache variables and their interactions. If CACHE is used, <type> and +<docstring> are required. <type> is used by the CMake GUI to choose a +widget with which the user sets a value. The value for <type> may be +one of + +:: + + FILEPATH = File chooser dialog. + PATH = Directory chooser dialog. + STRING = Arbitrary string. + BOOL = Boolean ON/OFF checkbox. + INTERNAL = No GUI entry (used for persistent variables). + +If <type> is INTERNAL, the cache variable is marked as internal, and +will not be shown to the user in tools like cmake-gui. This is +intended for values that should be persisted in the cache, but which +users should not normally change. INTERNAL implies FORCE. + +Normally, set(...CACHE...) creates cache variables, but does not +modify them. If FORCE is specified, the value of the cache variable +is set, even if the variable is already in the cache. This should +normally be avoided, as it will remove any changes to the cache +variable's value by the user. + +If PARENT_SCOPE is present, the variable will be set in the scope +above the current scope. Each new directory or function creates a new +scope. This command will set the value of a variable into the parent +directory or calling function (whichever is applicable to the case at +hand). PARENT_SCOPE cannot be combined with CACHE. + +If <value> is not specified then the variable is removed instead of +set. See also: the unset() command. + +:: + + set(<variable> <value1> ... <valueN>) + +In this case <variable> is set to a semicolon separated list of +values. + +<variable> can be an environment variable such as: + +:: + + set( ENV{PATH} /home/martink ) + +in which case the environment variable will be set. + +*** Variable types in CMake *** + +In CMake there are two types of variables: normal variables and cache +variables. Normal variables are meant for the internal use of the +script (just like variables in most programming languages); they are +not persisted across CMake runs. Cache variables (unless set with +INTERNAL) are mostly intended for configuration settings where the +first CMake run determines a suitable default value, which the user +can then override, by editing the cache with tools such as ccmake or +cmake-gui. Cache variables are stored in the CMake cache file, and +are persisted across CMake runs. + +Both types can exist at the same time with the same name but different +values. When ${FOO} is evaluated, CMake first looks for a normal +variable 'FOO' in scope and uses it if set. If and only if no normal +variable exists then it falls back to the cache variable 'FOO'. + +Some examples: + +The code 'set(FOO "x")' sets the normal variable 'FOO'. It does not +touch the cache, but it will hide any existing cache value 'FOO'. + +The code 'set(FOO "x" CACHE ...)' checks for 'FOO' in the cache, +ignoring any normal variable of the same name. If 'FOO' is in the +cache then nothing happens to either the normal variable or the cache +variable. If 'FOO' is not in the cache, then it is added to the +cache. + +Finally, whenever a cache variable is added or modified by a command, +CMake also *removes* the normal variable of the same name from the +current scope so that an immediately following evaluation of it will +expose the newly cached value. + +Normally projects should avoid using normal and cache variables of the +same name, as this interaction can be hard to follow. However, in +some situations it can be useful. One example (used by some +projects): + +A project has a subproject in its source tree. The child project has +its own CMakeLists.txt, which is included from the parent +CMakeLists.txt using add_subdirectory(). Now, if the parent and the +child project provide the same option (for example a compiler option), +the parent gets the first chance to add a user-editable option to the +cache. Normally, the child would then use the same value that the +parent uses. However, it may be necessary to hard-code the value for +the child project's option while still allowing the user to edit the +value used by the parent project. The parent project can achieve this +simply by setting a normal variable with the same name as the option +in a scope sufficient to hide the option's cache variable from the +child completely. The parent has already set the cache variable, so +the child's set(...CACHE...) will do nothing, and evaluating the +option variable will use the value from the normal variable, which +hides the cache variable. diff --git a/Help/command/set_directory_properties.rst b/Help/command/set_directory_properties.rst new file mode 100644 index 0000000..834013a --- /dev/null +++ b/Help/command/set_directory_properties.rst @@ -0,0 +1,15 @@ +set_directory_properties +------------------------ + +Set a property of the directory. + +:: + + set_directory_properties(PROPERTIES prop1 value1 prop2 value2) + +Set a property for the current directory and subdirectories. If the +property is not found, CMake will report an error. The properties +include: INCLUDE_DIRECTORIES, LINK_DIRECTORIES, +INCLUDE_REGULAR_EXPRESSION, and ADDITIONAL_MAKE_CLEAN_FILES. +ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned as +a part of "make clean" stage. diff --git a/Help/command/set_property.rst b/Help/command/set_property.rst new file mode 100644 index 0000000..8cb963e --- /dev/null +++ b/Help/command/set_property.rst @@ -0,0 +1,43 @@ +set_property +------------ + +Set a named property in a given scope. + +:: + + set_property(<GLOBAL | + DIRECTORY [dir] | + TARGET [target1 [target2 ...]] | + SOURCE [src1 [src2 ...]] | + TEST [test1 [test2 ...]] | + CACHE [entry1 [entry2 ...]]> + [APPEND] [APPEND_STRING] + PROPERTY <name> [value1 [value2 ...]]) + +Set one property on zero or more objects of a scope. The first +argument determines the scope in which the property is set. It must +be one of the following: + +GLOBAL scope is unique and does not accept a name. + +DIRECTORY scope defaults to the current directory but another +directory (already processed by CMake) may be named by full or +relative path. + +TARGET scope may name zero or more existing targets. + +SOURCE scope may name zero or more source files. Note that source +file properties are visible only to targets added in the same +directory (CMakeLists.txt). + +TEST scope may name zero or more existing tests. + +CACHE scope must name zero or more cache existing entries. + +The required PROPERTY option is immediately followed by the name of +the property to set. Remaining arguments are used to compose the +property value in the form of a semicolon-separated list. If the +APPEND option is given the list is appended to any existing property +value.If the APPEND_STRING option is given the string is append to any +existing property value as string, i.e. it results in a longer string +and not a list of strings. diff --git a/Help/command/set_source_files_properties.rst b/Help/command/set_source_files_properties.rst new file mode 100644 index 0000000..8ea02a3 --- /dev/null +++ b/Help/command/set_source_files_properties.rst @@ -0,0 +1,15 @@ +set_source_files_properties +--------------------------- + +Source files can have properties that affect how they are built. + +:: + + set_source_files_properties([file1 [file2 [...]]] + PROPERTIES prop1 value1 + [prop2 value2 [...]]) + +Set properties associated with source files using a key/value paired +list. See properties documentation for those known to CMake. +Unrecognized properties are ignored. Source file properties are +visible only to targets added in the same directory (CMakeLists.txt). diff --git a/Help/command/set_target_properties.rst b/Help/command/set_target_properties.rst new file mode 100644 index 0000000..f65ee24 --- /dev/null +++ b/Help/command/set_target_properties.rst @@ -0,0 +1,104 @@ +set_target_properties +--------------------- + +Targets can have properties that affect how they are built. + +:: + + set_target_properties(target1 target2 ... + PROPERTIES prop1 value1 + prop2 value2 ...) + +Set properties on a target. The syntax for the command is to list all +the files you want to change, and then provide the values you want to +set next. You can use any prop value pair you want and extract it +later with the GET_TARGET_PROPERTY command. + +Properties that affect the name of a target's output file are as +follows. The PREFIX and SUFFIX properties override the default target +name prefix (such as "lib") and suffix (such as ".so"). IMPORT_PREFIX +and IMPORT_SUFFIX are the equivalent properties for the import library +corresponding to a DLL (for SHARED library targets). OUTPUT_NAME sets +the real name of a target when it is built and can be used to help +create two targets of the same name even though CMake requires unique +logical target names. There is also a <CONFIG>_OUTPUT_NAME that can +set the output name on a per-configuration basis. <CONFIG>_POSTFIX +sets a postfix for the real name of the target when it is built under +the configuration named by <CONFIG> (in upper-case, such as +"DEBUG_POSTFIX"). The value of this property is initialized when the +target is created to the value of the variable CMAKE_<CONFIG>_POSTFIX +(except for executable targets because earlier CMake versions which +did not use this variable for executables). + +The LINK_FLAGS property can be used to add extra flags to the link +step of a target. LINK_FLAGS_<CONFIG> will add to the configuration +<CONFIG>, for example, DEBUG, RELEASE, MINSIZEREL, RELWITHDEBINFO. +DEFINE_SYMBOL sets the name of the preprocessor symbol defined when +compiling sources in a shared library. If not set here then it is set +to target_EXPORTS by default (with some substitutions if the target is +not a valid C identifier). This is useful for headers to know whether +they are being included from inside their library or outside to +properly setup dllexport/dllimport decorations. The COMPILE_FLAGS +property sets additional compiler flags used to build sources within +the target. It may also be used to pass additional preprocessor +definitions. + +The LINKER_LANGUAGE property is used to change the tool used to link +an executable or shared library. The default is set the language to +match the files in the library. CXX and C are common values for this +property. + +For shared libraries VERSION and SOVERSION can be used to specify the +build version and API version respectively. When building or +installing appropriate symlinks are created if the platform supports +symlinks and the linker supports so-names. If only one of both is +specified the missing is assumed to have the same version number. For +executables VERSION can be used to specify the build version. When +building or installing appropriate symlinks are created if the +platform supports symlinks. For shared libraries and executables on +Windows the VERSION attribute is parsed to extract a "major.minor" +version number. These numbers are used as the image version of the +binary. + +There are a few properties used to specify RPATH rules. INSTALL_RPATH +is a semicolon-separated list specifying the rpath to use in installed +targets (for platforms that support it). INSTALL_RPATH_USE_LINK_PATH +is a boolean that if set to true will append directories in the linker +search path and outside the project to the INSTALL_RPATH. +SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic +generation of an rpath allowing the target to run from the build tree. +BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link the +target in the build tree with the INSTALL_RPATH. This takes +precedence over SKIP_BUILD_RPATH and avoids the need for relinking +before installation. INSTALL_NAME_DIR is a string specifying the +directory portion of the "install_name" field of shared libraries on +Mac OSX to use in the installed targets. When the target is created +the values of the variables CMAKE_INSTALL_RPATH, +CMAKE_INSTALL_RPATH_USE_LINK_PATH, CMAKE_SKIP_BUILD_RPATH, +CMAKE_BUILD_WITH_INSTALL_RPATH, and CMAKE_INSTALL_NAME_DIR are used to +initialize these properties. + +PROJECT_LABEL can be used to change the name of the target in an IDE +like visual studio. VS_KEYWORD can be set to change the visual studio +keyword, for example Qt integration works better if this is set to +Qt4VSv1.0. + +VS_SCC_PROJECTNAME, VS_SCC_LOCALPATH, VS_SCC_PROVIDER and +VS_SCC_AUXPATH can be set to add support for source control bindings +in a Visual Studio project file. + +VS_GLOBAL_<variable> can be set to add a Visual Studio +project-specific global variable. Qt integration works better if +VS_GLOBAL_QtVersion is set to the Qt version FindQt4.cmake found. For +example, "4.7.3" + +The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the old +way to specify CMake scripts to run before and after installing a +target. They are used only when the old INSTALL_TARGETS command is +used to install the target. Use the INSTALL command instead. + +The EXCLUDE_FROM_DEFAULT_BUILD property is used by the visual studio +generators. If it is set to 1 the target will not be part of the +default build when you select "Build Solution". This can also be set +on a per-configuration basis using +EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG>. diff --git a/Help/command/set_tests_properties.rst b/Help/command/set_tests_properties.rst new file mode 100644 index 0000000..82cd5d8 --- /dev/null +++ b/Help/command/set_tests_properties.rst @@ -0,0 +1,36 @@ +set_tests_properties +-------------------- + +Set a property of the tests. + +:: + + set_tests_properties(test1 [test2...] PROPERTIES prop1 value1 prop2 value2) + +Set a property for the tests. If the property is not found, CMake +will report an error. Generator expressions will be expanded the same +as supported by the test's add_test call. The properties include: + +WILL_FAIL: If set to true, this will invert the pass/fail flag of the +test. + +PASS_REGULAR_EXPRESSION: If set, the test output will be checked +against the specified regular expressions and at least one of the +regular expressions has to match, otherwise the test will fail. + +:: + + Example: PASS_REGULAR_EXPRESSION "TestPassed;All ok" + +FAIL_REGULAR_EXPRESSION: If set, if the output will match to one of +specified regular expressions, the test will fail. + +:: + + Example: PASS_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed" + +Both PASS_REGULAR_EXPRESSION and FAIL_REGULAR_EXPRESSION expect a list +of regular expressions. + +TIMEOUT: Setting this will limit the test runtime to the number of +seconds specified. diff --git a/Help/command/site_name.rst b/Help/command/site_name.rst new file mode 100644 index 0000000..e17c1ee --- /dev/null +++ b/Help/command/site_name.rst @@ -0,0 +1,8 @@ +site_name +--------- + +Set the given variable to the name of the computer. + +:: + + site_name(variable) diff --git a/Help/command/source_group.rst b/Help/command/source_group.rst new file mode 100644 index 0000000..77bb9ad --- /dev/null +++ b/Help/command/source_group.rst @@ -0,0 +1,28 @@ +source_group +------------ + +Define a grouping for sources in the makefile. + +:: + + source_group(name [REGULAR_EXPRESSION regex] [FILES src1 src2 ...]) + +Defines a group into which sources will be placed in project files. +This is mainly used to setup file tabs in Visual Studio. Any file +whose name is listed or matches the regular expression will be placed +in this group. If a file matches multiple groups, the LAST group that +explicitly lists the file will be favored, if any. If no group +explicitly lists the file, the LAST group whose regular expression +matches the file will be favored. + +The name of the group may contain backslashes to specify subgroups: + +:: + + source_group(outer\\inner ...) + +For backwards compatibility, this command also supports the format: + +:: + + source_group(name regex) diff --git a/Help/command/string.rst b/Help/command/string.rst new file mode 100644 index 0000000..c191c63 --- /dev/null +++ b/Help/command/string.rst @@ -0,0 +1,152 @@ +string +------ + +String operations. + +:: + + string(REGEX MATCH <regular_expression> + <output variable> <input> [<input>...]) + string(REGEX MATCHALL <regular_expression> + <output variable> <input> [<input>...]) + string(REGEX REPLACE <regular_expression> + <replace_expression> <output variable> + <input> [<input>...]) + string(REPLACE <match_string> + <replace_string> <output variable> + <input> [<input>...]) + string(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512> + <output variable> <input>) + string(COMPARE EQUAL <string1> <string2> <output variable>) + string(COMPARE NOTEQUAL <string1> <string2> <output variable>) + string(COMPARE LESS <string1> <string2> <output variable>) + string(COMPARE GREATER <string1> <string2> <output variable>) + string(ASCII <number> [<number> ...] <output variable>) + string(CONFIGURE <string1> <output variable> + [@ONLY] [ESCAPE_QUOTES]) + string(TOUPPER <string1> <output variable>) + string(TOLOWER <string1> <output variable>) + string(LENGTH <string> <output variable>) + string(SUBSTRING <string> <begin> <length> <output variable>) + string(STRIP <string> <output variable>) + string(RANDOM [LENGTH <length>] [ALPHABET <alphabet>] + [RANDOM_SEED <seed>] <output variable>) + string(FIND <string> <substring> <output variable> [REVERSE]) + string(TIMESTAMP <output variable> [<format string>] [UTC]) + string(MAKE_C_IDENTIFIER <input string> <output variable>) + +REGEX MATCH will match the regular expression once and store the match +in the output variable. + +REGEX MATCHALL will match the regular expression as many times as +possible and store the matches in the output variable as a list. + +REGEX REPLACE will match the regular expression as many times as +possible and substitute the replacement expression for the match in +the output. The replace expression may refer to paren-delimited +subexpressions of the match using \1, \2, ..., \9. Note that two +backslashes (\\1) are required in CMake code to get a backslash +through argument parsing. + +REPLACE will replace all occurrences of match_string in the input with +replace_string and store the result in the output. + +MD5, SHA1, SHA224, SHA256, SHA384, and SHA512 will compute a +cryptographic hash of the input string. + +COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and store +true or false in the output variable. + +ASCII will convert all numbers into corresponding ASCII characters. + +CONFIGURE will transform a string like CONFIGURE_FILE transforms a +file. + +TOUPPER/TOLOWER will convert string to upper/lower characters. + +LENGTH will return a given string's length. + +SUBSTRING will return a substring of a given string. If length is -1 +the remainder of the string starting at begin will be returned. + +STRIP will return a substring of a given string with leading and +trailing spaces removed. + +RANDOM will return a random string of given length consisting of +characters from the given alphabet. Default length is 5 characters +and default alphabet is all numbers and upper and lower case letters. +If an integer RANDOM_SEED is given, its value will be used to seed the +random number generator. + +FIND will return the position where the given substring was found in +the supplied string. If the REVERSE flag was used, the command will +search for the position of the last occurrence of the specified +substring. + +The following characters have special meaning in regular expressions: + +:: + + ^ Matches at beginning of input + $ Matches at end of input + . Matches any single character + [ ] Matches any character(s) inside the brackets + [^ ] Matches any character(s) not inside the brackets + - Inside brackets, specifies an inclusive range between + characters on either side e.g. [a-f] is [abcdef] + To match a literal - using brackets, make it the first + or the last character e.g. [+*/-] matches basic + mathematical operators. + * Matches preceding pattern zero or more times + + Matches preceding pattern one or more times + ? Matches preceding pattern zero or once only + | Matches a pattern on either side of the | + () Saves a matched subexpression, which can be referenced + in the REGEX REPLACE operation. Additionally it is saved + by all regular expression-related commands, including + e.g. if( MATCHES ), in the variables CMAKE_MATCH_(0..9). + +*, + and ? have higher precedence than concatenation. | has lower +precedence than concatenation. This means that the regular expression +"^ab+d$" matches "abbd" but not "ababd", and the regular expression +"^(ab|cd)$" matches "ab" but not "abd". + +TIMESTAMP will write a string representation of the current date +and/or time to the output variable. + +Should the command be unable to obtain a timestamp the output variable +will be set to the empty string "". + +The optional UTC flag requests the current date/time representation to +be in Coordinated Universal Time (UTC) rather than local time. + +The optional <format string> may contain the following format +specifiers: + +:: + + %d The day of the current month (01-31). + %H The hour on a 24-hour clock (00-23). + %I The hour on a 12-hour clock (01-12). + %j The day of the current year (001-366). + %m The month of the current year (01-12). + %M The minute of the current hour (00-59). + %S The second of the current minute. + 60 represents a leap second. (00-60) + %U The week number of the current year (00-53). + %w The day of the current week. 0 is Sunday. (0-6) + %y The last two digits of the current year (00-99) + %Y The current year. + +Unknown format specifiers will be ignored and copied to the output +as-is. + +If no explicit <format string> is given it will default to: + +:: + + %Y-%m-%dT%H:%M:%S for local time. + %Y-%m-%dT%H:%M:%SZ for UTC. + +MAKE_C_IDENTIFIER will write a string which can be used as an +identifier in C. diff --git a/Help/command/subdir_depends.rst b/Help/command/subdir_depends.rst new file mode 100644 index 0000000..c72a4af --- /dev/null +++ b/Help/command/subdir_depends.rst @@ -0,0 +1,11 @@ +subdir_depends +-------------- + +Deprecated. Does nothing. + +:: + + subdir_depends(subdir dep1 dep2 ...) + +Does not do anything. This command used to help projects order +parallel builds correctly. This functionality is now automatic. diff --git a/Help/command/subdirs.rst b/Help/command/subdirs.rst new file mode 100644 index 0000000..dee49f8 --- /dev/null +++ b/Help/command/subdirs.rst @@ -0,0 +1,24 @@ +subdirs +------- + +Deprecated. Use the add_subdirectory() command instead. + +Add a list of subdirectories to the build. + +:: + + subdirs(dir1 dir2 ...[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...] + [PREORDER] ) + +Add a list of subdirectories to the build. The add_subdirectory +command should be used instead of subdirs although subdirs will still +work. This will cause any CMakeLists.txt files in the sub directories +to be processed by CMake. Any directories after the PREORDER flag are +traversed first by makefile builds, the PREORDER flag has no effect on +IDE projects. Any directories after the EXCLUDE_FROM_ALL marker will +not be included in the top level makefile or project file. This is +useful for having CMake create makefiles or projects for a set of +examples in a project. You would want CMake to generate makefiles or +project files for all the examples at the same time, but you would not +want them to show up in the top level project or be built each time +make is run from the top. diff --git a/Help/command/target_compile_definitions.rst b/Help/command/target_compile_definitions.rst new file mode 100644 index 0000000..0746d2a --- /dev/null +++ b/Help/command/target_compile_definitions.rst @@ -0,0 +1,96 @@ +target_compile_definitions +-------------------------- + +Add compile definitions to a target. + +:: + + target_compile_definitions(<target> <INTERFACE|PUBLIC|PRIVATE> [items1...] + [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]) + +Specify compile definitions to use when compiling a given target. The +named <target> must have been created by a command such as +add_executable or add_library and must not be an IMPORTED target. The +INTERFACE, PUBLIC and PRIVATE keywords are required to specify the +scope of the following arguments. PRIVATE and PUBLIC items will +populate the COMPILE_DEFINITIONS property of <target>. PUBLIC and +INTERFACE items will populate the INTERFACE_COMPILE_DEFINITIONS +property of <target>. The following arguments specify compile +definitions. Repeated calls for the same <target> append items in the +order called. + +Arguments to target_compile_definitions may use "generator +expressions" with the syntax "$<...>". Generator expressions are +evaluated during build system generation to produce information +specific to each build configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/command/target_compile_options.rst b/Help/command/target_compile_options.rst new file mode 100644 index 0000000..e086d5a --- /dev/null +++ b/Help/command/target_compile_options.rst @@ -0,0 +1,98 @@ +target_compile_options +---------------------- + +Add compile options to a target. + +:: + + target_compile_options(<target> [BEFORE] <INTERFACE|PUBLIC|PRIVATE> [items1...] + [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]) + +Specify compile options to use when compiling a given target. The +named <target> must have been created by a command such as +add_executable or add_library and must not be an IMPORTED target. If +BEFORE is specified, the content will be prepended to the property +instead of being appended. + +The INTERFACE, PUBLIC and PRIVATE keywords are required to specify the +scope of the following arguments. PRIVATE and PUBLIC items will +populate the COMPILE_OPTIONS property of <target>. PUBLIC and +INTERFACE items will populate the INTERFACE_COMPILE_OPTIONS property +of <target>. The following arguments specify compile opitions. +Repeated calls for the same <target> append items in the order called. + +Arguments to target_compile_options may use "generator expressions" +with the syntax "$<...>". Generator expressions are evaluated during +build system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/command/target_include_directories.rst b/Help/command/target_include_directories.rst new file mode 100644 index 0000000..63306cd --- /dev/null +++ b/Help/command/target_include_directories.rst @@ -0,0 +1,108 @@ +target_include_directories +-------------------------- + +Add include directories to a target. + +:: + + target_include_directories(<target> [SYSTEM] [BEFORE] <INTERFACE|PUBLIC|PRIVATE> [items1...] + [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]) + +Specify include directories or targets to use when compiling a given +target. The named <target> must have been created by a command such +as add_executable or add_library and must not be an IMPORTED target. + +If BEFORE is specified, the content will be prepended to the property +instead of being appended. + +The INTERFACE, PUBLIC and PRIVATE keywords are required to specify the +scope of the following arguments. PRIVATE and PUBLIC items will +populate the INCLUDE_DIRECTORIES property of <target>. PUBLIC and +INTERFACE items will populate the INTERFACE_INCLUDE_DIRECTORIES +property of <target>. The following arguments specify include +directories. Specified include directories may be absolute paths or +relative paths. Repeated calls for the same <target> append items in +the order called.If SYSTEM is specified, the compiler will be told the +directories are meant as system include directories on some platforms +(signalling this setting might achieve effects such as the compiler +skipping warnings, or these fixed-install system files not being +considered in dependency calculations - see compiler docs). If SYSTEM +is used together with PUBLIC or INTERFACE, the +INTERFACE_SYSTEM_INCLUDE_DIRECTORIES target property will be populated +with the specified directories. + +Arguments to target_include_directories may use "generator +expressions" with the syntax "$<...>". Generator expressions are +evaluated during build system generation to produce information +specific to each build configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/command/target_link_libraries.rst b/Help/command/target_link_libraries.rst new file mode 100644 index 0000000..049d465 --- /dev/null +++ b/Help/command/target_link_libraries.rst @@ -0,0 +1,215 @@ +target_link_libraries +--------------------- + +Link a target to given libraries. + +:: + + target_link_libraries(<target> [item1 [item2 [...]]] + [[debug|optimized|general] <item>] ...) + +Specify libraries or flags to use when linking a given target. The +named <target> must have been created in the current directory by a +command such as add_executable or add_library. The remaining +arguments specify library names or flags. Repeated calls for the same +<target> append items in the order called. + +If a library name matches that of another target in the project a +dependency will automatically be added in the build system to make +sure the library being linked is up-to-date before the target links. +Item names starting with '-', but not '-l' or '-framework', are +treated as linker flags. + +A "debug", "optimized", or "general" keyword indicates that the +library immediately following it is to be used only for the +corresponding build configuration. The "debug" keyword corresponds to +the Debug configuration (or to configurations named in the +DEBUG_CONFIGURATIONS global property if it is set). The "optimized" +keyword corresponds to all other configurations. The "general" +keyword corresponds to all configurations, and is purely optional +(assumed if omitted). Higher granularity may be achieved for +per-configuration rules by creating and linking to IMPORTED library +targets. See the IMPORTED mode of the add_library command for more +information. + +Library dependencies are transitive by default. When this target is +linked into another target then the libraries linked to this target +will appear on the link line for the other target too. See the +INTERFACE_LINK_LIBRARIES target property to override the set of +transitive link dependencies for a target. Calls to other signatures +of this command may set the property making any libraries linked +exclusively by this signature private. + +CMake will also propagate "usage requirements" from linked library +targets. Usage requirements affect compilation of sources in the +<target>. They are specified by properties defined on linked targets. +During generation of the build system, CMake integrates usage +requirement property values with the corresponding build properties +for <target>: + +:: + + INTERFACE_COMPILE_DEFINITONS: Appends to COMPILE_DEFINITONS + INTERFACE_INCLUDE_DIRECTORIES: Appends to INCLUDE_DIRECTORIES + INTERFACE_POSITION_INDEPENDENT_CODE: Sets POSITION_INDEPENDENT_CODE + or checked for consistency with existing value + + + +If an <item> is a library in a Mac OX framework, the Headers directory +of the framework will also be processed as a "usage requirement". +This has the same effect as passing the framework directory as an +include directory. target_link_libraries(<target> + +:: + + <PRIVATE|PUBLIC|INTERFACE> <lib> ... + [<PRIVATE|PUBLIC|INTERFACE> <lib> ... ] ...]) + +The PUBLIC, PRIVATE and INTERFACE keywords can be used to specify both +the link dependencies and the link interface in one command. +Libraries and targets following PUBLIC are linked to, and are made +part of the link interface. Libraries and targets following PRIVATE +are linked to, but are not made part of the link interface. Libraries +following INTERFACE are appended to the link interface and are not +used for linking <target>. + +:: + + target_link_libraries(<target> LINK_INTERFACE_LIBRARIES + [[debug|optimized|general] <lib>] ...) + +The LINK_INTERFACE_LIBRARIES mode appends the libraries to the +INTERFACE_LINK_LIBRARIES target property instead of using them for +linking. If policy CMP0022 is not NEW, then this mode also appends +libraries to the LINK_INTERFACE_LIBRARIES and its per-configuration +equivalent. This signature is for compatibility only. Prefer the +INTERFACE mode instead. Libraries specified as "debug" are wrapped in +a generator expression to correspond to debug builds. If policy +CMP0022 is not NEW, the libraries are also appended to the +LINK_INTERFACE_LIBRARIES_DEBUG property (or to the properties +corresponding to configurations listed in the DEBUG_CONFIGURATIONS +global property if it is set). Libraries specified as "optimized" are +appended to the INTERFACE_LINK_LIBRARIES property. If policy CMP0022 +is not NEW, they are also appended to the LINK_INTERFACE_LIBRARIES +property. Libraries specified as "general" (or without any keyword) +are treated as if specified for both "debug" and "optimized". + +:: + + target_link_libraries(<target> + <LINK_PRIVATE|LINK_PUBLIC> + [[debug|optimized|general] <lib>] ... + [<LINK_PRIVATE|LINK_PUBLIC> + [[debug|optimized|general] <lib>] ...]) + +The LINK_PUBLIC and LINK_PRIVATE modes can be used to specify both the +link dependencies and the link interface in one command. This +signature is for compatibility only. Prefer the PUBLIC or PRIVATE +keywords instead. Libraries and targets following LINK_PUBLIC are +linked to, and are made part of the INTERFACE_LINK_LIBRARIES. If +policy CMP0022 is not NEW, they are also made part of the +LINK_INTERFACE_LIBRARIES. Libraries and targets following +LINK_PRIVATE are linked to, but are not made part of the +INTERFACE_LINK_LIBRARIES (or LINK_INTERFACE_LIBRARIES). + +The library dependency graph is normally acyclic (a DAG), but in the +case of mutually-dependent STATIC libraries CMake allows the graph to +contain cycles (strongly connected components). When another target +links to one of the libraries CMake repeats the entire connected +component. For example, the code + +:: + + add_library(A STATIC a.c) + add_library(B STATIC b.c) + target_link_libraries(A B) + target_link_libraries(B A) + add_executable(main main.c) + target_link_libraries(main A) + +links 'main' to 'A B A B'. (While one repetition is usually +sufficient, pathological object file and symbol arrangements can +require more. One may handle such cases by manually repeating the +component in the last target_link_libraries call. However, if two +archives are really so interdependent they should probably be combined +into a single archive.) + +Arguments to target_link_libraries may use "generator expressions" +with the syntax "$<...>". Note however, that generator expressions +will not be used in OLD handling of CMP0003 or CMP0004. + +Generator expressions are evaluated during build system generation to +produce information specific to each build configuration. Valid +expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/command/try_compile.rst b/Help/command/try_compile.rst new file mode 100644 index 0000000..8ed3cf4 --- /dev/null +++ b/Help/command/try_compile.rst @@ -0,0 +1,71 @@ +try_compile +----------- + +Try building some code. + +:: + + try_compile(RESULT_VAR <bindir> <srcdir> + <projectName> [targetName] [CMAKE_FLAGS flags...] + [OUTPUT_VARIABLE <var>]) + +Try building a project. In this form, srcdir should contain a +complete CMake project with a CMakeLists.txt file and all sources. +The bindir and srcdir will not be deleted after this command is run. +Specify targetName to build a specific target instead of the 'all' or +'ALL_BUILD' target. + +:: + + try_compile(RESULT_VAR <bindir> <srcfile|SOURCES srcfile...> + [CMAKE_FLAGS flags...] + [COMPILE_DEFINITIONS flags...] + [LINK_LIBRARIES libs...] + [OUTPUT_VARIABLE <var>] + [COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]) + +Try building an executable from one or more source files. In this +form the user need only supply one or more source files that include a +definition for 'main'. CMake will create a CMakeLists.txt file to +build the source(s) as an executable. Specify COPY_FILE to get a copy +of the linked executable at the given fileName and optionally +COPY_FILE_ERROR to capture any error. + +In this version all files in bindir/CMakeFiles/CMakeTmp will be +cleaned automatically. For debugging, --debug-trycompile can be +passed to cmake to avoid this clean. However, multiple sequential +try_compile operations reuse this single output directory. If you use +--debug-trycompile, you can only debug one try_compile call at a time. +The recommended procedure is to configure with cmake all the way +through once, then delete the cache entry associated with the +try_compile call of interest, and then re-run cmake again with +--debug-trycompile. + +Some extra flags that can be included are, INCLUDE_DIRECTORIES, +LINK_DIRECTORIES, and LINK_LIBRARIES. COMPILE_DEFINITIONS are +-Ddefinition that will be passed to the compile line. + +The srcfile signature also accepts a LINK_LIBRARIES argument which may +contain a list of libraries or IMPORTED targets which will be linked +to in the generated project. If LINK_LIBRARIES is specified as a +parameter to try_compile, then any LINK_LIBRARIES passed as +CMAKE_FLAGS will be ignored. + +try_compile creates a CMakeList.txt file on the fly that looks like +this: + +:: + + add_definitions( <expanded COMPILE_DEFINITIONS from calling cmake>) + include_directories(${INCLUDE_DIRECTORIES}) + link_directories(${LINK_DIRECTORIES}) + add_executable(cmTryCompileExec sources) + target_link_libraries(cmTryCompileExec ${LINK_LIBRARIES}) + +In both versions of the command, if OUTPUT_VARIABLE is specified, then +the output from the build process is stored in the given variable. +The success or failure of the try_compile, i.e. TRUE or FALSE +respectively, is returned in RESULT_VAR. CMAKE_FLAGS can be used to +pass -DVAR:TYPE=VALUE flags to the cmake that is run during the build. +Set variable CMAKE_TRY_COMPILE_CONFIGURATION to choose a build +configuration. diff --git a/Help/command/try_run.rst b/Help/command/try_run.rst new file mode 100644 index 0000000..9a17ad9 --- /dev/null +++ b/Help/command/try_run.rst @@ -0,0 +1,52 @@ +try_run +------- + +Try compiling and then running some code. + +:: + + try_run(RUN_RESULT_VAR COMPILE_RESULT_VAR + bindir srcfile [CMAKE_FLAGS <Flags>] + [COMPILE_DEFINITIONS <flags>] + [COMPILE_OUTPUT_VARIABLE comp] + [RUN_OUTPUT_VARIABLE run] + [OUTPUT_VARIABLE var] + [ARGS <arg1> <arg2>...]) + +Try compiling a srcfile. Return TRUE or FALSE for success or failure +in COMPILE_RESULT_VAR. Then if the compile succeeded, run the +executable and return its exit code in RUN_RESULT_VAR. If the +executable was built, but failed to run, then RUN_RESULT_VAR will be +set to FAILED_TO_RUN. COMPILE_OUTPUT_VARIABLE specifies the variable +where the output from the compile step goes. RUN_OUTPUT_VARIABLE +specifies the variable where the output from the running executable +goes. + +For compatibility reasons OUTPUT_VARIABLE is still supported, which +gives you the output from the compile and run step combined. + +Cross compiling issues + +When cross compiling, the executable compiled in the first step +usually cannot be run on the build host. try_run() checks the +CMAKE_CROSSCOMPILING variable to detect whether CMake is in +crosscompiling mode. If that's the case, it will still try to compile +the executable, but it will not try to run the executable. Instead it +will create cache variables which must be filled by the user or by +presetting them in some CMake script file to the values the executable +would have produced if it had been run on its actual target platform. +These variables are RUN_RESULT_VAR (explanation see above) and if +RUN_OUTPUT_VARIABLE (or OUTPUT_VARIABLE) was used, an additional cache +variable RUN_RESULT_VAR__COMPILE_RESULT_VAR__TRYRUN_OUTPUT.This is +intended to hold stdout and stderr from the executable. + +In order to make cross compiling your project easier, use try_run only +if really required. If you use try_run, use RUN_OUTPUT_VARIABLE (or +OUTPUT_VARIABLE) only if really required. Using them will require +that when crosscompiling, the cache variables will have to be set +manually to the output of the executable. You can also "guard" the +calls to try_run with if(CMAKE_CROSSCOMPILING) and provide an +easy-to-preset alternative for this case. + +Set variable CMAKE_TRY_COMPILE_CONFIGURATION to choose a build +configuration. diff --git a/Help/command/unset.rst b/Help/command/unset.rst new file mode 100644 index 0000000..d8f0dcd --- /dev/null +++ b/Help/command/unset.rst @@ -0,0 +1,25 @@ +unset +----- + +Unset a variable, cache variable, or environment variable. + +:: + + unset(<variable> [CACHE | PARENT_SCOPE]) + +Removes the specified variable causing it to become undefined. If +CACHE is present then the variable is removed from the cache instead +of the current scope. + +If PARENT_SCOPE is present then the variable is removed from the scope +above the current scope. See the same option in the set() command for +further details. + +<variable> can be an environment variable such as: + +:: + + unset(ENV{LD_LIBRARY_PATH}) + +in which case the variable will be removed from the current +environment. diff --git a/Help/command/use_mangled_mesa.rst b/Help/command/use_mangled_mesa.rst new file mode 100644 index 0000000..a4d77e9 --- /dev/null +++ b/Help/command/use_mangled_mesa.rst @@ -0,0 +1,13 @@ +use_mangled_mesa +---------------- + +Copy mesa headers for use in combination with system GL. + +:: + + use_mangled_mesa(PATH_TO_MESA OUTPUT_DIRECTORY) + +The path to mesa includes, should contain gl_mangle.h. The mesa +headers are copied to the specified output directory. This allows +mangled mesa headers to override other GL headers by being added to +the include directory path earlier. diff --git a/Help/command/utility_source.rst b/Help/command/utility_source.rst new file mode 100644 index 0000000..e513627 --- /dev/null +++ b/Help/command/utility_source.rst @@ -0,0 +1,22 @@ +utility_source +-------------- + +Specify the source tree of a third-party utility. + +:: + + utility_source(cache_entry executable_name + path_to_source [file1 file2 ...]) + +When a third-party utility's source is included in the distribution, +this command specifies its location and name. The cache entry will +not be set unless the path_to_source and all listed files exist. It +is assumed that the source tree of the utility will have been built +before it is needed. + +When cross compiling CMake will print a warning if a utility_source() +command is executed, because in many cases it is used to build an +executable which is executed later on. This doesn't work when cross +compiling, since the executable can run only on their target platform. +So in this case the cache entry has to be adjusted manually so it +points to an executable which is runnable on the build host. diff --git a/Help/command/variable_requires.rst b/Help/command/variable_requires.rst new file mode 100644 index 0000000..7535e40 --- /dev/null +++ b/Help/command/variable_requires.rst @@ -0,0 +1,20 @@ +variable_requires +----------------- + +Deprecated. Use the if() command instead. + +Assert satisfaction of an option's required variables. + +:: + + variable_requires(TEST_VARIABLE RESULT_VARIABLE + REQUIRED_VARIABLE1 + REQUIRED_VARIABLE2 ...) + +The first argument (TEST_VARIABLE) is the name of the variable to be +tested, if that variable is false nothing else is done. If +TEST_VARIABLE is true, then the next argument (RESULT_VARIABLE) is a +variable that is set to true if all the required variables are set. +The rest of the arguments are variables that must be true or not set +to NOTFOUND to avoid an error. If any are not true, an error is +reported. diff --git a/Help/command/variable_watch.rst b/Help/command/variable_watch.rst new file mode 100644 index 0000000..a2df058 --- /dev/null +++ b/Help/command/variable_watch.rst @@ -0,0 +1,13 @@ +variable_watch +-------------- + +Watch the CMake variable for change. + +:: + + variable_watch(<variable name> [<command to execute>]) + +If the specified variable changes, the message will be printed about +the variable being changed. If the command is specified, the command +will be executed. The command will receive the following arguments: +COMMAND(<variable> <access> <value> <current list file> <stack>) diff --git a/Help/command/while.rst b/Help/command/while.rst new file mode 100644 index 0000000..72c055d --- /dev/null +++ b/Help/command/while.rst @@ -0,0 +1,17 @@ +while +----- + +Evaluate a group of commands while a condition is true + +:: + + while(condition) + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + endwhile(condition) + +All commands between while and the matching endwhile are recorded +without being invoked. Once the endwhile is evaluated, the recorded +list of commands is invoked as long as the condition is true. The +condition is evaluated using the same logic as the if command. diff --git a/Help/command/write_file.rst b/Help/command/write_file.rst new file mode 100644 index 0000000..015514b --- /dev/null +++ b/Help/command/write_file.rst @@ -0,0 +1,20 @@ +write_file +---------- + +Deprecated. Use the file(WRITE ) command instead. + +:: + + write_file(filename "message to write"... [APPEND]) + +The first argument is the file name, the rest of the arguments are +messages to write. If the argument APPEND is specified, then the +message will be appended. + +NOTE 1: file(WRITE ... and file(APPEND ... do exactly the same as +this one but add some more functionality. + +NOTE 2: When using write_file the produced file cannot be used as an +input to CMake (CONFIGURE_FILE, source file ...) because it will lead +to an infinite loop. Use configure_file if you want to generate input +files to CMake. diff --git a/Help/generator/CodeBlocks - Ninja.rst b/Help/generator/CodeBlocks - Ninja.rst new file mode 100644 index 0000000..0253af6 --- /dev/null +++ b/Help/generator/CodeBlocks - Ninja.rst @@ -0,0 +1,11 @@ +CodeBlocks - Ninja +------------------ + +Generates CodeBlocks project files. + +Project files for CodeBlocks will be created in the top directory and +in every subdirectory which features a CMakeLists.txt file containing +a PROJECT() call. Additionally a hierarchy of makefiles is generated +into the build tree. The appropriate make program can build the +project through the default make target. A "make install" target is +also provided. diff --git a/Help/generator/CodeBlocks - Unix Makefiles.rst b/Help/generator/CodeBlocks - Unix Makefiles.rst new file mode 100644 index 0000000..0a29835 --- /dev/null +++ b/Help/generator/CodeBlocks - Unix Makefiles.rst @@ -0,0 +1,11 @@ +CodeBlocks - Unix Makefiles +--------------------------- + +Generates CodeBlocks project files. + +Project files for CodeBlocks will be created in the top directory and +in every subdirectory which features a CMakeLists.txt file containing +a PROJECT() call. Additionally a hierarchy of makefiles is generated +into the build tree. The appropriate make program can build the +project through the default make target. A "make install" target is +also provided. diff --git a/Help/generator/Eclipse CDT4 - Ninja.rst b/Help/generator/Eclipse CDT4 - Ninja.rst new file mode 100644 index 0000000..270011f --- /dev/null +++ b/Help/generator/Eclipse CDT4 - Ninja.rst @@ -0,0 +1,11 @@ +Eclipse CDT4 - Ninja +-------------------- + +Generates Eclipse CDT 4.0 project files. + +Project files for Eclipse will be created in the top directory. In +out of source builds, a linked resource to the top level source +directory will be created. Additionally a hierarchy of makefiles is +generated into the build tree. The appropriate make program can build +the project through the default make target. A "make install" target +is also provided. diff --git a/Help/generator/Eclipse CDT4 - Unix Makefiles.rst b/Help/generator/Eclipse CDT4 - Unix Makefiles.rst new file mode 100644 index 0000000..c3449a7 --- /dev/null +++ b/Help/generator/Eclipse CDT4 - Unix Makefiles.rst @@ -0,0 +1,11 @@ +Eclipse CDT4 - Unix Makefiles +----------------------------- + +Generates Eclipse CDT 4.0 project files. + +Project files for Eclipse will be created in the top directory. In +out of source builds, a linked resource to the top level source +directory will be created. Additionally a hierarchy of makefiles is +generated into the build tree. The appropriate make program can build +the project through the default make target. A "make install" target +is also provided. diff --git a/Help/generator/KDevelop3 - Unix Makefiles.rst b/Help/generator/KDevelop3 - Unix Makefiles.rst new file mode 100644 index 0000000..2a29a2e --- /dev/null +++ b/Help/generator/KDevelop3 - Unix Makefiles.rst @@ -0,0 +1,13 @@ +KDevelop3 - Unix Makefiles +-------------------------- + +Generates KDevelop 3 project files. + +Project files for KDevelop 3 will be created in the top directory and +in every subdirectory which features a CMakeLists.txt file containing +a PROJECT() call. If you change the settings using KDevelop cmake +will try its best to keep your changes when regenerating the project +files. Additionally a hierarchy of UNIX makefiles is generated into +the build tree. Any standard UNIX-style make program can build the +project through the default make target. A "make install" target is +also provided. diff --git a/Help/generator/KDevelop3.rst b/Help/generator/KDevelop3.rst new file mode 100644 index 0000000..788d557 --- /dev/null +++ b/Help/generator/KDevelop3.rst @@ -0,0 +1,13 @@ +KDevelop3 +--------- + +Generates KDevelop 3 project files. + +Project files for KDevelop 3 will be created in the top directory and +in every subdirectory which features a CMakeLists.txt file containing +a PROJECT() call. If you change the settings using KDevelop cmake +will try its best to keep your changes when regenerating the project +files. Additionally a hierarchy of UNIX makefiles is generated into +the build tree. Any standard UNIX-style make program can build the +project through the default make target. A "make install" target is +also provided. diff --git a/Help/generator/Ninja.rst b/Help/generator/Ninja.rst new file mode 100644 index 0000000..08f74fb --- /dev/null +++ b/Help/generator/Ninja.rst @@ -0,0 +1,8 @@ +Ninja +----- + +Generates build.ninja files (experimental). + +A build.ninja file is generated into the build tree. Recent versions +of the ninja program can build the project through the "all" target. +An "install" target is also provided. diff --git a/Help/generator/Sublime Text 2 - Ninja.rst b/Help/generator/Sublime Text 2 - Ninja.rst new file mode 100644 index 0000000..b7a2b88 --- /dev/null +++ b/Help/generator/Sublime Text 2 - Ninja.rst @@ -0,0 +1,11 @@ +Sublime Text 2 - Ninja +---------------------- + +Generates Sublime Text 2 project files. + +Project files for Sublime Text 2 will be created in the top directory +and in every subdirectory which features a CMakeLists.txt file +containing a PROJECT() call. Additionally Makefiles (or build.ninja +files) are generated into the build tree. The appropriate make +program can build the project through the default make target. A +"make install" target is also provided. diff --git a/Help/generator/Sublime Text 2 - Unix Makefiles.rst b/Help/generator/Sublime Text 2 - Unix Makefiles.rst new file mode 100644 index 0000000..67d329e --- /dev/null +++ b/Help/generator/Sublime Text 2 - Unix Makefiles.rst @@ -0,0 +1,11 @@ +Sublime Text 2 - Unix Makefiles +------------------------------- + +Generates Sublime Text 2 project files. + +Project files for Sublime Text 2 will be created in the top directory +and in every subdirectory which features a CMakeLists.txt file +containing a PROJECT() call. Additionally Makefiles (or build.ninja +files) are generated into the build tree. The appropriate make +program can build the project through the default make target. A +"make install" target is also provided. diff --git a/Help/generator/Unix Makefiles.rst b/Help/generator/Unix Makefiles.rst new file mode 100644 index 0000000..97d74a8 --- /dev/null +++ b/Help/generator/Unix Makefiles.rst @@ -0,0 +1,8 @@ +Unix Makefiles +-------------- + +Generates standard UNIX makefiles. + +A hierarchy of UNIX makefiles is generated into the build tree. Any +standard UNIX-style make program can build the project through the +default make target. A "make install" target is also provided. diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst new file mode 100644 index 0000000..cde51a6 --- /dev/null +++ b/Help/manual/ccmake.1.rst @@ -0,0 +1,173 @@ +ccmake(1) +********* + +:: + + ccmake - Curses Interface for CMake. + +:: + + ccmake <path-to-source> + ccmake <path-to-existing-build> + +The "ccmake" executable is the CMake curses interface. Project +configuration settings may be specified interactively through this +GUI. Brief instructions are provided at the bottom of the terminal +when the program is running. + +CMake is a cross-platform build system generator. Projects specify +their build process with platform-independent CMake listfiles included +in each directory of a source tree with the name CMakeLists.txt. +Users build a project by using CMake to generate a build system for a +native tool on their platform. + + +* ``-C <initial-cache>``: Pre-load a script to populate the cache. + + When cmake is first run in an empty build tree, it creates a + CMakeCache.txt file and populates it with customizable settings for + the project. This option may be used to specify a file from which + to load cache entries before the first pass through the project's + cmake listfiles. The loaded entries take priority over the + project's default values. The given file should be a CMake script + containing SET commands that use the CACHE option, not a + cache-format file. + +* ``-D <var>:<type>=<value>``: Create a cmake cache entry. + + When cmake is first run in an empty build tree, it creates a + CMakeCache.txt file and populates it with customizable settings for + the project. This option may be used to specify a setting that + takes priority over the project's default value. The option may be + repeated for as many cache entries as desired. + +* ``-U <globbing_expr>``: Remove matching entries from CMake cache. + + This option may be used to remove one or more variables from the + CMakeCache.txt file, globbing expressions using * and ? are + supported. The option may be repeated for as many cache entries as + desired. + + Use with care, you can make your CMakeCache.txt non-working. + +* ``-G <generator-name>``: Specify a build system generator. + + CMake may support multiple native build systems on certain + platforms. A generator is responsible for generating a particular + build system. Possible generator names are specified in the + Generators section. + +* ``-T <toolset-name>``: Specify toolset name if supported by generator. + + Some CMake generators support a toolset name to be given to the + native build system to choose a compiler. This is supported only on + specific generators: + + :: + + Visual Studio >= 10 + Xcode >= 3.0 + + See native build system documentation for allowed toolset names. + +* ``-Wno-dev``: Suppress developer warnings. + + Suppress warnings that are meant for the author of the + CMakeLists.txt files. + +* ``-Wdev``: Enable developer warnings. + + Enable warnings that are meant for the author of the CMakeLists.txt + files. + +* ``--copyright [file]``: Print the CMake copyright and exit. + + If a file is specified, the copyright is written into it. + +* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. + + Usage describes the basic command line interface and its options. + +* ``--help-full [file]``: Print full help and exit. + + Full help displays most of the documentation provided by the UNIX + man page. It is provided for use on non-UNIX platforms, but is also + convenient if the man page is not installed. If a file is + specified, the help is written into it. + +* ``--help-html [file]``: Print full help in HTML format. + + This option is used by CMake authors to help produce web pages. If + a file is specified, the help is written into it. + +* ``--help-man [file]``: Print full help as a UNIX man page and exit. + + This option is used by the cmake build to generate the UNIX man + page. If a file is specified, the help is written into it. + +* ``--version,-version,/V [file]``: Show program name/version banner and exit. + + If a file is specified, the version is written into it. +:: + + CMake Properties - Properties supported by CMake, the Cross-Platform Makefile Generator. + +This is the documentation for the properties supported by CMake. +Properties can have different scopes. They can either be assigned to +a source file, a directory, a target or globally to CMake. By +modifying the values of properties the behaviour of the build system +can be customized. + +Copyright 2000-2012 Kitware, Inc., Insight Software Consortium. All +rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +Redistributions of source code must retain the above copyright notice, +this list of conditions and the following disclaimer. + +Redistributions in binary form must reproduce the above copyright +notice, this list of conditions and the following disclaimer in the +documentation and/or other materials provided with the distribution. + +Neither the names of Kitware, Inc., the Insight Software Consortium, +nor the names of their contributors may be used to endorse or promote +products derived from this software without specific prior written +permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +The following resources are available to get help using CMake: + + +* ``Home Page``: http://www.cmake.org + + The primary starting point for learning about CMake. + +* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ + + A Wiki is provided containing answers to frequently asked questions. + +* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html + + Links to available documentation may be found on this web page. + +* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html + + For help and discussion about using cmake, a mailing list is + provided at cmake@cmake.org. The list is member-post-only but one + may sign up on the CMake web page. Please first read the full + documentation at http://www.cmake.org before posting questions to + the list. diff --git a/Help/manual/cmake-commands.7.rst b/Help/manual/cmake-commands.7.rst new file mode 100644 index 0000000..71d7375 --- /dev/null +++ b/Help/manual/cmake-commands.7.rst @@ -0,0 +1,141 @@ +cmake-commands(7) +***************** + +.. only:: html or latex + + .. contents:: + +Normal Commands +=============== + +These commands may be used freely in CMake projects. + +.. toctree:: + /command/add_compile_options + /command/add_custom_command + /command/add_custom_target + /command/add_definitions + /command/add_dependencies + /command/add_executable + /command/add_library + /command/add_subdirectory + /command/add_test + /command/aux_source_directory + /command/break + /command/build_command + /command/cmake_host_system_information + /command/cmake_minimum_required + /command/cmake_policy + /command/configure_file + /command/create_test_sourcelist + /command/define_property + /command/elseif + /command/else + /command/enable_language + /command/enable_testing + /command/endforeach + /command/endfunction + /command/endif + /command/endmacro + /command/endwhile + /command/execute_process + /command/export + /command/file + /command/find_file + /command/find_library + /command/find_package + /command/find_path + /command/find_program + /command/fltk_wrap_ui + /command/foreach + /command/function + /command/get_cmake_property + /command/get_directory_property + /command/get_filename_component + /command/get_property + /command/get_source_file_property + /command/get_target_property + /command/get_test_property + /command/if + /command/include_directories + /command/include_external_msproject + /command/include_regular_expression + /command/include + /command/install + /command/link_directories + /command/list + /command/load_cache + /command/load_command + /command/macro + /command/mark_as_advanced + /command/math + /command/message + /command/option + /command/project + /command/qt_wrap_cpp + /command/qt_wrap_ui + /command/remove_definitions + /command/return + /command/separate_arguments + /command/set_directory_properties + /command/set_property + /command/set + /command/set_source_files_properties + /command/set_target_properties + /command/set_tests_properties + /command/site_name + /command/source_group + /command/string + /command/target_compile_definitions + /command/target_compile_options + /command/target_include_directories + /command/target_link_libraries + /command/try_compile + /command/try_run + /command/unset + /command/variable_watch + /command/while + +Deprecated Commands +=================== + +These commands are available only for compatibility with older +versions of CMake. Do not use them in new code. + +.. toctree:: + /command/build_name + /command/exec_program + /command/export_library_dependencies + /command/install_files + /command/install_programs + /command/install_targets + /command/link_libraries + /command/make_directory + /command/output_required_files + /command/remove + /command/subdir_depends + /command/subdirs + /command/use_mangled_mesa + /command/utility_source + /command/variable_requires + /command/write_file + +CTest Commands +============== + +These commands are available only in ctest scripts. + +.. toctree:: + /command/ctest_build + /command/ctest_configure + /command/ctest_coverage + /command/ctest_empty_binary_directory + /command/ctest_memcheck + /command/ctest_read_custom_files + /command/ctest_run_script + /command/ctest_sleep + /command/ctest_start + /command/ctest_submit + /command/ctest_test + /command/ctest_update + /command/ctest_upload diff --git a/Help/manual/cmake-generators.7.rst b/Help/manual/cmake-generators.7.rst new file mode 100644 index 0000000..c73d587 --- /dev/null +++ b/Help/manual/cmake-generators.7.rst @@ -0,0 +1,42 @@ +cmake-generators(7) +******************* + +.. only:: html or latex + + .. contents:: + +All Generators +============== + +.. toctree:: + /generator/Borland Makefiles + /generator/CodeBlocks - MinGW Makefiles + /generator/CodeBlocks - Ninja + /generator/CodeBlocks - NMake Makefiles + /generator/CodeBlocks - Unix Makefiles + /generator/Eclipse CDT4 - MinGW Makefiles + /generator/Eclipse CDT4 - Ninja + /generator/Eclipse CDT4 - NMake Makefiles + /generator/Eclipse CDT4 - Unix Makefiles + /generator/KDevelop3 + /generator/KDevelop3 - Unix Makefiles + /generator/MinGW Makefiles + /generator/MSYS Makefiles + /generator/Ninja + /generator/NMake Makefiles JOM + /generator/NMake Makefiles + /generator/Sublime Text 2 - MinGW Makefiles + /generator/Sublime Text 2 - Ninja + /generator/Sublime Text 2 - NMake Makefiles + /generator/Sublime Text 2 - Unix Makefiles + /generator/Unix Makefiles + /generator/Visual Studio 10 + /generator/Visual Studio 11 + /generator/Visual Studio 12 + /generator/Visual Studio 6 + /generator/Visual Studio 7 .NET 2003 + /generator/Visual Studio 7 + /generator/Visual Studio 8 2005 + /generator/Visual Studio 9 2008 + /generator/Watcom WMake + /generator/Xcode diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst new file mode 100644 index 0000000..6edfe27 --- /dev/null +++ b/Help/manual/cmake-gui.1.rst @@ -0,0 +1,138 @@ +cmake-gui(1) +************ + +:: + + cmake-gui - CMake GUI. + +:: + + cmake-gui [options] + cmake-gui [options] <path-to-source> + cmake-gui [options] <path-to-existing-build> + +The "cmake-gui" executable is the CMake GUI. Project configuration +settings may be specified interactively. Brief instructions are +provided at the bottom of the window when the program is running. + +CMake is a cross-platform build system generator. Projects specify +their build process with platform-independent CMake listfiles included +in each directory of a source tree with the name CMakeLists.txt. +Users build a project by using CMake to generate a build system for a +native tool on their platform. + + +* ``--copyright [file]``: Print the CMake copyright and exit. + + If a file is specified, the copyright is written into it. + +* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. + + Usage describes the basic command line interface and its options. + +* ``--help-full [file]``: Print full help and exit. + + Full help displays most of the documentation provided by the UNIX + man page. It is provided for use on non-UNIX platforms, but is also + convenient if the man page is not installed. If a file is + specified, the help is written into it. + +* ``--help-html [file]``: Print full help in HTML format. + + This option is used by CMake authors to help produce web pages. If + a file is specified, the help is written into it. + +* ``--help-man [file]``: Print full help as a UNIX man page and exit. + + This option is used by the cmake build to generate the UNIX man + page. If a file is specified, the help is written into it. + +* ``--version,-version,/V [file]``: Show program name/version banner and exit. + + If a file is specified, the version is written into it. +The following generators are available on this platform: + +:: + + CMake Properties - Properties supported by CMake, the Cross-Platform Makefile Generator. + +This is the documentation for the properties supported by CMake. +Properties can have different scopes. They can either be assigned to +a source file, a directory, a target or globally to CMake. By +modifying the values of properties the behaviour of the build system +can be customized. + +:: + + CMake Compatibility Listfile Commands - Obsolete commands supported by CMake for compatibility. + +This is the documentation for now obsolete listfile commands from +previous CMake versions, which are still supported for compatibility +reasons. You should instead use the newer, faster and shinier new +commands. ;-) + +The following modules are provided with CMake. They can be used with +INCLUDE(ModuleName). + +:: + + CMake Modules - Modules coming with CMake, the Cross-Platform Makefile Generator. + +This is the documentation for the modules and scripts coming with +CMake. Using these modules you can check the computer system for +installed software packages, features of the compiler and the +existence of headers to name just a few. + +Copyright 2000-2012 Kitware, Inc., Insight Software Consortium. All +rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +Redistributions of source code must retain the above copyright notice, +this list of conditions and the following disclaimer. + +Redistributions in binary form must reproduce the above copyright +notice, this list of conditions and the following disclaimer in the +documentation and/or other materials provided with the distribution. + +Neither the names of Kitware, Inc., the Insight Software Consortium, +nor the names of their contributors may be used to endorse or promote +products derived from this software without specific prior written +permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +The following resources are available to get help using CMake: + + +* ``Home Page``: http://www.cmake.org + + The primary starting point for learning about CMake. + +* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ + + A Wiki is provided containing answers to frequently asked questions. + +* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html + + Links to available documentation may be found on this web page. + +* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html + + For help and discussion about using cmake, a mailing list is + provided at cmake@cmake.org. The list is member-post-only but one + may sign up on the CMake web page. Please first read the full + documentation at http://www.cmake.org before posting questions to + the list. diff --git a/Help/manual/cmake-modules.7.rst b/Help/manual/cmake-modules.7.rst new file mode 100644 index 0000000..da518d3 --- /dev/null +++ b/Help/manual/cmake-modules.7.rst @@ -0,0 +1,230 @@ +cmake-modules(7) +**************** + +.. only:: html or latex + + .. contents:: + +All Modules +=========== + +.. toctree:: + /module/AddFileDependencies + /module/BundleUtilities + /module/CheckCCompilerFlag + /module/CheckCSourceCompiles + /module/CheckCSourceRuns + /module/CheckCXXCompilerFlag + /module/CheckCXXSourceCompiles + /module/CheckCXXSourceRuns + /module/CheckCXXSymbolExists + /module/CheckFortranFunctionExists + /module/CheckFunctionExists + /module/CheckIncludeFileCXX + /module/CheckIncludeFile + /module/CheckIncludeFiles + /module/CheckLanguage + /module/CheckLibraryExists + /module/CheckPrototypeDefinition + /module/CheckStructHasMember + /module/CheckSymbolExists + /module/CheckTypeSize + /module/CheckVariableExists + /module/CMakeAddFortranSubdirectory + /module/CMakeBackwardCompatibilityCXX + /module/CMakeDependentOption + /module/CMakeDetermineVSServicePack + /module/CMakeExpandImportedTargets + /module/CMakeFindFrameworks + /module/CMakeFindPackageMode + /module/CMakeForceCompiler + /module/CMakeGraphVizOptions + /module/CMakePackageConfigHelpers + /module/CMakeParseArguments + /module/CMakePrintHelpers + /module/CMakePrintSystemInformation + /module/CMakePushCheckState + /module/CMakeVerifyManifest + /module/CPackBundle + /module/CPackComponent + /module/CPackCygwin + /module/CPackDeb + /module/CPackDMG + /module/CPackNSIS + /module/CPackPackageMaker + /module/CPackRPM + /module/CPack + /module/CPackWIX + /module/CTest + /module/CTestScriptMode + /module/CTestUseLaunchers + /module/Dart + /module/DeployQt4 + /module/Documentation + /module/ExternalData + /module/ExternalProject + /module/FeatureSummary + /module/FindALSA + /module/FindArmadillo + /module/FindASPELL + /module/FindAVIFile + /module/FindBISON + /module/FindBLAS + /module/FindBoost + /module/FindBullet + /module/FindBZip2 + /module/FindCABLE + /module/FindCoin3D + /module/FindCUDA + /module/FindCups + /module/FindCURL + /module/FindCurses + /module/FindCVS + /module/FindCxxTest + /module/FindCygwin + /module/FindDart + /module/FindDCMTK + /module/FindDevIL + /module/FindDoxygen + /module/FindEXPAT + /module/FindFLEX + /module/FindFLTK2 + /module/FindFLTK + /module/FindFreetype + /module/FindGCCXML + /module/FindGDAL + /module/FindGettext + /module/FindGIF + /module/FindGit + /module/FindGLEW + /module/FindGLUT + /module/FindGnuplot + /module/FindGnuTLS + /module/FindGTest + /module/FindGTK2 + /module/FindGTK + /module/FindHDF5 + /module/FindHg + /module/FindHSPELL + /module/FindHTMLHelp + /module/FindIcotool + /module/FindImageMagick + /module/FindITK + /module/FindJasper + /module/FindJava + /module/FindJNI + /module/FindJPEG + /module/FindKDE3 + /module/FindKDE4 + /module/FindLAPACK + /module/FindLATEX + /module/FindLibArchive + /module/FindLibLZMA + /module/FindLibXml2 + /module/FindLibXslt + /module/FindLua50 + /module/FindLua51 + /module/FindLua + /module/FindMatlab + /module/FindMFC + /module/FindMotif + /module/FindMPEG2 + /module/FindMPEG + /module/FindMPI + /module/FindOpenAL + /module/FindOpenGL + /module/FindOpenMP + /module/FindOpenSceneGraph + /module/FindOpenSSL + /module/FindOpenThreads + /module/FindosgAnimation + /module/FindosgDB + /module/Findosg_functions + /module/FindosgFX + /module/FindosgGA + /module/FindosgIntrospection + /module/FindosgManipulator + /module/FindosgParticle + /module/FindosgPresentation + /module/FindosgProducer + /module/FindosgQt + /module/Findosg + /module/FindosgShadow + /module/FindosgSim + /module/FindosgTerrain + /module/FindosgText + /module/FindosgUtil + /module/FindosgViewer + /module/FindosgVolume + /module/FindosgWidget + /module/FindPackageHandleStandardArgs + /module/FindPackageMessage + /module/FindPerlLibs + /module/FindPerl + /module/FindPHP4 + /module/FindPhysFS + /module/FindPike + /module/FindPkgConfig + /module/FindPNG + /module/FindPostgreSQL + /module/FindProducer + /module/FindProtobuf + /module/FindPythonInterp + /module/FindPythonLibs + /module/FindQt3 + /module/FindQt4 + /module/FindQt + /module/FindQuickTime + /module/FindRTI + /module/FindRuby + /module/FindSDL_image + /module/FindSDL_mixer + /module/FindSDL_net + /module/FindSDL + /module/FindSDL_sound + /module/FindSDL_ttf + /module/FindSelfPackers + /module/FindSquish + /module/FindSubversion + /module/FindSWIG + /module/FindTCL + /module/FindTclsh + /module/FindTclStub + /module/FindThreads + /module/FindTIFF + /module/FindUnixCommands + /module/FindVTK + /module/FindWget + /module/FindWish + /module/FindwxWidgets + /module/FindwxWindows + /module/FindX11 + /module/FindXMLRPC + /module/FindZLIB + /module/FortranCInterface + /module/GenerateExportHeader + /module/GetPrerequisites + /module/GNUInstallDirs + /module/InstallRequiredSystemLibraries + /module/MacroAddFileDependencies + /module/ProcessorCount + /module/Qt4ConfigDependentSettings + /module/Qt4Macros + /module/SelectLibraryConfigurations + /module/SquishTestScript + /module/TestBigEndian + /module/TestCXXAcceptsFlag + /module/TestForANSIForScope + /module/TestForANSIStreamHeaders + /module/TestForSSTREAM + /module/TestForSTDNamespace + /module/UseEcos + /module/UseJavaClassFilelist + /module/UseJava + /module/UseJavaSymlinks + /module/UsePkgConfig + /module/UseQt4 + /module/UseSWIG + /module/UsewxWidgets + /module/Use_wxWindows + /module/WriteBasicConfigVersionFile diff --git a/Help/manual/cmake-policies.7.rst b/Help/manual/cmake-policies.7.rst new file mode 100644 index 0000000..cd91c91 --- /dev/null +++ b/Help/manual/cmake-policies.7.rst @@ -0,0 +1,38 @@ +cmake-policies(7) +***************** + +.. only:: html or latex + + .. contents:: + +All Policies +============ + +.. toctree:: + /policy/CMP0000 + /policy/CMP0001 + /policy/CMP0002 + /policy/CMP0003 + /policy/CMP0004 + /policy/CMP0005 + /policy/CMP0006 + /policy/CMP0007 + /policy/CMP0008 + /policy/CMP0009 + /policy/CMP0010 + /policy/CMP0011 + /policy/CMP0012 + /policy/CMP0013 + /policy/CMP0014 + /policy/CMP0015 + /policy/CMP0016 + /policy/CMP0017 + /policy/CMP0018 + /policy/CMP0019 + /policy/CMP0020 + /policy/CMP0021 + /policy/CMP0022 + /policy/CMP0023 + /policy/CMP0024 + /policy/CMP0025 + /policy/CMP0026 diff --git a/Help/manual/cmake-properties.7.rst b/Help/manual/cmake-properties.7.rst new file mode 100644 index 0000000..bb3acff --- /dev/null +++ b/Help/manual/cmake-properties.7.rst @@ -0,0 +1,262 @@ +cmake-properties(7) +******************* + +.. only:: html or latex + + .. contents:: + +Properties of Global Scope +========================== + +.. toctree:: + /prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS + /prop_gbl/AUTOMOC_TARGETS_FOLDER + /prop_gbl/DEBUG_CONFIGURATIONS + /prop_gbl/DISABLED_FEATURES + /prop_gbl/ENABLED_FEATURES + /prop_gbl/ENABLED_LANGUAGES + /prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS + /prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING + /prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE + /prop_gbl/GLOBAL_DEPENDS_NO_CYCLES + /prop_gbl/IN_TRY_COMPILE + /prop_gbl/PACKAGES_FOUND + /prop_gbl/PACKAGES_NOT_FOUND + /prop_gbl/PREDEFINED_TARGETS_FOLDER + /prop_gbl/REPORT_UNDEFINED_PROPERTIES + /prop_gbl/RULE_LAUNCH_COMPILE + /prop_gbl/RULE_LAUNCH_CUSTOM + /prop_gbl/RULE_LAUNCH_LINK + /prop_gbl/RULE_MESSAGES + /prop_gbl/TARGET_ARCHIVES_MAY_BE_SHARED_LIBS + /prop_gbl/TARGET_SUPPORTS_SHARED_LIBS + /prop_gbl/USE_FOLDERS + +Properties on Directories +========================= + +.. toctree:: + /prop_dir/ADDITIONAL_MAKE_CLEAN_FILES + /prop_dir/CACHE_VARIABLES + /prop_dir/CLEAN_NO_CUSTOM + /prop_dir/COMPILE_DEFINITIONS_CONFIG + /prop_dir/COMPILE_DEFINITIONS + /prop_dir/COMPILE_OPTIONS + /prop_dir/DEFINITIONS + /prop_dir/EXCLUDE_FROM_ALL + /prop_dir/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM + /prop_dir/INCLUDE_DIRECTORIES + /prop_dir/INCLUDE_REGULAR_EXPRESSION + /prop_dir/INTERPROCEDURAL_OPTIMIZATION_CONFIG + /prop_dir/INTERPROCEDURAL_OPTIMIZATION + /prop_dir/LINK_DIRECTORIES + /prop_dir/LISTFILE_STACK + /prop_dir/MACROS + /prop_dir/PARENT_DIRECTORY + /prop_dir/RULE_LAUNCH_COMPILE + /prop_dir/RULE_LAUNCH_CUSTOM + /prop_dir/RULE_LAUNCH_LINK + /prop_dir/TEST_INCLUDE_FILE + /prop_dir/VARIABLES + /prop_dir/VS_GLOBAL_SECTION_POST_section + /prop_dir/VS_GLOBAL_SECTION_PRE_section + +Properties on Targets +===================== + +.. toctree:: + /prop_tgt/ALIASED_TARGET + /prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG + /prop_tgt/ARCHIVE_OUTPUT_DIRECTORY + /prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG + /prop_tgt/ARCHIVE_OUTPUT_NAME + /prop_tgt/AUTOMOC_MOC_OPTIONS + /prop_tgt/AUTOMOC + /prop_tgt/BUILD_WITH_INSTALL_RPATH + /prop_tgt/BUNDLE_EXTENSION + /prop_tgt/BUNDLE + /prop_tgt/COMPATIBLE_INTERFACE_BOOL + /prop_tgt/COMPATIBLE_INTERFACE_STRING + /prop_tgt/COMPILE_DEFINITIONS_CONFIG + /prop_tgt/COMPILE_DEFINITIONS + /prop_tgt/COMPILE_FLAGS + /prop_tgt/COMPILE_OPTIONS + /prop_tgt/CONFIG_OUTPUT_NAME + /prop_tgt/CONFIG_POSTFIX + /prop_tgt/DEBUG_POSTFIX + /prop_tgt/DEFINE_SYMBOL + /prop_tgt/EchoString + /prop_tgt/ENABLE_EXPORTS + /prop_tgt/EXCLUDE_FROM_ALL + /prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG + /prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD + /prop_tgt/EXPORT_NAME + /prop_tgt/FOLDER + /prop_tgt/Fortran_FORMAT + /prop_tgt/Fortran_MODULE_DIRECTORY + /prop_tgt/FRAMEWORK + /prop_tgt/GENERATOR_FILE_NAME + /prop_tgt/GNUtoMS + /prop_tgt/HAS_CXX + /prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM + /prop_tgt/IMPORTED_CONFIGURATIONS + /prop_tgt/IMPORTED_IMPLIB_CONFIG + /prop_tgt/IMPORTED_IMPLIB + /prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG + /prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES + /prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG + /prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES + /prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG + /prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES + /prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG + /prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY + /prop_tgt/IMPORTED_LOCATION_CONFIG + /prop_tgt/IMPORTED_LOCATION + /prop_tgt/IMPORTED_NO_SONAME_CONFIG + /prop_tgt/IMPORTED_NO_SONAME + /prop_tgt/IMPORTED + /prop_tgt/IMPORTED_SONAME_CONFIG + /prop_tgt/IMPORTED_SONAME + /prop_tgt/IMPORT_PREFIX + /prop_tgt/IMPORT_SUFFIX + /prop_tgt/INCLUDE_DIRECTORIES + /prop_tgt/INSTALL_NAME_DIR + /prop_tgt/INSTALL_RPATH + /prop_tgt/INSTALL_RPATH_USE_LINK_PATH + /prop_tgt/INTERFACE_COMPILE_DEFINITIONS + /prop_tgt/INTERFACE_COMPILE_OPTIONS + /prop_tgt/INTERFACE_INCLUDE_DIRECTORIES + /prop_tgt/INTERFACE_LINK_LIBRARIES + /prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE + /prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES + /prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG + /prop_tgt/INTERPROCEDURAL_OPTIMIZATION + /prop_tgt/LABELS + /prop_tgt/LANG_VISIBILITY_PRESET + /prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG + /prop_tgt/LIBRARY_OUTPUT_DIRECTORY + /prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG + /prop_tgt/LIBRARY_OUTPUT_NAME + /prop_tgt/LINK_DEPENDS_NO_SHARED + /prop_tgt/LINK_DEPENDS + /prop_tgt/LINKER_LANGUAGE + /prop_tgt/LINK_FLAGS_CONFIG + /prop_tgt/LINK_FLAGS + /prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG + /prop_tgt/LINK_INTERFACE_LIBRARIES + /prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG + /prop_tgt/LINK_INTERFACE_MULTIPLICITY + /prop_tgt/LINK_LIBRARIES + /prop_tgt/LINK_SEARCH_END_STATIC + /prop_tgt/LINK_SEARCH_START_STATIC + /prop_tgt/LOCATION_CONFIG + /prop_tgt/LOCATION + /prop_tgt/MACOSX_BUNDLE_INFO_PLIST + /prop_tgt/MACOSX_BUNDLE + /prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST + /prop_tgt/MACOSX_RPATH + /prop_tgt/MAP_IMPORTED_CONFIG_CONFIG + /prop_tgt/NAME + /prop_tgt/NO_SONAME + /prop_tgt/NO_SYSTEM_FROM_IMPORTED + /prop_tgt/OSX_ARCHITECTURES_CONFIG + /prop_tgt/OSX_ARCHITECTURES + /prop_tgt/OUTPUT_NAME_CONFIG + /prop_tgt/OUTPUT_NAME + /prop_tgt/PDB_NAME_CONFIG + /prop_tgt/PDB_NAME + /prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG + /prop_tgt/PDB_OUTPUT_DIRECTORY + /prop_tgt/POSITION_INDEPENDENT_CODE + /prop_tgt/POST_INSTALL_SCRIPT + /prop_tgt/PREFIX + /prop_tgt/PRE_INSTALL_SCRIPT + /prop_tgt/PRIVATE_HEADER + /prop_tgt/PROJECT_LABEL + /prop_tgt/PUBLIC_HEADER + /prop_tgt/RESOURCE + /prop_tgt/RULE_LAUNCH_COMPILE + /prop_tgt/RULE_LAUNCH_CUSTOM + /prop_tgt/RULE_LAUNCH_LINK + /prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG + /prop_tgt/RUNTIME_OUTPUT_DIRECTORY + /prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG + /prop_tgt/RUNTIME_OUTPUT_NAME + /prop_tgt/SKIP_BUILD_RPATH + /prop_tgt/SOURCES + /prop_tgt/SOVERSION + /prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG + /prop_tgt/STATIC_LIBRARY_FLAGS + /prop_tgt/SUFFIX + /prop_tgt/TYPE + /prop_tgt/VERSION + /prop_tgt/VISIBILITY_INLINES_HIDDEN + /prop_tgt/VS_DOTNET_REFERENCES + /prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION + /prop_tgt/VS_GLOBAL_KEYWORD + /prop_tgt/VS_GLOBAL_PROJECT_TYPES + /prop_tgt/VS_GLOBAL_ROOTNAMESPACE + /prop_tgt/VS_GLOBAL_variable + /prop_tgt/VS_KEYWORD + /prop_tgt/VS_SCC_AUXPATH + /prop_tgt/VS_SCC_LOCALPATH + /prop_tgt/VS_SCC_PROJECTNAME + /prop_tgt/VS_SCC_PROVIDER + /prop_tgt/VS_WINRT_EXTENSIONS + /prop_tgt/VS_WINRT_REFERENCES + /prop_tgt/WIN32_EXECUTABLE + /prop_tgt/XCODE_ATTRIBUTE_an-attribute + +Properties on Tests +=================== + +.. toctree:: + /prop_test/ATTACHED_FILES_ON_FAIL + /prop_test/ATTACHED_FILES + /prop_test/COST + /prop_test/DEPENDS + /prop_test/ENVIRONMENT + /prop_test/FAIL_REGULAR_EXPRESSION + /prop_test/LABELS + /prop_test/MEASUREMENT + /prop_test/PASS_REGULAR_EXPRESSION + /prop_test/PROCESSORS + /prop_test/REQUIRED_FILES + /prop_test/RESOURCE_LOCK + /prop_test/RUN_SERIAL + /prop_test/TIMEOUT + /prop_test/WILL_FAIL + /prop_test/WORKING_DIRECTORY + +Properties on Source Files +========================== + +.. toctree:: + /prop_sf/ABSTRACT + /prop_sf/COMPILE_DEFINITIONS_CONFIG + /prop_sf/COMPILE_DEFINITIONS + /prop_sf/COMPILE_FLAGS + /prop_sf/EXTERNAL_OBJECT + /prop_sf/Fortran_FORMAT + /prop_sf/GENERATED + /prop_sf/HEADER_FILE_ONLY + /prop_sf/KEEP_EXTENSION + /prop_sf/LABELS + /prop_sf/LANGUAGE + /prop_sf/LOCATION + /prop_sf/MACOSX_PACKAGE_LOCATION + /prop_sf/OBJECT_DEPENDS + /prop_sf/OBJECT_OUTPUTS + /prop_sf/SYMBOLIC + /prop_sf/WRAP_EXCLUDE + +Properties on Cache Entries +=========================== + +.. toctree:: + /prop_cache/ADVANCED + /prop_cache/HELPSTRING + /prop_cache/MODIFIED + /prop_cache/STRINGS + /prop_cache/TYPE + /prop_cache/VALUE diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst new file mode 100644 index 0000000..99c782d --- /dev/null +++ b/Help/manual/cmake-variables.7.rst @@ -0,0 +1,254 @@ +cmake-variables(7) +****************** + +.. only:: html or latex + + .. contents:: + +Variables that Provide Information +================================== + +.. toctree:: + /variable/CMAKE_ARGC + /variable/CMAKE_ARGV0 + /variable/CMAKE_AR + /variable/CMAKE_BINARY_DIR + /variable/CMAKE_BUILD_TOOL + /variable/CMAKE_CACHEFILE_DIR + /variable/CMAKE_CACHE_MAJOR_VERSION + /variable/CMAKE_CACHE_MINOR_VERSION + /variable/CMAKE_CACHE_PATCH_VERSION + /variable/CMAKE_CFG_INTDIR + /variable/CMAKE_COMMAND + /variable/CMAKE_CROSSCOMPILING + /variable/CMAKE_CTEST_COMMAND + /variable/CMAKE_CURRENT_BINARY_DIR + /variable/CMAKE_CURRENT_LIST_DIR + /variable/CMAKE_CURRENT_LIST_FILE + /variable/CMAKE_CURRENT_LIST_LINE + /variable/CMAKE_CURRENT_SOURCE_DIR + /variable/CMAKE_DL_LIBS + /variable/CMAKE_EDIT_COMMAND + /variable/CMAKE_EXECUTABLE_SUFFIX + /variable/CMAKE_EXTRA_GENERATOR + /variable/CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES + /variable/CMAKE_GENERATOR + /variable/CMAKE_GENERATOR_TOOLSET + /variable/CMAKE_HOME_DIRECTORY + /variable/CMAKE_IMPORT_LIBRARY_PREFIX + /variable/CMAKE_IMPORT_LIBRARY_SUFFIX + /variable/CMAKE_LINK_LIBRARY_SUFFIX + /variable/CMAKE_MAJOR_VERSION + /variable/CMAKE_MAKE_PROGRAM + /variable/CMAKE_MINIMUM_REQUIRED_VERSION + /variable/CMAKE_MINOR_VERSION + /variable/CMAKE_PARENT_LIST_FILE + /variable/CMAKE_PATCH_VERSION + /variable/CMAKE_PROJECT_NAME + /variable/CMAKE_RANLIB + /variable/CMAKE_ROOT + /variable/CMAKE_SCRIPT_MODE_FILE + /variable/CMAKE_SHARED_LIBRARY_PREFIX + /variable/CMAKE_SHARED_LIBRARY_SUFFIX + /variable/CMAKE_SHARED_MODULE_PREFIX + /variable/CMAKE_SHARED_MODULE_SUFFIX + /variable/CMAKE_SIZEOF_VOID_P + /variable/CMAKE_SKIP_RPATH + /variable/CMAKE_SOURCE_DIR + /variable/CMAKE_STANDARD_LIBRARIES + /variable/CMAKE_STATIC_LIBRARY_PREFIX + /variable/CMAKE_STATIC_LIBRARY_SUFFIX + /variable/CMAKE_TWEAK_VERSION + /variable/CMAKE_VERBOSE_MAKEFILE + /variable/CMAKE_VERSION + /variable/CMAKE_VS_PLATFORM_TOOLSET + /variable/CMAKE_XCODE_PLATFORM_TOOLSET + /variable/PROJECT_BINARY_DIR + /variable/PROJECT-NAME_BINARY_DIR + /variable/PROJECT_NAME + /variable/PROJECT-NAME_SOURCE_DIR + /variable/PROJECT_SOURCE_DIR + +Variables that Change Behavior +============================== + +.. toctree:: + /variable/BUILD_SHARED_LIBS + /variable/CMAKE_ABSOLUTE_DESTINATION_FILES + /variable/CMAKE_AUTOMOC_RELAXED_MODE + /variable/CMAKE_BACKWARDS_COMPATIBILITY + /variable/CMAKE_BUILD_TYPE + /variable/CMAKE_COLOR_MAKEFILE + /variable/CMAKE_CONFIGURATION_TYPES + /variable/CMAKE_DEBUG_TARGET_PROPERTIES + /variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName + /variable/CMAKE_ERROR_DEPRECATED + /variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION + /variable/CMAKE_FIND_LIBRARY_PREFIXES + /variable/CMAKE_FIND_LIBRARY_SUFFIXES + /variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE + /variable/CMAKE_IGNORE_PATH + /variable/CMAKE_INCLUDE_PATH + /variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME + /variable/CMAKE_INSTALL_PREFIX + /variable/CMAKE_LIBRARY_PATH + /variable/CMAKE_MFC_FLAG + /variable/CMAKE_MODULE_PATH + /variable/CMAKE_NOT_USING_CONFIG_FLAGS + /variable/CMAKE_POLICY_DEFAULT_CMPNNNN + /variable/CMAKE_PREFIX_PATH + /variable/CMAKE_PROGRAM_PATH + /variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY + /variable/CMAKE_SYSTEM_IGNORE_PATH + /variable/CMAKE_SYSTEM_INCLUDE_PATH + /variable/CMAKE_SYSTEM_LIBRARY_PATH + /variable/CMAKE_SYSTEM_PREFIX_PATH + /variable/CMAKE_SYSTEM_PROGRAM_PATH + /variable/CMAKE_USER_MAKE_RULES_OVERRIDE + /variable/CMAKE_WARN_DEPRECATED + /variable/CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION + +Variables that Describe the System +================================== + +.. toctree:: + /variable/APPLE + /variable/BORLAND + /variable/CMAKE_CL_64 + /variable/CMAKE_COMPILER_2005 + /variable/CMAKE_HOST_APPLE + /variable/CMAKE_HOST_SYSTEM_NAME + /variable/CMAKE_HOST_SYSTEM_PROCESSOR + /variable/CMAKE_HOST_SYSTEM + /variable/CMAKE_HOST_SYSTEM_VERSION + /variable/CMAKE_HOST_UNIX + /variable/CMAKE_HOST_WIN32 + /variable/CMAKE_LIBRARY_ARCHITECTURE_REGEX + /variable/CMAKE_LIBRARY_ARCHITECTURE + /variable/CMAKE_OBJECT_PATH_MAX + /variable/CMAKE_SYSTEM_NAME + /variable/CMAKE_SYSTEM_PROCESSOR + /variable/CMAKE_SYSTEM + /variable/CMAKE_SYSTEM_VERSION + /variable/CYGWIN + /variable/ENV + /variable/MSVC10 + /variable/MSVC11 + /variable/MSVC12 + /variable/MSVC60 + /variable/MSVC70 + /variable/MSVC71 + /variable/MSVC80 + /variable/MSVC90 + /variable/MSVC_IDE + /variable/MSVC + /variable/MSVC_VERSION + /variable/UNIX + /variable/WIN32 + /variable/XCODE_VERSION + +Variables that Control the Build +================================ + +.. toctree:: + /variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY + /variable/CMAKE_AUTOMOC_MOC_OPTIONS + /variable/CMAKE_AUTOMOC + /variable/CMAKE_BUILD_WITH_INSTALL_RPATH + /variable/CMAKE_CONFIG_POSTFIX + /variable/CMAKE_DEBUG_POSTFIX + /variable/CMAKE_EXE_LINKER_FLAGS_CONFIG + /variable/CMAKE_EXE_LINKER_FLAGS + /variable/CMAKE_Fortran_FORMAT + /variable/CMAKE_Fortran_MODULE_DIRECTORY + /variable/CMAKE_GNUtoMS + /variable/CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE + /variable/CMAKE_INCLUDE_CURRENT_DIR + /variable/CMAKE_INSTALL_NAME_DIR + /variable/CMAKE_INSTALL_RPATH + /variable/CMAKE_INSTALL_RPATH_USE_LINK_PATH + /variable/CMAKE_LANG_VISIBILITY_PRESET + /variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY + /variable/CMAKE_LIBRARY_PATH_FLAG + /variable/CMAKE_LINK_DEF_FILE_FLAG + /variable/CMAKE_LINK_DEPENDS_NO_SHARED + /variable/CMAKE_LINK_INTERFACE_LIBRARIES + /variable/CMAKE_LINK_LIBRARY_FILE_FLAG + /variable/CMAKE_LINK_LIBRARY_FLAG + /variable/CMAKE_MACOSX_BUNDLE + /variable/CMAKE_MAP_IMPORTED_CONFIG_CONFIG + /variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG + /variable/CMAKE_MODULE_LINKER_FLAGS + /variable/CMAKE_NO_BUILTIN_CHRPATH + /variable/CMAKE_NO_SYSTEM_FROM_IMPORTED + /variable/CMAKE_PDB_OUTPUT_DIRECTORY + /variable/CMAKE_POSITION_INDEPENDENT_CODE + /variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY + /variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG + /variable/CMAKE_SHARED_LINKER_FLAGS + /variable/CMAKE_SKIP_BUILD_RPATH + /variable/CMAKE_SKIP_INSTALL_RPATH + /variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG + /variable/CMAKE_STATIC_LINKER_FLAGS + /variable/CMAKE_TRY_COMPILE_CONFIGURATION + /variable/CMAKE_USE_RELATIVE_PATHS + /variable/CMAKE_VISIBILITY_INLINES_HIDDEN + /variable/CMAKE_WIN32_EXECUTABLE + /variable/EXECUTABLE_OUTPUT_PATH + /variable/LIBRARY_OUTPUT_PATH + +Variables for Languages +======================= + +.. toctree:: + /variable/CMAKE_COMPILER_IS_GNULANG + /variable/CMAKE_Fortran_MODDIR_DEFAULT + /variable/CMAKE_Fortran_MODDIR_FLAG + /variable/CMAKE_Fortran_MODOUT_FLAG + /variable/CMAKE_INTERNAL_PLATFORM_ABI + /variable/CMAKE_LANG_ARCHIVE_APPEND + /variable/CMAKE_LANG_ARCHIVE_CREATE + /variable/CMAKE_LANG_ARCHIVE_FINISH + /variable/CMAKE_LANG_COMPILE_OBJECT + /variable/CMAKE_LANG_COMPILER_ABI + /variable/CMAKE_LANG_COMPILER_ID + /variable/CMAKE_LANG_COMPILER_LOADED + /variable/CMAKE_LANG_COMPILER + /variable/CMAKE_LANG_COMPILER_VERSION + /variable/CMAKE_LANG_CREATE_SHARED_LIBRARY + /variable/CMAKE_LANG_CREATE_SHARED_MODULE + /variable/CMAKE_LANG_CREATE_STATIC_LIBRARY + /variable/CMAKE_LANG_FLAGS_DEBUG + /variable/CMAKE_LANG_FLAGS_MINSIZEREL + /variable/CMAKE_LANG_FLAGS_RELEASE + /variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO + /variable/CMAKE_LANG_FLAGS + /variable/CMAKE_LANG_IGNORE_EXTENSIONS + /variable/CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES + /variable/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES + /variable/CMAKE_LANG_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES + /variable/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES + /variable/CMAKE_LANG_LIBRARY_ARCHITECTURE + /variable/CMAKE_LANG_LINKER_PREFERENCE_PROPAGATES + /variable/CMAKE_LANG_LINKER_PREFERENCE + /variable/CMAKE_LANG_LINK_EXECUTABLE + /variable/CMAKE_LANG_OUTPUT_EXTENSION + /variable/CMAKE_LANG_PLATFORM_ID + /variable/CMAKE_LANG_SIMULATE_ID + /variable/CMAKE_LANG_SIMULATE_VERSION + /variable/CMAKE_LANG_SIZEOF_DATA_PTR + /variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS + /variable/CMAKE_USER_MAKE_RULES_OVERRIDE_LANG + +Variables for CPack +=================== + +.. toctree:: + /variable/CPACK_ABSOLUTE_DESTINATION_FILES + /variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY + /variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION + /variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY + /variable/CPACK_INSTALL_SCRIPT + /variable/CPACK_PACKAGING_INSTALL_PREFIX + /variable/CPACK_SET_DESTDIR + /variable/CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst new file mode 100644 index 0000000..1147ab8 --- /dev/null +++ b/Help/manual/cmake.1.rst @@ -0,0 +1,441 @@ +cmake(1) +******** + +:: + + cmake - Cross-Platform Makefile Generator. + +:: + + cmake [options] <path-to-source> + cmake [options] <path-to-existing-build> + +The "cmake" executable is the CMake command-line interface. It may be +used to configure projects in scripts. Project configuration settings +may be specified on the command line with the -D option. The -i +option will cause cmake to interactively prompt for such settings. + +CMake is a cross-platform build system generator. Projects specify +their build process with platform-independent CMake listfiles included +in each directory of a source tree with the name CMakeLists.txt. +Users build a project by using CMake to generate a build system for a +native tool on their platform. + + +* ``-C <initial-cache>``: Pre-load a script to populate the cache. + + When cmake is first run in an empty build tree, it creates a + CMakeCache.txt file and populates it with customizable settings for + the project. This option may be used to specify a file from which + to load cache entries before the first pass through the project's + cmake listfiles. The loaded entries take priority over the + project's default values. The given file should be a CMake script + containing SET commands that use the CACHE option, not a + cache-format file. + +* ``-D <var>:<type>=<value>``: Create a cmake cache entry. + + When cmake is first run in an empty build tree, it creates a + CMakeCache.txt file and populates it with customizable settings for + the project. This option may be used to specify a setting that + takes priority over the project's default value. The option may be + repeated for as many cache entries as desired. + +* ``-U <globbing_expr>``: Remove matching entries from CMake cache. + + This option may be used to remove one or more variables from the + CMakeCache.txt file, globbing expressions using * and ? are + supported. The option may be repeated for as many cache entries as + desired. + + Use with care, you can make your CMakeCache.txt non-working. + +* ``-G <generator-name>``: Specify a build system generator. + + CMake may support multiple native build systems on certain + platforms. A generator is responsible for generating a particular + build system. Possible generator names are specified in the + Generators section. + +* ``-T <toolset-name>``: Specify toolset name if supported by generator. + + Some CMake generators support a toolset name to be given to the + native build system to choose a compiler. This is supported only on + specific generators: + + :: + + Visual Studio >= 10 + Xcode >= 3.0 + + See native build system documentation for allowed toolset names. + +* ``-Wno-dev``: Suppress developer warnings. + + Suppress warnings that are meant for the author of the + CMakeLists.txt files. + +* ``-Wdev``: Enable developer warnings. + + Enable warnings that are meant for the author of the CMakeLists.txt + files. + +* ``-E``: CMake command mode. + + For true platform independence, CMake provides a list of commands + that can be used on all systems. Run with -E help for the usage + information. Commands available are: chdir, compare_files, copy, + copy_directory, copy_if_different, echo, echo_append, environment, + make_directory, md5sum, remove, remove_directory, rename, tar, time, + touch, touch_nocreate. In addition, some platform specific commands + are available. On Windows: comspec, delete_regv, write_regv. On + UNIX: create_symlink. + +* ``-i``: Run in wizard mode. + + Wizard mode runs cmake interactively without a GUI. The user is + prompted to answer questions about the project configuration. The + answers are used to set cmake cache values. + +* ``-L[A][H]``: List non-advanced cached variables. + + List cache variables will run CMake and list all the variables from + the CMake cache that are not marked as INTERNAL or ADVANCED. This + will effectively display current CMake settings, which can then be + changed with -D option. Changing some of the variables may result + in more variables being created. If A is specified, then it will + display also advanced variables. If H is specified, it will also + display help for each variable. + +* ``--build <dir>``: Build a CMake-generated project binary tree. + + This abstracts a native build tool's command-line interface with the + following options: + + :: + + <dir> = Project binary directory to be built. + --target <tgt> = Build <tgt> instead of default targets. + --config <cfg> = For multi-configuration tools, choose <cfg>. + --clean-first = Build target 'clean' first, then build. + (To clean only, use --target 'clean'.) + --use-stderr = Don't merge stdout/stderr output and pass the + original stdout/stderr handles to the native + tool so it can use the capabilities of the + calling terminal (e.g. colored output). + -- = Pass remaining options to the native tool. + + Run cmake --build with no options for quick help. + +* ``-N``: View mode only. + + Only load the cache. Do not actually run configure and generate + steps. + +* ``-P <file>``: Process script mode. + + Process the given cmake file as a script written in the CMake + language. No configure or generate step is performed and the cache + is not modified. If variables are defined using -D, this must be + done before the -P argument. + +* ``--find-package``: Run in pkg-config like mode. + + Search a package using find_package() and print the resulting flags + to stdout. This can be used to use cmake instead of pkg-config to + find installed libraries in plain Makefile-based projects or in + autoconf-based projects (via share/aclocal/cmake.m4). + +* ``--graphviz=[file]``: Generate graphviz of dependencies, see CMakeGraphVizOptions.cmake for more. + + Generate a graphviz input file that will contain all the library and + executable dependencies in the project. See the documentation for + CMakeGraphVizOptions.cmake for more details. + +* ``--system-information [file]``: Dump information about this system. + + Dump a wide range of information about the current system. If run + from the top of a binary tree for a CMake project it will dump + additional information such as the cache, log files etc. + +* ``--debug-trycompile``: Do not delete the try_compile build tree. Only useful on one try_compile at a time. + + Do not delete the files and directories created for try_compile + calls. This is useful in debugging failed try_compiles. It may + however change the results of the try-compiles as old junk from a + previous try-compile may cause a different test to either pass or + fail incorrectly. This option is best used for one try-compile at a + time, and only when debugging. + +* ``--debug-output``: Put cmake in a debug mode. + + Print extra stuff during the cmake run like stack traces with + message(send_error ) calls. + +* ``--trace``: Put cmake in trace mode. + + Print a trace of all calls made and from where with + message(send_error ) calls. + +* ``--warn-uninitialized``: Warn about uninitialized values. + + Print a warning when an uninitialized variable is used. + +* ``--warn-unused-vars``: Warn about unused variables. + + Find variables that are declared or set, but not used. + +* ``--no-warn-unused-cli``: Don't warn about command line options. + + Don't find variables that are declared on the command line, but not + used. + +* ``--check-system-vars``: Find problems with variable usage in system files. + + Normally, unused and uninitialized variables are searched for only + in CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR. This flag tells CMake to + warn about other files as well. + +* ``--help-command cmd [file]``: Print help for a single command and exit. + + Full documentation specific to the given command is displayed. If a + file is specified, the documentation is written into and the output + format is determined depending on the filename suffix. Supported + are man page, HTML, DocBook and plain text. + +* ``--help-command-list [file]``: List available listfile commands and exit. + + The list contains all commands for which help may be obtained by + using the --help-command argument followed by a command name. If a + file is specified, the documentation is written into and the output + format is determined depending on the filename suffix. Supported + are man page, HTML, DocBook and plain text. + +* ``--help-commands [file]``: Print help for all commands and exit. + + Full documentation specific for all current commands is displayed.If + a file is specified, the documentation is written into and the + output format is determined depending on the filename suffix. + Supported are man page, HTML, DocBook and plain text. + +* ``--help-compatcommands [file]``: Print help for compatibility commands. + + Full documentation specific for all compatibility commands is + displayed.If a file is specified, the documentation is written into + and the output format is determined depending on the filename + suffix. Supported are man page, HTML, DocBook and plain text. + +* ``--help-module module [file]``: Print help for a single module and exit. + + Full documentation specific to the given module is displayed.If a + file is specified, the documentation is written into and the output + format is determined depending on the filename suffix. Supported + are man page, HTML, DocBook and plain text. + +* ``--help-module-list [file]``: List available modules and exit. + + The list contains all modules for which help may be obtained by + using the --help-module argument followed by a module name. If a + file is specified, the documentation is written into and the output + format is determined depending on the filename suffix. Supported + are man page, HTML, DocBook and plain text. + +* ``--help-modules [file]``: Print help for all modules and exit. + + Full documentation for all modules is displayed. If a file is + specified, the documentation is written into and the output format + is determined depending on the filename suffix. Supported are man + page, HTML, DocBook and plain text. + +* ``--help-custom-modules [file]``: Print help for all custom modules and exit. + + Full documentation for all custom modules is displayed. If a file + is specified, the documentation is written into and the output + format is determined depending on the filename suffix. Supported + are man page, HTML, DocBook and plain text. + +* ``--help-policy cmp [file]``: Print help for a single policy and exit. + + Full documentation specific to the given policy is displayed.If a + file is specified, the documentation is written into and the output + format is determined depending on the filename suffix. Supported + are man page, HTML, DocBook and plain text. + +* ``--help-policy-list [file]``: List available policies and exit. + + The list contains all policies for which help may be obtained by + using the --help-policy argument followed by a policy name. If a + file is specified, the documentation is written into and the output + format is determined depending on the filename suffix. Supported + are man page, HTML, DocBook and plain text. + +* ``--help-policies [file]``: Print help for all policies and exit. + + Full documentation for all policies is displayed.If a file is + specified, the documentation is written into and the output format + is determined depending on the filename suffix. Supported are man + page, HTML, DocBook and plain text. + +* ``--help-property prop [file]``: Print help for a single property and exit. + + Full documentation specific to the given property is displayed.If a + file is specified, the documentation is written into and the output + format is determined depending on the filename suffix. Supported + are man page, HTML, DocBook and plain text. + +* ``--help-property-list [file]``: List available properties and exit. + + The list contains all properties for which help may be obtained by + using the --help-property argument followed by a property name. If + a file is specified, the help is written into it.If a file is + specified, the documentation is written into and the output format + is determined depending on the filename suffix. Supported are man + page, HTML, DocBook and plain text. + +* ``--help-properties [file]``: Print help for all properties and exit. + + Full documentation for all properties is displayed.If a file is + specified, the documentation is written into and the output format + is determined depending on the filename suffix. Supported are man + page, HTML, DocBook and plain text. + +* ``--help-variable var [file]``: Print help for a single variable and exit. + + Full documentation specific to the given variable is displayed.If a + file is specified, the documentation is written into and the output + format is determined depending on the filename suffix. Supported + are man page, HTML, DocBook and plain text. + +* ``--help-variable-list [file]``: List documented variables and exit. + + The list contains all variables for which help may be obtained by + using the --help-variable argument followed by a variable name. If + a file is specified, the help is written into it.If a file is + specified, the documentation is written into and the output format + is determined depending on the filename suffix. Supported are man + page, HTML, DocBook and plain text. + +* ``--help-variables [file]``: Print help for all variables and exit. + + Full documentation for all variables is displayed.If a file is + specified, the documentation is written into and the output format + is determined depending on the filename suffix. Supported are man + page, HTML, DocBook and plain text. + +* ``--copyright [file]``: Print the CMake copyright and exit. + + If a file is specified, the copyright is written into it. + +* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. + + Usage describes the basic command line interface and its options. + +* ``--help-full [file]``: Print full help and exit. + + Full help displays most of the documentation provided by the UNIX + man page. It is provided for use on non-UNIX platforms, but is also + convenient if the man page is not installed. If a file is + specified, the help is written into it. + +* ``--help-html [file]``: Print full help in HTML format. + + This option is used by CMake authors to help produce web pages. If + a file is specified, the help is written into it. + +* ``--help-man [file]``: Print full help as a UNIX man page and exit. + + This option is used by the cmake build to generate the UNIX man + page. If a file is specified, the help is written into it. + +* ``--version,-version,/V [file]``: Show program name/version banner and exit. + + If a file is specified, the version is written into it. +The following generators are available on this platform: + +:: + + CMake Properties - Properties supported by CMake, the Cross-Platform Makefile Generator. + +This is the documentation for the properties supported by CMake. +Properties can have different scopes. They can either be assigned to +a source file, a directory, a target or globally to CMake. By +modifying the values of properties the behaviour of the build system +can be customized. + +:: + + CMake Compatibility Listfile Commands - Obsolete commands supported by CMake for compatibility. + +This is the documentation for now obsolete listfile commands from +previous CMake versions, which are still supported for compatibility +reasons. You should instead use the newer, faster and shinier new +commands. ;-) + +The following modules are provided with CMake. They can be used with +INCLUDE(ModuleName). + +:: + + CMake Modules - Modules coming with CMake, the Cross-Platform Makefile Generator. + +This is the documentation for the modules and scripts coming with +CMake. Using these modules you can check the computer system for +installed software packages, features of the compiler and the +existence of headers to name just a few. + +variables defined by cmake, that give information about the project, +and cmake + +Copyright 2000-2012 Kitware, Inc., Insight Software Consortium. All +rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +Redistributions of source code must retain the above copyright notice, +this list of conditions and the following disclaimer. + +Redistributions in binary form must reproduce the above copyright +notice, this list of conditions and the following disclaimer in the +documentation and/or other materials provided with the distribution. + +Neither the names of Kitware, Inc., the Insight Software Consortium, +nor the names of their contributors may be used to endorse or promote +products derived from this software without specific prior written +permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +The following resources are available to get help using CMake: + + +* ``Home Page``: http://www.cmake.org + + The primary starting point for learning about CMake. + +* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ + + A Wiki is provided containing answers to frequently asked questions. + +* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html + + Links to available documentation may be found on this web page. + +* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html + + For help and discussion about using cmake, a mailing list is + provided at cmake@cmake.org. The list is member-post-only but one + may sign up on the CMake web page. Please first read the full + documentation at http://www.cmake.org before posting questions to + the list. diff --git a/Help/manual/cpack.1.rst b/Help/manual/cpack.1.rst new file mode 100644 index 0000000..d9f46f4 --- /dev/null +++ b/Help/manual/cpack.1.rst @@ -0,0 +1,210 @@ +cpack(1) +******** + +:: + + cpack - Packaging driver provided by CMake. + +:: + + cpack -G <generator> [options] + +The "cpack" executable is the CMake packaging program. +CMake-generated build trees created for projects that use the +INSTALL_* commands have packaging support. This program will generate +the package. + +CMake is a cross-platform build system generator. Projects specify +their build process with platform-independent CMake listfiles included +in each directory of a source tree with the name CMakeLists.txt. +Users build a project by using CMake to generate a build system for a +native tool on their platform. + + +* ``-G <generator>``: Use the specified generator to generate package. + + CPack may support multiple native packaging systems on certain + platforms. A generator is responsible for generating input files + for particular system and invoking that systems. Possible generator + names are specified in the Generators section. + +* ``-C <Configuration>``: Specify the project configuration + + This option specifies the configuration that the project was build + with, for example 'Debug', 'Release'. + +* ``-D <var>=<value>``: Set a CPack variable. + + Set a variable that can be used by the generator. + +* ``--config <config file>``: Specify the config file. + + Specify the config file to use to create the package. By default + CPackConfig.cmake in the current directory will be used. + +* ``--verbose,-V``: enable verbose output + + Run cpack with verbose output. + +* ``--debug``: enable debug output (for CPack developers) + + Run cpack with debug output (for CPack developers). + +* ``-P <package name>``: override/define CPACK_PACKAGE_NAME + + If the package name is not specified on cpack commmand line + thenCPack.cmake defines it as CMAKE_PROJECT_NAME + +* ``-R <package version>``: override/define CPACK_PACKAGE_VERSION + + If version is not specified on cpack command line thenCPack.cmake + defines it from CPACK_PACKAGE_VERSION_[MAJOR|MINOR|PATCH]look into + CPack.cmake for detail + +* ``-B <package directory>``: override/define CPACK_PACKAGE_DIRECTORY + + The directory where CPack will be doing its packaging work.The + resulting package will be found there. Inside this directoryCPack + creates '_CPack_Packages' sub-directory which is theCPack temporary + directory. + +* ``--vendor <vendor name>``: override/define CPACK_PACKAGE_VENDOR + + If vendor is not specified on cpack command line (or inside + CMakeLists.txt) thenCPack.cmake defines it with a default value + +* ``--help-command cmd [file]``: Print help for a single command and exit. + + Full documentation specific to the given command is displayed. If a + file is specified, the documentation is written into and the output + format is determined depending on the filename suffix. Supported + are man page, HTML, DocBook and plain text. + +* ``--help-command-list [file]``: List available commands and exit. + + The list contains all commands for which help may be obtained by + using the --help-command argument followed by a command name. If a + file is specified, the documentation is written into and the output + format is determined depending on the filename suffix. Supported + are man page, HTML, DocBook and plain text. + +* ``--help-commands [file]``: Print help for all commands and exit. + + Full documentation specific for all current command is displayed.If + a file is specified, the documentation is written into and the + output format is determined depending on the filename suffix. + Supported are man page, HTML, DocBook and plain text. + +* ``--help-variable var [file]``: Print help for a single variable and exit. + + Full documentation specific to the given variable is displayed.If a + file is specified, the documentation is written into and the output + format is determined depending on the filename suffix. Supported + are man page, HTML, DocBook and plain text. + +* ``--help-variable-list [file]``: List documented variables and exit. + + The list contains all variables for which help may be obtained by + using the --help-variable argument followed by a variable name. If + a file is specified, the help is written into it.If a file is + specified, the documentation is written into and the output format + is determined depending on the filename suffix. Supported are man + page, HTML, DocBook and plain text. + +* ``--help-variables [file]``: Print help for all variables and exit. + + Full documentation for all variables is displayed.If a file is + specified, the documentation is written into and the output format + is determined depending on the filename suffix. Supported are man + page, HTML, DocBook and plain text. + +* ``--copyright [file]``: Print the CMake copyright and exit. + + If a file is specified, the copyright is written into it. + +* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. + + Usage describes the basic command line interface and its options. + +* ``--help-full [file]``: Print full help and exit. + + Full help displays most of the documentation provided by the UNIX + man page. It is provided for use on non-UNIX platforms, but is also + convenient if the man page is not installed. If a file is + specified, the help is written into it. + +* ``--help-html [file]``: Print full help in HTML format. + + This option is used by CMake authors to help produce web pages. If + a file is specified, the help is written into it. + +* ``--help-man [file]``: Print full help as a UNIX man page and exit. + + This option is used by the cmake build to generate the UNIX man + page. If a file is specified, the help is written into it. + +* ``--version,-version,/V [file]``: Show program name/version banner and exit. + + If a file is specified, the version is written into it. +:: + + CMake Compatibility Listfile Commands - Obsolete commands supported by CMake for compatibility. + +This is the documentation for now obsolete listfile commands from +previous CMake versions, which are still supported for compatibility +reasons. You should instead use the newer, faster and shinier new +commands. ;-) + +Copyright 2000-2012 Kitware, Inc., Insight Software Consortium. All +rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +Redistributions of source code must retain the above copyright notice, +this list of conditions and the following disclaimer. + +Redistributions in binary form must reproduce the above copyright +notice, this list of conditions and the following disclaimer in the +documentation and/or other materials provided with the distribution. + +Neither the names of Kitware, Inc., the Insight Software Consortium, +nor the names of their contributors may be used to endorse or promote +products derived from this software without specific prior written +permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +The following resources are available to get help using CMake: + + +* ``Home Page``: http://www.cmake.org + + The primary starting point for learning about CMake. + +* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ + + A Wiki is provided containing answers to frequently asked questions. + +* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html + + Links to available documentation may be found on this web page. + +* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html + + For help and discussion about using cmake, a mailing list is + provided at cmake@cmake.org. The list is member-post-only but one + may sign up on the CMake web page. Please first read the full + documentation at http://www.cmake.org before posting questions to + the list. diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst new file mode 100644 index 0000000..82a8396 --- /dev/null +++ b/Help/manual/ctest.1.rst @@ -0,0 +1,419 @@ +ctest(1) +******** + +:: + + ctest - Testing driver provided by CMake. + +:: + + ctest [options] + +The "ctest" executable is the CMake test driver program. +CMake-generated build trees created for projects that use the +ENABLE_TESTING and ADD_TEST commands have testing support. This +program will run the tests and report results. + + +* ``-C <cfg>, --build-config <cfg>``: Choose configuration to test. + + Some CMake-generated build trees can have multiple build + configurations in the same tree. This option can be used to specify + which one should be tested. Example configurations are "Debug" and + "Release". + +* ``-V,--verbose``: Enable verbose output from tests. + + Test output is normally suppressed and only summary information is + displayed. This option will show all test output. + +* ``-VV,--extra-verbose``: Enable more verbose output from tests. + + Test output is normally suppressed and only summary information is + displayed. This option will show even more test output. + +* ``--debug``: Displaying more verbose internals of CTest. + + This feature will result in a large number of output that is mostly + useful for debugging dashboard problems. + +* ``--output-on-failure``: Output anything outputted by the test program if the test should fail. This option can also be enabled by setting the environment variable CTEST_OUTPUT_ON_FAILURE + +* ``-F``: Enable failover. + + This option allows ctest to resume a test set execution that was + previously interrupted. If no interruption occurred, the -F option + will have no effect. + +* ``-j <jobs>, --parallel <jobs>``: Run the tests in parallel using thegiven number of jobs. + + This option tells ctest to run the tests in parallel using given + number of jobs. This option can also be set by setting the + environment variable CTEST_PARALLEL_LEVEL. + +* ``-Q,--quiet``: Make ctest quiet. + + This option will suppress all the output. The output log file will + still be generated if the --output-log is specified. Options such + as --verbose, --extra-verbose, and --debug are ignored if --quiet is + specified. + +* ``-O <file>, --output-log <file>``: Output to log file + + This option tells ctest to write all its output to a log file. + +* ``-N,--show-only``: Disable actual execution of tests. + + This option tells ctest to list the tests that would be run but not + actually run them. Useful in conjunction with the -R and -E + options. + +* ``-L <regex>, --label-regex <regex>``: Run tests with labels matching regular expression. + + This option tells ctest to run only the tests whose labels match the + given regular expression. + +* ``-R <regex>, --tests-regex <regex>``: Run tests matching regular expression. + + This option tells ctest to run only the tests whose names match the + given regular expression. + +* ``-E <regex>, --exclude-regex <regex>``: Exclude tests matching regular expression. + + This option tells ctest to NOT run the tests whose names match the + given regular expression. + +* ``-LE <regex>, --label-exclude <regex>``: Exclude tests with labels matching regular expression. + + This option tells ctest to NOT run the tests whose labels match the + given regular expression. + +* ``-D <dashboard>, --dashboard <dashboard>``: Execute dashboard test + + This option tells ctest to act as a Dart client and perform a + dashboard test. All tests are <Mode><Test>, where Mode can be + Experimental, Nightly, and Continuous, and Test can be Start, + Update, Configure, Build, Test, Coverage, and Submit. + +* ``-D <var>:<type>=<value>``: Define a variable for script mode + + Pass in variable values on the command line. Use in conjunction + with -S to pass variable values to a dashboard script. Parsing -D + arguments as variable values is only attempted if the value + following -D does not match any of the known dashboard types. + +* ``-M <model>, --test-model <model>``: Sets the model for a dashboard + + This option tells ctest to act as a Dart client where the TestModel + can be Experimental, Nightly, and Continuous. Combining -M and -T + is similar to -D + +* ``-T <action>, --test-action <action>``: Sets the dashboard action to perform + + This option tells ctest to act as a Dart client and perform some + action such as start, build, test etc. Combining -M and -T is + similar to -D + +* ``--track <track>``: Specify the track to submit dashboard to + + Submit dashboard to specified track instead of default one. By + default, the dashboard is submitted to Nightly, Experimental, or + Continuous track, but by specifying this option, the track can be + arbitrary. + +* ``-S <script>, --script <script>``: Execute a dashboard for a configuration + + This option tells ctest to load in a configuration script which sets + a number of parameters such as the binary and source directories. + Then ctest will do what is required to create and run a dashboard. + This option basically sets up a dashboard and then runs ctest -D + with the appropriate options. + +* ``-SP <script>, --script-new-process <script>``: Execute a dashboard for a configuration + + This option does the same operations as -S but it will do them in a + separate process. This is primarily useful in cases where the + script may modify the environment and you do not want the modified + environment to impact other -S scripts. + +* ``-A <file>, --add-notes <file>``: Add a notes file with submission + + This option tells ctest to include a notes file when submitting + dashboard. + +* ``-I [Start,End,Stride,test#,test#|Test file], --tests-information``: Run a specific number of tests by number. + + This option causes ctest to run tests starting at number Start, + ending at number End, and incrementing by Stride. Any additional + numbers after Stride are considered individual test numbers. Start, + End,or stride can be empty. Optionally a file can be given that + contains the same syntax as the command line. + +* ``-U, --union``: Take the Union of -I and -R + + When both -R and -I are specified by default the intersection of + tests are run. By specifying -U the union of tests is run instead. + +* ``--rerun-failed``: Run only the tests that failed previously + + This option tells ctest to perform only the tests that failed during + its previous run. When this option is specified, ctest ignores all + other options intended to modify the list of tests to run (-L, -R, + -E, -LE, -I, etc). In the event that CTest runs and no tests fail, + subsequent calls to ctest with the --rerun-failed option will run + the set of tests that most recently failed (if any). + +* ``--max-width <width>``: Set the max width for a test name to output + + Set the maximum width for each test name to show in the output. + This allows the user to widen the output to avoid clipping the test + name which can be very annoying. + +* ``--interactive-debug-mode [0|1]``: Set the interactive mode to 0 or 1. + + This option causes ctest to run tests in either an interactive mode + or a non-interactive mode. On Windows this means that in + non-interactive mode, all system debug pop up windows are blocked. + In dashboard mode (Experimental, Nightly, Continuous), the default + is non-interactive. When just running tests not for a dashboard the + default is to allow popups and interactive debugging. + +* ``--no-label-summary``: Disable timing summary information for labels. + + This option tells ctest not to print summary information for each + label associated with the tests run. If there are no labels on the + tests, nothing extra is printed. + +* ``--build-and-test``: Configure, build and run a test. + + This option tells ctest to configure (i.e. run cmake on), build, + and or execute a test. The configure and test steps are optional. + The arguments to this command line are the source and binary + directories. By default this will run CMake on the Source/Bin + directories specified unless --build-nocmake is specified. Both + --build-makeprogram and --build-generator MUST be provided to use + --build-and-test. If --test-command is specified then that will be + run after the build is complete. Other options that affect this + mode are --build-target --build-nocmake, --build-run-dir, + --build-two-config, --build-exe-dir, + --build-project,--build-noclean, --build-options + +* ``--build-target``: Specify a specific target to build. + + This option goes with the --build-and-test option, if left out the + all target is built. + +* ``--build-nocmake``: Run the build without running cmake first. + + Skip the cmake step. + +* ``--build-run-dir``: Specify directory to run programs from. + + Directory where programs will be after it has been compiled. + +* ``--build-two-config``: Run CMake twice + +* ``--build-exe-dir``: Specify the directory for the executable. + +* ``--build-generator``: Specify the generator to use. + +* ``--build-generator-toolset``: Specify the generator-specific toolset. + +* ``--build-project``: Specify the name of the project to build. + +* ``--build-makeprogram``: Specify the make program to use. + +* ``--build-noclean``: Skip the make clean step. + +* ``--build-config-sample``: A sample executable to use to determine the configuration + + A sample executable to use to determine the configuration that + should be used. e.g. Debug/Release/etc + +* ``--build-options``: Add extra options to the build step. + + This option must be the last option with the exception of + --test-command + +* ``--test-command``: The test to run with the --build-and-test option. + +* ``--test-timeout``: The time limit in seconds, internal use only. + +* ``--tomorrow-tag``: Nightly or experimental starts with next day tag. + + This is useful if the build will not finish in one day. + +* ``--ctest-config``: The configuration file used to initialize CTest state when submitting dashboards. + + This option tells CTest to use different initialization file instead + of CTestConfiguration.tcl. This way multiple initialization files + can be used for example to submit to multiple dashboards. + +* ``--overwrite``: Overwrite CTest configuration option. + + By default ctest uses configuration options from configuration file. + This option will overwrite the configuration option. + +* ``--extra-submit <file>[;<file>]``: Submit extra files to the dashboard. + + This option will submit extra files to the dashboard. + +* ``--force-new-ctest-process``: Run child CTest instances as new processes + + By default CTest will run child CTest instances within the same + process. If this behavior is not desired, this argument will + enforce new processes for child CTest processes. + +* ``--schedule-random``: Use a random order for scheduling tests + + This option will run the tests in a random order. It is commonly + used to detect implicit dependencies in a test suite. + +* ``--submit-index``: Submit individual dashboard tests with specific index + + This option allows performing the same CTest action (such as test) + multiple times and submit all stages to the same dashboard (Dart2 + required). Each execution requires different index. + +* ``--timeout <seconds>``: Set a global timeout on all tests. + + This option will set a global timeout on all tests that do not + already have a timeout set on them. + +* ``--stop-time <time>``: Set a time at which all tests should stop running. + + Set a real time of day at which all tests should timeout. Example: + 7:00:00 -0400. Any time format understood by the curl date parser + is accepted. Local time is assumed if no timezone is specified. + +* ``--http1.0``: Submit using HTTP 1.0. + + This option will force CTest to use HTTP 1.0 to submit files to the + dashboard, instead of HTTP 1.1. + +* ``--no-compress-output``: Do not compress test output when submitting. + + This flag will turn off automatic compression of test output. Use + this to maintain compatibility with an older version of CDash which + doesn't support compressed test output. + +* ``--print-labels``: Print all available test labels. + + This option will not run any tests, it will simply print the list of + all labels associated with the test set. + +* ``--help-command <cmd> [<file>]``: Show help for a single command and exit. + + Prints the help for the command to stdout or to the specified file. + +* ``--help-command-list [<file>]``: List available commands and exit. + + Prints the list of all available listfile commands to stdout or the + specified file. + +* ``--help-commands [<file>]``: Print help for all commands and exit. + + Prints the help for all commands to stdout or to the specified file. + +* ``--copyright [file]``: Print the CMake copyright and exit. + + If a file is specified, the copyright is written into it. + +* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. + + Usage describes the basic command line interface and its options. + +* ``--help-full [file]``: Print full help and exit. + + Full help displays most of the documentation provided by the UNIX + man page. It is provided for use on non-UNIX platforms, but is also + convenient if the man page is not installed. If a file is + specified, the help is written into it. + +* ``--help-html [file]``: Print full help in HTML format. + + This option is used by CMake authors to help produce web pages. If + a file is specified, the help is written into it. + +* ``--help-man [file]``: Print full help as a UNIX man page and exit. + + This option is used by the cmake build to generate the UNIX man + page. If a file is specified, the help is written into it. + +* ``--version,-version,/V [file]``: Show program name/version banner and exit. + + If a file is specified, the version is written into it. +The following generators are available on this platform: + +:: + + CMake Properties - Properties supported by CMake, the Cross-Platform Makefile Generator. + +This is the documentation for the properties supported by CMake. +Properties can have different scopes. They can either be assigned to +a source file, a directory, a target or globally to CMake. By +modifying the values of properties the behaviour of the build system +can be customized. + +:: + + CMake Compatibility Listfile Commands - Obsolete commands supported by CMake for compatibility. + +This is the documentation for now obsolete listfile commands from +previous CMake versions, which are still supported for compatibility +reasons. You should instead use the newer, faster and shinier new +commands. ;-) + +Copyright 2000-2012 Kitware, Inc., Insight Software Consortium. All +rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +Redistributions of source code must retain the above copyright notice, +this list of conditions and the following disclaimer. + +Redistributions in binary form must reproduce the above copyright +notice, this list of conditions and the following disclaimer in the +documentation and/or other materials provided with the distribution. + +Neither the names of Kitware, Inc., the Insight Software Consortium, +nor the names of their contributors may be used to endorse or promote +products derived from this software without specific prior written +permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +The following resources are available to get help using CMake: + + +* ``Home Page``: http://www.cmake.org + + The primary starting point for learning about CMake. + +* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ + + A Wiki is provided containing answers to frequently asked questions. + +* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html + + Links to available documentation may be found on this web page. + +* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html + + For help and discussion about using cmake, a mailing list is + provided at cmake@cmake.org. The list is member-post-only but one + may sign up on the CMake web page. Please first read the full + documentation at http://www.cmake.org before posting questions to + the list. diff --git a/Help/module/AddFileDependencies.rst b/Help/module/AddFileDependencies.rst new file mode 100644 index 0000000..3cbce33 --- /dev/null +++ b/Help/module/AddFileDependencies.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/AddFileDependencies.cmake diff --git a/Help/module/BundleUtilities.rst b/Help/module/BundleUtilities.rst new file mode 100644 index 0000000..5d9c840 --- /dev/null +++ b/Help/module/BundleUtilities.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/BundleUtilities.cmake diff --git a/Help/module/CMakeAddFortranSubdirectory.rst b/Help/module/CMakeAddFortranSubdirectory.rst new file mode 100644 index 0000000..9abf571 --- /dev/null +++ b/Help/module/CMakeAddFortranSubdirectory.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeAddFortranSubdirectory.cmake diff --git a/Help/module/CMakeBackwardCompatibilityCXX.rst b/Help/module/CMakeBackwardCompatibilityCXX.rst new file mode 100644 index 0000000..05e5f4a --- /dev/null +++ b/Help/module/CMakeBackwardCompatibilityCXX.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeBackwardCompatibilityCXX.cmake diff --git a/Help/module/CMakeDependentOption.rst b/Help/module/CMakeDependentOption.rst new file mode 100644 index 0000000..fd071b5 --- /dev/null +++ b/Help/module/CMakeDependentOption.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeDependentOption.cmake diff --git a/Help/module/CMakeDetermineVSServicePack.rst b/Help/module/CMakeDetermineVSServicePack.rst new file mode 100644 index 0000000..1768533 --- /dev/null +++ b/Help/module/CMakeDetermineVSServicePack.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeDetermineVSServicePack.cmake diff --git a/Help/module/CMakeExpandImportedTargets.rst b/Help/module/CMakeExpandImportedTargets.rst new file mode 100644 index 0000000..1084280 --- /dev/null +++ b/Help/module/CMakeExpandImportedTargets.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeExpandImportedTargets.cmake diff --git a/Help/module/CMakeFindFrameworks.rst b/Help/module/CMakeFindFrameworks.rst new file mode 100644 index 0000000..c2c219b --- /dev/null +++ b/Help/module/CMakeFindFrameworks.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeFindFrameworks.cmake diff --git a/Help/module/CMakeFindPackageMode.rst b/Help/module/CMakeFindPackageMode.rst new file mode 100644 index 0000000..d099d19 --- /dev/null +++ b/Help/module/CMakeFindPackageMode.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeFindPackageMode.cmake diff --git a/Help/module/CMakeForceCompiler.rst b/Help/module/CMakeForceCompiler.rst new file mode 100644 index 0000000..3277426 --- /dev/null +++ b/Help/module/CMakeForceCompiler.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeForceCompiler.cmake diff --git a/Help/module/CMakeGraphVizOptions.rst b/Help/module/CMakeGraphVizOptions.rst new file mode 100644 index 0000000..2cd97b3 --- /dev/null +++ b/Help/module/CMakeGraphVizOptions.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeGraphVizOptions.cmake diff --git a/Help/module/CMakePackageConfigHelpers.rst b/Help/module/CMakePackageConfigHelpers.rst new file mode 100644 index 0000000..a291aff --- /dev/null +++ b/Help/module/CMakePackageConfigHelpers.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakePackageConfigHelpers.cmake diff --git a/Help/module/CMakeParseArguments.rst b/Help/module/CMakeParseArguments.rst new file mode 100644 index 0000000..810a9dd --- /dev/null +++ b/Help/module/CMakeParseArguments.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeParseArguments.cmake diff --git a/Help/module/CMakePrintHelpers.rst b/Help/module/CMakePrintHelpers.rst new file mode 100644 index 0000000..a75a34f --- /dev/null +++ b/Help/module/CMakePrintHelpers.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakePrintHelpers.cmake diff --git a/Help/module/CMakePrintSystemInformation.rst b/Help/module/CMakePrintSystemInformation.rst new file mode 100644 index 0000000..0b5d848 --- /dev/null +++ b/Help/module/CMakePrintSystemInformation.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakePrintSystemInformation.cmake diff --git a/Help/module/CMakePushCheckState.rst b/Help/module/CMakePushCheckState.rst new file mode 100644 index 0000000..e897929 --- /dev/null +++ b/Help/module/CMakePushCheckState.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakePushCheckState.cmake diff --git a/Help/module/CMakeVerifyManifest.rst b/Help/module/CMakeVerifyManifest.rst new file mode 100644 index 0000000..eeff1bf --- /dev/null +++ b/Help/module/CMakeVerifyManifest.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeVerifyManifest.cmake diff --git a/Help/module/CPack.rst b/Help/module/CPack.rst new file mode 100644 index 0000000..bfbda1f --- /dev/null +++ b/Help/module/CPack.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPack.cmake diff --git a/Help/module/CPackBundle.rst b/Help/module/CPackBundle.rst new file mode 100644 index 0000000..651e874 --- /dev/null +++ b/Help/module/CPackBundle.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackBundle.cmake diff --git a/Help/module/CPackComponent.rst b/Help/module/CPackComponent.rst new file mode 100644 index 0000000..df82836 --- /dev/null +++ b/Help/module/CPackComponent.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackComponent.cmake diff --git a/Help/module/CPackCygwin.rst b/Help/module/CPackCygwin.rst new file mode 100644 index 0000000..21f4473 --- /dev/null +++ b/Help/module/CPackCygwin.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackCygwin.cmake diff --git a/Help/module/CPackDMG.rst b/Help/module/CPackDMG.rst new file mode 100644 index 0000000..784262c --- /dev/null +++ b/Help/module/CPackDMG.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackDMG.cmake diff --git a/Help/module/CPackDeb.rst b/Help/module/CPackDeb.rst new file mode 100644 index 0000000..d1526ee --- /dev/null +++ b/Help/module/CPackDeb.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackDeb.cmake diff --git a/Help/module/CPackNSIS.rst b/Help/module/CPackNSIS.rst new file mode 100644 index 0000000..bb35ed6 --- /dev/null +++ b/Help/module/CPackNSIS.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackNSIS.cmake diff --git a/Help/module/CPackPackageMaker.rst b/Help/module/CPackPackageMaker.rst new file mode 100644 index 0000000..de55448 --- /dev/null +++ b/Help/module/CPackPackageMaker.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackPackageMaker.cmake diff --git a/Help/module/CPackRPM.rst b/Help/module/CPackRPM.rst new file mode 100644 index 0000000..28d0e69 --- /dev/null +++ b/Help/module/CPackRPM.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackRPM.cmake diff --git a/Help/module/CPackWIX.rst b/Help/module/CPackWIX.rst new file mode 100644 index 0000000..1f5e451 --- /dev/null +++ b/Help/module/CPackWIX.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackWIX.cmake diff --git a/Help/module/CTest.rst b/Help/module/CTest.rst new file mode 100644 index 0000000..11a6af7 --- /dev/null +++ b/Help/module/CTest.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CTest.cmake diff --git a/Help/module/CTestScriptMode.rst b/Help/module/CTestScriptMode.rst new file mode 100644 index 0000000..be1b044 --- /dev/null +++ b/Help/module/CTestScriptMode.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CTestScriptMode.cmake diff --git a/Help/module/CTestUseLaunchers.rst b/Help/module/CTestUseLaunchers.rst new file mode 100644 index 0000000..688da08 --- /dev/null +++ b/Help/module/CTestUseLaunchers.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CTestUseLaunchers.cmake diff --git a/Help/module/CheckCCompilerFlag.rst b/Help/module/CheckCCompilerFlag.rst new file mode 100644 index 0000000..1be1491 --- /dev/null +++ b/Help/module/CheckCCompilerFlag.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCCompilerFlag.cmake diff --git a/Help/module/CheckCSourceCompiles.rst b/Help/module/CheckCSourceCompiles.rst new file mode 100644 index 0000000..1fa02f9 --- /dev/null +++ b/Help/module/CheckCSourceCompiles.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCSourceCompiles.cmake diff --git a/Help/module/CheckCSourceRuns.rst b/Help/module/CheckCSourceRuns.rst new file mode 100644 index 0000000..16b47e6 --- /dev/null +++ b/Help/module/CheckCSourceRuns.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCSourceRuns.cmake diff --git a/Help/module/CheckCXXCompilerFlag.rst b/Help/module/CheckCXXCompilerFlag.rst new file mode 100644 index 0000000..cfd1f45 --- /dev/null +++ b/Help/module/CheckCXXCompilerFlag.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCXXCompilerFlag.cmake diff --git a/Help/module/CheckCXXSourceCompiles.rst b/Help/module/CheckCXXSourceCompiles.rst new file mode 100644 index 0000000..d701c4e --- /dev/null +++ b/Help/module/CheckCXXSourceCompiles.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCXXSourceCompiles.cmake diff --git a/Help/module/CheckCXXSourceRuns.rst b/Help/module/CheckCXXSourceRuns.rst new file mode 100644 index 0000000..caab975 --- /dev/null +++ b/Help/module/CheckCXXSourceRuns.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCXXSourceRuns.cmake diff --git a/Help/module/CheckCXXSymbolExists.rst b/Help/module/CheckCXXSymbolExists.rst new file mode 100644 index 0000000..fc192e8 --- /dev/null +++ b/Help/module/CheckCXXSymbolExists.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCXXSymbolExists.cmake diff --git a/Help/module/CheckFortranFunctionExists.rst b/Help/module/CheckFortranFunctionExists.rst new file mode 100644 index 0000000..3395d05 --- /dev/null +++ b/Help/module/CheckFortranFunctionExists.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckFortranFunctionExists.cmake diff --git a/Help/module/CheckFunctionExists.rst b/Help/module/CheckFunctionExists.rst new file mode 100644 index 0000000..ed89dc4 --- /dev/null +++ b/Help/module/CheckFunctionExists.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckFunctionExists.cmake diff --git a/Help/module/CheckIncludeFile.rst b/Help/module/CheckIncludeFile.rst new file mode 100644 index 0000000..6b83108 --- /dev/null +++ b/Help/module/CheckIncludeFile.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckIncludeFile.cmake diff --git a/Help/module/CheckIncludeFileCXX.rst b/Help/module/CheckIncludeFileCXX.rst new file mode 100644 index 0000000..fdbf39f --- /dev/null +++ b/Help/module/CheckIncludeFileCXX.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckIncludeFileCXX.cmake diff --git a/Help/module/CheckIncludeFiles.rst b/Help/module/CheckIncludeFiles.rst new file mode 100644 index 0000000..b56f145 --- /dev/null +++ b/Help/module/CheckIncludeFiles.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckIncludeFiles.cmake diff --git a/Help/module/CheckLanguage.rst b/Help/module/CheckLanguage.rst new file mode 100644 index 0000000..16f1a3f --- /dev/null +++ b/Help/module/CheckLanguage.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckLanguage.cmake diff --git a/Help/module/CheckLibraryExists.rst b/Help/module/CheckLibraryExists.rst new file mode 100644 index 0000000..7512f46 --- /dev/null +++ b/Help/module/CheckLibraryExists.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckLibraryExists.cmake diff --git a/Help/module/CheckPrototypeDefinition.rst b/Help/module/CheckPrototypeDefinition.rst new file mode 100644 index 0000000..073fcb5 --- /dev/null +++ b/Help/module/CheckPrototypeDefinition.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckPrototypeDefinition.cmake diff --git a/Help/module/CheckStructHasMember.rst b/Help/module/CheckStructHasMember.rst new file mode 100644 index 0000000..5277ad2 --- /dev/null +++ b/Help/module/CheckStructHasMember.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckStructHasMember.cmake diff --git a/Help/module/CheckSymbolExists.rst b/Help/module/CheckSymbolExists.rst new file mode 100644 index 0000000..68ae700 --- /dev/null +++ b/Help/module/CheckSymbolExists.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckSymbolExists.cmake diff --git a/Help/module/CheckTypeSize.rst b/Help/module/CheckTypeSize.rst new file mode 100644 index 0000000..6ad0345 --- /dev/null +++ b/Help/module/CheckTypeSize.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckTypeSize.cmake diff --git a/Help/module/CheckVariableExists.rst b/Help/module/CheckVariableExists.rst new file mode 100644 index 0000000..07f0777 --- /dev/null +++ b/Help/module/CheckVariableExists.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckVariableExists.cmake diff --git a/Help/module/Dart.rst b/Help/module/Dart.rst new file mode 100644 index 0000000..524ac33 --- /dev/null +++ b/Help/module/Dart.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Dart.cmake diff --git a/Help/module/DeployQt4.rst b/Help/module/DeployQt4.rst new file mode 100644 index 0000000..3c0ef44 --- /dev/null +++ b/Help/module/DeployQt4.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/DeployQt4.cmake diff --git a/Help/module/Documentation.rst b/Help/module/Documentation.rst new file mode 100644 index 0000000..08e2ffb --- /dev/null +++ b/Help/module/Documentation.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Documentation.cmake diff --git a/Help/module/ExternalData.rst b/Help/module/ExternalData.rst new file mode 100644 index 0000000..f0f8f1d --- /dev/null +++ b/Help/module/ExternalData.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/ExternalData.cmake diff --git a/Help/module/ExternalProject.rst b/Help/module/ExternalProject.rst new file mode 100644 index 0000000..fce7056 --- /dev/null +++ b/Help/module/ExternalProject.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/ExternalProject.cmake diff --git a/Help/module/FeatureSummary.rst b/Help/module/FeatureSummary.rst new file mode 100644 index 0000000..6fd8f38 --- /dev/null +++ b/Help/module/FeatureSummary.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FeatureSummary.cmake diff --git a/Help/module/FindALSA.rst b/Help/module/FindALSA.rst new file mode 100644 index 0000000..2a73786 --- /dev/null +++ b/Help/module/FindALSA.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindALSA.cmake diff --git a/Help/module/FindASPELL.rst b/Help/module/FindASPELL.rst new file mode 100644 index 0000000..56dedc4 --- /dev/null +++ b/Help/module/FindASPELL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindASPELL.cmake diff --git a/Help/module/FindAVIFile.rst b/Help/module/FindAVIFile.rst new file mode 100644 index 0000000..71282a6 --- /dev/null +++ b/Help/module/FindAVIFile.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindAVIFile.cmake diff --git a/Help/module/FindArmadillo.rst b/Help/module/FindArmadillo.rst new file mode 100644 index 0000000..f0ac933 --- /dev/null +++ b/Help/module/FindArmadillo.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindArmadillo.cmake diff --git a/Help/module/FindBISON.rst b/Help/module/FindBISON.rst new file mode 100644 index 0000000..c6e5791 --- /dev/null +++ b/Help/module/FindBISON.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindBISON.cmake diff --git a/Help/module/FindBLAS.rst b/Help/module/FindBLAS.rst new file mode 100644 index 0000000..41f6771 --- /dev/null +++ b/Help/module/FindBLAS.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindBLAS.cmake diff --git a/Help/module/FindBZip2.rst b/Help/module/FindBZip2.rst new file mode 100644 index 0000000..281b1d1 --- /dev/null +++ b/Help/module/FindBZip2.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindBZip2.cmake diff --git a/Help/module/FindBoost.rst b/Help/module/FindBoost.rst new file mode 100644 index 0000000..1392540 --- /dev/null +++ b/Help/module/FindBoost.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindBoost.cmake diff --git a/Help/module/FindBullet.rst b/Help/module/FindBullet.rst new file mode 100644 index 0000000..4ed2b85 --- /dev/null +++ b/Help/module/FindBullet.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindBullet.cmake diff --git a/Help/module/FindCABLE.rst b/Help/module/FindCABLE.rst new file mode 100644 index 0000000..716d5ab --- /dev/null +++ b/Help/module/FindCABLE.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCABLE.cmake diff --git a/Help/module/FindCUDA.rst b/Help/module/FindCUDA.rst new file mode 100644 index 0000000..46ffa9f --- /dev/null +++ b/Help/module/FindCUDA.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCUDA.cmake diff --git a/Help/module/FindCURL.rst b/Help/module/FindCURL.rst new file mode 100644 index 0000000..e2acc49 --- /dev/null +++ b/Help/module/FindCURL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCURL.cmake diff --git a/Help/module/FindCVS.rst b/Help/module/FindCVS.rst new file mode 100644 index 0000000..c891c07 --- /dev/null +++ b/Help/module/FindCVS.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCVS.cmake diff --git a/Help/module/FindCoin3D.rst b/Help/module/FindCoin3D.rst new file mode 100644 index 0000000..fc70a74 --- /dev/null +++ b/Help/module/FindCoin3D.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCoin3D.cmake diff --git a/Help/module/FindCups.rst b/Help/module/FindCups.rst new file mode 100644 index 0000000..10d0646 --- /dev/null +++ b/Help/module/FindCups.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCups.cmake diff --git a/Help/module/FindCurses.rst b/Help/module/FindCurses.rst new file mode 100644 index 0000000..73dd011 --- /dev/null +++ b/Help/module/FindCurses.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCurses.cmake diff --git a/Help/module/FindCxxTest.rst b/Help/module/FindCxxTest.rst new file mode 100644 index 0000000..4f17c39 --- /dev/null +++ b/Help/module/FindCxxTest.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCxxTest.cmake diff --git a/Help/module/FindCygwin.rst b/Help/module/FindCygwin.rst new file mode 100644 index 0000000..2e529dd --- /dev/null +++ b/Help/module/FindCygwin.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCygwin.cmake diff --git a/Help/module/FindDCMTK.rst b/Help/module/FindDCMTK.rst new file mode 100644 index 0000000..8437d55 --- /dev/null +++ b/Help/module/FindDCMTK.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindDCMTK.cmake diff --git a/Help/module/FindDart.rst b/Help/module/FindDart.rst new file mode 100644 index 0000000..6f21ad4 --- /dev/null +++ b/Help/module/FindDart.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindDart.cmake diff --git a/Help/module/FindDevIL.rst b/Help/module/FindDevIL.rst new file mode 100644 index 0000000..91a28dd --- /dev/null +++ b/Help/module/FindDevIL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindDevIL.cmake diff --git a/Help/module/FindDoxygen.rst b/Help/module/FindDoxygen.rst new file mode 100644 index 0000000..cffe734 --- /dev/null +++ b/Help/module/FindDoxygen.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindDoxygen.cmake diff --git a/Help/module/FindEXPAT.rst b/Help/module/FindEXPAT.rst new file mode 100644 index 0000000..5063680 --- /dev/null +++ b/Help/module/FindEXPAT.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindEXPAT.cmake diff --git a/Help/module/FindFLEX.rst b/Help/module/FindFLEX.rst new file mode 100644 index 0000000..cc90791 --- /dev/null +++ b/Help/module/FindFLEX.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindFLEX.cmake diff --git a/Help/module/FindFLTK.rst b/Help/module/FindFLTK.rst new file mode 100644 index 0000000..cc1964c --- /dev/null +++ b/Help/module/FindFLTK.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindFLTK.cmake diff --git a/Help/module/FindFLTK2.rst b/Help/module/FindFLTK2.rst new file mode 100644 index 0000000..5c2acc4 --- /dev/null +++ b/Help/module/FindFLTK2.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindFLTK2.cmake diff --git a/Help/module/FindFreetype.rst b/Help/module/FindFreetype.rst new file mode 100644 index 0000000..424c3fc --- /dev/null +++ b/Help/module/FindFreetype.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindFreetype.cmake diff --git a/Help/module/FindGCCXML.rst b/Help/module/FindGCCXML.rst new file mode 100644 index 0000000..15fd4d0 --- /dev/null +++ b/Help/module/FindGCCXML.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGCCXML.cmake diff --git a/Help/module/FindGDAL.rst b/Help/module/FindGDAL.rst new file mode 100644 index 0000000..81fcb3a --- /dev/null +++ b/Help/module/FindGDAL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGDAL.cmake diff --git a/Help/module/FindGIF.rst b/Help/module/FindGIF.rst new file mode 100644 index 0000000..03d3a75 --- /dev/null +++ b/Help/module/FindGIF.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGIF.cmake diff --git a/Help/module/FindGLEW.rst b/Help/module/FindGLEW.rst new file mode 100644 index 0000000..77755da --- /dev/null +++ b/Help/module/FindGLEW.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGLEW.cmake diff --git a/Help/module/FindGLUT.rst b/Help/module/FindGLUT.rst new file mode 100644 index 0000000..40263ee --- /dev/null +++ b/Help/module/FindGLUT.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGLUT.cmake diff --git a/Help/module/FindGTK.rst b/Help/module/FindGTK.rst new file mode 100644 index 0000000..1ce6a86 --- /dev/null +++ b/Help/module/FindGTK.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGTK.cmake diff --git a/Help/module/FindGTK2.rst b/Help/module/FindGTK2.rst new file mode 100644 index 0000000..67c1ba9 --- /dev/null +++ b/Help/module/FindGTK2.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGTK2.cmake diff --git a/Help/module/FindGTest.rst b/Help/module/FindGTest.rst new file mode 100644 index 0000000..0e3b4d7 --- /dev/null +++ b/Help/module/FindGTest.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGTest.cmake diff --git a/Help/module/FindGettext.rst b/Help/module/FindGettext.rst new file mode 100644 index 0000000..e880dc0 --- /dev/null +++ b/Help/module/FindGettext.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGettext.cmake diff --git a/Help/module/FindGit.rst b/Help/module/FindGit.rst new file mode 100644 index 0000000..dd540ef --- /dev/null +++ b/Help/module/FindGit.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGit.cmake diff --git a/Help/module/FindGnuTLS.rst b/Help/module/FindGnuTLS.rst new file mode 100644 index 0000000..de0c1d4 --- /dev/null +++ b/Help/module/FindGnuTLS.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGnuTLS.cmake diff --git a/Help/module/FindGnuplot.rst b/Help/module/FindGnuplot.rst new file mode 100644 index 0000000..93a18b6 --- /dev/null +++ b/Help/module/FindGnuplot.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGnuplot.cmake diff --git a/Help/module/FindHDF5.rst b/Help/module/FindHDF5.rst new file mode 100644 index 0000000..8ac1b8b --- /dev/null +++ b/Help/module/FindHDF5.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindHDF5.cmake diff --git a/Help/module/FindHSPELL.rst b/Help/module/FindHSPELL.rst new file mode 100644 index 0000000..c1905a2 --- /dev/null +++ b/Help/module/FindHSPELL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindHSPELL.cmake diff --git a/Help/module/FindHTMLHelp.rst b/Help/module/FindHTMLHelp.rst new file mode 100644 index 0000000..47d9c8c --- /dev/null +++ b/Help/module/FindHTMLHelp.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindHTMLHelp.cmake diff --git a/Help/module/FindHg.rst b/Help/module/FindHg.rst new file mode 100644 index 0000000..94aba6f --- /dev/null +++ b/Help/module/FindHg.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindHg.cmake diff --git a/Help/module/FindITK.rst b/Help/module/FindITK.rst new file mode 100644 index 0000000..dbfabbd --- /dev/null +++ b/Help/module/FindITK.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindITK.cmake diff --git a/Help/module/FindIcotool.rst b/Help/module/FindIcotool.rst new file mode 100644 index 0000000..c139f58 --- /dev/null +++ b/Help/module/FindIcotool.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindIcotool.cmake diff --git a/Help/module/FindImageMagick.rst b/Help/module/FindImageMagick.rst new file mode 100644 index 0000000..3a3596e --- /dev/null +++ b/Help/module/FindImageMagick.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindImageMagick.cmake diff --git a/Help/module/FindJNI.rst b/Help/module/FindJNI.rst new file mode 100644 index 0000000..b753cf8 --- /dev/null +++ b/Help/module/FindJNI.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindJNI.cmake diff --git a/Help/module/FindJPEG.rst b/Help/module/FindJPEG.rst new file mode 100644 index 0000000..8036352 --- /dev/null +++ b/Help/module/FindJPEG.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindJPEG.cmake diff --git a/Help/module/FindJasper.rst b/Help/module/FindJasper.rst new file mode 100644 index 0000000..725a87f --- /dev/null +++ b/Help/module/FindJasper.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindJasper.cmake diff --git a/Help/module/FindJava.rst b/Help/module/FindJava.rst new file mode 100644 index 0000000..39e6b6b --- /dev/null +++ b/Help/module/FindJava.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindJava.cmake diff --git a/Help/module/FindKDE3.rst b/Help/module/FindKDE3.rst new file mode 100644 index 0000000..13ac15c --- /dev/null +++ b/Help/module/FindKDE3.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindKDE3.cmake diff --git a/Help/module/FindKDE4.rst b/Help/module/FindKDE4.rst new file mode 100644 index 0000000..8b22f7f --- /dev/null +++ b/Help/module/FindKDE4.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindKDE4.cmake diff --git a/Help/module/FindLAPACK.rst b/Help/module/FindLAPACK.rst new file mode 100644 index 0000000..6e99090 --- /dev/null +++ b/Help/module/FindLAPACK.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLAPACK.cmake diff --git a/Help/module/FindLATEX.rst b/Help/module/FindLATEX.rst new file mode 100644 index 0000000..4b14c71 --- /dev/null +++ b/Help/module/FindLATEX.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLATEX.cmake diff --git a/Help/module/FindLibArchive.rst b/Help/module/FindLibArchive.rst new file mode 100644 index 0000000..c46b1d0 --- /dev/null +++ b/Help/module/FindLibArchive.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLibArchive.cmake diff --git a/Help/module/FindLibLZMA.rst b/Help/module/FindLibLZMA.rst new file mode 100644 index 0000000..8880158 --- /dev/null +++ b/Help/module/FindLibLZMA.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLibLZMA.cmake diff --git a/Help/module/FindLibXml2.rst b/Help/module/FindLibXml2.rst new file mode 100644 index 0000000..bbb3225 --- /dev/null +++ b/Help/module/FindLibXml2.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLibXml2.cmake diff --git a/Help/module/FindLibXslt.rst b/Help/module/FindLibXslt.rst new file mode 100644 index 0000000..4107170 --- /dev/null +++ b/Help/module/FindLibXslt.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLibXslt.cmake diff --git a/Help/module/FindLua.rst b/Help/module/FindLua.rst new file mode 100644 index 0000000..977e5bf --- /dev/null +++ b/Help/module/FindLua.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLua.cmake diff --git a/Help/module/FindLua50.rst b/Help/module/FindLua50.rst new file mode 100644 index 0000000..0353fc3 --- /dev/null +++ b/Help/module/FindLua50.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLua50.cmake diff --git a/Help/module/FindLua51.rst b/Help/module/FindLua51.rst new file mode 100644 index 0000000..672ff35 --- /dev/null +++ b/Help/module/FindLua51.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLua51.cmake diff --git a/Help/module/FindMFC.rst b/Help/module/FindMFC.rst new file mode 100644 index 0000000..a3226a6 --- /dev/null +++ b/Help/module/FindMFC.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindMFC.cmake diff --git a/Help/module/FindMPEG.rst b/Help/module/FindMPEG.rst new file mode 100644 index 0000000..c9ce481 --- /dev/null +++ b/Help/module/FindMPEG.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindMPEG.cmake diff --git a/Help/module/FindMPEG2.rst b/Help/module/FindMPEG2.rst new file mode 100644 index 0000000..f843c89 --- /dev/null +++ b/Help/module/FindMPEG2.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindMPEG2.cmake diff --git a/Help/module/FindMPI.rst b/Help/module/FindMPI.rst new file mode 100644 index 0000000..fad10c7 --- /dev/null +++ b/Help/module/FindMPI.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindMPI.cmake diff --git a/Help/module/FindMatlab.rst b/Help/module/FindMatlab.rst new file mode 100644 index 0000000..43f861a --- /dev/null +++ b/Help/module/FindMatlab.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindMatlab.cmake diff --git a/Help/module/FindMotif.rst b/Help/module/FindMotif.rst new file mode 100644 index 0000000..e602a50 --- /dev/null +++ b/Help/module/FindMotif.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindMotif.cmake diff --git a/Help/module/FindOpenAL.rst b/Help/module/FindOpenAL.rst new file mode 100644 index 0000000..f086556 --- /dev/null +++ b/Help/module/FindOpenAL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindOpenAL.cmake diff --git a/Help/module/FindOpenGL.rst b/Help/module/FindOpenGL.rst new file mode 100644 index 0000000..85e89bc --- /dev/null +++ b/Help/module/FindOpenGL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindOpenGL.cmake diff --git a/Help/module/FindOpenMP.rst b/Help/module/FindOpenMP.rst new file mode 100644 index 0000000..01362ab --- /dev/null +++ b/Help/module/FindOpenMP.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindOpenMP.cmake diff --git a/Help/module/FindOpenSSL.rst b/Help/module/FindOpenSSL.rst new file mode 100644 index 0000000..f622bb1 --- /dev/null +++ b/Help/module/FindOpenSSL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindOpenSSL.cmake diff --git a/Help/module/FindOpenSceneGraph.rst b/Help/module/FindOpenSceneGraph.rst new file mode 100644 index 0000000..4346492 --- /dev/null +++ b/Help/module/FindOpenSceneGraph.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindOpenSceneGraph.cmake diff --git a/Help/module/FindOpenThreads.rst b/Help/module/FindOpenThreads.rst new file mode 100644 index 0000000..bb3f0f9 --- /dev/null +++ b/Help/module/FindOpenThreads.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindOpenThreads.cmake diff --git a/Help/module/FindPHP4.rst b/Help/module/FindPHP4.rst new file mode 100644 index 0000000..1de62e8 --- /dev/null +++ b/Help/module/FindPHP4.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPHP4.cmake diff --git a/Help/module/FindPNG.rst b/Help/module/FindPNG.rst new file mode 100644 index 0000000..e6d1618 --- /dev/null +++ b/Help/module/FindPNG.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPNG.cmake diff --git a/Help/module/FindPackageHandleStandardArgs.rst b/Help/module/FindPackageHandleStandardArgs.rst new file mode 100644 index 0000000..feda7ef --- /dev/null +++ b/Help/module/FindPackageHandleStandardArgs.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPackageHandleStandardArgs.cmake diff --git a/Help/module/FindPackageMessage.rst b/Help/module/FindPackageMessage.rst new file mode 100644 index 0000000..b682d8c --- /dev/null +++ b/Help/module/FindPackageMessage.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPackageMessage.cmake diff --git a/Help/module/FindPerl.rst b/Help/module/FindPerl.rst new file mode 100644 index 0000000..098f4b5 --- /dev/null +++ b/Help/module/FindPerl.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPerl.cmake diff --git a/Help/module/FindPerlLibs.rst b/Help/module/FindPerlLibs.rst new file mode 100644 index 0000000..8d8bbab --- /dev/null +++ b/Help/module/FindPerlLibs.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPerlLibs.cmake diff --git a/Help/module/FindPhysFS.rst b/Help/module/FindPhysFS.rst new file mode 100644 index 0000000..21d928b --- /dev/null +++ b/Help/module/FindPhysFS.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPhysFS.cmake diff --git a/Help/module/FindPike.rst b/Help/module/FindPike.rst new file mode 100644 index 0000000..b096ca4 --- /dev/null +++ b/Help/module/FindPike.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPike.cmake diff --git a/Help/module/FindPkgConfig.rst b/Help/module/FindPkgConfig.rst new file mode 100644 index 0000000..b8caf74 --- /dev/null +++ b/Help/module/FindPkgConfig.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPkgConfig.cmake diff --git a/Help/module/FindPostgreSQL.rst b/Help/module/FindPostgreSQL.rst new file mode 100644 index 0000000..b45c07e --- /dev/null +++ b/Help/module/FindPostgreSQL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPostgreSQL.cmake diff --git a/Help/module/FindProducer.rst b/Help/module/FindProducer.rst new file mode 100644 index 0000000..1c0c575 --- /dev/null +++ b/Help/module/FindProducer.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindProducer.cmake diff --git a/Help/module/FindProtobuf.rst b/Help/module/FindProtobuf.rst new file mode 100644 index 0000000..b978e01 --- /dev/null +++ b/Help/module/FindProtobuf.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindProtobuf.cmake diff --git a/Help/module/FindPythonInterp.rst b/Help/module/FindPythonInterp.rst new file mode 100644 index 0000000..3be2306 --- /dev/null +++ b/Help/module/FindPythonInterp.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPythonInterp.cmake diff --git a/Help/module/FindPythonLibs.rst b/Help/module/FindPythonLibs.rst new file mode 100644 index 0000000..8f0015d --- /dev/null +++ b/Help/module/FindPythonLibs.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPythonLibs.cmake diff --git a/Help/module/FindQt.rst b/Help/module/FindQt.rst new file mode 100644 index 0000000..3aa8a26 --- /dev/null +++ b/Help/module/FindQt.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindQt.cmake diff --git a/Help/module/FindQt3.rst b/Help/module/FindQt3.rst new file mode 100644 index 0000000..b933059 --- /dev/null +++ b/Help/module/FindQt3.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindQt3.cmake diff --git a/Help/module/FindQt4.rst b/Help/module/FindQt4.rst new file mode 100644 index 0000000..28036b2 --- /dev/null +++ b/Help/module/FindQt4.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindQt4.cmake diff --git a/Help/module/FindQuickTime.rst b/Help/module/FindQuickTime.rst new file mode 100644 index 0000000..735f7d2 --- /dev/null +++ b/Help/module/FindQuickTime.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindQuickTime.cmake diff --git a/Help/module/FindRTI.rst b/Help/module/FindRTI.rst new file mode 100644 index 0000000..a93ad16 --- /dev/null +++ b/Help/module/FindRTI.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindRTI.cmake diff --git a/Help/module/FindRuby.rst b/Help/module/FindRuby.rst new file mode 100644 index 0000000..a1e7922 --- /dev/null +++ b/Help/module/FindRuby.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindRuby.cmake diff --git a/Help/module/FindSDL.rst b/Help/module/FindSDL.rst new file mode 100644 index 0000000..79893c0 --- /dev/null +++ b/Help/module/FindSDL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSDL.cmake diff --git a/Help/module/FindSDL_image.rst b/Help/module/FindSDL_image.rst new file mode 100644 index 0000000..dc69d70 --- /dev/null +++ b/Help/module/FindSDL_image.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSDL_image.cmake diff --git a/Help/module/FindSDL_mixer.rst b/Help/module/FindSDL_mixer.rst new file mode 100644 index 0000000..1c9c446 --- /dev/null +++ b/Help/module/FindSDL_mixer.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSDL_mixer.cmake diff --git a/Help/module/FindSDL_net.rst b/Help/module/FindSDL_net.rst new file mode 100644 index 0000000..079d0bb --- /dev/null +++ b/Help/module/FindSDL_net.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSDL_net.cmake diff --git a/Help/module/FindSDL_sound.rst b/Help/module/FindSDL_sound.rst new file mode 100644 index 0000000..077edf7 --- /dev/null +++ b/Help/module/FindSDL_sound.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSDL_sound.cmake diff --git a/Help/module/FindSDL_ttf.rst b/Help/module/FindSDL_ttf.rst new file mode 100644 index 0000000..40c5ec4 --- /dev/null +++ b/Help/module/FindSDL_ttf.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSDL_ttf.cmake diff --git a/Help/module/FindSWIG.rst b/Help/module/FindSWIG.rst new file mode 100644 index 0000000..9b25b94 --- /dev/null +++ b/Help/module/FindSWIG.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSWIG.cmake diff --git a/Help/module/FindSelfPackers.rst b/Help/module/FindSelfPackers.rst new file mode 100644 index 0000000..5f2c689 --- /dev/null +++ b/Help/module/FindSelfPackers.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSelfPackers.cmake diff --git a/Help/module/FindSquish.rst b/Help/module/FindSquish.rst new file mode 100644 index 0000000..dc2c86d --- /dev/null +++ b/Help/module/FindSquish.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSquish.cmake diff --git a/Help/module/FindSubversion.rst b/Help/module/FindSubversion.rst new file mode 100644 index 0000000..aa15857 --- /dev/null +++ b/Help/module/FindSubversion.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSubversion.cmake diff --git a/Help/module/FindTCL.rst b/Help/module/FindTCL.rst new file mode 100644 index 0000000..cbd2035 --- /dev/null +++ b/Help/module/FindTCL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindTCL.cmake diff --git a/Help/module/FindTIFF.rst b/Help/module/FindTIFF.rst new file mode 100644 index 0000000..69f8ca5 --- /dev/null +++ b/Help/module/FindTIFF.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindTIFF.cmake diff --git a/Help/module/FindTclStub.rst b/Help/module/FindTclStub.rst new file mode 100644 index 0000000..6cc5b2d --- /dev/null +++ b/Help/module/FindTclStub.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindTclStub.cmake diff --git a/Help/module/FindTclsh.rst b/Help/module/FindTclsh.rst new file mode 100644 index 0000000..23e7d6b --- /dev/null +++ b/Help/module/FindTclsh.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindTclsh.cmake diff --git a/Help/module/FindThreads.rst b/Help/module/FindThreads.rst new file mode 100644 index 0000000..91967a7 --- /dev/null +++ b/Help/module/FindThreads.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindThreads.cmake diff --git a/Help/module/FindUnixCommands.rst b/Help/module/FindUnixCommands.rst new file mode 100644 index 0000000..9ad05ad --- /dev/null +++ b/Help/module/FindUnixCommands.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindUnixCommands.cmake diff --git a/Help/module/FindVTK.rst b/Help/module/FindVTK.rst new file mode 100644 index 0000000..f9c1efe --- /dev/null +++ b/Help/module/FindVTK.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindVTK.cmake diff --git a/Help/module/FindWget.rst b/Help/module/FindWget.rst new file mode 100644 index 0000000..06affd4 --- /dev/null +++ b/Help/module/FindWget.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindWget.cmake diff --git a/Help/module/FindWish.rst b/Help/module/FindWish.rst new file mode 100644 index 0000000..76be4cf --- /dev/null +++ b/Help/module/FindWish.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindWish.cmake diff --git a/Help/module/FindX11.rst b/Help/module/FindX11.rst new file mode 100644 index 0000000..906efd7 --- /dev/null +++ b/Help/module/FindX11.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindX11.cmake diff --git a/Help/module/FindXMLRPC.rst b/Help/module/FindXMLRPC.rst new file mode 100644 index 0000000..5d11a0c --- /dev/null +++ b/Help/module/FindXMLRPC.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindXMLRPC.cmake diff --git a/Help/module/FindZLIB.rst b/Help/module/FindZLIB.rst new file mode 100644 index 0000000..ded8634 --- /dev/null +++ b/Help/module/FindZLIB.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindZLIB.cmake diff --git a/Help/module/Findosg.rst b/Help/module/Findosg.rst new file mode 100644 index 0000000..6b407ac --- /dev/null +++ b/Help/module/Findosg.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Findosg.cmake diff --git a/Help/module/FindosgAnimation.rst b/Help/module/FindosgAnimation.rst new file mode 100644 index 0000000..f14a1e7 --- /dev/null +++ b/Help/module/FindosgAnimation.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgAnimation.cmake diff --git a/Help/module/FindosgDB.rst b/Help/module/FindosgDB.rst new file mode 100644 index 0000000..9f72bc7 --- /dev/null +++ b/Help/module/FindosgDB.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgDB.cmake diff --git a/Help/module/FindosgFX.rst b/Help/module/FindosgFX.rst new file mode 100644 index 0000000..0e1edfb --- /dev/null +++ b/Help/module/FindosgFX.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgFX.cmake diff --git a/Help/module/FindosgGA.rst b/Help/module/FindosgGA.rst new file mode 100644 index 0000000..562d73f --- /dev/null +++ b/Help/module/FindosgGA.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgGA.cmake diff --git a/Help/module/FindosgIntrospection.rst b/Help/module/FindosgIntrospection.rst new file mode 100644 index 0000000..53621a7 --- /dev/null +++ b/Help/module/FindosgIntrospection.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgIntrospection.cmake diff --git a/Help/module/FindosgManipulator.rst b/Help/module/FindosgManipulator.rst new file mode 100644 index 0000000..b9d615d --- /dev/null +++ b/Help/module/FindosgManipulator.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgManipulator.cmake diff --git a/Help/module/FindosgParticle.rst b/Help/module/FindosgParticle.rst new file mode 100644 index 0000000..9cf191c --- /dev/null +++ b/Help/module/FindosgParticle.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgParticle.cmake diff --git a/Help/module/FindosgPresentation.rst b/Help/module/FindosgPresentation.rst new file mode 100644 index 0000000..cb47841 --- /dev/null +++ b/Help/module/FindosgPresentation.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgPresentation.cmake diff --git a/Help/module/FindosgProducer.rst b/Help/module/FindosgProducer.rst new file mode 100644 index 0000000..c502851 --- /dev/null +++ b/Help/module/FindosgProducer.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgProducer.cmake diff --git a/Help/module/FindosgQt.rst b/Help/module/FindosgQt.rst new file mode 100644 index 0000000..08c8704 --- /dev/null +++ b/Help/module/FindosgQt.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgQt.cmake diff --git a/Help/module/FindosgShadow.rst b/Help/module/FindosgShadow.rst new file mode 100644 index 0000000..fbb22e1 --- /dev/null +++ b/Help/module/FindosgShadow.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgShadow.cmake diff --git a/Help/module/FindosgSim.rst b/Help/module/FindosgSim.rst new file mode 100644 index 0000000..9e47b65 --- /dev/null +++ b/Help/module/FindosgSim.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgSim.cmake diff --git a/Help/module/FindosgTerrain.rst b/Help/module/FindosgTerrain.rst new file mode 100644 index 0000000..dd401d8 --- /dev/null +++ b/Help/module/FindosgTerrain.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgTerrain.cmake diff --git a/Help/module/FindosgText.rst b/Help/module/FindosgText.rst new file mode 100644 index 0000000..bb028fb --- /dev/null +++ b/Help/module/FindosgText.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgText.cmake diff --git a/Help/module/FindosgUtil.rst b/Help/module/FindosgUtil.rst new file mode 100644 index 0000000..bb11bdf --- /dev/null +++ b/Help/module/FindosgUtil.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgUtil.cmake diff --git a/Help/module/FindosgViewer.rst b/Help/module/FindosgViewer.rst new file mode 100644 index 0000000..5def375 --- /dev/null +++ b/Help/module/FindosgViewer.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgViewer.cmake diff --git a/Help/module/FindosgVolume.rst b/Help/module/FindosgVolume.rst new file mode 100644 index 0000000..d836906 --- /dev/null +++ b/Help/module/FindosgVolume.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgVolume.cmake diff --git a/Help/module/FindosgWidget.rst b/Help/module/FindosgWidget.rst new file mode 100644 index 0000000..bdd1135 --- /dev/null +++ b/Help/module/FindosgWidget.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgWidget.cmake diff --git a/Help/module/Findosg_functions.rst b/Help/module/Findosg_functions.rst new file mode 100644 index 0000000..522e1ac --- /dev/null +++ b/Help/module/Findosg_functions.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Findosg_functions.cmake diff --git a/Help/module/FindwxWidgets.rst b/Help/module/FindwxWidgets.rst new file mode 100644 index 0000000..519beb7 --- /dev/null +++ b/Help/module/FindwxWidgets.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindwxWidgets.cmake diff --git a/Help/module/FindwxWindows.rst b/Help/module/FindwxWindows.rst new file mode 100644 index 0000000..35c9728 --- /dev/null +++ b/Help/module/FindwxWindows.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindwxWindows.cmake diff --git a/Help/module/FortranCInterface.rst b/Help/module/FortranCInterface.rst new file mode 100644 index 0000000..7afcf15 --- /dev/null +++ b/Help/module/FortranCInterface.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FortranCInterface.cmake diff --git a/Help/module/GNUInstallDirs.rst b/Help/module/GNUInstallDirs.rst new file mode 100644 index 0000000..79d3570 --- /dev/null +++ b/Help/module/GNUInstallDirs.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/GNUInstallDirs.cmake diff --git a/Help/module/GenerateExportHeader.rst b/Help/module/GenerateExportHeader.rst new file mode 100644 index 0000000..115713e --- /dev/null +++ b/Help/module/GenerateExportHeader.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/GenerateExportHeader.cmake diff --git a/Help/module/GetPrerequisites.rst b/Help/module/GetPrerequisites.rst new file mode 100644 index 0000000..84b20c8 --- /dev/null +++ b/Help/module/GetPrerequisites.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/GetPrerequisites.cmake diff --git a/Help/module/InstallRequiredSystemLibraries.rst b/Help/module/InstallRequiredSystemLibraries.rst new file mode 100644 index 0000000..5ea9af3 --- /dev/null +++ b/Help/module/InstallRequiredSystemLibraries.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/InstallRequiredSystemLibraries.cmake diff --git a/Help/module/MacroAddFileDependencies.rst b/Help/module/MacroAddFileDependencies.rst new file mode 100644 index 0000000..5f0bf6b --- /dev/null +++ b/Help/module/MacroAddFileDependencies.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/MacroAddFileDependencies.cmake diff --git a/Help/module/ProcessorCount.rst b/Help/module/ProcessorCount.rst new file mode 100644 index 0000000..0149d09 --- /dev/null +++ b/Help/module/ProcessorCount.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/ProcessorCount.cmake diff --git a/Help/module/Qt4ConfigDependentSettings.rst b/Help/module/Qt4ConfigDependentSettings.rst new file mode 100644 index 0000000..7002f53 --- /dev/null +++ b/Help/module/Qt4ConfigDependentSettings.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Qt4ConfigDependentSettings.cmake diff --git a/Help/module/Qt4Macros.rst b/Help/module/Qt4Macros.rst new file mode 100644 index 0000000..6448d53 --- /dev/null +++ b/Help/module/Qt4Macros.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Qt4Macros.cmake diff --git a/Help/module/SelectLibraryConfigurations.rst b/Help/module/SelectLibraryConfigurations.rst new file mode 100644 index 0000000..14fd6f8 --- /dev/null +++ b/Help/module/SelectLibraryConfigurations.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/SelectLibraryConfigurations.cmake diff --git a/Help/module/SquishTestScript.rst b/Help/module/SquishTestScript.rst new file mode 100644 index 0000000..47da404 --- /dev/null +++ b/Help/module/SquishTestScript.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/SquishTestScript.cmake diff --git a/Help/module/TestBigEndian.rst b/Help/module/TestBigEndian.rst new file mode 100644 index 0000000..f9e4d2f --- /dev/null +++ b/Help/module/TestBigEndian.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/TestBigEndian.cmake diff --git a/Help/module/TestCXXAcceptsFlag.rst b/Help/module/TestCXXAcceptsFlag.rst new file mode 100644 index 0000000..ee3d70a --- /dev/null +++ b/Help/module/TestCXXAcceptsFlag.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/TestCXXAcceptsFlag.cmake diff --git a/Help/module/TestForANSIForScope.rst b/Help/module/TestForANSIForScope.rst new file mode 100644 index 0000000..00d9238 --- /dev/null +++ b/Help/module/TestForANSIForScope.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/TestForANSIForScope.cmake diff --git a/Help/module/TestForANSIStreamHeaders.rst b/Help/module/TestForANSIStreamHeaders.rst new file mode 100644 index 0000000..212a30b --- /dev/null +++ b/Help/module/TestForANSIStreamHeaders.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/TestForANSIStreamHeaders.cmake diff --git a/Help/module/TestForSSTREAM.rst b/Help/module/TestForSSTREAM.rst new file mode 100644 index 0000000..d154751 --- /dev/null +++ b/Help/module/TestForSSTREAM.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/TestForSSTREAM.cmake diff --git a/Help/module/TestForSTDNamespace.rst b/Help/module/TestForSTDNamespace.rst new file mode 100644 index 0000000..ad989e3 --- /dev/null +++ b/Help/module/TestForSTDNamespace.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/TestForSTDNamespace.cmake diff --git a/Help/module/UseEcos.rst b/Help/module/UseEcos.rst new file mode 100644 index 0000000..0e57868 --- /dev/null +++ b/Help/module/UseEcos.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UseEcos.cmake diff --git a/Help/module/UseJava.rst b/Help/module/UseJava.rst new file mode 100644 index 0000000..fa2f1bd --- /dev/null +++ b/Help/module/UseJava.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UseJava.cmake diff --git a/Help/module/UseJavaClassFilelist.rst b/Help/module/UseJavaClassFilelist.rst new file mode 100644 index 0000000..b9cd476 --- /dev/null +++ b/Help/module/UseJavaClassFilelist.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UseJavaClassFilelist.cmake diff --git a/Help/module/UseJavaSymlinks.rst b/Help/module/UseJavaSymlinks.rst new file mode 100644 index 0000000..2fab8e8 --- /dev/null +++ b/Help/module/UseJavaSymlinks.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UseJavaSymlinks.cmake diff --git a/Help/module/UsePkgConfig.rst b/Help/module/UsePkgConfig.rst new file mode 100644 index 0000000..668f766 --- /dev/null +++ b/Help/module/UsePkgConfig.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UsePkgConfig.cmake diff --git a/Help/module/UseQt4.rst b/Help/module/UseQt4.rst new file mode 100644 index 0000000..c2f2ea8 --- /dev/null +++ b/Help/module/UseQt4.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UseQt4.cmake diff --git a/Help/module/UseSWIG.rst b/Help/module/UseSWIG.rst new file mode 100644 index 0000000..0007c35 --- /dev/null +++ b/Help/module/UseSWIG.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UseSWIG.cmake diff --git a/Help/module/Use_wxWindows.rst b/Help/module/Use_wxWindows.rst new file mode 100644 index 0000000..a489e98 --- /dev/null +++ b/Help/module/Use_wxWindows.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Use_wxWindows.cmake diff --git a/Help/module/UsewxWidgets.rst b/Help/module/UsewxWidgets.rst new file mode 100644 index 0000000..6829c2d --- /dev/null +++ b/Help/module/UsewxWidgets.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UsewxWidgets.cmake diff --git a/Help/module/WriteBasicConfigVersionFile.rst b/Help/module/WriteBasicConfigVersionFile.rst new file mode 100644 index 0000000..c637d5d --- /dev/null +++ b/Help/module/WriteBasicConfigVersionFile.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/WriteBasicConfigVersionFile.cmake diff --git a/Help/policy/CMP0000.rst b/Help/policy/CMP0000.rst new file mode 100644 index 0000000..9fbf842 --- /dev/null +++ b/Help/policy/CMP0000.rst @@ -0,0 +1,30 @@ +CMP0000 +------- + +A minimum required CMake version must be specified. + +CMake requires that projects specify the version of CMake to which +they have been written. This policy has been put in place so users +trying to build the project may be told when they need to update their +CMake. Specifying a version also helps the project build with CMake +versions newer than that specified. Use the cmake_minimum_required +command at the top of your main CMakeLists.txt file: + +:: + + cmake_minimum_required(VERSION <major>.<minor>) + +where "<major>.<minor>" is the version of CMake you want to support +(such as "2.6"). The command will ensure that at least the given +version of CMake is running and help newer versions be compatible with +the project. See documentation of cmake_minimum_required for details. + +Note that the command invocation must appear in the CMakeLists.txt +file itself; a call in an included file is not sufficient. However, +the cmake_policy command may be called to set policy CMP0000 to OLD or +NEW behavior explicitly. The OLD behavior is to silently ignore the +missing invocation. The NEW behavior is to issue an error instead of +a warning. An included file may set CMP0000 explicitly to affect how +this policy is enforced for the main CMakeLists.txt file. + +This policy was introduced in CMake version 2.6.0. diff --git a/Help/policy/CMP0001.rst b/Help/policy/CMP0001.rst new file mode 100644 index 0000000..344f1e2 --- /dev/null +++ b/Help/policy/CMP0001.rst @@ -0,0 +1,19 @@ +CMP0001 +------- + +CMAKE_BACKWARDS_COMPATIBILITY should no longer be used. + +The OLD behavior is to check CMAKE_BACKWARDS_COMPATIBILITY and present +it to the user. The NEW behavior is to ignore +CMAKE_BACKWARDS_COMPATIBILITY completely. + +In CMake 2.4 and below the variable CMAKE_BACKWARDS_COMPATIBILITY was +used to request compatibility with earlier versions of CMake. In +CMake 2.6 and above all compatibility issues are handled by policies +and the cmake_policy command. However, CMake must still check +CMAKE_BACKWARDS_COMPATIBILITY for projects written for CMake 2.4 and +below. + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0002.rst b/Help/policy/CMP0002.rst new file mode 100644 index 0000000..2c15bd4 --- /dev/null +++ b/Help/policy/CMP0002.rst @@ -0,0 +1,26 @@ +CMP0002 +------- + +Logical target names must be globally unique. + +Targets names created with add_executable, add_library, or +add_custom_target are logical build target names. Logical target +names must be globally unique because: + +:: + + - Unique names may be referenced unambiguously both in CMake + code and on make tool command lines. + - Logical names are used by Xcode and VS IDE generators + to produce meaningful project names for the targets. + +The logical name of executable and library targets does not have to +correspond to the physical file names built. Consider using the +OUTPUT_NAME target property to create two targets with the same +physical name while keeping logical names distinct. Custom targets +must simply have globally unique names (unless one uses the global +property ALLOW_DUPLICATE_CUSTOM_TARGETS with a Makefiles generator). + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0003.rst b/Help/policy/CMP0003.rst new file mode 100644 index 0000000..27b83f8 --- /dev/null +++ b/Help/policy/CMP0003.rst @@ -0,0 +1,102 @@ +CMP0003 +------- + +Libraries linked via full path no longer produce linker search paths. + +This policy affects how libraries whose full paths are NOT known are +found at link time, but was created due to a change in how CMake deals +with libraries whose full paths are known. Consider the code + +:: + + target_link_libraries(myexe /path/to/libA.so) + +CMake 2.4 and below implemented linking to libraries whose full paths +are known by splitting them on the link line into separate components +consisting of the linker search path and the library name. The +example code might have produced something like + +:: + + ... -L/path/to -lA ... + +in order to link to library A. An analysis was performed to order +multiple link directories such that the linker would find library A in +the desired location, but there are cases in which this does not work. +CMake versions 2.6 and above use the more reliable approach of passing +the full path to libraries directly to the linker in most cases. The +example code now produces something like + +:: + + ... /path/to/libA.so .... + +Unfortunately this change can break code like + +:: + + target_link_libraries(myexe /path/to/libA.so B) + +where "B" is meant to find "/path/to/libB.so". This code is wrong +because the user is asking the linker to find library B but has not +provided a linker search path (which may be added with the +link_directories command). However, with the old linking +implementation the code would work accidentally because the linker +search path added for library A allowed library B to be found. + +In order to support projects depending on linker search paths added by +linking to libraries with known full paths, the OLD behavior for this +policy will add the linker search paths even though they are not +needed for their own libraries. When this policy is set to OLD, CMake +will produce a link line such as + +:: + + ... -L/path/to /path/to/libA.so -lB ... + +which will allow library B to be found as it was previously. When +this policy is set to NEW, CMake will produce a link line such as + +:: + + ... /path/to/libA.so -lB ... + +which more accurately matches what the project specified. + +The setting for this policy used when generating the link line is that +in effect when the target is created by an add_executable or +add_library command. For the example described above, the code + +:: + + cmake_policy(SET CMP0003 OLD) # or cmake_policy(VERSION 2.4) + add_executable(myexe myexe.c) + target_link_libraries(myexe /path/to/libA.so B) + +will work and suppress the warning for this policy. It may also be +updated to work with the corrected linking approach: + +:: + + cmake_policy(SET CMP0003 NEW) # or cmake_policy(VERSION 2.6) + link_directories(/path/to) # needed to find library B + add_executable(myexe myexe.c) + target_link_libraries(myexe /path/to/libA.so B) + +Even better, library B may be specified with a full path: + +:: + + add_executable(myexe myexe.c) + target_link_libraries(myexe /path/to/libA.so /path/to/libB.so) + +When all items on the link line have known paths CMake does not check +this policy so it has no effect. + +Note that the warning for this policy will be issued for at most one +target. This avoids flooding users with messages for every target +when setting the policy once will probably fix all targets. + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0004.rst b/Help/policy/CMP0004.rst new file mode 100644 index 0000000..80045f5 --- /dev/null +++ b/Help/policy/CMP0004.rst @@ -0,0 +1,23 @@ +CMP0004 +------- + +Libraries linked may not have leading or trailing whitespace. + +CMake versions 2.4 and below silently removed leading and trailing +whitespace from libraries linked with code like + +:: + + target_link_libraries(myexe " A ") + +This could lead to subtle errors in user projects. + +The OLD behavior for this policy is to silently remove leading and +trailing whitespace. The NEW behavior for this policy is to diagnose +the existence of such whitespace as an error. The setting for this +policy used when checking the library names is that in effect when the +target is created by an add_executable or add_library command. + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0005.rst b/Help/policy/CMP0005.rst new file mode 100644 index 0000000..c11a9e6 --- /dev/null +++ b/Help/policy/CMP0005.rst @@ -0,0 +1,24 @@ +CMP0005 +------- + +Preprocessor definition values are now escaped automatically. + +This policy determines whether or not CMake should generate escaped +preprocessor definition values added via add_definitions. CMake +versions 2.4 and below assumed that only trivial values would be given +for macros in add_definitions calls. It did not attempt to escape +non-trivial values such as string literals in generated build rules. +CMake versions 2.6 and above support escaping of most values, but +cannot assume the user has not added escapes already in an attempt to +work around limitations in earlier versions. + +The OLD behavior for this policy is to place definition values given +to add_definitions directly in the generated build rules without +attempting to escape anything. The NEW behavior for this policy is to +generate correct escapes for all native build tools automatically. +See documentation of the COMPILE_DEFINITIONS target property for +limitations of the escaping implementation. + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0006.rst b/Help/policy/CMP0006.rst new file mode 100644 index 0000000..8d1e5bd --- /dev/null +++ b/Help/policy/CMP0006.rst @@ -0,0 +1,22 @@ +CMP0006 +------- + +Installing MACOSX_BUNDLE targets requires a BUNDLE DESTINATION. + +This policy determines whether the install(TARGETS) command must be +given a BUNDLE DESTINATION when asked to install a target with the +MACOSX_BUNDLE property set. CMake 2.4 and below did not distinguish +application bundles from normal executables when installing targets. +CMake 2.6 provides a BUNDLE option to the install(TARGETS) command +that specifies rules specific to application bundles on the Mac. +Projects should use this option when installing a target with the +MACOSX_BUNDLE property set. + +The OLD behavior for this policy is to fall back to the RUNTIME +DESTINATION if a BUNDLE DESTINATION is not given. The NEW behavior +for this policy is to produce an error if a bundle target is installed +without a BUNDLE DESTINATION. + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0007.rst b/Help/policy/CMP0007.rst new file mode 100644 index 0000000..f0d8c16 --- /dev/null +++ b/Help/policy/CMP0007.rst @@ -0,0 +1,15 @@ +CMP0007 +------- + +list command no longer ignores empty elements. + +This policy determines whether the list command will ignore empty +elements in the list. CMake 2.4 and below list commands ignored all +empty elements in the list. For example, a;b;;c would have length 3 +and not 4. The OLD behavior for this policy is to ignore empty list +elements. The NEW behavior for this policy is to correctly count +empty elements in a list. + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0008.rst b/Help/policy/CMP0008.rst new file mode 100644 index 0000000..b118ece --- /dev/null +++ b/Help/policy/CMP0008.rst @@ -0,0 +1,32 @@ +CMP0008 +------- + +Libraries linked by full-path must have a valid library file name. + +In CMake 2.4 and below it is possible to write code like + +:: + + target_link_libraries(myexe /full/path/to/somelib) + +where "somelib" is supposed to be a valid library file name such as +"libsomelib.a" or "somelib.lib". For Makefile generators this +produces an error at build time because the dependency on the full +path cannot be found. For VS IDE and Xcode generators this used to +work by accident because CMake would always split off the library +directory and ask the linker to search for the library by name +(-lsomelib or somelib.lib). Despite the failure with Makefiles, some +projects have code like this and build only with VS and/or Xcode. +This version of CMake prefers to pass the full path directly to the +native build tool, which will fail in this case because it does not +name a valid library file. + +This policy determines what to do with full paths that do not appear +to name a valid library file. The OLD behavior for this policy is to +split the library name from the path and ask the linker to search for +it. The NEW behavior for this policy is to trust the given path and +pass it directly to the native build tool unchanged. + +This policy was introduced in CMake version 2.6.1. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0009.rst b/Help/policy/CMP0009.rst new file mode 100644 index 0000000..481af1a --- /dev/null +++ b/Help/policy/CMP0009.rst @@ -0,0 +1,19 @@ +CMP0009 +------- + +FILE GLOB_RECURSE calls should not follow symlinks by default. + +In CMake 2.6.1 and below, FILE GLOB_RECURSE calls would follow through +symlinks, sometimes coming up with unexpectedly large result sets +because of symlinks to top level directories that contain hundreds of +thousands of files. + +This policy determines whether or not to follow symlinks encountered +during a FILE GLOB_RECURSE call. The OLD behavior for this policy is +to follow the symlinks. The NEW behavior for this policy is not to +follow the symlinks by default, but only if FOLLOW_SYMLINKS is given +as an additional argument to the FILE command. + +This policy was introduced in CMake version 2.6.2. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0010.rst b/Help/policy/CMP0010.rst new file mode 100644 index 0000000..01699e1 --- /dev/null +++ b/Help/policy/CMP0010.rst @@ -0,0 +1,15 @@ +CMP0010 +------- + +Bad variable reference syntax is an error. + +In CMake 2.6.2 and below, incorrect variable reference syntax such as +a missing close-brace ("${FOO") was reported but did not stop +processing of CMake code. This policy determines whether a bad +variable reference is an error. The OLD behavior for this policy is +to warn about the error, leave the string untouched, and continue. +The NEW behavior for this policy is to report an error. + +This policy was introduced in CMake version 2.6.3. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0011.rst b/Help/policy/CMP0011.rst new file mode 100644 index 0000000..0f41fff --- /dev/null +++ b/Help/policy/CMP0011.rst @@ -0,0 +1,22 @@ +CMP0011 +------- + +Included scripts do automatic cmake_policy PUSH and POP. + +In CMake 2.6.2 and below, CMake Policy settings in scripts loaded by +the include() and find_package() commands would affect the includer. +Explicit invocations of cmake_policy(PUSH) and cmake_policy(POP) were +required to isolate policy changes and protect the includer. While +some scripts intend to affect the policies of their includer, most do +not. In CMake 2.6.3 and above, include() and find_package() by +default PUSH and POP an entry on the policy stack around an included +script, but provide a NO_POLICY_SCOPE option to disable it. This +policy determines whether or not to imply NO_POLICY_SCOPE for +compatibility. The OLD behavior for this policy is to imply +NO_POLICY_SCOPE for include() and find_package() commands. The NEW +behavior for this policy is to allow the commands to do their default +cmake_policy PUSH and POP. + +This policy was introduced in CMake version 2.6.3. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0012.rst b/Help/policy/CMP0012.rst new file mode 100644 index 0000000..7a749bf --- /dev/null +++ b/Help/policy/CMP0012.rst @@ -0,0 +1,25 @@ +CMP0012 +------- + +if() recognizes numbers and boolean constants. + +In CMake versions 2.6.4 and lower the if() command implicitly +dereferenced arguments corresponding to variables, even those named +like numbers or boolean constants, except for 0 and 1. Numbers and +boolean constants such as true, false, yes, no, on, off, y, n, +notfound, ignore (all case insensitive) were recognized in some cases +but not all. For example, the code "if(TRUE)" might have evaluated as +false. Numbers such as 2 were recognized only in boolean expressions +like "if(NOT 2)" (leading to false) but not as a single-argument like +"if(2)" (also leading to false). Later versions of CMake prefer to +treat numbers and boolean constants literally, so they should not be +used as variable names. + +The OLD behavior for this policy is to implicitly dereference +variables named like numbers and boolean constants. The NEW behavior +for this policy is to recognize numbers and boolean constants without +dereferencing variables with such names. + +This policy was introduced in CMake version 2.8.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0013.rst b/Help/policy/CMP0013.rst new file mode 100644 index 0000000..e99997b --- /dev/null +++ b/Help/policy/CMP0013.rst @@ -0,0 +1,19 @@ +CMP0013 +------- + +Duplicate binary directories are not allowed. + +CMake 2.6.3 and below silently permitted add_subdirectory() calls to +create the same binary directory multiple times. During build system +generation files would be written and then overwritten in the build +tree and could lead to strange behavior. CMake 2.6.4 and above +explicitly detect duplicate binary directories. CMake 2.6.4 always +considers this case an error. In CMake 2.8.0 and above this policy +determines whether or not the case is an error. The OLD behavior for +this policy is to allow duplicate binary directories. The NEW +behavior for this policy is to disallow duplicate binary directories +with an error. + +This policy was introduced in CMake version 2.8.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0014.rst b/Help/policy/CMP0014.rst new file mode 100644 index 0000000..37178d1 --- /dev/null +++ b/Help/policy/CMP0014.rst @@ -0,0 +1,15 @@ +CMP0014 +------- + +Input directories must have CMakeLists.txt. + +CMake versions before 2.8 silently ignored missing CMakeLists.txt +files in directories referenced by add_subdirectory() or subdirs(), +treating them as if present but empty. In CMake 2.8.0 and above this +policy determines whether or not the case is an error. The OLD +behavior for this policy is to silently ignore the problem. The NEW +behavior for this policy is to report an error. + +This policy was introduced in CMake version 2.8.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0015.rst b/Help/policy/CMP0015.rst new file mode 100644 index 0000000..1b54979 --- /dev/null +++ b/Help/policy/CMP0015.rst @@ -0,0 +1,17 @@ +CMP0015 +------- + +link_directories() treats paths relative to the source dir. + +In CMake 2.8.0 and lower the link_directories() command passed +relative paths unchanged to the linker. In CMake 2.8.1 and above the +link_directories() command prefers to interpret relative paths with +respect to CMAKE_CURRENT_SOURCE_DIR, which is consistent with +include_directories() and other commands. The OLD behavior for this +policy is to use relative paths verbatim in the linker command. The +NEW behavior for this policy is to convert relative paths to absolute +paths by appending the relative path to CMAKE_CURRENT_SOURCE_DIR. + +This policy was introduced in CMake version 2.8.1. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0016.rst b/Help/policy/CMP0016.rst new file mode 100644 index 0000000..743b1a9 --- /dev/null +++ b/Help/policy/CMP0016.rst @@ -0,0 +1,13 @@ +CMP0016 +------- + +target_link_libraries() reports error if its only argument is not a target. + +In CMake 2.8.2 and lower the target_link_libraries() command silently +ignored if it was called with only one argument, and this argument +wasn't a valid target. In CMake 2.8.3 and above it reports an error +in this case. + +This policy was introduced in CMake version 2.8.3. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0017.rst b/Help/policy/CMP0017.rst new file mode 100644 index 0000000..c93e8b2 --- /dev/null +++ b/Help/policy/CMP0017.rst @@ -0,0 +1,19 @@ +CMP0017 +------- + +Prefer files from the CMake module directory when including from there. + +Starting with CMake 2.8.4, if a cmake-module shipped with CMake (i.e. +located in the CMake module directory) calls include() or +find_package(), the files located in the CMake module directory are +preferred over the files in CMAKE_MODULE_PATH. This makes sure that +the modules belonging to CMake always get those files included which +they expect, and against which they were developed and tested. In all +other cases, the files found in CMAKE_MODULE_PATH still take +precedence over the ones in the CMake module directory. The OLD +behaviour is to always prefer files from CMAKE_MODULE_PATH over files +from the CMake modules directory. + +This policy was introduced in CMake version 2.8.4. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0018.rst b/Help/policy/CMP0018.rst new file mode 100644 index 0000000..0f68267 --- /dev/null +++ b/Help/policy/CMP0018.rst @@ -0,0 +1,32 @@ +CMP0018 +------- + +Ignore CMAKE_SHARED_LIBRARY_<Lang>_FLAGS variable. + +CMake 2.8.8 and lower compiled sources in SHARED and MODULE libraries +using the value of the undocumented CMAKE_SHARED_LIBRARY_<Lang>_FLAGS +platform variable. The variable contained platform-specific flags +needed to compile objects for shared libraries. Typically it included +a flag such as -fPIC for position independent code but also included +other flags needed on certain platforms. CMake 2.8.9 and higher +prefer instead to use the POSITION_INDEPENDENT_CODE target property to +determine what targets should be position independent, and new +undocumented platform variables to select flags while ignoring +CMAKE_SHARED_LIBRARY_<Lang>_FLAGS completely. + +The default for either approach produces identical compilation flags, +but if a project modifies CMAKE_SHARED_LIBRARY_<Lang>_FLAGS from its +original value this policy determines which approach to use. + +The OLD behavior for this policy is to ignore the +POSITION_INDEPENDENT_CODE property for all targets and use the +modified value of CMAKE_SHARED_LIBRARY_<Lang>_FLAGS for SHARED and +MODULE libraries. + +The NEW behavior for this policy is to ignore +CMAKE_SHARED_LIBRARY_<Lang>_FLAGS whether it is modified or not and +honor the POSITION_INDEPENDENT_CODE target property. + +This policy was introduced in CMake version 2.8.9. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0019.rst b/Help/policy/CMP0019.rst new file mode 100644 index 0000000..2b37fa1 --- /dev/null +++ b/Help/policy/CMP0019.rst @@ -0,0 +1,20 @@ +CMP0019 +------- + +Do not re-expand variables in include and link information. + +CMake 2.8.10 and lower re-evaluated values given to the +include_directories, link_directories, and link_libraries commands to +expand any leftover variable references at the end of the +configuration step. This was for strict compatibility with VERY early +CMake versions because all variable references are now normally +evaluated during CMake language processing. CMake 2.8.11 and higher +prefer to skip the extra evaluation. + +The OLD behavior for this policy is to re-evaluate the values for +strict compatibility. The NEW behavior for this policy is to leave +the values untouched. + +This policy was introduced in CMake version 2.8.11. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0020.rst b/Help/policy/CMP0020.rst new file mode 100644 index 0000000..ad664b0 --- /dev/null +++ b/Help/policy/CMP0020.rst @@ -0,0 +1,25 @@ +CMP0020 +------- + +Automatically link Qt executables to qtmain target on Windows. + +CMake 2.8.10 and lower required users of Qt to always specify a link +dependency to the qtmain.lib static library manually on Windows. +CMake 2.8.11 gained the ability to evaluate generator expressions +while determining the link dependencies from IMPORTED targets. This +allows CMake itself to automatically link executables which link to Qt +to the qtmain.lib library when using IMPORTED Qt targets. For +applications already linking to qtmain.lib, this should have little +impact. For applications which supply their own alternative WinMain +implementation and for applications which use the QAxServer library, +this automatic linking will need to be disabled as per the +documentation. + +The OLD behavior for this policy is not to link executables to +qtmain.lib automatically when they link to the QtCore IMPORTEDtarget. +The NEW behavior for this policy is to link executables to qtmain.lib +automatically when they link to QtCore IMPORTED target. + +This policy was introduced in CMake version 2.8.11. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0021.rst b/Help/policy/CMP0021.rst new file mode 100644 index 0000000..3f5bd03 --- /dev/null +++ b/Help/policy/CMP0021.rst @@ -0,0 +1,18 @@ +CMP0021 +------- + +Fatal error on relative paths in INCLUDE_DIRECTORIES target property. + +CMake 2.8.10.2 and lower allowed the INCLUDE_DIRECTORIES target +property to contain relative paths. The base path for such relative +entries is not well defined. CMake 2.8.12 issues a FATAL_ERROR if the +INCLUDE_DIRECTORIES property contains a relative path. + +The OLD behavior for this policy is not to warn about relative paths +in the INCLUDE_DIRECTORIES target property. The NEW behavior for this +policy is to issue a FATAL_ERROR if INCLUDE_DIRECTORIES contains a +relative path. + +This policy was introduced in CMake version 2.8.12. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0022.rst b/Help/policy/CMP0022.rst new file mode 100644 index 0000000..78c688a --- /dev/null +++ b/Help/policy/CMP0022.rst @@ -0,0 +1,33 @@ +CMP0022 +------- + +INTERFACE_LINK_LIBRARIES defines the link interface. + +CMake 2.8.11 constructed the 'link interface' of a target from +properties matching (IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)?. +The modern way to specify config-sensitive content is to use generator +expressions and the IMPORTED_ prefix makes uniform processing of the +link interface with generator expressions impossible. The +INTERFACE_LINK_LIBRARIES target property was introduced as a +replacement in CMake 2.8.12. This new property is named consistently +with the INTERFACE_COMPILE_DEFINITIONS, INTERFACE_INCLUDE_DIRECTORIES +and INTERFACE_COMPILE_OPTIONS properties. For in-build targets, CMake +will use the INTERFACE_LINK_LIBRARIES property as the source of the +link interface only if policy CMP0022 is NEW. When exporting a target +which has this policy set to NEW, only the INTERFACE_LINK_LIBRARIES +property will be processed and generated for the IMPORTED target by +default. A new option to the install(EXPORT) and export commands +allows export of the old-style properties for compatibility with +downstream users of CMake versions older than 2.8.12. The +target_link_libraries command will no longer populate the properties +matching LINK_INTERFACE_LIBRARIES(_<CONFIG>)? if this policy is NEW. + +The OLD behavior for this policy is to ignore the +INTERFACE_LINK_LIBRARIES property for in-build targets. The NEW +behavior for this policy is to use the INTERFACE_LINK_LIBRARIES +property for in-build targets, and ignore the old properties matching +(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)?. + +This policy was introduced in CMake version 2.8.12. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0023.rst b/Help/policy/CMP0023.rst new file mode 100644 index 0000000..962b624 --- /dev/null +++ b/Help/policy/CMP0023.rst @@ -0,0 +1,33 @@ +CMP0023 +------- + +Plain and keyword target_link_libraries signatures cannot be mixed. + +CMake 2.8.12 introduced the target_link_libraries signature using the +PUBLIC, PRIVATE, and INTERFACE keywords to generalize the LINK_PUBLIC +and LINK_PRIVATE keywords introduced in CMake 2.8.7. Use of +signatures with any of these keywords sets the link interface of a +target explicitly, even if empty. This produces confusing behavior +when used in combination with the historical behavior of the plain +target_link_libraries signature. For example, consider the code: + +:: + + target_link_libraries(mylib A) + target_link_libraries(mylib PRIVATE B) + +After the first line the link interface has not been set explicitly so +CMake would use the link implementation, A, as the link interface. +However, the second line sets the link interface to empty. In order +to avoid this subtle behavior CMake now prefers to disallow mixing the +plain and keyword signatures of target_link_libraries for a single +target. + +The OLD behavior for this policy is to allow keyword and plain +target_link_libraries signatures to be mixed. The NEW behavior for +this policy is to not to allow mixing of the keyword and plain +signatures. + +This policy was introduced in CMake version 2.8.12. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0024.rst b/Help/policy/CMP0024.rst new file mode 100644 index 0000000..ce0b2e6 --- /dev/null +++ b/Help/policy/CMP0024.rst @@ -0,0 +1,22 @@ +CMP0024 +------- + +Disallow include export result. + +CMake 2.8.12 and lower allowed use of the include() command with the +result of the export() command. This relies on the assumption that +the export() command has an immediate effect at configure-time during +a cmake run. Certain properties of targets are not fully determined +until later at generate-time, such as the link language and complete +list of link libraries. Future refactoring will change the effect of +the export() command to be executed at generate-time. Use ALIAS +targets instead in cases where the goal is to refer to targets by +another name + +The OLD behavior for this policy is to allow including the result of +an export() command. The NEW behavior for this policy is to not to +allow including the result of an export() command. + +This policy was introduced in CMake version 2.8.13. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0025.rst b/Help/policy/CMP0025.rst new file mode 100644 index 0000000..25957e9 --- /dev/null +++ b/Help/policy/CMP0025.rst @@ -0,0 +1,21 @@ +CMP0025 +------- + +Compiler id for Apple Clang is now AppleClang. + +CMake >= 2.8.13 recognize that Apple Clang is a different compiler +than upstream Clang and that they have different version numbers. +CMake now prefers to present this to projects by setting +CMAKE_<LANG>_COMPILER_ID to "AppleClang" instead of "Clang". However, +existing projects may assume the compiler id for Apple Clang is just +"Clang" as it was in CMake < 2.8.13. Therefore this policy determines +for Apple Clang which compiler id to report in +CMAKE_<LANG>_COMPILER_ID after <LANG> is enabled by the project() or +enable_language() command. + +The OLD behavior for this policy is to use compiler id "Clang". The +NEW behavior for this policy is to use compiler id "AppleClang". + +This policy was introduced in CMake version 2.8.13. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0026.rst b/Help/policy/CMP0026.rst new file mode 100644 index 0000000..585da56 --- /dev/null +++ b/Help/policy/CMP0026.rst @@ -0,0 +1,25 @@ +CMP0026 +------- + +Disallow use of the LOCATION target property. + +CMake 2.8.12 and lower allowed reading the LOCATION target property to +determine the eventual location of build targets. This relies on the +assumption that all necessary information is available at +configure-time to determine the final location and filename of the +target. However, this property is not fully determined until later at +generate-time. At generate time, the $<TARGET_FILE> generator +expression can be used to determine the eventual LOCATION of a target +output. + +Code which reads the LOCATION target property can be ported to use the +$<TARGET_FILE> generator expression together with the file(GENERATE) +subcommand to generate a file containing the target location. + +The OLD behavior for this policy is to allow reading the LOCATION +property from build-targets. The NEW behavior for this policy is to +not to allow reading the LOCATION property from build-targets. + +This policy was introduced in CMake version 2.8.13. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/prop_cache/ADVANCED.rst b/Help/prop_cache/ADVANCED.rst new file mode 100644 index 0000000..a0a4f73 --- /dev/null +++ b/Help/prop_cache/ADVANCED.rst @@ -0,0 +1,8 @@ +ADVANCED +-------- + +True if entry should be hidden by default in GUIs. + +This is a boolean value indicating whether the entry is considered +interesting only for advanced configuration. The mark_as_advanced() +command modifies this property. diff --git a/Help/prop_cache/HELPSTRING.rst b/Help/prop_cache/HELPSTRING.rst new file mode 100644 index 0000000..71a86d0 --- /dev/null +++ b/Help/prop_cache/HELPSTRING.rst @@ -0,0 +1,7 @@ +HELPSTRING +---------- + +Help associated with entry in GUIs. + +This string summarizes the purpose of an entry to help users set it +through a CMake GUI. diff --git a/Help/prop_cache/MODIFIED.rst b/Help/prop_cache/MODIFIED.rst new file mode 100644 index 0000000..3ad7035 --- /dev/null +++ b/Help/prop_cache/MODIFIED.rst @@ -0,0 +1,7 @@ +MODIFIED +-------- + +Internal management property. Do not set or get. + +This is an internal cache entry property managed by CMake to track +interactive user modification of entries. Ignore it. diff --git a/Help/prop_cache/STRINGS.rst b/Help/prop_cache/STRINGS.rst new file mode 100644 index 0000000..2f8e32e --- /dev/null +++ b/Help/prop_cache/STRINGS.rst @@ -0,0 +1,9 @@ +STRINGS +------- + +Enumerate possible STRING entry values for GUI selection. + +For cache entries with type STRING, this enumerates a set of values. +CMake GUIs may use this to provide a selection widget instead of a +generic string entry field. This is for convenience only. CMake does +not enforce that the value matches one of those listed. diff --git a/Help/prop_cache/TYPE.rst b/Help/prop_cache/TYPE.rst new file mode 100644 index 0000000..eb75c2a --- /dev/null +++ b/Help/prop_cache/TYPE.rst @@ -0,0 +1,21 @@ +TYPE +---- + +Widget type for entry in GUIs. + +Cache entry values are always strings, but CMake GUIs present widgets +to help users set values. The GUIs use this property as a hint to +determine the widget type. Valid TYPE values are: + +:: + + BOOL = Boolean ON/OFF value. + PATH = Path to a directory. + FILEPATH = Path to a file. + STRING = Generic string value. + INTERNAL = Do not present in GUI at all. + STATIC = Value managed by CMake, do not change. + UNINITIALIZED = Type not yet specified. + +Generally the TYPE of a cache entry should be set by the command which +creates it (set, option, find_library, etc.). diff --git a/Help/prop_cache/VALUE.rst b/Help/prop_cache/VALUE.rst new file mode 100644 index 0000000..59aabd4 --- /dev/null +++ b/Help/prop_cache/VALUE.rst @@ -0,0 +1,7 @@ +VALUE +----- + +Value of a cache entry. + +This property maps to the actual value of a cache entry. Setting this +property always sets the value without checking, so use with care. diff --git a/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst b/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst new file mode 100644 index 0000000..e32eed3 --- /dev/null +++ b/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst @@ -0,0 +1,7 @@ +ADDITIONAL_MAKE_CLEAN_FILES +--------------------------- + +Additional files to clean during the make clean stage. + +A list of files that will be cleaned as a part of the "make clean" +stage. diff --git a/Help/prop_dir/CACHE_VARIABLES.rst b/Help/prop_dir/CACHE_VARIABLES.rst new file mode 100644 index 0000000..2c66f93 --- /dev/null +++ b/Help/prop_dir/CACHE_VARIABLES.rst @@ -0,0 +1,7 @@ +CACHE_VARIABLES +--------------- + +List of cache variables available in the current directory. + +This read-only property specifies the list of CMake cache variables +currently defined. It is intended for debugging purposes. diff --git a/Help/prop_dir/CLEAN_NO_CUSTOM.rst b/Help/prop_dir/CLEAN_NO_CUSTOM.rst new file mode 100644 index 0000000..9a4173e --- /dev/null +++ b/Help/prop_dir/CLEAN_NO_CUSTOM.rst @@ -0,0 +1,7 @@ +CLEAN_NO_CUSTOM +--------------- + +Should the output of custom commands be left. + +If this is true then the outputs of custom commands for this directory +will not be removed during the "make clean" stage. diff --git a/Help/prop_dir/COMPILE_DEFINITIONS.rst b/Help/prop_dir/COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000..bc5f754 --- /dev/null +++ b/Help/prop_dir/COMPILE_DEFINITIONS.rst @@ -0,0 +1,39 @@ +COMPILE_DEFINITIONS +------------------- + +Preprocessor definitions for compiling a directory's sources. + +The COMPILE_DEFINITIONS property may be set to a semicolon-separated +list of preprocessor definitions using the syntax VAR or VAR=value. +Function-style definitions are not supported. CMake will +automatically escape the value correctly for the native build system +(note that CMake language syntax may require escapes to specify some +values). This property may be set on a per-configuration basis using +the name COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case +name (ex. "COMPILE_DEFINITIONS_DEBUG"). This property will be +initialized in each directory by its value in the directory's parent. + +CMake will automatically drop some definitions that are not supported +by the native build tool. The VS6 IDE does not support definition +values with spaces (but NMake does). + +Disclaimer: Most native build tools have poor support for escaping +certain values. CMake has work-arounds for many cases but some values +may just not be possible to pass correctly. If a value does not seem +to be escaped correctly, do not attempt to work-around the problem by +adding escape sequences to the value. Your work-around may break in a +future version of CMake that has improved escape support. Instead +consider defining the macro in a (configured) header file. Then +report the limitation. Known limitations include: + +:: + + # - broken almost everywhere + ; - broken in VS IDE 7.0 and Borland Makefiles + , - broken in VS IDE + % - broken in some cases in NMake + & | - broken in some cases on MinGW + ^ < > \" - broken in most Make tools on Windows + +CMake does not reject these values outright because they do work in +some cases. Use with caution. diff --git a/Help/prop_dir/COMPILE_DEFINITIONS_CONFIG.rst b/Help/prop_dir/COMPILE_DEFINITIONS_CONFIG.rst new file mode 100644 index 0000000..0876ddf --- /dev/null +++ b/Help/prop_dir/COMPILE_DEFINITIONS_CONFIG.rst @@ -0,0 +1,8 @@ +COMPILE_DEFINITIONS_<CONFIG> +---------------------------- + +Per-configuration preprocessor definitions in a directory. + +This is the configuration-specific version of COMPILE_DEFINITIONS. +This property will be initialized in each directory by its value in +the directory's parent. diff --git a/Help/prop_dir/COMPILE_OPTIONS.rst b/Help/prop_dir/COMPILE_OPTIONS.rst new file mode 100644 index 0000000..821b4f6 --- /dev/null +++ b/Help/prop_dir/COMPILE_OPTIONS.rst @@ -0,0 +1,86 @@ +COMPILE_OPTIONS +--------------- + +List of options to pass to the compiler. + +This property specifies the list of directories given so far for this +property. This property exists on directories and targets. + +The target property values are used by the generators to set the +options for the compiler. + +Contents of COMPILE_OPTIONS may use "generator expressions" with the +syntax "$<...>". Generator expressions are evaluated during build +system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_dir/DEFINITIONS.rst b/Help/prop_dir/DEFINITIONS.rst new file mode 100644 index 0000000..22f7c15 --- /dev/null +++ b/Help/prop_dir/DEFINITIONS.rst @@ -0,0 +1,8 @@ +DEFINITIONS +----------- + +For CMake 2.4 compatibility only. Use COMPILE_DEFINITIONS instead. + +This read-only property specifies the list of flags given so far to +the add_definitions command. It is intended for debugging purposes. +Use the COMPILE_DEFINITIONS instead. diff --git a/Help/prop_dir/EXCLUDE_FROM_ALL.rst b/Help/prop_dir/EXCLUDE_FROM_ALL.rst new file mode 100644 index 0000000..1aa24e4 --- /dev/null +++ b/Help/prop_dir/EXCLUDE_FROM_ALL.rst @@ -0,0 +1,9 @@ +EXCLUDE_FROM_ALL +---------------- + +Exclude the directory from the all target of its parent. + +A property on a directory that indicates if its targets are excluded +from the default build target. If it is not, then with a Makefile for +example typing make will cause the targets to be built. The same +concept applies to the default build of other generators. diff --git a/Help/prop_dir/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst b/Help/prop_dir/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst new file mode 100644 index 0000000..993f620 --- /dev/null +++ b/Help/prop_dir/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst @@ -0,0 +1,34 @@ +IMPLICIT_DEPENDS_INCLUDE_TRANSFORM +---------------------------------- + +Specify #include line transforms for dependencies in a directory. + +This property specifies rules to transform macro-like #include lines +during implicit dependency scanning of C and C++ source files. The +list of rules must be semicolon-separated with each entry of the form +"A_MACRO(%)=value-with-%" (the % must be literal). During dependency +scanning occurrences of A_MACRO(...) on #include lines will be +replaced by the value given with the macro argument substituted for +'%'. For example, the entry + +:: + + MYDIR(%)=<mydir/%> + +will convert lines of the form + +:: + + #include MYDIR(myheader.h) + +to + +:: + + #include <mydir/myheader.h> + +allowing the dependency to be followed. + +This property applies to sources in all targets within a directory. +The property value is initialized in each directory by its value in +the directory's parent. diff --git a/Help/prop_dir/INCLUDE_DIRECTORIES.rst b/Help/prop_dir/INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000..6c5782f --- /dev/null +++ b/Help/prop_dir/INCLUDE_DIRECTORIES.rst @@ -0,0 +1,18 @@ +INCLUDE_DIRECTORIES +------------------- + +List of preprocessor include file search directories. + +This property specifies the list of directories given so far to the +include_directories command. This property exists on directories and +targets. In addition to accepting values from the include_directories +command, values may be set directly on any directory or any target +using the set_property command. A target gets its initial value for +this property from the value of the directory property. A directory +gets its initial value from its parent directory if it has one. Both +directory and target property values are adjusted by calls to the +include_directories command. + +The target property values are used by the generators to set the +include paths for the compiler. See also the include_directories +command. diff --git a/Help/prop_dir/INCLUDE_REGULAR_EXPRESSION.rst b/Help/prop_dir/INCLUDE_REGULAR_EXPRESSION.rst new file mode 100644 index 0000000..befafa5 --- /dev/null +++ b/Help/prop_dir/INCLUDE_REGULAR_EXPRESSION.rst @@ -0,0 +1,8 @@ +INCLUDE_REGULAR_EXPRESSION +-------------------------- + +Include file scanning regular expression. + +This read-only property specifies the regular expression used during +dependency scanning to match include files that should be followed. +See the include_regular_expression command. diff --git a/Help/prop_dir/INTERPROCEDURAL_OPTIMIZATION.rst b/Help/prop_dir/INTERPROCEDURAL_OPTIMIZATION.rst new file mode 100644 index 0000000..0c78dfb --- /dev/null +++ b/Help/prop_dir/INTERPROCEDURAL_OPTIMIZATION.rst @@ -0,0 +1,7 @@ +INTERPROCEDURAL_OPTIMIZATION +---------------------------- + +Enable interprocedural optimization for targets in a directory. + +If set to true, enables interprocedural optimizations if they are +known to be supported by the compiler. diff --git a/Help/prop_dir/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst b/Help/prop_dir/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst new file mode 100644 index 0000000..32520865 --- /dev/null +++ b/Help/prop_dir/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst @@ -0,0 +1,8 @@ +INTERPROCEDURAL_OPTIMIZATION_<CONFIG> +------------------------------------- + +Per-configuration interprocedural optimization for a directory. + +This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION. +If set, this property overrides the generic property for the named +configuration. diff --git a/Help/prop_dir/LINK_DIRECTORIES.rst b/Help/prop_dir/LINK_DIRECTORIES.rst new file mode 100644 index 0000000..fa37576 --- /dev/null +++ b/Help/prop_dir/LINK_DIRECTORIES.rst @@ -0,0 +1,8 @@ +LINK_DIRECTORIES +---------------- + +List of linker search directories. + +This read-only property specifies the list of directories given so far +to the link_directories command. It is intended for debugging +purposes. diff --git a/Help/prop_dir/LISTFILE_STACK.rst b/Help/prop_dir/LISTFILE_STACK.rst new file mode 100644 index 0000000..f729c1e --- /dev/null +++ b/Help/prop_dir/LISTFILE_STACK.rst @@ -0,0 +1,9 @@ +LISTFILE_STACK +-------------- + +The current stack of listfiles being processed. + +This property is mainly useful when trying to debug errors in your +CMake scripts. It returns a list of what list files are currently +being processed, in order. So if one listfile does an INCLUDE command +then that is effectively pushing the included listfile onto the stack. diff --git a/Help/prop_dir/MACROS.rst b/Help/prop_dir/MACROS.rst new file mode 100644 index 0000000..e4feada --- /dev/null +++ b/Help/prop_dir/MACROS.rst @@ -0,0 +1,8 @@ +MACROS +------ + +List of macro commands available in the current directory. + +This read-only property specifies the list of CMake macros currently +defined. It is intended for debugging purposes. See the macro +command. diff --git a/Help/prop_dir/PARENT_DIRECTORY.rst b/Help/prop_dir/PARENT_DIRECTORY.rst new file mode 100644 index 0000000..3bc5824 --- /dev/null +++ b/Help/prop_dir/PARENT_DIRECTORY.rst @@ -0,0 +1,8 @@ +PARENT_DIRECTORY +---------------- + +Source directory that added current subdirectory. + +This read-only property specifies the source directory that added the +current source directory as a subdirectory of the build. In the +top-level directory the value is the empty-string. diff --git a/Help/prop_dir/RULE_LAUNCH_COMPILE.rst b/Help/prop_dir/RULE_LAUNCH_COMPILE.rst new file mode 100644 index 0000000..342d0ae --- /dev/null +++ b/Help/prop_dir/RULE_LAUNCH_COMPILE.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_COMPILE +------------------- + +Specify a launcher for compile rules. + +See the global property of the same name for details. This overrides +the global property for a directory. diff --git a/Help/prop_dir/RULE_LAUNCH_CUSTOM.rst b/Help/prop_dir/RULE_LAUNCH_CUSTOM.rst new file mode 100644 index 0000000..93d1e01 --- /dev/null +++ b/Help/prop_dir/RULE_LAUNCH_CUSTOM.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_CUSTOM +------------------ + +Specify a launcher for custom rules. + +See the global property of the same name for details. This overrides +the global property for a directory. diff --git a/Help/prop_dir/RULE_LAUNCH_LINK.rst b/Help/prop_dir/RULE_LAUNCH_LINK.rst new file mode 100644 index 0000000..3cfb236 --- /dev/null +++ b/Help/prop_dir/RULE_LAUNCH_LINK.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_LINK +---------------- + +Specify a launcher for link rules. + +See the global property of the same name for details. This overrides +the global property for a directory. diff --git a/Help/prop_dir/TEST_INCLUDE_FILE.rst b/Help/prop_dir/TEST_INCLUDE_FILE.rst new file mode 100644 index 0000000..e477951 --- /dev/null +++ b/Help/prop_dir/TEST_INCLUDE_FILE.rst @@ -0,0 +1,7 @@ +TEST_INCLUDE_FILE +----------------- + +A cmake file that will be included when ctest is run. + +If you specify TEST_INCLUDE_FILE, that file will be included and +processed when ctest is run on the directory. diff --git a/Help/prop_dir/VARIABLES.rst b/Help/prop_dir/VARIABLES.rst new file mode 100644 index 0000000..0328295 --- /dev/null +++ b/Help/prop_dir/VARIABLES.rst @@ -0,0 +1,7 @@ +VARIABLES +--------- + +List of variables defined in the current directory. + +This read-only property specifies the list of CMake variables +currently defined. It is intended for debugging purposes. diff --git a/Help/prop_dir/VS_GLOBAL_SECTION_POST_section.rst b/Help/prop_dir/VS_GLOBAL_SECTION_POST_section.rst new file mode 100644 index 0000000..eb91832 --- /dev/null +++ b/Help/prop_dir/VS_GLOBAL_SECTION_POST_section.rst @@ -0,0 +1,29 @@ +VS_GLOBAL_SECTION_POST_<section> +-------------------------------- + +Specify a postSolution global section in Visual Studio. + +Setting a property like this generates an entry of the following form +in the solution file: + +:: + + GlobalSection(<section>) = postSolution + <contents based on property value> + EndGlobalSection + +The property must be set to a semicolon-separated list of key=value +pairs. Each such pair will be transformed into an entry in the +solution global section. Whitespace around key and value is ignored. +List elements which do not contain an equal sign are skipped. + +This property only works for Visual Studio 7 and above; it is ignored +on other generators. The property only applies when set on a +directory whose CMakeLists.txt contains a project() command. + +Note that CMake generates postSolution sections ExtensibilityGlobals +and ExtensibilityAddIns by default. If you set the corresponding +property, it will override the default section. For example, setting +VS_GLOBAL_SECTION_POST_ExtensibilityGlobals will override the default +contents of the ExtensibilityGlobals section, while keeping +ExtensibilityAddIns on its default. diff --git a/Help/prop_dir/VS_GLOBAL_SECTION_PRE_section.rst b/Help/prop_dir/VS_GLOBAL_SECTION_PRE_section.rst new file mode 100644 index 0000000..fbcd9e6 --- /dev/null +++ b/Help/prop_dir/VS_GLOBAL_SECTION_PRE_section.rst @@ -0,0 +1,22 @@ +VS_GLOBAL_SECTION_PRE_<section> +------------------------------- + +Specify a preSolution global section in Visual Studio. + +Setting a property like this generates an entry of the following form +in the solution file: + +:: + + GlobalSection(<section>) = preSolution + <contents based on property value> + EndGlobalSection + +The property must be set to a semicolon-separated list of key=value +pairs. Each such pair will be transformed into an entry in the +solution global section. Whitespace around key and value is ignored. +List elements which do not contain an equal sign are skipped. + +This property only works for Visual Studio 7 and above; it is ignored +on other generators. The property only applies when set on a +directory whose CMakeLists.txt contains a project() command. diff --git a/Help/prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS.rst b/Help/prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS.rst new file mode 100644 index 0000000..8fab503 --- /dev/null +++ b/Help/prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS.rst @@ -0,0 +1,19 @@ +ALLOW_DUPLICATE_CUSTOM_TARGETS +------------------------------ + +Allow duplicate custom targets to be created. + +Normally CMake requires that all targets built in a project have +globally unique logical names (see policy CMP0002). This is necessary +to generate meaningful project file names in Xcode and VS IDE +generators. It also allows the target names to be referenced +unambiguously. + +Makefile generators are capable of supporting duplicate custom target +names. For projects that care only about Makefile generators and do +not wish to support Xcode or VS IDE generators, one may set this +property to true to allow duplicate custom targets. The property +allows multiple add_custom_target command calls in different +directories to specify the same target name. However, setting this +property will cause non-Makefile generators to produce an error and +refuse to generate the project. diff --git a/Help/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst b/Help/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst new file mode 100644 index 0000000..9fe890c --- /dev/null +++ b/Help/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst @@ -0,0 +1,8 @@ +AUTOMOC_TARGETS_FOLDER +---------------------- + +Name of FOLDER for *_automoc targets that are added automatically by CMake for targets for which AUTOMOC is enabled. + +If not set, CMake uses the FOLDER property of the parent target as a +default value for this property. See also the documentation for the +FOLDER target property and the AUTOMOC target property. diff --git a/Help/prop_gbl/DEBUG_CONFIGURATIONS.rst b/Help/prop_gbl/DEBUG_CONFIGURATIONS.rst new file mode 100644 index 0000000..690143f --- /dev/null +++ b/Help/prop_gbl/DEBUG_CONFIGURATIONS.rst @@ -0,0 +1,14 @@ +DEBUG_CONFIGURATIONS +-------------------- + +Specify which configurations are for debugging. + +The value must be a semi-colon separated list of configuration names. +Currently this property is used only by the target_link_libraries +command (see its documentation for details). Additional uses may be +defined in the future. + +This property must be set at the top level of the project and before +the first target_link_libraries command invocation. If any entry in +the list does not match a valid configuration for the project the +behavior is undefined. diff --git a/Help/prop_gbl/DISABLED_FEATURES.rst b/Help/prop_gbl/DISABLED_FEATURES.rst new file mode 100644 index 0000000..111cdf6 --- /dev/null +++ b/Help/prop_gbl/DISABLED_FEATURES.rst @@ -0,0 +1,11 @@ +DISABLED_FEATURES +----------------- + +List of features which are disabled during the CMake run. + +List of features which are disabled during the CMake run. By default +it contains the names of all packages which were not found. This is +determined using the <NAME>_FOUND variables. Packages which are +searched QUIET are not listed. A project can add its own features to +this list. This property is used by the macros in +FeatureSummary.cmake. diff --git a/Help/prop_gbl/ENABLED_FEATURES.rst b/Help/prop_gbl/ENABLED_FEATURES.rst new file mode 100644 index 0000000..b03da5a --- /dev/null +++ b/Help/prop_gbl/ENABLED_FEATURES.rst @@ -0,0 +1,11 @@ +ENABLED_FEATURES +---------------- + +List of features which are enabled during the CMake run. + +List of features which are enabled during the CMake run. By default +it contains the names of all packages which were found. This is +determined using the <NAME>_FOUND variables. Packages which are +searched QUIET are not listed. A project can add its own features to +this list. This property is used by the macros in +FeatureSummary.cmake. diff --git a/Help/prop_gbl/ENABLED_LANGUAGES.rst b/Help/prop_gbl/ENABLED_LANGUAGES.rst new file mode 100644 index 0000000..43e3c09 --- /dev/null +++ b/Help/prop_gbl/ENABLED_LANGUAGES.rst @@ -0,0 +1,6 @@ +ENABLED_LANGUAGES +----------------- + +Read-only property that contains the list of currently enabled languages + +Set to list of currently enabled languages. diff --git a/Help/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst b/Help/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst new file mode 100644 index 0000000..185246c --- /dev/null +++ b/Help/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst @@ -0,0 +1,9 @@ +FIND_LIBRARY_USE_LIB64_PATHS +---------------------------- + +Whether FIND_LIBRARY should automatically search lib64 directories. + +FIND_LIBRARY_USE_LIB64_PATHS is a boolean specifying whether the +FIND_LIBRARY command should automatically search the lib64 variant of +directories called lib in the search path when building 64-bit +binaries. diff --git a/Help/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst b/Help/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst new file mode 100644 index 0000000..9a3edd8 --- /dev/null +++ b/Help/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst @@ -0,0 +1,9 @@ +FIND_LIBRARY_USE_OPENBSD_VERSIONING +----------------------------------- + +Whether FIND_LIBRARY should find OpenBSD-style shared libraries. + +This property is a boolean specifying whether the FIND_LIBRARY command +should find shared libraries with OpenBSD-style versioned extension: +".so.<major>.<minor>". The property is set to true on OpenBSD and +false on other platforms. diff --git a/Help/prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE.rst b/Help/prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE.rst new file mode 100644 index 0000000..832503b --- /dev/null +++ b/Help/prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE.rst @@ -0,0 +1,8 @@ +GLOBAL_DEPENDS_DEBUG_MODE +------------------------- + +Enable global target dependency graph debug mode. + +CMake automatically analyzes the global inter-target dependency graph +at the beginning of native build system generation. This property +causes it to display details of its analysis to stderr. diff --git a/Help/prop_gbl/GLOBAL_DEPENDS_NO_CYCLES.rst b/Help/prop_gbl/GLOBAL_DEPENDS_NO_CYCLES.rst new file mode 100644 index 0000000..d10661e --- /dev/null +++ b/Help/prop_gbl/GLOBAL_DEPENDS_NO_CYCLES.rst @@ -0,0 +1,10 @@ +GLOBAL_DEPENDS_NO_CYCLES +------------------------ + +Disallow global target dependency graph cycles. + +CMake automatically analyzes the global inter-target dependency graph +at the beginning of native build system generation. It reports an +error if the dependency graph contains a cycle that does not consist +of all STATIC library targets. This property tells CMake to disallow +all cycles completely, even among static libraries. diff --git a/Help/prop_gbl/IN_TRY_COMPILE.rst b/Help/prop_gbl/IN_TRY_COMPILE.rst new file mode 100644 index 0000000..3a2ef5b --- /dev/null +++ b/Help/prop_gbl/IN_TRY_COMPILE.rst @@ -0,0 +1,6 @@ +IN_TRY_COMPILE +-------------- + +Read-only property that is true during a try-compile configuration. + +True when building a project inside a TRY_COMPILE or TRY_RUN command. diff --git a/Help/prop_gbl/PACKAGES_FOUND.rst b/Help/prop_gbl/PACKAGES_FOUND.rst new file mode 100644 index 0000000..61cce1f --- /dev/null +++ b/Help/prop_gbl/PACKAGES_FOUND.rst @@ -0,0 +1,7 @@ +PACKAGES_FOUND +-------------- + +List of packages which were found during the CMake run. + +List of packages which were found during the CMake run. Whether a +package has been found is determined using the <NAME>_FOUND variables. diff --git a/Help/prop_gbl/PACKAGES_NOT_FOUND.rst b/Help/prop_gbl/PACKAGES_NOT_FOUND.rst new file mode 100644 index 0000000..ca3c5ba --- /dev/null +++ b/Help/prop_gbl/PACKAGES_NOT_FOUND.rst @@ -0,0 +1,7 @@ +PACKAGES_NOT_FOUND +------------------ + +List of packages which were not found during the CMake run. + +List of packages which were not found during the CMake run. Whether a +package has been found is determined using the <NAME>_FOUND variables. diff --git a/Help/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst b/Help/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst new file mode 100644 index 0000000..e85b823 --- /dev/null +++ b/Help/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst @@ -0,0 +1,9 @@ +PREDEFINED_TARGETS_FOLDER +------------------------- + +Name of FOLDER for targets that are added automatically by CMake. + +If not set, CMake uses "CMakePredefinedTargets" as a default value for +this property. Targets such as INSTALL, PACKAGE and RUN_TESTS will be +organized into this FOLDER. See also the documentation for the FOLDER +target property. diff --git a/Help/prop_gbl/REPORT_UNDEFINED_PROPERTIES.rst b/Help/prop_gbl/REPORT_UNDEFINED_PROPERTIES.rst new file mode 100644 index 0000000..29ba365 --- /dev/null +++ b/Help/prop_gbl/REPORT_UNDEFINED_PROPERTIES.rst @@ -0,0 +1,8 @@ +REPORT_UNDEFINED_PROPERTIES +--------------------------- + +If set, report any undefined properties to this file. + +If this property is set to a filename then when CMake runs it will +report any properties or variables that were accessed but not defined +into the filename specified in this property. diff --git a/Help/prop_gbl/RULE_LAUNCH_COMPILE.rst b/Help/prop_gbl/RULE_LAUNCH_COMPILE.rst new file mode 100644 index 0000000..980843b --- /dev/null +++ b/Help/prop_gbl/RULE_LAUNCH_COMPILE.rst @@ -0,0 +1,9 @@ +RULE_LAUNCH_COMPILE +------------------- + +Specify a launcher for compile rules. + +Makefile generators prefix compiler commands with the given launcher +command line. This is intended to allow launchers to intercept build +problems with high granularity. Non-Makefile generators currently +ignore this property. diff --git a/Help/prop_gbl/RULE_LAUNCH_CUSTOM.rst b/Help/prop_gbl/RULE_LAUNCH_CUSTOM.rst new file mode 100644 index 0000000..9d4a25c --- /dev/null +++ b/Help/prop_gbl/RULE_LAUNCH_CUSTOM.rst @@ -0,0 +1,9 @@ +RULE_LAUNCH_CUSTOM +------------------ + +Specify a launcher for custom rules. + +Makefile generators prefix custom commands with the given launcher +command line. This is intended to allow launchers to intercept build +problems with high granularity. Non-Makefile generators currently +ignore this property. diff --git a/Help/prop_gbl/RULE_LAUNCH_LINK.rst b/Help/prop_gbl/RULE_LAUNCH_LINK.rst new file mode 100644 index 0000000..191f1d5 --- /dev/null +++ b/Help/prop_gbl/RULE_LAUNCH_LINK.rst @@ -0,0 +1,9 @@ +RULE_LAUNCH_LINK +---------------- + +Specify a launcher for link rules. + +Makefile generators prefix link and archive commands with the given +launcher command line. This is intended to allow launchers to +intercept build problems with high granularity. Non-Makefile +generators currently ignore this property. diff --git a/Help/prop_gbl/RULE_MESSAGES.rst b/Help/prop_gbl/RULE_MESSAGES.rst new file mode 100644 index 0000000..38d83a3 --- /dev/null +++ b/Help/prop_gbl/RULE_MESSAGES.rst @@ -0,0 +1,13 @@ +RULE_MESSAGES +------------- + +Specify whether to report a message for each make rule. + +This property specifies whether Makefile generators should add a +progress message describing what each build rule does. If the +property is not set the default is ON. Set the property to OFF to +disable granular messages and report only as each target completes. +This is intended to allow scripted builds to avoid the build time cost +of detailed reports. If a CMAKE_RULE_MESSAGES cache entry exists its +value initializes the value of this property. Non-Makefile generators +currently ignore this property. diff --git a/Help/prop_gbl/TARGET_ARCHIVES_MAY_BE_SHARED_LIBS.rst b/Help/prop_gbl/TARGET_ARCHIVES_MAY_BE_SHARED_LIBS.rst new file mode 100644 index 0000000..930feba --- /dev/null +++ b/Help/prop_gbl/TARGET_ARCHIVES_MAY_BE_SHARED_LIBS.rst @@ -0,0 +1,7 @@ +TARGET_ARCHIVES_MAY_BE_SHARED_LIBS +---------------------------------- + +Set if shared libraries may be named like archives. + +On AIX shared libraries may be named "lib<name>.a". This property is +set to true on such platforms. diff --git a/Help/prop_gbl/TARGET_SUPPORTS_SHARED_LIBS.rst b/Help/prop_gbl/TARGET_SUPPORTS_SHARED_LIBS.rst new file mode 100644 index 0000000..f6e89fb --- /dev/null +++ b/Help/prop_gbl/TARGET_SUPPORTS_SHARED_LIBS.rst @@ -0,0 +1,9 @@ +TARGET_SUPPORTS_SHARED_LIBS +--------------------------- + +Does the target platform support shared libraries. + +TARGET_SUPPORTS_SHARED_LIBS is a boolean specifying whether the target +platform supports shared libraries. Basically all current general +general purpose OS do so, the exception are usually embedded systems +with no or special OSs. diff --git a/Help/prop_gbl/USE_FOLDERS.rst b/Help/prop_gbl/USE_FOLDERS.rst new file mode 100644 index 0000000..fdbca9f --- /dev/null +++ b/Help/prop_gbl/USE_FOLDERS.rst @@ -0,0 +1,9 @@ +USE_FOLDERS +----------- + +Use the FOLDER target property to organize targets into folders. + +If not set, CMake treats this property as OFF by default. CMake +generators that are capable of organizing into a hierarchy of folders +use the values of the FOLDER target property to name those folders. +See also the documentation for the FOLDER target property. diff --git a/Help/prop_sf/ABSTRACT.rst b/Help/prop_sf/ABSTRACT.rst new file mode 100644 index 0000000..339d115 --- /dev/null +++ b/Help/prop_sf/ABSTRACT.rst @@ -0,0 +1,9 @@ +ABSTRACT +-------- + +Is this source file an abstract class. + +A property on a source file that indicates if the source file +represents a class that is abstract. This only makes sense for +languages that have a notion of an abstract class and it is only used +by some tools that wrap classes into other languages. diff --git a/Help/prop_sf/COMPILE_DEFINITIONS.rst b/Help/prop_sf/COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000..334b158 --- /dev/null +++ b/Help/prop_sf/COMPILE_DEFINITIONS.rst @@ -0,0 +1,39 @@ +COMPILE_DEFINITIONS +------------------- + +Preprocessor definitions for compiling a source file. + +The COMPILE_DEFINITIONS property may be set to a semicolon-separated +list of preprocessor definitions using the syntax VAR or VAR=value. +Function-style definitions are not supported. CMake will +automatically escape the value correctly for the native build system +(note that CMake language syntax may require escapes to specify some +values). This property may be set on a per-configuration basis using +the name COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case +name (ex. "COMPILE_DEFINITIONS_DEBUG"). + +CMake will automatically drop some definitions that are not supported +by the native build tool. The VS6 IDE does not support definition +values with spaces (but NMake does). Xcode does not support +per-configuration definitions on source files. + +Disclaimer: Most native build tools have poor support for escaping +certain values. CMake has work-arounds for many cases but some values +may just not be possible to pass correctly. If a value does not seem +to be escaped correctly, do not attempt to work-around the problem by +adding escape sequences to the value. Your work-around may break in a +future version of CMake that has improved escape support. Instead +consider defining the macro in a (configured) header file. Then +report the limitation. Known limitations include: + +:: + + # - broken almost everywhere + ; - broken in VS IDE 7.0 and Borland Makefiles + , - broken in VS IDE + % - broken in some cases in NMake + & | - broken in some cases on MinGW + ^ < > \" - broken in most Make tools on Windows + +CMake does not reject these values outright because they do work in +some cases. Use with caution. diff --git a/Help/prop_sf/COMPILE_DEFINITIONS_CONFIG.rst b/Help/prop_sf/COMPILE_DEFINITIONS_CONFIG.rst new file mode 100644 index 0000000..e695f38 --- /dev/null +++ b/Help/prop_sf/COMPILE_DEFINITIONS_CONFIG.rst @@ -0,0 +1,8 @@ +COMPILE_DEFINITIONS_<CONFIG> +---------------------------- + +Per-configuration preprocessor definitions on a source file. + +This is the configuration-specific version of COMPILE_DEFINITIONS. +Note that Xcode does not support per-configuration source file flags +so this property will be ignored by the Xcode generator. diff --git a/Help/prop_sf/COMPILE_FLAGS.rst b/Help/prop_sf/COMPILE_FLAGS.rst new file mode 100644 index 0000000..daba502 --- /dev/null +++ b/Help/prop_sf/COMPILE_FLAGS.rst @@ -0,0 +1,8 @@ +COMPILE_FLAGS +------------- + +Additional flags to be added when compiling this source file. + +These flags will be added to the list of compile flags when this +source file builds. Use COMPILE_DEFINITIONS to pass additional +preprocessor definitions. diff --git a/Help/prop_sf/EXTERNAL_OBJECT.rst b/Help/prop_sf/EXTERNAL_OBJECT.rst new file mode 100644 index 0000000..efa0e9b --- /dev/null +++ b/Help/prop_sf/EXTERNAL_OBJECT.rst @@ -0,0 +1,8 @@ +EXTERNAL_OBJECT +--------------- + +If set to true then this is an object file. + +If this property is set to true then the source file is really an +object file and should not be compiled. It will still be linked into +the target though. diff --git a/Help/prop_sf/Fortran_FORMAT.rst b/Help/prop_sf/Fortran_FORMAT.rst new file mode 100644 index 0000000..69e34aa --- /dev/null +++ b/Help/prop_sf/Fortran_FORMAT.rst @@ -0,0 +1,9 @@ +Fortran_FORMAT +-------------- + +Set to FIXED or FREE to indicate the Fortran source layout. + +This property tells CMake whether a given Fortran source file uses +fixed-format or free-format. CMake will pass the corresponding format +flag to the compiler. Consider using the target-wide Fortran_FORMAT +property if all source files in a target share the same format. diff --git a/Help/prop_sf/GENERATED.rst b/Help/prop_sf/GENERATED.rst new file mode 100644 index 0000000..a3aa127 --- /dev/null +++ b/Help/prop_sf/GENERATED.rst @@ -0,0 +1,8 @@ +GENERATED +--------- + +Is this source file generated as part of the build process. + +If a source file is generated by the build process CMake will handle +it differently in terms of dependency checking etc. Otherwise having +a non-existent source file could create problems. diff --git a/Help/prop_sf/HEADER_FILE_ONLY.rst b/Help/prop_sf/HEADER_FILE_ONLY.rst new file mode 100644 index 0000000..b4fb2db --- /dev/null +++ b/Help/prop_sf/HEADER_FILE_ONLY.rst @@ -0,0 +1,9 @@ +HEADER_FILE_ONLY +---------------- + +Is this source file only a header file. + +A property on a source file that indicates if the source file is a +header file with no associated implementation. This is set +automatically based on the file extension and is used by CMake to +determine if certain dependency information should be computed. diff --git a/Help/prop_sf/KEEP_EXTENSION.rst b/Help/prop_sf/KEEP_EXTENSION.rst new file mode 100644 index 0000000..d6167e5 --- /dev/null +++ b/Help/prop_sf/KEEP_EXTENSION.rst @@ -0,0 +1,9 @@ +KEEP_EXTENSION +-------------- + +Make the output file have the same extension as the source file. + +If this property is set then the file extension of the output file +will be the same as that of the source file. Normally the output file +extension is computed based on the language of the source file, for +example .cxx will go to a .o extension. diff --git a/Help/prop_sf/LABELS.rst b/Help/prop_sf/LABELS.rst new file mode 100644 index 0000000..e1c1069 --- /dev/null +++ b/Help/prop_sf/LABELS.rst @@ -0,0 +1,8 @@ +LABELS +------ + +Specify a list of text labels associated with a source file. + +This property has meaning only when the source file is listed in a +target whose LABELS property is also set. No other semantics are +currently specified. diff --git a/Help/prop_sf/LANGUAGE.rst b/Help/prop_sf/LANGUAGE.rst new file mode 100644 index 0000000..97bfa20 --- /dev/null +++ b/Help/prop_sf/LANGUAGE.rst @@ -0,0 +1,10 @@ +LANGUAGE +-------- + +What programming language is the file. + +A property that can be set to indicate what programming language the +source file is. If it is not set the language is determined based on +the file extension. Typical values are CXX C etc. Setting this +property for a file means this file will be compiled. Do not set this +for headers or files that should not be compiled. diff --git a/Help/prop_sf/LOCATION.rst b/Help/prop_sf/LOCATION.rst new file mode 100644 index 0000000..252d680 --- /dev/null +++ b/Help/prop_sf/LOCATION.rst @@ -0,0 +1,7 @@ +LOCATION +-------- + +The full path to a source file. + +A read only property on a SOURCE FILE that contains the full path to +the source file. diff --git a/Help/prop_sf/MACOSX_PACKAGE_LOCATION.rst b/Help/prop_sf/MACOSX_PACKAGE_LOCATION.rst new file mode 100644 index 0000000..27f2929 --- /dev/null +++ b/Help/prop_sf/MACOSX_PACKAGE_LOCATION.rst @@ -0,0 +1,19 @@ +MACOSX_PACKAGE_LOCATION +----------------------- + +Place a source file inside a Mac OS X bundle, CFBundle, or framework. + +Executable targets with the MACOSX_BUNDLE property set are built as +Mac OS X application bundles on Apple platforms. Shared library +targets with the FRAMEWORK property set are built as Mac OS X +frameworks on Apple platforms. Module library targets with the BUNDLE +property set are built as Mac OS X CFBundle bundles on Apple +platforms. Source files listed in the target with this property set +will be copied to a directory inside the bundle or framework content +folder specified by the property value. For bundles the content +folder is "<name>.app/Contents". For frameworks the content folder is +"<name>.framework/Versions/<version>". For cfbundles the content +folder is "<name>.bundle/Contents" (unless the extension is changed). +See the PUBLIC_HEADER, PRIVATE_HEADER, and RESOURCE target properties +for specifying files meant for Headers, PrivateHeaders, or Resources +directories. diff --git a/Help/prop_sf/OBJECT_DEPENDS.rst b/Help/prop_sf/OBJECT_DEPENDS.rst new file mode 100644 index 0000000..18022de --- /dev/null +++ b/Help/prop_sf/OBJECT_DEPENDS.rst @@ -0,0 +1,18 @@ +OBJECT_DEPENDS +-------------- + +Additional files on which a compiled object file depends. + +Specifies a semicolon-separated list of full-paths to files on which +any object files compiled from this source file depend. An object +file will be recompiled if any of the named files is newer than it. + +This property need not be used to specify the dependency of a source +file on a generated header file that it includes. Although the +property was originally introduced for this purpose, it is no longer +necessary. If the generated header file is created by a custom +command in the same target as the source file, the automatic +dependency scanning process will recognize the dependency. If the +generated header file is created by another target, an inter-target +dependency should be created with the add_dependencies command (if one +does not already exist due to linking relationships). diff --git a/Help/prop_sf/OBJECT_OUTPUTS.rst b/Help/prop_sf/OBJECT_OUTPUTS.rst new file mode 100644 index 0000000..6a28553 --- /dev/null +++ b/Help/prop_sf/OBJECT_OUTPUTS.rst @@ -0,0 +1,9 @@ +OBJECT_OUTPUTS +-------------- + +Additional outputs for a Makefile rule. + +Additional outputs created by compilation of this source file. If any +of these outputs is missing the object will be recompiled. This is +supported only on Makefile generators and will be ignored on other +generators. diff --git a/Help/prop_sf/SYMBOLIC.rst b/Help/prop_sf/SYMBOLIC.rst new file mode 100644 index 0000000..c7d0b26 --- /dev/null +++ b/Help/prop_sf/SYMBOLIC.rst @@ -0,0 +1,8 @@ +SYMBOLIC +-------- + +Is this just a name for a rule. + +If SYMBOLIC (boolean) is set to true the build system will be informed +that the source file is not actually created on disk but instead used +as a symbolic name for a build rule. diff --git a/Help/prop_sf/WRAP_EXCLUDE.rst b/Help/prop_sf/WRAP_EXCLUDE.rst new file mode 100644 index 0000000..2c79f72 --- /dev/null +++ b/Help/prop_sf/WRAP_EXCLUDE.rst @@ -0,0 +1,10 @@ +WRAP_EXCLUDE +------------ + +Exclude this source file from any code wrapping techniques. + +Some packages can wrap source files into alternate languages to +provide additional functionality. For example, C++ code can be +wrapped into Java or Python etc using SWIG etc. If WRAP_EXCLUDE is +set to true (1 etc) that indicates that this source file should not be +wrapped. diff --git a/Help/prop_test/ATTACHED_FILES.rst b/Help/prop_test/ATTACHED_FILES.rst new file mode 100644 index 0000000..496d800 --- /dev/null +++ b/Help/prop_test/ATTACHED_FILES.rst @@ -0,0 +1,7 @@ +ATTACHED_FILES +-------------- + +Attach a list of files to a dashboard submission. + +Set this property to a list of files that will be encoded and +submitted to the dashboard as an addition to the test result. diff --git a/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst b/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst new file mode 100644 index 0000000..6819143 --- /dev/null +++ b/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst @@ -0,0 +1,7 @@ +ATTACHED_FILES_ON_FAIL +---------------------- + +Attach a list of files to a dashboard submission if the test fails. + +Same as ATTACHED_FILES, but these files will only be included if the +test does not pass. diff --git a/Help/prop_test/COST.rst b/Help/prop_test/COST.rst new file mode 100644 index 0000000..3236a02 --- /dev/null +++ b/Help/prop_test/COST.rst @@ -0,0 +1,7 @@ +COST +---- + +Set this to a floating point value. Tests in a test set will be run in descending order of cost. + +This property describes the cost of a test. You can explicitly set +this value; tests with higher COST values will run first. diff --git a/Help/prop_test/DEPENDS.rst b/Help/prop_test/DEPENDS.rst new file mode 100644 index 0000000..ee946d9 --- /dev/null +++ b/Help/prop_test/DEPENDS.rst @@ -0,0 +1,6 @@ +DEPENDS +------- + +Specifies that this test should only be run after the specified list of tests. + +Set this to a list of tests that must finish before this test is run. diff --git a/Help/prop_test/ENVIRONMENT.rst b/Help/prop_test/ENVIRONMENT.rst new file mode 100644 index 0000000..df9bc9e --- /dev/null +++ b/Help/prop_test/ENVIRONMENT.rst @@ -0,0 +1,9 @@ +ENVIRONMENT +----------- + +Specify environment variables that should be defined for running a test. + +If set to a list of environment variables and values of the form +MYVAR=value those environment variables will be defined while running +the test. The environment is restored to its previous state after the +test is done. diff --git a/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst b/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst new file mode 100644 index 0000000..b02d17d --- /dev/null +++ b/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst @@ -0,0 +1,8 @@ +FAIL_REGULAR_EXPRESSION +----------------------- + +If the output matches this regular expression the test will fail. + +If set, if the output matches one of specified regular expressions, +the test will fail.For example: FAIL_REGULAR_EXPRESSION +"[^a-z]Error;ERROR;Failed" diff --git a/Help/prop_test/LABELS.rst b/Help/prop_test/LABELS.rst new file mode 100644 index 0000000..8d75570 --- /dev/null +++ b/Help/prop_test/LABELS.rst @@ -0,0 +1,6 @@ +LABELS +------ + +Specify a list of text labels associated with a test. + +The list is reported in dashboard submissions. diff --git a/Help/prop_test/MEASUREMENT.rst b/Help/prop_test/MEASUREMENT.rst new file mode 100644 index 0000000..bc4936e --- /dev/null +++ b/Help/prop_test/MEASUREMENT.rst @@ -0,0 +1,8 @@ +MEASUREMENT +----------- + +Specify a CDASH measurement and value to be reported for a test. + +If set to a name then that name will be reported to CDASH as a named +measurement with a value of 1. You may also specify a value by +setting MEASUREMENT to "measurement=value". diff --git a/Help/prop_test/PASS_REGULAR_EXPRESSION.rst b/Help/prop_test/PASS_REGULAR_EXPRESSION.rst new file mode 100644 index 0000000..bb35f77 --- /dev/null +++ b/Help/prop_test/PASS_REGULAR_EXPRESSION.rst @@ -0,0 +1,8 @@ +PASS_REGULAR_EXPRESSION +----------------------- + +The output must match this regular expression for the test to pass. + +If set, the test output will be checked against the specified regular +expressions and at least one of the regular expressions has to match, +otherwise the test will fail. diff --git a/Help/prop_test/PROCESSORS.rst b/Help/prop_test/PROCESSORS.rst new file mode 100644 index 0000000..763b6d0 --- /dev/null +++ b/Help/prop_test/PROCESSORS.rst @@ -0,0 +1,8 @@ +PROCESSORS +---------- + +How many process slots this test requires + +Denotes the number of processors that this test will require. This is +typically used for MPI tests, and should be used in conjunction with +the ctest_test PARALLEL_LEVEL option. diff --git a/Help/prop_test/REQUIRED_FILES.rst b/Help/prop_test/REQUIRED_FILES.rst new file mode 100644 index 0000000..fac357c --- /dev/null +++ b/Help/prop_test/REQUIRED_FILES.rst @@ -0,0 +1,7 @@ +REQUIRED_FILES +-------------- + +List of files required to run the test. + +If set to a list of files, the test will not be run unless all of the +files exist. diff --git a/Help/prop_test/RESOURCE_LOCK.rst b/Help/prop_test/RESOURCE_LOCK.rst new file mode 100644 index 0000000..8c30f01 --- /dev/null +++ b/Help/prop_test/RESOURCE_LOCK.rst @@ -0,0 +1,7 @@ +RESOURCE_LOCK +------------- + +Specify a list of resources that are locked by this test. + +If multiple tests specify the same resource lock, they are guaranteed +not to run concurrently. diff --git a/Help/prop_test/RUN_SERIAL.rst b/Help/prop_test/RUN_SERIAL.rst new file mode 100644 index 0000000..8f65ae1 --- /dev/null +++ b/Help/prop_test/RUN_SERIAL.rst @@ -0,0 +1,8 @@ +RUN_SERIAL +---------- + +Do not run this test in parallel with any other test. + +Use this option in conjunction with the ctest_test PARALLEL_LEVEL +option to specify that this test should not be run in parallel with +any other tests. diff --git a/Help/prop_test/TIMEOUT.rst b/Help/prop_test/TIMEOUT.rst new file mode 100644 index 0000000..0b247b8 --- /dev/null +++ b/Help/prop_test/TIMEOUT.rst @@ -0,0 +1,9 @@ +TIMEOUT +------- + +How many seconds to allow for this test. + +This property if set will limit a test to not take more than the +specified number of seconds to run. If it exceeds that the test +process will be killed and ctest will move to the next test. This +setting takes precedence over CTEST_TESTING_TIMEOUT. diff --git a/Help/prop_test/WILL_FAIL.rst b/Help/prop_test/WILL_FAIL.rst new file mode 100644 index 0000000..f1f94a4 --- /dev/null +++ b/Help/prop_test/WILL_FAIL.rst @@ -0,0 +1,7 @@ +WILL_FAIL +--------- + +If set to true, this will invert the pass/fail flag of the test. + +This property can be used for tests that are expected to fail and +return a non zero return code. diff --git a/Help/prop_test/WORKING_DIRECTORY.rst b/Help/prop_test/WORKING_DIRECTORY.rst new file mode 100644 index 0000000..5222a19 --- /dev/null +++ b/Help/prop_test/WORKING_DIRECTORY.rst @@ -0,0 +1,7 @@ +WORKING_DIRECTORY +----------------- + +The directory from which the test executable will be called. + +If this is not set it is called from the directory the test executable +is located in. diff --git a/Help/prop_tgt/ALIASED_TARGET.rst b/Help/prop_tgt/ALIASED_TARGET.rst new file mode 100644 index 0000000..0af4365 --- /dev/null +++ b/Help/prop_tgt/ALIASED_TARGET.rst @@ -0,0 +1,7 @@ +ALIASED_TARGET +-------------- + +Name of target aliased by this target. + +If this is an ALIAS target, this property contains the name of the +target aliased. diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..f8efefb --- /dev/null +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst @@ -0,0 +1,18 @@ +ARCHIVE_OUTPUT_DIRECTORY +------------------------ + +Output directory in which to build ARCHIVE target files. + +This property specifies the directory into which archive target files +should be built. Multi-configuration generators (VS, Xcode) append a +per-configuration subdirectory to the specified directory. There are +three kinds of target files that may be built: archive, library, and +runtime. Executables are always treated as runtime targets. Static +libraries are always treated as archive targets. Module libraries are +always treated as library targets. For non-DLL platforms shared +libraries are treated as library targets. For DLL platforms the DLL +part of a shared library is treated as a runtime target and the +corresponding import library is treated as an archive target. All +Windows-based systems including Cygwin are DLL platforms. This +property is initialized by the value of the variable +CMAKE_ARCHIVE_OUTPUT_DIRECTORY if it is set when a target is created. diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000..3c0c4fd --- /dev/null +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,11 @@ +ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> +--------------------------------- + +Per-configuration output directory for ARCHIVE target files. + +This is a per-configuration version of ARCHIVE_OUTPUT_DIRECTORY, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the variable +CMAKE_ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is +created. diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst new file mode 100644 index 0000000..4784aff --- /dev/null +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst @@ -0,0 +1,15 @@ +ARCHIVE_OUTPUT_NAME +------------------- + +Output name for ARCHIVE target files. + +This property specifies the base name for archive target files. It +overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. There are +three kinds of target files that may be built: archive, library, and +runtime. Executables are always treated as runtime targets. Static +libraries are always treated as archive targets. Module libraries are +always treated as library targets. For non-DLL platforms shared +libraries are treated as library targets. For DLL platforms the DLL +part of a shared library is treated as a runtime target and the +corresponding import library is treated as an archive target. All +Windows-based systems including Cygwin are DLL platforms. diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000..314fa58 --- /dev/null +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,6 @@ +ARCHIVE_OUTPUT_NAME_<CONFIG> +---------------------------- + +Per-configuration output name for ARCHIVE target files. + +This is the configuration-specific version of ARCHIVE_OUTPUT_NAME. diff --git a/Help/prop_tgt/AUTOMOC.rst b/Help/prop_tgt/AUTOMOC.rst new file mode 100644 index 0000000..8af1116 --- /dev/null +++ b/Help/prop_tgt/AUTOMOC.rst @@ -0,0 +1,31 @@ +AUTOMOC +------- + +Should the target be processed with automoc (for Qt projects). + +AUTOMOC is a boolean specifying whether CMake will handle the Qt moc +preprocessor automatically, i.e. without having to use the +QT4_WRAP_CPP() or QT5_WRAP_CPP() macro. Currently Qt4 and Qt5 are +supported. When this property is set to TRUE, CMake will scan the +source files at build time and invoke moc accordingly. If an #include +statement like #include "moc_foo.cpp" is found, the Q_OBJECT class +declaration is expected in the header, and moc is run on the header +file. If an #include statement like #include "foo.moc" is found, then +a Q_OBJECT is expected in the current source file and moc is run on +the file itself. Additionally, all header files are parsed for +Q_OBJECT macros, and if found, moc is also executed on those files. +The resulting moc files, which are not included as shown above in any +of the source files are included in a generated +<targetname>_automoc.cpp file, which is compiled as part of the +target.This property is initialized by the value of the variable +CMAKE_AUTOMOC if it is set when a target is created. + +Additional command line options for moc can be set via the +AUTOMOC_MOC_OPTIONS property. + +By setting the CMAKE_AUTOMOC_RELAXED_MODE variable to TRUE the rules +for searching the files which will be processed by moc can be relaxed. +See the documentation for this variable for more details. + +The global property AUTOMOC_TARGETS_FOLDER can be used to group the +automoc targets together in an IDE, e.g. in MSVS. diff --git a/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst b/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst new file mode 100644 index 0000000..6ab5c85 --- /dev/null +++ b/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst @@ -0,0 +1,12 @@ +AUTOMOC_MOC_OPTIONS +------------------- + +Additional options for moc when using automoc (see the AUTOMOC property) + +This property is only used if the AUTOMOC property is set to TRUE for +this target. In this case, it holds additional command line options +which will be used when moc is executed during the build, i.e. it is +equivalent to the optional OPTIONS argument of the qt4_wrap_cpp() +macro. + +By default it is empty. diff --git a/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst b/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst new file mode 100644 index 0000000..abcf28f --- /dev/null +++ b/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst @@ -0,0 +1,11 @@ +BUILD_WITH_INSTALL_RPATH +------------------------ + +Should build tree targets have install tree rpaths. + +BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link the +target in the build tree with the INSTALL_RPATH. This takes +precedence over SKIP_BUILD_RPATH and avoids the need for relinking +before installation. This property is initialized by the value of the +variable CMAKE_BUILD_WITH_INSTALL_RPATH if it is set when a target is +created. diff --git a/Help/prop_tgt/BUNDLE.rst b/Help/prop_tgt/BUNDLE.rst new file mode 100644 index 0000000..166659f --- /dev/null +++ b/Help/prop_tgt/BUNDLE.rst @@ -0,0 +1,9 @@ +BUNDLE +------ + +This target is a CFBundle on the Mac. + +If a module library target has this property set to true it will be +built as a CFBundle when built on the mac. It will have the directory +structure required for a CFBundle and will be suitable to be used for +creating Browser Plugins or other application resources. diff --git a/Help/prop_tgt/BUNDLE_EXTENSION.rst b/Help/prop_tgt/BUNDLE_EXTENSION.rst new file mode 100644 index 0000000..94ac935 --- /dev/null +++ b/Help/prop_tgt/BUNDLE_EXTENSION.rst @@ -0,0 +1,7 @@ +BUNDLE_EXTENSION +---------------- + +The file extension used to name a BUNDLE target on the Mac. + +The default value is "bundle" - you can also use "plugin" or whatever +file extension is required by the host app for your bundle. diff --git a/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst b/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst new file mode 100644 index 0000000..7f95ef0 --- /dev/null +++ b/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst @@ -0,0 +1,17 @@ +COMPATIBLE_INTERFACE_BOOL +------------------------- + +Properties which must be compatible with their link interface + +The COMPATIBLE_INTERFACE_BOOL property may contain a list of +propertiesfor this target which must be consistent when evaluated as a +boolean in the INTERFACE of all linked dependees. For example, if a +property "FOO" appears in the list, then for each dependee, the +"INTERFACE_FOO" property content in all of its dependencies must be +consistent with each other, and with the "FOO" property in the +dependee. Consistency in this sense has the meaning that if the +property is set, then it must have the same boolean value as all +others, and if the property is not set, then it is ignored. Note that +for each dependee, the set of properties from this property must not +intersect with the set of properties from the +COMPATIBLE_INTERFACE_STRING property. diff --git a/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst b/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst new file mode 100644 index 0000000..a461f76 --- /dev/null +++ b/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst @@ -0,0 +1,15 @@ +COMPATIBLE_INTERFACE_STRING +--------------------------- + +Properties which must be string-compatible with their link interface + +The COMPATIBLE_INTERFACE_STRING property may contain a list of +properties for this target which must be the same when evaluated as a +string in the INTERFACE of all linked dependees. For example, if a +property "FOO" appears in the list, then for each dependee, the +"INTERFACE_FOO" property content in all of its dependencies must be +equal with each other, and with the "FOO" property in the dependee. +If the property is not set, then it is ignored. Note that for each +dependee, the set of properties from this property must not intersect +with the set of properties from the COMPATIBLE_INTERFACE_BOOL +property. diff --git a/Help/prop_tgt/COMPILE_DEFINITIONS.rst b/Help/prop_tgt/COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000..dabc022 --- /dev/null +++ b/Help/prop_tgt/COMPILE_DEFINITIONS.rst @@ -0,0 +1,114 @@ +COMPILE_DEFINITIONS +------------------- + +Preprocessor definitions for compiling a target's sources. + +The COMPILE_DEFINITIONS property may be set to a semicolon-separated +list of preprocessor definitions using the syntax VAR or VAR=value. +Function-style definitions are not supported. CMake will +automatically escape the value correctly for the native build system +(note that CMake language syntax may require escapes to specify some +values). This property may be set on a per-configuration basis using +the name COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case +name (ex. "COMPILE_DEFINITIONS_DEBUG"). + +CMake will automatically drop some definitions that are not supported +by the native build tool. The VS6 IDE does not support definition +values with spaces (but NMake does). + +Contents of COMPILE_DEFINITIONS may use "generator expressions" with +the syntax "$<...>". Generator expressions are evaluated during build +system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. + +Disclaimer: Most native build tools have poor support for escaping +certain values. CMake has work-arounds for many cases but some values +may just not be possible to pass correctly. If a value does not seem +to be escaped correctly, do not attempt to work-around the problem by +adding escape sequences to the value. Your work-around may break in a +future version of CMake that has improved escape support. Instead +consider defining the macro in a (configured) header file. Then +report the limitation. Known limitations include: + +:: + + # - broken almost everywhere + ; - broken in VS IDE 7.0 and Borland Makefiles + , - broken in VS IDE + % - broken in some cases in NMake + & | - broken in some cases on MinGW + ^ < > \" - broken in most Make tools on Windows + +CMake does not reject these values outright because they do work in +some cases. Use with caution. diff --git a/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst b/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst new file mode 100644 index 0000000..0adb7dd --- /dev/null +++ b/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst @@ -0,0 +1,6 @@ +COMPILE_DEFINITIONS_<CONFIG> +---------------------------- + +Per-configuration preprocessor definitions on a target. + +This is the configuration-specific version of COMPILE_DEFINITIONS. diff --git a/Help/prop_tgt/COMPILE_FLAGS.rst b/Help/prop_tgt/COMPILE_FLAGS.rst new file mode 100644 index 0000000..6ee6c51 --- /dev/null +++ b/Help/prop_tgt/COMPILE_FLAGS.rst @@ -0,0 +1,11 @@ +COMPILE_FLAGS +------------- + +Additional flags to use when compiling this target's sources. + +The COMPILE_FLAGS property sets additional compiler flags used to +build sources within the target. Use COMPILE_DEFINITIONS to pass +additional preprocessor definitions. + +This property is deprecated. Use the COMPILE_OPTIONS property or the +target_compile_options command instead. diff --git a/Help/prop_tgt/COMPILE_OPTIONS.rst b/Help/prop_tgt/COMPILE_OPTIONS.rst new file mode 100644 index 0000000..d0b6368 --- /dev/null +++ b/Help/prop_tgt/COMPILE_OPTIONS.rst @@ -0,0 +1,86 @@ +COMPILE_OPTIONS +--------------- + +List of options to pass to the compiler. + +This property specifies the list of options specified so far for this +property. This property exists on directories and targets. + +The target property values are used by the generators to set the +options for the compiler. + +Contents of COMPILE_OPTIONS may use "generator expressions" with the +syntax "$<...>". Generator expressions are evaluated during build +system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst b/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst new file mode 100644 index 0000000..f2c875e --- /dev/null +++ b/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst @@ -0,0 +1,7 @@ +<CONFIG>_OUTPUT_NAME +-------------------- + +Old per-configuration target file base name. + +This is a configuration-specific version of OUTPUT_NAME. Use +OUTPUT_NAME_<CONFIG> instead. diff --git a/Help/prop_tgt/CONFIG_POSTFIX.rst b/Help/prop_tgt/CONFIG_POSTFIX.rst new file mode 100644 index 0000000..11b50b9 --- /dev/null +++ b/Help/prop_tgt/CONFIG_POSTFIX.rst @@ -0,0 +1,10 @@ +<CONFIG>_POSTFIX +---------------- + +Postfix to append to the target file name for configuration <CONFIG>. + +When building with configuration <CONFIG> the value of this property +is appended to the target file name built on disk. For non-executable +targets, this property is initialized by the value of the variable +CMAKE_<CONFIG>_POSTFIX if it is set when a target is created. This +property is ignored on the Mac for Frameworks and App Bundles. diff --git a/Help/prop_tgt/DEBUG_POSTFIX.rst b/Help/prop_tgt/DEBUG_POSTFIX.rst new file mode 100644 index 0000000..1487656 --- /dev/null +++ b/Help/prop_tgt/DEBUG_POSTFIX.rst @@ -0,0 +1,7 @@ +DEBUG_POSTFIX +------------- + +See target property <CONFIG>_POSTFIX. + +This property is a special case of the more-general <CONFIG>_POSTFIX +property for the DEBUG configuration. diff --git a/Help/prop_tgt/DEFINE_SYMBOL.rst b/Help/prop_tgt/DEFINE_SYMBOL.rst new file mode 100644 index 0000000..f47f135 --- /dev/null +++ b/Help/prop_tgt/DEFINE_SYMBOL.rst @@ -0,0 +1,11 @@ +DEFINE_SYMBOL +------------- + +Define a symbol when compiling this target's sources. + +DEFINE_SYMBOL sets the name of the preprocessor symbol defined when +compiling sources in a shared library. If not set here then it is set +to target_EXPORTS by default (with some substitutions if the target is +not a valid C identifier). This is useful for headers to know whether +they are being included from inside their library or outside to +properly setup dllexport/dllimport decorations. diff --git a/Help/prop_tgt/ENABLE_EXPORTS.rst b/Help/prop_tgt/ENABLE_EXPORTS.rst new file mode 100644 index 0000000..283f5a8 --- /dev/null +++ b/Help/prop_tgt/ENABLE_EXPORTS.rst @@ -0,0 +1,19 @@ +ENABLE_EXPORTS +-------------- + +Specify whether an executable exports symbols for loadable modules. + +Normally an executable does not export any symbols because it is the +final program. It is possible for an executable to export symbols to +be used by loadable modules. When this property is set to true CMake +will allow other targets to "link" to the executable with the +TARGET_LINK_LIBRARIES command. On all platforms a target-level +dependency on the executable is created for targets that link to it. +For DLL platforms an import library will be created for the exported +symbols and then used for linking. All Windows-based systems +including Cygwin are DLL platforms. For non-DLL platforms that +require all symbols to be resolved at link time, such as Mac OS X, the +module will "link" to the executable using a flag like +"-bundle_loader". For other non-DLL platforms the link rule is simply +ignored since the dynamic loader will automatically bind symbols when +the module is loaded. diff --git a/Help/prop_tgt/EXCLUDE_FROM_ALL.rst b/Help/prop_tgt/EXCLUDE_FROM_ALL.rst new file mode 100644 index 0000000..caa5741 --- /dev/null +++ b/Help/prop_tgt/EXCLUDE_FROM_ALL.rst @@ -0,0 +1,10 @@ +EXCLUDE_FROM_ALL +---------------- + +Exclude the target from the all target. + +A property on a target that indicates if the target is excluded from +the default build target. If it is not, then with a Makefile for +example typing make will cause this target to be built. The same +concept applies to the default build of other generators. Installing +a target with EXCLUDE_FROM_ALL set to true has undefined behavior. diff --git a/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst b/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst new file mode 100644 index 0000000..19270a5 --- /dev/null +++ b/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst @@ -0,0 +1,8 @@ +EXCLUDE_FROM_DEFAULT_BUILD +-------------------------- + +Exclude target from "Build Solution". + +This property is only used by Visual Studio generators 7 and above. +When set to TRUE, the target will not be built when you press "Build +Solution". diff --git a/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst b/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst new file mode 100644 index 0000000..655a9de --- /dev/null +++ b/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst @@ -0,0 +1,9 @@ +EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG> +----------------------------------- + +Per-configuration version of target exclusion from "Build Solution". + +This is the configuration-specific version of +EXCLUDE_FROM_DEFAULT_BUILD. If the generic EXCLUDE_FROM_DEFAULT_BUILD +is also set on a target, EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG> takes +precedence in configurations for which it has a value. diff --git a/Help/prop_tgt/EXPORT_NAME.rst b/Help/prop_tgt/EXPORT_NAME.rst new file mode 100644 index 0000000..1b4247c --- /dev/null +++ b/Help/prop_tgt/EXPORT_NAME.rst @@ -0,0 +1,8 @@ +EXPORT_NAME +----------- + +Exported name for target files. + +This sets the name for the IMPORTED target generated when it this +target is is exported. If not set, the logical target name is used by +default. diff --git a/Help/prop_tgt/EchoString.rst b/Help/prop_tgt/EchoString.rst new file mode 100644 index 0000000..32ae2aa --- /dev/null +++ b/Help/prop_tgt/EchoString.rst @@ -0,0 +1,7 @@ +EchoString +---------- + +A message to be displayed when the target is built. + +A message to display on some generators (such as makefiles) when the +target is built. diff --git a/Help/prop_tgt/FOLDER.rst b/Help/prop_tgt/FOLDER.rst new file mode 100644 index 0000000..bfe4e8e --- /dev/null +++ b/Help/prop_tgt/FOLDER.rst @@ -0,0 +1,10 @@ +FOLDER +------ + +Set the folder name. Use to organize targets in an IDE. + +Targets with no FOLDER property will appear as top level entities in +IDEs like Visual Studio. Targets with the same FOLDER property value +will appear next to each other in a folder of that name. To nest +folders, use FOLDER values such as 'GUI/Dialogs' with '/' characters +separating folder levels. diff --git a/Help/prop_tgt/FRAMEWORK.rst b/Help/prop_tgt/FRAMEWORK.rst new file mode 100644 index 0000000..9f472c0 --- /dev/null +++ b/Help/prop_tgt/FRAMEWORK.rst @@ -0,0 +1,9 @@ +FRAMEWORK +--------- + +This target is a framework on the Mac. + +If a shared library target has this property set to true it will be +built as a framework when built on the mac. It will have the +directory structure required for a framework and will be suitable to +be used with the -framework option diff --git a/Help/prop_tgt/Fortran_FORMAT.rst b/Help/prop_tgt/Fortran_FORMAT.rst new file mode 100644 index 0000000..0a11d91 --- /dev/null +++ b/Help/prop_tgt/Fortran_FORMAT.rst @@ -0,0 +1,11 @@ +Fortran_FORMAT +-------------- + +Set to FIXED or FREE to indicate the Fortran source layout. + +This property tells CMake whether the Fortran source files in a target +use fixed-format or free-format. CMake will pass the corresponding +format flag to the compiler. Use the source-specific Fortran_FORMAT +property to change the format of a specific source file. If the +variable CMAKE_Fortran_FORMAT is set when a target is created its +value is used to initialize this property. diff --git a/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst b/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst new file mode 100644 index 0000000..9c86437 --- /dev/null +++ b/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst @@ -0,0 +1,17 @@ +Fortran_MODULE_DIRECTORY +------------------------ + +Specify output directory for Fortran modules provided by the target. + +If the target contains Fortran source files that provide modules and +the compiler supports a module output directory this specifies the +directory in which the modules will be placed. When this property is +not set the modules will be placed in the build directory +corresponding to the target's source directory. If the variable +CMAKE_Fortran_MODULE_DIRECTORY is set when a target is created its +value is used to initialize this property. + +Note that some compilers will automatically search the module output +directory for modules USEd during compilation but others will not. If +your sources USE modules their location must be specified by +INCLUDE_DIRECTORIES regardless of this property. diff --git a/Help/prop_tgt/GENERATOR_FILE_NAME.rst b/Help/prop_tgt/GENERATOR_FILE_NAME.rst new file mode 100644 index 0000000..032b22a --- /dev/null +++ b/Help/prop_tgt/GENERATOR_FILE_NAME.rst @@ -0,0 +1,9 @@ +GENERATOR_FILE_NAME +------------------- + +Generator's file for this target. + +An internal property used by some generators to record the name of the +project or dsp file associated with this target. Note that at +configure time, this property is only set for targets created by +include_external_msproject(). diff --git a/Help/prop_tgt/GNUtoMS.rst b/Help/prop_tgt/GNUtoMS.rst new file mode 100644 index 0000000..cf34da9 --- /dev/null +++ b/Help/prop_tgt/GNUtoMS.rst @@ -0,0 +1,17 @@ +GNUtoMS +------- + +Convert GNU import library (.dll.a) to MS format (.lib). + +When linking a shared library or executable that exports symbols using +GNU tools on Windows (MinGW/MSYS) with Visual Studio installed convert +the import library (.dll.a) from GNU to MS format (.lib). Both import +libraries will be installed by install(TARGETS) and exported by +install(EXPORT) and export() to be linked by applications with either +GNU- or MS-compatible tools. + +If the variable CMAKE_GNUtoMS is set when a target is created its +value is used to initialize this property. The variable must be set +prior to the first command that enables a language such as project() +or enable_language(). CMake provides the variable as an option to the +user automatically when configuring on Windows with GNU tools. diff --git a/Help/prop_tgt/HAS_CXX.rst b/Help/prop_tgt/HAS_CXX.rst new file mode 100644 index 0000000..7790932 --- /dev/null +++ b/Help/prop_tgt/HAS_CXX.rst @@ -0,0 +1,7 @@ +HAS_CXX +------- + +Link the target using the C++ linker tool (obsolete). + +This is equivalent to setting the LINKER_LANGUAGE property to CXX. +See that property's documentation for details. diff --git a/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst b/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst new file mode 100644 index 0000000..dc73807 --- /dev/null +++ b/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst @@ -0,0 +1,32 @@ +IMPLICIT_DEPENDS_INCLUDE_TRANSFORM +---------------------------------- + +Specify #include line transforms for dependencies in a target. + +This property specifies rules to transform macro-like #include lines +during implicit dependency scanning of C and C++ source files. The +list of rules must be semicolon-separated with each entry of the form +"A_MACRO(%)=value-with-%" (the % must be literal). During dependency +scanning occurrences of A_MACRO(...) on #include lines will be +replaced by the value given with the macro argument substituted for +'%'. For example, the entry + +:: + + MYDIR(%)=<mydir/%> + +will convert lines of the form + +:: + + #include MYDIR(myheader.h) + +to + +:: + + #include <mydir/myheader.h> + +allowing the dependency to be followed. + +This property applies to sources in the target on which it is set. diff --git a/Help/prop_tgt/IMPORTED.rst b/Help/prop_tgt/IMPORTED.rst new file mode 100644 index 0000000..bf9835e --- /dev/null +++ b/Help/prop_tgt/IMPORTED.rst @@ -0,0 +1,8 @@ +IMPORTED +-------- + +Read-only indication of whether a target is IMPORTED. + +The boolean value of this property is true for targets created with +the IMPORTED option to add_executable or add_library. It is false for +targets built within the project. diff --git a/Help/prop_tgt/IMPORTED_CONFIGURATIONS.rst b/Help/prop_tgt/IMPORTED_CONFIGURATIONS.rst new file mode 100644 index 0000000..6de1baa --- /dev/null +++ b/Help/prop_tgt/IMPORTED_CONFIGURATIONS.rst @@ -0,0 +1,11 @@ +IMPORTED_CONFIGURATIONS +----------------------- + +Configurations provided for an IMPORTED target. + +Set this to the list of configuration names available for an IMPORTED +target. The names correspond to configurations defined in the project +from which the target is imported. If the importing project uses a +different set of configurations the names may be mapped using the +MAP_IMPORTED_CONFIG_<CONFIG> property. Ignored for non-imported +targets. diff --git a/Help/prop_tgt/IMPORTED_IMPLIB.rst b/Help/prop_tgt/IMPORTED_IMPLIB.rst new file mode 100644 index 0000000..acf4b32 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_IMPLIB.rst @@ -0,0 +1,7 @@ +IMPORTED_IMPLIB +--------------- + +Full path to the import library for an IMPORTED target. + +Set this to the location of the ".lib" part of a windows DLL. Ignored +for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst b/Help/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst new file mode 100644 index 0000000..b4b3f02 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_IMPLIB_<CONFIG> +------------------------ + +<CONFIG>-specific version of IMPORTED_IMPLIB property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst b/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst new file mode 100644 index 0000000..2db2b0e --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst @@ -0,0 +1,14 @@ +IMPORTED_LINK_DEPENDENT_LIBRARIES +--------------------------------- + +Dependent shared libraries of an imported shared library. + +Shared libraries may be linked to other shared libraries as part of +their implementation. On some platforms the linker searches for the +dependent libraries of shared libraries they are including in the +link. Set this property to the list of dependent shared libraries of +an imported library. The list should be disjoint from the list of +interface libraries in the INTERFACE_LINK_LIBRARIES property. On +platforms requiring dependent shared libraries to be found at link +time CMake uses this list to add appropriate files or paths to the +link command line. Ignored for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst b/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst new file mode 100644 index 0000000..ee243c7 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst @@ -0,0 +1,8 @@ +IMPORTED_LINK_DEPENDENT_LIBRARIES_<CONFIG> +------------------------------------------ + +<CONFIG>-specific version of IMPORTED_LINK_DEPENDENT_LIBRARIES. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst new file mode 100644 index 0000000..5ca9c8b --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst @@ -0,0 +1,14 @@ +IMPORTED_LINK_INTERFACE_LANGUAGES +--------------------------------- + +Languages compiled into an IMPORTED static library. + +Set this to the list of languages of source files compiled to produce +a STATIC IMPORTED library (such as "C" or "CXX"). CMake accounts for +these languages when computing how to link a target to the imported +library. For example, when a C executable links to an imported C++ +static library CMake chooses the C++ linker to satisfy language +runtime dependencies of the static library. + +This property is ignored for targets that are not STATIC libraries. +This property is ignored for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst new file mode 100644 index 0000000..d4a10fb --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst @@ -0,0 +1,8 @@ +IMPORTED_LINK_INTERFACE_LANGUAGES_<CONFIG> +------------------------------------------ + +<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LANGUAGES. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst new file mode 100644 index 0000000..61134a4 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst @@ -0,0 +1,16 @@ +IMPORTED_LINK_INTERFACE_LIBRARIES +--------------------------------- + +Transitive link interface of an IMPORTED target. + +Set this to the list of libraries whose interface is included when an +IMPORTED library target is linked to another target. The libraries +will be included on the link line for the target. Unlike the +LINK_INTERFACE_LIBRARIES property, this property applies to all +imported target types, including STATIC libraries. This property is +ignored for non-imported targets. + +This property is ignored if the target also has a non-empty +INTERFACE_LINK_LIBRARIES property. + +This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst new file mode 100644 index 0000000..13b93ba --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst @@ -0,0 +1,13 @@ +IMPORTED_LINK_INTERFACE_LIBRARIES_<CONFIG> +------------------------------------------ + +<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LIBRARIES. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. + +This property is ignored if the target also has a non-empty +INTERFACE_LINK_LIBRARIES property. + +This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst new file mode 100644 index 0000000..3a86b99 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst @@ -0,0 +1,6 @@ +IMPORTED_LINK_INTERFACE_MULTIPLICITY +------------------------------------ + +Repetition count for cycles of IMPORTED static libraries. + +This is LINK_INTERFACE_MULTIPLICITY for IMPORTED targets. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst new file mode 100644 index 0000000..33b9b84 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_LINK_INTERFACE_MULTIPLICITY_<CONFIG> +--------------------------------------------- + +<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_MULTIPLICITY. + +If set, this property completely overrides the generic property for +the named configuration. diff --git a/Help/prop_tgt/IMPORTED_LOCATION.rst b/Help/prop_tgt/IMPORTED_LOCATION.rst new file mode 100644 index 0000000..8cfef73 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LOCATION.rst @@ -0,0 +1,21 @@ +IMPORTED_LOCATION +----------------- + +Full path to the main file on disk for an IMPORTED target. + +Set this to the location of an IMPORTED target file on disk. For +executables this is the location of the executable file. For bundles +on OS X this is the location of the executable file inside +Contents/MacOS under the application bundle folder. For static +libraries and modules this is the location of the library or module. +For shared libraries on non-DLL platforms this is the location of the +shared library. For frameworks on OS X this is the location of the +library file symlink just inside the framework folder. For DLLs this +is the location of the ".dll" part of the library. For UNKNOWN +libraries this is the location of the file to be linked. Ignored for +non-imported targets. + +Projects may skip IMPORTED_LOCATION if the configuration-specific +property IMPORTED_LOCATION_<CONFIG> is set. To get the location of an +imported target read one of the LOCATION or LOCATION_<CONFIG> +properties. diff --git a/Help/prop_tgt/IMPORTED_LOCATION_CONFIG.rst b/Help/prop_tgt/IMPORTED_LOCATION_CONFIG.rst new file mode 100644 index 0000000..f85bb19 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LOCATION_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_LOCATION_<CONFIG> +-------------------------- + +<CONFIG>-specific version of IMPORTED_LOCATION property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/Help/prop_tgt/IMPORTED_NO_SONAME.rst b/Help/prop_tgt/IMPORTED_NO_SONAME.rst new file mode 100644 index 0000000..4a1bb44 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_NO_SONAME.rst @@ -0,0 +1,9 @@ +IMPORTED_NO_SONAME +------------------ + +Specifies that an IMPORTED shared library target has no "soname". + +Set this property to true for an imported shared library file that has +no "soname" field. CMake may adjust generated link commands for some +platforms to prevent the linker from using the path to the library in +place of its missing soname. Ignored for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst b/Help/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst new file mode 100644 index 0000000..22d6822 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_NO_SONAME_<CONFIG> +--------------------------- + +<CONFIG>-specific version of IMPORTED_NO_SONAME property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/Help/prop_tgt/IMPORTED_SONAME.rst b/Help/prop_tgt/IMPORTED_SONAME.rst new file mode 100644 index 0000000..d80907e --- /dev/null +++ b/Help/prop_tgt/IMPORTED_SONAME.rst @@ -0,0 +1,8 @@ +IMPORTED_SONAME +--------------- + +The "soname" of an IMPORTED target of shared library type. + +Set this to the "soname" embedded in an imported shared library. This +is meaningful only on platforms supporting the feature. Ignored for +non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_SONAME_CONFIG.rst b/Help/prop_tgt/IMPORTED_SONAME_CONFIG.rst new file mode 100644 index 0000000..6ec9af3 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_SONAME_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_SONAME_<CONFIG> +------------------------ + +<CONFIG>-specific version of IMPORTED_SONAME property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/Help/prop_tgt/IMPORT_PREFIX.rst b/Help/prop_tgt/IMPORT_PREFIX.rst new file mode 100644 index 0000000..deede97 --- /dev/null +++ b/Help/prop_tgt/IMPORT_PREFIX.rst @@ -0,0 +1,9 @@ +IMPORT_PREFIX +------------- + +What comes before the import library name. + +Similar to the target property PREFIX, but used for import libraries +(typically corresponding to a DLL) instead of regular libraries. A +target property that can be set to override the prefix (such as "lib") +on an import library name. diff --git a/Help/prop_tgt/IMPORT_SUFFIX.rst b/Help/prop_tgt/IMPORT_SUFFIX.rst new file mode 100644 index 0000000..bd01250 --- /dev/null +++ b/Help/prop_tgt/IMPORT_SUFFIX.rst @@ -0,0 +1,9 @@ +IMPORT_SUFFIX +------------- + +What comes after the import library name. + +Similar to the target property SUFFIX, but used for import libraries +(typically corresponding to a DLL) instead of regular libraries. A +target property that can be set to override the suffix (such as +".lib") on an import library name. diff --git a/Help/prop_tgt/INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000..0e13e12 --- /dev/null +++ b/Help/prop_tgt/INCLUDE_DIRECTORIES.rst @@ -0,0 +1,94 @@ +INCLUDE_DIRECTORIES +------------------- + +List of preprocessor include file search directories. + +This property specifies the list of directories given so far to the +include_directories command. This property exists on directories and +targets. In addition to accepting values from the include_directories +command, values may be set directly on any directory or any target +using the set_property command. A target gets its initial value for +this property from the value of the directory property. A directory +gets its initial value from its parent directory if it has one. Both +directory and target property values are adjusted by calls to the +include_directories command. + +The target property values are used by the generators to set the +include paths for the compiler. See also the include_directories +command. + +Contents of INCLUDE_DIRECTORIES may use "generator expressions" with +the syntax "$<...>". Generator expressions are evaluated during build +system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/INSTALL_NAME_DIR.rst b/Help/prop_tgt/INSTALL_NAME_DIR.rst new file mode 100644 index 0000000..a67ec15 --- /dev/null +++ b/Help/prop_tgt/INSTALL_NAME_DIR.rst @@ -0,0 +1,8 @@ +INSTALL_NAME_DIR +---------------- + +Mac OSX directory name for installed targets. + +INSTALL_NAME_DIR is a string specifying the directory portion of the +"install_name" field of shared libraries on Mac OSX to use in the +installed targets. diff --git a/Help/prop_tgt/INSTALL_RPATH.rst b/Help/prop_tgt/INSTALL_RPATH.rst new file mode 100644 index 0000000..6206b68 --- /dev/null +++ b/Help/prop_tgt/INSTALL_RPATH.rst @@ -0,0 +1,9 @@ +INSTALL_RPATH +------------- + +The rpath to use for installed targets. + +A semicolon-separated list specifying the rpath to use in installed +targets (for platforms that support it). This property is initialized +by the value of the variable CMAKE_INSTALL_RPATH if it is set when a +target is created. diff --git a/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst b/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst new file mode 100644 index 0000000..f0006f8 --- /dev/null +++ b/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst @@ -0,0 +1,10 @@ +INSTALL_RPATH_USE_LINK_PATH +--------------------------- + +Add paths to linker search and installed rpath. + +INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true will +append directories in the linker search path and outside the project +to the INSTALL_RPATH. This property is initialized by the value of +the variable CMAKE_INSTALL_RPATH_USE_LINK_PATH if it is set when a +target is created. diff --git a/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst b/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000..7221c6b --- /dev/null +++ b/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst @@ -0,0 +1,85 @@ +INTERFACE_COMPILE_DEFINITIONS +----------------------------- + +List of public compile definitions for a library. + +Targets may populate this property to publish the compile definitions +required to compile against the headers for the target. Consuming +targets can add entries to their own COMPILE_DEFINITIONS property such +as $<TARGET_PROPERTY:foo,INTERFACE_COMPILE_DEFINITIONS> to use the +compile definitions specified in the interface of 'foo'. + +Generator expressions are evaluated during build system generation to +produce information specific to each build configuration. Valid +expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst b/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst new file mode 100644 index 0000000..99b5173 --- /dev/null +++ b/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst @@ -0,0 +1,85 @@ +INTERFACE_COMPILE_OPTIONS +------------------------- + +List of interface options to pass to the compiler. + +Targets may populate this property to publish the compile options +required to compile against the headers for the target. Consuming +targets can add entries to their own COMPILE_OPTIONS property such as +$<TARGET_PROPERTY:foo,INTERFACE_COMPILE_OPTIONS> to use the compile +options specified in the interface of 'foo'. + +Generator expressions are evaluated during build system generation to +produce information specific to each build configuration. Valid +expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000..9d8dc8d --- /dev/null +++ b/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst @@ -0,0 +1,85 @@ +INTERFACE_INCLUDE_DIRECTORIES +----------------------------- + +List of public include directories for a library. + +Targets may populate this property to publish the include directories +required to compile against the headers for the target. Consuming +targets can add entries to their own INCLUDE_DIRECTORIES property such +as $<TARGET_PROPERTY:foo,INTERFACE_INCLUDE_DIRECTORIES> to use the +include directories specified in the interface of 'foo'. + +Generator expressions are evaluated during build system generation to +produce information specific to each build configuration. Valid +expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst new file mode 100644 index 0000000..e272ee9 --- /dev/null +++ b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst @@ -0,0 +1,88 @@ +INTERFACE_LINK_LIBRARIES +------------------------ + +List public interface libraries for a shared library or executable. + +This property contains the list of transitive link dependencies. When +the target is linked into another target the libraries listed (and +recursively their link interface libraries) will be provided to the +other target also. This property is overriden by the +LINK_INTERFACE_LIBRARIES or LINK_INTERFACE_LIBRARIES_<CONFIG> property +if policy CMP0022 is OLD or unset. + + + +Generator expressions are evaluated during build system generation to +produce information specific to each build configuration. Valid +expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst b/Help/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst new file mode 100644 index 0000000..76c1e06 --- /dev/null +++ b/Help/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst @@ -0,0 +1,15 @@ +INTERFACE_POSITION_INDEPENDENT_CODE +----------------------------------- + +Whether consumers need to create a position-independent target + +The INTERFACE_POSITION_INDEPENDENT_CODE property informs consumers of +this target whether they must set their POSITION_INDEPENDENT_CODE +property to ON. If this property is set to ON, then the +POSITION_INDEPENDENT_CODE property on all consumers will be set to ON. +Similarly, if this property is set to OFF, then the +POSITION_INDEPENDENT_CODE property on all consumers will be set to +OFF. If this property is undefined, then consumers will determine +their POSITION_INDEPENDENT_CODE property by other means. Consumers +must ensure that the targets that they link to have a consistent +requirement for their INTERFACE_POSITION_INDEPENDENT_CODE property. diff --git a/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000..41b43e4 --- /dev/null +++ b/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst @@ -0,0 +1,84 @@ +INTERFACE_SYSTEM_INCLUDE_DIRECTORIES +------------------------------------ + +List of public system include directories for a library. + +Targets may populate this property to publish the include directories +which contain system headers, and therefore should not result in +compiler warnings. Consuming targets will then mark the same include +directories as system headers. + +Generator expressions are evaluated during build system generation to +produce information specific to each build configuration. Valid +expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst b/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst new file mode 100644 index 0000000..effa3b0 --- /dev/null +++ b/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst @@ -0,0 +1,7 @@ +INTERPROCEDURAL_OPTIMIZATION +---------------------------- + +Enable interprocedural optimization for a target. + +If set to true, enables interprocedural optimizations if they are +known to be supported by the compiler. diff --git a/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst b/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst new file mode 100644 index 0000000..492fee0 --- /dev/null +++ b/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst @@ -0,0 +1,8 @@ +INTERPROCEDURAL_OPTIMIZATION_<CONFIG> +------------------------------------- + +Per-configuration interprocedural optimization for a target. + +This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION. +If set, this property overrides the generic property for the named +configuration. diff --git a/Help/prop_tgt/LABELS.rst b/Help/prop_tgt/LABELS.rst new file mode 100644 index 0000000..5e46469 --- /dev/null +++ b/Help/prop_tgt/LABELS.rst @@ -0,0 +1,6 @@ +LABELS +------ + +Specify a list of text labels associated with a target. + +Target label semantics are currently unspecified. diff --git a/Help/prop_tgt/LANG_VISIBILITY_PRESET.rst b/Help/prop_tgt/LANG_VISIBILITY_PRESET.rst new file mode 100644 index 0000000..d4bde17 --- /dev/null +++ b/Help/prop_tgt/LANG_VISIBILITY_PRESET.rst @@ -0,0 +1,10 @@ +<LANG>_VISIBILITY_PRESET +------------------------ + +Value for symbol visibility compile flags + +The <LANG>_VISIBILITY_PRESET property determines the value passed in a +visibility related compile option, such as -fvisibility= for <LANG>. +This property only has an affect for libraries and executables with +exports. This property is initialized by the value of the variable +CMAKE_<LANG>_VISIBILITY_PRESET if it is set when a target is created. diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..a0ba619 --- /dev/null +++ b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst @@ -0,0 +1,18 @@ +LIBRARY_OUTPUT_DIRECTORY +------------------------ + +Output directory in which to build LIBRARY target files. + +This property specifies the directory into which library target files +should be built. Multi-configuration generators (VS, Xcode) append a +per-configuration subdirectory to the specified directory. There are +three kinds of target files that may be built: archive, library, and +runtime. Executables are always treated as runtime targets. Static +libraries are always treated as archive targets. Module libraries are +always treated as library targets. For non-DLL platforms shared +libraries are treated as library targets. For DLL platforms the DLL +part of a shared library is treated as a runtime target and the +corresponding import library is treated as an archive target. All +Windows-based systems including Cygwin are DLL platforms. This +property is initialized by the value of the variable +CMAKE_LIBRARY_OUTPUT_DIRECTORY if it is set when a target is created. diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000..2a38373 --- /dev/null +++ b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,11 @@ +LIBRARY_OUTPUT_DIRECTORY_<CONFIG> +--------------------------------- + +Per-configuration output directory for LIBRARY target files. + +This is a per-configuration version of LIBRARY_OUTPUT_DIRECTORY, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the variable +CMAKE_LIBRARY_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is +created. diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst b/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst new file mode 100644 index 0000000..1330e0d --- /dev/null +++ b/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst @@ -0,0 +1,15 @@ +LIBRARY_OUTPUT_NAME +------------------- + +Output name for LIBRARY target files. + +This property specifies the base name for library target files. It +overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. There are +three kinds of target files that may be built: archive, library, and +runtime. Executables are always treated as runtime targets. Static +libraries are always treated as archive targets. Module libraries are +always treated as library targets. For non-DLL platforms shared +libraries are treated as library targets. For DLL platforms the DLL +part of a shared library is treated as a runtime target and the +corresponding import library is treated as an archive target. All +Windows-based systems including Cygwin are DLL platforms. diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst b/Help/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000..785d1b2 --- /dev/null +++ b/Help/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,6 @@ +LIBRARY_OUTPUT_NAME_<CONFIG> +---------------------------- + +Per-configuration output name for LIBRARY target files. + +This is the configuration-specific version of LIBRARY_OUTPUT_NAME. diff --git a/Help/prop_tgt/LINKER_LANGUAGE.rst b/Help/prop_tgt/LINKER_LANGUAGE.rst new file mode 100644 index 0000000..b1ca867 --- /dev/null +++ b/Help/prop_tgt/LINKER_LANGUAGE.rst @@ -0,0 +1,14 @@ +LINKER_LANGUAGE +--------------- + +Specifies language whose compiler will invoke the linker. + +For executables, shared libraries, and modules, this sets the language +whose compiler is used to link the target (such as "C" or "CXX"). A +typical value for an executable is the language of the source file +providing the program entry point (main). If not set, the language +with the highest linker preference value is the default. See +documentation of CMAKE_<LANG>_LINKER_PREFERENCE variables. + +If this property is not set by the user, it will be calculated at +generate-time by CMake. diff --git a/Help/prop_tgt/LINK_DEPENDS.rst b/Help/prop_tgt/LINK_DEPENDS.rst new file mode 100644 index 0000000..5576b85 --- /dev/null +++ b/Help/prop_tgt/LINK_DEPENDS.rst @@ -0,0 +1,12 @@ +LINK_DEPENDS +------------ + +Additional files on which a target binary depends for linking. + +Specifies a semicolon-separated list of full-paths to files on which +the link rule for this target depends. The target binary will be +linked if any of the named files is newer than it. + +This property is ignored by non-Makefile generators. It is intended +to specify dependencies on "linker scripts" for custom Makefile link +rules. diff --git a/Help/prop_tgt/LINK_DEPENDS_NO_SHARED.rst b/Help/prop_tgt/LINK_DEPENDS_NO_SHARED.rst new file mode 100644 index 0000000..5c6778d --- /dev/null +++ b/Help/prop_tgt/LINK_DEPENDS_NO_SHARED.rst @@ -0,0 +1,14 @@ +LINK_DEPENDS_NO_SHARED +---------------------- + +Do not depend on linked shared library files. + +Set this property to true to tell CMake generators not to add +file-level dependencies on the shared library files linked by this +target. Modification to the shared libraries will not be sufficient +to re-link this target. Logical target-level dependencies will not be +affected so the linked shared libraries will still be brought up to +date before this target is built. + +This property is initialized by the value of the variable +CMAKE_LINK_DEPENDS_NO_SHARED if it is set when a target is created. diff --git a/Help/prop_tgt/LINK_FLAGS.rst b/Help/prop_tgt/LINK_FLAGS.rst new file mode 100644 index 0000000..409d00a --- /dev/null +++ b/Help/prop_tgt/LINK_FLAGS.rst @@ -0,0 +1,8 @@ +LINK_FLAGS +---------- + +Additional flags to use when linking this target. + +The LINK_FLAGS property can be used to add extra flags to the link +step of a target. LINK_FLAGS_<CONFIG> will add to the configuration +<CONFIG>, for example, DEBUG, RELEASE, MINSIZEREL, RELWITHDEBINFO. diff --git a/Help/prop_tgt/LINK_FLAGS_CONFIG.rst b/Help/prop_tgt/LINK_FLAGS_CONFIG.rst new file mode 100644 index 0000000..ba7adc8 --- /dev/null +++ b/Help/prop_tgt/LINK_FLAGS_CONFIG.rst @@ -0,0 +1,6 @@ +LINK_FLAGS_<CONFIG> +------------------- + +Per-configuration linker flags for a target. + +This is the configuration-specific version of LINK_FLAGS. diff --git a/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst new file mode 100644 index 0000000..75c2a31 --- /dev/null +++ b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst @@ -0,0 +1,22 @@ +LINK_INTERFACE_LIBRARIES +------------------------ + +List public interface libraries for a shared library or executable. + +By default linking to a shared library target transitively links to +targets with which the library itself was linked. For an executable +with exports (see the ENABLE_EXPORTS property) no default transitive +link dependencies are used. This property replaces the default +transitive link dependencies with an explicit list. When the target +is linked into another target the libraries listed (and recursively +their link interface libraries) will be provided to the other target +also. If the list is empty then no transitive link dependencies will +be incorporated when this target is linked into another target even if +the default set is non-empty. This property is initialized by the +value of the variable CMAKE_LINK_INTERFACE_LIBRARIES if it is set when +a target is created. This property is ignored for STATIC libraries. + +This property is overriden by the INTERFACE_LINK_LIBRARIES property if +policy CMP0022 is NEW. + +This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead. diff --git a/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst new file mode 100644 index 0000000..1a7a941 --- /dev/null +++ b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst @@ -0,0 +1,13 @@ +LINK_INTERFACE_LIBRARIES_<CONFIG> +--------------------------------- + +Per-configuration list of public interface libraries for a target. + +This is the configuration-specific version of +LINK_INTERFACE_LIBRARIES. If set, this property completely overrides +the generic property for the named configuration. + +This property is overriden by the INTERFACE_LINK_LIBRARIES property if +policy CMP0022 is NEW. + +This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead. diff --git a/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst b/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst new file mode 100644 index 0000000..4e26388 --- /dev/null +++ b/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst @@ -0,0 +1,12 @@ +LINK_INTERFACE_MULTIPLICITY +--------------------------- + +Repetition count for STATIC libraries with cyclic dependencies. + +When linking to a STATIC library target with cyclic dependencies the +linker may need to scan more than once through the archives in the +strongly connected component of the dependency graph. CMake by +default constructs the link line so that the linker will scan through +the component at least twice. This property specifies the minimum +number of scans if it is larger than the default. CMake uses the +largest value specified by any target in a component. diff --git a/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst b/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst new file mode 100644 index 0000000..5ea4a45 --- /dev/null +++ b/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst @@ -0,0 +1,8 @@ +LINK_INTERFACE_MULTIPLICITY_<CONFIG> +------------------------------------ + +Per-configuration repetition count for cycles of STATIC libraries. + +This is the configuration-specific version of +LINK_INTERFACE_MULTIPLICITY. If set, this property completely +overrides the generic property for the named configuration. diff --git a/Help/prop_tgt/LINK_LIBRARIES.rst b/Help/prop_tgt/LINK_LIBRARIES.rst new file mode 100644 index 0000000..3095d5d --- /dev/null +++ b/Help/prop_tgt/LINK_LIBRARIES.rst @@ -0,0 +1,89 @@ +LINK_LIBRARIES +-------------- + +List of direct link dependencies. + +This property specifies the list of libraries or targets which will be +used for linking. In addition to accepting values from the +target_link_libraries command, values may be set directly on any +target using the set_property command. + +The target property values are used by the generators to set the link +libraries for the compiler. See also the target_link_libraries +command. + +Contents of LINK_LIBRARIES may use "generator expressions" with the +syntax "$<...>". Generator expressions are evaluated during build +system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/LINK_SEARCH_END_STATIC.rst b/Help/prop_tgt/LINK_SEARCH_END_STATIC.rst new file mode 100644 index 0000000..fe105bd --- /dev/null +++ b/Help/prop_tgt/LINK_SEARCH_END_STATIC.rst @@ -0,0 +1,14 @@ +LINK_SEARCH_END_STATIC +---------------------- + +End a link line such that static system libraries are used. + +Some linkers support switches such as -Bstatic and -Bdynamic to +determine whether to use static or shared libraries for -lXXX options. +CMake uses these options to set the link type for libraries whose full +paths are not known or (in some cases) are in implicit link +directories for the platform. By default CMake adds an option at the +end of the library list (if necessary) to set the linker search type +back to its starting type. This property switches the final linker +search type to -Bstatic regardless of how it started. See also +LINK_SEARCH_START_STATIC. diff --git a/Help/prop_tgt/LINK_SEARCH_START_STATIC.rst b/Help/prop_tgt/LINK_SEARCH_START_STATIC.rst new file mode 100644 index 0000000..ca899fe --- /dev/null +++ b/Help/prop_tgt/LINK_SEARCH_START_STATIC.rst @@ -0,0 +1,14 @@ +LINK_SEARCH_START_STATIC +------------------------ + +Assume the linker looks for static libraries by default. + +Some linkers support switches such as -Bstatic and -Bdynamic to +determine whether to use static or shared libraries for -lXXX options. +CMake uses these options to set the link type for libraries whose full +paths are not known or (in some cases) are in implicit link +directories for the platform. By default the linker search type is +assumed to be -Bdynamic at the beginning of the library list. This +property switches the assumption to -Bstatic. It is intended for use +when linking an executable statically (e.g. with the GNU -static +option). See also LINK_SEARCH_END_STATIC. diff --git a/Help/prop_tgt/LOCATION.rst b/Help/prop_tgt/LOCATION.rst new file mode 100644 index 0000000..bdcb1df --- /dev/null +++ b/Help/prop_tgt/LOCATION.rst @@ -0,0 +1,27 @@ +LOCATION +-------- + +Read-only location of a target on disk. + +For an imported target, this read-only property returns the value of +the LOCATION_<CONFIG> property for an unspecified configuration +<CONFIG> provided by the target. + +For a non-imported target, this property is provided for compatibility +with CMake 2.4 and below. It was meant to get the location of an +executable target's output file for use in add_custom_command. The +path may contain a build-system-specific portion that is replaced at +build time with the configuration getting built (such as +"$(ConfigurationName)" in VS). In CMake 2.6 and above +add_custom_command automatically recognizes a target name in its +COMMAND and DEPENDS options and computes the target location. In +CMake 2.8.4 and above add_custom_command recognizes generator +expressions to refer to target locations anywhere in the command. +Therefore this property is not needed for creating custom commands. + +Do not set properties that affect the location of a target after +reading this property. These include properties whose names match +"(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?", +"(IMPLIB_)?(PREFIX|SUFFIX)", or "LINKER_LANGUAGE". Failure to follow +this rule is not diagnosed and leaves the location of the target +undefined. diff --git a/Help/prop_tgt/LOCATION_CONFIG.rst b/Help/prop_tgt/LOCATION_CONFIG.rst new file mode 100644 index 0000000..5c4d75b --- /dev/null +++ b/Help/prop_tgt/LOCATION_CONFIG.rst @@ -0,0 +1,20 @@ +LOCATION_<CONFIG> +----------------- + +Read-only property providing a target location on disk. + +A read-only property that indicates where a target's main file is +located on disk for the configuration <CONFIG>. The property is +defined only for library and executable targets. An imported target +may provide a set of configurations different from that of the +importing project. By default CMake looks for an exact-match but +otherwise uses an arbitrary available configuration. Use the +MAP_IMPORTED_CONFIG_<CONFIG> property to map imported configurations +explicitly. + +Do not set properties that affect the location of a target after +reading this property. These include properties whose names match +"(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?", +"(IMPLIB_)?(PREFIX|SUFFIX)", or "LINKER_LANGUAGE". Failure to follow +this rule is not diagnosed and leaves the location of the target +undefined. diff --git a/Help/prop_tgt/MACOSX_BUNDLE.rst b/Help/prop_tgt/MACOSX_BUNDLE.rst new file mode 100644 index 0000000..ff21e61 --- /dev/null +++ b/Help/prop_tgt/MACOSX_BUNDLE.rst @@ -0,0 +1,12 @@ +MACOSX_BUNDLE +------------- + +Build an executable as an application bundle on Mac OS X. + +When this property is set to true the executable when built on Mac OS +X will be created as an application bundle. This makes it a GUI +executable that can be launched from the Finder. See the +MACOSX_BUNDLE_INFO_PLIST target property for information about +creation of the Info.plist file for the application bundle. This +property is initialized by the value of the variable +CMAKE_MACOSX_BUNDLE if it is set when a target is created. diff --git a/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst b/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst new file mode 100644 index 0000000..097cce1 --- /dev/null +++ b/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst @@ -0,0 +1,29 @@ +MACOSX_BUNDLE_INFO_PLIST +------------------------ + +Specify a custom Info.plist template for a Mac OS X App Bundle. + +An executable target with MACOSX_BUNDLE enabled will be built as an +application bundle on Mac OS X. By default its Info.plist file is +created by configuring a template called MacOSXBundleInfo.plist.in +located in the CMAKE_MODULE_PATH. This property specifies an +alternative template file name which may be a full path. + +The following target properties may be set to specify content to be +configured into the file: + +:: + + MACOSX_BUNDLE_INFO_STRING + MACOSX_BUNDLE_ICON_FILE + MACOSX_BUNDLE_GUI_IDENTIFIER + MACOSX_BUNDLE_LONG_VERSION_STRING + MACOSX_BUNDLE_BUNDLE_NAME + MACOSX_BUNDLE_SHORT_VERSION_STRING + MACOSX_BUNDLE_BUNDLE_VERSION + MACOSX_BUNDLE_COPYRIGHT + +CMake variables of the same name may be set to affect all targets in a +directory that do not have each specific property set. If a custom +Info.plist is specified by this property it may of course hard-code +all the settings instead of using the target properties. diff --git a/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst b/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst new file mode 100644 index 0000000..729d929 --- /dev/null +++ b/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst @@ -0,0 +1,25 @@ +MACOSX_FRAMEWORK_INFO_PLIST +--------------------------- + +Specify a custom Info.plist template for a Mac OS X Framework. + +A library target with FRAMEWORK enabled will be built as a framework +on Mac OS X. By default its Info.plist file is created by configuring +a template called MacOSXFrameworkInfo.plist.in located in the +CMAKE_MODULE_PATH. This property specifies an alternative template +file name which may be a full path. + +The following target properties may be set to specify content to be +configured into the file: + +:: + + MACOSX_FRAMEWORK_ICON_FILE + MACOSX_FRAMEWORK_IDENTIFIER + MACOSX_FRAMEWORK_SHORT_VERSION_STRING + MACOSX_FRAMEWORK_BUNDLE_VERSION + +CMake variables of the same name may be set to affect all targets in a +directory that do not have each specific property set. If a custom +Info.plist is specified by this property it may of course hard-code +all the settings instead of using the target properties. diff --git a/Help/prop_tgt/MACOSX_RPATH.rst b/Help/prop_tgt/MACOSX_RPATH.rst new file mode 100644 index 0000000..f2d8078 --- /dev/null +++ b/Help/prop_tgt/MACOSX_RPATH.rst @@ -0,0 +1,10 @@ +MACOSX_RPATH +------------ + +Whether to use rpaths on Mac OS X. + +When this property is set to true, the directory portion of +the"install_name" field of shared libraries will default to +"@rpath".Runtime paths will also be embedded in binaries using this +target.This property is initialized by the value of the variable +CMAKE_MACOSX_RPATH if it is set when a target is created. diff --git a/Help/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst b/Help/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst new file mode 100644 index 0000000..09ff0ce --- /dev/null +++ b/Help/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst @@ -0,0 +1,19 @@ +MAP_IMPORTED_CONFIG_<CONFIG> +---------------------------- + +Map from project configuration to IMPORTED target's configuration. + +Set this to the list of configurations of an imported target that may +be used for the current project's <CONFIG> configuration. Targets +imported from another project may not provide the same set of +configuration names available in the current project. Setting this +property tells CMake what imported configurations are suitable for use +when building the <CONFIG> configuration. The first configuration in +the list found to be provided by the imported target is selected. If +this property is set and no matching configurations are available, +then the imported target is considered to be not found. This property +is ignored for non-imported targets. + +This property is initialized by the value of the variable +CMAKE_MAP_IMPORTED_CONFIG_<CONFIG> if it is set when a target is +created. diff --git a/Help/prop_tgt/NAME.rst b/Help/prop_tgt/NAME.rst new file mode 100644 index 0000000..ddd84f2 --- /dev/null +++ b/Help/prop_tgt/NAME.rst @@ -0,0 +1,6 @@ +NAME +---- + +Logical name for the target. + +Read-only logical name for the target as used by CMake. diff --git a/Help/prop_tgt/NO_SONAME.rst b/Help/prop_tgt/NO_SONAME.rst new file mode 100644 index 0000000..fc668b5 --- /dev/null +++ b/Help/prop_tgt/NO_SONAME.rst @@ -0,0 +1,14 @@ +NO_SONAME +--------- + +Whether to set "soname" when linking a shared library or module. + +Enable this boolean property if a generated shared library or module +should not have "soname" set. Default is to set "soname" on all +shared libraries and modules as long as the platform supports it. +Generally, use this property only for leaf private libraries or +plugins. If you use it on normal shared libraries which other targets +link against, on some platforms a linker will insert a full path to +the library (as specified at link time) into the dynamic section of +the dependent binary. Therefore, once installed, dynamic loader may +eventually fail to locate the library for the binary. diff --git a/Help/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst b/Help/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst new file mode 100644 index 0000000..070dd30 --- /dev/null +++ b/Help/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst @@ -0,0 +1,11 @@ +NO_SYSTEM_FROM_IMPORTED +----------------------- + +Do not treat includes from IMPORTED target interfaces as SYSTEM. + +The contents of the INTERFACE_INCLUDE_DIRECTORIES of IMPORTED targets +are treated as SYSTEM includes by default. If this property is +enabled, the contents of the INTERFACE_INCLUDE_DIRECTORIES of IMPORTED +targets are not treated as system includes. This property is +initialized by the value of the variable CMAKE_NO_SYSTEM_FROM_IMPORTED +if it is set when a target is created. diff --git a/Help/prop_tgt/OSX_ARCHITECTURES.rst b/Help/prop_tgt/OSX_ARCHITECTURES.rst new file mode 100644 index 0000000..68ff970 --- /dev/null +++ b/Help/prop_tgt/OSX_ARCHITECTURES.rst @@ -0,0 +1,11 @@ +OSX_ARCHITECTURES +----------------- + +Target specific architectures for OS X. + +The OSX_ARCHITECTURES property sets the target binary architecture for +targets on OS X. This property is initialized by the value of the +variable CMAKE_OSX_ARCHITECTURES if it is set when a target is +created. Use OSX_ARCHITECTURES_<CONFIG> to set the binary +architectures on a per-configuration basis. <CONFIG> is an upper-case +name (ex: "OSX_ARCHITECTURES_DEBUG"). diff --git a/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst b/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst new file mode 100644 index 0000000..ea05bea --- /dev/null +++ b/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst @@ -0,0 +1,7 @@ +OSX_ARCHITECTURES_<CONFIG> +-------------------------- + +Per-configuration OS X binary architectures for a target. + +This property is the configuration-specific version of +OSX_ARCHITECTURES. diff --git a/Help/prop_tgt/OUTPUT_NAME.rst b/Help/prop_tgt/OUTPUT_NAME.rst new file mode 100644 index 0000000..97bf010 --- /dev/null +++ b/Help/prop_tgt/OUTPUT_NAME.rst @@ -0,0 +1,8 @@ +OUTPUT_NAME +----------- + +Output name for target files. + +This sets the base name for output files created for an executable or +library target. If not set, the logical target name is used by +default. diff --git a/Help/prop_tgt/OUTPUT_NAME_CONFIG.rst b/Help/prop_tgt/OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000..7bfbcbc --- /dev/null +++ b/Help/prop_tgt/OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,6 @@ +OUTPUT_NAME_<CONFIG> +-------------------- + +Per-configuration target file base name. + +This is the configuration-specific version of OUTPUT_NAME. diff --git a/Help/prop_tgt/PDB_NAME.rst b/Help/prop_tgt/PDB_NAME.rst new file mode 100644 index 0000000..fe059e0 --- /dev/null +++ b/Help/prop_tgt/PDB_NAME.rst @@ -0,0 +1,10 @@ +PDB_NAME +-------- + +Output name for MS debug symbols .pdb file from linker. + +Set the base name for debug symbols file created for an executable or +shared library target. If not set, the logical target name is used by +default. + +This property is not implemented by the Visual Studio 6 generator. diff --git a/Help/prop_tgt/PDB_NAME_CONFIG.rst b/Help/prop_tgt/PDB_NAME_CONFIG.rst new file mode 100644 index 0000000..50c3aa2 --- /dev/null +++ b/Help/prop_tgt/PDB_NAME_CONFIG.rst @@ -0,0 +1,8 @@ +PDB_NAME_<CONFIG> +----------------- + +Per-configuration name for MS debug symbols .pdb file. + +This is the configuration-specific version of PDB_NAME. + +This property is not implemented by the Visual Studio 6 generator. diff --git a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..d973e90d --- /dev/null +++ b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst @@ -0,0 +1,11 @@ +PDB_OUTPUT_DIRECTORY +-------------------- + +Output directory for MS debug symbols .pdb file from linker. + +This property specifies the directory into which the MS debug symbols +will be placed by the linker. This property is initialized by the +value of the variable CMAKE_PDB_OUTPUT_DIRECTORY if it is set when a +target is created. + +This property is not implemented by the Visual Studio 6 generator. diff --git a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000..25ab944 --- /dev/null +++ b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,13 @@ +PDB_OUTPUT_DIRECTORY_<CONFIG> +----------------------------- + +Per-configuration output directory for MS debug symbols .pdb files. + +This is a per-configuration version of PDB_OUTPUT_DIRECTORY, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the variable +CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is +created. + +This property is not implemented by the Visual Studio 6 generator. diff --git a/Help/prop_tgt/POSITION_INDEPENDENT_CODE.rst b/Help/prop_tgt/POSITION_INDEPENDENT_CODE.rst new file mode 100644 index 0000000..1202447 --- /dev/null +++ b/Help/prop_tgt/POSITION_INDEPENDENT_CODE.rst @@ -0,0 +1,11 @@ +POSITION_INDEPENDENT_CODE +------------------------- + +Whether to create a position-independent target + +The POSITION_INDEPENDENT_CODE property determines whether position +independent executables or shared libraries will be created. This +property is true by default for SHARED and MODULE library targets and +false otherwise. This property is initialized by the value of the +variable CMAKE_POSITION_INDEPENDENT_CODE if it is set when a target is +created. diff --git a/Help/prop_tgt/POST_INSTALL_SCRIPT.rst b/Help/prop_tgt/POST_INSTALL_SCRIPT.rst new file mode 100644 index 0000000..f1adb40 --- /dev/null +++ b/Help/prop_tgt/POST_INSTALL_SCRIPT.rst @@ -0,0 +1,9 @@ +POST_INSTALL_SCRIPT +------------------- + +Deprecated install support. + +The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the old +way to specify CMake scripts to run before and after installing a +target. They are used only when the old INSTALL_TARGETS command is +used to install the target. Use the INSTALL command instead. diff --git a/Help/prop_tgt/PREFIX.rst b/Help/prop_tgt/PREFIX.rst new file mode 100644 index 0000000..a165104 --- /dev/null +++ b/Help/prop_tgt/PREFIX.rst @@ -0,0 +1,7 @@ +PREFIX +------ + +What comes before the library name. + +A target property that can be set to override the prefix (such as +"lib") on a library name. diff --git a/Help/prop_tgt/PRE_INSTALL_SCRIPT.rst b/Help/prop_tgt/PRE_INSTALL_SCRIPT.rst new file mode 100644 index 0000000..113d7c5 --- /dev/null +++ b/Help/prop_tgt/PRE_INSTALL_SCRIPT.rst @@ -0,0 +1,9 @@ +PRE_INSTALL_SCRIPT +------------------ + +Deprecated install support. + +The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the old +way to specify CMake scripts to run before and after installing a +target. They are used only when the old INSTALL_TARGETS command is +used to install the target. Use the INSTALL command instead. diff --git a/Help/prop_tgt/PRIVATE_HEADER.rst b/Help/prop_tgt/PRIVATE_HEADER.rst new file mode 100644 index 0000000..da2127b --- /dev/null +++ b/Help/prop_tgt/PRIVATE_HEADER.rst @@ -0,0 +1,11 @@ +PRIVATE_HEADER +-------------- + +Specify private header files in a FRAMEWORK shared library target. + +Shared library targets marked with the FRAMEWORK property generate +frameworks on OS X and normal shared libraries on other platforms. +This property may be set to a list of header files to be placed in the +PrivateHeaders directory inside the framework folder. On non-Apple +platforms these headers may be installed using the PRIVATE_HEADER +option to the install(TARGETS) command. diff --git a/Help/prop_tgt/PROJECT_LABEL.rst b/Help/prop_tgt/PROJECT_LABEL.rst new file mode 100644 index 0000000..a1491ee --- /dev/null +++ b/Help/prop_tgt/PROJECT_LABEL.rst @@ -0,0 +1,7 @@ +PROJECT_LABEL +------------- + +Change the name of a target in an IDE. + +Can be used to change the name of the target in an IDE like Visual +Studio. diff --git a/Help/prop_tgt/PUBLIC_HEADER.rst b/Help/prop_tgt/PUBLIC_HEADER.rst new file mode 100644 index 0000000..6e25d94 --- /dev/null +++ b/Help/prop_tgt/PUBLIC_HEADER.rst @@ -0,0 +1,11 @@ +PUBLIC_HEADER +------------- + +Specify public header files in a FRAMEWORK shared library target. + +Shared library targets marked with the FRAMEWORK property generate +frameworks on OS X and normal shared libraries on other platforms. +This property may be set to a list of header files to be placed in the +Headers directory inside the framework folder. On non-Apple platforms +these headers may be installed using the PUBLIC_HEADER option to the +install(TARGETS) command. diff --git a/Help/prop_tgt/RESOURCE.rst b/Help/prop_tgt/RESOURCE.rst new file mode 100644 index 0000000..1e9921d --- /dev/null +++ b/Help/prop_tgt/RESOURCE.rst @@ -0,0 +1,11 @@ +RESOURCE +-------- + +Specify resource files in a FRAMEWORK shared library target. + +Shared library targets marked with the FRAMEWORK property generate +frameworks on OS X and normal shared libraries on other platforms. +This property may be set to a list of files to be placed in the +Resources directory inside the framework folder. On non-Apple +platforms these files may be installed using the RESOURCE option to +the install(TARGETS) command. diff --git a/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst b/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst new file mode 100644 index 0000000..e92ab86 --- /dev/null +++ b/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_COMPILE +------------------- + +Specify a launcher for compile rules. + +See the global property of the same name for details. This overrides +the global and directory property for a target. diff --git a/Help/prop_tgt/RULE_LAUNCH_CUSTOM.rst b/Help/prop_tgt/RULE_LAUNCH_CUSTOM.rst new file mode 100644 index 0000000..2db0317 --- /dev/null +++ b/Help/prop_tgt/RULE_LAUNCH_CUSTOM.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_CUSTOM +------------------ + +Specify a launcher for custom rules. + +See the global property of the same name for details. This overrides +the global and directory property for a target. diff --git a/Help/prop_tgt/RULE_LAUNCH_LINK.rst b/Help/prop_tgt/RULE_LAUNCH_LINK.rst new file mode 100644 index 0000000..f330033 --- /dev/null +++ b/Help/prop_tgt/RULE_LAUNCH_LINK.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_LINK +---------------- + +Specify a launcher for link rules. + +See the global property of the same name for details. This overrides +the global and directory property for a target. diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..2aff5eb --- /dev/null +++ b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst @@ -0,0 +1,18 @@ +RUNTIME_OUTPUT_DIRECTORY +------------------------ + +Output directory in which to build RUNTIME target files. + +This property specifies the directory into which runtime target files +should be built. Multi-configuration generators (VS, Xcode) append a +per-configuration subdirectory to the specified directory. There are +three kinds of target files that may be built: archive, library, and +runtime. Executables are always treated as runtime targets. Static +libraries are always treated as archive targets. Module libraries are +always treated as library targets. For non-DLL platforms shared +libraries are treated as library targets. For DLL platforms the DLL +part of a shared library is treated as a runtime target and the +corresponding import library is treated as an archive target. All +Windows-based systems including Cygwin are DLL platforms. This +property is initialized by the value of the variable +CMAKE_RUNTIME_OUTPUT_DIRECTORY if it is set when a target is created. diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000..10be6cf --- /dev/null +++ b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,11 @@ +RUNTIME_OUTPUT_DIRECTORY_<CONFIG> +--------------------------------- + +Per-configuration output directory for RUNTIME target files. + +This is a per-configuration version of RUNTIME_OUTPUT_DIRECTORY, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the variable +CMAKE_RUNTIME_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is +created. diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst b/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst new file mode 100644 index 0000000..b62d887 --- /dev/null +++ b/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst @@ -0,0 +1,15 @@ +RUNTIME_OUTPUT_NAME +------------------- + +Output name for RUNTIME target files. + +This property specifies the base name for runtime target files. It +overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. There are +three kinds of target files that may be built: archive, library, and +runtime. Executables are always treated as runtime targets. Static +libraries are always treated as archive targets. Module libraries are +always treated as library targets. For non-DLL platforms shared +libraries are treated as library targets. For DLL platforms the DLL +part of a shared library is treated as a runtime target and the +corresponding import library is treated as an archive target. All +Windows-based systems including Cygwin are DLL platforms. diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst b/Help/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000..f9029e5 --- /dev/null +++ b/Help/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,6 @@ +RUNTIME_OUTPUT_NAME_<CONFIG> +---------------------------- + +Per-configuration output name for RUNTIME target files. + +This is the configuration-specific version of RUNTIME_OUTPUT_NAME. diff --git a/Help/prop_tgt/SKIP_BUILD_RPATH.rst b/Help/prop_tgt/SKIP_BUILD_RPATH.rst new file mode 100644 index 0000000..a91fa9c --- /dev/null +++ b/Help/prop_tgt/SKIP_BUILD_RPATH.rst @@ -0,0 +1,9 @@ +SKIP_BUILD_RPATH +---------------- + +Should rpaths be used for the build tree. + +SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic +generation of an rpath allowing the target to run from the build tree. +This property is initialized by the value of the variable +CMAKE_SKIP_BUILD_RPATH if it is set when a target is created. diff --git a/Help/prop_tgt/SOURCES.rst b/Help/prop_tgt/SOURCES.rst new file mode 100644 index 0000000..833b65a --- /dev/null +++ b/Help/prop_tgt/SOURCES.rst @@ -0,0 +1,7 @@ +SOURCES +------- + +Source names specified for a target. + +Read-only list of sources specified for a target. The names returned +are suitable for passing to the set_source_files_properties command. diff --git a/Help/prop_tgt/SOVERSION.rst b/Help/prop_tgt/SOVERSION.rst new file mode 100644 index 0000000..672ff23 --- /dev/null +++ b/Help/prop_tgt/SOVERSION.rst @@ -0,0 +1,14 @@ +SOVERSION +--------- + +What version number is this target. + +For shared libraries VERSION and SOVERSION can be used to specify the +build version and API version respectively. When building or +installing appropriate symlinks are created if the platform supports +symlinks and the linker supports so-names. If only one of both is +specified the missing is assumed to have the same version number. +SOVERSION is ignored if NO_SONAME property is set. For shared +libraries and executables on Windows the VERSION attribute is parsed +to extract a "major.minor" version number. These numbers are used as +the image version of the binary. diff --git a/Help/prop_tgt/STATIC_LIBRARY_FLAGS.rst b/Help/prop_tgt/STATIC_LIBRARY_FLAGS.rst new file mode 100644 index 0000000..d3b2cd4 --- /dev/null +++ b/Help/prop_tgt/STATIC_LIBRARY_FLAGS.rst @@ -0,0 +1,6 @@ +STATIC_LIBRARY_FLAGS +-------------------- + +Extra flags to use when linking static libraries. + +Extra flags to use when linking a static library. diff --git a/Help/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst b/Help/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst new file mode 100644 index 0000000..cca353d --- /dev/null +++ b/Help/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst @@ -0,0 +1,6 @@ +STATIC_LIBRARY_FLAGS_<CONFIG> +----------------------------- + +Per-configuration flags for creating a static library. + +This is the configuration-specific version of STATIC_LIBRARY_FLAGS. diff --git a/Help/prop_tgt/SUFFIX.rst b/Help/prop_tgt/SUFFIX.rst new file mode 100644 index 0000000..70844be --- /dev/null +++ b/Help/prop_tgt/SUFFIX.rst @@ -0,0 +1,7 @@ +SUFFIX +------ + +What comes after the target name. + +A target property that can be set to override the suffix (such as +".so" or ".exe") on the name of a library, module or executable. diff --git a/Help/prop_tgt/TYPE.rst b/Help/prop_tgt/TYPE.rst new file mode 100644 index 0000000..1951d46 --- /dev/null +++ b/Help/prop_tgt/TYPE.rst @@ -0,0 +1,8 @@ +TYPE +---- + +The type of the target. + +This read-only property can be used to test the type of the given +target. It will be one of STATIC_LIBRARY, MODULE_LIBRARY, +SHARED_LIBRARY, EXECUTABLE or one of the internal target types. diff --git a/Help/prop_tgt/VERSION.rst b/Help/prop_tgt/VERSION.rst new file mode 100644 index 0000000..87f6c49 --- /dev/null +++ b/Help/prop_tgt/VERSION.rst @@ -0,0 +1,16 @@ +VERSION +------- + +What version number is this target. + +For shared libraries VERSION and SOVERSION can be used to specify the +build version and API version respectively. When building or +installing appropriate symlinks are created if the platform supports +symlinks and the linker supports so-names. If only one of both is +specified the missing is assumed to have the same version number. For +executables VERSION can be used to specify the build version. When +building or installing appropriate symlinks are created if the +platform supports symlinks. For shared libraries and executables on +Windows the VERSION attribute is parsed to extract a "major.minor" +version number. These numbers are used as the image version of the +binary. diff --git a/Help/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst b/Help/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst new file mode 100644 index 0000000..3754410 --- /dev/null +++ b/Help/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst @@ -0,0 +1,11 @@ +VISIBILITY_INLINES_HIDDEN +------------------------- + +Whether to add a compile flag to hide symbols of inline functions + +The VISIBILITY_INLINES_HIDDEN property determines whether a flag for +hiding symbols for inline functions. the value passed used in a +visibility related compile option, such as -fvisibility=. This +property only has an affect for libraries and executables with +exports. This property is initialized by the value of the variable +CMAKE_VISIBILITY_INLINES_HIDDEN if it is set when a target is created. diff --git a/Help/prop_tgt/VS_DOTNET_REFERENCES.rst b/Help/prop_tgt/VS_DOTNET_REFERENCES.rst new file mode 100644 index 0000000..a661ad9 --- /dev/null +++ b/Help/prop_tgt/VS_DOTNET_REFERENCES.rst @@ -0,0 +1,7 @@ +VS_DOTNET_REFERENCES +-------------------- + +Visual Studio managed project .NET references + +Adds one or more semicolon-delimited .NET references to a generated +Visual Studio project. For example, "System;System.Windows.Forms". diff --git a/Help/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst b/Help/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst new file mode 100644 index 0000000..829d696 --- /dev/null +++ b/Help/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst @@ -0,0 +1,7 @@ +VS_DOTNET_TARGET_FRAMEWORK_VERSION +---------------------------------- + +Specify the .NET target framework version. + +Used to specify the .NET target framework version for C++/CLI. For +example, "v4.5". diff --git a/Help/prop_tgt/VS_GLOBAL_KEYWORD.rst b/Help/prop_tgt/VS_GLOBAL_KEYWORD.rst new file mode 100644 index 0000000..072475f --- /dev/null +++ b/Help/prop_tgt/VS_GLOBAL_KEYWORD.rst @@ -0,0 +1,9 @@ +VS_GLOBAL_KEYWORD +----------------- + +Visual Studio project keyword. + +Sets the "keyword" attribute for a generated Visual Studio project. +Defaults to "Win32Proj". You may wish to override this value with +"ManagedCProj", for example, in a Visual Studio managed C++ unit test +project. diff --git a/Help/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst b/Help/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst new file mode 100644 index 0000000..f4d9efc --- /dev/null +++ b/Help/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst @@ -0,0 +1,15 @@ +VS_GLOBAL_PROJECT_TYPES +----------------------- + +Visual Studio project type(s). + +Can be set to one or more UUIDs recognized by Visual Studio to +indicate the type of project. This value is copied verbatim into the +generated project file. Example for a managed C++ unit testing +project: + +:: + + {3AC096D0-A1C2-E12C-1390-A8335801FDAB};{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942} + +UUIDs are semicolon-delimited. diff --git a/Help/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst b/Help/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst new file mode 100644 index 0000000..a23c540 --- /dev/null +++ b/Help/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst @@ -0,0 +1,7 @@ +VS_GLOBAL_ROOTNAMESPACE +----------------------- + +Visual Studio project root namespace. + +Sets the "RootNamespace" attribute for a generated Visual Studio +project. The attribute will be generated only if this is set. diff --git a/Help/prop_tgt/VS_GLOBAL_variable.rst b/Help/prop_tgt/VS_GLOBAL_variable.rst new file mode 100644 index 0000000..56b8021 --- /dev/null +++ b/Help/prop_tgt/VS_GLOBAL_variable.rst @@ -0,0 +1,10 @@ +VS_GLOBAL_<variable> +-------------------- + +Visual Studio project-specific global variable. + +Tell the Visual Studio generator to set the global variable +'<variable>' to a given value in the generated Visual Studio project. +Ignored on other generators. Qt integration works better if +VS_GLOBAL_QtVersion is set to the version FindQt4.cmake found. For +example, "4.7.3" diff --git a/Help/prop_tgt/VS_KEYWORD.rst b/Help/prop_tgt/VS_KEYWORD.rst new file mode 100644 index 0000000..aa8e206 --- /dev/null +++ b/Help/prop_tgt/VS_KEYWORD.rst @@ -0,0 +1,7 @@ +VS_KEYWORD +---------- + +Visual Studio project keyword. + +Can be set to change the visual studio keyword, for example Qt +integration works better if this is set to Qt4VSv1.0. diff --git a/Help/prop_tgt/VS_SCC_AUXPATH.rst b/Help/prop_tgt/VS_SCC_AUXPATH.rst new file mode 100644 index 0000000..054f59e --- /dev/null +++ b/Help/prop_tgt/VS_SCC_AUXPATH.rst @@ -0,0 +1,7 @@ +VS_SCC_AUXPATH +-------------- + +Visual Studio Source Code Control Aux Path. + +Can be set to change the visual studio source code control auxpath +property. diff --git a/Help/prop_tgt/VS_SCC_LOCALPATH.rst b/Help/prop_tgt/VS_SCC_LOCALPATH.rst new file mode 100644 index 0000000..b5b7721 --- /dev/null +++ b/Help/prop_tgt/VS_SCC_LOCALPATH.rst @@ -0,0 +1,7 @@ +VS_SCC_LOCALPATH +---------------- + +Visual Studio Source Code Control Local Path. + +Can be set to change the visual studio source code control local path +property. diff --git a/Help/prop_tgt/VS_SCC_PROJECTNAME.rst b/Help/prop_tgt/VS_SCC_PROJECTNAME.rst new file mode 100644 index 0000000..6d7f628 --- /dev/null +++ b/Help/prop_tgt/VS_SCC_PROJECTNAME.rst @@ -0,0 +1,7 @@ +VS_SCC_PROJECTNAME +------------------ + +Visual Studio Source Code Control Project. + +Can be set to change the visual studio source code control project +name property. diff --git a/Help/prop_tgt/VS_SCC_PROVIDER.rst b/Help/prop_tgt/VS_SCC_PROVIDER.rst new file mode 100644 index 0000000..80475af --- /dev/null +++ b/Help/prop_tgt/VS_SCC_PROVIDER.rst @@ -0,0 +1,7 @@ +VS_SCC_PROVIDER +--------------- + +Visual Studio Source Code Control Provider. + +Can be set to change the visual studio source code control provider +property. diff --git a/Help/prop_tgt/VS_WINRT_EXTENSIONS.rst b/Help/prop_tgt/VS_WINRT_EXTENSIONS.rst new file mode 100644 index 0000000..cc6fb16 --- /dev/null +++ b/Help/prop_tgt/VS_WINRT_EXTENSIONS.rst @@ -0,0 +1,6 @@ +VS_WINRT_EXTENSIONS +------------------- + +Visual Studio project C++/CX language extensions for Windows Runtime + +Can be set to enable C++/CX language extensions. diff --git a/Help/prop_tgt/VS_WINRT_REFERENCES.rst b/Help/prop_tgt/VS_WINRT_REFERENCES.rst new file mode 100644 index 0000000..af98b2f --- /dev/null +++ b/Help/prop_tgt/VS_WINRT_REFERENCES.rst @@ -0,0 +1,7 @@ +VS_WINRT_REFERENCES +------------------- + +Visual Studio project Windows Runtime Metadata references + +Adds one or more semicolon-delimited WinRT references to a generated +Visual Studio project. For example, "Windows;Windows.UI.Core". diff --git a/Help/prop_tgt/WIN32_EXECUTABLE.rst b/Help/prop_tgt/WIN32_EXECUTABLE.rst new file mode 100644 index 0000000..336d5f7 --- /dev/null +++ b/Help/prop_tgt/WIN32_EXECUTABLE.rst @@ -0,0 +1,12 @@ +WIN32_EXECUTABLE +---------------- + +Build an executable with a WinMain entry point on windows. + +When this property is set to true the executable when linked on +Windows will be created with a WinMain() entry point instead of just +main(). This makes it a GUI executable instead of a console +application. See the CMAKE_MFC_FLAG variable documentation to +configure use of MFC for WinMain executables. This property is +initialized by the value of the variable CMAKE_WIN32_EXECUTABLE if it +is set when a target is created. diff --git a/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst b/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst new file mode 100644 index 0000000..0be313c --- /dev/null +++ b/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst @@ -0,0 +1,7 @@ +XCODE_ATTRIBUTE_<an-attribute> +------------------------------ + +Set Xcode target attributes directly. + +Tell the Xcode generator to set '<an-attribute>' to a given value in +the generated Xcode project. Ignored on other generators. diff --git a/Help/variable/APPLE.rst b/Help/variable/APPLE.rst new file mode 100644 index 0000000..3afdee8 --- /dev/null +++ b/Help/variable/APPLE.rst @@ -0,0 +1,6 @@ +APPLE +----- + +True if running on Mac OS X. + +Set to true on Mac OS X. diff --git a/Help/variable/BORLAND.rst b/Help/variable/BORLAND.rst new file mode 100644 index 0000000..4af6085 --- /dev/null +++ b/Help/variable/BORLAND.rst @@ -0,0 +1,6 @@ +BORLAND +------- + +True if the Borland compiler is being used. + +This is set to true if the Borland compiler is being used. diff --git a/Help/variable/BUILD_SHARED_LIBS.rst b/Help/variable/BUILD_SHARED_LIBS.rst new file mode 100644 index 0000000..6f30efb --- /dev/null +++ b/Help/variable/BUILD_SHARED_LIBS.rst @@ -0,0 +1,10 @@ +BUILD_SHARED_LIBS +----------------- + +Global flag to cause add_library to create shared libraries if on. + +If present and true, this will cause all libraries to be built shared +unless the library was explicitly added as a static library. This +variable is often added to projects as an OPTION so that each user of +a project can decide if they want to build the project using shared or +static libraries. diff --git a/Help/variable/CMAKE_ABSOLUTE_DESTINATION_FILES.rst b/Help/variable/CMAKE_ABSOLUTE_DESTINATION_FILES.rst new file mode 100644 index 0000000..3691453 --- /dev/null +++ b/Help/variable/CMAKE_ABSOLUTE_DESTINATION_FILES.rst @@ -0,0 +1,9 @@ +CMAKE_ABSOLUTE_DESTINATION_FILES +-------------------------------- + +List of files which have been installed using an ABSOLUTE DESTINATION path. + +This variable is defined by CMake-generated cmake_install.cmake +scripts. It can be used (read-only) by programs or scripts that +source those install scripts. This is used by some CPack generators +(e.g. RPM). diff --git a/Help/variable/CMAKE_AR.rst b/Help/variable/CMAKE_AR.rst new file mode 100644 index 0000000..5893677 --- /dev/null +++ b/Help/variable/CMAKE_AR.rst @@ -0,0 +1,7 @@ +CMAKE_AR +-------- + +Name of archiving tool for static libraries. + +This specifies the name of the program that creates archive or static +libraries. diff --git a/Help/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY.rst b/Help/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..6a22f73 --- /dev/null +++ b/Help/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY.rst @@ -0,0 +1,8 @@ +CMAKE_ARCHIVE_OUTPUT_DIRECTORY +------------------------------ + +Where to put all the ARCHIVE targets when built. + +This variable is used to initialize the ARCHIVE_OUTPUT_DIRECTORY +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_ARGC.rst b/Help/variable/CMAKE_ARGC.rst new file mode 100644 index 0000000..be120b8 --- /dev/null +++ b/Help/variable/CMAKE_ARGC.rst @@ -0,0 +1,7 @@ +CMAKE_ARGC +---------- + +Number of command line arguments passed to CMake in script mode. + +When run in -P script mode, CMake sets this variable to the number of +command line arguments. See also CMAKE_ARGV0, 1, 2 ... diff --git a/Help/variable/CMAKE_ARGV0.rst b/Help/variable/CMAKE_ARGV0.rst new file mode 100644 index 0000000..e5ed419 --- /dev/null +++ b/Help/variable/CMAKE_ARGV0.rst @@ -0,0 +1,9 @@ +CMAKE_ARGV0 +----------- + +Command line argument passed to CMake in script mode. + +When run in -P script mode, CMake sets this variable to the first +command line argument. It then also sets CMAKE_ARGV1, CMAKE_ARGV2, +... and so on, up to the number of command line arguments given. See +also CMAKE_ARGC. diff --git a/Help/variable/CMAKE_AUTOMOC.rst b/Help/variable/CMAKE_AUTOMOC.rst new file mode 100644 index 0000000..87e8a9b --- /dev/null +++ b/Help/variable/CMAKE_AUTOMOC.rst @@ -0,0 +1,7 @@ +CMAKE_AUTOMOC +------------- + +Whether to handle moc automatically for Qt targets. + +This variable is used to initialize the AUTOMOC property on all the +targets. See that target property for additional information. diff --git a/Help/variable/CMAKE_AUTOMOC_MOC_OPTIONS.rst b/Help/variable/CMAKE_AUTOMOC_MOC_OPTIONS.rst new file mode 100644 index 0000000..bdbed85 --- /dev/null +++ b/Help/variable/CMAKE_AUTOMOC_MOC_OPTIONS.rst @@ -0,0 +1,8 @@ +CMAKE_AUTOMOC_MOC_OPTIONS +------------------------- + +Additional options for moc when using automoc (see CMAKE_AUTOMOC). + +This variable is used to initialize the AUTOMOC_MOC_OPTIONS property +on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_AUTOMOC_RELAXED_MODE.rst b/Help/variable/CMAKE_AUTOMOC_RELAXED_MODE.rst new file mode 100644 index 0000000..8858410 --- /dev/null +++ b/Help/variable/CMAKE_AUTOMOC_RELAXED_MODE.rst @@ -0,0 +1,13 @@ +CMAKE_AUTOMOC_RELAXED_MODE +-------------------------- + +Switch between strict and relaxed automoc mode. + +By default, automoc behaves exactly as described in the documentation +of the AUTOMOC target property. When set to TRUE, it accepts more +input and tries to find the correct input file for moc even if it +differs from the documented behaviour. In this mode it e.g. also +checks whether a header file is intended to be processed by moc when a +"foo.moc" file has been included. + +Relaxed mode has to be enabled for KDE4 compatibility. diff --git a/Help/variable/CMAKE_BACKWARDS_COMPATIBILITY.rst b/Help/variable/CMAKE_BACKWARDS_COMPATIBILITY.rst new file mode 100644 index 0000000..4015739 --- /dev/null +++ b/Help/variable/CMAKE_BACKWARDS_COMPATIBILITY.rst @@ -0,0 +1,11 @@ +CMAKE_BACKWARDS_COMPATIBILITY +----------------------------- + +Version of cmake required to build project + +From the point of view of backwards compatibility, this specifies what +version of CMake should be supported. By default this value is the +version number of CMake that you are running. You can set this to an +older version of CMake to support deprecated commands of CMake in +projects that were written to use older versions of CMake. This can +be set by the user or set at the beginning of a CMakeLists file. diff --git a/Help/variable/CMAKE_BINARY_DIR.rst b/Help/variable/CMAKE_BINARY_DIR.rst new file mode 100644 index 0000000..703bb58 --- /dev/null +++ b/Help/variable/CMAKE_BINARY_DIR.rst @@ -0,0 +1,8 @@ +CMAKE_BINARY_DIR +---------------- + +The path to the top level of the build tree. + +This is the full path to the top level of the current CMake build +tree. For an in-source build, this would be the same as +CMAKE_SOURCE_DIR. diff --git a/Help/variable/CMAKE_BUILD_TOOL.rst b/Help/variable/CMAKE_BUILD_TOOL.rst new file mode 100644 index 0000000..f0bc938 --- /dev/null +++ b/Help/variable/CMAKE_BUILD_TOOL.rst @@ -0,0 +1,11 @@ +CMAKE_BUILD_TOOL +---------------- + +Tool used for the actual build process. + +This variable is set to the program that will be needed to build the +output of CMake. If the generator selected was Visual Studio 6, the +CMAKE_BUILD_TOOL will be set to msdev, for Unix Makefiles it will be +set to make or gmake, and for Visual Studio 7 it set to devenv. For +NMake Makefiles the value is nmake. This can be useful for adding +special flags and commands based on the final build environment. diff --git a/Help/variable/CMAKE_BUILD_TYPE.rst b/Help/variable/CMAKE_BUILD_TYPE.rst new file mode 100644 index 0000000..68f08ba --- /dev/null +++ b/Help/variable/CMAKE_BUILD_TYPE.rst @@ -0,0 +1,19 @@ +CMAKE_BUILD_TYPE +---------------- + +Specifies the build type on single-configuration generators. + +This statically specifies what build type (configuration) will be +built in this build tree. Possible values are empty, Debug, Release, +RelWithDebInfo and MinSizeRel. This variable is only meaningful to +single-configuration generators (such as make and Ninja) i.e. those +which choose a single configuration when CMake runs to generate a +build tree as opposed to multi-configuration generators which offer +selection of the build configuration within the generated build +environment. There are many per-config properties and variables +(usually following clean SOME_VAR_<CONFIG> order conventions), such as +CMAKE_C_FLAGS_<CONFIG>, specified as uppercase: +CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]. For example, +in a build tree configured to build type Debug, CMake will see to +having CMAKE_C_FLAGS_DEBUG settings get added to the CMAKE_C_FLAGS +settings. See also CMAKE_CONFIGURATION_TYPES. diff --git a/Help/variable/CMAKE_BUILD_WITH_INSTALL_RPATH.rst b/Help/variable/CMAKE_BUILD_WITH_INSTALL_RPATH.rst new file mode 100644 index 0000000..6875da6 --- /dev/null +++ b/Help/variable/CMAKE_BUILD_WITH_INSTALL_RPATH.rst @@ -0,0 +1,11 @@ +CMAKE_BUILD_WITH_INSTALL_RPATH +------------------------------ + +Use the install path for the RPATH + +Normally CMake uses the build tree for the RPATH when building +executables etc on systems that use RPATH. When the software is +installed the executables etc are relinked by CMake to have the +install RPATH. If this variable is set to true then the software is +always built with the install path for the RPATH and does not need to +be relinked when installed. diff --git a/Help/variable/CMAKE_CACHEFILE_DIR.rst b/Help/variable/CMAKE_CACHEFILE_DIR.rst new file mode 100644 index 0000000..78c7d93 --- /dev/null +++ b/Help/variable/CMAKE_CACHEFILE_DIR.rst @@ -0,0 +1,7 @@ +CMAKE_CACHEFILE_DIR +------------------- + +The directory with the CMakeCache.txt file. + +This is the full path to the directory that has the CMakeCache.txt +file in it. This is the same as CMAKE_BINARY_DIR. diff --git a/Help/variable/CMAKE_CACHE_MAJOR_VERSION.rst b/Help/variable/CMAKE_CACHE_MAJOR_VERSION.rst new file mode 100644 index 0000000..e6887d9 --- /dev/null +++ b/Help/variable/CMAKE_CACHE_MAJOR_VERSION.rst @@ -0,0 +1,8 @@ +CMAKE_CACHE_MAJOR_VERSION +------------------------- + +Major version of CMake used to create the CMakeCache.txt file + +This stores the major version of CMake used to write a CMake cache +file. It is only different when a different version of CMake is run +on a previously created cache file. diff --git a/Help/variable/CMAKE_CACHE_MINOR_VERSION.rst b/Help/variable/CMAKE_CACHE_MINOR_VERSION.rst new file mode 100644 index 0000000..799f0a9 --- /dev/null +++ b/Help/variable/CMAKE_CACHE_MINOR_VERSION.rst @@ -0,0 +1,8 @@ +CMAKE_CACHE_MINOR_VERSION +------------------------- + +Minor version of CMake used to create the CMakeCache.txt file + +This stores the minor version of CMake used to write a CMake cache +file. It is only different when a different version of CMake is run +on a previously created cache file. diff --git a/Help/variable/CMAKE_CACHE_PATCH_VERSION.rst b/Help/variable/CMAKE_CACHE_PATCH_VERSION.rst new file mode 100644 index 0000000..e67d544 --- /dev/null +++ b/Help/variable/CMAKE_CACHE_PATCH_VERSION.rst @@ -0,0 +1,8 @@ +CMAKE_CACHE_PATCH_VERSION +------------------------- + +Patch version of CMake used to create the CMakeCache.txt file + +This stores the patch version of CMake used to write a CMake cache +file. It is only different when a different version of CMake is run +on a previously created cache file. diff --git a/Help/variable/CMAKE_CFG_INTDIR.rst b/Help/variable/CMAKE_CFG_INTDIR.rst new file mode 100644 index 0000000..20435e5 --- /dev/null +++ b/Help/variable/CMAKE_CFG_INTDIR.rst @@ -0,0 +1,45 @@ +CMAKE_CFG_INTDIR +---------------- + +Build-time reference to per-configuration output subdirectory. + +For native build systems supporting multiple configurations in the +build tree (such as Visual Studio and Xcode), the value is a reference +to a build-time variable specifying the name of the per-configuration +output subdirectory. On Makefile generators this evaluates to "." +because there is only one configuration in a build tree. Example +values: + +:: + + $(IntDir) = Visual Studio 6 + $(OutDir) = Visual Studio 7, 8, 9 + $(Configuration) = Visual Studio 10 + $(CONFIGURATION) = Xcode + . = Make-based tools + +Since these values are evaluated by the native build system, this +variable is suitable only for use in command lines that will be +evaluated at build time. Example of intended usage: + +:: + + add_executable(mytool mytool.c) + add_custom_command( + OUTPUT out.txt + COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool + ${CMAKE_CURRENT_SOURCE_DIR}/in.txt out.txt + DEPENDS mytool in.txt + ) + add_custom_target(drive ALL DEPENDS out.txt) + +Note that CMAKE_CFG_INTDIR is no longer necessary for this purpose but +has been left for compatibility with existing projects. Instead +add_custom_command() recognizes executable target names in its COMMAND +option, so "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool" +can be replaced by just "mytool". + +This variable is read-only. Setting it is undefined behavior. In +multi-configuration build systems the value of this variable is passed +as the value of preprocessor symbol "CMAKE_INTDIR" to the compilation +of all source files. diff --git a/Help/variable/CMAKE_CL_64.rst b/Help/variable/CMAKE_CL_64.rst new file mode 100644 index 0000000..5096829 --- /dev/null +++ b/Help/variable/CMAKE_CL_64.rst @@ -0,0 +1,6 @@ +CMAKE_CL_64 +----------- + +Using the 64 bit compiler from Microsoft + +Set to true when using the 64 bit cl compiler from Microsoft. diff --git a/Help/variable/CMAKE_COLOR_MAKEFILE.rst b/Help/variable/CMAKE_COLOR_MAKEFILE.rst new file mode 100644 index 0000000..170baf3 --- /dev/null +++ b/Help/variable/CMAKE_COLOR_MAKEFILE.rst @@ -0,0 +1,7 @@ +CMAKE_COLOR_MAKEFILE +-------------------- + +Enables color output when using the Makefile generator. + +When enabled, the generated Makefiles will produce colored output. +Default is ON. diff --git a/Help/variable/CMAKE_COMMAND.rst b/Help/variable/CMAKE_COMMAND.rst new file mode 100644 index 0000000..f4e5f1e --- /dev/null +++ b/Help/variable/CMAKE_COMMAND.rst @@ -0,0 +1,8 @@ +CMAKE_COMMAND +------------- + +The full path to the cmake executable. + +This is the full path to the CMake executable cmake which is useful +from custom commands that want to use the cmake -E option for portable +system commands. (e.g. /usr/local/bin/cmake diff --git a/Help/variable/CMAKE_COMPILER_2005.rst b/Help/variable/CMAKE_COMPILER_2005.rst new file mode 100644 index 0000000..134559b --- /dev/null +++ b/Help/variable/CMAKE_COMPILER_2005.rst @@ -0,0 +1,6 @@ +CMAKE_COMPILER_2005 +------------------- + +Using the Visual Studio 2005 compiler from Microsoft + +Set to true when using the Visual Studio 2005 compiler from Microsoft. diff --git a/Help/variable/CMAKE_COMPILER_IS_GNULANG.rst b/Help/variable/CMAKE_COMPILER_IS_GNULANG.rst new file mode 100644 index 0000000..bc5652f --- /dev/null +++ b/Help/variable/CMAKE_COMPILER_IS_GNULANG.rst @@ -0,0 +1,15 @@ +CMAKE_COMPILER_IS_GNU<LANG> +--------------------------- + +True if the compiler is GNU. + +If the selected <LANG> compiler is the GNU compiler then this is TRUE, +if not it is FALSE. Unlike the other per-language variables, this +uses the GNU syntax for identifying languages instead of the CMake +syntax. Recognized values of the <LANG> suffix are: + +:: + + CC = C compiler + CXX = C++ compiler + G77 = Fortran compiler diff --git a/Help/variable/CMAKE_CONFIGURATION_TYPES.rst b/Help/variable/CMAKE_CONFIGURATION_TYPES.rst new file mode 100644 index 0000000..986b969 --- /dev/null +++ b/Help/variable/CMAKE_CONFIGURATION_TYPES.rst @@ -0,0 +1,10 @@ +CMAKE_CONFIGURATION_TYPES +------------------------- + +Specifies the available build types on multi-config generators. + +This specifies what build types (configurations) will be available +such as Debug, Release, RelWithDebInfo etc. This has reasonable +defaults on most platforms, but can be extended to provide other build +types. See also CMAKE_BUILD_TYPE for details of managing +configuration data, and CMAKE_CFG_INTDIR. diff --git a/Help/variable/CMAKE_CONFIG_POSTFIX.rst b/Help/variable/CMAKE_CONFIG_POSTFIX.rst new file mode 100644 index 0000000..af38bed --- /dev/null +++ b/Help/variable/CMAKE_CONFIG_POSTFIX.rst @@ -0,0 +1,7 @@ +CMAKE_<CONFIG>_POSTFIX +---------------------- + +Default filename postfix for libraries under configuration <CONFIG>. + +When a non-executable target is created its <CONFIG>_POSTFIX target +property is initialized with the value of this variable if it is set. diff --git a/Help/variable/CMAKE_CROSSCOMPILING.rst b/Help/variable/CMAKE_CROSSCOMPILING.rst new file mode 100644 index 0000000..cf9865b --- /dev/null +++ b/Help/variable/CMAKE_CROSSCOMPILING.rst @@ -0,0 +1,8 @@ +CMAKE_CROSSCOMPILING +-------------------- + +Is CMake currently cross compiling. + +This variable will be set to true by CMake if CMake is cross +compiling. Specifically if the build platform is different from the +target platform. diff --git a/Help/variable/CMAKE_CTEST_COMMAND.rst b/Help/variable/CMAKE_CTEST_COMMAND.rst new file mode 100644 index 0000000..d5dd2c3 --- /dev/null +++ b/Help/variable/CMAKE_CTEST_COMMAND.rst @@ -0,0 +1,8 @@ +CMAKE_CTEST_COMMAND +------------------- + +Full path to ctest command installed with cmake. + +This is the full path to the CTest executable ctest which is useful +from custom commands that want to use the cmake -E option for portable +system commands. diff --git a/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst b/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst new file mode 100644 index 0000000..fb55a11 --- /dev/null +++ b/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst @@ -0,0 +1,10 @@ +CMAKE_CURRENT_BINARY_DIR +------------------------ + +The path to the binary directory currently being processed. + +This the full path to the build directory that is currently being +processed by cmake. Each directory added by add_subdirectory will +create a binary directory in the build tree, and as it is being +processed this variable will be set. For in-source builds this is the +current source directory being processed. diff --git a/Help/variable/CMAKE_CURRENT_LIST_DIR.rst b/Help/variable/CMAKE_CURRENT_LIST_DIR.rst new file mode 100644 index 0000000..b816821 --- /dev/null +++ b/Help/variable/CMAKE_CURRENT_LIST_DIR.rst @@ -0,0 +1,17 @@ +CMAKE_CURRENT_LIST_DIR +---------------------- + +Full directory of the listfile currently being processed. + +As CMake processes the listfiles in your project this variable will +always be set to the directory where the listfile which is currently +being processed (CMAKE_CURRENT_LIST_FILE) is located. The value has +dynamic scope. When CMake starts processing commands in a source file +it sets this variable to the directory where this file is located. +When CMake finishes processing commands from the file it restores the +previous value. Therefore the value of the variable inside a macro or +function is the directory of the file invoking the bottom-most entry +on the call stack, not the directory of the file containing the macro +or function definition. + +See also CMAKE_CURRENT_LIST_FILE. diff --git a/Help/variable/CMAKE_CURRENT_LIST_FILE.rst b/Help/variable/CMAKE_CURRENT_LIST_FILE.rst new file mode 100644 index 0000000..910d7b4 --- /dev/null +++ b/Help/variable/CMAKE_CURRENT_LIST_FILE.rst @@ -0,0 +1,15 @@ +CMAKE_CURRENT_LIST_FILE +----------------------- + +Full path to the listfile currently being processed. + +As CMake processes the listfiles in your project this variable will +always be set to the one currently being processed. The value has +dynamic scope. When CMake starts processing commands in a source file +it sets this variable to the location of the file. When CMake +finishes processing commands from the file it restores the previous +value. Therefore the value of the variable inside a macro or function +is the file invoking the bottom-most entry on the call stack, not the +file containing the macro or function definition. + +See also CMAKE_PARENT_LIST_FILE. diff --git a/Help/variable/CMAKE_CURRENT_LIST_LINE.rst b/Help/variable/CMAKE_CURRENT_LIST_LINE.rst new file mode 100644 index 0000000..60e8e26 --- /dev/null +++ b/Help/variable/CMAKE_CURRENT_LIST_LINE.rst @@ -0,0 +1,7 @@ +CMAKE_CURRENT_LIST_LINE +----------------------- + +The line number of the current file being processed. + +This is the line number of the file currently being processed by +cmake. diff --git a/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst b/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst new file mode 100644 index 0000000..db063a4 --- /dev/null +++ b/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst @@ -0,0 +1,7 @@ +CMAKE_CURRENT_SOURCE_DIR +------------------------ + +The path to the source directory currently being processed. + +This the full path to the source directory that is currently being +processed by cmake. diff --git a/Help/variable/CMAKE_DEBUG_POSTFIX.rst b/Help/variable/CMAKE_DEBUG_POSTFIX.rst new file mode 100644 index 0000000..fde24b2 --- /dev/null +++ b/Help/variable/CMAKE_DEBUG_POSTFIX.rst @@ -0,0 +1,7 @@ +CMAKE_DEBUG_POSTFIX +------------------- + +See variable CMAKE_<CONFIG>_POSTFIX. + +This variable is a special case of the more-general +CMAKE_<CONFIG>_POSTFIX variable for the DEBUG configuration. diff --git a/Help/variable/CMAKE_DEBUG_TARGET_PROPERTIES.rst b/Help/variable/CMAKE_DEBUG_TARGET_PROPERTIES.rst new file mode 100644 index 0000000..2ded823 --- /dev/null +++ b/Help/variable/CMAKE_DEBUG_TARGET_PROPERTIES.rst @@ -0,0 +1,11 @@ +CMAKE_DEBUG_TARGET_PROPERTIES +----------------------------- + +Enables tracing output for target properties. + +This variable can be populated with a list of properties to generate +debug output for when evaluating target properties. Currently it can +only be used when evaluating the INCLUDE_DIRECTORIES, +COMPILE_DEFINITIONS and COMPILE_OPTIONS target properties. In that +case, it outputs a backtrace for each entry in the target property. +Default is unset. diff --git a/Help/variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName.rst b/Help/variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName.rst new file mode 100644 index 0000000..bcb277c --- /dev/null +++ b/Help/variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName.rst @@ -0,0 +1,15 @@ +CMAKE_DISABLE_FIND_PACKAGE_<PackageName> +---------------------------------------- + +Variable for disabling find_package() calls. + +Every non-REQUIRED find_package() call in a project can be disabled by +setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to TRUE. +This can be used to build a project without an optional package, +although that package is installed. + +This switch should be used during the initial CMake run. Otherwise if +the package has already been found in a previous CMake run, the +variables which have been stored in the cache will still be there. In +that case it is recommended to remove the cache variables for this +package from the cache using the cache editor or cmake -U diff --git a/Help/variable/CMAKE_DL_LIBS.rst b/Help/variable/CMAKE_DL_LIBS.rst new file mode 100644 index 0000000..cae4565 --- /dev/null +++ b/Help/variable/CMAKE_DL_LIBS.rst @@ -0,0 +1,7 @@ +CMAKE_DL_LIBS +------------- + +Name of library containing dlopen and dlcose. + +The name of the library that has dlopen and dlclose in it, usually +-ldl on most UNIX machines. diff --git a/Help/variable/CMAKE_EDIT_COMMAND.rst b/Help/variable/CMAKE_EDIT_COMMAND.rst new file mode 100644 index 0000000..24d26b5 --- /dev/null +++ b/Help/variable/CMAKE_EDIT_COMMAND.rst @@ -0,0 +1,7 @@ +CMAKE_EDIT_COMMAND +------------------ + +Full path to cmake-gui or ccmake. + +This is the full path to the CMake executable that can graphically +edit the cache. For example, cmake-gui, ccmake, or cmake -i. diff --git a/Help/variable/CMAKE_ERROR_DEPRECATED.rst b/Help/variable/CMAKE_ERROR_DEPRECATED.rst new file mode 100644 index 0000000..43ab282 --- /dev/null +++ b/Help/variable/CMAKE_ERROR_DEPRECATED.rst @@ -0,0 +1,8 @@ +CMAKE_ERROR_DEPRECATED +---------------------- + +Whether to issue deprecation errors for macros and functions. + +If TRUE, this can be used by macros and functions to issue fatal +errors when deprecated macros or functions are used. This variable is +FALSE by default. diff --git a/Help/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst b/Help/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst new file mode 100644 index 0000000..651d68d --- /dev/null +++ b/Help/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst @@ -0,0 +1,9 @@ +CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION +------------------------------------------- + +Ask cmake_install.cmake script to error out as soon as a file with absolute INSTALL DESTINATION is encountered. + +The fatal error is emitted before the installation of the offending +file takes place. This variable is used by CMake-generated +cmake_install.cmake scripts. If one sets this variable to ON while +running the script, it may get fatal error messages from the script. diff --git a/Help/variable/CMAKE_EXECUTABLE_SUFFIX.rst b/Help/variable/CMAKE_EXECUTABLE_SUFFIX.rst new file mode 100644 index 0000000..45c313c --- /dev/null +++ b/Help/variable/CMAKE_EXECUTABLE_SUFFIX.rst @@ -0,0 +1,9 @@ +CMAKE_EXECUTABLE_SUFFIX +----------------------- + +The suffix for executables on this platform. + +The suffix to use for the end of an executable filename if any, .exe +on Windows. + +CMAKE_EXECUTABLE_SUFFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst b/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst new file mode 100644 index 0000000..9e108f8 --- /dev/null +++ b/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst @@ -0,0 +1,6 @@ +CMAKE_EXE_LINKER_FLAGS +---------------------- + +Linker flags to be used to create executables. + +These flags will be used by the linker when creating an executable. diff --git a/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst new file mode 100644 index 0000000..dcaf300 --- /dev/null +++ b/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst @@ -0,0 +1,7 @@ +CMAKE_EXE_LINKER_FLAGS_<CONFIG> +------------------------------- + +Flags to be used when linking an executable. + +Same as CMAKE_C_FLAGS_* but used by the linker when creating +executables. diff --git a/Help/variable/CMAKE_EXTRA_GENERATOR.rst b/Help/variable/CMAKE_EXTRA_GENERATOR.rst new file mode 100644 index 0000000..71aec92 --- /dev/null +++ b/Help/variable/CMAKE_EXTRA_GENERATOR.rst @@ -0,0 +1,9 @@ +CMAKE_EXTRA_GENERATOR +--------------------- + +The extra generator used to build the project. + +When using the Eclipse, CodeBlocks or KDevelop generators, CMake +generates Makefiles (CMAKE_GENERATOR) and additionally project files +for the respective IDE. This IDE project file generator is stored in +CMAKE_EXTRA_GENERATOR (e.g. "Eclipse CDT4"). diff --git a/Help/variable/CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES.rst b/Help/variable/CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES.rst new file mode 100644 index 0000000..6187a7a --- /dev/null +++ b/Help/variable/CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES.rst @@ -0,0 +1,9 @@ +CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES +----------------------------------- + +Additional suffixes for shared libraries. + +Extensions for shared libraries other than that specified by +CMAKE_SHARED_LIBRARY_SUFFIX, if any. CMake uses this to recognize +external shared library files during analysis of libraries linked by a +target. diff --git a/Help/variable/CMAKE_FIND_LIBRARY_PREFIXES.rst b/Help/variable/CMAKE_FIND_LIBRARY_PREFIXES.rst new file mode 100644 index 0000000..1a9e7ce --- /dev/null +++ b/Help/variable/CMAKE_FIND_LIBRARY_PREFIXES.rst @@ -0,0 +1,9 @@ +CMAKE_FIND_LIBRARY_PREFIXES +--------------------------- + +Prefixes to prepend when looking for libraries. + +This specifies what prefixes to add to library names when the +find_library command looks for libraries. On UNIX systems this is +typically lib, meaning that when trying to find the foo library it +will look for libfoo. diff --git a/Help/variable/CMAKE_FIND_LIBRARY_SUFFIXES.rst b/Help/variable/CMAKE_FIND_LIBRARY_SUFFIXES.rst new file mode 100644 index 0000000..c533909 --- /dev/null +++ b/Help/variable/CMAKE_FIND_LIBRARY_SUFFIXES.rst @@ -0,0 +1,9 @@ +CMAKE_FIND_LIBRARY_SUFFIXES +--------------------------- + +Suffixes to append when looking for libraries. + +This specifies what suffixes to add to library names when the +find_library command looks for libraries. On Windows systems this is +typically .lib and .dll, meaning that when trying to find the foo +library it will look for foo.dll etc. diff --git a/Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst b/Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst new file mode 100644 index 0000000..5d7599c --- /dev/null +++ b/Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst @@ -0,0 +1,19 @@ +CMAKE_FIND_PACKAGE_WARN_NO_MODULE +--------------------------------- + +Tell find_package to warn if called without an explicit mode. + +If find_package is called without an explicit mode option (MODULE, +CONFIG or NO_MODULE) and no Find<pkg>.cmake module is in +CMAKE_MODULE_PATH then CMake implicitly assumes that the caller +intends to search for a package configuration file. If no package +configuration file is found then the wording of the failure message +must account for both the case that the package is really missing and +the case that the project has a bug and failed to provide the intended +Find module. If instead the caller specifies an explicit mode option +then the failure message can be more specific. + +Set CMAKE_FIND_PACKAGE_WARN_NO_MODULE to TRUE to tell find_package to +warn when it implicitly assumes Config mode. This helps developers +enforce use of an explicit mode in all calls to find_package within a +project. diff --git a/Help/variable/CMAKE_Fortran_FORMAT.rst b/Help/variable/CMAKE_Fortran_FORMAT.rst new file mode 100644 index 0000000..c0e971c --- /dev/null +++ b/Help/variable/CMAKE_Fortran_FORMAT.rst @@ -0,0 +1,7 @@ +CMAKE_Fortran_FORMAT +-------------------- + +Set to FIXED or FREE to indicate the Fortran source layout. + +This variable is used to initialize the Fortran_FORMAT property on all +the targets. See that target property for additional information. diff --git a/Help/variable/CMAKE_Fortran_MODDIR_DEFAULT.rst b/Help/variable/CMAKE_Fortran_MODDIR_DEFAULT.rst new file mode 100644 index 0000000..a8dfcdf --- /dev/null +++ b/Help/variable/CMAKE_Fortran_MODDIR_DEFAULT.rst @@ -0,0 +1,8 @@ +CMAKE_Fortran_MODDIR_DEFAULT +---------------------------- + +Fortran default module output directory. + +Most Fortran compilers write .mod files to the current working +directory. For those that do not, this is set to "." and used when +the Fortran_MODULE_DIRECTORY target property is not set. diff --git a/Help/variable/CMAKE_Fortran_MODDIR_FLAG.rst b/Help/variable/CMAKE_Fortran_MODDIR_FLAG.rst new file mode 100644 index 0000000..4b32df3 --- /dev/null +++ b/Help/variable/CMAKE_Fortran_MODDIR_FLAG.rst @@ -0,0 +1,7 @@ +CMAKE_Fortran_MODDIR_FLAG +------------------------- + +Fortran flag for module output directory. + +This stores the flag needed to pass the value of the +Fortran_MODULE_DIRECTORY target property to the compiler. diff --git a/Help/variable/CMAKE_Fortran_MODOUT_FLAG.rst b/Help/variable/CMAKE_Fortran_MODOUT_FLAG.rst new file mode 100644 index 0000000..a232213 --- /dev/null +++ b/Help/variable/CMAKE_Fortran_MODOUT_FLAG.rst @@ -0,0 +1,7 @@ +CMAKE_Fortran_MODOUT_FLAG +------------------------- + +Fortran flag to enable module output. + +Most Fortran compilers write .mod files out by default. For others, +this stores the flag needed to enable module output. diff --git a/Help/variable/CMAKE_Fortran_MODULE_DIRECTORY.rst b/Help/variable/CMAKE_Fortran_MODULE_DIRECTORY.rst new file mode 100644 index 0000000..b1d49d8 --- /dev/null +++ b/Help/variable/CMAKE_Fortran_MODULE_DIRECTORY.rst @@ -0,0 +1,8 @@ +CMAKE_Fortran_MODULE_DIRECTORY +------------------------------ + +Fortran module output directory. + +This variable is used to initialize the Fortran_MODULE_DIRECTORY +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_GENERATOR.rst b/Help/variable/CMAKE_GENERATOR.rst new file mode 100644 index 0000000..a4e70a5 --- /dev/null +++ b/Help/variable/CMAKE_GENERATOR.rst @@ -0,0 +1,7 @@ +CMAKE_GENERATOR +--------------- + +The generator used to build the project. + +The name of the generator that is being used to generate the build +files. (e.g. "Unix Makefiles", "Visual Studio 6", etc.) diff --git a/Help/variable/CMAKE_GENERATOR_TOOLSET.rst b/Help/variable/CMAKE_GENERATOR_TOOLSET.rst new file mode 100644 index 0000000..4540eaa --- /dev/null +++ b/Help/variable/CMAKE_GENERATOR_TOOLSET.rst @@ -0,0 +1,9 @@ +CMAKE_GENERATOR_TOOLSET +----------------------- + +Native build system toolset name specified by user. + +Some CMake generators support a toolset name to be given to the native +build system to choose a compiler. If the user specifies a toolset +name (e.g. via the cmake -T option) the value will be available in +this variable. diff --git a/Help/variable/CMAKE_GNUtoMS.rst b/Help/variable/CMAKE_GNUtoMS.rst new file mode 100644 index 0000000..e253f59 --- /dev/null +++ b/Help/variable/CMAKE_GNUtoMS.rst @@ -0,0 +1,8 @@ +CMAKE_GNUtoMS +------------- + +Convert GNU import libraries (.dll.a) to MS format (.lib). + +This variable is used to initialize the GNUtoMS property on targets +when they are created. See that target property for additional +information. diff --git a/Help/variable/CMAKE_HOME_DIRECTORY.rst b/Help/variable/CMAKE_HOME_DIRECTORY.rst new file mode 100644 index 0000000..fdc5d81 --- /dev/null +++ b/Help/variable/CMAKE_HOME_DIRECTORY.rst @@ -0,0 +1,6 @@ +CMAKE_HOME_DIRECTORY +-------------------- + +Path to top of source tree. + +This is the path to the top level of the source tree. diff --git a/Help/variable/CMAKE_HOST_APPLE.rst b/Help/variable/CMAKE_HOST_APPLE.rst new file mode 100644 index 0000000..d4b8483 --- /dev/null +++ b/Help/variable/CMAKE_HOST_APPLE.rst @@ -0,0 +1,6 @@ +CMAKE_HOST_APPLE +---------------- + +True for Apple OS X operating systems. + +Set to true when the host system is Apple OS X. diff --git a/Help/variable/CMAKE_HOST_SYSTEM.rst b/Help/variable/CMAKE_HOST_SYSTEM.rst new file mode 100644 index 0000000..4366ee3 --- /dev/null +++ b/Help/variable/CMAKE_HOST_SYSTEM.rst @@ -0,0 +1,7 @@ +CMAKE_HOST_SYSTEM +----------------- + +Name of system cmake is being run on. + +The same as CMAKE_SYSTEM but for the host system instead of the target +system when cross compiling. diff --git a/Help/variable/CMAKE_HOST_SYSTEM_NAME.rst b/Help/variable/CMAKE_HOST_SYSTEM_NAME.rst new file mode 100644 index 0000000..718208a --- /dev/null +++ b/Help/variable/CMAKE_HOST_SYSTEM_NAME.rst @@ -0,0 +1,7 @@ +CMAKE_HOST_SYSTEM_NAME +---------------------- + +Name of the OS CMake is running on. + +The same as CMAKE_SYSTEM_NAME but for the host system instead of the +target system when cross compiling. diff --git a/Help/variable/CMAKE_HOST_SYSTEM_PROCESSOR.rst b/Help/variable/CMAKE_HOST_SYSTEM_PROCESSOR.rst new file mode 100644 index 0000000..2700b66 --- /dev/null +++ b/Help/variable/CMAKE_HOST_SYSTEM_PROCESSOR.rst @@ -0,0 +1,7 @@ +CMAKE_HOST_SYSTEM_PROCESSOR +--------------------------- + +The name of the CPU CMake is running on. + +The same as CMAKE_SYSTEM_PROCESSOR but for the host system instead of +the target system when cross compiling. diff --git a/Help/variable/CMAKE_HOST_SYSTEM_VERSION.rst b/Help/variable/CMAKE_HOST_SYSTEM_VERSION.rst new file mode 100644 index 0000000..a8451e8 --- /dev/null +++ b/Help/variable/CMAKE_HOST_SYSTEM_VERSION.rst @@ -0,0 +1,7 @@ +CMAKE_HOST_SYSTEM_VERSION +------------------------- + +OS version CMake is running on. + +The same as CMAKE_SYSTEM_VERSION but for the host system instead of +the target system when cross compiling. diff --git a/Help/variable/CMAKE_HOST_UNIX.rst b/Help/variable/CMAKE_HOST_UNIX.rst new file mode 100644 index 0000000..bbefba7 --- /dev/null +++ b/Help/variable/CMAKE_HOST_UNIX.rst @@ -0,0 +1,7 @@ +CMAKE_HOST_UNIX +--------------- + +True for UNIX and UNIX like operating systems. + +Set to true when the host system is UNIX or UNIX like (i.e. APPLE and +CYGWIN). diff --git a/Help/variable/CMAKE_HOST_WIN32.rst b/Help/variable/CMAKE_HOST_WIN32.rst new file mode 100644 index 0000000..92ee456 --- /dev/null +++ b/Help/variable/CMAKE_HOST_WIN32.rst @@ -0,0 +1,6 @@ +CMAKE_HOST_WIN32 +---------------- + +True on windows systems, including win64. + +Set to true when the host system is Windows and on Cygwin. diff --git a/Help/variable/CMAKE_IGNORE_PATH.rst b/Help/variable/CMAKE_IGNORE_PATH.rst new file mode 100644 index 0000000..a818f74 --- /dev/null +++ b/Help/variable/CMAKE_IGNORE_PATH.rst @@ -0,0 +1,17 @@ +CMAKE_IGNORE_PATH +----------------- + +Path to be ignored by FIND_XXX() commands. + +Specifies directories to be ignored by searches in FIND_XXX() +commands. This is useful in cross-compiled environments where some +system directories contain incompatible but possibly linkable +libraries. For example, on cross-compiled cluster environments, this +allows a user to ignore directories containing libraries meant for the +front-end machine that modules like FindX11 (and others) would +normally search. By default this is empty; it is intended to be set +by the project. Note that CMAKE_IGNORE_PATH takes a list of directory +names, NOT a list of prefixes. If you want to ignore paths under +prefixes (bin, include, lib, etc.), you'll need to specify them +explicitly. See also CMAKE_PREFIX_PATH, CMAKE_LIBRARY_PATH, +CMAKE_INCLUDE_PATH, CMAKE_PROGRAM_PATH. diff --git a/Help/variable/CMAKE_IMPORT_LIBRARY_PREFIX.rst b/Help/variable/CMAKE_IMPORT_LIBRARY_PREFIX.rst new file mode 100644 index 0000000..1d16a37 --- /dev/null +++ b/Help/variable/CMAKE_IMPORT_LIBRARY_PREFIX.rst @@ -0,0 +1,9 @@ +CMAKE_IMPORT_LIBRARY_PREFIX +--------------------------- + +The prefix for import libraries that you link to. + +The prefix to use for the name of an import library if used on this +platform. + +CMAKE_IMPORT_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_IMPORT_LIBRARY_SUFFIX.rst b/Help/variable/CMAKE_IMPORT_LIBRARY_SUFFIX.rst new file mode 100644 index 0000000..c16825e --- /dev/null +++ b/Help/variable/CMAKE_IMPORT_LIBRARY_SUFFIX.rst @@ -0,0 +1,9 @@ +CMAKE_IMPORT_LIBRARY_SUFFIX +--------------------------- + +The suffix for import libraries that you link to. + +The suffix to use for the end of an import library filename if used on +this platform. + +CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_INCLUDE_CURRENT_DIR.rst b/Help/variable/CMAKE_INCLUDE_CURRENT_DIR.rst new file mode 100644 index 0000000..79f3952 --- /dev/null +++ b/Help/variable/CMAKE_INCLUDE_CURRENT_DIR.rst @@ -0,0 +1,13 @@ +CMAKE_INCLUDE_CURRENT_DIR +------------------------- + +Automatically add the current source- and build directories to the include path. + +If this variable is enabled, CMake automatically adds in each +directory ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} +to the include path for this directory. These additional include +directories do not propagate down to subdirectories. This is useful +mainly for out-of-source builds, where files generated into the build +tree are included by files located in the source tree. + +By default CMAKE_INCLUDE_CURRENT_DIR is OFF. diff --git a/Help/variable/CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE.rst b/Help/variable/CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE.rst new file mode 100644 index 0000000..948db50 --- /dev/null +++ b/Help/variable/CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE.rst @@ -0,0 +1,10 @@ +CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE +-------------------------------------- + +Automatically add the current source- and build directories to the INTERFACE_INCLUDE_DIRECTORIES. + +If this variable is enabled, CMake automatically adds for each shared +library target, static library target, module target and executable +target, ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} to +the INTERFACE_INCLUDE_DIRECTORIES.By default +CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE is OFF. diff --git a/Help/variable/CMAKE_INCLUDE_PATH.rst b/Help/variable/CMAKE_INCLUDE_PATH.rst new file mode 100644 index 0000000..360b403 --- /dev/null +++ b/Help/variable/CMAKE_INCLUDE_PATH.rst @@ -0,0 +1,10 @@ +CMAKE_INCLUDE_PATH +------------------ + +Path used for searching by FIND_FILE() and FIND_PATH(). + +Specifies a path which will be used both by FIND_FILE() and +FIND_PATH(). Both commands will check each of the contained +directories for the existence of the file which is currently searched. +By default it is empty, it is intended to be set by the project. See +also CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_PREFIX_PATH. diff --git a/Help/variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME.rst b/Help/variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME.rst new file mode 100644 index 0000000..2ad0689 --- /dev/null +++ b/Help/variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME.rst @@ -0,0 +1,9 @@ +CMAKE_INSTALL_DEFAULT_COMPONENT_NAME +------------------------------------ + +Default component used in install() commands. + +If an install() command is used without the COMPONENT argument, these +files will be grouped into a default component. The name of this +default install component will be taken from this variable. It +defaults to "Unspecified". diff --git a/Help/variable/CMAKE_INSTALL_NAME_DIR.rst b/Help/variable/CMAKE_INSTALL_NAME_DIR.rst new file mode 100644 index 0000000..540df6b --- /dev/null +++ b/Help/variable/CMAKE_INSTALL_NAME_DIR.rst @@ -0,0 +1,8 @@ +CMAKE_INSTALL_NAME_DIR +---------------------- + +Mac OS X directory name for installed targets. + +CMAKE_INSTALL_NAME_DIR is used to initialize the INSTALL_NAME_DIR +property on all targets. See that target property for more +information. diff --git a/Help/variable/CMAKE_INSTALL_PREFIX.rst b/Help/variable/CMAKE_INSTALL_PREFIX.rst new file mode 100644 index 0000000..72c8d41 --- /dev/null +++ b/Help/variable/CMAKE_INSTALL_PREFIX.rst @@ -0,0 +1,29 @@ +CMAKE_INSTALL_PREFIX +-------------------- + +Install directory used by install. + +If "make install" is invoked or INSTALL is built, this directory is +prepended onto all install directories. This variable defaults to +/usr/local on UNIX and c:/Program Files on Windows. + +On UNIX one can use the DESTDIR mechanism in order to relocate the +whole installation. DESTDIR means DESTination DIRectory. It is +commonly used by makefile users in order to install software at +non-default location. It is usually invoked like this: + +:: + + make DESTDIR=/home/john install + +which will install the concerned software using the installation +prefix, e.g. "/usr/local" prepended with the DESTDIR value which +finally gives "/home/john/usr/local". + +WARNING: DESTDIR may not be used on Windows because installation +prefix usually contains a drive letter like in "C:/Program Files" +which cannot be prepended with some other prefix. + +The installation prefix is also added to CMAKE_SYSTEM_PREFIX_PATH so +that find_package, find_program, find_library, find_path, and +find_file will search the prefix for other software. diff --git a/Help/variable/CMAKE_INSTALL_RPATH.rst b/Help/variable/CMAKE_INSTALL_RPATH.rst new file mode 100644 index 0000000..0992d57 --- /dev/null +++ b/Help/variable/CMAKE_INSTALL_RPATH.rst @@ -0,0 +1,8 @@ +CMAKE_INSTALL_RPATH +------------------- + +The rpath to use for installed targets. + +A semicolon-separated list specifying the rpath to use in installed +targets (for platforms that support it). This is used to initialize +the target property INSTALL_RPATH for all targets. diff --git a/Help/variable/CMAKE_INSTALL_RPATH_USE_LINK_PATH.rst b/Help/variable/CMAKE_INSTALL_RPATH_USE_LINK_PATH.rst new file mode 100644 index 0000000..9277a3b --- /dev/null +++ b/Help/variable/CMAKE_INSTALL_RPATH_USE_LINK_PATH.rst @@ -0,0 +1,9 @@ +CMAKE_INSTALL_RPATH_USE_LINK_PATH +--------------------------------- + +Add paths to linker search and installed rpath. + +CMAKE_INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true +will append directories in the linker search path and outside the +project to the INSTALL_RPATH. This is used to initialize the target +property INSTALL_RPATH_USE_LINK_PATH for all targets. diff --git a/Help/variable/CMAKE_INTERNAL_PLATFORM_ABI.rst b/Help/variable/CMAKE_INTERNAL_PLATFORM_ABI.rst new file mode 100644 index 0000000..9693bf6 --- /dev/null +++ b/Help/variable/CMAKE_INTERNAL_PLATFORM_ABI.rst @@ -0,0 +1,6 @@ +CMAKE_INTERNAL_PLATFORM_ABI +--------------------------- + +An internal variable subject to change. + +This is used in determining the compiler ABI and is subject to change. diff --git a/Help/variable/CMAKE_LANG_ARCHIVE_APPEND.rst b/Help/variable/CMAKE_LANG_ARCHIVE_APPEND.rst new file mode 100644 index 0000000..2c3abae --- /dev/null +++ b/Help/variable/CMAKE_LANG_ARCHIVE_APPEND.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_ARCHIVE_APPEND +--------------------------- + +Rule variable to append to a static archive. + +This is a rule variable that tells CMake how to append to a static +archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on +some platforms in order to support large object counts. See also +CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_FINISH. diff --git a/Help/variable/CMAKE_LANG_ARCHIVE_CREATE.rst b/Help/variable/CMAKE_LANG_ARCHIVE_CREATE.rst new file mode 100644 index 0000000..f93dd11 --- /dev/null +++ b/Help/variable/CMAKE_LANG_ARCHIVE_CREATE.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_ARCHIVE_CREATE +--------------------------- + +Rule variable to create a new static archive. + +This is a rule variable that tells CMake how to create a static +archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on +some platforms in order to support large object counts. See also +CMAKE_<LANG>_ARCHIVE_APPEND and CMAKE_<LANG>_ARCHIVE_FINISH. diff --git a/Help/variable/CMAKE_LANG_ARCHIVE_FINISH.rst b/Help/variable/CMAKE_LANG_ARCHIVE_FINISH.rst new file mode 100644 index 0000000..fff4128 --- /dev/null +++ b/Help/variable/CMAKE_LANG_ARCHIVE_FINISH.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_ARCHIVE_FINISH +--------------------------- + +Rule variable to finish an existing static archive. + +This is a rule variable that tells CMake how to finish a static +archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on +some platforms in order to support large object counts. See also +CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_APPEND. diff --git a/Help/variable/CMAKE_LANG_COMPILER.rst b/Help/variable/CMAKE_LANG_COMPILER.rst new file mode 100644 index 0000000..fffc347 --- /dev/null +++ b/Help/variable/CMAKE_LANG_COMPILER.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_COMPILER +--------------------- + +The full path to the compiler for LANG. + +This is the command that will be used as the <LANG> compiler. Once +set, you can not change this variable. diff --git a/Help/variable/CMAKE_LANG_COMPILER_ABI.rst b/Help/variable/CMAKE_LANG_COMPILER_ABI.rst new file mode 100644 index 0000000..be946c0 --- /dev/null +++ b/Help/variable/CMAKE_LANG_COMPILER_ABI.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_COMPILER_ABI +------------------------- + +An internal variable subject to change. + +This is used in determining the compiler ABI and is subject to change. diff --git a/Help/variable/CMAKE_LANG_COMPILER_ID.rst b/Help/variable/CMAKE_LANG_COMPILER_ID.rst new file mode 100644 index 0000000..cf9c386 --- /dev/null +++ b/Help/variable/CMAKE_LANG_COMPILER_ID.rst @@ -0,0 +1,33 @@ +CMAKE_<LANG>_COMPILER_ID +------------------------ + +Compiler identification string. + +A short string unique to the compiler vendor. Possible values +include: + +:: + + Absoft = Absoft Fortran (absoft.com) + ADSP = Analog VisualDSP++ (analog.com) + AppleClang = Apple Clang (apple.com) + Clang = LLVM Clang (clang.llvm.org) + Cray = Cray Compiler (cray.com) + Embarcadero, Borland = Embarcadero (embarcadero.com) + G95 = G95 Fortran (g95.org) + GNU = GNU Compiler Collection (gcc.gnu.org) + HP = Hewlett-Packard Compiler (hp.com) + Intel = Intel Compiler (intel.com) + MIPSpro = SGI MIPSpro (sgi.com) + MSVC = Microsoft Visual Studio (microsoft.com) + PGI = The Portland Group (pgroup.com) + PathScale = PathScale (pathscale.com) + SDCC = Small Device C Compiler (sdcc.sourceforge.net) + SunPro = Oracle Solaris Studio (oracle.com) + TI = Texas Instruments (ti.com) + TinyCC = Tiny C Compiler (tinycc.org) + Watcom = Open Watcom (openwatcom.org) + XL, VisualAge, zOS = IBM XL (ibm.com) + +This variable is not guaranteed to be defined for all compilers or +languages. diff --git a/Help/variable/CMAKE_LANG_COMPILER_LOADED.rst b/Help/variable/CMAKE_LANG_COMPILER_LOADED.rst new file mode 100644 index 0000000..3b8e9aa --- /dev/null +++ b/Help/variable/CMAKE_LANG_COMPILER_LOADED.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_COMPILER_LOADED +---------------------------- + +Defined to true if the language is enabled. + +When language <LANG> is enabled by project() or enable_language() this +variable is defined to 1. diff --git a/Help/variable/CMAKE_LANG_COMPILER_VERSION.rst b/Help/variable/CMAKE_LANG_COMPILER_VERSION.rst new file mode 100644 index 0000000..50e77eb --- /dev/null +++ b/Help/variable/CMAKE_LANG_COMPILER_VERSION.rst @@ -0,0 +1,8 @@ +CMAKE_<LANG>_COMPILER_VERSION +----------------------------- + +Compiler version string. + +Compiler version in major[.minor[.patch[.tweak]]] format. This +variable is not guaranteed to be defined for all compilers or +languages. diff --git a/Help/variable/CMAKE_LANG_COMPILE_OBJECT.rst b/Help/variable/CMAKE_LANG_COMPILE_OBJECT.rst new file mode 100644 index 0000000..f43ed6d --- /dev/null +++ b/Help/variable/CMAKE_LANG_COMPILE_OBJECT.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_COMPILE_OBJECT +--------------------------- + +Rule variable to compile a single object file. + +This is a rule variable that tells CMake how to compile a single +object file for the language <LANG>. diff --git a/Help/variable/CMAKE_LANG_CREATE_SHARED_LIBRARY.rst b/Help/variable/CMAKE_LANG_CREATE_SHARED_LIBRARY.rst new file mode 100644 index 0000000..adf1624 --- /dev/null +++ b/Help/variable/CMAKE_LANG_CREATE_SHARED_LIBRARY.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_CREATE_SHARED_LIBRARY +---------------------------------- + +Rule variable to create a shared library. + +This is a rule variable that tells CMake how to create a shared +library for the language <LANG>. diff --git a/Help/variable/CMAKE_LANG_CREATE_SHARED_MODULE.rst b/Help/variable/CMAKE_LANG_CREATE_SHARED_MODULE.rst new file mode 100644 index 0000000..406b4da --- /dev/null +++ b/Help/variable/CMAKE_LANG_CREATE_SHARED_MODULE.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_CREATE_SHARED_MODULE +--------------------------------- + +Rule variable to create a shared module. + +This is a rule variable that tells CMake how to create a shared +library for the language <LANG>. diff --git a/Help/variable/CMAKE_LANG_CREATE_STATIC_LIBRARY.rst b/Help/variable/CMAKE_LANG_CREATE_STATIC_LIBRARY.rst new file mode 100644 index 0000000..8114432 --- /dev/null +++ b/Help/variable/CMAKE_LANG_CREATE_STATIC_LIBRARY.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_CREATE_STATIC_LIBRARY +---------------------------------- + +Rule variable to create a static library. + +This is a rule variable that tells CMake how to create a static +library for the language <LANG>. diff --git a/Help/variable/CMAKE_LANG_FLAGS.rst b/Help/variable/CMAKE_LANG_FLAGS.rst new file mode 100644 index 0000000..6aa0a3e --- /dev/null +++ b/Help/variable/CMAKE_LANG_FLAGS.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_FLAGS +------------------ + +Flags for all build types. + +<LANG> flags used regardless of the value of CMAKE_BUILD_TYPE. diff --git a/Help/variable/CMAKE_LANG_FLAGS_DEBUG.rst b/Help/variable/CMAKE_LANG_FLAGS_DEBUG.rst new file mode 100644 index 0000000..a727641 --- /dev/null +++ b/Help/variable/CMAKE_LANG_FLAGS_DEBUG.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_FLAGS_DEBUG +------------------------ + +Flags for Debug build type or configuration. + +<LANG> flags used when CMAKE_BUILD_TYPE is Debug. diff --git a/Help/variable/CMAKE_LANG_FLAGS_MINSIZEREL.rst b/Help/variable/CMAKE_LANG_FLAGS_MINSIZEREL.rst new file mode 100644 index 0000000..fbb8516 --- /dev/null +++ b/Help/variable/CMAKE_LANG_FLAGS_MINSIZEREL.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_FLAGS_MINSIZEREL +----------------------------- + +Flags for MinSizeRel build type or configuration. + +<LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel.Short for +minimum size release. diff --git a/Help/variable/CMAKE_LANG_FLAGS_RELEASE.rst b/Help/variable/CMAKE_LANG_FLAGS_RELEASE.rst new file mode 100644 index 0000000..4b2c926 --- /dev/null +++ b/Help/variable/CMAKE_LANG_FLAGS_RELEASE.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_FLAGS_RELEASE +-------------------------- + +Flags for Release build type or configuration. + +<LANG> flags used when CMAKE_BUILD_TYPE is Release diff --git a/Help/variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO.rst b/Help/variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO.rst new file mode 100644 index 0000000..16bd4e9 --- /dev/null +++ b/Help/variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_FLAGS_RELWITHDEBINFO +--------------------------------- + +Flags for RelWithDebInfo type or configuration. + +<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo. Short for +Release With Debug Information. diff --git a/Help/variable/CMAKE_LANG_IGNORE_EXTENSIONS.rst b/Help/variable/CMAKE_LANG_IGNORE_EXTENSIONS.rst new file mode 100644 index 0000000..3d07e91 --- /dev/null +++ b/Help/variable/CMAKE_LANG_IGNORE_EXTENSIONS.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_IGNORE_EXTENSIONS +------------------------------ + +File extensions that should be ignored by the build. + +This is a list of file extensions that may be part of a project for a +given language but are not compiled. diff --git a/Help/variable/CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES.rst b/Help/variable/CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000..c60e18c --- /dev/null +++ b/Help/variable/CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES +----------------------------------------- + +Directories implicitly searched by the compiler for header files. + +CMake does not explicitly specify these directories on compiler +command lines for language <LANG>. This prevents system include +directories from being treated as user include directories on some +compilers. diff --git a/Help/variable/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES.rst b/Help/variable/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES.rst new file mode 100644 index 0000000..568950c --- /dev/null +++ b/Help/variable/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES.rst @@ -0,0 +1,17 @@ +CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES +-------------------------------------- + +Implicit linker search path detected for language <LANG>. + +Compilers typically pass directories containing language runtime +libraries and default library search paths when they invoke a linker. +These paths are implicit linker search directories for the compiler's +language. CMake automatically detects these directories for each +language and reports the results in this variable. + +When a library in one of these directories is given by full path to +target_link_libraries() CMake will generate the -l<name> form on link +lines to ensure the linker searches its implicit directories for the +library. Note that some toolchains read implicit directories from an +environment variable such as LIBRARY_PATH so keep its value consistent +when operating in a given build tree. diff --git a/Help/variable/CMAKE_LANG_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES.rst b/Help/variable/CMAKE_LANG_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES.rst new file mode 100644 index 0000000..05e6ddb --- /dev/null +++ b/Help/variable/CMAKE_LANG_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES.rst @@ -0,0 +1,8 @@ +CMAKE_<LANG>_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES +------------------------------------------------ + +Implicit linker framework search path detected for language <LANG>. + +These paths are implicit linker framework search directories for the +compiler's language. CMake automatically detects these directories +for each language and reports the results in this variable. diff --git a/Help/variable/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES.rst b/Help/variable/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES.rst new file mode 100644 index 0000000..fddfed8 --- /dev/null +++ b/Help/variable/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES.rst @@ -0,0 +1,10 @@ +CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES +------------------------------------ + +Implicit link libraries and flags detected for language <LANG>. + +Compilers typically pass language runtime library names and other +flags when they invoke a linker. These flags are implicit link +options for the compiler's language. CMake automatically detects +these libraries and flags for each language and reports the results in +this variable. diff --git a/Help/variable/CMAKE_LANG_LIBRARY_ARCHITECTURE.rst b/Help/variable/CMAKE_LANG_LIBRARY_ARCHITECTURE.rst new file mode 100644 index 0000000..4f31494 --- /dev/null +++ b/Help/variable/CMAKE_LANG_LIBRARY_ARCHITECTURE.rst @@ -0,0 +1,8 @@ +CMAKE_<LANG>_LIBRARY_ARCHITECTURE +--------------------------------- + +Target architecture library directory name detected for <lang>. + +If the <lang> compiler passes to the linker an architecture-specific +system library search directory such as <prefix>/lib/<arch> this +variable contains the <arch> name if/as detected by CMake. diff --git a/Help/variable/CMAKE_LANG_LINKER_PREFERENCE.rst b/Help/variable/CMAKE_LANG_LINKER_PREFERENCE.rst new file mode 100644 index 0000000..af7ee60 --- /dev/null +++ b/Help/variable/CMAKE_LANG_LINKER_PREFERENCE.rst @@ -0,0 +1,11 @@ +CMAKE_<LANG>_LINKER_PREFERENCE +------------------------------ + +Preference value for linker language selection. + +The "linker language" for executable, shared library, and module +targets is the language whose compiler will invoke the linker. The +LINKER_LANGUAGE target property sets the language explicitly. +Otherwise, the linker language is that whose linker preference value +is highest among languages compiled and linked into the target. See +also the CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES variable. diff --git a/Help/variable/CMAKE_LANG_LINKER_PREFERENCE_PROPAGATES.rst b/Help/variable/CMAKE_LANG_LINKER_PREFERENCE_PROPAGATES.rst new file mode 100644 index 0000000..d513767 --- /dev/null +++ b/Help/variable/CMAKE_LANG_LINKER_PREFERENCE_PROPAGATES.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES +----------------------------------------- + +True if CMAKE_<LANG>_LINKER_PREFERENCE propagates across targets. + +This is used when CMake selects a linker language for a target. +Languages compiled directly into the target are always considered. A +language compiled into static libraries linked by the target is +considered if this variable is true. diff --git a/Help/variable/CMAKE_LANG_LINK_EXECUTABLE.rst b/Help/variable/CMAKE_LANG_LINK_EXECUTABLE.rst new file mode 100644 index 0000000..abd5891 --- /dev/null +++ b/Help/variable/CMAKE_LANG_LINK_EXECUTABLE.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_LINK_EXECUTABLE +---------------------------- + +Rule variable to link an executable. + +Rule variable to link an executable for the given language. diff --git a/Help/variable/CMAKE_LANG_OUTPUT_EXTENSION.rst b/Help/variable/CMAKE_LANG_OUTPUT_EXTENSION.rst new file mode 100644 index 0000000..22fac29 --- /dev/null +++ b/Help/variable/CMAKE_LANG_OUTPUT_EXTENSION.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_OUTPUT_EXTENSION +----------------------------- + +Extension for the output of a compile for a single file. + +This is the extension for an object file for the given <LANG>. For +example .obj for C on Windows. diff --git a/Help/variable/CMAKE_LANG_PLATFORM_ID.rst b/Help/variable/CMAKE_LANG_PLATFORM_ID.rst new file mode 100644 index 0000000..1b243e3 --- /dev/null +++ b/Help/variable/CMAKE_LANG_PLATFORM_ID.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_PLATFORM_ID +------------------------ + +An internal variable subject to change. + +This is used in determining the platform and is subject to change. diff --git a/Help/variable/CMAKE_LANG_SIMULATE_ID.rst b/Help/variable/CMAKE_LANG_SIMULATE_ID.rst new file mode 100644 index 0000000..646c0db --- /dev/null +++ b/Help/variable/CMAKE_LANG_SIMULATE_ID.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_SIMULATE_ID +------------------------ + +Identification string of "simulated" compiler. + +Some compilers simulate other compilers to serve as drop-in +replacements. When CMake detects such a compiler it sets this +variable to what would have been the CMAKE_<LANG>_COMPILER_ID for the +simulated compiler. diff --git a/Help/variable/CMAKE_LANG_SIMULATE_VERSION.rst b/Help/variable/CMAKE_LANG_SIMULATE_VERSION.rst new file mode 100644 index 0000000..982053d --- /dev/null +++ b/Help/variable/CMAKE_LANG_SIMULATE_VERSION.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_SIMULATE_VERSION +----------------------------- + +Version string of "simulated" compiler. + +Some compilers simulate other compilers to serve as drop-in +replacements. When CMake detects such a compiler it sets this +variable to what would have been the CMAKE_<LANG>_COMPILER_VERSION for +the simulated compiler. diff --git a/Help/variable/CMAKE_LANG_SIZEOF_DATA_PTR.rst b/Help/variable/CMAKE_LANG_SIZEOF_DATA_PTR.rst new file mode 100644 index 0000000..c85b5e0 --- /dev/null +++ b/Help/variable/CMAKE_LANG_SIZEOF_DATA_PTR.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_SIZEOF_DATA_PTR +---------------------------- + +Size of pointer-to-data types for language <LANG>. + +This holds the size (in bytes) of pointer-to-data types in the target +platform ABI. It is defined for languages C and CXX (C++). diff --git a/Help/variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS.rst b/Help/variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS.rst new file mode 100644 index 0000000..e085fee --- /dev/null +++ b/Help/variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS +----------------------------------- + +Extensions of source files for the given language. + +This is the list of extensions for a given language's source files. diff --git a/Help/variable/CMAKE_LANG_VISIBILITY_PRESET.rst b/Help/variable/CMAKE_LANG_VISIBILITY_PRESET.rst new file mode 100644 index 0000000..bef670f --- /dev/null +++ b/Help/variable/CMAKE_LANG_VISIBILITY_PRESET.rst @@ -0,0 +1,8 @@ +CMAKE_<LANG>_VISIBILITY_PRESET +------------------------------ + +Default value for <LANG>_VISIBILITY_PRESET of targets. + +This variable is used to initialize the <LANG>_VISIBILITY_PRESET +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_LIBRARY_ARCHITECTURE.rst b/Help/variable/CMAKE_LIBRARY_ARCHITECTURE.rst new file mode 100644 index 0000000..c9a15f3 --- /dev/null +++ b/Help/variable/CMAKE_LIBRARY_ARCHITECTURE.rst @@ -0,0 +1,7 @@ +CMAKE_LIBRARY_ARCHITECTURE +-------------------------- + +Target architecture library directory name, if detected. + +This is the value of CMAKE_<lang>_LIBRARY_ARCHITECTURE as detected for +one of the enabled languages. diff --git a/Help/variable/CMAKE_LIBRARY_ARCHITECTURE_REGEX.rst b/Help/variable/CMAKE_LIBRARY_ARCHITECTURE_REGEX.rst new file mode 100644 index 0000000..6c41269 --- /dev/null +++ b/Help/variable/CMAKE_LIBRARY_ARCHITECTURE_REGEX.rst @@ -0,0 +1,7 @@ +CMAKE_LIBRARY_ARCHITECTURE_REGEX +-------------------------------- + +Regex matching possible target architecture library directory names. + +This is used to detect CMAKE_<lang>_LIBRARY_ARCHITECTURE from the +implicit linker search path by matching the <arch> name. diff --git a/Help/variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY.rst b/Help/variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..3bdd348 --- /dev/null +++ b/Help/variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY.rst @@ -0,0 +1,8 @@ +CMAKE_LIBRARY_OUTPUT_DIRECTORY +------------------------------ + +Where to put all the LIBRARY targets when built. + +This variable is used to initialize the LIBRARY_OUTPUT_DIRECTORY +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_LIBRARY_PATH.rst b/Help/variable/CMAKE_LIBRARY_PATH.rst new file mode 100644 index 0000000..e77dd34 --- /dev/null +++ b/Help/variable/CMAKE_LIBRARY_PATH.rst @@ -0,0 +1,10 @@ +CMAKE_LIBRARY_PATH +------------------ + +Path used for searching by FIND_LIBRARY(). + +Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() +will check each of the contained directories for the existence of the +library which is currently searched. By default it is empty, it is +intended to be set by the project. See also +CMAKE_SYSTEM_LIBRARY_PATH, CMAKE_PREFIX_PATH. diff --git a/Help/variable/CMAKE_LIBRARY_PATH_FLAG.rst b/Help/variable/CMAKE_LIBRARY_PATH_FLAG.rst new file mode 100644 index 0000000..ede39e9 --- /dev/null +++ b/Help/variable/CMAKE_LIBRARY_PATH_FLAG.rst @@ -0,0 +1,7 @@ +CMAKE_LIBRARY_PATH_FLAG +----------------------- + +The flag to be used to add a library search path to a compiler. + +The flag will be used to specify a library directory to the compiler. +On most compilers this is "-L". diff --git a/Help/variable/CMAKE_LINK_DEF_FILE_FLAG.rst b/Help/variable/CMAKE_LINK_DEF_FILE_FLAG.rst new file mode 100644 index 0000000..382447c --- /dev/null +++ b/Help/variable/CMAKE_LINK_DEF_FILE_FLAG.rst @@ -0,0 +1,7 @@ +CMAKE_LINK_DEF_FILE_FLAG +------------------------ + +Linker flag to be used to specify a .def file for dll creation. + +The flag will be used to add a .def file when creating a dll on +Windows; this is only defined on Windows. diff --git a/Help/variable/CMAKE_LINK_DEPENDS_NO_SHARED.rst b/Help/variable/CMAKE_LINK_DEPENDS_NO_SHARED.rst new file mode 100644 index 0000000..6ae7df6 --- /dev/null +++ b/Help/variable/CMAKE_LINK_DEPENDS_NO_SHARED.rst @@ -0,0 +1,8 @@ +CMAKE_LINK_DEPENDS_NO_SHARED +---------------------------- + +Whether to skip link dependencies on shared library files. + +This variable initializes the LINK_DEPENDS_NO_SHARED property on +targets when they are created. See that target property for +additional information. diff --git a/Help/variable/CMAKE_LINK_INTERFACE_LIBRARIES.rst b/Help/variable/CMAKE_LINK_INTERFACE_LIBRARIES.rst new file mode 100644 index 0000000..efe6fd7 --- /dev/null +++ b/Help/variable/CMAKE_LINK_INTERFACE_LIBRARIES.rst @@ -0,0 +1,8 @@ +CMAKE_LINK_INTERFACE_LIBRARIES +------------------------------ + +Default value for LINK_INTERFACE_LIBRARIES of targets. + +This variable is used to initialize the LINK_INTERFACE_LIBRARIES +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_LINK_LIBRARY_FILE_FLAG.rst b/Help/variable/CMAKE_LINK_LIBRARY_FILE_FLAG.rst new file mode 100644 index 0000000..6858e2c --- /dev/null +++ b/Help/variable/CMAKE_LINK_LIBRARY_FILE_FLAG.rst @@ -0,0 +1,7 @@ +CMAKE_LINK_LIBRARY_FILE_FLAG +---------------------------- + +Flag to be used to link a library specified by a path to its file. + +The flag will be used before a library file path is given to the +linker. This is needed only on very few platforms. diff --git a/Help/variable/CMAKE_LINK_LIBRARY_FLAG.rst b/Help/variable/CMAKE_LINK_LIBRARY_FLAG.rst new file mode 100644 index 0000000..c3e02d7 --- /dev/null +++ b/Help/variable/CMAKE_LINK_LIBRARY_FLAG.rst @@ -0,0 +1,7 @@ +CMAKE_LINK_LIBRARY_FLAG +----------------------- + +Flag to be used to link a library into an executable. + +The flag will be used to specify a library to link to an executable. +On most compilers this is "-l". diff --git a/Help/variable/CMAKE_LINK_LIBRARY_SUFFIX.rst b/Help/variable/CMAKE_LINK_LIBRARY_SUFFIX.rst new file mode 100644 index 0000000..390298d --- /dev/null +++ b/Help/variable/CMAKE_LINK_LIBRARY_SUFFIX.rst @@ -0,0 +1,6 @@ +CMAKE_LINK_LIBRARY_SUFFIX +------------------------- + +The suffix for libraries that you link to. + +The suffix to use for the end of a library filename, .lib on Windows. diff --git a/Help/variable/CMAKE_MACOSX_BUNDLE.rst b/Help/variable/CMAKE_MACOSX_BUNDLE.rst new file mode 100644 index 0000000..e4768f3 --- /dev/null +++ b/Help/variable/CMAKE_MACOSX_BUNDLE.rst @@ -0,0 +1,7 @@ +CMAKE_MACOSX_BUNDLE +------------------- + +Default value for MACOSX_BUNDLE of targets. + +This variable is used to initialize the MACOSX_BUNDLE property on all +the targets. See that target property for additional information. diff --git a/Help/variable/CMAKE_MAJOR_VERSION.rst b/Help/variable/CMAKE_MAJOR_VERSION.rst new file mode 100644 index 0000000..7dd24e5 --- /dev/null +++ b/Help/variable/CMAKE_MAJOR_VERSION.rst @@ -0,0 +1,6 @@ +CMAKE_MAJOR_VERSION +------------------- + +The Major version of cmake (i.e. the 2 in 2.X.X) + +This specifies the major version of the CMake executable being run. diff --git a/Help/variable/CMAKE_MAKE_PROGRAM.rst b/Help/variable/CMAKE_MAKE_PROGRAM.rst new file mode 100644 index 0000000..8307bc6 --- /dev/null +++ b/Help/variable/CMAKE_MAKE_PROGRAM.rst @@ -0,0 +1,7 @@ +CMAKE_MAKE_PROGRAM +------------------ + +See CMAKE_BUILD_TOOL. + +This variable is around for backwards compatibility, see +CMAKE_BUILD_TOOL. diff --git a/Help/variable/CMAKE_MAP_IMPORTED_CONFIG_CONFIG.rst b/Help/variable/CMAKE_MAP_IMPORTED_CONFIG_CONFIG.rst new file mode 100644 index 0000000..41ccde1 --- /dev/null +++ b/Help/variable/CMAKE_MAP_IMPORTED_CONFIG_CONFIG.rst @@ -0,0 +1,8 @@ +CMAKE_MAP_IMPORTED_CONFIG_<CONFIG> +---------------------------------- + +Default value for MAP_IMPORTED_CONFIG_<CONFIG> of targets. + +This variable is used to initialize the MAP_IMPORTED_CONFIG_<CONFIG> +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_MFC_FLAG.rst b/Help/variable/CMAKE_MFC_FLAG.rst new file mode 100644 index 0000000..221d26e --- /dev/null +++ b/Help/variable/CMAKE_MFC_FLAG.rst @@ -0,0 +1,16 @@ +CMAKE_MFC_FLAG +-------------- + +Tell cmake to use MFC for an executable or dll. + +This can be set in a CMakeLists.txt file and will enable MFC in the +application. It should be set to 1 for the static MFC library, and 2 +for the shared MFC library. This is used in Visual Studio 6 and 7 +project files. The CMakeSetup dialog used MFC and the CMakeLists.txt +looks like this: + +:: + + add_definitions(-D_AFXDLL) + set(CMAKE_MFC_FLAG 2) + add_executable(CMakeSetup WIN32 ${SRCS}) diff --git a/Help/variable/CMAKE_MINIMUM_REQUIRED_VERSION.rst b/Help/variable/CMAKE_MINIMUM_REQUIRED_VERSION.rst new file mode 100644 index 0000000..351de44 --- /dev/null +++ b/Help/variable/CMAKE_MINIMUM_REQUIRED_VERSION.rst @@ -0,0 +1,7 @@ +CMAKE_MINIMUM_REQUIRED_VERSION +------------------------------ + +Version specified to cmake_minimum_required command + +Variable containing the VERSION component specified in the +cmake_minimum_required command. diff --git a/Help/variable/CMAKE_MINOR_VERSION.rst b/Help/variable/CMAKE_MINOR_VERSION.rst new file mode 100644 index 0000000..bbc1073 --- /dev/null +++ b/Help/variable/CMAKE_MINOR_VERSION.rst @@ -0,0 +1,6 @@ +CMAKE_MINOR_VERSION +------------------- + +The Minor version of cmake (i.e. the 4 in X.4.X). + +This specifies the minor version of the CMake executable being run. diff --git a/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst b/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst new file mode 100644 index 0000000..6372bbd --- /dev/null +++ b/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst @@ -0,0 +1,6 @@ +CMAKE_MODULE_LINKER_FLAGS +------------------------- + +Linker flags to be used to create modules. + +These flags will be used by the linker when creating a module. diff --git a/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst new file mode 100644 index 0000000..87a1901 --- /dev/null +++ b/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst @@ -0,0 +1,6 @@ +CMAKE_MODULE_LINKER_FLAGS_<CONFIG> +---------------------------------- + +Flags to be used when linking a module. + +Same as CMAKE_C_FLAGS_* but used by the linker when creating modules. diff --git a/Help/variable/CMAKE_MODULE_PATH.rst b/Help/variable/CMAKE_MODULE_PATH.rst new file mode 100644 index 0000000..a2dde45 --- /dev/null +++ b/Help/variable/CMAKE_MODULE_PATH.rst @@ -0,0 +1,8 @@ +CMAKE_MODULE_PATH +----------------- + +List of directories to search for CMake modules. + +Commands like include() and find_package() search for files in +directories listed by this variable before checking the default +modules that come with CMake. diff --git a/Help/variable/CMAKE_NOT_USING_CONFIG_FLAGS.rst b/Help/variable/CMAKE_NOT_USING_CONFIG_FLAGS.rst new file mode 100644 index 0000000..cbe0350 --- /dev/null +++ b/Help/variable/CMAKE_NOT_USING_CONFIG_FLAGS.rst @@ -0,0 +1,7 @@ +CMAKE_NOT_USING_CONFIG_FLAGS +---------------------------- + +Skip _BUILD_TYPE flags if true. + +This is an internal flag used by the generators in CMake to tell CMake +to skip the _BUILD_TYPE flags. diff --git a/Help/variable/CMAKE_NO_BUILTIN_CHRPATH.rst b/Help/variable/CMAKE_NO_BUILTIN_CHRPATH.rst new file mode 100644 index 0000000..189f59f --- /dev/null +++ b/Help/variable/CMAKE_NO_BUILTIN_CHRPATH.rst @@ -0,0 +1,10 @@ +CMAKE_NO_BUILTIN_CHRPATH +------------------------ + +Do not use the builtin ELF editor to fix RPATHs on installation. + +When an ELF binary needs to have a different RPATH after installation +than it does in the build tree, CMake uses a builtin editor to change +the RPATH in the installed copy. If this variable is set to true then +CMake will relink the binary before installation instead of using its +builtin editor. diff --git a/Help/variable/CMAKE_NO_SYSTEM_FROM_IMPORTED.rst b/Help/variable/CMAKE_NO_SYSTEM_FROM_IMPORTED.rst new file mode 100644 index 0000000..c1919af --- /dev/null +++ b/Help/variable/CMAKE_NO_SYSTEM_FROM_IMPORTED.rst @@ -0,0 +1,8 @@ +CMAKE_NO_SYSTEM_FROM_IMPORTED +----------------------------- + +Default value for NO_SYSTEM_FROM_IMPORTED of targets. + +This variable is used to initialize the NO_SYSTEM_FROM_IMPORTED +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_OBJECT_PATH_MAX.rst b/Help/variable/CMAKE_OBJECT_PATH_MAX.rst new file mode 100644 index 0000000..9e30cbb --- /dev/null +++ b/Help/variable/CMAKE_OBJECT_PATH_MAX.rst @@ -0,0 +1,16 @@ +CMAKE_OBJECT_PATH_MAX +--------------------- + +Maximum object file full-path length allowed by native build tools. + +CMake computes for every source file an object file name that is +unique to the source file and deterministic with respect to the full +path to the source file. This allows multiple source files in a +target to share the same name if they lie in different directories +without rebuilding when one is added or removed. However, it can +produce long full paths in a few cases, so CMake shortens the path +using a hashing scheme when the full path to an object file exceeds a +limit. CMake has a built-in limit for each platform that is +sufficient for common tools, but some native tools may have a lower +limit. This variable may be set to specify the limit explicitly. The +value must be an integer no less than 128. diff --git a/Help/variable/CMAKE_PARENT_LIST_FILE.rst b/Help/variable/CMAKE_PARENT_LIST_FILE.rst new file mode 100644 index 0000000..5566a72 --- /dev/null +++ b/Help/variable/CMAKE_PARENT_LIST_FILE.rst @@ -0,0 +1,9 @@ +CMAKE_PARENT_LIST_FILE +---------------------- + +Full path to the CMake file that included the current one. + +While processing a CMake file loaded by include() or find_package() +this variable contains the full path to the file including it. The +top of the include stack is always the CMakeLists.txt for the current +directory. See also CMAKE_CURRENT_LIST_FILE. diff --git a/Help/variable/CMAKE_PATCH_VERSION.rst b/Help/variable/CMAKE_PATCH_VERSION.rst new file mode 100644 index 0000000..fe68bf2 --- /dev/null +++ b/Help/variable/CMAKE_PATCH_VERSION.rst @@ -0,0 +1,6 @@ +CMAKE_PATCH_VERSION +------------------- + +The patch version of cmake (i.e. the 3 in X.X.3). + +This specifies the patch version of the CMake executable being run. diff --git a/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst b/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..938d159 --- /dev/null +++ b/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst @@ -0,0 +1,8 @@ +CMAKE_PDB_OUTPUT_DIRECTORY +-------------------------- + +Where to put all the MS debug symbol files from linker. + +This variable is used to initialize the PDB_OUTPUT_DIRECTORY property +on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_POLICY_DEFAULT_CMPNNNN.rst b/Help/variable/CMAKE_POLICY_DEFAULT_CMPNNNN.rst new file mode 100644 index 0000000..e401aa5 --- /dev/null +++ b/Help/variable/CMAKE_POLICY_DEFAULT_CMPNNNN.rst @@ -0,0 +1,16 @@ +CMAKE_POLICY_DEFAULT_CMP<NNNN> +------------------------------ + +Default for CMake Policy CMP<NNNN> when it is otherwise left unset. + +Commands cmake_minimum_required(VERSION) and cmake_policy(VERSION) by +default leave policies introduced after the given version unset. Set +CMAKE_POLICY_DEFAULT_CMP<NNNN> to OLD or NEW to specify the default +for policy CMP<NNNN>, where <NNNN> is the policy number. + +This variable should not be set by a project in CMake code; use +cmake_policy(SET) instead. Users running CMake may set this variable +in the cache (e.g. -DCMAKE_POLICY_DEFAULT_CMP<NNNN>=<OLD|NEW>) to set +a policy not otherwise set by the project. Set to OLD to quiet a +policy warning while using old behavior or to NEW to try building the +project with new behavior. diff --git a/Help/variable/CMAKE_POSITION_INDEPENDENT_CODE.rst b/Help/variable/CMAKE_POSITION_INDEPENDENT_CODE.rst new file mode 100644 index 0000000..5e71665 --- /dev/null +++ b/Help/variable/CMAKE_POSITION_INDEPENDENT_CODE.rst @@ -0,0 +1,8 @@ +CMAKE_POSITION_INDEPENDENT_CODE +------------------------------- + +Default value for POSITION_INDEPENDENT_CODE of targets. + +This variable is used to initialize the POSITION_INDEPENDENT_CODE +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_PREFIX_PATH.rst b/Help/variable/CMAKE_PREFIX_PATH.rst new file mode 100644 index 0000000..4c21d5e --- /dev/null +++ b/Help/variable/CMAKE_PREFIX_PATH.rst @@ -0,0 +1,13 @@ +CMAKE_PREFIX_PATH +----------------- + +Path used for searching by FIND_XXX(), with appropriate suffixes added. + +Specifies a path which will be used by the FIND_XXX() commands. It +contains the "base" directories, the FIND_XXX() commands append +appropriate subdirectories to the base directories. So FIND_PROGRAM() +adds /bin to each of the directories in the path, FIND_LIBRARY() +appends /lib to each of the directories, and FIND_PATH() and +FIND_FILE() append /include . By default it is empty, it is intended +to be set by the project. See also CMAKE_SYSTEM_PREFIX_PATH, +CMAKE_INCLUDE_PATH, CMAKE_LIBRARY_PATH, CMAKE_PROGRAM_PATH. diff --git a/Help/variable/CMAKE_PROGRAM_PATH.rst b/Help/variable/CMAKE_PROGRAM_PATH.rst new file mode 100644 index 0000000..02c5e02 --- /dev/null +++ b/Help/variable/CMAKE_PROGRAM_PATH.rst @@ -0,0 +1,10 @@ +CMAKE_PROGRAM_PATH +------------------ + +Path used for searching by FIND_PROGRAM(). + +Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() +will check each of the contained directories for the existence of the +program which is currently searched. By default it is empty, it is +intended to be set by the project. See also +CMAKE_SYSTEM_PROGRAM_PATH, CMAKE_PREFIX_PATH. diff --git a/Help/variable/CMAKE_PROJECT_NAME.rst b/Help/variable/CMAKE_PROJECT_NAME.rst new file mode 100644 index 0000000..4734705 --- /dev/null +++ b/Help/variable/CMAKE_PROJECT_NAME.rst @@ -0,0 +1,7 @@ +CMAKE_PROJECT_NAME +------------------ + +The name of the current project. + +This specifies name of the current project from the closest inherited +PROJECT command. diff --git a/Help/variable/CMAKE_RANLIB.rst b/Help/variable/CMAKE_RANLIB.rst new file mode 100644 index 0000000..82672e9 --- /dev/null +++ b/Help/variable/CMAKE_RANLIB.rst @@ -0,0 +1,7 @@ +CMAKE_RANLIB +------------ + +Name of randomizing tool for static libraries. + +This specifies name of the program that randomizes libraries on UNIX, +not used on Windows, but may be present. diff --git a/Help/variable/CMAKE_ROOT.rst b/Help/variable/CMAKE_ROOT.rst new file mode 100644 index 0000000..f963a7f --- /dev/null +++ b/Help/variable/CMAKE_ROOT.rst @@ -0,0 +1,8 @@ +CMAKE_ROOT +---------- + +Install directory for running cmake. + +This is the install root for the running CMake and the Modules +directory can be found here. This is commonly used in this format: +${CMAKE_ROOT}/Modules diff --git a/Help/variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY.rst b/Help/variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..366ca66 --- /dev/null +++ b/Help/variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY.rst @@ -0,0 +1,8 @@ +CMAKE_RUNTIME_OUTPUT_DIRECTORY +------------------------------ + +Where to put all the RUNTIME targets when built. + +This variable is used to initialize the RUNTIME_OUTPUT_DIRECTORY +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_SCRIPT_MODE_FILE.rst b/Help/variable/CMAKE_SCRIPT_MODE_FILE.rst new file mode 100644 index 0000000..ad73cc0 --- /dev/null +++ b/Help/variable/CMAKE_SCRIPT_MODE_FILE.rst @@ -0,0 +1,8 @@ +CMAKE_SCRIPT_MODE_FILE +---------------------- + +Full path to the -P script file currently being processed. + +When run in -P script mode, CMake sets this variable to the full path +of the script file. When run to configure a CMakeLists.txt file, this +variable is not set. diff --git a/Help/variable/CMAKE_SHARED_LIBRARY_PREFIX.rst b/Help/variable/CMAKE_SHARED_LIBRARY_PREFIX.rst new file mode 100644 index 0000000..a863e2a --- /dev/null +++ b/Help/variable/CMAKE_SHARED_LIBRARY_PREFIX.rst @@ -0,0 +1,8 @@ +CMAKE_SHARED_LIBRARY_PREFIX +--------------------------- + +The prefix for shared libraries that you link to. + +The prefix to use for the name of a shared library, lib on UNIX. + +CMAKE_SHARED_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_SHARED_LIBRARY_SUFFIX.rst b/Help/variable/CMAKE_SHARED_LIBRARY_SUFFIX.rst new file mode 100644 index 0000000..c296ecd --- /dev/null +++ b/Help/variable/CMAKE_SHARED_LIBRARY_SUFFIX.rst @@ -0,0 +1,9 @@ +CMAKE_SHARED_LIBRARY_SUFFIX +--------------------------- + +The suffix for shared libraries that you link to. + +The suffix to use for the end of a shared library filename, .dll on +Windows. + +CMAKE_SHARED_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst b/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst new file mode 100644 index 0000000..fce950c --- /dev/null +++ b/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst @@ -0,0 +1,6 @@ +CMAKE_SHARED_LINKER_FLAGS +------------------------- + +Linker flags to be used to create shared libraries. + +These flags will be used by the linker when creating a shared library. diff --git a/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst new file mode 100644 index 0000000..fedc626 --- /dev/null +++ b/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst @@ -0,0 +1,7 @@ +CMAKE_SHARED_LINKER_FLAGS_<CONFIG> +---------------------------------- + +Flags to be used when linking a shared library. + +Same as CMAKE_C_FLAGS_* but used by the linker when creating shared +libraries. diff --git a/Help/variable/CMAKE_SHARED_MODULE_PREFIX.rst b/Help/variable/CMAKE_SHARED_MODULE_PREFIX.rst new file mode 100644 index 0000000..a5a2428 --- /dev/null +++ b/Help/variable/CMAKE_SHARED_MODULE_PREFIX.rst @@ -0,0 +1,8 @@ +CMAKE_SHARED_MODULE_PREFIX +-------------------------- + +The prefix for loadable modules that you link to. + +The prefix to use for the name of a loadable module on this platform. + +CMAKE_SHARED_MODULE_PREFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_SHARED_MODULE_SUFFIX.rst b/Help/variable/CMAKE_SHARED_MODULE_SUFFIX.rst new file mode 100644 index 0000000..32a3c34 --- /dev/null +++ b/Help/variable/CMAKE_SHARED_MODULE_SUFFIX.rst @@ -0,0 +1,9 @@ +CMAKE_SHARED_MODULE_SUFFIX +-------------------------- + +The suffix for shared libraries that you link to. + +The suffix to use for the end of a loadable module filename on this +platform + +CMAKE_SHARED_MODULE_SUFFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_SIZEOF_VOID_P.rst b/Help/variable/CMAKE_SIZEOF_VOID_P.rst new file mode 100644 index 0000000..2697fad --- /dev/null +++ b/Help/variable/CMAKE_SIZEOF_VOID_P.rst @@ -0,0 +1,8 @@ +CMAKE_SIZEOF_VOID_P +------------------- + +Size of a void pointer. + +This is set to the size of a pointer on the machine, and is determined +by a try compile. If a 64 bit size is found, then the library search +path is modified to look for 64 bit libraries first. diff --git a/Help/variable/CMAKE_SKIP_BUILD_RPATH.rst b/Help/variable/CMAKE_SKIP_BUILD_RPATH.rst new file mode 100644 index 0000000..8da6100 --- /dev/null +++ b/Help/variable/CMAKE_SKIP_BUILD_RPATH.rst @@ -0,0 +1,10 @@ +CMAKE_SKIP_BUILD_RPATH +---------------------- + +Do not include RPATHs in the build tree. + +Normally CMake uses the build tree for the RPATH when building +executables etc on systems that use RPATH. When the software is +installed the executables etc are relinked by CMake to have the +install RPATH. If this variable is set to true then the software is +always built with no RPATH. diff --git a/Help/variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY.rst b/Help/variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY.rst new file mode 100644 index 0000000..33ee8a8 --- /dev/null +++ b/Help/variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY.rst @@ -0,0 +1,11 @@ +CMAKE_SKIP_INSTALL_ALL_DEPENDENCY +--------------------------------- + +Don't make the install target depend on the all target. + +By default, the "install" target depends on the "all" target. This +has the effect, that when "make install" is invoked or INSTALL is +built, first the "all" target is built, then the installation starts. +If CMAKE_SKIP_INSTALL_ALL_DEPENDENCY is set to TRUE, this dependency +is not created, so the installation process will start immediately, +independent from whether the project has been completely built or not. diff --git a/Help/variable/CMAKE_SKIP_INSTALL_RPATH.rst b/Help/variable/CMAKE_SKIP_INSTALL_RPATH.rst new file mode 100644 index 0000000..f16b212 --- /dev/null +++ b/Help/variable/CMAKE_SKIP_INSTALL_RPATH.rst @@ -0,0 +1,14 @@ +CMAKE_SKIP_INSTALL_RPATH +------------------------ + +Do not include RPATHs in the install tree. + +Normally CMake uses the build tree for the RPATH when building +executables etc on systems that use RPATH. When the software is +installed the executables etc are relinked by CMake to have the +install RPATH. If this variable is set to true then the software is +always installed without RPATH, even if RPATH is enabled when +building. This can be useful for example to allow running tests from +the build directory with RPATH enabled before the installation step. +To omit RPATH in both the build and install steps, use +CMAKE_SKIP_RPATH instead. diff --git a/Help/variable/CMAKE_SKIP_RPATH.rst b/Help/variable/CMAKE_SKIP_RPATH.rst new file mode 100644 index 0000000..c93f67f --- /dev/null +++ b/Help/variable/CMAKE_SKIP_RPATH.rst @@ -0,0 +1,10 @@ +CMAKE_SKIP_RPATH +---------------- + +If true, do not add run time path information. + +If this is set to TRUE, then the rpath information is not added to +compiled executables. The default is to add rpath information if the +platform supports it. This allows for easy running from the build +tree. To omit RPATH in the install step, but not the build step, use +CMAKE_SKIP_INSTALL_RPATH instead. diff --git a/Help/variable/CMAKE_SOURCE_DIR.rst b/Help/variable/CMAKE_SOURCE_DIR.rst new file mode 100644 index 0000000..088fa83 --- /dev/null +++ b/Help/variable/CMAKE_SOURCE_DIR.rst @@ -0,0 +1,8 @@ +CMAKE_SOURCE_DIR +---------------- + +The path to the top level of the source tree. + +This is the full path to the top level of the current CMake source +tree. For an in-source build, this would be the same as +CMAKE_BINARY_DIR. diff --git a/Help/variable/CMAKE_STANDARD_LIBRARIES.rst b/Help/variable/CMAKE_STANDARD_LIBRARIES.rst new file mode 100644 index 0000000..9c728cd --- /dev/null +++ b/Help/variable/CMAKE_STANDARD_LIBRARIES.rst @@ -0,0 +1,7 @@ +CMAKE_STANDARD_LIBRARIES +------------------------ + +Libraries linked into every executable and shared library. + +This is the list of libraries that are linked into all executables and +libraries. diff --git a/Help/variable/CMAKE_STATIC_LIBRARY_PREFIX.rst b/Help/variable/CMAKE_STATIC_LIBRARY_PREFIX.rst new file mode 100644 index 0000000..0a3095d --- /dev/null +++ b/Help/variable/CMAKE_STATIC_LIBRARY_PREFIX.rst @@ -0,0 +1,8 @@ +CMAKE_STATIC_LIBRARY_PREFIX +--------------------------- + +The prefix for static libraries that you link to. + +The prefix to use for the name of a static library, lib on UNIX. + +CMAKE_STATIC_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_STATIC_LIBRARY_SUFFIX.rst b/Help/variable/CMAKE_STATIC_LIBRARY_SUFFIX.rst new file mode 100644 index 0000000..4d07671 --- /dev/null +++ b/Help/variable/CMAKE_STATIC_LIBRARY_SUFFIX.rst @@ -0,0 +1,9 @@ +CMAKE_STATIC_LIBRARY_SUFFIX +--------------------------- + +The suffix for static libraries that you link to. + +The suffix to use for the end of a static library filename, .lib on +Windows. + +CMAKE_STATIC_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_STATIC_LINKER_FLAGS.rst b/Help/variable/CMAKE_STATIC_LINKER_FLAGS.rst new file mode 100644 index 0000000..9c38673 --- /dev/null +++ b/Help/variable/CMAKE_STATIC_LINKER_FLAGS.rst @@ -0,0 +1,6 @@ +CMAKE_STATIC_LINKER_FLAGS +------------------------- + +Linker flags to be used to create static libraries. + +These flags will be used by the linker when creating a static library. diff --git a/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG.rst new file mode 100644 index 0000000..6cde24d --- /dev/null +++ b/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG.rst @@ -0,0 +1,7 @@ +CMAKE_STATIC_LINKER_FLAGS_<CONFIG> +---------------------------------- + +Flags to be used when linking a static library. + +Same as CMAKE_C_FLAGS_* but used by the linker when creating static +libraries. diff --git a/Help/variable/CMAKE_SYSTEM.rst b/Help/variable/CMAKE_SYSTEM.rst new file mode 100644 index 0000000..283d0be --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM.rst @@ -0,0 +1,9 @@ +CMAKE_SYSTEM +------------ + +Name of system cmake is compiling for. + +This variable is the composite of CMAKE_SYSTEM_NAME and +CMAKE_SYSTEM_VERSION, like this +${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}. If CMAKE_SYSTEM_VERSION +is not set, then CMAKE_SYSTEM is the same as CMAKE_SYSTEM_NAME. diff --git a/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst b/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst new file mode 100644 index 0000000..9e6b195 --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst @@ -0,0 +1,15 @@ +CMAKE_SYSTEM_IGNORE_PATH +------------------------ + +Path to be ignored by FIND_XXX() commands. + +Specifies directories to be ignored by searches in FIND_XXX() +commands. This is useful in cross-compiled environments where some +system directories contain incompatible but possibly linkable +libraries. For example, on cross-compiled cluster environments, this +allows a user to ignore directories containing libraries meant for the +front-end machine that modules like FindX11 (and others) would +normally search. By default this contains a list of directories +containing incompatible binaries for the host system. See also +CMAKE_SYSTEM_PREFIX_PATH, CMAKE_SYSTEM_LIBRARY_PATH, +CMAKE_SYSTEM_INCLUDE_PATH, and CMAKE_SYSTEM_PROGRAM_PATH. diff --git a/Help/variable/CMAKE_SYSTEM_INCLUDE_PATH.rst b/Help/variable/CMAKE_SYSTEM_INCLUDE_PATH.rst new file mode 100644 index 0000000..1734185 --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_INCLUDE_PATH.rst @@ -0,0 +1,11 @@ +CMAKE_SYSTEM_INCLUDE_PATH +------------------------- + +Path used for searching by FIND_FILE() and FIND_PATH(). + +Specifies a path which will be used both by FIND_FILE() and +FIND_PATH(). Both commands will check each of the contained +directories for the existence of the file which is currently searched. +By default it contains the standard directories for the current +system. It is NOT intended to be modified by the project, use +CMAKE_INCLUDE_PATH for this. See also CMAKE_SYSTEM_PREFIX_PATH. diff --git a/Help/variable/CMAKE_SYSTEM_LIBRARY_PATH.rst b/Help/variable/CMAKE_SYSTEM_LIBRARY_PATH.rst new file mode 100644 index 0000000..4778646 --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_LIBRARY_PATH.rst @@ -0,0 +1,11 @@ +CMAKE_SYSTEM_LIBRARY_PATH +------------------------- + +Path used for searching by FIND_LIBRARY(). + +Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() +will check each of the contained directories for the existence of the +library which is currently searched. By default it contains the +standard directories for the current system. It is NOT intended to be +modified by the project, use CMAKE_LIBRARY_PATH for this. See also +CMAKE_SYSTEM_PREFIX_PATH. diff --git a/Help/variable/CMAKE_SYSTEM_NAME.rst b/Help/variable/CMAKE_SYSTEM_NAME.rst new file mode 100644 index 0000000..9871dd9 --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_NAME.rst @@ -0,0 +1,9 @@ +CMAKE_SYSTEM_NAME +----------------- + +Name of the OS CMake is building for. + +This is the name of the operating system on which CMake is targeting. +On systems that have the uname command, this variable is set to the +output of uname -s. Linux, Windows, and Darwin for Mac OS X are the +values found on the big three operating systems. diff --git a/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst b/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst new file mode 100644 index 0000000..2dbae1f --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst @@ -0,0 +1,16 @@ +CMAKE_SYSTEM_PREFIX_PATH +------------------------ + +Path used for searching by FIND_XXX(), with appropriate suffixes added. + +Specifies a path which will be used by the FIND_XXX() commands. It +contains the "base" directories, the FIND_XXX() commands append +appropriate subdirectories to the base directories. So FIND_PROGRAM() +adds /bin to each of the directories in the path, FIND_LIBRARY() +appends /lib to each of the directories, and FIND_PATH() and +FIND_FILE() append /include . By default this contains the standard +directories for the current system and the CMAKE_INSTALL_PREFIX. It +is NOT intended to be modified by the project, use CMAKE_PREFIX_PATH +for this. See also CMAKE_SYSTEM_INCLUDE_PATH, +CMAKE_SYSTEM_LIBRARY_PATH, CMAKE_SYSTEM_PROGRAM_PATH, and +CMAKE_SYSTEM_IGNORE_PATH. diff --git a/Help/variable/CMAKE_SYSTEM_PROCESSOR.rst b/Help/variable/CMAKE_SYSTEM_PROCESSOR.rst new file mode 100644 index 0000000..1655ada --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_PROCESSOR.rst @@ -0,0 +1,8 @@ +CMAKE_SYSTEM_PROCESSOR +---------------------- + +The name of the CPU CMake is building for. + +On systems that support uname, this variable is set to the output of +uname -p, on windows it is set to the value of the environment +variable PROCESSOR_ARCHITECTURE diff --git a/Help/variable/CMAKE_SYSTEM_PROGRAM_PATH.rst b/Help/variable/CMAKE_SYSTEM_PROGRAM_PATH.rst new file mode 100644 index 0000000..e1fad63 --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_PROGRAM_PATH.rst @@ -0,0 +1,11 @@ +CMAKE_SYSTEM_PROGRAM_PATH +------------------------- + +Path used for searching by FIND_PROGRAM(). + +Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() +will check each of the contained directories for the existence of the +program which is currently searched. By default it contains the +standard directories for the current system. It is NOT intended to be +modified by the project, use CMAKE_PROGRAM_PATH for this. See also +CMAKE_SYSTEM_PREFIX_PATH. diff --git a/Help/variable/CMAKE_SYSTEM_VERSION.rst b/Help/variable/CMAKE_SYSTEM_VERSION.rst new file mode 100644 index 0000000..61bb40e --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_VERSION.rst @@ -0,0 +1,8 @@ +CMAKE_SYSTEM_VERSION +-------------------- + +OS version CMake is building for. + +A numeric version string for the system, on systems that support +uname, this variable is set to the output of uname -r. On other +systems this is set to major-minor version numbers. diff --git a/Help/variable/CMAKE_TRY_COMPILE_CONFIGURATION.rst b/Help/variable/CMAKE_TRY_COMPILE_CONFIGURATION.rst new file mode 100644 index 0000000..a92feab --- /dev/null +++ b/Help/variable/CMAKE_TRY_COMPILE_CONFIGURATION.rst @@ -0,0 +1,9 @@ +CMAKE_TRY_COMPILE_CONFIGURATION +------------------------------- + +Build configuration used for try_compile and try_run projects. + +Projects built by try_compile and try_run are built synchronously +during the CMake configuration step. Therefore a specific build +configuration must be chosen even if the generated build system +supports multiple configurations. diff --git a/Help/variable/CMAKE_TWEAK_VERSION.rst b/Help/variable/CMAKE_TWEAK_VERSION.rst new file mode 100644 index 0000000..56270aa --- /dev/null +++ b/Help/variable/CMAKE_TWEAK_VERSION.rst @@ -0,0 +1,8 @@ +CMAKE_TWEAK_VERSION +------------------- + +The tweak version of cmake (i.e. the 1 in X.X.X.1). + +This specifies the tweak version of the CMake executable being run. +Releases use tweak < 20000000 and development versions use the date +format CCYYMMDD for the tweak level. diff --git a/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst b/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst new file mode 100644 index 0000000..5a4c86b --- /dev/null +++ b/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst @@ -0,0 +1,23 @@ +CMAKE_USER_MAKE_RULES_OVERRIDE +------------------------------ + +Specify a CMake file that overrides platform information. + +CMake loads the specified file while enabling support for each +language from either the project() or enable_language() commands. It +is loaded after CMake's builtin compiler and platform information +modules have been loaded but before the information is used. The file +may set platform information variables to override CMake's defaults. + +This feature is intended for use only in overriding information +variables that must be set before CMake builds its first test project +to check that the compiler for a language works. It should not be +used to load a file in cases that a normal include() will work. Use +it only as a last resort for behavior that cannot be achieved any +other way. For example, one may set CMAKE_C_FLAGS_INIT to change the +default value used to initialize CMAKE_C_FLAGS before it is cached. +The override file should NOT be used to set anything that could be set +after languages are enabled, such as variables like +CMAKE_RUNTIME_OUTPUT_DIRECTORY that affect the placement of binaries. +Information set in the file will be used for try_compile and try_run +builds too. diff --git a/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE_LANG.rst b/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE_LANG.rst new file mode 100644 index 0000000..e6d2c68 --- /dev/null +++ b/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE_LANG.rst @@ -0,0 +1,7 @@ +CMAKE_USER_MAKE_RULES_OVERRIDE_<LANG> +------------------------------------- + +Specify a CMake file that overrides platform information for <LANG>. + +This is a language-specific version of CMAKE_USER_MAKE_RULES_OVERRIDE +loaded only when enabling language <LANG>. diff --git a/Help/variable/CMAKE_USE_RELATIVE_PATHS.rst b/Help/variable/CMAKE_USE_RELATIVE_PATHS.rst new file mode 100644 index 0000000..af6f08c --- /dev/null +++ b/Help/variable/CMAKE_USE_RELATIVE_PATHS.rst @@ -0,0 +1,10 @@ +CMAKE_USE_RELATIVE_PATHS +------------------------ + +Use relative paths (May not work!). + +If this is set to TRUE, then CMake will use relative paths between the +source and binary tree. This option does not work for more +complicated projects, and relative paths are used when possible. In +general, it is not possible to move CMake generated makefiles to a +different location regardless of the value of this variable. diff --git a/Help/variable/CMAKE_VERBOSE_MAKEFILE.rst b/Help/variable/CMAKE_VERBOSE_MAKEFILE.rst new file mode 100644 index 0000000..451ce8c --- /dev/null +++ b/Help/variable/CMAKE_VERBOSE_MAKEFILE.rst @@ -0,0 +1,8 @@ +CMAKE_VERBOSE_MAKEFILE +---------------------- + +Create verbose makefiles if on. + +This variable defaults to false. You can set this variable to true to +make CMake produce verbose makefiles that show each command line as it +is used. diff --git a/Help/variable/CMAKE_VERSION.rst b/Help/variable/CMAKE_VERSION.rst new file mode 100644 index 0000000..4ccc491 --- /dev/null +++ b/Help/variable/CMAKE_VERSION.rst @@ -0,0 +1,10 @@ +CMAKE_VERSION +------------- + +The full version of cmake in major.minor.patch[.tweak[-id]] format. + +This specifies the full version of the CMake executable being run. +This variable is defined by versions 2.6.3 and higher. See variables +CMAKE_MAJOR_VERSION, CMAKE_MINOR_VERSION, CMAKE_PATCH_VERSION, and +CMAKE_TWEAK_VERSION for individual version components. The [-id] +component appears in non-release versions and may be arbitrary text. diff --git a/Help/variable/CMAKE_VISIBILITY_INLINES_HIDDEN.rst b/Help/variable/CMAKE_VISIBILITY_INLINES_HIDDEN.rst new file mode 100644 index 0000000..f55c7b1 --- /dev/null +++ b/Help/variable/CMAKE_VISIBILITY_INLINES_HIDDEN.rst @@ -0,0 +1,8 @@ +CMAKE_VISIBILITY_INLINES_HIDDEN +------------------------------- + +Default value for VISIBILITY_INLINES_HIDDEN of targets. + +This variable is used to initialize the VISIBILITY_INLINES_HIDDEN +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_VS_PLATFORM_TOOLSET.rst b/Help/variable/CMAKE_VS_PLATFORM_TOOLSET.rst new file mode 100644 index 0000000..08c6061 --- /dev/null +++ b/Help/variable/CMAKE_VS_PLATFORM_TOOLSET.rst @@ -0,0 +1,10 @@ +CMAKE_VS_PLATFORM_TOOLSET +------------------------- + +Visual Studio Platform Toolset name. + +VS 10 and above use MSBuild under the hood and support multiple +compiler toolchains. CMake may specify a toolset explicitly, such as +"v110" for VS 11 or "Windows7.1SDK" for 64-bit support in VS 10 +Express. CMake provides the name of the chosen toolset in this +variable. diff --git a/Help/variable/CMAKE_WARN_DEPRECATED.rst b/Help/variable/CMAKE_WARN_DEPRECATED.rst new file mode 100644 index 0000000..7b2510b --- /dev/null +++ b/Help/variable/CMAKE_WARN_DEPRECATED.rst @@ -0,0 +1,7 @@ +CMAKE_WARN_DEPRECATED +--------------------- + +Whether to issue deprecation warnings for macros and functions. + +If TRUE, this can be used by macros and functions to issue deprecation +warnings. This variable is FALSE by default. diff --git a/Help/variable/CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION.rst b/Help/variable/CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION.rst new file mode 100644 index 0000000..f6a188d --- /dev/null +++ b/Help/variable/CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION.rst @@ -0,0 +1,8 @@ +CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION +------------------------------------------ + +Ask cmake_install.cmake script to warn each time a file with absolute INSTALL DESTINATION is encountered. + +This variable is used by CMake-generated cmake_install.cmake scripts. +If one sets this variable to ON while running the script, it may get +warning messages from the script. diff --git a/Help/variable/CMAKE_WIN32_EXECUTABLE.rst b/Help/variable/CMAKE_WIN32_EXECUTABLE.rst new file mode 100644 index 0000000..3e1e0dd --- /dev/null +++ b/Help/variable/CMAKE_WIN32_EXECUTABLE.rst @@ -0,0 +1,7 @@ +CMAKE_WIN32_EXECUTABLE +---------------------- + +Default value for WIN32_EXECUTABLE of targets. + +This variable is used to initialize the WIN32_EXECUTABLE property on +all the targets. See that target property for additional information. diff --git a/Help/variable/CMAKE_XCODE_PLATFORM_TOOLSET.rst b/Help/variable/CMAKE_XCODE_PLATFORM_TOOLSET.rst new file mode 100644 index 0000000..f0a4841 --- /dev/null +++ b/Help/variable/CMAKE_XCODE_PLATFORM_TOOLSET.rst @@ -0,0 +1,9 @@ +CMAKE_XCODE_PLATFORM_TOOLSET +---------------------------- + +Xcode compiler selection. + +Xcode supports selection of a compiler from one of the installed +toolsets. CMake provides the name of the chosen toolset in this +variable, if any is explicitly selected (e.g. via the cmake -T +option). diff --git a/Help/variable/CPACK_ABSOLUTE_DESTINATION_FILES.rst b/Help/variable/CPACK_ABSOLUTE_DESTINATION_FILES.rst new file mode 100644 index 0000000..d836629 --- /dev/null +++ b/Help/variable/CPACK_ABSOLUTE_DESTINATION_FILES.rst @@ -0,0 +1,10 @@ +CPACK_ABSOLUTE_DESTINATION_FILES +-------------------------------- + +List of files which have been installed using an ABSOLUTE DESTINATION path. + +This variable is a Read-Only variable which is set internally by CPack +during installation and before packaging using +CMAKE_ABSOLUTE_DESTINATION_FILES defined in cmake_install.cmake +scripts. The value can be used within CPack project configuration +file and/or CPack<GEN>.cmake file of <GEN> generator. diff --git a/Help/variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY.rst b/Help/variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY.rst new file mode 100644 index 0000000..e938978 --- /dev/null +++ b/Help/variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY.rst @@ -0,0 +1,8 @@ +CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY +------------------------------------------ + +Boolean toggle to include/exclude top level directory (component case). + +Similar usage as CPACK_INCLUDE_TOPLEVEL_DIRECTORY but for the +component case. See CPACK_INCLUDE_TOPLEVEL_DIRECTORY documentation +for the detail. diff --git a/Help/variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst b/Help/variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst new file mode 100644 index 0000000..4d96385 --- /dev/null +++ b/Help/variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst @@ -0,0 +1,10 @@ +CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION +------------------------------------------- + +Ask CPack to error out as soon as a file with absolute INSTALL DESTINATION is encountered. + +The fatal error is emitted before the installation of the offending +file takes place. Some CPack generators, like NSIS,enforce this +internally. This variable triggers the definition +ofCMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION when CPack runsVariables +common to all CPack generators diff --git a/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst b/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst new file mode 100644 index 0000000..4f96bff --- /dev/null +++ b/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst @@ -0,0 +1,19 @@ +CPACK_INCLUDE_TOPLEVEL_DIRECTORY +-------------------------------- + +Boolean toggle to include/exclude top level directory. + +When preparing a package CPack installs the item under the so-called +top level directory. The purpose of is to include (set to 1 or ON or +TRUE) the top level directory in the package or not (set to 0 or OFF +or FALSE). + +Each CPack generator has a built-in default value for this variable. +E.g. Archive generators (ZIP, TGZ, ...) includes the top level +whereas RPM or DEB don't. The user may override the default value by +setting this variable. + +There is a similar variable CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY +which may be used to override the behavior for the component packaging +case which may have different default value for historical (now +backward compatibility) reason. diff --git a/Help/variable/CPACK_INSTALL_SCRIPT.rst b/Help/variable/CPACK_INSTALL_SCRIPT.rst new file mode 100644 index 0000000..59b8cd7 --- /dev/null +++ b/Help/variable/CPACK_INSTALL_SCRIPT.rst @@ -0,0 +1,8 @@ +CPACK_INSTALL_SCRIPT +-------------------- + +Extra CMake script provided by the user. + +If set this CMake script will be executed by CPack during its local +[CPack-private] installation which is done right before packaging the +files. The script is not called by e.g.: make install. diff --git a/Help/variable/CPACK_PACKAGING_INSTALL_PREFIX.rst b/Help/variable/CPACK_PACKAGING_INSTALL_PREFIX.rst new file mode 100644 index 0000000..f9cfa1b --- /dev/null +++ b/Help/variable/CPACK_PACKAGING_INSTALL_PREFIX.rst @@ -0,0 +1,13 @@ +CPACK_PACKAGING_INSTALL_PREFIX +------------------------------ + +The prefix used in the built package. + +Each CPack generator has a default value (like /usr). This default +value may be overwritten from the CMakeLists.txt or the cpack command +line by setting an alternative value. + +e.g. set(CPACK_PACKAGING_INSTALL_PREFIX "/opt") + +This is not the same purpose as CMAKE_INSTALL_PREFIX which is used +when installing from the build tree without building a package. diff --git a/Help/variable/CPACK_SET_DESTDIR.rst b/Help/variable/CPACK_SET_DESTDIR.rst new file mode 100644 index 0000000..69d82e6 --- /dev/null +++ b/Help/variable/CPACK_SET_DESTDIR.rst @@ -0,0 +1,30 @@ +CPACK_SET_DESTDIR +----------------- + +Boolean toggle to make CPack use DESTDIR mechanism when packaging. + +DESTDIR means DESTination DIRectory. It is commonly used by makefile +users in order to install software at non-default location. It is a +basic relocation mechanism that should not be used on Windows (see +CMAKE_INSTALL_PREFIX documentation). It is usually invoked like this: + +:: + + make DESTDIR=/home/john install + +which will install the concerned software using the installation +prefix, e.g. "/usr/local" prepended with the DESTDIR value which +finally gives "/home/john/usr/local". When preparing a package, CPack +first installs the items to be packaged in a local (to the build tree) +directory by using the same DESTDIR mechanism. Nevertheless, if +CPACK_SET_DESTDIR is set then CPack will set DESTDIR before doing the +local install. The most noticeable difference is that without +CPACK_SET_DESTDIR, CPack uses CPACK_PACKAGING_INSTALL_PREFIX as a +prefix whereas with CPACK_SET_DESTDIR set, CPack will use +CMAKE_INSTALL_PREFIX as a prefix. + +Manually setting CPACK_SET_DESTDIR may help (or simply be necessary) +if some install rules uses absolute DESTINATION (see CMake INSTALL +command). However, starting with CPack/CMake 2.8.3 RPM and DEB +installers tries to handle DESTDIR automatically so that it is seldom +necessary for the user to set it. diff --git a/Help/variable/CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION.rst b/Help/variable/CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION.rst new file mode 100644 index 0000000..8d6f54f --- /dev/null +++ b/Help/variable/CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION.rst @@ -0,0 +1,8 @@ +CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION +------------------------------------------ + +Ask CPack to warn each time a file with absolute INSTALL DESTINATION is encountered. + +This variable triggers the definition of +CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION when CPack runs +cmake_install.cmake scripts. diff --git a/Help/variable/CYGWIN.rst b/Help/variable/CYGWIN.rst new file mode 100644 index 0000000..c168878 --- /dev/null +++ b/Help/variable/CYGWIN.rst @@ -0,0 +1,6 @@ +CYGWIN +------ + +True for Cygwin. + +Set to true when using Cygwin. diff --git a/Help/variable/ENV.rst b/Help/variable/ENV.rst new file mode 100644 index 0000000..977afc3 --- /dev/null +++ b/Help/variable/ENV.rst @@ -0,0 +1,7 @@ +ENV +--- + +Access environment variables. + +Use the syntax $ENV{VAR} to read environment variable VAR. See also +the set() command to set ENV{VAR}. diff --git a/Help/variable/EXECUTABLE_OUTPUT_PATH.rst b/Help/variable/EXECUTABLE_OUTPUT_PATH.rst new file mode 100644 index 0000000..7079230 --- /dev/null +++ b/Help/variable/EXECUTABLE_OUTPUT_PATH.rst @@ -0,0 +1,8 @@ +EXECUTABLE_OUTPUT_PATH +---------------------- + +Old executable location variable. + +The target property RUNTIME_OUTPUT_DIRECTORY supercedes this variable +for a target if it is set. Executable targets are otherwise placed in +this directory. diff --git a/Help/variable/LIBRARY_OUTPUT_PATH.rst b/Help/variable/LIBRARY_OUTPUT_PATH.rst new file mode 100644 index 0000000..1c1f8ae --- /dev/null +++ b/Help/variable/LIBRARY_OUTPUT_PATH.rst @@ -0,0 +1,9 @@ +LIBRARY_OUTPUT_PATH +------------------- + +Old library location variable. + +The target properties ARCHIVE_OUTPUT_DIRECTORY, +LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY supercede this +variable for a target if they are set. Library targets are otherwise +placed in this directory. diff --git a/Help/variable/MSVC.rst b/Help/variable/MSVC.rst new file mode 100644 index 0000000..e9f931b --- /dev/null +++ b/Help/variable/MSVC.rst @@ -0,0 +1,6 @@ +MSVC +---- + +True when using Microsoft Visual C + +Set to true when the compiler is some version of Microsoft Visual C. diff --git a/Help/variable/MSVC10.rst b/Help/variable/MSVC10.rst new file mode 100644 index 0000000..894c5aa --- /dev/null +++ b/Help/variable/MSVC10.rst @@ -0,0 +1,6 @@ +MSVC10 +------ + +True when using Microsoft Visual C 10.0 + +Set to true when the compiler is version 10.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC11.rst b/Help/variable/MSVC11.rst new file mode 100644 index 0000000..fe25297 --- /dev/null +++ b/Help/variable/MSVC11.rst @@ -0,0 +1,6 @@ +MSVC11 +------ + +True when using Microsoft Visual C 11.0 + +Set to true when the compiler is version 11.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC12.rst b/Help/variable/MSVC12.rst new file mode 100644 index 0000000..216d3d3 --- /dev/null +++ b/Help/variable/MSVC12.rst @@ -0,0 +1,6 @@ +MSVC12 +------ + +True when using Microsoft Visual C 12.0 + +Set to true when the compiler is version 12.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC60.rst b/Help/variable/MSVC60.rst new file mode 100644 index 0000000..572e9f4 --- /dev/null +++ b/Help/variable/MSVC60.rst @@ -0,0 +1,6 @@ +MSVC60 +------ + +True when using Microsoft Visual C 6.0 + +Set to true when the compiler is version 6.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC70.rst b/Help/variable/MSVC70.rst new file mode 100644 index 0000000..b1b7a881 --- /dev/null +++ b/Help/variable/MSVC70.rst @@ -0,0 +1,6 @@ +MSVC70 +------ + +True when using Microsoft Visual C 7.0 + +Set to true when the compiler is version 7.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC71.rst b/Help/variable/MSVC71.rst new file mode 100644 index 0000000..af309a6 --- /dev/null +++ b/Help/variable/MSVC71.rst @@ -0,0 +1,6 @@ +MSVC71 +------ + +True when using Microsoft Visual C 7.1 + +Set to true when the compiler is version 7.1 of Microsoft Visual C. diff --git a/Help/variable/MSVC80.rst b/Help/variable/MSVC80.rst new file mode 100644 index 0000000..306c67f --- /dev/null +++ b/Help/variable/MSVC80.rst @@ -0,0 +1,6 @@ +MSVC80 +------ + +True when using Microsoft Visual C 8.0 + +Set to true when the compiler is version 8.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC90.rst b/Help/variable/MSVC90.rst new file mode 100644 index 0000000..3cfcc67 --- /dev/null +++ b/Help/variable/MSVC90.rst @@ -0,0 +1,6 @@ +MSVC90 +------ + +True when using Microsoft Visual C 9.0 + +Set to true when the compiler is version 9.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC_IDE.rst b/Help/variable/MSVC_IDE.rst new file mode 100644 index 0000000..055f876 --- /dev/null +++ b/Help/variable/MSVC_IDE.rst @@ -0,0 +1,7 @@ +MSVC_IDE +-------- + +True when using the Microsoft Visual C IDE + +Set to true when the target platform is the Microsoft Visual C IDE, as +opposed to the command line compiler. diff --git a/Help/variable/MSVC_VERSION.rst b/Help/variable/MSVC_VERSION.rst new file mode 100644 index 0000000..d74114e --- /dev/null +++ b/Help/variable/MSVC_VERSION.rst @@ -0,0 +1,17 @@ +MSVC_VERSION +------------ + +The version of Microsoft Visual C/C++ being used if any. + +Known version numbers are: + +:: + + 1200 = VS 6.0 + 1300 = VS 7.0 + 1310 = VS 7.1 + 1400 = VS 8.0 + 1500 = VS 9.0 + 1600 = VS 10.0 + 1700 = VS 11.0 + 1800 = VS 12.0 diff --git a/Help/variable/PROJECT-NAME_BINARY_DIR.rst b/Help/variable/PROJECT-NAME_BINARY_DIR.rst new file mode 100644 index 0000000..a19940f --- /dev/null +++ b/Help/variable/PROJECT-NAME_BINARY_DIR.rst @@ -0,0 +1,8 @@ +<PROJECT-NAME>_BINARY_DIR +------------------------- + +Top level binary directory for the named project. + +A variable is created with the name used in the PROJECT command, and +is the binary directory for the project. This can be useful when +SUBDIR is used to connect several projects. diff --git a/Help/variable/PROJECT-NAME_SOURCE_DIR.rst b/Help/variable/PROJECT-NAME_SOURCE_DIR.rst new file mode 100644 index 0000000..f2f5caf --- /dev/null +++ b/Help/variable/PROJECT-NAME_SOURCE_DIR.rst @@ -0,0 +1,8 @@ +<PROJECT-NAME>_SOURCE_DIR +------------------------- + +Top level source directory for the named project. + +A variable is created with the name used in the PROJECT command, and +is the source directory for the project. This can be useful when +add_subdirectory is used to connect several projects. diff --git a/Help/variable/PROJECT_BINARY_DIR.rst b/Help/variable/PROJECT_BINARY_DIR.rst new file mode 100644 index 0000000..e506bdd --- /dev/null +++ b/Help/variable/PROJECT_BINARY_DIR.rst @@ -0,0 +1,6 @@ +PROJECT_BINARY_DIR +------------------ + +Full path to build directory for project. + +This is the binary directory of the most recent PROJECT command. diff --git a/Help/variable/PROJECT_NAME.rst b/Help/variable/PROJECT_NAME.rst new file mode 100644 index 0000000..7559af6 --- /dev/null +++ b/Help/variable/PROJECT_NAME.rst @@ -0,0 +1,6 @@ +PROJECT_NAME +------------ + +Name of the project given to the project command. + +This is the name given to the most recent PROJECT command. diff --git a/Help/variable/PROJECT_SOURCE_DIR.rst b/Help/variable/PROJECT_SOURCE_DIR.rst new file mode 100644 index 0000000..c9ba132 --- /dev/null +++ b/Help/variable/PROJECT_SOURCE_DIR.rst @@ -0,0 +1,6 @@ +PROJECT_SOURCE_DIR +------------------ + +Top level source directory for the current project. + +This is the source directory of the most recent PROJECT command. diff --git a/Help/variable/UNIX.rst b/Help/variable/UNIX.rst new file mode 100644 index 0000000..82e3454 --- /dev/null +++ b/Help/variable/UNIX.rst @@ -0,0 +1,7 @@ +UNIX +---- + +True for UNIX and UNIX like operating systems. + +Set to true when the target system is UNIX or UNIX like (i.e. APPLE +and CYGWIN). diff --git a/Help/variable/WIN32.rst b/Help/variable/WIN32.rst new file mode 100644 index 0000000..8cf7bf3 --- /dev/null +++ b/Help/variable/WIN32.rst @@ -0,0 +1,6 @@ +WIN32 +----- + +True on windows systems, including win64. + +Set to true when the target system is Windows. diff --git a/Help/variable/XCODE_VERSION.rst b/Help/variable/XCODE_VERSION.rst new file mode 100644 index 0000000..b6f0403 --- /dev/null +++ b/Help/variable/XCODE_VERSION.rst @@ -0,0 +1,7 @@ +XCODE_VERSION +------------- + +Version of Xcode (Xcode generator only). + +Under the Xcode generator, this is the version of Xcode as specified +in "Xcode.app/Contents/version.plist" (such as "3.1.2"). |