mirror of
https://github.com/clap-rs/clap
synced 2024-12-14 23:02:31 +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
18 lines
394 B
Text
18 lines
394 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/-c /fR] [/fB/-h/fR|/fB/-/-help/fR]
|
|
.SH DESCRIPTION
|
|
.SH OPTIONS
|
|
.TP
|
|
/fB/-c/fR [default: config.toml]
|
|
Set configuration file path
|
|
.RS
|
|
May also be specified with the /fBCONFIG_FILE/fR environment variable.
|
|
.RE
|
|
.TP
|
|
/fB/-h/fR, /fB/-/-help/fR
|
|
Print help (see a summary with /*(Aq/-h/*(Aq)
|