TclBlend
SCCS: @(#) README.tclblend 1.3 97/10/21 11:17:53

This is the directory where you configure, compile, test, and install 
UNIX versions TclBlend.  This directory also contains source files for 
TclBlend that are specific to UNIX.

The rest of this file contains instructions on how to do this.  The 
release should compile and run either "out of the box" or with trivial 
changes on any UNIX-like system that approximates POSIX, BSD, or 
System V.  We know that it runs on workstations from Sun.  To compile 
for a PC running Windows, see the README file in the directory ../win.


How To Install TclBlend (Binary Release Only):
----------------------------------------------

(a) You must have Tcl version 8.0 installed and compilied as a shared library.
    See the corresponding unix/README where you have Tcl8.0 installed for 
    information on how to do this.

(b) The environment variable LD_LIBRARY_PATH must contain a path that 
    points to this directory, as well as the Tcl8.0 unix directory.

(c) The environment variable CLASSPATH must contain a path to the Java 
    jar file, tclblend.zip.  On some versions of UNIX this can be done 
    by typing "setenv CLASSPATH ${CLASSPATH}:/home/user/tclblend1.0a1/tclblend.zip".

(d) TclBlend is a dynamically loaded module.  To add the TclBlend functions
    to the interperter, run tclsh from this directory, and type 
    "lappend auto_path [pwd]" followed by "package require java".  At this 
    point, TclBlend is ready to be used.


How To Compile And Install TclBlend (Source Release Only):
----------------------------------------------------------

(a) You must have Tcl version 8.0 installed and compilied as a shared library.
    See the corresponding unix/README where you have Tcl8.0 installed for 
    information on how to do this.

(b) Check for patches as described in ../README.

(c) If you have already compiled TclBlend once in this directory and are now
    preparing to compile again in the same directory but for a different
    platform, or if you have applied patches, type "make distclean" to
    discard all the configuration information computed previously.

(d) If the make fails then you'll have to personalize the Makefile
    for your site or possibly modify the distribution in other ways.
    If you need to modify Makefile, there are comments at the beginning 
    of it that describe the things you might want to change and how to 
    change them.

(e) Type "./configure --enable-shared".  This runs a configuration script 
    created by GNU autoconf, which configures TclBlend for your system 
    and creates a Makefile.  The configure script allows you to customize 
    the Tcl configuration for your site; for details on how you can do 
    this, type "./configure -help" or refer to the autoconf documentation 
    (not included here).  TclBlend's "configure" supports the following 
    special switches in addition to the standard ones:
	--with-tcl		Tcl8.0 is assumed to be installed in 
				../../tcl8.0.  If this is not true, then 
				use this switch to specify an absolute
				path to the location of the Tcl base. 
	--with-java		The configure script will attempt to locate
				where the Java JDK is installed.  If it 
				cannot locate the JDK, or an alternative 
				JDK needs to be specified, use this switch,
				followed by an absolute path to the correct 
				directory.
	--enable-gcc		If this switch is set, Tcl will configure
				itself to use gcc if it is available on your
				system.  Note:  it is not safe to modify the
				Makefile to use gcc after configure is run;
				if you do this, then information related to
				dynamic linking will be incorrect.
	--enable-shared		If this switch is specified, Tcl will compile
				itself as a shared library if it can figure
				out how to do that on this platform.

(f) Type "make".  This will create a library archive called "libtclblend.a" 
    or "libtclblend.so", as well as a directory called tclblend that contains 
    all of the Java class files.

(g) The environment variable LD_LIBRARY_PATH must contain a path that 
    points to this directory, as well as the Tcl8.0 unix directory.

(h) The environment variable CLASSPATH must contain a path to the Java 
    classfiles.  These will be located in the ./tclblend/ directory of this
    directory, after completion of the build.

(i) TclBlend is a dynamically loaded module.  To add the TclBlend functions
    to the interperter, run tclsh from this directory, and type 
    "lappend auto_path [pwd]" followed by "package require java".  At this 
    point, TclBlend is ready to be used.


Test suite
----------

There is a relatively complete test suite for all of the Tcl core in the 
subdirectory "tests".  To use it just type "make test" in this directory.  You
should then see a printout of the test files processed.  If any errors occur, 
you'll see a much more substantial printout for each error.  See the README 
file in the "tests" directory for more information on the test suite.  Note: 
don't run the tests as superuser: this will cause several of them to 
fail.

