doc/README-ru.md · bat

git.iko.soy/bat

bat/doc/README-ru.md

597 lines 29 kB history raw

1

2 <img src="logo-header.svg" alt="bat - a cat clone with wings">

3 <a href="https://github.com/sharkdp/bat/actions?query=workflow%3ACICD"><img src="https://github.com/sharkdp/bat/workflows/CICD/badge.svg" alt="Build Status"></a>

4 <img src="https://img.shields.io/crates/l/bat.svg" alt="license">

5 <a href="https://crates.io/crates/bat"><img src="https://img.shields.io/crates/v/bat.svg?colorB=319e8c" alt="Version info"></a>

6 Клон утилиты cat(1) с поддержкой выделения синтаксиса и Git

7

9

10 <a href="#выделение-синтаксиса">Ключевые возможности</a> •

11 <a href="#как-использовать">Использование</a> •

12 <a href="#установка">Установка</a> •

13 <a href="#кастомизация">Кастомизация</a> •

14 <a href="#цели-и-альтернативы">Цели и альтернативы </a>

15 [<a href="../README.md">English]

16 [<a href="README-zh.md">中文</a>]

17 [<a href="README-ja.md">日本語</a>]

18 [<a href="README-ko.md">한국어</a>]

19 [Русский]

20

22### Выделение синтаксиса

24`bat` поддерживает выделение синтаксиса для огромного количества языков программирования и разметки:

