
This is INSTALL for $__lastrelease$

It describes how to build and install CooL on your computer. Please
read the file "LICENSE" before installing and using the CooL-SPE on
your machine.


The build/installation procedure
=================================

The first time you call "make" in this directory (the root directory
of the CooL-SPE source tree), make invokes a configuration script
asking you a few questions about the environment where ShapeTools is
to be built and installed. You will be asked for:

- the operation system of your machine.
	See the following section for a list of supported operating
	system platforms.
- the hosttype of your machine.
	See the following section for a list of supported hosttypes.
- the object file format 
	See the following section for a list of supported object file
	formats. 
- the c compiler
	See the following section for a list of supported c compilers.
- the compiler and compile flags to be used.
- whether the emacs lisp code shall be compiled and installed.
	This is *very* recommendable if you are an emacs user.
- the locations, where executables, libraries and manuals shall be
	installed. Below in this file, you will also find some words
	about installation locations.

Subsequent calls of "make" will not run the configuration script
again automatically. Type

	make config	to run the script again and change the
			configuration of the build/install procedure

	make		to build CooL
	make install	to install the commands, libraries and manuals
	make clean	to clean up


Important Hints
================

When modifying the Makefile manually, make sure to keep at least one
whitespace between equal sign and value in macro definitions. The
configuration script expects this.


Supported Operating System Platforms
=====================================

Our current development platform is Sinix 5.41. We ported to and
tested CooL to a certain number of other machines. This is the
complete list of supported operating system platforms:

	System V Release 4 (tested on a '386 system with Sinix 5.41)
	Linux 
	Solaris 2 (tested on SUN 10 with Solaris 2.3)

??? For installing CooL on machines with other operating systems
see the section about porting to other system platforms below. ???



Supported Hosttypes
====================

Our current development hosttype Intel 486. We ported to and
tested CooL to a certain number of other machines. This is the
complete list of supported hosttypes:

	Intel 486
	SPARC 10
	MIPS R3000

??? For installing CooL on machines with other hosttypes
see the section about porting to other system platforms below. ???



Supported Object file formats
==============================

Our current development object file format is elf. We ported to and
tested CooL to a certain number of other machines. This is the
complete list of supported object file formats:

	elf
	coff

??? For installing CooL on machines with other object file formats
see the section about porting to other system platforms below. ???



Supported C Compilers
======================

Our current development c compiler is gcc. We ported to and
tested CooL to a certain number of other machines. This is the
complete list of supported c compilers:

	gcc
	AT&T
	CES

??? For installing CooL on machines with other c compilers
see the section about porting to other system platforms below. ???


Installation Locations
=======================

CooL is a pretty large package, consisting of executable commands,
manual pages and a set of different libraries. We recommend the
following installation tree:

	.../bin			commands
	.../man/man1		manuals
	.../include		include files
	.../lib			C-libraries
	.../lib/emacs/lisp	emacs lisp code (optional)

If you agree on this setup, you just have to set the installation
base path (...) during the CooL configuration phase. If not, you
may set the path for each group individually.


Needed Disk Space
==================

The following table shows the amount of disk space approximately
needed when compiling and installing the CooL-SPE. The values are
determined on an Intel-PC with Sinix 5.41 and may be different
on your machine.

Distribution	???.? MB (compressed)
		???.? MB (unpacked)

Compilation 	???.? MB (stripped)    ???.? MB (with debug info)
		
Installation
 - base system	???.? MB (stripped)    ???.? MB (with debug info)
 - OIs		???.? MB (   "    )    ???.? MB (       "       )
 - emacs stuff	???.? MB (   "    )    ???.? MB (       "       )


Porting CooL to other Operating System Platforms
=======================================================

??? For compiling, configure the top Makefile using 'make config' and
choose the default system (svr_4). After that, edit the Makefile and
change the switch in the 'CFLAGS' definition to
'-D<your_system_name>'. ???

If you have successfully ported CooL to another system, please let us
know. We would like to receive a diff-file documenting your
changes. This should help us to enlarge the set of CooL standard
system platforms.

If you have any problems, drop a mail to: ???
