man - オンライン解説書のセクションを表示する

形式

man [–wx] [–M path] [section] entry …
man –k [–M path] keyword …

説明

man コマンドは、シェル・コマンドと、TSO/E コマンドの z/OS® UNIX セットの両方に関するヘルプ情報を表示します。このコマンドを使用して、関連付けられている指定のキーワードを含むヘルプ・ファイルを検索することができます。

オプション

–k: キーワードの情報について構文行の事前に計算されたデータベースを検索します。
–M path: ヘルプ・ファイルについて、path で示されるディレクトリーを検索します。-M が指定されていないと、man は環境変数が設定されている場合、MANPATH 環境変数で指定されたパスを使用し、その他の場合は、man は /usr/man/%L を検索します。LANG 環境変数の値はこのディレクトリーおよび MANPATH で指定されたディレクトリーの %L に対して置き換えられます。すべてのヘルプ・ファイルは、1 つ以上の個所に経路指定された同じように構造化されたファイル・ツリーの検索により検出されます。man が検索する各ディレクトリーで検出するファイルとディレクトリーについての説明は、ファイルを参照してください。
–w: ヘルプ・ファイルを含むファイルのファイル名だけを表示します。
–x: man がヘルプ・ファイルを検出するため検索するファイルを表示します。 –x は、 man がオンライン・ブック・ファイルからマニュアル・ページを抽出するときに検出したすべてのエラーも表示します。BookServer 終了値を参照してください。
section: オンライン・ヘルプのセクションを表す (0 ～ 9) の番号です。セクション番号を指定すると、man はすべてのセクションを検索する代わりにそのセクションの項目だけを検索します。z/OS UNIX で使用可能なオンライン・ヘルプは、1 つのセクションを含んでいます。
1 Commands

指定された項目を見つけるために、man は MANPATH の各ディレクトリーで特定の名前のファイルを調べます。要求されたセクション番号ごとに、man は MANPATH で以下のファイルを以下の順序で検索します。

MANPATH の各ディレクトリーにある catn/entry.n。
MANPATH の各ディレクトリーにある mann/*.stfp。
MANPATH の各ディレクトリーにある mann/*.book。
MANPATH の各ディレクトリーにある mann/entry.n。

セクション番号が何も指定されないと、man はすべてのセクションを 1 から 9、次に 0 の順に検索します。man で最初に見つかった項目が表示されます。

出力が端末へ送られる場合は、man は、マニュアル・ページをフィルターに掛けて表示する pager コマンドを呼び出します。MANPAGER が定義されていると、これが使用されます。定義されていない場合は、PAGER が定義されているとこれが使用され、そうでない場合は、man は、デフォルトでは以下のコマンドを使用します。

pg –e –p '(Page %d)'

2 バイトのロケールで実行している場合は、more コマンドなど、2 バイト文字をサポートしているコマンドを呼び出すように MANPAGER または PAGER を設定してください。pg は 2 バイト文字をサポートしていません。

例

比較を行うユーティリティーを探すには、次を使用します。

man –k compare

man コマンドを使用して、TSO/E コマンドの z/OS UNIX セットに関する資料の説明を表示することができます。これを行うには、すべてのコマンドの頭に tso を付ける必要があります。例えば、MOUNT コマンドの z/OS UNIX バリエーションの説明を表示するには、以下のように入力します。

man tsomount

man コマンドを使用すれば、サブコマンドをサポートするコマンドの資料の説明を表示することもできます。これを行うには、すべてのサブコマンドの接頭部としてコマンドの名前を付ける必要があります。例えば、dbx alias サブコマンドの説明を表示するには、以下のように入力します。

man dbxalias

pdbx のサブコマンドについても同じことが言えます。例えば、次のように入力すると、

man pdbxcont

cont サブコマンドの情報が表示されます。

tcsh の ls-F 組み込みコマンドのオンライン資料の説明を表示するには、ダッシュを付けないで ls-F を入力する必要があります。同じように、マニュアル・ページを表示するには次のコマンドを発行します。

man lsF

tcsh の @ (at) 組み込みコマンドに関するオンライン・マニュアルの説明を表示するには、tcsh を前に付けて at を入力します。同じように、マニュアル・ページを表示するには次のコマンドを発行します。

man tcshat

環境変数

man は、以下の環境変数を使用します。

MANPATH: マニュアル・ページで検索するパスのリストを含みます。
MANPAGER, PAGER: マニュアル・ページを端末に表示するとき使用する出力フィルター操作コマンドを含む。
2 バイトのロケールで実行している場合は、この変数が more コマンドなど、2 バイト文字をサポートしているコマンドに対して設定されていることを確認してください。
TMPDIR: 一時ファイルが常駐するディレクトリーを識別します。

ローカライズ

man は、以下のローカライズ環境変数を使用します。

LANG
LC_ALL
LC_CTYPE
LC_MESSAGES
NLSPATH

詳しくは、ローカライズを参照してください。

ファイル

man は、以下のファイルを使用します。

/usr/man/%L/man[0-9]/*.stfpt: マニュアル・ページを含む単一タグの形式設定済みプレーン・テキスト・ファイル。
/usr/man/%L/man[0-9]/*.book: マニュアル・ページを含んでいる BookManager® ブック・ファイル
/usr/man/%L/cat[0-9]/ * .[0-9]: フォーマット済みヘルプ・ファイルを含むサブディレクトリー
/usr/man/%L/whatis: –k オプションで使用されるデータベース

終了値

0: トピックが見つからない
1: トピックの内容がバッファー長を超えている
-1: エラーなし

BookServer 終了値

-x オプションが指定されており、man がオンライン・ブック・ファイルからマニュアル・ページを抽出しているときにエラーを検出した場合、以下の終了値が表示されます。

112105: BookServer の bookread コンポーネントは、コード・ページ変換テーブルの区分データ・セットの検索または読み取りができませんでした。z/OS プログラム・ディレクトリーと BookServer プログラム・ディレクトリーで説明されている bookread 構成を確認してください。
100000-199999: bookread セッションを開いているときにエラーが発生しました。
200000-299999: ブックを開いているときにエラーが発生しました。
300000-399999: トピック ID をユニコードに変換中にエラーが発生しました。
400000-499999: ブック・ファイル内のトピックに位置決めしているときにエラーが発生しました。
500000-599999: トピック行の読み取り中にエラーが発生しました。
600000-699999: 内部コード・ページからブックのテキストを変換してコード・ページ・エラーを表示するときにエラーが発生しました。
700000-799999: ブック・ファイルを閉じるときにエラーが発生しました。
800000-899999: セッションを閉じるときにエラーが発生しました。
900000-999999: ブック・ファイルの上部に位置決めしているときにエラーが発生しました。
1000000-1099999: CONTENTS トピック ID をルックアップしているときにエラーが発生しました。

移植性

POSIX.2 ユーザー移植性拡張, X/Open 移植性ガイド, UNIX システム.

環境変数 MANPATH のエレメントは、コロンで分離されます。

–M オプション、–x オプション、–w オプション、MANPAGER 環境変数、デフォルト pager、およびコマンド行に section を指定する機能は、すべて POSIX 標準の拡張です。