Installing Clean
================

By default the Clean system is installed in the current directory.
You can override these defaults by changing INSTALL_BIN_DIR,
INSTALL_LIB_DIR, INSTALL_MAN_DIR in the Makefile.

To install the Clean system *without* the Clean IO interface type:

	% make

To install the Clean system *with* the Clean IO interface,
first check the variable OPENWINHOME. It should point to the
directory where OpenLook is installed on your system. Then type:

	% make io

To use the Clean IO interface, you need X-windows with the
OpenLook(tm) ToolKit or the Xview ToolKit.

* Warning *
There are several problems with the X windows implementation
of the Clean IO library. We regret that we currently cannot
support it.

Using Clean
===========

To compile Clean programs you use the command 'clm'. The manual
page for clm provides more information.

For the IO demos you should use the '-sl' flag to specify a
link options file. There are four flavours:

	'-sl x' (or '-sl xv')	# Xview toolkit, dynamically linked
	'-sl xs' (or '-sl xvs')	# Xview toolkit, statically linked
	'-sl olit'				# Open Look toolkit, dynamically linked
	'-sl olits'				# Open Look toolkit, statically linked

On some systems (Solaris) you must set the environment variable
LD_LIBRARY_PATH before you run a Clean IO program. The variable
should point to the directories where the toolkit and Clean
libraries can be found. For example:

	% export LD_LIBRARY_PATH=/usr/openwin/lib:/home/jane/clean/iolib

or
	% setenv LD_LIBRARY_PATH /usr/openwin/lib:/home/jane/clean/iolib

depending on the shell you use. If you forget to do this you'll get
the message:

	ld.so.1: ./worm: fatal: libCleanIO.so: can't open file: errno=2

or something similar.
	

Compiling the example programs
==============================

The directory 'examples' contains small Clean programs. The
directory 'iodemos' contains a number of IO programs. Both
directories contain a Makefile to compile the demos.

General Info
============

Bug reports, questions and suggestions are welcome. Please send
them to:

	mailto:clean@cs.kun.nl

The Clean Software is distributed via ftp:

	ftp://ftp.cs.kun.nl//pub/Clean
	
More information about Clean is also available on the World Wide Web:

	http://www.cs.kun.nl/~clean

Versions of Concurrent Clean are available for several platforms. 