26![Пример выделения синтаксиса](https://i.imgur.com/3FGy5tW.png)

28### Интеграция с Git

29`bat` использует `git`, чтобы показать изменения в коде

30(смотрите на левый сайдбар):

32![Пример интеграции с Git](https://i.imgur.com/azUAzdx.png)

34### Показать непечатаемые символы

36Вы можете использовать `-A` / `--show-all` флаг, чтобы показать символы, которые невозможно напечатать:

38![Строка с неотображемыми символами](https://i.imgur.com/X0orYY9.png)

40### Автоматическое разделение текста

42`bat` умеет перенаправлять вывод в `less`, если вывод не помещается на экране полностью.

44### Объединение файлов

46О... Вы также можете объединять файлы :wink:. Когда

47`bat` обнаружит неинтерактивный терминал (например, когда вы перенаправляете вывод в файл или процесс), он будет работать как утилита `cat` и выведет содержимое файлов как обычный текст (без подсветки синтаксиса).

49## Как использовать

51Вывести единственный файл в терминале

53```bash

54> bat README.md

55```

57Отобразить сразу несколько файлов в терминале

59```bash

60> bat src/*.rs

61```

63Читаем из stdin и определяем синтаксис автоматически (внимание: это делается по заглавной строке файла, например, `#!/bin/sh`)

65```bash

66> curl -s https://sh.rustup.rs | bat

67```

69Прочитать из stdin с явным указанием языка

71```bash

72> yaml2json .travis.yml | json_pp | bat -l json

73```

75Вывести и выделить неотображаемые символы

76```bash

77> bat -A /etc/hosts

78```

80Использование в качестве замены `cat`

82```bash

83bat > note.md # мгновенно создаем новый файл

85bat header.md content.md footer.md > document.md

87bat -n main.rs # показываем только количество строк

89bat f - g # выводит 'f' в stdin, а потом 'g'.

90```

92### Интеграция с другими утилитами

94#### `find` или `fd`

96Вы можете использовать флаг `-exec` в `find`, чтобы посмотреть превью всех файлов в `bat`

97```bash

98find … -exec bat {} +

99```

100

101Если вы используете [`fd`](https://github.com/sharkdp/fd), применяйте для этого флаг `-X`/`--exec-batch`:

102```bash

103fd … -X bat

104```

105

106#### `ripgrep`

107

108С помощью [`batgrep`](https://github.com/eth-p/bat-extras/blob/master/doc/batgrep.md), `bat` может быть использован для вывода результата запроса [`ripgrep`](https://github.com/BurntSushi/ripgrep)

109

110```bash

111batgrep needle src/

112```

113

114#### `tail -f`

115

116`bat` может быть использован вместе с `tail -f`, чтобы выводить содержимое файла с подсветкой синтаксиса в реальном времени.

117```bash

118tail -f /var/log/pacman.log | bat --paging=never -l log

119```

120Заметьте, что мы должны отключить пэйджинг, чтобы это заработало. Мы также явно указали синтаксис (`-l log`), так как он не может быть автоматически определен в данном случае.

121

122#### `git`

123

124Вы можете использовать `bat` с `git show`, чтобы просмотреть старую версию файла с выделением синтаксиса:

125```bash

126git show v0.6.0:src/main.rs | bat -l rs

127```

128

129Обратите внимание, что выделение синтаксиса не работает в `git diff` на данный момент. Если вам это нужно, посмотрите [`delta`](https://github.com/dandavison/delta).

130

131#### `xclip`

132

133Нумерация стро и отображение изменений затрудняет копирование содержимого файлов в буфер обмена.

134Чтобы спроваиться с этим, используйте флаг `-p`/`--plain` или просто перенаправьте стандартный вывод в `xclip`:

135```bash

136bat main.cpp | xclip

137```

138`bat` обнаружит перенаправление вывода и выведет обычный текст без выделения синтаксиса.

139

140#### `man`

141

142`bat` может быть использован в виде выделения цвета для `man`, для этого установите переменную окружения

143`MANPAGER`:

144

145```bash

146export MANPAGER="sh -c 'col -bx | bat -l man -p'"

147man 2 select

148```

149

150Возможно вам понадобится также установить `MANROFFOPT="-c"`, если у вас есть проблемы с форматированием.

151

152Если вы хотите сделать этой одной командой, вы можете использовать [`batman`](https://github.com/eth-p/bat-extras/blob/master/doc/batman.md).

153

154Обратите внимание, что [синтаксис manpage](assets/syntaxes/02_Extra/Manpage.sublime-syntax) разрабатывается в этом репозитории и все еще находится в разработке.

155

156#### `prettier` / `shfmt` / `rustfmt`

157

158[`Prettybat`](https://github.com/eth-p/bat-extras/blob/master/doc/prettybat.md) — скрипт, который форматирует код и выводит его с помощью `bat`.

159

160

161## Установка

162

163[![Packaging status](https://repology.org/badge/vertical-allrepos/bat-cat.svg)](https://repology.org/project/bat-cat/versions)

164

165### Ubuntu (с помощью `apt`)

166*... и другие дистрибутивы основанные на Debian.*

167

168`bat` есть в репозиториях [Ubuntu](https://packages.ubuntu.com/eoan/bat) и

169[Debian](https://packages.debian.org/sid/bat) и доступен начиная с Ubuntu Eoan 19.10. На Debian `bat` пока что доступен только с нестабильной веткой "Sid".

170

171Если ваша версия Ubuntu/Debian достаточно новая, вы можете установить `bat` так:

172

173```bash

174apt install bat

175```

176

177Если вы установили `bat` таким образом, то бинарный файл может быть установлен как `batcat` вместо `bat` (из-за [конфликта имени с другим пакетом](https://github.com/sharkdp/bat/issues/982)). Вы можете сделать симлинк или алиас `bat -> batcat`, чтобы предотвратить подобные проблемы и в других дистрибутивах.

178

179``` bash

180mkdir -p ~/.local/bin

181ln -s /usr/bin/batcat ~/.local/bin/bat

182```

183

184### Ubuntu (С помощью самого нового `.deb` пакета)

185*... и другие дистрибутивы Linux основанные на Debian*

186

187Если пакет еще недоступен в вашем Ubuntu/Debian дистрибутиве или вы хотите установить самую последнюю версию `bat`, то вы можете скачать самый последний `deb`-пакет отсюда:

188[release page](https://github.com/sharkdp/bat/releases) и установить так:

189

190```bash

191sudo dpkg -i bat_0.18.3_amd64.deb # измените архитектуру и версию

192```

193

194### Alpine Linux

195

196Вы можете установить [`bat`](https://pkgs.alpinelinux.org/packages?name=bat) из официальных источников:

197

198```bash

199apk add bat

200```

201

202### Arch Linux

203

204Вы можете установить [`bat`](https://www.archlinux.org/packages/community/x86_64/bat/) из официального источника:

205

206```bash

207pacman -S bat

208```

209

210### Fedora

211

212Вы можете установить [`bat`](https://koji.fedoraproject.org/koji/packageinfo?packageID=27506) из официального репозитория [Fedora Modular](https://docs.fedoraproject.org/en-US/modularity/using-modules/).

213

214```bash

215dnf install bat

216```

217

218### Gentoo Linux

219

220Вы можете установить [`bat`](https://packages.gentoo.org/packages/sys-apps/bat) из официальных источников:

221

222```bash

223emerge sys-apps/bat

224```

225

226### Void Linux

227

228Вы можете установить `bat` с помощью `xbps-install`:

229```bash

230xbps-install -S bat

231```

232

233### FreeBSD

234

235Вы можете установить [`bat`](https://www.freshports.org/textproc/bat) с помощью `pkg`:

236

237```bash

238pkg install bat

239```

240

241или самому скомпилировать его:

242

243```bash

244cd /usr/ports/textproc/bat

245make install

246```

247

248### С помощью nix

249

250Вы можете установить `bat`, используя [nix package manager](https://nixos.org/nix):

251

252```bash

253nix-env -i bat

254```

255

256### openSUSE

257

258Вы можете установить `bat` с помощью `zypper`:

259

260```bash

261zypper install bat

262```

263

264### macOS

265

266Вы можете установить `bat` с помощью [Homebrew](http://braumeister.org/formula/bat):

267

268```bash

269brew install bat

270```

271

272Или же установить его с помощью [MacPorts](https://ports.macports.org/port/bat/summary):

273

274```bash

275port install bat

276```

277

278### Windows

279

280Есть несколько способов установить `bat`. Как только вы установили его, посмотрите на секцию ["Использование `bat` в Windows"](#using-bat-on-windows).

281

282#### С помощью Chocolatey

283

284Вы можете установить `bat` с помощью [Chocolatey](https://chocolatey.org/packages/Bat):

285```bash

286choco install bat

287```

288

289#### С помощью Scoop

290

291Вы можете установить `bat` с помощью [scoop](https://scoop.sh/):

292```bash

293scoop install bat

294```

295

296Для этого у вас должен быть установлен [Visual C++ Redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads).

297

298#### Из заранее скомпилированных файлов:

299

300Их вы можете скачать на [странице релизов](https://github.com/sharkdp/bat/releases).

301

302Для этого у вас должен быть установлен [Visual C++ Redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads).

303

304### С помощью Docker

305

306Вы можете использовать [Docker image](https://hub.docker.com/r/danlynn/bat/), чтобы запустить `bat` в контейнере:

307```bash

308docker pull danlynn/bat

309alias bat='docker run -it --rm -e BAT_THEME -e BAT_STYLE -e BAT_TABS -v "$(pwd):/myapp" danlynn/bat'

310```

311

312### С помощью Ansible

313

314Вы можете установить `bat` с [Ansible](https://www.ansible.com/):

315

316```bash

317# Устанавливаем роль на устройстве

318ansible-galaxy install aeimer.install_bat

319```

320

321```yaml

322---

323# Playbook для установки bat

324- host: all

325 roles:

326 - aeimer.install_bat

327```

328

329- [Ansible Galaxy](https://galaxy.ansible.com/aeimer/install_bat)

330- [GitHub](https://github.com/aeimer/ansible-install-bat)

331

332Этот способ должен сработать со следующими дистрибутивами:

333- Debian/Ubuntu

334- ARM (например Raspberry PI)

335- Arch Linux

336- Void Linux

337- FreeBSD

338- macOS

339

340### Из скомпилированных файлов

341

342Перейдите на [страницу релизов](https://github.com/sharkdp/bat/releases) для

343скомпилированных файлов `bat` для различных платформ. Бинарные файлы со статической связкой так же доступны: выбирайте архив с `musl` в имени.

344

345### Из исходников

346

347Если вы желаете установить `bat` из исходников, вам понадобится Rust 1.51 или выше. После этого используйте `cargo`, чтобы все скомпилировать:

348

349```bash

350cargo install --locked bat

351```

352

353## Кастомизация

354

355### Темы для выделения текста

356

357Используйте `bat --list-themes`, чтобы вывести список всех доступных тем. Для выбора темы `TwoDark` используйте `bat` с флагом

358`--theme=TwoDark` или выставьте переменную окружения `BAT_THEME` в `TwoDark`. Используйте `export BAT_THEME="TwoDark"` в конфигурационном файле вашей оболочки, чтобы изменить ее навсегда. Или же используйте [конфигурационный файл](https://github.com/sharkdp/bat#configuration-file) `bat`.

359

360Если вы хотите просто просмотреть темы, используйте следующую команду (для этого вам понадобится [`fzf`](https://github.com/junegunn/fzf)):

361```bash

362bat --list-themes | fzf --preview="bat --theme={} --color=always /путь/к/файлу"

363```

364

365`bat` отлично смотрится на темном фоне. Однако если ваш терминал использует светлую тему, то такие темы как `GitHub` или `OneHalfLight` будут смотреться куда лучше!

366Вы также можете использовать новую тему, для этого перейдите [в раздел добавления тем](https://github.com/sharkdp/bat#добавление-новых-тем).

367

368### Изменение внешнего вывода

369

370Вы можете использовать флаг `--style`, чтобы изменять внешний вид вывода в `bat`.

371Например, вы можете использовать `--style=numbers,changes`, чтобы показать только количество строк и изменений в Git. Установите переменную окружения `BAT_STYLE` чтобы изменить это навсегда, или используйте [конфиг файл](https://github.com/sharkdp/bat#configuration-file) `bat`.

372

373### Добавление новых синтаксисов

374

375`bat` использует [`syntect`](https://github.com/trishume/syntect/) для выделения синтаксиса. `syntect` может читать

376[файл `.sublime-syntax`](https://www.sublimetext.com/docs/3/syntax.html)

377и темы. Чтобы добавить новый синтаксис, сделайте следующее:

378

379Создайте каталог с синтаксисом:

380

381```bash

382mkdir -p "$(bat --config-dir)/syntaxes"

383cd "$(bat --config-dir)/syntaxes"

384

385# Разместите файлы '.sublime-syntax'

386# в каталоге (или субкаталогах), например:

387git clone https://github.com/tellnobody1/sublime-purescript-syntax

388```

389

390Теперь используйте следующую команду, чтобы превратить эти файлы в бинарный кеш:

391

392```bash

393bat cache --build

394```

395

396Теперь вы можете использовать `bat --list-languages`, чтобы проверить, доступны ли новые языки.

397

398Если когда-нибудь вы заходите вернуться к настройкам по умолчанию, введите

399

400```bash

401bat cache --clear

402```

403

404### Добавление новых тем

405

406Это работает похожим образом, так же как и добавление новых тем выделения синтаксиса

407

408Во-первых, создайте каталог с новыми темами для синтаксиса:

409```bash

410mkdir -p "$(bat --config-dir)/themes"

411cd "$(bat --config-dir)/themes"

412

413# Загрузите тему в формате '.tmTheme':

414git clone https://github.com/greggb/sublime-snazzy

415

416# Обновите кеш

417bat cache --build

418```

419

420Теперь используйте `bat --list-themes`, чтобы проверить доступность новых тем.

421

422### Использование другого пейджера.

423

424`bat` использует пейджер, указанный в переменной окружения `PAGER`. Если она не задана, то используется `less`.

425Если вы желаете использовать другой пейджер, вы можете либо изменить переменную `PAGER`, либо `BAT_PAGER` чтобы перезаписать то, что указано в `PAGER`.

426

427Чтобы передать дополнительные аргументы вашему пейджеру, перечислите их в этой переменной:

428

429```bash

430export BAT_PAGER="less -RF"

431```

432

433Так же вы можете использовать [файл конфигурации](https://github.com/sharkdp/bat#configuration-file) `bat` (флаг `--pager`).

434

435**Внимание**: По умолчанию пейджером является`less` (без каких-либо аргументов),

436`bat` задаст следующие флаги для пейджера:

437 `-R`/`--RAW-CONTROL-CHARS`,

438`-F`/`--quit-if-one-screen` и `-X`/`--no-init`. Последний флаг(`-X`) используется только для `less`, чья версия раньше 530.

439

440Флаг `-R` нужен чтобы корректно воспроизвести ANSI цвета. Второй флаг (`-F`) говорит

441`less` чтобы тот сразу же завершился, если размер вывода меньше чем вертикальный размер терминала.

442Это удобно для небольших файлов, так как вам не надо каждый раз нажимать `q`, чтобы выйти из пейджера. Третий флаг (`-X`) нужен для того, чтобы исправить баг с `--quit-if-one-screen` в старых версиях `less`. К сожалению, это блокирует возможность использования колеса мышки.

443

444Если вы хотите все же его включить, вы можете добавить флаг `-R`.

445Для `less` новее чем 530 оно должно работать из коробки.

446

447### Темная тема

448

449Если вы используете темный режим в macOS, возможно вы захотите чтобы `bat` использовал другую тему, основанную на теме вашей ОС. Следующий сниппет использует тему `default`, когда у вас включен темный режим, и тему `GitHub`, когда включен светлый.

450

451```bash

452alias cat="bat --theme=\$(defaults read -globalDomain AppleInterfaceStyle &> /dev/null && echo default || echo GitHub)"

453```

454

455## Файл конфигурации

456

457`bat` также может быть кастомизирован с помощью файла конфигурации. Его местоположение зависит от вашей ОС: чтобы посмотреть его путь, введите

458```

459bat --config-file

460```

461

462Также вы можете установить переменную окружения `BAT_CONFIG_PATH`, чтобы изменить путь к файлу конфигурации.

463```bash

464export BAT_CONFIG_PATH="/path/to/bat.conf"

465```

466

467Файл конфигурации «по умолчанию» может быть создан с помощью флага `--generate-config-file`.

468```bash

469bat --generate-config-file

470```

471

472### Формат

473

474Файл конфигурации - это всего лишь набор аргументов. Введите `bat --help`, чтобы просмотреть список всех возможных флагов и аргументов. Также вы можете закомментировать строку с помощью `#`.

475

476Пример файла конфигурации:

477```bash

478# Установить тему "TwoDark"

479--theme="TwoDark"

480

481# Показывать количество строк, изменений в Git и заголовок файла

482--style="numbers,changes,header"

483

484# Использовать курсив (поддерживается не всеми терминалами)

485--italic-text=always

486

487# Использовать синтаксис C++ для всех Arduino .ino файлов

488--map-syntax "*.ino:C++"

489

490# Использовать синтаксик Git Ignore для всех файлов .ignore

491--map-syntax ".ignore:Git Ignore"

492```

493

494## Использование `bat` в Windows

495

496`bat` полностью работоспособен "из коробки", но для некоторых возможностей могут понадобиться дополнительные настройки.

497

498### Пейджинг

499

500Windows поддерживает только очень простой пейджер `more`. Вы можете скачать установщик для `less` [с его сайта](http://www.greenwoodsoftware.com/less/download.html) или [через Chocolatey](https://chocolatey.org/packages/Less). Чтобы его использовать, скопируйте исполняемый файл в ваш `PATH` или [используйте переменную окружения](#Использование-другого-пейджера). [Пакет из Chocolatey](#windows) установит все автоматически.

501

502### Цвета

503

504Windows 10 поддерживает цвета и в `conhost.exe` (Command Prompt), и в PowerShell начиная с версии Windows

505[v1511](https://ru.wikipedia.org/wiki/Windows_10#Обновления и поддержка), так же как и в bash. На ранних версиях Windows вы можете использовать

506[Cmder](http://cmder.net/), в котором есть [ConEmu](https://conemu.github.io/).

507

508**Внимание:** Версия `less` в Git и MSYS2 воспроизводит цвета некорректно. Если у вас нет других пейджеров, мы можете отключить использование пейджеров с помощью флага `--paging=never`

509или установить `BAT_PAGER` равным пустой строке.

510

511### Cygwin

512

513Из коробки `bat` не поддерживает пути в стиле Unix (`/cygdrive/*`). Когда указан абсолютный путь cygwin, `bat` выдаст следующую ошибку: `The system cannot find the path specified. (os error 3)`

514

515Она может быть решена добавлением следующей функции в `.bash_profile`:

516

517```bash

518bat() {

519 local index

520 local args=("$@")

521 for index in $(seq 0 ${#args[@]}) ; do

522 case "${args[index]}" in

523 -*) continue;;

524 *) [ -e "${args[index]}" ] && args[index]="$(cygpath --windows "${args[index]}")";;

525 esac

526 done

527 command bat "${args[@]}"

528}

529```

530

531## Проблемы и их решение

532

533### Терминалы и цвета

534

535`bat` поддерживает терминалы *с* и *без* поддержки truecolor. Однако подсветка синтаксиса не оптимизирована для терминалов с 8-битными цветами, и рекомендуется использовать терминалы с поддержкой 24-битных цветов (`terminator`, `konsole`, `iTerm2`, ...).

536Смотрите [эту статью](https://gist.github.com/XVilka/8346728) для полного списка терминалов.

537

538Удостовертесь, что переменная `COLORTERM` равна `truecolor` или

539`24bit`. Иначе `bat` не сможет определить поддержку 24-битных цветов (и будет использовать 8-битные).

540

541### Текст и номера строк плохо видны

542

543Используйте другую тему (`bat --list-themes` выведет список всех установленных тем). Темы `OneHalfDark` и

544`OneHalfLight` имеют более яркие номера строк и тексты.

545

546### Кодировки файлов

547

548`bat` поддерживает UTF-8 и UTF-16. Файлы в других кодировках, возможно, придётся перекодировать, так как кодировка может быть распознана неверно. Используйте `iconv`.

549Пример: у вас есть PHP файл в кодировке Latin-1 (ISO-8859-1):

550``` bash

551iconv -f ISO-8859-1 -t UTF-8 my-file.php | bat

552```

553Внимание: вам может понадобится флаг `-l`/`--language`, если `bat` не сможет автоматически определить синтаксис.

554

555## Разработка

556

557```bash

558# Рекурсивно клонирует все модули

559git clone --recursive https://github.com/sharkdp/bat

560