4BSD/usr/man/cat1/vgrind.1

Compare this file to the similar file:
Show the results in this format:



VGRIND(1)           UNIX Programmer's Manual            VGRIND(1)



NAME
     vgrind - grind nice listings of C programs

SYNOPSIS
     vgrind [ -t ] [ -n ] [ -x ] [ -W ] [ -h header ] name ...

DESCRIPTION
     _V_g_r_i_n_d formats the C programs which are arguments in a nice
     style using _t_r_o_f_f (1).  Comments are placed in italics, key-
     words 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 -h option specifies a header to be placed at the top of
     each page.  If the program is not C source, but should be
     framed like the output of _v_g_r_i_n_d, the -n option should be
     specified.

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

     To create an index, it is only necessary to create an empty
     file _i_n_d_e_x in the current directory.  As you run _v_g_r_i_n_d, the
     index will be automatically kept up to date.  The index of
     function definitions can then be run off via giving _v_g_r_i_n_d
     the -x option and the file _i_n_d_e_x as argument.

FILES
     index               file where source for index is created
     /usr/lib/tmac/tmac.vgrindmacro package
     /usr/lib/vfontedpr  preprocessor

AUTHOR
     William Joy

SEE ALSO
     vtroff(1)

BUGS
     Vfontedpr assumes that a certain programming style is fol-
     lowed: 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.  If this convention is not followed, the
     indexing and marginal function name comment mechanisms will
     fail.

     More generally, arbitrary formatting styles for C programs
     mostly look bad.  The use of spaces to align source code



Printed 11/10/80                                                1






VGRIND(1)           UNIX Programmer's Manual            VGRIND(1)



     fails miserably; if you plan to _v_g_r_i_n_d your program you
     should use tabs.  This is somewhat inevitable since the font
     used by _v_g_r_i_n_d is variable width.

     Should be able to be used as a preprocessor

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















































Printed 11/10/80                                                2