@@ -0,0 +1,641 @@
1+<p align="center">
2+ <img src="doc/logo-header.svg" alt="bat - a cat clone with wings"><br>
3+ <a href="https://travis-ci.org/sharkdp/bat"><img src="https://travis-ci.org/sharkdp/bat.svg?branch=master" alt="Build Status"></a>
4+ <a href="https://ci.appveyor.com/project/sharkdp/bat"><img src="https://ci.appveyor.com/api/projects/status/cptsmtbiwbnr2vhf/branch/master?svg=true"></a>
5+ <img src="https://img.shields.io/crates/l/bat.svg" alt="license">
6+ <a href="https://crates.io/crates/bat"><img src="https://img.shields.io/crates/v/bat.svg?colorB=319e8c" alt="Version info"></a><br>
7+ Клон утилиты <i>cat(1)</i> с поддержкой выделения синтаксиса и Git
8+</p>
9+
10+<p align="center">
11+ <a href="#syntax-highlighting">Главные преимущества</a> •
12+ <a href="#how-to-use">Использование</a> •
13+ <a href="#installation">Установка</a> •
14+ <a href="#customization">Кастомизация</a> •
15+ <a href="#project-goals-and-alternatives">Цели проекта и его альтернативы </a> •
16+ Translation [<a href="https://github.com/chinanf-boy/bat-zh">中文</a>][<a href="doc/README-ja.md">日本語</a>][<a href="doc/README-ko.md">한국어</a>][<a href="doc/README-ru.md">日本語</a>][<a href="doc/README-ko.md">Русский</a>]
17+</p>
18+
19+### Выделение синтаксиса
20+
21+`bat` поддерживает выделение синтаксиса для огромного количества языков программирования и разметки:
22+
23+
24+
25+### Интеграция с Git
26+`bat` использует `git` чтобы показать изменения в коде
27+(смотрите на левый сайдбар):
28+
29+
30+
31+### Show non-printable characters
32+
33+Вы можете использовать `-A` / `--show-all` флаг чтобы показать символы, которые невозможно напечатать:
34+
35+
36+
37+### Автоматическое разделение текста
38+
39+`bat` умеет траслировать вывод в `less` если вывод слишком большой, чтобы уместится на экране целиком
40+
41+### Объединение файлов
42+
43+О..вы так же можете объединять файлы :wink:. Всегда когда
44+`bat` обнаруживает неинтерактивный терминал (например когда вы направляете вывод в файл или процесс), `bat` будет работать как вставная замена `cat` и откатится к выводу это файла как обычного текста
45+
46+## Как использовать
47+
48+Вывести единственный файл в терминале
49+
50+```bash
51+> bat README.md
52+```
53+
54+Отобразить сразу несколько файлов в терминале
55+
56+```bash
57+> bat src/*.rs
58+```
59+
60+Читаем из stdin и определяем синтаксис автоматически
61+
62+```bash
63+> curl -s https://sh.rustup.rs | bat
64+```
65+
66+Читает из stdin и указываем что это за язык
67+
68+```bash
69+> yaml2json .travis.yml | json_pp | bat -l json
70+```
71+
72+Вывести и выделить неотображаемые символы
73+```bash
74+> bat -A /etc/hosts
75+```
76+
77+Использование как замена `cat`
78+
79+```bash
80+bat > note.md # мгновенно создаем новый файл
81+
82+bat header.md content.md footer.md > document.md
83+
84+bat -n main.rs # показываем только количество строк
85+
86+bat f - g # выводит 'f' в stdin, а потом 'g'.
87+```
88+
89+### Интеграция с другими утилитами
90+
91+#### `find` или `fd`
92+
93+Вы можете использовать флаг `-exec` в `find` чтобы посмотреть превью всех файлов в `bat`
94+```bash
95+find … -exec bat {} +
96+```
97+
98+Если вы используете [`fd`](https://github.com/sharkdp/fd), вы вполне можете использоваль флаг `-X`/`--exec-batch` чтобы сделать тоже самое:
99+```bash
100+fd … -X bat
101+```
102+
103+#### `ripgrep`
104+
105+С помощью [`batgrep`](https://github.com/eth-p/bat-extras/blob/master/doc/batgrep.md), `bat` может быть использован для вывода результата запроса [`ripgrep`](https://github.com/BurntSushi/ripgrep)
106+
107+```bash
108+batgrep needle src/
109+```
110+
111+#### `tail -f`
112+
113+`bat` can be combined with `tail -f` to continuously monitor a given file with syntax highlighting.
114+```bash
115+tail -f /var/log/pacman.log | bat --paging=never -l log
116+```
117+Note that we have to switch off paging in order for this to work. We have also specified the syntax
118+explicitly (`-l log`), as it can not be auto-detected in this case.
119+
120+#### `git`
121+
122+You can combine `bat` with `git show` to view an older version of a given file with proper syntax
123+highlighting:
124+```bash
125+git show v0.6.0:src/main.rs | bat -l rs
126+```
127+
128+Note that syntax highlighting within diffs is currently not supported. If you are looking for this, check out [`delta`](https://github.com/dandavison/delta).
129+
130+#### `xclip`
131+
132+The line numbers and Git modification markers in the output of `bat` can make it hard to copy
133+the contents of a file. To prevent this, you can call `bat` with the `-p`/`--plain` option or
134+simply pipe the output into `xclip`:
135+```bash
136+bat main.cpp | xclip
137+```
138+`bat` will detect that the output is being redirected and print the plain file contents.
139+
140+#### `man`
141+
142+`bat` can be used as a colorizing pager for `man`, by setting the
143+`MANPAGER` environment variable:
144+
145+```bash
146+export MANPAGER="sh -c 'col -bx | bat -l man -p'"
147+man 2 select
148+```
149+
150+It might also be necessary to set `MANROFFOPT="-c"` if you experience
151+formatting problems.
152+
153+If you prefer to have this bundled in a new command, you can also use [`batman`](https://github.com/eth-p/bat-extras/blob/master/doc/batman.md).
154+
155+Note that the [Manpage syntax](assets/syntaxes/02_Extra/Manpage.sublime-syntax) is developed in this repository and still needs some work.
156+
157+#### `prettier` / `shfmt` / `rustfmt`
158+
159+The [`prettybat`](https://github.com/eth-p/bat-extras/blob/master/doc/prettybat.md) script is a wrapper that will format code and print it with `bat`.
160+
161+
162+## Installation
163+
164+[](https://repology.org/project/bat/versions)
165+
166+### On Ubuntu (using `apt`)
167+*... and other Debian-based Linux distributions.*
168+
169+`bat` is making its way through the [Ubuntu](https://packages.ubuntu.com/eoan/bat) and
170+[Debian](https://packages.debian.org/sid/bat) package release process, and is available
171+for Ubuntu as of Eoan 19.10. On Debian `bat` is currently only available on the unstable
172+"Sid" branch.
173+
174+If your Ubuntu/Debian installation is new enough you can simply run:
175+
176+```bash
177+apt install bat
178+```
179+
180+If you install `bat` this way, please note that the executable may be installed as `batcat` instead of `bat` (due to [a name
181+clash with another package](https://github.com/sharkdp/bat/issues/982)). You can set up a `bat -> batcat` symlink or alias to prevent any issues that may come up because of this and to be consistent with other distrutions:
182+``` bash
183+mkdir -p ~/.local/bin
184+ln -s /usr/bin/batcat ~/.local/bin/bat
185+```
186+
187+### On Ubuntu (using most recent `.deb` packages)
188+*... and other Debian-based Linux distributions.*
189+
190+If the package has not yet been promoted to your Ubuntu/Debian installation, or you want
191+the most recent release of `bat`, download the latest `.deb` package from the
192+[release page](https://github.com/sharkdp/bat/releases) and install it via:
193+
194+```bash
195+sudo dpkg -i bat_0.15.4_amd64.deb # adapt version number and architecture
196+```
197+
198+### On Alpine Linux
199+
200+You can install [the `bat` package](https://pkgs.alpinelinux.org/packages?name=bat)
201+from the official sources, provided you have the appropriate repository enabled:
202+
203+```bash
204+apk add bat
205+```
206+
207+### On Arch Linux
208+
209+You can install [the `bat` package](https://www.archlinux.org/packages/community/x86_64/bat/)
210+from the official sources:
211+
212+```bash
213+pacman -S bat
214+```
215+
216+### On Fedora
217+
218+You can install [the `bat` package](https://koji.fedoraproject.org/koji/packageinfo?packageID=27506) from the official [Fedora Modular](https://docs.fedoraproject.org/en-US/modularity/using-modules/) repository.
219+
220+```bash
221+dnf install bat
222+```
223+
224+### On Gentoo Linux
225+
226+You can install [the `bat` package](https://packages.gentoo.org/packages/sys-apps/bat)
227+from the official sources:
228+
229+```bash
230+emerge sys-apps/bat
231+```
232+
233+### On Void Linux
234+
235+You can install `bat` via xbps-install:
236+```bash
237+xbps-install -S bat
238+```
239+
240+### On FreeBSD
241+
242+You can install a precompiled [`bat` package](https://www.freshports.org/textproc/bat) with pkg:
243+
244+```bash
245+pkg install bat
246+```
247+
248+or build it on your own from the FreeBSD ports:
249+
250+```bash
251+cd /usr/ports/textproc/bat
252+make install
253+```
254+
255+### Via nix
256+
257+You can install `bat` using the [nix package manager](https://nixos.org/nix):
258+
259+```bash
260+nix-env -i bat
261+```
262+
263+### On openSUSE
264+
265+You can install `bat` with zypper:
266+
267+```bash
268+zypper install bat
269+```
270+
271+### On macOS
272+
273+You can install `bat` with [Homebrew](http://braumeister.org/formula/bat):
274+
275+```bash
276+brew install bat
277+```
278+
279+Or install `bat` with [MacPorts](https://ports.macports.org/port/bat/summary):
280+
281+```bash
282+port install bat
283+```
284+
285+### On Windows
286+
287+There are a few options to install `bat` on Windows. Once you have installed `bat`,
288+take a look at the ["Using `bat` on Windows"](#using-bat-on-windows) section.
289+
290+#### With Chocolatey
291+
292+You can install `bat` via [Chocolatey](https://chocolatey.org/packages/Bat):
293+```bash
294+choco install bat
295+```
296+
297+#### With Scoop
298+
299+You can install `bat` via [scoop](https://scoop.sh/):
300+```bash
301+scoop install bat
302+```
303+
304+You will need to install the [Visual C++ Redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) package.
305+
306+#### From prebuilt binaries:
307+
308+You can download prebuilt binaries from the [Release page](https://github.com/sharkdp/bat/releases),
309+
310+You will need to install the [Visual C++ Redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) package.
311+
312+### Via Docker
313+
314+There is a [Docker image](https://hub.docker.com/r/danlynn/bat/) that you can use to run `bat` in a container:
315+```bash
316+docker pull danlynn/bat
317+alias bat='docker run -it --rm -e BAT_THEME -e BAT_STYLE -e BAT_TABS -v "$(pwd):/myapp" danlynn/bat'
318+```
319+
320+### Via Ansible
321+
322+You can install `bat` with [Ansible](https://www.ansible.com/):
323+
324+```bash
325+# Install role on local machine
326+ansible-galaxy install aeimer.install_bat
327+```
328+
329+```yaml
330+---
331+# Playbook to install bat
332+- host: all
333+ roles:
334+ - aeimer.install_bat
335+```
336+
337+- [Ansible Galaxy](https://galaxy.ansible.com/aeimer/install_bat)
338+- [GitHub](https://github.com/aeimer/ansible-install-bat)
339+
340+This should work with the following distributions:
341+- Debian/Ubuntu
342+- ARM (eg. Raspberry PI)
343+- Arch Linux
344+- Void Linux
345+- FreeBSD
346+- MacOS
347+
348+### From binaries
349+
350+Check out the [Release page](https://github.com/sharkdp/bat/releases) for
351+prebuilt versions of `bat` for many different architectures. Statically-linked
352+binaries are also available: look for archives with `musl` in the file name.
353+
354+### From source
355+
356+If you want to build `bat` from source, you need Rust 1.40 or
357+higher. You can then use `cargo` to build everything:
358+
359+```bash
360+cargo install --locked bat
361+```
362+
363+## Customization
364+
365+### Highlighting theme
366+
367+Use `bat --list-themes` to get a list of all available themes for syntax
368+highlighting. To select the `TwoDark` theme, call `bat` with the
369+`--theme=TwoDark` option or set the `BAT_THEME` environment variable to
370+`TwoDark`. Use `export BAT_THEME="TwoDark"` in your shell's startup file to
371+make the change permanent. Alternatively, use `bat`s
372+[configuration file](https://github.com/sharkdp/bat#configuration-file).
373+
374+If you want to preview the different themes on a custom file, you can use
375+the following command (you need [`fzf`](https://github.com/junegunn/fzf) for this):
376+```bash
377+bat --list-themes | fzf --preview="bat --theme={} --color=always /path/to/file"
378+```
379+
380+`bat` looks good on a dark background by default. However, if your terminal uses a
381+light background, some themes like `GitHub` or `OneHalfLight` will work better for you.
382+You can also use a custom theme by following the
383+['Adding new themes' section below](https://github.com/sharkdp/bat#adding-new-themes).
384+
385+### Output style
386+
387+You can use the `--style` option to control the appearance of `bat`s output.
388+You can use `--style=numbers,changes`, for example, to show only Git changes
389+and line numbers but no grid and no file header. Set the `BAT_STYLE` environment
390+variable to make these changes permanent or use `bat`s
391+[configuration file](https://github.com/sharkdp/bat#configuration-file).
392+
393+### Adding new syntaxes / language definitions
394+
395+`bat` uses the excellent [`syntect`](https://github.com/trishume/syntect/)
396+library for syntax highlighting. `syntect` can read any
397+[Sublime Text `.sublime-syntax` file](https://www.sublimetext.com/docs/3/syntax.html)
398+and theme. To add new syntax definitions, do the following.
399+
400+Create a folder with syntax definition files:
401+
402+```bash
403+mkdir -p "$(bat --config-dir)/syntaxes"
404+cd "$(bat --config-dir)/syntaxes"
405+
406+# Put new '.sublime-syntax' language definition files
407+# in this folder (or its subdirectories), for example:
408+git clone https://github.com/tellnobody1/sublime-purescript-syntax
409+```
410+
411+Now use the following command to parse these files into a binary cache:
412+
413+```bash
414+bat cache --build
415+```
416+
417+Finally, use `bat --list-languages` to check if the new languages are available.
418+
419+If you ever want to go back to the default settings, call:
420+
421+```bash
422+bat cache --clear
423+```
424+
425+### Adding new themes
426+
427+This works very similar to how we add new syntax definitions.
428+
429+First, create a folder with the new syntax highlighting themes:
430+```bash
431+mkdir -p "$(bat --config-dir)/themes"
432+cd "$(bat --config-dir)/themes"
433+
434+# Download a theme in '.tmTheme' format, for example:
435+git clone https://github.com/greggb/sublime-snazzy
436+
437+# Update the binary cache
438+bat cache --build
439+```
440+
441+Finally, use `bat --list-themes` to check if the new themes are available.
442+
443+### Using a different pager
444+
445+`bat` uses the pager that is specified in the `PAGER` environment variable. If this variable is not
446+set, `less` is used by default. If you want to use a different pager, you can either modify the
447+`PAGER` variable or set the `BAT_PAGER` environment variable to override what is specified in
448+`PAGER`.
449+
450+If you want to pass command-line arguments to the pager, you can also set them via the
451+`PAGER`/`BAT_PAGER` variables:
452+
453+```bash
454+export BAT_PAGER="less -RF"
455+```
456+
457+Instead of using environment variables, you can also use `bat`s [configuration file](https://github.com/sharkdp/bat#configuration-file) to configure the pager (`--pager` option).
458+
459+**Note**: By default, if the pager is set to `less` (and no command-line options are specified),
460+`bat` will pass the following command line options to the pager: `-R`/`--RAW-CONTROL-CHARS`,
461+`-F`/`--quit-if-one-screen` and `-X`/`--no-init`. The last option (`-X`) is only used for `less`
462+versions older than 530.
463+
464+The `-R` option is needed to interpret ANSI colors correctly. The second option (`-F`) instructs
465+less to exit immediately if the output size is smaller than the vertical size of the terminal.
466+This is convenient for small files because you do not have to press `q` to quit the pager. The
467+third option (`-X`) is needed to fix a bug with the `--quit-if-one-screen` feature in old versions
468+of `less`. Unfortunately, it also breaks mouse-wheel support in `less`.
469+
470+If you want to enable mouse-wheel scrolling on older versions of `less`, you can pass just `-R` (as
471+in the example above, this will disable the quit-if-one-screen feature). For less 530 or newer,
472+it should work out of the box.
473+
474+### Dark mode
475+
476+If you make use of the dark mode feature in macOS, you might want to configure `bat` to use a different
477+theme based on the OS theme. The following snippet uses the `default` theme when in the _dark mode_
478+and the `GitHub` theme when in the _light mode_.
479+
480+```bash
481+alias cat="bat --theme=\$(defaults read -globalDomain AppleInterfaceStyle &> /dev/null && echo default || echo GitHub)"
482+```
483+
484+## Configuration file
485+
486+`bat` can also be customized with a configuration file. The location of the file is dependent
487+on your operating system. To get the default path for your system, call
488+```
489+bat --config-file
490+```
491+
492+Alternatively, you can use the `BAT_CONFIG_PATH` environment variable to point `bat` to a
493+non-default location of the configuration file:
494+```bash
495+export BAT_CONFIG_PATH="/path/to/bat.conf"
496+```
497+
498+A default configuration file can be created with the `--generate-config-file` option.
499+```bash
500+bat --generate-config-file
501+```
502+
503+### Format
504+
505+The configuration file is a simple list of command line arguments. Use `bat --help` to see a full list of possible options and values. In addition, you can add comments by prepending a line with the `#` character.
506+
507+Example configuration file:
508+```bash
509+# Set the theme to "TwoDark"
510+--theme="TwoDark"
511+
512+# Show line numbers, Git modifications and file header (but no grid)
513+--style="numbers,changes,header"
514+
515+# Use italic text on the terminal (not supported on all terminals)
516+--italic-text=always
517+
518+# Use C++ syntax for .ino files
519+--map-syntax "*.ino:C++"
520+
521+# Use ".gitignore"-style highlighting for ".ignore" files
522+--map-syntax ".ignore:Git Ignore"
523+```
524+
525+## Using `bat` on Windows
526+
527+`bat` mostly works out-of-the-box on Windows, but a few features may need extra configuration.
528+
529+### Paging
530+
531+Windows only includes a very limited pager in the form of `more`. You can download a Windows binary
532+for `less` [from its homepage](http://www.greenwoodsoftware.com/less/download.html) or [through
533+Chocolatey](https://chocolatey.org/packages/Less). To use it, place the binary in a directory in
534+your `PATH` or [define an environment variable](#using-a-different-pager). The [Chocolatey package](#on-windows) installs `less` automatically.
535+
536+### Colors
537+
538+Windows 10 natively supports colors in both `conhost.exe` (Command Prompt) and PowerShell since
539+[v1511](https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1511_(November_Update)), as
540+well as in newer versions of bash. On earlier versions of Windows, you can use
541+[Cmder](http://cmder.net/), which includes [ConEmu](https://conemu.github.io/).
542+
543+**Note:** The Git and MSYS versions of `less` do not correctly interpret colors on Windows. If you
544+don’t have any other pagers installed, you can disable paging entirely by passing `--paging=never`
545+or by setting `BAT_PAGER` to an empty string.
546+
547+### Cygwin
548+
549+`bat` on Windows does not natively support Cygwin's unix-style paths (`/cygdrive/*`). When passed an absolute cygwin path as an argument, `bat` will encounter the following error: `The system cannot find the path specified. (os error 3)`
550+
551+This can be solved by creating a wrapper or adding the following function to your `.bash_profile` file:
552+
553+```bash
554+bat() {
555+ local index
556+ local args=("$@")
557+ for index in $(seq 0 ${#args[@]}) ; do
558+ case "${args[index]}" in
559+ -*) continue;;
560+ *) [ -e "${args[index]}" ] && args[index]="$(cygpath --windows "${args[index]}")";;
561+ esac
562+ done
563+ command bat "${args[@]}"
564+}
565+```
566+
567+## Troubleshooting
568+
569+### Terminals & colors
570+
571+`bat` handles terminals *with* and *without* truecolor support. However, the colors in the syntax
572+highlighting themes are not optimized for 8-bit colors and it is therefore strongly recommended
573+that you use a terminal with 24-bit truecolor support (`terminator`, `konsole`, `iTerm2`, ...).
574+See [this article](https://gist.github.com/XVilka/8346728) for more details and a full list of
575+terminals with truecolor support.
576+
577+Make sure that your truecolor terminal sets the `COLORTERM` variable to either `truecolor` or
578+`24bit`. Otherwise, `bat` will not be able to determine whether or not 24-bit escape sequences
579+are supported (and fall back to 8-bit colors).
580+
581+### Line numbers and grid are hardly visible
582+
583+Please try a different theme (see `bat --list-themes` for a list). The `OneHalfDark` and
584+`OneHalfLight` themes provide grid and line colors that are brighter.
585+
586+### File encodings
587+
588+`bat` natively supports UTF-8 as well as UTF-16. For every other file encoding, you may need to
589+convert to UTF-8 first because the encodings can typically not be auto-detected. You can `iconv`
590+to do so.
591+Example: if you have a PHP file in Latin-1 (ISO-8859-1) encoding, you can call:
592+``` bash
593+iconv -f ISO-8859-1 -t UTF-8 my-file.php | bat
594+```
595+Note: you might have to use the `-l`/`--language` option if the syntax can not be auto-detected
596+by `bat`.
597+
598+## Development
599+
600+```bash
601+# Recursive clone to retrieve all submodules
602+git clone --recursive https://github.com/sharkdp/bat
603+
604+# Build (debug version)
605+cd bat
606+cargo build --bins
607+
608+# Run unit tests and integration tests
609+cargo test
610+
611+# Install (release version)
612+cargo install --locked
613+
614+# Build a bat binary with modified syntaxes and themes
615+bash assets/create.sh
616+cargo install --locked --force
617+```
618+
619+## Maintainers
620+
621+- [sharkdp](https://github.com/sharkdp)
622+- [eth-p](https://github.com/eth-p)
623+
624+## Project goals and alternatives
625+
626+`bat` tries to achieve the following goals:
627+
628+- Provide beautiful, advanced syntax highlighting
629+- Integrate with Git to show file modifications
630+- Be a drop-in replacement for (POSIX) `cat`
631+- Offer a user-friendly command-line interface
632+
633+There are a lot of alternatives, if you are looking for similar programs. See
634+[this document](doc/alternatives.md) for a comparison.
635+
636+## License
637+Copyright (c) 2018-2020 [bat-developers](https://github.com/sharkdp/bat).
638+
639+`bat` is distributed under the terms of both the MIT License and the Apache License 2.0.
640+
641+See the [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) files for license details.