xref: /csrg-svn/old/lisp/man/liszt.1 (revision 43707)
1.\" Copyright (c) 1980, 1990 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)liszt.1	6.2 (Berkeley) 06/24/90
7.\"
8.Dd
9.Dt LISZT 1
10.Os BSD 4
11.Sh NAME
12.Nm liszt
13.Nd compile a Franz Lisp program
14.Sh SYNOPSIS
15.Nm liszt
16.Op Fl mpqruwxCQST
17.Op Fl e Ar form
18.Op Fl o Ar objfile
19.Op Ar name
20.Sh DESCRIPTION
21.Nm Liszt
22takes a file whose names ends in `.l' and compiles the FRANZ
23LISP
24code there leaving an object program on the file whose name is that of the
25source with `.o' substituted for `.l'.
26.Pp
27The following options are interpreted by
28.Nm liszt .
29.Tw Fl
30.Tp Fl e
31Evaluate the given form before compilation begins.
32.Tp Fl m
33Compile a MACLISP
34file, by changing the readtable to conform to
35MACLISP
36syntax and including a macro-defined compatibility package.
37.Tp Fl o
38Put the object code in the specified file, rather than the default `.o' file.
39.Tp Fl p
40places profiling code at the beginning of each non-local function.
41If the lisp system is also created with profiling in it, this allows
42function calling frequency to be determined (see
43.Xr prof  1  . )
44.Tp Fl q
45Only print warning and error messages.
46Compilation statistics and notes on correct but unusual constructs
47will not be printed.
48.Tp Fl r
49place bootstrap code at the beginning of the object file, which when
50the object file is executed will cause a lisp system to be invoked
51and the object file fasl'ed in.
52.Tp Fl u
53Compile a UCI-lispfile, by changing the readtable to conform to
54UCI-Lisp syntax and including a macro-defined compatibility package.
55.Tp Fl w
56Suppress warning diagnostics.
57.Tp Fl x
58Create a lisp cross reference file with the same name as the source
59file but with  `.x' appended.
60The program
61.Xr lxref  1
62reads this file and creates a human readable cross
63reference listing.
64.Tp Fl C
65put comments in the assembler output of the compiler. Useful
66for debugging the compiler.
67.Tp Fl Q
68Print compilation statistics and warn of strange constructs.
69This is the default.
70.Tp Fl S
71Compile the named program and leave the assembler-language output on
72the corresponding file suffixed `.s'.
73This will also prevent the assembler language file from being assembled.
74.Tp Fl T
75send the assembler output to standard output.
76.Tp
77.Pp
78If
79no source file is specified, then the compiler will run interactively.
80You will find yourself talking to the
81.Xr lisp  1
82top-level command interpreter.
83You can compile a file by using the
84function
85.Nm liszt
86(an nlambda) with the same arguments as you use on the command line.
87For example to compile `foo', a MACLISP
88file, you would use:
89.Pp
90.Dl (liszt \-m foo)
91.Pp
92Note that
93.Nm liszt
94supplies the ``.l'' extension for you.
95.Sh FILES
96.Dw /usr/lib/lisp/machacks.l
97.Di L
98.Dp Pa /usr/lib/lisp/machacks.l
99MACLISP
100compatibility package
101.Dp Pa /usr/lib/lisp/syscall.l
102macro definitions of Unix system calls
103.Dp Pa /usr/lib/lisp/ucifnc.l
104UCI Lisp compatibility package
105.Dp
106.Sh AUTHOR
107John Foderaro
108.Sh SEE ALSO
109.Xr lisp 1 ,
110.Xr lxref 1
111.Sh ENVIRONMENT
112.Nm Liszt
113checks these
114environment variables;
115.Ev PATH ,
116.Ev SHELL
117and
118.Ev TERM .
119.Sh HISTORY
120.Nm Lisp
121appeared in 3 BSD.
122