mirror of
https://github.com/clap-rs/clap
synced 2024-12-13 22:32:33 +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
41 lines
675 B
Text
41 lines
675 B
Text
.ie /n(.g .ds Aq /(aq
|
|
.el .ds Aq '
|
|
.TH my-app 1 "my-app "
|
|
.SH NAME
|
|
my/-app
|
|
.SH SYNOPSIS
|
|
/fBmy/-app/fR [/fB/-/-choice/fR] [/fB/-/-method/fR] [/fB/-h/fR|/fB/-/-help/fR] [/fIpositional_choice/fR]
|
|
.SH DESCRIPTION
|
|
.SH OPTIONS
|
|
.TP
|
|
/fB/-/-choice/fR
|
|
|
|
.br
|
|
[/fIpossible values: /fRbash, fish, zsh]
|
|
.TP
|
|
/fB/-/-method/fR
|
|
|
|
.br
|
|
/fIPossible values:/fR
|
|
.RS 14
|
|
.IP /(bu 2
|
|
fast: use the Fast method
|
|
.IP /(bu 2
|
|
slow: use the slow method
|
|
.RE
|
|
.TP
|
|
/fB/-h/fR, /fB/-/-help/fR
|
|
Print help (see a summary with /*(Aq/-h/*(Aq)
|
|
.TP
|
|
[/fIpositional_choice/fR]
|
|
Pick the Position you want the command to run in
|
|
.br
|
|
|
|
.br
|
|
/fIPossible values:/fR
|
|
.RS 14
|
|
.IP /(bu 2
|
|
left: run left adjusted
|
|
.IP /(bu 2
|
|
right
|
|
.RE
|