VGRIND(1)                            BSD                             VGRIND(1)



NAME
     vgrind - grind nice listings of programs

SYNOPSIS
     vgrind [ -f ] [ - ] [ -t ] [ -n ] [ -x ] [ -W ] [ -sn ] [ -h header ] [
     -d file ] [ -llanguage ] name ...

DESCRIPTION
     vgrind formats the program sources (specified as arguments) using either
     troff(1) or any troff source formatter.  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.

     vgrind runs in two basic modes, filter mode or regular mode.  In filter
     mode vgrind acts as a filter in a manner similar to tbl(1).  The standard
     input is passed directly to the standard output except for lines
     bracketed by the following troff-like macros:

     .vS  Starts processing

     .vE  Ends processing

     These lines are formatted as described above.  The output from this
     filter can then be passed to a troff formatter for processing.  There
     need be no particular ordering with eqn(1) or tbl(1).

     In regular mode vgrind accepts input files, processes them, and passes
     them to a troff formatter for output.

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

   Specifying An Output Processor

     vgrind allows the specification of an alternate troff source formatter
     through the assignment of the TROFF environment variable.  To specify a
     formatter other than troff(1), set the variable TROFF to the value of the
     command desired.  If the TROFF variable is not set, troff(1), is used.

OPTIONS
     -f   Forces filter mode

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

     -t   Causes formatted text to go to the standard output (similar to the
          same option in troff)

     -n   Forces no keyword bolding

     -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 (BSD troff doesn't support the Versatec).

     -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 (the
          default is the filename)

     -d   Specifies an alternate language definitions file (the default is
          /usr/lib/vgrindefs)

     -l   Specifies the language to use.  Currently known are PASCAL (-lp),
          MODEL (-lm),C (-lc or the default), CSH (-lcsh), SHELL (-lsh),
          RATFOR (-lr), MODULA2 (-lmod2), YACC (-lyacc), ISP (-lisp), and ICON
          (-lI).

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

BUGS
     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
     keywords function or procedure.

     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.

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

     The filter mode does not work in documents using the -me or -ms macros.

SEE ALSO
     vgrindefs(5)