# -------------------------------------------------------------------
# Installation instructions for Tcl-GDBI
# 
# http://www.binaryevolution.com/~tdarugar/
# 
# $Id: INSTALL.txt,v 1.7 1999/05/17 23:20:13 tdarugar Exp $
# -------------------------------------------------------------------


Requirements:
------------
 - tcl 8.x
 - mysql database with development libraries

# ===================================================================

Installation:
------------
You may need to compile the shared object for your operating
system. Look for a file named sql.yourOperatingSystem.so in
the distribution (eg. sql.solaris.so). If it's there, rename 
it sql.so and go to step 4. The default sql.so that comes with
the package is for linux.

If the appropriate sql.so is not there, peform the following 
steps:

Step 1: Unpack the files:
------------------------

gzip -dc tcl-sql-xxx.tgz | tar xvf -

Step 2: Modify Makefile:
-----------------------

Edit the makefile, setting the paths and options as appropriate.
You'll need to give yourself write permissions:
chmod +w Makefile

Step 3: Compile:
---------------

make clean ; make

Step 4: Test:
------------

In the tcl-sql directory, try loading the extention:
tclsh
load ./sql.so

The extention should load without complaints.

Step 5: More tests:
-------------------

Try the test files in the 'tests' directory:

cd tests
tclsh8.0 multi_conn.test > output
diff output multi_conn.test.out

This should ideally produce nothing, but may result in slightly
different results depending on your platform and version of MySQL.

Repeat for multi_query.test and stuff.test .

Step 6: Install:
---------------

Copy the 'sql1.0' directory and its contents to the location of 
your tcl packages.

Typical locations to copy to:

On Redhat linux:	/usr/lib/tcl8.0
Other unix:		/usr/local/lib/tcl8.0

You can also do something like:

cd /usr/lib/tcl8.0
ln -s /path/to/tcl-sql/sql1.0

Step 7: Test the package:
-------------------------

Try the package by starting up the tcl shell and loading the package:

cd /tmp
tclsh8.0
package require sql

You should see the result '1.0'.