manual page distributed with 4.2BSD

SCCS-vsn: old/lisp/man/lxref.1 5.1

diff --git a/usr/src/old/lisp/man/lxref.1 b/usr/src/old/lisp/man/lxref.1
index e86204b..9283535 100644 (file)
--- a/usr/src/old/lisp/man/lxref.1
+++ b/usr/src/old/lisp/man/lxref.1
@@ -2,9 +2,9 @@
 .\" All rights reserved.  The Berkeley software License Agreement
 .\" specifies the terms and conditions for redistribution.
 .\"
 .\" All rights reserved.  The Berkeley software License Agreement
 .\" specifies the terms and conditions for redistribution.
 .\"

-.\"    @(#)lxref.1     4.1 (Berkeley) %G%
+.\"    @(#)lxref.1     5.1 (Berkeley) %G%

 .\"
 .\"

-.TH LXREF 1 9/24/80
+.TH LXREF 1 "24 September 1980"

 .UC 4
 .SH NAME
 lxref \- lisp cross reference program
 .UC 4
 .SH NAME
 lxref \- lisp cross reference program


@@ -12,7 +12,10 @@ lxref \- lisp cross reference program
 .B lxref
 [
 .B \-N
 .B lxref
 [
 .B \-N

-] file ...
+] xref-file ...
+[ 
+.B \-a 
+source-file ... ]

 .SH DESCRIPTION
 .I Lxref
 reads cross reference file(s) written by the lisp compiler 
 .SH DESCRIPTION
 .I Lxref
 reads cross reference file(s) written by the lisp compiler 


@@ -20,11 +23,13 @@ reads cross reference file(s) written by the lisp compiler
 and prints a cross reference listing on the standard output.
 .I Liszt
 will create a cross reference file during compilation when it is 
 and prints a cross reference listing on the standard output.
 .I Liszt
 will create a cross reference file during compilation when it is 

-given the \-x switch.
+given the
+.B \-x
+switch.

 Cross reference files usually end in `.x' and consequently
 .I lxref
 will append a `.x' to the file names given if necessary.
 Cross reference files usually end in `.x' and consequently
 .I lxref
 will append a `.x' to the file names given if necessary.

-The one option to 
+The first option to 

 .I lxref
 is a decimal integer, N, which sets the 
 .I ignorelevel.
 .I lxref
 is a decimal integer, N, which sets the 
 .I ignorelevel.


@@ -35,6 +40,35 @@ instead of listing each one of them.
 The default for
 .I ignorelevel 
 is 50.
 The default for
 .I ignorelevel 
 is 50.

+.PP
+The 
+.B \-a
+option causes 
+.I lxref
+to put limited cross reference information in the sources named.
+.I lxref
+will scan the source and when it comes across a definition of a function
+(that is a line beginning with 
+.I "`(def'"
+it will preceed that line with a list of the functions which call this 
+function, written as a comment preceeded by 
+.I "`;.. '".
+All existing lines beginning with
+.I "`;.. '"
+will be removed from the file.
+If the source file contains a line beginning
+.I "`;.-'"
+then this will disable this annotation process from this point on until a 
+.I "`;.+'"
+is seen (however, lines beginning with 
+.I "`;.. '"
+will continue to be deleted).
+After the annoation is done, the original file
+.I "`foo.l'"
+is renamed to
+.I `#.foo.l'"
+and the new file with annotation is named 
+.I "`foo.l'"

 .SH AUTHOR
 John Foderaro
 .SH SEE ALSO
 .SH AUTHOR
 John Foderaro
 .SH SEE ALSO