Tree [63a57e] pcl_build_1_branch / doc /
History



File Date Author Commit
.cvsignore 2002-08-14 Christophe Rhodes Christophe Rhodes [bb6182] 0.7.6.22:
FOR-CMUCL-DEVELOPERS 2000-09-18 William Harold Newman William Harold Newman [a530bb] Initial revision
README 2001-08-10 William Harold Newman William Harold Newman [8dc064] 0.pre7.8:
beyond-ansi.sgml 2003-02-07 Daniel Barlow Daniel Barlow [c5dac3] 0.7.12.25
compiler.sgml 2003-02-23 William Harold Newman William Harold Newman [24e6aa] 0.7.12.55:
efficiency.sgml 2002-05-30 Christophe Rhodes Christophe Rhodes [7f0f52] 0.7.4.8:
ffi.sgml 2002-07-29 William Harold Newman William Harold Newman [b624a6] 0.7.6.9:
intro.sgml 2002-07-07 William Harold Newman William Harold Newman [666b15] 0.7.5.6:
make-doc.sh 2002-04-03 William Harold Newman William Harold Newman [a916a6] 0.7.2.5:
sbcl-html.dsl 2003-02-23 William Harold Newman William Harold Newman [24e6aa] 0.7.12.55:
sbcl.1 2003-02-23 William Harold Newman William Harold Newman [24e6aa] 0.7.12.55:
user-manual.sgml 2002-11-07 Christophe Rhodes Christophe Rhodes [8e1eb3] 0.7.9.36:

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