on master help sign in
Update man page
commit4776c2a575dee60a8d36616352458c597932919c authorsharkdp <davidpeter@web.de> dateSun 11 Nov 2018, 12:31 (8 years ago) parentf98a96c
1 file changed+40−22
doc/bat.1+40−22
doc/bat.1+40−22
@@ -12,10 +12,9 @@ bat <SUBCOMMAND>
1212.HP
1313\fB\-l\fR, \fB\-\-language\fR <language>
1414.IP
15−Explicitly set the language for syntax highlighting. The language can be
16−specified as a name (like 'C++' or 'LaTeX') or possible file extension (like
17−\&'cpp', 'hpp' or 'md'). Use '\-\-list\-languages' to show all supported language
18−names and file extensions.
15+Explicitly set the language for syntax highlighting. The language can be specified as a
16+name (like 'C++' or 'LaTeX') or possible file extension (like 'cpp', 'hpp' or 'md'). Use
17+\&'\-\-list\-languages' to show all supported language names and file extensions.
1918.HP
2019\fB\-\-list\-languages\fR
2120.IP
@@ -29,9 +28,9 @@ Map a file extension or file name to an existing syntax. For example, to highlig
2928.HP
3029\fB\-\-theme\fR <theme>
3130.IP
32−Set the theme for syntax highlighting. Use '\-\-list\-themes' to see all
33−available themes. To set a default theme, export the BAT_THEME environment
34−variable (e.g.: export BAT_THEME="TwoDark").
31+Set the theme for syntax highlighting. Use '\-\-list\-themes' to see all available themes.
32+To set a default theme, add the '\-\-theme="..."' option to the configuration file or
33+export the BAT_THEME environment variable (e.g.: export BAT_THEME="...").
3534.HP
3635\fB\-\-list\-themes\fR
3736.IP
@@ -39,13 +38,12 @@ Display a list of supported themes for syntax highlighting.
3938.HP
4039\fB\-\-style\fR <style\-components>
4140.IP
42−Configure which elements (line numbers, file headers, grid borders, Git
43−modifications, ..) to display in addition to the file contents. The argument
44−is a comma\-separated list of components to display (e.g.
45−\&'numbers,changes,grid') or a pre\-defined style ('full'). To set a default
46−theme, export the BAT_STYLE environment variable (e.g.: export
47−BAT_STYLE="numbers"). [possible values: auto, full, plain, changes, header,
48−grid, numbers]
41+Configure which elements (line numbers, file headers, grid borders, Git modifications,
42+\&..) to display in addition to the file contents. The argument is a comma\-separated list
43+of components to display (e.g. 'numbers,changes,grid') or a pre\-defined style ('full').
44+To set a default style, add the '\-\-style=".."' option to the configuration file or
45+export the BAT_STYLE environment variable (e.g.: export BAT_STYLE=".."). Possible
46+values: *auto*, full, plain, changes, header, grid, numbers.
4947.HP
5048\fB\-p\fR, \fB\-\-plain\fR
5149.IP
@@ -53,10 +51,14 @@ Only show plain style, no decorations. This is an alias for '\-\-style=plain'
5351.HP
5452\fB\-n\fR, \fB\-\-number\fR
5553.IP
56−Only show line numbers, no other decorations. This is an alias for
57−\&'\-\-style=numbers'
54+Only show line numbers, no other decorations. This is an alias for '\-\-style=numbers'
5855.HP
59−\fB\-\-line\-range\fR <N:M>
56+\fB\-A\fR, \fB\-\-show\-all\fR
57+.IP
58+Show non\-printable characters like space, tab or newline. Use '\-\-tabs' to control the
59+width of the tab\-placeholders.
60+.HP
61+\fB\-\-line\-range\fR <N:M>...
6062.IP
6163Only print the specified range of lines for each file. For example:
6264.RS
@@ -73,6 +75,11 @@ prints lines 40 to the end of the file
7375Specify when to use colored output. The automatic mode only enables colors if an
7476interactive terminal is detected. Possible values: *auto*, never, always.
7577.HP
78+\fB\-\-italic\-text\fR <when>
79+.IP
80+Specify when to use ANSI sequences for italic text in the output. Possible values:
81+always, *never*.
82+.HP
7683\fB\-\-decorations\fR <when>
7784.IP
7885Specify when to use the decorations that have been specified via '\-\-style'. The
@@ -82,9 +89,15 @@ values: *auto*, never, always.
8289\fB\-\-paging\fR <when>
8390.IP
8491Specify when to use the pager. To control which pager is used, set the PAGER or
85−BAT_PAGER environment variables (the latter takes precedence). The default pager is
86−\&'less'. To disable the pager permanently, set BAT_PAGER to an empty string. Possible
87−values: *auto*, never, always.
92+BAT_PAGER environment variables (the latter takes precedence) or use the '\-\-pager'
93+option. To disable the pager permanently, set BAT_PAGER to an empty string or set
94+\&'\-\-paging=never' in the configuration file. Possible values: *auto*, never, always.
95+.HP
96+\fB\-\-pager\fR <command>
97+.IP
98+Determine which pager is used. This option will overwrite the PAGER and BAT_PAGER
99+environment variables. The default pager is 'less'. To disable the pager completely, use
100+the '\-\-paging' option. Example: '\-\-pager "less \fB\-RF\fR"'.
88101.HP
89102\fB\-\-wrap\fR <mode>
90103.IP
@@ -99,6 +112,12 @@ Set the tab width to T spaces. Use a width of 0 to pass tabs through directly
99112This option exists for POSIX\-compliance reasons ('u' is for 'unbuffered'). The output is
100113always unbuffered \- this option is simply ignored.
101114.HP
115+\fB\-\-terminal\-width\fR <width>
116+.IP
117+Explicitly set the width of the terminal instead of determining it automatically. If
118+prefixed with '+' or '\-', the value will be treated as an offset to the actual terminal
119+width.
120+.HP
102121\fB\-h\fR, \fB\-\-help\fR
103122.IP
104123Print this help message.
@@ -115,5 +134,4 @@ from standard input.
115134.SH "SUBCOMMANDS"
116135.IP
117136cache
118−.IP
119−Modify the syntax\-definition and theme cache. See "bat cache --help" for more information
137+Modify the syntax\-definition and theme cache