Command::before_long_help

before_long_help

since 0.1.0

Free-form help text for before auto-generated long help (--help).

Example

Spec

TOML

name = "myprog"
before-long-help = "Some verbose and long info I'd like to appear before the help info"
[args]

YAML

name: myprog
before-long-help: Some verbose and long info I'd like to appear before the help info
args: {}

JSON

{
  "name": "myprog",
  "before-long-help": "Some verbose and long info I'd like to appear before the help info",
  "args": {}
}

Input

myprog --help

Output

Some verbose and long info I'd like to appear before the help info


Usage: myprog

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