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


Contents
========

The Clean OS/2 package contains the following files:

readme          this file.

clean.zip       contains the Clean binaries and library files. Unpacking
                creates the directories 'bin' and 'lib'.

cleanio.zip     contains files for the IO libraries of the Clean system.
                Unpacking creates the directories 'CleanIO' and 'OsIO'.
                It add also some files to the directory 'lib.

examples.zip    contains simple examples. Unpacking creates the directory
                Examples.
     
ioexamples.zip  contains examples for the Clean IO system. Unpacking
                creates the directory IOExamples.
     
smallemx.cmd    a simple utility to unpack emx packages


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 clean.zip (and examples.zip if you want to see
    example Clean programs)

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

-   a part of the emx enviroment (version 0.9a) for OS/2 (see below).
	Note: the current release does not work with emx 0.9b


In addition, to use the Clean IO system you need:

-   the file cleanio.zip (and ioexamples.zip if you want to see
    example Clean IO programs)


To install the Clean system:

-   create a directory called, for example, 'Clean'.

-   copy all the needed Clean files (the zip files in
    binary mode, if you are using ftp) to this directory.

-   unpack the zip files with the unzip command. This will create
    the directories 'bin' and 'lib' (and 'CleanIO' and 'OsIO' if
    you unpack cleanio.zip). 

-   change the config.sys file in the following way (assuming
    that 'D:\Clean' is the directory for the clean system,
    and 'D:\emx' is the directory of the emx system):

    add the following lines:
    
    SET CLEANLIB=D:\Clean\lib
    SET GCCLIB=D:\emx\lib
    SET CLEANPATH=D:\Clean\lib;D:\Clean\CleanIO;D:\Clean\OsIO

    add the directory 'D:\clean\bin' to the PATH variable  

-   restart your computer.


To install the emx system:

-   get the following files from an emx site (see below):
           emxdev.zip
           emxrt.zip
           gnudev.zip
        
-   unpack the emx files. You don't need the full emx package to
    use the Clean system. You can use the 'smallemx' command
    to unpack the needed files (this assumes you use 'unzip' to
    unpack the zip files). The following is a minimal
    listing of the files you need to run the Clean system:
    
        from emxdev.zip
            emx/lib/crt0.o
            emx/lib/emx2.a
            emx/lib/gcc.a
            emx/lib/m.a
            emx/lib/os2.a
            emx/lib/st/c.a
            emx/lib/st/c_app.a
            emx/lib/st/c_import.a
            emx/lib/st/emx.a

        from emxrt.zip
            emx/bin/emxbind.exe
            emx/bin/emxl.exe
            emx/dll/emx.dll
            emx/dll/emx.emxlibcs.dll

        from gnudev.zip
            emx/bin/as.exe
            emx/bin/ld.exe

-   change the config.sys file in the following way (assuming
    that 'D:\emx' is the directory of the emx system):

    add the directory 'D:\emx\dll' to the LIBPATH variable.

    add the directory 'D:\emx\bin' to the PATH variable.

-   restart your computer.


The unpacking utility, and the emx environment can be obtained at 
the following ftp sites:

    ftp-os2.cdrom.com
        emx package:   /pub/os2/emx09a
        unzip:         /pub/os2/archiver/unzip512x2.exe
    
    src.doc.ic.ac.uk
        emx package:   /pub/packages/os2/unix/emx09a
        unzip:         /pub/packages/os2/32bit/archiver/unz512x2.exe
    
    ftp.informatik.tu-muenchen.de
        emx package:   /pub/comp/os/os2/gnu/emx+gcc
        unzip:         /pub/comp/os/os2/archiver/unzip512.exe


Usage
=====

Clean programs can be compiled with the 'clm' command. See clm.txt
in the 'lib' directory for more information on this command. To link
the IO package you should add a the -p option to the clm command.


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

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.

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

        clean@cs.kun.nl

We also have some pages on the World Wide Web:

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