======================================
                   XPK - The external compression library
                   ======================================

 LIESMICH
 README

Overview of files in archive, German and English.

 libs/xpkmaster.library
 libs/powerpacker.library
 libs/iff.library

xpkmaster.library is the main library. It's the interface between programs
and compression libs. Using powerpacker.library, the masterlib can also
decompress powerpacker files. iff.library has been adapted to XPK so 
programs that use it will automatically decompress XPK files. Copy these
files to LIBS:.


 libs/compressors/xpkBLZW.library
 libs/compressors/xpkNONE.library
 libs/compressors/xpkNUKE.library
 libs/compressors/xpkRLEN.library
 libs/compressors/xpkIMPL.library
 libs/compressors/xpkENCO.library

These are the compression libs. You must create a compressors/ directory
withing LIBS: and copy them there. Here's a quick overview of their
properties:
    +---------------------------------------------------------+
    |             CF        CSpeed      USpeed        Modes   |
    | NUKE        +           +           ++            n     |
    | IMPL        +           0           +             y     |
    | BLZW        0           ++          +             y     |
    | RLEN        -           ++          ++            n     |
    | NONE        --          ++          ++            n     |
    | ENCO        --          ++          ++            n     |
    +---------------------------------------------------------+
ENCO is a very simple encoding library, RLEN very simple compression
(both mainly programming examples) and NONE does just nothing.


 docs/BLZW.doc
 docs/NUKE.doc

Descriptions of those compressors.


 clients/README
 clients/xDir
 clients/xLoadSeg
 clients/xPK
 clients/xQuery
 clients/xType
 clients/xUP

The shell-based XPK programs. See README inside


 apps/xDrop
 apps/xDrop.info
 apps/xDrop.doc
 apps/xDrop.info
 apps/ShowIFF
 apps/ShowIFF.doc
 apps/ShowIFF.info

xDrop requires OS 2.0. It opens an App-Icon on the WB screen which you can
drag files on. They get compressed and their uncompressed original gets
deleted. Double-click on the app-icon to get a control panel. ShowIFF
is the well-known IFF displayer, now can decompress XPK-files thanks to
the new iff.library. 


 xfh/README
 xfh/XFH-handler
 xfh/XFH.doc
 xfh/Mountlist
 xfh/patcharp/README
 xfh/patcharp/patcharp

XFH is a decompressing file handle for XPK. It makes the files on a 
partition appear as though they were uncompressed. The way to go:
      Assign XFH0: DH1:
      Mount XH0: from Mountlist
After that you can use XH0: just like DH1:, but files are decompressed
on the fly. You may of course use several XFH partitions, read the
mountlist.


                               ---------------
                               FOR PROGRAMMERS
                               ---------------

 examples/makefile
 examples/xpkdice.c
 examples/xpkmanx.c
 examples/xpksas.c
 examples/xpkgcc.c
 examples/xsum.asm
 examples/xsum.c
 examples/xsum2.c

xpk<compiler> are plain file packers for the four most well-known C
compilers. xSum.c adds up all the bytes in a file, no matter if 
compressed or not. xSum2.c does the same without ever reading the
whole file. xSum.asm is the assembler version of xSum.


 include/libraries/xpk.h
 include/libraries/xpk.i
 include/libraries/xpksub.h
 include/libraries/xpksub.i
 include/inline/xpk.h
 include/inline/xpksub.h
 include/xpkmaster.fd
 include/xpksub.fd

The include files for various compilers.


 lib/xpkdice.lib
 lib/xpkmanx.lib
 lib/xpksas.lib

The link-libraries. DICE always need one, and the other languages need them
for the ...Tags() version of the XPK calls.


 rlen/makefile
 rlen/xpkRLEN.c

A sample compression library. Contact me if you write another.


 enco/makefile
 enco/xpkENCO.c

A sample encryption library. Contact me if you write another.


 sources/makefile
 sources/xDir.c
 sources/xPK.c
 sources/xQuery.c
 sources/xType.c

The sources for the according clients.


 oberon/examples/xpk.mod           
 oberon/examples/xsum.mod          
 oberon/interfaces/XpkMaster.mod   
 oberon/interfaces/XpkSubCalls.mod 
 oberon/interfaces/XpkSubDefs.mod

Oberon interface to XPK.



                                  ---------
                                  COPYRIGHT
                                  ---------

XPK is copyrighted by its authors. It may be used for non-commercial
purposes. For further questions refer to

   Urban Dominik Müller
   Schulhausstrasse 83
CH-6312 Steinhausen
   SCHWEIZ

   umueller@amiga.physik.unizh.ch



                                   -------
                                   AUTHORS
                                   -------

U. Dominik Mueller  XPK concept, xpkmaster.library, NUKE, RLEN, NONE, ENCO
Bryan Ford          XPK concept, xpkmaster.library, BLZW
Peter Struijk       Imploder, IMPL
Nico Francois       PowerPacker
Kristian Nielsen    XFH
Martin A. Blatter   xDrop
Christian Schneider XPK concept, xLoadSeg
Christian Weber     iff.library adaptation, ShowIFF
Markus Wild         GCC interface & examples
Harmut Goebel       Oberon interface & examples