VGRIND(1)

NAME
vgrind - grind nice listings of C programs for the versatec

SYNOPSIS
vgrind [ -nx ] [ -h header ] name ...

DESCRIPTION
Vgrind formats the C programs 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.

The -h option specifies a header to be placed at the top of each page. If the program is not C source, but should be framed like the output of vgrind, the -n option should be specified.

To create an index, it is only necessary to create an empty file index in the current directory. As you run vgrind, the index will be automatically kept up to date. The index of function definitions can then be run off via giving vgrind the -x option and the file index as argument.

FILES
index    file where source for index is created
/usr/lib/tmac/tmac.vgrind    macro package
/usr/lib/vfontedpr    preprocessor

AUTHOR
William Joy

SEE ALSO
vtroff(1)

BUGS
Vfontedpr assumes that a certain programming style is followed: functions begin with the name of the function in column one, and lines defining functions end with a ). The function name is followed immediately by a ``('' with no intervening space. If this convention is not followed, the indexing and marginal function name comment mechanisms will fail.

More generally, arbitrary formatting styles for C 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.