'\" te
.\" Copyright (c) 1980 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution.
.\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved
.TH vgrind 1 "2000 年 3 月 3 日" "SunOS 5.11" "ユーザーコマンド"
.SH 名前
vgrind \- プログラムリストの整形
.SH 形式
.LP
.nf
\fBvgrind\fR [\fB-2fntwx\fR] [\fB-d\fR \fIdefs-file\fR] [\fB-h\fR \fIheader\fR] [\fB-l\fR \fIlanguage\fR] 
     [\fB-s\fR \fIn\fR] [\fB-o\fR \fIpagelist\fR] [\fB-P\fR \fIprinter\fR] [\fB-T\fR \fIoutput-device\fR] \fIfilename\fR...
.fi

.SH 機能説明
.sp
.LP
\fBvgrind\fR ユーティリティーは、\fBtroff\fR(1) を使用して、\fIfilename\fR 引数で指定されたプログラムソースを整形された形式でフォーマットします。コメントは斜体、キーワードは太字で配置され、各関数が出現すると、その名前がページの余白に表示されます。
.sp
.LP
\fBvgrind\fR は、2 つの基本モード (フィルタモードまたは通常モード) で実行されます。フィルタモードでは、\fBvgrind\fR は \fBtbl\fR(1) と同様のフィルタとして機能します。\fBtroff\fR のようなマクロで囲まれた行を除いて、標準入力は標準出力に直接渡されます。
.sp
.ne 2
.mk
.na
\fB\fB .vS\fR\fR
.ad
.RS 9n
.rt  
処理の開始
.RE

.sp
.ne 2
.mk
.na
\fB\fB\&.vE\fR\fR
.ad
.RS 9n
.rt  
処理の終了
.RE

