groff_tmac(5) FreeBSD 一般コマンドマニュアル

groff_tmac

前のページ 上に戻る 次のページ

groff_tmac



解説

       roff(7) 清書システムは、特殊な用途のドキュメントに適したマ
       クロパッケージを提供しています。それぞれのマクロパッケージ
       は、そのパッケージの tmac B>フB>ァB>イB>ルと呼ばれるファイル中にマ
       クロおよび定義を格納しています。 tmac  と い う 名 前 は、
       `Troff MACros' を縮めたものです。

       tmac  ファイルは、普通の roff ソースドキュメントです。ただ
       し、通常このファイルには定義および設定コマンドしか含まれて
       お ら ず、 テキストは入っていません。tmac ファイルはすべて
       tmac ディレクトリという 1 つあるいは少数のディレクトリ内に
       保管されています。


名称付け

       古くからある roff システムには、奇妙な名称付けの体系があり
       ました。マクロパッケージの名称が `m' で始まっている場合 に
       は、この文字は省略されました。例えば、マニュアルページ用の
       マクロパッケージ manan と呼ばれ、そのパッケージのマ ク
       ロ ファ イ ルは tmac.an と呼ばれました (現在のバージョンの
       groff では、このファイルは代りに an.tmac と呼ばれること に
       注意してください)。

       似 たような理由で、名称が `m' で始まらないマクロパッケージ
       は、 `m' をつけて表されることがよくありました。 例 え ば、
       tmac.doc  に対応するパッケージは、 mdoc と呼ばれました。な
       ぜなら、このパッケージをアクティブにするためのコマンドライ
       ンは、次のように表されるからです。

              troff -mdoc

       現 在の groff(1) のバージョンでは、パッケージ名に `m' が付
       こうが付くまいが、この悩ましいマクロパッケージの名称付け体
       系をどちらも提供しています。ですので、 groff では、 man マ
       クロパッケージは、次のいずれでも指定可能です。

              groff -m man
              groff -man
              groff -mman
              groff -m an

       システムでどのマクロパッケージが利用可能であるかを判別する
       のに最も簡単な方法は、 tmac ディレクトリ群の中身を調べるこ
       とです。例えば、 tmac.anything または anything.tmac と呼ば
       れるファイルは、 anything という名前のマクロパッケージを決
       定しています。

       groff では、マクロパッケージの大部分は、古くからあるパッケ
       ージに対して `m' を先頭に付けた groff_<name>(7) という名前
       のマニュアルページで説明がされています。


