r3083: add scl support
[clsql.git] / doc / intro.sgml
index 25c672ea4429c990335d493de3aecac286b5b58e..99bad1e5d394bbb972d1502a4d6dcdaa97f30f4f 100644 (file)
@@ -37,6 +37,9 @@ are:
 <listitem>
 <para>improved packages and symbol export.</para>
 </listitem>
+<listitem>
+<para>transaction support.</para>
+</listitem>
 </itemizedlist>
     </para>
   </sect1>
@@ -46,21 +49,15 @@ are:
 
     <sect2>
       <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> 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
-<ulink
-url="ftp://ftp.med-info.com/pub/defsystem/"><citetitle>site</citetitle></ulink>
-of &clsql;.
+      <para> &clsql; uses &asdf; to compile and load its
+components.  &asdf; is included in the <ulink
+url="http://cclan.sourceforge.net"><citetitle>&cclan;</citetitle></ulink> collection.
       </para>
     </sect2>
 
     <sect2>
       <title>&uffi;</title>
-      <para> &clsql; uses <ulink
+      <para>&clsql; uses <ulink
 url="http://uffi.med-info.com/"><citetitle>&uffi;</citetitle></ulink>
 as a <emphasis>Foreign Function Interface</emphasis> (<glossterm
 linkend="gloss-ffi">FFI</glossterm>) to support multiple &cl;
@@ -76,13 +73,15 @@ other systems.</para>
       <title>Supported Common Lisp Implementation</title>
       <para>
 The implementations that support &clsql; is governed by the supported
-implementations of &uffi;. At the time of the initial release of &clsql;,
-the following implementations are supported:
+implementations of &uffi;. The following implementations are supported:
       </para>
       <itemizedlist mark="opencircle">
-       <listitem><para>&acl; v6.1 on Redhat Linux 7.2 and Microsoft Windows.</para></listitem>
-       <listitem><para>&lw; v4.2 on Redhat Linux 7.2 and Microsoft Windows.</para></listitem>
-       <listitem><para>&cmucl; 18d on Redhat Linux 7.2.</para></listitem>
+       <listitem><para>&acl; v6.2 on Debian Linux, FreeBSD 4.5, and Microsoft Windows XP.</para></listitem>
+       <listitem><para>&lw; v4.2 on Debian Linux and Microsoft Windows XP.</para></listitem>
+       <listitem><para>&cmucl; 18d on Debian Linux, FreeBSD 4.5, and Solaris 2.8.</para></listitem>
+       <listitem><para>&sbcl; 0.7.8 on Debian Linux.</para></listitem>
+       <listitem><para>&scl; 1.1 on Debian Linux.</para></listitem>
+       <listitem><para>&openmcl; 0.13 on Debian Linux PowerPC.</para></listitem>
       </itemizedlist>
     </sect2>
 
@@ -92,9 +91,9 @@ the following implementations are supported:
        Currently, &clsql; supports the following databases:
       </para>
       <itemizedlist mark="opencircle">
-       <listitem><para>&mysql; v3.23.49 on Redhat Linux 7.2 and Microsoft Windows.</para></listitem>
-       <listitem><para>&postgresql; v7.1 on Redhat Linux 7.2. Support for both direct API connections and TCP socket connections.</para></listitem>
-       <listitem><para>Allegro's ODBC interface (&aodbc;) on Redhat Linux 7.2 and Microsoft Windows.</para></listitem>
+       <listitem><para>&mysql; v3.23.51.</para></listitem>
+       <listitem><para>&postgresql; v7.2 with both direct API and TCP socket connections.</para></listitem>
+       <listitem><para>Allegro's ODBC interface (&aodbc;) using iODBC ODBC manager.</para></listitem>
       </itemizedlist>
     </sect2>
 
@@ -114,47 +113,82 @@ the following implementations are supported:
     </sect2>
 
     <sect2>
