vgrind(1) FreeBSD 一般コマンドマニュアル

vgrind

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

vgrind


            [-p postproc] [-sn] [-t] [-x] name ...


解説

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

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

     .vS     処理領域開始

     .vE     処理領域終了

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

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

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

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

     -             標準入力から読み込みます( -f オプションが指定された場合はデ
                   フォルトです)。

     -W            (ナロー)バリアン用ではなく、(ワイド)バーサテックプリンタの
                   出力を行います。

     -d file       プログラミング言語定義ファイルを指定します(デフォルトでは
                   /usr/share/misc/vgrindefs を使用します)。

     -f            フィルタモードで動作します。

     -h header     各ページのヘッダ文字列を指定します(デフォルトは入力ファイル
                   名です)。

     -l            入力ファイルのプログラミング言語を指定します。現在使用可能
                   なものは以下のとおりです: PASCAL (-lp), MODEL (-lm), C (-lc
                   もしくはデフォルト), C++ (-lc++), CSH (-lcsh), SHELL
                   (-lsh), RATFOR (-lr), MODULA2 (-lmod2), YACC (-lyacc), LISP
                   (-lisp), ICON (-lI), PERL (-lperl) 。

     -n            キーワードのボールド化を行いません。

     -p postproc   postproc を出力のポストプロセッサとして使用します。
                   psroff(1) がデフォルトです。

     /usr/share/tmac/tmac.vgrind  マクロパッケージ
     /usr/libexec/vfontedpr       プリプロセッサ
     /usr/share/misc/vgrindefs    言語記述ファイル


関連項目

     getcap(3), vgrindefs(5)


バグ

     vfontedpr は、以下のプログラミングスタイルを仮定しています:

     C 言語 - 関数名は、空白またはアスタリスクのみからなる行の直後にあり、括弧
     でくくられた引数リストが同じ行にある。

     PASCAL - 関数名は、キーワード function または procedure と同じ行にある。

     MODEL - 関数名は、キーワード is beginproc と同じ行にある。

     もし以上に従っていない場合、インデックスと余白への関数名印刷が不正確なも
     のになります。

     その他、いくつかのプログラミングスタイルはきれいに清書されません: ブラン
     クによってソースコードの先頭などを揃えた場合、正しくフォーマットされませ
     ん。 vgrind を使って清書する場合は、タブによってソースコードを揃えるよう
     にします。これは vgrind が可変幅フォントを使用するからです。

     vgrind は、 ctags(1) が関数を検出する方式を採用すべきです。

     フィルタモードは -me または -ms マクロを用いたドキュメントで、正しく動作
     しません。 (このモードは一体どこで使うのでしょう)


歴史

     vgrind は 3.0BSD で追加されました。

FreeBSD 4.4                      June 6, 1993                      FreeBSD 4.4

ABELNET VPSサービス