143721Scael.\" Copyright (c) 1980, 1990 Regents of the University of California. 2*49207Scael.\" All rights reserved. 319197Smckusick.\" 4*49207Scael.\" %sccs.include.redist.roff% 519197Smckusick.\" 6*49207Scael.\" @(#)lxref.1 6.3 (Berkeley) 05/06/91 7*49207Scael.\" 8*49207Scael.Dd 9*49207Scael.Dt LXREF 1 10*49207Scael.Os BSD 4 11*49207Scael.Sh NAME 12*49207Scael.Nm lxref 13*49207Scael.Nd lisp cross reference program 14*49207Scael.Sh SYNOPSIS 15*49207Scael.Nm lxref 16*49207Scael.Op Fl Ns Ar N 17*49207Scael.Ar xref\-file ... 18*49207Scael.Op Fl a Ar source\-file ... 19*49207Scael.Sh DESCRIPTION 20*49207Scael.Nm Lxref 21*49207Scaelreads cross reference file(s) written by the lisp compiler 22*49207Scael.Xr liszt 1 2319197Smckusickand prints a cross reference listing on the standard output. 24*49207Scael.Xr Liszt 1 25*49207Scaelwill create a cross reference file during compilation when it is 2619198Smckusickgiven the 27*49207Scael.Fl x 2819198Smckusickswitch. 29*49207ScaelCross reference files usually end in 30*49207Scael.Pa \&.x 31*49207Scaeland consequently 32*49207Scael.Nm lxref 33*49207Scaelwill append a 34*49207Scael.Pa \&.x 35*49207Scaelto the file names given if necessary. 36*49207Scael.Pp 37*49207ScaelOptions and arguments: 38*49207Scael.Bl -tag -width indent 39*49207Scael.It Fl Ar N 40*49207ScaelThe value 41*49207Scael.Ar N 42*49207Scael(a decimal integer) 43*49207Scaelsets the 44*49207Scael.Em ignorelevel . 45*49207ScaelIf a function is called more than 46*49207Scael.Em ignorelevel 47*49207Scaeltimes, the cross reference listing will just print the number of calls 4819197Smckusickinstead of listing each one of them. 4919197SmckusickThe default for 50*49207Scael.Em ignorelevel 5119197Smckusickis 50. 52*49207Scael.It Fl a Ar source(s) 53*49207ScaelPut limited cross reference information in the 54*49207Scael.Ar source(s) 55*49207Scaelnamed. 56*49207Scael.Nm lxref 5719198Smckusickwill scan the source and when it comes across a definition of a function 58*49207Scael(that is a line beginning with 59*49207Scael.Li "`(def'" 60*49207Scaelit will preceed that line with a list of the functions which call this 61*49207Scaelfunction, written as a comment preceeded by 62*49207Scael.Li "`;.. '". 6319198SmckusickAll existing lines beginning with 64*49207Scael.Li "`;.. '" 6519198Smckusickwill be removed from the file. 6619198SmckusickIf the source file contains a line beginning 67*49207Scael.Li "`;.-'" 68*49207Scaelthen this will disable this annotation process from this point on until a 69*49207Scael.Li "`;.+'" 70*49207Scaelis seen (however, lines beginning with 71*49207Scael.Li "`;.. '" 7219198Smckusickwill continue to be deleted). 7319198SmckusickAfter the annoation is done, the original file 74*49207Scael.Pa foo.l 7519198Smckusickis renamed to 76*49207Scael.Pa #.foo.l 77*49207Scaeland the new file with annotation is named 78*49207Scael.Pa foo.l 79*49207Scael.El 80*49207Scael.Sh SEE ALSO 81*49207Scael.Xr lisp 1 , 82*49207Scael.Xr liszt 1 83*49207Scael.Sh HISTORY 84*49207Scael.Nm Lxref 85*49207Scaelappeared in 86*49207Scael.Bx 4.0 . 87