1.0.13.20: added SB-EXT:*EXIT-HOOKS*

[sbcl.git] / doc / manual / start-stop.texinfo

diff --git a/doc/manual/start-stop.texinfo b/doc/manual/start-stop.texinfo
index 86c1956..77940c2 100644 (file)
--- a/doc/manual/start-stop.texinfo
+++ b/doc/manual/start-stop.texinfo
@@ -3,10 +3,11 @@
 @chapter Starting and Stopping
 
 @menu
 @chapter Starting and Stopping
 
 @menu

-* Starting SBCL::               
-* Stopping SBCL::               
-* Command Line Options::        
-* Initialization Files::        
+* Starting SBCL::
+* Stopping SBCL::
+* Command Line Options::
+* Initialization Files::
+* Initialization and Exit Hooks::

 @end menu
 
 @node Starting SBCL
 @end menu
 
 @node Starting SBCL

@@ -14,9 +15,9 @@
 @section Starting SBCL
 
 @menu
 @section Starting SBCL
 
 @menu

-* Running from Shell::          
-* Running from Emacs::          
-* Shebang Scripts::             
+* Running from Shell::
+* Running from Emacs::
+* Shebang Scripts::

 @end menu
 
 @node Running from Shell
 @end menu
 
 @node Running from Shell

@@ -77,9 +78,9 @@ an example.)
 @section Stopping SBCL
 
 @menu
 @section Stopping SBCL
 
 @menu

-* Quit::                        
+* Quit::

 * End of File::
 * End of File::

-* Saving a Core Image::              
+* Saving a Core Image::

 * Exit on Errors::
 @end menu
 
 * Exit on Errors::
 @end menu
 

@@ -108,9 +109,10 @@ using SBCL as part of a shell pipeline.
 
 SBCL has the ability to save its state as a file for later
 execution. This functionality is important for its bootstrapping
 
 SBCL has the ability to save its state as a file for later
 execution. This functionality is important for its bootstrapping

-process, and is also provided as an extension to the user.  
+process, and is also provided as an extension to the user.

 
 @include fun-sb-ext-save-lisp-and-die.texinfo
 
 @include fun-sb-ext-save-lisp-and-die.texinfo

+@include var-sb-ext-star-save-hooks-star.texinfo

 
 To facilitate distribution of SBCL applications using external
 resources, the filesystem location of the SBCL core file being used is
 
 To facilitate distribution of SBCL applications using external
 resources, the filesystem location of the SBCL core file being used is

@@ -163,8 +165,8 @@ passed on to the user program even if they was intended for the
 runtime system or the Lisp system.
 
 @menu
 runtime system or the Lisp system.
 
 @menu

-* Runtime Options::             
-* Toplevel Options::            
+* Runtime Options::
+* Toplevel Options::

 @end menu
 
 @node Runtime Options
 @end menu
 
 @node Runtime Options

@@ -179,6 +181,10 @@ the Lisp core file is a user-created core file, it may run a
 nonstandard toplevel which does not recognize the standard toplevel
 options.
 
 nonstandard toplevel which does not recognize the standard toplevel
 options.
 

+@item --dynamic-space-size @var{megabytes}
+Size of the dynamic space reserved on startup in megabytes. Default
+value is platform dependent.
+

 @item --noinform
 Suppress the printing of any banner or other informational message at
 startup. This makes it easier to write Lisp programs which work
 @item --noinform
 Suppress the printing of any banner or other informational message at
 startup. This makes it easier to write Lisp programs which work

@@ -208,16 +214,19 @@ chance to see it.
 
 @item --sysinit @var{filename}
 Load filename instead of the default system initialization file
 
 @item --sysinit @var{filename}
 Load filename instead of the default system initialization file

