CATMAN
Section: Manual pager utils (8)
Updated: 2019-10-23
Index
Return to Main Contents
名前
catman - フォーマットされたマニュアルページを生成・更新する
書式
catman
[-d?V]
[-M
path]
[-C
file]
[section]
...
説明
catman
は、フォーマット済みマニュアルページ (cat ページと呼ばれる) の最新の
セットを生成するために用いられる。
通常 cat ページはオリジナルの man ページよりもずっと速く表示できるが、
余分な保存領域が必要とされる。
cat ページをサポートするかどうかは、
ローカルな管理者 (cat ページを保存するディレクトリに関する権限を持って
いる人) の判断による。
catman
に与えることのできるオプションは、フォーマットを行うマニュアルページの
階層 (hierarchy) とセクションである。
デフォルトの階層は、 man_db の設定ファイルで
システムのマニュアルページの系列として指定されているものである。
デフォルトのセクションは、環境変数
$MANSECT
が与えられていれば、その内容をコロン区切りでパースしたものになり、
与えられていなければ
man
のコンパイル時に指定されている標準的なセットとなる。
catman
の実行時にセクションの名前をスペースで区切って与えれば、
これらの両方を上書きする。
catman
はそれぞれの階層における
index
データベースキャッシュを利用して、どのファイルをフォーマットすべきかを
決定する。
オプション
- -d, --debug
-
デバッグ情報を表示する。
- -M path, --manpath=path
-
検索対象にするマニュアルページの階層を変えたい場合、
それらをコロンで区切った形式で指定する。
デフォルトでは、man-db 設定ファイルのシステムのマニュアル系列で示されている
すべてのパスである。
- -C file, --config-file=file
-
デフォルトの
~/.manpath
ではなく、ユーザー設定ファイルを使用する。
- -?, --help
-
ヘルプメッセージを表示して、終了する。
- --usage
-
簡単な使用法のメッセージを表示して、終了する。
- -V, --version
-
バージョン情報を表示する。
環境変数
- MANSECT
-
$MANSECT
が設定されていると、その値はセクションのリスト (コロン区切り) として扱われ、
マニュアルのどのセクションを検索するかを決定する際に用いられる。
/etc/man_db.conf
の
SECTION
指定で上書きされていない限り、デフォルトは
"1 1p 8 2 3 3p 3pm 4 5 6 7 9 0p n l p o 1x 2x 3x 4x 5x 6x 7x 8x"
である。
- MANPATH
-
$MANPATH
が設定されていると、その内容は検索対象とするマニュアルの階層を
コロンで区切ったリストとみなされる。
ファイル
- /etc/man_db.conf
-
man-db の設定ファイル
- /usr/man/index.(bt|db|dir|pag)
-
従来形式のグローバルな
index
データベースキャッシュ。
- /var/catman/index.(bt|db|dir|pag)
-
新しい FSSTND 準拠のグローバルな
index
データベースキャッシュ。
関連項目
man(1),
manpath(5),
mandb(8)
著者
Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).
Index
- 名前
-
- 書式
-
- 説明
-
- オプション
-
- 環境変数
-
- ファイル
-
- 関連項目
-
- 著者
-
This document was created by
man2html,
using the manual pages.
Time: 08:44:54 GMT, July 02, 2020