mirrors/CLI11
1
0
Fork 0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-05-01 13:13:53 +00:00
Code Issues Releases Wiki Activity

Add note for set custom option

Browse Source
This commit is contained in:
Henry Schreiner 2018-05-19 08:02:40 +02:00 committed by GitHub
parent 9b54b6e0fe
commit 0b1bfacfd3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -180,6 +180,7 @@ The add commands return a pointer to an internally stored `Option`. If you set t
* `->required()`: The program will quit if this option is not present. This is `mandatory` in Plumbum, but required options seems to be a more standard term. For compatibility, `->mandatory()` also works. * `->required()`: The program will quit if this option is not present. This is `mandatory` in Plumbum, but required options seems to be a more standard term. For compatibility, `->mandatory()` also works.
* `->expected(N)`: Take `N` values instead of as many as possible, only for vector args. If negative, require at least `-N`; end with `--` or another recognized option. * `->expected(N)`: Take `N` values instead of as many as possible, only for vector args. If negative, require at least `-N`; end with `--` or another recognized option.
* `->set_custom_option(typename, N)`: Set the name and intrinsic size of an option. The parser will require multiples of this number.
* `->needs(opt)`: This option requires another option to also be present, opt is an `Option` pointer. * `->needs(opt)`: This option requires another option to also be present, opt is an `Option` pointer.
* `->excludes(opt)`: This option cannot be given with `opt` present, opt is an `Option` pointer. * `->excludes(opt)`: This option cannot be given with `opt` present, opt is an `Option` pointer.
* `->envname(name)`: Gets the value from the environment if present and not passed on the command line. * `->envname(name)`: Gets the value from the environment if present and not passed on the command line.