doc/README

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