doc/manual/start-stop.texinfo

   1 @node Starting and Stopping
   2 @comment  node-name,  next,  previous,  up
   3 @chapter Starting and Stopping
   4
   5 @menu
   6 * Starting SBCL::
   7 * Stopping SBCL::
   8 * Command Line Options::
   9 * Initialization Files::
  10 @end menu
  11
  12 @node Starting SBCL
  13 @comment  node-name,  next,  previous,  up
  14 @section Starting SBCL
  15
  16 @menu
  17 * Running from Shell::
  18 * Running from Emacs::
  19 * Shebang Scripts::
  20 @end menu
  21
  22 @node Running from Shell
  23 @comment  node-name,  next,  previous,  up
  24 @subsection From Shell to Lisp
  25
  26 To run SBCL type @command{sbcl} at the command line.
  27
  28 You should end up in the toplevel @dfn{REPL} (read, eval, print
  29 -loop), where you can interact with SBCL by typing expressions.
  30
  31 @smallexample
  32 $ sbcl
  33 This is SBCL 0.8.13.60, an implementation of ANSI Common Lisp.
  34 More information about SBCL is available at <http://www.sbcl.org/>.
  35
  36 SBCL is free software, provided as is, with absolutely no warranty.
  37 It is mostly in the public domain; some portions are provided under
  38 BSD-style licenses.  See the CREDITS and COPYING files in the
  39 distribution for more information.
  40 * (+ 2 2)
  41
  42 4
  43 * (quit)
  44 $
  45 @end smallexample
  46
  47 See also @ref{Command Line Options} and @ref{Stopping SBCL}.
  48
  49 @node Running from Emacs
  50 @comment  node-name,  next,  previous,  up
  51 @subsection Running from Emacs
  52
  53 To run SBCL as an inferior-lisp from Emacs in your @file{.emacs} do
  54 something like:
  55
  56 @lisp
  57 ;;; The SBCL binary and command-line arguments
  58 (setq inferior-lisp-program "/usr/local/bin/sbcl --noinform")
  59 @end lisp
  60
  61 For more information on using SBCL with Emacs, see @ref{Editor
  62 Integration}.
  63
  64
  65 @node Shebang Scripts
  66 @comment  node-name,  next,  previous,  up
  67 @subsection Shebang Scripts
  68
  69 SBCL doesn't come with built-in support for shebang-line execution,
  70 but this can be provided with a shell trampoline, or by dispatching
  71 from initialization files (@pxref{Unix-style Command Line Protocol} for
  72 an example.)
  73
  74
  75 @node Stopping SBCL
  76 @comment  node-name,  next,  previous,  up
  77 @section Stopping SBCL
  78
  79 @menu
  80 * Quit::
  81 * End of File::
  82 * Saving a Core Image::
  83 * Exit on Errors::
  84 @end menu
  85
  86 @node Quit
  87 @comment  node-name,  next,  previous,  up
  88 @subsection Quit
  89
  90 SBCL can be stopped at any time by calling @code{sb-ext:quit},
  91 optionally returning a specified numeric value to the calling process.
  92 See notes in @ref{Threading} about the interaction between this
  93 feature and sessions.
  94
  95 @include fun-sb-ext-quit.texinfo
  96
  97 @node End of File
  98 @comment  node-name,  next,  previous,  up
  99 @subsection End of File
 100
 101 By default SBCL also exits on end of input, caused either by user
 102 pressing @kbd{Control-D} on an attached terminal, or end of input when
 103 using SBCL as part of a shell pipeline.
 104
 105 @node Saving a Core Image
 106 @comment  node-name,  next,  previous,  up
 107 @subsection Saving a Core Image
 108
 109 SBCL has the ability to save its state as a file for later
 110 execution. This functionality is important for its bootstrapping
 111 process, and is also provided as an extension to the user.
 112
 113 @include fun-sb-ext-save-lisp-and-die.texinfo
 114
 115 To facilitate distribution of SBCL applications using external
 116 resources, the filesystem location of the SBCL core file being used is
 117 available from Lisp.
 118
 119 @include var-sb-ext-star-core-pathname-star.texinfo
 120
 121 @node Exit on Errors
 122 @comment  node-name,  next,  previous,  up
 123 @subsection Exit on Errors
 124
 125 SBCL can also be configured to exit if an unhandled error occurs,
 126 which is mainly useful for acting as part of a shell pipeline; doing
 127 so under most other circumstances would mean giving up large parts of
 128 the flexibility and robustness of Common Lisp. See @ref{Debugger Entry}.
 129
 130 @node Command Line Options
 131 @comment  node-name,  next,  previous,  up
 132 @section Command Line Options
 133
 134 @c FIXME: This is essentially cut-and-paste from the manpage
 135 @c What should probably be done is generate both this and the
 136 @c man-page from ``sbcl --help'' output.
 137
 138 Command line options can be considered an advanced topic; for ordinary
 139 interactive use, no command line arguments should be necessary.
 140
 141 In order to understand the command line argument syntax for SBCL, it
 142 is helpful to understand that the SBCL system is implemented as two
 143 components, a low-level runtime environment written in C and a
 144 higher-level system written in Common Lisp itself. Some command line
 145 arguments are processed during the initialization of the low-level
 146 runtime environment, some command line arguments are processed during
 147 the initialization of the Common Lisp system, and any remaining
 148 command line arguments are passed on to user code.
 149
 150 The full, unambiguous syntax for invoking SBCL at the command line is:
 151
 152 @command{sbcl} @var{runtime-option}* @code{--end-runtime-options} @var{toplevel-option}* @code{--end-toplevel-options} @var{user-options}*
 153
 154 For convenience, the @code{--end-runtime-options} and
 155 @code{--end-toplevel-options} elements can be omitted. Omitting these
 156 elements can be convenient when you are running the program
 157 interactively, and you can see that no ambiguities are possible with
 158 the option values you are using. Omitting these elements is probably a
 159 bad idea for any batch file where any of the options are under user
 160 control, since it makes it impossible for SBCL to detect erroneous
 161 command line input, so that erroneous command line arguments will be
 162 passed on to the user program even if they was intended for the
 163 runtime system or the Lisp system.
 164
 165 @menu
 166 * Runtime Options::
 167 * Toplevel Options::
 168 @end menu
 169
 170 @node Runtime Options
 171 @comment  node-name,  next,  previous,  up
 172 @subsection Runtime Options
 173
 174 @table @code
 175
 176 @item --core @var{corefilename}
 177 Run the specified Lisp core file instead of the default. Note that if
 178 the Lisp core file is a user-created core file, it may run a
 179 nonstandard toplevel which does not recognize the standard toplevel
 180 options.
 181
 182 @item --noinform
 183 Suppress the printing of any banner or other informational message at
 184 startup. This makes it easier to write Lisp programs which work
 185 cleanly in Unix pipelines. See also the @code{--noprint} and
 186 @code{--disable-debugger} options.
 187
 188 @item --help
 189 Print some basic information about SBCL, then exit.
 190
 191 @item --version
 192 Print SBCL's version information, then exit.
 193
 194 @end table
 195
 196 In the future, runtime options may be added to control behaviour such
 197 as lazy allocation of memory.
 198
 199 Runtime options, including any --end-runtime-options option, are
 200 stripped out of the command line before the Lisp toplevel logic gets a
 201 chance to see it.
 202
 203 @node Toplevel Options
 204 @comment  node-name,  next,  previous,  up
 205 @subsection Toplevel Options
 206
 207 @table @code
 208
 209 @item --sysinit @var{filename}
 210 Load filename instead of the default system initialization file
 211 (@pxref{System Initialization File}.) There is no special option to
 212 cause no system initialization file to be read, but on a Unix
 213 system ``@code{"--sysinit /dev/null}'' can be used to achieve the same
 214 effect.
 215
 216 @item --userinit @var{filename}
 217 Load filename instead of the default user initialization file
 218 (@pxref{User Initialization File}.) There is no special option to
 219 cause no user initialization file to be read, but ``@code{--userinit
 220 /dev/null}'' can be used to achieve the same effect.
 221
 222 @item --eval @var{command}
 223 After executing any initialization file, but before starting the
 224 read-eval-print loop on standard input, read and evaluate the com-
 225 mand given. More than one @code{--eval} option can be used, and all
 226 will be read and executed, in the order they appear on the command
 227 line.
 228
 229 @item --load @var{filename}
 230 This is equivalent to @code{--eval '(load "@var{filename}")'}. The
 231 special syntax is intended to reduce quoting headaches when invoking
 232 SBCL from shell scripts.
 233
 234 @item --noprint
 235 When ordinarily the toplevel "read-eval-print loop" would be exe-
 236 cuted, execute a "read-eval loop" instead, i.e. don't print a prompt
 237 and don't echo results. Combined with the @code{--noinform} runtime
 238 option, this makes it easier to write Lisp "scripts" which work
 239 cleanly in Unix pipelines.
 240
 241 @item --disable-debugger
 242 This is equivalent to @code{--eval '(sb-ext:disable-debugger)'}.
 243 @xref{Debugger Entry}.
 244
 245 @end table
 246
 247
 248 @node Initialization Files
 249 @comment  node-name,  next,  previous,  up
 250 @section Initialization Files
 251
 252 This section covers initialization files processed at startup, which
 253 can be used to customize the lisp environment.
 254
 255 @menu
 256 * System Initialization File::
 257 * User Initialization File::
 258 * Initialization File Semantics::
 259 * Initialization Examples::
 260 @end menu
 261
 262 @node System Initialization File
 263 @comment  node-name,  next,  previous,  up
 264 @subsection System Initialization File
 265
 266 Site-wide startup script. Unless overridden with the command line
 267 option @code{--sysinit} defaults to @file{@env{SBCL_HOME}/sbclrc}, or
 268 if that doesn't exist to @file{/etc/sbclrc}.
 269
 270 No system initialization file is required.
 271
 272 @node User Initialization File
 273 @comment  node-name,  next,  previous,  up
 274 @subsection User Initialization File
 275
 276 Per-user startup script. Unless overridden with the command line
 277 option @code{--userinit} defaults to @file{@env{HOME}/.sbclrc}.
 278
 279 No user initialization file is required.
 280
 281 @node Initialization File Semantics
 282 @comment  node-name,  next,  previous,  up
 283 @subsection Initialization File Semantics
 284
 285 SBCL processes initialization files with @code{read} and @code{eval},
 286 not @code{load}; hence initialization files can be used to set startup
 287 @code{*package*} and @code{*readtable*}, and for proclaiming a global
 288 optimization policy.
 289
 290 @node Initialization Examples
 291 @comment  node-name,  next,  previous,  up
 292 @subsection Initialization Examples
 293
 294 Some examples of what you may consider doing in the initialization
 295 files follow.
 296
 297 @menu
 298 * Unix-style Command Line Protocol::
 299 * Automatic Recompilation of Stale Fasls::
 300 @end menu
 301
 302 @node Unix-style Command Line Protocol
 303 @comment  node-name,  next,  previous,  up
 304 @subsubsection Unix-style Command Line Protocol
 305
 306 Standard Unix tools that are interpreters follow a common command line
 307 protocol that is necessary to work with ``shebang scripts''. SBCL
 308 doesn't do this by default, but adding the following snippet to an
 309 initialization file does the trick:
 310
 311 @lisp
 312 ;;; If the first user-processable command-line argument is a filename,
 313 ;;; disable the debugger, load the file handling shebang-line and quit.
 314 (let ((script (and (second *posix-argv*)
 315                    (probe-file (second *posix-argv*)))))
 316    (when script
 317       ;; Handle shebang-line
 318       (set-dispatch-macro-character #\# #\!
 319                                     (lambda (stream char arg)
 320                                        (declare (ignore char arg))
 321                                        (read-line stream)))
 322       ;; Disable debugger
 323       (setf *invoke-debugger-hook*
 324             (lambda (condition hook)
 325               (declare (ignore hook))
 326               ;; Uncomment to get backtraces on errors
 327               ;; (sb-debug:backtrace 20)
 328               (format *error-output* "Error: ~A~%" condition)
 329               (quit)))
 330       (load script)
 331       (quit)))
 332 @end lisp
 333
 334 Example file (@file{hello.lisp}):
 335
 336 @lisp
 337 #!/usr/local/bin/sbcl --noinform
 338 (write-line "Hello, World!")
 339 @end lisp
 340
 341 Usage examples:
 342
 343 @smallexample
 344 $ ./hello.lisp
 345 Hello, World!
 346 @end smallexample
 347
 348 @smallexample
 349 $ sbcl hello.lisp
 350 This is SBCL 0.8.13.70, an implementation of ANSI Common Lisp.
 351 More information about SBCL is available at <http://www.sbcl.org/>.
 352
 353 SBCL is free software, provided as is, with absolutely no warranty.
 354 It is mostly in the public domain; some portions are provided under
 355 BSD-style licenses.  See the CREDITS and COPYING files in the
 356 distribution for more information.
 357 Hello, World!
 358 @end smallexample
 359
 360
 361 @node Automatic Recompilation of Stale Fasls
 362 @comment  node-name,  next,  previous,  up
 363 @subsubsection Automatic Recompilation of Stale Fasls
 364
 365 SBCL fasl-format is at current stage of development undergoing
 366 non-backwards compatible changes fairly often. The following snippet
 367 handles recompilation automatically for ASDF-based systems.
 368
 369 @lisp
 370 (require :asdf)
 371
 372 ;;; If a fasl was stale, try to recompile and load (once).
 373 (defmethod asdf:perform :around ((o asdf:load-op)
 374                                  (c asdf:cl-source-file))
 375    (handler-case (call-next-method o c)
 376       ;; If a fasl was stale, try to recompile and load (once).
 377       (sb-ext:invalid-fasl ()
 378          (asdf:perform (make-instance 'asdf:compile-op) c)
 379          (call-next-method))))
 380 @end lisp