次のページ 前のページ 目次へ

5. どのマクロパッケージを使うべきか?

man page を書く時に利用することを目的としたいくつかのマクロがある。 通常は、これらのマクロは、groff マクロディレクトリである /usr/lib/groff/tmac におかれる。ファイル名は、tmac.<なんとか> で、<な んとか> は groff の -m オプションの引数である。Groff は `-m <なんとか >' オプションが指定された時に、マクロファイル tmac.<なんとか> を使用す る。しばしば、`-m' と`<なんとか>' の間のスペースが省略され、tmac.an の マクロパッケージを利用して man page をフォーマットする時に、`groff - man' を使うことになる。これが、`tmac.an' というおかしな名前を持ってい る理由である。

tmac.an 以外に、tmac.doc という、これも良く利用されるマクロパッケージ があり、これは、カリフォルニア大学のバークレー分校(UCB)でもともと開 発されたものである。多くの BSD の man page はこれを使用しており、UCB は、これをドキュメンテーションの標準にしているようである。tmac.doc は、 非常に柔軟であるけれども、悲しいかな、tmac.doc を使わないで、常に、 `groff -man' を呼び出すマニュアルブラウザがある。例えば、私が今まで見 た全ての xman プログラムは、tmac.doc を要求する man page を台無しにし てしまう。したがって、tmac.an を使うことにしてほしい。他のマクロパッケー ジを使用することは、有害であると考えられる。Tmac.andoc は、類似のマク ロパッケージであって、ソースを見て、tmac.an か tmac.doc を読み込む。本 当は、全ての man page ブラウザは、tmac.andoc を使用すべきなんだろうけ ど、今までのところそうではなく、最良の方法は、古めかしい tmac.an にし がみついてる他ない。そこで、ここからは、tmac.an にだけについて説明する ことにする。

もし、tmac.doc マクロを使いたいと言うことなら、以下のポインタを参照し てほしい。
           http://www.bsdi.com/bsdi-man

そこには、検索可能なインデックスがある。'mdoc' と入力すれば、mdoc(7)、 mdoc.samples(7) 及びBSD man page を書くためのチュートリアルが得られる。


次のページ 前のページ 目次へ