.sp
.LP
これらの行は上記のとおりにフォーマットされます。このフィルタからの出力は、出力用に \fBtroff\fR に渡すことができます。\fBeqn\fR(1) または \fBtbl\fR(1) では、特定の順序は必要ありません。
.sp
.LP
通常モードでは、\fBvgrind\fR は入力 \fIfilename\fR を受け入れ、それを処理して出力用に \fBtroff \fR に渡します。標準入力を指定するには、ハイフン (`\fB-\fR') を使用します。それ以外の場合は、\fBvgrind\fR は標準入力からの読み取りを試みることなく終了します。ファイル名は、その他のすべてのオプション引数のあとに指定する必要があります。
.sp
.LP
通常モードでは、\fB-t\fR または \fB-P\fR オプションが指定されている場合の出力は次のとおりです。
.RS +4
.TP
.ie t \(bu
.el o
\fB-t\fR オプションが指定されている場合は、標準出力に (\fBtroff\fR 形式で) 出力されます。
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fB- P\fR オプションが指定されている場合は、指定されたプリンタに (PostScript として) 出力されます。
.RE
.sp
.LP
それ以外の場合の出力は次のとおりです。
.RS +4
.TP
.ie t \(bu
.el o
システムのデフォルトプリンタが 1 台定義され、コマンドの標準出力が tty の場合は、そのプリンタに (PostScript として) 出力されます。
.RE
.RS +4
.TP
.ie t \(bu
.el o
標準出力が tty 以外の場合 (つまり、標準出力がパイプまたはファイルへのリダイレクトである場合) は、標準出力に (PostScript として) 出力されます。
.RE
.sp
.LP
どちらのモードでも、\fBvgrind\fR は小数点で始まる行を変換せずに渡します。
.SH オプション
.sp
.LP
サポートしているオプションは、次のとおりです。
.sp
.ne 2
.mk
.na
\fB\fB-2\fR\fR
.ad
.RS 16n
.rt  
2 つのカラムの出力を生成します。このオプションを指定すると、デフォルトのポイントサイズが 8 に変更されます (\fB-s8\fR オプションが指定された場合と同様)。また、横モードで表示されるように出力が配置されます。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-f\fR\fR
.ad
.RS 16n
.rt  
強制的にフィルタモードになります。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-n\fR\fR
.ad
.RS 16n
.rt  
キーワードを太字にしません。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-w\fR\fR
.ad
.RS 16n
.rt  
TAB 文字が通常の 8 カラムではなく 4 カラムの間隔を空けるものと見なされます。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-x\fR\fR
.ad
.RS 16n
.rt  
インデックスファイルを「整形された」形式で出力します。\fBvgrind\fR が現在のディレクトリに存在する \fBindex \fR というファイルで実行されるたびに、インデックスファイル自体が生成されます。\fBvgrind\fR に \fB- x\fR オプションおよびファイル \fBindex\fR を引数として指定すると、関数定義のインデックスを出力できます。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-d\fR \fIdefs-file\fR\fR
.ad
.RS 16n
.rt  
代替の言語定義ファイルを指定します (デフォルトは \fB/usr/lib/vgrindefs\fR)。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-h\fR \fIheader\fR \fR
.ad
.RS 16n
.rt  
すべての出力ページの中央にヘッダーが表示されるように指定します。スペースが埋め込まれたヘッダーを指定するには、引用符を使用します。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-l\fR \fIlanguage\fR\fR
.ad
.RS 16n
.rt  
使用する言語を指定します。現在認識されている\fI言語\fRは、Bourne シェル (\fB-lsh\fR)、C (\fB-lc\fR、デフォルト)、C++ (\fB-lc++\fR)、C シェル (\fB-lcsh\fR)、emacs MLisp (\fB-lml\fR)、FORTRAN (\fB- lf\fR)、Icon (\fB-lI\fR)、ISP (\fB-i\fR)、LDL (\fB-lLDL\fR)、Model (\fB-lm\fR)、Pascal (\fB-lp \fR)、および RATFOR (\fB-lr\fR) です。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-P\fR \fIprinter\fR\fR
.ad
.RS 16n
.rt  
指定された\fIプリンタ\fRに出力を送信します。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-s\fR\fIn\fR \fR
.ad
.RS 16n
.rt  
出力で使用するポイントサイズを指定します (\fBtroff\fR \fB\&.ps\fR ポイントサイズ要求の引数とまったく同じ)。
.RE

.sp
.LP
\fBvgrind\fR は、\fBTROFF\fR 環境変数で指定されたフォーマッタに次のオプションを渡します。「環境変数」を参照してください。
.sp
.ne 2
.mk
.na
\fB\fB-t\fR\fR
.ad
.RS 20n
.rt  
\fBtroff\fR の同オプションと同様です。つまり、フォーマット済みのテキストが標準出力に渡されます。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-o\fR\fIpagelist\fR\fR
.ad
.RS 20n
.rt  
\fIpagelist\fR で示したページだけを出力します。このリストには、複数のページ番号またはページ番号の範囲 (またはその両方) をコンマで区切って記述します。範囲として \fIN-M\fR と記述すればページ番号 \fIN\fR から \fIM\fR までが出力され、リストの先頭に \fB-N\fR と記述すれば先頭ページからページ番号 \fIN\fR までが出力され、最後に \fIN\fR- と記述すればページ番号 \fIN\fR から最終ページまでが出力されます。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-T\fR \fIoutput-device\fR\fR
.ad
.RS 20n
.rt  
指定された \fIoutput-device\fR の出力をフォーマットします。
.RE

.SH オペランド
.sp
.LP
次のオペランドを指定できます。
.sp
.ne 2
.mk
.na
\fB\fIfilename\fR\fR
.ad
.RS 12n
.rt  
\fBvgrind\fR で処理されるプログラムソースの名前。標準入力を指定するには、`\fB-\fR' を使用します。
.RE

.SH 環境
.sp
.LP
通常モードでは、\fBvgrind\fR は中間出力を \fBTROFF\fR 環境変数の値で指定されたテキストフォーマッタに出力します。この変数が環境に定義されていない場合は、\fB/usr/bin/troff\fR に出力します。このメカニズムでは、\fBtroff\fR の名前で地域のバリエーションが許可されます。
.SH ファイル
.sp
.ne 2
.mk
.na
\fB\fBindex\fR\fR
.ad
.sp .6
.RS 4n
インデックスのソースが作成されるファイル
.RE

.sp
.ne 2
.mk
.na
\fB\fB/usr/lib/vgrindefs\fR\fR
.ad
.sp .6
.RS 4n
言語の記述
.RE

.sp
.ne 2
.mk
.na
\fB\fB/usr/lib/vfontedpr\fR\fR
.ad
.sp .6
.RS 4n
プリプロセッサ
.RE

.sp
.ne 2
.mk
.na
\fB\fB/usr/share/lib/tmac/tmac.vgrind\fR\fR
.ad
.sp .6
.RS 4n
マクロパッケージ
.RE

.SH 属性
.sp
.LP
属性についての詳細は、マニュアルページの \fBattributes\fR(5) を参照してください。
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
属性タイプ属性値
_
使用条件text/doctools
.TE

.SH 関連項目
.sp
.LP
\fBcsh\fR(1), \fBctags\fR(1), \fBeqn\fR(1), \fBtbl\fR(1), \fBtroff\fR(1), \fBattributes\fR(5), \fBvgrindefs\fR(5)
.SH 使用上の留意点
.sp
.LP
\fBvgrind\fR では、特定のプログラミング形式に従うことを前提にしています。
.sp
.ne 2
.mk
.na
\fBC\fR
.ad
.RS 11n
.rt  
関数名は 1 行で SPACE、TAB、またはアスタリスク (\fB*\fR) のあとにのみ指定できます。括弧で囲まれた引数も同じ行に指定する必要があります。
.RE

.sp
.ne 2
.mk
.na
\fBFORTRAN\fR
.ad
.RS 11n
.rt  
関数名は、キーワード \fBfunction\fR または \fBsubroutine\fR と同じ行に指定する必要があります。
.RE

.sp
.ne 2
.mk
.na
\fBMLisp\fR
.ad
.RS 11n
.rt  
関数名は、直前の \fBdefun\fR と同じ行に指定してはいけません。
.RE

.sp
.ne 2
.mk
.na
\fBModel\fR
.ad
.RS 11n
.rt  
関数名は、キーワード \fBis beginproc\fR と同じ行に指定する必要があります。
.RE

.sp
.ne 2
.mk
.na
\fBPascal\fR
.ad
.RS 11n
.rt  
関数名は、キーワード \fBfunction\fR または \fBprocedure\fR と同じ行に指定する必要があります。
.RE

.sp
.LP
これらの規則に従っていない場合は、インデックスおよび限界関数名のコメントメカニズムが失敗します。
.sp
.LP
さらに一般的には、通常はプログラムの任意のフォーマット形式の体裁が悪くなります。\fBvgrind\fR ではさまざまな幅のフォントが使用されるため、プログラムに \fBvgrind\fR 出力の準備をするには、SPACE 文字ではなく TAB を使用してソースコードを適切にそろえます。
.sp
.LP
ここでは、関数の認識時に \fBctags\fR(1) のメカニズムを使用する必要があります。
.sp
.LP
\fB-w\fR オプションは不便ですが、目的の効果を実現する方法はほかにありません。
.sp
.LP
\fBtmac.vgrind\fR で定義されたマクロは、その他のマクロパッケージのマクロとの共存が許容されないため、フィルタモードを有効に使用することが困難になります。
.sp
.LP
\fBvgrind\fR は、\fBcsh\fR(1) スクリプトで特定の特殊文字を処理しません。
.sp
.LP
\fBtmac.vgrind\fR フォーマットマクロによって 2 カラムモードで使用されるページの高さと幅で固定されるため、標準的な米国のサイズである 8.5 インチ X 11 インチ以外の用紙サイズでは 2 カラム出力が事実上役に立たなくなります。その他の用紙サイズを使用するには、\fBtmac.vgrind\fR で指定されたサイズ値を編集する必要があります。より適切なソリューションとして、横方向出力専用の \fBtroff\fR 出力デバイス仕様を作成して、そこにサイズ情報を記録することが考えられます。