# -- CVS $Id: INSTALL,v 1.5 1996/05/04 21:06:04 aku Exp $
#

Installation and compilation instructions
with regard to the BlobX extension to TCL
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

o	This extension requires plain tcl, version 7.5 or
	higher.  If you don't have it installed, do this now.


o	This extension requires the extension Tcl-Blob,
	version 1.1 or higher.  If you don't have it installed,
	do this now.


o	That you are reading this text means, that you extracted
	the gzipped tar-archive in a directory of your choice.
	This operation should have created a subdirectory with
	the name 'blobX<version>'.  It is refered to as
	"source-directory" from now on.


o	'cd' into the source-directory, e.g. make it your working
	directory, then start the automatic setup by typing
	'configure'.

	See 'INSTALL.configure' for more information about
	'configure' (it's the unchanged file 'INSTALL' as part
	of the 'autoconf' package).


o	The configure script searches for tcl.h in the following
	places:

	-1	$(TCL_INCLUDE_DIR)
	-2	$(prefix)
	-3	/usr/local/include
	-4	/usr/include
	-5	../tcl7.5/generic
	-6	../tcl/generic
	-7	../tcl

	By default $(TCL_INCLUDE_DIR) is empty and $(prefix) points
	to the location of an installed 'tclsh' or is /usr/local if
	tclsh could not be found via $PATH.

	Use the following options to overide the defaults:

		--prefix=DIR		 	-> $(prefix)=DIR
		--with-tcl=DIR			-> $(TCL_INCLUDE_DIR)=DIR/include
		--with-tcl-include-dir=DIR	-> $(TCL_INCLUDE_DIR)=DIR


o	To find libtcl.a (libtcl.so.??) the paths

	-1	$(TCL_LIB_DIR)
	-2	$(exec_prefix)
	-3	/usr/local/include
	-4	/usr/include
	-5	$(srcdir)/../tcl7.5/unix
	-6	$(srcdir)/../tcl/unix
	-7	$(srcdir)/../tcl

	are searched. $(TCL_LIB_DIR) is empty by default, but
	can be set via --with-tcl or --with-tcl-lib-dir.

		--with-tcl=DIR		-> $(TCL_LIB_DIR)=DIR/lib
		--with-tcl-lib-dir=DIR	-> $(TCL_LIB_DIR)=DIR

	$(exec_prefix) contains the same value as $(prefix) by
	default, but can be set explicitly via --exec-prefix


o	The configure script searches for blob.h in the following
	places:

	-1	$(BLOB_INCLUDE_DIR)
	-2	$(prefix)
	-3	/usr/local/include
	-4	/usr/include
	-5	../blob1.1
	-6	../blob

	By default $(BLOB_INCLUDE_DIR) is empty and $(prefix) points
	to the location of an installed 'tclsh' or is /usr/local if
	tclsh could not be found via $PATH.

	Use the following options to overide the defaults:

		--prefix=DIR		 	-> $(prefix)=DIR
		--with-blob=DIR			-> $(BLOB_INCLUDE_DIR)=DIR/include
		--with-blob-include-dir=DIR	-> $(BLOB_INCLUDE_DIR)=DIR


o	To find libblob.a (libblob.so.??) the paths

	-1	$(BLOB_LIB_DIR)
	-2	$(exec_prefix)
	-3	/usr/local/include
	-4	/usr/include
	-5	$(srcdir)/../blob1.1
	-6	$(srcdir)/../blob

	are searched. $(BLOB_LIB_DIR) is empty by default, but
	can be set via --with-blob or --with-blob-lib-dir.

		--with-blob=DIR		-> $(BLOB_LIB_DIR)=DIR/lib
		--with-blob-lib-dir=DIR	-> $(BLOB_LIB_DIR)=DIR

	$(exec_prefix) contains the same value as $(prefix) by
	default, but can be set explicitly via --exec-prefix


o	The configure script searches for option.h in the following
	places:

	-1	$(OPTION_INCLUDE_DIR)
	-2	$(prefix)
	-3	/usr/local/include
	-4	/usr/include
	-5	../option1.1
	-6	../option

	By default $(OPTION_INCLUDE_DIR) is empty and $(prefix) points
	to the location of an installed 'tclsh' or is /usr/local if
	tclsh could not be found via $PATH.

	Use the following options to overide the defaults:

		--prefix=DIR		 	-> $(prefix)=DIR
		--with-option=DIR		-> $(OPTION_INCLUDE_DIR)=DIR/include
		--with-option-include-dir=DIR	-> $(OPTION_INCLUDE_DIR)=DIR


o	To find liboption.a (liboption.so.??) the paths

	-1	$(OPTION_LIB_DIR)
	-2	$(exec_prefix)
	-3	/usr/local/include
	-4	/usr/include
	-5	$(srcdir)/../option1.1
	-6	$(srcdir)/../option

	are searched. $(OPTION_LIB_DIR) is empty by default, but
	can be set via --with-option or --with-option-lib-dir.

		--with-option=DIR		-> $(OPTION_LIB_DIR)=DIR/lib
		--with-option-lib-dir=DIR	-> $(OPTION_LIB_DIR)=DIR

	$(exec_prefix) contains the same value as $(prefix) by
	default, but can be set explicitly via --exec-prefix


o	Another notable configure option is --enable-shared whose
	appearance commands the script to configure the Makefile
	for creation of shared libraries (as required for dynamic
	loading).


o	Now start the compilation by typing 'make'.
	The makefile will then check number and names of the files
	in the package, generate dependency information, compile
	them and at last build the library.

	The tool 'get-manifest' used during file check requires /tmp.


o	To check the extension, type 'make test' or 'make check'.
	This will build a tclsh containing just tcl, blobX, blob and
	then runs some test-scripts checking the behaviour of the
	created library.


o	At last type 'make install' to install library and header.


o	To install a tclsh containing just tcl, blobX and blob type
	'make install-bin'.  With the advent of dynamic loading this
	should not be necessary anymore.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Enjoy
	Andreas Kupries (aku@kisters.de)
