ViewVC logotype

Contents of /src/general-info/net-README.txt

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.27 - (hide annotations)
Mon Jul 3 12:29:54 1995 UTC (18 years, 9 months ago) by ram
Branch: MAIN
CVS Tags: sparc-tramp-assem-base, double-double-array-base, post-merge-intl-branch, release-19b-pre1, release-19b-pre2, merged-unicode-utf16-extfmt-2009-06-11, double-double-init-sparc-2, unicode-utf16-extfmt-2009-03-27, double-double-base, snapshot-2007-09, snapshot-2007-08, snapshot-2008-08, snapshot-2008-09, ppc_gencgc_snap_2006-01-06, sse2-packed-2008-11-12, snapshot-2008-05, snapshot-2008-06, snapshot-2008-07, snapshot-2007-05, snapshot-2008-01, snapshot-2008-02, snapshot-2008-03, intl-branch-working-2010-02-19-1000, snapshot-2006-11, snapshot-2006-10, double-double-init-sparc, snapshot-2006-12, unicode-string-buffer-impl-base, sse2-base, release-20b-pre1, release-20b-pre2, unicode-string-buffer-base, sse2-packed-base, sparc-tramp-assem-2010-07-19, amd64-dd-start, snapshot-2003-10, snapshot-2004-10, release-18e-base, release-19f-pre1, snapshot-2008-12, snapshot-2008-11, intl-2-branch-base, snapshot-2004-08, snapshot-2004-09, remove_negative_zero_not_zero, snapshot-2007-01, snapshot-2007-02, snapshot-2004-05, snapshot-2004-06, snapshot-2004-07, release-19e, release-19d, GIT-CONVERSION, double-double-init-ppc, release-19c, dynamic-extent-base, unicode-utf16-sync-2008-12, LINKAGE_TABLE, release-19c-base, cross-sol-x86-merged, label-2009-03-16, release-19f-base, PRE_LINKAGE_TABLE, merge-sse2-packed, mod-arith-base, sparc_gencgc_merge, merge-with-19f, snapshot-2004-12, snapshot-2004-11, intl-branch-working-2010-02-11-1000, unicode-snapshot-2009-05, unicode-snapshot-2009-06, amd64-merge-start, ppc_gencgc_snap_2005-12-17, double-double-init-%make-sparc, unicode-utf16-sync-2008-07, release-18e-pre2, unicode-utf16-sync-2008-09, unicode-utf16-extfmts-sync-2008-12, prm-before-macosx-merge-tag, cold-pcl-base, RELEASE_20b, snapshot-2008-04, snapshot-2003-11, snapshot-2005-07, unicode-utf16-sync-label-2009-03-16, RELEASE_19f, snapshot-2007-03, release-20a-base, cross-sol-x86-base, unicode-utf16-char-support-2009-03-26, unicode-utf16-char-support-2009-03-25, release-19a-base, unicode-utf16-extfmts-pre-sync-2008-11, snapshot-2008-10, sparc_gencgc, snapshot-2007-04, snapshot-2010-12, snapshot-2010-11, unicode-utf16-sync-2008-11, snapshot-2007-07, snapshot-2011-09, snapshot-2011-06, snapshot-2011-07, snapshot-2011-04, snapshot-2007-06, snapshot-2011-02, snapshot-2011-03, snapshot-2011-01, snapshot-2003-12, release-19a-pre1, release-19a-pre3, release-19a-pre2, pre-merge-intl-branch, release-19a, UNICODE-BASE, double-double-array-checkpoint, double-double-reader-checkpoint-1, release-19d-base, release-19e-pre1, double-double-irrat-end, release-19e-pre2, snapshot-2010-05, snapshot-2010-04, snapshot-2010-07, snapshot-2010-06, snapshot-2010-01, snapshot-2010-03, snapshot-2010-02, release-19d-pre2, release-19d-pre1, snapshot-2010-08, release-18e, double-double-init-checkpoint-1, double-double-reader-base, label-2009-03-25, snapshot-2005-03, release-19b-base, cross-sol-x86-2010-12-20, double-double-init-x86, sse2-checkpoint-2008-10-01, intl-branch-2010-03-18-1300, snapshot-2005-11, double-double-sparc-checkpoint-1, snapshot-2004-04, sse2-merge-with-2008-11, sse2-merge-with-2008-10, snapshot-2005-10, RELEASE_20a, snapshot-2005-12, release-20a-pre1, snapshot-2005-01, snapshot-2009-11, snapshot-2009-12, unicode-utf16-extfmt-2009-06-11, portable-clx-import-2009-06-16, unicode-utf16-string-support, release-19c-pre1, cross-sparc-branch-base, release-19e-base, intl-branch-base, double-double-irrat-start, snapshot-2005-06, snapshot-2005-05, snapshot-2005-04, ppc_gencgc_snap_2005-05-14, snapshot-2005-02, unicode-utf16-base, portable-clx-base, snapshot-2005-09, snapshot-2005-08, lisp-executable-base, snapshot-2009-08, snapshot-2007-12, snapshot-2007-10, snapshot-2007-11, snapshot-2009-02, snapshot-2009-01, snapshot-2009-07, snapshot-2009-05, snapshot-2009-04, snapshot-2006-02, snapshot-2006-03, release-18e-pre1, snapshot-2006-01, snapshot-2006-06, snapshot-2006-07, snapshot-2006-04, snapshot-2006-05, pre-telent-clx, snapshot-2006-08, snapshot-2006-09, HEAD
Branch point for: release-19b-branch, double-double-reader-branch, double-double-array-branch, mod-arith-branch, RELEASE-19F-BRANCH, portable-clx-branch, sparc_gencgc_branch, cross-sparc-branch, RELEASE-20B-BRANCH, unicode-string-buffer-branch, sparc-tramp-assem-branch, dynamic-extent, UNICODE-BRANCH, release-19d-branch, ppc_gencgc_branch, sse2-packed-branch, lisp-executable, RELEASE-20A-BRANCH, amd64-dd-branch, double-double-branch, unicode-string-buffer-impl-branch, intl-branch, release-18e-branch, cold-pcl, unicode-utf16-branch, cross-sol-x86-branch, release-19e-branch, sse2-branch, release-19a-branch, release-19c-branch, intl-2-branch, unicode-utf16-extfmt-branch
Changes since 1.26: +4 -0 lines
File MIME type: text/plain
Lock status: Locked ram
Add note about alpha /sbin/swapdefault
1 ram 1.14 CMU Common Lisp is a public domain implementation of Common Lisp. Both
2     sources and executables are freely available via anonymous FTP; this software
3     is "as is", and has no warranty of any kind. CMU and the authors assume no
4     responsibility for the consequences of any use of this software. See
5     doc/release-notes.txt for a description of the state of the release you have.
6 ram 1.1
7 ram 1.26 The CMU Common Lisp project is no longer funded, so only minimal support is
8     being done at CMU. There is a net community of CMU Common Lisp users and
9     maintainers who communicate via comp.lang.lisp and the cmucl-bugs@cs.cmu.edu
10     mailing list.
11 ram 1.1
12 ram 1.10 See "man cmucl" (man/man1/cmucl.1) for other general information.
13 ram 1.1
14     Distribution:
16     CMU Common Lisp is only available via anonymous FTP. We don't have the
17 ram 1.15 manpower to make tapes. These are our distribution machines:
18 ram 1.24 lisp-sun1.slisp.cs.cmu.edu (
19 ram 1.5 lisp-rt1.slisp.cs.cmu.edu (
20     lisp-rt2.slisp.cs.cmu.edu (
21 ram 1.1
22 ram 1.4 Log in with the user "anonymous" and "username@host" as password (i.e. your
23 ram 1.26 EMAIL address.) When you log in, cd USING ONE SINGLE "cd" COMMAND to
24     /afs/cs/project/clisp/release. If you have any trouble with FTP access, please
25     send mail to slisp@cs.cmu.edu.
26 ram 1.1
27 ram 1.26 The most recent version is: 17f
28 ram 1.25 The old version is: 16f
30     The currently supported platforms are:
31 ram 1.26 alpha_osf1:
32     DEC Alpha workstations running OSF1.
33 ram 1.25
34     hp700_ux90:
35     HP 700 series machines (based on the HPPA architecture) running HP/UX
36     9.x.
38 ram 1.26 sgi_52:
39     MIPS-based SGI workstations running Irix 5.x.
41     sun4c_411:
42     Sun SPARC machines running the the pre-Solaris BSD SunOS system,
43     version 4.x.
45     sun4c_53:
46     Sun SPARC machines running Solaris/SunOS 5.x.
49     The release area holds gzip'ed tar files with names of the form:
50     <version>-<platform>.tar.gz
51     <version>-extra-<platform>.tar.gz
52     <version>-runtime-<platform>.tar.gz
53 ram 1.1
54 ram 1.25 -- The first file holds binaries and documentation for the standard Common
55     Lisp portion of CMU CL. This includes our version of the PCL
56     implementation of the CLOS object system.
57     -- The `-extra' file contains the Hemlock editor, the Motif toolkit,
58     the graphical debugger and the CLX interface to X11.
59     -- The `-runtime' file contins one file: lib/runtime.core, which is a
60     smaller substitute for lib/lisp.core. See the "runtime distribution"
61     section.
63 ram 1.26 The installed sizes of the configurations are approximately:
64 ram 1.25 Basic: 15 megabytes
65     Basic+Extra: 24 megabytes
66     Runtime: 5.3 megabytes
68     For installation directions, see the section "site initialization".
70 ram 1.26 FTP gzip'ed tar archives in binary mode. To extract, "cd" to the
71 ram 1.1 directory that is to be the root of the tree, then type:
72 ram 1.26 gzcat file.tar.gz | tar xf - .
73 ram 1.1
74 ram 1.26 If poor network connections make it difficult to transfer a 5 meg file, the
75 ram 1.15 release is also available split into 2 megabyte chunks, suffixed `.0', `.1',
76     etc. To extract from multiple files, use:
77 ram 1.26 cat file.tar.gz.* | gunzip | tar xf - .
78 ram 1.10
79 ram 1.6 The release area also contains source distributions and other binary
80 ram 1.10 distributions. A listing of the current contents of the release area is in
81 ram 1.23 FILES. Major release announcements will be made to comp.lang.lisp.
82 ram 1.1
84     Site initialization:
86     To run CMU CL, place bin/ in PATH and setenv CMUCLLIB to point to lib/. The
87     file lib/site-init.lisp contains site-specific initialization, such as setting
88     of the site name. Any site-specific initialization should be placed in this
89 ram 1.10 file; this file can be compiled. See bin/sample-wrapper for a shell script
90 ram 1.26 template that sets up environment variables and then runs CMU CL. CMUCLLIB now
91     defaults to /usr/local/lib/cmucl/lib.
93     You may want to have your EMACS maintainer place doc/cmu-user.info in the info
94     root, or you can setenv INFOPATH to include the doc/ directory.
95     [NOTE: the Info version of the manual has become increasingly out of date
96     because we can't find a working version of LaTexInfo.]
97 ram 1.1
98 ram 1.21 To load in CLX, the Motif interface and windowing debugger, or Hemlock and save
99     an augmented Lisp image, run lib/config. This runs `lisp' on
100     `lib/config.lisp', which uses an interactive dialog to determine what systems
101     to load and where to save the result. The default output is to overwrite
102     library:lisp.core. To avoid overwriting the running Lisp image, any existing
103     image is renamed to `lisp.core.BAK'; this file may be manually deleted to save
104     disk space.
105 ram 1.15
106 ram 1.25
107 ram 1.26 MOTIF NOTE:
109     The Motif server doesn't work on Alpha/OSF1 yet.
111     On all platforms, the Motif interface should be considered somewhat
112     experimental. The code has been compiled with type checking and debug info.
113     If Motif is loaded, the graphical inspector/debugger becomes the default, but
114     this can be disabled by:
115     (setf interface:*interface-style* :tty)
117     In order to use Motif (and the graphical debugger) with X servers from non-OSF
118     vendors (like Sun) you may need to set the environment variable XKEYSYMDB to
119     point to the file lib/XKeysymDB. The environment variable value should include
120     the file name XKeysymDB, not just the path. Otherwise, you will get many error
121     messages every time a new connection is opened to the CMU CL motifd. This file
122     is read by the X11R5 Xt in order to augment the keysym database with certain
123     OSF vendor keysyms that Motif wants to use.
124 ram 1.23
125 ram 1.25 If you get errors about being unable to start the Motif server, try:
126     -- Setting DISPLAY to the full hostname, like:
127     lisp-rt1.slisp.cs.cmu.edu:0
128     -- Killing any motifd processes that didn't die when Lisp did.
129     -- Deleting any .motif-socket-* files in /tmp.
130     -- Make sure CMUCLLIB points to the lib/ directory, and that motifd is
131     in the lib/ directory.
132 ram 1.23
133 ram 1.26
134 ram 1.23 Installation example (assuming the distribution files are in the cwd):
136     % mkdir cmucl
137     % cd cmucl
138 ram 1.26 % gzcat ../17c-sunos.tar.gz | tar xf -
139     % gzcat ../17c-extra-sunos.tar.gz | tar xf -
140 ram 1.23 % cd lib
141     % setenv CMUCLLIB `pwd`
142 ram 1.26 % setenv XKEYSYMDB `pwd`/XKeysymDB
143 ram 1.23 % cd ../bin
144     % setenv PATH $PATH":"`pwd`
146     Now you can run the basic Lisp:
147     % lisp
148     CMU Common Lisp 17c, running on lisp-sun1.slisp.cs.cmu.edu
149     Send bug reports and questions to your local CMU CL maintainer, or to
150     cmucl-bugs@cs.cmu.edu.
151     Loaded subsystems:
152     Python 1.0, target SPARCstation/Sun 4
153     CLOS based on PCL version: September 16 92 PCL (f)
154     common-lisp-user> (quit)
156     Use config to load optional subsystems:
157     % ../lib/config
158     ; Loading #p"library:config.lisp".
159     1: specify result file (currently "library:lisp.core")
160     2: toggle loading of the CLX X library, currently enabled.
161     3: toggle loading of Motif and the graphical debugger, currently enabled.
162     4: toggle loading the Hemlock editor, currently enabled.
163     5: specify some site-specific file to load.
164     6: configure according to current options.
165     7: abort the configuration process.
167     Option number: 6
169     ;; Loading #p".../lib/subsystems/clx-library.sparcf".
170     ;; Loading #p".../lib/subsystems/clm-library.sparcf".
171     ;; Loading #p".../lib/subsystems/hemlock-library.sparcf".
172     Saved ".../foo/lib/lisp.core" as ".../foo/lib/lisp.core.BAK".
173     [Doing purification: Done.]
174     [Undoing binding stack... done]
175     [Saving current lisp image into .../foo/lib/lisp.core:
176     Writing 14804416 bytes from the Read-Only space at 0x00200000.
177     Writing 3542680 bytes from the Static space at 0x0C000000.
178     Writing 1464 bytes from the Dynamic space at 0x10000000.
179     done.]
180     %
183 ram 1.25 Runtime distributions:
185 ram 1.26 The <version>-runtime-<platform>.tar.gz distribution contains a small alternate
186 ram 1.25 version of lib/lisp.core called lib/runtime.core. If you say:
187     lisp -core lib/runtime.core
189     you'll get a Lisp process into which you can load a compiled CMU CL program.
191     The runtime image does not contain PCL (CLOS), the compiler, or the full
192     Common Lisp eval. EVAL only supports function calls and the (non-lambda)
193     FUNCTION, QUOTE, PROGN, EVAL-WHEN and SETQ special forms. Macros are o.k. as
194     long as they expand into one of the supported forms.
196     Additional compactness is gained by byte-compiling some language features that
197     are primarily used for development and debugging, like the reader.
199     Probably the main use for the runtime image is to load in some large
200     application, saving the result with SAVE-LISP. This core image can then
201     replace lisp.core in distributions based on CMU CL. The SAVE-LISP
202     :INIT-FUNCTION argument can be used to replace the top-level Lisp prompt with
203     the function of your choice.
205     Note that the size of the loaded application can be substantially reduced by
206     using non-default compilation policies, like:
207     (declaim (optimize (speed 3) (safety 0) (debug 0)))
209     See the "CMU Common Lisp User's Manual" for more discussion of compilation
210     policy, byte compilation, etc.
212     You can reduce the size of your distribution somewhat more by deleting the
213     doc/ directory containing the CMU CL documentation. Really, the entire tree
214     and CMUCLLIB environment variable are unnecessary. All you need is the "lisp"
215     executable and the core file, which can be started by using the -core option,
216     like in:
217     lisp -core my.core
220 ram 1.18 SunOS/SPARC Notes:
221 ram 1.1
222 ram 1.26 With this release, there are now two Sun versions, one for SunOS 4.x and one
223     for SunOS 5.x (Solaris.)
224 ram 1.19
225 ram 1.18 At least 16 meg of memory is recommended, and more is better. Your system
226 ram 1.25 maintainer may need to configure extra paging space for large Lisp
227     applications.
228 ram 1.18
229 ram 1.1 It is not possible to mmap a file in a tmpfs filesystem. If /tmp is a "tmpfs"
230 ram 1.17 filesystem, then you must setenv CMUCL_EMPTYFILE to the pathname of some file
231     (in a normal filesystem) that can be used instead of /tmp/empty. The "df"
232     command will show tmpfs filesystems as mounted on "swap". If this problem
233     exists on your system, lisp will get an error like:
234 ram 1.11 mapin: mmap: Invalid argument
235     ensure_space: Failed to validate 67108864 bytes at 0x01000000
236 ram 1.1
237 ram 1.11
238 ram 1.25 HP/UX (HPPA) Notes:
240     CMU CL only runs with HP/UX version 9.x. Currently there are two major quirks:
241     -- Huge amounts of swap space are required, since every time a lisp process
242     forks, paging space is reserved for the entire image (~20 meg per fork.)
243     Even when one Lisp has started successfully, any subsequent RUN-PROGRAM
244     could possibly fail. Probably you need at least 75 meg for reliable
245     operation. Run /etc/swapinfo. If swapping hasn't already been enabled on
246     the unix filesystem partitions, you can increase paging space using
247     /etc/swapon or by modifying /etc/checklist. (Note that a runtime-only
248     image will require much less paging space.)
249     -- Due to a HP/UX bug, the normal "lisp" startup program has been replaced by
250     a wrapper which creates a copy on /tmp of the actual startup program (now
251     kept in lib/lisp.orig) If a lisp process terminates violently, spurious
252     copies of /tmp/lisp.copy.a* may be left around. Also, due to some weird
253     terminal I/O interaction, if you interrupt Lisp when it is running in a
254     shell script, Lisp keeps trying to read from the terminal even though the
255     shell is too. Note that the CMUCLLIB environment variable is used to
256     locate lisp.orig (the actual startup code.)
257 ram 1.26 -- load-foreign does work now, but it only recognizes one particular object
258     file format (which is not the one used by the version of gcc we have.)
259     "file foo.o" must print:
260     foo.o: PA-RISC1.1 relocatable object
263     Alpha/OSF1 and SGI/Irix notes:
264 ram 1.25
265 ram 1.27 IMPORTANT Alpha/OSF1 NOTE: CMU CL requires lazy allocation of paging space.
266     If you get "map: not enough space" errors on startup, then you (or your
267     sysadmin) need to do "rm /sbin/swapdefault" to enable lazy allocation.
269 ram 1.26 LOAD-FOREIGN has not been implemented for these platforms yet. Feel free to
270     add support to code/foreign.lisp (and let us know.)
272     Motifd seems to work on Irix, but has not been tested. Motifd does not run on
273     Alpha/OSF1. At a minimum, this would require fixing places that currently
274     use "long" to mean 32 bits.
275 ram 1.25
277 ram 1.1 Running CMU CL:
279 ram 1.15 Run "lisp". If Hemlock is loaded, you can also "lisp -edit". Hemlock will
280     use X if the DISPLAY environment variable is defined, otherwise it will use
281 ram 1.21 terminal i/o based on TERM and /etc/termcap. If the Motif debugger is loaded,
282     it will be invoked on errors and by INSPECT.
283 ram 1.1
284     Source availability:
286     Lisp and documentation sources are available via anonymous FTP ftp to any CMU
287 ram 1.15 CS machine. [See the "Distribution" section for FTP instructions.] All CMU
288 ram 1.16 written code is public domain, but CMU CL also makes use of two imported
289     packages: PCL and CLX. Although these packages are copyrighted, they may be
290     freely distributed without any licensing agreement or fee.
291 ram 1.7
292 ram 1.15 The release area contains a source distribution, which is an image of all the
293 ram 1.25 source code files used to build the current version:
294 ram 1.26 <version>-source.tar.gz (3 meg)
295 ram 1.7
296 ram 1.25 A brief overview of the source tree:
297     Totally machine-independent compiler code:
298     .../compiler/*.lisp
299     See especially node.lisp and ir1tran.lisp for the front end. vop.lisp,
300     vmdef.lisp and ir2tran.lisp for the back end.
301 ram 1.15
302 ram 1.25 Stuff that is dependent on our choice of object format, but not
303     particularly machine-dependent:
304     .../compiler/generic/*.lisp
305 ram 1.1
306 ram 1.26 Compiler back-end for the MIPS, SPARC, HPPA and Alpha
307 ram 1.25 .../compiler/mips/*.lisp
308     .../compiler/sparc/*.lisp
309     .../compiler/hppa/*.lisp
310 ram 1.26 .../compiler/alpha/*.lisp
311 ram 1.1
312 ram 1.25 Miscellaneous Lisp run-time code:
313     .../code/*.lisp
314 ram 1.1
315 ram 1.25 C run-time code:
316     .../lisp/*
317 ram 1.1
319 ram 1.25 There is also a distribution of documentation sources:
320 ram 1.26 documents.tar.gz
321 ram 1.25
322 ram 1.26 The contents of the ".../internals/" directory in the document distribution may
323     be of interest. This is a very drafty 160 page version of an internal design
324     document. Some of the "tex" files may be more humanly readable, since many
325     formatting commands need to be added. There is some inaccurate (dated)
326     material in the compiler description.
327 ram 1.1
328 ram 1.25 See ".../internals/architecture.tex (the System Architecture chapter in the
329     internals document) for more information on the source tree organization.
330 ram 1.26
332     Building from sources:
334     Recompiling CMU CL is somewhat arcane, and also requires a machine with a
335     working CMU CL and lots of memory and paging space. The minimum amount of
336     memory and paging space will depend on the platform, but 32meg of memory and
337     100 meg of paging space is probably safe. You will also need at least 100meg
338     of free disk space for source and object files.
340     The build procedure is somewhat involved. In particular, some C header files
341     are actually generated by the Lisp compilation process. See
342     internals/architecture.tex in the documents distribution for some discussion of
343     building. Also, see tools/build-and-install, a script that David Axmark
344     developed for automating the process.
346     Porting CMU CL to a new architecture requires much, much more than just
347     recompilation, since it requires writing a new compiler backend. Porting to a
348     new Unix is easy in comparison, but still not very easy, since Lisp source code
349     still needs to be modified.

  ViewVC Help
Powered by ViewVC 1.1.5