X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=doc%2FREADME;h=bf901a4af709bdf1507349530a21cce96a87a9a3;hb=b1b43e74be3d133bd1edf7d17adb607f8290331f;hp=bfb2f08f8eff9421a7806ec7b40964f69a97e724;hpb=d3ad760954643743cf83f06283ef5afcc1ed388b;p=sbcl.git diff --git a/doc/README b/doc/README index bfb2f08..bf901a4 100644 --- a/doc/README +++ b/doc/README @@ -1,12 +1,23 @@ -SBCL is -- ahem! -- not completely documented at this point. -What can I say? Help with documentation might not be refused.:-) - -There is a user manual in DocBook format, in user-manual.sgml. -It's based on the CMU CL user manual, and some of its chapters -aren't done, 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's available from SourceForge -by anonymous ftp. +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 +.