1ctest(1) General Commands Manual ctest(1)
2
6 ctest - Testing driver provided by CMake.
7
9 ctest [options]
10
12 The "ctest" executable is the CMake test driver program. CMake-gener‐
13 ated build trees created for projects that use the ENABLE_TESTING and
14 ADD_TEST commands have testing support. This program will run the
15 tests and report results.
16
19 -C <cfg>, --build-config <cfg>
20 Choose configuration to test.
21 Some CMake-generated build trees can have multiple build config‐
23 urations in the same tree. This option can be used to specify
24 which one should be tested. Example configurations are "Debug"
25 and "Release".
26 -V,--verbose
29 Enable verbose output from tests.
30 Test output is normally suppressed and only summary information
32 is displayed. This option will show all test output.
33 -VV,--extra-verbose
36 Enable more verbose output from tests.
37 Test output is normally suppressed and only summary information
39 is displayed. This option will show even more test output.
40 --debug
43 Displaying more verbose internals of CTest.
44 This feature will result in large number of output that is
46 mostly useful for debugging dashboard problems.
47 -Q,--quiet
50 Make ctest quiet.
51 This option will suppress all the output. The output log file
53 will still be generated if the --output-log is specified.
54 Options such as --verbose, --extra-verbose, and --debug are
55 ignored if --quiet is specified.
56 -O <file>, --output-log <file>
59 Output to log file
60 This option tells ctest to write all its output to a log file.
62 -N,--show-only
65 Disable actual execution of tests.
66 This option tells ctest to list the tests that would be run but
68 not actually run them. Useful in conjunction with the -R and -E
69 options.
70 -R <regex>, --tests-regex <regex>
73 Run tests matching regular expression.
74 This option tells ctest to run only the tests whose names match
76 the given regular expression.
77 -E <regex>, --exclude-regex <regex>
80 Exclude tests matching regular expression.
81 This option tells ctest to NOT run the tests whose names match
83 the given regular expression.
84 -D <dashboard>, --dashboard <dashboard>
87 Execute dashboard test
88 This option tells ctest to perform act as a Dart client and per‐
90 form a dashboard test. All tests are <Mode><Test>, where Mode
91 can be Experimental, Nightly, and Continuous, and Test can be
92 Start, Update, Configure, Build, Test, Coverage, and Submit.
93 -M <model>, --test-model <model>
96 Sets the model for a dashboard
97 This option tells ctest to act as a Dart client where the Test‐
99 Model can be Experimental, Nightly, and Continuous. Combining -M
100 and -T is similar to -D
101 -T <action>, --test-action <action>
104 Sets the dashboard action to perform
105 This option tells ctest to act as a Dart client and perform some
107 action such as start, build, test etc. Combining -M and -T is
108 similar to -D
109 --track <track>
112 Specify the track to submit dashboard to
113 Submit dashboard to specified track instead of default one. By
115 default, the dashboard is submitted to Nightly, Experimental, or
116 Continuous track, but by specifying this option, the track can
117 be arbitrary.
118 -S <script>, --script <script>
121 Execute a dashboard for a configuration
122 This option tells ctest to load in a configuration script which
124 sets a number of parameters such as the binary and source direc‐
125 tories. Then ctest will do what is required to create and run a
126 dashboard. This option basically sets up a dashboard and then
127 runs ctest -D with the appropriate options.
128 -SP <script>, --script-new-process <script>
131 Execute a dashboard for a configuration
132 This option does the same operations as -S but it will do them
134 in a seperate process. This is primarily useful in cases where
135 the script may modify the environment and you do not want the
136 modified enviroment to impact other -S scripts.
137 -A <file>, --add-notes <file>
140 Add a notes file with submission
141 This option tells ctest to include a notes file when submitting
143 dashboard.
144 -I [Start,End,Stride,test#,test#|Test file], --tests-information
147 Run a specific number of tests by number.
148 This option causes ctest to run tests starting at number Start,
150 ending at number End, and incrementing by Stride. Any additional
151 numbers after Stride are considered individual test numbers.
152 Start, End,or stride can be empty. Optionally a file can be
153 given that contains the same syntax as the command line.
154 -U, --union
157 Take the Union of -I and -R
158 When both -R and -I are specified by default the intersection of
160 tests are run. By specifying -U the union of tests is run
161 instead.
162 --interactive-debug-mode [0|1]
165 Set the interactive mode to 0 or 1.
166 This option causes ctest to run tests in either an interactive
168 mode or a non-interactive mode. On Windows this means that in
169 non-interactive mode, all system debug pop up windows are
170 blocked. In dashboard mode (Experimental, Nightly, Continuous),
171 the default is non-interactive. When just running tests not for
172 a dashboard the default is to allow popups and interactive
173 debugging.
174 --build-and-test
177 Configure, build and run a test.
178 This option tells ctest to configure (i.e. run cmake on), build,
180 and or execute a test. The configure and test steps are
181 optional. The arguments to this command line are the source and
182 binary directories. By default this will run CMake on the
183 Source/Bin directories specified unless --build-nocmake is spec‐
184 ified. Both --build-makeprogram and --build-generator MUST be
185 provided to use --built-and-test. If --test-command is specified
186 then that will be run after the build is complete. Other options
187 that affect this mode are --build-target --build-nocmake,
188 --build-run-dir, --build-two-config, --build-exe-dir, --build-
189 project,--build-noclean, --build-options
190 --build-target
193 Specify a specific target to build.
194 This option goes with the --build-and-test option, if left out
196 the all target is built.
197 --build-nocmake
200 Run the build without running cmake first.
201 Skip the cmake step.
203 --build-run-dir
206 Specify directory to run programs from.
207 Directory where programs will be after it has been compiled.
209 --build-two-config
212 Run CMake twice
213 --build-exe-dir
216 Specify the directory for the executable.
217 --build-generator
220 Specify the generator to use.
221 --build-project
224 Specify the name of the project to build.
225 --build-makeprogram
228 Specify the make program to use.
229 --build-noclean
232 Skip the make clean step.
233 --build-options
236 Add extra options to the build step.
237 This option must be the last option with the exception of
239 --test-command
240 --test-command
243 The test to run with the --build-and-test option.
244 --tomorrow-tag
247 Nightly or experimental starts with next day tag.
248 This is useful if the build will not finish in one day.
250 --ctest-config
253 The configuration file used to initialize CTest state when sub‐
254 mitting dashboards.
255 This option tells CTest to use different initialization file
257 instead of DartConfiguration.tcl. This way multiple initializa‐
258 tion files can be used for example to submit to multiple dash‐
259 boards.
260 --overwrite
263 Overwrite CTest configuration option.
264 By default ctest uses configuration options from configuration
266 file. This option will overwrite the configuration option.
267 --extra-submit <file>[;<file>]
270 Submit extra files to the dashboard.
271 This option will submit extra files to the dashboard.
273 --force-new-ctest-process
276 Run child CTest instances as new processes
277 By default CTest will run child CTest instances within the same
279 process. If this behavior is not desired, this argument will
280 enforce new processes for child CTest processes.
281 --submit-index
284 Submit individual dashboard tests with specific index
285 This option allows performing the same CTest action (such as
287 test) multiple times and submit all stages to the same dashboard
288 (Dart2 required). Each execution requires different index.
289 --copyright [file]
292 Print the CMake copyright and exit.
293 If a file is specified, the copyright is written into it.
295 --help Print usage information and exit.
298 Usage describes the basic command line interface and its
300 options.
301 --help-full [file]
304 Print full help and exit.
305 Full help displays most of the documentation provided by the
307 UNIX man page. It is provided for use on non-UNIX platforms,
308 but is also convenient if the man page is not installed. If a
309 file is specified, the help is written into it.
310 --help-html [file]
313 Print full help in HTML format.
314 This option is used by CMake authors to help produce web pages.
316 If a file is specified, the help is written into it.
317 --help-man [file]
320 Print a UNIX man page and exit.
321 This option is used by the cmake build to generate the UNIX man
323 page. If a file is specified, the help is written into it.
324 --version [file]
327 Show program name/version banner and exit.
328 If a file is specified, the version is written into it.
330
333 The following modules are provided with CMake. They can be used with
334 INCLUDE(ModuleName).
335
338 Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights
339 reserved.
340 Redistribution and use in source and binary forms, with or without mod‐
343 ification, are permitted provided that the following conditions are
344 met:
345 * Redistributions of source code must retain the above copyright
348 notice, this list of conditions and the following disclaimer.
349 * Redistributions in binary form must reproduce the above copy‐
352 right notice, this list of conditions and the following dis‐
353 claimer in the documentation and/or other materials provided
354 with the distribution.
355 * The names of Kitware, Inc., the Insight Consortium, or the names
358 of any consortium members, or of any contributors, may not be
359 used to endorse or promote products derived from this software
360 without specific prior written permission.
361 * Modified source versions must be plainly marked as such, and
364 must not be misrepresented as being the original software.
365 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS
368 IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
369 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTIC‐
370 ULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBU‐
371 TORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEM‐
372 PLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PRO‐
373 CUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROF‐
374 ITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIA‐
375 BILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEG‐
376 LIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFT‐
377 WARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
378
381 cmake(1), ccmake(1)
382 The following resources are available to get help using CMake:
385 Home Page
388 http://www.cmake.org
389 The primary starting point for learning about CMake.
391 Frequently Asked Questions
394 http://www.cmake.org/Wiki/CMake_FAQ
395 A Wiki is provided containing answers to frequently asked ques‐
397 tions.
398 Online Documentation
401 http://www.cmake.org/HTML/Documentation.html
402 Links to available documentation may be found on this web page.
404 Mailing List
407 http://www.cmake.org/HTML/MailingLists.html
408 For help and discussion about using cmake, a mailing list is
410 provided at cmake@cmake.org. The list is member-post-only but
411 one may sign up on the CMake web page. Please first read the
412 full documentation at http://www.cmake.org before posting ques‐
413 tions to the list.
414 Summary of helpful links:
417 Home: http://www.cmake.org
420 Docs: http://www.cmake.org/HTML/Documentation.html
421 Mail: http://www.cmake.org/HTML/MailingLists.html
422 FAQ: http://www.cmake.org/Wiki/CMake_FAQ
423
426 This manual page was generated by the "--help-man" option.
427ctest 2.4-patch 8 April 24, 2008 ctest(1)