git.iko.soy/bat
on 8d0aa39 help sign in
bat/doc/bat.1
159 lines 5.2 kB history raw
1.TH BAT "1"
2.SH NAME
3bat \- manual page for bat
4.SH DESCRIPTION
5bat - a cat(1) clone with syntax highlighting and Git integration.
6.SH "USAGE"
7.IP
8bat [OPTIONS] [FILE]...
9.IP
10bat <SUBCOMMAND>
11.SH "OPTIONS"
12.HP
13General remarks
14.IP
15Command-line options like '-l'/'--language' that take values can be specified as
16either '--language value', '--language=value', '-l value' or '-lvalue'.
17.HP
18\fB\-l\fR, \fB\-\-language\fR <language>
19.IP
20Explicitly set the language for syntax highlighting. The language can be
21specified as a name (like 'C++' or 'LaTeX') or possible file extension
22(like 'cpp', 'hpp' or 'md'). Use '\-\-list\-languages' to show all supported
23language names and file extensions.
24.HP
25\fB\-L\fR, \fB\-\-list\-languages\fR
26.IP
27Display a list of supported languages for syntax highlighting.
28.HP
29\fB\-m\fR, \fB\-\-map\-syntax\fR <from:to>...
30.IP
31Map a file extension or file name to an existing syntax. For example, to
32highlight *.conf files with the INI syntax, use '\-m conf:ini'. To
33highlight files named '.myignore' with the Git Ignore syntax, use '\-m
34\&.myignore:gitignore'.
35.HP
36\fB\-\-theme\fR <theme>
37.IP
38Set the theme for syntax highlighting. Use '\-\-list\-themes' to see all
39available themes. To set a default theme, add the '\-\-theme="..."' option
40to the configuration file or export the BAT_THEME environment variable
41(e.g.: export BAT_THEME="...").
42.HP
43\fB\-\-list\-themes\fR
44.IP
45Display a list of supported themes for syntax highlighting.
46.HP
47\fB\-\-style\fR <style\-components>
48.IP
49Configure which elements (line numbers, file headers, grid borders, Git
50modifications, ..) to display in addition to the file contents. The
51argument is a comma\-separated list of components to display (e.g.
52\&'numbers,changes,grid') or a pre\-defined style ('full'). To set a default
53style, add the '\-\-style=".."' option to the configuration file or export
54the BAT_STYLE environment variable (e.g.: export BAT_STYLE=".."). Possible
55values: *auto*, full, plain, changes, header, grid, numbers, snip.
56.HP
57\fB\-p\fR, \fB\-\-plain\fR
58.IP
59Only show plain style, no decorations. This is an alias for
60\&'\-\-style=plain'. When '\-p' is used twice ('\-pp'), it also disables
61automatic paging (alias for '\-\-style=plain \fB\-\-pager\fR=\fI\,never\/\fR').
62.HP
63\fB\-n\fR, \fB\-\-number\fR
64.IP
65Only show line numbers, no other decorations. This is an alias for
66\&'\-\-style=numbers'
67.HP
68\fB\-A\fR, \fB\-\-show\-all\fR
69.IP
70Show non\-printable characters like space, tab or newline. Use '\-\-tabs' to
71control the width of the tab\-placeholders.
72.HP
73\fB\-r\fR, \fB\-\-line\-range\fR <N:M>...
74.IP
75Only print the specified range of lines for each file. For example:
76.RS
77.IP "\-\-line\-range 30:40"
78prints lines 30 to 40
79.IP "\-\-line\-range :40"
80prints lines 1 to 40
81.IP "\-\-line\-range 40:"
82prints lines 40 to the end of the file
83.RE
84.HP
85\fB\-H\fR, \fB\-\-highlight\-line\fR <N>...
86.IP
87Highlight the N\-th line with a different background color
88.HP
89\fB\-\-color\fR <when>
90.IP
91Specify when to use colored output. The automatic mode only enables colors
92if an interactive terminal is detected. Possible values: *auto*, never,
93always.
94.HP
95\fB\-\-italic\-text\fR <when>
96.IP
97Specify when to use ANSI sequences for italic text in the output. Possible
98values: always, *never*.
99.HP
100\fB\-\-decorations\fR <when>
101.IP
102Specify when to use the decorations that have been specified via
103\&'\-\-style'. The automatic mode only enables decorations if an interactive
104terminal is detected. Possible values: *auto*, never, always.
105.HP
106\fB\-\-paging\fR <when>
107.IP
108Specify when to use the pager. To control which pager is used, set the
109PAGER or BAT_PAGER environment variables (the latter takes precedence) or
110use the '\-\-pager' option. To disable the pager permanently, set BAT_PAGER
111to an empty string or set '\-\-paging=never' in the configuration file.
112Possible values: *auto*, never, always.
113.HP
114\fB\-\-pager\fR <command>
115.IP
116Determine which pager is used. This option will overwrite the PAGER and
117BAT_PAGER environment variables. The default pager is 'less'. To disable
118the pager completely, use the '\-\-paging' option. Example: '\-\-pager "less
119\fB\-RF\fR"'.
120.HP
121\fB\-\-wrap\fR <mode>
122.IP
123Specify the text\-wrapping mode (*auto*, never, character). The
124\&'\-\-terminal\-width' option can be used in addition to control the output
125width.
126.HP
127\fB\-\-tabs\fR <T>
128.IP
129Set the tab width to T spaces. Use a width of 0 to pass tabs through
130directly
131.HP
132\fB\-u\fR, \fB\-\-unbuffered\fR
133.IP
134This option exists for POSIX\-compliance reasons ('u' is for 'unbuffered').
135The output is always unbuffered \- this option is simply ignored.
136.HP
137\fB\-\-terminal\-width\fR <width>
138.IP
139Explicitly set the width of the terminal instead of determining it
140automatically. If prefixed with '+' or '\-', the value will be treated as
141an offset to the actual terminal width. See also: '\-\-wrap'.
142.HP
143\fB\-h\fR, \fB\-\-help\fR
144.IP
145Print this help message.
146.HP
147\fB\-V\fR, \fB\-\-version\fR
148.IP
149Show version information.
150.SH "ARGS"
151.IP
152<FILE>...
153.IP
154File(s) to print / concatenate. Use a dash ('\-') or no argument at all to read
155from standard input.
156.SH "SUBCOMMANDS"
157.IP
158cache
159Modify the syntax\-definition and theme cache