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