.\" Copyright (c) 1980 Regents of the University of California.
.\" All rights reserved. The Berkeley software License Agreement
.\" specifies the terms and conditions for redistribution.
.\" @(#)vgrind.1 6.2 (Berkeley) %G%
vgrind \- grind nice listings of programs
formats the program sources which are arguments
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.
runs in two basic modes, filter mode or regular mode. In filter mode
acts as a filter in a manner similar to
The standard input is passed directly to the standard output except
for lines bracketed by the
These lines are formatted as described above. The output from this
for output. There need be no particular ordering with
accepts input files, processes them, and passes them to
passes any lines beginning with a decimal point without conversion.
forces input to be taken from standard input (default if
similar to the same option in
causing formatted text to go to the standard output
forces no keyword bolding
outputs the index file in a ``pretty'' format.
The index file itself is produced whenever
is run with a file called
in the current directory.
definitions can then be run off by giving
forces output to the (wide) Versatec printer rather than the (narrow)
specifies a point size to use on output (exactly the same as the argument
specifies a particular header to put on every output page (default is
specifies an alternate language definitions
file (default is /usr/lib/vgrindefs)
specifies the language to use. Currently known are PASCAL
index file where source for index is created
/usr/lib/tmac/tmac.vgrind macro package
/usr/lib/vfontedpr preprocessor
/usr/lib/vgrindefs language descriptions
Dave Presotto & William Joy
Vfontedpr assumes that a certain programming style is followed:
\- 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.
\- function names need to appear on the same line as the keywords
\- function names need to appear on the same line as the keywords
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
your program you should use tabs. This is somewhat inevitable since the
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?)