Command::next_line_help

next_line_help

since 0.1.0

Places the help string for all arguments and subcommands on the line after them.

Example

Spec

TOML

name = "prog"
next-line-help = true
[args]
opt = { short = 'o', long = "long-option-flag", action = "set", value-names = ["value1", "value2"], help = "Some really long help and complex\nhelp that makes more sense to be\non a line after the option" }

YAML

name: prog
next-line-help: true
args:
  opt:
    short: o
    long: long-option-flag
    action: set
    value-names:
    - value1
    - value2
    help: |-
      Some really long help and complex
      help that makes more sense to be
      on a line after the option

JSON

{
  "name": "prog",
  "next-line-help": true,
  "args": {
    "opt": {
      "short": "o",
      "long": "long-option-flag",
      "action": "set",
      "value-names": [
        "value1",
        "value2"
      ],
      "help": "Some really long help and complex\nhelp that makes more sense to be\non a line after the option"
    }
  }
}

Input

prog --help

Output

Usage: prog [OPTIONS]

Options:
  -o, --long-option-flag <value1> <value2>
          Some really long help and complex
          help that makes more sense to be
          on a line after the option
  -h, --help
          Print help