doc/README

   1 SBCL is -- ahem! -- imperfectly documented. What can we say? Help with
   2 documentation might not be refused.:-)
   3
   4 There is a Unix man page, sbcl.1.
   5
   6 There is a user manual in texinfo format, in doc/manual/. (In
   7 binary distributions, the compiled-into-HTML translations are also
   8 included.)
   9
  10 Much of the documentation for supported extensions is in their Lisp
  11 doc strings. For example, to find out how to use the SAVE-LISP-AND-DIE
  12 function in the SB-EXT package, you can execute
  13   (documentation 'sb-ext:save-lisp-and-die 'function)
  14 or
  15   (describe 'sb-ext:save-lisp-and-die)
  16 in SBCL.
  17
  18 The user manual is incomplete, and some of its chapters are just notes
  19 that "this is similar to chapter such-and-such of the CMU CL user
  20 manual". The old CMU CL documentation can still be useful both for
  21 missing chapters of the user manual and for documentation of the
  22 internals of the system. It can be downloaded from
  23 <ftp://sbcl.sourceforge.net/pub/sbcl/cmucl-docs.tar.bz2>.