diff options
Diffstat (limited to 'doc/html/program_options/overview.html')
| -rw-r--r-- | doc/html/program_options/overview.html | 62 |
1 files changed, 31 insertions, 31 deletions
diff --git a/doc/html/program_options/overview.html b/doc/html/program_options/overview.html index ba2e11e54b..38aa04501d 100644 --- a/doc/html/program_options/overview.html +++ b/doc/html/program_options/overview.html @@ -27,11 +27,11 @@ <div class="titlepage"><div><div><h2 class="title" style="clear: both"> <a name="program_options.overview"></a>Library Overview</h2></div></div></div> <div class="toc"><dl class="toc"> -<dt><span class="section"><a href="overview.html#idp419635344">Options Description Component</a></span></dt> -<dt><span class="section"><a href="overview.html#idp419698320">Parsers Component</a></span></dt> -<dt><span class="section"><a href="overview.html#idp419708736">Storage Component</a></span></dt> -<dt><span class="section"><a href="overview.html#idp419720112">Specific parsers</a></span></dt> -<dt><span class="section"><a href="overview.html#idp419751968">Annotated List of Symbols</a></span></dt> +<dt><span class="section"><a href="overview.html#idp438489024">Options Description Component</a></span></dt> +<dt><span class="section"><a href="overview.html#idp438551872">Parsers Component</a></span></dt> +<dt><span class="section"><a href="overview.html#idp438562288">Storage Component</a></span></dt> +<dt><span class="section"><a href="overview.html#idp438573728">Specific parsers</a></span></dt> +<dt><span class="section"><a href="overview.html#idp438605648">Annotated List of Symbols</a></span></dt> </dl></div> <p>In the tutorial section, we saw several examples of library usage. Here we will describe the overall library design including the primary @@ -75,11 +75,11 @@ </p> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp419635344"></a>Options Description Component</h3></div></div></div> +<a name="idp438489024"></a>Options Description Component</h3></div></div></div> <div class="toc"><dl class="toc"> -<dt><span class="section"><a href="overview.html#idp419662768">Syntactic Information</a></span></dt> -<dt><span class="section"><a href="overview.html#idp419681424">Semantic Information</a></span></dt> -<dt><span class="section"><a href="overview.html#idp419686016">Positional Options</a></span></dt> +<dt><span class="section"><a href="overview.html#idp438516384">Syntactic Information</a></span></dt> +<dt><span class="section"><a href="overview.html#idp438535040">Semantic Information</a></span></dt> +<dt><span class="section"><a href="overview.html#idp438539632">Positional Options</a></span></dt> </dl></div> <p>The options description component has three main classes: <code class="computeroutput"><a class="link" href="../boost/program_options/option_description.html" title="Class option_description">option_description</a></code>, <code class="computeroutput"><a class="link" href="../boost/program_options/value_semantic.html" title="Class value_semantic">value_semantic</a></code> and <code class="computeroutput"><a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a></code>. The @@ -147,8 +147,8 @@ desc.add_options() </p> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="idp419662768"></a>Syntactic Information</h4></div></div></div> -<div class="toc"><dl class="toc"><dt><span class="section"><a href="overview.html#idp419672528">Description formatting</a></span></dt></dl></div> +<a name="idp438516384"></a>Syntactic Information</h4></div></div></div> +<div class="toc"><dl class="toc"><dt><span class="section"><a href="overview.html#idp438526144">Description formatting</a></span></dt></dl></div> <p>The syntactic information is provided by the <code class="computeroutput"><a class="link" href="../boost/program_options/options_description.html" title="Class options_description">boost::program_options::options_description</a></code> class and some methods of the @@ -196,7 +196,7 @@ desc.add_options() </p> <div class="section"> <div class="titlepage"><div><div><h5 class="title"> -<a name="idp419672528"></a>Description formatting</h5></div></div></div> +<a name="idp438526144"></a>Description formatting</h5></div></div></div> <p> Sometimes the description can get rather long, for example, when several option's values need separate documentation. Below we @@ -292,7 +292,7 @@ bla bla bla bla bla bla bla bla bla bla bla bla bla bla bla"); </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="idp419681424"></a>Semantic Information</h4></div></div></div> +<a name="idp438535040"></a>Semantic Information</h4></div></div></div> <p>The semantic information is completely provided by the <code class="computeroutput"><a class="link" href="../boost/program_options/value_semantic.html" title="Class value_semantic">boost::program_options::value_semantic</a></code> class. For example: @@ -315,7 +315,7 @@ desc.add_options() </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="idp419686016"></a>Positional Options</h4></div></div></div> +<a name="idp438539632"></a>Positional Options</h4></div></div></div> <p>Our definition of option as (name, value) pairs is simple and useful, but in one special case of the command line, there's a problem. A command line can include a <em class="firstterm">positional option</em>, @@ -338,7 +338,7 @@ desc.add_options() </pre> <p> </p> -<p>The <code class="computeroutput"><a class="link" href="../boost/program_options/positional_op_idp709111376.html" title="Class positional_options_description">positional_options_description</a></code> class allows the command line +<p>The <code class="computeroutput"><a class="link" href="../boost/program_options/positional_op_idp690853936.html" title="Class positional_options_description">positional_options_description</a></code> class allows the command line parser to assign the names. The class specifies how many positional options are allowed, and for each allowed option, specifies the name. For example: </p> @@ -364,7 +364,7 @@ pd.add("output-file", 2).add("input-file", -1); <td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../doc/src/images/warning.png"></td> <th align="left">Warning</th> </tr> -<tr><td align="left" valign="top"><p>The <code class="computeroutput"><a class="link" href="../boost/program_options/positional_op_idp709111376.html" title="Class positional_options_description">positional_options_description</a></code> class only specifies translation from +<tr><td align="left" valign="top"><p>The <code class="computeroutput"><a class="link" href="../boost/program_options/positional_op_idp690853936.html" title="Class positional_options_description">positional_options_description</a></code> class only specifies translation from position to name, and the option name should still be registered with an instance of the <code class="computeroutput"><a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a></code> class.</p></td></tr> </table></div> @@ -372,7 +372,7 @@ pd.add("output-file", 2).add("input-file", -1); </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp419698320"></a>Parsers Component</h3></div></div></div> +<a name="idp438551872"></a>Parsers Component</h3></div></div></div> <p>The parsers component splits input sources into (name, value) pairs. Each parser looks for possible options and consults the options description component to determine if the option is known and how its value @@ -423,7 +423,7 @@ pd.add("output-file", 2).add("input-file", -1); </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp419708736"></a>Storage Component</h3></div></div></div> +<a name="idp438562288"></a>Storage Component</h3></div></div></div> <p>The storage component is responsible for: </p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> @@ -466,15 +466,15 @@ notify(vm); </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp419720112"></a>Specific parsers</h3></div></div></div> +<a name="idp438573728"></a>Specific parsers</h3></div></div></div> <div class="toc"><dl class="toc"> -<dt><span class="section"><a href="overview.html#idp419720784">Configuration file parser</a></span></dt> -<dt><span class="section"><a href="overview.html#idp419732624">Environment variables parser</a></span></dt> +<dt><span class="section"><a href="overview.html#idp438574400">Configuration file parser</a></span></dt> +<dt><span class="section"><a href="overview.html#idp438586240">Environment variables parser</a></span></dt> </dl></div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="idp419720784"></a>Configuration file parser</h4></div></div></div> -<p>The <code class="computeroutput"><a class="link" href="../boost/program_options/parse_config__idp709072400.html" title="Function template parse_config_file">parse_config_file</a></code> function implements parsing +<a name="idp438574400"></a>Configuration file parser</h4></div></div></div> +<p>The <code class="computeroutput"><a class="link" href="../boost/program_options/parse_config__idp690814960.html" title="Function template parse_config_file">parse_config_file</a></code> function implements parsing of simple INI-like configuration files. Configuration file syntax is line based: </p> @@ -509,7 +509,7 @@ gui.accessibility.visual_bell=yes </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="idp419732624"></a>Environment variables parser</h4></div></div></div> +<a name="idp438586240"></a>Environment variables parser</h4></div></div></div> <p><em class="firstterm">Environment variables</em> are string variables which are available to all programs via the <code class="computeroutput">getenv</code> function of C runtime library. The operating system allows to set initial values @@ -523,7 +523,7 @@ gui.accessibility.visual_bell=yes they are particularly suitable for options which apply to all programs. </p> <p>The environment variables can be parsed with the - <code class="computeroutput"><a class="link" href="../boost/program_options/parse_environ_idp709088016.html" title="Function parse_environment">parse_environment</a></code> function. The function have several overloaded + <code class="computeroutput"><a class="link" href="../boost/program_options/parse_environ_idp690830576.html" title="Function parse_environment">parse_environment</a></code> function. The function have several overloaded versions. The first parameter is always an <code class="computeroutput"><a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a></code> instance, and the second specifies what variables must be processed, and what option names must correspond to it. To describe the second @@ -537,14 +537,14 @@ gui.accessibility.visual_bell=yes name <code class="literal">proxy</code> the environment variable might be called <code class="envar">BOOST_PROXY</code>. During parsing, we need to perform reverse conversion of the names. This is accomplished by passing the choosen - prefix as the second parameter of the <code class="computeroutput"><a class="link" href="../boost/program_options/parse_environ_idp709088016.html" title="Function parse_environment">parse_environment</a></code> function. + prefix as the second parameter of the <code class="computeroutput"><a class="link" href="../boost/program_options/parse_environ_idp690830576.html" title="Function parse_environment">parse_environment</a></code> function. Say, if you pass <code class="literal">BOOST_</code> as the prefix, and there are two variables, <code class="envar">CVSROOT</code> and <code class="envar">BOOST_PROXY</code>, the first variable will be ignored, and the second one will be converted to option <code class="literal">proxy</code>. </p> <p>The above logic is sufficient in many cases, but it is also - possible to pass, as the second parameter of the <code class="computeroutput"><a class="link" href="../boost/program_options/parse_environ_idp709088016.html" title="Function parse_environment">parse_environment</a></code> + possible to pass, as the second parameter of the <code class="computeroutput"><a class="link" href="../boost/program_options/parse_environ_idp690830576.html" title="Function parse_environment">parse_environment</a></code> function, any function taking a <code class="computeroutput">std::string</code> and returning <code class="computeroutput">std::string</code>. That function will be called for each environment variable and should return either the name of the option, or @@ -554,7 +554,7 @@ gui.accessibility.visual_bell=yes </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp419751968"></a>Annotated List of Symbols</h3></div></div></div> +<a name="idp438605648"></a>Annotated List of Symbols</h3></div></div></div> <p>The following table describes all the important symbols in the library, for quick access.</p> <div class="informaltable"><table class="table" width="100%"> @@ -573,7 +573,7 @@ gui.accessibility.visual_bell=yes <td>describes a number of options</td> </tr> <tr> -<td><code class="computeroutput"><a class="link" href="../boost/program_options/value_idp709237120.html" title="Function value">value</a></code></td> +<td><code class="computeroutput"><a class="link" href="../boost/program_options/value_idp690979680.html" title="Function value">value</a></code></td> <td>defines the option's value</td> </tr> <tr><td colspan="2">Parsers component</td></tr> @@ -586,11 +586,11 @@ gui.accessibility.visual_bell=yes <td>parses command line (extended interface)</td> </tr> <tr> -<td><code class="computeroutput"><a class="link" href="../boost/program_options/parse_config__idp709072400.html" title="Function template parse_config_file">parse_config_file</a></code></td> +<td><code class="computeroutput"><a class="link" href="../boost/program_options/parse_config__idp690814960.html" title="Function template parse_config_file">parse_config_file</a></code></td> <td>parses config file</td> </tr> <tr> -<td><code class="computeroutput"><a class="link" href="../boost/program_options/parse_environ_idp709088016.html" title="Function parse_environment">parse_environment</a></code></td> +<td><code class="computeroutput"><a class="link" href="../boost/program_options/parse_environ_idp690830576.html" title="Function parse_environment">parse_environment</a></code></td> <td>parses environment</td> </tr> <tr><td colspan="2">Storage component</td></tr> |