
                                     
                 OCamlMySQL -- MySQL access for OCaml
                 *************************************
                              Shawn Wagner
                           shawnw@speakeasy.org
                    http://raevnos.pennmush.org/ocaml/
                    ===============================
                         Based on a release by:
                            Christian Lindig
                           lindig@eecs.harvard.edu
                     http://www.eecs.harvard.edu/~lindig 
                   ==================================
                                    
  
  ocaml-mysql is a package for ocaml that provides access to mysql 
databases. It consists of low level functions implemented in C and a
module Mysql intended for application development. 
  

1  Building
*=*=*=*=*=*

  
  Compiling this package from sources requires the following software to
be installed on your system:
  
   
 1. ocaml 3.06 or above including C header files.  
 2. findlib  
 3. The mysql client library and header files.  
 4. An ANSI C compiler like gcc.
  
  A configure script is provided which should help to find the
particular files. In case configure fails, edit the setting in the
config file directly. This also applies when the C compiler fails to
find some include file. However, you should first try the obvious:
               
              <<
                    % ./configure
                    % make
                    % make opt
                    % make install
              >>
  
  This creates the mysql libraries, and a toplevel called mysqltop. 
  
2  Trouble Shooting
*=*=*=*=*=*=*=*=*=*

  
  If compilation fails this is most probably because include or library
files were not found. The configure looks in a number of places but may
fail to find the files on your system. In case you have GNU Autoconf
installed you can take a look at the configure.in and add more
directories to search: 
               
              <<
                AC_CHECKING(for MySQL header files)
                dnl
                dirs="/usr/local/include
                      /usr/local/mysql/include
                      /usr/include
                      /usr/include/mysql"
              >>
  
  Do not forget to create a new configure script by invoking autoconf.
Please send a patch back to the author.
  

3  Installation
*=*=*=*=*=*=*=*

  
  Running make install will use findlib to install the library, and put
the mysqltop top-level in /usr/local/bin or wherever else ./configure
thinks it should go.
  

4  Documentation
*=*=*=*=*=*=*=*=

   
   Check the interface files, or doc/index.html.
  Reading the mysql documentation should help, too.
  A small demo demo.ml is provided. You can try it in the mysqltop ocaml
interpreter that make all should have built. 
  

5  Copying
*=*=*=*=*=

  
  You are encouraged to distribute this code under certain terms:
                Copyright  2001 - 2003 Shawn Wagner
              shawnw@speakeasy.org.  Copyright  1998, 1999 Christian
              Lindig lindig@gaertner.de.  . All rights reserved.
              Redistribution and use in source and binary forms, with or
              without  modification, are permitted provided that the
              following conditions  are met:
              
                 
               1. Redistributions of source code must retain the above
                 copyright  notice, this list of conditions and the
                 following disclaimer.
               
               2. Redistributions in binary form must reproduce the
                 above  copyright notice, this list of conditions and
                 the following  disclaimer in the documentation and/or
                 other materials  provided with the distribution.  
              
              This software is provided ``as is'' and any express or 
              implied warranties, including, but not limited to, the
              implied  warranties of merchantability and fitness for a
              particular purpose  are disclaimed. In no event shall the
              author and copyright holder  be liable for any direct,
              indirect, incidental, special,  exemplary, or
              consequential damages (including, but not limited  to,
              procurement of substitute goods or services; loss of use, 
              data, or profits; or business interruption) however caused
              and on  any theory of liability, whether in contract,
              strict liability, or  tort (including negligence or
              otherwise) arising in any way out of  the use of this
              software, even if advised of the possibility of  such
              damage.
