mirror of
git://git.code.sf.net/p/sbcl/sbcl
synced 2026-09-10 07:26:40 -04:00
2be4173812
Some checks are pending
CL-host / ecl (push) Waiting to run
CL-host / clisp (push) Waiting to run
CL-host / ccl (push) Waiting to run
CL-host / cmucl (push) Waiting to run
CL-host / sbcl (push) Waiting to run
CL-host / compare-xc-host-fasls (ccl, false) (push) Blocked by required conditions
CL-host / compare-xc-host-fasls (clisp, false) (push) Blocked by required conditions
CL-host / compare-xc-host-fasls (cmucl, false) (push) Blocked by required conditions
CL-host / compare-xc-host-fasls (self, false) (push) Blocked by required conditions
Linux arm / build (push) Waiting to run
Linux arm64 / build () (push) Waiting to run
Linux qemu / build (ppc64le) (push) Waiting to run
Linux qemu / build (riscv64) (push) Waiting to run
Linux / build (x86, --without-sb-unicode, ) (push) Waiting to run
Linux / build (x86, --with-sb-thread, ) (push) Waiting to run
Linux / build (x86, --without-sb-thread, ) (push) Waiting to run
Linux / build (x86-64, --with-mark-region-gc --with-nonstop-foreign-call) (push) Waiting to run
Linux / build (x86-64, --with-sb-fasteval --without-sb-eval --with-nonstop-foreign-call, fasteval) (push) Waiting to run
Linux / build (x86-64, --with-sb-thread --with-nonstop-foreign-call, sse4) (push) Waiting to run
Linux / build (x86-64, --with-sb-thread, ) (push) Waiting to run
Linux / build (x86-64, --without-sb-thread, ) (push) Waiting to run
Linux / build (x86-64, --without-sb-unicode, ) (push) Waiting to run
Mac / build (arm64, --with-mark-region-gc --with-nonstop-foreign-call) (push) Waiting to run
Mac / build (arm64, --with-sb-thread --with-nonstop-foreign-call) (push) Waiting to run
Mac / build (x86-64, --with-mark-region-gc --with-nonstop-foreign-call) (push) Waiting to run
Mac / build (x86-64, --with-sb-thread --with-nonstop-foreign-call) (push) Waiting to run
Windows arm64 / build (arm64, clang-aarch64, clangarm64) (push) Waiting to run
Windows / build (x86-64, ucrt-x86_64, ucrt64) (push) Waiting to run
- make bug reporting instructions more consistent - add DOCUMENTATION file - deduplicate Texinfo @cindex lines - fix typos and URLs - update obsolete references to Texinfo - standardize the spelling of HyperSpec
24 lines
996 B
Plaintext
24 lines
996 B
Plaintext
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/, generated
|
|
from the SB-MANUAL contrib. (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>.
|