Changeset 15288

Timestamp:

Mar 28, 2012, 7:19:12 PM (13 years ago)

Author:

wade.humeniuk

Message:

Added env and silently-ignore-catastrophic-failures keyword variable documentation to run-program

File:

• trunk/source/doc/src/external-process.xml (modified) (2 diffs)

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

@@ -78 +78 @@
             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*)</synopsis>
           </refsynopsisdiv>
 
@@ -242 +243 @@
                     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
+                    (&lt;Environment Variable
+                    Name&gt;&nbsp;.&nbsp;&lt;Value&gt;). Name and
+                    value are case sensitive strings. See <xref
+                    linkend="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>