-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathsyntax_test_bat.txt
159 lines (143 loc) · 8.38 KB
/
syntax_test_bat.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
# SYNTAX TEST "cmd-help.sublime-syntax"
bat 0.18.2
A cat(1) clone with syntax highlighting and Git integration.
USAGE:
# <- string.section-heading.cmd-help
#^^^^^ string.section-heading.cmd-help
bat [OPTIONS] [FILE]...
# ^^^ constant.other.keyword.cmd-help
# ^^^^^^^ - entity.name.function.option.cmd-help
bat <SUBCOMMAND>
# ^^^ constant.other.keyword.cmd-help
# ^^^^^^^^^^^^ - constant.other.keyword.cmd-help
#todo: handle Usage lines
OPTIONS:
#^^^^^^^ string.section-heading.cmd-help
-A, --show-all
# ^^ entity.name.function.option.cmd-help
# ^^ - entity.name.function.option.cmd-help
# ^^^^^^^^^^ entity.name.function.option.cmd-help
Show non-printable characters like space, tab or newline. This option can also be used
# <- - option-def.cmd-help
to print binary files. Use '--tabs' to control the width of the tab-placeholders.
-p, --plain
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
--pager=never').
# ^^^^^^^ - entity.name.function.option.cmd-help
-l, --language <language>
# ^ - entity.name.function.option.cmd-help - entity.name.function.option.cmd-help keyword.other.argument.cmd-help
# ^^^^^^^^^^ entity.name.function.option.cmd-help keyword.other.argument.cmd-help
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.
-H, --highlight-line <N:M>...
# ^^^^^ entity.name.function.option.cmd-help keyword.other.argument.cmd-help
Highlight the specified line ranges with a different background color For example:
'--highlight-line 40' highlights line 40
'--highlight-line 30:40' highlights lines 30 to 40
'--highlight-line :40' highlights lines 1 to 40
'--highlight-line 40:' highlights lines 40 to the end of the file
--file-name <name>...
# ^^^^^^^^^^^ entity.name.function.option.cmd-help
# ^^^^^^^^^ entity.name.function.option.cmd-help keyword.other.argument.cmd-help
Specify the name to display for a file. Useful when piping data to bat from STDIN when
bat does not otherwise know the filename. Note that the provided file name is also used
for syntax detection.
-d, --diff
Only show lines that have been added/removed/modified with respect to the Git index. Use
--diff-context=N to control how much context you want to see.
--diff-context <N>
Include N lines of context around added/removed/modified lines when using '--diff'.
--tabs <T>
Set the tab width to T spaces. Use a width of 0 to pass tabs through directly
--wrap <mode>
Specify the text-wrapping mode (*auto*, never, character). The '--terminal-width' option
can be used in addition to control the output width.
--terminal-width <width>
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'.
-n, --number
Only show line numbers, no other decorations. This is an alias for '--style=numbers'
--color <when>
Specify when to use colored output. The automatic mode only enables colors if an
interactive terminal is detected - colors are automatically disabled if the output goes
to a pipe.
Possible values: *auto*, never, always.
--italic-text <when>
Specify when to use ANSI sequences for italic text in the output. Possible values:
always, *never*.
--decorations <when>
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.
-f, --force-colorization
Alias for '--decorations=always --color=always'. This is useful if the output of bat is
piped to another program, but you want to keep the colorization/decorations.
--paging <when>
Specify when to use the pager. To disable the pager, use --paging=never' or its
alias,'-P'. To disable the pager permanently, set BAT_PAGER to an empty string. To
# ^^ - entity.name.function.option.cmd-help
control which pager is used, see the '--pager' option. Possible values: *auto*, never,
always.
--pager <command>
Determine which pager is used. This option will override the PAGER and BAT_PAGER
environment variables. The default pager is 'less'. To control when the pager is used,
see the '--paging' option. Example: '--pager "less -RF"'.
-m, --map-syntax <glob:syntax>...
Map a glob pattern to an existing syntax name. The glob pattern is matched on the full
path and the filename. For example, to highlight *.build files with the Python syntax,
use -m '*.build:Python'. To highlight files named '.myignore' with the Git Ignore
# ^^ - entity.name.function.option.cmd-help
syntax, use -m '.myignore:Git Ignore'. Note that the right-hand side is the *name* of
the syntax, not a file extension.
--theme <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="...").
--list-themes
Display a list of supported themes for syntax highlighting.
--style <components>
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:
* full: enables all available components.
* auto: same as 'full', unless the output is piped (default).
* plain: disables all available components.
* changes: show Git modification markers.
* header: show filenames before the content.
* grid: vertical/horizontal lines to separate side bar
and the header from the content.
* rule: horizontal lines to delimit files.
* numbers: show line numbers in the side bar.
* snip: draw separation lines between distinct line ranges.
-r, --line-range <N:M>...
Only print the specified range of lines for each file. For example:
'--line-range 30:40' prints lines 30 to 40
'--line-range :40' prints lines 1 to 40
'--line-range 40:' prints lines 40 to the end of the file
'--line-range 40' only prints line 40
-L, --list-languages
Display a list of supported languages for syntax highlighting.
-u, --unbuffered
This option exists for POSIX-compliance reasons ('u' is for 'unbuffered'). The output is
always unbuffered - this option is simply ignored.
--diagnostic
Show diagnostic information for bug reports.
-h, --help
Print this help message.
-V, --version
Show version information.
ARGS:
<FILE>...
# ^^^^^^^^^ keyword.other.argument.cmd-help
File(s) to print / concatenate. Use a dash ('-') or no argument at all to read from
standard input.
SUBCOMMANDS:
cache Modify the syntax-definition and theme cache
# ^^^^^ constant.other.keyword.cmd-help
Note: `bat -h` prints a short and concise overview while `bat --help` gives all details.