mirror of
https://github.com/clap-rs/clap
synced 2024-12-14 06:42: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
57 lines
1.3 KiB
Text
57 lines
1.3 KiB
Text
.ie /n(.g .ds Aq /(aq
|
|
.el .ds Aq '
|
|
.TH my-app 1 "my-app 3.0"
|
|
.SH NAME
|
|
my/-app
|
|
.SH SYNOPSIS
|
|
/fBmy/-app/fR [/fB/-/-single/-quotes/fR] [/fB/-/-double/-quotes/fR] [/fB/-/-backticks/fR] [/fB/-/-backslash/fR] [/fB/-/-brackets/fR] [/fB/-/-expansions/fR] [/fB/-h/fR|/fB/-/-help/fR] [/fB/-V/fR|/fB/-/-version/fR] [/fIsubcommands/fR]
|
|
.SH DESCRIPTION
|
|
.SH OPTIONS
|
|
.TP
|
|
/fB/-/-single/-quotes/fR
|
|
Can be /*(Aqalways/*(Aq, /*(Aqauto/*(Aq, or /*(Aqnever/*(Aq
|
|
.TP
|
|
/fB/-/-double/-quotes/fR
|
|
Can be "always", "auto", or "never"
|
|
.TP
|
|
/fB/-/-backticks/fR
|
|
For more information see `echo test`
|
|
.TP
|
|
/fB/-/-backslash/fR
|
|
Avoid /*(Aq//n/*(Aq
|
|
.TP
|
|
/fB/-/-brackets/fR
|
|
List packages [filter]
|
|
.TP
|
|
/fB/-/-expansions/fR
|
|
Execute the shell command with $SHELL
|
|
.TP
|
|
/fB/-h/fR, /fB/-/-help/fR
|
|
Print help
|
|
.TP
|
|
/fB/-V/fR, /fB/-/-version/fR
|
|
Print version
|
|
.SH SUBCOMMANDS
|
|
.TP
|
|
my/-app/-cmd/-single/-quotes(1)
|
|
Can be /*(Aqalways/*(Aq, /*(Aqauto/*(Aq, or /*(Aqnever/*(Aq
|
|
.TP
|
|
my/-app/-cmd/-double/-quotes(1)
|
|
Can be "always", "auto", or "never"
|
|
.TP
|
|
my/-app/-cmd/-backticks(1)
|
|
For more information see `echo test`
|
|
.TP
|
|
my/-app/-cmd/-backslash(1)
|
|
Avoid /*(Aq//n/*(Aq
|
|
.TP
|
|
my/-app/-cmd/-brackets(1)
|
|
List packages [filter]
|
|
.TP
|
|
my/-app/-cmd/-expansions(1)
|
|
Execute the shell command with $SHELL
|
|
.TP
|
|
my/-app/-help(1)
|
|
Print this message or the help of the given subcommand(s)
|
|
.SH VERSION
|
|
v3.0
|