Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2025-01-05 17:28:42 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix(help): Don't rely on ALL CAPS for headers

Browse source 
I see them fulfilling two roles
- A form of bolding
- As a callback to their placeholder in usage

However, it is a bit of an unpolished look and no other CLI seems to do
it.  This looks a bit more proefessional.  We have colored help for
formatting and I think the sections relation to usage will be clear
enough.
This commit is contained in:
Ed Page 2022-08-26 09:40:23 -05:00
parent 1682649836
commit 9b23a09f7a
84 changed files with 587 additions and 577 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -48,6 +48,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Removed lifetimes from `Command`, `Arg`, `ArgGroup`, and `PossibleValue` - Removed lifetimes from `Command`, `Arg`, `ArgGroup`, and `PossibleValue`
- *(help)* Make `DeriveDisplayOrder` the default and removed the setting. To sort help, set `next_display_order(None)` (#2808) - *(help)* Make `DeriveDisplayOrder` the default and removed the setting. To sort help, set `next_display_order(None)` (#2808)
- *(help)* Subcommand display order respects `Command::next_display_order` instead of `DeriveDisplayOrder` and using its own initial display order value (#2808) - *(help)* Subcommand display order respects `Command::next_display_order` instead of `DeriveDisplayOrder` and using its own initial display order value (#2808)
- *(help)* Help headings are now title cased, making any user-provided help headings inconsistent
- *(env)* Parse `--help` and `--version` like any `ArgAction::SetTrue` flag (#3776) - *(env)* Parse `--help` and `--version` like any `ArgAction::SetTrue` flag (#3776)
- *(derive)* Changed the default for arguments from `parse` to `value_parser`., removing `parse` support - *(derive)* Changed the default for arguments from `parse` to `value_parser`., removing `parse` support
- *(derive)* `subcommand_required(true).arg_required_else_help(true)` is set instead of `SubcommandRequiredElseHelp` (#3280) - *(derive)* `subcommand_required(true).arg_required_else_help(true)` is set instead of `SubcommandRequiredElseHelp` (#3280)
@ -83,6 +84,7 @@ MSRV is now 1.60.0
- *(help)* Use `Command::display_name` in the help title rather than `Command::bin_name` - *(help)* Use `Command::display_name` in the help title rather than `Command::bin_name`
- *(help)* Show when a flag is `ArgAction::Count` by adding an `...` - *(help)* Show when a flag is `ArgAction::Count` by adding an `...`
- *(help)* Use a more neutral palette for coloring - *(help)* Use a more neutral palette for coloring
- *(help)* Don't rely on ALL CAPS for help headers
- *(version)* Use `Command::display_name` rather than `Command::bin_name` - *(version)* Use `Command::display_name` rather than `Command::bin_name`
- *(parser)* Assert on unknown args when using external subcommands (#3703) - *(parser)* Assert on unknown args when using external subcommands (#3703)
- *(parser)* Always fill in `""` argument for external subcommands (#3263) - *(parser)* Always fill in `""` argument for external subcommands (#3263)

10
examples/cargo-example-derive.md
View file

@ -8,13 +8,13 @@ The help looks like:
$ cargo-example-derive --help $ cargo-example-derive --help
cargo cargo
USAGE: Usage:
cargo <SUBCOMMAND> cargo <SUBCOMMAND>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
SUBCOMMANDS: Subcommands:
example-derive A simple to use, efficient, and full-featured Command Line Argument Parser example-derive A simple to use, efficient, and full-featured Command Line Argument Parser
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
@ -22,10 +22,10 @@ $ cargo-example-derive example-derive --help
cargo-example-derive [..] cargo-example-derive [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
cargo example-derive [OPTIONS] cargo example-derive [OPTIONS]
OPTIONS: Options:
--manifest-path <MANIFEST_PATH> --manifest-path <MANIFEST_PATH>
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

10
examples/cargo-example.md
View file

@ -8,13 +8,13 @@ The help looks like:
$ cargo-example --help $ cargo-example --help
cargo cargo
USAGE: Usage:
cargo <SUBCOMMAND> cargo <SUBCOMMAND>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
SUBCOMMANDS: Subcommands:
example A simple to use, efficient, and full-featured Command Line Argument Parser example A simple to use, efficient, and full-featured Command Line Argument Parser
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
@ -22,10 +22,10 @@ $ cargo-example example --help
cargo-example [..] cargo-example [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
cargo example [OPTIONS] cargo example [OPTIONS]
OPTIONS: Options:
--manifest-path <PATH> --manifest-path <PATH>
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

4
examples/demo.md
View file

@ -3,10 +3,10 @@ $ demo --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
demo[EXE] [OPTIONS] --name <NAME> demo[EXE] [OPTIONS] --name <NAME>
OPTIONS: Options:
-n, --name <NAME> Name of the person to greet -n, --name <NAME> Name of the person to greet
-c, --count <COUNT> Number of times to greet [default: 1] -c, --count <COUNT> Number of times to greet [default: 1]
-h, --help Print help information -h, --help Print help information

8
examples/derive_ref/custom-bool.md
View file

@ -7,13 +7,13 @@ $ custom-bool --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
custom-bool[EXE] [OPTIONS] --foo <FOO> <BOOM> custom-bool[EXE] [OPTIONS] --foo <FOO> <BOOM>
ARGS: Arguments:
<BOOM> [possible values: true, false] <BOOM> [possible values: true, false]
OPTIONS: Options:
--foo <FOO> [possible values: true, false] --foo <FOO> [possible values: true, false]
--bar <BAR> [default: false] --bar <BAR> [default: false]
-h, --help Print help information -h, --help Print help information
@ -25,7 +25,7 @@ error: The following required arguments were not provided:
--foo <FOO> --foo <FOO>
<BOOM> <BOOM>
USAGE: Usage:
custom-bool[EXE] [OPTIONS] --foo <FOO> <BOOM> custom-bool[EXE] [OPTIONS] --foo <FOO> <BOOM>
For more information try --help For more information try --help

18
examples/derive_ref/interop_tests.md
View file

@ -39,7 +39,7 @@ error: Found argument '--unknown' which wasn't expected, or isn't valid in this
If you tried to supply `--unknown` as a value rather than a flag, use `-- --unknown` If you tried to supply `--unknown` as a value rather than a flag, use `-- --unknown`
USAGE: Usage:
interop_augment_args[EXE] [OPTIONS] interop_augment_args[EXE] [OPTIONS]
For more information try --help For more information try --help
@ -77,7 +77,7 @@ error: Found argument '--unknown' which wasn't expected, or isn't valid in this
If you tried to supply `--unknown` as a value rather than a flag, use `-- --unknown` If you tried to supply `--unknown` as a value rather than a flag, use `-- --unknown`
USAGE: Usage:
interop_augment_subcommands[EXE] derived [OPTIONS] interop_augment_subcommands[EXE] derived [OPTIONS]
For more information try --help For more information try --help
@ -89,7 +89,7 @@ $ interop_augment_subcommands unknown
? failed ? failed
error: Found argument 'unknown' which wasn't expected, or isn't valid in this context error: Found argument 'unknown' which wasn't expected, or isn't valid in this context
USAGE: Usage:
interop_augment_subcommands[EXE] [SUBCOMMAND] interop_augment_subcommands[EXE] [SUBCOMMAND]
For more information try --help For more information try --help
@ -103,14 +103,14 @@ $ interop_hand_subcommand
? failed ? failed
clap clap
USAGE: Usage:
interop_hand_subcommand[EXE] [OPTIONS] <SUBCOMMAND> interop_hand_subcommand[EXE] [OPTIONS] <SUBCOMMAND>
OPTIONS: Options:
-t, --top-level -t, --top-level
-h, --help Print help information -h, --help Print help information
SUBCOMMANDS: Subcommands:
add add
remove remove
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
@ -154,7 +154,7 @@ error: Found argument '--unknown' which wasn't expected, or isn't valid in this
If you tried to supply `--unknown` as a value rather than a flag, use `-- --unknown` If you tried to supply `--unknown` as a value rather than a flag, use `-- --unknown`
USAGE: Usage:
interop_hand_subcommand[EXE] add [NAME]... interop_hand_subcommand[EXE] add [NAME]...
For more information try --help For more information try --help
@ -198,7 +198,7 @@ $ interop_hand_subcommand unknown
? failed ? failed
error: Found argument 'unknown' which wasn't expected, or isn't valid in this context error: Found argument 'unknown' which wasn't expected, or isn't valid in this context
USAGE: Usage:
interop_hand_subcommand[EXE] [OPTIONS] <SUBCOMMAND> interop_hand_subcommand[EXE] [OPTIONS] <SUBCOMMAND>
For more information try --help For more information try --help
@ -255,7 +255,7 @@ error: Found argument '--unknown' which wasn't expected, or isn't valid in this
If you tried to supply `--unknown` as a value rather than a flag, use `-- --unknown` If you tried to supply `--unknown` as a value rather than a flag, use `-- --unknown`
USAGE: Usage:
interop_flatten_hand_args[EXE] [OPTIONS] interop_flatten_hand_args[EXE] [OPTIONS]
For more information try --help For more information try --help

8
examples/escaped-positional-derive.md
View file

@ -8,13 +8,13 @@ $ escaped-positional-derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
escaped-positional-derive[EXE] [OPTIONS] [-- <SLOP>...] escaped-positional-derive[EXE] [OPTIONS] [-- <SLOP>...]
ARGS: Arguments:
<SLOP>... <SLOP>...
OPTIONS: Options:
-f -f
-p <PEAR> -p <PEAR>
-h, --help Print help information -h, --help Print help information
@ -37,7 +37,7 @@ $ escaped-positional-derive foo bar
? failed ? failed
error: Found argument 'foo' which wasn't expected, or isn't valid in this context error: Found argument 'foo' which wasn't expected, or isn't valid in this context
USAGE: Usage:
escaped-positional-derive[EXE] [OPTIONS] [-- <SLOP>...] escaped-positional-derive[EXE] [OPTIONS] [-- <SLOP>...]
For more information try --help For more information try --help

8
examples/escaped-positional.md
View file

@ -8,13 +8,13 @@ $ escaped-positional --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
escaped-positional[EXE] [OPTIONS] [-- <SLOP>...] escaped-positional[EXE] [OPTIONS] [-- <SLOP>...]
ARGS: Arguments:
<SLOP>... <SLOP>...
OPTIONS: Options:
-f -f
-p <PEAR> -p <PEAR>
-h, --help Print help information -h, --help Print help information
@ -37,7 +37,7 @@ $ escaped-positional foo bar
? failed ? failed
error: Found argument 'foo' which wasn't expected, or isn't valid in this context error: Found argument 'foo' which wasn't expected, or isn't valid in this context
USAGE: Usage:
escaped-positional[EXE] [OPTIONS] [-- <SLOP>...] escaped-positional[EXE] [OPTIONS] [-- <SLOP>...]
For more information try --help For more information try --help

4
examples/find.md
View file

@ -5,10 +5,10 @@ $ find --help
clap 4.0.0-alpha.0 clap 4.0.0-alpha.0
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
find[EXE] [OPTIONS] --name <NAME> find[EXE] [OPTIONS] --name <NAME>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

40
examples/git-derive.md
View file

@ -9,13 +9,13 @@ $ git-derive
git git
A fictional versioning CLI A fictional versioning CLI
USAGE: Usage:
git-derive[EXE] <SUBCOMMAND> git-derive[EXE] <SUBCOMMAND>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
SUBCOMMANDS: Subcommands:
clone Clones repos clone Clones repos
push pushes things push pushes things
add adds things add adds things
@ -26,13 +26,13 @@ $ git-derive help
git git
A fictional versioning CLI A fictional versioning CLI
USAGE: Usage:
git-derive[EXE] <SUBCOMMAND> git-derive[EXE] <SUBCOMMAND>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
SUBCOMMANDS: Subcommands:
clone Clones repos clone Clones repos
push pushes things push pushes things
add adds things add adds things
@ -43,13 +43,13 @@ $ git-derive help add
git-add git-add
adds things adds things
USAGE: Usage:
git-derive[EXE] add <PATH>... git-derive[EXE] add <PATH>...
ARGS: Arguments:
<PATH>... Stuff to add <PATH>... Stuff to add
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
``` ```
@ -61,13 +61,13 @@ $ git-derive add
git-add git-add
adds things adds things
USAGE: Usage:
git-derive[EXE] add <PATH>... git-derive[EXE] add <PATH>...
ARGS: Arguments:
<PATH>... Stuff to add <PATH>... Stuff to add
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
$ git-derive add Cargo.toml Cargo.lock $ git-derive add Cargo.toml Cargo.lock
@ -80,15 +80,15 @@ Default subcommand:
$ git-derive stash -h $ git-derive stash -h
git-stash git-stash
USAGE: Usage:
git-derive[EXE] stash [OPTIONS] git-derive[EXE] stash [OPTIONS]
git-derive[EXE] stash <SUBCOMMAND> git-derive[EXE] stash <SUBCOMMAND>
OPTIONS: Options:
-m, --message <MESSAGE> -m, --message <MESSAGE>
-h, --help Print help information -h, --help Print help information
SUBCOMMANDS: Subcommands:
push push
pop pop
apply apply
@ -97,23 +97,23 @@ SUBCOMMANDS:
$ git-derive stash push -h $ git-derive stash push -h
git-stash-push git-stash-push
USAGE: Usage:
git-derive[EXE] stash push [OPTIONS] git-derive[EXE] stash push [OPTIONS]
OPTIONS: Options:
-m, --message <MESSAGE> -m, --message <MESSAGE>
-h, --help Print help information -h, --help Print help information
$ git-derive stash pop -h $ git-derive stash pop -h
git-stash-pop git-stash-pop
USAGE: Usage:
git-derive[EXE] stash pop [STASH] git-derive[EXE] stash pop [STASH]
ARGS: Arguments:
<STASH> <STASH>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
$ git-derive stash -m "Prototype" $ git-derive stash -m "Prototype"

40
examples/git.md
View file

@ -7,13 +7,13 @@ $ git
git git
A fictional versioning CLI A fictional versioning CLI
USAGE: Usage:
git[EXE] <SUBCOMMAND> git[EXE] <SUBCOMMAND>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
SUBCOMMANDS: Subcommands:
clone Clones repos clone Clones repos
push pushes things push pushes things
add adds things add adds things
@ -24,13 +24,13 @@ $ git help
git git
A fictional versioning CLI A fictional versioning CLI
USAGE: Usage:
git[EXE] <SUBCOMMAND> git[EXE] <SUBCOMMAND>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
SUBCOMMANDS: Subcommands:
clone Clones repos clone Clones repos
push pushes things push pushes things
add adds things add adds things
@ -41,13 +41,13 @@ $ git help add
git-add git-add
adds things adds things
USAGE: Usage:
git[EXE] add <PATH>... git[EXE] add <PATH>...
ARGS: Arguments:
<PATH>... Stuff to add <PATH>... Stuff to add
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
``` ```
@ -59,13 +59,13 @@ $ git add
git-add git-add
adds things adds things
USAGE: Usage:
git[EXE] add <PATH>... git[EXE] add <PATH>...
ARGS: Arguments:
<PATH>... Stuff to add <PATH>... Stuff to add
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
$ git add Cargo.toml Cargo.lock $ git add Cargo.toml Cargo.lock
@ -78,15 +78,15 @@ Default subcommand:
$ git stash -h $ git stash -h
git-stash git-stash
USAGE: Usage:
git[EXE] stash [OPTIONS] git[EXE] stash [OPTIONS]
git[EXE] stash <SUBCOMMAND> git[EXE] stash <SUBCOMMAND>
OPTIONS: Options:
-m, --message <MESSAGE> -m, --message <MESSAGE>
-h, --help Print help information -h, --help Print help information
SUBCOMMANDS: Subcommands:
push push
pop pop
apply apply
@ -95,23 +95,23 @@ SUBCOMMANDS:
$ git stash push -h $ git stash push -h
git-stash-push git-stash-push
USAGE: Usage:
git[EXE] stash push [OPTIONS] git[EXE] stash push [OPTIONS]
OPTIONS: Options:
-m, --message <MESSAGE> -m, --message <MESSAGE>
-h, --help Print help information -h, --help Print help information
$ git stash pop -h $ git stash pop -h
git-stash-pop git-stash-pop
USAGE: Usage:
git[EXE] stash pop [STASH] git[EXE] stash pop [STASH]
ARGS: Arguments:
<STASH> <STASH>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
$ git stash -m "Prototype" $ git stash -m "Prototype"

4
examples/multicall-busybox.md
View file

@ -27,10 +27,10 @@ $ busybox
? failed ? failed
busybox busybox
USAGE: Usage:
busybox [OPTIONS] [APPLET] busybox [OPTIONS] [APPLET]
OPTIONS: Options:
--install <install> Install hardlinks for all subcommands in path --install <install> Install hardlinks for all subcommands in path
-h, --help Print help information -h, --help Print help information

14
examples/pacman.md
View file

@ -39,14 +39,14 @@ pacman 5.2.1
Pacman Development Team Pacman Development Team
package manager utility package manager utility
USAGE: Usage:
pacman[EXE] <SUBCOMMAND> pacman[EXE] <SUBCOMMAND>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
query -Q --query Query the package database. query -Q --query Query the package database.
sync -S --sync Synchronize packages. sync -S --sync Synchronize packages.
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
@ -55,13 +55,13 @@ $ pacman -S -h
pacman-sync pacman-sync
Synchronize packages. Synchronize packages.
USAGE: Usage:
pacman[EXE] {sync|--sync|-S} [OPTIONS] [--] [package]... pacman[EXE] {sync|--sync|-S} [OPTIONS] [--] [package]...
ARGS: Arguments:
<package>... packages <package>... packages
OPTIONS: Options:
-s, --search <search>... search remote repositories for matching strings -s, --search <search>... search remote repositories for matching strings
-i, --info view package information -i, --info view package information
-h, --help Print help information -h, --help Print help information
@ -74,7 +74,7 @@ $ pacman -S -s foo -i bar
? failed ? failed
error: The argument '--search <search>...' cannot be used with '--info' error: The argument '--search <search>...' cannot be used with '--info'
USAGE: Usage:
pacman[EXE] {sync|--sync|-S} --search <search>... <package>... pacman[EXE] {sync|--sync|-S} --search <search>... <package>...
For more information try --help For more information try --help

8
examples/tutorial_builder/01_quick.md
View file

@ -3,19 +3,19 @@ $ 01_quick --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
01_quick[EXE] [OPTIONS] [name] [SUBCOMMAND] 01_quick[EXE] [OPTIONS] [name] [SUBCOMMAND]
ARGS: Arguments:
<name> Optional name to operate on <name> Optional name to operate on
OPTIONS: Options:
-c, --config <FILE> Sets a custom config file -c, --config <FILE> Sets a custom config file
-d, --debug... Turn debugging information on -d, --debug... Turn debugging information on
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
test does testing things test does testing things
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)

4
examples/tutorial_builder/02_app_settings.md
View file

@ -3,10 +3,10 @@ $ 02_app_settings --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
02_app_settings[EXE] --two <VALUE> --one <VALUE> 02_app_settings[EXE] --two <VALUE> --one <VALUE>
OPTIONS: Options:
--two <VALUE> --two <VALUE>
--one <VALUE> --one <VALUE>
-h, --help Print help information -h, --help Print help information

4
examples/tutorial_builder/02_apps.md
View file

@ -4,10 +4,10 @@ MyApp 1.0
Kevin K. <kbknapp@gmail.com> Kevin K. <kbknapp@gmail.com>
Does awesome things Does awesome things
USAGE: Usage:
02_apps[EXE] --two <VALUE> --one <VALUE> 02_apps[EXE] --two <VALUE> --one <VALUE>
OPTIONS: Options:
--two <VALUE> --two <VALUE>
--one <VALUE> --one <VALUE>
-h, --help Print help information -h, --help Print help information

4
examples/tutorial_builder/02_crate.md
View file

@ -3,10 +3,10 @@ $ 02_crate --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
02_crate[EXE] --two <VALUE> --one <VALUE> 02_crate[EXE] --two <VALUE> --one <VALUE>
OPTIONS: Options:
--two <VALUE> --two <VALUE>
--one <VALUE> --one <VALUE>
-h, --help Print help information -h, --help Print help information

4
examples/tutorial_builder/03_01_flag_bool.md
View file

@ -3,10 +3,10 @@ $ 03_01_flag_bool --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_01_flag_bool[EXE] [OPTIONS] 03_01_flag_bool[EXE] [OPTIONS]
OPTIONS: Options:
-v, --verbose -v, --verbose
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

4
examples/tutorial_builder/03_01_flag_count.md
View file

@ -3,10 +3,10 @@ $ 03_01_flag_count --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_01_flag_count[EXE] [OPTIONS] 03_01_flag_count[EXE] [OPTIONS]
OPTIONS: Options:
-v, --verbose... -v, --verbose...
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

4
examples/tutorial_builder/03_02_option.md
View file

@ -3,10 +3,10 @@ $ 03_02_option --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_02_option[EXE] [OPTIONS] 03_02_option[EXE] [OPTIONS]
OPTIONS: Options:
-n, --name <name> -n, --name <name>
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

4
examples/tutorial_builder/03_02_option_mult.md
View file

@ -3,10 +3,10 @@ $ 03_02_option_mult --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_02_option_mult[EXE] [OPTIONS] 03_02_option_mult[EXE] [OPTIONS]
OPTIONS: Options:
-n, --name <name> -n, --name <name>
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

6
examples/tutorial_builder/03_03_positional.md
View file

@ -3,13 +3,13 @@ $ 03_03_positional --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_03_positional[EXE] [name] 03_03_positional[EXE] [name]
ARGS: Arguments:
<name> <name>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

6
examples/tutorial_builder/03_03_positional_mult.md
View file

@ -3,13 +3,13 @@ $ 03_03_positional_mult --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_03_positional_mult[EXE] [name]... 03_03_positional_mult[EXE] [name]...
ARGS: Arguments:
<name>... <name>...
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

18
examples/tutorial_builder/03_04_subcommands.md
View file

@ -3,14 +3,14 @@ $ 03_04_subcommands help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_04_subcommands[EXE] <SUBCOMMAND> 03_04_subcommands[EXE] <SUBCOMMAND>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
add Adds files to myapp add Adds files to myapp
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
@ -18,13 +18,13 @@ $ 03_04_subcommands help add
clap-add [..] clap-add [..]
Adds files to myapp Adds files to myapp
USAGE: Usage:
03_04_subcommands[EXE] add [NAME] 03_04_subcommands[EXE] add [NAME]
ARGS: Arguments:
<NAME> <NAME>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -40,14 +40,14 @@ $ 03_04_subcommands
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_04_subcommands[EXE] <SUBCOMMAND> 03_04_subcommands[EXE] <SUBCOMMAND>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
add Adds files to myapp add Adds files to myapp
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)

6
examples/tutorial_builder/03_05_default_values.md
View file

@ -3,13 +3,13 @@ $ 03_05_default_values --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_05_default_values[EXE] [NAME] 03_05_default_values[EXE] [NAME]
ARGS: Arguments:
<NAME> [default: alice] <NAME> [default: alice]
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

6
examples/tutorial_builder/04_01_enum.md
View file

@ -3,13 +3,13 @@ $ 04_01_enum --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
04_01_enum[EXE] <MODE> 04_01_enum[EXE] <MODE>
ARGS: Arguments:
<MODE> What mode to run the program in [possible values: fast, slow] <MODE> What mode to run the program in [possible values: fast, slow]
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

6
examples/tutorial_builder/04_01_possible.md
View file

@ -3,13 +3,13 @@ $ 04_01_possible --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
04_01_possible[EXE] <MODE> 04_01_possible[EXE] <MODE>
ARGS: Arguments:
<MODE> What mode to run the program in [possible values: fast, slow] <MODE> What mode to run the program in [possible values: fast, slow]
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

6
examples/tutorial_builder/04_02_parse.md
View file

@ -3,13 +3,13 @@ $ 04_02_parse --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
04_02_parse[EXE] <PORT> 04_02_parse[EXE] <PORT>
ARGS: Arguments:
<PORT> Network port to use <PORT> Network port to use
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

6
examples/tutorial_builder/04_02_validate.md
View file

@ -3,13 +3,13 @@ $ 04_02_validate --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
04_02_validate[EXE] <PORT> 04_02_validate[EXE] <PORT>
ARGS: Arguments:
<PORT> Network port to use <PORT> Network port to use
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

12
examples/tutorial_builder/04_03_relations.md
View file

@ -3,13 +3,13 @@ $ 04_03_relations --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
04_03_relations[EXE] [OPTIONS] <--set-ver <VER>|--major|--minor|--patch> [INPUT_FILE] 04_03_relations[EXE] [OPTIONS] <--set-ver <VER>|--major|--minor|--patch> [INPUT_FILE]
ARGS: Arguments:
<INPUT_FILE> some regular input <INPUT_FILE> some regular input
OPTIONS: Options:
--set-ver <VER> set version manually --set-ver <VER> set version manually
--major auto inc major --major auto inc major
--minor auto inc minor --minor auto inc minor
@ -24,7 +24,7 @@ $ 04_03_relations
error: The following required arguments were not provided: error: The following required arguments were not provided:
<--set-ver <VER>|--major|--minor|--patch> <--set-ver <VER>|--major|--minor|--patch>
USAGE: Usage:
04_03_relations[EXE] [OPTIONS] <--set-ver <VER>|--major|--minor|--patch> [INPUT_FILE] 04_03_relations[EXE] [OPTIONS] <--set-ver <VER>|--major|--minor|--patch> [INPUT_FILE]
For more information try --help For more information try --help
@ -36,7 +36,7 @@ $ 04_03_relations --major --minor
? failed ? failed
error: The argument '--major' cannot be used with '--minor' error: The argument '--major' cannot be used with '--minor'
USAGE: Usage:
04_03_relations[EXE] <--set-ver <VER>|--major|--minor|--patch> 04_03_relations[EXE] <--set-ver <VER>|--major|--minor|--patch>
For more information try --help For more information try --help
@ -46,7 +46,7 @@ $ 04_03_relations --major -c config.toml
error: The following required arguments were not provided: error: The following required arguments were not provided:
<INPUT_FILE|--spec-in <SPEC_IN>> <INPUT_FILE|--spec-in <SPEC_IN>>
USAGE: Usage:
04_03_relations[EXE] -c <CONFIG> <--set-ver <VER>|--major|--minor|--patch> <INPUT_FILE|--spec-in <SPEC_IN>> 04_03_relations[EXE] -c <CONFIG> <--set-ver <VER>|--major|--minor|--patch> <INPUT_FILE|--spec-in <SPEC_IN>>
For more information try --help For more information try --help

12
examples/tutorial_builder/04_04_custom.md
View file

@ -3,13 +3,13 @@ $ 04_04_custom --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
04_04_custom[EXE] [OPTIONS] [INPUT_FILE] 04_04_custom[EXE] [OPTIONS] [INPUT_FILE]
ARGS: Arguments:
<INPUT_FILE> some regular input <INPUT_FILE> some regular input
OPTIONS: Options:
--set-ver <VER> set version manually --set-ver <VER> set version manually
--major auto inc major --major auto inc major
--minor auto inc minor --minor auto inc minor
@ -23,7 +23,7 @@ $ 04_04_custom
? failed ? failed
error: Can only modify one version field error: Can only modify one version field
USAGE: Usage:
04_04_custom[EXE] [OPTIONS] [INPUT_FILE] 04_04_custom[EXE] [OPTIONS] [INPUT_FILE]
For more information try --help For more information try --help
@ -35,7 +35,7 @@ $ 04_04_custom --major --minor
? failed ? failed
error: Can only modify one version field error: Can only modify one version field
USAGE: Usage:
04_04_custom[EXE] [OPTIONS] [INPUT_FILE] 04_04_custom[EXE] [OPTIONS] [INPUT_FILE]
For more information try --help For more information try --help
@ -45,7 +45,7 @@ $ 04_04_custom --major -c config.toml
Version: 2.2.3 Version: 2.2.3
error: INPUT_FILE or --spec-in is required when using --config error: INPUT_FILE or --spec-in is required when using --config
USAGE: Usage:
04_04_custom[EXE] [OPTIONS] [INPUT_FILE] 04_04_custom[EXE] [OPTIONS] [INPUT_FILE]
For more information try --help For more information try --help

8
examples/tutorial_derive/01_quick.md
View file

@ -3,19 +3,19 @@ $ 01_quick_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
01_quick_derive[EXE] [OPTIONS] [NAME] [SUBCOMMAND] 01_quick_derive[EXE] [OPTIONS] [NAME] [SUBCOMMAND]
ARGS: Arguments:
<NAME> Optional name to operate on <NAME> Optional name to operate on
OPTIONS: Options:
-c, --config <FILE> Sets a custom config file -c, --config <FILE> Sets a custom config file
-d, --debug... Turn debugging information on -d, --debug... Turn debugging information on
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
test does testing things test does testing things
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)

4
examples/tutorial_derive/02_app_settings.md
View file

@ -3,10 +3,10 @@ $ 02_app_settings_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
02_app_settings_derive[EXE] --two <TWO> --one <ONE> 02_app_settings_derive[EXE] --two <TWO> --one <ONE>
OPTIONS: Options:
--two <TWO> --two <TWO>
--one <ONE> --one <ONE>
-h, --help Print help information -h, --help Print help information

4
examples/tutorial_derive/02_apps.md
View file

@ -4,10 +4,10 @@ MyApp 1.0
Kevin K. <kbknapp@gmail.com> Kevin K. <kbknapp@gmail.com>
Does awesome things Does awesome things
USAGE: Usage:
02_apps_derive[EXE] --two <TWO> --one <ONE> 02_apps_derive[EXE] --two <TWO> --one <ONE>
OPTIONS: Options:
--two <TWO> --two <TWO>
--one <ONE> --one <ONE>
-h, --help Print help information -h, --help Print help information

4
examples/tutorial_derive/02_crate.md
View file

@ -3,10 +3,10 @@ $ 02_crate_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
02_crate_derive[EXE] --two <TWO> --one <ONE> 02_crate_derive[EXE] --two <TWO> --one <ONE>
OPTIONS: Options:
--two <TWO> --two <TWO>
--one <ONE> --one <ONE>
-h, --help Print help information -h, --help Print help information

4
examples/tutorial_derive/03_01_flag_bool.md
View file

@ -3,10 +3,10 @@ $ 03_01_flag_bool_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_01_flag_bool_derive[EXE] [OPTIONS] 03_01_flag_bool_derive[EXE] [OPTIONS]
OPTIONS: Options:
-v, --verbose -v, --verbose
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

4
examples/tutorial_derive/03_01_flag_count.md
View file

@ -3,10 +3,10 @@ $ 03_01_flag_count_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_01_flag_count_derive[EXE] [OPTIONS] 03_01_flag_count_derive[EXE] [OPTIONS]
OPTIONS: Options:
-v, --verbose... -v, --verbose...
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

4
examples/tutorial_derive/03_02_option.md
View file

@ -3,10 +3,10 @@ $ 03_02_option_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_02_option_derive[EXE] [OPTIONS] 03_02_option_derive[EXE] [OPTIONS]
OPTIONS: Options:
-n, --name <NAME> -n, --name <NAME>
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

4
examples/tutorial_derive/03_02_option_mult.md
View file

@ -3,10 +3,10 @@ $ 03_02_option_mult_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_02_option_mult_derive[EXE] [OPTIONS] 03_02_option_mult_derive[EXE] [OPTIONS]
OPTIONS: Options:
-n, --name <NAME> -n, --name <NAME>
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

6
examples/tutorial_derive/03_03_positional.md
View file

@ -3,13 +3,13 @@ $ 03_03_positional_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_03_positional_derive[EXE] [NAME] 03_03_positional_derive[EXE] [NAME]
ARGS: Arguments:
<NAME> <NAME>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

6
examples/tutorial_derive/03_03_positional_mult.md
View file

@ -3,13 +3,13 @@ $ 03_03_positional_mult_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_03_positional_mult_derive[EXE] [NAME]... 03_03_positional_mult_derive[EXE] [NAME]...
ARGS: Arguments:
<NAME>... <NAME>...
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

18
examples/tutorial_derive/03_04_subcommands.md
View file

@ -3,14 +3,14 @@ $ 03_04_subcommands_derive help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_04_subcommands_derive[EXE] <SUBCOMMAND> 03_04_subcommands_derive[EXE] <SUBCOMMAND>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
add Adds files to myapp add Adds files to myapp
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
@ -18,13 +18,13 @@ $ 03_04_subcommands_derive help add
clap-add [..] clap-add [..]
Adds files to myapp Adds files to myapp
USAGE: Usage:
03_04_subcommands_derive[EXE] add [NAME] 03_04_subcommands_derive[EXE] add [NAME]
ARGS: Arguments:
<NAME> <NAME>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -40,14 +40,14 @@ $ 03_04_subcommands_derive
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_04_subcommands_derive[EXE] <SUBCOMMAND> 03_04_subcommands_derive[EXE] <SUBCOMMAND>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
add Adds files to myapp add Adds files to myapp
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)

6
examples/tutorial_derive/03_05_default_values.md
View file

@ -3,13 +3,13 @@ $ 03_05_default_values_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
03_05_default_values_derive[EXE] [NAME] 03_05_default_values_derive[EXE] [NAME]
ARGS: Arguments:
<NAME> [default: alice] <NAME> [default: alice]
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

6
examples/tutorial_derive/04_01_enum.md
View file

@ -3,13 +3,13 @@ $ 04_01_enum_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
04_01_enum_derive[EXE] <MODE> 04_01_enum_derive[EXE] <MODE>
ARGS: Arguments:
<MODE> What mode to run the program in [possible values: fast, slow] <MODE> What mode to run the program in [possible values: fast, slow]
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

6
examples/tutorial_derive/04_02_parse.md
View file

@ -3,13 +3,13 @@ $ 04_02_parse_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
04_02_parse_derive[EXE] <PORT> 04_02_parse_derive[EXE] <PORT>
ARGS: Arguments:
<PORT> Network port to use <PORT> Network port to use
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

6
examples/tutorial_derive/04_02_validate.md
View file

@ -3,13 +3,13 @@ $ 04_02_validate_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
04_02_validate_derive[EXE] <PORT> 04_02_validate_derive[EXE] <PORT>
ARGS: Arguments:
<PORT> Network port to use <PORT> Network port to use
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

12
examples/tutorial_derive/04_03_relations.md
View file

@ -3,13 +3,13 @@ $ 04_03_relations_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
04_03_relations_derive[EXE] [OPTIONS] <--set-ver <VER>|--major|--minor|--patch> [INPUT_FILE] 04_03_relations_derive[EXE] [OPTIONS] <--set-ver <VER>|--major|--minor|--patch> [INPUT_FILE]
ARGS: Arguments:
<INPUT_FILE> some regular input <INPUT_FILE> some regular input
OPTIONS: Options:
--set-ver <VER> set version manually --set-ver <VER> set version manually
--major auto inc major --major auto inc major
--minor auto inc minor --minor auto inc minor
@ -24,7 +24,7 @@ $ 04_03_relations_derive
error: The following required arguments were not provided: error: The following required arguments were not provided:
<--set-ver <VER>|--major|--minor|--patch> <--set-ver <VER>|--major|--minor|--patch>
USAGE: Usage:
04_03_relations_derive[EXE] [OPTIONS] <--set-ver <VER>|--major|--minor|--patch> [INPUT_FILE] 04_03_relations_derive[EXE] [OPTIONS] <--set-ver <VER>|--major|--minor|--patch> [INPUT_FILE]
For more information try --help For more information try --help
@ -36,7 +36,7 @@ $ 04_03_relations_derive --major --minor
? failed ? failed
error: The argument '--major' cannot be used with '--minor' error: The argument '--major' cannot be used with '--minor'
USAGE: Usage:
04_03_relations_derive[EXE] <--set-ver <VER>|--major|--minor|--patch> 04_03_relations_derive[EXE] <--set-ver <VER>|--major|--minor|--patch>
For more information try --help For more information try --help
@ -46,7 +46,7 @@ $ 04_03_relations_derive --major -c config.toml
error: The following required arguments were not provided: error: The following required arguments were not provided:
<INPUT_FILE|--spec-in <SPEC_IN>> <INPUT_FILE|--spec-in <SPEC_IN>>
USAGE: Usage:
04_03_relations_derive[EXE] -c <CONFIG> <--set-ver <VER>|--major|--minor|--patch> <INPUT_FILE|--spec-in <SPEC_IN>> 04_03_relations_derive[EXE] -c <CONFIG> <--set-ver <VER>|--major|--minor|--patch> <INPUT_FILE|--spec-in <SPEC_IN>>
For more information try --help For more information try --help

12
examples/tutorial_derive/04_04_custom.md
View file

@ -3,13 +3,13 @@ $ 04_04_custom_derive --help
clap [..] clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
04_04_custom_derive[EXE] [OPTIONS] [INPUT_FILE] 04_04_custom_derive[EXE] [OPTIONS] [INPUT_FILE]
ARGS: Arguments:
<INPUT_FILE> some regular input <INPUT_FILE> some regular input
OPTIONS: Options:
--set-ver <VER> set version manually --set-ver <VER> set version manually
--major auto inc major --major auto inc major
--minor auto inc minor --minor auto inc minor
@ -23,7 +23,7 @@ $ 04_04_custom_derive
? failed ? failed
error: Can only modify one version field error: Can only modify one version field
USAGE: Usage:
clap [OPTIONS] [INPUT_FILE] clap [OPTIONS] [INPUT_FILE]
For more information try --help For more information try --help
@ -35,7 +35,7 @@ $ 04_04_custom_derive --major --minor
? failed ? failed
error: Can only modify one version field error: Can only modify one version field
USAGE: Usage:
clap [OPTIONS] [INPUT_FILE] clap [OPTIONS] [INPUT_FILE]
For more information try --help For more information try --help
@ -45,7 +45,7 @@ $ 04_04_custom_derive --major -c config.toml
Version: 2.2.3 Version: 2.2.3
error: INPUT_FILE or --spec-in is required when using --config error: INPUT_FILE or --spec-in is required when using --config
USAGE: Usage:
clap [OPTIONS] [INPUT_FILE] clap [OPTIONS] [INPUT_FILE]
For more information try --help For more information try --help

4
examples/typed-derive.md
View file

@ -5,10 +5,10 @@ Help:
$ typed-derive --help $ typed-derive --help
clap clap
USAGE: Usage:
typed-derive[EXE] [OPTIONS] typed-derive[EXE] [OPTIONS]
OPTIONS: Options:
-O <OPTIMIZATION> Implicitly using `std::str::FromStr` -O <OPTIMIZATION> Implicitly using `std::str::FromStr`
-I <DIR> Allow invalid UTF-8 paths -I <DIR> Allow invalid UTF-8 paths
--bind <BIND> Handle IP addresses --bind <BIND> Handle IP addresses

12
src/output/help.rs
View file

@ -155,7 +155,7 @@ impl<'cmd, 'writer> Help<'cmd, 'writer> {
self.write_about(true, true); self.write_about(true, true);
} }
"usage-heading" => { "usage-heading" => {
self.header("USAGE:"); self.header("Usage:");
} }
"usage" => { "usage" => {
self.writer self.writer
@ -340,8 +340,8 @@ impl<'cmd, 'writer> Help<'cmd, 'writer> {
let mut first = if !pos.is_empty() { let mut first = if !pos.is_empty() {
// Write positional args if any // Write positional args if any
self.header("ARGS:\n"); self.header("Arguments:\n");
self.write_args(&pos, "ARGS", positional_sort_key); self.write_args(&pos, "Arguments", positional_sort_key);
false false
} else { } else {
true true
@ -351,8 +351,8 @@ impl<'cmd, 'writer> Help<'cmd, 'writer> {
if !first { if !first {
self.none("\n\n"); self.none("\n\n");
} }
self.header("OPTIONS:\n"); self.header("Options:\n");
self.write_args(&non_pos, "OPTIONS", option_sort_key); self.write_args(&non_pos, "Options", option_sort_key);
first = false; first = false;
} }
if !custom_headings.is_empty() { if !custom_headings.is_empty() {
@ -385,7 +385,7 @@ impl<'cmd, 'writer> Help<'cmd, 'writer> {
self.none("\n\n"); self.none("\n\n");
} }
let default_help_heading = Str::from("SUBCOMMANDS"); let default_help_heading = Str::from("Subcommands");
self.header( self.header(
self.cmd self.cmd
.get_subcommand_help_heading() .get_subcommand_help_heading()

2
src/output/usage.rs
View file

@ -32,7 +32,7 @@ impl<'cmd> Usage<'cmd> {
pub(crate) fn create_usage_with_title(&self, used: &[Id]) -> StyledStr { pub(crate) fn create_usage_with_title(&self, used: &[Id]) -> StyledStr {
debug!("Usage::create_usage_with_title"); debug!("Usage::create_usage_with_title");
let mut styled = StyledStr::new(); let mut styled = StyledStr::new();
styled.header("USAGE:"); styled.header("Usage:");
styled.none("\n "); styled.none("\n ");
styled.extend(self.create_usage_no_title(used).into_iter()); styled.extend(self.create_usage_no_title(used).into_iter());
styled styled

24
tests/builder/app_settings.rs
View file

@ -6,25 +6,25 @@ use clap::{arg, error::ErrorKind, Arg, ArgAction, Command};
static ALLOW_EXT_SC: &str = "clap-test v1.4.8 static ALLOW_EXT_SC: &str = "clap-test v1.4.8
USAGE: Usage:
clap-test [SUBCOMMAND] clap-test [SUBCOMMAND]
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
static DONT_COLLAPSE_ARGS: &str = "clap-test v1.4.8 static DONT_COLLAPSE_ARGS: &str = "clap-test v1.4.8
USAGE: Usage:
clap-test [arg1] [arg2] [arg3] clap-test [arg1] [arg2] [arg3]
ARGS: Arguments:
<arg1> some <arg1> some
<arg2> some <arg2> some
<arg3> some <arg3> some
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -127,10 +127,10 @@ fn arg_required_else_help_with_default() {
fn arg_required_else_help_error_message() { fn arg_required_else_help_error_message() {
static ARG_REQUIRED_ELSE_HELP: &str = "test 1.0 static ARG_REQUIRED_ELSE_HELP: &str = "test 1.0
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
-i, --info Provides more info -i, --info Provides more info
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -288,13 +288,13 @@ fn skip_possible_values() {
Kevin K. Kevin K.
tests stuff tests stuff
USAGE: Usage:
test [OPTIONS] [arg1] test [OPTIONS] [arg1]
ARGS: Arguments:
<arg1> some pos arg <arg1> some pos arg
OPTIONS: Options:
-o, --opt <opt> some option -o, --opt <opt> some option
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -567,10 +567,10 @@ fn dont_collapse_args() {
fn require_eq() { fn require_eq() {
static REQUIRE_EQUALS: &str = "clap-test v1.4.8 static REQUIRE_EQUALS: &str = "clap-test v1.4.8
USAGE: Usage:
clap-test --opt=<FILE> clap-test --opt=<FILE>
OPTIONS: Options:
-o, --opt=<FILE> some -o, --opt=<FILE> some
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

8
tests/builder/arg_aliases.rs
View file

@ -193,10 +193,10 @@ fn invisible_arg_aliases_help_output() {
static SC_INVISIBLE_ALIAS_HELP: &str = "ct-test 1.2 static SC_INVISIBLE_ALIAS_HELP: &str = "ct-test 1.2
Some help Some help
USAGE: Usage:
ct test [OPTIONS] ct test [OPTIONS]
OPTIONS: Options:
-o, --opt <opt> -o, --opt <opt>
-f, --flag -f, --flag
-h, --help Print help information -h, --help Print help information
@ -224,10 +224,10 @@ fn visible_arg_aliases_help_output() {
static SC_VISIBLE_ALIAS_HELP: &str = "ct-test 1.2 static SC_VISIBLE_ALIAS_HELP: &str = "ct-test 1.2
Some help Some help
USAGE: Usage:
ct test [OPTIONS] ct test [OPTIONS]
OPTIONS: Options:
-o, --opt <opt> [aliases: visible] -o, --opt <opt> [aliases: visible]
-f, --flag [aliases: v_flg, flag2, flg3] -f, --flag [aliases: v_flg, flag2, flg3]
-h, --help Print help information -h, --help Print help information

8
tests/builder/arg_aliases_short.rs
View file

@ -160,10 +160,10 @@ fn invisible_short_arg_aliases_help_output() {
static SC_INVISIBLE_ALIAS_HELP: &str = "ct-test 1.2 static SC_INVISIBLE_ALIAS_HELP: &str = "ct-test 1.2
Some help Some help
USAGE: Usage:
ct test [OPTIONS] ct test [OPTIONS]
OPTIONS: Options:
-o, --opt <opt> -o, --opt <opt>
-f, --flag -f, --flag
-h, --help Print help information -h, --help Print help information
@ -191,10 +191,10 @@ fn visible_short_arg_aliases_help_output() {
static SC_VISIBLE_ALIAS_HELP: &str = "ct-test 1.2 static SC_VISIBLE_ALIAS_HELP: &str = "ct-test 1.2
Some help Some help
USAGE: Usage:
ct test [OPTIONS] ct test [OPTIONS]
OPTIONS: Options:
-o, --opt <opt> [short aliases: v] -o, --opt <opt> [short aliases: v]
-f, --flag [aliases: flag1] [short aliases: a, b, 🦆] -f, --flag [aliases: flag1] [short aliases: a, b, 🦆]
-h, --help Print help information -h, --help Print help information

8
tests/builder/cargo.rs
View file

@ -7,10 +7,10 @@ use clap::{
static DESCRIPTION_ONLY: &str = "prog 1 static DESCRIPTION_ONLY: &str = "prog 1
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
prog prog
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -18,10 +18,10 @@ OPTIONS:
static AUTHORS_ONLY: &str = "prog 1 static AUTHORS_ONLY: &str = "prog 1
USAGE: Usage:
prog prog
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";

4
tests/builder/command.rs
View file

@ -5,10 +5,10 @@ use clap::{command, error::ErrorKind};
static EVERYTHING: &str = "clap {{version}} static EVERYTHING: &str = "clap {{version}}
A simple to use, efficient, and full-featured Command Line Argument Parser A simple to use, efficient, and full-featured Command Line Argument Parser
USAGE: Usage:
clap clap
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";

10
tests/builder/conflicts.rs
View file

@ -292,7 +292,7 @@ fn get_arg_conflicts_with_group() {
fn conflict_output() { fn conflict_output() {
static CONFLICT_ERR: &str = "error: The argument '--flag...' cannot be used with '-F' static CONFLICT_ERR: &str = "error: The argument '--flag...' cannot be used with '-F'
USAGE: Usage:
clap-test --flag... --long-option-2 <option2> <positional> <positional2> clap-test --flag... --long-option-2 <option2> <positional> <positional2>
For more information try --help For more information try --help
@ -310,7 +310,7 @@ For more information try --help
fn conflict_output_rev() { fn conflict_output_rev() {
static CONFLICT_ERR_REV: &str = "error: The argument '-F' cannot be used with '--flag...' static CONFLICT_ERR_REV: &str = "error: The argument '-F' cannot be used with '--flag...'
USAGE: Usage:
clap-test -F --long-option-2 <option2> <positional> <positional2> clap-test -F --long-option-2 <option2> <positional> <positional2>
For more information try --help For more information try --help
@ -328,7 +328,7 @@ For more information try --help
fn conflict_output_with_required() { fn conflict_output_with_required() {
static CONFLICT_ERR: &str = "error: The argument '--flag...' cannot be used with '-F' static CONFLICT_ERR: &str = "error: The argument '--flag...' cannot be used with '-F'
USAGE: Usage:
clap-test --flag... --long-option-2 <option2> <positional> <positional2> clap-test --flag... --long-option-2 <option2> <positional> <positional2>
For more information try --help For more information try --help
@ -346,7 +346,7 @@ For more information try --help
fn conflict_output_rev_with_required() { fn conflict_output_rev_with_required() {
static CONFLICT_ERR_REV: &str = "error: The argument '-F' cannot be used with '--flag...' static CONFLICT_ERR_REV: &str = "error: The argument '-F' cannot be used with '--flag...'
USAGE: Usage:
clap-test -F --long-option-2 <option2> <positional> <positional2> clap-test -F --long-option-2 <option2> <positional> <positional2>
For more information try --help For more information try --help
@ -366,7 +366,7 @@ fn conflict_output_three_conflicting() {
--two --two
--three --three
USAGE: Usage:
three_conflicting_arguments --one three_conflicting_arguments --one
For more information try --help For more information try --help

2
tests/builder/default_vals.rs
View file

@ -731,7 +731,7 @@ fn default_vals_donnot_show_in_smart_usage() {
"error: The following required arguments were not provided: "error: The following required arguments were not provided:
<input> <input>
USAGE: Usage:
bug [OPTIONS] <input> bug [OPTIONS] <input>
For more information try --help For more information try --help

36
tests/builder/derive_order.rs
View file

@ -8,10 +8,10 @@ use clap::{Arg, ArgAction, Command};
fn no_derive_order() { fn no_derive_order() {
static NO_DERIVE_ORDER: &str = "test 1.2 static NO_DERIVE_ORDER: &str = "test 1.2
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
--flag_a second flag --flag_a second flag
--flag_b first flag --flag_b first flag
-h, --help Print help information -h, --help Print help information
@ -49,10 +49,10 @@ OPTIONS:
fn derive_order() { fn derive_order() {
static UNIFIED_HELP_AND_DERIVE: &str = "test 1.2 static UNIFIED_HELP_AND_DERIVE: &str = "test 1.2
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
--flag_b first flag --flag_b first flag
--option_b <option_b> first option --option_b <option_b> first option
--flag_a second flag --flag_a second flag
@ -87,10 +87,10 @@ OPTIONS:
fn derive_order_next_order() { fn derive_order_next_order() {
static HELP: &str = "test 1.2 static HELP: &str = "test 1.2
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
--flag_b first flag --flag_b first flag
--option_b <option_b> first option --option_b <option_b> first option
-h, --help Print help information -h, --help Print help information
@ -135,10 +135,10 @@ OPTIONS:
fn derive_order_no_next_order() { fn derive_order_no_next_order() {
static HELP: &str = "test 1.2 static HELP: &str = "test 1.2
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
--flag_a first flag --flag_a first flag
--flag_b second flag --flag_b second flag
-h, --help Print help information -h, --help Print help information
@ -182,10 +182,10 @@ OPTIONS:
fn derive_order_subcommand_propagate() { fn derive_order_subcommand_propagate() {
static UNIFIED_DERIVE_SC_PROP: &str = "test-sub 1.2 static UNIFIED_DERIVE_SC_PROP: &str = "test-sub 1.2
USAGE: Usage:
test sub [OPTIONS] test sub [OPTIONS]
OPTIONS: Options:
--flag_b first flag --flag_b first flag
--option_b <option_b> first option --option_b <option_b> first option
--flag_a second flag --flag_a second flag
@ -222,10 +222,10 @@ OPTIONS:
fn derive_order_subcommand_propagate_with_explicit_display_order() { fn derive_order_subcommand_propagate_with_explicit_display_order() {
static UNIFIED_DERIVE_SC_PROP_EXPLICIT_ORDER: &str = "test-sub 1.2 static UNIFIED_DERIVE_SC_PROP_EXPLICIT_ORDER: &str = "test-sub 1.2
USAGE: Usage:
test sub [OPTIONS] test sub [OPTIONS]
OPTIONS: Options:
--flag_a second flag --flag_a second flag
--flag_b first flag --flag_b first flag
--option_b <option_b> first option --option_b <option_b> first option
@ -268,14 +268,14 @@ OPTIONS:
fn subcommand_sorted_display_order() { fn subcommand_sorted_display_order() {
static SUBCMD_ALPHA_ORDER: &str = "test 1 static SUBCMD_ALPHA_ORDER: &str = "test 1
USAGE: Usage:
test [SUBCOMMAND] test [SUBCOMMAND]
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
a1 blah a1 a1 blah a1
b1 blah b1 b1 blah b1
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
@ -305,14 +305,14 @@ SUBCOMMANDS:
fn subcommand_derived_display_order() { fn subcommand_derived_display_order() {
static SUBCMD_DECL_ORDER: &str = "test 1 static SUBCMD_DECL_ORDER: &str = "test 1
USAGE: Usage:
test [SUBCOMMAND] test [SUBCOMMAND]
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
b1 blah b1 b1 blah b1
a1 blah a1 a1 blah a1
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)

6
tests/builder/display_order.rs
View file

@ -11,13 +11,13 @@ fn very_large_display_order() {
"test --help", "test --help",
"test "test
USAGE: Usage:
test [SUBCOMMAND] test [SUBCOMMAND]
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
SUBCOMMANDS: Subcommands:
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
sub sub
", ",

8
tests/builder/double_require.rs
View file

@ -2,10 +2,10 @@ use clap::{error::ErrorKind, Arg, ArgAction, Command};
static HELP: &str = "prog static HELP: &str = "prog
USAGE: Usage:
prog [OPTIONS] prog [OPTIONS]
OPTIONS: Options:
-a -a
-b -b
-c -c
@ -15,7 +15,7 @@ OPTIONS:
static ONLY_B_ERROR: &str = "error: The following required arguments were not provided: static ONLY_B_ERROR: &str = "error: The following required arguments were not provided:
-c -c
USAGE: Usage:
prog -b -c prog -b -c
For more information try --help For more information try --help
@ -24,7 +24,7 @@ For more information try --help
static ONLY_C_ERROR: &str = "error: The following required arguments were not provided: static ONLY_C_ERROR: &str = "error: The following required arguments were not provided:
-b -b
USAGE: Usage:
prog -c -b prog -c -b
For more information try --help For more information try --help

2
tests/builder/empty_values.rs
View file

@ -118,7 +118,7 @@ fn no_empty_values_without_equals_but_requires_equals() {
static NO_EUQALS_ERROR: &str = static NO_EUQALS_ERROR: &str =
"error: Equal sign is needed when assigning values to '--config=<config>'. "error: Equal sign is needed when assigning values to '--config=<config>'.
USAGE: Usage:
config [OPTIONS] config [OPTIONS]
For more information try --help For more information try --help

14
tests/builder/error.rs
View file

@ -25,7 +25,7 @@ fn assert_error<F: clap::error::ErrorFormatter>(
fn app_error() { fn app_error() {
static MESSAGE: &str = "error: Failed for mysterious reasons static MESSAGE: &str = "error: Failed for mysterious reasons
USAGE: Usage:
test [OPTIONS] --all test [OPTIONS] --all
For more information try --help For more information try --help
@ -91,10 +91,10 @@ fn null_prints_help() {
static MESSAGE: &str = "\ static MESSAGE: &str = "\
test test
USAGE: Usage:
test test
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
"; ";
assert_error(err, expected_kind, MESSAGE, false); assert_error(err, expected_kind, MESSAGE, false);
@ -112,10 +112,10 @@ fn raw_prints_help() {
static MESSAGE: &str = "\ static MESSAGE: &str = "\
test test
USAGE: Usage:
test test
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
"; ";
assert_error(err, expected_kind, MESSAGE, false); assert_error(err, expected_kind, MESSAGE, false);
@ -144,7 +144,7 @@ fn rich_formats_validation_error() {
static MESSAGE: &str = "\ static MESSAGE: &str = "\
error: Found argument 'unused' which wasn't expected, or isn't valid in this context error: Found argument 'unused' which wasn't expected, or isn't valid in this context
USAGE: Usage:
test test
For more information try --help For more information try --help
@ -165,7 +165,7 @@ fn raw_formats_validation_error() {
error: Found an argument which wasn't expected or isn't valid in this context error: Found an argument which wasn't expected or isn't valid in this context
Invalid Argument: unused Invalid Argument: unused
USAGE: Usage:
test test
"; ";
assert_error(err, expected_kind, MESSAGE, true); assert_error(err, expected_kind, MESSAGE, true);

12
tests/builder/flag_subcommands.rs
View file

@ -499,10 +499,10 @@ fn flag_subcommand_long_infer_exact_match() {
static FLAG_SUBCOMMAND_HELP: &str = "pacman-query static FLAG_SUBCOMMAND_HELP: &str = "pacman-query
Query the package database. Query the package database.
USAGE: Usage:
pacman {query|--query|-Q} [OPTIONS] pacman {query|--query|-Q} [OPTIONS]
OPTIONS: Options:
-s, --search <search>... search locally installed packages for matching strings -s, --search <search>... search locally installed packages for matching strings
-i, --info <info>... view package information -i, --info <info>... view package information
-h, --help Print help information -h, --help Print help information
@ -548,10 +548,10 @@ fn flag_subcommand_long_short_normal_usage_string() {
static FLAG_SUBCOMMAND_NO_SHORT_HELP: &str = "pacman-query static FLAG_SUBCOMMAND_NO_SHORT_HELP: &str = "pacman-query
Query the package database. Query the package database.
USAGE: Usage:
pacman {query|--query} [OPTIONS] pacman {query|--query} [OPTIONS]
OPTIONS: Options:
-s, --search <search>... search locally installed packages for matching strings -s, --search <search>... search locally installed packages for matching strings
-i, --info <info>... view package information -i, --info <info>... view package information
-h, --help Print help information -h, --help Print help information
@ -601,10 +601,10 @@ fn flag_subcommand_long_normal_usage_string() {
static FLAG_SUBCOMMAND_NO_LONG_HELP: &str = "pacman-query static FLAG_SUBCOMMAND_NO_LONG_HELP: &str = "pacman-query
Query the package database. Query the package database.
USAGE: Usage:
pacman {query|-Q} [OPTIONS] pacman {query|-Q} [OPTIONS]
OPTIONS: Options:
-s, --search <search>... search locally installed packages for matching strings -s, --search <search>... search locally installed packages for matching strings
-i, --info <info>... view package information -i, --info <info>... view package information
-h, --help Print help information -h, --help Print help information

4
tests/builder/flags.rs
View file

@ -6,7 +6,7 @@ const USE_FLAG_AS_ARGUMENT: &str =
\tIf you tried to supply `--another-flag` as a value rather than a flag, use `-- --another-flag` \tIf you tried to supply `--another-flag` as a value rather than a flag, use `-- --another-flag`
USAGE: Usage:
mycat [OPTIONS] [filename] mycat [OPTIONS] [filename]
For more information try --help For more information try --help
@ -183,7 +183,7 @@ fn issue_2308_multiple_dashes() {
If you tried to supply `-----` as a value rather than a flag, use `-- -----` If you tried to supply `-----` as a value rather than a flag, use `-- -----`
USAGE: Usage:
test <arg> test <arg>
For more information try --help For more information try --help

12
tests/builder/groups.rs
View file

@ -5,7 +5,7 @@ use clap::{arg, error::ErrorKind, Arg, ArgAction, ArgGroup, Command, Id};
static REQ_GROUP_USAGE: &str = "error: The following required arguments were not provided: static REQ_GROUP_USAGE: &str = "error: The following required arguments were not provided:
<base|--delete> <base|--delete>
USAGE: Usage:
clap-test <base|--delete> clap-test <base|--delete>
For more information try --help For more information try --help
@ -14,7 +14,7 @@ For more information try --help
static REQ_GROUP_CONFLICT_USAGE: &str = static REQ_GROUP_CONFLICT_USAGE: &str =
"error: The argument '--delete' cannot be used with '<base>' "error: The argument '--delete' cannot be used with '<base>'
USAGE: Usage:
clap-test <base|--delete> clap-test <base|--delete>
For more information try --help For more information try --help
@ -23,7 +23,7 @@ For more information try --help
static REQ_GROUP_CONFLICT_ONLY_OPTIONS: &str = static REQ_GROUP_CONFLICT_ONLY_OPTIONS: &str =
"error: The argument '--delete' cannot be used with '--all' "error: The argument '--delete' cannot be used with '--all'
USAGE: Usage:
clap-test <--all|--delete> clap-test <--all|--delete>
For more information try --help For more information try --help
@ -263,13 +263,13 @@ fn group_overrides_required() {
fn group_usage_use_val_name() { fn group_usage_use_val_name() {
static GROUP_USAGE_USE_VAL_NAME: &str = "prog static GROUP_USAGE_USE_VAL_NAME: &str = "prog
USAGE: Usage:
prog <A> prog <A>
ARGS: Arguments:
<A> <A>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
"; ";
let cmd = Command::new("prog") let cmd = Command::new("prog")

336
tests/builder/help.rs
View file

@ -78,7 +78,7 @@ fn help_multi_subcommand_error() {
static EXPECTED: &str = "error: The subcommand 'foo' wasn't recognized static EXPECTED: &str = "error: The subcommand 'foo' wasn't recognized
USAGE: Usage:
ctest subcmd multi [OPTIONS] ctest subcmd multi [OPTIONS]
For more information try --help For more information try --help
@ -90,14 +90,14 @@ For more information try --help
fn req_last_arg_usage() { fn req_last_arg_usage() {
static LAST_ARG_REQ_MULT: &str = "example 1.0 static LAST_ARG_REQ_MULT: &str = "example 1.0
USAGE: Usage:
example <FIRST>... [--] <SECOND>... example <FIRST>... [--] <SECOND>...
ARGS: Arguments:
<FIRST>... First <FIRST>... First
<SECOND>... Second <SECOND>... Second
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -119,14 +119,14 @@ OPTIONS:
fn args_with_last_usage() { fn args_with_last_usage() {
static LAST_ARG_USAGE: &str = "flamegraph 0.1 static LAST_ARG_USAGE: &str = "flamegraph 0.1
USAGE: Usage:
flamegraph [OPTIONS] [BINFILE] [-- <ARGS>...] flamegraph [OPTIONS] [BINFILE] [-- <ARGS>...]
ARGS: Arguments:
<BINFILE> The path of the binary to be profiled. for a binary. <BINFILE> The path of the binary to be profiled. for a binary.
<ARGS>... Any arguments you wish to pass to the being profiled. <ARGS>... Any arguments you wish to pass to the being profiled.
OPTIONS: Options:
-v, --verbose Prints out more stuff. -v, --verbose Prints out more stuff.
-t, --timeout <SECONDS> Timeout in seconds. -t, --timeout <SECONDS> Timeout in seconds.
-f, --frequency <HERTZ> The sampling frequency. -f, --frequency <HERTZ> The sampling frequency.
@ -204,15 +204,15 @@ fn complex_help_output() {
Kevin K. <kbknapp@gmail.com> Kevin K. <kbknapp@gmail.com>
tests clap library tests clap library
USAGE: Usage:
clap-test [OPTIONS] [ARGS] [SUBCOMMAND] clap-test [OPTIONS] [ARGS] [SUBCOMMAND]
ARGS: Arguments:
<positional> tests positionals <positional> tests positionals
<positional2> tests positionals with exclusions <positional2> tests positionals with exclusions
<positional3>... tests specific values [possible values: vi, emacs] <positional3>... tests specific values [possible values: vi, emacs]
OPTIONS: Options:
-o, --option <opt>... tests options -o, --option <opt>... tests options
-f, --flag... tests flags -f, --flag... tests flags
-F tests flags with exclusions -F tests flags with exclusions
@ -227,7 +227,7 @@ OPTIONS:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
subcmd tests subcommands subcmd tests subcommands
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
"; ";
@ -242,10 +242,10 @@ fn after_and_before_help_output() {
clap-test v1.4.8 clap-test v1.4.8
tests clap library tests clap library
USAGE: Usage:
clap-test clap-test
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -268,10 +268,10 @@ fn after_and_before_long_help_output() {
clap-test v1.4.8 clap-test v1.4.8
tests clap library tests clap library
USAGE: Usage:
clap-test clap-test
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -283,10 +283,10 @@ some text that comes after the help
clap-test v1.4.8 clap-test v1.4.8
tests clap library tests clap library
USAGE: Usage:
clap-test clap-test
OPTIONS: Options:
-h, --help -h, --help
Print help information Print help information
@ -311,10 +311,10 @@ static MULTI_SC_HELP: &str = "ctest-subcmd-multi 0.1
Kevin K. <kbknapp@gmail.com> Kevin K. <kbknapp@gmail.com>
tests subcommands tests subcommands
USAGE: Usage:
ctest subcmd multi [OPTIONS] ctest subcmd multi [OPTIONS]
OPTIONS: Options:
-f, --flag tests flags -f, --flag tests flags
-o, --option <scoption>... tests options -o, --option <scoption>... tests options
-h, --help Print help information -h, --help Print help information
@ -357,10 +357,10 @@ fn no_wrap_help() {
fn no_wrap_default_help() { fn no_wrap_default_help() {
static DEFAULT_HELP: &str = "ctest 1.0 static DEFAULT_HELP: &str = "ctest 1.0
USAGE: Usage:
ctest ctest
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -374,10 +374,10 @@ OPTIONS:
fn wrapped_help() { fn wrapped_help() {
static WRAPPED_HELP: &str = "test static WRAPPED_HELP: &str = "test
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
-a, --all -a, --all
Also do versioning for private crates (will not be Also do versioning for private crates (will not be
published) published)
@ -430,10 +430,10 @@ OPTIONS:
fn unwrapped_help() { fn unwrapped_help() {
static UNWRAPPED_HELP: &str = "test static UNWRAPPED_HELP: &str = "test
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
-a, --all Also do versioning for private crates -a, --all Also do versioning for private crates
(will not be published) (will not be published)
--exact Specify inter dependency version numbers --exact Specify inter dependency version numbers
@ -478,10 +478,10 @@ OPTIONS:
fn possible_value_wrapped_help() { fn possible_value_wrapped_help() {
static WRAPPED_HELP: &str = "test static WRAPPED_HELP: &str = "test
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
--possible-values <possible_values> --possible-values <possible_values>
Possible values: Possible values:
- short_name: - short_name:
@ -545,13 +545,13 @@ fn complex_subcommand_help_output() {
Kevin K. <kbknapp@gmail.com> Kevin K. <kbknapp@gmail.com>
tests subcommands tests subcommands
USAGE: Usage:
clap-test subcmd [OPTIONS] [--] [scpositional] clap-test subcmd [OPTIONS] [--] [scpositional]
ARGS: Arguments:
<scpositional> tests positionals <scpositional> tests positionals
OPTIONS: Options:
-o, --option <scoption>... tests options -o, --option <scoption>... tests options
-f, --flag... tests flags -f, --flag... tests flags
-s, --subcmdarg <subcmdarg> tests other args -s, --subcmdarg <subcmdarg> tests other args
@ -567,10 +567,10 @@ OPTIONS:
fn issue_626_unicode_cutoff() { fn issue_626_unicode_cutoff() {
static ISSUE_626_CUTOFF: &str = "ctest 0.1 static ISSUE_626_CUTOFF: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-c, --cafe <FILE> A coffeehouse, coffee shop, or café is an -c, --cafe <FILE> A coffeehouse, coffee shop, or café is an
establishment which primarily serves hot establishment which primarily serves hot
coffee, related coffee beverages (e.g., café coffee, related coffee beverages (e.g., café
@ -603,10 +603,10 @@ OPTIONS:
static HIDE_POS_VALS: &str = "ctest 0.1 static HIDE_POS_VALS: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-p, --pos <VAL> Some vals [possible values: fast, slow] -p, --pos <VAL> Some vals [possible values: fast, slow]
-c, --cafe <FILE> A coffeehouse, coffee shop, or café. -c, --cafe <FILE> A coffeehouse, coffee shop, or café.
-h, --help Print help information -h, --help Print help information
@ -671,10 +671,10 @@ fn hide_single_possible_val() {
fn possible_vals_with_help() { fn possible_vals_with_help() {
static POS_VALS_HELP: &str = "ctest 0.1 static POS_VALS_HELP: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-p, --pos <VAL> -p, --pos <VAL>
Some vals Some vals
@ -721,10 +721,10 @@ OPTIONS:
fn issue_626_panic() { fn issue_626_panic() {
static ISSUE_626_PANIC: &str = "ctest 0.1 static ISSUE_626_PANIC: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-c, --cafe <FILE> -c, --cafe <FILE>
La culture du café est très développée La culture du café est très développée
dans de nombreux pays à climat chaud dans de nombreux pays à climat chaud
@ -777,10 +777,10 @@ fn issue_626_variable_panic() {
fn final_word_wrapping() { fn final_word_wrapping() {
static FINAL_WORD_WRAPPING: &str = "ctest 0.1 static FINAL_WORD_WRAPPING: &str = "ctest 0.1
USAGE: Usage:
ctest ctest
OPTIONS: Options:
-h, --help -h, --help
Print help Print help
information information
@ -797,10 +797,10 @@ OPTIONS:
static WRAPPING_NEWLINE_CHARS: &str = "ctest 0.1 static WRAPPING_NEWLINE_CHARS: &str = "ctest 0.1
USAGE: Usage:
ctest [mode] ctest [mode]
ARGS: Arguments:
<mode> x, max, maximum 20 characters, contains <mode> x, max, maximum 20 characters, contains
symbols. symbols.
l, long Copy-friendly, 14 l, long Copy-friendly, 14
@ -808,7 +808,7 @@ ARGS:
m, med, medium Copy-friendly, 8 m, med, medium Copy-friendly, 8
characters, contains symbols. characters, contains symbols.
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -853,10 +853,10 @@ fn dont_wrap_urls() {
const EXPECTED: &str = "\ const EXPECTED: &str = "\
Example-update Example-update
USAGE: Usage:
Example update [OPTIONS] Example update [OPTIONS]
OPTIONS: Options:
--force-non-host --force-non-host
Install toolchains Install toolchains
that require an that require an
@ -872,10 +872,10 @@ OPTIONS:
static OLD_NEWLINE_CHARS: &str = "ctest 0.1 static OLD_NEWLINE_CHARS: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-m Some help with some wrapping -m Some help with some wrapping
(Defaults to something) (Defaults to something)
-h, --help Print help information -h, --help Print help information
@ -908,10 +908,10 @@ fn old_newline_variables() {
fn issue_688_hide_pos_vals() { fn issue_688_hide_pos_vals() {
static ISSUE_688: &str = "ctest 0.1 static ISSUE_688: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
--filter <filter> Sets the filter, or sampling method, to use for interpolation when resizing the particle --filter <filter> Sets the filter, or sampling method, to use for interpolation when resizing the particle
images. The default is Linear (Bilinear). [possible values: Nearest, Linear, Cubic, images. The default is Linear (Bilinear). [possible values: Nearest, Linear, Cubic,
Gaussian, Lanczos3] Gaussian, Lanczos3]
@ -961,14 +961,14 @@ fn issue_702_multiple_values() {
foo foo
bar bar
USAGE: Usage:
myapp [OPTIONS] [--] [ARGS] myapp [OPTIONS] [--] [ARGS]
ARGS: Arguments:
<arg1> some option <arg1> some option
<arg2>... some option <arg2>... some option
OPTIONS: Options:
-s, --some <some> some option -s, --some <some> some option
-o, --other <other> some other option -o, --other <other> some other option
-l, --label <label>... a label -l, --label <label>... a label
@ -1020,14 +1020,14 @@ something really really long, with
multiple lines of text multiple lines of text
that should be displayed that should be displayed
USAGE: Usage:
myapp [arg1] myapp [arg1]
ARGS: Arguments:
<arg1> <arg1>
some option some option
OPTIONS: Options:
-h, --help -h, --help
Print help information Print help information
@ -1048,13 +1048,13 @@ OPTIONS:
static RIPGREP_USAGE: &str = "ripgrep 0.5 static RIPGREP_USAGE: &str = "ripgrep 0.5
USAGE: Usage:
rg [OPTIONS] <pattern> [<path> ...] rg [OPTIONS] <pattern> [<path> ...]
rg [OPTIONS] [-e PATTERN | -f FILE ]... [<path> ...] rg [OPTIONS] [-e PATTERN | -f FILE ]... [<path> ...]
rg [OPTIONS] --files [<path> ...] rg [OPTIONS] --files [<path> ...]
rg [OPTIONS] --type-list rg [OPTIONS] --type-list
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -1086,9 +1086,9 @@ fn ripgrep_usage_using_templates() {
"\ "\
{bin} {version} {bin} {version}
USAGE:{usage} Usage:{usage}
OPTIONS: Options:
{options}", {options}",
); );
@ -1099,19 +1099,19 @@ OPTIONS:
fn sc_negates_reqs() { fn sc_negates_reqs() {
static SC_NEGATES_REQS: &str = "prog 1.0 static SC_NEGATES_REQS: &str = "prog 1.0
USAGE: Usage:
prog --opt <FILE> [PATH] prog --opt <FILE> [PATH]
prog [PATH] <SUBCOMMAND> prog [PATH] <SUBCOMMAND>
ARGS: Arguments:
<PATH> help <PATH> help
OPTIONS: Options:
-o, --opt <FILE> tests options -o, --opt <FILE> tests options
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
test test
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
"; ";
@ -1129,10 +1129,10 @@ SUBCOMMANDS:
fn hide_args() { fn hide_args() {
static HIDDEN_ARGS: &str = "prog 1.0 static HIDDEN_ARGS: &str = "prog 1.0
USAGE: Usage:
prog [OPTIONS] prog [OPTIONS]
OPTIONS: Options:
-f, --flag testing flags -f, --flag testing flags
-o, --opt <FILE> tests options -o, --opt <FILE> tests options
-h, --help Print help information -h, --help Print help information
@ -1151,20 +1151,20 @@ OPTIONS:
fn args_negate_sc() { fn args_negate_sc() {
static ARGS_NEGATE_SC: &str = "prog 1.0 static ARGS_NEGATE_SC: &str = "prog 1.0
USAGE: Usage:
prog [OPTIONS] [PATH] prog [OPTIONS] [PATH]
prog <SUBCOMMAND> prog <SUBCOMMAND>
ARGS: Arguments:
<PATH> help <PATH> help
OPTIONS: Options:
-f, --flag testing flags -f, --flag testing flags
-o, --opt <FILE> tests options -o, --opt <FILE> tests options
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
test test
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
"; ";
@ -1183,13 +1183,13 @@ SUBCOMMANDS:
fn issue_1046_hide_scs() { fn issue_1046_hide_scs() {
static ISSUE_1046_HIDDEN_SCS: &str = "prog 1.0 static ISSUE_1046_HIDDEN_SCS: &str = "prog 1.0
USAGE: Usage:
prog [OPTIONS] [PATH] prog [OPTIONS] [PATH]
ARGS: Arguments:
<PATH> some <PATH> some
OPTIONS: Options:
-f, --flag testing flags -f, --flag testing flags
-o, --opt <FILE> tests options -o, --opt <FILE> tests options
-h, --help Print help information -h, --help Print help information
@ -1214,10 +1214,10 @@ email <email@server.com>
Show how the about text is not Show how the about text is not
wrapped wrapped
USAGE: Usage:
ctest ctest
OPTIONS: Options:
-h, --help -h, --help
Print help information Print help information
@ -1236,10 +1236,10 @@ OPTIONS:
static OVERRIDE_HELP_SHORT: &str = "test 0.1 static OVERRIDE_HELP_SHORT: &str = "test 0.1
USAGE: Usage:
test test
OPTIONS: Options:
-H, --help Print help information -H, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -1257,10 +1257,10 @@ fn override_help_short() {
static OVERRIDE_HELP_LONG: &str = "test 0.1 static OVERRIDE_HELP_LONG: &str = "test 0.1
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
-h, --hell Print help information -h, --hell Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -1278,10 +1278,10 @@ fn override_help_long() {
static OVERRIDE_HELP_ABOUT: &str = "test 0.1 static OVERRIDE_HELP_ABOUT: &str = "test 0.1
USAGE: Usage:
test test
OPTIONS: Options:
-h, --help Print custom help information -h, --help Print custom help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -1332,15 +1332,15 @@ fn arg_long_conflict_with_help() {
fn last_arg_mult_usage() { fn last_arg_mult_usage() {
static LAST_ARG: &str = "last 0.1 static LAST_ARG: &str = "last 0.1
USAGE: Usage:
last <TARGET> [CORPUS] [-- <ARGS>...] last <TARGET> [CORPUS] [-- <ARGS>...]
ARGS: Arguments:
<TARGET> some <TARGET> some
<CORPUS> some <CORPUS> some
<ARGS>... some <ARGS>... some
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -1363,15 +1363,15 @@ OPTIONS:
fn last_arg_mult_usage_req() { fn last_arg_mult_usage_req() {
static LAST_ARG_REQ: &str = "last 0.1 static LAST_ARG_REQ: &str = "last 0.1
USAGE: Usage:
last <TARGET> [CORPUS] -- <ARGS>... last <TARGET> [CORPUS] -- <ARGS>...
ARGS: Arguments:
<TARGET> some <TARGET> some
<CORPUS> some <CORPUS> some
<ARGS>... some <ARGS>... some
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -1395,20 +1395,20 @@ OPTIONS:
fn last_arg_mult_usage_req_with_sc() { fn last_arg_mult_usage_req_with_sc() {
static LAST_ARG_REQ_SC: &str = "last 0.1 static LAST_ARG_REQ_SC: &str = "last 0.1
USAGE: Usage:
last <TARGET> [CORPUS] -- <ARGS>... last <TARGET> [CORPUS] -- <ARGS>...
last <SUBCOMMAND> last <SUBCOMMAND>
ARGS: Arguments:
<TARGET> some <TARGET> some
<CORPUS> some <CORPUS> some
<ARGS>... some <ARGS>... some
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
test some test some
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
"; ";
@ -1434,20 +1434,20 @@ SUBCOMMANDS:
fn last_arg_mult_usage_with_sc() { fn last_arg_mult_usage_with_sc() {
static LAST_ARG_SC: &str = "last 0.1 static LAST_ARG_SC: &str = "last 0.1
USAGE: Usage:
last <TARGET> [CORPUS] [-- <ARGS>...] last <TARGET> [CORPUS] [-- <ARGS>...]
last <SUBCOMMAND> last <SUBCOMMAND>
ARGS: Arguments:
<TARGET> some <TARGET> some
<CORPUS> some <CORPUS> some
<ARGS>... some <ARGS>... some
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
test some test some
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
"; ";
@ -1470,10 +1470,10 @@ SUBCOMMANDS:
static HIDE_DEFAULT_VAL: &str = "default 0.1 static HIDE_DEFAULT_VAL: &str = "default 0.1
USAGE: Usage:
default [OPTIONS] default [OPTIONS]
OPTIONS: Options:
--arg <argument> Pass an argument to the program. [default: default-argument] --arg <argument> Pass an argument to the program. [default: default-argument]
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -1503,10 +1503,10 @@ fn hide_default_val() {
fn escaped_whitespace_values() { fn escaped_whitespace_values() {
static ESCAPED_DEFAULT_VAL: &str = "default 0.1 static ESCAPED_DEFAULT_VAL: &str = "default 0.1
USAGE: Usage:
default [OPTIONS] default [OPTIONS]
OPTIONS: Options:
--arg <argument> Pass an argument to the program. [default: \"\\n\"] [possible values: normal, \" \", \"\\n\", \"\\t\", --arg <argument> Pass an argument to the program. [default: \"\\n\"] [possible values: normal, \" \", \"\\n\", \"\\t\",
other] other]
-h, --help Print help information -h, --help Print help information
@ -1595,10 +1595,10 @@ fn issue_1052_require_delim_help() {
Kevin K. Kevin K.
tests stuff tests stuff
USAGE: Usage:
test --fake <some> <val> test --fake <some> <val>
OPTIONS: Options:
-f, --fake <some> <val> some help -f, --fake <some> <val> some help
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -1625,10 +1625,10 @@ fn custom_headers_headers() {
Will M. Will M.
does stuff does stuff
USAGE: Usage:
test [OPTIONS] --fake <some> <val> test [OPTIONS] --fake <some> <val>
OPTIONS: Options:
-f, --fake <some> <val> some help -f, --fake <some> <val> some help
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -1666,10 +1666,10 @@ static MULTIPLE_CUSTOM_HELP_SECTIONS: &str = "blorp 1.4
Will M. Will M.
does stuff does stuff
USAGE: Usage:
test [OPTIONS] --fake <some> <val> --birthday-song <song> --birthday-song-volume <volume> test [OPTIONS] --fake <some> <val> --birthday-song <song> --birthday-song-volume <volume>
OPTIONS: Options:
-f, --fake <some> <val> some help -f, --fake <some> <val> some help
--style <style> Choose musical style to play the song --style <style> Choose musical style to play the song
-s, --speed <SPEED> How fast? [possible values: fast, slow] -s, --speed <SPEED> How fast? [possible values: fast, slow]
@ -1747,10 +1747,10 @@ static CUSTOM_HELP_SECTION_HIDDEN_ARGS: &str = "blorp 1.4
Will M. Will M.
does stuff does stuff
USAGE: Usage:
test [OPTIONS] --song <song> --song-volume <volume> test [OPTIONS] --song <song> --song-volume <volume>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -1799,10 +1799,10 @@ fn custom_help_headers_hide_args() {
static ISSUE_897: &str = "ctest-foo 0.1 static ISSUE_897: &str = "ctest-foo 0.1
Long about foo Long about foo
USAGE: Usage:
ctest foo ctest foo
OPTIONS: Options:
-h, --help -h, --help
Print help information Print help information
@ -1824,10 +1824,10 @@ fn show_long_about_issue_897() {
static ISSUE_897_SHORT: &str = "ctest-foo 0.1 static ISSUE_897_SHORT: &str = "ctest-foo 0.1
About foo About foo
USAGE: Usage:
ctest foo ctest foo
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -1847,13 +1847,13 @@ fn show_short_about_issue_897() {
fn issue_1364_no_short_options() { fn issue_1364_no_short_options() {
static ISSUE_1364: &str = "demo static ISSUE_1364: &str = "demo
USAGE: Usage:
demo [OPTIONS] [FILES]... demo [OPTIONS] [FILES]...
ARGS: Arguments:
<FILES>... <FILES>...
OPTIONS: Options:
-f -f
-h, --help Print help information -h, --help Print help information
"; ";
@ -1881,14 +1881,14 @@ OPTIONS:
fn issue_1487() { fn issue_1487() {
static ISSUE_1487: &str = "test static ISSUE_1487: &str = "test
USAGE: Usage:
ctest <arg1|arg2> ctest <arg1|arg2>
ARGS: Arguments:
<arg1> <arg1>
<arg2> <arg2>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
"; ";
@ -2003,10 +2003,10 @@ fn help_required_and_no_args() {
fn issue_1642_long_help_spacing() { fn issue_1642_long_help_spacing() {
static ISSUE_1642: &str = "prog static ISSUE_1642: &str = "prog
USAGE: Usage:
prog [OPTIONS] prog [OPTIONS]
OPTIONS: Options:
--config --config
The config file used by the myprog must be in JSON format The config file used by the myprog must be in JSON format
with only valid keys and may not contain other nonsense with only valid keys and may not contain other nonsense
@ -2033,7 +2033,7 @@ and on, so I'll stop now.",
const AFTER_HELP_NO_ARGS: &str = "myapp 1.0 const AFTER_HELP_NO_ARGS: &str = "myapp 1.0
USAGE: Usage:
myapp myapp
This is after help. This is after help.
@ -2061,10 +2061,10 @@ fn help_subcmd_help() {
static HELP_SUBCMD_HELP: &str = "myapp-help static HELP_SUBCMD_HELP: &str = "myapp-help
Print this message or the help of the given subcommand(s) Print this message or the help of the given subcommand(s)
USAGE: Usage:
myapp help [SUBCOMMAND]... myapp help [SUBCOMMAND]...
ARGS: Arguments:
[SUBCOMMAND]... The subcommand whose help message to display [SUBCOMMAND]... The subcommand whose help message to display
"; ";
@ -2079,10 +2079,10 @@ fn subcmd_help_subcmd_help() {
static SUBCMD_HELP_SUBCMD_HELP: &str = "myapp-subcmd-help static SUBCMD_HELP_SUBCMD_HELP: &str = "myapp-subcmd-help
Print this message or the help of the given subcommand(s) Print this message or the help of the given subcommand(s)
USAGE: Usage:
myapp subcmd help [SUBCOMMAND]... myapp subcmd help [SUBCOMMAND]...
ARGS: Arguments:
[SUBCOMMAND]... The subcommand whose help message to display [SUBCOMMAND]... The subcommand whose help message to display
"; ";
@ -2101,10 +2101,10 @@ ARGS:
fn option_usage_order() { fn option_usage_order() {
static OPTION_USAGE_ORDER: &str = "order static OPTION_USAGE_ORDER: &str = "order
USAGE: Usage:
order [OPTIONS] order [OPTIONS]
OPTIONS: Options:
-a -a
-B -B
-b -b
@ -2136,13 +2136,13 @@ OPTIONS:
fn prefer_about_over_long_about_in_subcommands_list() { fn prefer_about_over_long_about_in_subcommands_list() {
static ABOUT_IN_SUBCOMMANDS_LIST: &str = "about-in-subcommands-list static ABOUT_IN_SUBCOMMANDS_LIST: &str = "about-in-subcommands-list
USAGE: Usage:
about-in-subcommands-list [SUBCOMMAND] about-in-subcommands-list [SUBCOMMAND]
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
SUBCOMMANDS: Subcommands:
sub short about sub sub short about sub
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
"; ";
@ -2165,14 +2165,14 @@ SUBCOMMANDS:
fn issue_1794_usage() { fn issue_1794_usage() {
static USAGE_WITH_GROUP: &str = "hello static USAGE_WITH_GROUP: &str = "hello
USAGE: Usage:
deno <pos1|--option1> [pos2] deno <pos1|--option1> [pos2]
ARGS: Arguments:
<pos1> <pos1>
<pos2> <pos2>
OPTIONS: Options:
--option1 --option1
-h, --help Print help information -h, --help Print help information
"; ";
@ -2197,13 +2197,13 @@ OPTIONS:
static CUSTOM_HEADING_POS: &str = "test 1.4 static CUSTOM_HEADING_POS: &str = "test 1.4
USAGE: Usage:
test [ARGS] test [ARGS]
ARGS: Arguments:
<gear> Which gear <gear> Which gear
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -2224,7 +2224,7 @@ fn custom_heading_pos() {
static ONLY_CUSTOM_HEADING_OPTS_NO_ARGS: &str = "test 1.4 static ONLY_CUSTOM_HEADING_OPTS_NO_ARGS: &str = "test 1.4
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
NETWORKING: NETWORKING:
@ -2246,7 +2246,7 @@ fn only_custom_heading_opts_no_args() {
static ONLY_CUSTOM_HEADING_POS_NO_ARGS: &str = "test 1.4 static ONLY_CUSTOM_HEADING_POS_NO_ARGS: &str = "test 1.4
USAGE: Usage:
test [speed] test [speed]
NETWORKING: NETWORKING:
@ -2281,10 +2281,10 @@ fn issue_2508_number_of_values_with_single_value_name() {
"my_app --help", "my_app --help",
"my_app "my_app
USAGE: Usage:
my_app [OPTIONS] my_app [OPTIONS]
OPTIONS: Options:
--some_arg <some_arg> <some_arg> --some_arg <some_arg> <some_arg>
--some_arg_issue <ARG> <ARG> --some_arg_issue <ARG> <ARG>
-h, --help Print help information -h, --help Print help information
@ -2304,14 +2304,14 @@ fn missing_positional_final_required() {
"test --help", "test --help",
"test "test
USAGE: Usage:
test [arg1] <arg2> test [arg1] <arg2>
ARGS: Arguments:
<arg1> <arg1>
<arg2> <arg2>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
", ",
false, false,
@ -2330,15 +2330,15 @@ fn missing_positional_final_multiple() {
"test --help", "test --help",
"test "test
USAGE: Usage:
test [ARGS] test [ARGS]
ARGS: Arguments:
<foo> <foo>
<bar> <bar>
<baz>... <baz>...
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
", ",
false, false,
@ -2358,13 +2358,13 @@ fn positional_multiple_values_is_dotted() {
"test --help", "test --help",
"test "test
USAGE: Usage:
test <foo>... test <foo>...
ARGS: Arguments:
<foo>... <foo>...
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
", ",
false, false,
@ -2382,13 +2382,13 @@ OPTIONS:
"test --help", "test --help",
"test "test
USAGE: Usage:
test <BAR>... test <BAR>...
ARGS: Arguments:
<BAR>... <BAR>...
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
", ",
false, false,
@ -2409,13 +2409,13 @@ fn positional_multiple_occurrences_is_dotted() {
"test --help", "test --help",
"test "test
USAGE: Usage:
test <foo>... test <foo>...
ARGS: Arguments:
<foo>... <foo>...
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
", ",
false, false,
@ -2434,13 +2434,13 @@ OPTIONS:
"test --help", "test --help",
"test "test
USAGE: Usage:
test <BAR>... test <BAR>...
ARGS: Arguments:
<BAR>... <BAR>...
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
", ",
false, false,
@ -2462,10 +2462,10 @@ fn too_few_value_names_is_dotted() {
"test --help", "test --help",
"test "test
USAGE: Usage:
test --foo <one> <two>... test --foo <one> <two>...
OPTIONS: Options:
--foo <one> <two>... --foo <one> <two>...
-h, --help Print help information -h, --help Print help information
", ",
@ -2565,10 +2565,10 @@ fn subcommand_help_doesnt_have_useless_help_flag() {
"example-help "example-help
Print this message or the help of the given subcommand(s) Print this message or the help of the given subcommand(s)
USAGE: Usage:
example help [SUBCOMMAND]... example help [SUBCOMMAND]...
ARGS: Arguments:
[SUBCOMMAND]... The subcommand whose help message to display [SUBCOMMAND]... The subcommand whose help message to display
", ",
false, false,
@ -2608,10 +2608,10 @@ fn dont_propagate_version_to_help_subcommand() {
"example-help "example-help
Print this message or the help of the given subcommand(s) Print this message or the help of the given subcommand(s)
USAGE: Usage:
example help [SUBCOMMAND]... example help [SUBCOMMAND]...
ARGS: Arguments:
[SUBCOMMAND]... The subcommand whose help message to display [SUBCOMMAND]... The subcommand whose help message to display
", ",
false, false,
@ -2643,10 +2643,10 @@ fn parent_cmd_req_in_usage_with_help_flag() {
static EXPECTED: &str = "parent-test static EXPECTED: &str = "parent-test
some some
USAGE: Usage:
parent <TARGET> <ARGS> test parent <TARGET> <ARGS> test
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
"; ";
let cmd = Command::new("parent") let cmd = Command::new("parent")
@ -2667,10 +2667,10 @@ fn parent_cmd_req_in_usage_with_help_subcommand() {
static EXPECTED: &str = "parent-test static EXPECTED: &str = "parent-test
some some
USAGE: Usage:
parent <TARGET> <ARGS> test parent <TARGET> <ARGS> test
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
"; ";
let cmd = Command::new("parent") let cmd = Command::new("parent")
@ -2691,10 +2691,10 @@ fn parent_cmd_req_in_usage_with_render_help() {
static EXPECTED: &str = "parent-test static EXPECTED: &str = "parent-test
some some
USAGE: Usage:
parent <TARGET> <ARGS> test parent <TARGET> <ARGS> test
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
"; ";
let mut cmd = Command::new("parent") let mut cmd = Command::new("parent")

32
tests/builder/help_env.rs
View file

@ -8,10 +8,10 @@ use super::utils;
static HIDE_ENV: &str = "ctest 0.1 static HIDE_ENV: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-c, --cafe <FILE> A coffeehouse, coffee shop, or café. -c, --cafe <FILE> A coffeehouse, coffee shop, or café.
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -19,10 +19,10 @@ OPTIONS:
static SHOW_ENV: &str = "ctest 0.1 static SHOW_ENV: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-c, --cafe <FILE> A coffeehouse, coffee shop, or café. [env: ENVVAR=MYVAL] -c, --cafe <FILE> A coffeehouse, coffee shop, or café. [env: ENVVAR=MYVAL]
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -30,10 +30,10 @@ OPTIONS:
static HIDE_ENV_VALS: &str = "ctest 0.1 static HIDE_ENV_VALS: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-c, --cafe <FILE> A coffeehouse, coffee shop, or café. [env: ENVVAR] -c, --cafe <FILE> A coffeehouse, coffee shop, or café. [env: ENVVAR]
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -41,10 +41,10 @@ OPTIONS:
static SHOW_ENV_VALS: &str = "ctest 0.1 static SHOW_ENV_VALS: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-c, --cafe <FILE> A coffeehouse, coffee shop, or café. [env: ENVVAR=MYVAL] -c, --cafe <FILE> A coffeehouse, coffee shop, or café. [env: ENVVAR=MYVAL]
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -52,10 +52,10 @@ OPTIONS:
static HIDE_ENV_FLAG: &str = "ctest 0.1 static HIDE_ENV_FLAG: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-c, --cafe A coffeehouse, coffee shop, or café. -c, --cafe A coffeehouse, coffee shop, or café.
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -63,10 +63,10 @@ OPTIONS:
static SHOW_ENV_FLAG: &str = "ctest 0.1 static SHOW_ENV_FLAG: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-c, --cafe A coffeehouse, coffee shop, or café. [env: ENVVAR=MYVAL] -c, --cafe A coffeehouse, coffee shop, or café. [env: ENVVAR=MYVAL]
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -74,10 +74,10 @@ OPTIONS:
static HIDE_ENV_VALS_FLAG: &str = "ctest 0.1 static HIDE_ENV_VALS_FLAG: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-c, --cafe A coffeehouse, coffee shop, or café. [env: ENVVAR] -c, --cafe A coffeehouse, coffee shop, or café. [env: ENVVAR]
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -85,10 +85,10 @@ OPTIONS:
static SHOW_ENV_VALS_FLAG: &str = "ctest 0.1 static SHOW_ENV_VALS_FLAG: &str = "ctest 0.1
USAGE: Usage:
ctest [OPTIONS] ctest [OPTIONS]
OPTIONS: Options:
-c, --cafe A coffeehouse, coffee shop, or café. [env: ENVVAR=MYVAL] -c, --cafe A coffeehouse, coffee shop, or café. [env: ENVVAR=MYVAL]
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information

36
tests/builder/hidden_args.rs
View file

@ -6,10 +6,10 @@ static HIDDEN_ARGS: &str = "test 1.4
Kevin K. Kevin K.
tests stuff tests stuff
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
-F, --flag2 some other flag -F, --flag2 some other flag
--option <opt> some option --option <opt> some option
-h, --help Print help information -h, --help Print help information
@ -35,10 +35,10 @@ static HIDDEN_SHORT_ARGS: &str = "test 2.31.2
Steve P. Steve P.
hides short args hides short args
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
-v, --visible This text should be visible -v, --visible This text should be visible
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
@ -75,10 +75,10 @@ fn hide_short_args_long_help() {
Steve P. Steve P.
hides short args hides short args
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
-c, --config -c, --config
Some help text describing the --config arg Some help text describing the --config arg
@ -117,10 +117,10 @@ static HIDDEN_LONG_ARGS: &str = "test 2.31.2
Steve P. Steve P.
hides long args hides long args
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
-v, --visible -v, --visible
This text should be visible This text should be visible
@ -158,10 +158,10 @@ static HIDDEN_LONG_ARGS_SHORT_HELP: &str = "test 2.31.2
Steve P. Steve P.
hides long args hides long args
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
-c, --config Some help text describing the --config arg -c, --config Some help text describing the --config arg
-v, --visible This text should be visible -v, --visible This text should be visible
-h, --help Print help information -h, --help Print help information
@ -193,13 +193,13 @@ fn hide_long_args_short_help() {
static HIDDEN_POS_ARGS: &str = "test 1.4 static HIDDEN_POS_ARGS: &str = "test 1.4
USAGE: Usage:
test [another] test [another]
ARGS: Arguments:
<another> another pos <another> another pos
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -216,10 +216,10 @@ fn hide_pos_args() {
static HIDDEN_SUBCMDS: &str = "test 1.4 static HIDDEN_SUBCMDS: &str = "test 1.4
USAGE: Usage:
test test
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -235,7 +235,7 @@ fn hide_subcmds() {
static HIDDEN_OPT_ARGS_ONLY: &str = "test 1.4 static HIDDEN_OPT_ARGS_ONLY: &str = "test 1.4
USAGE: Usage:
test test
After help After help
@ -261,7 +261,7 @@ fn hide_opt_args_only() {
static HIDDEN_POS_ARGS_ONLY: &str = "test 1.4 static HIDDEN_POS_ARGS_ONLY: &str = "test 1.4
USAGE: Usage:
test test
After help After help
@ -283,7 +283,7 @@ fn hide_pos_args_only() {
static HIDDEN_SUBCMDS_ONLY: &str = "test 1.4 static HIDDEN_SUBCMDS_ONLY: &str = "test 1.4
USAGE: Usage:
test test
After help After help

4
tests/builder/multiple_values.rs
View file

@ -431,10 +431,10 @@ fn optional_value() {
const HELP: &str = "\ const HELP: &str = "\
test test
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
-p [<NUM>] -p [<NUM>]
-h, --help Print help information -h, --help Print help information
"; ";

6
tests/builder/opts.rs
View file

@ -10,7 +10,7 @@ static DYM: &str =
\tIf you tried to supply `--optio` as a value rather than a flag, use `-- --optio` \tIf you tried to supply `--optio` as a value rather than a flag, use `-- --optio`
USAGE: Usage:
clap-test --option <opt>... clap-test --option <opt>...
For more information try --help For more information try --help
@ -24,7 +24,7 @@ static DYM_ISSUE_1073: &str =
\tIf you tried to supply `--files-without-matches` as a value rather than a flag, use `-- --files-without-matches` \tIf you tried to supply `--files-without-matches` as a value rather than a flag, use `-- --files-without-matches`
USAGE: Usage:
ripgrep-616 --files-without-match ripgrep-616 --files-without-match
For more information try --help For more information try --help
@ -50,7 +50,7 @@ fn require_equals_fail_message() {
static NO_EQUALS: &str = static NO_EQUALS: &str =
"error: Equal sign is needed when assigning values to '--config=<cfg>'. "error: Equal sign is needed when assigning values to '--config=<cfg>'.
USAGE: Usage:
prog [OPTIONS] prog [OPTIONS]
For more information try --help For more information try --help

10
tests/builder/positionals.rs
View file

@ -211,13 +211,13 @@ fn positional_hyphen_does_not_panic() {
#[test] #[test]
fn single_positional_usage_string() { fn single_positional_usage_string() {
let mut cmd = Command::new("test").arg(arg!([FILE] "some file")); let mut cmd = Command::new("test").arg(arg!([FILE] "some file"));
assert_eq!(cmd.render_usage(), "USAGE:\n test [FILE]"); assert_eq!(cmd.render_usage(), "Usage:\n test [FILE]");
} }
#[test] #[test]
fn single_positional_multiple_usage_string() { fn single_positional_multiple_usage_string() {
let mut cmd = Command::new("test").arg(arg!([FILE]... "some file")); let mut cmd = Command::new("test").arg(arg!([FILE]... "some file"));
assert_eq!(cmd.render_usage(), "USAGE:\n test [FILE]..."); assert_eq!(cmd.render_usage(), "Usage:\n test [FILE]...");
} }
#[test] #[test]
@ -225,7 +225,7 @@ fn multiple_positional_usage_string() {
let mut cmd = Command::new("test") let mut cmd = Command::new("test")
.arg(arg!([FILE] "some file")) .arg(arg!([FILE] "some file"))
.arg(arg!([FILES]... "some file")); .arg(arg!([FILES]... "some file"));
assert_eq!(cmd.render_usage(), "USAGE:\n test [ARGS]"); assert_eq!(cmd.render_usage(), "Usage:\n test [ARGS]");
} }
#[test] #[test]
@ -233,13 +233,13 @@ fn multiple_positional_one_required_usage_string() {
let mut cmd = Command::new("test") let mut cmd = Command::new("test")
.arg(arg!(<FILE> "some file")) .arg(arg!(<FILE> "some file"))
.arg(arg!([FILES]... "some file")); .arg(arg!([FILES]... "some file"));
assert_eq!(cmd.render_usage(), "USAGE:\n test <FILE> [FILES]..."); assert_eq!(cmd.render_usage(), "Usage:\n test <FILE> [FILES]...");
} }
#[test] #[test]
fn single_positional_required_usage_string() { fn single_positional_required_usage_string() {
let mut cmd = Command::new("test").arg(arg!(<FILE> "some file")); let mut cmd = Command::new("test").arg(arg!(<FILE> "some file"));
assert_eq!(cmd.render_usage(), "USAGE:\n test <FILE>"); assert_eq!(cmd.render_usage(), "Usage:\n test <FILE>");
} }
// This tests a programmer error and will only succeed with debug_assertions // This tests a programmer error and will only succeed with debug_assertions

24
tests/builder/require.rs
View file

@ -6,7 +6,7 @@ use clap::{arg, error::ErrorKind, Arg, ArgAction, ArgGroup, Command};
static REQUIRE_EQUALS: &str = "error: The following required arguments were not provided: static REQUIRE_EQUALS: &str = "error: The following required arguments were not provided:
--opt=<FILE> --opt=<FILE>
USAGE: Usage:
clap-test --opt=<FILE> clap-test --opt=<FILE>
For more information try --help For more information try --help
@ -15,7 +15,7 @@ For more information try --help
static REQUIRE_EQUALS_FILTERED: &str = "error: The following required arguments were not provided: static REQUIRE_EQUALS_FILTERED: &str = "error: The following required arguments were not provided:
--opt=<FILE> --opt=<FILE>
USAGE: Usage:
clap-test --opt=<FILE> --foo=<FILE> clap-test --opt=<FILE> --foo=<FILE>
For more information try --help For more information try --help
@ -25,7 +25,7 @@ static REQUIRE_EQUALS_FILTERED_GROUP: &str =
"error: The following required arguments were not provided: "error: The following required arguments were not provided:
--opt=<FILE> --opt=<FILE>
USAGE: Usage:
clap-test --opt=<FILE> --foo=<FILE> <--g1=<FILE>|--g2=<FILE>> clap-test --opt=<FILE> --foo=<FILE> <--g1=<FILE>|--g2=<FILE>>
For more information try --help For more information try --help
@ -35,7 +35,7 @@ static MISSING_REQ: &str = "error: The following required arguments were not pro
--long-option-2 <option2> --long-option-2 <option2>
<positional2> <positional2>
USAGE: Usage:
clap-test --long-option-2 <option2> -F <positional2> clap-test --long-option-2 <option2> -F <positional2>
For more information try --help For more information try --help
@ -44,7 +44,7 @@ For more information try --help
static COND_REQ_IN_USAGE: &str = "error: The following required arguments were not provided: static COND_REQ_IN_USAGE: &str = "error: The following required arguments were not provided:
--output <output> --output <output>
USAGE: Usage:
test --target <target> --input <input> --output <output> test --target <target> --input <input> --output <output>
For more information try --help For more information try --help
@ -140,7 +140,7 @@ static POSITIONAL_REQ: &str = "error: The following required arguments were not
<flag> <flag>
<opt> <opt>
USAGE: Usage:
clap-test <flag> <opt> [ARGS] clap-test <flag> <opt> [ARGS]
For more information try --help For more information try --help
@ -159,7 +159,7 @@ fn positional_required_with_requires_if_no_value() {
static POSITIONAL_REQ_IF_NO_VAL: &str = "error: The following required arguments were not provided: static POSITIONAL_REQ_IF_NO_VAL: &str = "error: The following required arguments were not provided:
<flag> <flag>
USAGE: Usage:
clap-test <flag> [ARGS] clap-test <flag> [ARGS]
For more information try --help For more information try --help
@ -180,7 +180,7 @@ static POSITIONAL_REQ_IF_VAL: &str = "error: The following required arguments we
<foo> <foo>
<opt> <opt>
USAGE: Usage:
clap-test <flag> <foo> <opt> clap-test <flag> <foo> <opt>
For more information try --help For more information try --help
@ -1030,7 +1030,7 @@ static ISSUE_1158: &str = "error: The following required arguments were not prov
-y <Y> -y <Y>
-z <Z> -z <Z>
USAGE: Usage:
example -x <X> -y <Y> -z <Z> <ID> example -x <X> -y <Y> -z <Z> <ID>
For more information try --help For more information try --help
@ -1066,7 +1066,7 @@ fn multiple_required_unless_usage_printing() {
--a <a> --a <a>
--b <b> --b <b>
USAGE: Usage:
test --c <c> --a <a> --b <b> test --c <c> --a <a> --b <b>
For more information try --help For more information try --help
@ -1434,7 +1434,7 @@ fn required_error_doesnt_duplicate() {
const EXPECTED: &str = "\ const EXPECTED: &str = "\
error: The argument '-b <b>' cannot be used with '-c <c>' error: The argument '-b <b>' cannot be used with '-c <c>'
USAGE: Usage:
clap-test -b <b> <a> clap-test -b <b> <a>
For more information try --help For more information try --help
@ -1457,7 +1457,7 @@ fn required_require_with_group_shows_flag() {
error: The following required arguments were not provided: error: The following required arguments were not provided:
--first --first
USAGE: Usage:
test --require-first <--first|--second> test --require-first <--first|--second>
For more information try --help For more information try --help

48
tests/builder/subcommands.rs
View file

@ -4,28 +4,28 @@ use clap::{arg, error::ErrorKind, Arg, ArgAction, Command};
static VISIBLE_ALIAS_HELP: &str = "clap-test 2.6 static VISIBLE_ALIAS_HELP: &str = "clap-test 2.6
USAGE: Usage:
clap-test [SUBCOMMAND] clap-test [SUBCOMMAND]
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
test Some help [aliases: dongle, done] test Some help [aliases: dongle, done]
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
"; ";
static INVISIBLE_ALIAS_HELP: &str = "clap-test 2.6 static INVISIBLE_ALIAS_HELP: &str = "clap-test 2.6
USAGE: Usage:
clap-test [SUBCOMMAND] clap-test [SUBCOMMAND]
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
test Some help test Some help
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
"; ";
@ -37,7 +37,7 @@ static DYM_SUBCMD: &str = "error: The subcommand 'subcm' wasn't recognized
If you believe you received this message in error, try re-running with 'dym -- subcm' If you believe you received this message in error, try re-running with 'dym -- subcm'
USAGE: Usage:
dym [SUBCOMMAND] dym [SUBCOMMAND]
For more information try --help For more information try --help
@ -50,7 +50,7 @@ static DYM_SUBCMD_AMBIGUOUS: &str = "error: The subcommand 'te' wasn't recognize
If you believe you received this message in error, try re-running with 'dym -- te' If you believe you received this message in error, try re-running with 'dym -- te'
USAGE: Usage:
dym [SUBCOMMAND] dym [SUBCOMMAND]
For more information try --help For more information try --help
@ -61,7 +61,7 @@ static SUBCMD_AFTER_DOUBLE_DASH: &str =
\tIf you tried to supply `subcmd` as a subcommand, remove the '--' before it. \tIf you tried to supply `subcmd` as a subcommand, remove the '--' before it.
USAGE: Usage:
cmd [SUBCOMMAND] cmd [SUBCOMMAND]
For more information try --help For more information try --help
@ -183,7 +183,7 @@ fn subcmd_did_you_mean_output_arg() {
\tIf you tried to supply `--subcmarg` as a value rather than a flag, use `-- --subcmarg` \tIf you tried to supply `--subcmarg` as a value rather than a flag, use `-- --subcmarg`
USAGE: Usage:
dym [SUBCOMMAND] dym [SUBCOMMAND]
For more information try --help For more information try --help
@ -204,7 +204,7 @@ fn subcmd_did_you_mean_output_arg_false_positives() {
\tIf you tried to supply `--subcmarg` as a value rather than a flag, use `-- --subcmarg` \tIf you tried to supply `--subcmarg` as a value rather than a flag, use `-- --subcmarg`
USAGE: Usage:
dym [SUBCOMMAND] dym [SUBCOMMAND]
For more information try --help For more information try --help
@ -358,7 +358,7 @@ fn subcommand_placeholder_test() {
.subcommand_value_name("TEST_PLACEHOLDER") .subcommand_value_name("TEST_PLACEHOLDER")
.subcommand_help_heading("TEST_HEADER"); .subcommand_help_heading("TEST_HEADER");
assert_eq!(&cmd.render_usage(), "USAGE:\n myprog [TEST_PLACEHOLDER]"); assert_eq!(&cmd.render_usage(), "Usage:\n myprog [TEST_PLACEHOLDER]");
let mut help_text = Vec::new(); let mut help_text = Vec::new();
cmd.write_help(&mut help_text) cmd.write_help(&mut help_text)
@ -440,7 +440,7 @@ fn subcommand_not_recognized() {
"fake help", "fake help",
"error: The subcommand 'help' wasn't recognized "error: The subcommand 'help' wasn't recognized
USAGE: Usage:
fake [SUBCOMMAND] fake [SUBCOMMAND]
For more information try --help For more information try --help
@ -517,7 +517,7 @@ fn bad_multicall_command_error() {
static HELLO_EXPECTED: &str = "\ static HELLO_EXPECTED: &str = "\
error: The subcommand 'world' wasn't recognized error: The subcommand 'world' wasn't recognized
USAGE: Usage:
<SUBCOMMAND> <SUBCOMMAND>
For more information try help For more information try help
@ -535,7 +535,7 @@ error: The subcommand 'baz' wasn't recognized
If you believe you received this message in error, try re-running with ' -- baz' If you believe you received this message in error, try re-running with ' -- baz'
USAGE: Usage:
<SUBCOMMAND> <SUBCOMMAND>
For more information try help For more information try help
@ -576,13 +576,13 @@ fn multicall_help_flag() {
static EXPECTED: &str = "\ static EXPECTED: &str = "\
foo-bar 1.0.0 foo-bar 1.0.0
USAGE: Usage:
foo bar [value] foo bar [value]
ARGS: Arguments:
<value> <value>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -599,13 +599,13 @@ fn multicall_help_subcommand() {
static EXPECTED: &str = "\ static EXPECTED: &str = "\
foo-bar 1.0.0 foo-bar 1.0.0
USAGE: Usage:
foo bar [value] foo bar [value]
ARGS: Arguments:
<value> <value>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";
@ -622,13 +622,13 @@ fn multicall_render_help() {
static EXPECTED: &str = "\ static EXPECTED: &str = "\
foo-bar 1.0.0 foo-bar 1.0.0
USAGE: Usage:
foo bar [value] foo bar [value]
ARGS: Arguments:
<value> <value>
OPTIONS: Options:
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
"; ";

26
tests/builder/template_help.rs
View file

@ -6,7 +6,7 @@ static EXAMPLE1_TMPL_S: &str = "{bin} {version}
{author} {author}
{about} {about}
USAGE: Usage:
{usage} {usage}
{all-args}"; {all-args}";
@ -15,31 +15,31 @@ static EXAMPLE1_TMPS_F: &str = "{bin} {version}
{author} {author}
{about} {about}
USAGE: Usage:
{usage} {usage}
OPTIONS: Options:
{options} {options}
ARGS: Arguments:
{positionals} {positionals}
SUBCOMMANDS: Subcommands:
{subcommands}"; {subcommands}";
static CUSTOM_TEMPL_HELP: &str = "MyApp 1.0 static CUSTOM_TEMPL_HELP: &str = "MyApp 1.0
Kevin K. <kbknapp@gmail.com> Kevin K. <kbknapp@gmail.com>
Does awesome things Does awesome things
USAGE: Usage:
MyApp [OPTIONS] <output> [SUBCOMMAND] MyApp [OPTIONS] <output> [SUBCOMMAND]
OPTIONS: Options:
-c, --config <FILE> Sets a custom config file -c, --config <FILE> Sets a custom config file
-d... Turn debugging information on -d... Turn debugging information on
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
ARGS: Arguments:
<output> Sets an optional output file <output> Sets an optional output file
SUBCOMMANDS: Subcommands:
test does testing things test does testing things
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
"; ";
@ -48,19 +48,19 @@ static SIMPLE_TEMPLATE: &str = "MyApp 1.0
Kevin K. <kbknapp@gmail.com> Kevin K. <kbknapp@gmail.com>
Does awesome things Does awesome things
USAGE: Usage:
MyApp [OPTIONS] <output> [SUBCOMMAND] MyApp [OPTIONS] <output> [SUBCOMMAND]
ARGS: Arguments:
<output> Sets an optional output file <output> Sets an optional output file
OPTIONS: Options:
-c, --config <FILE> Sets a custom config file -c, --config <FILE> Sets a custom config file
-d... Turn debugging information on -d... Turn debugging information on
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
test does testing things test does testing things
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
"; ";

2
tests/derive/author_version_about.rs
View file

@ -23,7 +23,7 @@ fn no_author_version_about() {
struct Opt {} struct Opt {}
let output = utils::get_long_help::<Opt>(); let output = utils::get_long_help::<Opt>();
assert!(output.starts_with("foo \n\nUSAGE:")); assert!(output.starts_with("foo \n\nUsage:"));
} }
#[test] #[test]

10
tests/derive/doc_comments_help.rs
View file

@ -59,7 +59,15 @@ fn empty_line_in_doc_comment_is_double_linefeed() {
struct LoremIpsum {} struct LoremIpsum {}
let help = utils::get_long_help::<LoremIpsum>(); let help = utils::get_long_help::<LoremIpsum>();
assert!(help.starts_with("lorem-ipsum \nFoo.\n\nBar\n\nUSAGE:")); assert!(help.starts_with(
"\
lorem-ipsum
Foo.
Bar
Usage:"
));
} }
#[test] #[test]

20
tests/derive/help.rs
View file

@ -220,7 +220,7 @@ fn derive_generated_error_has_full_context() {
let expected = r#"error: The following required argument was not provided: req_str let expected = r#"error: The following required argument was not provided: req_str
USAGE: Usage:
clap --req-str <REQ_STR> clap --req-str <REQ_STR>
clap <SUBCOMMAND> clap <SUBCOMMAND>
@ -233,10 +233,10 @@ For more information try --help
fn derive_order_next_order() { fn derive_order_next_order() {
static HELP: &str = "test 1.2 static HELP: &str = "test 1.2
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
--flag-b first flag --flag-b first flag
--option-b <OPTION_B> first option --option-b <OPTION_B> first option
-h, --help Print help information -h, --help Print help information
@ -289,10 +289,10 @@ OPTIONS:
fn derive_order_next_order_flatten() { fn derive_order_next_order_flatten() {
static HELP: &str = "test 1.2 static HELP: &str = "test 1.2
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
--flag-b first flag --flag-b first flag
--option-b <OPTION_B> first option --option-b <OPTION_B> first option
-h, --help Print help information -h, --help Print help information
@ -345,10 +345,10 @@ OPTIONS:
fn derive_order_no_next_order() { fn derive_order_no_next_order() {
static HELP: &str = "test 1.2 static HELP: &str = "test 1.2
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
--flag-a first flag --flag-a first flag
--flag-b second flag --flag-b second flag
-h, --help Print help information -h, --help Print help information
@ -401,10 +401,10 @@ fn derive_possible_value_help() {
static HELP: &str = "clap static HELP: &str = "clap
Application help Application help
USAGE: Usage:
clap <ARG> clap <ARG>
ARGS: Arguments:
<ARG> <ARG>
Argument help Argument help
@ -412,7 +412,7 @@ ARGS:
- foo: Foo help - foo: Foo help
- bar: Bar help - bar: Bar help
OPTIONS: Options:
-h, --help -h, --help
Print help information Print help information
"; ";

4
tests/macros.rs
View file

@ -303,10 +303,10 @@ mod arg {
const HELP: &str = "\ const HELP: &str = "\
test test
USAGE: Usage:
test [OPTIONS] test [OPTIONS]
OPTIONS: Options:
-p [<NUM>] -p [<NUM>]
-h, --help Print help information -h, --help Print help information
"; ";

6
tests/ui/arg_required_else_help_stderr.toml
View file

@ -5,15 +5,15 @@ stdout = ""
stderr = """ stderr = """
stdio-fixture 1.0 stdio-fixture 1.0
USAGE: Usage:
stdio-fixture[EXE] [OPTIONS] [SUBCOMMAND] stdio-fixture[EXE] [OPTIONS] [SUBCOMMAND]
OPTIONS: Options:
--verbose log --verbose log
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
more more
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
""" """

2
tests/ui/error_stderr.toml
View file

@ -7,7 +7,7 @@ error: Found argument '--unknown-argument' which wasn't expected, or isn't valid
\tIf you tried to supply `--unknown-argument` as a value rather than a flag, use `-- --unknown-argument` \tIf you tried to supply `--unknown-argument` as a value rather than a flag, use `-- --unknown-argument`
USAGE: Usage:
stdio-fixture[EXE] [OPTIONS] [SUBCOMMAND] stdio-fixture[EXE] [OPTIONS] [SUBCOMMAND]
For more information try --help For more information try --help

6
tests/ui/h_flag_stdout.toml
View file

@ -4,15 +4,15 @@ status.code = 0
stdout = """ stdout = """
stdio-fixture 1.0 stdio-fixture 1.0
USAGE: Usage:
stdio-fixture[EXE] [OPTIONS] [SUBCOMMAND] stdio-fixture[EXE] [OPTIONS] [SUBCOMMAND]
OPTIONS: Options:
--verbose log --verbose log
-h, --help Print help information -h, --help Print help information
-V, --version Print version information -V, --version Print version information
SUBCOMMANDS: Subcommands:
more more
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
""" """

6
tests/ui/help_cmd_stdout.toml
View file

@ -4,10 +4,10 @@ status.code = 0
stdout = """ stdout = """
stdio-fixture 1.0 stdio-fixture 1.0
USAGE: Usage:
stdio-fixture[EXE] [OPTIONS] [SUBCOMMAND] stdio-fixture[EXE] [OPTIONS] [SUBCOMMAND]
OPTIONS: Options:
--verbose --verbose
more log more log
@ -17,7 +17,7 @@ OPTIONS:
-V, --version -V, --version
Print version information Print version information
SUBCOMMANDS: Subcommands:
more more
help help

6
tests/ui/help_flag_stdout.toml
View file

@ -4,10 +4,10 @@ status.code = 0
stdout = """ stdout = """
stdio-fixture 1.0 stdio-fixture 1.0
USAGE: Usage:
stdio-fixture[EXE] [OPTIONS] [SUBCOMMAND] stdio-fixture[EXE] [OPTIONS] [SUBCOMMAND]
OPTIONS: Options:
--verbose --verbose
more log more log
@ -17,7 +17,7 @@ OPTIONS:
-V, --version -V, --version
Print version information Print version information
SUBCOMMANDS: Subcommands:
more more
help help