r1650: *** empty log message ***
[clsql.git] / doc / intro.sgml
index bc663236ce0ebd7f4b43097bb78fe54d8a22c500..25c672ea4429c990335d493de3aecac286b5b58e 100644 (file)
@@ -16,10 +16,28 @@ structure of &clsql; is based on the
     <title>History</title>
     <para>
       &clsql; is written by Kevin M. Rosenberg and based substantially
-on Pierre R. Mai's excellent &maisql; package. The main changes have
-been to port the &ffi; to &uffi;, add to Allegro's ODBC interface as a
-supported database, add a compatibility layer for &cmucl; specific
-code, and make the code more robust in terms of &mysql; support.
+on Pierre R. Mai's excellent &maisql; package. The main changes from &maisql;
+are:
+<itemizedlist>
+<listitem>
+<para>port from the &cmucl; FFI to &uffi;.</para>
+</listitem>
+<listitem>
+<para>new &acl; ODBC interface back-end.</para>
+</listitem>
+<listitem>
+<para>compatibility layer for &cmucl; specific code.</para>
+</listitem>
+<listitem>
+<para>much improved robustness for the &mysql; back-end.</para>
+</listitem>
+<listitem>
+<para>improved system loading.</para>
+</listitem>
+<listitem>
+<para>improved packages and symbol export.</para>
+</listitem>
+</itemizedlist>
     </para>
   </sect1>
 
@@ -30,10 +48,10 @@ code, and make the code more robust in terms of &mysql; support.
       <title>&defsystem;</title>
       <para> &clsql; uses &defsystem to compile and load its
 components.  &defsystem; is included in the <ulink
-url="http://clocc.sourceforge.net"><citetitle>&clocc;</citetitle></ulink>. The
-defsystem version in the pre-packaged distribution is rather old and
+url="http://clocc.sourceforge.net"><citetitle>&clocc;</citetitle></ulink> collection. The
+version in the pre-packaged distribution is rather old and
 may not function well. The version in CVS tree tree works quite
-well. For convenience, a copy of the latest defsystem at the FTP
+well. For convenience, a copy of the latest &defsystem; at the FTP
 <ulink
 url="ftp://ftp.med-info.com/pub/defsystem/"><citetitle>site</citetitle></ulink>
 of &clsql;.
@@ -89,9 +107,9 @@ the following implementations are supported:
       <title>Ensure &defsystem; is loaded</title>
       <para>
        Simply load the file <filename>defsystem.lisp</filename>.
-<computeroutput>
+        <programlisting>
 (load "defsystem.lisp")
-</computeroutput>
+        </programlisting>
       </para>
     </sect2>
 
@@ -112,24 +130,28 @@ files for Microsoft Windows are supplied with the distribution.</para>
 edit <filename>Makefile</filename> or <filename>Makefile.msvc</filename> to
 correctly specify the location of your &mysql; installation. On UNIX systems, use
 the command:
-<programlisting>make</programlisting>. On a Microsoft Windows system,
-use the command: <programlisting>nmake /f
-Makefile.msvc</programlisting>.</para>
-    </sect2>
+     <programlisting>make</programlisting>
+On a Microsoft Windows system,
+use the command: 
+     <programlisting>
+nmake /f
+Makefile.msvc
+  </programlisting></para>
+      </sect2>
 
     <sect2>
       <title>Load &uffi;</title>
       <para>
        Unpack the appropriate &uffi; version for your system which creates a directory
-for the &uffi; files. Add that directory to &defsystem; <varname>*central-registry*</varname>.
+for the &uffi; files. Add that directory to Defsystem's <varname>mk:*central-registry*</varname>.
 You can do that by either pushing the pathname of the directory onto this variable, or
 use the new <function>add-registry-location</function> present in the newest versions of
-&defsystem;. The below example code assumes the &uffi; files reside in the
+&defsystem;. The following example code assumes the &uffi; files reside in the
 <filename>/usr/local/src/lisp/uffi</filename> directory.
-       <computeroutput>
-       (mk:add-registry-location #P"/usr/local/src/lisp/uffi")
-       (mk:load-system :uffi)
-        </computeroutput>
+       <programlisting>
+(mk:add-registry-location #P"/usr/local/src/lisp/uffi")
+(mk:load-system :uffi)
+        </programlisting>
       </para>
     </sect2>