NAMEvgrind - grind nice listings of programs
vgrind [-2ftnxw] [-sn]
[-h header] [-d file]
[-l language] [-P printer]
[-T device] [-o list]
DESCRIPTIONVgrind formats the program sources which are arguments in a nice style using troff(1). Comments are placed in italics, keywords in bold face, and the name of the current function is listed down the margin of each page as it is encountered.
Vgrind runs in two basic modes, filter mode or regular mode. In filter mode vgrind acts as a filter in a manner similar to tbl(1). The standard input is passed directly to the standard output except for lines bracketed by the troff-like macros:
These lines are formatted as described above. The output from this filter can be passed to troff for output. There need be no particular ordering with eqn(1) or tbl(1).
In regular mode vgrind accepts input files, processes them, and passes them to troff(1) for output.
In both modes vgrind passes any lines beginning with a decimal point without conversion.
The options are:
FILESindex file where source for index is created
/usr/ucblib/tmac/vgrind macro package
/usr/ucblib/vgrindefs language descriptions
NOTESVfontedpr assumes that a certain programming style is followed:
For C and C++ - function names can be preceded on a line only by spaces, tabs, or an asterisk. The parenthesized arguments must also be on the same line.
For PASCAL - function names need to appear on the same line as the keywords function or procedure.
For MODEL - function names need to appear on the same line as the keywords is beginproc.
If these conventions are not followed, the indexing and marginal function name comment mechanisms will fail.
More generally, arbitrary formatting styles for programs mostly look bad. The use of spaces to align source code fails miserably; if you plan to vgrind your program you should use tabs. This is somewhat inevitable since the font used by vgrind is variable width.
The mechanism of ctags in recognizing functions should be used here.
Filter mode does not work in documents using the -me or -ms macros. (So what use is it anyway?)
Written by Dave Presotto & William Joy.
Visit the GSP FreeBSD Man Page Interface.