Update of /cvsroot/sbcl/sbcl/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv1084/doc
Merge sbcl-manual-dash-fix.patch from sbcl-devel "Re: patches
from debian" by Peter Van Eynde, 2005-06-16.
RCS file: /cvsroot/sbcl/sbcl/doc/sbcl.1,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -d -r1.37 -r1.38
--- sbcl.1 1 Aug 2005 12:52:25 -0000 1.37
+++ sbcl.1 3 Aug 2005 14:24:02 -0000 1.38
@@ -78,10 +78,10 @@
SBCL also includes various non-ANSI extensions, described more fully
in the User Manual. Some of these are in the base system and others
are "contrib" modules loaded on request using REQUIRE. For example,
-to load the SB-BSD-SOCKETS module that providces TCP/IP connectivity,
+to load the SB\-BSD\-SOCKETS module that providces TCP/IP connectivity,
* (require 'asdf)
- * (require 'sb-bsd-sockets)
+ * (require 'sb\-bsd\-sockets)
Many Lispy extensions have been retained from CMU CL:
@@ -138,7 +138,7 @@
Most extensions supported by CMU CL have been unbundled from SBCL,
including Motif support, the Hemlock editor, search paths, the
low-level Unix interface, the WIRE protocol, various user-level macros
-and functions (e.g. LETF, ITERATE, MEMQ, REQUIRED-ARGUMENT), and many
+and functions (e.g. LETF, ITERATE, MEMQ, REQUIRED\-ARGUMENT), and many
SBCL inplements multithreading, but in a completely different fashion
@@ -155,7 +155,7 @@
things which are universally available in Unix scripting languages,
-e.g. RUN-PROGRAM and POSIX argv and getenv
+e.g. RUN\-PROGRAM and POSIX argv and getenv
hooks into the low level workings of the system which can be useful
@@ -163,9 +163,9 @@
whenever GC occurs, or tuning compiler diagnostic output
-unportable performance hacks, e.g. FREEZE-TYPE and PURIFY. For more
+unportable performance hacks, e.g. FREEZE\-TYPE and PURIFY. For more
information about these, look at the online documentation for symbols
-in the SB-EXT package, and look at the user manual.
+in the SB\-EXT package, and look at the user manual.
There are also a few retained extensions which don't fall into any
@@ -175,9 +175,9 @@
Some of the retained extensions have new names and/or different
options than their CMU CL counterparts. For example, the SBCL function
which saves a Lisp image to disk and kills the running process is
-called SAVE-LISP-AND-DIE instead of SAVE-LISP, and SBCL's
-SAVE-LISP-AND-DIE supports fewer keyword options than CMU CL's
+called SAVE\-LISP\-AND\-DIE instead of SAVE\-LISP, and SBCL's
+SAVE\-LISP\-AND\-DIE supports fewer keyword options than CMU CL's
(Why doesn't SBCL support more extensions natively? Why drop all
those nice extensions from CMU CL when the code already exists? This
@@ -238,10 +238,10 @@
The full, unambiguous syntax for invoking SBCL at the command line is
-.B sbcl [runtime options] --end-runtime-options [toplevel options] --end-toplevel-options [user options]
+.B sbcl [runtime options] \-\-end\-runtime\-options [toplevel options] \-\-end\-toplevel\-options [user options]
-For convenience, the --end-runtime-options and --end-toplevel-options
+For convenience, the \-\-end\-runtime\-options and \-\-end\-toplevel\-options
elements can be omitted. Omitting these elements can be convenient
when you are running the program interactively, and you can see that
no ambiguities are possible with the option values you are using.
@@ -253,99 +253,99 @@
Supported runtime options are
-.B --core <corefilename>
+.B \-\-core <corefilename>
Run the specified Lisp core file instead of the default. (See the FILES
section for the standard core, or the system documentation for
-SB-INT:SAVE-LISP-AND-DIE for information about how to create a
+SB\-INT:SAVE\-LISP\-AND\-DIE for information about how to create a
custom core.) Note that if the Lisp core file is a user-created core
file, it may run a nonstandard toplevel which does not recognize the
standard toplevel options.
Suppress the printing of any banner or other informational message at
startup. (This makes it easier to write Lisp programs which work
-cleanly in Unix pipelines. See also the "--noprint" and
+cleanly in Unix pipelines. See also the "\-\-noprint" and
Print some basic information about SBCL, then exit.
Print SBCL's version information, then exit.
In the future, runtime options may be added to control behavior such
as lazy allocation of memory.
-Runtime options, including any --end-runtime-options option,
+Runtime options, including any \-\-end\-runtime\-options option,
are stripped out of the command line before the
Lisp toplevel logic gets a chance to see it.
The toplevel options supported by the standard SBCL core are
-.B --sysinit <filename>
+.B \-\-sysinit <filename>
Load filename instead of the default system-wide initialization file.
(See the FILES section.) There is no special option to cause no
system-wide initialization file to be read, but on a Unix system
-"--sysinit /dev/null" can be used to achieve the same effect.
+"\-\-sysinit /dev/null" can be used to achieve the same effect.
-.B --userinit <filename>
+.B \-\-userinit <filename>
Load filename instead of the default user initialization file. (See
the FILES section.) There is no special option to cause no user
-initialization file to be read, but on a Unix system "--userinit
+initialization file to be read, but on a Unix system "\-\-userinit
/dev/null" can be used to achieve the same effect.
-.B --eval <command>
+.B \-\-eval <command>
After executing any initialization file, but before starting the
read-eval-print loop on standard input, read and evaluate the command
-given. More than one --eval option can be used, and all will be read
+given. More than one \-\-eval option can be used, and all will be read
and executed, in the order they appear on the command line.
-.B --load <filename>
-This is equivalent to --eval '(load "<filename>")'. The special
+.B \-\-load <filename>
+This is equivalent to \-\-eval '(load "<filename>")'. The special
syntax is intended to reduce quoting headaches when invoking SBCL
from shell scripts.
When ordinarily the toplevel "read-eval-print loop" would be executed,
execute a "read-eval loop" instead, i.e. don't print a prompt and
-don't echo results. Combined with the --noinform runtime option, this
+don't echo results. Combined with the \-\-noinform runtime option, this
makes it easier to write Lisp "scripts" which work cleanly in Unix
-This is equivalent to --eval '(sb-ext:disable-debugger)'. By default,
+This is equivalent to \-\-eval '(sb\-ext:disable\-debugger)'. By default,
a Common Lisp system tries to ask the programmer for help when it gets
in trouble (by printing a debug prompt, then listening, on
-*DEBUG-IO*). However, this is not useful behavior for a system running
+*DEBUG\-IO*). However, this is not useful behavior for a system running
with no programmer available, and this option tries to set up more
appropriate behavior for that situation. This is implemented by
-redefining INVOKE-DEBUGGER so that any call exits the process with a
+redefining INVOKE\-DEBUGGER so that any call exits the process with a
failure code after printing a backtrace. (Note that because it is
implemented by modifying special variables and FDEFINITIONs, its
-effects persist in .core files created by SB-EXT:SAVE-LISP-AND-DIE. If
+effects persist in .core files created by SB\-EXT:SAVE\-LISP\-AND\-DIE. If
you want to undo its effects, e.g. if you build a system unattended
and then want to operate a derived system interactively, see the
-Regardless of the order in which --sysinit, --userinit, and --eval
+Regardless of the order in which \-\-sysinit, \-\-userinit, and \-\-eval
options appear on the command line, the sysinit file, if it exists, is
loaded first; then the userinit file, if it exists, is loaded; then
-any --eval commands are read and executed in sequence; then the
+any \-\-eval commands are read and executed in sequence; then the
read-eval-print loop is started on standard input. At any step, error
-conditions or commands such as SB-EXT:QUIT can cause execution to be
+conditions or commands such as SB\-EXT:QUIT can cause execution to be
terminated before proceeding to subsequent steps.
-Note that when running SBCL with the --core option, using a core file
-created by a user call to the SB-EXT:SAVE-LISP-AND-DIE, the toplevel
+Note that when running SBCL with the \-\-core option, using a core file
+created by a user call to the SB\-EXT:SAVE\-LISP\-AND\-DIE, the toplevel
options may be under the control of user code passed as arguments to
-SB-EXT:SAVE-LISP-AND-DIE. For this purpose, the --end-toplevel-options
+SB\-EXT:SAVE\-LISP\-AND\-DIE. For this purpose, the \-\-end\-toplevel\-options
option itself can be considered a toplevel option, i.e. the user core,
at its option, may not support it.
In the standard SBCL startup sequence (i.e. with no user core
-involved) toplevel options and any --end-toplevel-options option are
+involved) toplevel options and any \-\-end\-toplevel\-options option are
stripped out of the command line argument list before user code gets a
chance to see it.
@@ -354,7 +354,7 @@
SBCL currently runs on X86 (Linux, FreeBSD, OpenBSD, and NetBSD), Alpha
(Linux, Tru64), PPC (Linux, Darwin/MacOS X), SPARC (Linux and Solaris
2.x), and MIPS (Linux). For information on other ongoing and possible
-ports, see the sbcl-devel mailing list, and/or the web site.
+ports, see the sbcl\-devel mailing list, and/or the web site.
SBCL requires on the order of 16Mb RAM to run on X86 systems, though
all but the smallest programs would be happier with 32Mb or more.
@@ -378,8 +378,8 @@
compiling a file containing
(DECLAIM (FTYPE (FUNCTION (T) NULL) SOMETIMES))
(DEFUN SOMETIMES (X) (ODDP X))
-(DEFUN FOO (X) (IF (SOMETIMES X) 'THIS-TIME 'NOT-THIS-TIME))
-then running (FOO 1) gives NOT-THIS-TIME, because the compiler
+(DEFUN FOO (X) (IF (SOMETIMES X) 'THIS\-TIME 'NOT\-THIS\-TIME))
+then running (FOO 1) gives NOT\-THIS\-TIME, because the compiler
relied on the truth of the DECLAIM without checking it.
Some things are implemented very inefficiently.
@@ -389,7 +389,7 @@
multidimensional arrays of floating point numbers.
-The DYNAMIC-EXTENT declaration isn't implemented at all, not even
+The DYNAMIC\-EXTENT declaration isn't implemented at all, not even
for &REST lists or upward closures, so such constructs always allocate
their temporary storage from the heap, causing GC overhead.
@@ -426,7 +426,7 @@
(DEFUN F ...)
(DECLAIM (NOTINLINE F)),
doesn't do what you'd expect. (Instead, you have to declare the
-function as SB-EXT:MAYBE-INLINE to get the desired effect.)
+function as SB\-EXT:MAYBE\-INLINE to get the desired effect.)
There are several nonconforming bits of type syntax. E.g. (1) The type
@@ -454,8 +454,8 @@
enough information to reproduce the symptoms reliably, and if you say
clearly what the symptoms are. E.g. "There seems to be something wrong
with TAN of very small negative arguments. When I execute
-(TAN LEAST-NEGATIVE-SINGLE-FLOAT) interactively on sbcl-1.2.3 on my
-Linux 4.5 X86 box, I get an UNBOUND-VARIABLE error."
+(TAN LEAST\-NEGATIVE\-SINGLE\-FLOAT) interactively on sbcl-1.2.3 on my
+Linux 4.5 X86 box, I get an UNBOUND\-VARIABLE error."
@@ -483,16 +483,16 @@
dumped memory image containing most of SBCL, to be loaded by
the 'sbcl' executable. Looked for in $SBCL_HOME,
-unless overridden by the --core option.
+unless overridden by the \-\-core option.
optional system-wide startup script, looked for in $SBCL_HOME/sbclrc
-then /etc/sbclrc, unless overridden by the --sysinit command line
+then /etc/sbclrc, unless overridden by the \-\-sysinit command line
optional per-user customizable startup script (in user's home
-directory, or as specified by --userinit)
+directory, or as specified by \-\-userinit)
@@ -517,4 +517,4 @@
for more information, including directions on how to subscribe to the
-sbcl-devel and sbcl-help mailing-lists.
+sbcl\-devel and sbcl\-help mailing-lists.
RCS file: /cvsroot/sbcl/sbcl/doc/sbcl-asdf-install.1,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- sbcl-asdf-install.1 26 Nov 2003 02:11:09 -0000 1.1
+++ sbcl-asdf-install.1 3 Aug 2005 14:24:02 -0000 1.2
@@ -1,17 +1,17 @@
-.TH SBCL-ASDF-INSTALL 1 "$Date$"
+.TH SBCL\-ASDF\-INSTALL 1 "$Date$"
-- Download and Install ASDF Systems
Each argument may be
-The name of a cliki page. asdf-install visits that page and finds
+The name of a cliki page. asdf\-install visits that page and finds
the download location from the `:(package)' tag - usually rendered
as "Download ASDF package from ..."
@@ -24,7 +24,7 @@
Downloads and installs an ASDF system or anything else that looks
-convincingly like one, including updating the ASDF:*CENTRAL-REGISTRY*
+convincingly like one, including updating the ASDF:*CENTRAL\-REGISTRY*
symlinks for all the toplevel .asd files it contains. Please read
this file before use: in particular: this is an automatic tool that
downloads and compiles stuff it finds on the 'net. Please look at the
@@ -32,7 +32,7 @@
.SH SECURITY CONCERNS: READ THIS CAREFULLY
-When you invoke asdf-install, you are asking SBCL to download,
+When you invoke asdf\-install, you are asking SBCL to download,
compile, and install software from some random site on the web. Given
that it's indirected through a page on CLiki, any malicious third party
doesn't even need to hack the distribution server to replace the
@@ -40,7 +40,7 @@
For this reason, we encourage package providers to crypto-sign their
packages (see details at the URL in the PACKAGE CREATION section) and
-users to check the signatures. asdf-install has three levels of
+users to check the signatures. asdf\-install has three levels of
automatic signature checking: "on", "off" and "unknown sites", which
can be set using the configuration variables described in
CUSTOMIZATION below. The default is "unknown sites", which will
@@ -52,7 +52,7 @@
-If the file $HOME/.asdf-install exists, it is loaded. This can be
+If the file $HOME/.asdf\-install exists, it is loaded. This can be
used to override the default values of exported special variables.
Presently these are
@@ -62,23 +62,23 @@
defaults to $http_proxy environment variable
preferred/nearest CCLAN node. See the list at
Set from $SBCL_HOME environment variable. This should already be
correct for whatever SBCL is running, if it's been installed correctly
Verify GPG signatures for the downloaded packages?
-NIL - no, T - yes, :UNKNOWN-LOCATIONS - only for URLs which aren't in CCLAN and don't begin with one of the prefixes in *SAFE-URL-PREFIXES*
+NIL - no, T - yes, :UNKNOWN\-LOCATIONS - only for URLs which aren't in CCLAN and don't begin with one of the prefixes in *SAFE\-URL\-PREFIXES*
@@ -87,28 +87,28 @@
value for format
List of locations for which GPG signature checking won't be done when
-*verify-gpg-signatures* is :unknown-locations
+*verify\-gpg\-signatures* is :unknown\-locations
.SH PACKAGE CREATION
If you want to create your own packages that can be installed using this
loader, see the "Making your package downloadable..." section at
.SH HACKERS NOTE
Listen very carefully: I will say this only as often as it appears to
-be necessary to say it. asdf-install is not a good example of how to
+be necessary to say it. asdf\-install is not a good example of how to
write a URL parser, HTTP client, or anything else, really.
Well-written extensible and robust URL parsers, HTTP clients, FTP
clients, etc would definitely be nice things to have, but it would be
nicer to have them in CCLAN where anyone can use them - after having
-downloaded them with asdf-install - than in SBCL contrib where they're
+downloaded them with asdf\-install - than in SBCL contrib where they're
restricted to SBCL users and can only be updated once a month via SBCL
developers. This is a bootstrap tool, and as such, will tend to
resist changes that make it longer or dependent on more other