X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fintro.xml;h=facffa7f67dbf08ef4bd9ed09d0af93274a26f3e;hb=bd57425b302d5c2e52732545f3f354a2f5f471cf;hp=ac54ec4e866c6e5a45a11a97d556719cfabb8463;hpb=a35619ce17c910796b4f6f58c5916f8f513073e1;p=clsql.git
diff --git a/doc/intro.xml b/doc/intro.xml
index ac54ec4..facffa7 100644
--- a/doc/intro.xml
+++ b/doc/intro.xml
@@ -1,4 +1,4 @@
-
+
@@ -58,7 +58,7 @@
Prerequisites
- &defsystem;
+ &asdf;
&clsql; uses &asdf; to compile and load its
components. &asdf; is included in the &cclan; collection.
@@ -123,12 +123,12 @@
Installation
- Ensure &defsystem; is loaded
+ Ensure &asdf; is loaded
- Simply load the file defsystem.lisp.
-
-(load "defsystem.lisp")
-
+ Simply load the file asdf.lisp.
+
+(load "asdf.lisp")
+
@@ -138,45 +138,46 @@
parameters and return values. The &ffi; in most &clsql;
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.
+ 32-bit integers. The helper libraries reside in the directories
+ uffi/ and db-mysql.
- 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 DLL and LIB
- files for Microsoft Windows are supplied with the distribution.
-
+
+ &mswindows;
+
+ Files named Makefile.msvc are supplied
+ for building the libraries under Microsoft Windows. Since
+ &mswindows; does not come with that compiler, compiled
+ DLL and LIB library files are
+ supplied with &clsql;.
+
+
+
+
+ &unix;
+
+ Files named Makefile are supplied for building the libraries
+ under &unix;. However, the .asd automatically invoke
+ the makefiles when necessary. So, manual building of the helper libraries
+ is not necessary on &unix;.
+
+
- 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. 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
-
- in the root directory of &clsql; to build the libraries
- interfaces/mysql/clsql-mysql.so
- and interfaces/clsql-uffi/clsql-uffi.so.
-
Load &uffi;
Unzip or untar the &uffi; distribution which creates a directory
- for the &uffi; files. Add that directory to Defsystem's asdf:*central-registry*.
+ for the &uffi; files. Add that directory to &asdf;'s asdf:*central-registry*.
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
/usr/share/lisp/uffi/
directory.
-
+
(push #P"/usr/share/lisp/uffi/" asdf:*central-registry*)
-(asdf:oos 'asdf:load-op :uffi)
-
+(asdf:operate 'asdf:load-op :uffi)
+
@@ -184,15 +185,15 @@ make libs
If you plan to use the clsql-postgresql-socket interface, you must load the md5 module.
Unzip or untar the cl-md5 distribution, which creates a directory for the cl-md5 files.
- Add that directory to Defsystem's asdf:*central-registry*.
+ Add that directory to &asdf;'s asdf:*central-registry*.
You can do that by pushing the pathname of the directory onto this variable.
The following example code assumes the cl-md5 files reside in the
/usr/share/lisp/cl-md5/
directory.
-
+
(push #P"/usr/share/lisp/cl-md5/" asdf:*central-registry*)
-(asdf:oos 'asdf:load-op :md5)
-
+(asdf:operate 'asdf:load-op :md5)
+
@@ -200,36 +201,40 @@ make libs
Load &clsql; modules
Unzip or untar the &clsql; distribution which creates a directory
- for the &clsql; files. Add that directory to Defsystem's asdf:*central-registry*.
+ for the &clsql; files. Add that directory to &asdf;'s asdf:*central-registry*.
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
/usr/share/lisp/clsql/
directory. You need to load, at a minimum,
the main :clsql system and at least one interface system.
-
+
(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
-
+(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
+
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.
+ After loading &clsql;, you can execute the test suite. A configuration
+ file named .clsql-test.config must be created
+ in your home directory. There are instructures on the format of that file
+ in the tests/tests.lisp file in the &clsql;
+ source directory. After creating that file, you can run the test suite
+ with &asdf;:
+
+ (asdf:operate 'asdf:test-op 'clsql)
+
-
+
+