0.8.9.7:

[sbcl.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 464a644..28da68d 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,6 +5,9 @@ They are in
        src/runtime/sbcl
 and
        output/sbcl.core
        src/runtime/sbcl
 and
        output/sbcl.core

+In addition, there are a number of modules that extend the basic sbcl
+functionality, in
+        contrib/

 
 sbcl is a standard executable, built by compiling and linking an
 ordinary C program. It provides the runtime environment for the
 
 sbcl is a standard executable, built by compiling and linking an
 ordinary C program. It provides the runtime environment for the

@@ -19,15 +22,17 @@ it can find sbcl.core. There are three ways for it to find
 sbcl.core:
 
   1. by default, in /usr/lib/sbcl/sbcl.core or /usr/local/lib/sbcl/sbcl.core
 sbcl.core:
 
   1. by default, in /usr/lib/sbcl/sbcl.core or /usr/local/lib/sbcl/sbcl.core

+     (depending on the SBCL_HOME C preproccessor #define at compile-time)

   2. by environment variable: 
   2. by environment variable: 

-     $ export SBCL_HOME=/foo/bar/
+     $ export SBCL_HOME=/foo/bar/lib/sbcl

      $ sbcl
   3. by command line option:
      $ sbcl --core /foo/bar/sbcl.core"
      $ sbcl
   3. by command line option:
      $ sbcl --core /foo/bar/sbcl.core"

-The usual, recommended approach is method #1. Method #2 is useful if
-you're installing SBCL on a system in your user account, instead of
-installing SBCL on an entire system. Method #3 is mostly useful for
-testing or other special cases.
+
+The usual, recommended approach is method #1.  Method #2 is useful if
+you're installing SBCL on a system in a non-standard location (e.g. in
+your user account), instead of installing SBCL on an entire system.
+Method #3 is mostly useful for testing or other special cases.

 
 So: the standard installation procedure is
   1. Copy sbcl.core to /usr/lib or /usr/local/lib.
 
 So: the standard installation procedure is
   1. Copy sbcl.core to /usr/lib or /usr/local/lib.

@@ -43,10 +48,10 @@ variable to /usr or /usr/local as appropriate before starting
 install.sh: e.g.
 
    # INSTALL_ROOT=/usr/local sh install.sh
 install.sh: e.g.
 
    # INSTALL_ROOT=/usr/local sh install.sh

-

 or
 or

-

    $ INSTALL_ROOT=/home/me/sbcl sh install.sh
    $ INSTALL_ROOT=/home/me/sbcl sh install.sh

+(if your INSTALL_ROOT is XYZ, SBCL_HOME should be set to
+XYZ/lib/sbcl).

 
 IF YOU HAVE A SOURCE DISTRIBUTION:
 
 
 IF YOU HAVE A SOURCE DISTRIBUTION:
 

@@ -55,6 +60,7 @@ This software has been built successfully on these systems:
                os = Debian GNU/Linux 2.1 with libc >= 2.1
                        host lisp = CMU CL 2.4.17
                        host lisp = SBCL itself
                os = Debian GNU/Linux 2.1 with libc >= 2.1
                        host lisp = CMU CL 2.4.17
                        host lisp = SBCL itself

+                       host lisp = CLISP CVS as of end of April

                os = RedHat Linux 6.2
                        host lisp = SBCL itself
                os = FreeBSD 3.4 or 4.0
                os = RedHat Linux 6.2
                        host lisp = SBCL itself
                os = FreeBSD 3.4 or 4.0

@@ -76,9 +82,12 @@ This software has been built successfully on these systems:
                os = Debian GNU/Linux 2.2 with libc >= 2.1
                        host lisp = OpenMCL 0.12
                        host lisp = SBCL itself
                os = Debian GNU/Linux 2.2 with libc >= 2.1
                        host lisp = OpenMCL 0.12
                        host lisp = SBCL itself

-
-It is known not to build under CLISP (as of early June 2002) because
-of bugs in the CLISP garbage collector.
+               os = MacOS X.2
+                       host lisp = OpenMCL 0.13.6
+                       host lisp = SBCL itself
+       cpu = mips and mipsel
+               os = Debian GNU/Linux 3.0
+                       host lisp = SBCL itself

 
 Reports of other systems that it works on (or doesn't work on, for
 that matter), or help in making it run on more systems, would be
 
 Reports of other systems that it works on (or doesn't work on, for
 that matter), or help in making it run on more systems, would be

@@ -129,10 +138,12 @@ To build the system binaries:
      where it can be found.
   3. If you like, you can tweak the *FEATURES* set for the resulting
      Lisp system, enabling or disabling features like documentation
      where it can be found.
   3. If you like, you can tweak the *FEATURES* set for the resulting
      Lisp system, enabling or disabling features like documentation

-     strings or extra debugging code. The preferred way to do this is
-     by creating a file "customize-target-features.lisp", containing
-     a lambda expression which is applied to the default *FEATURES*
-     set and which returns the new *FEATURES* set, e.g.
+     strings, threads, or extra debugging code (see
+     "base-target-features.lisp-expr" for a list of recognized
+     *FEATURES*).  The preferred way to do this is by creating a file
+     "customize-target-features.lisp", containing a lambda expression
+     which is applied to the default *FEATURES* set and which returns
+     the new *FEATURES* set, e.g.

        (LAMBDA (LIST)
          (ADJOIN :SB-SHOW
                  (REMOVE :SB-DOC
        (LAMBDA (LIST)
          (ADJOIN :SB-SHOW
                  (REMOVE :SB-DOC