Command::help_template

help_template

since 0.1.0

Sets the help template to be used, overriding the default format.

Example

Spec

TOML

name = "myprog"
help-template = "{before-help}{name} {version}\n{author-with-newline}{about-with-newline}\n{usage-heading} {usage}\n\n{all-args}{after-help}"
[args]

YAML

name: myprog
help-template: |-
  {before-help}{name} {version}
  {author-with-newline}{about-with-newline}
  {usage-heading} {usage}

  {all-args}{after-help}
args: {}

JSON

{
  "name": "myprog",
  "help-template": "{before-help}{name} {version}\n{author-with-newline}{about-with-newline}\n{usage-heading} {usage}\n\n{all-args}{after-help}",
  "args": {}
}

Input

myprog --help

Output

myprog

Usage: myprog

Options:
  -h, --help  Print help