summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorsharkdp <davidpeter@web.de>2019-08-31 14:47:04 +0200
committersharkdp <davidpeter@web.de>2019-08-31 14:47:04 +0200
commit83dd3fb5512832ea640161198ba6a991b965fdc3 (patch)
tree5904170f46ab4f9c4d98debfc1486823f6135636 /doc
parented345f28897ff3b2ec2bcc206550dcaa9c897862 (diff)
Update man page
Diffstat (limited to 'doc')
-rw-r--r--doc/bat.198
1 files changed, 54 insertions, 44 deletions
diff --git a/doc/bat.1 b/doc/bat.1
index 9c7665d5..6ed8574e 100644
--- a/doc/bat.1
+++ b/doc/bat.1
@@ -17,25 +17,28 @@ either '--language value', '--language=value', '-l value' or '-lvalue'.
.HP
\fB\-l\fR, \fB\-\-language\fR <language>
.IP
-Explicitly set the language for syntax highlighting. The language can be specified as a
-name (like 'C++' or 'LaTeX') or possible file extension (like 'cpp', 'hpp' or 'md'). Use
-\&'\-\-list\-languages' to show all supported language names and file extensions.
+Explicitly set the language for syntax highlighting. The language can be
+specified as a name (like 'C++' or 'LaTeX') or possible file extension
+(like 'cpp', 'hpp' or 'md'). Use '\-\-list\-languages' to show all supported
+language names and file extensions.
.HP
-\fB\-\-list\-languages\fR
+\fB\-L\fR, \fB\-\-list\-languages\fR
.IP
Display a list of supported languages for syntax highlighting.
.HP
\fB\-m\fR, \fB\-\-map\-syntax\fR <from:to>...
.IP
-Map a file extension or file name to an existing syntax. For example, to highlight
-*.conf files with the INI syntax, use '\-m conf:ini'. To highlight files named
-\&'.myignore' with the Git Ignore syntax, use '\-m .myignore:gitignore'.
+Map a file extension or file name to an existing syntax. For example, to
+highlight *.conf files with the INI syntax, use '\-m conf:ini'. To
+highlight files named '.myignore' with the Git Ignore syntax, use '\-m
+\&.myignore:gitignore'.
.HP
\fB\-\-theme\fR <theme>
.IP
-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
-export the BAT_THEME environment variable (e.g.: export BAT_THEME="...").
+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 export the BAT_THEME environment variable
+(e.g.: export BAT_THEME="...").
.HP
\fB\-\-list\-themes\fR
.IP
@@ -43,27 +46,29 @@ Display a list of supported themes for syntax highlighting.
.HP
\fB\-\-style\fR <style\-components>
.IP
-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
-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
-export the BAT_STYLE environment variable (e.g.: export BAT_STYLE=".."). Possible
-values: *auto*, full, plain, changes, header, grid, numbers.
+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 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 export
+the BAT_STYLE environment variable (e.g.: export BAT_STYLE=".."). Possible
+values: *auto*, full, plain, changes, header, grid, numbers, snip.
.HP
\fB\-p\fR, \fB\-\-plain\fR
.IP
-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
-\fB\-\-pager\fR=\fI\,never\/\fR').
+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 \fB\-\-pager\fR=\fI\,never\/\fR').
.HP
\fB\-n\fR, \fB\-\-number\fR
.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
\fB\-A\fR, \fB\-\-show\-all\fR
.IP
-Show non\-printable characters like space, tab or newline. Use '\-\-tabs' to control the
-width of the tab\-placeholders.
+Show non\-printable characters like space, tab or newline. Use '\-\-tabs' to
+control the width of the tab\-placeholders.
.HP
\fB\-r\fR, \fB\-\-line\-range\fR <N:M>...
.IP
@@ -83,52 +88,57 @@ Highlight the N\-th line with a different background color
.HP
\fB\-\-color\fR <when>
.IP
-Specify when to use colored output. The automatic mode only enables colors if an
-interactive terminal is detected. Possible values: *auto*, never, always.
+Specify when to use colored output. The automatic mode only enables colors
+if an interactive terminal is detected. Possible values: *auto*, never,
+always.
.HP
\fB\-\-italic\-text\fR <when>
.IP
-Specify when to use ANSI sequences for italic text in the output. Possible values:
-always, *never*.
+Specify when to use ANSI sequences for italic text in the output. Possible
+values: always, *never*.
.HP
\fB\-\-decorations\fR <when>
.IP
-Specify when to use the decorations that have been specified via '\-\-style'. The
-automatic mode only enables decorations if an interactive terminal is detected. Possible
-values: *auto*, never, always.
+Specify when to use the decorations that have been specified via
+\&'\-\-style'. The automatic mode only enables decorations if an interactive
+terminal is detected. Possible values: *auto*, never, always.
.HP
\fB\-\-paging\fR <when>
.IP
-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'
-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.
+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' 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.
.HP
\fB\-\-pager\fR <command>
.IP
-Determine which pager is used. This option will overwrite the PAGER and BAT_PAGER
-environment variables. The default pager is 'less'. To disable the pager completely, use
-the '\-\-paging' option. Example: '\-\-pager "less \fB\-RF\fR"'.
+Determine which pager is used. This option will overwrite the PAGER and
+BAT_PAGER environment variables. The default pager is 'less'. To disable
+the pager completely, use the '\-\-paging' option. Example: '\-\-pager "less
+\fB\-RF\fR"'.
.HP
\fB\-\-wrap\fR <mode>
.IP
-Specify the text\-wrapping mode (*auto*, never, character). The '\-\-terminal\-width' option
-can be used in addition to control the output width.
+Specify the text\-wrapping mode (*auto*, never, character). The
+\&'\-\-terminal\-width' option can be used in addition to control the output
+width.
.HP
\fB\-\-tabs\fR <T>
.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
\fB\-u\fR, \fB\-\-unbuffered\fR
.IP
-This option exists for POSIX\-compliance reasons ('u' is for 'unbuffered'). The output is
-always unbuffered \- this option is simply ignored.
+This option exists for POSIX\-compliance reasons ('u' is for 'unbuffered').
+The output is always unbuffered \- this option is simply ignored.
.HP
\fB\-\-terminal\-width\fR <width>
.IP
-Explicitly set the width of the terminal instead of determining it automatically. If
-prefixed with '+' or '\-', the value will be treated as an offset to the actual terminal
-width. See also: '\-\-wrap'.
+Explicitly set the width of the terminal instead of determining it
+automatically. If prefixed with '+' or '\-', the value will be treated as
+an offset to the actual terminal width. See also: '\-\-wrap'.
.HP
\fB\-h\fR, \fB\-\-help\fR
.IP