Ignore:
Timestamp:
Nov 6, 2009, 7:41:49 PM (10 years ago)
Author:
rme
Message:

Document FASL-CONCATENATE. (Description lifted from
http://clozure.com/pipermail/openmcl-devel/2009-May/009649.html)

File:
1 edited

Legend:

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

    r13106 r13172  
    17831783  </sect1>
    17841784
     1785  <sect1 id="concatenating-fasl-files">
     1786    <title>Concatenating FASL Files</title>
     1787    <para>
     1788      Multiple fasl files can be concatenated into a single file.
     1789    </para>
     1790  <refentry id="fasl-concatenate">
     1791    <indexterm zone="f_fasl-concatenate">
     1792      <primary>fasl-concatenate</primary>
     1793    </indexterm>
     1794
     1795    <refnamediv>
     1796      <refname>FASL-CONCATENATE</refname>
     1797      <refpurpose>
     1798        Concatenate several fasl files, producing a single output file.
     1799      </refpurpose>
     1800      <refclass>Function</refclass>
     1801    </refnamediv>
     1802   
     1803    <refsynopsisdiv>
     1804      <synopsis><function>fasl-concatenate</function> out-file fasl-files &key; (:if-exists :error)</synopsis>
     1805    </refsynopsisdiv>
     1806
     1807    <refsect1>
     1808      <title>Arguments and Values</title>
     1809      <variablelist>
     1810        <varlistentry>
     1811          <term>out-file</term>
     1812          <listitem>
     1813            <para>
     1814              Name of the file in which to store the concatenation.
     1815            </para>
     1816          </listitem>
     1817        </varlistentry>
     1818        <varlistentry>
     1819          <term>fasl-files</term>
     1820          <listitem>
     1821            <para>
     1822              List of names of fasl files to concatenate.
     1823            </para>
     1824          </listitem>
     1825        </varlistentry>
     1826        <varlistentry>
     1827          <term>:if-exists</term>
     1828          <listitem>
     1829            <para>
     1830              As for <function>OPEN</function>, defaults to <literal>
     1831              :error</literal>
     1832            </para>
     1833          </listitem>
     1834        </varlistentry>
     1835      </variablelist>
     1836    </refsect1>
     1837   
     1838    <refsect1>
     1839      <title>Description</title>
     1840      <para>
     1841        Creates a fasl file which, when loaded, will have the same
     1842        effect as loading the individual input fasl files in the
     1843        specified order.  The single file might be easier to
     1844        distribute or install, and loading it may be at least a little
     1845        faster than loading the individual files (since it avoids the
     1846        overhead of opening and closing each file in succession.)
     1847      </para>
     1848      <para>
     1849        The PATHNAME-TYPE of the output file and of each input file
     1850        defaults to the current platform's fasl file type (.dx64fsl or
     1851        whatever.)  If any of the input files has a different
     1852        type/extension an error will be signaled, but it doesn't
     1853        otherwise try too hard to verify that the input files are real
     1854        fasl files for the current platform.
     1855      </para>
     1856    </refsect1>
     1857  </refentry>
     1858  </sect1>
    17851859  <sect1 id="floating-point">
    17861860    <title>Floating Point Numbers</title>
Note: See TracChangeset for help on using the changeset viewer.