vgrind 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 (see the
-f option) 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(1) 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:
-
forces input to be taken from standard input (default if -f is specified )
-W
forces output to the (wide) Versatec printer rather than the (narrow) Varian
-d file
specifies an alternative language definitions file (default is /usr/share/misc/vgrindefs)
-h header
specifies a particular header to put on every output page (default is the file name)
-l
specifies the language to use. Currently known are PASCAL (-lp), MODEL (-lm), C (-lc or the default), CSH (-lcsh), SHELL (-lsh), RATFOR (-lr), MODULA2 (-lmod2), YACC (-lyacc), LISP (-lisp), and ICON (-lI).
-n
forces no keyword bolding
-s
specifies a point size to use on output (exactly the same as the argument of a .ps)
-t
similar to the same option in
troff(1) causing formatted text to go to the standard output
-x
outputs the index file in a ``pretty'' format. The index file itself is produced whenever vgrind is run with a file called index in the current directory. The index of function definitions can then be run off by giving vgrind the -x option and the file index as argument.