INSTALL

   1 IF YOU HAVE A BINARY DISTRIBUTION:
   2
   3 The two files that SBCL needs to run are sbcl and sbcl.core.
   4 They are in
   5         src/runtime/sbcl
   6 and
   7         output/sbcl.core
   8
   9 sbcl is a standard executable, built by compiling and linking an
  10 ordinary C program. It provides the runtime environment for the
  11 running Lisp image, but it doesn't know much about high-level Lisp
  12 stuff (like symbols and printing and objects) so it's pretty useless
  13 by itself. sbcl.core is a dump file written in a special SBCL format
  14 which only sbcl understands, and it contains all the high-level Lisp
  15 stuff.
  16
  17 In order to get a usable system, you need to run sbcl in a way that
  18 it can find sbcl.core. There are three ways for it to find
  19 sbcl.core:
  20   1. by default, in /usr/lib/sbcl.core or /usr/local/lib/sbcl.core
  21   2. by environment variable:
  22      $ export SBCL_HOME=/foo/bar/
  23      $ sbcl
  24   3. by command line option:
  25      $ sbcl --core /foo/bar/sbcl.core"
  26 The usual, recommended approach is method #1. Method #2 is useful if
  27 you're installing SBCL on a system in your user account, instead of
  28 installing SBCL on an entire system. Method #3 is mostly useful for
  29 testing or other special cases.
  30
  31 So: the standard installation procedure is
  32   1. Copy sbcl.core to /usr/lib or /usr/local/lib.
  33   2. Copy sbcl to /usr/bin or /usr/local/bin.
  34   3. Optionally copy sbcl.1 to /usr/man/man1 or /usr/local/man/man1.
  35 The script install.sh does these for you (choosing the /usr/local
  36 subdirectory) in each case.
  37
  38
  39 IF YOU HAVE A SOURCE DISTRIBUTION:
  40
  41 This software has been built successfully on these systems:
  42         cpu = x86 (Intel 386 or higher, or compatibles like the AMD K6)
  43                 os = Debian GNU/Linux 2.1 with libc >= 2.1
  44                         host lisp = CMU CL 2.4.17
  45                         host lisp = SBCL itself
  46                 os = RedHat Linux 6.2
  47                         host lisp = SBCL itself
  48                 os = FreeBSD 3.4 or 4.0
  49                         host lisp = CMU CL
  50                         host lisp = SBCL itself
  51                 os = OpenBSD 2.6, 2.7, 2.8, 2.9, and 3.0
  52                         host lisp = SBCL itself
  53         cpu = sparc
  54                 os = Debian GNU/Linux 2.2 with libc >= 2.2
  55                         host lisp = SBCL itself
  56                 os = Solaris 8
  57                         host lisp = SBCL itself
  58 It is known not to build under CLISP because of (as of early June 2002)
  59 bugs in the CLISP garbage collector, and it is known not to build under
  60 other systems like OpenMCL because of (as of early June 2002) remaining
  61 dependencies of SBCL bootstrapping on CMUCLisms like the representation
  62 of BYTE.
  63
  64 Reports of other systems that it works on (or doesn't work on, for
  65 that matter), or help in making it run on more systems, would be
  66 appreciated.
  67
  68                 CAUTION CAUTION CAUTION CAUTION CAUTION
  69             SBCL, like CMU CL, overcommits memory. That is, it
  70         asks the OS for more virtual memory address space than
  71         it actually intends to use, and the OS is expected to
  72         optimistically give it this address space even if the OS
  73         doesn't have enough RAM+swap to back it up. This works
  74         fine as long as SBCL's memory usage pattern is sparse
  75         enough that the OS can actually implement the requested
  76         VM usage. Unfortunately, if the OS runs out of RAM+swap to
  77         implement the requested VM usage, things get bad. On many
  78         systems, including the Linux 2.2.13 kernel that I used for
  79         development of SBCL up to version 0.6.0, the kernel kills
  80         processes more-or-less randomly when it runs out of
  81         resources. You may think your Linux box is very stable, but
  82         it is unlikely to be stable if this happens.:-| So be sure
  83         to have enough memory available when you build the system.
  84             (This can be considered a bug in SBCL, or a bug in the
  85         Unix overcommitment-of-memory architecture, or both. It's
  86         not clear what the best fix is. On the SBCL side, Peter Van
  87         Eynde has a lazy-allocation patch for CMU CL that lets
  88         it run without overcommitting memory, and that could be
  89         ported to SBCL, but unfortunately that might introduce
  90         new issues, e.g. alien programs allocating memory in the
  91         address space that SBCL thinks of as its own, and later
  92         getting trashed when SBCL lazily allocates the memory.
  93         On the OS side, there might be some way to address the
  94         problem with quotas, I don't know.)
  95
  96 To build the system binaries:
  97   0. If you want to be on the bleeding edge, you can update your
  98      sources to the latest development snapshot (or any previous
  99      development snapshot, for that matter) by using anonymous CVS
 100      to SourceForge. (This is not recommended if you're just using SBCL
 101      as a tool for other work, but if you're interested in working on
 102      SBCL itself, it's a good idea.) Follow the "CVS Repository" link on
 103      <http://sourceforge.net/projects/sbcl> for instructions.
 104   1. Make sure that you have enough RAM+swap to build SBCL, as
 105      per the CAUTION note above. (As of version 0.6.0, the most
 106      memory-intensive operation in make.sh is the second call to
 107      GENESIS, which makes the Lisp image grow to nearly 128 Mb RAM+swap.
 108   2. If the GNU make command is not available under the name "gmake",
 109      then define the environment variable GNUMAKE to a name where it can
 110      be found.
 111   3. If you like, you can tweak the *FEATURES* set for the resulting
 112      Lisp system, enabling or disabling features like documentation
 113      strings or extra debugging code. The preferred way to do this is
 114      by creating a file "customize-target-features.lisp", containing
 115      a lambda expression which is applied to the default *FEATURES*
 116      set and which returns the new *FEATURES* set, e.g.
 117         (LAMBDA (LIST)
 118           (ADJOIN :SB-SHOW
 119                   (REMOVE :SB-DOC
 120                           LIST)))
 121      (This is the preferred way because it lets local changes interact
 122      cleanly with CVS changes to the main, global source tree.)
 123   4. Run "sh make.sh" in the same directory where you unpacked the
 124      tarball. If you don't already have a SBCL binary installed
 125      as "sbcl" in your path, you'll need to tell make.sh what Lisp
 126      system to use as the cross-compilation host. (To use CMU CL
 127      as the cross-compilation host, run "sh make.sh 'lisp -batch'",
 128      assuming CMU CL has been installed under its default name "lisp".)
 129   5. Wait. This can be a slow process. On my test machines, the
 130      wall clock time for a build of sbcl-0.6.7 was approximately
 131        1.5 hours on a 450MHz K6/3 with 248Mb RAM, running RH Linux 6.2;
 132        4 hours on a 200MHz Pentium (P54C) with 64Mb RAM, running FreeBSD 4.0;
 133        13 hours on a 133MHz Pentium (P54C) with 48Mb RAM, running OpenBSD 2.6.
 134      Around the 48Mb mark, the build process is starved for RAM:
 135      on my 48Mb OpenBSD machine with nothing else running, it
 136      spent about 2/3 of its wall clock time swapping. Anything which
 137      substantially increases memory use, like running X11, Emacs, or,
 138      God forbid, Netscape, can increase the build time substantially.
 139
 140 Now you should have the same src/runtime/sbcl and output/sbcl.core
 141 files that come with the binary distribution, and you can install
 142 them as in the "IF YOU HAVE A BINARY DISTRIBUTION" instructions (above).
 143
 144 To convert the DocBook version of the system documentation (files
 145 ending in .sgml) to more-readable form (HTML or text):
 146   DocBook is an abstract markup system based on SGML. It's intended
 147   to be automatically translated to other formats. Tools to do this
 148   exist on the web, and are becoming increasingly easy to find as
 149   more free software projects move their documentation to DocBook.
 150   Any one of these systems should work with the SBCL documentation.
 151   If you'd like to have the documentation produced in the same
 152   format as appears in the binary distribution, and you have
 153   the jade binary and Norman Walsh's modular DSSSL stylesheets
 154   installed, you can try the doc/make-doc.sh script. Otherwise,
 155   your formatted copy of the SBCL documentation should have the
 156   same content as in the binary distribution, but details of
 157   presentation will probably vary.