VGRIND(1,C) AIX Commands Reference VGRIND(1,C)
-------------------------------------------------------------------------------
vgrind
PURPOSE
Grinds (formats) nice listings of programs.
SYNTAX
+------------+ +------------+ +----------+ +--------------+
vgrind -| +--------+ |-| |-| |-| |-- name --|
+-| -f -sn |-+ +- -hheader -+ +- -dfile -+ +- -llanguage -+
| - -t |
| -n -x |
| -W |
+--------+
DESCRIPTION
The vgrind command formats the program sources, which are arguments, in a nice
style using troff. Comments 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 vgrind command runs in two basic modes, filter mode or regular mode. In
filter mode vgrind acts as a filter in a manner similar to tbl. 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 for output. There need be no particular ordering with eqn
or tbl.
In regular mode the vgrind command accepts input files, processes them, and
passes them to troff for output.
In both modes the vgrind command passes any lines beginning with a decimal
point without conversion.
FLAGS
-f Forces filter mode.
Processed November 8, 1990 VGRIND(1,C) 1
VGRIND(1,C) AIX Commands Reference VGRIND(1,C)
- Forces input to be taken from standard input (default if -f is
specified).
-d Specifies an alternate language definitions file (default is
/usr/lib/vgrindefs).
-h Specifies a particular header to put on every output page (default is
the file name).
-l Specifies the language to use. Currently known are CSH (-lcsh) (which
is the default), PASCAL (-lp), MODEL (-lm), C (-lc), SHELL (-lsh),
RATFOR (-lr), MODULA2 (-lmod2), YACC (-lyacc), LISP (-lisp), and ICON
(-lI).
-n Forces no bolding of keyword.
-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 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.
-W Forces output to the (wide) Versatec printer rather than the (narrow)
Varian printer.
FILES
index File where source for index is created.
/usr/lib/tmac/tmac.vgrind Macro package.
/usr/lib/vfontedpr Preprocessor.
/usr/lib/vgrindefs Language descriptions.
Processed November 8, 1990 VGRIND(1,C) 2