MirroredRepos/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2025-04-19 01:00:34 +01:00
Code Issues Releases Wiki Activity

Use consistent syntax for command-line options

Browse Source 
closes #574
This commit is contained in:
sharkdp 2019-08-15 21:57:32 +02:00
parent 9c2d4f6a51
commit 187a3b9341
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/bat.1
View File

@ -10,6 +10,11 @@ bat [OPTIONS] [FILE]...
bat <SUBCOMMAND> bat <SUBCOMMAND>
.SH "OPTIONS" .SH "OPTIONS"
.HP .HP
General remarks
.IP
Command-line options like '-l'/'--language' that take values can be specified as
either '--language value', '--language=value', '-l value' or '-lvalue'.
.HP
\fB\-l\fR, \fB\-\-language\fR <language> \fB\-l\fR, \fB\-\-language\fR <language>
.IP .IP
Explicitly set the language for syntax highlighting. The language can be specified as a Explicitly set the language for syntax highlighting. The language can be specified as a
@ -29,7 +34,7 @@ Map a file extension or file name to an existing syntax. For example, to highlig
\fB\-\-theme\fR <theme> \fB\-\-theme\fR <theme>
.IP .IP
Set the theme for syntax highlighting. Use '\-\-list\-themes' to see all available themes. Set the theme for syntax highlighting. Use '\-\-list\-themes' to see all available themes.
To set a default theme, add the '\-\-theme="..."' option to the configuration file or To set a default theme, add the '\-\-theme "..."' option to the configuration file or
export the BAT_THEME environment variable (e.g.: export BAT_THEME="..."). export the BAT_THEME environment variable (e.g.: export BAT_THEME="...").
.HP .HP
\fB\-\-list\-themes\fR \fB\-\-list\-themes\fR
@ -41,19 +46,19 @@ Display a list of supported themes for syntax highlighting.
Configure which elements (line numbers, file headers, grid borders, Git modifications, Configure which elements (line numbers, file headers, grid borders, Git modifications,
\&..) to display in addition to the file contents. The argument is a comma\-separated list \&..) to display in addition to the file contents. The argument is a comma\-separated list
of components to display (e.g. 'numbers,changes,grid') or a pre\-defined style ('full'). of components to display (e.g. 'numbers,changes,grid') or a pre\-defined style ('full').
To set a default style, add the '\-\-style=".."' option to the configuration file or To set a default style, add the '\-\-style ".."' option to the configuration file or
export the BAT_STYLE environment variable (e.g.: export BAT_STYLE=".."). Possible export the BAT_STYLE environment variable (e.g.: export BAT_STYLE=".."). Possible
values: *auto*, full, plain, changes, header, grid, numbers. values: *auto*, full, plain, changes, header, grid, numbers.
.HP .HP
\fB\-p\fR, \fB\-\-plain\fR \fB\-p\fR, \fB\-\-plain\fR
.IP .IP
Only show plain style, no decorations. This is an alias for '\-\-style=plain'. When '\-p' Only show plain style, no decorations. This is an alias for '\-\-style plain'. When '\-p'
is used twice ('\-pp'), it also disables automatic paging (alias for '\-\-style=plain is used twice ('\-pp'), it also disables automatic paging (alias for '\-\-style plain
\fB\-\-pager\fR=\fI\,never\/\fR'). \fB\-\-pager\fR=\fI\,never\/\fR').
.HP .HP
\fB\-n\fR, \fB\-\-number\fR \fB\-n\fR, \fB\-\-number\fR
.IP .IP
Only show line numbers, no other decorations. This is an alias for '\-\-style=numbers' Only show line numbers, no other decorations. This is an alias for '\-\-style numbers'
.HP .HP
\fB\-A\fR, \fB\-\-show\-all\fR \fB\-A\fR, \fB\-\-show\-all\fR
.IP .IP
@ -97,7 +102,7 @@ values: *auto*, never, always.
Specify when to use the pager. To control which pager is used, set the PAGER or Specify when to use the pager. To control which pager is used, set the PAGER or
BAT_PAGER environment variables (the latter takes precedence) or use the '\-\-pager' BAT_PAGER environment variables (the latter takes precedence) or use the '\-\-pager'
option. To disable the pager permanently, set BAT_PAGER to an empty string or set option. To disable the pager permanently, set BAT_PAGER to an empty string or set
\&'\-\-paging=never' in the configuration file. 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