@@ -72,16 +72,16 @@ Features that were added in the last released minor version are marked with
7272### Introduction
7373
7474CLI11 provides all the features you expect in a powerful command line parser,
75- with a beautiful, minimal syntax and no dependencies beyond C++11. It is header
76- only, and comes in a single file form for easy inclusion in projects. It is easy
77- to use for small projects, but powerful enough for complex command line
75+ with a beautiful, minimal syntax and no dependencies beyond C++11. It is
76+ header- only, and comes in a single file form for easy inclusion in projects. It
77+ is easy to use for small projects, but powerful enough for complex command line
7878projects, and can be customized for frameworks. It is tested on [ Azure] [ ] and
7979[ GitHub Actions] [ actions-link ] , and was originally used by the [ GooFit GPU
8080fitting framework] [ goofit ] . It was inspired by [ ` plumbum.cli ` ] [ plumbum ] for
81- Python. CLI11 has a user friendly introduction in this README, a more in-depth
81+ Python. CLI11 has a user- friendly introduction in this README, a more in-depth
8282tutorial [ GitBook] [ ] , as well as [ API documentation] [ api-docs ] generated by
8383Travis. See the [ changelog] ( ./CHANGELOG.md ) or [ GitHub Releases] [ ] for details
84- for current and past releases. Also see the [ Version 1.0 post] [ ] , [ Version 1.3
84+ on current and past releases. Also see the [ Version 1.0 post] [ ] , [ Version 1.3
8585post] [ ] , [ Version 1.6 post] [ ] , or [ Version 2.0 post] [ ] for more information.
8686
8787You can be notified when new releases are made by subscribing to
@@ -115,7 +115,7 @@ An acceptable CLI parser library should be all of the following:
115115- Ability to add a configuration file (` TOML ` , ` INI ` , or custom format), and
116116 produce it as well.
117117- Produce real values that can be used directly in code, not something you have
118- pay compute time to look up, for HPC applications.
118+ to pay compute time to look up, for HPC applications.
119119- Work with common types, simple custom types, and extensible to exotic types.
120120- Permissively licensed.
121121
@@ -172,20 +172,20 @@ this library:
172172 suggested close matches.
173173- Autocomplete: This might eventually be added to both Plumbum and CLI11, but it
174174 is not supported yet.
175- - While not recommended, CLI11 does now support non standard option names such
175+ - While not recommended, CLI11 does now support non- standard option names such
176176 as ` -option ` . This is enabled through ` allow_non_standard_option_names() `
177177 modifier on an app.
178178
179179## Install
180180
181- To use, the most common methods are described here additional methods and
181+ To use, the most common methods are described here, additional methods and
182182details are available at [ installation] [ ] :
183183
184184- All-in-one local header: Copy ` CLI11.hpp ` from the [ most recent
185185 release] [ github releases ] into your include directory, and you are set. This
186186 is combined from the source files for every release. This includes the entire
187187 command parser library, but does not include separate utilities (like ` Timer ` ,
188- ` AutoTimer ` ). The utilities are completely self contained and can be copied
188+ ` AutoTimer ` ). The utilities are completely self- contained and can be copied
189189 separately.
190190- All-in-one global header: Like above, but copying the file to a shared folder
191191 location like ` /opt/CLI11 ` . Then, the C++ include path has to be extended to
@@ -1126,8 +1126,8 @@ option_groups. These are:
11261126 executes after the first argument of an application is processed. See
11271127 [Subcommand callbacks](#callbacks) for some additional details.
11281128- `.allow_extras()`: Do not throw an error if extra arguments are left over.
1129- - `.allow_extras(CLI::ExtrasMode)`: Specify the method of handling unrecognized
1130- arguments.
1129+ - `.allow_extras(CLI::ExtrasMode)`: 🆕 Specify the method of handling
1130+ unrecognized arguments.
11311131 - `CLI::ExtrasMode::Error`: generate an error on unrecognized argument. Same
11321132 as `.allow_extras(false)`.
11331133 - `CLI::ExtrasMode::ErrorImmediately`: generate an error immediately on
@@ -1151,8 +1151,8 @@ option_groups. These are:
11511151 remaining_arg list. It is ideal for allowing your app or subcommand to be a
11521152 "prefix" to calling another app. Can be called with a `bool` value to turn on
11531153 or off
1154- - `.prefix_command(CLI::PrefixCommandMode)`: specify the prefix_command mode to
1155- use. `PrefixCommandMode::on` and `PrefixCommandMode::off` are the same as
1154+ - `.prefix_command(CLI::PrefixCommandMode)`: 🆕 specify the prefix_command mode
1155+ to use. `PrefixCommandMode::on` and `PrefixCommandMode::off` are the same as
11561156 `prefix_command(true)` or `prefix_command(false)`. Calling with
11571157 `PrefixCommandMode::separator_only` will only trigger prefix command mode by
11581158 the use of the subcommand separator `--` other unrecognized arguments would be
0 commit comments