[Openmcl-cvs-notifications] r15288 - /trunk/source/doc/src/external-process.xml

[wade.humeniuk at clozure.com]

Author: wade.humeniuk
Date: Wed Mar 28 21:19:12 2012
New Revision: 15288

Log:
Added env and silently-ignore-catastrophic-failures keyword variable docume=
ntation to run-program

Modified:
    trunk/source/doc/src/external-process.xml

Modified: trunk/source/doc/src/external-process.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D
--- trunk/source/doc/src/external-process.xml (original)
+++ trunk/source/doc/src/external-process.xml Wed Mar 28 21:19:12 2012
@@ -77,7 +77,8 @@
 	    program args &key; (wait t) pty sharing input
 	    if-input-does-not-exist output (if-output-exists :error) (error
 	    :output) (if-error-exists :error) status-hook
-	    external-format</synopsis>
+	    external-format env (silently-ignore-catastrophic-failures
+            *silently-ignore-catastrophic-failure-in-run-program*)</synops=
is>
 	  </refsynopsisdiv>
 =

 	  <refsect1>
@@ -241,6 +242,34 @@
 		    linkend=3D"External-Formats"/>) for all of the
 		    streams (input, output, and error) used to
 		    communicate with the external process.
+		  </para>
+		</listitem>
+	      </varlistentry>
+	      <varlistentry>
+		<term>env</term>
+		<listitem>
+		  <para>
+		    New OS environment variable bindings for the
+		    external process.  By default the external process
+		    inherits the environment of the running Lisp
+		    process.  Env is an association list with elements
+		    (<Environment Variable
+		    Name> . <Value>). Name and
+		    value are case sensitive strings. See <xref
+		    linkend=3D"f_setenv"/>.
+		  </para>
+		</listitem>
+	      </varlistentry>
+	      <varlistentry>
+		<term>>silently-ignore-catastrophic-failures</term>
+		<listitem>
+		  <para>
+		    If NIL, signal an error if run-program is unable
+		    to start the program. If non-NIL, treat failure to
+		    start the same as failure from the program itself,
+		    by setting the status and exit-code
+		    fields. Default is
+		    *silently-ignore-catastrophic-failure-in-run-program*.
 		  </para>
 		</listitem>
 	      </varlistentry>