macref(1)                                               macref(1)



     NAME
          macref - produce cross-reference listing of macro files

     SYNOPSIS
          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.  The -s flag option causes symbol-use statistics
          to be printed.  The -n flag option causes one line to be
          printed for each reference to a symbol.  The options may be
          grouped behind one -.  You may use -- to delimit the end of
          options.  macref does not accept - as standard input.

          The default output is a list of the symbols found in the in-
          put, 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 oc-
                   curs outside a macro.  Any names listed in the
                   NMname part are macros within which Mname is de-
                   fined.

          type     the type associated, by context, with this oc-
                   currence 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 modi-
                         fied, and that the only valid parameter sym-
                         bol 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.



     April, 1990                                                     1

     macref(1)                                               macref(1)



     FILES
          /usr/bin/macref

     SEE ALSO
          nroff(1), troff(1).


















































     2                                                     April, 1990