Command::override_help

override_help

since 0.1.0

Overrides the clap generated help message (both -h and --help).

Example

Spec

TOML

name = "myprog"
override-help = "myapp v1.0\n           Does awesome things\n           (C) me@mail.com\n\n           Usage: myapp <opts> <command>\n\n           Options:\n           -h, --help       Display this message\n           -V, --version    Display version info\n           -s <stuff>       Do something with stuff\n           -v               Be verbose\n\n           Commands:\n           help             Print this message\n           work             Do some work"
[args]

YAML

name: myprog
override-help: |-
  myapp v1.0
             Does awesome things
             (C) me@mail.com

             Usage: myapp <opts> <command>

             Options:
             -h, --help       Display this message
             -V, --version    Display version info
             -s <stuff>       Do something with stuff
             -v               Be verbose

             Commands:
             help             Print this message
             work             Do some work
args: {}

JSON

{
  "name": "myprog",
  "override-help": "myapp v1.0\n           Does awesome things\n           (C) me@mail.com\n\n           Usage: myapp <opts> <command>\n\n           Options:\n           -h, --help       Display this message\n           -V, --version    Display version info\n           -s <stuff>       Do something with stuff\n           -v               Be verbose\n\n           Commands:\n           help             Print this message\n           work             Do some work",
  "args": {}
}

Input

prog --help

Output

myapp v1.0
           Does awesome things
           (C) me@mail.com

           Usage: myapp <opts> <command>

           Options:
           -h, --help       Display this message
           -V, --version    Display version info
           -s <stuff>       Do something with stuff
           -v               Be verbose

           Commands:
           help             Print this message
           work             Do some work