summaryrefslogtreecommitdiffstats
path: root/vendor/clap-3.2.20/examples/escaped-positional-derive.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/clap-3.2.20/examples/escaped-positional-derive.md')
-rw-r--r--vendor/clap-3.2.20/examples/escaped-positional-derive.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/vendor/clap-3.2.20/examples/escaped-positional-derive.md b/vendor/clap-3.2.20/examples/escaped-positional-derive.md
new file mode 100644
index 000000000..fa39a2c03
--- /dev/null
+++ b/vendor/clap-3.2.20/examples/escaped-positional-derive.md
@@ -0,0 +1,63 @@
+**This requires enabling the [`derive` feature flag][crate::_features].**
+
+You can use `--` to escape further arguments.
+
+Let's see what this looks like in the help:
+```console
+$ escaped-positional-derive --help
+clap [..]
+A simple to use, efficient, and full-featured Command Line Argument Parser
+
+USAGE:
+ escaped-positional-derive[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-derive
+-f used: false
+-p's value: None
+'slops' values: []
+
+```
+
+Notice that we can't pass positional arguments before `--`:
+```console
+$ escaped-positional-derive foo bar
+? failed
+error: Found argument 'foo' which wasn't expected, or isn't valid in this context
+
+USAGE:
+ escaped-positional-derive[EXE] [OPTIONS] [-- <SLOP>...]
+
+For more information try --help
+
+```
+
+But you can after:
+```console
+$ escaped-positional-derive -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-derive -- -f -p=bob sloppy slop slop
+-f used: false
+-p's value: None
+'slops' values: ["-f", "-p=bob", "sloppy", "slop", "slop"]
+
+```