About Boost.ProgramOptions
Please check out the library's documentation to learn more.
Quick Start
You are viewing the develop version of this library.
The master and develop pages are shown here to provide access to the newest in-development in-progress documentation. See the "Documentation" link on this page.
Other aspects of the page will reflect the previous official version, or not be available until the next release.
Contributors: This Release
Program Options, part of the collection of Boost C++ Libraries, allows for definition and acquisition of (name, value) pairs from the user via conventional methods such as command line and config file. It is roughly analogous to getopt_long, but for use with C++.
License
Distributed under the Boost Software License, Version 1.0.
Properties
- C++03
- Requires Linking
Build Status
(in progress...)
| Branch | Travis | Appveyor | codecov.io | Deps | Docs | Tests |
|---|---|---|---|---|---|---|
master |
 |
 |
 |
 |
 |
|
develop |
 |
 |
 |
 |
 |
Directories
| Name | Purpose |
|---|---|
build |
build script for link library |
ci |
continuous integration scripts |
doc |
documentation |
example |
use case examples |
include |
headers |
src |
source code for link library |
test |
unit tests |
More information
- Ask questions: Be sure to read the documentation first to see if it answers your question.
- Report bugs: Be sure to mention Boost version, platform and compiler you're using. A small compilable code sample to reproduce the problem is always good as well.
- Submit Pull Requests against the develop branch. Note that by submitting patches you agree to license your modifications under the Boost Software License, Version 1.0. Be sure to include tests proving your changes work properly.
- Discussions about the library are held on the Boost developers mailing list. Be sure to read the discussion policy before posting and add the
[program_options]tag at the beginning of the subject line.
<p>Program Options, part of the collection of <a href="http://github.com/boostorg">Boost C++ Libraries</a>, allows for definition and acquisition of (name, value) pairs from the user via conventional methods such as command line and config file. It is roughly analogous to getopt_long, but for use with C++.</p> <h3>License</h3> <p>Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p> <h3>Properties</h3> <ul> <li>C++03</li> <li>Requires Linking</li> </ul> <h3>Build Status</h3> <p>(in progress...)</p> <table> <thead> <tr> <th align="center">Branch</th> <th align="left">Travis</th> <th align="left">Appveyor</th> <th align="left">codecov.io</th> <th align="left">Deps</th> <th align="left">Docs</th> <th align="left">Tests</th> </tr> </thead> <tbody> <tr> <td align="center"><a href="https://github.com/boostorg/program_options/tree/master"><code>master</code></a></td> <td align="left"><a href="https://travis-ci.org/boostorg/program_options"><img src="https://travis-ci.org/boostorg/program_options.svg?branch=master" alt="Build Status" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/vprus/program-options/branch/master"><img src="https://ci.appveyor.com/api/projects/status/e0quisadwh1v7ok5/branch/master?svg=true" alt="Build status" /></a></td> <td align="left"><a href="https://codecov.io/gh/boostorg/program_options/branch/master"><img src="https://codecov.io/gh/boostorg/program_options/branch/master/graph/badge.svg" alt="codecov" /></a></td> <td align="left"><a href="https://pdimov.github.io/boostdep-report/master/program_options.html"><img src="https://img.shields.io/badge/deps-master-brightgreen.svg" alt="Deps" /></a></td> <td align="left"><a href="http://www.boost.org/doc/libs/master/doc/html/program_options.html"><img src="https://img.shields.io/badge/docs-master-brightgreen.svg" alt="Documentation" /></a></td> <td align="left"><a href="https://regression.boost.io/master/developer/program_options.html"><img src="https://img.shields.io/badge/matrix-master-brightgreen.svg" alt="Enter the Matrix" /></a></td> </tr> <tr> <td align="center"><a href="https://github.com/boostorg/program_options/tree/develop"><code>develop</code></a></td> <td align="left"><a href="https://travis-ci.org/boostorg/program_options"><img src="https://travis-ci.org/boostorg/program_options.svg?branch=develop" alt="Build Status" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/vprus/program-options/branch/develop"><img src="https://ci.appveyor.com/api/projects/status/e0quisadwh1v7ok5/branch/develop?svg=true" alt="Build status" /></a></td> <td align="left"><a href="https://codecov.io/gh/boostorg/program_options/branch/develop"><img src="https://codecov.io/gh/boostorg/program_options/branch/develop/graph/badge.svg" alt="codecov" /></a></td> <td align="left"><a href="https://pdimov.github.io/boostdep-report/develop/program_options.html"><img src="https://img.shields.io/badge/deps-develop-brightgreen.svg" alt="Deps" /></a></td> <td align="left"><a href="http://www.boost.org/doc/libs/develop/doc/html/program_options.html"><img src="https://img.shields.io/badge/docs-develop-brightgreen.svg" alt="Documentation" /></a></td> <td align="left"><a href="https://regression.boost.io/develop/developer/program_options.html"><img src="https://img.shields.io/badge/matrix-develop-brightgreen.svg" alt="Enter the Matrix" /></a></td> </tr> </tbody> </table> <h3>Directories</h3> <table> <thead> <tr> <th align="left">Name</th> <th align="left">Purpose</th> </tr> </thead> <tbody> <tr> <td align="left"><code>build</code></td> <td align="left">build script for link library</td> </tr> <tr> <td align="left"><code>ci</code></td> <td align="left">continuous integration scripts</td> </tr> <tr> <td align="left"><code>doc</code></td> <td align="left">documentation</td> </tr> <tr> <td align="left"><code>example</code></td> <td align="left">use case examples</td> </tr> <tr> <td align="left"><code>include</code></td> <td align="left">headers</td> </tr> <tr> <td align="left"><code>src</code></td> <td align="left">source code for link library</td> </tr> <tr> <td align="left"><code>test</code></td> <td align="left">unit tests</td> </tr> </tbody> </table> <h3>More information</h3> <ul> <li><a href="http://stackoverflow.com/questions/ask?tags=c%2B%2B,boost,boost-program_options">Ask questions</a>: Be sure to read the documentation first to see if it answers your question.</li> <li><a href="https://github.com/boostorg/program_options/issues">Report bugs</a>: Be sure to mention Boost version, platform and compiler you're using. A small compilable code sample to reproduce the problem is always good as well.</li> <li><a href="https://github.com/boostorg/program_options/pulls">Submit Pull Requests</a> against the <strong>develop</strong> branch. Note that by submitting patches you agree to license your modifications under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>. Be sure to include tests proving your changes work properly.</li> <li>Discussions about the library are held on the <a href="http://www.boost.org/community/groups.html#main">Boost developers mailing list</a>. Be sure to read the <a href="http://www.boost.org/community/policy.html">discussion policy</a> before posting and add the <code>[program_options]</code> tag at the beginning of the subject line.</li> </ul>
-
Code Commits Commits authored to any Boost repository. With 1 contribution, you will earn the bronze badge for Code Commits.
-
Documentation Doc contributions using standardised Boost tooling (Antora / BoostLook). With 1 contribution, you will earn the bronze badge for Documentation.
-
Library Authoring Authored an original Boost library accepted into the collection. With 1 contribution, you will earn the bronze badge for Library Authoring.
-
Library Maintenance Number of libraries actively maintained. With 1 contribution, you will earn the bronze badge for Library Maintenance.
-
Library Review Formal review submissions on Boost proposals. With 1 contribution, you will earn the bronze badge for Library Review.
-
Library Versioning Authored new versions / releases of Boost libraries. With 10 contributions, you will earn the bronze badge for Library Versioning.
-
Mailing List Participation Participation on the Boost developers mailing list. With 1 contribution, you will earn the bronze badge for Mailing List Participation.
-
News Posts Published Articles / news posts published on Boost.org. With 1 contribution, you will earn the bronze badge for News Posts Published.
<p>Program Options, part of the collection of <a href="http://github.com/boostorg">Boost C++ Libraries</a>, allows for definition and acquisition of (name, value) pairs from the user via conventional methods such as command line and config file. It is roughly analogous to getopt_long, but for use with C++.</p> <h3>License</h3> <p>Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p> <h3>Properties</h3> <ul> <li>C++03</li> <li>Requires Linking</li> </ul> <h3>Build Status</h3> <p>(in progress...)</p> <table> <thead> <tr> <th align="center">Branch</th> <th align="left">Travis</th> <th align="left">Appveyor</th> <th align="left">codecov.io</th> <th align="left">Deps</th> <th align="left">Docs</th> <th align="left">Tests</th> </tr> </thead> <tbody> <tr> <td align="center"><a href="https://github.com/boostorg/program_options/tree/master"><code>master</code></a></td> <td align="left"><a href="https://travis-ci.org/boostorg/program_options"><img src="https://travis-ci.org/boostorg/program_options.svg?branch=master" alt="Build Status" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/vprus/program-options/branch/master"><img src="https://ci.appveyor.com/api/projects/status/e0quisadwh1v7ok5/branch/master?svg=true" alt="Build status" /></a></td> <td align="left"><a href="https://codecov.io/gh/boostorg/program_options/branch/master"><img src="https://codecov.io/gh/boostorg/program_options/branch/master/graph/badge.svg" alt="codecov" /></a></td> <td align="left"><a href="https://pdimov.github.io/boostdep-report/master/program_options.html"><img src="https://img.shields.io/badge/deps-master-brightgreen.svg" alt="Deps" /></a></td> <td align="left"><a href="http://www.boost.org/doc/libs/master/doc/html/program_options.html"><img src="https://img.shields.io/badge/docs-master-brightgreen.svg" alt="Documentation" /></a></td> <td align="left"><a href="https://regression.boost.io/master/developer/program_options.html"><img src="https://img.shields.io/badge/matrix-master-brightgreen.svg" alt="Enter the Matrix" /></a></td> </tr> <tr> <td align="center"><a href="https://github.com/boostorg/program_options/tree/develop"><code>develop</code></a></td> <td align="left"><a href="https://travis-ci.org/boostorg/program_options"><img src="https://travis-ci.org/boostorg/program_options.svg?branch=develop" alt="Build Status" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/vprus/program-options/branch/develop"><img src="https://ci.appveyor.com/api/projects/status/e0quisadwh1v7ok5/branch/develop?svg=true" alt="Build status" /></a></td> <td align="left"><a href="https://codecov.io/gh/boostorg/program_options/branch/develop"><img src="https://codecov.io/gh/boostorg/program_options/branch/develop/graph/badge.svg" alt="codecov" /></a></td> <td align="left"><a href="https://pdimov.github.io/boostdep-report/develop/program_options.html"><img src="https://img.shields.io/badge/deps-develop-brightgreen.svg" alt="Deps" /></a></td> <td align="left"><a href="http://www.boost.org/doc/libs/develop/doc/html/program_options.html"><img src="https://img.shields.io/badge/docs-develop-brightgreen.svg" alt="Documentation" /></a></td> <td align="left"><a href="https://regression.boost.io/develop/developer/program_options.html"><img src="https://img.shields.io/badge/matrix-develop-brightgreen.svg" alt="Enter the Matrix" /></a></td> </tr> </tbody> </table> <h3>Directories</h3> <table> <thead> <tr> <th align="left">Name</th> <th align="left">Purpose</th> </tr> </thead> <tbody> <tr> <td align="left"><code>build</code></td> <td align="left">build script for link library</td> </tr> <tr> <td align="left"><code>ci</code></td> <td align="left">continuous integration scripts</td> </tr> <tr> <td align="left"><code>doc</code></td> <td align="left">documentation</td> </tr> <tr> <td align="left"><code>example</code></td> <td align="left">use case examples</td> </tr> <tr> <td align="left"><code>include</code></td> <td align="left">headers</td> </tr> <tr> <td align="left"><code>src</code></td> <td align="left">source code for link library</td> </tr> <tr> <td align="left"><code>test</code></td> <td align="left">unit tests</td> </tr> </tbody> </table> <h3>More information</h3> <ul> <li><a href="http://stackoverflow.com/questions/ask?tags=c%2B%2B,boost,boost-program_options">Ask questions</a>: Be sure to read the documentation first to see if it answers your question.</li> <li><a href="https://github.com/boostorg/program_options/issues">Report bugs</a>: Be sure to mention Boost version, platform and compiler you're using. A small compilable code sample to reproduce the problem is always good as well.</li> <li><a href="https://github.com/boostorg/program_options/pulls">Submit Pull Requests</a> against the <strong>develop</strong> branch. Note that by submitting patches you agree to license your modifications under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>. Be sure to include tests proving your changes work properly.</li> <li>Discussions about the library are held on the <a href="http://www.boost.org/community/groups.html#main">Boost developers mailing list</a>. Be sure to read the <a href="http://www.boost.org/community/policy.html">discussion policy</a> before posting and add the <code>[program_options]</code> tag at the beginning of the subject line.</li> </ul>
-
Achievement-based Reflects the depth of your contributions. Accumulate achievements to unlock five tiers; Bronze, Silver, Gold, Platinum and Diamond.
-
Tenure-based Awarded in recognition of your time on the platform. The longer you've been part of the Boost community, the higher the tier you unlock.
-
Boost day celebration A celebration of the day you joined Boost. Awarded annually to mark another year as part of the community.
