1.0.23.29: Specify the required double-stack alignment for MIPS.
[sbcl/tcr.git] / README
blob09984f36055b86a5e93876dc893eb7b17c3d4d14
1 GENERAL INFORMATION
3 Welcome to SBCL.
5 If you'd like to install or build the system, see the "INSTALL" file.
7 To find out more about who created the system, see the "CREDITS" file.
9 If you'd like information about the legalities of copying the system,
10 see the "COPYING" file.
12 If you'd like more information about using the system, see the man
13 page, "sbcl.1", or the user manual in the "doc/manual" subdirectory of
14 the distribution. (The user manual is maintained as Texinfo in the
15 source distribution; HTML version is available for download, and
16 "INSTALL" describes how to build the Texinfo version in HTML and PDF.)
18 The system is a work in progress. See the "TODO" file in the source
19 distribution for some highlights.
21 The "BUGS" file lists current known bugs.
23 If you'd like to make suggestions, report a bug, or help to improve the
24 system, please send mail to one of the mailing lists:
25   sbcl-help@lists.sourceforge.net
26   sbcl-devel@lists.sourceforge.net
27 Note that as a spam reduction measure you must subscribe to the lists
28 before you can post.
31 SYSTEM-SPECIFIC HINTS
33 for NetBSD:
34   NetBSD 2.0 and above are required because of the lack of needed
35   signal APIs in NetBSD 1.6 and earlier.
37 for OpenBSD:
38   OpenBSD 3.0 has stricter ulimit values, and/or enforces them more
39   strictly, than its predecessors. Therefore SBCL's initial mmap()
40   won't work unless you increase the limit on the data segment from
41   the OpenBSD defaults, e.g. with
42     ulimit -S -d 1000000
43   before you run SBCL. Otherwise SBCL fails with a message like
44   "ensure_space: failed to validate xxxxxxx bytes at yyyyy". (SBCL
45   is just allocating this huge address space, not actually using this
46   huge memory at this point. OpenBSD <3.0 had no problem with this,
47   but OpenBSD 3.0 is less hospitable.)