mirror of
https://github.com/sharkdp/bat
synced 2024-12-21 09:43:06 +00:00
214 lines
8.1 KiB
Groff
Vendored
214 lines
8.1 KiB
Groff
Vendored
.TH {{PROJECT_EXECUTABLE_UPPERCASE}} "1"
|
|
.SH NAME
|
|
{{PROJECT_EXECUTABLE}} \- a cat(1) clone with syntax highlighting and Git integration.
|
|
.SH "USAGE"
|
|
.IP "{{PROJECT_EXECUTABLE}} [OPTIONS] [FILE]..."
|
|
.IP "{{PROJECT_EXECUTABLE}} cache [CACHE-OPTIONS] [--build|--clear]
|
|
.SH DESCRIPTION
|
|
{{PROJECT_EXECUTABLE}} prints the syntax-highlighted content of a collection of FILEs to the
|
|
terminal. If no FILE is specified, or when FILE is '-', it reads from standard input.
|
|
|
|
{{PROJECT_EXECUTABLE}} supports a large number of programming and markup languages.
|
|
It also communicates with git(1) to show modifications with respect to the git index.
|
|
{{PROJECT_EXECUTABLE}} automatically pipes its output through a pager (by default: less).
|
|
|
|
Whenever the output of {{PROJECT_EXECUTABLE}} goes to a non-interactive terminal, i.e. when the
|
|
output is piped into another process or into a file, {{PROJECT_EXECUTABLE}} will act as a drop-in
|
|
replacement for cat(1) and fall back to printing the plain file contents.
|
|
|
|
.SH "OPTIONS"
|
|
General remarks: Command-line options like '-l'/'--language' that take values can be specified as
|
|
either '--language value', '--language=value', '-l value' or '-lvalue'.
|
|
.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.
|
|
.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').
|
|
.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.
|
|
.HP
|
|
\fB\-H\fR, \fB\-\-highlight\-line\fR <N:M>...
|
|
.IP
|
|
Highlight the specified line ranges with a different background color For example:
|
|
.RS
|
|
.IP "\-\-highlight\-line 40"
|
|
highlights line 40
|
|
.IP "\-\-highlight\-line 30:40"
|
|
highlights lines 30 to 40
|
|
.IP "\-\-highlight\-line :40"
|
|
highlights lines 1 to 40
|
|
.IP "\-\-highlight\-line 40:"
|
|
highlights lines 40 to the end of the file
|
|
.RE
|
|
.HP
|
|
\fB\-\-tabs\fR <T>
|
|
.IP
|
|
Set the tab width to T spaces. Use a width of 0 to pass tabs through directly
|
|
.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.
|
|
.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'.
|
|
.HP
|
|
\fB\-n\fR, \fB\-\-number\fR
|
|
.IP
|
|
Only show line numbers, no other decorations. This is an alias for '\-\-style=numbers'
|
|
.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.
|
|
.HP
|
|
\fB\-\-italic\-text\fR <when>
|
|
.IP
|
|
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.
|
|
.HP
|
|
\fB\-f\fR, \fB\-\-force\-colorization\fR
|
|
.IP
|
|
Alias for '--decorations=always --color=always'. This is useful \
|
|
if the output of {{PROJECT_EXECUTABLE}} is piped to another program, but you want \
|
|
to keep the colorization/decorations.
|
|
.HP
|
|
\fB\-\-paging\fR <when>
|
|
.IP
|
|
Specify when to use the pager. To disable the pager, use \&'\-\-paging=never' or its alias,
|
|
\fB-P\fR. To disable the pager permanently, set BAT_PAGER to an empty string. To control
|
|
which pager is used, see the '\-\-pager' option. Possible values: *auto*, never, always.
|
|
.HP
|
|
\fB\-\-pager\fR <command>
|
|
.IP
|
|
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 \fB\-RF\fR"'.
|
|
.HP
|
|
\fB\-m\fR, \fB\-\-map\-syntax\fR <glob-pattern:syntax-name>...
|
|
.IP
|
|
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
|
|
syntax, use -m '.myignore:Git Ignore'.
|
|
.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="...").
|
|
.HP
|
|
\fB\-\-list\-themes\fR
|
|
.IP
|
|
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, snip.
|
|
.HP
|
|
\fB\-r\fR, \fB\-\-line\-range\fR <N:M>...
|
|
.IP
|
|
Only print the specified range of lines for each file. For example:
|
|
.RS
|
|
.IP "\-\-line\-range 30:40"
|
|
prints lines 30 to 40
|
|
.IP "\-\-line\-range :40"
|
|
prints lines 1 to 40
|
|
.IP "\-\-line\-range 40:"
|
|
prints lines 40 to the end of the file
|
|
.RE
|
|
.HP
|
|
\fB\-L\fR, \fB\-\-list\-languages\fR
|
|
.IP
|
|
Display a list of supported languages for syntax highlighting.
|
|
.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.
|
|
.HP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
.IP
|
|
Print this help message.
|
|
.HP
|
|
\fB\-V\fR, \fB\-\-version\fR
|
|
.IP
|
|
Show version information.
|
|
.SH "POSITIONAL ARGUMENTS"
|
|
.HP
|
|
\fB<FILE>...\fR
|
|
.IP
|
|
Files to print and concatenate. Use a dash ('\-') or no argument at all to read from
|
|
standard input.
|
|
.SH "SUBCOMMANDS"
|
|
.HP
|
|
\fBcache\fR - Modify the syntax\-definition and theme cache.
|
|
.SH "FILES"
|
|
{{PROJECT_EXECUTABLE}} can also be customized with a configuration file. The location of the file
|
|
is dependent on your operating system. To get the default path for your system, call:
|
|
|
|
\fB{{PROJECT_EXECUTABLE}} --config-file\fR
|
|
|
|
Alternatively, you can use the BAT_CONFIG_PATH environment variable to point {{PROJECT_EXECUTABLE}} to a non-default
|
|
location of the configuration file.
|
|
.SH "ADDING CUSTOM LANGUAGES"
|
|
{{PROJECT_EXECUTABLE}} supports Sublime Text \fB.sublime-syntax\fR language files, and can be
|
|
customized to add additional languages to your local installation. To do this, add the \fB.sublime-syntax\fR language
|
|
files to `\fB$({{PROJECT_EXECUTABLE}} --config-dir)/syntaxes\fR` and run `\fB{{PROJECT_EXECUTABLE}} cache --build\fR`.
|
|
|
|
\fBExample:\fR
|
|
|
|
.RS 0.5i
|
|
mkdir -p "$({{PROJECT_EXECUTABLE}} --config-dir)/syntaxes"
|
|
.br
|
|
cd "$({{PROJECT_EXECUTABLE}} --config-dir)/syntaxes"
|
|
|
|
# Put new '.sublime-syntax' language definition files
|
|
.br
|
|
# in this folder (or its subdirectories), for example:
|
|
.br
|
|
git clone https://github.com/tellnobody1/sublime-purescript-syntax
|
|
|
|
# And then build the cache.
|
|
.br
|
|
{{PROJECT_EXECUTABLE}} cache --build
|
|
.RE
|
|
|
|
Once the cache is built, the new language will be visible in `\fB{{PROJECT_EXECUTABLE}} --list-languages\fR`.
|
|
.br
|
|
If you ever want to remove the custom languages, you can clear the cache with `\fB{{PROJECT_EXECUTABLE}} cache --clear\fR`.
|
|
|
|
.SH "ADDING CUSTOM THEMES"
|
|
Similarly to custom languages, {{PROJECT_EXECUTABLE}} supports Sublime Text \fB.tmTheme\fR themes.
|
|
These can be installed to `\fB$({{PROJECT_EXECUTABLE}} --config-dir)/themes\fR`, and are added to the cache with
|
|
`\fB{{PROJECT_EXECUTABLE}} cache --build`.
|
|
.SH "MORE INFORMATION"
|
|
|
|
For more information and up-to-date documentation, visit the {{PROJECT_EXECUTABLE}} repo:
|
|
.br
|
|
\fBhttps://github.com/sharkdp/bat\fR
|