[Openmcl-cvs-notifications] r14398 - /trunk/source/doc/src/using.xml

[rme at clozure.com]

Author: rme
Date: Tue Nov  2 15:20:35 2010
New Revision: 14398

Log:
Document ccl:quit.

Modified:
    trunk/source/doc/src/using.xml

Modified: trunk/source/doc/src/using.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/using.xml (original)
+++ trunk/source/doc/src/using.xml Tue Nov  2 15:20:35 2010
@@ -3177,4 +3177,42 @@
 =

 </sect2>
 </sect1>
+<sect1 id=3D"other-extensions"><title>Other Extensions</title>
+<refentry id=3D"v_quit">
+  <indexterm zone=3D"v_quit">
+    <primary>quit</primary>
+  </indexterm>
+  =

+  <refnamediv>
+    <refname>QUIT</refname>
+    <refpurpose>
+      Cleanly exit the lisp.
+    </refpurpose>
+    <refclass>Function</refclass>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <synopsis><function>quit</function> &optional; (exit 0) &key; error-ha=
ndler
+    </synopsis>
+  </refsynopsisdiv>
+
+  <refsect1><title>Summary</title>
+    <para>
+      Cleanly exit from lisp.  If the exit argument is a value of type
+      (signed-byte 32), that value will be passed to the C library
+      function _exit() as the status code.  (A value of nil is treated
+      as a zero.)
+    </para>
+    <para>
+      Alternatively, exit may be a function of no arguments;  this function
+      will be called instead of _exit() to exit the lisp.
+    </para>
+    <para>
+      The error-handler argument, if supplied, must be a function of one
+      argument, the condition, that will be called if an error occurs when
+      preparing to quit.  The error-handler function should exit the lisp.
+    </para>
+  </refsect1>
+</refentry>
+</sect1>
 </chapter>