Zenn
📖

`tldr` コマンド 日本語化方法

2024/05/21に公開
tldr
tech

概要

tldrコマンドは、コマンドの利用方法をまとめた事例集を表示できるコマンドです
https://github.com/tldr-pages/tldr

catコマンドの利用例を表示
> tldr cat
  cat

  Print and concatenate files.
  More information: https://keith.github.io/xcode-man-pages/cat.1.html.

  Print the contents of a file to stdout:

    cat path/to/file

  Concatenate several files into an output file:

    cat path/to/file1 path/to/file2 ... > path/to/output_file

  Append several files to an output file:

    cat path/to/file1 path/to/file2 ... >> path/to/output_file

  Copy the contents of a file into an output file without buffering:

    cat -u /dev/tty12 > /dev/tty13

  Write stdin to a file:

    cat - > path/to/file

  Number all output lines:

    cat -n path/to/file

  Display non-printable and whitespace characters (with M- prefix if non-ASCII):

    cat -v -t -e path/to/file

日本語対応

tldrは対応していれば日本語で表示することが可能です
対応しているコマンドは、pages.jaディレクトリ配下にあるコマンドです
https://github.com/tldr-pages/tldr/tree/main/pages.ja

catコマンドの利用例を日本語化
> tldr -L ja cat

  cat

  ファイルの出力と連結を行います。
  詳しくはこちら: https://manned.org/cat.1posix

  ファイルの内容を標準出力に出力する:

    cat ファイルパス

  複数ファイルを連結して1つの出力ファイルにする:

    cat ファイルパス1 ファイルパス2 ... > 出力ファイルパス

  複数ファイルを1つの出力ファイルに追加する:

    cat ファイルパス1 ファイルパス2 ... >> 出力ファイルパス

  ファイルの内容をバッファリング(一時保存)せずに出力ファイルにコピーする:

    cat -u /dev/tty12 > /dev/tty13

  stdin(標準入力)をファイルに書き込む:

    cat - > ファイルパス

日本語化

tldrコマンドを日本語対応する手順を示します。

  1. 現在の言語設定を確認
  2. 設定ファイルを配置
  3. 設定ファイルを記述
  4. 設定ファイルを反映
  5. 日本語ファイルがダウンロードされているか確認

1. 現在の言語設定を確認

tldr -iでtldrコマンドで利用できる言語のファイルを確認できます。
デフォルトではenのみです。

現在のダウンロード済言語ファイルを確認
>  tldr -i
Automatic update in 9d, 10h
Installed languages:
en    : 4941
total : 4941 pages

2. 設定ファイルを配置

tldrコマンド用の設定ファイルを配置することで、読み込む言語ファイルを設定することが可能になります。
tldr --gen-config でデフォルトの設定ファイルを出力し、それを tldr --config-path でデフォルトのパスに配置します。

設定ファイルを生成し、デフォルトパスに配置
> tldr --gen-config > $(tldr --config-path)

3. 設定ファイルを編集

デフォルトの設定ファイルでは、読み込み言語が増えないため、設定ファイルを編集します。

日本語ファイルを取り込むように設定
> vim $(tldr --config-path) # エディタはお好きなものを

[cache]
dir = "/Users/username/Library/Caches/tlrc"
mirror = "https://github.com/tldr-pages/tldr/releases/latest/download"
auto_update = true
max_age = 336
languages = ['ja'] # <- 'ja' を追加

4. 設定ファイルを反映

3番で設定した設定ファイルをコマンドに取り込みます。
こうすることで言語ファイルが取り込まれます。

日本語ファイルを読み込む
> tldr --update
info: downloading 'tldr.sha256sums'... 3.27 KiB
info: 'pages.en' is up to date
info: downloading 'tldr-pages.ja.zip'... 99.80 KiB
info: validating sha256sums...  OK
info: extracting 'pages.ja'... 274 pages, 274 new
info: cache update successful (total: 274 pages, 274 new).

5. 設定が有効になったか確認

4番で設定ファイルが反映できていれば、日本語用のファイルがダウンロードされtldr -iのリストに記載されているはずです。

日本語ファイルをダウンロードしているか確認
Cache: /Users/username/Library/Caches/tlrc (last update: 3s ago)
Automatic update in 13d, 23h
Installed languages:
en    : 4944
ja    : 274
total : 5218 pages

Discussion