The Concurrent Clean System (version 1.1) for OS/2
================================================== 


Contents
========

The Clean OS/2 package contains the following files:

README          this file.

LICENSE		license.

Clean1.1.zip    contains the Clean binaries, libraries and example files.
                Unpacking creates the directory 'Clean1.1'.


Installation
============

To use the Clean system under OS/2 you need:

-   A HPFS partition on your machine. If you don't have a HPFS
    partition, you have to format (part of) your disk(s).
    See the OS/2 manuals how to create a HPFS partition.

-   The file Clean1.1.zip.

-   An unpacking utility called 'unzip.exe' (see below).

-   OS/2 system disks or cd-rom if you haven't installed link386.exe
    and rc.exe.


To install the Clean system:

-   Install link386.exe and rc.exe if these files are not installed. These
    files are an optional part of OS/2. You can find out if these are
    installed by typing link386 and rc in an OS/2 window or by looking inside
    the os2 folder. You can install the files by running the 'Selective
    Install' program in the System Setup folder, select 'Ok', then select
    'Optional System Utilities', then 'More' to the right of 'Optional
    System Utilities', then select 'Link Object Modules', then 'Ok' and
    finally 'Install'.

-   Move the file 'Clean1.1.zip' to the directory in which you want to
    install Clean. Unpack the zip files with the unzip command. This will
    create the directory 'Clean1.1'.

-   Edit the file 'Clean1.1\lib\d.lo', change the first line into the full
    path name of the file 'cleanlib.lib' in the folder 'Clean1.1\lib' and
    save the file. Also edit the file 'Clean1.1\lib\s.lo', change the first
    line into the full path name of the file 'os2interface.lib' in the folder
    'Clean1.1\lib'.

-   Edit the 'config.sys' file of OS/2.
    - If you have used previous versions of Clean remove the files beginning
      with 'SET CLEANLIB=' and 'SET CLEANPATH='.
    - Add the directory 'Clean1.1\dll' after LIBPATH. For example if you
      install Clean in the directory 'd:\' add ';d:\Clean1.1\dll' at the end
      of the line beginning with 'LIBPATH='. Or move the file 'cleanlib.dll'
      in the directory 'Clean1.1\lib' to one of the directories mentioned in
      the LIBPATH line.
    - Add the directory 'Clean1.1\bin' to the PATH variable. For example if
      you install Clean in the directory 'd:\' add ';d:\Clean1.1\bin' at the
      end of the line beginning with 'SET PATH='.
    - Save the 'config.sys' file.

-   Restart your computer.


Usage
=====

Clean programs can be compiled with the 'clm' command. See clm.txt
in the 'bin' directory for more information on this command.
To link Clean programs that use the IO library use:
  clm -p -sl d main_module
to link with the dll cleanlib.dll. Programs linked in this way are smaller
and can be linked faster, but require cleanlib.dll to run.
Linking with:
  clm -p -sl s main_module
takes longer, and generates a larger applications, but do not require
cleanlib.dll to run.


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

If you find any bugs, have questions, comments or suggestions you can
reach us at:

        clean@cs.kun.nl

There is a mailing list for discussions about Clean.  Send mail to
"clean-request@cs.kun.nl" with the word "subscribe" in the Subject: field
to join this mailing list.

We also have some pages on the World Wide Web:

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

