1.0.36.27: less mprotect calls in GENCGC

[sbcl.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 25150ff..1204ae8 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -19,9 +19,14 @@ INSTALLING SBCL
 
 1.1. Quick start:
 
 
 1.1. Quick start:
 

+  To run SBCL without installing it, from the top of binary distribution
+  directory:
+
+    $ sh run-sbcl.sh
+

   The following command installs SBCL and related documentation under
   The following command installs SBCL and related documentation under

-  the "/usr/local" directory:
-  
+  the "/usr/local" directory (typically run as root):
+

     # INSTALL_ROOT=/usr/local sh install.sh
 
   You can also install SBCL as a user, under your home directory:
     # INSTALL_ROOT=/usr/local sh install.sh
 
   You can also install SBCL as a user, under your home directory:

@@ -154,13 +159,27 @@ INSTALLING SBCL
                (pushnew x features))
              (disable (x)
                (setf features (remove x features))))
                (pushnew x features))
              (disable (x)
                (setf features (remove x features))))

-        ;; Threading support, available only on x86/x86-64 Linux, x86 Solaris
-        ;; and x86 Mac OS X (experimental).
+        ;; Threading support.

         (enable :sb-thread)))
 
   This is the preferred way because it lets local changes interact
   cleanly with CVS changes to the main, global source tree.
 
         (enable :sb-thread)))
 
   This is the preferred way because it lets local changes interact
   cleanly with CVS changes to the main, global source tree.
 

+  Some features of interest:
+
+    :SB-THREAD
+      Native threads. Enabled by default on x86[-64] Linux only, also
+      available on x86[-64] Max OS X, x86[-64] FreeBSD, and x86
+      Solaris.
+
+    :SB-UNICODE
+      Unicode support. Enabled by default. Disabling this feature
+      limits characters to the 8-bit ISO-8859-1 set.
+
+    :SB-XREF-FOR-INTERNALS
+      XREF data for SBCL internals. Not enabled by default, increases
+      core size by 5-6mb.
+

   A catalog of available features and their meaning can be found in
   "base-target-features.lisp-expr".
 
   A catalog of available features and their meaning can be found in
   "base-target-features.lisp-expr".
 

@@ -186,7 +205,7 @@ INSTALLING SBCL
 
     * Check that the host lisp you're building with is known to work as
       an SBCL build host, and that your operating system is supported.
 
     * Check that the host lisp you're building with is known to work as
       an SBCL build host, and that your operating system is supported.

-      
+

     * Try to do a build without loading any initialization files
       for the cross-compilation host (for example
       "sh make.sh 'sbcl --userinit /dev/null --sysinit /dev/null'").
     * Try to do a build without loading any initialization files
       for the cross-compilation host (for example
       "sh make.sh 'sbcl --userinit /dev/null --sysinit /dev/null'").

@@ -208,7 +227,7 @@ INSTALLING SBCL
   itself, it's a good idea.) Follow the "CVS Repository" link on
   <http://sourceforge.net/projects/sbcl> for instructions.
 
   itself, it's a good idea.) Follow the "CVS Repository" link on
   <http://sourceforge.net/projects/sbcl> for instructions.
 

-2.5. Supported platforms 
+2.5. Supported platforms

 
   Last updated for SBCL 0.9.3.74 (2005-08-20).
 
 
   Last updated for SBCL 0.9.3.74 (2005-08-20).
 

@@ -225,23 +244,25 @@ INSTALLING SBCL
 
     SBCL
     CMUCL
 
     SBCL
     CMUCL

-    OpenMCL
+    CCL (formerly known as OpenMCL)

     ABCL (recent versions only)
     ABCL (recent versions only)

+    CLISP (only some versions: 2.44.1 is OK, 2.47 is not)
+    XCL
+    

 
     Note that every release isn't tested with every possible host
     compiler.  You're most likely to get a clean build with SBCL itself
 
     Note that every release isn't tested with every possible host
     compiler.  You're most likely to get a clean build with SBCL itself

-    as host, otherwise OpenMCL on a PPC and CMUCL elsewhere.
+    as host, otherwise CCL on a PPC and CMUCL elsewhere.

 
   Supported operating systems and architectures:
 
 
   Supported operating systems and architectures:
 

-                           x86 PPC Alpha Sparc HPPA MIPS MIPSel x86-64
-    Linux 2.2, 2.4, 2.6     X   X    X     X    X    X     X      X
-    FreeBSD                 X
+                           x86 x86-64 PPC Sparc Alpha MIPS MIPSel
+    Linux 2.6               X     X    X    X     X     X     X
+    Darwin (Mac OS X)       X     X    X
+    Solaris                 X               X
+    FreeBSD                 X     X
+    NetBSD                  X          X

     OpenBSD 3.4, 3.5        X
     OpenBSD 3.4, 3.5        X

-    NetBSD                  X
-    Solaris                 X              X
-    Tru64                            X
-    Darwin (Mac OS X)       X   X

     Windows                 X
 
     Some operating systems are more equal than others: most of the
     Windows                 X
 
     Some operating systems are more equal than others: most of the

@@ -252,5 +273,9 @@ INSTALLING SBCL
     by e.g. testing during the monthly freeze periods, and most
     importantly by reporting any problems.
 
     by e.g. testing during the monthly freeze periods, and most
     importantly by reporting any problems.
 

-    If you need support beyond what is available on the mailing lists,
-    see "Consultants" in the "SUPPORT" file.
+    For further support, see Getting Support and Reporting Bugs
+    in the manual, or
+
+      http://www.sbcl.org/manual/Getting-Support-and-Reporting-Bugs.html
+
+    if you do not have the manual for some reason.