xref: /original-bsd/old/lisp/man/lxref.1 (revision 403c148d)
1.\" Copyright (c) 1980, 1990 Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" %sccs.include.redist.roff%
5.\"
6.\"     @(#)lxref.1	6.3 (Berkeley) 05/06/91
7.\"
8.Dd
9.Dt LXREF 1
10.Os BSD 4
11.Sh NAME
12.Nm lxref
13.Nd lisp cross reference program
14.Sh SYNOPSIS
15.Nm lxref
16.Op Fl Ns Ar N
17.Ar xref\-file ...
18.Op Fl a Ar source\-file ...
19.Sh DESCRIPTION
20.Nm Lxref
21reads cross reference file(s) written by the lisp compiler
22.Xr liszt 1
23and prints a cross reference listing on the standard output.
24.Xr Liszt 1
25will create a cross reference file during compilation when it is
26given the
27.Fl x
28switch.
29Cross reference files usually end in
30.Pa \&.x
31and consequently
32.Nm lxref
33will append a
34.Pa \&.x
35to the file names given if necessary.
36.Pp
37Options and arguments:
38.Bl -tag -width indent
39.It Fl Ar N
40The value
41.Ar N
42(a decimal integer)
43sets the
44.Em ignorelevel .
45If a function is called more than
46.Em ignorelevel
47times, the cross reference listing will just print the number of calls
48instead of listing each one of them.
49The default for
50.Em ignorelevel
51is 50.
52.It Fl a Ar source(s)
53Put limited cross reference information in the
54.Ar source(s)
55named.
56.Nm lxref
57will scan the source and when it comes across a definition of a function
58(that is a line beginning with
59.Li "`(def'"
60it will preceed that line with a list of the functions which call this
61function, written as a comment preceeded by
62.Li "`;.. '".
63All existing lines beginning with
64.Li "`;.. '"
65will be removed from the file.
66If the source file contains a line beginning
67.Li "`;.-'"
68then this will disable this annotation process from this point on until a
69.Li "`;.+'"
70is seen (however, lines beginning with
71.Li "`;.. '"
72will continue to be deleted).
73After the annoation is done, the original file
74.Pa foo.l
75is renamed to
76.Pa #.foo.l
77and the new file with annotation is named
78.Pa foo.l
79.El
80.Sh SEE ALSO
81.Xr lisp 1 ,
82.Xr liszt 1
83.Sh HISTORY
84.Nm Lxref
85appeared in
86.Bx 4.0 .
87