r9576: Add generalized-boolean
[clsql.git] / doc / intro.xml
index a1457a694d2bf4de262f1e5e8830a02b37a98daa..c68cc5296d4c12ef0dfb2c7ae16b529926d0d1b8 100644 (file)
@@ -42,7 +42,7 @@
          <para>Optimized loading of integer and floating-point fields.</para>
        </listitem>
        <listitem>
-         <para>Additional database backends: &acl; ODBC and &sqlite;.</para>
+         <para>Additional database backends: &odbc;, &aodbc;, and &sqlite;.</para>
        </listitem>
        <listitem>
          <para>A compatibility layer for &cmucl; specific code.</para>
        implementations of &uffi;. The following implementations are supported:
       </para>
       <itemizedlist mark="opencircle">
-       <listitem><para>&acl; v6.2 on Debian Linux, FreeBSD 4.5, and Microsoft Windows XP.</para></listitem>
-       <listitem><para>&lw; v4.3 on Debian Linux and Microsoft Windows XP.</para></listitem>
-       <listitem><para>&cmucl; 18e on Debian Linux, FreeBSD 4.5, and Solaris 2.8.</para></listitem>
-       <listitem><para>&sbcl; 0.8.5 on Debian Linux.</para></listitem>
+       <listitem><para>&acl; v6.2 and 7.0b on Debian Linux x86 &amp;
+       x86_64 &amp; PowerPC, FreeBSD 4.5, and Microsoft Windows
+       XP.</para></listitem>
+       <listitem><para>&lw; v4.3 on Debian Linux and Microsoft
+       Windows XP.</para></listitem>
+       <listitem><para>&cmucl; 18e on Debian Linux, FreeBSD 4.5, and
+       Solaris 2.8.</para></listitem>
+       <listitem><para>&sbcl; 0.8.5 on Debian
+       Linux.</para></listitem>
        <listitem><para>&scl; 1.1.1 on Debian Linux.</para></listitem>
-       <listitem><para>&openmcl; 0.14 on Debian Linux PowerPC.</para></listitem>
+       <listitem><para>&openmcl; 0.14 on Debian Linux
+       PowerPC.</para></listitem>
       </itemizedlist>
     </sect2>
     
        Currently, &clsql; supports the following databases:
       </para>
       <itemizedlist mark="opencircle">
-       <listitem><para>&mysql; v3.23.51 and v4.0.15.</para></listitem>
-       <listitem><para>&postgresql; v7.2 with both direct API and TCP
+       <listitem><para>&mysql; v3.23.51 and v4.0.18.</para></listitem>
+       <listitem><para>&postgresql; v7.4 with both direct API and TCP
        socket connections.</para></listitem>
        <listitem><para>&sqlite;.</para></listitem>
-       <listitem><para>Allegro's ODBC interface (&aodbc;) using iODBC
-       ODBC manager.</para></listitem>
+       <listitem><para>Direct &odbc; interface.</para></listitem>
+        <listitem><para>&oracle; OCI.</para></listitem>
+       <listitem><para>Allegro's DB interface (&aodbc;).</para></listitem>
       </itemizedlist>
     </sect2>
     
     </sect2>
     
     <sect2>
-      <title>Load &uffi;</title>
+      <title>Add &uffi; path</title>
       <para>
        Unzip or untar the &uffi; distribution which creates a directory
        for the &uffi; files. Add that directory to &asdf;'s <varname>asdf:*central-registry*</varname>.
        directory.
        <screen>
 (push #P"/usr/share/lisp/uffi/" asdf:*central-registry*)
-(asdf:operate 'asdf:load-op :uffi)
        </screen>
       </para>
     </sect2>
    <sect2>
-     <title>Load &md5; module</title>
+     <title>Add &md5; path</title>
      <para>
        If you plan to use the clsql-postgresql-socket interface, you
        must load the md5 module.  Unzip or untar the cl-md5
        <filename>/usr/share/lisp/cl-md5/</filename> directory.
        <screen>
 (push #P"/usr/share/lisp/cl-md5/" asdf:*central-registry*)
-(asdf:operate 'asdf:load-op :md5)
        </screen>
      </para>
    </sect2>
    
    <sect2>
-     <title>Load &clsql; modules</title>
+     <title>Add &clsql; path and load module</title>
      <para>
        Unzip or untar the &clsql; distribution which creates a
        directory for the &clsql; files. Add that directory to &asdf;'s
        pushing the pathname of the directory onto this variable.  The
        following example code assumes the &clsql; files reside in the
        <filename>/usr/share/lisp/clsql/</filename> directory. You need
-       to load, at a minimum, the main <symbol>clsql</symbol> system
-       and at least one interface system. The below example show loading
-       all &clsql; systems.
+       to load the <symbol>clsql</symbol> system.
 
        <screen>
 (push #P"/usr/share/lisp/clsql/" asdf:*central-registry*)
-(asdf:operate 'asdf:load-op 'clsql-base)              ; base CLSQL package
-(asdf:operate 'asdf:load-op 'clsql-mysql)             ; MySQL interface
-(asdf:operate 'asdf:load-op 'clsql-postgresql)        ; PostgreSQL interface
-(asdf:operate 'asdf:load-op 'clsql-postgresql-socket) ; Socket PGSQL interface
-(asdf:operate 'asdf:load-op 'clsql-aodbc)             ; Allegro ODBC interface
 (asdf:operate 'asdf:load-op 'clsql)                   ; main CLSQL package
        </screen>
       </para>
     </sect2>
     
     <sect2>
-      <title>Run test suite</title>
+      <title>Run test suite (optional)</title>
       <para>
-       After loading &clsql;, you can execute the test suite. A
-       configuration file named
+       The test suite can be executed using the &asdf;
+       <symbol>test-op</symbol> operator. If &clsql; has not been
+       loaded with <symbol>asdf:load-op</symbol>, the
+       <symbol>asdf:test-op</symbol> operator will automatically load
+       &clsql;. A configuration file named
        <filename>.clsql-test.config</filename> must be created in
        your home directory. There are instructures on the format of
-       that file in the <filename>tests/tests.lisp</filename> file in
-       the &clsql; source directory. After creating that file, you
-       can run the test suite with &asdf;:
+       that file in the <filename>tests/README</filename>. After
+       creating <filename>.clsql-test.config</filename>, you can run
+       the test suite with &asdf;:
        <screen>
          (asdf:operate 'asdf:test-op 'clsql)
         </screen>