[cmake-commits] king committed CMakeCommands.html 1.30 1.31

cmake-commits at cmake.org cmake-commits at cmake.org
Sat Oct 28 06:00:12 EDT 2006


Update of /cvsroot/CMake/CMakeWeb/HTML
In directory public:/mounts/ram/cvs-serv29273

Modified Files:
	CMakeCommands.html 
Log Message:
STYLE: Documentation update.


Index: CMakeCommands.html
===================================================================
RCS file: /cvsroot/CMake/CMakeWeb/HTML/CMakeCommands.html,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -d -r1.30 -r1.31
--- CMakeCommands.html	14 Oct 2006 10:00:09 -0000	1.30
+++ CMakeCommands.html	28 Oct 2006 10:00:09 -0000	1.31
@@ -122,7 +122,7 @@
   </li>
   <li>
     <b><code>EXECUTE_PROCESS</code></b>: Execute one or more child processes.<br>
-    <pre>  EXECUTE_PROCESS(COMMAND &lt;cmd1&gt; [args1...]]<br>                  [COMMAND &lt;cmd2&gt; [args2...] [...]]<br>                  [WORKING_DIRECTORY &lt;directory&gt;]<br>                  [TIMEOUT &lt;seconds&gt;]<br>                  [RESULT_VARIABLE &lt;variable&gt;]<br>                  [OUTPUT_VARIABLE &lt;variable&gt;]<br>                  [ERROR_VARIABLE &lt;variable&gt;]<br>                  [INPUT_FILE &lt;file&gt;]<br>                  [OUTPUT_FILE &lt;file&gt;]<br>                  [ERROR_FILE &lt;file&gt;]<br>                  [OUTPUT_QUIET]<br>                  [ERROR_QUIET])<br></pre>
+    <pre>  EXECUTE_PROCESS(COMMAND &lt;cmd1&gt; [args1...]]<br>                  [COMMAND &lt;cmd2&gt; [args2...] [...]]<br>                  [WORKING_DIRECTORY &lt;directory&gt;]<br>                  [TIMEOUT &lt;seconds&gt;]<br>                  [RESULT_VARIABLE &lt;variable&gt;]<br>                  [OUTPUT_VARIABLE &lt;variable&gt;]<br>                  [ERROR_VARIABLE &lt;variable&gt;]<br>                  [INPUT_FILE &lt;file&gt;]<br>                  [OUTPUT_FILE &lt;file&gt;]<br>                  [ERROR_FILE &lt;file&gt;]<br>                  [OUTPUT_QUIET]<br>                  [ERROR_QUIET]<br>                  [OUTPUT_STRIP_TRAILING_WHITESPACE]<br>                  [ERROR_STRIP_TRAILING_WHITESPACE])<br></pre>
     <p>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.<br><p>The EXECUTE_PROCESS command is a newer more powerful version of EXEC_PROGRAM, but the old command has been kept for compatibility.
   </li>
   <li>
@@ -141,7 +141,7 @@
     <b><code>FIND_FILE</code></b>: Find the full path to a file.<br>
     <pre>   FIND_FILE(&lt;VAR&gt; name1 path1 path2 ...)<br></pre>
     <p>This is the short-hand signature for the command that is sufficient in many cases.  It is the same as FIND_FILE(&lt;VAR&gt; name1 PATHS path2 path2 ...)<br><pre>   FIND_FILE(<br>             &lt;VAR&gt; <br>             name | NAMES name1 [name2 ...]<br>             PATHS path1 [path2 ... ENV var]<br>             [PATH_SUFFIXES suffix1 [suffix2 ...]]<br>             [DOC "cache documentation string"]<br>             [NO_DEFAULT_PATH]<br>             [NO_CMAKE_ENVIRONMENT_PATH]<br>             [NO_CMAKE_PATH]<br>             [NO_SYSTEM_ENVIRONMENT_PATH]<br>             [NO_CMAKE_SYSTEM_PATH]<br>            )<br></pre>
