catman(1M)

名前 | 形式 | 機能説明 | オプション | オペランド | 環境 | ファイル | 属性 | 関連項目 | 診断 | 警告 | 注意事項

名前

catman – 参照マニュアル用のフォーマット整形したファイルの作成

形式

/usr/bin/catman  [-c] [-n] [-p] [-t] [-w] [-M directory]
 [-T macro-package] [sections]

機能説明

catman は nroff(1) または sgml(5) の入力ファイルから、オンラインマニュアルページのプレフォーマット・バージョンを生成します。プレフォーマットされたマニュアルページのディレクトリは、自己包括的にかつフォーマットされていないエントリから独立して作成されるので、一群のマシンの間でそれらのマニュアルページを (rdist(1) などによって) 容易に配布することができます。

catman は、MANPATH または -M で指定されたディレクトリに windex のデータベースファイルも作成します。windex のデータベースファイルは、キーワード、そのキーワードが指す参照マニュアルページ、参照マニュアルページに書かれたユーティリティーまたはインタフェースの目的を説明するテキスト行の 3 つのカラムで構成されているリストです。各キーワードは、「名前」 (NAME) の行の `–' (ダッシュ) の前にあるコンマで区切られた単語のリストから抽出します。キーワードが指す参照マニュアルページは、「名前」の行の最初の単語です。3 つ目のカラムの記述は、「名前」の行の – のあとに続くテキストから抽出します。「名前」の行は、.THマクロによって作成されるページヘッダーのすぐあとに置く必要があります (必要とされる形式については、「注意事項」を参照)。

各マニュアルページを検査し、それに対応するプレフォーマット・バージョンが 存在しないものあるいは、現状のマニュアルページよりも古いものについて、プレフォーマット・バージョンを再生成します。変更箇所があれば、catman は windex データべースも再作成します。

マニュアルページがシャドウページである場合、つまりその内容が書かれた別のマニュアルページをソースファイルにしている場合、対象となるプレフォーマットされたマニュアルページへのシンボリックリンクが catx または fmtx ディレクトリ内に作成されます。

フォーマットされていない nroff のソースファイルにあるシャドウファイルは、最初の行に .so manx/yyy.x という形式の行があることで識別できます。

SGML のソースファイルにあるシャドウファイルは、文字列 SHADOW_PAGE があることで識別できます。シャドウファイルで宣言されたファイルの実体は、ソースとなるファイルを示しています。

オプション

サポートしているオプションは、次のとおりです。

-c

SGML のソースファイルから、フォーマットされていない nroff のソースファイルを適切な man サブディレクトリに作成します。このオプションは SGML ファイルと同じ名前で man ディレクトリにある既存のファイルをすべて上書きします。

-n

windex データべースの作成または再作成を行いません。このオプションを指定した場合は windex データベースが作成されないので、apropos、whatis、man -f、man -k コマンドを実行しても失敗します。

-p

実際の処理は実行せず、どのような処理が行われるかの表示だけを行います。

-t

cat サブディレクトリへの nroff を行う代わりに、該当する fmt サブディレクトリ内に troff 処理後のエントリを作成します。

-w

whatis(1) および man(1) の -f と -k オプションで使用する windex データべースの作成だけを行います。マニュアルページの再フォーマットは実行しません。

-M directory

引数に指定したディレクトリ (デフォルトは /usr/share/man) 中にあるマニュアルページを更新します。コンマは、マニュアルセクションの番号を示すために使用されているので、-M オプションの引数として指定するディレクトリ名には `,' (コンマ) が含まれないようにしてください。man(1) を参照してください。

-T macro-package

標準のマニュアルページマクロの代わりに、 macro-package 引数で指定したマクロパッケージを使用します (デフォルトは man(5))。

オペランド

次のオペランドを指定できます。

sections

