Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

Tree [82e426] amd64-pthread-branch / doc /
History



File Date Author Commit
internals-notes 2004-10-28 Christophe Rhodes Christophe Rhodes [10047f] 0.8.13.77.character.46:
manual 2005-01-15 Alexey Dejneka Alexey Dejneka [2d996b] 0.8.18.33:
.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
README 2004-10-28 Christophe Rhodes Christophe Rhodes [10047f] 0.8.13.77.character.46:
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 2004-10-28 Christophe Rhodes Christophe Rhodes [10047f] 0.8.13.77.character.46:
sbcl-asdf-install.1 2003-11-26 Kevin Rosenberg Kevin Rosenberg [3c5c2c] 0.8.6.1:
sbcl.1 2004-05-29 Nikodemus Siivola Nikodemus Siivola [feae8b] 0.8.10.62:

Read Me

SBCL is -- ahem! -- not completely documented at this point. What can
I 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>.