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 4.1 (Berkeley) 04/29/85

C 4 vgrind - grind nice listings of programs vgrind [ -t ] [ -n ] [ -x ] [ -W ] [ -c ] [ -m ] [ -p ] [ -i ] [ -sn ] [ -h header ] name ... Vgrind formats the C, MODEL, or PASCAL 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 -W option sends the output to a 4 page wide raster plotter; normally, the output is printed on a narrow plotter.

The -c, -m, -p, and -i options select C, MODEL, PASCAL or ISP respectively as the language of the input files. The -c switch is the default and need not be specified.

Font size may be specified using the -s switch. The argument n is the point size (same as the argument of a .ps troff command).

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

The -t option is analogous to the -t option of troff (1) placing typesetter codes on the standard output.

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.

index file where source for index is created

/usr/lib/tmac/tmac.vgrind macro package

/usr/lib/vfontedpr preprocessor

William Joy vtroff(1) Vfontedpr assumes that a certain programming style is followed:

For C - 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.

For PASCAL - function names need to appear on the same line as the keywords function and procedure. The keyword end at the beginning of a line is interpreted as the end of the current function.

For MODEL - function names need to appear on the same line as the keywords is beginproc.

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 vgrind your program you should use tabs. This is somewhat inevitable since the font used by vgrind is variable width.

Should be able to be used as a preprocessor

The mechanism of ctags in recognizing functions should be used here.