on master help sign in
Add initial version of man page, see #52
commitb682679776121d223300a4d6f14cfdbc81226947 authorsharkdp <davidpeter@web.de> dateMon 27 Aug 2018, 22:57 (8 years ago) parent8177143
1 file changed+109
doc/bat.1+109
doc/bat.1new file+109
@@ -0,0 +1,109 @@
1+.TH BAT "1"
2+.SH NAME
3+bat \- manual page for bat
4+.SH DESCRIPTION
5+bat - a cat(1) clone with syntax highlighting and Git integration.
6+.SH "USAGE"
7+.IP
8+bat [OPTIONS] [FILE]...
9+.IP
10+bat <SUBCOMMAND>
11+.SH "OPTIONS"
12+.HP
13+\fB\-l\fR, \fB\-\-language\fR <language>
14+.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.
19+.HP
20+\fB\-\-list\-languages\fR
21+.IP
22+Display a list of supported languages for syntax highlighting.
23+.HP
24+\fB\-\-theme\fR <theme>
25+.IP
26+Set the theme for syntax highlighting. Use '\-\-list\-themes' to see all
27+available themes. To set a default theme, export the BAT_THEME environment
28+variable (e.g.: export BAT_THEME="TwoDark").
29+.HP
30+\fB\-\-list\-themes\fR
31+.IP
32+Display a list of supported themes for syntax highlighting.
33+.HP
34+\fB\-\-style\fR <style\-components>
35+.IP
36+Configure which elements (line numbers, file headers, grid borders, Git
37+modifications, ..) to display in addition to the file contents. The argument
38+is a comma\-separated list of components to display (e.g.
39+\&'numbers,changes,grid') or a pre\-defined style ('full') [default: auto]
40+[possible values: auto, full, plain, changes, header, grid, numbers]
41+.HP
42+\fB\-p\fR
43+.IP
44+Only show plain style, no decorations. This is an alias for '\-\-style=plain'
45+.HP
46+\fB\-n\fR, \fB\-\-number\fR
47+.IP
48+Only show line numbers, no other decorations. This is an alias for
49+\&'\-\-style=numbers'
50+.HP
51+\fB\-\-line\-range\fR <N:M>
52+.IP
53+Only print the specified range of lines for each file. For example:
54+.RS
55+.IP "\-\-line\-range 30:40"
56+prints lines 30 to 40
57+.IP "\-\-line\-range :40"
58+prints lines 1 to 40
59+.IP "\-\-line\-range 40:"
60+prints lines 40 to the end of the file
61+.RE
62+.HP
63+\fB\-\-color\fR <when>
64+.IP
65+Specify when to use colored output. The automatic mode only enables colors if
66+an interactive terminal is detected. [default: auto] [possible values: auto,
67+never, always]
68+.HP
69+\fB\-\-decorations\fR <when>
70+.IP
71+Specify when to use the decorations that have been specified via '\-\-style'.
72+The automatic mode only enables decorations if an interactive terminal is
73+detected. [default: auto] [possible values: auto, never, always]
74+.HP
75+\fB\-\-paging\fR <when>
76+.IP
77+Specify when to use the pager. To control which pager is used, set the PAGER
78+or BAT_PAGER environment variables (the latter takes precedence). The default
79+pager is 'less'. To disable the pager permanently, set BAT_PAGER to an empty
80+string. [default: auto] [possible values: auto, never, always]
81+.HP
82+\fB\-\-wrap\fR <mode>
83+.IP
84+Specify the text\-wrapping mode. [default: character]
85+[possible values: character, never]
86+.HP
87+\fB\-u\fR
88+.IP
89+This option exists for POSIX\-compliance reasons ('u' is for 'unbuffered'). The
90+output is always unbuffered \- this option is simply ignored.
91+.HP
92+\fB\-h\fR, \fB\-\-help\fR
93+.IP
94+Print this help message.
95+.HP
96+\fB\-V\fR, \fB\-\-version\fR
97+.IP
98+Show version information.
99+.SH "ARGS"
100+.IP
101+<FILE>...
102+.IP
103+File(s) to print / concatenate. Use a dash ('\-') or no argument at all to read
104+from standard input.
105+.SH "SUBCOMMANDS"
106+.IP
107+cache
108+.IP
109+Modify the syntax\-definition and theme cache. See "bat cache --help" for more information