r1798: Initial support for pooled connections

[clsql.git] / doc / intro.sgml

diff --git a/doc/intro.sgml b/doc/intro.sgml
index 7c8c2277642c20f916ef580b58c331395e3e8812..5f0b76b81fb91fc1f413a324b83574d6d99b0d3e 100644 (file)
--- a/doc/intro.sgml
+++ b/doc/intro.sgml
@@ -72,27 +72,16 @@ are zip files for Microsoft Windows systems and gzipped tar files for
 other systems.</para>
     </sect2>
 
-    <sect2>
-      <title>XPTest (optional)</title>
-      <para>The test suite for &clsql; uses the onShore Development's
-XPTest package. onShore has graciously put the package in the public
-domain. You can download the package from onShore's web <ulink
-url="http://alpha.onshored.com/lisp-software/"><citetitle>site</citetitle></ulink>.
-This package is not required except if you wish to run the &clsql;
-test suite.</para>
-    </sect2>
-
     <sect2>
       <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.1 on Redhat Linux 7.2, FreeBSD 4.5, and Microsoft Windows XP.</para></listitem>
+       <listitem><para>&lw; v4.2 on Redhat Linux 7.2 and Microsoft Windows XP.</para></listitem>
+       <listitem><para>&cmucl; 18d-pre on Redhat Linux 7.2, FreeBSD 4.5, and Solaris 2.8.</para></listitem>
       </itemizedlist>
     </sect2>
 
@@ -102,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.49.</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>
 
@@ -139,7 +128,10 @@ files for Microsoft Windows are supplied with the distribution.</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. Then, you can give the command
+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>
@@ -152,7 +144,7 @@ in the root directory of &clsql; to build the libraries
     <sect2>
       <title>Load &uffi;</title>
       <para>
-       Unpack the appropriate &uffi; version for your system which creates a directory
+       Unzip or untar the &uffi; distribution 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
@@ -165,6 +157,39 @@ use the new <function>add-registry-location</function> present in the newest ver
       </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>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 &clsql; files reside in the
+<filename>/usr/local/src/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/clsql")
+(mk:load-system :clsql)              ; main clsql package
+(mk:load-system :clsql-mysql)       ; MySQL interface
+(mk:load-system :clsql-postgresql)  ; PostgreSQL interface
+(mk:load-system :clsql-postgresql-socket) ; Socket PGSQL interface
+(mk:load-system :clsql-aodbc)       ; Allegro ODBC interface
+        </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>