diff options
| author | DongHun Kwak <dh0128.kwak@samsung.com> | 2016-10-06 10:41:18 +0900 |
|---|---|---|
| committer | DongHun Kwak <dh0128.kwak@samsung.com> | 2016-10-06 10:43:11 +0900 |
| commit | f763a99a501650eff2c60288aa6f10ef916d769e (patch) | |
| tree | 02af7e13f9a38c888ebf340fe764cbe7dae99da9 /libs/program_options | |
| parent | 5cde13f21d36c7224b0e13d11c4b49379ae5210d (diff) | |
| download | boost-f763a99a501650eff2c60288aa6f10ef916d769e.tar.gz boost-f763a99a501650eff2c60288aa6f10ef916d769e.tar.bz2 boost-f763a99a501650eff2c60288aa6f10ef916d769e.zip | |
Imported Upstream version 1.62.0upstream/1.62.0
Change-Id: I9d4c1ddb7b7d8f0069217ecc582700f9fda6dd4c
Signed-off-by: DongHun Kwak <dh0128.kwak@samsung.com>
Diffstat (limited to 'libs/program_options')
66 files changed, 23 insertions, 6898 deletions
diff --git a/libs/program_options/doc/autodoc.xml b/libs/program_options/doc/autodoc.xml index 729e4d1a0b..d7fc6a3a0b 100644 --- a/libs/program_options/doc/autodoc.xml +++ b/libs/program_options/doc/autodoc.xml @@ -3,12 +3,10 @@ <namespace name="boost"> <namespace name="program_options"> <namespace name="command_line_style"> -<enum name="style_t"><enumvalue name="allow_long"><default> 1</default><purpose>Allow "--long_name" style. </purpose></enumvalue><enumvalue name="allow_short"><default> allow_long << 1</default><purpose>Allow "-<single character" style. </purpose></enumvalue><enumvalue name="allow_dash_for_short"><default> allow_short << 1</default><purpose>Allow "-" in short options. </purpose></enumvalue><enumvalue name="allow_slash_for_short"><default> allow_dash_for_short << 1</default><purpose>Allow "/" in short options. </purpose></enumvalue><enumvalue name="long_allow_adjacent"><default> allow_slash_for_short << 1</default><description><para>Allow option parameter in the same token for long option, like in - --foo=10 - </para></description></enumvalue><enumvalue name="long_allow_next"><default> long_allow_adjacent << 1</default><description><para>Allow option parameter in the next token for long options. </para></description></enumvalue><enumvalue name="short_allow_adjacent"><default> long_allow_next << 1</default><description><para>Allow option parameter in the same token for short options. </para></description></enumvalue><enumvalue name="short_allow_next"><default> short_allow_adjacent << 1</default><description><para>Allow option parameter in the next token for short options. </para></description></enumvalue><enumvalue name="allow_sticky"><default> short_allow_next << 1</default><description><para>Allow to merge several short options together, so that "-s -k" become "-sk". All of the options but last should accept no parameter. For example, if "-s" accept a parameter, then "k" will be taken as parameter, not another short option. Dos-style short options cannot be sticky. </para></description></enumvalue><enumvalue name="allow_guessing"><default> allow_sticky << 1</default><description><para>Allow abbreviated spellings for long options, if they unambiguously identify long option. No long option name should be prefix of other long option name if guessing is in effect. </para></description></enumvalue><enumvalue name="long_case_insensitive"><default> allow_guessing << 1</default><description><para>Ignore the difference in case for long options. </para></description></enumvalue><enumvalue name="short_case_insensitive"><default> long_case_insensitive << 1</default><description><para>Ignore the difference in case for short options. </para></description></enumvalue><enumvalue name="case_insensitive"><default> (long_case_insensitive | short_case_insensitive)</default><description><para>Ignore the difference in case for all options. </para></description></enumvalue><enumvalue name="allow_long_disguise"><default> short_case_insensitive << 1</default><description><para>Allow long options with single option starting character, e.g <computeroutput>-foo=10</computeroutput> </para></description></enumvalue><enumvalue name="unix_style"><default> (allow_short | short_allow_adjacent | short_allow_next +<enum name="style_t"><enumvalue name="allow_long"><default>= 1</default><purpose>Allow "--long_name" style. </purpose></enumvalue><enumvalue name="allow_short"><default>= allow_long << 1</default><purpose>Allow "-<single character" style. </purpose></enumvalue><enumvalue name="allow_dash_for_short"><default>= allow_short << 1</default><purpose>Allow "-" in short options. </purpose></enumvalue><enumvalue name="allow_slash_for_short"><default>= allow_dash_for_short << 1</default><purpose>Allow "/" in short options. </purpose></enumvalue><enumvalue name="long_allow_adjacent"><default>= allow_slash_for_short << 1</default><description><para>Allow option parameter in the same token for long option, like in --foo=10 </para></description></enumvalue><enumvalue name="long_allow_next"><default>= long_allow_adjacent << 1</default><description><para>Allow option parameter in the next token for long options. </para></description></enumvalue><enumvalue name="short_allow_adjacent"><default>= long_allow_next << 1</default><description><para>Allow option parameter in the same token for short options. </para></description></enumvalue><enumvalue name="short_allow_next"><default>= short_allow_adjacent << 1</default><description><para>Allow option parameter in the next token for short options. </para></description></enumvalue><enumvalue name="allow_sticky"><default>= short_allow_next << 1</default><description><para>Allow to merge several short options together, so that "-s -k" become "-sk". All of the options but last should accept no parameter. For example, if "-s" accept a parameter, then "k" will be taken as parameter, not another short option. Dos-style short options cannot be sticky. </para></description></enumvalue><enumvalue name="allow_guessing"><default>= allow_sticky << 1</default><description><para>Allow abbreviated spellings for long options, if they unambiguously identify long option. No long option name should be prefix of other long option name if guessing is in effect. </para></description></enumvalue><enumvalue name="long_case_insensitive"><default>= allow_guessing << 1</default><description><para>Ignore the difference in case for long options. </para></description></enumvalue><enumvalue name="short_case_insensitive"><default>= long_case_insensitive << 1</default><description><para>Ignore the difference in case for short options. </para></description></enumvalue><enumvalue name="case_insensitive"><default>= (long_case_insensitive | short_case_insensitive)</default><description><para>Ignore the difference in case for all options. </para></description></enumvalue><enumvalue name="allow_long_disguise"><default>= short_case_insensitive << 1</default><description><para>Allow long options with single option starting character, e.g <computeroutput>-foo=10</computeroutput> </para></description></enumvalue><enumvalue name="unix_style"><default>= (allow_short | short_allow_adjacent | short_allow_next | allow_long | long_allow_adjacent | long_allow_next | allow_sticky | allow_guessing - | allow_dash_for_short)</default><description><para>The more-or-less traditional unix style. </para></description></enumvalue><enumvalue name="default_style"><default> unix_style</default><description><para>The default style. </para></description></enumvalue><description><para>Various possible styles of options.</para><para>There are "long" options, which start with "--" and "short", which start with either "-" or "/". Both kinds can be allowed or disallowed, see allow_long and allow_short. The allowed character for short options is also configurable.</para><para>Option's value can be specified in the same token as name ("--foo=bar"), or in the next token.</para><para>It's possible to introduce long options by the same character as short options, see allow_long_disguise.</para><para>Finally, guessing (specifying only prefix of option) and case insensitive processing are supported. </para></description></enum> + | allow_dash_for_short)</default><description><para>The more-or-less traditional unix style. </para></description></enumvalue><enumvalue name="default_style"><default>= unix_style</default><description><para>The default style. </para></description></enumvalue><description><para>Various possible styles of options.</para><para>There are "long" options, which start with "--" and "short", which start with either "-" or "/". Both kinds can be allowed or disallowed, see allow_long and allow_short. The allowed character for short options is also configurable.</para><para>Option's value can be specified in the same token as name ("--foo=bar"), or in the next token.</para><para>It's possible to introduce long options by the same character as short options, see allow_long_disguise.</para><para>Finally, guessing (specifying only prefix of option) and case insensitive processing are supported. </para></description></enum> </namespace> @@ -49,8 +47,10 @@ <class name="eof_iterator"><template> <template-type-parameter name="Derived"/> <template-type-parameter name="ValueType"/> - </template><inherit access="public">iterator_facade< Derived, const ValueType, forward_traversal_tag ></inherit><description><para>The '<classname alt="boost::eof_iterator">eof_iterator</classname>' class is useful for constructing forward iterators in cases where iterator extract data from some source and it's easy to detect 'eof' \-- i.e. the situation where there's no data. One apparent example is reading lines from a file.</para><para>Implementing such iterators using '<classname alt="iterator_facade">iterator_facade</classname>' directly would require to create class with three core operation, a couple of constructors. When using '<classname alt="boost::eof_iterator">eof_iterator</classname>', the derived class should define only one method to get new value, plus a couple of constructors.</para><para>The basic idea is that iterator has 'eof' bit. Two iterators are equal only if both have their 'eof' bits set. The 'get' method either obtains the new value or sets the 'eof' bit.</para><para>Specifically, derived class should define:</para><para>1. A default constructor, which creates iterator with 'eof' bit set. The constructor body should call 'found_eof' method defined here. 2. Some other constructor. It should initialize some 'data pointer' used in iterator operation and then call 'get'. 3. The 'get' method. It should operate this way:<itemizedlist> + </template><inherit access="public">iterator_facade< Derived, const ValueType, forward_traversal_tag ></inherit><description><para>The '<classname alt="boost::eof_iterator">eof_iterator</classname>' class is useful for constructing forward iterators in cases where iterator extract data from some source and it's easy to detect 'eof' -- i.e. the situation where there's no data. One apparent example is reading lines from a file.</para><para>Implementing such iterators using 'iterator_facade' directly would require to create class with three core operation, a couple of constructors. When using '<classname alt="boost::eof_iterator">eof_iterator</classname>', the derived class should define only one method to get new value, plus a couple of constructors.</para><para>The basic idea is that iterator has 'eof' bit. Two iterators are equal only if both have their 'eof' bits set. The 'get' method either obtains the new value or sets the 'eof' bit.</para><para>Specifically, derived class should define:</para><para><orderedlist> +<listitem><para>A default constructor, which creates iterator with 'eof' bit set. The constructor body should call 'found_eof' method defined here.</para></listitem><listitem><para>Some other constructor. It should initialize some 'data pointer' used in iterator operation and then call 'get'.</para></listitem><listitem><para>The 'get' method. It should operate this way:<itemizedlist> <listitem><para>look at some 'data pointer' to see if new element is available; if not, it should call 'found_eof'.</para></listitem><listitem><para>extract new element and store it at location returned by the 'value' method.</para></listitem><listitem><para>advance the data pointer.</para></listitem></itemizedlist> +</para></listitem></orderedlist> </para><para>Essentially, the 'get' method has the functionality of both 'increment' and 'dereference'. It's very good for the cases where data extraction implicitly moves data pointer, like for stream operation. </para></description><method-group name="public member functions"> </method-group> <constructor/> @@ -68,7 +68,7 @@ <header name="boost/program_options/errors.hpp"> <namespace name="boost"> <namespace name="program_options"> -<class name="error"><description><para>Base class for all errors in the library. </para></description><method-group name="public member functions"> +<class name="error"><inherit access="public">logic_error</inherit><description><para>Base class for all errors in the library. </para></description><method-group name="public member functions"> </method-group> <constructor><parameter name="xwhat"><paramtype>const std::string &</paramtype></parameter></constructor> </class><class name="too_many_positional_options_error"><inherit access="public">boost::program_options::error</inherit><description><para>Class thrown when there are too many positional options. This is a programming error. </para></description><method-group name="public member functions"> @@ -80,7 +80,7 @@ </class><class name="reading_file"><inherit access="public">boost::program_options::error</inherit><description><para>Class thrown if config file can not be read </para></description><method-group name="public member functions"> </method-group> <constructor><parameter name="filename"><paramtype>const char *</paramtype></parameter></constructor> -</class><class name="error_with_option_name"><inherit access="public">boost::program_options::error</inherit><description><para>Base class for most exceptions in the library.</para><para>Substitutes the values for the parameter name placeholders in the template to create the human readable error message</para><para>Placeholders are surrounded by % signs: example% Poor man's version of boost::format</para><para>If a parameter name is absent, perform default substitutions instead so ugly placeholders are never left in-place.</para><para>Options are displayed in "canonical" form This is the most unambiguous form of the *parsed* option name and would correspond to option_description::format_name() i.e. what is shown by print_usage()</para><para>The "canonical" form depends on whether the option is specified in short or long form, using dashes or slashes or without a prefix (from a configuration file) </para></description><data-member name="m_error_template"><type>std::string</type><description><para>template with placeholders </para></description></data-member> +</class><class name="error_with_option_name"><inherit access="public">boost::program_options::error</inherit><description><para>Base class for most exceptions in the library.</para><para>Substitutes the values for the parameter name placeholders in the template to create the human readable error message</para><para>Placeholders are surrounded by % signs: example% Poor man's version of boost::format</para><para>If a parameter name is absent, perform default substitutions instead so ugly placeholders are never left in-place.</para><para>Options are displayed in "canonical" form This is the most unambiguous form of the <emphasis>parsed</emphasis> option name and would correspond to option_description::format_name() i.e. what is shown by print_usage()</para><para>The "canonical" form depends on whether the option is specified in short or long form, using dashes or slashes or without a prefix (from a configuration file) </para></description><data-member name="m_error_template"><type>std::string</type><description><para>template with placeholders </para></description></data-member> <method-group name="public member functions"> <method name="set_substitute"><type>void</type><parameter name="parameter_name"><paramtype>const std::string &</paramtype></parameter><parameter name="value"><paramtype>const std::string &</paramtype></parameter><description><para>Substitute parameter_name->value to create the error message from the error template </para></description></method> <method name="set_substitute_default"><type>void</type><parameter name="parameter_name"><paramtype>const std::string &</paramtype></parameter><parameter name="from"><paramtype>const std::string &</paramtype></parameter><parameter name="to"><paramtype>const std::string &</paramtype></parameter><description><para>If the parameter is missing, then make the from->to substitution instead </para></description></method> @@ -128,7 +128,7 @@ <method-group name="protected member functions"> <method name="substitute_placeholders" cv="const" specifiers="virtual"><type>void</type><parameter name="error_template"><paramtype>const std::string &</paramtype></parameter><description><para>Makes all substitutions using the template </para></description></method> </method-group> -</class><class name="invalid_syntax"><inherit access="public">boost::program_options::error_with_option_name</inherit><description><para>Class thrown when there's syntax error either for command line or config file options. See derived children for concrete classes. </para></description><enum name="kind_t"><enumvalue name="long_not_allowed"><default> 30</default></enumvalue><enumvalue name="long_adjacent_not_allowed"/><enumvalue name="short_adjacent_not_allowed"/><enumvalue name="empty_adjacent_parameter"/><enumvalue name="missing_parameter"/><enumvalue name="extra_parameter"/><enumvalue name="unrecognized_line"/></enum> +</class><class name="invalid_syntax"><inherit access="public">boost::program_options::error_with_option_name</inherit><description><para>Class thrown when there's syntax error either for command line or config file options. See derived children for concrete classes. </para></description><enum name="kind_t"><enumvalue name="long_not_allowed"><default>= 30</default></enumvalue><enumvalue name="long_adjacent_not_allowed"/><enumvalue name="short_adjacent_not_allowed"/><enumvalue name="empty_adjacent_parameter"/><enumvalue name="missing_parameter"/><enumvalue name="extra_parameter"/><enumvalue name="unrecognized_line"/></enum> <method-group name="public member functions"> <method name="kind" cv="const"><type>kind_t</type></method> <method name="tokens" cv="const" specifiers="virtual"><type>std::string</type><description><para>Convenience functions for backwards compatibility </para></description></method> @@ -147,7 +147,7 @@ </method-group> <constructor><parameter name="kind"><paramtype>kind_t</paramtype></parameter><parameter name="option_name"><paramtype>const std::string &</paramtype><default>""</default></parameter><parameter name="original_token"><paramtype>const std::string &</paramtype><default>""</default></parameter><parameter name="option_style"><paramtype>int</paramtype><default>0</default></parameter></constructor> <destructor/> -</class><class name="validation_error"><inherit access="public">boost::program_options::error_with_option_name</inherit><description><para>Class thrown when value of option is incorrect. </para></description><enum name="kind_t"><enumvalue name="multiple_values_not_allowed"><default> 30</default></enumvalue><enumvalue name="at_least_one_value_required"/><enumvalue name="invalid_bool_value"/><enumvalue name="invalid_option_value"/><enumvalue name="invalid_option"/></enum> +</class><class name="validation_error"><inherit access="public">boost::program_options::error_with_option_name</inherit><description><para>Class thrown when value of option is incorrect. </para></description><enum name="kind_t"><enumvalue name="multiple_values_not_allowed"><default>= 30</default></enumvalue><enumvalue name="at_least_one_value_required"/><enumvalue name="invalid_bool_value"/><enumvalue name="invalid_option_value"/><enumvalue name="invalid_option"/></enum> <method-group name="public member functions"> </method-group> <constructor><parameter name="kind"><paramtype>kind_t</paramtype></parameter><parameter name="option_name"><paramtype>const std::string &</paramtype><default>""</default></parameter><parameter name="original_token"><paramtype>const std::string &</paramtype><default>""</default></parameter><parameter name="option_style"><paramtype>int</paramtype><default>0</default></parameter></constructor> @@ -168,7 +168,6 @@ -<function name="strip_prefixes"><type>std::string</type><parameter name="text"><paramtype>const std::string &</paramtype></parameter></function> @@ -178,6 +177,7 @@ +<function name="strip_prefixes"><type>std::string</type><parameter name="text"><paramtype>const std::string &</paramtype></parameter></function> @@ -189,7 +189,7 @@ <namespace name="program_options"> <class name="basic_option"><template> <template-type-parameter name="charT"/> - </template><description><para>Option found in input source. Contains a key and a value. The key, in turn, can be a string (name of an option), or an integer (position in input source) \-- in case no name is specified. The latter is only possible for command line. The template parameter specifies the type of char used for storing the option's value. </para></description><data-member name="string_key"><type>std::string</type><description><para>String key of this option. Intentionally independent of the template parameter. </para></description></data-member> + </template><description><para>Option found in input source. Contains a key and a value. The key, in turn, can be a string (name of an option), or an integer (position in input source) -- in case no name is specified. The latter is only possible for command line. The template parameter specifies the type of char used for storing the option's value. </para></description><data-member name="string_key"><type>std::string</type><description><para>String key of this option. Intentionally independent of the template parameter. </para></description></data-member> <data-member name="position_key"><type>int</type><description><para>Position key of this option. All options without an explicit name are sequentially numbered starting from 0. If an option has explicit name, 'position_key' is equal to -1. It is possible that both position_key and string_key is specified, in case name is implicitly added. </para></description></data-member> <data-member name="value"><type>std::vector< std::basic_string< charT > ></type><description><para>Option's value </para></description></data-member> <data-member name="original_tokens"><type>std::vector< std::basic_string< charT > ></type><description><para>The original unchanged tokens this option was created from. </para></description></data-member> @@ -226,12 +226,12 @@ <header name="boost/program_options/options_description.hpp"> <namespace name="boost"> <namespace name="program_options"> -<class name="option_description"><description><para>Describes one possible command line/config file option. There are two kinds of properties of an option. First describe it syntactically and are used only to validate input. Second affect interpretation of the option, for example default value for it or function that should be called when the value is finally known. Routines which perform parsing never use second kind of properties \-- they are side effect free. <para><emphasis role="bold">See Also:</emphasis><para><classname alt="boost::program_options::options_description">options_description</classname> </para></para> +<class name="option_description"><description><para>Describes one possible command line/config file option. There are two kinds of properties of an option. First describe it syntactically and are used only to validate input. Second affect interpretation of the option, for example default value for it or function that should be called when the value is finally known. Routines which perform parsing never use second kind of properties -- they are side effect free. <para><emphasis role="bold">See Also:</emphasis><para><classname alt="boost::program_options::options_description">options_description</classname> </para></para> </para></description><enum name="match_result"><enumvalue name="no_match"/><enumvalue name="full_match"/><enumvalue name="approximate_match"/></enum> <method-group name="public member functions"> <method name="match" cv="const"><type>match_result</type><parameter name="option"><paramtype>const std::string &</paramtype></parameter><parameter name="approx"><paramtype>bool</paramtype></parameter><parameter name="long_ignore_case"><paramtype>bool</paramtype></parameter><parameter name="short_ignore_case"><paramtype>bool</paramtype></parameter><description><para>Given 'option', specified in the input source, returns 'true' if 'option' specifies *this. </para></description></method> <method name="key" cv="const"><type>const std::string &</type><parameter name="option"><paramtype>const std::string &</paramtype></parameter><description><para>Returns the key that should identify the option, in particular in the <classname alt="boost::program_options::variables_map">variables_map</classname> class. The 'option' parameter is the option spelling from the input source. If option name contains '*', returns 'option'. If long name was specified, it's the long name, otherwise it's a short name with prepended '-'. </para></description></method> -<method name="canonical_display_name" cv="const"><type>std::string</type><parameter name="canonical_option_style"><paramtype>int</paramtype><default>0</default></parameter><description><para>Returns the canonical name for the option description to enable the user to recognised a matching option. 1) For short options ('-', '/'), returns the short name prefixed. 2) For long options ('--' / '-') returns the long name prefixed 3) All other cases, returns the long name (if present) or the short name, unprefixed. </para></description></method> +<method name="canonical_display_name" cv="const"><type>std::string</type><parameter name="canonical_option_style"><paramtype>int</paramtype><default>0</default></parameter><description><para>Returns the canonical name for the option description to enable the user to recognised a matching option. 1) For short options ('-', '/'), returns the short name prefixed. 2) For long options ('–' / '-') returns the long name prefixed 3) All other cases, returns the long name (if present) or the short name, unprefixed. </para></description></method> <method name="long_name" cv="const"><type>const std::string &</type></method> <method name="description" cv="const"><type>const std::string &</type><purpose>Explanation of this option. </purpose></method> <method name="semantic" cv="const"><type>shared_ptr< const <classname>value_semantic</classname> ></type><purpose>Semantic of option's value. </purpose></method> @@ -240,7 +240,7 @@ </method-group> <constructor/> <constructor><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="s"><paramtype>const <classname>value_semantic</classname> *</paramtype></parameter><description><para>Initializes the object with the passed data.</para><para>Note: it would be nice to make the second parameter auto_ptr, to explicitly pass ownership. Unfortunately, it's often needed to create objects of types derived from '<classname alt="boost::program_options::value_semantic">value_semantic</classname>': <classname alt="boost::program_options::options_description">options_description</classname> d; d.add_options()("a", parameter<int>("n")->default_value(1)); Here, the static type returned by 'parameter' should be derived from <classname alt="boost::program_options::value_semantic">value_semantic</classname>.</para><para>Alas, derived->base conversion for auto_ptr does not really work, see <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2000/n1232.pdf">http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2000/n1232.pdf</ulink> <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#84">http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#84</ulink></para><para>So, we have to use plain old pointers. Besides, users are not expected to use the constructor directly.</para><para>The 'name' parameter is interpreted by the following rules:<itemizedlist> -<listitem><para>if there's no "," character in 'name', it specifies long name</para></listitem><listitem><para>otherwise, the part before "," specifies long name and the part after \-- short name. </para></listitem></itemizedlist> +<listitem><para>if there's no "," character in 'name', it specifies long name</para></listitem><listitem><para>otherwise, the part before "," specifies long name and the part after -- short name. </para></listitem></itemizedlist> </para></description></constructor> <constructor><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="s"><paramtype>const <classname>value_semantic</classname> *</paramtype></parameter><parameter name="description"><paramtype>const char *</paramtype></parameter><description><para>Initializes the class with the passed data. </para></description></constructor> <destructor/> @@ -318,7 +318,7 @@ <constructor specifiers="explicit"><parameter name="po"><paramtype>const <classname>basic_parsed_options</classname>< char > &</paramtype></parameter><description><para>Constructs wrapped options from options in UTF8 encoding. </para></description></constructor> </class-specialization><class name="basic_command_line_parser"><template> <template-type-parameter name="charT"/> - </template><description><para>Command line parser.</para><para>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 number of parameters will be confusing.</para><para>For the most common case, the function parse_command_line is a better alternative.</para><para>There are two typedefs \-- command_line_parser and wcommand_line_parser, for charT == char and charT == wchar_t cases. </para></description><method-group name="public member functions"> + </template><inherit access="private">cmdline</inherit><description><para>Command line parser.</para><para>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 number of parameters will be confusing.</para><para>For the most common case, the function parse_command_line is a better alternative.</para><para>There are two typedefs -- command_line_parser and wcommand_line_parser, for charT == char and charT == wchar_t cases. </para></description><method-group name="public member functions"> <method name="options"><type><classname>basic_command_line_parser</classname> &</type><parameter name="desc"><paramtype>const <classname>options_description</classname> &</paramtype></parameter><description><para>Sets options descriptions to use. </para></description></method> <method name="positional"><type><classname>basic_command_line_parser</classname> &</type><parameter name="desc"><paramtype>const <classname>positional_options_description</classname> &</paramtype></parameter><description><para>Sets positional options description to use. </para></description></method> <method name="style"><type><classname>basic_command_line_parser</classname> &</type><parameter name=""><paramtype>int</paramtype></parameter><description><para>Sets the command line style. </para></description></method> @@ -341,7 +341,6 @@ - <function name="parse_command_line"><type><classname>basic_parsed_options</classname>< charT ></type><template> <template-type-parameter name="charT"/> </template><parameter name="argc"><paramtype>int</paramtype></parameter><parameter name="argv"><paramtype>const charT *const</paramtype></parameter><parameter name=""><paramtype>const <classname>options_description</classname> &</paramtype></parameter><parameter name="style"><paramtype>int</paramtype><default>0</default></parameter><parameter name="ext"><paramtype>function1< std::pair< std::string, std::string >, const std::string & ></paramtype><default>ext_parser()</default></parameter><description><para>Creates instance of 'command_line_parser', passes parameters to it, and returns the result of calling the 'run' method. </para></description></function> @@ -362,6 +361,7 @@ + </namespace> </namespace> </header> @@ -449,9 +449,9 @@ </template><inherit access="public">boost::program_options::value_semantic_codecvt_helper< charT ></inherit><inherit access="public">boost::program_options::typed_value_base</inherit><description><para>Class which handles value of a specific type. </para></description><method-group name="public member functions"> <method name="default_value"><type><classname>typed_value</classname> *</type><parameter name="v"><paramtype>const T &</paramtype></parameter><description><para>Specifies default value, which will be used if none is explicitly specified. The type 'T' should provide operator<< for ostream. </para></description></method> <method name="default_value"><type><classname>typed_value</classname> *</type><parameter name="v"><paramtype>const T &</paramtype></parameter><parameter name="textual"><paramtype>const std::string &</paramtype></parameter><description><para>Specifies default value, which will be used if none is explicitly specified. Unlike the above overload, the type 'T' need not provide operator<< for ostream, but textual representation of default value must be provided by the user. </para></description></method> -<method name="implicit_value"><type><classname>typed_value</classname> *</type><parameter name="v"><paramtype>const T &</paramtype></parameter><description><para>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, but if given, must be strictly adjacent to the option, i.e.: '-ovalue' or '--option=value'. Giving '-o' or '--option' will cause the implicit value to be applied. </para></description></method> +<method name="implicit_value"><type><classname>typed_value</classname> *</type><parameter name="v"><paramtype>const T &</paramtype></parameter><description><para>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, but if given, must be strictly adjacent to the option, i.e.: '-ovalue' or '–option=value'. Giving '-o' or '–option' will cause the implicit value to be applied. </para></description></method> <method name="value_name"><type><classname>typed_value</classname> *</type><parameter name="name"><paramtype>const std::string &</paramtype></parameter><description><para>Specifies the name used to to the value in help message. </para></description></method> -<method name="implicit_value"><type><classname>typed_value</classname> *</type><parameter name="v"><paramtype>const T &</paramtype></parameter><parameter name="textual"><paramtype>const std::string &</paramtype></parameter><description><para>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, but if given, must be strictly adjacent to the option, i.e.: '-ovalue' or '--option=value'. Giving '-o' or '--option' will cause the implicit value to be applied. Unlike the above overload, the type 'T' need not provide operator<< for ostream, but textual representation of default value must be provided by the user. </para></description></method> +<method name="implicit_value"><type><classname>typed_value</classname> *</type><parameter name="v"><paramtype>const T &</paramtype></parameter><parameter name="textual"><paramtype>const std::string &</paramtype></parameter><description><para>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, but if given, must be strictly adjacent to the option, i.e.: '-ovalue' or '–option=value'. Giving '-o' or '–option' will cause the implicit value to be applied. Unlike the above overload, the type 'T' need not provide operator<< for ostream, but textual representation of default value must be provided by the user. </para></description></method> <method name="notifier"><type><classname>typed_value</classname> *</type><parameter name="f"><paramtype>function1< void, const T & ></paramtype></parameter><description><para>Specifies a function to be called when the final value is determined. </para></description></method> <method name="composing"><type><classname>typed_value</classname> *</type><description><para>Specifies that the value is composing. See the 'is_composing' method for explanation. </para></description></method> <method name="multitoken"><type><classname>typed_value</classname> *</type><description><para>Specifies that the value can span multiple tokens. </para></description></method> @@ -523,13 +523,9 @@ <method name="operator[]" cv="const"><type>const <classname>variable_value</classname> &</type><parameter name="name"><paramtype>const std::string &</paramtype></parameter><description><para>Obtains the value of variable 'name', from *this and possibly from the chain of variable maps.</para><para><itemizedlist> <listitem><para>if there's no value in *this.<itemizedlist> <listitem><para>if there's next variable map, returns value from it</para></listitem><listitem><para>otherwise, returns empty value</para></listitem></itemizedlist> -</para></listitem></itemizedlist> -</para><para><itemizedlist> -<listitem><para>if there's defaulted value<itemizedlist> +</para></listitem><listitem><para>if there's defaulted value<itemizedlist> <listitem><para>if there's next variable map, which has a non-defaulted value, return that</para></listitem><listitem><para>otherwise, return value from *this</para></listitem></itemizedlist> -</para></listitem></itemizedlist> -</para><para><itemizedlist> -<listitem><para>if there's a non-defaulted value, returns it. </para></listitem></itemizedlist> +</para></listitem><listitem><para>if there's a non-defaulted value, returns it. </para></listitem></itemizedlist> </para></description></method> <method name="next"><type>void</type><parameter name="next"><paramtype><classname>abstract_variables_map</classname> *</paramtype></parameter><description><para>Sets next variable map, which will be used to find variables not found in *this. </para></description></method> </method-group> @@ -539,18 +535,8 @@ <method-group name="private member functions"> <method name="get" cv="const = 0" specifiers="virtual"><type>const <classname>variable_value</classname> &</type><parameter name="name"><paramtype>const std::string &</paramtype></parameter><description><para>Returns value of variable 'name' stored in *this, or empty value otherwise. </para></description></method> </method-group> -</class><class name="variables_map"><inherit access="public">boost::program_options::abstract_variables_map</inherit><description><para>Concrete variables map which store variables in real map.</para><para>This class is derived from std::map<std::string, variable_value>, so you can use all map operators to examine its content. </para></description><method-group name="public member functions"> -<method name="operator[]" cv="const"><type>const <classname>variable_value</classname> &</type><parameter name="name"><paramtype>const std::string &</paramtype></parameter><description><para>Obtains the value of variable 'name', from *this and possibly from the chain of variable maps.</para><para><itemizedlist> -<listitem><para>if there's no value in *this.<itemizedlist> -<listitem><para>if there's next variable map, returns value from it</para></listitem><listitem><para>otherwise, returns empty value</para></listitem></itemizedlist> -</para></listitem></itemizedlist> -</para><para><itemizedlist> -<listitem><para>if there's defaulted value<itemizedlist> -<listitem><para>if there's next variable map, which has a non-defaulted value, return that</para></listitem><listitem><para>otherwise, return value from *this</para></listitem></itemizedlist> -</para></listitem></itemizedlist> -</para><para><itemizedlist> -<listitem><para>if there's a non-defaulted value, returns it. </para></listitem></itemizedlist> -</para></description></method> +</class><class name="variables_map"><inherit access="public">boost::program_options::abstract_variables_map</inherit><inherit access="public">std::map< std::string, variable_value ></inherit><description><para>Concrete variables map which store variables in real map.</para><para>This class is derived from std::map<std::string, variable_value>, so you can use all map operators to examine its content. </para></description><method-group name="public member functions"> +<method name="operator[]" cv="const"><type>const <classname>variable_value</classname> &</type><parameter name="name"><paramtype>const std::string &</paramtype></parameter></method> <method name="clear"><type>void</type></method> <method name="notify"><type>void</type></method> </method-group> @@ -587,4 +573,4 @@ <header name="boost/program_options/version.hpp"> <macro name="BOOST_PROGRAM_OPTIONS_VERSION"><description><para>The version of the source interface. The value will be incremented whenever a change is made which might cause compilation errors for existing code. </para></description></macro> </header> -</library-reference> +</library-reference>
\ No newline at end of file diff --git a/libs/program_options/doc/html/BOOST_PROGRAM_OPTIONS_DECL.html b/libs/program_options/doc/html/BOOST_PROGRAM_OPTIONS_DECL.html deleted file mode 100644 index 8ce7fa1a11..0000000000 --- a/libs/program_options/doc/html/BOOST_PROGRAM_OPTIONS_DECL.html +++ /dev/null @@ -1,49 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Macro BOOST_PROGRAM_OPTIONS_DECL</title> -<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="program_options/reference.html#header.boost.program_options.config_hpp" title="Header <boost/program_options/config.hpp>"> -<link rel="prev" href="boost/program_options/command_line_style/style_t.html" title="Type style_t"> -<link rel="next" href="boost/environment_iterator.html" title="Class environment_iterator"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> -<td align="center"><a href="../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="boost/program_options/command_line_style/style_t.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#header.boost.program_options.config_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="boost/environment_iterator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="BOOST_PROGRAM_OPTIONS_DECL"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Macro BOOST_PROGRAM_OPTIONS_DECL</span></h2> -<p>BOOST_PROGRAM_OPTIONS_DECL</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="program_options/reference.html#header.boost.program_options.config_hpp" title="Header <boost/program_options/config.hpp>">boost/program_options/config.hpp</a>> - -</span>BOOST_PROGRAM_OPTIONS_DECL</pre></div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="boost/program_options/command_line_style/style_t.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#header.boost.program_options.config_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="boost/environment_iterator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/BOOST_PROGRAM_OPTIONS_VERSION.html b/libs/program_options/doc/html/BOOST_PROGRAM_OPTIONS_VERSION.html deleted file mode 100644 index eff98c9f3a..0000000000 --- a/libs/program_options/doc/html/BOOST_PROGRAM_OPTIONS_VERSION.html +++ /dev/null @@ -1,52 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Macro BOOST_PROGRAM_OPTIONS_VERSION</title> -<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="program_options/reference.html#header.boost.program_options.version_hpp" title="Header <boost/program_options/version.hpp>"> -<link rel="prev" href="boost/program_options/notify.html" title="Function notify"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> -<td align="center"><a href="../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="boost/program_options/notify.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#header.boost.program_options.version_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> -</div> -<div class="refentry"> -<a name="BOOST_PROGRAM_OPTIONS_VERSION"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Macro BOOST_PROGRAM_OPTIONS_VERSION</span></h2> -<p>BOOST_PROGRAM_OPTIONS_VERSION</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="program_options/reference.html#header.boost.program_options.version_hpp" title="Header <boost/program_options/version.hpp>">boost/program_options/version.hpp</a>> - -</span>BOOST_PROGRAM_OPTIONS_VERSION</pre></div> -<div class="refsect1"> -<a name="idp67295152"></a><h2>Description</h2> -<p>The version of the source interface. The value will be incremented whenever a change is made which might cause compilation errors for existing code. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="boost/program_options/notify.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#header.boost.program_options.version_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> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/environment_iterator.html b/libs/program_options/doc/html/boost/environment_iterator.html deleted file mode 100644 index 37ebd722ac..0000000000 --- a/libs/program_options/doc/html/boost/environment_iterator.html +++ /dev/null @@ -1,77 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class environment_iterator</title> -<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../program_options/reference.html#header.boost.program_options.environment_iterator_hpp" title="Header <boost/program_options/environment_iterator.hpp>"> -<link rel="prev" href="../BOOST_PROGRAM_OPTIONS_DECL.html" title="Macro BOOST_PROGRAM_OPTIONS_DECL"> -<link rel="next" href="eof_iterator.html" title="Class template eof_iterator"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> -<td align="center"><a href="../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../BOOST_PROGRAM_OPTIONS_DECL.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../program_options/reference.html#header.boost.program_options.environment_iterator_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="eof_iterator.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.environment_iterator"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class environment_iterator</span></h2> -<p>boost::environment_iterator</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../program_options/reference.html#header.boost.program_options.environment_iterator_hpp" title="Header <boost/program_options/environment_iterator.hpp>">boost/program_options/environment_iterator.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="environment_iterator.html" title="Class environment_iterator">environment_iterator</a> <span class="special">:</span> <span class="keyword">public</span> boost::eof_iterator< environment_iterator, std::pair< std::string, std::string > > -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="environment_iterator.html#boost.environment_iteratorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="environment_iterator.html#idp10985568-bb"><span class="identifier">environment_iterator</span></a><span class="special">(</span><span class="keyword">char</span> <span class="special">*</span><span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="environment_iterator.html#idp10986544-bb"><span class="identifier">environment_iterator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="environment_iterator.html#idp10984000-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="environment_iterator.html#idp10984560-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp62978688"></a><h2>Description</h2> -<div class="refsect2"> -<a name="idp62979072"></a><h3> -<a name="boost.environment_iteratorconstruct-copy-destruct"></a><code class="computeroutput">environment_iterator</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp10985568-bb"></a><span class="identifier">environment_iterator</span><span class="special">(</span><span class="keyword">char</span> <span class="special">*</span><span class="special">*</span> environment<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp10986544-bb"></a><span class="identifier">environment_iterator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp62989456"></a><h3> -<a name="idp10984000-bb"></a><code class="computeroutput">environment_iterator</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp10984560-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../BOOST_PROGRAM_OPTIONS_DECL.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../program_options/reference.html#header.boost.program_options.environment_iterator_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="eof_iterator.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/eof_iterator.html b/libs/program_options/doc/html/boost/eof_iterator.html deleted file mode 100644 index 0e863da307..0000000000 --- a/libs/program_options/doc/html/boost/eof_iterator.html +++ /dev/null @@ -1,111 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class template eof_iterator</title> -<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../program_options/reference.html#header.boost.program_options.eof_iterator_hpp" title="Header <boost/program_options/eof_iterator.hpp>"> -<link rel="prev" href="environment_iterator.html" title="Class environment_iterator"> -<link rel="next" href="program_options/error.html" title="Class error"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> -<td align="center"><a href="../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="environment_iterator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../program_options/reference.html#header.boost.program_options.eof_iterator_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="program_options/error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.eof_iterator"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class template eof_iterator</span></h2> -<p>boost::eof_iterator</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../program_options/reference.html#header.boost.program_options.eof_iterator_hpp" title="Header <boost/program_options/eof_iterator.hpp>">boost/program_options/eof_iterator.hpp</a>> - -</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Derived<span class="special">,</span> <span class="keyword">typename</span> ValueType<span class="special">></span> -<span class="keyword">class</span> <a class="link" href="eof_iterator.html" title="Class template eof_iterator">eof_iterator</a> <span class="special">:</span> - <span class="keyword">public</span> <span class="identifier">iterator_facade</span><span class="special"><</span> <span class="identifier">Derived</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">ValueType</span><span class="special">,</span> <span class="identifier">forward_traversal_tag</span> <span class="special">></span> -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="eof_iterator.html#boost.eof_iteratorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="eof_iterator.html#idp5618128-bb"><span class="identifier">eof_iterator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="eof_iterator.html#idp5618416-bb">protected member functions</a></span> - <span class="identifier">ValueType</span> <span class="special">&</span> <a class="link" href="eof_iterator.html#idp5618992-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="eof_iterator.html#idp5620224-bb"><span class="identifier">found_eof</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="eof_iterator.html#idp7887184-bb">private member functions</a></span> - <span class="keyword">void</span> <a class="link" href="eof_iterator.html#idp7887760-bb"><span class="identifier">increment</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="eof_iterator.html#idp7888608-bb"><span class="identifier">equal</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="eof_iterator.html" title="Class template eof_iterator">eof_iterator</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">ValueType</span> <span class="special">&</span> <a class="link" href="eof_iterator.html#idp7890864-bb"><span class="identifier">dereference</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63048064"></a><h2>Description</h2> -<p>The '<a class="link" href="eof_iterator.html" title="Class template eof_iterator">eof_iterator</a>' class is useful for constructing forward iterators in cases where iterator extract data from some source and it's easy to detect 'eof' \-- i.e. the situation where there's no data. One apparent example is reading lines from a file.</p> -<p>Implementing such iterators using 'iterator_facade' directly would require to create class with three core operation, a couple of constructors. When using '<a class="link" href="eof_iterator.html" title="Class template eof_iterator">eof_iterator</a>', the derived class should define only one method to get new value, plus a couple of constructors.</p> -<p>The basic idea is that iterator has 'eof' bit. Two iterators are equal only if both have their 'eof' bits set. The 'get' method either obtains the new value or sets the 'eof' bit.</p> -<p>Specifically, derived class should define:</p> -<p>1. A default constructor, which creates iterator with 'eof' bit set. The constructor body should call 'found_eof' method defined here. 2. Some other constructor. It should initialize some 'data pointer' used in iterator operation and then call 'get'. 3. The 'get' method. It should operate this way:</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>look at some 'data pointer' to see if new element is available; if not, it should call 'found_eof'.</p></li> -<li class="listitem"><p>extract new element and store it at location returned by the 'value' method.</p></li> -<li class="listitem"><p>advance the data pointer.</p></li> -</ul></div> -<p> -</p> -<p>Essentially, the 'get' method has the functionality of both 'increment' and 'dereference'. It's very good for the cases where data extraction implicitly moves data pointer, like for stream operation. </p> -<div class="refsect2"> -<a name="idp63054160"></a><h3> -<a name="boost.eof_iteratorconstruct-copy-destruct"></a><code class="computeroutput">eof_iterator</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp5618128-bb"></a><span class="identifier">eof_iterator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -<div class="refsect2"> -<a name="idp63059232"></a><h3> -<a name="idp5618416-bb"></a><code class="computeroutput">eof_iterator</code> protected member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">ValueType</span> <span class="special">&</span> <a name="idp5618992-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<p>Returns the reference which should be used by derived class to store the next value. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp5620224-bb"></a><span class="identifier">found_eof</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<p>Should be called by derived class to indicate that it can't produce next element. </p> -</li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp63069904"></a><h3> -<a name="idp7887184-bb"></a><code class="computeroutput">eof_iterator</code> private member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp7887760-bb"></a><span class="identifier">increment</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp7888608-bb"></a><span class="identifier">equal</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="eof_iterator.html" title="Class template eof_iterator">eof_iterator</a> <span class="special">&</span> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">ValueType</span> <span class="special">&</span> <a name="idp7890864-bb"></a><span class="identifier">dereference</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="environment_iterator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../program_options/reference.html#header.boost.program_options.eof_iterator_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="program_options/error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/abstract_variables_map.html b/libs/program_options/doc/html/boost/program_options/abstract_variables_map.html deleted file mode 100644 index 723a54cc5c..0000000000 --- a/libs/program_options/doc/html/boost/program_options/abstract_variables_map.html +++ /dev/null @@ -1,125 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class abstract_variables_map</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> -<link rel="prev" href="variable_value.html" title="Class variable_value"> -<link rel="next" href="variables_map.html" title="Class variables_map"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="variable_value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="variables_map.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.abstract_variables_map"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class abstract_variables_map</span></h2> -<p>boost::program_options::abstract_variables_map</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>">boost/program_options/variables_map.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="abstract_variables_map.html#boost.program_options.abstract_variables_mapconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="abstract_variables_map.html#idp5551184-bb"><span class="identifier">abstract_variables_map</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="abstract_variables_map.html#idp5551472-bb"><span class="identifier">abstract_variables_map</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="abstract_variables_map.html#idp5552896-bb"><span class="special">~</span><span class="identifier">abstract_variables_map</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="abstract_variables_map.html#idp8294720-bb">public member functions</a></span> - <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="abstract_variables_map.html#idp9170800-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</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="special">;</span> - <span class="keyword">void</span> <a class="link" href="abstract_variables_map.html#idp9179104-bb"><span class="identifier">next</span></a><span class="special">(</span><a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="abstract_variables_map.html#idp5553184-bb">private member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="abstract_variables_map.html#idp5553760-bb"><span class="identifier">get</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="special">=</span> <span class="number">0</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp67054032"></a><h2>Description</h2> -<p>Implements string->string mapping with convenient value casting facilities. </p> -<div class="refsect2"> -<a name="idp67054880"></a><h3> -<a name="boost.program_options.abstract_variables_mapconstruct-copy-destruct"></a><code class="computeroutput">abstract_variables_map</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp5551184-bb"></a><span class="identifier">abstract_variables_map</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp5551472-bb"></a><span class="identifier">abstract_variables_map</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span> next<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp5552896-bb"></a><span class="special">~</span><span class="identifier">abstract_variables_map</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp67070704"></a><h3> -<a name="idp8294720-bb"></a><code class="computeroutput">abstract_variables_map</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp9170800-bb"></a><span class="keyword">operator</span><span class="special">[</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> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Obtains the value of variable 'name', from *this and possibly from the chain of variable maps.</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> -<p>if there's no value in *this.</p> -<div class="itemizedlist"><ul class="itemizedlist" type="circle"> -<li class="listitem"><p>if there's next variable map, returns value from it</p></li> -<li class="listitem"><p>otherwise, returns empty value</p></li> -</ul></div> -<p> -</p> -</li></ul></div> -<p> -</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> -<p>if there's defaulted value</p> -<div class="itemizedlist"><ul class="itemizedlist" type="circle"> -<li class="listitem"><p>if there's next variable map, which has a non-defaulted value, return that</p></li> -<li class="listitem"><p>otherwise, return value from *this</p></li> -</ul></div> -<p> -</p> -</li></ul></div> -<p> -</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>if there's a non-defaulted value, returns it. </p></li></ul></div> -<p> -</p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp9179104-bb"></a><span class="identifier">next</span><span class="special">(</span><a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span> next<span class="special">)</span><span class="special">;</span></pre> -<p>Sets next variable map, which will be used to find variables not found in *this. </p> -</li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp67095664"></a><h3> -<a name="idp5553184-bb"></a><code class="computeroutput">abstract_variables_map</code> private member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp5553760-bb"></a><span class="identifier">get</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> name<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> -<p>Returns value of variable 'name' stored in *this, or empty value otherwise. </p> -</li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="variable_value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="variables_map.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/ambiguous_option.html b/libs/program_options/doc/html/boost/program_options/ambiguous_option.html deleted file mode 100644 index 42d9a7c78d..0000000000 --- a/libs/program_options/doc/html/boost/program_options/ambiguous_option.html +++ /dev/null @@ -1,90 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class ambiguous_option</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="unknown_option.html" title="Class unknown_option"> -<link rel="next" href="invalid_syntax.html" title="Class invalid_syntax"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="unknown_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_syntax.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.ambiguous_option"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class ambiguous_option</span></h2> -<p>boost::program_options::ambiguous_option</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="ambiguous_option.html" title="Class ambiguous_option">ambiguous_option</a> <span class="special">:</span> - <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error_with_no_option_name</span> -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="ambiguous_option.html#boost.program_options.ambiguous_optionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="ambiguous_option.html#idp8685760-bb"><span class="identifier">ambiguous_option</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="ambiguous_option.html#idp8686752-bb"><span class="special">~</span><span class="identifier">ambiguous_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="ambiguous_option.html#idp8684016-bb">public member functions</a></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">string</span> <span class="special">></span> <span class="special">&</span> <a class="link" href="ambiguous_option.html#idp8684464-bb"><span class="identifier">alternatives</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="ambiguous_option.html#idp8687040-bb">protected member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="ambiguous_option.html#idp8687616-bb"><span class="identifier">substitute_placeholders</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="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63747936"></a><h2>Description</h2> -<p>Class thrown when there's ambiguity amoung several possible options. </p> -<div class="refsect2"> -<a name="idp63748608"></a><h3> -<a name="boost.program_options.ambiguous_optionconstruct-copy-destruct"></a><code class="computeroutput">ambiguous_option</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp8685760-bb"></a><span class="identifier">ambiguous_option</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">string</span> <span class="special">></span> <span class="special">&</span> xalternatives<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp8686752-bb"></a><span class="special">~</span><span class="identifier">ambiguous_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp63764768"></a><h3> -<a name="idp8684016-bb"></a><code class="computeroutput">ambiguous_option</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><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">string</span> <span class="special">></span> <span class="special">&</span> <a name="idp8684464-bb"></a><span class="identifier">alternatives</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div> -</div> -<div class="refsect2"> -<a name="idp63777296"></a><h3> -<a name="idp8687040-bb"></a><code class="computeroutput">ambiguous_option</code> protected member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp8687616-bb"></a><span class="identifier">substitute_placeholders</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> error_template<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Makes all substitutions using the template </p> -</li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="unknown_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_syntax.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/basic_command_line_parser.html b/libs/program_options/doc/html/boost/program_options/basic_command_line_parser.html deleted file mode 100644 index 04dab0097d..0000000000 --- a/libs/program_options/doc/html/boost/program_options/basic_command_line_parser.html +++ /dev/null @@ -1,120 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class template basic_command_line_parser</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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_op_idp8181920.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"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="basic_parsed_op_idp8181920.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> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class template basic_command_line_parser</span></h2> -<p>boost::program_options::basic_command_line_parser</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</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="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#idp8804368-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#idp8805792-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#idp184384-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#idp184944-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#idp187664-bb"><span class="identifier">positional</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="positional_opti_idp5922480.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#idp190352-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#idp209264-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#idp211536-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#idp213056-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#idp214976-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="idp65364976"></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 number 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="idp65366992"></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="idp8804368-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="idp8805792-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="idp65389328"></a><h3> -<a name="idp184384-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="idp184944-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="idp187664-bb"></a><span class="identifier">positional</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="positional_opti_idp5922480.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="idp190352-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="idp209264-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="idp211536-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="idp213056-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="idp214976-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> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="basic_parsed_op_idp8181920.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> diff --git a/libs/program_options/doc/html/boost/program_options/basic_option.html b/libs/program_options/doc/html/boost/program_options/basic_option.html deleted file mode 100644 index 0afe33fad8..0000000000 --- a/libs/program_options/doc/html/boost/program_options/basic_option.html +++ /dev/null @@ -1,110 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class template basic_option</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.option_hpp" title="Header <boost/program_options/option.hpp>"> -<link rel="prev" href="invalid_bool_value.html" title="Class invalid_bool_value"> -<link rel="next" href="option_description.html" title="Class option_description"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="invalid_bool_value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.option_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="option_description.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.basic_option"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class template basic_option</span></h2> -<p>boost::program_options::basic_option</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.option_hpp" title="Header <boost/program_options/option.hpp>">boost/program_options/option.hpp</a>> - -</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="basic_option.html" title="Class template basic_option">basic_option</a> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="basic_option.html#boost.program_options.basic_optionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_option.html#idp5380768-bb"><span class="identifier">basic_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_option.html#idp5381056-bb"><span class="identifier">basic_option</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">vector</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="comment">// <a class="link" href="basic_option.html#boost.program_options.basic_optionpublic-data-members">public data members</a></span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="basic_option.html#boost.program_options.basic_option.string_key"><span class="identifier">string_key</span></a><span class="special">;</span> - <span class="keyword">int</span> <a class="link" href="basic_option.html#boost.program_options.basic_option.position_key"><span class="identifier">position_key</span></a><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="basic_option.html#boost.program_options.basic_option.value"><span class="identifier">value</span></a><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="basic_option.html#boost.program_options.basic_option.original_tokens"><span class="identifier">original_tokens</span></a><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="basic_option.html#boost.program_options.basic_option.unregistered"><span class="identifier">unregistered</span></a><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="basic_option.html#boost.program_options.basic_option.case_insensitive"><span class="identifier">case_insensitive</span></a><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp64235808"></a><h2>Description</h2> -<p>Option found in input source. Contains a key and a value. The key, in turn, can be a string (name of an option), or an integer (position in input source) \-- in case no name is specified. The latter is only possible for command line. The template parameter specifies the type of char used for storing the option's value. </p> -<div class="refsect2"> -<a name="idp64236816"></a><h3> -<a name="boost.program_options.basic_optionconstruct-copy-destruct"></a><code class="computeroutput">basic_option</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp5380768-bb"></a><span class="identifier">basic_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp5381056-bb"></a><span class="identifier">basic_option</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> xstring_key<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">string</span> <span class="special">></span> <span class="special">&</span> xvalue<span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp64256320"></a><h3> -<a name="boost.program_options.basic_optionpublic-data-members"></a><code class="computeroutput">basic_option</code> - public - public data members</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="boost.program_options.basic_option.string_key"></a><span class="identifier">string_key</span><span class="special">;</span></pre> -<p>String key of this option. Intentionally independent of the template parameter. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">int</span> <a name="boost.program_options.basic_option.position_key"></a><span class="identifier">position_key</span><span class="special">;</span></pre> -<p>Position key of this option. All options without an explicit name are sequentially numbered starting from 0. If an option has explicit name, 'position_key' is equal to -1. It is possible that both position_key and string_key is specified, in case name is implicitly added. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><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 name="boost.program_options.basic_option.value"></a><span class="identifier">value</span><span class="special">;</span></pre> -<p>Option's value </p> -</li> -<li class="listitem"> -<pre class="literallayout"><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 name="boost.program_options.basic_option.original_tokens"></a><span class="identifier">original_tokens</span><span class="special">;</span></pre> -<p>The original unchanged tokens this option was created from. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="boost.program_options.basic_option.unregistered"></a><span class="identifier">unregistered</span><span class="special">;</span></pre> -<p>True if option was not recognized. In that case, 'string_key' and 'value' are results of purely syntactic parsing of source. The original tokens can be recovered from the "original_tokens" member. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="boost.program_options.basic_option.case_insensitive"></a><span class="identifier">case_insensitive</span><span class="special">;</span></pre> -<p>True if string_key has to be handled case insensitive. </p> -</li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="invalid_bool_value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.option_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="option_description.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/basic_parsed_op_idp8181920.html b/libs/program_options/doc/html/boost/program_options/basic_parsed_op_idp8181920.html deleted file mode 100644 index 6ca5fb0822..0000000000 --- a/libs/program_options/doc/html/boost/program_options/basic_parsed_op_idp8181920.html +++ /dev/null @@ -1,96 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class basic_parsed_options<wchar_t></title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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.html" title="Class template basic_parsed_options"> -<link rel="next" href="basic_command_line_parser.html" title="Class template basic_command_line_parser"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="basic_parsed_options.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="basic_command_line_parser.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.basic_parsed_op_idp8181920"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class basic_parsed_options<wchar_t></span></h2> -<p>boost::program_options::basic_parsed_options<wchar_t></p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="basic_parsed_op_idp8181920.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">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="basic_parsed_op_idp8181920.html#boost.program_options.basic_parsed_op_idp8181920construct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="basic_parsed_op_idp8181920.html#idp7463808-bb"><span class="identifier">basic_parsed_options</span></a><span class="special">(</span><span class="keyword">const</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="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="basic_parsed_op_idp8181920.html#boost.program_options.basic_parsed_op_idp8181920public-data-members">public data members</a></span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <a class="link" href="basic_option.html" title="Class template basic_option">basic_option</a><span class="special"><</span> <span class="keyword">wchar_t</span> <span class="special">></span> <span class="special">></span> <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> <span class="identifier">description</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="keyword">char</span> <span class="special">></span> <a class="link" href="basic_parsed_op_idp8181920.html#boost.program_options.basic_parsed_op_idp8181920.utf8_encoded_options"><span class="identifier">utf8_encoded_options</span></a><span class="special">;</span> - <span class="keyword">int</span> <a class="link" href="basic_parsed_op_idp8181920.html#boost.program_options.basic_parsed_op_idp8181920.m_options_prefix"><span class="identifier">m_options_prefix</span></a><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65268416"></a><h2>Description</h2> -<p>Specialization of <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a> which:</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>provides convenient conversion from <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options<char></a></p></li> -<li class="listitem"><p>stores the passed char-based options for later use. </p></li> -</ul></div> -<p> -</p> -<div class="refsect2"> -<a name="idp65272048"></a><h3> -<a name="boost.program_options.basic_parsed_op_idp8181920construct-copy-destruct"></a><code class="computeroutput">basic_parsed_options</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp7463808-bb"></a><span class="identifier">basic_parsed_options</span><span class="special">(</span><span class="keyword">const</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="keyword">char</span> <span class="special">></span> <span class="special">&</span> po<span class="special">)</span><span class="special">;</span></pre> -<p>Constructs wrapped options from options in UTF8 encoding. </p> -</li></ol></div> -</div> -<div class="refsect2"> -<a name="idp65283200"></a><h3> -<a name="boost.program_options.basic_parsed_op_idp8181920public-data-members"></a><code class="computeroutput">basic_parsed_options</code> - public - public data members</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<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="keyword">char</span> <span class="special">></span> <a name="boost.program_options.basic_parsed_op_idp8181920.utf8_encoded_options"></a><span class="identifier">utf8_encoded_options</span><span class="special">;</span></pre> -<p>Stores UTF8 encoded options that were passed to constructor, to avoid reverse conversion in some cases. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">int</span> <a name="boost.program_options.basic_parsed_op_idp8181920.m_options_prefix"></a><span class="identifier">m_options_prefix</span><span class="special">;</span></pre> -<p>Mainly used for the diagnostic messages in exceptions. The canonical option prefix for the parser which generated these results, depending on the settings for basic_command_line_parser::style() or cmdline::style(). In order of precedence of command_line_style enums: allow_long allow_long_disguise allow_dash_for_short allow_slash_for_short </p> -</li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="basic_parsed_options.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="basic_command_line_parser.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/basic_parsed_options.html b/libs/program_options/doc/html/boost/program_options/basic_parsed_options.html deleted file mode 100644 index 52aab4c6ea..0000000000 --- a/libs/program_options/doc/html/boost/program_options/basic_parsed_options.html +++ /dev/null @@ -1,95 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class template basic_parsed_options</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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="duplicate_option_error.html" title="Class duplicate_option_error"> -<link rel="next" href="basic_parsed_op_idp8181920.html" title="Class basic_parsed_options<wchar_t>"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="duplicate_option_error.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="basic_parsed_op_idp8181920.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.basic_parsed_options"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class template basic_parsed_options</span></h2> -<p>boost::program_options::basic_parsed_options</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</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="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_optionsconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="basic_parsed_options.html#idp6014160-bb"><span class="identifier">basic_parsed_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="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_optionspublic-data-members">public data members</a></span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <a class="link" href="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> <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_options.options"><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> <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_options.description"><span class="identifier">description</span></a><span class="special">;</span> - <span class="keyword">int</span> <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_options.m_options_prefix"><span class="identifier">m_options_prefix</span></a><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65194496"></a><h2>Description</h2> -<p>Results of parsing an input source. The primary use of this class is passing information from parsers component to value storage component. This class does not makes much sense itself. </p> -<div class="refsect2"> -<a name="idp65195376"></a><h3> -<a name="boost.program_options.basic_parsed_optionsconstruct-copy-destruct"></a><code class="computeroutput">basic_parsed_options</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp6014160-bb"></a><span class="identifier">basic_parsed_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> xdescription<span class="special">,</span> - <span class="keyword">int</span> options_prefix <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -<div class="refsect2"> -<a name="idp65206800"></a><h3> -<a name="boost.program_options.basic_parsed_optionspublic-data-members"></a><code class="computeroutput">basic_parsed_options</code> - public - public data members</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <a class="link" href="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> <a name="boost.program_options.basic_parsed_options.options"></a><span class="identifier">options</span><span class="special">;</span></pre> -<p>Options found in the source. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> <a name="boost.program_options.basic_parsed_options.description"></a><span class="identifier">description</span><span class="special">;</span></pre> -<p>Options description that was used for parsing. Parsers should return pointer to the instance of <a class="link" href="option_description.html" title="Class option_description">option_description</a> passed to them, and issues of lifetime are up to the caller. Can be NULL. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">int</span> <a name="boost.program_options.basic_parsed_options.m_options_prefix"></a><span class="identifier">m_options_prefix</span><span class="special">;</span></pre> -<p>Mainly used for the diagnostic messages in exceptions. The canonical option prefix for the parser which generated these results, depending on the settings for basic_command_line_parser::style() or cmdline::style(). In order of precedence of command_line_style enums: allow_long allow_long_disguise allow_dash_for_short allow_slash_for_short </p> -</li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp65227888"></a><h3>Specializations</h3> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><a class="link" href="basic_parsed_op_idp8181920.html" title="Class basic_parsed_options<wchar_t>">Class basic_parsed_options<wchar_t></a></p></li></ul></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="duplicate_option_error.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="basic_parsed_op_idp8181920.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/bool_switch.html b/libs/program_options/doc/html/boost/program_options/bool_switch.html deleted file mode 100644 index f90d744021..0000000000 --- a/libs/program_options/doc/html/boost/program_options/bool_switch.html +++ /dev/null @@ -1,55 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function bool_switch</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="wvalue.html" title="Function wvalue"> -<link rel="next" href="variable_value.html" title="Class variable_value"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="wvalue.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="variable_value.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.bool_switch"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function bool_switch</span></h2> -<p>boost::program_options::bool_switch</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> - -</span> -<span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="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> <span class="identifier">bool_switch</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="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> <span class="identifier">bool_switch</span><span class="special">(</span><span class="keyword">bool</span> <span class="special">*</span> v<span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp66812832"></a><h2>Description</h2> -<p>Works the same way as the 'value<bool>' function, but the created <code class="computeroutput"><a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a></code> won't accept any explicit value. So, if the option is present on the command line, the value will be 'true'. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="wvalue.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="variable_value.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/collect_unrecognized.html b/libs/program_options/doc/html/boost/program_options/collect_unrecognized.html deleted file mode 100644 index b03c5acdd7..0000000000 --- a/libs/program_options/doc/html/boost/program_options/collect_unrecognized.html +++ /dev/null @@ -1,57 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function template collect_unrecognized</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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="parse_config_fi_idp5606176.html" title="Function template parse_config_file"> -<link rel="next" href="parse_environme_idp6997248.html" title="Function parse_environment"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="parse_config_fi_idp5606176.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="parse_environme_idp6997248.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.collect_unrecognized"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function template collect_unrecognized</span></h2> -<p>boost::program_options::collect_unrecognized</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</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> - <span class="identifier">collect_unrecognized</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> <a class="link" href="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> options<span class="special">,</span> - <span class="keyword">enum</span> <span class="identifier">collect_unrecognized_mode</span> mode<span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65571456"></a><h2>Description</h2> -<p>Collects the original tokens for all named options with 'unregistered' flag set. If 'mode' is 'include_positional' also collects all positional options. Returns the vector of origianl tokens for all collected options. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="parse_config_fi_idp5606176.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="parse_environme_idp6997248.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/collect_unrecognized_mode.html b/libs/program_options/doc/html/boost/program_options/collect_unrecognized_mode.html deleted file mode 100644 index a97e40f398..0000000000 --- a/libs/program_options/doc/html/boost/program_options/collect_unrecognized_mode.html +++ /dev/null @@ -1,55 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Type collect_unrecognized_mode</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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_command_line_parser.html" title="Class template basic_command_line_parser"> -<link rel="next" href="ext_parser.html" title="Type definition ext_parser"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="basic_command_line_parser.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="ext_parser.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.collect_unrecognized_mode"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Type collect_unrecognized_mode</span></h2> -<p>boost::program_options::collect_unrecognized_mode</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</span> - -<span class="keyword">enum</span> <span class="identifier">collect_unrecognized_mode</span> <span class="special">{</span> include_positional, exclude_positional <span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65444848"></a><h2>Description</h2> -<p>Controls if the 'collect_unregistered' function should include positional options, or not. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="basic_command_line_parser.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="ext_parser.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/command_line_style/style_t.html b/libs/program_options/doc/html/boost/program_options/command_line_style/style_t.html deleted file mode 100644 index cad972b646..0000000000 --- a/libs/program_options/doc/html/boost/program_options/command_line_style/style_t.html +++ /dev/null @@ -1,111 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Type style_t</title> -<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../../program_options/reference.html#header.boost.program_options.cmdline_hpp" title="Header <boost/program_options/cmdline.hpp>"> -<link rel="prev" href="../../../program_options/reference.html" title="Reference"> -<link rel="next" href="../../../BOOST_PROGRAM_OPTIONS_DECL.html" title="Macro BOOST_PROGRAM_OPTIONS_DECL"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../../../program_options/reference.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../program_options/reference.html#header.boost.program_options.cmdline_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="../../../BOOST_PROGRAM_OPTIONS_DECL.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.command_line_style.style_t"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Type style_t</span></h2> -<p>boost::program_options::command_line_style::style_t</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../program_options/reference.html#header.boost.program_options.cmdline_hpp" title="Header <boost/program_options/cmdline.hpp>">boost/program_options/cmdline.hpp</a>> - -</span> -<span class="keyword">enum</span> <span class="identifier">style_t</span> <span class="special">{</span> <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.allow_long">allow_long</a> = 1, <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.allow_short">allow_short</a> = allow_long << 1, - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.allow_dash_for_short">allow_dash_for_short</a> = allow_short << 1, - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.allow_slash_for_short">allow_slash_for_short</a> = allow_dash_for_short << 1, - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.long_allow_adjacent">long_allow_adjacent</a> = allow_slash_for_short << 1, - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.long_allow_next">long_allow_next</a> = long_allow_adjacent << 1, - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.short_allow_adjacent">short_allow_adjacent</a> = long_allow_next << 1, - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.short_allow_next">short_allow_next</a> = short_allow_adjacent << 1, - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.allow_sticky">allow_sticky</a> = short_allow_next << 1, - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.allow_guessing">allow_guessing</a> = allow_sticky << 1, - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.long_case_insensitive">long_case_insensitive</a> = allow_guessing << 1, - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.short_case_insensitive">short_case_insensitive</a> = long_case_insensitive << 1, - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.case_insensitive">case_insensitive</a> = (long_case_insensitive | short_case_insensitive), - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.allow_long_disguise">allow_long_disguise</a> = short_case_insensitive << 1, - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.unix_style">unix_style</a> = (allow_short | short_allow_adjacent | short_allow_next - | allow_long | long_allow_adjacent | long_allow_next - | allow_sticky | allow_guessing - | allow_dash_for_short), - <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.default_style">default_style</a> = unix_style <span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp62915728"></a><h2>Description</h2> -<p>Various possible styles of options.</p> -<p>There are "long" options, which start with "--" and "short", which start with either "-" or "/". Both kinds can be allowed or disallowed, see allow_long and allow_short. The allowed character for short options is also configurable.</p> -<p>Option's value can be specified in the same token as name ("--foo=bar"), or in the next token.</p> -<p>It's possible to introduce long options by the same character as short options, see allow_long_disguise.</p> -<p>Finally, guessing (specifying only prefix of option) and case insensitive processing are supported. </p> -<div class="variablelist"><dl> -<dt><span class="term"><code class="computeroutput">allow_long</code><a name="boost.program_options.command_line_style.style_t.allow_long"></a></span></dt> -<dd>Allow "--long_name" style. </dd> -<dt><span class="term"><code class="computeroutput">allow_short</code><a name="boost.program_options.command_line_style.style_t.allow_short"></a></span></dt> -<dd>Allow "-<single character" style. </dd> -<dt><span class="term"><code class="computeroutput">allow_dash_for_short</code><a name="boost.program_options.command_line_style.style_t.allow_dash_for_short"></a></span></dt> -<dd>Allow "-" in short options. </dd> -<dt><span class="term"><code class="computeroutput">allow_slash_for_short</code><a name="boost.program_options.command_line_style.style_t.allow_slash_for_short"></a></span></dt> -<dd>Allow "/" in short options. </dd> -<dt><span class="term"><code class="computeroutput">long_allow_adjacent</code><a name="boost.program_options.command_line_style.style_t.long_allow_adjacent"></a></span></dt> -<dd><p>Allow option parameter in the same token for long option, like in - --foo=10 - </p></dd> -<dt><span class="term"><code class="computeroutput">long_allow_next</code><a name="boost.program_options.command_line_style.style_t.long_allow_next"></a></span></dt> -<dd><p>Allow option parameter in the next token for long options. </p></dd> -<dt><span class="term"><code class="computeroutput">short_allow_adjacent</code><a name="boost.program_options.command_line_style.style_t.short_allow_adjacent"></a></span></dt> -<dd><p>Allow option parameter in the same token for short options. </p></dd> -<dt><span class="term"><code class="computeroutput">short_allow_next</code><a name="boost.program_options.command_line_style.style_t.short_allow_next"></a></span></dt> -<dd><p>Allow option parameter in the next token for short options. </p></dd> -<dt><span class="term"><code class="computeroutput">allow_sticky</code><a name="boost.program_options.command_line_style.style_t.allow_sticky"></a></span></dt> -<dd><p>Allow to merge several short options together, so that "-s -k" become "-sk". All of the options but last should accept no parameter. For example, if "-s" accept a parameter, then "k" will be taken as parameter, not another short option. Dos-style short options cannot be sticky. </p></dd> -<dt><span class="term"><code class="computeroutput">allow_guessing</code><a name="boost.program_options.command_line_style.style_t.allow_guessing"></a></span></dt> -<dd><p>Allow abbreviated spellings for long options, if they unambiguously identify long option. No long option name should be prefix of other long option name if guessing is in effect. </p></dd> -<dt><span class="term"><code class="computeroutput">long_case_insensitive</code><a name="boost.program_options.command_line_style.style_t.long_case_insensitive"></a></span></dt> -<dd><p>Ignore the difference in case for long options. </p></dd> -<dt><span class="term"><code class="computeroutput">short_case_insensitive</code><a name="boost.program_options.command_line_style.style_t.short_case_insensitive"></a></span></dt> -<dd><p>Ignore the difference in case for short options. </p></dd> -<dt><span class="term"><code class="computeroutput">case_insensitive</code><a name="boost.program_options.command_line_style.style_t.case_insensitive"></a></span></dt> -<dd><p>Ignore the difference in case for all options. </p></dd> -<dt><span class="term"><code class="computeroutput">allow_long_disguise</code><a name="boost.program_options.command_line_style.style_t.allow_long_disguise"></a></span></dt> -<dd><p>Allow long options with single option starting character, e.g <code class="computeroutput">-foo=10</code> </p></dd> -<dt><span class="term"><code class="computeroutput">unix_style</code><a name="boost.program_options.command_line_style.style_t.unix_style"></a></span></dt> -<dd><p>The more-or-less traditional unix style. </p></dd> -<dt><span class="term"><code class="computeroutput">default_style</code><a name="boost.program_options.command_line_style.style_t.default_style"></a></span></dt> -<dd><p>The default style. </p></dd> -</dl></div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../../../program_options/reference.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../program_options/reference.html#header.boost.program_options.cmdline_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="../../../BOOST_PROGRAM_OPTIONS_DECL.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/duplicate_option_error.html b/libs/program_options/doc/html/boost/program_options/duplicate_option_error.html deleted file mode 100644 index 90b444b7ce..0000000000 --- a/libs/program_options/doc/html/boost/program_options/duplicate_option_error.html +++ /dev/null @@ -1,65 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class duplicate_option_error</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header <boost/program_options/options_description.hpp>"> -<link rel="prev" href="options_description.html" title="Class options_description"> -<link rel="next" href="basic_parsed_options.html" title="Class template basic_parsed_options"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="options_description.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="basic_parsed_options.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.duplicate_option_error"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class duplicate_option_error</span></h2> -<p>boost::program_options::duplicate_option_error</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header <boost/program_options/options_description.hpp>">boost/program_options/options_description.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="duplicate_option_error.html" title="Class duplicate_option_error">duplicate_option_error</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error</span> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="duplicate_option_error.html#boost.program_options.duplicate_option_errorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="duplicate_option_error.html#idp5960608-bb"><span class="identifier">duplicate_option_error</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="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp64910272"></a><h2>Description</h2> -<p>Class thrown when duplicate option description is found. </p> -<div class="refsect2"> -<a name="idp64910944"></a><h3> -<a name="boost.program_options.duplicate_option_errorconstruct-copy-destruct"></a><code class="computeroutput">duplicate_option_error</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp5960608-bb"></a><span class="identifier">duplicate_option_error</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> xwhat<span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="options_description.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="basic_parsed_options.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/error.html b/libs/program_options/doc/html/boost/program_options/error.html deleted file mode 100644 index 02cfb8991d..0000000000 --- a/libs/program_options/doc/html/boost/program_options/error.html +++ /dev/null @@ -1,65 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class error</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="../eof_iterator.html" title="Class template eof_iterator"> -<link rel="next" href="too_many_positi_idp7389984.html" title="Class too_many_positional_options_error"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../eof_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="too_many_positi_idp7389984.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.error"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class error</span></h2> -<p>boost::program_options::error</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="error.html" title="Class error">error</a> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="error.html#boost.program_options.errorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="error.html#idp7389008-bb"><span class="identifier">error</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="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63144800"></a><h2>Description</h2> -<p>Base class for all errors in the library. </p> -<div class="refsect2"> -<a name="idp63145440"></a><h3> -<a name="boost.program_options.errorconstruct-copy-destruct"></a><code class="computeroutput">error</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp7389008-bb"></a><span class="identifier">error</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> xwhat<span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../eof_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="too_many_positi_idp7389984.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/error_with_no_option_name.html b/libs/program_options/doc/html/boost/program_options/error_with_no_option_name.html deleted file mode 100644 index f8c44fb049..0000000000 --- a/libs/program_options/doc/html/boost/program_options/error_with_no_option_name.html +++ /dev/null @@ -1,85 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class error_with_no_option_name</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="required_option.html" title="Class required_option"> -<link rel="next" href="unknown_option.html" title="Class unknown_option"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="required_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="unknown_option.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.error_with_no_option_name"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class error_with_no_option_name</span></h2> -<p>boost::program_options::error_with_no_option_name</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="error_with_no_option_name.html" title="Class error_with_no_option_name">error_with_no_option_name</a> <span class="special">:</span> - <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error_with_option_name</span> -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="error_with_no_option_name.html#boost.program_options.error_with_no_option_nameconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="error_with_no_option_name.html#idp7265232-bb"><span class="identifier">error_with_no_option_name</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">""</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="error_with_no_option_name.html#idp7267072-bb"><span class="special">~</span><span class="identifier">error_with_no_option_name</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="error_with_no_option_name.html#idp6760192-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="error_with_no_option_name.html#idp6760752-bb"><span class="identifier">set_option_name</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="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63629472"></a><h2>Description</h2> -<p>Base class of unparsable options, when the desired option cannot be identified.</p> -<p>It makes no sense to have an option name, when we can't match an option to the parameter</p> -<p>Having this a part of the <a class="link" href="error_with_option_name.html" title="Class error_with_option_name">error_with_option_name</a> hierachy makes error handling a lot easier, even if the name indicates some sort of conceptual dissonance! </p> -<div class="refsect2"> -<a name="idp63631872"></a><h3> -<a name="boost.program_options.error_with_no_option_nameconstruct-copy-destruct"></a><code class="computeroutput">error_with_no_option_name</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp7265232-bb"></a><span class="identifier">error_with_no_option_name</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> template_<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> original_token <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp7267072-bb"></a><span class="special">~</span><span class="identifier">error_with_no_option_name</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp63649936"></a><h3> -<a name="idp6760192-bb"></a><code class="computeroutput">error_with_no_option_name</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp6760752-bb"></a><span class="identifier">set_option_name</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></pre> -<p>Does NOT set option name, because no option name makes sense </p> -</li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="required_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="unknown_option.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/error_with_option_name.html b/libs/program_options/doc/html/boost/program_options/error_with_option_name.html deleted file mode 100644 index a824b10be7..0000000000 --- a/libs/program_options/doc/html/boost/program_options/error_with_option_name.html +++ /dev/null @@ -1,159 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class error_with_option_name</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="reading_file.html" title="Class reading_file"> -<link rel="next" href="multiple_values.html" title="Class multiple_values"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="reading_file.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="multiple_values.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.error_with_option_name"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class error_with_option_name</span></h2> -<p>boost::program_options::error_with_option_name</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="error_with_option_name.html" title="Class error_with_option_name">error_with_option_name</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error</span> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="error_with_option_name.html#boost.program_options.error_with_option_nameconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="error_with_option_name.html#idp6883840-bb"><span class="identifier">error_with_option_name</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">""</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">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="error_with_option_name.html#idp6887744-bb"><span class="special">~</span><span class="identifier">error_with_option_name</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="error_with_option_name.html#idp8664592-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp8665152-bb"><span class="identifier">set_substitute</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="special">;</span> - <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp8667760-bb"><span class="identifier">set_substitute_default</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="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="keyword">void</span> <a class="link" href="error_with_option_name.html#idp8678432-bb"><span class="identifier">add_context</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="keyword">int</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp8681776-bb"><span class="identifier">set_prefix</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp5967312-bb"><span class="identifier">set_option_name</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="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#idp5970240-bb"><span class="identifier">get_option_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp5971360-bb"><span class="identifier">set_original_token</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="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="error_with_option_name.html#idp5972896-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="error_with_option_name.html#idp6888416-bb">protected member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp6888992-bb"><span class="identifier">substitute_placeholders</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="special">;</span> - <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp6725232-bb"><span class="identifier">replace_token</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="keyword">const</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#idp6727728-bb"><span class="identifier">get_canonical_option_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#idp6729376-bb"><span class="identifier">get_canonical_option_prefix</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="error_with_option_name.html#boost.program_options.error_with_option_namepublic-data-members">public data members</a></span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#boost.program_options.error_with_option_name.m_error_template"><span class="identifier">m_error_template</span></a><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63348736"></a><h2>Description</h2> -<p>Base class for most exceptions in the library.</p> -<p>Substitutes the values for the parameter name placeholders in the template to create the human readable error message</p> -<p>Placeholders are surrounded by % signs: example% Poor man's version of boost::format</p> -<p>If a parameter name is absent, perform default substitutions instead so ugly placeholders are never left in-place.</p> -<p>Options are displayed in "canonical" form This is the most unambiguous form of the *parsed* option name and would correspond to option_description::format_name() i.e. what is shown by print_usage()</p> -<p>The "canonical" form depends on whether the option is specified in short or long form, using dashes or slashes or without a prefix (from a configuration file) </p> -<div class="refsect2"> -<a name="idp63351296"></a><h3> -<a name="boost.program_options.error_with_option_nameconstruct-copy-destruct"></a><code class="computeroutput">error_with_option_name</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp6883840-bb"></a><span class="identifier">error_with_option_name</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> template_<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> option_name <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> original_token <span class="special">=</span> <span class="string">""</span><span class="special">,</span> - <span class="keyword">int</span> option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"> -<pre class="literallayout"><a name="idp6887744-bb"></a><span class="special">~</span><span class="identifier">error_with_option_name</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<p>gcc says that throw specification on dtor is loosened without this line </p> -</li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp63375040"></a><h3> -<a name="idp8664592-bb"></a><code class="computeroutput">error_with_option_name</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp8665152-bb"></a><span class="identifier">set_substitute</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> parameter_name<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> value<span class="special">)</span><span class="special">;</span></pre> -<p>Substitute parameter_name->value to create the error message from the error template </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp8667760-bb"></a><span class="identifier">set_substitute_default</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> parameter_name<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> from<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> to<span class="special">)</span><span class="special">;</span></pre> -<p>If the parameter is missing, then make the from->to substitution instead </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp8678432-bb"></a><span class="identifier">add_context</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> option_name<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> original_token<span class="special">,</span> <span class="keyword">int</span> option_style<span class="special">)</span><span class="special">;</span></pre> -<p>Add context to an exception </p> -</li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp8681776-bb"></a><span class="identifier">set_prefix</span><span class="special">(</span><span class="keyword">int</span> option_style<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp5967312-bb"></a><span class="identifier">set_option_name</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> option_name<span class="special">)</span><span class="special">;</span></pre> -<p>Overridden in <code class="computeroutput"><a class="link" href="error_with_no_option_name.html" title="Class error_with_no_option_name">error_with_no_option_name</a></code> </p> -</li> -<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp5970240-bb"></a><span class="identifier">get_option_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp5971360-bb"></a><span class="identifier">set_original_token</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> original_token<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp5972896-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Creates the error_message on the fly Currently a thin wrapper for substitute_placeholders() </p> -</li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp63448960"></a><h3> -<a name="idp6888416-bb"></a><code class="computeroutput">error_with_option_name</code> protected member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp6888992-bb"></a><span class="identifier">substitute_placeholders</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> error_template<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Makes all substitutions using the template </p> -</li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp6725232-bb"></a><span class="identifier">replace_token</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> from<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> to<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp6727728-bb"></a><span class="identifier">get_canonical_option_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Construct option name in accordance with the appropriate prefix style: i.e. long dash or short slash etc </p> -</li> -<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp6729376-bb"></a><span class="identifier">get_canonical_option_prefix</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp63484704"></a><h3> -<a name="boost.program_options.error_with_option_namepublic-data-members"></a><code class="computeroutput">error_with_option_name</code> - public - public data members</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="boost.program_options.error_with_option_name.m_error_template"></a><span class="identifier">m_error_template</span><span class="special">;</span></pre> -<p>template with placeholders </p> -</li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="reading_file.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="multiple_values.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/ext_parser.html b/libs/program_options/doc/html/boost/program_options/ext_parser.html deleted file mode 100644 index 1d78a13a73..0000000000 --- a/libs/program_options/doc/html/boost/program_options/ext_parser.html +++ /dev/null @@ -1,54 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Type definition ext_parser</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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="collect_unrecognized_mode.html" title="Type collect_unrecognized_mode"> -<link rel="next" href="parse_command_line.html" title="Function template parse_command_line"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="collect_unrecognized_mode.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="parse_command_line.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.ext_parser"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Type definition ext_parser</span></h2> -<p>ext_parser</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</span> -<span class="keyword">typedef</span> <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="identifier">ext_parser</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65464176"></a><h2>Description</h2> -<p>Augments <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options<wchar_t></a> with conversion from 'parsed_options' </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="collect_unrecognized_mode.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="parse_command_line.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/invalid_bool_value.html b/libs/program_options/doc/html/boost/program_options/invalid_bool_value.html deleted file mode 100644 index 59ca02df86..0000000000 --- a/libs/program_options/doc/html/boost/program_options/invalid_bool_value.html +++ /dev/null @@ -1,65 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class invalid_bool_value</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="invalid_option_value.html" title="Class invalid_option_value"> -<link rel="next" href="basic_option.html" title="Class template basic_option"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="invalid_option_value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="basic_option.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.invalid_bool_value"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class invalid_bool_value</span></h2> -<p>boost::program_options::invalid_bool_value</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="invalid_bool_value.html" title="Class invalid_bool_value">invalid_bool_value</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">validation_error</span> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="invalid_bool_value.html#boost.program_options.invalid_bool_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_bool_value.html#idp7795040-bb"><span class="identifier">invalid_bool_value</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="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp64144880"></a><h2>Description</h2> -<p>Class thrown if there is an invalid bool value given </p> -<div class="refsect2"> -<a name="idp64145616"></a><h3> -<a name="boost.program_options.invalid_bool_valueconstruct-copy-destruct"></a><code class="computeroutput">invalid_bool_value</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp7795040-bb"></a><span class="identifier">invalid_bool_value</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> value<span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="invalid_option_value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="basic_option.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/invalid_command_idp6969504.html b/libs/program_options/doc/html/boost/program_options/invalid_command_idp6969504.html deleted file mode 100644 index 44a88123f8..0000000000 --- a/libs/program_options/doc/html/boost/program_options/invalid_command_idp6969504.html +++ /dev/null @@ -1,74 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class invalid_command_line_syntax</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="invalid_config_file_syntax.html" title="Class invalid_config_file_syntax"> -<link rel="next" href="validation_error.html" title="Class validation_error"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="invalid_config_file_syntax.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="validation_error.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.invalid_command_idp6969504"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class invalid_command_line_syntax</span></h2> -<p>boost::program_options::invalid_command_line_syntax</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="invalid_command_idp6969504.html" title="Class invalid_command_line_syntax">invalid_command_line_syntax</a> <span class="special">:</span> - <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">invalid_syntax</span> -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="invalid_command_idp6969504.html#boost.program_options.invalid_command_idp6969504construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_command_idp6969504.html#idp7228672-bb"><span class="identifier">invalid_command_line_syntax</span></a><span class="special">(</span><span class="identifier">kind_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="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="invalid_command_idp6969504.html#idp7232576-bb"><span class="special">~</span><span class="identifier">invalid_command_line_syntax</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63981312"></a><h2>Description</h2> -<p>Class thrown when there are syntax errors in given command line </p> -<div class="refsect2"> -<a name="idp63981984"></a><h3> -<a name="boost.program_options.invalid_command_idp6969504construct-copy-destruct"></a><code class="computeroutput">invalid_command_line_syntax</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp7228672-bb"></a><span class="identifier">invalid_command_line_syntax</span><span class="special">(</span><span class="identifier">kind_t</span> kind<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> option_name <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> original_token <span class="special">=</span> <span class="string">""</span><span class="special">,</span> - <span class="keyword">int</span> option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp7232576-bb"></a><span class="special">~</span><span class="identifier">invalid_command_line_syntax</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="invalid_config_file_syntax.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="validation_error.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/invalid_command_line_style.html b/libs/program_options/doc/html/boost/program_options/invalid_command_line_style.html deleted file mode 100644 index 58c5080fc2..0000000000 --- a/libs/program_options/doc/html/boost/program_options/invalid_command_line_style.html +++ /dev/null @@ -1,65 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class invalid_command_line_style</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="too_many_positi_idp7389984.html" title="Class too_many_positional_options_error"> -<link rel="next" href="reading_file.html" title="Class reading_file"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="too_many_positi_idp7389984.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="reading_file.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.invalid_command_line_style"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class invalid_command_line_style</span></h2> -<p>boost::program_options::invalid_command_line_style</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="invalid_command_line_style.html" title="Class invalid_command_line_style">invalid_command_line_style</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error</span> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="invalid_command_line_style.html#boost.program_options.invalid_command_line_styleconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_command_line_style.html#idp6553104-bb"><span class="identifier">invalid_command_line_style</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="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63191968"></a><h2>Description</h2> -<p>Class thrown when there are programming error related to style </p> -<div class="refsect2"> -<a name="idp63192608"></a><h3> -<a name="boost.program_options.invalid_command_line_styleconstruct-copy-destruct"></a><code class="computeroutput">invalid_command_line_style</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp6553104-bb"></a><span class="identifier">invalid_command_line_style</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> msg<span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="too_many_positi_idp7389984.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="reading_file.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/invalid_config_file_syntax.html b/libs/program_options/doc/html/boost/program_options/invalid_config_file_syntax.html deleted file mode 100644 index 6f147c6aa2..0000000000 --- a/libs/program_options/doc/html/boost/program_options/invalid_config_file_syntax.html +++ /dev/null @@ -1,81 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class invalid_config_file_syntax</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="invalid_syntax.html" title="Class invalid_syntax"> -<link rel="next" href="invalid_command_idp6969504.html" title="Class invalid_command_line_syntax"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="invalid_syntax.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_command_idp6969504.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.invalid_config_file_syntax"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class invalid_config_file_syntax</span></h2> -<p>boost::program_options::invalid_config_file_syntax</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="invalid_config_file_syntax.html" title="Class invalid_config_file_syntax">invalid_config_file_syntax</a> <span class="special">:</span> - <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">invalid_syntax</span> -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="invalid_config_file_syntax.html#boost.program_options.invalid_config_file_syntaxconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_config_file_syntax.html#idp6967552-bb"><span class="identifier">invalid_config_file_syntax</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="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="invalid_config_file_syntax.html#idp6969216-bb"><span class="special">~</span><span class="identifier">invalid_config_file_syntax</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="invalid_config_file_syntax.html#idp6965056-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="invalid_config_file_syntax.html#idp6965616-bb"><span class="identifier">tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63923456"></a><h2>Description</h2> -<div class="refsect2"> -<a name="idp63923872"></a><h3> -<a name="boost.program_options.invalid_config_file_syntaxconstruct-copy-destruct"></a><code class="computeroutput">invalid_config_file_syntax</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp6967552-bb"></a><span class="identifier">invalid_config_file_syntax</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> invalid_line<span class="special">,</span> <span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp6969216-bb"></a><span class="special">~</span><span class="identifier">invalid_config_file_syntax</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp63938448"></a><h3> -<a name="idp6965056-bb"></a><code class="computeroutput">invalid_config_file_syntax</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp6965616-bb"></a><span class="identifier">tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Convenience functions for backwards compatibility </p> -</li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="invalid_syntax.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_command_idp6969504.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/invalid_option_value.html b/libs/program_options/doc/html/boost/program_options/invalid_option_value.html deleted file mode 100644 index de3eae96ac..0000000000 --- a/libs/program_options/doc/html/boost/program_options/invalid_option_value.html +++ /dev/null @@ -1,69 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class invalid_option_value</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="validation_error.html" title="Class validation_error"> -<link rel="next" href="invalid_bool_value.html" title="Class invalid_bool_value"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="validation_error.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_bool_value.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.invalid_option_value"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class invalid_option_value</span></h2> -<p>boost::program_options::invalid_option_value</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="invalid_option_value.html" title="Class invalid_option_value">invalid_option_value</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">validation_error</span> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="invalid_option_value.html#boost.program_options.invalid_option_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_option_value.html#idp6896016-bb"><span class="identifier">invalid_option_value</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="special">;</span> - <a class="link" href="invalid_option_value.html#idp6896992-bb"><span class="identifier">invalid_option_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp64107968"></a><h2>Description</h2> -<p>Class thrown if there is an invalid option value given </p> -<div class="refsect2"> -<a name="idp64108704"></a><h3> -<a name="boost.program_options.invalid_option_valueconstruct-copy-destruct"></a><code class="computeroutput">invalid_option_value</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp6896016-bb"></a><span class="identifier">invalid_option_value</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> value<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp6896992-bb"></a><span class="identifier">invalid_option_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="validation_error.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_bool_value.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/invalid_syntax.html b/libs/program_options/doc/html/boost/program_options/invalid_syntax.html deleted file mode 100644 index 84d69bd95e..0000000000 --- a/libs/program_options/doc/html/boost/program_options/invalid_syntax.html +++ /dev/null @@ -1,101 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class invalid_syntax</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="ambiguous_option.html" title="Class ambiguous_option"> -<link rel="next" href="invalid_config_file_syntax.html" title="Class invalid_config_file_syntax"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="ambiguous_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_config_file_syntax.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.invalid_syntax"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class invalid_syntax</span></h2> -<p>boost::program_options::invalid_syntax</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="invalid_syntax.html" title="Class invalid_syntax">invalid_syntax</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error_with_option_name</span> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - - <span class="keyword">enum</span> <a name="boost.program_options.invalid_syntax.kind_t"></a>kind_t <span class="special">{</span> long_not_allowed = 30, long_adjacent_not_allowed, - short_adjacent_not_allowed, empty_adjacent_parameter, - missing_parameter, extra_parameter, unrecognized_line <span class="special">}</span><span class="special">;</span> - <span class="comment">// <a class="link" href="invalid_syntax.html#boost.program_options.invalid_syntaxconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_syntax.html#idp8787376-bb"><span class="identifier">invalid_syntax</span></a><span class="special">(</span><span class="identifier">kind_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="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="invalid_syntax.html#idp8791280-bb"><span class="special">~</span><span class="identifier">invalid_syntax</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="invalid_syntax.html#idp6821904-bb">public member functions</a></span> - <span class="identifier">kind_t</span> <a class="link" href="invalid_syntax.html#idp6822464-bb"><span class="identifier">kind</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="invalid_syntax.html#idp6823584-bb"><span class="identifier">tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="invalid_syntax.html#idp8791568-bb">protected member functions</a></span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="invalid_syntax.html#idp8792144-bb"><span class="identifier">get_template</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63844128"></a><h2>Description</h2> -<p>Class thrown when there's syntax error either for command line or config file options. See derived children for concrete classes. </p> -<div class="refsect2"> -<a name="idp63844944"></a><h3> -<a name="boost.program_options.invalid_syntaxconstruct-copy-destruct"></a><code class="computeroutput">invalid_syntax</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp8787376-bb"></a><span class="identifier">invalid_syntax</span><span class="special">(</span><span class="identifier">kind_t</span> kind<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> option_name <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> original_token <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">int</span> option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp8791280-bb"></a><span class="special">~</span><span class="identifier">invalid_syntax</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp63868256"></a><h3> -<a name="idp6821904-bb"></a><code class="computeroutput">invalid_syntax</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><span class="identifier">kind_t</span> <a name="idp6822464-bb"></a><span class="identifier">kind</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp6823584-bb"></a><span class="identifier">tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Convenience functions for backwards compatibility </p> -</li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp63882432"></a><h3> -<a name="idp8791568-bb"></a><code class="computeroutput">invalid_syntax</code> protected member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp8792144-bb"></a><span class="identifier">get_template</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre> -<p>Used to convert kind_t to a related error text </p> -</li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="ambiguous_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_config_file_syntax.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/multiple_occurrences.html b/libs/program_options/doc/html/boost/program_options/multiple_occurrences.html deleted file mode 100644 index db3124bb50..0000000000 --- a/libs/program_options/doc/html/boost/program_options/multiple_occurrences.html +++ /dev/null @@ -1,71 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class multiple_occurrences</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="multiple_values.html" title="Class multiple_values"> -<link rel="next" href="required_option.html" title="Class required_option"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="multiple_values.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="required_option.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.multiple_occurrences"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class multiple_occurrences</span></h2> -<p>boost::program_options::multiple_occurrences</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="multiple_occurrences.html" title="Class multiple_occurrences">multiple_occurrences</a> <span class="special">:</span> - <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error_with_option_name</span> -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="multiple_occurrences.html#boost.program_options.multiple_occurrencesconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="multiple_occurrences.html#idp8376240-bb"><span class="identifier">multiple_occurrences</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="multiple_occurrences.html#idp8376528-bb"><span class="special">~</span><span class="identifier">multiple_occurrences</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63543648"></a><h2>Description</h2> -<p>Class thrown when there are several occurrences of an option, but user called a method which cannot return them all. </p> -<div class="refsect2"> -<a name="idp63544448"></a><h3> -<a name="boost.program_options.multiple_occurrencesconstruct-copy-destruct"></a><code class="computeroutput">multiple_occurrences</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp8376240-bb"></a><span class="identifier">multiple_occurrences</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp8376528-bb"></a><span class="special">~</span><span class="identifier">multiple_occurrences</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="multiple_values.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="required_option.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/multiple_values.html b/libs/program_options/doc/html/boost/program_options/multiple_values.html deleted file mode 100644 index 7f50f655a5..0000000000 --- a/libs/program_options/doc/html/boost/program_options/multiple_values.html +++ /dev/null @@ -1,69 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class multiple_values</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="error_with_option_name.html" title="Class error_with_option_name"> -<link rel="next" href="multiple_occurrences.html" title="Class multiple_occurrences"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="error_with_option_name.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="multiple_occurrences.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.multiple_values"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class multiple_values</span></h2> -<p>boost::program_options::multiple_values</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="multiple_values.html" title="Class multiple_values">multiple_values</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error_with_option_name</span> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="multiple_values.html#boost.program_options.multiple_valuesconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="multiple_values.html#idp8373504-bb"><span class="identifier">multiple_values</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="multiple_values.html#idp8373792-bb"><span class="special">~</span><span class="identifier">multiple_values</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63512416"></a><h2>Description</h2> -<p>Class thrown when there are several option values, but user called a method which cannot return them all. </p> -<div class="refsect2"> -<a name="idp63513216"></a><h3> -<a name="boost.program_options.multiple_valuesconstruct-copy-destruct"></a><code class="computeroutput">multiple_values</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp8373504-bb"></a><span class="identifier">multiple_values</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp8373792-bb"></a><span class="special">~</span><span class="identifier">multiple_values</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="error_with_option_name.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="multiple_occurrences.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/notify.html b/libs/program_options/doc/html/boost/program_options/notify.html deleted file mode 100644 index 9fa3bf9bc9..0000000000 --- a/libs/program_options/doc/html/boost/program_options/notify.html +++ /dev/null @@ -1,54 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function notify</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> -<link rel="prev" href="store_idp6709808.html" title="Function store"> -<link rel="next" href="../../BOOST_PROGRAM_OPTIONS_VERSION.html" title="Macro BOOST_PROGRAM_OPTIONS_VERSION"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="store_idp6709808.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="../../BOOST_PROGRAM_OPTIONS_VERSION.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.notify"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function notify</span></h2> -<p>boost::program_options::notify</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>">boost/program_options/variables_map.hpp</a>> - -</span> -<span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> <span class="identifier">notify</span><span class="special">(</span><a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> m<span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp67286544"></a><h2>Description</h2> -<p>Runs all 'notify' function for options in 'm'. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="store_idp6709808.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="../../BOOST_PROGRAM_OPTIONS_VERSION.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/option_description.html b/libs/program_options/doc/html/boost/program_options/option_description.html deleted file mode 100644 index 9de58f4381..0000000000 --- a/libs/program_options/doc/html/boost/program_options/option_description.html +++ /dev/null @@ -1,145 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class option_description</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header <boost/program_options/options_description.hpp>"> -<link rel="prev" href="basic_option.html" title="Class template basic_option"> -<link rel="next" href="options_descrip_idp8075600.html" title="Class options_description_easy_init"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="basic_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="options_descrip_idp8075600.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.option_description"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class option_description</span></h2> -<p>boost::program_options::option_description</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header <boost/program_options/options_description.hpp>">boost/program_options/options_description.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - - <span class="keyword">enum</span> <a name="boost.program_options.option_description.match_result"></a>match_result <span class="special">{</span> no_match, full_match, approximate_match <span class="special">}</span><span class="special">;</span> - <span class="comment">// <a class="link" href="option_description.html#boost.program_options.option_descriptionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="option_description.html#idp6407712-bb"><span class="identifier">option_description</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="option_description.html#idp6408000-bb"><span class="identifier">option_description</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="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="option_description.html#idp8533648-bb"><span class="identifier">option_description</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="value_semantic.html" title="Class value_semantic">value_semantic</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="option_description.html#idp8072752-bb"><span class="special">~</span><span class="identifier">option_description</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="option_description.html#idp10988304-bb">public member functions</a></span> - <span class="identifier">match_result</span> <a class="link" href="option_description.html#idp10988864-bb"><span class="identifier">match</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">bool</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</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> <a class="link" href="option_description.html#idp10993232-bb"><span class="identifier">key</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="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#idp8141696-bb"><span class="identifier">canonical_display_name</span></a><span class="special">(</span><span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</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> <a class="link" href="option_description.html#idp8144512-bb"><span class="identifier">long_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</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> <a class="link" href="option_description.html#idp8145632-bb"><span class="identifier">description</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">shared_ptr</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">></span> <a class="link" href="option_description.html#idp8147056-bb"><span class="identifier">semantic</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#idp6404592-bb"><span class="identifier">format_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#idp6406048-bb"><span class="identifier">format_parameter</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="option_description.html#idp8073040-bb">private member functions</a></span> - <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> <a class="link" href="option_description.html#idp8073616-bb"><span class="identifier">set_name</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="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp64415872"></a><h2>Description</h2> -<p>Describes one possible command line/config file option. There are two kinds of properties of an option. First describe it syntactically and are used only to validate input. Second affect interpretation of the option, for example default value for it or function that should be called when the value is finally known. Routines which perform parsing never use second kind of properties \-- they are side effect free. </p> -<p><span class="bold"><strong>See Also:</strong></span></p> -<p><a class="link" href="options_description.html" title="Class options_description">options_description</a> </p> -<p> -</p> -<div class="refsect2"> -<a name="idp64418784"></a><h3> -<a name="boost.program_options.option_descriptionconstruct-copy-destruct"></a><code class="computeroutput">option_description</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp6407712-bb"></a><span class="identifier">option_description</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"> -<pre class="literallayout"><a name="idp6408000-bb"></a><span class="identifier">option_description</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span> s<span class="special">)</span><span class="special">;</span></pre> -<p>Initializes the object with the passed data.</p> -<p>Note: it would be nice to make the second parameter auto_ptr, to explicitly pass ownership. Unfortunately, it's often needed to create objects of types derived from '<code class="computeroutput"><a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a></code>': <code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code> d; d.add_options()("a", parameter<int>("n")->default_value(1)); Here, the static type returned by 'parameter' should be derived from <code class="computeroutput"><a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a></code>.</p> -<p>Alas, derived->base conversion for auto_ptr does not really work, see <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2000/n1232.pdf" target="_top">http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2000/n1232.pdf</a> <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#84" target="_top">http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#84</a></p> -<p>So, we have to use plain old pointers. Besides, users are not expected to use the constructor directly.</p> -<p>The 'name' parameter is interpreted by the following rules:</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>if there's no "," character in 'name', it specifies long name</p></li> -<li class="listitem"><p>otherwise, the part before "," specifies long name and the part after \-- short name. </p></li> -</ul></div> -<p> -</p> -</li> -<li class="listitem"> -<pre class="literallayout"><a name="idp8533648-bb"></a><span class="identifier">option_description</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span> s<span class="special">,</span> - <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> description<span class="special">)</span><span class="special">;</span></pre> -<p>Initializes the class with the passed data. </p> -</li> -<li class="listitem"><pre class="literallayout"><a name="idp8072752-bb"></a><span class="special">~</span><span class="identifier">option_description</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp64457632"></a><h3> -<a name="idp10988304-bb"></a><code class="computeroutput">option_description</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">match_result</span> -<a name="idp10988864-bb"></a><span class="identifier">match</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> option<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> <span class="keyword">bool</span> long_ignore_case<span class="special">,</span> - <span class="keyword">bool</span> short_ignore_case<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Given 'option', specified in the input source, returns 'true' if 'option' specifies *this. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="idp10993232-bb"></a><span class="identifier">key</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> option<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns the key that should identify the option, in particular in the <code class="computeroutput"><a class="link" href="variables_map.html" title="Class variables_map">variables_map</a></code> class. The 'option' parameter is the option spelling from the input source. If option name contains '*', returns 'option'. If long name was specified, it's the long name, otherwise it's a short name with prepended '-'. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp8141696-bb"></a><span class="identifier">canonical_display_name</span><span class="special">(</span><span class="keyword">int</span> canonical_option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns the canonical name for the option description to enable the user to recognised a matching option. 1) For short options ('-', '/'), returns the short name prefixed. 2) For long options ('--' / '-') returns the long name prefixed 3) All other cases, returns the long name (if present) or the short name, unprefixed. </p> -</li> -<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="idp8144512-bb"></a><span class="identifier">long_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="idp8145632-bb"></a><span class="identifier">description</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Explanation of this option. </li> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">></span> <a name="idp8147056-bb"></a><span class="identifier">semantic</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Semantic of option's value. </li> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp6404592-bb"></a><span class="identifier">format_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the option name, formatted suitably for usage message. </li> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp6406048-bb"></a><span class="identifier">format_parameter</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns the parameter name and properties, formatted suitably for usage message. </p> -</li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp64529024"></a><h3> -<a name="idp8073040-bb"></a><code class="computeroutput">option_description</code> private member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> <a name="idp8073616-bb"></a><span class="identifier">set_name</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="basic_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="options_descrip_idp8075600.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/options_descrip_idp8075600.html b/libs/program_options/doc/html/boost/program_options/options_descrip_idp8075600.html deleted file mode 100644 index ffbb2bd48f..0000000000 --- a/libs/program_options/doc/html/boost/program_options/options_descrip_idp8075600.html +++ /dev/null @@ -1,85 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class options_description_easy_init</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header <boost/program_options/options_description.hpp>"> -<link rel="prev" href="option_description.html" title="Class option_description"> -<link rel="next" href="options_description.html" title="Class options_description"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="option_description.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="options_description.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.options_descrip_idp8075600"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class options_description_easy_init</span></h2> -<p>boost::program_options::options_description_easy_init</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header <boost/program_options/options_description.hpp>">boost/program_options/options_description.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="options_descrip_idp8075600.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="options_descrip_idp8075600.html#boost.program_options.options_descrip_idp8075600construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="options_descrip_idp8075600.html#idp6053360-bb"><span class="identifier">options_description_easy_init</span></a><span class="special">(</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="options_descrip_idp8075600.html#idp8077088-bb">public member functions</a></span> - <a class="link" href="options_descrip_idp8075600.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> <a class="link" href="options_descrip_idp8075600.html#idp8077648-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</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> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="options_descrip_idp8075600.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> - <a class="link" href="options_descrip_idp8075600.html#idp7493104-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</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="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="options_descrip_idp8075600.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> - <a class="link" href="options_descrip_idp8075600.html#idp7496080-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</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="value_semantic.html" title="Class value_semantic">value_semantic</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="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp64587536"></a><h2>Description</h2> -<p>Class which provides convenient creation syntax to <a class="link" href="option_description.html" title="Class option_description">option_description</a>. </p> -<div class="refsect2"> -<a name="idp64589136"></a><h3> -<a name="boost.program_options.options_descrip_idp8075600construct-copy-destruct"></a><code class="computeroutput">options_description_easy_init</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp6053360-bb"></a><span class="identifier">options_description_easy_init</span><span class="special">(</span><a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> owner<span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -<div class="refsect2"> -<a name="idp64596560"></a><h3> -<a name="idp8077088-bb"></a><code class="computeroutput">options_description_easy_init</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a class="link" href="options_descrip_idp8075600.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> -<a name="idp8077648-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> description<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a class="link" href="options_descrip_idp8075600.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> -<a name="idp7493104-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span> s<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a class="link" href="options_descrip_idp8075600.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> -<a name="idp7496080-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span> s<span class="special">,</span> - <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> description<span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="option_description.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="options_description.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/options_description.html b/libs/program_options/doc/html/boost/program_options/options_description.html deleted file mode 100644 index cd62c2638f..0000000000 --- a/libs/program_options/doc/html/boost/program_options/options_description.html +++ /dev/null @@ -1,146 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class options_description</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header <boost/program_options/options_description.hpp>"> -<link rel="prev" href="options_descrip_idp8075600.html" title="Class options_description_easy_init"> -<link rel="next" href="duplicate_option_error.html" title="Class duplicate_option_error"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="options_descrip_idp8075600.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="duplicate_option_error.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.options_description"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class options_description</span></h2> -<p>boost::program_options::options_description</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header <boost/program_options/options_description.hpp>">boost/program_options/options_description.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="options_description.html#boost.program_options.options_descriptionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="options_description.html#idp5512576-bb"><span class="identifier">options_description</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> - <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="options_description.html#idp5515232-bb"><span class="identifier">options_description</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">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> - <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="options_description.html#idp6058624-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="options_description.html#idp6410704-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span><span class="special">)</span><span class="special">;</span> - <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> <a class="link" href="options_description.html#idp6413216-bb"><span class="identifier">add</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="keyword">unsigned</span> <a class="link" href="options_description.html#idp6416080-bb"><span class="identifier">get_option_column_width</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="options_descrip_idp8075600.html" title="Class options_description_easy_init">options_description_easy_init</a> <a class="link" href="options_description.html#idp6417584-bb"><span class="identifier">add_options</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> - <a class="link" href="options_description.html#idp8823808-bb"><span class="identifier">find</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">bool</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="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">*</span> - <a class="link" href="options_description.html#idp6215600-bb"><span class="identifier">find_nothrow</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">bool</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="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</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">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> <span class="special">></span> <span class="special">&</span> <a class="link" href="options_description.html#idp6220496-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="options_description.html#idp6222080-bb"><span class="identifier">print</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="options_description.html#idp8544736-bb">friend functions</a></span> - <span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> - <a class="link" href="options_description.html#idp8545296-bb"><span class="keyword">operator</span><span class="special"><<</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</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><span class="special">)</span><span class="special">;</span> - - <span class="comment">// public data members</span> - <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="identifier">m_default_line_length</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp64755792"></a><h2>Description</h2> -<p>A set of option descriptions. This provides convenient interface for adding new option (the add_options) method, and facilities to search for options by name.</p> -<p>See here for option adding interface discussion. </p> -<p><span class="bold"><strong>See Also:</strong></span></p> -<p><a class="link" href="option_description.html" title="Class option_description">option_description</a> </p> -<p> -</p> -<div class="refsect2"> -<a name="idp64758608"></a><h3> -<a name="boost.program_options.options_descriptionconstruct-copy-destruct"></a><code class="computeroutput">options_description</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><a name="idp5512576-bb"></a><span class="identifier">options_description</span><span class="special">(</span><span class="keyword">unsigned</span> line_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> - <span class="keyword">unsigned</span> min_description_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span></pre> -<p>Creates the instance. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><a name="idp5515232-bb"></a><span class="identifier">options_description</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> caption<span class="special">,</span> - <span class="keyword">unsigned</span> line_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> - <span class="keyword">unsigned</span> min_description_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span></pre> -<p>Creates the instance. The 'caption' parameter gives the name of this '<code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code>' instance. Primarily useful for output. The 'description_length' specifies the number of columns that should be reserved for the description text; if the option text encroaches into this, then the description will start on the next line. </p> -</li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp64785360"></a><h3> -<a name="idp6058624-bb"></a><code class="computeroutput">options_description</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp6410704-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> desc<span class="special">)</span><span class="special">;</span></pre> -<p>Adds new variable description. Throws duplicate_variable_error if either short or long name matches that of already present one. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> <a name="idp6413216-bb"></a><span class="identifier">add</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>Adds a group of option description. This has the same effect as adding all option_descriptions in 'desc' individually, except that output operator will show a separate group. Returns *this. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">unsigned</span> <a name="idp6416080-bb"></a><span class="identifier">get_option_column_width</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Find the maximum width of the option column, including options in groups. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="options_descrip_idp8075600.html" title="Class options_description_easy_init">options_description_easy_init</a> <a name="idp6417584-bb"></a><span class="identifier">add_options</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<p>Returns an object of implementation-defined type suitable for adding options to <code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code>. The returned object will have overloaded operator() with parameter type matching '<code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code>' constructors. Calling the operator will create new <code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code> instance and add it. </p> -</li> -<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> -<a name="idp8823808-bb"></a><span class="identifier">find</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> name<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> <span class="keyword">bool</span> long_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> - <span class="keyword">bool</span> short_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">*</span> -<a name="idp6215600-bb"></a><span class="identifier">find_nothrow</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> name<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> - <span class="keyword">bool</span> long_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> short_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><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">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> <span class="special">></span> <span class="special">&</span> <a name="idp6220496-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp6222080-bb"></a><span class="identifier">print</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="keyword">unsigned</span> width <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Outputs 'desc' to the specified stream, calling 'f' to output each <code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code> element. </p> -</li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp64872688"></a><h3> -<a name="idp8544736-bb"></a><code class="computeroutput">options_description</code> friend functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> -<a name="idp8545296-bb"></a><span class="keyword">operator</span><span class="special"><<</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<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>Produces a human readable output of 'desc', listing options, their descriptions and allowed parameters. Other <code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code> instances previously passed to add will be output separately. </p> -</li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="options_descrip_idp8075600.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="duplicate_option_error.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/parse_command_line.html b/libs/program_options/doc/html/boost/program_options/parse_command_line.html deleted file mode 100644 index 57346cc8bd..0000000000 --- a/libs/program_options/doc/html/boost/program_options/parse_command_line.html +++ /dev/null @@ -1,58 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function template parse_command_line</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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="ext_parser.html" title="Type definition ext_parser"> -<link rel="next" href="parse_config_fi_idp8590400.html" title="Function template parse_config_file"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="ext_parser.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="parse_config_fi_idp8590400.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.parse_command_line"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function template parse_command_line</span></h2> -<p>boost::program_options::parse_command_line</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</span> -<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> charT<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> - <span class="identifier">parse_command_line</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="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="keyword">int</span> style <span class="special">=</span> <span class="number">0</span><span class="special">,</span> - <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> ext <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></pre></div> -<div class="refsect1"> -<a name="idp65502288"></a><h2>Description</h2> -<p>Creates instance of 'command_line_parser', passes parameters to it, and returns the result of calling the 'run' method. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="ext_parser.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="parse_config_fi_idp8590400.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/parse_config_fi_idp5606176.html b/libs/program_options/doc/html/boost/program_options/parse_config_fi_idp5606176.html deleted file mode 100644 index 6448444957..0000000000 --- a/libs/program_options/doc/html/boost/program_options/parse_config_fi_idp5606176.html +++ /dev/null @@ -1,58 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function template parse_config_file</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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="parse_config_fi_idp8590400.html" title="Function template parse_config_file"> -<link rel="next" href="collect_unrecognized.html" title="Function template collect_unrecognized"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="parse_config_fi_idp8590400.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.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.parse_config_fi_idp5606176"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function template parse_config_file</span></h2> -<p>boost::program_options::parse_config_file</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</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> <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> - <span class="identifier">parse_config_file</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<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="keyword">bool</span> allow_unregistered <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65545776"></a><h2>Description</h2> -<p>Parse a config file.</p> -<p>Read from file with the given name. The character type is passed to the file stream. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="parse_config_fi_idp8590400.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.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/parse_config_fi_idp8590400.html b/libs/program_options/doc/html/boost/program_options/parse_config_fi_idp8590400.html deleted file mode 100644 index 8869c62e26..0000000000 --- a/libs/program_options/doc/html/boost/program_options/parse_config_fi_idp8590400.html +++ /dev/null @@ -1,59 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function template parse_config_file</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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="parse_command_line.html" title="Function template parse_command_line"> -<link rel="next" href="parse_config_fi_idp5606176.html" title="Function template parse_config_file"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="parse_command_line.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="parse_config_fi_idp5606176.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.parse_config_fi_idp8590400"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function template parse_config_file</span></h2> -<p>boost::program_options::parse_config_file</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</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> <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> - <span class="identifier">parse_config_file</span><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="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> - <span class="keyword">bool</span> allow_unregistered <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65525056"></a><h2>Description</h2> -<p>Parse a config file.</p> -<p>Read from given stream. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="parse_command_line.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="parse_config_fi_idp5606176.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/parse_environme_idp6765216.html b/libs/program_options/doc/html/boost/program_options/parse_environme_idp6765216.html deleted file mode 100644 index 81de0fdb54..0000000000 --- a/libs/program_options/doc/html/boost/program_options/parse_environme_idp6765216.html +++ /dev/null @@ -1,55 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function parse_environment</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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="parse_environme_idp7001408.html" title="Function parse_environment"> -<link rel="next" href="split_unix.html" title="Function split_unix"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="parse_environme_idp7001408.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="split_unix.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.parse_environme_idp6765216"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function parse_environment</span></h2> -<p>boost::program_options::parse_environment</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</span> -<span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="../../program_options/reference.html#boost.program_options.parsed_options">parsed_options</a> -<span class="identifier">parse_environment</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><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> prefix<span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65619616"></a><h2>Description</h2> -<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function exists to resolve ambiguity between the two above functions when second argument is of 'char*' type. There's implicit conversion to both function1 and string. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="parse_environme_idp7001408.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="split_unix.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/parse_environme_idp6997248.html b/libs/program_options/doc/html/boost/program_options/parse_environme_idp6997248.html deleted file mode 100644 index 54a4574405..0000000000 --- a/libs/program_options/doc/html/boost/program_options/parse_environme_idp6997248.html +++ /dev/null @@ -1,58 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function parse_environment</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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="collect_unrecognized.html" title="Function template collect_unrecognized"> -<link rel="next" href="parse_environme_idp7001408.html" title="Function parse_environment"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="collect_unrecognized.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="parse_environme_idp7001408.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.parse_environme_idp6997248"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function parse_environment</span></h2> -<p>boost::program_options::parse_environment</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</span> -<span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="../../program_options/reference.html#boost.program_options.parsed_options">parsed_options</a> -<span class="identifier">parse_environment</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><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> name_mapper<span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65590496"></a><h2>Description</h2> -<p>Parse environment.</p> -<p>For each environment variable, the 'name_mapper' function is called to obtain the option name. If it returns empty string, the variable is ignored.</p> -<p>This is done since naming of environment variables is typically different from the naming of command line options. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="collect_unrecognized.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="parse_environme_idp7001408.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/parse_environme_idp7001408.html b/libs/program_options/doc/html/boost/program_options/parse_environme_idp7001408.html deleted file mode 100644 index e3a2f2cd6c..0000000000 --- a/libs/program_options/doc/html/boost/program_options/parse_environme_idp7001408.html +++ /dev/null @@ -1,56 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function parse_environment</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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="parse_environme_idp6997248.html" title="Function parse_environment"> -<link rel="next" href="parse_environme_idp6765216.html" title="Function parse_environment"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="parse_environme_idp6997248.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="parse_environme_idp6765216.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.parse_environme_idp7001408"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function parse_environment</span></h2> -<p>boost::program_options::parse_environment</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</span> -<span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="../../program_options/reference.html#boost.program_options.parsed_options">parsed_options</a> -<span class="identifier">parse_environment</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><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> prefix<span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65605776"></a><h2>Description</h2> -<p>Parse environment.</p> -<p>Takes all environment variables which start with 'prefix'. The option name is obtained from variable name by removing the prefix and converting the remaining string into lower case. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="parse_environme_idp6997248.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="parse_environme_idp6765216.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/positional_opti_idp5922480.html b/libs/program_options/doc/html/boost/program_options/positional_opti_idp5922480.html deleted file mode 100644 index a420474ef3..0000000000 --- a/libs/program_options/doc/html/boost/program_options/positional_opti_idp5922480.html +++ /dev/null @@ -1,91 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class positional_options_description</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.positional_options_hpp" title="Header <boost/program_options/positional_options.hpp>"> -<link rel="prev" href="split_unix.html" title="Function split_unix"> -<link rel="next" href="value_semantic.html" title="Class value_semantic"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="split_unix.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.positional_options_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="value_semantic.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.positional_opti_idp5922480"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class positional_options_description</span></h2> -<p>boost::program_options::positional_options_description</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.positional_options_hpp" title="Header <boost/program_options/positional_options.hpp>">boost/program_options/positional_options.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="positional_opti_idp5922480.html" title="Class positional_options_description">positional_options_description</a> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="positional_opti_idp5922480.html#boost.program_options.positional_opti_idp5922480construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="positional_opti_idp5922480.html#idp7173568-bb"><span class="identifier">positional_options_description</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="positional_opti_idp5922480.html#idp5924768-bb">public member functions</a></span> - <a class="link" href="positional_opti_idp5922480.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span> <a class="link" href="positional_opti_idp5922480.html#idp5925328-bb"><span class="identifier">add</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">int</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">unsigned</span> <a class="link" href="positional_opti_idp5922480.html#idp5928448-bb"><span class="identifier">max_total_count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</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> <a class="link" href="positional_opti_idp5922480.html#idp7171104-bb"><span class="identifier">name_for_position</span></a><span class="special">(</span><span class="keyword">unsigned</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65722736"></a><h2>Description</h2> -<p>Describes positional options.</p> -<p>The class allows to guess option names for positional options, which are specified on the command line and are identified by the position. The class uses the information provided by the user to associate a name with every positional option, or tell that no name is known.</p> -<p>The primary assumption is that only the relative order of the positional options themselves matters, and that any interleaving ordinary options don't affect interpretation of positional options.</p> -<p>The user initializes the class by specifying that first N positional options should be given the name X1, following M options should be given the name X2 and so on. </p> -<div class="refsect2"> -<a name="idp65724896"></a><h3> -<a name="boost.program_options.positional_opti_idp5922480construct-copy-destruct"></a><code class="computeroutput">positional_options_description</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp7173568-bb"></a><span class="identifier">positional_options_description</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -<div class="refsect2"> -<a name="idp65730848"></a><h3> -<a name="idp5924768-bb"></a><code class="computeroutput">positional_options_description</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="positional_opti_idp5922480.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span> <a name="idp5925328-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">int</span> max_count<span class="special">)</span><span class="special">;</span></pre> -<p>Species that up to 'max_count' next positional options should be given the 'name'. The value of '-1' means 'unlimited'. No calls to 'add' can be made after call with 'max_value' equal to '-1'. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">unsigned</span> <a name="idp5928448-bb"></a><span class="identifier">max_total_count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns the maximum number of positional options that can be present. Can return (numeric_limits<unsigned>::max)() to indicate unlimited number. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="idp7171104-bb"></a><span class="identifier">name_for_position</span><span class="special">(</span><span class="keyword">unsigned</span> position<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns the name that should be associated with positional options at 'position'. Precondition: position < max_total_count() </p> -</li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="split_unix.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.positional_options_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="value_semantic.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/reading_file.html b/libs/program_options/doc/html/boost/program_options/reading_file.html deleted file mode 100644 index fbaa04911d..0000000000 --- a/libs/program_options/doc/html/boost/program_options/reading_file.html +++ /dev/null @@ -1,65 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class reading_file</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="invalid_command_line_style.html" title="Class invalid_command_line_style"> -<link rel="next" href="error_with_option_name.html" title="Class error_with_option_name"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="invalid_command_line_style.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="error_with_option_name.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.reading_file"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class reading_file</span></h2> -<p>boost::program_options::reading_file</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="reading_file.html" title="Class reading_file">reading_file</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error</span> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="reading_file.html#boost.program_options.reading_fileconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="reading_file.html#idp6556112-bb"><span class="identifier">reading_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="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63217392"></a><h2>Description</h2> -<p>Class thrown if config file can not be read </p> -<div class="refsect2"> -<a name="idp63218032"></a><h3> -<a name="boost.program_options.reading_fileconstruct-copy-destruct"></a><code class="computeroutput">reading_file</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp6556112-bb"></a><span class="identifier">reading_file</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="invalid_command_line_style.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="error_with_option_name.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/required_option.html b/libs/program_options/doc/html/boost/program_options/required_option.html deleted file mode 100644 index 9c23f84e48..0000000000 --- a/libs/program_options/doc/html/boost/program_options/required_option.html +++ /dev/null @@ -1,69 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class required_option</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="multiple_occurrences.html" title="Class multiple_occurrences"> -<link rel="next" href="error_with_no_option_name.html" title="Class error_with_no_option_name"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="multiple_occurrences.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="error_with_no_option_name.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.required_option"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class required_option</span></h2> -<p>boost::program_options::required_option</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="required_option.html" title="Class required_option">required_option</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error_with_option_name</span> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="required_option.html#boost.program_options.required_optionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="required_option.html#idp6756192-bb"><span class="identifier">required_option</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="special">;</span> - <a class="link" href="required_option.html#idp6757168-bb"><span class="special">~</span><span class="identifier">required_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63578224"></a><h2>Description</h2> -<p>Class thrown when a required/mandatory option is missing </p> -<div class="refsect2"> -<a name="idp63578896"></a><h3> -<a name="boost.program_options.required_optionconstruct-copy-destruct"></a><code class="computeroutput">required_option</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp6756192-bb"></a><span class="identifier">required_option</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> option_name<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp6757168-bb"></a><span class="special">~</span><span class="identifier">required_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="multiple_occurrences.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="error_with_no_option_name.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/split_unix.html b/libs/program_options/doc/html/boost/program_options/split_unix.html deleted file mode 100644 index 234df890fc..0000000000 --- a/libs/program_options/doc/html/boost/program_options/split_unix.html +++ /dev/null @@ -1,62 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function split_unix</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<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="parse_environme_idp6765216.html" title="Function parse_environment"> -<link rel="next" href="positional_opti_idp5922480.html" title="Class positional_options_description"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="parse_environme_idp6765216.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="positional_opti_idp5922480.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.split_unix"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function split_unix</span></h2> -<p>boost::program_options::split_unix</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> - -</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> -<span class="identifier">split_unix</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> cmdline<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> seperator <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> quote <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> escape <span class="special">=</span> <span class="string">"\\"</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">wstring</span> <span class="special">></span> -<span class="identifier">split_unix</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">&</span> cmdline<span class="special">,</span> - <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">&</span> seperator <span class="special">=</span> <span class="identifier">L</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">wstring</span> <span class="special">&</span> quote <span class="special">=</span> <span class="identifier">L</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">wstring</span> <span class="special">&</span> escape <span class="special">=</span> <span class="identifier">L</span><span class="string">"\\"</span><span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65677984"></a><h2>Description</h2> -<p>Splits a given string to a collection of single strings which can be passed to command_line_parser. The second parameter is used to specify a collection of possible seperator chars used for splitting. The seperator is defaulted to space " ". Splitting is done in a unix style way, with respect to quotes '"' and escape characters '\' </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="parse_environme_idp6765216.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="positional_opti_idp5922480.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/store_idp6705280.html b/libs/program_options/doc/html/boost/program_options/store_idp6705280.html deleted file mode 100644 index 22fd647450..0000000000 --- a/libs/program_options/doc/html/boost/program_options/store_idp6705280.html +++ /dev/null @@ -1,56 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function store</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> -<link rel="prev" href="variables_map.html" title="Class variables_map"> -<link rel="next" href="store_idp6709808.html" title="Function store"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="variables_map.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="store_idp6709808.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.store_idp6705280"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function store</span></h2> -<p>boost::program_options::store</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>">boost/program_options/variables_map.hpp</a>> - -</span> -<span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> -<span class="identifier">store</span><span class="special">(</span><span class="keyword">const</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="keyword">char</span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> m<span class="special">,</span> - <span class="keyword">bool</span> utf8 <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp67261648"></a><h2>Description</h2> -<p>Stores in 'm' all options that are defined in 'options'. If 'm' already has a non-defaulted value of an option, that value is not changed, even if 'options' specify some value. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="variables_map.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="store_idp6709808.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/store_idp6709808.html b/libs/program_options/doc/html/boost/program_options/store_idp6709808.html deleted file mode 100644 index 7e96c79685..0000000000 --- a/libs/program_options/doc/html/boost/program_options/store_idp6709808.html +++ /dev/null @@ -1,55 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function store</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> -<link rel="prev" href="store_idp6705280.html" title="Function store"> -<link rel="next" href="notify.html" title="Function notify"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="store_idp6705280.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="notify.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.store_idp6709808"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function store</span></h2> -<p>boost::program_options::store</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>">boost/program_options/variables_map.hpp</a>> - -</span> -<span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> -<span class="identifier">store</span><span class="special">(</span><span class="keyword">const</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="keyword">wchar_t</span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> m<span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp67276544"></a><h2>Description</h2> -<p>Stores in 'm' all options that are defined in 'options'. If 'm' already has a non-defaulted value of an option, that value is not changed, even if 'options' specify some value. This is wide character variant. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="store_idp6705280.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="notify.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/too_many_positi_idp7389984.html b/libs/program_options/doc/html/boost/program_options/too_many_positi_idp7389984.html deleted file mode 100644 index 13b4daf163..0000000000 --- a/libs/program_options/doc/html/boost/program_options/too_many_positi_idp7389984.html +++ /dev/null @@ -1,67 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class too_many_positional_options_error</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="error.html" title="Class error"> -<link rel="next" href="invalid_command_line_style.html" title="Class invalid_command_line_style"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="error.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_command_line_style.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.too_many_positi_idp7389984"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class too_many_positional_options_error</span></h2> -<p>boost::program_options::too_many_positional_options_error</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="too_many_positi_idp7389984.html" title="Class too_many_positional_options_error">too_many_positional_options_error</a> <span class="special">:</span> - <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error</span> -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="too_many_positi_idp7389984.html#boost.program_options.too_many_positi_idp7389984construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="too_many_positi_idp7389984.html#idp7392080-bb"><span class="identifier">too_many_positional_options_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63168400"></a><h2>Description</h2> -<p>Class thrown when there are too many positional options. This is a programming error. </p> -<div class="refsect2"> -<a name="idp63169040"></a><h3> -<a name="boost.program_options.too_many_positi_idp7389984construct-copy-destruct"></a><code class="computeroutput">too_many_positional_options_error</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp7392080-bb"></a><span class="identifier">too_many_positional_options_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="error.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_command_line_style.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/typed_value.html b/libs/program_options/doc/html/boost/program_options/typed_value.html deleted file mode 100644 index 419b035dfe..0000000000 --- a/libs/program_options/doc/html/boost/program_options/typed_value.html +++ /dev/null @@ -1,158 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class template typed_value</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="typed_value_base.html" title="Class typed_value_base"> -<link rel="next" href="value.html" title="Function value"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="typed_value_base.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.typed_value"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class template typed_value</span></h2> -<p>boost::program_options::typed_value</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> - -</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> charT <span class="special">=</span> <span class="keyword">char</span><span class="special">></span> -<span class="keyword">class</span> <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">:</span> <span class="keyword">public</span> boost::program_options::value_semantic_codecvt_helper< charT >, - <span class="keyword">public</span> boost::program_options::typed_value_base -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="typed_value.html#boost.program_options.typed_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="typed_value.html#idp8519888-bb"><span class="identifier">typed_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="comment">// <a class="link" href="typed_value.html#idp8839216-bb">public member functions</a></span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp8839776-bb"><span class="identifier">default_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp8842128-bb"><span class="identifier">default_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</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> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp6773056-bb"><span class="identifier">implicit_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp6775488-bb"><span class="identifier">value_name</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="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp6777776-bb"><span class="identifier">implicit_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</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> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp6781168-bb"><span class="identifier">notifier</span></a><span class="special">(</span><span class="identifier">function1</span><span class="special"><</span> <span class="keyword">void</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <span class="special">></span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp5975888-bb"><span class="identifier">composing</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp5977408-bb"><span class="identifier">multitoken</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp5978928-bb"><span class="identifier">zero_tokens</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp5980816-bb"><span class="identifier">required</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="typed_value.html#idp5982384-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="typed_value.html#idp5983504-bb"><span class="identifier">is_composing</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">unsigned</span> <a class="link" href="typed_value.html#idm33328-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">unsigned</span> <a class="link" href="typed_value.html#idm32208-bb"><span class="identifier">max_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="typed_value.html#idm31088-bb"><span class="identifier">adjacent_tokens_only</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="typed_value.html#idm29968-bb"><span class="identifier">is_required</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="typed_value.html#idm28848-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</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">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="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="typed_value.html#idm25872-bb"><span class="identifier">apply_default</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="typed_value.html#idp8516000-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span> <span class="special">&</span> <a class="link" href="typed_value.html#idp8518336-bb"><span class="identifier">value_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp66578192"></a><h2>Description</h2> -<p>Class which handles value of a specific type. </p> -<div class="refsect2"> -<a name="idp66578928"></a><h3> -<a name="boost.program_options.typed_valueconstruct-copy-destruct"></a><code class="computeroutput">typed_value</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp8519888-bb"></a><span class="identifier">typed_value</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> store_to<span class="special">)</span><span class="special">;</span></pre> -<p>Ctor. The 'store_to' parameter tells where to store the value when it's known. The parameter can be NULL. </p> -</li></ol></div> -</div> -<div class="refsect2"> -<a name="idp66586704"></a><h3> -<a name="idp8839216-bb"></a><code class="computeroutput">typed_value</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp8839776-bb"></a><span class="identifier">default_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<span class="special">)</span><span class="special">;</span></pre> -<p>Specifies default value, which will be used if none is explicitly specified. The type 'T' should provide operator<< for ostream. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp8842128-bb"></a><span class="identifier">default_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<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> textual<span class="special">)</span><span class="special">;</span></pre> -<p>Specifies default value, which will be used if none is explicitly specified. Unlike the above overload, the type 'T' need not provide operator<< for ostream, but textual representation of default value must be provided by the user. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp6773056-bb"></a><span class="identifier">implicit_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<span class="special">)</span><span class="special">;</span></pre> -<p>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, but if given, must be strictly adjacent to the option, i.e.: '-ovalue' or '--option=value'. Giving '-o' or '--option' will cause the implicit value to be applied. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp6775488-bb"></a><span class="identifier">value_name</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> name<span class="special">)</span><span class="special">;</span></pre> -<p>Specifies the name used to to the value in help message. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp6777776-bb"></a><span class="identifier">implicit_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<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> textual<span class="special">)</span><span class="special">;</span></pre> -<p>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, but if given, must be strictly adjacent to the option, i.e.: '-ovalue' or '--option=value'. Giving '-o' or '--option' will cause the implicit value to be applied. Unlike the above overload, the type 'T' need not provide operator<< for ostream, but textual representation of default value must be provided by the user. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp6781168-bb"></a><span class="identifier">notifier</span><span class="special">(</span><span class="identifier">function1</span><span class="special"><</span> <span class="keyword">void</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <span class="special">></span> f<span class="special">)</span><span class="special">;</span></pre> -<p>Specifies a function to be called when the final value is determined. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp5975888-bb"></a><span class="identifier">composing</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<p>Specifies that the value is composing. See the 'is_composing' method for explanation. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp5977408-bb"></a><span class="identifier">multitoken</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<p>Specifies that the value can span multiple tokens. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp5978928-bb"></a><span class="identifier">zero_tokens</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<p>Specifies that no tokens may be provided as the value of this option, which means that only presense of the option is significant. For such option to be useful, either the 'validate' function should be specialized, or the 'implicit_value' method should be also used. In most cases, you can use the 'bool_switch' function instead of using this method. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp5980816-bb"></a><span class="identifier">required</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<p>Specifies that the value must occur. </p> -</li> -<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp5982384-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp5983504-bb"></a><span class="identifier">is_composing</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">unsigned</span> <a name="idm33328-bb"></a><span class="identifier">min_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">unsigned</span> <a name="idm32208-bb"></a><span class="identifier">max_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm31088-bb"></a><span class="identifier">adjacent_tokens_only</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm29968-bb"></a><span class="identifier">is_required</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idm28848-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<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> new_tokens<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Creates an instance of the 'validator' class and calls its operator() to perform the actual conversion. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idm25872-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>If default value was specified via previous call to 'default_value', stores that value into 'value_store'. Returns true if default value was stored. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp8516000-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>If an address of variable to store value was specified when creating *this, stores the value there. Otherwise, does nothing. </p> -</li> -<li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span> <span class="special">&</span> <a name="idp8518336-bb"></a><span class="identifier">value_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="typed_value_base.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/typed_value_base.html b/libs/program_options/doc/html/boost/program_options/typed_value_base.html deleted file mode 100644 index a65b894d96..0000000000 --- a/libs/program_options/doc/html/boost/program_options/typed_value_base.html +++ /dev/null @@ -1,73 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class typed_value_base</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="untyped_value.html" title="Class untyped_value"> -<link rel="next" href="typed_value.html" title="Class template typed_value"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="untyped_value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="typed_value.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.typed_value_base"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class typed_value_base</span></h2> -<p>boost::program_options::typed_value_base</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="typed_value_base.html" title="Class typed_value_base">typed_value_base</a> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="typed_value_base.html#boost.program_options.typed_value_baseconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="typed_value_base.html#idp6154992-bb"><span class="special">~</span><span class="identifier">typed_value_base</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="typed_value_base.html#idp6152880-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span> <span class="special">&</span> <a class="link" href="typed_value_base.html#idp6153440-bb"><span class="identifier">value_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp66404416"></a><h2>Description</h2> -<p>Base class for all option that have a fixed type, and are willing to announce this type to the outside world. Any 'value_semantics' for which you want to find out the type can be dynamic_cast-ed to <a class="link" href="typed_value_base.html" title="Class typed_value_base">typed_value_base</a>. If conversion succeeds, the 'type' method can be called. </p> -<div class="refsect2"> -<a name="idp66406176"></a><h3> -<a name="boost.program_options.typed_value_baseconstruct-copy-destruct"></a><code class="computeroutput">typed_value_base</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp6154992-bb"></a><span class="special">~</span><span class="identifier">typed_value_base</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -<div class="refsect2"> -<a name="idp66412752"></a><h3> -<a name="idp6152880-bb"></a><code class="computeroutput">typed_value_base</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span> <span class="special">&</span> <a name="idp6153440-bb"></a><span class="identifier">value_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="untyped_value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="typed_value.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/unknown_option.html b/libs/program_options/doc/html/boost/program_options/unknown_option.html deleted file mode 100644 index a94a706560..0000000000 --- a/libs/program_options/doc/html/boost/program_options/unknown_option.html +++ /dev/null @@ -1,71 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class unknown_option</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="error_with_no_option_name.html" title="Class error_with_no_option_name"> -<link rel="next" href="ambiguous_option.html" title="Class ambiguous_option"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="error_with_no_option_name.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="ambiguous_option.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.unknown_option"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class unknown_option</span></h2> -<p>boost::program_options::unknown_option</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="unknown_option.html" title="Class unknown_option">unknown_option</a> <span class="special">:</span> - <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error_with_no_option_name</span> -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="unknown_option.html#boost.program_options.unknown_optionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="unknown_option.html#idp7269392-bb"><span class="identifier">unknown_option</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="string">""</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="unknown_option.html#idp7270656-bb"><span class="special">~</span><span class="identifier">unknown_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp63685312"></a><h2>Description</h2> -<p>Class thrown when option name is not recognized. </p> -<div class="refsect2"> -<a name="idp63686048"></a><h3> -<a name="boost.program_options.unknown_optionconstruct-copy-destruct"></a><code class="computeroutput">unknown_option</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp7269392-bb"></a><span class="identifier">unknown_option</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> original_token <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp7270656-bb"></a><span class="special">~</span><span class="identifier">unknown_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="error_with_no_option_name.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="ambiguous_option.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/untyped_value.html b/libs/program_options/doc/html/boost/program_options/untyped_value.html deleted file mode 100644 index bdf7408f66..0000000000 --- a/libs/program_options/doc/html/boost/program_options/untyped_value.html +++ /dev/null @@ -1,122 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class untyped_value</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="value_semantic__idp9236160.html" title="Class value_semantic_codecvt_helper<wchar_t>"> -<link rel="next" href="typed_value_base.html" title="Class typed_value_base"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="value_semantic__idp9236160.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="typed_value_base.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.untyped_value"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class untyped_value</span></h2> -<p>boost::program_options::untyped_value</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="untyped_value.html" title="Class untyped_value">untyped_value</a> <span class="special">:</span> - <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">value_semantic_codecvt_helper</span><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="untyped_value.html#boost.program_options.untyped_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="untyped_value.html#idp6149888-bb"><span class="identifier">untyped_value</span></a><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="comment">// <a class="link" href="untyped_value.html#idp9507088-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="untyped_value.html#idp9507648-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="untyped_value.html#idp9509536-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="untyped_value.html#idp9511424-bb"><span class="identifier">max_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp9513312-bb"><span class="identifier">adjacent_tokens_only</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp9515216-bb"><span class="identifier">is_composing</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp6692832-bb"><span class="identifier">is_required</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="untyped_value.html#idp6694688-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</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">vector</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="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp6698016-bb"><span class="identifier">apply_default</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="untyped_value.html#idp6147232-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp66299488"></a><h2>Description</h2> -<p>Class which specifies a simple handling of a value: the value will have string type and only one token is allowed. </p> -<div class="refsect2"> -<a name="idp66300288"></a><h3> -<a name="boost.program_options.untyped_valueconstruct-copy-destruct"></a><code class="computeroutput">untyped_value</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp6149888-bb"></a><span class="identifier">untyped_value</span><span class="special">(</span><span class="keyword">bool</span> zero_tokens <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -<div class="refsect2"> -<a name="idp66308144"></a><h3> -<a name="idp9507088-bb"></a><code class="computeroutput">untyped_value</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp9507648-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns the name of the option. The name is only meaningful for automatic help message. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp9509536-bb"></a><span class="identifier">min_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>The minimum number of tokens for this option that should be present on the command line. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp9511424-bb"></a><span class="identifier">max_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>The maximum number of tokens for this option that should be present on the command line. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp9513312-bb"></a><span class="identifier">adjacent_tokens_only</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns true if the option should only take adjacent token, not one from further command-line arguments. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp9515216-bb"></a><span class="identifier">is_composing</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns true if values from different sources should be composed. Otherwise, value from the first source is used and values from other sources are discarded. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp6692832-bb"></a><span class="identifier">is_required</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns true if value must be given. Non-optional value </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp6694688-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>If 'value_store' is already initialized, or new_tokens has more than one elements, throws. Otherwise, assigns the first string from 'new_tokens' to 'value_store', without any modifications. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp6698016-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Does nothing. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp6147232-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Does nothing. </p> -</li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="value_semantic__idp9236160.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="typed_value_base.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/validation_error.html b/libs/program_options/doc/html/boost/program_options/validation_error.html deleted file mode 100644 index 337ac8d84f..0000000000 --- a/libs/program_options/doc/html/boost/program_options/validation_error.html +++ /dev/null @@ -1,89 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class validation_error</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="invalid_command_idp6969504.html" title="Class invalid_command_line_syntax"> -<link rel="next" href="invalid_option_value.html" title="Class invalid_option_value"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="invalid_command_idp6969504.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_option_value.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.validation_error"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class validation_error</span></h2> -<p>boost::program_options::validation_error</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="validation_error.html" title="Class validation_error">validation_error</a> <span class="special">:</span> - <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error_with_option_name</span> -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - - <span class="keyword">enum</span> <a name="boost.program_options.validation_error.kind_t"></a>kind_t <span class="special">{</span> multiple_values_not_allowed = 30, - at_least_one_value_required, invalid_bool_value, - invalid_option_value, invalid_option <span class="special">}</span><span class="special">;</span> - <span class="comment">// <a class="link" href="validation_error.html#boost.program_options.validation_errorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="validation_error.html#idp8832736-bb"><span class="identifier">validation_error</span></a><span class="special">(</span><span class="identifier">kind_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="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="validation_error.html#idp6891040-bb"><span class="special">~</span><span class="identifier">validation_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="validation_error.html#idp6891328-bb">protected member functions</a></span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="validation_error.html#idp6891904-bb"><span class="identifier">get_template</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp64049168"></a><h2>Description</h2> -<p>Class thrown when value of option is incorrect. </p> -<div class="refsect2"> -<a name="idp64049904"></a><h3> -<a name="boost.program_options.validation_errorconstruct-copy-destruct"></a><code class="computeroutput">validation_error</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp8832736-bb"></a><span class="identifier">validation_error</span><span class="special">(</span><span class="identifier">kind_t</span> kind<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> option_name <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> original_token <span class="special">=</span> <span class="string">""</span><span class="special">,</span> - <span class="keyword">int</span> option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp6891040-bb"></a><span class="special">~</span><span class="identifier">validation_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp64073200"></a><h3> -<a name="idp6891328-bb"></a><code class="computeroutput">validation_error</code> protected member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp6891904-bb"></a><span class="identifier">get_template</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre> -<p>Used to convert kind_t to a related error text </p> -</li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="invalid_command_idp6969504.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_option_value.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/value.html b/libs/program_options/doc/html/boost/program_options/value.html deleted file mode 100644 index a8c0517895..0000000000 --- a/libs/program_options/doc/html/boost/program_options/value.html +++ /dev/null @@ -1,55 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function value</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="typed_value.html" title="Class template typed_value"> -<link rel="next" href="wvalue.html" title="Function wvalue"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="typed_value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="wvalue.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.value"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function value</span></h2> -<p>boost::program_options::value</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> - -</span> -<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="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> <span class="identifier">value</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="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> <span class="identifier">value</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> v<span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp66763488"></a><h2>Description</h2> -<p>Creates a typed_value<T> instance. This function is the primary method to create <code class="computeroutput"><a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a></code> instance for a specific type, which can later be passed to '<code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code>' constructor. The second overload is used when it's additionally desired to store the value of option into program variable. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="typed_value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="wvalue.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/value_semantic.html b/libs/program_options/doc/html/boost/program_options/value_semantic.html deleted file mode 100644 index d6153d9fe8..0000000000 --- a/libs/program_options/doc/html/boost/program_options/value_semantic.html +++ /dev/null @@ -1,121 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class value_semantic</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="positional_opti_idp5922480.html" title="Class positional_options_description"> -<link rel="next" href="value_semantic__idp8632624.html" title="Class template value_semantic_codecvt_helper"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="positional_opti_idp5922480.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semantic__idp8632624.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.value_semantic"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class value_semantic</span></h2> -<p>boost::program_options::value_semantic</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="value_semantic.html#boost.program_options.value_semanticconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="value_semantic.html#idp8632336-bb"><span class="special">~</span><span class="identifier">value_semantic</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="value_semantic.html#idp7177040-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="value_semantic.html#idp7177600-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="value_semantic.html#idp6387520-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="value_semantic.html#idp6389408-bb"><span class="identifier">max_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="value_semantic.html#idp6391296-bb"><span class="identifier">adjacent_tokens_only</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="value_semantic.html#idp6393200-bb"><span class="identifier">is_composing</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="value_semantic.html#idp6395152-bb"><span class="identifier">is_required</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> - <a class="link" href="value_semantic.html#idp7784592-bb"><span class="identifier">parse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</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">vector</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="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="value_semantic.html#idp7788640-bb"><span class="identifier">apply_default</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="value_semantic.html#idp7791248-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp65937360"></a><h2>Description</h2> -<p>Class which specifies how the option's value is to be parsed and converted into C++ types. </p> -<div class="refsect2"> -<a name="idp65938144"></a><h3> -<a name="boost.program_options.value_semanticconstruct-copy-destruct"></a><code class="computeroutput">value_semantic</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp8632336-bb"></a><span class="special">~</span><span class="identifier">value_semantic</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> -</div> -<div class="refsect2"> -<a name="idp65944576"></a><h3> -<a name="idp7177040-bb"></a><code class="computeroutput">value_semantic</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp7177600-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> -<p>Returns the name of the option. The name is only meaningful for automatic help message. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp6387520-bb"></a><span class="identifier">min_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> -<p>The minimum number of tokens for this option that should be present on the command line. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp6389408-bb"></a><span class="identifier">max_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> -<p>The maximum number of tokens for this option that should be present on the command line. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp6391296-bb"></a><span class="identifier">adjacent_tokens_only</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> -<p>Returns true if the option should only take adjacent token, not one from further command-line arguments. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp6393200-bb"></a><span class="identifier">is_composing</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> -<p>Returns true if values from different sources should be composed. Otherwise, value from the first source is used and values from other sources are discarded. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp6395152-bb"></a><span class="identifier">is_required</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> -<p>Returns true if value must be given. Non-optional value </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp7784592-bb"></a><span class="identifier">parse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">,</span> - <span class="keyword">bool</span> utf8<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> -<p>Parses a group of tokens that specify a value of option. Stores the result in 'value_store', using whatever representation is desired. May be be called several times if value of the same option is specified more than once. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp7788640-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> -<p>Called to assign default value to 'value_store'. Returns true if default value is assigned, and false if no default value exists. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp7791248-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> -<p>Called when final value of an option is determined. </p> -</li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="positional_opti_idp5922480.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semantic__idp8632624.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/value_semantic__idp8632624.html b/libs/program_options/doc/html/boost/program_options/value_semantic__idp8632624.html deleted file mode 100644 index c83bf56aa1..0000000000 --- a/libs/program_options/doc/html/boost/program_options/value_semantic__idp8632624.html +++ /dev/null @@ -1,62 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class template value_semantic_codecvt_helper</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="value_semantic.html" title="Class value_semantic"> -<link rel="next" href="value_semantic__idp8634400.html" title="Class value_semantic_codecvt_helper<char>"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="value_semantic.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semantic__idp8634400.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.value_semantic__idp8632624"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class template value_semantic_codecvt_helper</span></h2> -<p>boost::program_options::value_semantic_codecvt_helper</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> - -</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="value_semantic__idp8632624.html" title="Class template value_semantic_codecvt_helper">value_semantic_codecvt_helper</a> <span class="special">{</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp66040096"></a><h2>Description</h2> -<p>Helper class which perform necessary character conversions in the 'parse' method and forwards the data further. </p> -<div class="refsect2"> -<a name="idp66040896"></a><h3>Specializations</h3> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p><a class="link" href="value_semantic__idp8634400.html" title="Class value_semantic_codecvt_helper<char>">Class value_semantic_codecvt_helper<char></a></p></li> -<li class="listitem"><p><a class="link" href="value_semantic__idp9236160.html" title="Class value_semantic_codecvt_helper<wchar_t>">Class value_semantic_codecvt_helper<wchar_t></a></p></li> -</ul></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="value_semantic.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semantic__idp8634400.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/value_semantic__idp8634400.html b/libs/program_options/doc/html/boost/program_options/value_semantic__idp8634400.html deleted file mode 100644 index 1fc2db5dc7..0000000000 --- a/libs/program_options/doc/html/boost/program_options/value_semantic__idp8634400.html +++ /dev/null @@ -1,83 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class value_semantic_codecvt_helper<char></title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="value_semantic__idp8632624.html" title="Class template value_semantic_codecvt_helper"> -<link rel="next" href="value_semantic__idp9236160.html" title="Class value_semantic_codecvt_helper<wchar_t>"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="value_semantic__idp8632624.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semantic__idp9236160.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.value_semantic__idp8634400"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class value_semantic_codecvt_helper<char></span></h2> -<p>boost::program_options::value_semantic_codecvt_helper<char></p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="value_semantic__idp8634400.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">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">value_semantic</span> -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - - <span class="comment">// <a class="link" href="value_semantic__idp8634400.html#idp8636768-bb">private member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> - <a class="link" href="value_semantic__idp8634400.html#idp8637344-bb"><span class="identifier">parse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</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">vector</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="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="value_semantic__idp8634400.html#idp9232640-bb">protected member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> - <a class="link" href="value_semantic__idp8634400.html#idp9233216-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</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">vector</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="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp66091616"></a><h2>Description</h2> -<p>Helper conversion class for values that accept ascii strings as input. Overrides the 'parse' method and defines new 'xparse' method taking std::string. Depending on whether input to parse is ascii or UTF8, will pass it to xparse unmodified, or with UTF8->ascii conversion. </p> -<div class="refsect2"> -<a name="idp66092816"></a><h3> -<a name="idp8636768-bb"></a><code class="computeroutput">value_semantic_codecvt_helper</code> private member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp8637344-bb"></a><span class="identifier">parse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">,</span> - <span class="keyword">bool</span> utf8<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Parses a group of tokens that specify a value of option. Stores the result in 'value_store', using whatever representation is desired. May be be called several times if value of the same option is specified more than once. </p> -</li></ol></div> -</div> -<div class="refsect2"> -<a name="idp66111728"></a><h3> -<a name="idp9232640-bb"></a><code class="computeroutput">value_semantic_codecvt_helper</code> protected member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp9233216-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="value_semantic__idp8632624.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semantic__idp9236160.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/value_semantic__idp9236160.html b/libs/program_options/doc/html/boost/program_options/value_semantic__idp9236160.html deleted file mode 100644 index c658e1ffbd..0000000000 --- a/libs/program_options/doc/html/boost/program_options/value_semantic__idp9236160.html +++ /dev/null @@ -1,83 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class value_semantic_codecvt_helper<wchar_t></title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="value_semantic__idp8634400.html" title="Class value_semantic_codecvt_helper<char>"> -<link rel="next" href="untyped_value.html" title="Class untyped_value"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="value_semantic__idp8634400.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="untyped_value.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.value_semantic__idp9236160"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class value_semantic_codecvt_helper<wchar_t></span></h2> -<p>boost::program_options::value_semantic_codecvt_helper<wchar_t></p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="value_semantic__idp9236160.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">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">value_semantic</span> -<span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - - <span class="comment">// <a class="link" href="value_semantic__idp9236160.html#idp9238512-bb">private member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> - <a class="link" href="value_semantic__idp9236160.html#idp7358480-bb"><span class="identifier">parse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</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">vector</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="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="value_semantic__idp9236160.html#idp7362704-bb">protected member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> - <a class="link" href="value_semantic__idp9236160.html#idp7363280-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</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">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp66178448"></a><h2>Description</h2> -<p>Helper conversion class for values that accept ascii strings as input. Overrides the 'parse' method and defines new 'xparse' method taking std::wstring. Depending on whether input to parse is ascii or UTF8, will recode input to Unicode, or pass it unmodified. </p> -<div class="refsect2"> -<a name="idp66179392"></a><h3> -<a name="idp9238512-bb"></a><code class="computeroutput">value_semantic_codecvt_helper</code> private member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp7358480-bb"></a><span class="identifier">parse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">,</span> - <span class="keyword">bool</span> utf8<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Parses a group of tokens that specify a value of option. Stores the result in 'value_store', using whatever representation is desired. May be be called several times if value of the same option is specified more than once. </p> -</li></ol></div> -</div> -<div class="refsect2"> -<a name="idp66198400"></a><h3> -<a name="idp7362704-bb"></a><code class="computeroutput">value_semantic_codecvt_helper</code> protected member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp7363280-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<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">wstring</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="value_semantic__idp8634400.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="untyped_value.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/variable_value.html b/libs/program_options/doc/html/boost/program_options/variable_value.html deleted file mode 100644 index c02749a885..0000000000 --- a/libs/program_options/doc/html/boost/program_options/variable_value.html +++ /dev/null @@ -1,118 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class variable_value</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> -<link rel="prev" href="bool_switch.html" title="Function bool_switch"> -<link rel="next" href="abstract_variables_map.html" title="Class abstract_variables_map"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="bool_switch.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="abstract_variables_map.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.variable_value"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class variable_value</span></h2> -<p>boost::program_options::variable_value</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>">boost/program_options/variables_map.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="variable_value.html#boost.program_options.variable_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="variable_value.html#idp8291888-bb"><span class="identifier">variable_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="variable_value.html#idp8292176-bb"><span class="identifier">variable_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="variable_value.html#idp6662432-bb">friend functions</a></span> - <span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> - <a class="link" href="variable_value.html#idp6662992-bb"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</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="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="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="special">;</span> - - <span class="comment">// <a class="link" href="variable_value.html#idp9811120-bb">public member functions</a></span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp9811680-bb"><span class="identifier">as</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp9814144-bb"><span class="identifier">as</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="variable_value.html#idp8285920-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="variable_value.html#idp8287296-bb"><span class="identifier">defaulted</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp8288896-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp8290448-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp66929088"></a><h2>Description</h2> -<p>Class holding value of option. Contains details about how the value is set and allows to conveniently obtain the value. </p> -<div class="refsect2"> -<a name="idp66929904"></a><h3> -<a name="boost.program_options.variable_valueconstruct-copy-destruct"></a><code class="computeroutput">variable_value</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp8291888-bb"></a><span class="identifier">variable_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp8292176-bb"></a><span class="identifier">variable_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> xv<span class="special">,</span> <span class="keyword">bool</span> xdefaulted<span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp66944064"></a><h3> -<a name="idp6662432-bb"></a><code class="computeroutput">variable_value</code> friend functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> -<a name="idp6662992-bb"></a><span class="identifier">store</span><span class="special">(</span><span class="keyword">const</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="keyword">char</span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> m<span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span></pre> -<p>Stores in 'm' all options that are defined in 'options'. If 'm' already has a non-defaulted value of an option, that value is not changed, even if 'options' specify some value. </p> -</li></ol></div> -</div> -<div class="refsect2"> -<a name="idp66960144"></a><h3> -<a name="idp9811120-bb"></a><code class="computeroutput">variable_value</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a name="idp9811680-bb"></a><span class="identifier">as</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>If stored value if of type T, returns that value. Otherwise, throws boost::bad_any_cast exception. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <span class="special">&</span> <a name="idp9814144-bb"></a><span class="identifier">as</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp8285920-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if no value is stored. </li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp8287296-bb"></a><span class="identifier">defaulted</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns true if the value was not explicitly given, but has default value. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a name="idp8288896-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns the contained value. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a name="idp8290448-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<p>Returns the contained value. </p> -</li> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="bool_switch.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="abstract_variables_map.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/variables_map.html b/libs/program_options/doc/html/boost/program_options/variables_map.html deleted file mode 100644 index 352a41d877..0000000000 --- a/libs/program_options/doc/html/boost/program_options/variables_map.html +++ /dev/null @@ -1,137 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class variables_map</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> -<link rel="prev" href="abstract_variables_map.html" title="Class abstract_variables_map"> -<link rel="next" href="store_idp6705280.html" title="Function store"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="abstract_variables_map.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="store_idp6705280.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.variables_map"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class variables_map</span></h2> -<p>boost::program_options::variables_map</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>">boost/program_options/variables_map.hpp</a>> - -</span> -<span class="keyword">class</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">abstract_variables_map</span> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="variables_map.html#boost.program_options.variables_mapconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="variables_map.html#idp6953584-bb"><span class="identifier">variables_map</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="variables_map.html#idp6953872-bb"><span class="identifier">variables_map</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="variables_map.html#idp5558720-bb">public member functions</a></span> - <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="variables_map.html#idp6713648-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</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="special">;</span> - <span class="keyword">void</span> <a class="link" href="variables_map.html#idp6721904-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="variables_map.html#idp6722752-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="variables_map.html#idp6955184-bb">private member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="variables_map.html#idp6955760-bb"><span class="identifier">get</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="special">;</span> - - <span class="comment">// <a class="link" href="variables_map.html#idp6958928-bb">friend functions</a></span> - <span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> - <a class="link" href="variables_map.html#idp6959488-bb"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</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="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="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="special">;</span> -<span class="special">}</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp67175568"></a><h2>Description</h2> -<p>Concrete variables map which store variables in real map.</p> -<p>This class is derived from std::map<std::string, variable_value>, so you can use all map operators to examine its content. </p> -<div class="refsect2"> -<a name="idp67176784"></a><h3> -<a name="boost.program_options.variables_mapconstruct-copy-destruct"></a><code class="computeroutput">variables_map</code> - public - construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp6953584-bb"></a><span class="identifier">variables_map</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp6953872-bb"></a><span class="identifier">variables_map</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span> next<span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp67188656"></a><h3> -<a name="idp5558720-bb"></a><code class="computeroutput">variables_map</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp6713648-bb"></a><span class="keyword">operator</span><span class="special">[</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> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Obtains the value of variable 'name', from *this and possibly from the chain of variable maps.</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> -<p>if there's no value in *this.</p> -<div class="itemizedlist"><ul class="itemizedlist" type="circle"> -<li class="listitem"><p>if there's next variable map, returns value from it</p></li> -<li class="listitem"><p>otherwise, returns empty value</p></li> -</ul></div> -<p> -</p> -</li></ul></div> -<p> -</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> -<p>if there's defaulted value</p> -<div class="itemizedlist"><ul class="itemizedlist" type="circle"> -<li class="listitem"><p>if there's next variable map, which has a non-defaulted value, return that</p></li> -<li class="listitem"><p>otherwise, return value from *this</p></li> -</ul></div> -<p> -</p> -</li></ul></div> -<p> -</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>if there's a non-defaulted value, returns it. </p></li></ul></div> -<p> -</p> -</li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp6721904-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp6722752-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp67215728"></a><h3> -<a name="idp6955184-bb"></a><code class="computeroutput">variables_map</code> private member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp6955760-bb"></a><span class="identifier">get</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> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Implementation of abstract_variables_map::get which does 'find' in *this. </p> -</li></ol></div> -</div> -<div class="refsect2"> -<a name="idp67228688"></a><h3> -<a name="idp6958928-bb"></a><code class="computeroutput">variables_map</code> friend functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> -<a name="idp6959488-bb"></a><span class="identifier">store</span><span class="special">(</span><span class="keyword">const</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="keyword">char</span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> xm<span class="special">,</span> - <span class="keyword">bool</span> utf8<span class="special">)</span><span class="special">;</span></pre> -<p>Stores in 'm' all options that are defined in 'options'. If 'm' already has a non-defaulted value of an option, that value is not changed, even if 'options' specify some value. </p> -</li></ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="abstract_variables_map.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="store_idp6705280.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/boost/program_options/wvalue.html b/libs/program_options/doc/html/boost/program_options/wvalue.html deleted file mode 100644 index fdef07600a..0000000000 --- a/libs/program_options/doc/html/boost/program_options/wvalue.html +++ /dev/null @@ -1,55 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Function wvalue</title> -<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="value.html" title="Function value"> -<link rel="next" href="bool_switch.html" title="Function bool_switch"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> -<td align="center"><a href="../../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="bool_switch.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.program_options.wvalue"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Function wvalue</span></h2> -<p>boost::program_options::wvalue</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> - -</span> -<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="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> <span class="identifier">wvalue</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="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> <span class="identifier">wvalue</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> v<span class="special">)</span><span class="special">;</span></pre></div> -<div class="refsect1"> -<a name="idp66791040"></a><h2>Description</h2> -<p>Creates a typed_value<T> instance. This function is the primary method to create <code class="computeroutput"><a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a></code> instance for a specific type, which can later be passed to '<code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code>' constructor. </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="bool_switch.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/index.html b/libs/program_options/doc/html/index.html deleted file mode 100644 index 6dd22c2111..0000000000 --- a/libs/program_options/doc/html/index.html +++ /dev/null @@ -1,123 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Chapter 1. Boost.Program_options</title> -<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="index.html" title="Chapter 1. Boost.Program_options"> -<link rel="next" href="program_options/tutorial.html" title="Tutorial"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> -<td align="center"><a href="../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"><a accesskey="n" href="program_options/tutorial.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div> -<div class="chapter"> -<div class="titlepage"><div> -<div><h2 class="title"> -<a name="program_options"></a>Chapter 1. Boost.Program_options</h2></div> -<div><div class="author"><h3 class="author"> -<span class="firstname">Vladimir</span> <span class="surname">Prus</span> -</h3></div></div> -<div><p class="copyright">Copyright © 2002-2004 Vladimir Prus</p></div> -<div><div class="legalnotice"> -<a name="idp57740672"></a><p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></div> -</div></div> -<div class="toc"> -<p><b>Table of Contents</b></p> -<dl> -<dt><span class="section"><a href="index.html#idp57777664">Introduction</a></span></dt> -<dt><span class="section"><a href="program_options/tutorial.html">Tutorial</a></span></dt> -<dd><dl> -<dt><span class="section"><a href="program_options/tutorial.html#idp61505680">Getting Started</a></span></dt> -<dt><span class="section"><a href="program_options/tutorial.html#idp57669040">Option Details</a></span></dt> -<dt><span class="section"><a href="program_options/tutorial.html#idp62599264">Multiple Sources</a></span></dt> -</dl></dd> -<dt><span class="section"><a href="program_options/overview.html">Library Overview</a></span></dt> -<dd><dl> -<dt><span class="section"><a href="program_options/overview.html#idp62625248">Options Description Component</a></span></dt> -<dt><span class="section"><a href="program_options/overview.html#idp62681168">Parsers Component</a></span></dt> -<dt><span class="section"><a href="program_options/overview.html#idp62690848">Storage Component</a></span></dt> -<dt><span class="section"><a href="program_options/overview.html#idp62701408">Specific parsers</a></span></dt> -<dt><span class="section"><a href="program_options/overview.html#idp62729312">Annotated List of Symbols</a></span></dt> -</dl></dd> -<dt><span class="section"><a href="program_options/howto.html">How To</a></span></dt> -<dd><dl> -<dt><span class="section"><a href="program_options/howto.html#idp62753184">Non-conventional Syntax</a></span></dt> -<dt><span class="section"><a href="program_options/howto.html#idp62759200">Response Files</a></span></dt> -<dt><span class="section"><a href="program_options/howto.html#idp62766992">Winmain Command Line</a></span></dt> -<dt><span class="section"><a href="program_options/howto.html#idp62771840">Option Groups and Hidden Options</a></span></dt> -<dt><span class="section"><a href="program_options/howto.html#idp62785952">Custom Validators</a></span></dt> -<dt><span class="section"><a href="program_options/howto.html#idp62794432">Unicode Support</a></span></dt> -<dt><span class="section"><a href="program_options/howto.html#idp62812256">Allowing Unknown Options</a></span></dt> -</dl></dd> -<dt><span class="section"><a href="program_options/design.html">Design Discussion</a></span></dt> -<dd><dl><dt><span class="section"><a href="program_options/design.html#program_options.design.unicode">Unicode Support</a></span></dt></dl></dd> -<dt><span class="section"><a href="index/s06.html">Acknowledgements</a></span></dt> -<dt><span class="section"><a href="program_options/reference.html">Reference</a></span></dt> -<dd><dl> -<dt><span class="section"><a href="program_options/reference.html#header.boost.program_options.cmdline_hpp">Header <boost/program_options/cmdline.hpp></a></span></dt> -<dt><span class="section"><a href="program_options/reference.html#header.boost.program_options.config_hpp">Header <boost/program_options/config.hpp></a></span></dt> -<dt><span class="section"><a href="program_options/reference.html#header.boost.program_options.environment_iterator_hpp">Header <boost/program_options/environment_iterator.hpp></a></span></dt> -<dt><span class="section"><a href="program_options/reference.html#header.boost.program_options.eof_iterator_hpp">Header <boost/program_options/eof_iterator.hpp></a></span></dt> -<dt><span class="section"><a href="program_options/reference.html#header.boost.program_options.errors_hpp">Header <boost/program_options/errors.hpp></a></span></dt> -<dt><span class="section"><a href="program_options/reference.html#header.boost.program_options.option_hpp">Header <boost/program_options/option.hpp></a></span></dt> -<dt><span class="section"><a href="program_options/reference.html#header.boost.program_options.options_description_hpp">Header <boost/program_options/options_description.hpp></a></span></dt> -<dt><span class="section"><a href="program_options/reference.html#header.boost.program_options.parsers_hpp">Header <boost/program_options/parsers.hpp></a></span></dt> -<dt><span class="section"><a href="program_options/reference.html#header.boost.program_options.positional_options_hpp">Header <boost/program_options/positional_options.hpp></a></span></dt> -<dt><span class="section"><a href="program_options/reference.html#header.boost.program_options.value_semantic_hpp">Header <boost/program_options/value_semantic.hpp></a></span></dt> -<dt><span class="section"><a href="program_options/reference.html#header.boost.program_options.variables_map_hpp">Header <boost/program_options/variables_map.hpp></a></span></dt> -<dt><span class="section"><a href="program_options/reference.html#header.boost.program_options.version_hpp">Header <boost/program_options/version.hpp></a></span></dt> -</dl></dd> -</dl> -</div> -<div class="section"> -<div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="idp57777664"></a>Introduction</h2></div></div></div> -<p>The program_options library allows program developers to obtain - <span class="emphasis"><em>program options</em></span>, that is (name, value) pairs from the user, - via conventional methods such as command line and config file.</p> -<p>Why would you use such a library, and why is it better than parsing - your command line by straightforward hand-written code? - </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>It's easier. The syntax for declaring options is simple, and - the library itself is small. Things like conversion of option values to - desired type and storing into program variables are handled - automatically. - </p></li> -<li class="listitem"><p>Error reporting is better. All the problems with the command line are - reported, while hand-written code can just misparse the input. In - addition, the usage message can be automatically generated, to - avoid falling out of sync with the real list of options.</p></li> -<li class="listitem"><p>Options can be read from anywhere. Sooner or later the command - line will be not enough for your users, and you'll want config files - or maybe even environment variables. These can be added without significant - effort on your part. - </p></li> -</ul></div> -<p> - </p> -<p> - Now let's see some examples of the library usage in the <a class="xref" href="program_options/tutorial.html" title="Tutorial">the section called “Tutorial”</a>. - </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer"></div></td> -</tr></table> -<hr> -<div class="spirit-nav"><a accesskey="n" href="program_options/tutorial.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div> -</body> -</html> diff --git a/libs/program_options/doc/html/index/s06.html b/libs/program_options/doc/html/index/s06.html deleted file mode 100644 index 6f89496ad2..0000000000 --- a/libs/program_options/doc/html/index/s06.html +++ /dev/null @@ -1,96 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Acknowledgements</title> -<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="prev" href="../program_options/design.html" title="Design Discussion"> -<link rel="next" href="../program_options/reference.html" title="Reference"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> -<td align="center"><a href="../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../program_options/design.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../program_options/reference.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="section"> -<div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="idp62867472"></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 - would be otherwise. - </p> -<p>In the early stages, the library was affected by discussions with - Gennadiy Rozental, William Kempf and Alexander Okhotin. - </p> -<p>Hartmut Kaiser was the first person to try the library on his project - and send a number of suggestions and fixes. - </p> -<p>The formal review lead to numerous comments and enhancements. Pavol - Droba helped with the option description semantic. Gennadiy Rozental has - criticised many aspects of the library which caused various simplifications. - Pavel Vozenilek did carefull review of the implementation. A number of - comments were made by: - </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>David Abrahams</p></li> -<li class="listitem"><p>Neal D. Becker</p></li> -<li class="listitem"><p>Misha Bergal</p></li> -<li class="listitem"><p>James Curran</p></li> -<li class="listitem"><p>Carl Daniel</p></li> -<li class="listitem"><p>Beman Dawes</p></li> -<li class="listitem"><p>Tanton Gibbs</p></li> -<li class="listitem"><p>Holger Grund</p></li> -<li class="listitem"><p>Hartmut Kaiser</p></li> -<li class="listitem"><p>Petr Kocmid</p></li> -<li class="listitem"><p>Baptiste Lepilleur</p></li> -<li class="listitem"><p>Marcelo E. Magallon</p></li> -<li class="listitem"><p>Chuck Messenger</p></li> -<li class="listitem"><p>John Torjo</p></li> -<li class="listitem"><p>Matthias Troyer</p></li> -</ul></div> -<p> - </p> -<p>Doug Gregor and Reece Dunn helped to resolve the issues with Boostbook - version of the documentation. - </p> -<p>Even after review, a number of people have helped with further development: - </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>Rob Lievaart</p></li> -<li class="listitem"><p>Thorsten Ottosen</p></li> -<li class="listitem"><p>Joseph Wu</p></li> -<li class="listitem"><p>Ferdinand Prantl</p></li> -<li class="listitem"><p>Miro Jurisic</p></li> -<li class="listitem"><p>John Maddock</p></li> -<li class="listitem"><p>Janusz Piwowarski</p></li> -<li class="listitem"><p>Charles Brockman</p></li> -<li class="listitem"><p>Jonathan Wakely</p></li> -</ul></div> -<p> - </p> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../program_options/design.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../program_options/reference.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/program_option_HTML.manifest b/libs/program_options/doc/html/program_option_HTML.manifest deleted file mode 100644 index 87baa85a5b..0000000000 --- a/libs/program_options/doc/html/program_option_HTML.manifest +++ /dev/null @@ -1,64 +0,0 @@ -index.html -program_options/tutorial.html -program_options/overview.html -program_options/howto.html -program_options/design.html -index/s06.html -program_options/reference.html -boost/program_options/command_line_style/style_t.html -BOOST_PROGRAM_OPTIONS_DECL.html -boost/environment_iterator.html -boost/eof_iterator.html -boost/program_options/error.html -boost/program_options/too_many_positi_idp7389984.html -boost/program_options/invalid_command_line_style.html -boost/program_options/reading_file.html -boost/program_options/error_with_option_name.html -boost/program_options/multiple_values.html -boost/program_options/multiple_occurrences.html -boost/program_options/required_option.html -boost/program_options/error_with_no_option_name.html -boost/program_options/unknown_option.html -boost/program_options/ambiguous_option.html -boost/program_options/invalid_syntax.html -boost/program_options/invalid_config_file_syntax.html -boost/program_options/invalid_command_idp6969504.html -boost/program_options/validation_error.html -boost/program_options/invalid_option_value.html -boost/program_options/invalid_bool_value.html -boost/program_options/basic_option.html -boost/program_options/option_description.html -boost/program_options/options_descrip_idp8075600.html -boost/program_options/options_description.html -boost/program_options/duplicate_option_error.html -boost/program_options/basic_parsed_options.html -boost/program_options/basic_parsed_op_idp8181920.html -boost/program_options/basic_command_line_parser.html -boost/program_options/collect_unrecognized_mode.html -boost/program_options/ext_parser.html -boost/program_options/parse_command_line.html -boost/program_options/parse_config_fi_idp8590400.html -boost/program_options/parse_config_fi_idp5606176.html -boost/program_options/collect_unrecognized.html -boost/program_options/parse_environme_idp6997248.html -boost/program_options/parse_environme_idp7001408.html -boost/program_options/parse_environme_idp6765216.html -boost/program_options/split_unix.html -boost/program_options/positional_opti_idp5922480.html -boost/program_options/value_semantic.html -boost/program_options/value_semantic__idp8632624.html -boost/program_options/value_semantic__idp8634400.html -boost/program_options/value_semantic__idp9236160.html -boost/program_options/untyped_value.html -boost/program_options/typed_value_base.html -boost/program_options/typed_value.html -boost/program_options/value.html -boost/program_options/wvalue.html -boost/program_options/bool_switch.html -boost/program_options/variable_value.html -boost/program_options/abstract_variables_map.html -boost/program_options/variables_map.html -boost/program_options/store_idp6705280.html -boost/program_options/store_idp6709808.html -boost/program_options/notify.html -BOOST_PROGRAM_OPTIONS_VERSION.html diff --git a/libs/program_options/doc/html/program_options/design.html b/libs/program_options/doc/html/program_options/design.html deleted file mode 100644 index 9591f0c721..0000000000 --- a/libs/program_options/doc/html/program_options/design.html +++ /dev/null @@ -1,202 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Design Discussion</title> -<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="prev" href="howto.html" title="How To"> -<link rel="next" href="../index/s06.html" title="Acknowledgements"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> -<td align="center"><a href="../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="howto.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../index/s06.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="section"> -<div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="program_options.design"></a>Design Discussion</h2></div></div></div> -<div class="toc"><dl><dt><span class="section"><a href="design.html#program_options.design.unicode">Unicode Support</a></span></dt></dl></div> -<p>This section focuses on some of the design questions. - </p> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="program_options.design.unicode"></a>Unicode Support</h3></div></div></div> -<p>Unicode support was one of the features specifically requested - during the formal review. Throughout this document "Unicode support" is - a synonym for "wchar_t" support, assuming that "wchar_t" always uses - Unicode encoding. Also, when talking about "ascii" (in lowercase) we'll - not mean strict 7-bit ASCII encoding, but rather "char" strings in local - 8-bit encoding. - </p> -<p> - Generally, "Unicode support" can mean - many things, but for the program_options library it means that: - - </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>Each parser should accept either <code class="computeroutput">char*</code> - or <code class="computeroutput">wchar_t*</code>, correctly split the input into option - names and option values and return the data. - </p></li> -<li class="listitem"><p>For each option, it should be possible to specify whether the conversion - from string to value uses ascii or Unicode. - </p></li> -<li class="listitem"> -<p>The library guarantees that: - </p> -<div class="itemizedlist"><ul class="itemizedlist" type="circle"> -<li class="listitem"><p>ascii input is passed to an ascii value without change - </p></li> -<li class="listitem"><p>Unicode input is passed to a Unicode value without change</p></li> -<li class="listitem"><p>ascii input passed to a Unicode value, and Unicode input - passed to an ascii value will be converted using a codecvt - facet (which may be specified by the user). - </p></li> -</ul></div> -<p> - </p> -</li> -</ul></div> -<p> - </p> -<p>The important point is that it's possible to have some "ascii - options" together with "Unicode options". There are two reasons for - this. First, for a given type you might not have the code to extract the - value from Unicode string and it's not good to require that such code be written. - 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 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> -<p>Another important point is that ascii strings are passed though - without modification. In other words, it's not possible to just convert - ascii to Unicode and process the Unicode further. The problem is that the - default conversion mechanism -- the <code class="computeroutput">codecvt</code> facet -- might - not work with 8-bit input without additional setup. - </p> -<p>The Unicode support outlined above is not complete. For example, we - don't support Unicode option names. Unicode support is hard and - requires a Boost-wide solution. Even comparing two arbitrary Unicode - strings is non-trivial. Finally, using Unicode in option names is - related to internationalization, which has it's own - complexities. E.g. if option names depend on current locale, then all - program parts and other parts which use the name must be - internationalized too. - </p> -<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. - </p> -<p>The choice, mostly, is between code size and execution - speed. A templated solution would either link library code into every - application that uses the library (thereby making shared library - impossible), or provide explicit instantiations in the shared library - (increasing its size). The solution based on internal encoding would - necessarily make conversions in a number of places and will be somewhat slower. - Since speed is generally not an issue for this library, the second - solution looks more attractive, but we'll take a closer look at - individual components. - </p> -<p>For the parsers component, we have three choices: - </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>Use a fully templated implementation: given a string of a - certain type, a parser will return a <code class="computeroutput"><a class="link" href="reference.html#boost.program_options.parsed_options">parsed_options</a></code> instance - with strings of the same type (i.e. the <code class="computeroutput"><a class="link" href="reference.html#boost.program_options.parsed_options">parsed_options</a></code> class - will be templated).</p></li> -<li class="listitem"><p>Use internal encoding: same as above, but strings will be converted to and - from the internal encoding.</p></li> -<li class="listitem"><p>Use and partly expose the internal encoding: same as above, - but the strings in the <code class="computeroutput"><a class="link" href="reference.html#boost.program_options.parsed_options">parsed_options</a></code> instance will be in the - internal encoding. This might avoid a conversion if - <code class="computeroutput"><a class="link" href="reference.html#boost.program_options.parsed_options">parsed_options</a></code> instance is passed directly to other components, - but can be also dangerous or confusing for a user. - </p></li> -</ul></div> -<p> - </p> -<p>The second solution appears to be the best -- it does not increase - the code size much and is cleaner than the third. To avoid extra - conversions, the Unicode version of <code class="computeroutput"><a class="link" href="reference.html#boost.program_options.parsed_options">parsed_options</a></code> can also store - strings in internal encoding. - </p> -<p>For the options descriptions component, we don't have much - choice. Since it's not desirable to have either all options use ascii or all - of them use Unicode, but rather have some ascii and some Unicode options, the - interface of the <code class="computeroutput"><a class="link" href="../boost/program_options/value_semantic.html" title="Class value_semantic">value_semantic</a></code> must work with both. The only way is - to pass an additional flag telling if strings use ascii or internal encoding. - 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_idp6705280.html" title="Function store">store</a></code>. - For Unicode input, the <code class="computeroutput"><a class="link" href="../boost/program_options/store_idp6705280.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> -<p>Finally, what internal encoding should we use? The - alternatives are: - <code class="computeroutput">std::wstring</code> (using UCS-4 encoding) and - <code class="computeroutput">std::string</code> (using UTF-8 encoding). The difference between - alternatives is: - </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>Speed: UTF-8 is a bit slower</p></li> -<li class="listitem"><p>Space: UTF-8 takes less space when input is ascii</p></li> -<li class="listitem"><p>Code size: UTF-8 requires additional conversion code. However, - it allows one to use existing parsers without converting them to - <code class="computeroutput">std::wstring</code> and such conversion is likely to create a - number of new instantiations. - </p></li> -</ul></div> -<p> - There's no clear leader, but the last point seems important, so UTF-8 - 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, - so searching for 7-bit strings is simple. However, there are - two subtle issues: - </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>We need to assume the character literals use ascii encoding - and that inputs use Unicode encoding.</p></li> -<li class="listitem"><p>A Unicode character (say '=') can be followed by 'composing - character' and the combination is not the same as just '=', so a - simple search for '=' might find the wrong character. - </p></li> -</ul></div> -<p> - Neither of these issues appear to be critical in practice, since ascii is - almost universal encoding and since composing characters following '=' (and - other characters with special meaning to the library) are not likely to appear. - </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="howto.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../index/s06.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/program_options/howto.html b/libs/program_options/doc/html/program_options/howto.html deleted file mode 100644 index 27aa505d15..0000000000 --- a/libs/program_options/doc/html/program_options/howto.html +++ /dev/null @@ -1,453 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>How To</title> -<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="prev" href="overview.html" title="Library Overview"> -<link rel="next" href="design.html" title="Design Discussion"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> -<td align="center"><a href="../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="overview.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="design.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="section"> -<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> -<dt><span class="section"><a href="howto.html#idp62753184">Non-conventional Syntax</a></span></dt> -<dt><span class="section"><a href="howto.html#idp62759200">Response Files</a></span></dt> -<dt><span class="section"><a href="howto.html#idp62766992">Winmain Command Line</a></span></dt> -<dt><span class="section"><a href="howto.html#idp62771840">Option Groups and Hidden Options</a></span></dt> -<dt><span class="section"><a href="howto.html#idp62785952">Custom Validators</a></span></dt> -<dt><span class="section"><a href="howto.html#idp62794432">Unicode Support</a></span></dt> -<dt><span class="section"><a href="howto.html#idp62812256">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="idp62753184"></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="idp62754400"></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 - value, which are used directly. The above example can be handled by the - following code: - </p> -<p> - </p> -<pre class="programlisting"> -pair<string, string> reg_foo(const string& s) -{ - if (s.find("-f") == 0) { - if (s.substr(2, 3) == "no-") - return make_pair(s.substr(5), string("false")); - else - return make_pair(s.substr(2), string("true")); - } else { - return make_pair(string(), string()); - } -} -</pre> -<p> - Here's the definition of the additional parser. When parsing the command - line, we pass the additional parser: -</p> -<pre class="programlisting"> -store(command_line_parser(ac, av).options(desc).extra_parser(reg_foo) - .run(), vm); -</pre> -<p> - The complete example can be found in the "example/custom_syntax.cpp" - file. - </p> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp62759200"></a>Response Files</h3></div></div></div> -<a class="indexterm" name="idp62759840"></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 - the command line specifies a name of response file to use, it's loaded - and parsed in addition to the command line. The library does not - provide direct support for response files, so you'll need to write some - extra code. - </p> -<p> - First, you need to define an option for the response file: -</p> -<pre class="programlisting"> -("response-file", value<string>(), - "can be specified with '@name', too") -</pre> -<p> - </p> -<p>Second, you'll need an additional parser to support the standard syntax - for specifying response files: "@file": -</p> -<pre class="programlisting"> -pair<string, string> at_option_parser(string const&s) -{ - if ('@' == s[0]) - return std::make_pair(string("response-file"), s.substr(1)); - else - return pair<string, string>(); -} - -</pre> -<p> - </p> -<p>Finally, when the "response-file" option is found, you'll have to - load that file and pass it to the command line parser. This part is the - hardest. We'll use the Boost.Tokenizer library, which works but has some - limitations. You might also consider Boost.StringAlgo. The code is: -</p> -<pre class="programlisting"> -if (vm.count("response-file")) { - // Load the file and tokenize it - ifstream ifs(vm["response-file"].as<string>().c_str()); - if (!ifs) { - cout << "Could not open the response file\n"; - return 1; - } - // Read the whole file into a string - stringstream ss; - ss << ifs.rdbuf(); - // Split the file content - char_separator<char> sep(" \n\r"); - std::string ResponsefileContents( ss.str() ); - tokenizer<char_separator<char> > tok(ResponsefileContents, sep); - 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); -} - -</pre> -<p> - The complete example can be found in the "example/response_file.cpp" - file. - </p> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp62766992"></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 - compilers, it is possible to obtain - the split command line, but it's not clear if all compilers support the - same mechanism on all versions of the operating system. The - <code class="computeroutput">split_winmain</code> function is a portable mechanism provided - by the library.</p> -<p>Here's an example of use: -</p> -<pre class="programlisting"> -vector<string> args = split_winmain(lpCmdLine); -store(command_line_parser(args).options(desc).run(), vm); -</pre> -<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="idp62771840"></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> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>Some options make sense only for specific source, for example, - configuration files.</p></li> -<li class="listitem"><p>The user would prefer some structure in the generated help message.</p></li> -<li class="listitem"><p>Some options shouldn't appear in the generated help message at all.</p></li> -</ul></div> -<p> - </p> -<p>To solve the above issues, the library allows a programmer to create several - instances of the <code class="computeroutput"><a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a></code> class, which can be merged in - different combinations. The following example will define three groups of - options: command line specific, and two options group for specific program - modules, only one of which is shown in the generated help message. - </p> -<p>Each group is defined using standard syntax. However, you should - use reasonable names for each <code class="computeroutput"><a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a></code> instance: -</p> -<pre class="programlisting"> -options_description general("General options"); -general.add_options() - ("help", "produce a help message") - ("help-module", value<string>(), - "produce a help for a given module") - ("version", "output the version number") - ; - -options_description gui("GUI options"); -gui.add_options() - ("display", value<string>(), "display to use") - ; - -options_description backend("Backend options"); -backend.add_options() - ("num-threads", value<int>(), "the initial number of threads") - ; -</pre> -<p> - </p> -<p>After declaring options groups, we merge them in two - combinations. The first will include all options and be used for parsing. The - second will be used for the "--help" option. -</p> -<pre class="programlisting"> -// Declare an options description instance which will include -// all the options -options_description all("Allowed options"); -all.add(general).add(gui).add(backend); - -// Declare an options description instance which will be shown -// to the user -options_description visible("Allowed options"); -visible.add(general).add(gui); -</pre> -<p> - </p> -<p>What is left is to parse and handle the options: -</p> -<pre class="programlisting"> -variables_map vm; -store(parse_command_line(ac, av, all), vm); - -if (vm.count("help")) -{ - cout << visible; - return 0; -} -if (vm.count("help-module")) { - const string& s = vm["help-module"].as<string>(); - if (s == "gui") { - cout << gui; - } else if (s == "backend") { - cout << backend; - } else { - cout << "Unknown module '" - << s << "' in the --help-module option\n"; - return 1; - } - return 0; -} -if (vm.count("num-threads")) { - cout << "The 'num-threads' options was set to " - << vm["num-threads"].as<int>() << "\n"; -} -</pre> -<p> - When parsing the command line, all options are allowed. The "--help" - message, however, does not include the "Backend options" group -- the - options in that group are hidden. The user can explicitly force the - display of that options group by passing "--help-module backend" - option. The complete example can be found in the - "example/option_groups.cpp" file. - </p> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp62785952"></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 - classes. In order to do so, the user should provide suitable overload of - the <code class="computeroutput">validate</code> function. - </p> -<p> - Let's first define a simple class: -</p> -<pre class="programlisting"> -struct magic_number { -public: - magic_number(int n) : n(n) {} - int n; -}; -</pre> -<p> and then overload the <code class="computeroutput">validate</code> function: -</p> -<pre class="programlisting"> -void validate(boost::any& v, - const std::vector<std::string>& values, - magic_number* target_type, int) -{ - static regex r("\\d\\d\\d-(\\d\\d\\d)"); - - using namespace boost::program_options; - - // Make sure no previous assignment to 'a' was made. - validators::check_first_occurrence(v); - // Extract the first string from 'values'. If there is more than - // 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 - // 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 - the <code class="computeroutput">magic_number</code> class. The second is the list of strings - found in the next occurrence of the option. The remaining two parameters - are needed to workaround the lack of partial template specialization and - partial function template ordering on some compilers. - </p> -<p>The function first checks that we don't try to assign to the same - option twice. Then it checks that only a single string was passed - in. Next the string is verified with the help of the Boost.Regex - library. If that test is passed, the parsed value is stored into the - <code class="computeroutput">v</code> variable. - </p> -<p>The complete example can be found in the "example/regex.cpp" file. - </p> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp62794432"></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" type="disc"> -<li class="listitem"><p>Use Unicode-aware parsers for Unicode input</p></li> -<li class="listitem"><p>Require Unicode support for options which need it</p></li> -</ul></div> -<p> - </p> -<p>Most of the parsers have Unicode versions. For example, the - <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> function has an overload which takes - <code class="computeroutput">wchar_t</code> strings, instead of ordinary <code class="computeroutput">char</code>. - </p> -<p>Even if some of the parsers are Unicode-aware, it does not mean you - need to change definition of all the options. In fact, for many options, - like integer ones, it makes no sense. To make use of Unicode you'll need - <span class="emphasis"><em>some</em></span> Unicode-aware options. They are different from - ordinary options in that they accept <code class="computeroutput">wstring</code> input, and - process it using wide character streams. Creating an Unicode-aware option - is easy: just use the the <code class="computeroutput">wvalue</code> function instead of the - regular <code class="computeroutput">value</code>. - </p> -<p>When an ascii parser passes data to an ascii option, or a Unicode - parser passes data to a Unicode option, the data are not changed at - all. So, the ascii option will see a string in local 8-bit encoding, and - the Unicode option will see whatever string was passed as the Unicode - input. - </p> -<p>What happens when Unicode data is passed to an ascii option, and - vice versa? The library automatically performs the conversion from - Unicode to local 8-bit encoding. For example, if command line is in - ascii, but you use <code class="computeroutput">wstring</code> options, then the ascii input - will be converted into Unicode. - </p> -<p>To perform the conversion, the library uses the <code class="computeroutput">codecvt<wchar_t, - char></code> locale facet from the global locale. If - you want to work with strings that use local 8-bit encoding (as opposed to - 7-bit ascii subset), your application should start with: - </p> -<pre class="programlisting"> -locale::global(locale("")); - </pre> -<p> - which would set up the conversion facet according to the user's selected - 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: - </p> -<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 environment. On Linux, one can - run, for example: </p> -<pre class="screen"> -$ export LC_CTYPE=ru_RU.KOI8-R -</pre> -<p> - </p> -</li> -<li class="listitem"><p>Run the "test_convert" binary with any non-ascii string in the - selected encoding as its parameter. If you see a list of Unicode codepoints, - everything's OK. Otherwise, locale support on your system might be - broken.</p></li> -</ol></div> -<p> - </p> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp62812256"></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="../index.html" title="Chapter 1. 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 - 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#idp213056-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(); - </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 - 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 - <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 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> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="overview.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="design.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/program_options/overview.html b/libs/program_options/doc/html/program_options/overview.html deleted file mode 100644 index b338021276..0000000000 --- a/libs/program_options/doc/html/program_options/overview.html +++ /dev/null @@ -1,617 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Library Overview</title> -<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="prev" href="tutorial.html" title="Tutorial"> -<link rel="next" href="howto.html" title="How To"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> -<td align="center"><a href="../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="tutorial.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="howto.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="section"> -<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> -<dt><span class="section"><a href="overview.html#idp62625248">Options Description Component</a></span></dt> -<dt><span class="section"><a href="overview.html#idp62681168">Parsers Component</a></span></dt> -<dt><span class="section"><a href="overview.html#idp62690848">Storage Component</a></span></dt> -<dt><span class="section"><a href="overview.html#idp62701408">Specific parsers</a></span></dt> -<dt><span class="section"><a href="overview.html#idp62729312">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 - components and their function. - </p> -<p>The library has three main components: - </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>The options description component, which describes the allowed options - 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. - </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 - representation of values that parsers return into desired C++ types. - </p></li> -</ul></div> -<p> - </p> -<p>To be a little more concrete, the <code class="computeroutput">options_description</code> - class is from the options description component, the - <code class="computeroutput">parse_command_line</code> function is from the parsers component, and the - <code class="computeroutput">variables_map</code> class is from the storage component. </p> -<p>In the tutorial we've learned how those components can be used by the - <code class="computeroutput">main</code> function to parse the command line and config - file. Before going into the details of each component, a few notes about - the world outside of <code class="computeroutput">main</code>. - </p> -<p> - For that outside world, the storage component is the most important. It - provides a class which stores all option values and that class can be - freely passed around your program to modules which need access to the - options. All the other components can be used only in the place where - the actual parsing is the done. However, it might also make sense for the - individual program modules to describe their options and pass them to the - main module, which will merge all options. Of course, this is only - important when the number of options is large and declaring them in one - place becomes troublesome. - </p> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp62625248"></a>Options Description Component</h3></div></div></div> -<div class="toc"><dl> -<dt><span class="section"><a href="overview.html#idp62648560">Syntactic Information</a></span></dt> -<dt><span class="section"><a href="overview.html#idp62666128">Semantic Information</a></span></dt> -<dt><span class="section"><a href="overview.html#idp62670288">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 - first two together describe a single option. The <code class="computeroutput"><a class="link" href="../boost/program_options/option_description.html" title="Class option_description">option_description</a></code> - class contains the option's name, description and a pointer to <code class="computeroutput"><a class="link" href="../boost/program_options/value_semantic.html" title="Class value_semantic">value_semantic</a></code>, - which, in turn, knows the type of the option's value and can parse the value, - apply the default value, and so on. The <code class="computeroutput"><a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a></code> class is a - container for instances of <code class="computeroutput"><a class="link" href="../boost/program_options/option_description.html" title="Class option_description">option_description</a></code>. - </p> -<p>For almost every library, those classes could be created in a - conventional way: that is, you'd create new options using constructors and - then call the <code class="computeroutput">add</code> method of <code class="computeroutput"><a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a></code>. However, - that's overly verbose for declaring 20 or 30 options. This concern led - to creation of the syntax that you've already seen: -</p> -<pre class="programlisting"> -options_description desc; -desc.add_options() - ("help", "produce help") - ("optimization", value<int>()->default_value(10), "optimization level") - ; -</pre> -<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>. - That class contains the code to parse - values of a specific type, and contains a number of methods which can be - called by the user to specify additional information. (This - 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. - </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 - different behaviour. For the remainder of this section, we'll talk only - about the <code class="computeroutput">value</code> function. - </p> -<p>The information about an option is divided into syntactic and - semantic. Syntactic information includes the name of the option and the - number of tokens which can be used to specify the value. This - information is used by parsers to group tokens into (name, value) pairs, - 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. - </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 - use overly complex structures. For example, it's not easy to parse - syntax like: </p> -<pre class="screen">calc --expression=1 + 2/3</pre> -<p> because it's not - possible to parse </p> -<pre class="screen">1 + 2/3</pre> -<p> without knowing that it's a C - expression. With a little help from the user the task becomes trivial, - and the syntax clear: </p> -<pre class="screen">calc --expression="1 + 2/3"</pre> -<p> - </p> -<div class="section"> -<div class="titlepage"><div><div><h4 class="title"> -<a name="idp62648560"></a>Syntactic Information</h4></div></div></div> -<div class="toc"><dl><dt><span class="section"><a href="overview.html#idp62657440">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: - </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p> - name of the option, used to identify the option inside the - program, - </p></li> -<li class="listitem"><p> - description of the option, which can be presented to the user, - </p></li> -<li class="listitem"><p> - the allowed number of source tokens that comprise options's - value, which is used during parsing. - </p></li> -</ul></div> -<p> - </p> -<p>Consider the following example: - </p> -<pre class="programlisting"> -options_description desc; -desc.add_options() - ("help", "produce help message") - ("compression", value<string>(), "compression level") - ("verbose", value<string>()->implicit_value("0"), "verbosity level") - ("email", value<string>()->multitoken(), "email to send to") - ; - </pre> -<p> - For the first parameter, we specify only the name and the - description. No value can be specified in the parsed source. - For the first option, the user must specify a value, using a single - token. For the third option, the user may either provide a single token - for the value, or no token at all. For the last option, the value can - span several tokens. For example, the following command line is OK: - </p> -<pre class="screen"> - test --help --compression 10 --verbose --email beadle@mars beadle2@mars - </pre> -<p> - </p> -<div class="section"> -<div class="titlepage"><div><div><h5 class="title"> -<a name="idp62657440"></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 - describe some simple formatting mechanisms you can use. - </p> -<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 - 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: - </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 - look like: - </p> -<pre class="screen"> - --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> - </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: - </p> -<pre class="programlisting"> -options.add_options() - ("well_formated", "As you can see this is a very well formatted -option description.\n" - "You can do this for example:\n\n" - "Values:\n" - " Value1: \tdoes this and that, bla bla bla bla -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"); - </pre> -<p> - will produce: - </p> -<pre class="screen"> - --well_formated As you can see this is a - very well formatted - option description. - You can do this for - example: - - Values: - Value1: does this and - that, bla bla - bla bla bla bla - bla bla bla bla - bla bla bla bla - bla - Value2: does something - else, bla bla - bla bla bla bla - bla bla bla bla - bla bla bla bla - bla - - This paragraph has a - first line indent only, - 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, otherwise an exception of type - program_options::error is thrown. Finally, the tabulator is ignored if - 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="idp62666128"></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> -<pre class="programlisting"> -options_description desc; -desc.add_options() - ("compression", value<int>()->default_value(10), "compression level") - ("email", value< vector<string> >() - ->composing()->notifier(&your_function), "email") - ; -</pre> -<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. - </p> -</div> -<div class="section"> -<div class="titlepage"><div><div><h4 class="title"> -<a name="idp62670288"></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>, - which does not specify any name at all, for example: - </p> -<pre class="screen"> - archiver --compression=9 /etc/passwd - </pre> -<p> - Here, the "/etc/passwd" element does not have any option name. - </p> -<p>One solution is to ask the user to extract positional options - himself and process them as he likes. However, there's a nicer approach - -- provide a method to automatically assign the names for positional - options, so that the above command line can be interpreted the same way - as: - </p> -<pre class="screen"> - archiver --compression=9 --input-file=/etc/passwd - </pre> -<p> - </p> -<p>The <code class="computeroutput"><a class="link" href="../boost/program_options/positional_opti_idp5922480.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> -<pre class="programlisting"> -positional_options_description pd; pd.add("input-file", 1); -</pre> -<p> specifies that for exactly one, first, positional - option the name will be "input-file". - </p> -<p>It's possible to specify that a number, or even all positional options, be - given the same name. -</p> -<pre class="programlisting"> -positional_options_description pd; -pd.add("output-file", 2).add("input-file", -1); -</pre> -<p> - In the above example, the first two positional options will be associated - with name "output-file", and any others with the name "input-file". - </p> -<div class="warning"><table border="0" summary="Warning"> -<tr> -<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_opti_idp5922480.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> -</div> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp62681168"></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 - is specified. In the simplest case, the name is explicitly specified, - which allows the library to decide if such option is known. If it is known, the - <code class="computeroutput"><a class="link" href="../boost/program_options/value_semantic.html" title="Class value_semantic">value_semantic</a></code> instance determines how the value is specified. (If - it is not known, an exception is thrown.) Common - cases are when the value is explicitly specified by the user, and when - the value cannot be specified by the user, but the presence of the - option implies some value (for example, <code class="computeroutput">true</code>). So, the - parser checks that the value is specified when needed and not specified - when not needed, and returns new (name, value) pair. - </p> -<p> - To invoke a parser you typically call a function, passing the options - description and command line or config file or something else. - 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. - </p> -<p> - There are three exceptions to the above model -- all related to - traditional usage of the command line. While they require some support - from the options description component, the additional complexity is - tolerable. - </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>The name specified on the command line may be - different from the option name -- it's common to provide a "short option - name" alias to a longer name. It's also common to allow an abbreviated name - to be specified on the command line. - </p></li> -<li class="listitem"><p>Sometimes it's desirable to specify value as several - tokens. For example, an option "--email-recipient" may be followed - by several emails, each as a separate command line token. This - behaviour is supported, though it can lead to parsing ambiguities - and is not enabled by default. - </p></li> -<li class="listitem"><p>The command line may contain positional options -- elements - which don't have any name. The command line parser provides a - mechanism to guess names for such options, as we've seen in the - tutorial. - </p></li> -</ul></div> -<p> - </p> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp62690848"></a>Storage Component</h3></div></div></div> -<p>The storage component is responsible for: - </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>Storing the final values of an option into a special class and in - regular variables</p></li> -<li class="listitem"><p>Handling priorities among different sources.</p></li> -<li class="listitem"><p>Calling user-specified <code class="computeroutput">notify</code> functions with the final - values of options.</p></li> -</ul></div> -<p> - </p> -<p>Let's consider an example: -</p> -<pre class="programlisting"> -variables_map vm; -store(parse_command_line(argc, argv, desc), vm); -store(parse_config_file("example.cfg", desc), vm); -notify(vm); -</pre> -<p> - The <code class="computeroutput">variables_map</code> class is used to store the option - values. The two calls to the <code class="computeroutput">store</code> function add values - found on the command line and in the config file. Finally the call to - the <code class="computeroutput">notify</code> function runs the user-specified notify - functions and stores the values into regular variables, if needed. - </p> -<p>The priority is handled in a simple way: the <code class="computeroutput">store</code> - function will not change the value of an option if it's already - assigned. In this case, if the command line specifies the value for an - option, any value in the config file is ignored. - </p> -<div class="warning"><table border="0" summary="Warning"> -<tr> -<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>Don't forget to call the <code class="computeroutput">notify</code> function after you've - stored all parsed values.</p></td></tr> -</table></div> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp62701408"></a>Specific parsers</h3></div></div></div> -<div class="toc"><dl> -<dt><span class="section"><a href="overview.html#idp62702048">Configuration file parser</a></span></dt> -<dt><span class="section"><a href="overview.html#idp62712560">Environment variables parser</a></span></dt> -</dl></div> -<div class="section"> -<div class="titlepage"><div><div><h4 class="title"> -<a name="idp62702048"></a>Configuration file parser</h4></div></div></div> -<p>The <code class="computeroutput"><a class="link" href="../boost/program_options/parse_config_fi_idp8590400.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> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"> -<p>A line in the form:</p> -<pre class="screen"> -<em class="replaceable"><code>name</code></em>=<em class="replaceable"><code>value</code></em> - </pre> -<p>gives a value to an option.</p> -</li> -<li class="listitem"> -<p>A line in the form:</p> -<pre class="screen"> -[<em class="replaceable"><code>section name</code></em>] - </pre> -<p>introduces a new section in the configuration file.</p> -</li> -<li class="listitem"><p>The <code class="literal">#</code> character introduces a - comment that spans until the end of the line.</p></li> -</ul></div> -<p>The option names are relative to the section names, so - the following configuration file part:</p> -<pre class="screen"> -[gui.accessibility] -visual_bell=yes - </pre> -<p>is equivalent to</p> -<pre class="screen"> -gui.accessibility.visual_bell=yes - </pre> -</div> -<div class="section"> -<div class="titlepage"><div><div><h4 class="title"> -<a name="idp62712560"></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 - for a given user, and the values can be further changed on the command - line. For example, on Windows one can use the - <code class="filename">autoexec.bat</code> file or (on recent versions) the - <code class="filename">Control Panel/System/Advanced/Environment Variables</code> - dialog, and on Unix —, the <code class="filename">/etc/profile</code>, - <code class="filename">~/.profile</code> and <code class="filename">~/.bash_profile</code> - files. Because environment variables can be set for the entire system, - 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_environme_idp6997248.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 - parameter we need to consider naming conventions for environment - variables.</p> -<p>If you have an option that should be specified via environment - variable, you need make up the variable's name. To avoid name clashes, - we suggest that you use a sufficiently unique prefix for environment - variables. Also, while option names are most likely in lower case, - environment variables conventionally use upper case. So, for an option - 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_environme_idp6997248.html" title="Function parse_environment">parse_environment</a></code> function. - Say, if you pass <code class="literal">BOOST_</code> as the prefix, and there are - two variables, <code class="envar">CVSROOT</code> and <code class="envar">BOOST_PROXY</code>, the - first variable will be ignored, and the second one will be converted to - option <code class="literal">proxy</code>. - </p> -<p>The above logic is sufficient in many cases, but it is also - possible to pass, as the second parameter of the <code class="computeroutput"><a class="link" href="../boost/program_options/parse_environme_idp6997248.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 - empty string if the variable should be ignored. - </p> -</div> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp62729312"></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%"> -<colgroup> -<col class="c1"> -<col class="c2"> -</colgroup> -<thead><tr> -<th>Symbol</th> -<th>Description</th> -</tr></thead> -<tbody> -<tr><td colspan="2">Options description component</td></tr> -<tr> -<td><code class="computeroutput"><a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a></code></td> -<td>describes a number of options</td> -</tr> -<tr> -<td><code class="computeroutput"><a class="link" href="../boost/program_options/value.html" title="Function value">value</a></code></td> -<td>defines the option's value</td> -</tr> -<tr><td colspan="2">Parsers component</td></tr> -<tr> -<td><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></td> -<td>parses command line (simpified interface)</td> -</tr> -<tr> -<td><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></td> -<td>parses command line (extended interface)</td> -</tr> -<tr> -<td><code class="computeroutput"><a class="link" href="../boost/program_options/parse_config_fi_idp8590400.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_environme_idp6997248.html" title="Function parse_environment">parse_environment</a></code></td> -<td>parses environment</td> -</tr> -<tr><td colspan="2">Storage component</td></tr> -<tr> -<td><code class="computeroutput"><a class="link" href="../boost/program_options/variables_map.html" title="Class variables_map">variables_map</a></code></td> -<td>storage for option values</td> -</tr> -</tbody> -</table></div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="tutorial.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="howto.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/program_options/reference.html b/libs/program_options/doc/html/program_options/reference.html deleted file mode 100644 index 535afe05ca..0000000000 --- a/libs/program_options/doc/html/program_options/reference.html +++ /dev/null @@ -1,244 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Reference</title> -<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="prev" href="../index/s06.html" title="Acknowledgements"> -<link rel="next" href="../boost/program_options/command_line_style/style_t.html" title="Type style_t"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> -<td align="center"><a href="../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../index/s06.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../boost/program_options/command_line_style/style_t.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="section"> -<div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="program_options.reference"></a>Reference</h2></div></div></div> -<div class="toc"><dl> -<dt><span class="section"><a href="reference.html#header.boost.program_options.cmdline_hpp">Header <boost/program_options/cmdline.hpp></a></span></dt> -<dt><span class="section"><a href="reference.html#header.boost.program_options.config_hpp">Header <boost/program_options/config.hpp></a></span></dt> -<dt><span class="section"><a href="reference.html#header.boost.program_options.environment_iterator_hpp">Header <boost/program_options/environment_iterator.hpp></a></span></dt> -<dt><span class="section"><a href="reference.html#header.boost.program_options.eof_iterator_hpp">Header <boost/program_options/eof_iterator.hpp></a></span></dt> -<dt><span class="section"><a href="reference.html#header.boost.program_options.errors_hpp">Header <boost/program_options/errors.hpp></a></span></dt> -<dt><span class="section"><a href="reference.html#header.boost.program_options.option_hpp">Header <boost/program_options/option.hpp></a></span></dt> -<dt><span class="section"><a href="reference.html#header.boost.program_options.options_description_hpp">Header <boost/program_options/options_description.hpp></a></span></dt> -<dt><span class="section"><a href="reference.html#header.boost.program_options.parsers_hpp">Header <boost/program_options/parsers.hpp></a></span></dt> -<dt><span class="section"><a href="reference.html#header.boost.program_options.positional_options_hpp">Header <boost/program_options/positional_options.hpp></a></span></dt> -<dt><span class="section"><a href="reference.html#header.boost.program_options.value_semantic_hpp">Header <boost/program_options/value_semantic.hpp></a></span></dt> -<dt><span class="section"><a href="reference.html#header.boost.program_options.variables_map_hpp">Header <boost/program_options/variables_map.hpp></a></span></dt> -<dt><span class="section"><a href="reference.html#header.boost.program_options.version_hpp">Header <boost/program_options/version.hpp></a></span></dt> -</dl></div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="header.boost.program_options.cmdline_hpp"></a>Header <<a href="../../../../../boost/program_options/cmdline.hpp" target="_top">boost/program_options/cmdline.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">namespace</span> <span class="identifier">command_line_style</span> <span class="special">{</span> - <span class="keyword">enum</span> <a class="link" href="../boost/program_options/command_line_style/style_t.html" title="Type style_t">style_t</a><span class="special">;</span> - <span class="special">}</span> - <span class="special">}</span> -<span class="special">}</span></pre> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="header.boost.program_options.config_hpp"></a>Header <<a href="../../../../../boost/program_options/config.hpp" target="_top">boost/program_options/config.hpp</a>></h3></div></div></div> -<pre class="synopsis"> - -<a class="link" href="../BOOST_PROGRAM_OPTIONS_DECL.html" title="Macro BOOST_PROGRAM_OPTIONS_DECL">BOOST_PROGRAM_OPTIONS_DECL</a></pre> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="header.boost.program_options.environment_iterator_hpp"></a>Header <<a href="../../../../../boost/program_options/environment_iterator.hpp" target="_top">boost/program_options/environment_iterator.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">class</span> <a class="link" href="../boost/environment_iterator.html" title="Class environment_iterator">environment_iterator</a><span class="special">;</span> -<span class="special">}</span></pre> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="header.boost.program_options.eof_iterator_hpp"></a>Header <<a href="../../../../../boost/program_options/eof_iterator.hpp" target="_top">boost/program_options/eof_iterator.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">template</span><span class="special"><</span><span class="keyword">typename</span> Derived<span class="special">,</span> <span class="keyword">typename</span> ValueType<span class="special">></span> <span class="keyword">class</span> <a class="link" href="../boost/eof_iterator.html" title="Class template eof_iterator">eof_iterator</a><span class="special">;</span> -<span class="special">}</span></pre> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="header.boost.program_options.errors_hpp"></a>Header <<a href="../../../../../boost/program_options/errors.hpp" target="_top">boost/program_options/errors.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/error.html" title="Class error">error</a><span class="special">;</span> - <span class="keyword">class</span> <a class="link" href="../boost/program_options/too_many_positi_idp7389984.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/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/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/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/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/multiple_occurrences.html" title="Class multiple_occurrences">multiple_occurrences</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/error_with_no_option_name.html" title="Class error_with_no_option_name">error_with_no_option_name</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/ambiguous_option.html" title="Class ambiguous_option">ambiguous_option</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> - <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_command_idp6969504.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/validation_error.html" title="Class validation_error">validation_error</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_bool_value.html" title="Class invalid_bool_value">invalid_bool_value</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> - <span class="special">}</span> -<span class="special">}</span></pre> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="header.boost.program_options.option_hpp"></a>Header <<a href="../../../../../boost/program_options/option.hpp" target="_top">boost/program_options/option.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">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_option.html" title="Class template basic_option">basic_option</a><span class="special">;</span> - - <span class="keyword">typedef</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="keyword">char</span> <span class="special">></span> <a name="boost.program_options.option"></a><span class="identifier">option</span><span class="special">;</span> - <span class="keyword">typedef</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="keyword">wchar_t</span> <span class="special">></span> <a name="boost.program_options.woption"></a><span class="identifier">woption</span><span class="special">;</span> - <span class="special">}</span> -<span class="special">}</span></pre> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="header.boost.program_options.options_description_hpp"></a>Header <<a href="../../../../../boost/program_options/options_description.hpp" target="_top">boost/program_options/options_description.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/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_descrip_idp8075600.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_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/duplicate_option_error.html" title="Class duplicate_option_error">duplicate_option_error</a><span class="special">;</span> - <span class="special">}</span> -<span class="special">}</span></pre> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="header.boost.program_options.parsers_hpp"></a>Header <<a href="../../../../../boost/program_options/parsers.hpp" target="_top">boost/program_options/parsers.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">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_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</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_op_idp8181920.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="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">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> - - <span class="keyword">typedef</span> <a class="link" href="../boost/program_options/basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <a name="boost.program_options.parsed_options"></a><span class="identifier">parsed_options</span><span class="special">;</span> - <span class="keyword">typedef</span> <a class="link" href="../boost/program_options/basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">wchar_t</span> <span class="special">></span> <a name="boost.program_options.wparsed_options"></a><span class="identifier">wparsed_options</span><span class="special">;</span> - <span class="keyword">typedef</span> <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> <a class="link" href="../boost/program_options/ext_parser.html" title="Type definition ext_parser"><span class="identifier">ext_parser</span></a><span class="special">;</span> - <span class="keyword">typedef</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">char</span> <span class="special">></span> <a name="boost.program_options.command_line_parser"></a><span class="identifier">command_line_parser</span><span class="special">;</span> - <span class="keyword">typedef</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">wchar_t</span> <span class="special">></span> <a name="boost.program_options.wcommand_line_parser"></a><span class="identifier">wcommand_line_parser</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> charT<span class="special">></span> - <a class="link" href="../boost/program_options/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="../boost/program_options/parse_command_line.html" title="Function template parse_command_line"><span class="identifier">parse_command_line</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="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">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> - <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> <a class="link" href="../boost/program_options/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="../boost/program_options/parse_config_fi_idp8590400.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> <a class="link" href="../boost/program_options/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="../boost/program_options/parse_config_fi_idp5606176.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_environme_idp6997248.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_environme_idp7001408.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_environme_idp6765216.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> - <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">wstring</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">wstring</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">wstring</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">L</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">wstring</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">L</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">wstring</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">L</span><span class="string">"\\"</span><span class="special">)</span><span class="special">;</span> - <span class="special">}</span> -<span class="special">}</span></pre> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<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_opti_idp5922480.html" title="Class positional_options_description">positional_options_description</a><span class="special">;</span> - <span class="special">}</span> -<span class="special">}</span></pre> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="header.boost.program_options.value_semantic_hpp"></a>Header <<a href="../../../../../boost/program_options/value_semantic.hpp" target="_top">boost/program_options/value_semantic.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/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_semantic__idp8632624.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_semantic__idp8634400.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__idp9236160.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">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/typed_value_base.html" title="Class typed_value_base">typed_value_base</a><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> charT <span class="special">=</span> <span class="keyword">char</span><span class="special">></span> <span class="keyword">class</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">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.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.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> - <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="keyword">bool</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="special">}</span> -<span class="special">}</span></pre> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="header.boost.program_options.variables_map_hpp"></a>Header <<a href="../../../../../boost/program_options/variables_map.hpp" target="_top">boost/program_options/variables_map.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/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/abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</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_idp6705280.html" title="Function store"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/program_options/basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><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_idp6709808.html" title="Function store"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/program_options/basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><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> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="header.boost.program_options.version_hpp"></a>Header <<a href="../../../../../boost/program_options/version.hpp" target="_top">boost/program_options/version.hpp</a>></h3></div></div></div> -<pre class="synopsis"> - -<a class="link" href="../BOOST_PROGRAM_OPTIONS_VERSION.html" title="Macro BOOST_PROGRAM_OPTIONS_VERSION">BOOST_PROGRAM_OPTIONS_VERSION</a></pre> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../index/s06.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../boost/program_options/command_line_style/style_t.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> diff --git a/libs/program_options/doc/html/program_options/tutorial.html b/libs/program_options/doc/html/program_options/tutorial.html deleted file mode 100644 index 13b132b627..0000000000 --- a/libs/program_options/doc/html/program_options/tutorial.html +++ /dev/null @@ -1,370 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Tutorial</title> -<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="up" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="prev" href="../index.html" title="Chapter 1. Boost.Program_options"> -<link rel="next" href="overview.html" title="Library Overview"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> -<td align="center"><a href="../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overview.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="section"> -<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> -<dt><span class="section"><a href="tutorial.html#idp61505680">Getting Started</a></span></dt> -<dt><span class="section"><a href="tutorial.html#idp57669040">Option Details</a></span></dt> -<dt><span class="section"><a href="tutorial.html#idp62599264">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 - show only the interesting code parts, but the complete programs can be found - in the "BOOST_ROOT/libs/program_options/example" directory. Through all the - examples, we'll assume that the following namespace alias is in effect: -</p> -<pre class="programlisting">namespace po = boost::program_options;</pre> -<p> - </p> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp61505680"></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"): - -</p> -<pre class="programlisting"> -// Declare the supported options. -po::options_description desc("Allowed options"); -desc.add_options() - ("help", "produce help message") - ("compression", po::value<int>(), "set compression level") -; - -po::variables_map vm; -po::store(po::parse_command_line(ac, av, desc), vm); -po::notify(vm); - -if (vm.count("help")) { - cout << desc << "\n"; - return 1; -} - -if (vm.count("compression")) { - cout << "Compression level was set to " - << vm["compression"].as<int>() << ".\n"; -} else { - cout << "Compression level was not set.\n"; -} -</pre> -<p> - </p> -<p>We start by declaring all allowed options using the - <code class="computeroutput"><a class="link" href="../boost/program_options/options_description.html" title="Class options_description">options_description</a></code> class. The <code class="computeroutput">add_options</code> method of that - class returns a special proxy object that defines - <code class="computeroutput">operator()</code>. Calls to that operator actually declare - options. The parameters are option name, information about value, and option - description. In this example, the first option has no value, and the second - one has a value of type <code class="computeroutput">int</code>. - </p> -<p>After that, an object of class <code class="computeroutput">variables_map</code> is - declared. That class is intended to store values of options, and can store - values of arbitrary types. Next, the calls to <code class="computeroutput">store</code>, - <code class="computeroutput">parse_command_line</code> and <code class="computeroutput">notify</code> functions cause - <code class="computeroutput">vm</code> to contain all the options found on the command - line.</p> -<p>And now, finally, we can use the options as we like. The - <code class="computeroutput">variables_map</code> class can be used just like - <code class="computeroutput">std::map</code>, except that values stored there must be retrieved - with the <code class="computeroutput">as</code> method shown above. (If the type specified in the - call to the <code class="computeroutput">as</code> method is different from the actually stored - type, an exception is thrown.) - </p> -<p>It's now a good time to try compiling the code yourself, but if - you're not yet ready, here's an example session: -</p> -<pre class="screen"> -$ <strong class="userinput"><code>bin/gcc/debug/first</code></strong> -Compression level was not set. -$ <strong class="userinput"><code>bin/gcc/debug/first --help</code></strong> -Allowed options: - --help : produce help message - --compression arg : set compression level -$ <strong class="userinput"><code>bin/gcc/debug/first --compression 10</code></strong> -Compression level was set to 10. - </pre> -<p> - </p> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp57669040"></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 - <code class="filename">example/options_description.cpp</code>.</p> -<p>Imagine we're writing a compiler. It should take the optimization - level, a number of include paths, and a number of input files, and perform some - interesting work. Let's describe the options: - </p> -<pre class="programlisting"> -int opt; -po::options_description desc("Allowed options"); -desc.add_options() - ("help", "produce help message") - ("optimization", po::value<int>(&opt)->default_value(10), - "optimization level") - ("include-path,I", po::value< vector<string> >(), - "include path") - ("input-file", po::value< vector<string> >(), "input file") -; -</pre> -<p> - </p> -<p>The <code class="literal">"help"</code> option should be familiar from - the previous example. It's a good idea to have this option in all cases. - </p> -<p>The <code class="literal">"optimization"</code> option shows two new features. First, we specify - the address of the variable(<code class="computeroutput">&opt</code>). After storing values, that - variable will have the value of the option. Second, we specify a default - value of 10, which will be used if no value is specified by the user. - </p> -<p>The <code class="literal">"include-path"</code> option is an example of the - only case where the interface of the <code class="computeroutput">options_description</code> - class serves only one - source -- the command line. Users typically like to use short option names - for common options, and the "include-path,I" name specifies that short - option name is "I". So, both "--include-path" and "-I" can be used. - </p> -<p>Note also that the type of the <code class="literal">"include-path"</code> - option is <span class="type">std::vector</span>. The library provides special - support for vectors -- it will be possible to specify the option several - times, and all specified values will be collected in one vector. - </p> -<p>The "input-file" option specifies the list of files to - process. That's okay for a start, but, of course, writing something like: - </p> -<pre class="screen"> -<strong class="userinput"><code>compiler --input-file=a.cpp</code></strong> - </pre> -<p> - is a little non-standard, compared with - </p> -<pre class="screen"> -<strong class="userinput"><code>compiler a.cpp</code></strong> - </pre> -<p> - We'll address this in a moment. - </p> -<p> - The command line tokens which have no option name, as above, are - called "positional options" by this library. They can be handled - too. With a little help from the user, the library can decide that "a.cpp" - really means the same as "--input-file=a.cpp". Here's the additional code - we need: - </p> -<pre class="programlisting"> -po::positional_options_description p; -p.add("input-file", -1); - -po::variables_map vm; -po::store(po::command_line_parser(ac, av). - options(desc).positional(p).run(), vm); -po::notify(vm); - </pre> -<p> - </p> -<p> - The first two lines say that all positional options should be translated - into "input-file" options. Also note that we use the - <code class="computeroutput"><a class="link" href="reference.html#boost.program_options.command_line_parser">command_line_parser</a></code> class to parse the command - line, not the <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> - function. The latter is a convenient wrapper for simple cases, but now we - need to pass additional information. - </p> -<p>By now, all options are described and parsed. We'll save ourselves the - trouble of implementing the rest of the compiler logic and only print the - options: - </p> -<pre class="programlisting"> -if (vm.count("include-path")) -{ - cout << "Include paths are: " - << vm["include-path"].as< vector<string> >() << "\n"; -} - -if (vm.count("input-file")) -{ - cout << "Input files are: " - << vm["input-file"].as< vector<string> >() << "\n"; -} - -cout << "Optimization level is " << opt << "\n"; -</pre> -<p> - </p> -<p>Here's an example session: - </p> -<pre class="screen"> -$ <strong class="userinput"><code>bin/gcc/debug/options_description --help</code></strong> -Usage: options_description [options] -Allowed options: - --help : produce help message - --optimization arg : optimization level - -I [ --include-path ] arg : include path - --input-file arg : input file -$ <strong class="userinput"><code>bin/gcc/debug/options_description</code></strong> -Optimization level is 10 -$ <strong class="userinput"><code>bin/gcc/debug/options_description --optimization 4 -I foo a.cpp</code></strong> -Include paths are: foo -Input files are: a.cpp -Optimization level is 4 -</pre> -<p> - </p> -<p> - Oops, there's a slight problem. It's still possible to specify the - "--input-file" option, and usage message says so, which can be confusing - for the user. It would be nice to hide this information, but let's wait - for the next example. - </p> -</div> -<div class="section"> -<div class="titlepage"><div><div><h3 class="title"> -<a name="idp62599264"></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 - made some choices which should be applied on every run? It's desirable to - create a config file with common settings which will be used together with - the command line. - </p> -<p>Of course, there will be a need to combine the values from command - line and config file. For example, the optimization level specified on the - command line should override the value from the config file. On the other - hand, include paths should be combined. - </p> -<p>Let's see the code now. The complete program is in - "examples/multiple_sources.cpp". The option definition has two interesting - details. First, we declare several instances of the - <code class="computeroutput">options_description</code> class. The reason is that, in general, - not all options are alike. Some options, like "input-file" above, should - not be presented in an automatic help message. Some options make sense only - in the config file. Finally, it's nice to have some structure in the help message, - not just a long list of options. Let's declare several option groups: - </p> -<pre class="programlisting"> -// Declare a group of options that will be -// allowed only on command line -po::options_description generic("Generic options"); -generic.add_options() - ("version,v", "print version string") - ("help", "produce help message") - ; - -// Declare a group of options that will be -// allowed both on command line and in -// config file -po::options_description config("Configuration"); -config.add_options() - ("optimization", po::value<int>(&opt)->default_value(10), - "optimization level") - ("include-path,I", - po::value< vector<string> >()->composing(), - "include path") - ; - -// Hidden options, will be allowed both on command line and -// in config file, but will not be shown to the user. -po::options_description hidden("Hidden options"); -hidden.add_options() - ("input-file", po::value< vector<string> >(), "input file") - ; -</pre> -<p> - Note the call to the <code class="computeroutput">composing</code> method in the declaration of the - "include-path" option. It tells the library that values from different sources - should be composed together, as we'll see shortly. - </p> -<p> - The <code class="computeroutput">add</code> method of the <code class="computeroutput">options_description</code> - class can be used to further group the options: - </p> -<pre class="programlisting"> -po::options_description cmdline_options; -cmdline_options.add(generic).add(config).add(hidden); - -po::options_description config_file_options; -config_file_options.add(config).add(hidden); - -po::options_description visible("Allowed options"); -visible.add(generic).add(config); - </pre> -<p> - </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_idp6705280.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 - "include-file", the values are merged. - </p> -<p>Here's an example session: -</p> -<pre class="screen"> -$ <strong class="userinput"><code>bin/gcc/debug/multiple_sources</code></strong> -Include paths are: /opt -Optimization level is 1 -$ <strong class="userinput"><code>bin/gcc/debug/multiple_sources --help</code></strong> -Allows options: - -Generic options: - -v [ --version ] : print version string - --help : produce help message - -Configuration: - --optimization n : optimization level - -I [ --include-path ] path : include path - -$ <strong class="userinput"><code>bin/gcc/debug/multiple_sources --optimization=4 -I foo a.cpp b.cpp</code></strong> -Include paths are: foo /opt -Input files are: a.cpp b.cpp -Optimization level is 4 -</pre> -<p> - The first invocation uses values from the configuration file. The second - invocation also uses values from command line. As we see, the include - paths on the command line and in the configuration file are merged, - while optimization is taken from the command line. - </p> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. - (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at - <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overview.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> |