diff options
Diffstat (limited to 'doc/html/boost/program_options/basic_command_line_parser.html')
| -rw-r--r--[-rwxr-xr-x] | doc/html/boost/program_options/basic_command_line_parser.html | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/doc/html/boost/program_options/basic_command_line_parser.html b/doc/html/boost/program_options/basic_command_line_parser.html index e25fde6a86..b65dcfc513 100755..100644 --- a/doc/html/boost/program_options/basic_command_line_parser.html +++ b/doc/html/boost/program_options/basic_command_line_parser.html @@ -6,7 +6,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> -<link rel="prev" href="basic_parsed_options_wc_id1074553.html" title="Class basic_parsed_options<wchar_t>"> +<link rel="prev" href="basic_parsed_opti_id790649.html" title="Class basic_parsed_options<wchar_t>"> <link rel="next" href="collect_unrecognized_mode.html" title="Type collect_unrecognized_mode"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -20,7 +20,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_parsed_options_wc_id1074553.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp"><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="collect_unrecognized_mode.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_parsed_opti_id790649.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp"><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="collect_unrecognized_mode.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.basic_command_line_parser"></a><div class="titlepage"></div> @@ -35,71 +35,71 @@ <span class="keyword">class</span> <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="basic_command_line_parser.html#boost.program_options.basic_command_line_parserconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_command_line_parser.html#id1171711-bb"><span class="identifier">basic_command_line_parser</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_command_line_parser.html#id1161394-bb"><span class="identifier">basic_command_line_parser</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html#id1139901-bb"><span class="identifier">basic_command_line_parser</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html#id1155729-bb"><span class="identifier">basic_command_line_parser</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_command_line_parser.html#id1074665-bb">public member functions</a></span> - <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#id1074668-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_command_line_parser.html#id1181603-bb">public member functions</a></span> + <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#id1181606-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> - <a class="link" href="basic_command_line_parser.html#id1163295-bb"><span class="identifier">positional</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="positional_options_desc_id1150344.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#id1156102-bb"><span class="identifier">style</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#id1157721-bb"><span class="identifier">extra_parser</span></a><span class="special">(</span><span class="identifier">ext_parser</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <a class="link" href="basic_command_line_parser.html#id1157739-bb"><span class="identifier">run</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#id1160210-bb"><span class="identifier">allow_unregistered</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#id1171697-bb"><span class="identifier">extra_style_parser</span></a><span class="special">(</span><span class="identifier">style_parser</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html#id1160652-bb"><span class="identifier">positional</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="positional_option_id789522.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#id1160674-bb"><span class="identifier">style</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#id1160691-bb"><span class="identifier">extra_parser</span></a><span class="special">(</span><span class="identifier">ext_parser</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <a class="link" href="basic_command_line_parser.html#id1139855-bb"><span class="identifier">run</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#id1139869-bb"><span class="identifier">allow_unregistered</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#id1139887-bb"><span class="identifier">extra_style_parser</span></a><span class="special">(</span><span class="identifier">style_parser</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="id2521294"></a><h2>Description</h2> +<a name="id2572677"></a><h2>Description</h2> <p>Command line parser.</p> <p>The class allows one to specify all the information needed for parsing and to parse the command line. It is primarily needed to emulate named function parameters -- a regular function with 5 parameters will be hard to use and creating overloads with a smaller nuber of parameters will be confusing.</p> <p>For the most common case, the function parse_command_line is a better alternative.</p> <p>There are two typedefs -- command_line_parser and wcommand_line_parser, for charT == char and charT == wchar_t cases. </p> <div class="refsect2"> -<a name="id2521316"></a><h3> +<a name="id2572698"></a><h3> <a name="boost.program_options.basic_command_line_parserconstruct-copy-destruct"></a><code class="computeroutput">basic_command_line_parser</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="id1171711-bb"></a><span class="identifier">basic_command_line_parser</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">></span> <span class="special">&</span> args<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="id1139901-bb"></a><span class="identifier">basic_command_line_parser</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">></span> <span class="special">&</span> args<span class="special">)</span><span class="special">;</span></pre> <p>Creates a command line parser for the specified arguments list. The 'args' parameter should not include program name. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="id1161394-bb"></a><span class="identifier">basic_command_line_parser</span><span class="special">(</span><span class="keyword">int</span> argc<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> argv<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="id1155729-bb"></a><span class="identifier">basic_command_line_parser</span><span class="special">(</span><span class="keyword">int</span> argc<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> argv<span class="special">)</span><span class="special">;</span></pre> <p>Creates a command line parser for the specified arguments list. The parameters should be the same as passed to 'main'. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="id2521502"></a><h3> -<a name="id1074665-bb"></a><code class="computeroutput">basic_command_line_parser</code> public member functions</h3> +<a name="id2572883"></a><h3> +<a name="id1181603-bb"></a><code class="computeroutput">basic_command_line_parser</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="id1074668-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> desc<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="id1181606-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> desc<span class="special">)</span><span class="special">;</span></pre> <p>Sets options descriptions to use. </p> </li> <li class="listitem"> <pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> -<a name="id1163295-bb"></a><span class="identifier">positional</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="positional_options_desc_id1150344.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span> desc<span class="special">)</span><span class="special">;</span></pre> +<a name="id1160652-bb"></a><span class="identifier">positional</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="positional_option_id789522.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span> desc<span class="special">)</span><span class="special">;</span></pre> <p>Sets positional options description to use. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="id1156102-bb"></a><span class="identifier">style</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="id1160674-bb"></a><span class="identifier">style</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span></pre> <p>Sets the command line style. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="id1157721-bb"></a><span class="identifier">extra_parser</span><span class="special">(</span><span class="identifier">ext_parser</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="id1160691-bb"></a><span class="identifier">extra_parser</span><span class="special">(</span><span class="identifier">ext_parser</span><span class="special">)</span><span class="special">;</span></pre> <p>Sets the extra parsers. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <a name="id1157739-bb"></a><span class="identifier">run</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <a name="id1139855-bb"></a><span class="identifier">run</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Parses the options and returns the result of parsing. Throws on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="id1160210-bb"></a><span class="identifier">allow_unregistered</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="id1139869-bb"></a><span class="identifier">allow_unregistered</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Specifies that unregistered options are allowed and should be passed though. For each command like token that looks like an option but does not contain a recognized name, an instance of basic_option<charT> will be added to result, with 'unrecognized' field set to 'true'. It's possible to collect all unrecognized options with the 'collect_unrecognized' funciton. </p> </li> -<li class="listitem"><pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="id1171697-bb"></a><span class="identifier">extra_style_parser</span><span class="special">(</span><span class="identifier">style_parser</span> s<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="id1139887-bb"></a><span class="identifier">extra_style_parser</span><span class="special">(</span><span class="identifier">style_parser</span> s<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> </div> @@ -114,7 +114,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_parsed_options_wc_id1074553.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp"><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="collect_unrecognized_mode.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_parsed_opti_id790649.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp"><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="collect_unrecognized_mode.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |