macref(1)                                               macref(1)



NAME
     macref - produces a cross-reference listing of macro files

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

ARGUMENTS
     --   Delimits the end of options.

     file Specifies the macro file.

     -n   Causes one line to be printed for each reference to a
          symbol.

     -s   Causes symbol-use statistics to be printed.

     -t   Causes a macro table of contents to be printed.

DESCRIPTION
     macref 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.

     The options may be grouped behind one dash (-).  The macref
     program 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.  The macref command 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
          Specifies 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 Specifies the type associated, by context, with this
          occurrence of the symbol.  The types may be:

          r    request

          m    macro

          d    diversion




January 1992                                                    1

macref(1)                                               macref(1)



          s    string

          n    number register

          p    parameter (for example, \$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 Specifies the line number on which the reference
          occurred.

     #    Modifies the value of the symbol.

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

FILES
     /usr/bin/macref
          Executable file

SEE ALSO
     nroff(1), troff(1)
































2                                                    January 1992