Update man page

This commit is contained in:
sharkdp 2019-08-31 14:47:04 +02:00
parent ed345f2889
commit 83dd3fb551

View file

@ -17,25 +17,28 @@ either '--language value', '--language=value', '-l value' or '-lvalue'.
.HP .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
name (like 'C++' or 'LaTeX') or possible file extension (like 'cpp', 'hpp' or 'md'). Use specified as a name (like 'C++' or 'LaTeX') or possible file extension
\&'\-\-list\-languages' to show all supported language names and file extensions. (like 'cpp', 'hpp' or 'md'). Use '\-\-list\-languages' to show all supported
language names and file extensions.
.HP .HP
\fB\-\-list\-languages\fR \fB\-L\fR, \fB\-\-list\-languages\fR
.IP .IP
Display a list of supported languages for syntax highlighting. Display a list of supported languages for syntax highlighting.
.HP .HP
\fB\-m\fR, \fB\-\-map\-syntax\fR <from:to>... \fB\-m\fR, \fB\-\-map\-syntax\fR <from:to>...
.IP .IP
Map a file extension or file name to an existing syntax. For example, to highlight Map a file extension or file name to an existing syntax. For example, to
*.conf files with the INI syntax, use '\-m conf:ini'. To highlight files named highlight *.conf files with the INI syntax, use '\-m conf:ini'. To
\&'.myignore' with the Git Ignore syntax, use '\-m .myignore:gitignore'. highlight files named '.myignore' with the Git Ignore syntax, use '\-m
\&.myignore:gitignore'.
.HP .HP
\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
To set a default theme, add the '\-\-theme "..."' option to the configuration file or available themes. To set a default theme, add the '\-\-theme="..."' option
export the BAT_THEME environment variable (e.g.: export BAT_THEME="..."). to the configuration file or export the BAT_THEME environment variable
(e.g.: export BAT_THEME="...").
.HP .HP
\fB\-\-list\-themes\fR \fB\-\-list\-themes\fR
.IP .IP
@ -43,27 +46,29 @@ Display a list of supported themes for syntax highlighting.
.HP .HP
\fB\-\-style\fR <style\-components> \fB\-\-style\fR <style\-components>
.IP .IP
Configure which elements (line numbers, file headers, grid borders, Git modifications, Configure which elements (line numbers, file headers, grid borders, Git
\&..) to display in addition to the file contents. The argument is a comma\-separated list modifications, ..) to display in addition to the file contents. The
of components to display (e.g. 'numbers,changes,grid') or a pre\-defined style ('full'). argument is a comma\-separated list of components to display (e.g.
To set a default style, add the '\-\-style ".."' option to the configuration file or \&'numbers,changes,grid') or a pre\-defined style ('full'). To set a default
export the BAT_STYLE environment variable (e.g.: export BAT_STYLE=".."). Possible style, add the '\-\-style=".."' option to the configuration file or export
values: *auto*, full, plain, changes, header, grid, numbers. the BAT_STYLE environment variable (e.g.: export BAT_STYLE=".."). Possible
values: *auto*, full, plain, changes, header, grid, numbers, snip.
.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
is used twice ('\-pp'), it also disables automatic paging (alias for '\-\-style plain \&'\-\-style=plain'. When '\-p' is used twice ('\-pp'), it also disables
\fB\-\-pager\fR=\fI\,never\/\fR'). automatic paging (alias for '\-\-style=plain \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
Show non\-printable characters like space, tab or newline. Use '\-\-tabs' to control the Show non\-printable characters like space, tab or newline. Use '\-\-tabs' to
width of the tab\-placeholders. control the width of the tab\-placeholders.
.HP .HP
\fB\-r\fR, \fB\-\-line\-range\fR <N:M>... \fB\-r\fR, \fB\-\-line\-range\fR <N:M>...
.IP .IP
@ -83,52 +88,57 @@ Highlight the N\-th line with a different background color
.HP .HP
\fB\-\-color\fR <when> \fB\-\-color\fR <when>
.IP .IP
Specify when to use colored output. The automatic mode only enables colors if an Specify when to use colored output. The automatic mode only enables colors
interactive terminal is detected. Possible values: *auto*, never, always. if an interactive terminal is detected. Possible values: *auto*, never,
always.
.HP .HP
\fB\-\-italic\-text\fR <when> \fB\-\-italic\-text\fR <when>
.IP .IP
Specify when to use ANSI sequences for italic text in the output. Possible values: Specify when to use ANSI sequences for italic text in the output. Possible
always, *never*. values: always, *never*.
.HP .HP
\fB\-\-decorations\fR <when> \fB\-\-decorations\fR <when>
.IP .IP
Specify when to use the decorations that have been specified via '\-\-style'. The Specify when to use the decorations that have been specified via
automatic mode only enables decorations if an interactive terminal is detected. Possible \&'\-\-style'. The automatic mode only enables decorations if an interactive
values: *auto*, never, always. terminal is detected. Possible 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 control which pager is used, set the
BAT_PAGER environment variables (the latter takes precedence) or use the '\-\-pager' PAGER or BAT_PAGER environment variables (the latter takes precedence) or
option. To disable the pager permanently, set BAT_PAGER to an empty string or set use the '\-\-pager' option. To disable the pager permanently, set BAT_PAGER
\&'\-\-paging never' in the configuration file. Possible values: *auto*, never, always. to an empty string or set '\-\-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 overwrite the PAGER and
environment variables. The default pager is 'less'. To disable the pager completely, use BAT_PAGER environment variables. The default pager is 'less'. To disable
the '\-\-paging' option. Example: '\-\-pager "less \fB\-RF\fR"'. the pager completely, use the '\-\-paging' option. Example: '\-\-pager "less
\fB\-RF\fR"'.
.HP .HP
\fB\-\-wrap\fR <mode> \fB\-\-wrap\fR <mode>
.IP .IP
Specify the text\-wrapping mode (*auto*, never, character). The '\-\-terminal\-width' option Specify the text\-wrapping mode (*auto*, never, character). The
can be used in addition to control the output width. \&'\-\-terminal\-width' option can be used in addition to control the output
width.
.HP .HP
\fB\-\-tabs\fR <T> \fB\-\-tabs\fR <T>
.IP .IP
Set the tab width to T spaces. Use a width of 0 to pass tabs through directly Set the tab width to T spaces. Use a width of 0 to pass tabs through
directly
.HP .HP
\fB\-u\fR, \fB\-\-unbuffered\fR \fB\-u\fR, \fB\-\-unbuffered\fR
.IP .IP
This option exists for POSIX\-compliance reasons ('u' is for 'unbuffered'). The output is This option exists for POSIX\-compliance reasons ('u' is for 'unbuffered').
always unbuffered \- this option is simply ignored. The output is always unbuffered \- this option is simply ignored.
.HP .HP
\fB\-\-terminal\-width\fR <width> \fB\-\-terminal\-width\fR <width>
.IP .IP
Explicitly set the width of the terminal instead of determining it automatically. If Explicitly set the width of the terminal instead of determining it
prefixed with '+' or '\-', the value will be treated as an offset to the actual terminal automatically. If prefixed with '+' or '\-', the value will be treated as
width. See also: '\-\-wrap'. an offset to the actual terminal width. See also: '\-\-wrap'.
.HP .HP
\fB\-h\fR, \fB\-\-help\fR \fB\-h\fR, \fB\-\-help\fR
.IP .IP