先頭文字が `–' でないパラメータは、catman によって処理される マニュアルセクションとみなします。各セクションは空白で区切ります。このオペランドが指定されると、指定するマニュアルセクションだけが処理されます。次に例を示します。

catman 1 2 3

上記のコマンドは、セクション 1、2、3 のマニュアルページだけを更新します。セクションが指定されない場合、 環境変数 MANPATH に指定された man ディレクトリにあるすべてのセクションが処理されます。

環境

TROFF

-t オプションが指定された場合に用いるフォーマッタの名前。この環境変数が設定されていない場合は、 troff(1) が用いられます。

MANPATH

catman と man(1) で処理されるディレクトリの、コロンで区切られたリスト。各ディレクトリは、コンマで区切られたセクションのリストの後に続いて指定できます。この環境変数に値を設定すると、デフォルトのディレクトリ検索パスである /usr/share/man と、デフォルトのセクション検索パスである man.cf を無効にします。また、-M フラグはデフォルトのディレクトリ検索パスを、-s フラグはデフォルトのセクション検索パスを、それぞれ無効にします。

ファイル

/usr/share/man

マニュアルページのデフォルトのディレクトリ

/usr/share/man/man*/*.*

nroff 入力ファイル (未処理)

/usr/share/man/sman*/*.*

SGML 入力ファイル (未処理)

/usr/share/man/cat*/*.*

プレフォーマットされた nroff 処理後のマニュアルページ

/usr/share/man/fmt*/*.*

プレフォーマットされた troff 処理後のマニュアルページ

/usr/share/man/windex

目次とキーワードのデータべース

/usr/lib/makewhatis

windex データべース生成用のコマンドスクリプト

/usr/share/lib/tmac/an

デフォルトのマクロパッケージ

属性

次の属性については attributes(5) のマニュアルページを参照してください。

属性タイプ	属性値
使用条件	SUNWdoc
CSI	対応済み

関連項目

apropos(1), man(1), nroff(1), rdist(1), rm(1), troff(1), whatis(1), attributes(5), man(5), sgml(5)

診断

man?/xxx.? (.so'ed from man?/yyy.?): No such file or directory

メッセージの冒頭に示されたファイルは、カッコ内のファイルが参照しようとしたが、存在しませんでした。

target of .so in man?/xxx.? must be relative to /usr/man

catman では、ディレクトリ /usr/man からの相対パスで示したファイル名のみを参照できます。

opendir:man?: No such file or directory

catman が通常検索するディレクトリのうちの 1 つが見つかりません (軽度の警告メッセージ)。

*.*: No such file or directory

catman によって、 中身が空のディレクトリが見つかりました (軽度の警告メッセージ)。

警告

以前に catman を実行して cat* ディレクトリがすでにインストールされている場合に、オペレーティングシステムをアップグレードした場合は、catman を実行する前に cat* ディレクトリ構造全体を削除してください (rm(1) 参照)。

すべての man* ディレクトリがそろっていない場合には、whatis データベースを再構築するために catman を再度実行しないでください。catman は、 man* ディレクトリにもとづいてこの windex ファイルを構築します。

注意事項

catman には、正しい windex のインデックスファイルを生成するための要件があります。catman は、個々のマニュアルページのファイル中に、特定の形式を持つ 2 つのマクロ行 (ページの先頭の .TH 行と.SH NAME の行) を必要とします。

.TH マクロには、最低 3 つの引数 (ファイル名、セクション番号、日付) が必要です。.TH行は、.TH マクロで始まり、そのあとに、1 つの空白、マニュアルページのファイル名、1 つの空白、セクション番号、1 つの空白、日付が続きます。日付は、“day month year” (日本語の場合は “年月日”) として二重引用符で囲みます。このうちの month には 3 文字の省略形 (Jan、Feb、Mar、など) を指定します。

.TH.SH NAME マクロは、.TH 行のすぐあとに置く必要があります (これら 2 つの行の間には何も置かない)。「名前」の行では、フォントの変更はできません。.SH NAME のすぐ次の行には、マニュアルページのファイル名、コンマで区切られたシャドウファイル名 (もしあれば)、ダッシュ、簡単な概要を含む行が続きます。これらの要素は、すべて 1 つの行に収める必要があります (改行を入れないでください)。

.TH 行と .SH NAME の行の正しいコーディング例を次に示します。

.TH nismatch 1M "10 Apr 1998"
.SH NAME
nismatch, nisgrep \- utilities for searching NIS+ tables

SunOS 5.10  最終更新日 1998 年 2 月 27 日

名前 | 形式 | 機能説明 | オプション | オペランド | 環境 | ファイル | 属性 | 関連項目 | 診断 | 警告 | 注意事項