X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fintro.sgml;h=5f0b76b81fb91fc1f413a324b83574d6d99b0d3e;hb=027a7e4184689652fe762bf079e37b6a0e3c41ca;hp=25c672ea4429c990335d493de3aecac286b5b58e;hpb=01e78fad2d9c4c18f11ec032c80afa59212ba109;p=clsql.git

diff --git a/doc/intro.sgml b/doc/intro.sgml
index 25c672e..5f0b76b 100644
--- a/doc/intro.sgml
+++ b/doc/intro.sgml
@@ -60,7 +60,7 @@ of &clsql;.
 
     <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 +76,12 @@ 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.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>
 
@@ -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.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>
 
@@ -114,35 +113,38 @@ 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, a 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
+	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
@@ -155,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>