0.8.1.9:

[sbcl.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index be59775..5839336 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,6 +1,6 @@
 IF YOU HAVE A BINARY DISTRIBUTION:
 
 IF YOU HAVE A BINARY DISTRIBUTION:
 

-The two files that SBCL needs to run are sbcl and sbcl.core.
+The two files that SBCL needs to run, at minimum, are sbcl and sbcl.core.

 They are in 
        src/runtime/sbcl
 and
 They are in 
        src/runtime/sbcl
 and

@@ -17,7 +17,8 @@ stuff.
 In order to get a usable system, you need to run sbcl in a way that
 it can find sbcl.core. There are three ways for it to find
 sbcl.core:
 In order to get a usable system, you need to run sbcl in a way that
 it can find sbcl.core. There are three ways for it to find
 sbcl.core:

-  1. by default, in /usr/lib/sbcl.core or /usr/local/lib/sbcl.core
+
+  1. by default, in /usr/lib/sbcl/sbcl.core or /usr/local/lib/sbcl/sbcl.core

   2. by environment variable: 
      $ export SBCL_HOME=/foo/bar/
      $ sbcl
   2. by environment variable: 
      $ export SBCL_HOME=/foo/bar/
      $ sbcl

@@ -31,10 +32,21 @@ testing or other special cases.
 So: the standard installation procedure is
   1. Copy sbcl.core to /usr/lib or /usr/local/lib.
   2. Copy sbcl to /usr/bin or /usr/local/bin.
 So: the standard installation procedure is
   1. Copy sbcl.core to /usr/lib or /usr/local/lib.
   2. Copy sbcl to /usr/bin or /usr/local/bin.

-  3. Optionally copy sbcl.1 to /usr/man/man1 or /usr/local/man/man1.
-The script install.sh does these for you (choosing the /usr/local
-subdirectory) in each case.
+  3. Copy the contrib modules that you're using (if any) to the same place
+      as sbcl.core
+  4. Optionally copy sbcl.1 to /usr/man/man1 or /usr/local/man/man1.
+
+The script install.sh does all of this for you, including compilation
+of all contrib modules it can find, and installation of all those that
+pass their tests.  You should set the INSTALL_ROOT environment
+variable to /usr or /usr/local as appropriate before starting
+install.sh: e.g.
+
+   # INSTALL_ROOT=/usr/local sh install.sh
+
+or

 
 

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

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

@@ -43,6 +55,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

@@ -50,6 +63,11 @@ This software has been built successfully on these systems:
                        host lisp = SBCL itself
                os = OpenBSD 2.6, 2.7, 2.8, 2.9, and 3.0
                        host lisp = SBCL itself
                        host lisp = SBCL itself
                os = OpenBSD 2.6, 2.7, 2.8, 2.9, and 3.0
                        host lisp = SBCL itself

+       cpu = alpha
+               os = Debian GNU/Linux 2.2 with libc >= 2.1
+                       host lisp = SBCL itself
+               os = Tru64 5.1
+                       host lisp = SBCL itself

        cpu = sparc
                os = Debian GNU/Linux 2.2 with libc >= 2.2
                        host lisp = SBCL itself
        cpu = sparc
                os = Debian GNU/Linux 2.2 with libc >= 2.2
                        host lisp = SBCL itself

@@ -60,9 +78,6 @@ This software has been built successfully on these systems:
                        host lisp = OpenMCL 0.12
                        host lisp = SBCL itself
 
                        host lisp = OpenMCL 0.12
                        host lisp = SBCL itself
 

-It is known not to build under CLISP because of (as of early June 2002)
-bugs in the CLISP garbage collector.
-

 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
 appreciated.
 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
 appreciated.

@@ -106,10 +121,10 @@ To build the system binaries:
   1. Make sure that you have enough RAM+swap to build SBCL, as
      per the CAUTION note above. (As of version 0.6.0, the most
      memory-intensive operation in make.sh is the second call to
   1. Make sure that you have enough RAM+swap to build SBCL, as
      per the CAUTION note above. (As of version 0.6.0, the most
      memory-intensive operation in make.sh is the second call to

-     GENESIS, which makes the Lisp image grow to nearly 128 Mb RAM+swap.
-  2. If the GNU make command is not available under the name "gmake",
-     then define the environment variable GNUMAKE to a name where it can
-     be found.
+     GENESIS, which makes the Lisp image grow to around 128 Mb RAM+swap.
+  2. If the GNU make command is not available under the names "gmake"
+     or "make", then define the environment variable GNUMAKE to a name
+     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
   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