Command::about

about

since 0.1.0

Sets the program’s description for the short help (-h).

Example

Spec

TOML

name = "myprog"
about = "Does really amazing things for great people"
[args]

YAML

name: myprog
about: Does really amazing things for great people
args: {}

JSON

{
  "name": "myprog",
  "about": "Does really amazing things for great people",
  "args": {}
}

Input

myprog -h

Output

Does really amazing things for great people

Usage: myprog

Options:
  -h, --help  Print help