-    <p>This command is used to find a full path to named file. A cache entry named by &lt;VAR&gt; is created to store the result of this command.  If nothing is found, the result will be &lt;VAR&gt;-NOTFOUND.  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 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 can be used to give sub directories that will be appended to the search paths.<br><p>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:<br><p>1. Search cmake specific environment variables.  This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.<br><pre>   CMAKE_FRAMEWORK_PATH<br>   CMAKE_APPBUNDLE_PATH<br>   CMAKE_INCLUDE_PATH<br></pre>
+    <p>This command is used to find a full path to named file. A cache entry named by &lt;VAR&gt; 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 &lt;VAR&gt;-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 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 can be used to give sub directories that will be appended to the search paths.<br><p>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:<br><p>1. Search cmake specific environment variables.  This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.<br><pre>   CMAKE_FRAMEWORK_PATH<br>   CMAKE_APPBUNDLE_PATH<br>   CMAKE_INCLUDE_PATH<br></pre>
     <p>2. Search cmake variables with the same names as the cmake specific environment 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.<br><pre>   CMAKE_FRAMEWORK_PATH<br>   CMAKE_APPBUNDLE_PATH<br>   CMAKE_INCLUDE_PATH<br></pre>
     <p>3. Search the standard system environment variables. This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument.<br><pre>   PATH<br>   INCLUDE<br></pre>
     <p>4. Search cmake variables defined in the Platform files for the current system.  This can be skipped if NO_CMAKE_SYSTEM_PATH is passed.<br><pre>   CMAKE_SYSTEM_FRAMEWORK_PATH<br>   CMAKE_SYSTEM_APPBUNDLE_PATH<br>   CMAKE_SYSTEM_INCLUDE_PATH<br></pre>
@@ -154,7 +154,7 @@
     <b><code>FIND_LIBRARY</code></b>: Find a library.<br>
     <pre>   FIND_LIBRARY(&lt;VAR&gt; name1 path1 path2 ...)<br></pre>
     <p>This is the short-hand signature for the command that is sufficient in many cases.  It is the same as FIND_LIBRARY(&lt;VAR&gt; name1 PATHS path2 path2 ...)<br><pre>   FIND_LIBRARY(<br>             &lt;VAR&gt; <br>             name | NAMES name1 [name2 ...]<br>             PATHS path1 [path2 ... ENV var]<br>             [PATH_SUFFIXES suffix1 [suffix2 ...]]<br>             [DOC "cache documentation string"]<br>             [NO_DEFAULT_PATH]<br>             [NO_CMAKE_ENVIRONMENT_PATH]<br>             [NO_CMAKE_PATH]<br>             [NO_SYSTEM_ENVIRONMENT_PATH]<br>             [NO_CMAKE_SYSTEM_PATH]<br>            )<br></pre>
-    <p>This command is used to find a library. A cache entry named by &lt;VAR&gt; is created to store the result of this command.  If nothing is found, the result will be &lt;VAR&gt;-NOTFOUND.  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 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 can be used to give sub directories that will be appended to the search paths.<br><p>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:<br><p>1. Search cmake specific environment variables.  This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.<br><pre>   CMAKE_FRAMEWORK_PATH<br>   CMAKE_APPBUNDLE_PATH<br>   CMAKE_LIBRARY_PATH<br></pre>
+    <p>This command is used to find a library. A cache entry named by &lt;VAR&gt; 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 &lt;VAR&gt;-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 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 can be used to give sub directories that will be appended to the search paths.<br><p>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:<br><p>1. Search cmake specific environment variables.  This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.<br><pre>   CMAKE_FRAMEWORK_PATH<br>   CMAKE_APPBUNDLE_PATH<br>   CMAKE_LIBRARY_PATH<br></pre>
     <p>2. Search cmake variables with the same names as the cmake specific environment 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.<br><pre>   CMAKE_FRAMEWORK_PATH<br>   CMAKE_APPBUNDLE_PATH<br>   CMAKE_LIBRARY_PATH<br></pre>
     <p>3. Search the standard system environment variables. This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument.<br><pre>   PATH<br>   LIB<br></pre>
     <p>4. Search cmake variables defined in the Platform files for the current system.  This can be skipped if NO_CMAKE_SYSTEM_PATH is passed.<br><pre>   CMAKE_SYSTEM_FRAMEWORK_PATH<br>   CMAKE_SYSTEM_APPBUNDLE_PATH<br>   CMAKE_SYSTEM_LIBRARY_PATH<br></pre>
