Command::long_about

long_about

since 0.1.0

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

Example

Spec

TOML

name = "myprog"
long-about = "Does really amazing things to great people. Now let's talk a little more in depth about how this subcommand really works. It may take about a few lines of text, but that's ok!"
[args]

YAML

name: myprog
long-about: Does really amazing things to great people. Now let's talk a little more in depth about how this subcommand really works. It may take about a few lines of text, but that's ok!
args: {}

JSON

{
  "name": "myprog",
  "long-about": "Does really amazing things to great people. Now let's talk a little more in depth about how this subcommand really works. It may take about a few lines of text, but that's ok!",
  "args": {}
}

Input

myprog --help

Output

Does really amazing things to great people. Now let's talk a little more in depth about how this subcommand really works. It may take about a few lines of text,
but that's ok!

Usage: myprog

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