r8207: fix making libraries
[clsql.git] / doc / intro.xml
index b0a431ae217041c9a2ada89c0e84e71ee03dd471..facffa7f67dbf08ef4bd9ed09d0af93274a26f3e 100644 (file)
       <title>Ensure &asdf; is loaded</title>
       <para>
        Simply load the file <filename>asdf.lisp</filename>.
-       <programlisting>
+       <screen>
 (load "asdf.lisp")
-       </programlisting>
+       </screen>
       </para>
     </sect2>
     
        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
+       <filename>uffi/</filename> and <filename>db-mysql</filename>.
       </para>
       
-      <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>
+      <sect3>
+       <title>&mswindows;</title>
+       <para>
+         Files named <filename>Makefile.msvc</filename> are supplied
+         for building the libraries under Microsoft Windows.  Since
+         &mswindows; does not come with that compiler, compiled
+         <type>DLL</type> and <type>LIB</type> library files are
+         supplied with &clsql;.
+       </para>
+      </sect3>
+
+      <sect3>
+       <title>&unix;</title>
+       <para>
+         Files named <filename>Makefile</filename> are supplied for building the libraries
+         under &unix;. However, the <filename>.asd</filename> automatically invoke
+         the makefiles when necessary. So, manual building of the helper libraries
+         is not necessary on &unix;.
+       </para>
+      </sect3>
       
-      <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>
@@ -173,10 +174,10 @@ make libs
        The following example code assumes the &uffi; files reside in the
        <filename>/usr/share/lisp/uffi/</filename> 
        directory.
-       <programlisting>
+       <screen>
 (push #P"/usr/share/lisp/uffi/" asdf:*central-registry*)
-(asdf:oos 'asdf:load-op :uffi)
-       </programlisting>
+(asdf:operate 'asdf:load-op :uffi)
+       </screen>
       </para>
     </sect2>
    <sect2>
@@ -189,10 +190,10 @@ make libs
         The following example code assumes the cl-md5 files reside in the
        <filename>/usr/share/lisp/cl-md5/</filename> 
        directory.
-       <programlisting>
+       <screen>
 (push #P"/usr/share/lisp/cl-md5/" asdf:*central-registry*)
-(asdf:oos 'asdf:load-op :md5)
-       </programlisting>
+(asdf:operate 'asdf:load-op :md5)
+       </screen>
      </para>
    </sect2>
    
@@ -206,7 +207,7 @@ make libs
        <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>
+       <screen>
 (push #P"/usr/share/lisp/clsql/" asdf:*central-repository*)
 (asdf:operate 'asdf:load-op 'clsql-base)        ; base clsql package
 (asdf:operate 'asdf:load-op 'clsql-mysql)       ; MySQL interface
@@ -214,7 +215,7 @@ make libs
 (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
-       </programlisting>
+       </screen>
       </para>
     </sect2>
     
@@ -227,9 +228,9 @@ make libs
        in the <filename>tests/tests.lisp</filename> file in the &clsql;
        source directory. After creating that file, you can run the test suite
        with &asdf;:
-       <programlisting>
+       <screen>
          (asdf:operate 'asdf:test-op 'clsql)
-        </programlisting>.     .
+        </screen>
       </para>
     </sect2>