Tree [eb10fa] sbcl_1_0_16 / doc /
History



File Date Author Commit
internals 2007-09-09 Christophe Rhodes Christophe Rhodes [fab074] 1.0.9.48: texi2pdf rework (Aymeric Vincent sbcl...
internals-notes 2008-03-13 Nikodemus Siivola Nikodemus Siivola [66b919] 1.0.15.30: thread-safe FIND-CLASS
manual 2008-01-10 William Harold Newman William Harold Newman [7ea27d] 1.0.13.22: text tweaks
.cvsignore 2003-11-26 William Harold Newman William Harold Newman [d1b347] 0.8.6.2:
FOR-CMUCL-DEVELOPERS 2000-09-18 William Harold Newman William Harold Newman [a530bb] Initial revision
GIT-FOR-SBCL-HACKERS.txt 2007-08-20 Rudi Schlatte Rudi Schlatte [0455d5] 1.0.8.41: doc spelling fixes.
PACKAGING-SBCL.txt 2007-07-16 Nikodemus Siivola Nikodemus Siivola [09526a] 1.0.7.20: note for SBCL packagers
README 2008-01-10 William Harold Newman William Harold Newman [7ea27d] 1.0.13.22: text tweaks
clean.sh 2004-10-28 Christophe Rhodes Christophe Rhodes [10047f] 0.8.13.77.character.46:
entities.inc 2003-11-26 Kevin Rosenberg Kevin Rosenberg [3c5c2c] 0.8.6.1:
make-doc.sh 2007-04-19 NIIMI Satoshi NIIMI Satoshi [a3cecc] 1.0.4.107: fix doc/make-doc.sh if "make" comman...
sbcl-asdf-install.1 2005-08-03 Juho Snellman Juho Snellman [58d2fc] 0.9.3.23:
sbcl.1 2008-03-13 Nikodemus Siivola Nikodemus Siivola [06a908] 1.0.15.23: typos and grammar

Read Me

SBCL is -- ahem! -- imperfectly documented. What can we say? Help with
documentation might not be refused.:-)

There is a Unix man page, sbcl.1.

There is a user manual in texinfo format, in doc/manual/. (In
binary distributions, the compiled-into-HTML translations are also
included.) 

Much of the documentation for supported extensions is in their Lisp
doc strings. For example, to find out how to use the SAVE-LISP-AND-DIE
function in the SB-EXT package, you can execute
  (documentation 'sb-ext:save-lisp-and-die 'function)
or
  (describe 'sb-ext:save-lisp-and-die)
in SBCL.

The user manual is incomplete, and some of its chapters are just notes
that "this is similar to chapter such-and-such of the CMU CL user
manual". The old CMU CL documentation can still be useful both for
missing chapters of the user manual and for documentation of the
internals of the system. It can be downloaded from
<ftp://sbcl.sourceforge.net/pub/sbcl/cmucl-docs.tar.bz2>.