Changeset 8548


Ignore:
Timestamp:
Feb 21, 2008, 5:03:47 PM (12 years ago)
Author:
gb
Message:

minor structure fixes, fix internal links, etc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/source/doc/src/openmcl-documentation.xml

    r8520 r8548  
    279279</programlisting>
    280280        <para>The openmcl shell script will pass all of its arguments
    281         to the OpenMCL kernel.  See <xref linkend="invocation"/> for
     281        to the OpenMCL kernel.  See <xref linkend="Invocation"/> for
    282282        more information about "args".  When invoked this way, the
    283283        lisp should be able to initialize the
     
    292292</programlisting>
    293293      </sect2>
    294 
     294      <sect2 id="Invocation">
     295        <title>Invocation</title>
     296        <para>Assuming that the shell script is properly installed, it can be used to invoke OpenMCL from a shell prompt:
     297        <programlisting>
     298shell&gt;<replaceable>ccl</replaceable> <emphasis>args</emphasis>
     299        </programlisting>
     300        <literal>ccl</literal> will run a 32-bit session;
     301        <literal>ccl64</literal> will run a 64-bit session.
     302        </para>
     303      </sect2>
    295304      <sect2 id="Personal-Customization-with-the-Init-File">
    296305        <title>Personal Customization with the Init File</title>
     
    604613    here.</para>
    605614
    606     <sect1 id="building-definitions"><title>>building definitions</title>
     615    <sect1 id="building-definitions"><title>building definitions</title>
    607616      <para>The following terms are used in subsequent sections; it
    608617      may be helpful to refer to these definitions.</para>
     
    75307539              <listitem>
    75317540                <para>The argument/return values
    7532                 is <link linkend=""Referencing-and-Using-Foreign-Memory-Addresses">a MACPTR</link>.</para>
     7541                is <link linkend="Referencing-and-Using-Foreign-Memory-Addresses">a MACPTR</link>.</para>
    75337542              </listitem>
    75347543            </varlistentry>
     
    98789887              <listitem>
    98799888                <para>NIL or a keyword; the keyword may contain
    9880                 <link linkend="arb30">escaping constructs</link>.</para>
     9889                <link linkend="Case-sensitivity-of-foreign-names-in-OpenMCL" >escaping constructs</link>.</para>
    98819890              </listitem>
    98829891            </varlistentry>
     
    1002910038            that would mean that any stand-alone application using it would
    1003010039            have to include a copy of the interface database
    10031             (see <xref linkend="arb25"/>), which is undesireable
     10040            (see <xref linkend="The-Interface-Database"/>), which is undesireable
    1003210041            because it's large.
    1003310042          </para>
     
    1020110210              <listitem>
    1020210211                <para>a keyword which names a foreign type or record, as
    10203                 described in <xref linkend="arb45"/>.
     10212                described in <xref linkend="Foreign-type--record--and-field-names"/>.
    1020410213                </para>
    1020510214              </listitem>
     
    1054410553              <listitem>
    1054510554                <para>One of the foreign argument-type keywords, described
    10546                 above, or an equivalent <link linkend="arb23">foreign
     10555                above, or an equivalent <link linkend="Specifying-And-Using-Foreign-Types">foreign
    1054710556                type specifier</link>.</para>
    1054810557              </listitem>
     
    1056310572              <listitem>
    1056410573                <para>One of the foreign argument-type keywords, described
    10565                 above, or an equivalent <link linkend="arb23">foreign
     10574                above, or an equivalent <link linkend="Specifying-And-Using-Foreign-Types">foreign
    1056610575                type specifier</link>.</para>
    1056710576              </listitem>
     
    1065810667              <listitem>
    1065910668                <para>One of the foreign argument-type keywords, described
    10660                 above, or an equivalent <link linkend="arb23">foreign
     10669                above, or an equivalent <link linkend="Specifying-And-Using-Foreign-Types">foreign
    1066110670                type specifier</link>.</para>
    1066210671              </listitem>
     
    1067710686              <listitem>
    1067810687                <para>One of the foreign argument-type keywords, described
    10679                 above, or an equivalent <link linkend="arb23">foreign
     10688                above, or an equivalent <link linkend="Specifying-And-Using-Foreign-Types">foreign
    1068010689                type specifier</link>.</para>
    1068110690              </listitem>
     
    1081410823
    1081510824              <listitem>
    10816                 <para>One of the foreign argument-type keywords, described
    10817                 above, or an equivalent <link linkend="arb23">foreign
    10818                 type specifier</link>.
    10819                 In addition, if the keyword
     10825                <para>One of the foreign argument-type keywords,
     10826                described above, or an equivalent <link
     10827                linkend="Specifying-And-Using-Foreign-Types">foreign
     10828                type specifier</link>.  In addition, if the keyword
    1082010829                :WITHOUT-INTERRUPTS is specified, the callback will be
    10821                 executed with lisp interrupts disabled if the corresponding
    10822                 var is non-NIL. If :WITHOUT-INTERRUPTS is specified more
    10823                 than once, the rightmost instance wins.</para>
     10830                executed with lisp interrupts disabled if the
     10831                corresponding var is non-NIL. If :WITHOUT-INTERRUPTS
     10832                is specified more than once, the rightmost instance
     10833                wins.</para>
    1082410834              </listitem>
    1082510835            </varlistentry>
     
    1088710897          bound to the &#34;OS&#34; package and with readtable-case preserved.</para>
    1088810898         
    10889           <para>Does a lookup on that symbol
    10890           in <link linkend="arb25">the OpenMCL interface database</link>,
    10891           signalling
    10892           an error if no foreign function information can be found for the
    10893           symbol in any
    10894           active <link linkend="arb29">interface directory</link>.</para>
     10899          <para>Does a lookup on that symbol in <link
     10900          linkend="The-Interface-Database">the OpenMCL interface
     10901          database</link>, signalling an error if no foreign function
     10902          information can be found for the symbol in any active <link
     10903          linkend="Using-Interface-Directories">interface
     10904          directory</link>.</para>
    1089510905
    1089610906          <para>Notes the foreign function information, including the foreign
     
    1120511215
    1120611216          <simplelist type="inline">
    11207             <member><xref linkend="arb35"/></member>
     11217            <member><xref linkend="Tutorial--Allocating-Foreign-Data-on-the-Lisp-Heap"/></member>
    1120811218          </simplelist>
    1120911219        </refsect1>
Note: See TracChangeset for help on using the changeset viewer.