UNIX/Linuxの部屋 catmanコマンドの使い方

TOP UNIX/Linuxの部屋 UNIX/Linuxコマンド一覧 用語集 新版 由来/読み方辞書 環境変数マニュアル Cシェル変数 システム設定ファイル システムコール・ライブラリ ネットワークプログラミングの基礎知識 クラウドサービス徹底比較・徹底解説




コマンド catman オンラインマニュアルの整形を行う このエントリーをはてなブックマークに追加

man で表示されるマニュアルは、nroff というマクロ言語の形式で用意されている。

man コマンドを実行すると、nroff 形式のファイルを nroff や groff コマンドで変換して、catman というプレインテキスト形式に整形する。この変換作業には少し時間がかかるので、一度参照されたマニュアルは catman 形式で保存しておき、二度目からは catman 形式のファイルを表示することで man の実行が速くなる。

catman コマンドは、事前に整形作業を行って、プレインテキストを作成しておくためのコマンドである。一度も見たことがないマニュアルを初めて表示するときに時間がかかるのが嫌なら、事前に catman コマンドを実行しておくとよい。ただし、その分ディスク容量を喰うことになる。

catman を使わなくても、一度表示したマニュアルは man コマンドが自動的に整形済のプレインテキスト版を保存してくれるので、man の速度に不満がないなら catman を使う必要はない。

具体的には
% catman /usr/share/man/man1/
⇒ /usr/share/man/man1/ 以下のマニュアルを整形し、/usr/share/man/cat1/ に書き込む。
% catman /usr/share/man/ja/man8/
⇒ /usr/share/man/ja/man8/ 以下のマニュアルを整形し、/usr/share/man/ja/cat8/ に書き込む。
% catman /usr/X11R6/man/
⇒ /usr/X11R6/man/ 以下のマニュアル (全セクション) を整形し、/usr/X11R6/man/cat?/ に書き込む。
などと指定する。しかし一般的にはオンラインマニュアルは、全ユーザが参照する共用のものなので、root になって man ユーザの権限で
# su man -c "catman /usr/share/man/man1"
⇒ /usr/share/man/man1 以下のマニュアルを整形する。su コマンドを使って、man の権限で catman を実行する。
とするとよいだろう。
>> Solaris10オンラインマニュアル(man) Solaris10 catman(1M)
>> Linuxオンラインマニュアル(man) Linux catman(8)
>> FreeBSDオンラインマニュアル(man) FreeBSD catman(1)