Changeset 14398


Ignore:
Timestamp:
Nov 2, 2010, 8:20:35 PM (9 years ago)
Author:
rme
Message:

Document ccl:quit.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/source/doc/src/using.xml

    r13830 r14398  
    31783178</sect2>
    31793179</sect1>
     3180<sect1 id="other-extensions"><title>Other Extensions</title>
     3181<refentry id="v_quit">
     3182  <indexterm zone="v_quit">
     3183    <primary>quit</primary>
     3184  </indexterm>
     3185 
     3186  <refnamediv>
     3187    <refname>QUIT</refname>
     3188    <refpurpose>
     3189      Cleanly exit the lisp.
     3190    </refpurpose>
     3191    <refclass>Function</refclass>
     3192  </refnamediv>
     3193
     3194  <refsynopsisdiv>
     3195    <synopsis><function>quit</function> &optional; (exit 0) &key; error-handler
     3196    </synopsis>
     3197  </refsynopsisdiv>
     3198
     3199  <refsect1><title>Summary</title>
     3200    <para>
     3201      Cleanly exit from lisp.  If the exit argument is a value of type
     3202      (signed-byte 32), that value will be passed to the C library
     3203      function _exit() as the status code.  (A value of nil is treated
     3204      as a zero.)
     3205    </para>
     3206    <para>
     3207      Alternatively, exit may be a function of no arguments;  this function
     3208      will be called instead of _exit() to exit the lisp.
     3209    </para>
     3210    <para>
     3211      The error-handler argument, if supplied, must be a function of one
     3212      argument, the condition, that will be called if an error occurs when
     3213      preparing to quit.  The error-handler function should exit the lisp.
     3214    </para>
     3215  </refsect1>
     3216</refentry>
     3217</sect1>
    31803218</chapter>
Note: See TracChangeset for help on using the changeset viewer.