2021/02/22(月)FreeBSD 日本語マニュアル閲覧環境の整備

FreeBSD

FreeBSD日本語マニュアル

現状、最新のFreeBSD日本語マニュアルは小金丸さんという方が
http://www.koganemaru.co.jp/
で作成され、公開されています。
ありがたいことです。

本記事では、
  • 上記サイトで公開されている整形済みマニュアルページ(本記事では、catページと呼ぶ)
  • FreeBSD 標準の man コマンド
  • 日本語表示可能なページャ(テキストビューア)
を使用して、日本語マニュアル表示環境を整えることを目的とします。

本ページでは、ja-groff などの整形ツールをインストールせずに済む方法を紹介します。

マニュアルのインストール

日本語マニュアルを読むだけの場合、
man(未整形状態)ではなく cat ページ(整形済み)だけでしたら、ja-groff 等の整形ツールを
インストールせずとも表示可能なので、cat ページを利用します。
 pkg add -M ja-cat-doc-12.2.20201029.amd64.txz
あるいは
 pkg add -M ftp://ftp.koganemaru.co.jp/pub/jman12/ja-man-doc-12.2.20201029.amd64.txz
のように、-M (依存関係無視オプション) 付きで pkg add してください。

pkg add が完了すると、 /usr/share/man/ja 以下に cat ページがセクション毎のディレクトリに分かれて配置されます。

ページャとして、ja-less や lv などの日本語を推測して表示可能なものをインストールしてください。
 pkg install ja-less

設定

FreeBSD 標準の man コマンドは、環境変数 LANG / LC_CTYPE に応じたディレクトリからマニュアルページを探してくる機能があります。

自分が使用するロケールに symlink します。
# cd /usr/share/man
# ln -s ja ja_JP.UTF-8
# ln -s ja ja_JP.eucJP
cat ページ自体は eucJP でエンコードされていますが、
cat ページは整形されずにそのまま PAGER に渡されますので、
気にせずリンクしてしまいます。

ページャの設定

例として jless (ja-lessパッケージ) コマンドを使用する方法を記載します。
jless は日本語文字コードを推測して表示できます。（他には lv 等もあります）。

環境変数を以下のように設定します。
JLESSCHARSET=japanese
LC_CTYPE=ja_JP.UTF-8
PAGER=jless
export JLESSCHARSET LC_CTYPE PAGER
JLESSCHARSET=japanese
jless コマンドに、入力データは日本語であると指示します
LC_CTYPE
端末の文字コードを指定します。この環境変数と、シンボリックリンクを張る名前は同じにします。
eucJPやUTF-8など、複数のキャラクターセットを使用している場合は、複数のシンボリックリンクを張ります。
PAGER
manコマンドのページャとして jless を指定します。
以上で、man.conf(5) や環境変数 MANPATH などの設定無しで、日本語マニュアルを表示可能となります。
（特に理由が無い限り、man.conf や環境変数 MANPATH は設定しないでください。）

また、この方法では、man -o ls のように、オリジナルの英語版マニュアルページを表示することも可能です。