VGRIND

Section: User Commands (1)
索引 jman

BSD mandoc

索引

名称

vgrind - プログラムのソースを清書する

索引

書式

[- ] [-W ] [-d file ] [-f ] [-h header ] [-l language ] [-n ] [-p postproc ] [-sn ] [-t ] [-x ] name ...

索引

解説

ユーティリティは、プログラムのソースを troff(1) を使って清書します。コメントはイタリック体で、キーワードはボールド体で、現在印刷中の関数名は、各ページの余白部分に列挙されます。

ユーティリティには 2 つの基本的なモード、フィルタモード( -f オプションの項を参照)と標準モードがあります。フィルタモードでは、は tbl(1) と同様に振る舞います。すなわち、以下の troff ライク なマクロに囲まれた部分以外は素通しします。

.vS: 処理領域開始
.vE: 処理領域終了

マクロに囲まれた行は既に示したように清書されます。からの出力を troff(1) に渡すことにより印刷することができます。 eqn(1) や tbl(1) との呼び出し順序には特別な制限はありません。

通常モードでは、は入力ファイル全体を処理し、ポストプロセッサを起動して出力処理を行わせます。ポストプロセッサのデフォルトは psroff(1) です

どちらのモードでも、はピリオドで開始する行は変更せずに出力します。

オプションは以下のとおりです。

-: 標準入力から読み込みます( -f オプションが指定された場合はデフォルトです)。
-W: (ナロー)バリアン用ではなく、(ワイド)バーサテックプリンタの出力を行います。
-d file: プログラミング言語定義ファイルを指定します(デフォルトでは /usr/share/misc/vgrindefs を使用します)。
-f: フィルタモードで動作します。
-h header: 各ページのヘッダ文字列を指定します(デフォルトは入力ファイル名です)。
-l: 入力ファイルのプログラミング言語を指定します。現在使用可能なものは以下のとおりです: PASCAL (-l p ) MODEL (-l m ) C ( -l c もしくはデフォルト), C++ (-l c++ ) CSH (-l csh ) SHELL (-l sh ) RATFOR (-l r ) MODULA2 (-l mod2 ) YACC (-l yacc ) LISP (-l isp ) ICON (-l I ) PERL (-l perl ) 。
-n: キーワードのボールド化を行いません。
-p postproc: postproc を出力のポストプロセッサとして使用します。 psroff(1) がデフォルトです。
-s: 出力文字のポイントサイズを指定します(troff の .ps と同じ引数です)。
-t: troff(1) の同一のオプションと同じく、フォーマット後、標準出力に書き出します。
-x: インデックスファイルを清書します。は、カレントディレクトリに index という名前のファイルがあればつねにインデックスを出力します。このインデックスファイルをに -x オプションとともに指定することで、清書することができます。