1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Summary of run-time parameters</title> 5<link rel="stylesheet" href="../../boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../index.html" title="Boost.Test"> 8<link rel="up" href="../runtime_config.html" title="Runtime parameters"> 9<link rel="prev" href="custom_command_line_arguments.html" title="Custom command line arguments"> 10<link rel="next" href="../adv_scenarios.html" title="Advanced Usage Scenarios"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="custom_command_line_arguments.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../runtime_config.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../adv_scenarios.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_test.runtime_config.summary"></a><a class="link" href="summary.html" title="Summary of run-time parameters">Summary of run-time 28 parameters</a> 29</h3></div></div></div> 30<div class="informaltable"><table class="table"> 31<colgroup> 32<col> 33<col> 34</colgroup> 35<thead><tr> 36<th> 37 <p> 38 Command 39 </p> 40 </th> 41<th> 42 <p> 43 Short description 44 </p> 45 </th> 46</tr></thead> 47<tbody> 48<tr> 49<td> 50 <p> 51 <a class="link" href="../utf_reference/rt_param_reference/auto_dbg.html" title="auto_start_dbg"><code class="computeroutput"><span class="identifier">auto_start_dbg</span></code></a> 52 </p> 53 </td> 54<td> 55 <p> 56 Instructs the framework to automatically attach debugger in case 57 of system failure. 58 </p> 59 </td> 60</tr> 61<tr> 62<td> 63 <p> 64 <a class="link" href="../utf_reference/rt_param_reference/build_info.html" title="build_info"><code class="computeroutput"><span class="identifier">build_info</span></code></a> 65 </p> 66 </td> 67<td> 68 <p> 69 Instructs the framework to display library build information. 70 </p> 71 </td> 72</tr> 73<tr> 74<td> 75 <p> 76 <a class="link" href="../utf_reference/rt_param_reference/catch_system.html" title="catch_system_errors"><code class="computeroutput"><span class="identifier">catch_system_error</span></code></a> 77 </p> 78 </td> 79<td> 80 <p> 81 Instructs the framework to catch system errors. 82 </p> 83 </td> 84</tr> 85<tr> 86<td> 87 <p> 88 <a class="link" href="../utf_reference/rt_param_reference/color_output.html" title="color_output"><code class="computeroutput"><span class="identifier">color_output</span></code></a> 89 </p> 90 </td> 91<td> 92 <p> 93 Instructs the framework to produce color output 94 </p> 95 </td> 96</tr> 97<tr> 98<td> 99 <p> 100 <a class="link" href="../utf_reference/rt_param_reference/detect_fp_exceptions.html" title="detect_fp_exceptions"><code class="computeroutput"><span class="identifier">detect_fp_exceptions</span></code></a> 101 </p> 102 </td> 103<td> 104 <p> 105 Instructs the framework to trap floating point exceptions (on supported 106 platforms). 107 </p> 108 </td> 109</tr> 110<tr> 111<td> 112 <p> 113 <a class="link" href="../utf_reference/rt_param_reference/detect_memory_leaks.html" title="detect_memory_leaks"><code class="computeroutput"><span class="identifier">detect_memory_leaks</span></code></a> 114 </p> 115 </td> 116<td> 117 <p> 118 Instructs the framework to detect memory leaks (on supported platforms). 119 </p> 120 </td> 121</tr> 122<tr> 123<td> 124 <p> 125 <a class="link" href="../utf_reference/rt_param_reference/help.html" title="help"><code class="computeroutput"><span class="identifier">help</span></code></a> 126 </p> 127 </td> 128<td> 129 <p> 130 Provides help on the <span class="emphasis"><em>Unit Test Framework</em></span> parameters. 131 </p> 132 </td> 133</tr> 134<tr> 135<td> 136 <p> 137 <a class="link" href="../utf_reference/rt_param_reference/list_content.html" title="list_content"><code class="computeroutput"><span class="identifier">list_content</span></code></a> 138 </p> 139 </td> 140<td> 141 <p> 142 Lists the tests units, their organization in the test tree, their 143 enabled/disabled state... 144 </p> 145 </td> 146</tr> 147<tr> 148<td> 149 <p> 150 <a class="link" href="../utf_reference/rt_param_reference/list_labels.html" title="list_labels"><code class="computeroutput"><span class="identifier">list_labels</span></code></a> 151 </p> 152 </td> 153<td> 154 <p> 155 Lists the labels defined in the test module. 156 </p> 157 </td> 158</tr> 159<tr> 160<td> 161 <p> 162 <a class="link" href="../utf_reference/rt_param_reference/log_format.html" title="log_format"><code class="computeroutput"><span class="identifier">log_format</span></code></a> 163 </p> 164 </td> 165<td> 166 <p> 167 Specifies the log format 168 </p> 169 </td> 170</tr> 171<tr> 172<td> 173 <p> 174 <a class="link" href="../utf_reference/rt_param_reference/log_level.html" title="log_level"><code class="computeroutput"><span class="identifier">log_level</span></code></a> 175 </p> 176 </td> 177<td> 178 <p> 179 Specifies the framework's logging level 180 </p> 181 </td> 182</tr> 183<tr> 184<td> 185 <p> 186 <a class="link" href="../utf_reference/rt_param_reference/log_sink.html" title="log_sink"><code class="computeroutput"><span class="identifier">log_sink</span></code></a> 187 </p> 188 </td> 189<td> 190 <p> 191 Specifies where to write testing log to. 192 </p> 193 </td> 194</tr> 195<tr> 196<td> 197 <p> 198 <a class="link" href="../utf_reference/rt_param_reference/logger.html" title="logger"><code class="computeroutput"><span class="identifier">logger</span></code></a> 199 </p> 200 </td> 201<td> 202 <p> 203 Specifies the log level, format and sink of one or more loggers. 204 </p> 205 </td> 206</tr> 207<tr> 208<td> 209 <p> 210 <a class="link" href="../utf_reference/rt_param_reference/output_format.html" title="output_format"><code class="computeroutput"><span class="identifier">output_format</span></code></a> 211 </p> 212 </td> 213<td> 214 <p> 215 Specifies the log format and the report format. 216 </p> 217 </td> 218</tr> 219<tr> 220<td> 221 <p> 222 <a class="link" href="../utf_reference/rt_param_reference/random.html" title="random"><code class="computeroutput"><span class="identifier">random</span></code></a> 223 </p> 224 </td> 225<td> 226 <p> 227 Instructs the framework to run the tests in random order 228 </p> 229 </td> 230</tr> 231<tr> 232<td> 233 <p> 234 <a class="link" href="../utf_reference/rt_param_reference/report_format.html" title="report_format"><code class="computeroutput"><span class="identifier">report_format</span></code></a> 235 </p> 236 </td> 237<td> 238 <p> 239 Specifies the report format. 240 </p> 241 </td> 242</tr> 243<tr> 244<td> 245 <p> 246 <a class="link" href="../utf_reference/rt_param_reference/report_level.html" title="report_level"><code class="computeroutput"><span class="identifier">report_level</span></code></a> 247 </p> 248 </td> 249<td> 250 <p> 251 Specifies the level of details carried by the framework's testing 252 result report. 253 </p> 254 </td> 255</tr> 256<tr> 257<td> 258 <p> 259 <a class="link" href="../utf_reference/rt_param_reference/report_memory_leaks_to.html" title="report_memory_leaks_to"><code class="computeroutput"><span class="identifier">report_memory_leaks_to</span></code></a> 260 </p> 261 </td> 262<td> 263 <p> 264 Specifies file name where memory leaks report should be re-directed 265 to. 266 </p> 267 </td> 268</tr> 269<tr> 270<td> 271 <p> 272 <a class="link" href="../utf_reference/rt_param_reference/report_sink.html" title="report_sink"><code class="computeroutput"><span class="identifier">report_sink</span></code></a> 273 </p> 274 </td> 275<td> 276 <p> 277 Specifies where to write the testing result report to. 278 </p> 279 </td> 280</tr> 281<tr> 282<td> 283 <p> 284 <a class="link" href="../utf_reference/rt_param_reference/result_code.html" title="result_code"><code class="computeroutput"><span class="identifier">result_code</span></code></a> 285 </p> 286 </td> 287<td> 288 <p> 289 Instructs the framework to return or ignore a result code indicating 290 an error in the tests. 291 </p> 292 </td> 293</tr> 294<tr> 295<td> 296 <p> 297 <a class="link" href="../utf_reference/rt_param_reference/run_test.html" title="run_test"><code class="computeroutput"><span class="identifier">run_test</span></code></a> 298 </p> 299 </td> 300<td> 301 <p> 302 Allows to filter which test units to execute at runtime. 303 </p> 304 </td> 305</tr> 306<tr> 307<td> 308 <p> 309 <a class="link" href="../utf_reference/rt_param_reference/save_pattern.html" title="save_pattern"><code class="computeroutput"><span class="identifier">save_pattern</span></code></a> 310 </p> 311 </td> 312<td> 313 <p> 314 Facilitates mode switching for testing output streams. 315 </p> 316 </td> 317</tr> 318<tr> 319<td> 320 <p> 321 <a class="link" href="../utf_reference/rt_param_reference/show_progress.html" title="show_progress"><code class="computeroutput"><span class="identifier">show_progress</span></code></a> 322 </p> 323 </td> 324<td> 325 <p> 326 Instructs the framework to print progress information. More details 327 <a class="link" href="../test_output/test_output_progress.html" title="Progress display">here</a>. 328 </p> 329 </td> 330</tr> 331<tr> 332<td> 333 <p> 334 <a class="link" href="../utf_reference/rt_param_reference/use_alt_stack.html" title="use_alt_stack"><code class="computeroutput"><span class="identifier">use_alt_stack</span></code></a> 335 </p> 336 </td> 337<td> 338 <p> 339 Instructs the framework to use an alternative stack for signal 340 processing (on supported platforms). 341 </p> 342 </td> 343</tr> 344<tr> 345<td> 346 <p> 347 <a class="link" href="../utf_reference/rt_param_reference/usage.html" title="usage"><code class="computeroutput"><span class="identifier">usage</span></code></a> 348 </p> 349 </td> 350<td> 351 <p> 352 Displays short usage message. 353 </p> 354 </td> 355</tr> 356<tr> 357<td> 358 <p> 359 <a class="link" href="../utf_reference/rt_param_reference/wait_for_debugger.html" title="wait_for_debugger"><code class="computeroutput"><span class="identifier">wait_for_debugger</span></code></a> 360 </p> 361 </td> 362<td> 363 <p> 364 Instructs the framework to pause test module before testing is 365 started to allow debugger to attach. 366 </p> 367 </td> 368</tr> 369</tbody> 370</table></div> 371</div> 372<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 373<td align="left"></td> 374<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<p> 375 Distributed under the Boost Software License, Version 1.0. (See accompanying 376 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 377 </p> 378</div></td> 379</tr></table> 380<hr> 381<div class="spirit-nav"> 382<a accesskey="p" href="custom_command_line_arguments.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../runtime_config.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../adv_scenarios.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 383</div> 384</body> 385</html> 386
