4.4BSD/usr/share/man/cat1/vgrind.0

VGRIND(1)                    BSD Reference Manual                    VGRIND(1)

NNAAMMEE
     vvggrriinndd - grind nice listings of programs

SSYYNNOOPPSSIISS
     vvggrriinndd [--] [--WW] [--dd _f_i_l_e] [--ff] [--hh _h_e_a_d_e_r] [--ll _l_a_n_g_u_a_g_e] [--nn] [--ssnn] [--tt]
            [--xx] _n_a_m_e _._._.

DDEESSCCRRIIPPTTIIOONN
     VVggrriinndd formats the program sources 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.

     VVggrriinndd runs in two basic modes, filter mode (see the --ff option) or regu-
     lar mode.  In filter mode vvggrriinndd acts as a filter in a manner similar to
     tbl(1).  The standard input is passed directly to the standard output ex-
     cept for lines bracketed by the _t_r_o_f_f_-_l_i_k_e macros:

     .vS     starts processing

     .vE     ends processing

     These lines are formatted as described above.  The output from this fil-
     ter can be passed to troff for output.  There need be no particular or-
     dering with eqn(1) or tbl(1).

     In regular mode vvggrriinndd accepts input files, processes them, and passes
     them to troff(1) for output.

     In both modes vvggrriinndd passes any lines beginning with a decimal point
     without conversion.

     The options are:

     --             forces input to be taken from standard input (default if --ff
                   is specified )

     --WW            forces output to the (wide) Versatec printer rather than
                   the (narrow) Varian

     --dd _f_i_l_e       specifies an alternate language definitions file (default
                   is _/_u_s_r_/_s_h_a_r_e_/_m_i_s_c_/_v_g_r_i_n_d_e_f_s)

     --ff            forces filter mode

     --hh _h_e_a_d_e_r     specifies a particular header to put on every output page
                   (default is the file name)

     --ll            specifies the language to use.  Currently known are PASCAL
                   (--ll_p), MODEL (--ll_m), C (--ll_c or the default), CSH (--ll_c_s_h),
                   SHELL (--ll_s_h), RATFOR (--ll_r), MODULA2 (--ll_m_o_d_2), YACC
                   (--ll_y_a_c_c), LISP (--ll_i_s_p), and ICON (--ll_I).

     --nn            forces no keyword bolding

     --ss            specifies a point size to use on output (exactly the same
                   as the argument of a .ps)

     --tt            similar to the same option in troff causing formatted text
                   to go to the standard output

     --xx            outputs the index file in a ``pretty'' format.  The index
                   file itself is produced whenever vvggrriinndd is run with a file
                   called _i_n_d_e_x in the current directory.  The index of func-
                   tion definitions can then be run off by giving vvggrriinndd the
                   --xx option and the file _i_n_d_e_x as argument.

FFIILLEESS
     index                        file where source for index is created
     /usr/share/tmac/tmac.vgrind  macro package
     /usr/libexec/vfontedpr       preprocessor
     /usr/share/misc/vgrindefs    language descriptions

SSEEEE AALLSSOO
     getcap(3),  vgrindefs(5)

BBUUGGSS
     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 key-
     words _f_u_n_c_t_i_o_n or _p_r_o_c_e_d_u_r_e.

     For MODEL - function names need to appear on the same line as the key-
     words _i_s _b_e_g_i_n_p_r_o_c.

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

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

     Filter mode does not work in documents using the --mmee or --mmss macros.  (So
     what use is it anyway?)

HHIISSTTOORRYY
     The vvggrriinndd command appeared in 3.0BSD.

4th Berkeley Distribution        June 6, 1993                                2