mirror of
https://github.com/clap-rs/clap
synced 2024-12-12 22:02:35 +00:00
7110401595
This just affects how it's rendered; rather than attempting to highlight these blocks as a shell script, they'll get highlighted as console output. See the rendered versions for a better comparison.
65 lines
1.3 KiB
Markdown
65 lines
1.3 KiB
Markdown
*Jump to [source](escaped-positional.rs)*
|
|
|
|
**This requires enabling the `cargo` feature flag.**
|
|
|
|
You can use `--` to escape further arguments.
|
|
|
|
Let's see what this looks like in the help:
|
|
```console
|
|
$ escaped-positional --help
|
|
clap [..]
|
|
A simple to use, efficient, and full-featured Command Line Argument Parser
|
|
|
|
USAGE:
|
|
escaped-positional[EXE] [OPTIONS] [-- <SLOP>...]
|
|
|
|
ARGS:
|
|
<SLOP>...
|
|
|
|
OPTIONS:
|
|
-f
|
|
-h, --help Print help information
|
|
-p <PEAR>
|
|
-V, --version Print version information
|
|
|
|
```
|
|
|
|
Here is a baseline without any arguments:
|
|
```console
|
|
$ escaped-positional
|
|
-f used: false
|
|
-p's value: None
|
|
'slops' values: []
|
|
|
|
```
|
|
|
|
Notice that we can't pass positional arguments before `--`:
|
|
```console
|
|
$ escaped-positional foo bar
|
|
? failed
|
|
error: Found argument 'foo' which wasn't expected, or isn't valid in this context
|
|
|
|
USAGE:
|
|
escaped-positional[EXE] [OPTIONS] [-- <SLOP>...]
|
|
|
|
For more information try --help
|
|
|
|
```
|
|
|
|
But you can after:
|
|
```console
|
|
$ escaped-positional -f -p=bob -- sloppy slop slop
|
|
-f used: true
|
|
-p's value: Some("bob")
|
|
'slops' values: ["sloppy", "slop", "slop"]
|
|
|
|
```
|
|
|
|
As mentioned, the parser will directly pass everything through:
|
|
```console
|
|
$ escaped-positional -- -f -p=bob sloppy slop slop
|
|
-f used: false
|
|
-p's value: None
|
|
'slops' values: ["-f", "-p=bob", "sloppy", "slop", "slop"]
|
|
|
|
```
|