[Cmake-commits] [cmake-commits] hoffman committed cmake-2-6.html 1.1 1.2 cpack-2-6.html 1.1 1.2 ctest-2-6.html 1.1 1.2
cmake-commits at cmake.org
cmake-commits at cmake.org
Tue May 6 10:50:37 EDT 2008
Update of /cvsroot/CMake/CMakeWeb/HTML
In directory public:/mounts/ram/cvs-serv4095
Modified Files:
cmake-2-6.html cpack-2-6.html ctest-2-6.html
Log Message:
ENH: update docs to 2.6.0
Index: cmake-2-6.html
===================================================================
RCS file: /cvsroot/CMake/CMakeWeb/HTML/cmake-2-6.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -C 2 -d -r1.1 -r1.2
*** cmake-2-6.html 1 Apr 2008 21:09:29 -0000 1.1
--- cmake-2-6.html 6 May 2008 14:50:34 -0000 1.2
***************
*** 43,186 ****
<h2><a name="section_Options"/>Options</h2>
<ul>
! <li><a href="#command_-C <initial-cache>"><b><code>-C <initial-cache></code></b></a></li> <li><a href="#command_-D <var>:<type>=<value>"><b><code>-D <var>:<type>=<value></code></b></a></li> <li><a href="#command_-U <globbing_expr>"><b><code>-U <globbing_expr></code></b></a></li> <li><a href="#command_-G <generator-name>"><b><code>-G <generator-name></code></b></a></li> <li><a href="#command_-Wno-dev"><b><code>-Wno-dev</code></b></a></li> <li><a href="#command_-Wdev"><b><code>-Wdev</code></b></a></li> <li><a href="#command_-E"><b><code>-E</code></b></a></li> <li><a href="#command_-i"><b><code>-i</code></b></a></li> <li><a href="#command_-L[A][H]"><b><code>-L[A][H]</code></b></a></li> <li><a href="#command_-N"><b><code>-N</code></b></a></li> <li><a href="#command_-P <file>"><b><code>-P <file></code></b></a></li> <li><a href="#command_--graphviz=[file]"><b><code>--graphviz=[file]</code></b></a></li> <li><a href="#command_--system-information [file]"><b><code>--system-information [file]</code></b></a></li> <li><a href="#command_--debug-trycompile"><b><code>--debug-trycompile</code></b></a></li> <li><a href="#command_--debug-output"><b><code>--debug-output</code></b></a></li> <li><a href="#command_--help-command cmd [file]"><b><code>--help-command cmd [file]</code></b></a></li> <li><a href="#command_--help-command-list [file]"><b><code>--help-command-list [file]</code></b></a></li> <li><a href="#command_--help-commands [file]"><b><code>--help-commands [file]</code></b></a></li> <li><a href="#command_--help-compatcommands [file]"><b><code>--help-compatcommands [file]</code></b></a></li> <li><a href="#command_--help-module module [file]"><b><code>--help-module module [file]</code></b></a></li> <li><a href="#command_--help-module-list [file]"><b><code>--help-module-list [file]</code></b></a></li> <li><a href="#command_--help-modules [file]"><b><code>--help-modules [file]</code></b></a></li> <li><a href="#command_--help-custom-modules [file]"><b><code>--help-custom-modules [file]</code></b></a></li> <li><a href="#command_--help-property prop [file]"><b><code>--help-property prop [file]</code></b></a></li> <li><a href="#command_--help-property-list [file]"><b><code>--help-property-list [file]</code></b></a></li> <li><a href="#command_--help-properties [file]"><b><code>--help-properties [file]</code></b></a></li> <li><a href="#command_--help-variable var [file]"><b><code>--help-variable var [file]</code></b></a></li> <li><a href="#command_--help-variable-list [file]"><b><code>--help-variable-list [file]</code></b></a></li> <li><a href="#command_--help-variables [file]"><b><code>--help-variables [file]</code></b></a></li> <li><a href="#command_--copyright [file]"><b><code>--copyright [file]</code></b></a></li> <li><a href="#command_--help"><b><code>--help</code></b></a></li> <li><a href="#command_--help-full [file]"><b><code>--help-full [file]</code></b></a></li> <li><a href="#command_--help-html [file]"><b><code>--help-html [file]</code></b></a></li> <li><a href="#command_--help-man [file]"><b><code>--help-man [file]</code></b></a></li> <li><a href="#command_--version [file]"><b><code>--version [file]</code></b></a></li></ul>
<ul>
<li>
! <a name="command_-C <initial-cache>"><b><code>-C <initial-cache></code></b></a>: Pre-load a script to populate the cache.<br>
<p>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.
</li>
<li>
! <a name="command_-D <var>:<type>=<value>"><b><code>-D <var>:<type>=<value></code></b></a>: Create a cmake cache entry.<br>
[...5068 lines suppressed...]
<ul>
! <li><a href="#see:HomePage"><b><code>Home Page</code></b></a></li> <li><a href="#see:FrequentlyAskedQuestions"><b><code>Frequently Asked Questions</code></b></a></li> <li><a href="#see:OnlineDocumentation"><b><code>Online Documentation</code></b></a></li> <li><a href="#see:MailingList"><b><code>Mailing List</code></b></a></li></ul>
<p>The following resources are available to get help using CMake:
<ul>
<li>
! <a name="see:HomePage"><b><code>Home Page</code></b></a>: <a href="http://www.cmake.org">http://www.cmake.org</a><br>
<p>The primary starting point for learning about CMake.
</li>
<li>
! <a name="see:FrequentlyAskedQuestions"><b><code>Frequently Asked Questions</code></b></a>: <a href="http://www.cmake.org/Wiki/CMake_FAQ">http://www.cmake.org/Wiki/CMake_FAQ</a><br>
<p>A Wiki is provided containing answers to frequently asked questions.
</li>
<li>
! <a name="see:OnlineDocumentation"><b><code>Online Documentation</code></b></a>: <a href="http://www.cmake.org/HTML/Documentation.html">http://www.cmake.org/HTML/Documentation.html</a><br>
<p>Links to available documentation may be found on this web page.
</li>
<li>
! <a name="see:MailingList"><b><code>Mailing List</code></b></a>: <a href="http://www.cmake.org/HTML/MailingLists.html">http://www.cmake.org/HTML/MailingLists.html</a><br>
<p>For help and discussion about using cmake, a mailing list is provided at cmake at 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 <a href="http://www.cmake.org">http://www.cmake.org</a> before posting questions to the list.
</li>
Index: ctest-2-6.html
===================================================================
RCS file: /cvsroot/CMake/CMakeWeb/HTML/ctest-2-6.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -C 2 -d -r1.1 -r1.2
*** ctest-2-6.html 1 Apr 2008 21:09:29 -0000 1.1
--- ctest-2-6.html 6 May 2008 14:50:35 -0000 1.2
***************
*** 30,181 ****
<h2><a name="section_Options"/>Options</h2>
<ul>
! <li><a href="#command_-C <cfg>, --build-config <cfg>"><b><code>-C <cfg>, --build-config <cfg></code></b></a></li> <li><a href="#command_-V,--verbose"><b><code>-V,--verbose</code></b></a></li> <li><a href="#command_-VV,--extra-verbose"><b><code>-VV,--extra-verbose</code></b></a></li> <li><a href="#command_--debug"><b><code>--debug</code></b></a></li> <li><a href="#command_-Q,--quiet"><b><code>-Q,--quiet</code></b></a></li> <li><a href="#command_-O <file>, --output-log <file>"><b><code>-O <file>, --output-log <file></code></b></a></li> <li><a href="#command_-N,--show-only"><b><code>-N,--show-only</code></b></a></li> <li><a href="#command_-R <regex>, --tests-regex <regex>"><b><code>-R <regex>, --tests-regex <regex></code></b></a></li> <li><a href="#command_-E <regex>, --exclude-regex <regex>"><b><code>-E <regex>, --exclude-regex <regex></code></b></a></li> <li><a href="#command_-D <dashboard>, --dashboard <dashboard>"><b><code>-D <dashboard>, --dashboard <dashboard></code></b></a></li> <li><a href="#command_-M <model>, --test-model <model>"><b><code>-M <model>, --test-model <model></code></b></a></li> <li><a href="#command_-T <action>, --test-action <action>"><b><code>-T <action>, --test-action <action></code></b></a></li> <li><a href="#command_--track <track>"><b><code>--track <track></code></b></a></li> <li><a href="#command_-S <script>, --script <script>"><b><code>-S <script>, --script <script></code></b></a></li> <li><a href="#command_-SP <script>, --script-new-process <script>"><b><code>-SP <script>, --script-new-process <script></code></b></a></li> <li><a href="#command_-A <file>, --add-notes <file>"><b><code>-A <file>, --add-notes <file></code></b></a></li> <li><a href="#command_-I [Start,End,Stride,test#,test#|Test file], --tests-information"><b><code>-I [Start,End,Stride,test#,test#|Test file], --tests-information</code></b></a></li> <li><a href="#command_-U, --union"><b><code>-U, --union</code></b></a></li> <li><a href="#command_--interactive-debug-mode [0|1]"><b><code>--interactive-debug-mode [0|1]</code></b></a></li> <li><a href="#command_--build-and-test"><b><code>--build-and-test</code></b></a></li> <li><a href="#command_--build-target"><b><code>--build-target</code></b></a></li> <li><a href="#command_--build-nocmake"><b><code>--build-nocmake</code></b></a></li> <li><a href="#command_--build-run-dir"><b><code>--build-run-dir</code></b></a></li> <li><a href="#command_--build-two-config"><b><code>--build-two-config</code></b></a></li> <li><a href="#command_--build-exe-dir"><b><code>--build-exe-dir</code></b></a></li> <li><a href="#command_--build-generator"><b><code>--build-generator</code></b></a></li> <li><a href="#command_--build-project"><b><code>--build-project</code></b></a></li> <li><a href="#command_--build-makeprogram"><b><code>--build-makeprogram</code></b></a></li> <li><a href="#command_--build-noclean"><b><code>--build-noclean</code></b></a></li> <li><a href="#command_--build-config-sample"><b><code>--build-config-sample</code></b></a></li> <li><a href="#command_--build-options"><b><code>--build-options</code></b></a></li> <li><a href="#command_--test-command"><b><code>--test-command</code></b></a></li> <li><a href="#command_--test-timeout"><b><code>--test-timeout</code></b></a></li> <li><a href="#command_--tomorrow-tag"><b><code>--tomorrow-tag</code></b></a></li> <li><a href="#command_--ctest-config"><b><code>--ctest-config</code></b></a></li> <li><a href="#command_--overwrite"><b><code>--overwrite</code></b></a></li> <li><a href="#command_--extra-submit <file>[;<file>]"><b><code>--extra-submit <file>[;<file>]</code></b></a></li> <li><a href="#command_--force-new-ctest-process"><b><code>--force-new-ctest-process</code></b></a></li> <li><a href="#command_--submit-index"><b><code>--submit-index</code></b></a></li></ul>
<ul>
<li>
! <a name="command_-C <cfg>, --build-config <cfg>"><b><code>-C <cfg>, --build-config <cfg></code></b></a>: Choose configuration to test.<br>
<p>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".
</li>
<li>
! <a name="command_-V,--verbose"><b><code>-V,--verbose</code></b></a>: Enable verbose output from tests.<br>
<p>Test output is normally suppressed and only summary information is displayed. This option will show all test output.
</li>
<li>
! <a name="command_-VV,--extra-verbose"><b><code>-VV,--extra-verbose</code></b></a>: Enable more verbose output from tests.<br>
<p>Test output is normally suppressed and only summary information is displayed. This option will show even more test output.
</li>
<li>
! <a name="command_--debug"><b><code>--debug</code></b></a>: Displaying more verbose internals of CTest.<br>
<p>This feature will result in large number of output that is mostly useful for debugging dashboard problems.
</li>
<li>
! <a name="command_-Q,--quiet"><b><code>-Q,--quiet</code></b></a>: Make ctest quiet.<br>
<p>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.
</li>
<li>
! <a name="command_-O <file>, --output-log <file>"><b><code>-O <file>, --output-log <file></code></b></a>: Output to log file<br>
<p>This option tells ctest to write all its output to a log file.
</li>
<li>
! <a name="command_-N,--show-only"><b><code>-N,--show-only</code></b></a>: Disable actual execution of tests.<br>
<p>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.
</li>
<li>
! <a name="command_-R <regex>, --tests-regex <regex>"><b><code>-R <regex>, --tests-regex <regex></code></b></a>: Run tests matching regular expression.<br>
<p>This option tells ctest to run only the tests whose names match the given regular expression.
</li>
<li>
! <a name="command_-E <regex>, --exclude-regex <regex>"><b><code>-E <regex>, --exclude-regex <regex></code></b></a>: Exclude tests matching regular expression.<br>
<p>This option tells ctest to NOT run the tests whose names match the given regular expression.
</li>
<li>
! <a name="command_-D <dashboard>, --dashboard <dashboard>"><b><code>-D <dashboard>, --dashboard <dashboard></code></b></a>: Execute dashboard test<br>
<p>This option tells ctest to perform 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.
</li>
<li>
! <a name="command_-M <model>, --test-model <model>"><b><code>-M <model>, --test-model <model></code></b></a>: Sets the model for a dashboard<br>
<p>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
</li>
<li>
! <a name="command_-T <action>, --test-action <action>"><b><code>-T <action>, --test-action <action></code></b></a>: Sets the dashboard action to perform<br>
<p>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
</li>
<li>
! <a name="command_--track <track>"><b><code>--track <track></code></b></a>: Specify the track to submit dashboard to<br>
<p>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.
</li>
<li>
! <a name="command_-S <script>, --script <script>"><b><code>-S <script>, --script <script></code></b></a>: Execute a dashboard for a configuration<br>
<p>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.
</li>
<li>
! <a name="command_-SP <script>, --script-new-process <script>"><b><code>-SP <script>, --script-new-process <script></code></b></a>: Execute a dashboard for a configuration<br>
<p>This option does the same operations as -S but it will do them in a seperate process. This is primarily useful in cases where the script may modify the environment and you do not want the modified enviroment to impact other -S scripts.
</li>
<li>
! <a name="command_-A <file>, --add-notes <file>"><b><code>-A <file>, --add-notes <file></code></b></a>: Add a notes file with submission<br>
<p>This option tells ctest to include a notes file when submitting dashboard.
</li>
<li>
! <a name="command_-I [Start,End,Stride,test#,test#|Test file], --tests-information"><b><code>-I [Start,End,Stride,test#,test#|Test file], --tests-information</code></b></a>: Run a specific number of tests by number.<br>
<p>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.
</li>
<li>
! <a name="command_-U, --union"><b><code>-U, --union</code></b></a>: Take the Union of -I and -R<br>
<p>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.
</li>
<li>
! <a name="command_--interactive-debug-mode [0|1]"><b><code>--interactive-debug-mode [0|1]</code></b></a>: Set the interactive mode to 0 or 1.<br>
<p>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.
</li>
<li>
! <a name="command_--build-and-test"><b><code>--build-and-test</code></b></a>: Configure, build and run a test.<br>
<p>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 --built-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
</li>
<li>
! <a name="command_--build-target"><b><code>--build-target</code></b></a>: Specify a specific target to build.<br>
<p>This option goes with the --build-and-test option, if left out the all target is built.
</li>
<li>
! <a name="command_--build-nocmake"><b><code>--build-nocmake</code></b></a>: Run the build without running cmake first.<br>
<p>Skip the cmake step.
</li>
<li>
! <a name="command_--build-run-dir"><b><code>--build-run-dir</code></b></a>: Specify directory to run programs from.<br>
<p>Directory where programs will be after it has been compiled.
</li>
<li>
! <a name="command_--build-two-config"><b><code>--build-two-config</code></b></a>: Run CMake twice
</li>
<li>
! <a name="command_--build-exe-dir"><b><code>--build-exe-dir</code></b></a>: Specify the directory for the executable.
</li>
<li>
! <a name="command_--build-generator"><b><code>--build-generator</code></b></a>: Specify the generator to use.
</li>
<li>
! <a name="command_--build-project"><b><code>--build-project</code></b></a>: Specify the name of the project to build.
</li>
<li>
! <a name="command_--build-makeprogram"><b><code>--build-makeprogram</code></b></a>: Specify the make program to use.
</li>
<li>
! <a name="command_--build-noclean"><b><code>--build-noclean</code></b></a>: Skip the make clean step.
</li>
<li>
! <a name="command_--build-config-sample"><b><code>--build-config-sample</code></b></a>: A sample executable to use to determine the configuraiton<br>
<p>A sample executable to use to determine the configuraiton that should be used. e.g. Debug/Release/etc
</li>
<li>
! <a name="command_--build-options"><b><code>--build-options</code></b></a>: Add extra options to the build step.<br>
<p>This option must be the last option with the exception of --test-command
</li>
<li>
! <a name="command_--test-command"><b><code>--test-command</code></b></a>: The test to run with the --build-and-test option.
</li>
<li>
! <a name="command_--test-timeout"><b><code>--test-timeout</code></b></a>: The time limit in seconds, internal use only.
</li>
<li>
! <a name="command_--tomorrow-tag"><b><code>--tomorrow-tag</code></b></a>: Nightly or experimental starts with next day tag.<br>
<p>This is useful if the build will not finish in one day.
</li>
<li>
! <a name="command_--ctest-config"><b><code>--ctest-config</code></b></a>: The configuration file used to initialize CTest state when submitting dashboards.<br>
<p>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.
</li>
<li>
! <a name="command_--overwrite"><b><code>--overwrite</code></b></a>: Overwrite CTest configuration option.<br>
<p>By default ctest uses configuration options from configuration file. This option will overwrite the configuration option.
</li>
<li>
! <a name="command_--extra-submit <file>[;<file>]"><b><code>--extra-submit <file>[;<file>]</code></b></a>: Submit extra files to the dashboard.<br>
<p>This option will submit extra files to the dashboard.
</li>
<li>
! <a name="command_--force-new-ctest-process"><b><code>--force-new-ctest-process</code></b></a>: Run child CTest instances as new processes<br>
<p>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.
</li>
<li>
! <a name="command_--submit-index"><b><code>--submit-index</code></b></a>: Submit individual dashboard tests with specific index<br>
<p>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.
</li>
--- 30,181 ----
<h2><a name="section_Options"/>Options</h2>
<ul>
! <li><a href="#opt:-Ccfg--build-configcfg"><b><code>-C <cfg>, --build-config <cfg></code></b></a></li> <li><a href="#opt:-V--verbose"><b><code>-V,--verbose</code></b></a></li> <li><a href="#opt:-VV--extra-verbose"><b><code>-VV,--extra-verbose</code></b></a></li> <li><a href="#opt:--debug"><b><code>--debug</code></b></a></li> <li><a href="#opt:-Q--quiet"><b><code>-Q,--quiet</code></b></a></li> <li><a href="#opt:-Ofile--output-logfile"><b><code>-O <file>, --output-log <file></code></b></a></li> <li><a href="#opt:-N--show-only"><b><code>-N,--show-only</code></b></a></li> <li><a href="#opt:-Rregex--tests-regexregex"><b><code>-R <regex>, --tests-regex <regex></code></b></a></li> <li><a href="#opt:-Eregex--exclude-regexregex"><b><code>-E <regex>, --exclude-regex <regex></code></b></a></li> <li><a href="#opt:-Ddashboard--dashboarddashboard"><b><code>-D <dashboard>, --dashboard <dashboard></code></b></a></li> <li><a href="#opt:-Mmodel--test-modelmodel"><b><code>-M <model>, --test-model <model></code></b></a></li> <li><a href="#opt:-Taction--test-actionaction"><b><code>-T <action>, --test-action <action></code></b></a></li> <li><a href="#opt:--tracktrack"><b><code>--track <track></code></b></a></li> <li><a href="#opt:-Sscript--scriptscript"><b><code>-S <script>, --script <script></code></b></a></li> <li><a href="#opt:-SPscript--script-new-processscript"><b><code>-SP <script>, --script-new-process <script></code></b></a></li> <li><a href="#opt:-Afile--add-notesfile"><b><code>-A <file>, --add-notes <file></code></b></a></li> <li><a href="#opt:-IStartEndStridetesttestTestfile--tests-information"><b><code>-I [Start,End,Stride,test#,test#|Test file], --tests-information</code></b></a></li> <li><a href="#opt:-U--union"><b><code>-U, --union</code></b></a></li> <li><a href="#opt:--interactive-debug-mode01"><b><code>--interactive-debug-mode [0|1]</code></b></a></li> <li><a href="#opt:--build-and-test"><b><code>--build-and-test</code></b></a></li> <li><a href="#opt:--build-target"><b><code>--build-target</code></b></a></li> <li><a href="#opt:--build-nocmake"><b><code>--build-nocmake</code></b></a></li> <li><a href="#opt:--build-run-dir"><b><code>--build-run-dir</code></b></a></li> <li><a href="#opt:--build-two-config"><b><code>--build-two-config</code></b></a></li> <li><a href="#opt:--build-exe-dir"><b><code>--build-exe-dir</code></b></a></li> <li><a href="#opt:--build-generator"><b><code>--build-generator</code></b></a></li> <li><a href="#opt:--build-project"><b><code>--build-project</code></b></a></li> <li><a href="#opt:--build-makeprogram"><b><code>--build-makeprogram</code></b></a></li> <li><a href="#opt:--build-noclean"><b><code>--build-noclean</code></b></a></li> <li><a href="#opt:--build-config-sample"><b><code>--build-config-sample</code></b></a></li> <li><a href="#opt:--build-options"><b><code>--build-options</code></b></a></li> <li><a href="#opt:--test-command"><b><code>--test-command</code></b></a></li> <li><a href="#opt:--test-timeout"><b><code>--test-timeout</code></b></a></li> <li><a href="#opt:--tomorrow-tag"><b><code>--tomorrow-tag</code></b></a></li> <li><a href="#opt:--ctest-config"><b><code>--ctest-config</code></b></a></li> <li><a href="#opt:--overwrite"><b><code>--overwrite</code></b></a></li> <li><a href="#opt:--extra-submitfilefile"><b><code>--extra-submit <file>[;<file>]</code></b></a></li> <li><a href="#opt:--force-new-ctest-process"><b><code>--force-new-ctest-process</code></b></a></li> <li><a href="#opt:--submit-index"><b><code>--submit-index</code></b></a></li></ul>
<ul>
<li>
! <a name="opt:-Ccfg--build-configcfg"><b><code>-C <cfg>, --build-config <cfg></code></b></a>: Choose configuration to test.<br>
<p>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".
</li>
<li>
! <a name="opt:-V--verbose"><b><code>-V,--verbose</code></b></a>: Enable verbose output from tests.<br>
<p>Test output is normally suppressed and only summary information is displayed. This option will show all test output.
</li>
<li>
! <a name="opt:-VV--extra-verbose"><b><code>-VV,--extra-verbose</code></b></a>: Enable more verbose output from tests.<br>
<p>Test output is normally suppressed and only summary information is displayed. This option will show even more test output.
</li>
<li>
! <a name="opt:--debug"><b><code>--debug</code></b></a>: Displaying more verbose internals of CTest.<br>
<p>This feature will result in large number of output that is mostly useful for debugging dashboard problems.
</li>
<li>
! <a name="opt:-Q--quiet"><b><code>-Q,--quiet</code></b></a>: Make ctest quiet.<br>
<p>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.
</li>
<li>
! <a name="opt:-Ofile--output-logfile"><b><code>-O <file>, --output-log <file></code></b></a>: Output to log file<br>
<p>This option tells ctest to write all its output to a log file.
</li>
<li>
! <a name="opt:-N--show-only"><b><code>-N,--show-only</code></b></a>: Disable actual execution of tests.<br>
<p>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.
</li>
<li>
! <a name="opt:-Rregex--tests-regexregex"><b><code>-R <regex>, --tests-regex <regex></code></b></a>: Run tests matching regular expression.<br>
<p>This option tells ctest to run only the tests whose names match the given regular expression.
</li>
<li>
! <a name="opt:-Eregex--exclude-regexregex"><b><code>-E <regex>, --exclude-regex <regex></code></b></a>: Exclude tests matching regular expression.<br>
<p>This option tells ctest to NOT run the tests whose names match the given regular expression.
</li>
<li>
! <a name="opt:-Ddashboard--dashboarddashboard"><b><code>-D <dashboard>, --dashboard <dashboard></code></b></a>: Execute dashboard test<br>
<p>This option tells ctest to perform 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.
</li>
<li>
! <a name="opt:-Mmodel--test-modelmodel"><b><code>-M <model>, --test-model <model></code></b></a>: Sets the model for a dashboard<br>
<p>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
</li>
<li>
! <a name="opt:-Taction--test-actionaction"><b><code>-T <action>, --test-action <action></code></b></a>: Sets the dashboard action to perform<br>
<p>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
</li>
<li>
! <a name="opt:--tracktrack"><b><code>--track <track></code></b></a>: Specify the track to submit dashboard to<br>
<p>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.
</li>
<li>
! <a name="opt:-Sscript--scriptscript"><b><code>-S <script>, --script <script></code></b></a>: Execute a dashboard for a configuration<br>
<p>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.
</li>
<li>
! <a name="opt:-SPscript--script-new-processscript"><b><code>-SP <script>, --script-new-process <script></code></b></a>: Execute a dashboard for a configuration<br>
<p>This option does the same operations as -S but it will do them in a seperate process. This is primarily useful in cases where the script may modify the environment and you do not want the modified enviroment to impact other -S scripts.
</li>
<li>
! <a name="opt:-Afile--add-notesfile"><b><code>-A <file>, --add-notes <file></code></b></a>: Add a notes file with submission<br>
<p>This option tells ctest to include a notes file when submitting dashboard.
</li>
<li>
! <a name="opt:-IStartEndStridetesttestTestfile--tests-information"><b><code>-I [Start,End,Stride,test#,test#|Test file], --tests-information</code></b></a>: Run a specific number of tests by number.<br>
<p>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.
</li>
<li>
! <a name="opt:-U--union"><b><code>-U, --union</code></b></a>: Take the Union of -I and -R<br>
<p>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.
</li>
<li>
! <a name="opt:--interactive-debug-mode01"><b><code>--interactive-debug-mode [0|1]</code></b></a>: Set the interactive mode to 0 or 1.<br>
<p>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.
</li>
<li>
! <a name="opt:--build-and-test"><b><code>--build-and-test</code></b></a>: Configure, build and run a test.<br>
<p>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 --built-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
</li>
<li>
! <a name="opt:--build-target"><b><code>--build-target</code></b></a>: Specify a specific target to build.<br>
<p>This option goes with the --build-and-test option, if left out the all target is built.
</li>
<li>
! <a name="opt:--build-nocmake"><b><code>--build-nocmake</code></b></a>: Run the build without running cmake first.<br>
<p>Skip the cmake step.
</li>
<li>
! <a name="opt:--build-run-dir"><b><code>--build-run-dir</code></b></a>: Specify directory to run programs from.<br>
<p>Directory where programs will be after it has been compiled.
</li>
<li>
! <a name="opt:--build-two-config"><b><code>--build-two-config</code></b></a>: Run CMake twice
</li>
<li>
! <a name="opt:--build-exe-dir"><b><code>--build-exe-dir</code></b></a>: Specify the directory for the executable.
</li>
<li>
! <a name="opt:--build-generator"><b><code>--build-generator</code></b></a>: Specify the generator to use.
</li>
<li>
! <a name="opt:--build-project"><b><code>--build-project</code></b></a>: Specify the name of the project to build.
</li>
<li>
! <a name="opt:--build-makeprogram"><b><code>--build-makeprogram</code></b></a>: Specify the make program to use.
</li>
<li>
! <a name="opt:--build-noclean"><b><code>--build-noclean</code></b></a>: Skip the make clean step.
</li>
<li>
! <a name="opt:--build-config-sample"><b><code>--build-config-sample</code></b></a>: A sample executable to use to determine the configuraiton<br>
<p>A sample executable to use to determine the configuraiton that should be used. e.g. Debug/Release/etc
</li>
<li>
! <a name="opt:--build-options"><b><code>--build-options</code></b></a>: Add extra options to the build step.<br>
<p>This option must be the last option with the exception of --test-command
</li>
<li>
! <a name="opt:--test-command"><b><code>--test-command</code></b></a>: The test to run with the --build-and-test option.
</li>
<li>
! <a name="opt:--test-timeout"><b><code>--test-timeout</code></b></a>: The time limit in seconds, internal use only.
</li>
<li>
! <a name="opt:--tomorrow-tag"><b><code>--tomorrow-tag</code></b></a>: Nightly or experimental starts with next day tag.<br>
<p>This is useful if the build will not finish in one day.
</li>
<li>
! <a name="opt:--ctest-config"><b><code>--ctest-config</code></b></a>: The configuration file used to initialize CTest state when submitting dashboards.<br>
<p>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.
</li>
<li>
! <a name="opt:--overwrite"><b><code>--overwrite</code></b></a>: Overwrite CTest configuration option.<br>
<p>By default ctest uses configuration options from configuration file. This option will overwrite the configuration option.
</li>
<li>
! <a name="opt:--extra-submitfilefile"><b><code>--extra-submit <file>[;<file>]</code></b></a>: Submit extra files to the dashboard.<br>
<p>This option will submit extra files to the dashboard.
</li>
<li>
! <a name="opt:--force-new-ctest-process"><b><code>--force-new-ctest-process</code></b></a>: Run child CTest instances as new processes<br>
<p>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.
</li>
<li>
! <a name="opt:--submit-index"><b><code>--submit-index</code></b></a>: Submit individual dashboard tests with specific index<br>
<p>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.
</li>
***************
*** 187,204 ****
<h2><a name="section_Commands"/>Commands</h2>
<ul>
! <li><a href="#command_break"><b><code>break</code></b></a></li> <li><a href="#command_build_name"><b><code>build_name</code></b></a></li> <li><a href="#command_cmake_minimum_required"><b><code>cmake_minimum_required</code></b></a></li> <li><a href="#command_cmake_policy"><b><code>cmake_policy</code></b></a></li> <li><a href="#command_configure_file"><b><code>configure_file</code></b></a></li> <li><a href="#command_CTEST_BUILD"><b><code>CTEST_BUILD</code></b></a></li> <li><a href="#command_CTEST_CONFIGURE"><b><code>CTEST_CONFIGURE</code></b></a></li> <li><a href="#command_CTEST_COVERAGE"><b><code>CTEST_COVERAGE</code></b></a></li> <li><a href="#command_CTEST_EMPTY_BINARY_DIRECTORY"><b><code>CTEST_EMPTY_BINARY_DIRECTORY</code></b></a></li> <li><a href="#command_CTEST_MEMCHECK"><b><code>CTEST_MEMCHECK</code></b></a></li> <li><a href="#command_CTEST_READ_CUSTOM_FILES"><b><code>CTEST_READ_CUSTOM_FILES</code></b></a></li> <li><a href="#command_CTEST_RUN_SCRIPT"><b><code>CTEST_RUN_SCRIPT</code></b></a></li> <li><a href="#command_CTEST_SLEEP"><b><code>CTEST_SLEEP</code></b></a></li> <li><a href="#command_CTEST_START"><b><code>CTEST_START</code></b></a></li> <li><a href="#command_CTEST_SUBMIT"><b><code>CTEST_SUBMIT</code></b></a></li> <li><a href="#command_CTEST_TEST"><b><code>CTEST_TEST</code></b></a></li> <li><a href="#command_CTEST_UPDATE"><b><code>CTEST_UPDATE</code></b></a></li> <li><a href="#command_else"><b><code>else</code></b></a></li> <li><a href="#command_elseif"><b><code>elseif</code></b></a></li> <li><a href="#command_endforeach"><b><code>endforeach</code></b></a></li> <li><a href="#command_endfunction"><b><code>endfunction</code></b></a></li> <li><a href="#command_endif"><b><code>endif</code></b></a></li> <li><a href="#command_endmacro"><b><code>endmacro</code></b></a></li> <li><a href="#command_endwhile"><b><code>endwhile</code></b></a></li> <li><a href="#command_exec_program"><b><code>exec_program</code></b></a></li> <li><a href="#command_execute_process"><b><code>execute_process</code></b></a></li> <li><a href="#command_file"><b><code>file</code></b></a></li> <li><a href="#command_find_file"><b><code>find_file</code></b></a></li> <li><a href="#command_find_library"><b><code>find_library</code></b></a></li> <li><a href="#command_find_package"><b><code>find_package</code></b></a></li> <li><a href="#command_find_path"><b><code>find_path</code></b></a></li> <li><a href="#command_find_program"><b><code>find_program</code></b></a></li> <li><a href="#command_foreach"><b><code>foreach</code></b></a></li> <li><a href="#command_function"><b><code>function</code></b></a></li> <li><a href="#command_get_cmake_property"><b><code>get_cmake_property</code></b></a></li> <li><a href="#command_get_directory_property"><b><code>get_directory_property</code></b></a></li> <li><a href="#command_get_filename_component"><b><code>get_filename_component</code></b></a></li> <li><a href="#command_get_property"><b><code>get_property</code></b></a></li> <li><a href="#command_if"><b><code>if</code></b></a></li> <li><a href="#command_include"><b><code>include</code></b></a></li> <li><a href="#command_list"><b><code>list</code></b></a></li> <li><a href="#command_macro"><b><code>macro</code></b></a></li> <li><a href="#command_make_directory"><b><code>make_directory</code></b></a></li> <li><a href="#command_mark_as_advanced"><b><code>mark_as_advanced</code></b></a></li> <li><a href="#command_math"><b><code>math</code></b></a></li> <li><a href="#command_message"><b><code>message</code></b></a></li> <li><a href="#command_option"><b><code>option</code></b></a></li> <li><a href="#command_remove"><b><code>remove</code></b></a></li> <li><a href="#command_return"><b><code>return</code></b></a></li> <li><a href="#command_separate_arguments"><b><code>separate_arguments</code></b></a></li> <li><a href="#command_set"><b><code>set</code></b></a></li> <li><a href="#command_set_directory_properties"><b><code>set_directory_properties</code></b></a></li> <li><a href="#command_set_property"><b><code>set_property</code></b></a></li> <li><a href="#command_site_name"><b><code>site_name</code></b></a></li> <li><a href="#command_string"><b><code>string</code></b></a></li> <li><a href="#command_variable_watch"><b><code>variable_watch</code></b></a></li> <li><a href="#command_while"><b><code>while</code></b></a></li> <li><a href="#command_write_file"><b><code>write_file</code></b></a></li></ul>
<ul>
<li>
! <a name="command_break"><b><code>break</code></b></a>: Break from an enclosing foreach or while loop.<br>
<pre> break()<br></pre>
<p>Breaks from an enclosing foreach loop or while loop
</li>
<li>
! <a name="command_build_name"><b><code>build_name</code></b></a>: Deprecated. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead.<br>
<pre> build_name(variable)<br></pre>
<p>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.
</li>
<li>
! <a name="command_cmake_minimum_required"><b><code>cmake_minimum_required</code></b></a>: Set the minimum required version of cmake for a project.<br>
<pre> cmake_minimum_required(VERSION major[.minor[.patch]]<br> [FATAL_ERROR])<br></pre>
<p>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<br><pre> cmake_policy(VERSION major[.minor[.patch]])<br></pre>
--- 187,204 ----
<h2><a name="section_Commands"/>Commands</h2>
<ul>
! <li><a href="#command:break"><b><code>break</code></b></a></li> <li><a href="#command:build_name"><b><code>build_name</code></b></a></li> <li><a href="#command:cmake_minimum_required"><b><code>cmake_minimum_required</code></b></a></li> <li><a href="#command:cmake_policy"><b><code>cmake_policy</code></b></a></li> <li><a href="#command:configure_file"><b><code>configure_file</code></b></a></li> <li><a href="#command:CTEST_BUILD"><b><code>CTEST_BUILD</code></b></a></li> <li><a href="#command:CTEST_CONFIGURE"><b><code>CTEST_CONFIGURE</code></b></a></li> <li><a href="#command:CTEST_COVERAGE"><b><code>CTEST_COVERAGE</code></b></a></li> <li><a href="#command:CTEST_EMPTY_BINARY_DIRECTORY"><b><code>CTEST_EMPTY_BINARY_DIRECTORY</code></b></a></li> <li><a href="#command:CTEST_MEMCHECK"><b><code>CTEST_MEMCHECK</code></b></a></li> <li><a href="#command:CTEST_READ_CUSTOM_FILES"><b><code>CTEST_READ_CUSTOM_FILES</code></b></a></li> <li><a href="#command:CTEST_RUN_SCRIPT"><b><code>CTEST_RUN_SCRIPT</code></b></a></li> <li><a href="#command:CTEST_SLEEP"><b><code>CTEST_SLEEP</code></b></a></li> <li><a href="#command:CTEST_START"><b><code>CTEST_START</code></b></a></li> <li><a href="#command:CTEST_SUBMIT"><b><code>CTEST_SUBMIT</code></b></a></li> <li><a href="#command:CTEST_TEST"><b><code>CTEST_TEST</code></b></a></li> <li><a href="#command:CTEST_UPDATE"><b><code>CTEST_UPDATE</code></b></a></li> <li><a href="#command:else"><b><code>else</code></b></a></li> <li><a href="#command:elseif"><b><code>elseif</code></b></a></li> <li><a href="#command:endforeach"><b><code>endforeach</code></b></a></li> <li><a href="#command:endfunction"><b><code>endfunction</code></b></a></li> <li><a href="#command:endif"><b><code>endif</code></b></a></li> <li><a href="#command:endmacro"><b><code>endmacro</code></b></a></li> <li><a href="#command:endwhile"><b><code>endwhile</code></b></a></li> <li><a href="#command:exec_program"><b><code>exec_program</code></b></a></li> <li><a href="#command:execute_process"><b><code>execute_process</code></b></a></li> <li><a href="#command:file"><b><code>file</code></b></a></li> <li><a href="#command:find_file"><b><code>find_file</code></b></a></li> <li><a href="#command:find_library"><b><code>find_library</code></b></a></li> <li><a href="#command:find_package"><b><code>find_package</code></b></a></li> <li><a href="#command:find_path"><b><code>find_path</code></b></a></li> <li><a href="#command:find_program"><b><code>find_program</code></b></a></li> <li><a href="#command:foreach"><b><code>foreach</code></b></a></li> <li><a href="#command:function"><b><code>function</code></b></a></li> <li><a href="#command:get_cmake_property"><b><code>get_cmake_property</code></b></a></li> <li><a href="#command:get_directory_property"><b><code>get_directory_property</code></b></a></li> <li><a href="#command:get_filename_component"><b><code>get_filename_component</code></b></a></li> <li><a href="#command:get_property"><b><code>get_property</code></b></a></li> <li><a href="#command:if"><b><code>if</code></b></a></li> <li><a href="#command:include"><b><code>include</code></b></a></li> <li><a href="#command:list"><b><code>list</code></b></a></li> <li><a href="#command:macro"><b><code>macro</code></b></a></li> <li><a href="#command:make_directory"><b><code>make_directory</code></b></a></li> <li><a href="#command:mark_as_advanced"><b><code>mark_as_advanced</code></b></a></li> <li><a href="#command:math"><b><code>math</code></b></a></li> <li><a href="#command:message"><b><code>message</code></b></a></li> <li><a href="#command:option"><b><code>option</code></b></a></li> <li><a href="#command:remove"><b><code>remove</code></b></a></li> <li><a href="#command:return"><b><code>return</code></b></a></li> <li><a href="#command:separate_arguments"><b><code>separate_arguments</code></b></a></li> <li><a href="#command:set"><b><code>set</code></b></a></li> <li><a href="#command:set_directory_properties"><b><code>set_directory_properties</code></b></a></li> <li><a href="#command:set_property"><b><code>set_property</code></b></a></li> <li><a href="#command:site_name"><b><code>site_name</code></b></a></li> <li><a href="#command:string"><b><code>string</code></b></a></li> <li><a href="#command:variable_watch"><b><code>variable_watch</code></b></a></li> <li><a href="#command:while"><b><code>while</code></b></a></li> <li><a href="#command:write_file"><b><code>write_file</code></b></a></li></ul>
<ul>
<li>
! <a name="command:break"><b><code>break</code></b></a>: Break from an enclosing foreach or while loop.<br>
<pre> break()<br></pre>
<p>Breaks from an enclosing foreach loop or while loop
</li>
<li>
! <a name="command:build_name"><b><code>build_name</code></b></a>: Deprecated. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead.<br>
<pre> build_name(variable)<br></pre>
<p>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.
</li>
<li>
! <a name="command:cmake_minimum_required"><b><code>cmake_minimum_required</code></b></a>: Set the minimum required version of cmake for a project.<br>
<pre> cmake_minimum_required(VERSION major[.minor[.patch]]<br> [FATAL_ERROR])<br></pre>
<p>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<br><pre> cmake_policy(VERSION major[.minor[.patch]])<br></pre>
***************
*** 207,211 ****
</li>
<li>
! <a name="command_cmake_policy"><b><code>cmake_policy</code></b></a>: Manage CMake Policy settings.<br>
<p>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.<br><p>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.<br><pre> cmake_policy(VERSION major.minor[.patch])<br></pre>
<p>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 reset to use OLD behavior with a warning. 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.<br><pre> cmake_policy(SET CMP<NNNN> NEW)<br> cmake_policy(SET CMP<NNNN> OLD)<br></pre>
--- 207,211 ----
</li>
<li>
! <a name="command:cmake_policy"><b><code>cmake_policy</code></b></a>: Manage CMake Policy settings.<br>
<p>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.<br><p>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.<br><pre> cmake_policy(VERSION major.minor[.patch])<br></pre>
<p>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 reset to use OLD behavior with a warning. 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.<br><pre> cmake_policy(SET CMP<NNNN> NEW)<br> cmake_policy(SET CMP<NNNN> OLD)<br></pre>
***************
*** 214,330 ****
</li>
<li>
! <a name="command_configure_file"><b><code>configure_file</code></b></a>: Copy a file to another location and modify its contents.<br>
<pre> configure_file(InputFile OutputFile<br> [COPYONLY] [ESCAPE_QUOTES] [@ONLY])<br></pre>
<p>The Input and Output files have to have full paths. 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 replaces and ${VAR} will be ignored. This is useful for configuring scripts that use ${VAR}. Any occurrences of #cmakedefine VAR will be replaced with either #define VAR or /* #undef VAR */ depending on the setting of VAR in CMake
</li>
<li>
! <a name="command_CTEST_BUILD"><b><code>CTEST_BUILD</code></b></a>: Builds the repository.<br>
<pre> CTEST_BUILD([BUILD build_dir] [RETURN_VALUE res])<br></pre>
<p>Builds the given build directory and stores results in Build.xml.
</li>
<li>
! <a name="command_CTEST_CONFIGURE"><b><code>CTEST_CONFIGURE</code></b></a>: Configures the repository.<br>
<pre> CTEST_CONFIGURE(BUILD build_dir RETURN_VALUE res)<br></pre>
<p>Configures the given build directory and stores results in Configure.xml. The second argument is a variable that will hold return value.
</li>
<li>
! <a name="command_CTEST_COVERAGE"><b><code>CTEST_COVERAGE</code></b></a>: Tests the repository.<br>
<pre> CTEST_COVERAGE([BUILD build_dir] [RETURN_VALUE res])<br></pre>
<p>Perform the coverage of the given build directory and stores results in Coverage.xml. The second argument is a variable that will hold value.
</li>
<li>
! <a name="command_CTEST_EMPTY_BINARY_DIRECTORY"><b><code>CTEST_EMPTY_BINARY_DIRECTORY</code></b></a>: empties the binary directory<br>
<pre> CTEST_EMPTY_BINARY_DIRECTORY( directory )<br></pre>
<p>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.
</li>
<li>
! <a name="command_CTEST_MEMCHECK"><b><code>CTEST_MEMCHECK</code></b></a>: Tests the repository.<br>
<pre> CTEST_MEMCHECK([BUILD build_dir] [RETURN_VALUE res])<br></pre>
<p>Performs a memory checking of tests in the given build directory and stores results in MemCheck.xml. The second argument is a variable that will hold value.
</li>
<li>
! <a name="command_CTEST_READ_CUSTOM_FILES"><b><code>CTEST_READ_CUSTOM_FILES</code></b></a>: read CTestCustom files.<br>
<pre> CTEST_READ_CUSTOM_FILES( directory ... )<br></pre>
<p>Read all the CTestCustom.ctest or CTestCustom.cmake files from the given directory.
</li>
<li>
! <a name="command_CTEST_RUN_SCRIPT"><b><code>CTEST_RUN_SCRIPT</code></b></a>: runs a ctest -S script<br>
<pre> CTEST_RUN_SCRIPT([NEW_PROCESS] script_file_name script_file_name1 <br> script_file_name2 ...)<br></pre>
<p>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 seperate process.
</li>
<li>
! <a name="command_CTEST_SLEEP"><b><code>CTEST_SLEEP</code></b></a>: sleeps for some amount of time<br>
<pre> CTEST_SLEEP( seconds )<br> CTEST_SLEEP( time1 duration time2 )<br></pre>
<p>With one argument it will sleep for a given number of seconds. With three arguments it will wait for time2 - time1 - duration seconds.
</li>
<li>
! <a name="command_CTEST_START"><b><code>CTEST_START</code></b></a>: Starts the testing for a given model<br>
<pre> CTEST_START(Model [TRACK <track>] [source [binary]])<br></pre>
<p>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.
</li>
<li>
! <a name="command_CTEST_SUBMIT"><b><code>CTEST_SUBMIT</code></b></a>: Submits the repository.<br>
<pre> CTEST_SUBMIT([RETURN_VALUE res])<br></pre>
<p>Submits the test results for the project.
</li>
<li>
! <a name="command_CTEST_TEST"><b><code>CTEST_TEST</code></b></a>: Tests the repository.<br>
<pre> CTEST_TEST([BUILD build_dir] [RETURN_VALUE res])<br></pre>
<p>Tests the given build directory and stores results in Test.xml. The second argument is a variable that will hold value.
</li>
<li>
! <a name="command_CTEST_UPDATE"><b><code>CTEST_UPDATE</code></b></a>: Updates the repository.<br>
<pre> CTEST_UPDATE([SOURCE source] [RETURN_VALUE res])<br></pre>
<p>Updates the given source directory and stores results in Update.xml. The second argument is a variable that will hold the number of files modified. If there is a problem, the variable will be -1.
</li>
<li>
! <a name="command_else"><b><code>else</code></b></a>: Starts the else portion of an if block.<br>
<pre> else(expression)<br></pre>
<p>See the if command.
</li>
<li>
! <a name="command_elseif"><b><code>elseif</code></b></a>: Starts the elseif portion of an if block.<br>
<pre> elseif(expression)<br></pre>
<p>See the if command.
</li>
<li>
! <a name="command_endforeach"><b><code>endforeach</code></b></a>: Ends a list of commands in a FOREACH block.<br>
<pre> endforeach(expression)<br></pre>
<p>See the FOREACH command.
</li>
<li>
! <a name="command_endfunction"><b><code>endfunction</code></b></a>: Ends a list of commands in a function block.<br>
<pre> endfunction(expression)<br></pre>
<p>See the function command.
</li>
<li>
! <a name="command_endif"><b><code>endif</code></b></a>: Ends a list of commands in an if block.<br>
<pre> endif(expression)<br></pre>
<p>See the if command.
</li>
<li>
! <a name="command_endmacro"><b><code>endmacro</code></b></a>: Ends a list of commands in a macro block.<br>
<pre> endmacro(expression)<br></pre>
<p>See the macro command.
</li>
<li>
! <a name="command_endwhile"><b><code>endwhile</code></b></a>: Ends a list of commands in a while block.<br>
<pre> endwhile(expression)<br></pre>
<p>See the while command.
</li>
<li>
! <a name="command_exec_program"><b><code>exec_program</code></b></a>: Deprecated. Use the execute_process() command instead.<br>
<p>Run an executable program during the processing of the CMakeList.txt file.<br><pre> exec_program(Executable [directory in which to run]<br> [ARGS <arguments to executable>]<br> [OUTPUT_VARIABLE <var>]<br> [RETURN_VALUE <var>])<br></pre>
<p>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.<br>
</li>
<li>
! <a name="command_execute_process"><b><code>execute_process</code></b></a>: Execute one or more child processes.<br>
<pre> execute_process(COMMAND <cmd1> [args1...]]<br> [COMMAND <cmd2> [args2...] [...]]<br> [WORKING_DIRECTORY <directory>]<br> [TIMEOUT <seconds>]<br> [RESULT_VARIABLE <variable>]<br> [OUTPUT_VARIABLE <variable>]<br> [ERROR_VARIABLE <variable>]<br> [INPUT_FILE <file>]<br> [OUTPUT_FILE <file>]<br> [ERROR_FILE <file>]<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>
! <a name="command_file"><b><code>file</code></b></a>: File manipulation command.<br>
<pre> file(WRITE filename "message to write"... )<br> file(APPEND filename "message to write"... )<br> file(READ filename variable [LIMIT numBytes] [OFFSET offset] [HEX])<br> file(STRINGS filename variable [LIMIT_COUNT num]<br> [LIMIT_INPUT numBytes] [LIMIT_OUTPUT numBytes]<br> [LENGTH_MINIMUM numBytes] [LENGTH_MAXIMUM numBytes]<br> [NEWLINE_CONSUME] [REGEX regex]<br> [NO_HEX_CONVERSION])<br> file(GLOB variable [RELATIVE path] [globbing expressions]...)<br> file(GLOB_RECURSE variable [RELATIVE path] <br> [globbing expressions]...)<br> file(REMOVE [file1 ...])<br> file(REMOVE_RECURSE [file1 ...])<br> file(MAKE_DIRECTORY [directory1 directory2 ...])<br> file(RELATIVE_PATH variable directory file)<br> file(TO_CMAKE_PATH path result)<br> file(TO_NATIVE_PATH path result)<br> file(DOWNLOAD url file [TIMEOUT timeout] [STATUS status] [LOG log])<br></pre>
! <p>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.<br><p>APPEND will write a message into a file same as WRITE, except it will append it to the end of the file<br><p>NOTE: When using file WRITE and file APPEND, 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.<br><p>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.<br><p>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.<br><p>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.<br><p>REGEX specifies a regular expression that a string must match to be returned. Typical usage <br><pre> file(STRINGS myfile.txt myfile)<br></pre>
<p>stores a list in the variable "myfile" in which each item is a line from the input file.<br><p>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.<br><p>Examples of globbing expressions include:<br><pre> *.cxx - match all files with extension cxx<br> *.vt? - match all files with extension vta,...,vtz<br> f[3-5].txt - match files f3.txt, f4.txt, f5.txt<br></pre>
<p>GLOB_RECURSE will generate similar list as the regular GLOB, except it will traverse all the subdirectories of the matched directory and match the files.<br><p>Examples of recursive globbing include:<br><pre> /dir/*.py - match all python files in /dir and subdirectories<br></pre>
--- 214,330 ----
</li>
<li>
! <a name="command:configure_file"><b><code>configure_file</code></b></a>: Copy a file to another location and modify its contents.<br>
<pre> configure_file(InputFile OutputFile<br> [COPYONLY] [ESCAPE_QUOTES] [@ONLY])<br></pre>
<p>The Input and Output files have to have full paths. 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 replaces and ${VAR} will be ignored. This is useful for configuring scripts that use ${VAR}. Any occurrences of #cmakedefine VAR will be replaced with either #define VAR or /* #undef VAR */ depending on the setting of VAR in CMake
</li>
<li>
! <a name="command:CTEST_BUILD"><b><code>CTEST_BUILD</code></b></a>: Builds the repository.<br>
<pre> CTEST_BUILD([BUILD build_dir] [RETURN_VALUE res])<br></pre>
<p>Builds the given build directory and stores results in Build.xml.
</li>
<li>
! <a name="command:CTEST_CONFIGURE"><b><code>CTEST_CONFIGURE</code></b></a>: Configures the repository.<br>
<pre> CTEST_CONFIGURE(BUILD build_dir RETURN_VALUE res)<br></pre>
<p>Configures the given build directory and stores results in Configure.xml. The second argument is a variable that will hold return value.
</li>
<li>
! <a name="command:CTEST_COVERAGE"><b><code>CTEST_COVERAGE</code></b></a>: Tests the repository.<br>
<pre> CTEST_COVERAGE([BUILD build_dir] [RETURN_VALUE res])<br></pre>
<p>Perform the coverage of the given build directory and stores results in Coverage.xml. The second argument is a variable that will hold value.
</li>
<li>
! <a name="command:CTEST_EMPTY_BINARY_DIRECTORY"><b><code>CTEST_EMPTY_BINARY_DIRECTORY</code></b></a>: empties the binary directory<br>
<pre> CTEST_EMPTY_BINARY_DIRECTORY( directory )<br></pre>
<p>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.
</li>
<li>
! <a name="command:CTEST_MEMCHECK"><b><code>CTEST_MEMCHECK</code></b></a>: Tests the repository.<br>
<pre> CTEST_MEMCHECK([BUILD build_dir] [RETURN_VALUE res])<br></pre>
<p>Performs a memory checking of tests in the given build directory and stores results in MemCheck.xml. The second argument is a variable that will hold value.
</li>
<li>
! <a name="command:CTEST_READ_CUSTOM_FILES"><b><code>CTEST_READ_CUSTOM_FILES</code></b></a>: read CTestCustom files.<br>
<pre> CTEST_READ_CUSTOM_FILES( directory ... )<br></pre>
<p>Read all the CTestCustom.ctest or CTestCustom.cmake files from the given directory.
</li>
<li>
! <a name="command:CTEST_RUN_SCRIPT"><b><code>CTEST_RUN_SCRIPT</code></b></a>: runs a ctest -S script<br>
<pre> CTEST_RUN_SCRIPT([NEW_PROCESS] script_file_name script_file_name1 <br> script_file_name2 ...)<br></pre>
<p>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 seperate process.
</li>
<li>
! <a name="command:CTEST_SLEEP"><b><code>CTEST_SLEEP</code></b></a>: sleeps for some amount of time<br>
<pre> CTEST_SLEEP( seconds )<br> CTEST_SLEEP( time1 duration time2 )<br></pre>
<p>With one argument it will sleep for a given number of seconds. With three arguments it will wait for time2 - time1 - duration seconds.
</li>
<li>
! <a name="command:CTEST_START"><b><code>CTEST_START</code></b></a>: Starts the testing for a given model<br>
<pre> CTEST_START(Model [TRACK <track>] [source [binary]])<br></pre>
<p>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.
</li>
<li>
! <a name="command:CTEST_SUBMIT"><b><code>CTEST_SUBMIT</code></b></a>: Submits the repository.<br>
<pre> CTEST_SUBMIT([RETURN_VALUE res])<br></pre>
<p>Submits the test results for the project.
</li>
<li>
! <a name="command:CTEST_TEST"><b><code>CTEST_TEST</code></b></a>: Tests the repository.<br>
<pre> CTEST_TEST([BUILD build_dir] [RETURN_VALUE res])<br></pre>
<p>Tests the given build directory and stores results in Test.xml. The second argument is a variable that will hold value.
</li>
<li>
! <a name="command:CTEST_UPDATE"><b><code>CTEST_UPDATE</code></b></a>: Updates the repository.<br>
<pre> CTEST_UPDATE([SOURCE source] [RETURN_VALUE res])<br></pre>
<p>Updates the given source directory and stores results in Update.xml. The second argument is a variable that will hold the number of files modified. If there is a problem, the variable will be -1.
</li>
<li>
! <a name="command:else"><b><code>else</code></b></a>: Starts the else portion of an if block.<br>
<pre> else(expression)<br></pre>
<p>See the if command.
</li>
<li>
! <a name="command:elseif"><b><code>elseif</code></b></a>: Starts the elseif portion of an if block.<br>
<pre> elseif(expression)<br></pre>
<p>See the if command.
</li>
<li>
! <a name="command:endforeach"><b><code>endforeach</code></b></a>: Ends a list of commands in a FOREACH block.<br>
<pre> endforeach(expression)<br></pre>
<p>See the FOREACH command.
</li>
<li>
! <a name="command:endfunction"><b><code>endfunction</code></b></a>: Ends a list of commands in a function block.<br>
<pre> endfunction(expression)<br></pre>
<p>See the function command.
</li>
<li>
! <a name="command:endif"><b><code>endif</code></b></a>: Ends a list of commands in an if block.<br>
<pre> endif(expression)<br></pre>
<p>See the if command.
</li>
<li>
! <a name="command:endmacro"><b><code>endmacro</code></b></a>: Ends a list of commands in a macro block.<br>
<pre> endmacro(expression)<br></pre>
<p>See the macro command.
</li>
<li>
! <a name="command:endwhile"><b><code>endwhile</code></b></a>: Ends a list of commands in a while block.<br>
<pre> endwhile(expression)<br></pre>
<p>See the while command.
</li>
<li>
! <a name="command:exec_program"><b><code>exec_program</code></b></a>: Deprecated. Use the execute_process() command instead.<br>
<p>Run an executable program during the processing of the CMakeList.txt file.<br><pre> exec_program(Executable [directory in which to run]<br> [ARGS <arguments to executable>]<br> [OUTPUT_VARIABLE <var>]<br> [RETURN_VALUE <var>])<br></pre>
<p>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.<br>
</li>
<li>
! <a name="command:execute_process"><b><code>execute_process</code></b></a>: Execute one or more child processes.<br>
<pre> execute_process(COMMAND <cmd1> [args1...]]<br> [COMMAND <cmd2> [args2...] [...]]<br> [WORKING_DIRECTORY <directory>]<br> [TIMEOUT <seconds>]<br> [RESULT_VARIABLE <variable>]<br> [OUTPUT_VARIABLE <variable>]<br> [ERROR_VARIABLE <variable>]<br> [INPUT_FILE <file>]<br> [OUTPUT_FILE <file>]<br> [ERROR_FILE <file>]<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>
! <a name="command:file"><b><code>file</code></b></a>: File manipulation command.<br>
<pre> file(WRITE filename "message to write"... )<br> file(APPEND filename "message to write"... )<br> file(READ filename variable [LIMIT numBytes] [OFFSET offset] [HEX])<br> file(STRINGS filename variable [LIMIT_COUNT num]<br> [LIMIT_INPUT numBytes] [LIMIT_OUTPUT numBytes]<br> [LENGTH_MINIMUM numBytes] [LENGTH_MAXIMUM numBytes]<br> [NEWLINE_CONSUME] [REGEX regex]<br> [NO_HEX_CONVERSION])<br> file(GLOB variable [RELATIVE path] [globbing expressions]...)<br> file(GLOB_RECURSE variable [RELATIVE path] <br> [globbing expressions]...)<br> file(REMOVE [file1 ...])<br> file(REMOVE_RECURSE [file1 ...])<br> file(MAKE_DIRECTORY [directory1 directory2 ...])<br> file(RELATIVE_PATH variable directory file)<br> file(TO_CMAKE_PATH path result)<br> file(TO_NATIVE_PATH path result)<br> file(DOWNLOAD url file [TIMEOUT timeout] [STATUS status] [LOG log])<br></pre>
! <p>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.<br><p>APPEND will write a message into a file same as WRITE, except it will append it to the end of the file<br><p>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.<br><p>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.<br><p>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.<br><p>REGEX specifies a regular expression that a string must match to be returned. Typical usage <br><pre> file(STRINGS myfile.txt myfile)<br></pre>
<p>stores a list in the variable "myfile" in which each item is a line from the input file.<br><p>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.<br><p>Examples of globbing expressions include:<br><pre> *.cxx - match all files with extension cxx<br> *.vt? - match all files with extension vta,...,vtz<br> f[3-5].txt - match files f3.txt, f4.txt, f5.txt<br></pre>
<p>GLOB_RECURSE will generate similar list as the regular GLOB, except it will traverse all the subdirectories of the matched directory and match the files.<br><p>Examples of recursive globbing include:<br><pre> /dir/*.py - match all python files in /dir and subdirectories<br></pre>
***************
*** 332,336 ****
</li>
<li>
! <a name="command_find_file"><b><code>find_file</code></b></a>: Find the full path to a file.<br>
<pre> find_path(<VAR> 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(<VAR> name1 [PATHS path1 path2 ...])<br><pre> find_path(<br> <VAR><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> [CMAKE_FIND_ROOT_PATH_BOTH |<br> ONLY_CMAKE_FIND_ROOT_PATH |<br> NO_CMAKE_FIND_ROOT_PATH]<br> )<br></pre>
--- 332,336 ----
</li>
<li>
! <a name="command:find_file"><b><code>find_file</code></b></a>: Find the full path to a file.<br>
<pre> find_path(<VAR> 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(<VAR> name1 [PATHS path1 path2 ...])<br><pre> find_path(<br> <VAR><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> [CMAKE_FIND_ROOT_PATH_BOTH |<br> ONLY_CMAKE_FIND_ROOT_PATH |<br> NO_CMAKE_FIND_ROOT_PATH]<br> )<br></pre>
***************
*** 345,349 ****
</li>
<li>
! <a name="command_find_library"><b><code>find_library</code></b></a>: Find a library.<br>
<pre> find_library(<VAR> 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(<VAR> name1 [PATHS path1 path2 ...])<br><pre> find_library(<br> <VAR><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> [CMAKE_FIND_ROOT_PATH_BOTH |<br> ONLY_CMAKE_FIND_ROOT_PATH |<br> NO_CMAKE_FIND_ROOT_PATH]<br> )<br></pre>
--- 345,349 ----
</li>
<li>
! <a name="command:find_library"><b><code>find_library</code></b></a>: Find a library.<br>
<pre> find_library(<VAR> 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(<VAR> name1 [PATHS path1 path2 ...])<br><pre> find_library(<br> <VAR><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> [CMAKE_FIND_ROOT_PATH_BOTH |<br> ONLY_CMAKE_FIND_ROOT_PATH |<br> NO_CMAKE_FIND_ROOT_PATH]<br> )<br></pre>
***************
*** 358,362 ****
</li>
<li>
! <a name="command_find_package"><b><code>find_package</code></b></a>: Load settings for an external project.<br>
<pre> find_package(<package> [major[.minor[.patch]]] [EXACT] [QUIET]<br> [[REQUIRED|COMPONENTS] [components...]])<br></pre>
<p>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 documented by the package itself. The QUIET option disables messages if the package cannot be found. The REQUIRED option stops processing with an error message if the package cannot be found. A package-specific list of components may be listed after the REQUIRED option or after the COMPONENTS option if no REQUIRED option is given. The "[major[.minor[.patch]]]" version argument specifies a desired version with which the package found should be compatible. The EXACT option requests that the version be matched exactly. Version support is currently provided only on a package-by-package basis (details below).<br><p>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.<br><p>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 the command proceeds to Config mode.<br><p>The complete Config mode command signature is:<br><pre> find_package(<package> [major[.minor[.patch]]] [EXACT] [QUIET]<br> [[REQUIRED|COMPONENTS] [components...]] [NO_MODULE]<br> [NAMES name1 [name2 ...]]<br> [CONFIGS config1 [config2 ...]]<br> [PATHS path1 [path2 ... ]]<br> [PATH_SUFFIXES suffix1 [suffix2 ...]]<br> [NO_DEFAULT_PATH]<br> [NO_CMAKE_ENVIRONMENT_PATH]<br> [NO_CMAKE_PATH]<br> [NO_SYSTEM_ENVIRONMENT_PATH]<br> [NO_CMAKE_BUILDS_PATH]<br> [NO_CMAKE_SYSTEM_PATH]<br> [CMAKE_FIND_ROOT_PATH_BOTH |<br> ONLY_CMAKE_FIND_ROOT_PATH |<br> NO_CMAKE_FIND_ROOT_PATH])<br></pre>
--- 358,362 ----
</li>
<li>
! <a name="command:find_package"><b><code>find_package</code></b></a>: Load settings for an external project.<br>
<pre> find_package(<package> [major[.minor[.patch]]] [EXACT] [QUIET]<br> [[REQUIRED|COMPONENTS] [components...]])<br></pre>
<p>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 documented by the package itself. The QUIET option disables messages if the package cannot be found. The REQUIRED option stops processing with an error message if the package cannot be found. A package-specific list of components may be listed after the REQUIRED option or after the COMPONENTS option if no REQUIRED option is given. The "[major[.minor[.patch]]]" version argument specifies a desired version with which the package found should be compatible. The EXACT option requests that the version be matched exactly. Version support is currently provided only on a package-by-package basis (details below).<br><p>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.<br><p>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 the command proceeds to Config mode.<br><p>The complete Config mode command signature is:<br><pre> find_package(<package> [major[.minor[.patch]]] [EXACT] [QUIET]<br> [[REQUIRED|COMPONENTS] [components...]] [NO_MODULE]<br> [NAMES name1 [name2 ...]]<br> [CONFIGS config1 [config2 ...]]<br> [PATHS path1 [path2 ... ]]<br> [PATH_SUFFIXES suffix1 [suffix2 ...]]<br> [NO_DEFAULT_PATH]<br> [NO_CMAKE_ENVIRONMENT_PATH]<br> [NO_CMAKE_PATH]<br> [NO_SYSTEM_ENVIRONMENT_PATH]<br> [NO_CMAKE_BUILDS_PATH]<br> [NO_CMAKE_SYSTEM_PATH]<br> [CMAKE_FIND_ROOT_PATH_BOTH |<br> ONLY_CMAKE_FIND_ROOT_PATH |<br> NO_CMAKE_FIND_ROOT_PATH])<br></pre>
***************
*** 377,381 ****
</li>
<li>
! <a name="command_find_path"><b><code>find_path</code></b></a>: Find the directory containing a file.<br>
<pre> find_path(<VAR> 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(<VAR> name1 [PATHS path1 path2 ...])<br><pre> find_path(<br> <VAR><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> [CMAKE_FIND_ROOT_PATH_BOTH |<br> ONLY_CMAKE_FIND_ROOT_PATH |<br> NO_CMAKE_FIND_ROOT_PATH]<br> )<br></pre>
--- 377,381 ----
</li>
<li>
! <a name="command:find_path"><b><code>find_path</code></b></a>: Find the directory containing a file.<br>
<pre> find_path(<VAR> 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(<VAR> name1 [PATHS path1 path2 ...])<br><pre> find_path(<br> <VAR><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> [CMAKE_FIND_ROOT_PATH_BOTH |<br> ONLY_CMAKE_FIND_ROOT_PATH |<br> NO_CMAKE_FIND_ROOT_PATH]<br> )<br></pre>
***************
*** 390,394 ****
</li>
<li>
! <a name="command_find_program"><b><code>find_program</code></b></a>: Find an executable program.<br>
<pre> find_program(<VAR> 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(<VAR> name1 [PATHS path1 path2 ...])<br><pre> find_program(<br> <VAR><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> [CMAKE_FIND_ROOT_PATH_BOTH |<br> ONLY_CMAKE_FIND_ROOT_PATH |<br> NO_CMAKE_FIND_ROOT_PATH]<br> )<br></pre>
--- 390,394 ----
</li>
<li>
! <a name="command:find_program"><b><code>find_program</code></b></a>: Find an executable program.<br>
<pre> find_program(<VAR> 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(<VAR> name1 [PATHS path1 path2 ...])<br><pre> find_program(<br> <VAR><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> [CMAKE_FIND_ROOT_PATH_BOTH |<br> ONLY_CMAKE_FIND_ROOT_PATH |<br> NO_CMAKE_FIND_ROOT_PATH]<br> )<br></pre>
***************
*** 403,427 ****
</li>
<li>
! <a name="command_foreach"><b><code>foreach</code></b></a>: Evaluate a group of commands for each value in a list.<br>
<pre> foreach(loop_var arg1 arg2 ...)<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> endforeach(loop_var)<br> foreach(loop_var RANGE total)<br> foreach(loop_var RANGE start stop [step])<br></pre>
<p>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.<br><p>Foreach can also iterate over a generated range of numbers. There are three types of this iteration:<br><p>* When specifying single number, the range will have elements 0 to "total".<br><p>* When specifying two numbers, the range will have elements from the first number to the second number.<br><p>* The third optional number is the increment used to iterate from the first number to the second number.
</li>
<li>
! <a name="command_function"><b><code>function</code></b></a>: Start recording a function for later invocation as a command.<br>
<pre> function(<name> [arg1 [arg2 [arg3 ...]]])<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> endfunction(<name>)<br></pre>
<p>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 argument pass the last expected argument.
</li>
<li>
! <a name="command_get_cmake_property"><b><code>get_cmake_property</code></b></a>: Get a property of the CMake instance.<br>
<pre> get_cmake_property(VAR property)<br></pre>
<p>Get a property from the CMake instance. The value of the property is stored in the variable VAR. If the property is not found, CMake will report an error. Some supported properties include: VARIABLES, CACHE_VARIABLES, COMMANDS, and MACROS.
</li>
<li>
! <a name="command_get_directory_property"><b><code>get_directory_property</code></b></a>: Get a property of the directory.<br>
<pre> get_directory_property(VAR [DIRECTORY dir] property)<br></pre>
<p>Get a property from the Directory. The value of the property is stored in the variable VAR. If the property is not found, CMake will report an error. The properties include: VARIABLES, CACHE_VARIABLES, COMMANDS, MACROS, INCLUDE_DIRECTORIES, LINK_DIRECTORIES, DEFINITIONS, INCLUDE_REGULAR_EXPRESSION, LISTFILE_STACK, PARENT_DIRECTORY, and DEFINITION varname. If the DIRECTORY argument is provided then the property of the provided directory will be retrieved instead of the current directory. You can only get properties of a directory during or after it has been traversed by cmake.
</li>
<li>
! <a name="command_get_filename_component"><b><code>get_filename_component</code></b></a>: Get a specific component of a full filename.<br>
<pre> get_filename_component(VarName FileName<br> PATH|ABSOLUTE|NAME|EXT|NAME_WE<br> [CACHE])<br></pre>
<p>Set VarName to be the path (PATH), file name (NAME), file extension (EXT), file name without extension (NAME_WE) of FileName, or the full absolute (ABSOLUTE) file name without symlinks. Note that the path is converted to Unix slashes format and has no trailing slashes. The longest file extension is always considered. If the optional CACHE argument is specified, the result variable is added to the cache.<br><pre> get_filename_component(VarName FileName<br> PROGRAM [PROGRAM_ARGS ArgVar]<br> [CACHE])<br></pre>
--- 403,427 ----
</li>
<li>
! <a name="command:foreach"><b><code>foreach</code></b></a>: Evaluate a group of commands for each value in a list.<br>
<pre> foreach(loop_var arg1 arg2 ...)<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> endforeach(loop_var)<br> foreach(loop_var RANGE total)<br> foreach(loop_var RANGE start stop [step])<br></pre>
<p>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.<br><p>Foreach can also iterate over a generated range of numbers. There are three types of this iteration:<br><p>* When specifying single number, the range will have elements 0 to "total".<br><p>* When specifying two numbers, the range will have elements from the first number to the second number.<br><p>* The third optional number is the increment used to iterate from the first number to the second number.
</li>
<li>
! <a name="command:function"><b><code>function</code></b></a>: Start recording a function for later invocation as a command.<br>
<pre> function(<name> [arg1 [arg2 [arg3 ...]]])<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> endfunction(<name>)<br></pre>
<p>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 argument pass the last expected argument.
</li>
<li>
! <a name="command:get_cmake_property"><b><code>get_cmake_property</code></b></a>: Get a property of the CMake instance.<br>
<pre> get_cmake_property(VAR property)<br></pre>
<p>Get a property from the CMake instance. The value of the property is stored in the variable VAR. If the property is not found, CMake will report an error. Some supported properties include: VARIABLES, CACHE_VARIABLES, COMMANDS, and MACROS.
</li>
<li>
! <a name="command:get_directory_property"><b><code>get_directory_property</code></b></a>: Get a property of the directory.<br>
<pre> get_directory_property(VAR [DIRECTORY dir] property)<br></pre>
<p>Get a property from the Directory. The value of the property is stored in the variable VAR. If the property is not found, CMake will report an error. The properties include: VARIABLES, CACHE_VARIABLES, COMMANDS, MACROS, INCLUDE_DIRECTORIES, LINK_DIRECTORIES, DEFINITIONS, INCLUDE_REGULAR_EXPRESSION, LISTFILE_STACK, PARENT_DIRECTORY, and DEFINITION varname. If the DIRECTORY argument is provided then the property of the provided directory will be retrieved instead of the current directory. You can only get properties of a directory during or after it has been traversed by cmake.
</li>
<li>
! <a name="command:get_filename_component"><b><code>get_filename_component</code></b></a>: Get a specific component of a full filename.<br>
<pre> get_filename_component(VarName FileName<br> PATH|ABSOLUTE|NAME|EXT|NAME_WE<br> [CACHE])<br></pre>
<p>Set VarName to be the path (PATH), file name (NAME), file extension (EXT), file name without extension (NAME_WE) of FileName, or the full absolute (ABSOLUTE) file name without symlinks. Note that the path is converted to Unix slashes format and has no trailing slashes. The longest file extension is always considered. If the optional CACHE argument is specified, the result variable is added to the cache.<br><pre> get_filename_component(VarName FileName<br> PROGRAM [PROGRAM_ARGS ArgVar]<br> [CACHE])<br></pre>
***************
*** 429,438 ****
</li>
<li>
! <a name="command_get_property"><b><code>get_property</code></b></a>: Get a property.<br>
! <pre> get_property(<variable><br> <GLOBAL |<br> DIRECTORY [dir] |<br> TARGET <target> |<br> SOURCE <source> |<br> TEST <test> |<br> VARIABLE><br> PROPERTY <name><br> [DEFINED | BRIEF_DOCS | FULL_DOCS])<br></pre>
! <p>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:<br><p>GLOBAL scope is unique and does not accept a name.<br><p>DIRECTORY scope defaults to the current directory but another directory (already processed by CMake) may be named by full or relative path.<br><p>TARGET scope must name one existing target.<br><p>SOURCE scope must name one source file.<br><p>TEST scope must name one existing test.<br><p>VARIABLE scope is unique and does not accept a name.<br><p>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 DEFINED option is given the variable is set to a boolean value indicating whether the property has been set. 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.
</li>
<li>
! <a name="command_if"><b><code>if</code></b></a>: Conditionally execute a group of commands.<br>
<pre> if(expression)<br> # then section.<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> elseif(expression2)<br> # elseif section.<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> else(expression)<br> # else section.<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> endif(expression)<br></pre>
<p>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 same expression must be given to if, and endif. Long expressions can be used and the order or precedence is that the EXISTS, COMMAND, and DEFINED operators will be evaluated first. 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:<br><pre> if(variable)<br></pre>
--- 429,438 ----
</li>
<li>
! <a name="command:get_property"><b><code>get_property</code></b></a>: Get a property.<br>
! <pre> get_property(<variable><br> <GLOBAL |<br> DIRECTORY [dir] |<br> TARGET <target> |<br> SOURCE <source> |<br> TEST <test> |<br> VARIABLE><br> PROPERTY <name><br> [SET | DEFINED | BRIEF_DOCS | FULL_DOCS])<br></pre>
! <p>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:<br><p>GLOBAL scope is unique and does not accept a name.<br><p>DIRECTORY scope defaults to the current directory but another directory (already processed by CMake) may be named by full or relative path.<br><p>TARGET scope must name one existing target.<br><p>SOURCE scope must name one source file.<br><p>TEST scope must name one existing test.<br><p>VARIABLE scope is unique and does not accept a name.<br><p>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.
</li>
<li>
! <a name="command:if"><b><code>if</code></b></a>: Conditionally execute a group of commands.<br>
<pre> if(expression)<br> # then section.<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> elseif(expression2)<br> # elseif section.<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> else(expression)<br> # else section.<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> endif(expression)<br></pre>
<p>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 same expression must be given to if, and endif. Long expressions can be used and the order or precedence is that the EXISTS, COMMAND, and DEFINED operators will be evaluated first. 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:<br><pre> if(variable)<br></pre>
***************
*** 453,512 ****
</li>
<li>
! <a name="command_include"><b><code>include</code></b></a>: Read CMake listfile code from the given file.<br>
<pre> include(file1 [OPTIONAL] [RESULT_VARIABLE <VAR>])<br> include(module [OPTIONAL] [RESULT_VARIABLE <VAR>])<br></pre>
<p>Reads CMake listfile code from the given file. Commands in the file are processed immediately as if they were written in place of the include command. 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.<br><p>If a module is specified instead of a file, the file with name <modulename>.cmake is searched in the CMAKE_MODULE_PATH.
</li>
<li>
! <a name="command_list"><b><code>list</code></b></a>: List operations.<br>
<pre> list(LENGTH <list> <output variable>)<br> list(GET <list> <element index> [<element index> ...] <output variable>)<br> list(APPEND <list> <element> [<element> ...])<br> list(FIND <list> <value> <output variable>)<br> list(INSERT <list> <element_index> <element> [<element> ...])<br> list(REMOVE_ITEM <list> <value> [<value> ...])<br> list(REMOVE_AT <list> <index> [<index> ...])<br> list(REMOVE_DUPLICATES <list>)<br> list(REVERSE <list>)<br> list(SORT <list>)<br></pre>
<p>LENGTH will return a given list's length.<br><p>GET will return list of elements specified by indices from the list.<br><p>APPEND will append elements to the list.<br><p>FIND will return the index of the element specified in the list or -1 if it wasn't found.<br><p>INSERT will insert elements to the list to the specified location.<br><p>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.<br><p>REMOVE_DUPLICATES will remove duplicated items in the list.<br><p>REVERSE reverses the contents of the list in-place.<br><p>SORT sorts the list in-place alphabetically.<br><p>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.<br><p>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.<br>
</li>
<li>
! <a name="command_macro"><b><code>macro</code></b></a>: Start recording a macro for later invocation as a command.<br>
<pre> macro(<name> [arg1 [arg2 [arg3 ...]]])<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> endmacro(<name>)<br></pre>
<p>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 argument pass 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 you should look at the function command.
</li>
<li>
! <a name="command_make_directory"><b><code>make_directory</code></b></a>: Deprecated. Use the file(MAKE_DIRECTORY ) command instead.<br>
<pre> make_directory(directory)<br></pre>
<p>Creates the specified directory. Full paths should be given. Any parent directories that do not exist will also be created. Use with care.
</li>
<li>
! <a name="command_mark_as_advanced"><b><code>mark_as_advanced</code></b></a>: Mark cmake cached variables as advanced.<br>
<pre> mark_as_advanced([CLEAR|FORCE] VAR VAR2 VAR...)<br></pre>
<p>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.<br><p>It does nothing in script mode.
</li>
<li>
! <a name="command_math"><b><code>math</code></b></a>: Mathematical expressions.<br>
<pre> math(EXPR <output variable> <math expression>)<br></pre>
<p>EXPR evaluates mathematical expression and return 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.
</li>
<li>
! <a name="command_message"><b><code>message</code></b></a>: Display a message to the user.<br>
<pre> message([SEND_ERROR | STATUS | FATAL_ERROR]<br> "message to display" ...)<br></pre>
<p>By default the message is displayed in a pop up window (CMakeSetup), or in the stdout of cmake, or the error section of ccmake. If the first argument is SEND_ERROR then an error is raised, and the generate phase will be skipped. If the first argument is FATAL_ERROR, all processing is halted. If the first argument is STATUS then the message is displayed in the progress line for the GUI, or with a -- in the command line cmake.
</li>
<li>
! <a name="command_option"><b><code>option</code></b></a>: Provides an option that the user can optionally select.<br>
<pre> option(<option_variable> "help string describing option"<br> [initial value])<br></pre>
<p>Provide an option for the user to select as ON or OFF. If no initial value is provided, OFF is used.
</li>
<li>
! <a name="command_remove"><b><code>remove</code></b></a>: Deprecated. Use the list(REMOVE_ITEM ) command instead.<br>
<pre> remove(VAR VALUE VALUE ...)<br></pre>
<p>Removes VALUE from the variable VAR. This is typically used to remove entries from a vector (e.g. semicolon separated list). VALUE is expanded.
</li>
<li>
! <a name="command_return"><b><code>return</code></b></a>: Return from a directory or function.<br>
<pre> return()<br></pre>
<p>Returns from a directory or function. When this command is encountered, it caused process of the current function or directory to stop and control is return to the caller of the function, or the parent directory if any. Note that a macro is not a function and does not handle return like a function does.
</li>
<li>
! <a name="command_separate_arguments"><b><code>separate_arguments</code></b></a>: Split space separated arguments into a semi-colon separated list.<br>
<pre> separate_arguments(VARIABLE)<br></pre>
<p>Convert the value of VARIABLE to a semi-colon separated list. All spaces are replaced with ';'. This helps with generating command lines.
</li>
<li>
! <a name="command_set"><b><code>set</code></b></a>: Set a CMAKE variable to a given value.<br>
<pre> set(<variable> <value> [[CACHE <type> <docstring> [FORCE]] | PARENT_SCOPE])<br></pre>
<p>Within CMake sets <variable> to the value <value>. <value> is expanded before <variable> is set to it. If CACHE is present, then the <variable> is put in the cache. <type> and <docstring> are then 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<br><pre> FILEPATH = File chooser dialog.<br> PATH = Directory chooser dialog.<br> STRING = Arbitrary string.<br> BOOL = Boolean ON/OFF checkbox.<br> INTERNAL = No GUI entry (used for persistent variables).<br></pre>
--- 453,512 ----
</li>
<li>
! <a name="command:include"><b><code>include</code></b></a>: Read CMake listfile code from the given file.<br>
<pre> include(file1 [OPTIONAL] [RESULT_VARIABLE <VAR>])<br> include(module [OPTIONAL] [RESULT_VARIABLE <VAR>])<br></pre>
<p>Reads CMake listfile code from the given file. Commands in the file are processed immediately as if they were written in place of the include command. 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.<br><p>If a module is specified instead of a file, the file with name <modulename>.cmake is searched in the CMAKE_MODULE_PATH.
</li>
<li>
! <a name="command:list"><b><code>list</code></b></a>: List operations.<br>
<pre> list(LENGTH <list> <output variable>)<br> list(GET <list> <element index> [<element index> ...] <output variable>)<br> list(APPEND <list> <element> [<element> ...])<br> list(FIND <list> <value> <output variable>)<br> list(INSERT <list> <element_index> <element> [<element> ...])<br> list(REMOVE_ITEM <list> <value> [<value> ...])<br> list(REMOVE_AT <list> <index> [<index> ...])<br> list(REMOVE_DUPLICATES <list>)<br> list(REVERSE <list>)<br> list(SORT <list>)<br></pre>
<p>LENGTH will return a given list's length.<br><p>GET will return list of elements specified by indices from the list.<br><p>APPEND will append elements to the list.<br><p>FIND will return the index of the element specified in the list or -1 if it wasn't found.<br><p>INSERT will insert elements to the list to the specified location.<br><p>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.<br><p>REMOVE_DUPLICATES will remove duplicated items in the list.<br><p>REVERSE reverses the contents of the list in-place.<br><p>SORT sorts the list in-place alphabetically.<br><p>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.<br><p>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.<br>
</li>
<li>
! <a name="command:macro"><b><code>macro</code></b></a>: Start recording a macro for later invocation as a command.<br>
<pre> macro(<name> [arg1 [arg2 [arg3 ...]]])<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> endmacro(<name>)<br></pre>
<p>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 argument pass 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 you should look at the function command.
</li>
<li>
! <a name="command:make_directory"><b><code>make_directory</code></b></a>: Deprecated. Use the file(MAKE_DIRECTORY ) command instead.<br>
<pre> make_directory(directory)<br></pre>
<p>Creates the specified directory. Full paths should be given. Any parent directories that do not exist will also be created. Use with care.
</li>
<li>
! <a name="command:mark_as_advanced"><b><code>mark_as_advanced</code></b></a>: Mark cmake cached variables as advanced.<br>
<pre> mark_as_advanced([CLEAR|FORCE] VAR VAR2 VAR...)<br></pre>
<p>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.<br><p>It does nothing in script mode.
</li>
<li>
! <a name="command:math"><b><code>math</code></b></a>: Mathematical expressions.<br>
<pre> math(EXPR <output variable> <math expression>)<br></pre>
<p>EXPR evaluates mathematical expression and return 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.
</li>
<li>
! <a name="command:message"><b><code>message</code></b></a>: Display a message to the user.<br>
<pre> message([SEND_ERROR | STATUS | FATAL_ERROR]<br> "message to display" ...)<br></pre>
<p>By default the message is displayed in a pop up window (CMakeSetup), or in the stdout of cmake, or the error section of ccmake. If the first argument is SEND_ERROR then an error is raised, and the generate phase will be skipped. If the first argument is FATAL_ERROR, all processing is halted. If the first argument is STATUS then the message is displayed in the progress line for the GUI, or with a -- in the command line cmake.
</li>
<li>
! <a name="command:option"><b><code>option</code></b></a>: Provides an option that the user can optionally select.<br>
<pre> option(<option_variable> "help string describing option"<br> [initial value])<br></pre>
<p>Provide an option for the user to select as ON or OFF. If no initial value is provided, OFF is used.
</li>
<li>
! <a name="command:remove"><b><code>remove</code></b></a>: Deprecated. Use the list(REMOVE_ITEM ) command instead.<br>
<pre> remove(VAR VALUE VALUE ...)<br></pre>
<p>Removes VALUE from the variable VAR. This is typically used to remove entries from a vector (e.g. semicolon separated list). VALUE is expanded.
</li>
<li>
! <a name="command:return"><b><code>return</code></b></a>: Return from a directory or function.<br>
<pre> return()<br></pre>
<p>Returns from a directory or function. When this command is encountered, it caused process of the current function or directory to stop and control is return to the caller of the function, or the parent directory if any. Note that a macro is not a function and does not handle return like a function does.
</li>
<li>
! <a name="command:separate_arguments"><b><code>separate_arguments</code></b></a>: Split space separated arguments into a semi-colon separated list.<br>
<pre> separate_arguments(VARIABLE)<br></pre>
<p>Convert the value of VARIABLE to a semi-colon separated list. All spaces are replaced with ';'. This helps with generating command lines.
</li>
<li>
! <a name="command:set"><b><code>set</code></b></a>: Set a CMAKE variable to a given value.<br>
<pre> set(<variable> <value> [[CACHE <type> <docstring> [FORCE]] | PARENT_SCOPE])<br></pre>
<p>Within CMake sets <variable> to the value <value>. <value> is expanded before <variable> is set to it. If CACHE is present, then the <variable> is put in the cache. <type> and <docstring> are then 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<br><pre> FILEPATH = File chooser dialog.<br> PATH = Directory chooser dialog.<br> STRING = Arbitrary string.<br> BOOL = Boolean ON/OFF checkbox.<br> INTERNAL = No GUI entry (used for persistent variables).<br></pre>
***************
*** 516,535 ****
</li>
<li>
! <a name="command_set_directory_properties"><b><code>set_directory_properties</code></b></a>: Set a property of the directory.<br>
<pre> set_directory_properties(PROPERTIES prop1 value1 prop2 value2)<br></pre>
<p>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.<br><p>ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned as a part of "make clean" stage.
</li>
<li>
! <a name="command_set_property"><b><code>set_property</code></b></a>: Set a named property in a given scope.<br>
<pre> set_property(<GLOBAL |<br> DIRECTORY [dir] |<br> TARGET [target1 [target2 ...]] |<br> SOURCE [src1 [src2 ...]] |<br> TEST [test1 [test2 ...]]><br> [APPEND]<br> PROPERTY <name> [value1 [value2 ...]])<br></pre>
<p>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:<br><p>GLOBAL scope is unique and does not accept a name.<br><p>DIRECTORY scope defaults to the current directory but another directory (already processed by CMake) may be named by full or relative path.<br><p>TARGET scope may name zero or more existing targets.<br><p>SOURCE scope may name zero or more source files.<br><p>TEST scope may name zero or more existing tests.<br><p>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.
</li>
<li>
! <a name="command_site_name"><b><code>site_name</code></b></a>: Set the given variable to the name of the computer.<br>
<pre> site_name(variable)<br></pre>
</li>
<li>
! <a name="command_string"><b><code>string</code></b></a>: String operations.<br>
<pre> string(REGEX MATCH <regular_expression><br> <output variable> <input> [<input>...])<br> string(REGEX MATCHALL <regular_expression><br> <output variable> <input> [<input>...])<br> string(REGEX REPLACE <regular_expression><br> <replace_expression> <output variable><br> <input> [<input>...])<br> string(REPLACE <match_string><br> <replace_string> <output variable><br> <input> [<input>...])<br> string(COMPARE EQUAL <string1> <string2> <output variable>)<br> string(COMPARE NOTEQUAL <string1> <string2> <output variable>)<br> string(COMPARE LESS <string1> <string2> <output variable>)<br> string(COMPARE GREATER <string1> <string2> <output variable>)<br> string(ASCII <number> [<number> ...] <output variable>)<br> string(CONFIGURE <string1> <output variable><br> [@ONLY] [ESCAPE_QUOTES])<br> string(TOUPPER <string1> <output variable>)<br> string(TOLOWER <string1> <output variable>)<br> string(LENGTH <string> <output variable>)<br> string(SUBSTRING <string> <begin> <length> <output variable>)<br> string(STRIP <string> <output variable>)<br> string(RANDOM [LENGTH <length>] [ALPHABET <alphabet>]<br> <output variable>)<br></pre>
<p>REGEX MATCH will match the regular expression once and store the match in the output variable.<br><p>REGEX MATCHALL will match the regular expression as many times as possible and store the matches in the output variable as a list.<br><p>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.<br><p>REPLACE will replace all occurrences of match_string in the input with replace_string and store the result in the output.<br><p>COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and store true or false in the output variable.<br><p>ASCII will convert all numbers into corresponding ASCII characters.<br><p>CONFIGURE will transform a string like CONFIGURE_FILE transforms a file.<br><p>TOUPPER/TOLOWER will convert string to upper/lower characters.<br><p>LENGTH will return a given string's length.<br><p>SUBSTRING will return a substring of a given string.<br><p>STRIP will return a substring of a given string with leading and trailing spaces removed.<br><p>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.<br><p>The following characters have special meaning in regular expressions:<br><pre> ^ Matches at beginning of a line<br> $ Matches at end of a line<br> . Matches any single character<br> [ ] Matches any character(s) inside the brackets<br> [^ ] Matches any character(s) not inside the brackets<br> - Matches any character in range on either side of a dash<br> * Matches preceding pattern zero or more times<br> + Matches preceding pattern one or more times<br> ? Matches preceding pattern zero or once only<br> | Matches a pattern on either side of the |<br> () Saves a matched subexpression, which can be referenced in the REGEX REPLACE operation. Additionally it is saved in the special CMake variables CMAKE_MATCH_(0..9).</pre>
--- 516,535 ----
</li>
<li>
! <a name="command:set_directory_properties"><b><code>set_directory_properties</code></b></a>: Set a property of the directory.<br>
<pre> set_directory_properties(PROPERTIES prop1 value1 prop2 value2)<br></pre>
<p>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.<br><p>ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned as a part of "make clean" stage.
</li>
<li>
! <a name="command:set_property"><b><code>set_property</code></b></a>: Set a named property in a given scope.<br>
<pre> set_property(<GLOBAL |<br> DIRECTORY [dir] |<br> TARGET [target1 [target2 ...]] |<br> SOURCE [src1 [src2 ...]] |<br> TEST [test1 [test2 ...]]><br> [APPEND]<br> PROPERTY <name> [value1 [value2 ...]])<br></pre>
<p>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:<br><p>GLOBAL scope is unique and does not accept a name.<br><p>DIRECTORY scope defaults to the current directory but another directory (already processed by CMake) may be named by full or relative path.<br><p>TARGET scope may name zero or more existing targets.<br><p>SOURCE scope may name zero or more source files.<br><p>TEST scope may name zero or more existing tests.<br><p>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.
</li>
<li>
! <a name="command:site_name"><b><code>site_name</code></b></a>: Set the given variable to the name of the computer.<br>
<pre> site_name(variable)<br></pre>
</li>
<li>
! <a name="command:string"><b><code>string</code></b></a>: String operations.<br>
<pre> string(REGEX MATCH <regular_expression><br> <output variable> <input> [<input>...])<br> string(REGEX MATCHALL <regular_expression><br> <output variable> <input> [<input>...])<br> string(REGEX REPLACE <regular_expression><br> <replace_expression> <output variable><br> <input> [<input>...])<br> string(REPLACE <match_string><br> <replace_string> <output variable><br> <input> [<input>...])<br> string(COMPARE EQUAL <string1> <string2> <output variable>)<br> string(COMPARE NOTEQUAL <string1> <string2> <output variable>)<br> string(COMPARE LESS <string1> <string2> <output variable>)<br> string(COMPARE GREATER <string1> <string2> <output variable>)<br> string(ASCII <number> [<number> ...] <output variable>)<br> string(CONFIGURE <string1> <output variable><br> [@ONLY] [ESCAPE_QUOTES])<br> string(TOUPPER <string1> <output variable>)<br> string(TOLOWER <string1> <output variable>)<br> string(LENGTH <string> <output variable>)<br> string(SUBSTRING <string> <begin> <length> <output variable>)<br> string(STRIP <string> <output variable>)<br> string(RANDOM [LENGTH <length>] [ALPHABET <alphabet>]<br> <output variable>)<br></pre>
<p>REGEX MATCH will match the regular expression once and store the match in the output variable.<br><p>REGEX MATCHALL will match the regular expression as many times as possible and store the matches in the output variable as a list.<br><p>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.<br><p>REPLACE will replace all occurrences of match_string in the input with replace_string and store the result in the output.<br><p>COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and store true or false in the output variable.<br><p>ASCII will convert all numbers into corresponding ASCII characters.<br><p>CONFIGURE will transform a string like CONFIGURE_FILE transforms a file.<br><p>TOUPPER/TOLOWER will convert string to upper/lower characters.<br><p>LENGTH will return a given string's length.<br><p>SUBSTRING will return a substring of a given string.<br><p>STRIP will return a substring of a given string with leading and trailing spaces removed.<br><p>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.<br><p>The following characters have special meaning in regular expressions:<br><pre> ^ Matches at beginning of a line<br> $ Matches at end of a line<br> . Matches any single character<br> [ ] Matches any character(s) inside the brackets<br> [^ ] Matches any character(s) not inside the brackets<br> - Matches any character in range on either side of a dash<br> * Matches preceding pattern zero or more times<br> + Matches preceding pattern one or more times<br> ? Matches preceding pattern zero or once only<br> | Matches a pattern on either side of the |<br> () Saves a matched subexpression, which can be referenced in the REGEX REPLACE operation. Additionally it is saved in the special CMake variables CMAKE_MATCH_(0..9).</pre>
***************
*** 537,551 ****
</li>
<li>
! <a name="command_variable_watch"><b><code>variable_watch</code></b></a>: Watch the CMake variable for change.<br>
<pre> variable_watch(<variable name> [<command to execute>])<br></pre>
<p>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>)
</li>
<li>
! <a name="command_while"><b><code>while</code></b></a>: Evaluate a group of commands while a condition is true<br>
<pre> while(condition)<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> endwhile(condition)<br></pre>
<p>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.
</li>
<li>
! <a name="command_write_file"><b><code>write_file</code></b></a>: Deprecated. Use the file(WRITE ) command instead.<br>
<pre> write_file(filename "message to write"... [APPEND])<br></pre>
<p>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.<br><p>NOTE 1: file(WRITE ... and file(APPEND ... do exactly the same as this one but add some more functionality.<br><p>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.
--- 537,551 ----
</li>
<li>
! <a name="command:variable_watch"><b><code>variable_watch</code></b></a>: Watch the CMake variable for change.<br>
<pre> variable_watch(<variable name> [<command to execute>])<br></pre>
<p>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>)
</li>
<li>
! <a name="command:while"><b><code>while</code></b></a>: Evaluate a group of commands while a condition is true<br>
<pre> while(condition)<br> COMMAND1(ARGS ...)<br> COMMAND2(ARGS ...)<br> ...<br> endwhile(condition)<br></pre>
<p>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.
</li>
<li>
! <a name="command:write_file"><b><code>write_file</code></b></a>: Deprecated. Use the file(WRITE ) command instead.<br>
<pre> write_file(filename "message to write"... [APPEND])<br></pre>
<p>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.<br><p>NOTE 1: file(WRITE ... and file(APPEND ... do exactly the same as this one but add some more functionality.<br><p>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.
***************
*** 579,599 ****
<h2><a name="section_See Also"/>See Also</h2>
<ul>
! <li><a href="#command_Home Page"><b><code>Home Page</code></b></a></li> <li><a href="#command_Frequently Asked Questions"><b><code>Frequently Asked Questions</code></b></a></li> <li><a href="#command_Online Documentation"><b><code>Online Documentation</code></b></a></li> <li><a href="#command_Mailing List"><b><code>Mailing List</code></b></a></li></ul>
<p>The following resources are available to get help using CMake:
<ul>
<li>
! <a name="command_Home Page"><b><code>Home Page</code></b></a>: <a href="http://www.cmake.org">http://www.cmake.org</a><br>
<p>The primary starting point for learning about CMake.
</li>
<li>
! <a name="command_Frequently Asked Questions"><b><code>Frequently Asked Questions</code></b></a>: <a href="http://www.cmake.org/Wiki/CMake_FAQ">http://www.cmake.org/Wiki/CMake_FAQ</a><br>
<p>A Wiki is provided containing answers to frequently asked questions.
</li>
<li>
! <a name="command_Online Documentation"><b><code>Online Documentation</code></b></a>: <a href="http://www.cmake.org/HTML/Documentation.html">http://www.cmake.org/HTML/Documentation.html</a><br>
<p>Links to available documentation may be found on this web page.
</li>
<li>
! <a name="command_Mailing List"><b><code>Mailing List</code></b></a>: <a href="http://www.cmake.org/HTML/MailingLists.html">http://www.cmake.org/HTML/MailingLists.html</a><br>
<p>For help and discussion about using cmake, a mailing list is provided at cmake at 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 <a href="http://www.cmake.org">http://www.cmake.org</a> before posting questions to the list.
</li>
--- 579,599 ----
<h2><a name="section_See Also"/>See Also</h2>
<ul>
! <li><a href="#see:HomePage"><b><code>Home Page</code></b></a></li> <li><a href="#see:FrequentlyAskedQuestions"><b><code>Frequently Asked Questions</code></b></a></li> <li><a href="#see:OnlineDocumentation"><b><code>Online Documentation</code></b></a></li> <li><a href="#see:MailingList"><b><code>Mailing List</code></b></a></li></ul>
<p>The following resources are available to get help using CMake:
<ul>
<li>
! <a name="see:HomePage"><b><code>Home Page</code></b></a>: <a href="http://www.cmake.org">http://www.cmake.org</a><br>
<p>The primary starting point for learning about CMake.
</li>
<li>
! <a name="see:FrequentlyAskedQuestions"><b><code>Frequently Asked Questions</code></b></a>: <a href="http://www.cmake.org/Wiki/CMake_FAQ">http://www.cmake.org/Wiki/CMake_FAQ</a><br>
<p>A Wiki is provided containing answers to frequently asked questions.
</li>
<li>
! <a name="see:OnlineDocumentation"><b><code>Online Documentation</code></b></a>: <a href="http://www.cmake.org/HTML/Documentation.html">http://www.cmake.org/HTML/Documentation.html</a><br>
<p>Links to available documentation may be found on this web page.
</li>
<li>
! <a name="see:MailingList"><b><code>Mailing List</code></b></a>: <a href="http://www.cmake.org/HTML/MailingLists.html">http://www.cmake.org/HTML/MailingLists.html</a><br>
<p>For help and discussion about using cmake, a mailing list is provided at cmake at 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 <a href="http://www.cmake.org">http://www.cmake.org</a> before posting questions to the list.
</li>
Index: cpack-2-6.html
===================================================================
RCS file: /cvsroot/CMake/CMakeWeb/HTML/cpack-2-6.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -C 2 -d -r1.1 -r1.2
*** cpack-2-6.html 1 Apr 2008 21:09:29 -0000 1.1
--- cpack-2-6.html 6 May 2008 14:50:34 -0000 1.2
***************
*** 30,49 ****
<h2><a name="section_Options"/>Options</h2>
<ul>
! <li><a href="#command_-G <generator>"><b><code>-G <generator></code></b></a></li> <li><a href="#command_-C <Configuration>"><b><code>-C <Configuration></code></b></a></li> <li><a href="#command_-D <var>=<value>"><b><code>-D <var>=<value></code></b></a></li> <li><a href="#command_--config <config file>"><b><code>--config <config file></code></b></a></li></ul>
<ul>
<li>
! <a name="command_-G <generator>"><b><code>-G <generator></code></b></a>: Use the specified generator to generate package.<br>
<p>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.
</li>
<li>
! <a name="command_-C <Configuration>"><b><code>-C <Configuration></code></b></a>: Specify the project configuration<br>
<p>This option specifies the configuration that the project was build with, for example 'Debug', 'Release'.
</li>
<li>
! <a name="command_-D <var>=<value>"><b><code>-D <var>=<value></code></b></a>: Set a CPack variable.<br>
<p>Set a variable that can be used by the generator.
</li>
<li>
! <a name="command_--config <config file>"><b><code>--config <config file></code></b></a>: Specify the config file.<br>
<p>Specify the config file to use to create the package. By default CPackConfig.cmake in the current directory will be used.
</li>
--- 30,49 ----
<h2><a name="section_Options"/>Options</h2>
<ul>
! <li><a href="#opt:-Ggenerator"><b><code>-G <generator></code></b></a></li> <li><a href="#opt:-CConfiguration"><b><code>-C <Configuration></code></b></a></li> <li><a href="#opt:-Dvarvalue"><b><code>-D <var>=<value></code></b></a></li> <li><a href="#opt:--configconfigfile"><b><code>--config <config file></code></b></a></li></ul>
<ul>
<li>
! <a name="opt:-Ggenerator"><b><code>-G <generator></code></b></a>: Use the specified generator to generate package.<br>
<p>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.
</li>
<li>
! <a name="opt:-CConfiguration"><b><code>-C <Configuration></code></b></a>: Specify the project configuration<br>
<p>This option specifies the configuration that the project was build with, for example 'Debug', 'Release'.
</li>
<li>
! <a name="opt:-Dvarvalue"><b><code>-D <var>=<value></code></b></a>: Set a CPack variable.<br>
<p>Set a variable that can be used by the generator.
</li>
<li>
! <a name="opt:--configconfigfile"><b><code>--config <config file></code></b></a>: Specify the config file.<br>
<p>Specify the config file to use to create the package. By default CPackConfig.cmake in the current directory will be used.
</li>
***************
*** 51,73 ****
<h2><a name="section_Generators"/>Generators</h2>
<ul>
! <li><a href="#command_NSIS"><b><code>NSIS</code></b></a></li> <li><a href="#command_STGZ"><b><code>STGZ</code></b></a></li> <li><a href="#command_TBZ2"><b><code>TBZ2</code></b></a></li> <li><a href="#command_TGZ"><b><code>TGZ</code></b></a></li> <li><a href="#command_TZ"><b><code>TZ</code></b></a></li> <li><a href="#command_ZIP"><b><code>ZIP</code></b></a></li></ul>
<ul>
<li>
! <a name="command_NSIS"><b><code>NSIS</code></b></a>: Null Soft Installer
</li>
<li>
! <a name="command_STGZ"><b><code>STGZ</code></b></a>: Self extracting Tar GZip compression
</li>
<li>
! <a name="command_TBZ2"><b><code>TBZ2</code></b></a>: Tar BZip2 compression
</li>
<li>
! <a name="command_TGZ"><b><code>TGZ</code></b></a>: Tar GZip compression
</li>
<li>
! <a name="command_TZ"><b><code>TZ</code></b></a>: Tar Compress compression
</li>
<li>
! <a name="command_ZIP"><b><code>ZIP</code></b></a>: ZIP file format
</li>
</ul>
--- 51,73 ----
<h2><a name="section_Generators"/>Generators</h2>
<ul>
! <li><a href="#gen:NSIS"><b><code>NSIS</code></b></a></li> <li><a href="#gen:STGZ"><b><code>STGZ</code></b></a></li> <li><a href="#gen:TBZ2"><b><code>TBZ2</code></b></a></li> <li><a href="#gen:TGZ"><b><code>TGZ</code></b></a></li> <li><a href="#gen:TZ"><b><code>TZ</code></b></a></li> <li><a href="#gen:ZIP"><b><code>ZIP</code></b></a></li></ul>
<ul>
<li>
! <a name="gen:NSIS"><b><code>NSIS</code></b></a>: Null Soft Installer
</li>
<li>
! <a name="gen:STGZ"><b><code>STGZ</code></b></a>: Self extracting Tar GZip compression
</li>
<li>
! <a name="gen:TBZ2"><b><code>TBZ2</code></b></a>: Tar BZip2 compression
</li>
<li>
! <a name="gen:TGZ"><b><code>TGZ</code></b></a>: Tar GZip compression
</li>
<li>
! <a name="gen:TZ"><b><code>TZ</code></b></a>: Tar Compress compression
</li>
<li>
! <a name="gen:ZIP"><b><code>ZIP</code></b></a>: ZIP file format
</li>
</ul>
***************
*** 99,119 ****
<h2><a name="section_See Also"/>See Also</h2>
<ul>
! <li><a href="#command_Home Page"><b><code>Home Page</code></b></a></li> <li><a href="#command_Frequently Asked Questions"><b><code>Frequently Asked Questions</code></b></a></li> <li><a href="#command_Online Documentation"><b><code>Online Documentation</code></b></a></li> <li><a href="#command_Mailing List"><b><code>Mailing List</code></b></a></li></ul>
<p>The following resources are available to get help using CMake:
<ul>
<li>
! <a name="command_Home Page"><b><code>Home Page</code></b></a>: <a href="http://www.cmake.org">http://www.cmake.org</a><br>
<p>The primary starting point for learning about CMake.
</li>
<li>
! <a name="command_Frequently Asked Questions"><b><code>Frequently Asked Questions</code></b></a>: <a href="http://www.cmake.org/Wiki/CMake_FAQ">http://www.cmake.org/Wiki/CMake_FAQ</a><br>
<p>A Wiki is provided containing answers to frequently asked questions.
</li>
<li>
! <a name="command_Online Documentation"><b><code>Online Documentation</code></b></a>: <a href="http://www.cmake.org/HTML/Documentation.html">http://www.cmake.org/HTML/Documentation.html</a><br>
<p>Links to available documentation may be found on this web page.
</li>
<li>
! <a name="command_Mailing List"><b><code>Mailing List</code></b></a>: <a href="http://www.cmake.org/HTML/MailingLists.html">http://www.cmake.org/HTML/MailingLists.html</a><br>
<p>For help and discussion about using cmake, a mailing list is provided at cmake at 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 <a href="http://www.cmake.org">http://www.cmake.org</a> before posting questions to the list.
</li>
--- 99,119 ----
<h2><a name="section_See Also"/>See Also</h2>
<ul>
! <li><a href="#see:HomePage"><b><code>Home Page</code></b></a></li> <li><a href="#see:FrequentlyAskedQuestions"><b><code>Frequently Asked Questions</code></b></a></li> <li><a href="#see:OnlineDocumentation"><b><code>Online Documentation</code></b></a></li> <li><a href="#see:MailingList"><b><code>Mailing List</code></b></a></li></ul>
<p>The following resources are available to get help using CMake:
<ul>
<li>
! <a name="see:HomePage"><b><code>Home Page</code></b></a>: <a href="http://www.cmake.org">http://www.cmake.org</a><br>
<p>The primary starting point for learning about CMake.
</li>
<li>
! <a name="see:FrequentlyAskedQuestions"><b><code>Frequently Asked Questions</code></b></a>: <a href="http://www.cmake.org/Wiki/CMake_FAQ">http://www.cmake.org/Wiki/CMake_FAQ</a><br>
<p>A Wiki is provided containing answers to frequently asked questions.
</li>
<li>
! <a name="see:OnlineDocumentation"><b><code>Online Documentation</code></b></a>: <a href="http://www.cmake.org/HTML/Documentation.html">http://www.cmake.org/HTML/Documentation.html</a><br>
<p>Links to available documentation may be found on this web page.
</li>
<li>
! <a name="see:MailingList"><b><code>Mailing List</code></b></a>: <a href="http://www.cmake.org/HTML/MailingLists.html">http://www.cmake.org/HTML/MailingLists.html</a><br>
<p>For help and discussion about using cmake, a mailing list is provided at cmake at 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 <a href="http://www.cmake.org">http://www.cmake.org</a> before posting questions to the list.
</li>
More information about the Cmake-commits
mailing list