doc/README-ja.md · bat

git.iko.soy/bat

bat/doc/README-ja.md

626 lines 24 kB history raw

1

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

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?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>

7 シンタックスハイライトとGitとの連携機能付きの cat(1) クローン。

8

10

11 <a href="#シンタックスハイライト">特徴</a> •

12 <a href="#使い方">使い方</a> •

13 <a href="#インストール">インストール</a> •

14 <a href="#カスタマイズ">カスタマイズ</a> •

15 <a href="#プロジェクトの目標と既存の類似したOSS">プロジェクトの目標と既存の類似したOSS</a> •

16 翻訳 [<a href="https://github.com/chinanf-boy/bat-zh">中文</a>][<a href="README-ja.md">日本語</a>][<a href="README-ko.md">한국어</a>]

17

19### シンタックスハイライト

21`bat` は多くのプログラミング言語やマークアップ言語の

22シンタックスハイライトに対応しています:

24![Syntax highlighting example](https://imgur.com/rGsdnDe.png)

26### Gitの統合

28`bat` は `git` とも連携しており、差分を表現する記号が表示されます

29（図の左端）:

31![Git integration example](https://i.imgur.com/2lSW4RE.png)

33### 印刷できない文字の表示

35`-A`/`--show-all` オプションをつけることで

36印刷できない文字を可視化できます:

38![Non-printable character example](https://i.imgur.com/WndGp9H.png)

40### 自動ページング

42出力が1つの画面に対して大きすぎる場合、`bat` は自身の出力を `less` にパイプで繋げることが可能です。

44### ファイルの連結

46あなたはさらにファイルを連結させるに使うことも可能です:wink:。

47`bat` は非対話型のターミナルを検出すると、

48いつでも `cat` の完全互換として振る舞い、

49プレーンなファイルを表示します。

51## 使い方

53単一のファイルを表示させたい

55```bash

56> bat README.md

57```

59複数のファイルを一度に表示させたい場合

61```bash

62> bat src/*.rs

63```

65標準入力から自動的に構文を決定させたい場合

67```bash

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

69```

71標準入力から明示的に言語を指定したい場合

73```bash

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

75```

77空白文字を可視化させたい場合:

78```bash

79> bat -A /etc/hosts

80```

82`cat` の代わりに `bat` を使用する際の例:

84```bash

85bat > note.md # quickly create a new file

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

89bat -n main.rs # show line numbers (only)

91bat f - g # output 'f', then stdin, then 'g'.

92```

94### 他のツールとの統合

96#### `find` or `fd`

98`find` の `-exec` オプションを使用して、`bat` ですべての検索結果をプレビューできます:

99```bash

100find … -exec bat {} +

101```

102

103[`fd`](https://github.com/sharkdp/fd) を使用している場合は、`-X` /`-exec-batch` オプションを使用して同じことを行うことができます:

104```bash

105fd … -X bat

106```

107

108#### `ripgrep`

109

110[`batgrep`](https://github.com/eth-p/bat-extras/blob/master/doc/batgrep.md) では、[`ripgrep`](https://github.com/BurntSushi/ripgrep) 検索結果のプリンターとして `bat` を使用できます。

111

112```bash

113batgrep needle src/

114```

115

116#### `tail -f`

117

118`bat` を `tail -f` と組み合わせて、構文強調表示を使用して特定のファイルを継続的に監視できます。

119```bash

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

121```

122Note that we have to switch off paging in order for this to work. We have also specified the syntax

123explicitly (`-l log`), as it can not be auto-detected in this case.

124

125#### `git`

126

127`bat` を `git show` と組み合わせて、

128適切な構文強調表示を使用して特定のファイルの古いバージョンを表示できます:

129```bash

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

131```

132

133差分内の構文強調表示は現在サポートされていないことに注意してください。これを探しているなら、[`delta`](https://github.com/dandavison/delta) をチェックしてください。

134

135#### `xclip`

136

137`bat` の出力の行番号と Git 変更マーカーにより、ファイルの内容をコピーするのが難しくなる場合があります。

138これを防ぐには、`-p` / `-plain` オプションを使用して `bat` を呼び出すか、

139単に出力を `xclip` にパイプします:

140```bash

141bat main.cpp | xclip

142```

143`bat` は出力がリダイレクトされていることを検出し、プレーンファイルの内容を出力します。

144

145#### `man`

146

147`bat` は `MANPAGER` 環境変数を設定することにより、

148`man` の色付けページャーとして使用できます:

149

150```bash

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

152man 2 select

153```

154

155フォーマットの問題が発生した場合は

156`MANROFFOPT = "-c"` を設定する必要もあります。

157

158これを新しいコマンドにバンドルしたい場合は [`batman`](https://github.com/eth-p/bat-extras/blob/master/doc/batman.md) も使用できます。

159

160[Manpage syntax](assets/syntaxes/Manpage.sublime-syntax) はこのリポジトリで開発されており、まだ作業が必要であることに注意してください。

161

162#### `prettier` / `shfmt` / `rustfmt`

163

164[`prettybat`](https://github.com/eth-p/bat-extras/blob/master/doc/prettybat.md) スクリプトは、コードをフォーマットし、`bat` で印刷するラッパーです。

165

166

167## インストール

168

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

170

171### On Ubuntu

172*... や他のDebianベースのLinuxディストリビューション*

173

174Ubuntu Eoan 19.10 または Debian 不安定版 sid 以降の [the Ubuntu `bat` package](https://packages.ubuntu.com/eoan/bat) または [the Debian `bat` package](https://packages.debian.org/sid/bat) をインストールできます:

175

176```bash

177apt install bat

178```

179

180batの最新リリースを実行する場合、または Ubuntu/Debian の古いバージョンを使用している場合は、[release page](https://github.com/sharkdp/bat/releases) から最新の `.deb` パッケージをダウンロードし、

181次の方法でインストールします:

182```bash

183sudo dpkg -i bat_0.13.0_amd64.deb # adapt version number and architecture

184```

185

186### On Alpine Linux

187

188適切なリポジトリが有効になっている場合は、

189公式のソースから [`bat` package](https://pkgs.alpinelinux.org/packages?name=bat) をインストールできます:

190

191```bash

192apk add bat

193```

194

195### On Arch Linux

196

197[Arch Linuxの公式リソース](https://www.archlinux.org/packages/community/x86_64/bat/)

198からインストールできます。

199

200```bash

201pacman -S bat

202```

203

204### On Fedora

205

206公式の [Fedora Modular](https://docs.fedoraproject.org/en-US/modularity/using-modules/) リポジトリから [the `bat` package](https://koji.fedoraproject.org/koji/packageinfo?packageID=27506) をインストールできます。

207

208```bash

209dnf install bat

210```

211

212### On Gentoo Linux

213

214公式ソースから

215[the `bat` package](https://packages.gentoo.org/packages/sys-apps/bat) をインストールできます。

216

217```bash

218emerge sys-apps/bat

219```

220

221### On Void Linux

222

223xbps-ininstall経由で `bat` をインストールできます。

224```

225xbps-install -S bat

226```

227

228### On FreeBSD

229

230pkg を使用してプリコンパイルされた [`bat` package](https://www.freshports.org/textproc/bat) をインストールできます:

231

232```bash

233pkg install bat

234```

235

236または FreeBSD ポートから自分でビルドする:

237

238```bash

239cd /usr/ports/textproc/bat

240make install

241```

242

243### Via nix

244

245`bat` を [nix package manager](https://nixos.org/nix) 経由でインストールすることができます:

246

247```bash

248nix-env -i bat

249```

250

251### On openSUSE

252

253`bat` をzypperでインストールすることができます:

254

255```bash

256zypper install bat

257```

258

259### On macOS

260

261[Homebrew](http://braumeister.org/formula/bat)で `bat` をインストールできます:

262

263```bash

264brew install bat

265```

266

267または [MacPorts](https://ports.macports.org/port/bat/summary) で `bat` をインストールします:

268

269```bash

270port install bat

271```

272

273### On Windows

274

275Windowsにbatをインストールするいくつかのオプションがあります。

276batをインストールしたら [Windowsでのbatの使用](#windows-での-bat-の利用) セクションをご覧ください。

277

278#### With Chocolatey

279

280[Chocolatey](https://chocolatey.org/packages/Bat) から `bat` をインストールできます:

281```bash

282choco install bat

283```

284

285#### With Scoop

286

287[scoop](https://scoop.sh/) から `bat` をインストールできます:

288```bash

289scoop install bat

290```

291

292[Visual C ++再頒布可能](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) パッケージをインストールする必要があります。

293

294#### From prebuilt binaries:

295

296[リリースページ](https://github.com/sharkdp/bat/releases) からビルド済みのバイナリをダウンロードできます。

297

298[Visual C ++再頒布可能](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) パッケージをインストールする必要があります。

299

300### Via Docker

301

302コンテナ内で `bat` を使いたい方のために [Docker image](https://hub.docker.com/r/danlynn/bat/) が用意されています:

303```bash

304docker pull danlynn/bat

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

306```

307

308### Via Ansible

309

310[Ansible](https://www.ansible.com/) でインストールすることができます:

311

312```bash

313# Install role on local machine

314ansible-galaxy install aeimer.install_bat

315```

316

317```yaml

318---

319# Playbook to install bat

320- host: all

321 roles:

322 - aeimer.install_bat

323```

324

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

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

327

328これは以下のディストリビューションで動作するはずです:

329- Debian/Ubuntu

330- ARM (eg. Raspberry PI)

331- Arch Linux

332- Void Linux

333- FreeBSD

334- MacOS

335

336### From binaries

337

338

339多くの異なるアーキテクチャのためのプレビルドバージョンを[リリースページ](https://github.com/sharkdp/bat/releases)からチェックしてみてください。静的にリンクされている多くのバイナリも利用できます: ファイル名に `musl` を含むアーカイブを探します。

340

341### From source

342

343

344`bat` をソースからビルドしたいならば、Rust 1.36 以上の環境が必要です。

345そして `cargo` をビルドに対して使用します:

346

347```bash

348cargo install bat

349```

350

351一部のプラットフォームでは `llvm` および/または `libclang-dev` のインストールが必要になる場合があります。

352

353## カスタマイズ

354

355### ハイライトテーマ

356

357`bat --list-themes` を使うと現在利用可能なシンタックスハイライトのテーマを入手できます。

358`TwoDark` テーマを選ぶためには

359`--theme=TwoDark` オプションをつけるか `BAT_THEME` という環境変数に

360`TwoDark` を代入する必要があります。シェルの起動ファイルに `export BAT_THEME="TwoDark"`

361と定義すればその設定が変わることはないでしょう。あるいは、 `bat` の

362[設定ファイル](#設定ファイル)を利用してください。

363

364カスタムファイルでさまざまなテーマをプレビューする場合は、

365次のコマンドを使用できます（これには [`fzf`](https://github.com/junegunn/fzf) が必要です）。

366``` bash

367bat --list-themes | fzf --preview="bat --theme={} --color=always /path/to/file"

368```

369

370`bat` はデフォルトだと黒い背景色のターミナルに適しています。

371しかし、`GitHub` や `OneHalfLight` のような白い背景色のテーマでもいい感じにすることができます。

372['新しいテーマの追加' セクションに従って](#新しいテーマの追加)

373カスタムテーマを使用することもできます。

374

375### 出力のスタイル

376

377`--style` を使うことで `bat` の表示の見た目を変更することができます。

378例えば、 `--style=numbers,changes` と入力します。

379すると、Gitの差分と行番号だけが表示され、グリッド線とファイルヘッダーは表示されません。

380環境変数に `BAT_STYLE` を定義するとこれらの設定を永続的に使用することができます。

381[設定ファイル](#設定ファイル) を参考にしても良いでしょう。

382

383### 新しい構文の追加 / 言語の定義

384

385`bat` はシンタックスハイライトのための [`syntext`](https://github.com/trishume/syntect/)

386という素晴らしいライブラリを使用しています。`syntect` は、

387[Sublime Text の `.sublime-syntax` ファイル](https://www.sublimetext.com/docs/3/syntax.html)

388とテーマを読み取ることができます。新しい構文を定義するために以下の手順を行います。

389

390構文定義ファイルを入れておくためのフォルダを作る:

391

392```bash

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

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

395

396# Put new '.sublime-syntax' language definition files

397# in this folder (or its subdirectories), for example:

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

399```

400

401次のコマンドを使用して、これらのファイルをバイナリキャッシュに解析します:

402

403```bash

404bat cache --build

405```

406

407最後に `bat --list-languages` と入力すると新しい言語が利用可能かどうかチェックします。

408

409デフォルトの設定に戻したいときは以下のコマンドを実行します:

410

411```bash

412bat cache --clear

413```

414

415### 新しいテーマの追加

416

417これは構文を新しく定義するやり方と非常に似ています。

418

419まず、新しいシンタックスハイライトのテーマのフォルダを作ります:

420```bash

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

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

423

424# Download a theme in '.tmTheme' format, for example:

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

426

427# Update the binary cache

428bat cache --build

429```

430

431最後に、 `bat --list-themes` で新しいテーマが利用可能がチェックします

432

433### 異なるページャーの使用

434

435`bat` は環境変数 `PAGER` に使用するページャーを明記します。

436この環境変数が定義されていない場合、デフォルトで `less` が使用されます。

437もし、異なるページャーが使用したい場合は、`PAGER` を修正してください。

438または、`PAGER` を上書きする環境変数として `BAT_PAGER` を定義することも可能です。

439

440もし、ページャーにコマンドライン引数を渡したい場合は、

441`PAGER`/`BAT_PAGER` 環境変数を定義してください:

442

443```bash

444export BAT_PAGER="less -RF"

445```

446

447環境変数を利用する代わりに、 `bat` の [設定ファイル](#設定ファイル) を使用して設定も可能です（`--pager` オプション）

448

449**注意**: デフォルトにより、ページャーが `less` にセットされているならば

450`bat` はページャーの以下のコマンドラインオプションを受け付けるでしょう:

451`-R`/`--RAW-CONTROL-CHARS`, `-F`/`--quit-if-one-screen` そして `-X`/`--no-init`。

452最後のオプション（-X）は、530 より古いバージョンにのみ使用されます。

453

454`-R` オプションは、ANSIカラーを正しく解釈するために必要です。

4552番目のオプション（`-F`）は、出力サイズが端末の垂直サイズよりも小さい場合、すぐに終了するようにlessに指示します。

456これは、ページャーを終了するために `q` を押す必要がないため、小さなファイルに便利です。

4573番目のオプション（`-X`）は、`less` の古いバージョンの `--quit-if-one-screen` 機能のバグを修正するために必要です。

458残念ながら、`less` のマウスホイールのサポートも少なくなります。

459

460`less` の古いバージョンでマウスホイールのスクロールを有効にしたい場合は、

461`-R` だけを渡すことができます（上記の例のように、これは1画面終了機能を無効にします）。

462530以下の場合は、そのまま使用できます。

463

464### Dark mode

465

466macOSでダークモード機能を使用する場合、OSテーマに基づいて異なるテーマを使用するように `bat` を構成することができます。

467次のスニペットは、ライトモードの場合は `デフォルト` のテーマを使用し、

468ダークモードの場合は `GitHub` テーマを使用します。

469

470```bash

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

472```

473

474## 設定ファイル

475

476`bat` は設定ファイルでカスタマイズすることが可能です。ファイルの場所はOSに依存します。

477使用しているOSのデフォルトパスを調べるには以下のコマンドを実行してください:

478```

479bat --config-file

480```

481

482または、`BAT_CONFIG_PATH` 環境変数を使用して、`bat` が

483構成ファイルのデフォルト以外の場所を指すようにすることができます:

484```bash

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

486```

487

488### フォーマット

489

490この設定ファイルはコマンドライン引数の単純なリストです。 `bat --help` を利用すると、利用可能なオプションとその値を閲覧することができます。さらに、`#` でコメント文を加えることができます。

491

492設定ファイルの例:

493```bash

494# Set the theme to "TwoDark"

495--theme="TwoDark"

496

497# Show line numbers, Git modifications and file header (but no grid)

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

499

500# Use italic text on the terminal (not supported on all terminals)

501--italic-text=always

502

503# Use C++ syntax for .ino files

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

505

506# Use ".gitignore"-style highlighting for ".ignore" files

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

508```

509

510## Windows での `bat` の利用

511

512Windows 上で `bat` はほとんど動作しますが、いくつかの機能は設定を必要をする場合があります。

513

514### ページング

515

516Windowsには、`more` 形式の非常に限られたページャーしか含まれていません。

517`less` 用のWindowsバイナリは、[ホームページ](http://www.greenwoodsoftware.com/less/download.html) または

518[Chocolatey](https://chocolatey.org/packages/Less) からダウンロードできます。

519これを使用するには、バイナリを `PATH` のディレクトリに配置するか、環境変数を定義します。[Chocolateyパッケージ](#on-windows) は `less` を自動的にインストールします。

520

521### 色

522

523Windows 10では、`conhost.exe` （コマンドプロンプト）と

524[v1511](https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1511_(November_Update)) 以降の PowerShell の両方、

525およびbashの新しいバージョンの色がネイティブにサポートされています。以前のバージョンのWindowsでは、

526[ConEmu](https://conemu.github.io/) を含む [Cmder](http://cmder.net/) を使用できます。

527

528**注意:** Git と MSYS の `less` はWindows上で色を正しく解釈しません。

529もし、あなたが他のページャーをインストールしていないのであれば、 `--paging=never` オプションを付け加える

530または `BAT_PAGER` に空文字を設定することでページングを完全に無効にできます。

531

532### Cygwin

533

534Windows上の `bat` は Cygwin のunix風のpath(`/cygdrive/*`)をネイティブサポートしていません。絶対的なcygwinパスを引数として受けたときに、 `bat` は以下のエラーを返すでしょう: `The system cannot find the path specified. (os error 3)`

535

536wrapperを作成するまたは以下の関数を `.bash_profile` に追記することでこの問題を解決することができます:

537

538```bash

539bat() {

540 local index

541 local args=("$@")

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

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

544 -*) continue;;

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

546 esac