devn00b
/
EQ2EMu


			
				
					
						
						
							12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
							<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>help</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Boost.Test">
<link rel="up" href="../rt_param_reference.html" title="Runtime parameters reference">
<link rel="prev" href="detect_memory_leaks.html" title="detect_memory_leaks">
<link rel="next" href="list_content.html" title="list_content">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="detect_memory_leaks.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rt_param_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="list_content.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_test.utf_reference.rt_param_reference.help"></a><a class="link" href="help.html" title="help"><code class="computeroutput"><span class="identifier">help</span></code></a>
</h4></div></div></div>
<p>
          Parameter <span class="emphasis"><em>help</em></span> displays help on the framework's parameters.
          The parameter accepts an optional argument value:
        </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
              if present, the argument value is interpreted as a parameter name.
              Name guessing works as well (so for example <code class="computeroutput"><span class="special">--</span><span class="identifier">help</span><span class="special">=</span><span class="identifier">rand</span></code> displays help on the parameter
              <code class="computeroutput"><span class="identifier">random</span></code>).
            </li>
<li class="listitem">
              if the parameter name is unknown or ambiguous, an error is reported,
            </li>
<li class="listitem">
              if the argument value is absent, a summary of all framework's parameter
              is displayed.
            </li>
</ul></div>
<h5>
<a name="boost_test.utf_reference.rt_param_reference.help.h0"></a>
          <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.help.acceptable_values"></a></span><a class="link" href="help.html#boost_test.utf_reference.rt_param_reference.help.acceptable_values">Acceptable
          values</a>
        </h5>
<p>
          An optional parameter name <a class="link" href="../rt_param_reference.html#regular_param_value">string</a>.
        </p>
<h5>
<a name="boost_test.utf_reference.rt_param_reference.help.h1"></a>
          <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.help.command_line_syntax"></a></span><a class="link" href="help.html#boost_test.utf_reference.rt_param_reference.help.command_line_syntax">Command
          line syntax</a>
        </h5>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
              <code class="computeroutput"><span class="special">--</span><span class="identifier">help</span><span class="special">[=&lt;</span><span class="identifier">parameter</span>
              <span class="identifier">name</span><span class="special">&gt;]</span></code>
            </li></ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
      contributors<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="detect_memory_leaks.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rt_param_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="list_content.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>