-      <title>Build <filename>clsql-mysql</filename> helper library</title>
-      <para>&mysql; uses functions that require 64-bit integer
+      <title>Build &c; helper libraries</title>
+      <para>&clsql; uses functions that require 64-bit integer
 parameters and return values. The &ffi; in most &clsql;
-implementations do not support 64-bit integers. Thus, C helper
-library is required to break these 64-bit integers into two compatible
+implementations do not support 64-bit integers. Thus, C helper
+libraries are required to break these 64-bit integers into two compatible
 32-bit integers.</para>
 
-<para><filename>Makefile</filename>'s for Microsoft Windows and GNU/Solaris systems
-are supplied to build this library. In addition, the <type>DLL</type> and <type>LIB</type>
+<para>Makefiles for Microsoft Windows and GNU/Solaris systems
+are supplied to build the libraries. Since many Microsoft Windows
+users don't have access to a compiler, the <type>DLL</type> and <type>LIB</type>
 files for Microsoft Windows are supplied with the distribution.</para>
 
-<para>To build the library, first move to the directory
-<filename>interfaces/mysql</filename> directory. You may need to
-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>
+<para>To build the libraries on a GNU or Solaris, use the shell and
+change to the root directory of &clsql;. You may need to edit the file
+<filename>interfaces/mysql/Makefile</filename> to specify the location of your
+MySQL installation. The default Makefiles are setup for shared library
+linking on Linux. If you are using FreeBSD or Solaris, you will need
+to change the linker setting as instructed in the Makefile. 
+Then, you can give the command
+<programlisting>
+make libs
+</programlisting>
+in the root directory of &clsql; to build the libraries 
+<filename>interfaces/mysql/clsql-mysql.so</filename> and
+<filename>interfaces/clsql-uffi/clsql-uffi.so</filename>.
+</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'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 following example code assumes the &uffi; files reside in the
-<filename>/usr/local/src/lisp/uffi</filename> directory.
+       Unzip or untar the &uffi; distribution which creates a directory
+for the &uffi; files. Add that directory to Defsystem's <varname>asdf:*central-registry*</varname>.
+You can do that by pushing the pathname of the directory onto this variable.
+ The following example code assumes the &uffi; files reside in the
+<filename>/usr/share/lisp/uffi/</filename> directory.
+       <programlisting>
+(push #P"/usr/share/lisp/uffi/" asdf:*central-repository*)
+(asdf:oos 'asdf:load-op :uffi)
+        </programlisting>
+      </para>
+    </sect2>
+
+    <sect2>
+      <title>Load &clsql; modules</title>
+      <para>
+       Unzip or untar the &clsql; distribution which creates a directory
+for the &clsql; files. Add that directory to Defsystem's <varname>asdf:*central-registry*</varname>.
+You can do that by 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.
        <programlisting>
-(mk:add-registry-location #P"/usr/local/src/lisp/uffi")
-(mk:load-system :uffi)
+(push #P"/usr/share/lisp/clsql/" asdf:*central-repository*)
+(asdf:oos 'asdf:load-op :clsql-base)        ; base clsql package
+(asdf:oos 'asdf:load-op :clsql-mysql)       ; MySQL interface
+(asdf:oos 'asdf:load-op :clsql-postgresql)  ; PostgreSQL interface
+(asdf:oos 'asdf:load-op :clsql-postgresql-socket) ; Socket PGSQL interface
+(asdf:oos 'asdf:load-op :clsql-aodbc)       ; Allegro ODBC interface
+(asdf:oos 'asdf:load-op :clsql)             ; main clsql package
         </programlisting>
       </para>
     </sect2>
 
+    <sect2>
+      <title>Run test suite</title>
+      <para>
+       After loading &clsql;, you can execute the test program in
+the directory <filename>./test-suite</filename>. The test file,
+<filename>tester-clsql</filename>
+has instructions for creating a <filename>test.config</filename>.
+After creating that file, simple load the test file with Lisp
+and the tests should automatically execute.
+      </para>
+    </sect2>
+
   </sect1>
 
 </chapter>