vgrind - grind nice listings of programs
vgrind [-] [-W] [-d file] [-f] [-h header] [-l language]
[-n] [-sn] [-t]
[-x] name ...
vgrind formats the program sources which are arguments in a
using troff(1). Comments are placed in italics, keywords in
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:
.vS starts processing
.vE ends processing
These lines are formatted as described above. The output
from this filter
can be passed to troff(1) for output. There need be no
ordering with eqn(1) or tbl(1).
In regular mode vgrind accepts input files, processes them,
them to troff(1) for output.
In both modes vgrind passes any lines beginning with a decimal point
The options are as follows:
- Forces input to be taken from standard input (default if -f is
-W Forces output to the (wide) Versatec printer rather
Specifies an alternate language definitions file
-f Forces filter mode.
Specifies a particular header to put on every output
is the file name).
-l Specifies the language to use. Currently known are
MODEL (-lm), C (-lc or the default), CSH (-lcsh),
RATFOR (-lr), MODULA2 (-lmod2), YACC (-lyacc), LISP
-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
itself is produced whenever vgrind is run with a
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.
index file where source for index is
/usr/share/tmac/tmac.vgrind macro package
/usr/share/misc/vgrindefs language descriptions
lpr(1), troff(1), getcap(3), vgrindefs(5)
The vgrind command appeared in 3.0BSD.
vfontedpr assumes that a certain programming style is followed:
For 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
If these conventions are not followed, the indexing and
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
since the font used by vgrind is variable width.
The mechanism of ctags(1) in recognizing functions should be
Filter mode does not work in documents using the -me or -ms
what use is it anyway?)
OpenBSD 3.6 June 6, 1993
[ Back ]