macref コマンド

目的

マクロ・ファイルの相互参照リストを作成します。

構文

macref [ -n ] [ -s ] [ -t ] [ ] [ File ... ]

説明

macref コマンドは、指定された英語のファイルを読み取り (nroff または troff コマンドの入力と想定されています)、入力内の記号の相互参照リストを作成します。

デフォルトの出力は入力内の記号のリストで、各記号にはその記号に対するすべての参照のリストが付いています。macref コマンドは、記号をアルファベット順に左の列にリストし、その参照を右の列にリストします。各参照は、次の形で出力されます。

[ [(  NMName ) ]
MName- ]
Type LNumber
[  # ]

生成された名前は、~sym という人工シンボル名でリストされます。

入力パラメーター

項目 説明
ファイル macref コマンドが相互参照マクロのリストを含む出力を作成する nroff または troff ファイルを指定します。

出力パラメーター

項目 説明
NMName MName が定義されたマクロ名。
MName 参照が発生するマクロ名。参照がマクロの外で発生する場合、このフィールドは存在しません。
Type コンテキストによって、このシンボルのオカレンスと対応するタイプ。次のタイプがあります。
r
要求
m
マクロ
d
逸脱
s
文字列
n
数値レジスター
p
パラメーター。例えば、¥$x は、 x へのパラメーター参照です。

注: パラメーターは変更されません。また、有効なパラメーターのシンボル名は、1、2 . . . 9 だけです。

LNumber 参照が発生した行番号。
# この記号がシンボルの値を変更しています。

フラグ

項目 説明
-n 記号への参照ごとに 1 行ずつ出力させます。
-s 記号の使用状況の統計情報値を出力させます。
-t マクロの目次を出力させます。

複数のフラグを 1 つの - (負符号) の後にまとめて指定できます。フラグの終わりを区切るには、— (ダッシュ) を使用します。

注: macref コマンドは、 - を標準入力として受け入れません。

ファイル

項目 説明
/tmp/macref.tXXXXXX 一時ファイルが入っています。
/tmp/macref.sXXXXXX 一時ファイルが入っています。
/tmp/macref.cXXXXXX 一時ファイルが入っています。