X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;ds=inline;f=doc%2Fintro.sgml;h=5f0b76b81fb91fc1f413a324b83574d6d99b0d3e;hb=bee8d8430248df571c743f07f2fbc80d369394b4;hp=7c8c2277642c20f916ef580b58c331395e3e8812;hpb=17c4d99ca97dbdec882028929d645e16164b4b0b;p=clsql.git
diff --git a/doc/intro.sgml b/doc/intro.sgml
index 7c8c227..5f0b76b 100644
--- 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.
-
- XPTest (optional)
- 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 site.
-This package is not required except if you wish to run the &clsql;
-test suite.
-
-
Supported Common Lisp Implementation
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:
- &acl; v6.1 on Redhat Linux 7.2 and Microsoft Windows.
- &lw; v4.2 on Redhat Linux 7.2 and Microsoft Windows.
- &cmucl; 18d on Redhat Linux 7.2.
+ &acl; v6.1 on Redhat Linux 7.2, FreeBSD 4.5, and Microsoft Windows XP.
+ &lw; v4.2 on Redhat Linux 7.2 and Microsoft Windows XP.
+ &cmucl; 18d-pre on Redhat Linux 7.2, FreeBSD 4.5, and Solaris 2.8.
@@ -102,9 +91,9 @@ the following implementations are supported:
Currently, &clsql; supports the following databases:
- &mysql; v3.23.49 on Redhat Linux 7.2 and Microsoft Windows.
- &postgresql; v7.1 on Redhat Linux 7.2. Support for both direct API connections and TCP socket connections.
- Allegro's ODBC interface (&aodbc;) on Redhat Linux 7.2 and Microsoft Windows.
+ &mysql; v3.23.49.
+ &postgresql; v7.2 with both direct API and TCP socket connections.
+ Allegro's ODBC interface (&aodbc;) using iODBC ODBC manager.
@@ -139,7 +128,10 @@ files for Microsoft Windows are supplied with the distribution.
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
interfaces/mysql/Makefile 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
make libs
@@ -152,7 +144,7 @@ in the root directory of &clsql; to build the libraries
Load &uffi;
- 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 mk:*central-registry*.
You can do that by either pushing the pathname of the directory onto this variable, or
use the new add-registry-location present in the newest versions of
@@ -165,6 +157,39 @@ use the new add-registry-location present in the newest ver
+
+ Load &clsql; modules
+
+ Unzip or untar the &clsql; distribution which creates a directory
+for the &clsql; files. Add that directory to Defsystem's mk:*central-registry*.
+You can do that by either pushing the pathname of the directory onto this variable, or
+use the new add-registry-location present in the newest versions of
+&defsystem;. The following example code assumes the &clsql; files reside in the
+/usr/local/src/lisp/clsql directory. You need to load, at a minimum,
+the main :clsql system and at least one interface system.
+
+(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
+
+
+
+
+
+ Run test suite
+
+ After loading &clsql;, you can execute the test program in
+the directory ./test-suite. The test file,
+tester-clsql
+has instructions for creating a test.config.
+After creating that file, simple load the test file with Lisp
+and the tests should automatically execute.
+
+
+