@@ -165,14 +165,14 @@
   </li>
   <li>
     <b><code>FIND_PACKAGE</code></b>: Load settings for an external project.<br>
-    <pre>  FIND_PACKAGE(&lt;name&gt; [major.minor] [QUIET]<br>               [REQUIRED [componets...]])<br></pre>
-    <p>Finds and loads settings from an external project.  &lt;name&gt;_FOUND will be set to indicate whether the package was found.  Settings that can be used when &lt;name&gt;_FOUND is true are package-specific.  The package is found through several steps.  Directories listed in CMAKE_MODULE_PATH are searched for files called "Find&lt;name&gt;.cmake".  If such a file is found, it is read and processed by CMake, and is responsible for finding the package.  If no such file is found, it is expected that the package is another project built by CMake that has a "&lt;name&gt;Config.cmake" file.  A cache entry called &lt;name&gt;_DIR is created and is expected to be set to the directory containing this file.  If the file is found, it is read and processed by CMake to load the settings of the package.  If &lt;name&gt;_DIR has not been set during a configure step, the command will generate an error describing the problem unless the QUIET argument is specified.  If &lt;name&gt;_DIR has been set to a directory not containing a "&lt;name&gt;Config.cmake" file, an error is always generated.  If REQUIRED is specified and the package is not found, a FATAL_ERROR is generated and the configure step stops executing.  A package-specific list of components may be listed after the REQUIRED option.
+    <pre>  FIND_PACKAGE(&lt;name&gt; [major.minor] [QUIET] [NO_MODULE]<br>               [[REQUIRED|COMPONENTS] [componets...]])<br></pre>
+    <p>Finds and loads settings from an external project.  &lt;name&gt;_FOUND will be set to indicate whether the package was found.  Settings that can be used when &lt;name&gt;_FOUND is true are package-specific.  The package is found through several steps.  Directories listed in CMAKE_MODULE_PATH are searched for files called "Find&lt;name&gt;.cmake".  If such a file is found, it is read and processed by CMake, and is responsible for finding the package.  This first step may be skipped by using the NO_MODULE option.  If no such file is found, it is expected that the package is another project built by CMake that has a "&lt;name&gt;Config.cmake" file.  A cache entry called &lt;name&gt;_DIR is created and is expected to be set to the directory containing this file.  If the file is found, it is read and processed by CMake to load the settings of the package.  If &lt;name&gt;_DIR has not been set during a configure step, the command will generate an error describing the problem unless the QUIET argument is specified.  If &lt;name&gt;_DIR has been set to a directory not containing a "&lt;name&gt;Config.cmake" file, an error is always generated.  If REQUIRED is specified and the package is not found, a FATAL_ERROR is generated and the configure step stops executing.  A package-specific list of components may be listed after the REQUIRED option, or after the COMPONENTS option if no REQUIRED option is given.
   </li>
   <li>
     <b><code>FIND_PATH</code></b>: Find the directory containing a file.<br>
     <pre>   FIND_PATH(&lt;VAR&gt; name1 path1 path2 ...)<br></pre>
     <p>This is the short-hand signature for the command that is sufficient in many cases.  It is the same as FIND_PATH(&lt;VAR&gt; name1 PATHS path2 path2 ...)<br><pre>   FIND_PATH(<br>             &lt;VAR&gt; <br>             name | NAMES name1 [name2 ...]<br>             PATHS path1 [path2 ... ENV var]<br>             [PATH_SUFFIXES suffix1 [suffix2 ...]]<br>             [DOC "cache documentation string"]<br>             [NO_DEFAULT_PATH]<br>             [NO_CMAKE_ENVIRONMENT_PATH]<br>             [NO_CMAKE_PATH]<br>             [NO_SYSTEM_ENVIRONMENT_PATH]<br>             [NO_CMAKE_SYSTEM_PATH]<br>            )<br></pre>
