Arg::long_help

long_help

since 0.1.0

Sets the description of the argument for long help (--help).

Example

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", long-help = "The config file used by the myprog must be in JSON format with only valid keys and may not contain other nonsense that cannot be read by this program. Obviously I'm going on and on, so I'll stop now." }

YAML

name: prog
args:
  cfg:
    long: config
    long-help: The config file used by the myprog must be in JSON format with only valid keys and may not contain other nonsense that cannot be read by this program. Obviously I'm going on and on, so I'll stop now.

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "long-help": "The config file used by the myprog must be in JSON format with only valid keys and may not contain other nonsense that cannot be read by this program. Obviously I'm going on and on, so I'll stop now."
    }
  }
}

Input

prog --help

Output

Usage: prog [OPTIONS]

Options:
      --config <cfg>
          The config file used by the myprog must be in JSON format with only valid keys and may not contain other nonsense that cannot be read by this program.
          Obviously I'm going on and on, so I'll stop now.

  -h, --help
          Print help (see a summary with '-h')