日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
VGRIND(1) FreeBSD 一般コマンドマニュアル VGRIND(1)
名称
vgrind -- プログラムの良いリストを磨く
書式
vgrind [-] [-W] [-d file] [-f] [-h header] [-llanguage] [-n]
[-p postproc] [-s pointsize] [-t] [-x] name ...
解説
vgrind ユーティリティは、troff(1) を使用して良いスタイルのコマンド行の引
数として指定されるプログラムソースを書式化します。コメントは、イタリック
体、ボールド体のキーワードで置かれ、現在の関数の名前は、それが遭遇するよ
うに各ページのマージンを下げてリストされます。
vgrind ユーティリティは、2 つの基本的なモード、フィルタモード (-f オプ
ションを参照)、または通常モードで実行します。フィルタモードで、vgrind
は、tbl(1) に似た方法のフィルタとして動作します。標準入力は、troff に似た
マクロによって囲まれた行を除けば標準出力に直接渡されます:
.vS 処理を開始する
.vE 処理を終了する
これらの行は、上に説明されるように書式化されます。出力のためにこのフィル
タからの出力を troff(1) に渡すことができます。eqn(1) または tbl(1) で特定
の順序である必要はありません。
通常モードで、vgrind は、入力ファイルを受け付け、それらを処理し、そして、
それらを出力のために、デフォルトで psroff(1) であるポストプロセッサに渡し
ます。
両方のモードで、vgrind は、変換なしで小数点で始まるあらゆる行を渡します。
オプションは、次の通りです:
- 入力は、(-f が指定されるなら、デフォルトで) 標準入力から強
制的に取られます。
-W (狭い) Varian ではなく (広い) Versatec プリンタに強制的に出
力します。
-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 デフォルトで psroff(1) である出力をポスト処理するために
postproc を使用します。
-s pointsize 出力において使用するポイントサイズを指定します (.ps の引数
として正確に同じです)。
-t troff(1) の同じオプションと同様に、書式化されたテキストは、
標準出力に行きます。
-x ``プリティ'' 形式でインデックスファイルを出力します。イン
デックスファイル自体は、vgrind が、カレントディレクトリの
index と呼ばれるファイルで実行されるときはいつでも、生成さ
れます。次に、-x オプションと引数としてファイル index を
vgrind に与えることによって関数定義のインデックスを清書
(run off) することができます。
関連ファイル
index インデックスのためのソースが作成される場所の
ファイル
/usr/share/tmac/tmac.vgrind マクロパッケージ
/usr/libexec/vfontedpr プリプロセッサ
/usr/share/misc/vgrindefs 言語記述
関連項目
getcap(3), vgrindefs(5)
歴史
vgrind コマンドは 3.0BSD で追加されました。
バグ
vfontedpr プリプロセッサは、特定のプログラミングスタイルが、次の通りであ
ることを仮定します:
C について、- 空白、タブまたはアスタリスクだけによって行に関数名を先行す
ることができます。また、括弧で囲まれた引数は、同じ行になければなりませ
ん。
PASCAL について、- 関数名は、キーワード function または procedure と同じ
行に現れる必要があります。
MODEL について、- 関数は、キーワード is beginproc と同じ行に現れる必要が
あります。
これらの慣習が従われないなら、インデックスとマージン関数名のコメントのメ
カニズムは、失敗します。
より一般的に、プログラムのための任意の書式スタイルは、たいていみてくれが
悪くなります。ソースコードを整列するための空白の使用は、ぶざまに失敗しま
す。利用者が利用者のプログラムを vgrind するつもりであるなら、利用者は、
タブを使用するべきです。vgrind によって使用されるフォントは、可変の幅であ
るので、これは、いくらか必然的です。
認識している関数の ctags(1) メカニズムは、ここで使用されるべきです。
フィルタモードは、-me または -ms マクロを使用している文書化で動作しませ
ん。(したがって、とにかく、何に使用するか?)
FreeBSD 11.2 August 29, 2006 FreeBSD 11.2