macref(1M)                                                       macref(1M)

NAME
     macref - produces cross-reference listing of macro files

SYNOPSIS
     macref [-t] [-s] [-n] [--] file ...

DESCRIPTION
     macref reads the named files (which are assumed to be nroff(1M) or
     troff(1M) input), and produces a cross-reference listing of the sym-
     bols in the input.

     A -t on the command line causes a macro table of contents to be
     printed. The -s option causes symbol-use statistics to be printed. The
     -n option causes one line to be printed for each reference to a sym-
     bol. The options may be grouped behind one -. You may use "--" to del-
     imit the end of options. macref does not accept - as standard input.

     The default output is a list of the symbols found in the input, each
     accompanied by a list of all references to that symbol. macref lists
     the symbols alphabetically in the leftmost column, with the references
     following to the right. Each reference is given in the form:

          [[(NMname)] Mname-] type lnum [#]

     where the fields have the following meanings:

     Mname    The name of the macro within which the reference occurs. This
              field is missing if the reference occurs outside a macro. Any
              names listed in the NMname part are macros within which Mname
              is defined.

     type     The type associated, by context, with this occurrence of the
              symbol. The types may be:

              r  request
              m  macro
              d  diversion
              s  string
              n  number register
              p  parameter (e.g. \$x is a parameter reference to x. Note
                 that parameters are never modified, and that the only
                 valid parameter symbol names are 1, 2, ... 9).

     lnum     The line number on which the reference occurred.

     #        This reference modifies the value of the symbol.

     Generated names are listed under the artificial symbol name "~sym".

SEE ALSO
     nroff(1M), troff(1M), man(5), mm(5), mv(5).




Page 1                       Reliant UNIX 5.44                Printed 11/98