man(1)

キーワードによるエントリー名の検索 (第 1 形式)

上記の第 1 の形式では、指定されたキーワードに対する個々のエントリーの一行解説を検索します。引き数は以下のとおりです。

エントリーの一行解説の表示 (第 2 形式)

上記の第 2 の形式では、指定された個々のエントリーの一行解説を探し、それを表示あるいはプリントします。使用できる引き数を以下に示します。

個々のマニュアルエントリーの表示 (第 3 形式)

上記の第 3 の形式は、1 つあるいは複数のマニュアルエントリーを表示するのに用いられます。この形式の man には、以下に示す引き数を指定できます。

標準出力がテレタイプであり、 - フラグが指定されていない場合、 man は、その出力を -s オプションを付けた more more(1) 参照) へパイプで渡し、複数のブランク行を取り除いて 各スクリーンごとに表示を停止させます。このデフォルトの動作は、ユーザーの環境で PAGER 変数を設定することにより変更することができます。 PAGER の値は、出力フィルタ名 (例えば、 pg(1)) に、必要なオプションを付けた文字列でなければなりません。

ファイル検索の順序

man は、複数の適切なディレクトリを検索して、指定されたマニュアルエントリーを見つけます。検索は、エントリーが見つかるか、またはすべての候補ディレクトリが検索されるまで続けられます。最初に検索される 3 つのディレクトリは、 /usr/share/man, /usr/contrib/man, および /usr/local/man の順です。

MANPATH 環境変数を使って、検索するディレクトリを指定することができます。この変数が設定されていれば、上記のデフォルトパスの情報は無視されます。 ログインする際、 /etc/profile (または /etc/csh.login) は MANPATH 環境変数をデフォルトの状態に設定します。 /etc/MANPATH ファイルが存在する場合、デフォルト設定はこのファイルから取得されます。 MANPATH 変数は、 PATH 変数と同じ書式です environ(5) 参照)。

これらの各ディレクトリの中で、 man は、 cat*.Z サブディレクトリ、 man*.Z サブディレクトリ、 cat* サブディレクトリ、 および man* サブディレクトリを検索します。 man*.Z および man* ディレクトリには、各エントリーの nroff(1) 互換のソーステキストが入っています。 cat*.Z および cat* ディレクトリには、各エントリーのフォーマット済みバージョンが入っています。 man*.Z および cat*.Z ディレクトリには、圧縮形式のエントリーが格納されています。 これらのディレクトリの中のファイルは、 uncompress compress(1) 参照) コマンドにより復元した後に表示あるいはプリントされます。

LANG 環境変数が、 lang(5) により定義された有効な言語のいずれかに設定されており、また MANPATH 変数は設定されていないか、またはデフォルト ディレクトリが設定されている場合、 man は、 /usr/share/man を検索する前に、3 つの追加ディレクトリの中でマニュアルエントリーを探します。 まず、 man は /usr/share/man/$LANG を検索し、次に /usr/contrib/man/$LANG を、さらに /usr/local/man/$LANG を検索します。したがって、母国語のマニュアルエントリーがシステム中に存在し、 正しくインストールされていれば、それらが表示されます。

MANPATH 環境変数にデフォルト以外の値が設定されている場合は、パスの一部として $LANG を用いた上記のディレクトリは、自動的には検索されません。すべてのディレクトリを MANPATH に明示的に指定しなければなりません。 %L, %l, %t および %c 指示子をパスの一部として使用し、そのローカルな実行環境に 固有のディレクトリを検索させることができます。 MANPATH の完全な説明については environ(5) を参照してください。

man は、検索したサブディレクトリの中の最新バージョンを使用します。 最新バージョンが以下のディレクトリに存在する場合の処理は次のとおりです。

cat* または cat*.Z サブディレクトリしか存在しない場合、あるいは nroff(1) がインストールされていない場合は、 フォーマット済みのエントリーだけを表示できます。

使用中のシステムでフォーマット済みのエントリーを格納するには、 catman(1M) を、オプションはデフォルトで実行してください。 これにより、(使用中のシステムに存在する cat* ディレクトリをすべて削除した後)、 cat*.Z ディレクトリが作成されます。また、 man -k オプションで使用するファイル /usr/share/lib/whatis も作成されます。 cat* ディレクトリを作成する場合は、システムに存在する cat*.Z ディレクトリをすべて削除するとスペースを節約できます。 (cat* および cat*.Z) の両方のディレクトリが存在する場合は、 man は、その両方をアップデートするので注意してください。

特殊なマニュアルエントリー

状況によっては、ローカルに使用するため、あるいはサードパーティの ソフトウェア業者による配布のためのマニュアルエントリーを作成する必要が 生ずることがあります。マニュアルフォーマット マクロは、 ヒューレットパッカード社以外から提供されるマニュアルエントリーのフッタに HP の名称が表示されないようにページフッタを再定義できるように構成されています。 この変更、および nroff または troff で使用するマニュアルフォーマットマクロの説明については、 man(5) を参照してください。

環境変数

LANG は、メッセージの表示に使用する言語を決定します。 LANG はまた、(上で説明した) 検索パスを決定するためにも使用されます。

LANG が指定されていない場合か、または空の文字列の場合、メッセージに対しては LANG の代わりに "C" lang(5) 参照) がデフォルトとして使用されますが、検索パスに対しては使用されません。

いずれかのインターナショナル変数に無効な値が設定されている場合、 man は、すべてのインターナショナル変数が "C" に設定されているものとして動作します。 environ(5) を参照してください。

MANPATH に値が設定されている場合、この変数は、指定されたエントリーを検索するために 調べるパスとして、デフォルトパスに代わるディレクトリのリストを指示します。

PAGER に値が設定されている場合、この変数は、 出力をページごとに分割した表示を行うために more(1) の代わりに用いる出力フィルタを定義します。

サポートされる国際的コードセット

シングルバイトおよびマルチバイトの文字コードセットがサポートされます。