X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=doc%2FREADME;h=375689d9b4b5ac3462eea41c95cef87b66eb54a8;hb=40bf78b47ea89b15698adb9c550efa4cbacafeb7;hp=7024f2fd9bd13fb8670bd2731e9caf24061ac727;hpb=a530bbe337109d898d5b4a001fc8f1afa3b5dc39;p=sbcl.git diff --git a/doc/README b/doc/README index 7024f2f..375689d 100644 --- a/doc/README +++ b/doc/README @@ -1,8 +1,25 @@ -SBCL is -- ahem! -- not particularly well documented at this point. -What can I say? Help with documentation might not be refused.:-) - -The old CMUCL documentation, in the cmucl/ subdirectory, is still -somewhat useful. The old user's manual is very useful. Most of the -CMUCL extensions to Common Lisp have gone away, but the general -information about how to use the Python compiler is still very -relevant. +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 +.