-(@pxref{System Initialization File}.) There is no special option to
-cause no system initialization file to be read, but on a Unix
-system ``@code{"--sysinit /dev/null}'' can be used to achieve the same
-effect.
+(@pxref{System Initialization File}.)
+
+@item --no-sysinit
+Don't load a system-wide initialization file.  If this option is given,
+the @code{--sysinit} option is ignored.

 
 @item --userinit @var{filename}
 Load filename instead of the default user initialization file
 
 @item --userinit @var{filename}
 Load filename instead of the default user initialization file

-(@pxref{User Initialization File}.) There is no special option to
-cause no user initialization file to be read, but ``@code{--userinit
-/dev/null}'' can be used to achieve the same effect.
+(@pxref{User Initialization File}.)
+
+@item --no-userinit
+Don't load a user initialization file.  If this option is given,
+the @code{--userinit} option is ignored.

 
 @item --eval @var{command}
 After executing any initialization file, but before starting the
 
 @item --eval @var{command}
 After executing any initialization file, but before starting the

@@ -253,10 +262,10 @@ This section covers initialization files processed at startup, which
 can be used to customize the lisp environment.
 
 @menu
 can be used to customize the lisp environment.
 
 @menu

-* System Initialization File::  
-* User Initialization File::    
-* Initialization File Semantics::  
-* Initialization Examples::     
+* System Initialization File::
+* User Initialization File::
+* Initialization File Semantics::
+* Initialization Examples::

 @end menu
 
 @node System Initialization File
 @end menu
 
 @node System Initialization File

@@ -295,13 +304,15 @@ Some examples of what you may consider doing in the initialization
 files follow.
 
 @menu
 files follow.
 
 @menu

-* Unix-style Command Line Protocol::  
-* Automatic Recompilation of Stale Fasls::  
+* Unix-style Command Line Protocol::
+* Automatic Recompilation of Stale Fasls::

 @end menu
 
 @node Unix-style Command Line Protocol
 @comment  node-name,  next,  previous,  up
 @subsubsection Unix-style Command Line Protocol
 @end menu
 
 @node Unix-style Command Line Protocol
 @comment  node-name,  next,  previous,  up
 @subsubsection Unix-style Command Line Protocol

+@vindex sb-ext:*posix-argv*
+@vindex *posix-argv*

 
 Standard Unix tools that are interpreters follow a common command line
 protocol that is necessary to work with ``shebang scripts''. SBCL
 
 Standard Unix tools that are interpreters follow a common command line
 protocol that is necessary to work with ``shebang scripts''. SBCL

@@ -311,7 +322,7 @@ initialization file does the trick:
 @lisp
 ;;; If the first user-processable command-line argument is a filename,
 ;;; disable the debugger, load the file handling shebang-line and quit.
 @lisp
 ;;; If the first user-processable command-line argument is a filename,
 ;;; disable the debugger, load the file handling shebang-line and quit.

-(let ((script (and (second *posix-argv*) 
+(let ((script (and (second *posix-argv*)

                    (probe-file (second *posix-argv*)))))
    (when script
       ;; Handle shebang-line
                    (probe-file (second *posix-argv*)))))
    (when script
       ;; Handle shebang-line

@@ -320,7 +331,7 @@ initialization file does the trick:
                                        (declare (ignore char arg))
                                        (read-line stream)))
       ;; Disable debugger
                                        (declare (ignore char arg))
                                        (read-line stream)))
       ;; Disable debugger

-      (setf *invoke-debugger-hook* 
+      (setf *invoke-debugger-hook*

             (lambda (condition hook)
               (declare (ignore hook))
               ;; Uncomment to get backtraces on errors
             (lambda (condition hook)
               (declare (ignore hook))
               ;; Uncomment to get backtraces on errors

@@ -369,8 +380,8 @@ handles recompilation automatically for ASDF-based systems.
 @lisp
 (require :asdf)
 
 @lisp
 (require :asdf)
 

-;;; If a fasl was stale, try to recompile and load (once). 
-(defmethod asdf:perform :around ((o asdf:load-op) 
+;;; If a fasl was stale, try to recompile and load (once).
+(defmethod asdf:perform :around ((o asdf:load-op)

                                  (c asdf:cl-source-file))
    (handler-case (call-next-method o c)
       ;; If a fasl was stale, try to recompile and load (once).
                                  (c asdf:cl-source-file))
    (handler-case (call-next-method o c)
       ;; If a fasl was stale, try to recompile and load (once).

@@ -378,3 +389,13 @@ handles recompilation automatically for ASDF-based systems.
          (asdf:perform (make-instance 'asdf:compile-op) c)
          (call-next-method))))
 @end lisp
          (asdf:perform (make-instance 'asdf:compile-op) c)
          (call-next-method))))
 @end lisp

+
+@node Initialization and Exit Hooks
+@comment  node-name,  next,  previous,  up
+@section Initialization and Exit Hooks
+
+SBCL provides hooks into the system initialization and exit.
+
+@include var-sb-ext-star-init-hooks-star.texinfo
+@include var-sb-ext-star-exit-hooks-star.texinfo
+