diff options
Diffstat (limited to 'ja/man/man1/vgrind.1')
-rw-r--r-- | ja/man/man1/vgrind.1 | 239 |
1 files changed, 239 insertions, 0 deletions
diff --git a/ja/man/man1/vgrind.1 b/ja/man/man1/vgrind.1 new file mode 100644 index 0000000000..1853765398 --- /dev/null +++ b/ja/man/man1/vgrind.1 @@ -0,0 +1,239 @@ +.\" Copyright (c) 1980, 1990, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)vgrind.1 8.1 (Berkeley) 6/6/93 +.\" jpman %Id: vgrind.1,v 1.3 1997/06/30 16:47:04 horikawa Stab % +.\" +.Dd June 6, 1993 +.Dt VGRIND 1 +.Os BSD 4 +.Sh 名称 +.Nm vgrind +.Nd プログラムのソースを清書する +.Sh 書式 +.Nm +.Op Fl +.Op Fl W +.Op Fl d Ar file +.Op Fl f +.Op Fl h Ar header +.Op Fl l Ns Ar language +.Op Fl n +.Op Fl p Ar postproc +.Op Fl sn +.Op Fl t +.Op Fl x +.Ar name Ar ... +.Sh 解説 +.Nm +は、プログラムのソースを +.Xr troff 1 +を使って清書します。コメント +はイタリック体で、キーワードはボールド体で、現在印刷中の関数名は、 +各ページの余白部分に列挙されます。 +.Pp +.Nm +には 2 つの基本的なモード、フィルタモード( +.Fl f +オプションの項を参照)と +標準モードがあります。フィルタモードでは、 +.Nm +は +.Xr tbl 1 +と同様 +に振る舞います。すなわち、以下の +.Em "troff ライク" +なマクロに囲まれた部分以外 +は素通しします。 +.Bl -tag -width Ds +.It \&.vS +処理領域開始 +.It \&.vE +処理領域終了 +.El +.Pp +マクロに囲まれた行は既に示したように清書されます。 +.Nm +からの出力を +.Xr troff +に渡すことにより印刷することができます。 +.Xr eqn 1 +や +.Xr tbl 1 +との呼び出し順序には特別な制限はありません。 +.Pp +通常モードでは、 +.Nm +は入力ファイル全体を処理し、 +ポストプロセッサを起動して出力処理を行わせます。 +ポストプロセッサのデフォルトは +.Xr psroff 1 +です +.Pp +どちらのモードでも、 +.Nm +はピリオドで開始する行は変更せずに出力します。 +.Pp +オプションは以下のとおりです。 +.Bl -tag -width Ar +.It Fl +標準入力から読み込みます( +.Fl f +オプションが指定された場合はデフォルトです)。 +.It Fl W +(ナロー)バリアン用ではなく、(ワイド)バーサテックプリンタの出力を +行います。 +.It Fl d Ar file +プログラミング言語定義ファイルを指定します(デフォルトでは +.Pa /usr/share/misc/vgrindefs +を使用します)。 +.It Fl f +フィルタモードで動作します。 +.It Fl h Ar header +各ページのヘッダ文字列を指定します(デフォルトは入力ファイル名です)。 +.It Fl l +入力ファイルのプログラミング言語を指定します。現在使用可能なものは以下 +のとおりです: +.Tn PASCAL +.Pq Fl l Ns Ar p , +.Tn MODEL +.Pq Fl l Ns Ar m , +C +.Pf ( Fl l Ns Ar c +もしくはデフォルト), +.Tn C++ +.Pq Fl l Ns Ar c++ , +.Tn CSH +.Pq Fl l Ns Ar csh , +.Tn SHELL +.Pq Fl l Ns Ar sh , +.Tn RATFOR +.Pq Fl l Ns Ar r , +.Tn MODULA2 +.Pq Fl l Ns Ar mod2 , +.Tn YACC +.Pq Fl l Ns Ar yacc , +.Tn LISP +.Pq Fl l Ns Ar isp , +.Tn ICON +.Pq Fl l Ns Ar I , +.Tn TCL +.Pq Fl l Ns Ar Tcl , +.Tn PERL +.Pq Fl l Ns Ar perl +。 +.It Fl n +キーワードのボールド化を行いません。 +.It Fl p Ar postproc +.Ar postproc +を出力のポストプロセッサとして使用します。 +.Xr psroff 1 +がデフォルトです。 +.It Fl s +出力文字のポイントサイズを指定します(troff の .ps と同じ引数です)。 +.It Fl t +.Xr troff +の同一のオプションと同じく、 +フォーマット後、標準出力に書き出します。 +.It Fl x +インデックスファイルを清書します。 +.Nm +は、カレントディレクトリに +.Pa index +という名前のファイルがあればつねにインデックスを +出力します。このインデックスファイルを +.Nm +に +.Fl x +オプションととも +に指定することで、清書することができます。 +.El +.Sh 関連ファイル +.Bl -tag -width /usr/share/misc/vgrindefsxx -compact +.It Pa index +インデックスファイル +.It Pa /usr/share/tmac/tmac.vgrind +マクロパッケージ +.It Pa /usr/libexec/vfontedpr +プリプロセッサ +.It Pa /usr/share/misc/vgrindefs +言語記述ファイル +.El +.Sh 関連項目 +.Xr getcap 3 , +.Xr vgrindefs 5 +.Sh バグ +vfontedpr は、以下のプログラミングスタイルを仮定しています: +.Pp +.Tn C 言語 +\- 関数名は、空白またはアスタリスクのみからなる行の直後にあり、括 +弧でくくられた引数リストが同じ行にある。 +.Pp +.Tn PASCAL +\- 関数名は、キーワード +.Em function +または +.Em procedure +と同じ行にある。 +.Pp +.Tn MODEL +\- 関数名は、キーワード +.Em is beginproc +と同じ行にある。 +.Pp +もし以上に従っていない場合、インデックスと余白への関数名印刷が不正確な +ものになります。 +.Pp +その他、いくつかのプログラミングスタイルはきれいに清書されません: +ブランクによってソースコードの先頭などを揃えた場合、正しくフォーマットされ +ません。 +.Nm +を使って清書する場合は、タブによってソースコードを揃える +ようにします。これは +.Nm +が可変幅フォントを使用するからです。 +.Pp +.Nm +は、 +.Xr ctags 1 +が関数を検出する方式を採用すべきです。 +.Pp +フィルタモードは +.Fl me +または +.Fl ms +マクロを用いたドキュメントで、正しく動作しません。 +(このモードは一体どこで使うのでしょう) +.Sh 歴史 +.Nm +は +.Bx 3.0 +で追加されました。 |