mirror of
https://github.com/clap-rs/clap
synced 2024-12-16 07:42:32 +00:00
36bc641648
This is an intermediate solution for #4408. As there were no agreeed upon goals, I went with what I felt read well and that I saw commonly used on non-clap commands. - "information" isn't really a necessary word. - I originally favored `Print this help` but realied that doesn't read correctly in completions. - Besides being shorter, the reason for the flipped short/long hint is it gives people the context they need for scanning, emphasizing "summary" and "more". Fixes #4409
39 lines
736 B
Text
39 lines
736 B
Text
.ie /n(.g .ds Aq /(aq
|
|
.el .ds Aq '
|
|
.TH my-app 1 "my-app 3.0"
|
|
.SH NAME
|
|
my/-app /- Tests completions
|
|
.SH SYNOPSIS
|
|
/fBmy/-app/fR [/fB/-c/fR|/fB/-/-config/fR]... [/fB/-h/fR|/fB/-/-help/fR] [/fB/-V/fR|/fB/-/-version/fR] [/fIfile/fR] [/fIchoice/fR] [/fIsubcommands/fR]
|
|
.SH DESCRIPTION
|
|
Tests completions
|
|
.SH OPTIONS
|
|
.TP
|
|
/fB/-c/fR, /fB/-/-config/fR
|
|
some config file
|
|
.TP
|
|
/fB/-h/fR, /fB/-/-help/fR
|
|
Print help
|
|
.TP
|
|
/fB/-V/fR, /fB/-/-version/fR
|
|
Print version
|
|
.TP
|
|
[/fIfile/fR]
|
|
some input file
|
|
.TP
|
|
[/fIchoice/fR]
|
|
|
|
.br
|
|
[/fIpossible values: /fRfirst, second]
|
|
.SH SUBCOMMANDS
|
|
.TP
|
|
my/-app/-test(1)
|
|
tests things
|
|
.TP
|
|
my/-app/-some_cmd(1)
|
|
top level subcommand
|
|
.TP
|
|
my/-app/-help(1)
|
|
Print this message or the help of the given subcommand(s)
|
|
.SH VERSION
|
|
v3.0
|