Command::before_help

before_help

since 0.1.0

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

Example

Spec

TOML

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

YAML

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

JSON

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

Input

myprog -h

Output

Some info I'd like to appear before the help info


Usage: myprog

Options:
  -h, --help  Print help