clap/examples/multicall-busybox.md
Ed Page 36bc641648 fix(help): Remove extraneous text from built-ins
This is an intermediate solution for #4408.  As there were no agreeed
upon goals, I went with what I felt read well and that I saw commonly
used on non-clap commands.

- "information" isn't really a necessary word.
- I originally favored `Print this help` but realied that doesn't read
  correctly in completions.
- Besides being shorter, the reason for the flipped short/long hint is
  it gives people the context they need for scanning, emphasizing
  "summary" and "more".

Fixes #4409
2023-01-03 11:02:26 -06:00

891 B

See the documentation for [Command::multicall][crate::Command::multicall] for rationale.

This example omits every command except true and false, which are the most trivial to implement,

$ 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.

$ busybox --install
? failed
...

Though users must pass something:

$ busybox
? failed
Usage: busybox [OPTIONS] [APPLET]

APPLETS:
  true   does nothing successfully
  false  does nothing unsuccessfully
  help   Print this message or the help of the given subcommand(s)

Options:
      --install <install>  Install hardlinks for all subcommands in path
  -h, --help               Print help