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

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

NAME
     vgrind - grind nice listings of programs

SYNOPSIS
     vgrind [-f] [-] [-t] [-n] [-x] [-W] [-sn] [-h header] [-d
     <description file>] [-l<language>] name ...

DESCRIPTION
     _V_g_r_i_n_d formats the program sources which are arguments in a
     nice style using _t_r_o_f_f(_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.

     _V_g_r_i_n_d runs in two basic modes, filter mode or regular mode.
     In filter mode _v_g_r_i_n_d acts as a filter in a manner similar
     to _t_b_l(_1).  The standard input is passed directly to the
     standard output except 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 filter can be passed to _t_r_o_f_f for output.  There
     need be no particular ordering with _e_q_n(_1) or _t_b_l(_1).

     In regular mode _v_g_r_i_n_d accepts input files, processes them,
     and passes them to _t_r_o_f_f(_1) for output.

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

     The options are:

     -f   forces filter mode

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

     -t   similar to the same option in _t_r_o_f_f causing formatted
          text to go to the standard output

     -n   forces no keyword bolding

     -x   processes an index file.  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
          automatically be kept up to date.  The index of func-
          tion definitions can then be run off by giving _v_g_r_i_n_d
          the -x option and the file _i_n_d_e_x as argument.

Printed 8/5/83                                                  1

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

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

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

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

     -d   specifies the language definitions file (default is
          /usr/lib/vgrindefs)

     -l   specifies the language to use.  Currently known are
          PASCAL (-lp), MODEL (-lm), C (-lc or the default), and
          ISP (-li).

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

AUTHOR
     Dave Presotto & William Joy

SEE ALSO
     vtroff(1) vgrindefs(5)

BUGS
     The basic format of a procedure must be:

          <string matching the start of a procedure>
          <block begin> <block end>

     This works all right in most cases.  However, in PASCAL
     vgrind can't distinguish between a procedure start and a
     procedure variable.  Therefore vgrind requires a slight
     modification of the procedure and function variable declara-
     tions.  Putting a comment in the declaration between the
     keyword and the name (e.g. function {} junk) should be suf-
     ficient.  Sorry if this looks strange.

Printed 8/5/83                                                  2