書式
manpath [-qgdc?V] [-m system[,...]] [-C file]説明
$MANPATH 環境変数が設定されている場合、 manpath は単にその内容を表示し、警告を発行します。設定されていない場合、 manpath は適切なマニュアルページ階層検索パスを決定し、その結果を表示します。コロン区切りのパスは man-db 設定ファイル (/etc/manpath.config) およびユーザーの環境変数から得られる情報を元に決定されます。
オプション
- -q, --quiet
- 警告を発行しません。
- -d, --debug
- デバッグ情報を表示します。
- -c, --catpath
- manpath に対応する catpath (整形済みマニュアルページのパス) を生成します。一度 manpath が決定してから、それぞれのパス要素に対応する catpath に変換します。
- -g, --global
- Produce a manpath consisting of all paths named as `global' within the man-db configuration file.
-m system[,...], --systems=system[,...]
-
システム上で他の OS のマニュアル階層にアクセスできる場合、このオプションを使用すると manpath にそれらを含めることができます。
NewOS のマニュアルページ階層を含める場合は -m NewOS オプションを使用します。
system はコンマ区切りの OS 名で指定します。現在の OS のマニュアルページ階層を含める場合は、システム名の引数文字列に man を含めます。このオプションは $SYSTEM 環境変数を上書きします。
- -C file, --config-file=file
- デフォルトの ~/.manpath ではなく指定したユーザ設定ファイルを使用します。
- -?, --help
- ヘルプメッセージを表示して終了します。
- --usage
- Print a short usage message and exit.
- -V, --version
- バージョン情報を表示します。
環境変数
- MANPATH
- $MANPATH が設定されている場合、 manpath はその場でマニュアルページ検索パスを決定するのでは無く、 $MANPATH の値を表示します。 $MANPATH の先頭にコロンが存在する場合、 $MANPATH 環境変数の値が設定ファイルの中身から決定されるリストの後に付加されます。 $MANPATH の末尾にコロンが存在する場合、設定ファイルの中身から決定されるリストが $MANPATH 環境変数の値の後に付加されます。 $MANPATH にコロンが連続して存在する (::) 場合、設定ファイルの中身から決定されるリストが連続して存在するコロンの間に付加されます。
- SYSTEM
- $SYSTEM が設定されている場合、 -m オプションで指定した引数と同様の効果があります。
ファイル
- /etc/manpath.config
- man-db 設定ファイルです。