diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 54 |
1 files changed, 28 insertions, 26 deletions
@@ -148,32 +148,6 @@ var args struct { arg.MustParse(&args) ``` -### Custom placeholders - -```go -var args struct { - Input string `arg:"positional" placeholder:"SRC"` - Output []string `arg:"positional" placeholder:"DST"` - Optimize int `arg:"-O" help:"optimization level" placeholder:"LEVEL"` - MaxJobs int `arg:"-j" help:"maximum number of simultaneous jobs" placeholder:"N"` -} -arg.MustParse(&args) -``` -```shell -$ ./example -h -Usage: example [--optimize LEVEL] [--maxjobs N] SRC [DST [DST ...]] - -Positional arguments: - SRC - DST - -Options: - --optimize LEVEL, -O LEVEL - optimization level - --maxjobs N, -j N maximum number of simultaneous jobs - --help, -h display this help and exit -``` - ### Default values (before v1.2) ```go @@ -361,6 +335,34 @@ $ ./example main.NameDotName{Head:"file", Tail:"txt"} ``` +### Custom placeholders + +Use the `placeholder` tag to control which placeholder text is used in the usage text. + +```go +var args struct { + Input string `arg:"positional" placeholder:"SRC"` + Output []string `arg:"positional" placeholder:"DST"` + Optimize int `arg:"-O" help:"optimization level" placeholder:"LEVEL"` + MaxJobs int `arg:"-j" help:"maximum number of simultaneous jobs" placeholder:"N"` +} +arg.MustParse(&args) +``` +```shell +$ ./example -h +Usage: example [--optimize LEVEL] [--maxjobs N] SRC [DST [DST ...]] + +Positional arguments: + SRC + DST + +Options: + --optimize LEVEL, -O LEVEL + optimization level + --maxjobs N, -j N maximum number of simultaneous jobs + --help, -h display this help and exit +``` + ### Description strings ```go |
