third_party_rust_clap/examples/cargo-example.md at weekly_20240708

mirror of https://github.com/openharmony/third_party_rust_clap.git synced 2026-07-23 09:35:26 -04:00

Files

T

Ed Page 5e91ba12fb 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

961 B

Raw Permalink Blame History

For more on creating a custom subcommand, see the cargo book. The crate clap-cargo can help in mimicking cargo's interface.

The help looks like:

$ cargo-example --help
Usage: cargo <COMMAND>

Commands:
  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)

Options:
  -h, --help  Print help

$ cargo-example example --help
A simple to use, efficient, and full-featured Command Line Argument Parser

Usage: cargo example [OPTIONS]

Options:
      --manifest-path <PATH>  
  -h, --help                  Print help
  -V, --version               Print version

Then to directly invoke the command, run:

$ cargo-example example
None

$ cargo-example example --manifest-path Cargo.toml
Some("Cargo.toml")

961 B Raw Permalink Blame History

961 B

Raw Permalink Blame History