29 Commits

Author SHA1 Message Date
Vladimir Prus 902aaedaaa overview.xml: clarify wording 2025-09-13 10:38:35 +01:00
Marcos Simental 6b2bc88964 Fix listing typo (#130)
The paragraph lists a couple of options and expands information on each element. However,  the following explanation lists the first element, the first, the third, and the last, whereas the logic of the discussion aims to explain the listing as first, second, third, and last elements.
2025-09-13 10:36:14 +01:00
ivanpanch 4287ba32b7 docs: correct spelling and grammar 2025-08-27 23:08:03 +01:00
Daniel James 646cc20a54 Fix the documentation build 2018-03-23 11:26:22 +03:00
Tom Kent 9bf97405dc Additional examples (#21)
* Added multiple inputs to example

In the section after the introduction of using value<vector<...>> to store
multiple values, I updated the example to show multiple input values and their
results.

* Make it clear how to enable sections for ini files

It was unclear how the user should support sections, should they have nested options_description's (no), nested variables_map's (no), it is just a dotted string that is input! This adds a snippet showing that.

* Added an example for environment options

This example shows how to use program_options to pull environmental options
into a program. This instance uses a function to map env options to config
options.

* Added an example showing different types in a config file

I went through a lot of the common types that a user may want to include in
a config file (especially the boolean options) and showed an example with
them all.

With some minor modifications, this could also be added to the tests directory
as there are several cases in here that I didn't see checked anywhere else in
the code.

* Added explanation comments to new examples

* Added an example with a heirarchy of inputs

This file shows an example program that can get inputs from the command line,
environmental variables, multiple config files specified on the command line,
and a default config file. There are multiple usage examples at the bottom in
the comments.

* Reference to example showing environment options

* Added section detailing type conversion.

Added explicity acknowledging that hex/oct/bin formatted strings aren't allowed.
Detailed the bool_switch value and what strings evaluate true/false.

* Added a global to the config file example

* Semicolon typo

* Split components into seperate functions

* Added unregistered entry and flag to prevent error

* Added logic to capture unregistered value

* Build new examples

* Backslashes need escaping on unix

* match permissions
2018-03-22 18:29:58 +03:00
Jurko 3cec23f2ba fix documentation typos & style
typo corrections:
 - otherwisee --> otherwise
 - it's is --> it is
 - nuber --> number
 - will likely to use --> is likely to use
 - varaible --> variable
 - defauled --> defaulted

stylistic changes:
 - which would make --> making
2014-11-27 10:21:48 +01:00
Jurko fcc4e6ef1a trim trailing spaces 2014-11-27 09:45:10 +01:00
Vladimir Prus 7051655c76 Clarify docs for 'zero_token'.
Fixes #1132.


[SVN r67774]
2011-01-08 11:45:50 +00:00
Vladimir Prus c25408f6d2 Document config file support in more detail. Fixes #808. Fixes #1125.
[SVN r38495]
2007-08-07 13:55:41 +00:00
Vladimir Prus 4223d3231d Fix typo
[SVN r38186]
2007-07-11 18:22:57 +00:00
Vladimir Prus dc334deea7 Fix typo
[SVN r33990]
2006-05-18 06:06:18 +00:00
Vladimir Prus 596f8aa46f Remove remaining occurences of "implicit" method from the docs.
[SVN r32265]
2006-01-09 09:53:20 +00:00
Vladimir Prus 881c3b4e3a Fix typo.
[SVN r32174]
2005-12-28 07:28:45 +00:00
Vladimir Prus f2e43384fb Note that positional options must be still registered.
[SVN r31740]
2005-11-22 12:43:23 +00:00
Vladimir Prus 065b0a4a9d Correct example usage of positional_options_description::add.
[SVN r27218]
2005-02-07 14:27:20 +00:00
Vladimir Prus a9c3f21021 Remove a couple of potentially confusing sentences.
[SVN r26839]
2005-01-24 16:03:26 +00:00
Vladimir Prus f27dce4ed4 Initial docs for text formatting rules.
[SVN r26785]
2005-01-21 16:11:26 +00:00
Vladimir Prus c184748325 Typo fixes
[SVN r26694]
2005-01-14 07:10:19 +00:00
Vladimir Prus 11946c4461 Some doc updates
[SVN r26676]
2005-01-12 10:00:25 +00:00
Vladimir Prus 1f57064c70 Fix title capitalization
[SVN r26280]
2004-11-24 14:40:17 +00:00
Vladimir Prus 0c9cfb5825 Fix order of value and description parameters in the docs.
Thanks to Charles Brockman for the report.


[SVN r26279]
2004-11-24 14:39:14 +00:00
Vladimir Prus 903eef69e9 More edits
[SVN r24739]
2004-08-26 09:00:53 +00:00
Vladimir Prus b4192e34b9 Another set of doc/comment edits from Charles.
[SVN r24657]
2004-08-23 10:18:09 +00:00
Vladimir Prus 24691b0584 More edits. Also, merge options_descriptons.xml into overview.xml.
[SVN r24186]
2004-07-30 08:41:12 +00:00
Vladimir Prus 542f66a604 More edits from Charles.
[SVN r24183]
2004-07-30 07:20:38 +00:00
Vladimir Prus 03b0829de9 Even more edits from Charles.
[SVN r24157]
2004-07-29 14:00:01 +00:00
Vladimir Prus 96d2b150e5 More edits from Charles Brockman.
[SVN r23946]
2004-07-22 09:41:10 +00:00
Vladimir Prus 07f98fc711 Correct URLS in DOCTYPE element.
[SVN r23362]
2004-07-06 06:10:54 +00:00
Vladimir Prus 196f6c0b5b Import revision 295 of the program_options library.
[SVN r22823]
2004-05-14 13:40:31 +00:00