1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>help</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="../rt_param_reference.html" title="Runtime parameters reference"> 9<link rel="prev" href="detect_memory_leaks.html" title="detect_memory_leaks"> 10<link rel="next" href="list_content.html" title="list_content"> 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="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> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<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> 28</h4></div></div></div> 29<p> 30 Parameter <span class="emphasis"><em>help</em></span> displays help on the framework's parameters. 31 The parameter accepts an optional argument value: 32 </p> 33<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 34<li class="listitem"> 35 if present, the argument value is interpreted as a parameter name. 36 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 37 <code class="computeroutput"><span class="identifier">random</span></code>). 38 </li> 39<li class="listitem"> 40 if the parameter name is unknown or ambiguous, an error is reported, 41 </li> 42<li class="listitem"> 43 if the argument value is absent, a summary of all framework's parameter 44 is displayed. 45 </li> 46</ul></div> 47<h5> 48<a name="boost_test.utf_reference.rt_param_reference.help.h0"></a> 49 <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 50 values</a> 51 </h5> 52<p> 53 An optional parameter name <a class="link" href="../rt_param_reference.html#regular_param_value">string</a>. 54 </p> 55<h5> 56<a name="boost_test.utf_reference.rt_param_reference.help.h1"></a> 57 <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 58 line syntax</a> 59 </h5> 60<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 61 <code class="computeroutput"><span class="special">--</span><span class="identifier">help</span><span class="special">[=<</span><span class="identifier">parameter</span> 62 <span class="identifier">name</span><span class="special">>]</span></code> 63 </li></ul></div> 64</div> 65<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 66<td align="left"></td> 67<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<p> 68 Distributed under the Boost Software License, Version 1.0. (See accompanying 69 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>) 70 </p> 71</div></td> 72</tr></table> 73<hr> 74<div class="spirit-nav"> 75<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> 76</div> 77</body> 78</html> 79
