CMUCL commit: src/docs/cmu-user (extensions.tex)

[Raymond Toy]

    Date: Saturday, July 31, 2010 @ 09:36:48
  Author: rtoy
    Path: /project/cmucl/cvsroot/src/docs/cmu-user

Modified: extensions.tex

o Forgot to add :executable to save-lisp signature.
o Give example of how to start an executable image.
o Document the ld-library-path, modules, and ext-formats searc-lists. 


----------------+
 extensions.tex |   24 ++++++++++++++++++------
 1 file changed, 18 insertions(+), 6 deletions(-)


Index: src/docs/cmu-user/extensions.tex
diff -u src/docs/cmu-user/extensions.tex:1.45 src/docs/cmu-user/extensions.tex:1.46
--- src/docs/cmu-user/extensions.tex:1.45	Tue Apr 20 22:31:16 2010
+++ src/docs/cmu-user/extensions.tex	Sat Jul 31 09:36:48 2010
@@ -1330,7 +1330,7 @@
     \args{\var{file}
       \keys{\kwd{purify} \kwd{root-structures} \kwd{init-function}}
       \morekeys{\kwd{load-init-file} \kwd{print-herald} \kwd{site-init}}
-      \yetmorekeys{\kwd{process-command-line} \kwd{batch-mode}}}}
+      \yetmorekeys{\kwd{process-command-line} \kwd{batch-mode} \kwd{executable}}}}
   
   The \code{save-lisp} function saves the state of the currently
   running Lisp core image in \var{file}.  The keyword arguments have
@@ -1385,8 +1385,9 @@
     incorporated into the C runtime, so one (large) executable is
     created instead of a new separate core file.
 
-    This feature is only available on some platforms.  Currently only
-    x86 on Linux and FreeBSD support this.
+    This feature is only available on some platforms, as indicated by
+    having the feature \kwd{executable}.  Currently only x86 ports and
+    the solaris/sparc port have this feature.
   \end{Lentry}
 \end{defun}
 
@@ -1394,6 +1395,12 @@
 \begin{example}
 lisp -core file
 \end{example}
+However, if the \kwd{executable} option was specified, you can just
+use
+\begin{example}
+  file
+\end{example}
+since the executable contains the core file within the executable.
 
 \begin{defun}{extensions:}{purify}{
     \args{\var{file}
@@ -1551,11 +1558,16 @@
 \item[\code{home:}] The user's home directory.
 
 \item[\code{library:}] The \cmucl{} \file{lib/} directory (\code{CMUCLLIB} environment
-variable.)
-
-\item[\code{path:}] The Unix command path (\code{PATH} environment variable.)
+variable).
 
+\item[\code{path:}] The Unix command path (\code{PATH} environment variable).
+\item[\code{ld-library-path:}] The Unix \code{LD_LIBRARY_PATH}
+  environment variable.
 \item[\code{target:}] The root of the tree where \cmucl{} was compiled.
+\item[\code{modules:}] The list of directories where \cmucl{}'s
+  modules can be found.
+\item[\code{ext-formats:}] The list of directories where \cmucl{} can
+  find the implementation of external formats.  
 \end{Lentry}
 It can be useful to redefine these search-lists, for example, \file{library:}
 can be augmented to allow logical pathname translations to be located, and