-    <p>This command is used to find a directory containing the named file. A cache entry named by &lt;VAR&gt; is created to store the result of this command.  If nothing is found, the result will be &lt;VAR&gt;-NOTFOUND.  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 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 can be used to give sub directories that will be appended to the search paths.<br><p>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:<br><p>1. Search cmake specific environment variables.  This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.<br><pre>   CMAKE_FRAMEWORK_PATH<br>   CMAKE_APPBUNDLE_PATH<br>   CMAKE_INCLUDE_PATH<br></pre>
+    <p>This command is used to find a directory containing the named file. A cache entry named by &lt;VAR&gt; 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 &lt;VAR&gt;-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 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 can be used to give sub directories that will be appended to the search paths.<br><p>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:<br><p>1. Search cmake specific environment variables.  This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.<br><pre>   CMAKE_FRAMEWORK_PATH<br>   CMAKE_APPBUNDLE_PATH<br>   CMAKE_INCLUDE_PATH<br></pre>
     <p>2. Search cmake variables with the same names as the cmake specific environment 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.<br><pre>   CMAKE_FRAMEWORK_PATH<br>   CMAKE_APPBUNDLE_PATH<br>   CMAKE_INCLUDE_PATH<br></pre>
     <p>3. Search the standard system environment variables. This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument.<br><pre>   PATH<br>   INCLUDE<br></pre>
     <p>4. Search cmake variables defined in the Platform files for the current system.  This can be skipped if NO_CMAKE_SYSTEM_PATH is passed.<br><pre>   CMAKE_SYSTEM_FRAMEWORK_PATH<br>   CMAKE_SYSTEM_APPBUNDLE_PATH<br>   CMAKE_SYSTEM_INCLUDE_PATH<br></pre>
@@ -185,7 +185,7 @@
     <b><code>FIND_PROGRAM</code></b>: Find an executable program.<br>
     <pre>   FIND_PROGRAM(&lt;VAR&gt; name1 path1 path2 ...)<br></pre>
     <p>This is the short-hand signature for the command that is sufficient in many cases.  It is the same as FIND_PROGRAM(&lt;VAR&gt; name1 PATHS path2 path2 ...)<br><pre>   FIND_PROGRAM(<br>             &lt;VAR&gt; <br>             name | NAMES name1 [name2 ...]<br>             PATHS path1 [path2 ... ENV var]<br>             [PATH_SUFFIXES suffix1 [suffix2 ...]]<br>             [DOC "cache documentation string"]<br>             [NO_DEFAULT_PATH]<br>             [NO_CMAKE_ENVIRONMENT_PATH]<br>             [NO_CMAKE_PATH]<br>             [NO_SYSTEM_ENVIRONMENT_PATH]<br>             [NO_CMAKE_SYSTEM_PATH]<br>            )<br></pre>
-    <p>This command is used to find a program. A cache entry named by &lt;VAR&gt; is created to store the result of this command.  If nothing is found, the result will be &lt;VAR&gt;-NOTFOUND.  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 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 can be used to give sub directories that will be appended to the search paths.<br><p>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:<br><p>1. Search cmake specific environment variables.  This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.<br><pre>   CMAKE_FRAMEWORK_PATH<br>   CMAKE_APPBUNDLE_PATH<br>   CMAKE_PROGRAM_PATH<br></pre>
+    <p>This command is used to find a program. A cache entry named by &lt;VAR&gt; 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 &lt;VAR&gt;-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 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 can be used to give sub directories that will be appended to the search paths.<br><p>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:<br><p>1. Search cmake specific environment variables.  This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.<br><pre>   CMAKE_FRAMEWORK_PATH<br>   CMAKE_APPBUNDLE_PATH<br>   CMAKE_PROGRAM_PATH<br></pre>
     <p>2. Search cmake variables with the same names as the cmake specific environment 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.<br><pre>   CMAKE_FRAMEWORK_PATH<br>   CMAKE_APPBUNDLE_PATH<br>   CMAKE_PROGRAM_PATH<br></pre>
     <p>3. Search the standard system environment variables. This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument.<br><pre>   PATH<br>   <br></pre>
     <p>4. Search cmake variables defined in the Platform files for the current system.  This can be skipped if NO_CMAKE_SYSTEM_PATH is passed.<br><pre>   CMAKE_SYSTEM_FRAMEWORK_PATH<br>   CMAKE_SYSTEM_APPBUNDLE_PATH<br>   CMAKE_SYSTEM_PROGRAM_PATH<br></pre>
