summaryrefslogtreecommitdiffstats
path: root/vendor/clap-3.2.20/examples/multicall-busybox.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/clap-3.2.20/examples/multicall-busybox.md')
-rw-r--r--vendor/clap-3.2.20/examples/multicall-busybox.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/vendor/clap-3.2.20/examples/multicall-busybox.md b/vendor/clap-3.2.20/examples/multicall-busybox.md
new file mode 100644
index 000000000..5ca2cad5b
--- /dev/null
+++ b/vendor/clap-3.2.20/examples/multicall-busybox.md
@@ -0,0 +1,42 @@
+See the documentation for [`Command::multicall`][crate::App::multicall] for rationale.
+
+This example omits every command except true and false,
+which are the most trivial to implement,
+```console
+$ busybox true
+? 0
+
+$ busybox false
+? 1
+
+```
+*Note: without the links setup, we can't demonstrate the multicall behavior*
+
+But includes the `--install` option as an example of why it can be useful
+for the main program to take arguments that aren't applet subcommands.
+```console
+$ busybox --install
+? failed
+...
+
+```
+
+Though users must pass something:
+```console
+$ busybox
+? failed
+busybox
+
+USAGE:
+ busybox [OPTIONS] [APPLET]
+
+OPTIONS:
+ -h, --help Print help information
+ --install <install> Install hardlinks for all subcommands in path
+
+APPLETS:
+ false does nothing unsuccessfully
+ help Print this message or the help of the given subcommand(s)
+ true does nothing successfully
+
+```