README.md

February 24, 2026 ยท View on GitHub

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++11
  • Requires Linking

Development

The library is essentially done. No major new features are expected, the primary goal is stability, as well as small changes to re-align with the evolution of Boost C++ Libraries and C++.

  • Good PRs within the scope are welcome. It may take some time, and maybe a ping or two, to get merged.
  • Good issues are appreciated, but realistically, might remain open indefinitely, unless you also prepare a PR.
  • Drive-by PRs and issues are not welcome.
  • AI-assisted PRs are OK, but you should self-review every changed line.

Build Status

(in progress...)

BranchTravisAppveyorcodecov.ioDepsDocsTests
masterBuild StatusBuild statuscodecovDepsDocumentationEnter the Matrix
developBuild StatusBuild statuscodecovDepsDocumentationEnter the Matrix

Directories

NamePurpose
buildbuild script for link library
cicontinuous integration scripts
docdocumentation
exampleuse case examples
includeheaders
srcsource code for link library
testunit 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.