1
0
mirror of https://github.com/sharkdp/bat.git synced 2025-03-14 06:38:24 +00:00

Hide alias in help, update man and completions

A long alias doesn't make sense, since `--paging=never` already exists
This commit is contained in:
Dash Peters 2020-07-02 00:07:37 -07:00
parent f53ea60ed4
commit c264f74771
4 changed files with 20 additions and 20 deletions

View File

@ -3,6 +3,7 @@
## Features ## Features
- Added support for the `NO_COLOR` environment variable, see #1021 and #1031 (@eth-p) - Added support for the `NO_COLOR` environment variable, see #1021 and #1031 (@eth-p)
- Added `-P` short flag to disable paging, revised man page description, see #1075 and #1082 (@LordFlashmeow)
## Bugfixes ## Bugfixes

View File

@ -52,6 +52,8 @@ complete -c {{PROJECT_EXECUTABLE}} -l paging -xka "auto never always" -d "Specif
complete -c {{PROJECT_EXECUTABLE}} -s p -l plain -d "Only show plain style, no decorations. Alias for '--style=plain'" -n "not __fish_seen_subcommand_from cache" complete -c {{PROJECT_EXECUTABLE}} -s p -l plain -d "Only show plain style, no decorations. Alias for '--style=plain'" -n "not __fish_seen_subcommand_from cache"
complete -c {{PROJECT_EXECUTABLE}} -s P -d "Disable paging. Alias for '--paging=never'" -n "not __fish_seen_subcommand_from cache"
complete -c {{PROJECT_EXECUTABLE}} -s A -l show-all -d "Show non-printable characters like space/tab/newline" -n "not __fish_seen_subcommand_from cache" complete -c {{PROJECT_EXECUTABLE}} -s A -l show-all -d "Show non-printable characters like space/tab/newline" -n "not __fish_seen_subcommand_from cache"
complete -c {{PROJECT_EXECUTABLE}} -l style -xka "auto full plain changes header grid numbers" -d "Comma-separated list of style elements or presets to display with file contents" -n "not __fish_seen_subcommand_from cache" complete -c {{PROJECT_EXECUTABLE}} -l style -xka "auto full plain changes header grid numbers" -d "Comma-separated list of style elements or presets to display with file contents" -n "not __fish_seen_subcommand_from cache"

View File

@ -89,15 +89,14 @@ values: *auto*, never, always.
.HP .HP
\fB\-\-paging\fR <when> \fB\-\-paging\fR <when>
.IP .IP
Specify when to use the pager. To control which pager is used, set the PAGER or Specify when to use the pager. To disable the pager, use \&'\-\-paging=never' or its alias,
BAT_PAGER environment variables (the latter takes precedence) or use the '\-\-pager' \fB-P\fR. To disable the pager permanently, set BAT_PAGER to an empty string. To control
option. To disable the pager permanently, set BAT_PAGER to an empty string or set which pager is used, see the '\-\-pager' option. Possible values: *auto*, never, always.
\&'\-\-paging=never' in the configuration file. Possible values: *auto*, never, always.
.HP .HP
\fB\-\-pager\fR <command> \fB\-\-pager\fR <command>
.IP .IP
Determine which pager is used. This option will overwrite the PAGER and BAT_PAGER Determine which pager is used. This option will override the PAGER and BAT_PAGER
environment variables. The default pager is 'less'. To disable the pager completely, use environment variables. The default pager is 'less'. To control when the pager is used, see
the '\-\-paging' option. Example: '\-\-pager "less \fB\-RF\fR"'. the '\-\-paging' option. Example: '\-\-pager "less \fB\-RF\fR"'.
.HP .HP
\fB\-m\fR, \fB\-\-map\-syntax\fR <glob-pattern:syntax-name>... \fB\-m\fR, \fB\-\-map\-syntax\fR <glob-pattern:syntax-name>...

View File

@ -265,23 +265,22 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
.possible_values(&["auto", "never", "always"]) .possible_values(&["auto", "never", "always"])
.default_value("auto") .default_value("auto")
.hide_default_value(true) .hide_default_value(true)
.help("Specify when to use the pager (*auto*, never, always).") .help("Specify when to use the pager, or use `-P` to disable (*auto*, never, always).")
.long_help( .long_help(
"Specify when to use the pager. To control which pager \ "Specify when to use the pager. To disable the pager, use \
is used, set the PAGER or BAT_PAGER environment \ --paging=never' or its alias,'-P'. To disable the pager permanently, \
variables (the latter takes precedence) or use the '--pager' option. \ set BAT_PAGER to an empty string. To control which pager is used, see the \
To disable the pager permanently, set BAT_PAGER to an empty string \ '--pager' option. Possible values: *auto*, never, always."
or set '--paging=never' in the configuration file. \
Possible values: *auto*, never, always.",
), ),
) )
.arg( .arg(
Arg::with_name("no-paging") Arg::with_name("no-paging")
.short("P") .short("P")
.long("no-paging")
.alias("no-pager") .alias("no-pager")
.overrides_with("no-paging") .overrides_with("no-paging")
.help("Alias for --paging=never") .hidden(true)
.hidden_short_help(true)
.help("Alias for '--paging=never'")
) )
.arg( .arg(
Arg::with_name("pager") Arg::with_name("pager")
@ -292,11 +291,10 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
.hidden_short_help(true) .hidden_short_help(true)
.help("Determine which pager to use.") .help("Determine which pager to use.")
.long_help( .long_help(
"Determine which pager is used. This option will overwrite \ "Determine which pager is used. This option will override the \
the PAGER and BAT_PAGER environment variables. The default \ PAGER and BAT_PAGER environment variables. The default pager is 'less'. \
pager is 'less'. To disable the pager completely, use the \ To control when the pager is used, see the '--paging' option. \
'--paging' option. \ Example: '--pager \"less -RF\"'."
Example: '--pager \"less -RF\"'.",
), ),
) )
.arg( .arg(