X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=doc%2Fsbcl.1;h=9211aac8d0ffc679217564e5742a7a25f6ed0cbe;hb=4d8378af498b544256340e09919758e1f88029ac;hp=908f9a197672de614f0ee3f675d232529506c903;hpb=19e8b826506c42de9430ca9df0bc1439467e9f24;p=sbcl.git diff --git a/doc/sbcl.1 b/doc/sbcl.1 index 908f9a1..9211aac 100644 --- a/doc/sbcl.1 +++ b/doc/sbcl.1 @@ -72,7 +72,7 @@ SBCL compiles Common Lisp to native code. (Even today, some 30 years after the MacLisp compiler, people will tell you that Lisp is an interpreted language. Ignore them.) -SBCL aims for but has not yet reached compliance with the ANSI +SBCL aims for but has not completely achieved compliance with the ANSI standard for Common Lisp. More information about this is available in the BUGS section below. @@ -186,30 +186,30 @@ likely to be a priority.) .SH THE COMPILER -SBCL is essentially a compiler-only implementation of Lisp. All +SBCL is essentially a compiler-only implementation of Common Lisp. All nontrivial Lisp code is compiled to native machine code before being executed, even when the Lisp code is typed interactively at the "interpreter" prompt. SBCL inherits from CMU CL the "Python" native code compiler. (Though -we've essentially dropped that name in order to avoid confusion with -the scripting language also called Python.) This compiler is very -clever about understanding the type system of Common Lisp and using it -to optimize code, and about producing notes to let the user know when -the compiler doesn't have enough type information to produce efficient +we often avoid that name in order to avoid confusion with the +scripting language also called Python.) This compiler is very clever +about understanding the type system of Common Lisp and using it to +optimize code, and about producing notes to let the user know when the +compiler doesn't have enough type information to produce efficient code. It also tries (almost always successfully) to follow the unusual but very useful principle that "declarations are assertions", i.e. type declarations should be checked at runtime unless the user explicitly tells the system that speed is more important than safety. -The CMU CL version of this compiler reportedly produces pretty good -code for modern CPU architectures which have lots of registers, but -its code for the X86 is marred by a lot of extra loads and stores to -stack-based temporary variables. Because of this, and because of the -extra levels of indirection in Common Lisp relative to C, the -performance of SBCL isn't going to impress people who are impressed by -small constant factors. However, even on the X86 it tends to be faster -than byte interpreted languages (and can be a lot faster). +The compiler reportedly produces pretty good code for modern CPU +architectures which have lots of registers, but its code for the X86 +is marred by many extra loads and stores to stack-based temporary +variables. Because of this, and because of the extra levels of +indirection in Common Lisp relative to C, the performance of SBCL +isn't going to impress people who are impressed by small constant +factors. However, even on the X86 it tends to be faster than byte +interpreted languages (and can be a lot faster). The compiled code uses garbage collection to automatically manage memory. The garbage collector implementation varies considerably @@ -267,15 +267,23 @@ Supported runtime options are .TP 3 .B --core Run the specified Lisp core file instead of the default. (See the FILES -section.) 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. +section for the standard core, or the system documentation for +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. .TP 3 .B --noinform 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 "--disable-debugger" options.) +.TP 3 +.B --help +Print some basic information about SBCL, then exit. +.TP 3 +.B --version +Print SBCL's version information, then exit. .PP In the future, runtime options may be added to control behavior such @@ -285,7 +293,7 @@ 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. -Supported toplevel options for the standard SBCL core are +The toplevel options supported by the standard SBCL core are .TP 3 .B --sysinit Load filename instead of the default system-wide initialization file. @@ -301,9 +309,9 @@ initialization file to be read, but on a Unix system "--userinit .TP 3 .B --eval After executing any initialization file, but before starting the -read-eval-print loop on standard input, evaluate the command given. -More than one --eval option can be used, and all will be executed, in -the order they appear on the command line. +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 +and executed, in the order they appear on the command line. .TP 3 .B --load This is equivalent to --eval '(load "")'. The special @@ -336,10 +344,10 @@ command.) 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 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 terminated -before proceeding to subsequent steps. +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 +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 @@ -361,9 +369,8 @@ X86 (Linux, FreeBSD, and OpenBSD), Alpha (Linux, Tru64), PPC For information on other ongoing and possible 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 for all but the smallest programs would be happier with 32Mb -or more. +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. .SH ENVIRONMENT @@ -380,9 +387,9 @@ default. .SH FILES -/usr/lib/sbcl.core and /usr/local/lib/sbcl.core are the standard -locations for the standard SBCL core, unless overridden by the SBCL_HOME -variable. +/usr/lib/sbcl/sbcl.core and /usr/local/lib/sbcl/sbcl.core are the +standard locations for the standard SBCL core, unless overridden by +the SBCL_HOME variable. /etc/sbclrc and /usr/local/etc/sbclrc are the standard locations for system-wide SBCL initialization files, unless overridden by the @@ -419,8 +426,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 -never compiled code to check the declaration. +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. .TP 3 @@ -459,15 +466,6 @@ result as a function value) is a fundamentally slow operation. There are still some nagging pre-ANSIisms, notably .TP 3 -\-- -CLOS (based on the PCL reference implementation) is incompletely -integrated into the system, so that e.g. SB-PCL::FIND-CLASS is a -different function than CL::FIND-CLASS. (In practice, you need to -be a pretty advanced user before this is a serious problem, and -by then you can usually work around it, but it's still distasteful. -It's arguably the outstanding "This should be fixed by version 1.0" -issue.) -.TP 3 -- The ANSI-recommended idiom for creating a function which is only sometimes expanded inline, @@ -493,7 +491,7 @@ handled specially by certain type expanders.) To report a bug, please send mail to the mailing lists sbcl-help or sbcl-devel. You can find the complete mailing list addresses on the -web pages, . (You may also find fancy +web pages at . (You may also find fancy SourceForge bug-tracking machinery there, but don't be fooled. As of 2002-07-25 anyway, we don't actively monitor that machinery, and it exists only because we haven't been able to figure out how to turn @@ -520,8 +518,8 @@ executable program containing some low-level runtime support and a loader, used to read sbcl.core .TP .I sbcl.core -dumped memory image containing most of SBCL, to be loaded by the -'sbcl' executable +dumped memory image containing most of SBCL, to be loaded by +the 'sbcl' executable .TP .I sbclrc optional system-wide startup script (in an etc-ish system @@ -534,4 +532,4 @@ optional per-user customizable startup script (in user's home directory) Dozens of people have made substantial contributions to SBCL and its subsystems, and to the CMU CL system on which it was based, over the -years. See the CREDITS file in the distribution. +years. See the CREDITS file in the distribution for more information.