Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2025-01-09 03:08:45 +00:00
Code Issues Projects Releases Packages Wiki Activity
clap/clap_mangen/tests/snapshots/value_env.bash.roff

19 lines
394 B
Text
Raw Normal View History

fix(man): show the environment info with separate paragraph (#3631) This commit updates the man page renderer to use a relative margin indent for environment variable text instead of appending to the existing help text. Signed-off-by: Orhun Parmaksız <orhunparmaksiz@gmail.com> Fixes: #3630
2022-04-20 13:50:11 +00:00
.ie /n(.g .ds Aq /(aq
.el .ds Aq '
.TH my-app 1 "my-app "
.SH NAME
my/-app
.SH SYNOPSIS
fix!: Require explicit help/version disabling Before we introduced actions, it required specific setups to engage with claps version and help printing. With actions making that more explicit, we don't get as much benefit from our multiple, obscure, ways of users customizing help Before - Modify existing help or version with `mut_arg` which would automatically be pushed down the command tree like `global(true)` - Create an new help or version and have it treated as if it was the built-in on (I think) - Use the same flags as built-in and have the built-in flags automatically disabled - Users could explicitly disable the built-in functionality and do what they want Now - `mut_arg` no longer works as we define help and version flags at the end - If someone defines a flag that overlaps with the built-ins by id, long, or short, a debug assert will tell them to explicitly disable the built-in - Any customization has to be done by a user providing their own. To propagate through the command tree, they need to set `global(true)`. Benefits - Hopefully, this makes it less confusing on how to override help behavior. Someone creates an arg and we then tell them how to disable the built-in - This greatly simplifies the arg handling by pushing more responsibility onto the developer in what are hopefully just corner cases - This removes about 1Kb from .text Fixes #3405 Fixes #4033
2022-08-08 21:08:47 +00:00
/fBmy/-app/fR [/fB/-c /fR] [/fB/-h/fR|/fB/-/-help/fR]
fix(man): show the environment info with separate paragraph (#3631) This commit updates the man page renderer to use a relative margin indent for environment variable text instead of appending to the existing help text. Signed-off-by: Orhun Parmaksız <orhunparmaksiz@gmail.com> Fixes: #3630
2022-04-20 13:50:11 +00:00
.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
fix!: Require explicit help/version disabling Before we introduced actions, it required specific setups to engage with claps version and help printing. With actions making that more explicit, we don't get as much benefit from our multiple, obscure, ways of users customizing help Before - Modify existing help or version with `mut_arg` which would automatically be pushed down the command tree like `global(true)` - Create an new help or version and have it treated as if it was the built-in on (I think) - Use the same flags as built-in and have the built-in flags automatically disabled - Users could explicitly disable the built-in functionality and do what they want Now - `mut_arg` no longer works as we define help and version flags at the end - If someone defines a flag that overlaps with the built-ins by id, long, or short, a debug assert will tell them to explicitly disable the built-in - Any customization has to be done by a user providing their own. To propagate through the command tree, they need to set `global(true)`. Benefits - Hopefully, this makes it less confusing on how to override help behavior. Someone creates an arg and we then tell them how to disable the built-in - This greatly simplifies the arg handling by pushing more responsibility onto the developer in what are hopefully just corner cases - This removes about 1Kb from .text Fixes #3405 Fixes #4033
2022-08-08 21:08:47 +00:00
.TP
/fB/-h/fR, /fB/-/-help/fR
fix(help): Remove extraneous text from built-ins 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
2023-01-03 16:49:43 +00:00
Print help (see a summary with /*(Aq/-h/*(Aq)
Reference in a new issue Copy permalink