diff options
| author | DongHun Kwak <dh0128.kwak@samsung.com> | 2016-10-06 10:30:07 +0900 |
|---|---|---|
| committer | DongHun Kwak <dh0128.kwak@samsung.com> | 2016-10-06 10:32:57 +0900 |
| commit | 71d216b90256936a9638f325af9bc69d720e75de (patch) | |
| tree | 9c5f682d341c7c88ad0c8e3d4b262e00b6fb691a /doc/html/program_options | |
| parent | 733b5d5ae2c5d625211e2985ac25728ac3f54883 (diff) | |
| download | boost-71d216b90256936a9638f325af9bc69d720e75de.tar.gz boost-71d216b90256936a9638f325af9bc69d720e75de.tar.bz2 boost-71d216b90256936a9638f325af9bc69d720e75de.zip | |
Imported Upstream version 1.59.0
Change-Id: I2dde00f4eca71df3eea9d251dcaecde18a6c90a5
Signed-off-by: DongHun Kwak <dh0128.kwak@samsung.com>
Diffstat (limited to 'doc/html/program_options')
| -rw-r--r-- | doc/html/program_options/design.html | 17 | ||||
| -rw-r--r-- | doc/html/program_options/howto.html | 89 | ||||
| -rw-r--r-- | doc/html/program_options/overview.html | 103 | ||||
| -rw-r--r-- | doc/html/program_options/reference.html | 35 | ||||
| -rw-r--r-- | doc/html/program_options/s06.html | 3 | ||||
| -rw-r--r-- | doc/html/program_options/tutorial.html | 15 |
6 files changed, 134 insertions, 128 deletions
diff --git a/doc/html/program_options/design.html b/doc/html/program_options/design.html index 78558c1c28..3d3f08b005 100644 --- a/doc/html/program_options/design.html +++ b/doc/html/program_options/design.html @@ -1,3 +1,4 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> @@ -76,8 +77,8 @@ Second, imagine a reusable library which has some options and exposes options description in its interface. If <span class="emphasis"><em>all</em></span> options are either ascii or Unicode, and the library does not use any - Unicode strings, then the author will likely to use ascii options, which - would make the library unusable inside Unicode + Unicode strings, then the author is likely to use ascii options, making + the library unusable inside Unicode applications. Essentially, it would be necessary to provide two versions of the library -- ascii and Unicode. </p> @@ -99,7 +100,7 @@ <p>The primary question in implementing the Unicode support is whether to use templates and <code class="computeroutput">std::basic_string</code> or to use some internal encoding and convert between internal and external encodings on - the interface boundaries. + the interface boundaries. </p> <p>The choice, mostly, is between code size and execution speed. A templated solution would either link library code into every @@ -142,8 +143,8 @@ The instance of <code class="computeroutput"><a class="link" href="../boost/program_options/value_semantic.html" title="Class value_semantic">value_semantic</a></code> can then convert into some other encoding if needed. </p> -<p>For the storage component, the only affected function is <code class="computeroutput"><a class="link" href="../boost/program_options/store_idp156630368.html" title="Function store">store</a></code>. - For Unicode input, the <code class="computeroutput"><a class="link" href="../boost/program_options/store_idp156630368.html" title="Function store">store</a></code> function should convert the value to the +<p>For the storage component, the only affected function is <code class="computeroutput"><a class="link" href="../boost/program_options/store_idp219446064.html" title="Function store">store</a></code>. + For Unicode input, the <code class="computeroutput"><a class="link" href="../boost/program_options/store_idp219446064.html" title="Function store">store</a></code> function should convert the value to the internal encoding. It should also inform the <code class="computeroutput"><a class="link" href="../boost/program_options/value_semantic.html" title="Class value_semantic">value_semantic</a></code> class about the used encoding. </p> @@ -164,10 +165,10 @@ </ul></div> <p> There's no clear leader, but the last point seems important, so UTF-8 - will be used. + will be used. </p> -<p>Choosing the UTF-8 encoding allows the use of existing parsers, - because 7-bit ascii characters retain their values in UTF-8, +<p>Choosing the UTF-8 encoding allows the use of existing parsers, + because 7-bit ascii characters retain their values in UTF-8, so searching for 7-bit strings is simple. However, there are two subtle issues: </p> diff --git a/doc/html/program_options/howto.html b/doc/html/program_options/howto.html index 27d23103a6..6d170ba6c3 100644 --- a/doc/html/program_options/howto.html +++ b/doc/html/program_options/howto.html @@ -1,3 +1,4 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> @@ -26,24 +27,24 @@ <div class="titlepage"><div><div><h2 class="title" style="clear: both"> <a name="program_options.howto"></a>How To</h2></div></div></div> <div class="toc"><dl class="toc"> -<dt><span class="section"><a href="howto.html#idp337019152">Non-conventional Syntax</a></span></dt> -<dt><span class="section"><a href="howto.html#idp337025280">Response Files</a></span></dt> -<dt><span class="section"><a href="howto.html#idp337033312">Winmain Command Line</a></span></dt> -<dt><span class="section"><a href="howto.html#idp337038544">Option Groups and Hidden Options</a></span></dt> -<dt><span class="section"><a href="howto.html#idp337053952">Custom Validators</a></span></dt> -<dt><span class="section"><a href="howto.html#idp337062944">Unicode Support</a></span></dt> -<dt><span class="section"><a href="howto.html#idp337082224">Allowing Unknown Options</a></span></dt> +<dt><span class="section"><a href="howto.html#idp343302352">Non-conventional Syntax</a></span></dt> +<dt><span class="section"><a href="howto.html#idp343308464">Response Files</a></span></dt> +<dt><span class="section"><a href="howto.html#idp343316480">Winmain Command Line</a></span></dt> +<dt><span class="section"><a href="howto.html#idp343321712">Option Groups and Hidden Options</a></span></dt> +<dt><span class="section"><a href="howto.html#idp343336928">Custom Validators</a></span></dt> +<dt><span class="section"><a href="howto.html#idp343345920">Unicode Support</a></span></dt> +<dt><span class="section"><a href="howto.html#idp343365200">Allowing Unknown Options</a></span></dt> </dl></div> <p>This section describes how the library can be used in specific situations.</p> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp337019152"></a>Non-conventional Syntax</h3></div></div></div> +<a name="idp343302352"></a>Non-conventional Syntax</h3></div></div></div> <p>Sometimes, standard command line syntaxes are not enough. For example, the gcc compiler has "-frtti" and -fno-rtti" options, and this syntax is not directly supported. </p> -<a class="indexterm" name="idp337020400"></a><p>For such cases, the library allows the user to provide an +<a class="indexterm" name="idp343303600"></a><p>For such cases, the library allows the user to provide an <em class="firstterm">additional parser</em> -- a function which will be called on each command line element, before any processing by the library. If the additional parser recognises the syntax, it returns the option name and @@ -75,13 +76,13 @@ store(command_line_parser(ac, av).options(desc).extra_parser(reg_foo) </pre> <p> The complete example can be found in the "example/custom_syntax.cpp" - file. + file. </p> </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp337025280"></a>Response Files</h3></div></div></div> -<a class="indexterm" name="idp337025952"></a><p>Some operating system have very low limits of the command line +<a name="idp343308464"></a>Response Files</h3></div></div></div> +<a class="indexterm" name="idp343309136"></a><p>Some operating system have very low limits of the command line length. The common way to work around those limitations is using <em class="firstterm">response files</em>. A response file is just a configuration file which uses the same syntax as the command line. If @@ -94,7 +95,7 @@ store(command_line_parser(ac, av).options(desc).extra_parser(reg_foo) First, you need to define an option for the response file: </p> <pre class="programlisting"> -("response-file", value<string>(), +("response-file", value<string>(), "can be specified with '@name', too") </pre> <p> @@ -137,18 +138,18 @@ if (vm.count("response-file")) { vector<string> args; copy(tok.begin(), tok.end(), back_inserter(args)); // Parse the file and store the options - store(command_line_parser(args).options(desc).run(), vm); + store(command_line_parser(args).options(desc).run(), vm); } </pre> <p> The complete example can be found in the "example/response_file.cpp" - file. + file. </p> </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp337033312"></a>Winmain Command Line</h3></div></div></div> +<a name="idp343316480"></a>Winmain Command Line</h3></div></div></div> <p>On the Windows operating system, GUI applications receive the command line as a single string, not split into elements. For that reason, the command line parser cannot be used directly. At least on some @@ -163,14 +164,14 @@ if (vm.count("response-file")) { vector<string> args = split_winmain(lpCmdLine); store(command_line_parser(args).options(desc).run(), vm); </pre> -<p> +<p> The <code class="computeroutput">split_winmain</code> function is overloaded for <code class="computeroutput">wchar_t</code> strings, so can also be used in Unicode applications. </p> </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp337038544"></a>Option Groups and Hidden Options</h3></div></div></div> +<a name="idp343321712"></a>Option Groups and Hidden Options</h3></div></div></div> <p>Having a single 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 with all the program's options can be problematic: </p> @@ -235,7 +236,7 @@ visible.add(general).add(gui); variables_map vm; store(parse_command_line(ac, av, all), vm); -if (vm.count("help")) +if (vm.count("help")) { cout << visible; return 0; @@ -247,7 +248,7 @@ if (vm.count("help-module")) { } else if (s == "backend") { cout << backend; } else { - cout << "Unknown module '" + cout << "Unknown module '" << s << "' in the --help-module option\n"; return 1; } @@ -255,8 +256,8 @@ if (vm.count("help-module")) { } if (vm.count("num-threads")) { cout << "The 'num-threads' options was set to " - << vm["num-threads"].as<int>() << "\n"; -} + << vm["num-threads"].as<int>() << "\n"; +} </pre> <p> When parsing the command line, all options are allowed. The "--help" @@ -269,7 +270,7 @@ if (vm.count("num-threads")) { </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp337053952"></a>Custom Validators</h3></div></div></div> +<a name="idp343336928"></a>Custom Validators</h3></div></div></div> <p>By default, the conversion of option's value from string into C++ type is done using iostreams, which sometimes is not convenient. The library allows the user to customize the conversion for specific @@ -289,7 +290,7 @@ public: <p> and then overload the <code class="computeroutput">validate</code> function: </p> <pre class="programlisting"> -void validate(boost::any& v, +void validate(boost::any& v, const std::vector<std::string>& values, magic_number* target_type, int) { @@ -303,16 +304,16 @@ void validate(boost::any& v, // one string, it's an error, and exception will be thrown. const string& s = validators::get_single_string(values); - // Do regex match and convert the interesting part to + // Do regex match and convert the interesting part to // int. smatch match; if (regex_match(s, match, r)) { v = any(magic_number(lexical_cast<int>(match[1]))); } else { throw validation_error(validation_error::invalid_option_value); - } + } } - + </pre> <p>The function takes four parameters. The first is the storage for the value, and in this case is either empty or contains an instance of @@ -332,7 +333,7 @@ void validate(boost::any& v, </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp337062944"></a>Unicode Support</h3></div></div></div> +<a name="idp343345920"></a>Unicode Support</h3></div></div></div> <p>To use the library with Unicode, you'd need to: </p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> @@ -376,7 +377,7 @@ locale::global(locale("")); </pre> <p> which would set up the conversion facet according to the user's selected - locale. + locale. </p> <p>It's wise to check the status of the C++ locale support on your implementation, though. The quick test involves three steps: @@ -384,7 +385,7 @@ locale::global(locale("")); <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"><p>Go the the "test" directory and build the "test_convert" binary.</p></li> <li class="listitem"> -<p>Set some non-ascii locale in the environmemt. On Linux, one can +<p>Set some non-ascii locale in the environment. On Linux, one can run, for example: </p> <pre class="screen"> $ export LC_CTYPE=ru_RU.KOI8-R @@ -402,38 +403,38 @@ $ export LC_CTYPE=ru_RU.KOI8-R </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp337082224"></a>Allowing Unknown Options</h3></div></div></div> -<p>Usually, the library throws an exception on unknown option names. This - behaviour can be changed. For example, only some part of your application uses +<a name="idp343365200"></a>Allowing Unknown Options</h3></div></div></div> +<p>Usually, the library throws an exception on unknown option names. This + behaviour can be changed. For example, only some part of your application uses <a class="link" href="../program_options.html" title="Chapter 21. Boost.Program_options">Program_options</a>, and you wish to pass unrecognized options to another part of the program, or even to another application.</p> -<p>To allow unregistered options on the command line, you need to use +<p>To allow unregistered options on the command line, you need to use the <code class="computeroutput"><a class="link" href="../boost/program_options/basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a></code> class for parsing (not <code class="computeroutput"><a class="link" href="../boost/program_options/parse_command_line.html" title="Function template parse_command_line">parse_command_line</a></code>) - and call the <code class="computeroutput"><a class="link" href="../boost/program_options/basic_command_line_parser.html#idp222564416-bb">allow_unregistered</a></code> + and call the <code class="computeroutput"><a class="link" href="../boost/program_options/basic_command_line_parser.html#idp217723408-bb">allow_unregistered</a></code> method of that class: </p> <pre class="programlisting"> -parsed_options parsed = - command_line_parser(argc, argv).options(desc).allow_unregistered().run(); +parsed_options parsed = + command_line_parser(argc, argv).options(desc).allow_unregistered().run(); </pre> <p> - - For each token that looks like an option, but does not have a known name, - an instance of <code class="computeroutput"><a class="link" href="../boost/program_options/basic_option.html" title="Class template basic_option">basic_option</a></code> will be added to the result. - The <code class="computeroutput">string_key</code> and <code class="computeroutput">value</code> fields of the instance will contain results + + For each token that looks like an option, but does not have a known name, + an instance of <code class="computeroutput"><a class="link" href="../boost/program_options/basic_option.html" title="Class template basic_option">basic_option</a></code> will be added to the result. + The <code class="computeroutput">string_key</code> and <code class="computeroutput">value</code> fields of the instance will contain results of syntactic parsing of the token, the <code class="computeroutput">unregistered</code> field will be set to <code class="computeroutput">true</code>, and the <code class="computeroutput">original_tokens</code> field will contain the token as it appeared on the command line. </p> -<p>If you want to pass the unrecognized options further, the +<p>If you want to pass the unrecognized options further, the <code class="computeroutput"><a class="link" href="../boost/program_options/collect_unrecognized.html" title="Function template collect_unrecognized">collect_unrecognized</a></code> function can be used. The function will collect original tokens for all unrecognized values, and optionally, all found positional options. - Say, if your code handles a few options, but does not handles positional options at all, you can use the function like this: + Say, if your code handles a few options, but does not handle positional options at all, you can use the function like this: </p> <pre class="programlisting"> vector<string> to_pass_further = collect_unrecognized(parsed.options, include_positional); </pre> <p> - + </p> </div> </div> diff --git a/doc/html/program_options/overview.html b/doc/html/program_options/overview.html index 7bac6c7acb..fdb5e6f4a7 100644 --- a/doc/html/program_options/overview.html +++ b/doc/html/program_options/overview.html @@ -1,3 +1,4 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> @@ -26,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#idp336874880">Options Description Component</a></span></dt> -<dt><span class="section"><a href="overview.html#idp336938048">Parsers Component</a></span></dt> -<dt><span class="section"><a href="overview.html#idp336948784">Storage Component</a></span></dt> -<dt><span class="section"><a href="overview.html#idp336960208">Specific parsers</a></span></dt> -<dt><span class="section"><a href="overview.html#idp336992224">Annotated List of Symbols</a></span></dt> +<dt><span class="section"><a href="overview.html#idp343157936">Options Description Component</a></span></dt> +<dt><span class="section"><a href="overview.html#idp343221840">Parsers Component</a></span></dt> +<dt><span class="section"><a href="overview.html#idp343232256">Storage Component</a></span></dt> +<dt><span class="section"><a href="overview.html#idp343243632">Specific parsers</a></span></dt> +<dt><span class="section"><a href="overview.html#idp343275424">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 @@ -43,7 +44,7 @@ and what to do with the values of the options. </p></li> <li class="listitem"><p>The parsers component, which uses this information to find option names - and values in the input sources and return them. + and values in the input sources and return them. </p></li> <li class="listitem"><p>The storage component, which provides the interface to access the value of an option. It also converts the string @@ -74,11 +75,11 @@ </p> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp336874880"></a>Options Description Component</h3></div></div></div> +<a name="idp343157936"></a>Options Description Component</h3></div></div></div> <div class="toc"><dl class="toc"> -<dt><span class="section"><a href="overview.html#idp336902304">Syntactic Information</a></span></dt> -<dt><span class="section"><a href="overview.html#idp336921056">Semantic Information</a></span></dt> -<dt><span class="section"><a href="overview.html#idp336925760">Positional Options</a></span></dt> +<dt><span class="section"><a href="overview.html#idp343185296">Syntactic Information</a></span></dt> +<dt><span class="section"><a href="overview.html#idp343205008">Semantic Information</a></span></dt> +<dt><span class="section"><a href="overview.html#idp343209600">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 @@ -101,7 +102,7 @@ desc.add_options() ("optimization", value<int>()->default_value(10), "optimization level") ; </pre> -<p> +<p> </p> <p>The call to the <code class="computeroutput">value</code> function creates an instance of a class derived from the <code class="computeroutput">value_semantic</code> class: <code class="computeroutput">typed_value</code>. @@ -111,13 +112,13 @@ desc.add_options() essentially emulates named parameters of the constructor.) Calls to <code class="computeroutput">operator()</code> on the object returned by <code class="computeroutput">add_options</code> forward arguments to the constructor of the <code class="computeroutput">option_description</code> - class and add the new instance. + class and add the new instance. </p> <p> Note that in addition to the <code class="computeroutput">value</code>, library provides the <code class="computeroutput">bool_switch</code> function, and user can write his own function which will return - other subclasses of <code class="computeroutput">value_semantic</code> with + other subclasses of <code class="computeroutput">value_semantic</code> with different behaviour. For the remainder of this section, we'll talk only about the <code class="computeroutput">value</code> function. </p> @@ -128,7 +129,7 @@ desc.add_options() where value is just a vector of strings (<code class="computeroutput">std::vector<std::string></code>). The semantic layer is responsible for converting the value of the option into more usable C++ - types. + types. </p> <p>This separation is an important part of library design. The parsers use only the syntactic layer, which takes away some of the freedom to @@ -146,13 +147,13 @@ desc.add_options() </p> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="idp336902304"></a>Syntactic Information</h4></div></div></div> -<div class="toc"><dl class="toc"><dt><span class="section"><a href="overview.html#idp336912128">Description formatting</a></span></dt></dl></div> +<a name="idp343185296"></a>Syntactic Information</h4></div></div></div> +<div class="toc"><dl class="toc"><dt><span class="section"><a href="overview.html#idp343195056">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 <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 - and includes: + and includes: </p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"><p> @@ -191,11 +192,11 @@ desc.add_options() <pre class="screen"> test --help --compression 10 --verbose --email beadle@mars beadle2@mars </pre> -<p> +<p> </p> <div class="section"> <div class="titlepage"><div><div><h5 class="title"> -<a name="idp336912128"></a>Description formatting</h5></div></div></div> +<a name="idp343195056"></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 @@ -204,18 +205,18 @@ desc.add_options() <p>The description string has one or more paragraphs, separated by the newline character ('\n'). When an option is output, the library will compute the indentation for options's description. Each of the - paragraph is output as a separate line with that intentation. If + paragraph is output as a separate line with that intentation. If a paragraph does not fit on one line it is spanned over multiple lines (which will have the same indentation). </p> <p>You may specify additional indent for the first specified by - inserting spaces at the beginning of a paragraph. For example: + inserting spaces at the beginning of a paragraph. For example: </p> <pre class="programlisting"> options.add_options() ("help", " A long help msg a long help msg a long help msg a long help msg a long help msg a long help msg a long help msg a long help msg ") - ; + ; </pre> <p> will specify a four-space indent for the first line. The output will @@ -228,14 +229,14 @@ msg a long help msg a long help msg a long help msg a long help msg ") help msg a long help msg a long help msg a long help msg - + </pre> <p> </p> <p>For the case where line is wrapped, you can want an additional indent for wrapped text. This can be done by inserting a tabulator character ('\t') at the desired position. For - example: + example: </p> <pre class="programlisting"> options.add_options() @@ -248,7 +249,7 @@ bla bla bla bla bla bla bla bla bla bla bla\n" " Value2: \tdoes something else, bla bla bla bla bla bla bla bla bla bla bla bla bla bla bla\n\n" " This paragraph has a first line indent only, -bla bla bla bla bla bla bla bla bla bla bla bla bla bla bla"); +bla bla bla bla bla bla bla bla bla bla bla bla bla bla bla"); </pre> <p> will produce: @@ -282,17 +283,17 @@ bla bla bla bla bla bla bla bla bla bla bla bla bla bla bla"); </pre> <p> The tab character is removed before output. Only one tabulator per - paragraph is allowed, otherwisee an exception of type + paragraph is allowed, otherwise an exception of type program_options::error is thrown. Finally, the tabulator is ignored if - it's is not on the first line of the paragraph or is on the last + it is not on the first line of the paragraph or is on the last possible position of the first line. </p> </div> </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="idp336921056"></a>Semantic Information</h4></div></div></div> -<p>The semantic information is completely provided by the +<a name="idp343205008"></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: </p> @@ -304,17 +305,17 @@ desc.add_options() ->composing()->notifier(&your_function), "email") ; </pre> -<p> +<p> These declarations specify that default value of the first option is 10, that the second option can appear several times and all instances should be merged, and that after parsing is done, the library will call function <code class="computeroutput">&your_function</code>, passing the value of the - "email" option as argument. + "email" option as argument. </p> </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="idp336925760"></a>Positional Options</h4></div></div></div> +<a name="idp343209600"></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>, @@ -337,7 +338,7 @@ desc.add_options() </pre> <p> </p> -<p>The <code class="computeroutput"><a class="link" href="../boost/program_options/positional_op_idp211204448.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_idp150873344.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> @@ -363,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_idp211204448.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_idp150873344.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> @@ -371,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="idp336938048"></a>Parsers Component</h3></div></div></div> +<a name="idp343221840"></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 @@ -391,7 +392,7 @@ pd.add("output-file", 2).add("input-file", -1); The results of parsing are returned as an instance of the <code class="computeroutput"><a class="link" href="reference.html#boost.program_options.parsed_options">parsed_options</a></code> class. Typically, that object is passed directly to the storage component. However, it also can be used directly, or undergo some additional - processing. + processing. </p> <p> There are three exceptions to the above model -- all related to @@ -422,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="idp336948784"></a>Storage Component</h3></div></div></div> +<a name="idp343232256"></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; "> @@ -465,15 +466,15 @@ notify(vm); </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp336960208"></a>Specific parsers</h3></div></div></div> +<a name="idp343243632"></a>Specific parsers</h3></div></div></div> <div class="toc"><dl class="toc"> -<dt><span class="section"><a href="overview.html#idp336960880">Configuration file parser</a></span></dt> -<dt><span class="section"><a href="overview.html#idp336972768">Environment variables parser</a></span></dt> +<dt><span class="section"><a href="overview.html#idp343244304">Configuration file parser</a></span></dt> +<dt><span class="section"><a href="overview.html#idp343256080">Environment variables parser</a></span></dt> </dl></div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="idp336960880"></a>Configuration file parser</h4></div></div></div> -<p>The <code class="computeroutput"><a class="link" href="../boost/program_options/parse_config__idp143891520.html" title="Function template parse_config_file">parse_config_file</a></code> function implements parsing +<a name="idp343244304"></a>Configuration file parser</h4></div></div></div> +<p>The <code class="computeroutput"><a class="link" href="../boost/program_options/parse_config__idp206025792.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> @@ -508,7 +509,7 @@ gui.accessibility.visual_bell=yes </div> <div class="section"> <div class="titlepage"><div><div><h4 class="title"> -<a name="idp336972768"></a>Environment variables parser</h4></div></div></div> +<a name="idp343256080"></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 @@ -522,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_idp196667312.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_idp224270416.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 @@ -536,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_idp196667312.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_idp224270416.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>. + 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_idp196667312.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_idp224270416.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 @@ -553,7 +554,7 @@ gui.accessibility.visual_bell=yes </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp336992224"></a>Annotated List of Symbols</h3></div></div></div> +<a name="idp343275424"></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%"> @@ -572,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_idp97704160.html" title="Function value">value</a></code></td> +<td><code class="computeroutput"><a class="link" href="../boost/program_options/value_idp109113408.html" title="Function value">value</a></code></td> <td>defines the option's value</td> </tr> <tr><td colspan="2">Parsers component</td></tr> @@ -585,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__idp143891520.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__idp206025792.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_idp196667312.html" title="Function parse_environment">parse_environment</a></code></td> +<td><code class="computeroutput"><a class="link" href="../boost/program_options/parse_environ_idp224270416.html" title="Function parse_environment">parse_environment</a></code></td> <td>parses environment</td> </tr> <tr><td colspan="2">Storage component</td></tr> diff --git a/doc/html/program_options/reference.html b/doc/html/program_options/reference.html index 62632a911a..56fbdde984 100644 --- a/doc/html/program_options/reference.html +++ b/doc/html/program_options/reference.html @@ -1,3 +1,4 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> @@ -82,7 +83,7 @@ <span class="keyword">class</span> <a class="link" href="../boost/program_options/error_with_option_name.html" title="Class error_with_option_name">error_with_option_name</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/invalid_bool_value.html" title="Class invalid_bool_value">invalid_bool_value</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/invalid_command_line_style.html" title="Class invalid_command_line_style">invalid_command_line_style</a><span class="special">;</span> - <span class="keyword">class</span> <a class="link" href="../boost/program_options/invalid_comman_idp96224752.html" title="Class invalid_command_line_syntax">invalid_command_line_syntax</a><span class="special">;</span> + <span class="keyword">class</span> <a class="link" href="../boost/program_options/invalid_comma_idp163674448.html" title="Class invalid_command_line_syntax">invalid_command_line_syntax</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/invalid_config_file_syntax.html" title="Class invalid_config_file_syntax">invalid_config_file_syntax</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/invalid_option_value.html" title="Class invalid_option_value">invalid_option_value</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/invalid_syntax.html" title="Class invalid_syntax">invalid_syntax</a><span class="special">;</span> @@ -90,7 +91,7 @@ <span class="keyword">class</span> <a class="link" href="../boost/program_options/multiple_values.html" title="Class multiple_values">multiple_values</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/reading_file.html" title="Class reading_file">reading_file</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/required_option.html" title="Class required_option">required_option</a><span class="special">;</span> - <span class="keyword">class</span> <a class="link" href="../boost/program_options/too_many_posi_idp153391744.html" title="Class too_many_positional_options_error">too_many_positional_options_error</a><span class="special">;</span> + <span class="keyword">class</span> <a class="link" href="../boost/program_options/too_many_posi_idp112496320.html" title="Class too_many_positional_options_error">too_many_positional_options_error</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/unknown_option.html" title="Class unknown_option">unknown_option</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/validation_error.html" title="Class validation_error">validation_error</a><span class="special">;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="boost.program_options.strip_prefixes"></a><span class="identifier">strip_prefixes</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> text<span class="special">)</span><span class="special">;</span> @@ -117,7 +118,7 @@ <span class="keyword">class</span> <a class="link" href="../boost/program_options/duplicate_option_error.html" title="Class duplicate_option_error">duplicate_option_error</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/option_description.html" title="Class option_description">option_description</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a><span class="special">;</span> - <span class="keyword">class</span> <a class="link" href="../boost/program_options/options_descri_idp33114784.html" title="Class options_description_easy_init">options_description_easy_init</a><span class="special">;</span> + <span class="keyword">class</span> <a class="link" href="../boost/program_options/options_descr_idp214375408.html" title="Class options_description_easy_init">options_description_easy_init</a><span class="special">;</span> <span class="special">}</span> <span class="special">}</span></pre> </div> @@ -128,7 +129,7 @@ <span class="keyword">namespace</span> <span class="identifier">program_options</span> <span class="special">{</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> charT<span class="special">></span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/basic_parsed__idp143565040.html" title="Class basic_parsed_options<wchar_t>">basic_parsed_options</a><span class="special"><</span><span class="keyword">wchar_t</span><span class="special">></span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/basic_parsed__idp152015376.html" title="Class basic_parsed_options<wchar_t>">basic_parsed_options</a><span class="special"><</span><span class="keyword">wchar_t</span><span class="special">></span><span class="special">;</span> <span class="keyword">enum</span> <a class="link" href="../boost/program_options/collect_unrecognized_mode.html" title="Type collect_unrecognized_mode">collect_unrecognized_mode</a><span class="special">;</span> @@ -144,23 +145,23 @@ <span class="identifier">function1</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">></span> <span class="special">=</span> <span class="identifier">ext_parser</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> charT<span class="special">></span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> basic_parsed_options<span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> - <a class="link" href="../boost/program_options/parse_config__idp143891520.html" title="Function template parse_config_file"><span class="identifier">parse_config_file</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> + <a class="link" href="../boost/program_options/parse_config__idp206025792.html" title="Function template parse_config_file"><span class="identifier">parse_config_file</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> charT<span class="special">></span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> basic_parsed_options<span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> - <a class="link" href="../boost/program_options/parse_config__idp103825696.html" title="Function template parse_config_file"><span class="identifier">parse_config_file</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> + <a class="link" href="../boost/program_options/parse_config__idp203490384.html" title="Function template parse_config_file"><span class="identifier">parse_config_file</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> charT<span class="special">></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> <a class="link" href="../boost/program_options/collect_unrecognized.html" title="Function template collect_unrecognized"><span class="identifier">collect_unrecognized</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> <a class="link" href="../boost/program_options/basic_option.html" title="Class template basic_option">basic_option</a><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="keyword">enum</span> <span class="identifier">collect_unrecognized_mode</span><span class="special">)</span><span class="special">;</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="reference.html#boost.program_options.parsed_options">parsed_options</a> - <a class="link" href="../boost/program_options/parse_environ_idp196667312.html" title="Function parse_environment"><span class="identifier">parse_environment</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> + <a class="link" href="../boost/program_options/parse_environ_idp224270416.html" title="Function parse_environment"><span class="identifier">parse_environment</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">function1</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="reference.html#boost.program_options.parsed_options">parsed_options</a> - <a class="link" href="../boost/program_options/parse_environ_idp193796176.html" title="Function parse_environment"><span class="identifier">parse_environment</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="../boost/program_options/parse_environ_idp154393360.html" title="Function parse_environment"><span class="identifier">parse_environment</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="reference.html#boost.program_options.parsed_options">parsed_options</a> - <a class="link" href="../boost/program_options/parse_environ_idp203705312.html" title="Function parse_environment"><span class="identifier">parse_environment</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="../boost/program_options/parse_environm_idp75334496.html" title="Function parse_environment"><span class="identifier">parse_environment</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</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">string</span> <span class="special">></span> <a class="link" href="../boost/program_options/split_unix.html" title="Function split_unix"><span class="identifier">split_unix</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">" \t"</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">"'\""</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">"\\"</span><span class="special">)</span><span class="special">;</span> @@ -175,7 +176,7 @@ <a name="header.boost.program_options.positional_options_hpp"></a>Header <<a href="../../../boost/program_options/positional_options.hpp" target="_top">boost/program_options/positional_options.hpp</a>></h3></div></div></div> <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">program_options</span> <span class="special">{</span> - <span class="keyword">class</span> <a class="link" href="../boost/program_options/positional_op_idp211204448.html" title="Class positional_options_description">positional_options_description</a><span class="special">;</span> + <span class="keyword">class</span> <a class="link" href="../boost/program_options/positional_op_idp150873344.html" title="Class positional_options_description">positional_options_description</a><span class="special">;</span> <span class="special">}</span> <span class="special">}</span></pre> </div> @@ -188,12 +189,12 @@ <span class="keyword">class</span> <a class="link" href="../boost/program_options/typed_value_base.html" title="Class typed_value_base">typed_value_base</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/untyped_value.html" title="Class untyped_value">untyped_value</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/value_semantic.html" title="Class value_semantic">value_semantic</a><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> charT<span class="special">></span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/value_semanti_idp202214064.html" title="Class template value_semantic_codecvt_helper">value_semantic_codecvt_helper</a><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> charT<span class="special">></span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/value_semanti_idp207166032.html" title="Class template value_semantic_codecvt_helper">value_semantic_codecvt_helper</a><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/value_semanti_idp144997440.html" title="Class value_semantic_codecvt_helper<char>">value_semantic_codecvt_helper</a><span class="special"><</span><span class="keyword">char</span><span class="special">></span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/value_semanti_idp213096512.html" title="Class value_semantic_codecvt_helper<wchar_t>">value_semantic_codecvt_helper</a><span class="special"><</span><span class="keyword">wchar_t</span><span class="special">></span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="../boost/program_options/typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="../boost/program_options/value_idp97704160.html" title="Function value"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="../boost/program_options/typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="../boost/program_options/value_idp97704160.html" title="Function value"><span class="identifier">value</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/value_semanti_idp103539104.html" title="Class value_semantic_codecvt_helper<char>">value_semantic_codecvt_helper</a><span class="special"><</span><span class="keyword">char</span><span class="special">></span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/value_semantic_idp99204112.html" title="Class value_semantic_codecvt_helper<wchar_t>">value_semantic_codecvt_helper</a><span class="special"><</span><span class="keyword">wchar_t</span><span class="special">></span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="../boost/program_options/typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="../boost/program_options/value_idp109113408.html" title="Function value"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="../boost/program_options/typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="../boost/program_options/value_idp109113408.html" title="Function value"><span class="identifier">value</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="../boost/program_options/typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">wchar_t</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="../boost/program_options/wvalue.html" title="Function wvalue"><span class="identifier">wvalue</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="../boost/program_options/typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">wchar_t</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="../boost/program_options/wvalue.html" title="Function wvalue"><span class="identifier">wvalue</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="../boost/program_options/typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="keyword">bool</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="../boost/program_options/bool_switch.html" title="Function bool_switch"><span class="identifier">bool_switch</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> @@ -210,9 +211,9 @@ <span class="keyword">class</span> <a class="link" href="../boost/program_options/variable_value.html" title="Class variable_value">variable_value</a><span class="special">;</span> <span class="keyword">class</span> <a class="link" href="../boost/program_options/variables_map.html" title="Class variables_map">variables_map</a><span class="special">;</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> - <a class="link" href="../boost/program_options/store_idp156630368.html" title="Function store"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</span> basic_parsed_options<span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="../boost/program_options/variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="../boost/program_options/store_idp219446064.html" title="Function store"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</span> basic_parsed_options<span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="../boost/program_options/variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> - <a class="link" href="../boost/program_options/store_idp145373328.html" title="Function store"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</span> basic_parsed_options<span class="special"><</span> <span class="keyword">wchar_t</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="../boost/program_options/variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="../boost/program_options/store_idp104980944.html" title="Function store"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</span> basic_parsed_options<span class="special"><</span> <span class="keyword">wchar_t</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="../boost/program_options/variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> <a class="link" href="../boost/program_options/notify.html" title="Function notify"><span class="identifier">notify</span></a><span class="special">(</span><a class="link" href="../boost/program_options/variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span> <span class="special">}</span></pre> diff --git a/doc/html/program_options/s06.html b/doc/html/program_options/s06.html index 3e39bee1ba..641a005e5f 100644 --- a/doc/html/program_options/s06.html +++ b/doc/html/program_options/s06.html @@ -1,3 +1,4 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> @@ -24,7 +25,7 @@ </div> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="idp337144448"></a>Acknowledgements</h2></div></div></div> +<a name="idp343427424"></a>Acknowledgements</h2></div></div></div> <p>I'm very gratefull to all the people who helped with the development, by discussion, fixes, and as users. It was pleasant to see all that involvement, which made the library much better than it diff --git a/doc/html/program_options/tutorial.html b/doc/html/program_options/tutorial.html index d2a06f5a7f..d6121e0f98 100644 --- a/doc/html/program_options/tutorial.html +++ b/doc/html/program_options/tutorial.html @@ -1,3 +1,4 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> @@ -26,9 +27,9 @@ <div class="titlepage"><div><div><h2 class="title" style="clear: both"> <a name="program_options.tutorial"></a>Tutorial</h2></div></div></div> <div class="toc"><dl class="toc"> -<dt><span class="section"><a href="tutorial.html#idp336802688">Getting Started</a></span></dt> -<dt><span class="section"><a href="tutorial.html#idp336820928">Option Details</a></span></dt> -<dt><span class="section"><a href="tutorial.html#idp336847424">Multiple Sources</a></span></dt> +<dt><span class="section"><a href="tutorial.html#idp343085776">Getting Started</a></span></dt> +<dt><span class="section"><a href="tutorial.html#idp343103984">Option Details</a></span></dt> +<dt><span class="section"><a href="tutorial.html#idp343130416">Multiple Sources</a></span></dt> </dl></div> <p>In this section, we'll take a look at the most common usage scenarios of the program_options library, starting with the simplest one. The examples @@ -41,7 +42,7 @@ </p> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp336802688"></a>Getting Started</h3></div></div></div> +<a name="idp343085776"></a>Getting Started</h3></div></div></div> <p>The first example is the simplest possible: it only handles two options. Here's the source code (the full program is in "example/first.cpp"): @@ -112,7 +113,7 @@ Compression level was set to 10. </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp336820928"></a>Option Details</h3></div></div></div> +<a name="idp343103984"></a>Option Details</h3></div></div></div> <p>An option value, surely, can have other types than <code class="computeroutput">int</code>, and can have other interesting properties, which we'll discuss right now. The complete version of the code snipped below can be found in @@ -245,7 +246,7 @@ Optimization level is 4 </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp336847424"></a>Multiple Sources</h3></div></div></div> +<a name="idp343130416"></a>Multiple Sources</h3></div></div></div> <p>It's quite likely that specifying all options to our compiler on the command line will annoy users. What if a user installs a new library and wants to always pass an additional command line element? What if he has @@ -318,7 +319,7 @@ visible.add(generic).add(config); </p> <p>The parsing and storing of values follows the usual pattern, except that we additionally call <code class="computeroutput">parse_config_file</code>, and - call the <code class="computeroutput"><a class="link" href="../boost/program_options/store_idp156630368.html" title="Function store">store</a></code> function twice. But what + call the <code class="computeroutput"><a class="link" href="../boost/program_options/store_idp219446064.html" title="Function store">store</a></code> function twice. But what happens if the same value is specified both on the command line and in config file? Usually, the value stored first is preferred. This is what happens for the "--optimization" option. For "composing" options, like |