取り込み

       ドキュメント中でマクロパッケージを使うための方法はいくつか
       ら ない場合、 .mso は代りに tmac.name をオープンしようとし
       ます。また、この逆も行います。

       .so および .mso リクエストを解決するために、roff プリプ ロ
       セッサ soelim が呼ばれなくてはならないことに注意してくださ
       い。ただし、インクルードされるファイルが前処理が必要な場合
       に限ります。これは、コマンドライン上でパイプラインから直接
       呼ぶか、または groff-s オプションを使うかすればでき ま
       す。

       B>約B>束B>事のセクションで述べているように、プリプロセッサワード
       中に文字 `s' を入れても良いです。

       例えば、マクロファイルが /usr/share/tmac/macros.tmac に 保
       存 されており、 docu.roff という名前のドキュメントで使用さ
       れているとします。

       実行時において、このドキュメントに対するフォーマッタ呼び出
       しは次のように行います。

              groff -m macros docu.roff

       ドキュメント内に直接マクロファイルを取り込むには、
              .mso macros.tmac
       あるいは
              .so /usr/share/tmac/macros.tmac
       を使用します。

       どちらの場合でも、フォーマッタは
              groff -s docu.roff
       を使用して呼び出されます。


約束事

       最近の roff 清書システムの多くでサポートされている約束事が
       あります。次に述べられているような B>プB>リB>プB>ロB>セB>ッB>サB>ワB>ーB>ド が
       それです。

       ド キュメントの 1 行目がコメントである場合、最初の単語 (コ
       メント文字および空白の後) は B>プB>リB>プB>ロB>セB>ッB>サ B>ワB>ーB>ドで構成さ
       れます。これはつまり、このワードの文字が、ドキュメントを整
       形する際に起動しなくてはならないプリプロセッサコマンドの省
       略形であると解釈されるということです。ほとんどの場合、プリ
       プロセッサのオプションに対応した文字だけが認識されます。そ
       れは、 `e', `G', `g', `p', `R', `s', `t' です ( roff(7) を
       参照)。

       さらに、ユーザへの良き忘備録として書いておきますが、フォー
       マッタによっては ( man(1) プログラムのように) プリプロセッ
       サワードで指定されたプリプロセッサを自動的に起動させること
       までもできるものがあります。ただし、このことをあてにしては
       いけません。

       もしあなたが書いたマクロが一般用途に使えるかもしれないもの
       なら、 groff メンテナに連絡を取って、そのマクロが groff の
       contrib ソースディレクトリに含まれるようにしてください。

       マクロを書く際には、いくつか一般的なガイドラインがあれば役
       に立つでしょう。

       o 機能のあるバックスラッシュはすべて 2 重にします。 `\' ->
         `\\'

       o 印字可能なバックスラッシュはすべて `\e' というように書か
         なくてはなりません。

       o ドットはすべてエスケープしてください。 `.' -> `\.'

       o テキスト部分には、印字できない文字 `\&' を広く使用するよ
         う にしてください。特に、 `\' の前や行頭で使用してくださ
         い。ただし、遅延コマンドの前では使用しないでください。

       o 文字 `@' を一時的な変数名に使用してください。

       o あなたが書いたマクロをテキストおよびグラフィックデバイス
         に対してテストしてください。例えば、 latin1ps がそう
         です。


関連ファイル

       tmac メカニズムを使用したいマクロ名はすべて、 name.tmac ま
       た は  tmac.name  の書式に従って名付けられなければなりませ
       ん。

       マクロファイルは、 tmac B>デB>ィB>レB>クB>トB>リB>群に保存されています。
       このディレクトリ群すべてが tmac B>パB>スを構成しています。

       マ ク ロファイルを検索するパスの要素は (順番に) 次の通りで
       す:

       o   troff に対応する groff の -M コマンドラインオプショ ン
           で指定されるディレクトリ command line option

       o   GROFF_TMAC_PATH 環境変数で与えられるディレクトリ

       o   現在のディレクトリ ( -U コマンドラインスイッチを使用し
           て、安全ではないモードである場合のみ)

       o   ホームディレクトリ

       o   サイト固有の (プラットフォーム非依存の) ディレクトリ、
           プ ラッ ト フォーム固有ディレクトリ、そしてメイン tmac
           ディレクトリ:

             /usr/share/tmac
             /usr/share/tmac

       す。このドキュメントは Bernd Warken <bwarken@mayn.de> が書
       きました。

       このドキュメントは FDL (GNU Free Documentation License) バ
       ー ジョン 1.1 以降の条項のもとで配布されています。お使いの
       システムには FDL のコピーがあるはずです。また、

              <http://www.gnu.org/copyleft/fdl.html>
       からオンラインでも入手可能です。


関連項目

       groff システムの詳細すべてについて 信 頼 で き る 情 報 源
       は、groff の info(1) ファイルです。

       groff の概要については、 roff(7) および groff ソースパッケ
       ージ中の README ファイルを参照してください。

       groff  tmac   マ ク ロ パッ ケ ー ジ  は、   groff_man(7),
       groff_mwww(7),    groff_mdoc(7),    groff_mdoc.samples(7),
       groff_me(7), groff_mm(7), groff_mmroff(7), groff_ms(7)  で
       す。

       groff の言語については groff(7) で、フォーマッタについては
       groff(1), troff(1) で説明されています。

       ファイルシステム 階 層 標 準  (FHS)   は  http://www.path-
       name.com/fhs/ で入手可能です。



Groff Version 1.17.2      6 August 2001             GROFF_TMAC(5)

ABELNET VPSサービス