@@ -244,7 +244,7 @@
     <p>True if both variables would be considered true individually.<br><pre>  IF(variable1 OR variable2)<br></pre>
     <p>True if either variable would be considered true individually.<br><pre>  IF(COMMAND command-name)<br></pre>
     <p>True if the given name is a command that can be invoked.<br><pre>  IF(EXISTS file-name)<br>  IF(EXISTS directory-name)<br></pre>
-    <p>True if the named file or directory exists.  Behavior is well-defined only for full paths.<br><pre>  IF(FILE_IS_NEWER file1 file2)<br></pre>
+    <p>True if the named file or directory exists.  Behavior is well-defined only for full paths.<br><pre>  IF(file1 IS_NEWER_THAN file2)<br></pre>
     <p>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.<br><pre>  IF(IS_DIRECTORY directory-name)<br></pre>
     <p>True if the given name is a directory.  Behavior is well-defined only for full paths.<br><pre>  IF(variable MATCHES regex)<br>  IF(string MATCHES regex)<br></pre>
     <p>True if the given string or variable's value matches the given regular expression.<br><pre>  IF(variable LESS number)<br>  IF(string LESS number)<br>  IF(variable GREATER number)<br>  IF(string GREATER number)<br>  IF(variable EQUAL number)<br>  IF(string EQUAL number)<br></pre>
@@ -416,7 +416,7 @@
   <li>
     <b><code>SET_TARGET_PROPERTIES</code></b>: Targets can have properties that affect how they are built.<br>
     <pre>  SET_TARGET_PROPERTIES(target1 target2 ...<br>                        PROPERTIES prop1 value1<br>                        prop2 value2 ...)<br></pre>
-    <p>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.<br><p>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 &lt;CONFIG&gt;_OUTPUT_NAME that can set the output name on a per-configuration basis.  &lt;CONFIG&gt;_POSTFIX sets a postfix for the real name of the target when it is built under the configuration named by &lt;CONFIG&gt; (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_&lt;CONFIG&gt;_POSTFIX (except for executable targets because earlier CMake versions which did not use this variable for executables).<br><p>The LINK_FLAGS property can be used to add extra flags to the link step of a target. LINK_FLAGS_&lt;CONFIG&gt; will add to the configuration &lt;CONFIG&gt;, 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 our 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.<br><p>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.<br><p>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.<br><p>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.<br><p>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.<br><p>When a library is built CMake by default generates code to remove any existing library using all possible names.  This is needed to support libraries that switch between STATIC and SHARED by a user option.  However when using OUTPUT_NAME to build a static and shared library of the same name using different logical target names the two targets will remove each other's files.  This can be prevented by setting the CLEAN_DIRECT_OUTPUT property to 1.<br><p>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.
+    <p>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.<br><p>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 &lt;CONFIG&gt;_OUTPUT_NAME that can set the output name on a per-configuration basis.  &lt;CONFIG&gt;_POSTFIX sets a postfix for the real name of the target when it is built under the configuration named by &lt;CONFIG&gt; (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_&lt;CONFIG&gt;_POSTFIX (except for executable targets because earlier CMake versions which did not use this variable for executables).<br><p>The LINK_FLAGS property can be used to add extra flags to the link step of a target. LINK_FLAGS_&lt;CONFIG&gt; will add to the configuration &lt;CONFIG&gt;, 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 our 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.<br><p>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.<br><p>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. <br><p>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.<br><p>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.<br><p>When a library is built CMake by default generates code to remove any existing library using all possible names.  This is needed to support libraries that switch between STATIC and SHARED by a user option.  However when using OUTPUT_NAME to build a static and shared library of the same name using different logical target names the two targets will remove each other's files.  This can be prevented by setting the CLEAN_DIRECT_OUTPUT property to 1.<br><p>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.
   </li>
   <li>
     <b><code>SET_TESTS_PROPERTIES</code></b>: Set a property of the tests.<br>



More information about the Cmake-commits mailing list