


      MACREF(1)                     (DWB)                     MACREF(1)



      NAME
           macref - produce cross-reference listing of macro files

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

      DESCRIPTION
           The macref program reads the named files (which are assumed
           to be nroff(1)/troff(1) input) and produces a cross-
           reference listing of the symbols in the input.

           A -t in the command line causes a macro table of contents to
           be printed.  A -s causes symbol use statistics to be output.

           The default output is a list of the symbols found in the
           input, each accompanied by a list of all references to that
           symbol.  (This output may be defeated by using a -n in the
           command line).  The symbols are listed 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 at the text level.  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(1), troff(1).



      Page 1                                          (73 A2 02MT REV1)






      MACREF(1)                     (DWB)                     MACREF(1)























































      Page 2                                          (73 A2 02MT REV1)






