libs/test/doc/html/boost_test/utf_reference/rt_param_reference.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Runtime parameters reference</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="../utf_reference.html" title="Unit Test Framework API reference">
   9 <link rel="prev" href="testout_reference/test_output_macro_disable_type.html" title="BOOST_TEST_DONT_PRINT_LOG_VALUE">
  10 <link rel="next" href="rt_param_reference/auto_dbg.html" title="auto_start_dbg">
  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="testout_reference/test_output_macro_disable_type.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../utf_reference.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="rt_param_reference/auto_dbg.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.utf_reference.rt_param_reference"></a><a class="link" href="rt_param_reference.html" title="Runtime parameters reference">Runtime
  28       parameters reference</a>
  29 </h3></div></div></div>
  30 <div class="toc"><dl class="toc">
  31 <dt><span class="section"><a href="rt_param_reference/auto_dbg.html"><code class="computeroutput"><span class="identifier">auto_start_dbg</span></code></a></span></dt>
  32 <dt><span class="section"><a href="rt_param_reference/build_info.html"><code class="computeroutput"><span class="identifier">build_info</span></code></a></span></dt>
  33 <dt><span class="section"><a href="rt_param_reference/catch_system.html"><code class="computeroutput"><span class="identifier">catch_system_errors</span></code></a></span></dt>
  34 <dt><span class="section"><a href="rt_param_reference/color_output.html"><code class="computeroutput"><span class="identifier">color_output</span></code></a></span></dt>
  35 <dt><span class="section"><a href="rt_param_reference/detect_fp_exceptions.html"><code class="computeroutput"><span class="identifier">detect_fp_exceptions</span></code></a></span></dt>
  36 <dt><span class="section"><a href="rt_param_reference/detect_memory_leaks.html"><code class="computeroutput"><span class="identifier">detect_memory_leaks</span></code></a></span></dt>
  37 <dt><span class="section"><a href="rt_param_reference/help.html"><code class="computeroutput"><span class="identifier">help</span></code></a></span></dt>
  38 <dt><span class="section"><a href="rt_param_reference/list_content.html"><code class="computeroutput"><span class="identifier">list_content</span></code></a></span></dt>
  39 <dt><span class="section"><a href="rt_param_reference/list_labels.html"><code class="computeroutput"><span class="identifier">list_labels</span></code></a></span></dt>
  40 <dt><span class="section"><a href="rt_param_reference/log_format.html"><code class="computeroutput"><span class="identifier">log_format</span></code></a></span></dt>
  41 <dt><span class="section"><a href="rt_param_reference/log_level.html"><code class="computeroutput"><span class="identifier">log_level</span></code></a></span></dt>
  42 <dt><span class="section"><a href="rt_param_reference/log_sink.html"><code class="computeroutput"><span class="identifier">log_sink</span></code></a></span></dt>
  43 <dt><span class="section"><a href="rt_param_reference/logger.html"><code class="computeroutput"><span class="identifier">logger</span></code></a></span></dt>
  44 <dt><span class="section"><a href="rt_param_reference/output_format.html"><code class="computeroutput"><span class="identifier">output_format</span></code></a></span></dt>
  45 <dt><span class="section"><a href="rt_param_reference/random.html"><code class="computeroutput"><span class="identifier">random</span></code></a></span></dt>
  46 <dt><span class="section"><a href="rt_param_reference/report_format.html"><code class="computeroutput"><span class="identifier">report_format</span></code></a></span></dt>
  47 <dt><span class="section"><a href="rt_param_reference/report_level.html"><code class="computeroutput"><span class="identifier">report_level</span></code></a></span></dt>
  48 <dt><span class="section"><a href="rt_param_reference/report_memory_leaks_to.html"><code class="computeroutput"><span class="identifier">report_memory_leaks_to</span></code></a></span></dt>
  49 <dt><span class="section"><a href="rt_param_reference/report_sink.html"><code class="computeroutput"><span class="identifier">report_sink</span></code></a></span></dt>
  50 <dt><span class="section"><a href="rt_param_reference/result_code.html"><code class="computeroutput"><span class="identifier">result_code</span></code></a></span></dt>
  51 <dt><span class="section"><a href="rt_param_reference/run_test.html"><code class="computeroutput"><span class="identifier">run_test</span></code></a></span></dt>
  52 <dt><span class="section"><a href="rt_param_reference/save_pattern.html"><code class="computeroutput"><span class="identifier">save_pattern</span></code></a></span></dt>
  53 <dt><span class="section"><a href="rt_param_reference/show_progress.html"><code class="computeroutput"><span class="identifier">show_progress</span></code></a></span></dt>
  54 <dt><span class="section"><a href="rt_param_reference/use_alt_stack.html"><code class="computeroutput"><span class="identifier">use_alt_stack</span></code></a></span></dt>
  55 <dt><span class="section"><a href="rt_param_reference/usage.html"><code class="computeroutput"><span class="identifier">usage</span></code></a></span></dt>
  56 <dt><span class="section"><a href="rt_param_reference/wait_for_debugger.html"><code class="computeroutput"><span class="identifier">wait_for_debugger</span></code></a></span></dt>
  57 </dl></div>
  58 <p>
  59         Following sections provide detailed specification for all <span class="emphasis"><em>Unit
  60         Test Framework</em></span> runtime parameters. Each parameter specification
  61         includes:
  62       </p>
  63 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  64 <li class="listitem">
  65             The full parameter name.
  66           </li>
  67 <li class="listitem">
  68             Description of parameter semantic and default value.
  69           </li>
  70 <li class="listitem">
  71             Acceptable argument values. The default value for the parameter is bold
  72             in the acceptable values list.
  73           </li>
  74 <li class="listitem">
  75             Command line syntax. The format of all command line arguments is: <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">prefix</span><span class="special">&gt;&lt;</span><span class="identifier">name</span><span class="special">&gt;[&lt;</span><span class="identifier">separator</span><span class="special">&gt;&lt;</span><span class="identifier">value</span><span class="special">&gt;]</span></code>. For example: <code class="computeroutput"><span class="special">--</span><span class="identifier">param</span><span class="special">=&lt;</span><span class="identifier">value</span><span class="special">&gt;</span></code>.
  76             <code class="computeroutput"><span class="special">[]</span></code> around separator and
  77             value indicate that argument value is optional. For example: <code class="computeroutput"><span class="special">-</span><span class="identifier">q</span><span class="special">[</span> <span class="special">&lt;</span><span class="identifier">value</span><span class="special">&gt;]</span></code>.
  78           </li>
  79 <li class="listitem">
  80             Corresponding environment variable name.
  81           </li>
  82 </ul></div>
  83 <div class="note"><table border="0" summary="Note">
  84 <tr>
  85 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  86 <th align="left">Note</th>
  87 </tr>
  88 <tr><td align="left" valign="top">
  89 <p>
  90           All command line argument formats support parameter name guessing. What
  91           this means is that is if command like format is like this:
  92         </p>
  93 <pre class="programlisting">--long_parameter_name=&lt;value&gt;</pre>
  94 <p>
  95           you can in fact use any unambiguous prefix of the parameter name to specify
  96           the argument. For example:
  97         </p>
  98 <pre class="programlisting">--long_param=123</pre>
  99 <p>
 100           or
 101         </p>
 102 <pre class="programlisting">--long_p=123.</pre>
 103 <p>
 104           If parameter name prefix you chose is ambiguous the framework lets you
 105           know which parameters match specified prefix. For example, try
 106         </p>
 107 <pre class="programlisting">--log=all</pre>
 108 </td></tr>
 109 </table></div>
 110 <h5>
 111 <a name="boost_test.utf_reference.rt_param_reference.h0"></a>
 112         <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.parameter_value_formats"></a></span><a class="link" href="rt_param_reference.html#boost_test.utf_reference.rt_param_reference.parameter_value_formats">Parameter
 113         value formats</a>
 114       </h5>
 115 <p>
 116         The <span class="emphasis"><em>Unit Test Framework</em></span> runtime parameters take value
 117         of the following types: string, boolean, enumeration, unsigned, long. Formats
 118         required for values of these types are following:
 119       </p>
 120 <h6>
 121 <a name="boost_test.utf_reference.rt_param_reference.h1"></a>
 122         <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.string_unsigned_long"></a></span><a class="link" href="rt_param_reference.html#boost_test.utf_reference.rt_param_reference.string_unsigned_long">String,
 123         unsigned, long</a>
 124       </h6>
 125 <p>
 126         <a name="regular_param_value"></a>Values of these types are expected in the
 127         same format they are represented in C++.
 128       </p>
 129 <h6>
 130 <a name="boost_test.utf_reference.rt_param_reference.h2"></a>
 131         <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.boolean"></a></span><a class="link" href="rt_param_reference.html#boost_test.utf_reference.rt_param_reference.boolean">Boolean</a>
 132       </h6>
 133 <p>
 134         <a name="boolean_param_value"></a>Values of these types are options with
 135         yes/no or true/false meaning. True values are represented by case insensitive
 136         strings: "Y", "YES", "TRUE", "1".
 137         False values are represented by case insensitive strings: "N",
 138         "NO", "FALSE", "0".
 139       </p>
 140 <h6>
 141 <a name="boost_test.utf_reference.rt_param_reference.h3"></a>
 142         <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.enumeration"></a></span><a class="link" href="rt_param_reference.html#boost_test.utf_reference.rt_param_reference.enumeration">Enumeration</a>
 143       </h6>
 144 <p>
 145         <a name="enum_param_value"></a>Values of an enumeration type are expected
 146         as case sensitive strings representing enumeration value names. Each parameter
 147         with an enumeration value lists all valid names in a parameter`s description.
 148       </p>
 149 </div>
 150 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 151 <td align="left"></td>
 152 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
 153       contributors<p>
 154         Distributed under the Boost Software License, Version 1.0. (See accompanying
 155         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>)
 156       </p>
 157 </div></td>
 158 </tr></table>
 159 <hr>
 160 <div class="spirit-nav">
 161 <a accesskey="p" href="testout_reference/test_output_macro_disable_type.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../utf_reference.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="rt_param_reference/auto_dbg.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 162 </div>
 163 </body>
 164 </html>