Arg::value_name

value_name

since 0.1.0

Placeholder for the argument’s value in the help message / usage.

Example

Spec

TOML

name = "prog"
[args]
config = { long = "config", value-name = "FILE" }

YAML

name: prog
args:
  config:
    long: config
    value-name: FILE

JSON

{
  "name": "prog",
  "args": {
    "config": {
      "long": "config",
      "value-name": "FILE"
    }
  }
}

Input

prog --help

Output

Usage: prog [OPTIONS]

Options:
      --config <FILE>
  -h, --help           Print help