NAME

macref − produce cross-reference listing of macro files

SYNOPSIS

macref [−t] [−s] [−n] [−−] file(s)

DESCRIPTION

macref reads the named file(s), (which are assumed to be nroff(1)/troff(1) input) and produces a cross-reference listing of the symbols in the input. 

A −t on the command line causes a macro table of contents to be printed.  The option −s causes symbol- use statistics to be output.  The option −n 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 input, each accompanied by a list of all references to that symbol.  macref lists the sysmbols 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), mm(1), mv(5), mmt(1), and man(5). 

Version 2.5r1  —  December 06, 1986