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 [bf5a81] sbcl_0_8_12 / doc /
History



File Date Author Commit
catalogs 2004-04-22 Kevin Rosenberg Kevin Rosenberg [742475] 0.8.9.56:
internals-notes 2004-03-08 Christophe Rhodes Christophe Rhodes [0728e7] 0.8.8.19:
manual 2004-06-21 Christophe Rhodes Christophe Rhodes [554397] 0.8.11.20:
.cvsignore 2003-11-26 William Harold Newman William Harold Newman [d1b347] 0.8.6.2:
DOCDOC 2004-02-24 William Harold Newman William Harold Newman [464f56] 0.8.8:
FOR-CMUCL-DEVELOPERS 2000-09-18 William Harold Newman William Harold Newman [a530bb] Initial revision
Makefile 2004-03-24 William Harold Newman William Harold Newman [74c81a] 0.8.9.1:
README 2001-08-10 William Harold Newman William Harold Newman [8dc064] 0.pre7.8:
beyond-ansi.xml 2004-01-01 Daniel Barlow Daniel Barlow [582503] 0.8.7.3
clean.sh 2004-05-09 William Harold Newman William Harold Newman [bfdb13] 0.8.10.16:
compiler.xml 2003-12-02 Kevin Rosenberg Kevin Rosenberg [765d10] 0.8.6.24:
efficiency.xml 2003-12-02 Kevin Rosenberg Kevin Rosenberg [765d10] 0.8.6.24:
entities.inc 2003-11-26 Kevin Rosenberg Kevin Rosenberg [3c5c2c] 0.8.6.1:
ffi.xml 2003-12-12 William Harold Newman William Harold Newman [4f07ad] 0.8.6.36:
fo.xsl 2003-11-26 Kevin Rosenberg Kevin Rosenberg [3c5c2c] 0.8.6.1:
html.xsl 2003-11-26 Kevin Rosenberg Kevin Rosenberg [3c5c2c] 0.8.6.1:
html_chunk.xsl 2003-12-08 Kevin Rosenberg Kevin Rosenberg [d5fb3f] 0.8.6.33:
intro.xml 2003-12-02 Kevin Rosenberg Kevin Rosenberg [765d10] 0.8.6.24:
make-doc.sh 2003-11-26 William Harold Newman William Harold Newman [d1b347] 0.8.6.2:
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:
user-manual.xml 2003-12-02 Kevin Rosenberg Kevin Rosenberg [765d10] 0.8.6.24:

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 DocBook format, in user-manual.sgml. (In
binary distributions, the compiled-into-HTML translations are also
included.) Several free software packages are available to compile
DocBook into HTML or other formats. The commands to use 'jade' to
translate the manual into HTML are in make-doc.sh.

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>.