名称

groff_trace - groff マクロパッケージ trace.tmac

書式

groff -m trace [ options...] [ files...]

角括弧 (ブラケット) 中の要素はオプションの引数を意味します。また、省略 (...) はこの種の引数がいくつもありえることを意味します。

解説

groff(1) の trace (トレース) マクロパッケージは、roff フォーマット言語で書かれた文書をデバッグするための便利なツールです。要するに、呼び出しスタックトレースは、標準エラーに出力されます。要するに、マクロの呼び出しの開始点と終了点で診断メッセージが表示されるということです。これは、ある種のマクロにおいてエラーの追跡に大いに役立ちます。

このトレース処理は、groff か troff コマンドラインオプション -m trace の指定により活性化されます。このトレース処理はさらに groffer(1) ビューア (閲覧) プログラムで働きます。より細かい制御は、groff マクロ呼び出し .mso trace.tmac によって文書内にそのマクロファイルを含めることにより得ることができます。この行の後で定義されるマクロだけがトレースされます。

ある他のマクロパッケージが同様にトレースされる場合、コマンドライン上の -m trace の後でそれは指定されなければなりません。

ユーザによって呼び出されるマクロをなにも含んでいないので、マクロファイル trace.tmac は、普通ではありません。そうしないで、既存のマクロ定義と追加機能はそれらが診断メッセージを表示するように修正されます。

使用例

次の例において、roff フラグメントが標準入力を介して groff に送り込まれます。端末上の診断メッセージ (標準エラー) に興味を持っているだけなので、正常なフォーマットされた出力 (標準出力) はニルバーナデバイス /dev/null に出力先変更されます。結果の診断メッセージは、下記の対応する例に直接表示されます。

関連ファイル

trace マクロは、 tmac ディレクトリ にあるファイル trace.tmac の中で維持されます。詳細に関しては、 groff_tmac(5) を参照してください。

環境変数

マクロファイルを検索する追加 tmac ディレクトリの

コロンで分離されたリスト。詳細に関しては、 groff_tmac(5) を参照してください。

作者

Copyright (C) 2002 Free Software Foundation, Inc.

この文書は、FDL (GNU Free Documentation License) バージョン 1.1 以降の条項に従って配布されます。利用者のシステムには、FDL のコピーを受け取っているはずです。それはでオンラインでも入手可能です。

この文書は groff、GNU roff 配布の一部です。それはによって書かれました。

関連項目

groff(1)

groff システムの概観。

troff(1)

オプション -m にの詳細ついて。

groffer(1)

すべての種類の roff 文書のためのビューア (閲覧) プログラム。

groff_tmac(5)

groff マクロパッケージの一般的な説明。

groff(7)

groff フォーマット言語のための簡潔なリファレンス (参照)。

groff システムのすべての部分のための完全なリファレンス (参照) は、groff info(1) ファイルに置かれています。