@database xadmaster.guide
@$VER: xadmaster.guide 1.2 (18.11.1998) by SDI
@node Main "Welcome to the XAD system documentation"

	*********************************************************
	*							*
	*  xadmaster.library - the powerful unarchiving system  *
	*							*
	*********************************************************

		@{"What is it" LINK What}		Concept and Indroduction
		@{"Why use it" LINK WhyUse}		Use it!
		@{"Requirements" LINK Requires}		XAD system requirements
		@{"Installation" LINK Install}		How to install XAD system
		@{"Clients" LINK Clients}			Supported archivers

		@{"Shareware" LINK Shareware}		xadmaster.library is Shareware
		@{"Disclaimer" LINK Disclaimer}		Read this!
		@{"Author" LINK Author}			Contact me

		@{"Thanks" LINK Thanks}			Some helpful people
@endnode

@node What "What is it"
The xadmaster.library is the base library of a standard interface for
dearchiving file and disk archives. Maybe you know xfdmaster.library
already, which is the interface for decrunching crunched data files and
crunched programs. The xadmaster.library is the same, but for archives and
disks.

This library allows to unarchive lots of different archiver formats with
just one archiver tool. If someone makes a nice GUI for xadmaster.library,
it can be used for all the included archiver types. It is no longer needed
to have lots of archivers with lots of options and lots of GUIs and lots
of problems. Only one library and one tool. Beside this xadmaster.library
allows to unarchive very strange archiver types. Some of the older
archivers do not work any longer on newer machines, but xadmaster.library
solves this problem, as there is needed only a short @{"client" LINK Clients} to support a
new format.

Disk archives can be decrunched to devices, memory and files. This is not
possible with the most disk archiver programs.

Ok, that's the future. At the moment xadmaster.library supports very less
formats. I hope this will change in near future.
@endnode

@node WhyUse "Why use XAD system"
This library system has some advantages:
  - It supports lots of different archive types.
  - Archivers are internal or in specific clients. No special programs are
    needed.
  - All archivers have the same interface and do their work in same way.
    There is no need to learn different options for different archivers or
    get around interface problems of archiver programs.
  - The library has a lot of features not supported by most archivers, e.g.
    unarchiving disks into image files.
  - The archiver clients are really short compared to most archiver
    programs.
  - The library can support nearly all possible archivers, also very
    strange and old ones.
  - Adding new archivers is really easy by making a new external @{"client" LINK Clients}.
@endnode

@node Requires "Requirements of XAD system"
All executable files in this packet require at least OS version V37 (OS2.0)
to do their work.

The xadmaster.library must be in the LIBS: drawer and any needed client in
the LIBS:xad drawer.
@endnode

@node Install "What to do to install XAD system"
Copy xadmaster.library to LIBS: and the clients to the LIBS:xad drawer. The
utility programs can be copied anywhere. Best will be C: drawer.

The source examples and developer files are not needed to use the system.
These files are for programmers only.
@endnode

@node Clients
Currently there are following internal clients:

Disk archivers
  SuperDuper3	Buffer file of SuperDuper3
  xDisk		XPK based archiver from Oliver Wagner released with German
		Amiga Plus magazine
  xMash		XPK based archiver
	
File archivers
  Tar		UNIX tar program, does not support gzipped or compressed
		archives. You may use xfdmaster.library to decrunch GZip
		files, but this may fail for really large files (like on
		GeekGadgets) as xfdmaster needs to have source and
		destination in memory. Use GZip or GUnZip for these files.

Clients can be internal (in the library) or external (in LIBS:xad drawer).
External clients can be made by anyone and may also replace the internal
clients.
@endnode

@node Shareware "xadmaster.library is Shareware"
The xadmaster.library is Shareware with very special conditions. There are
no usage restrictions, and xadmaster.library use can be implemented into
programs without any restrictions.

Only the end users have to pay shareware, when using xadmaster.library.
There are 3 forms of payment to get a registered user:
  - Send $20 US to my snail mail address.
  - Make detailed bug reports about 3 currently unknown bugs. I decide
    whether a bug report is counted or not. Mainly this depends on two
    facts:
    - was the bug already reported
    - does the description help me to find the bug
    After the first report you will get a partly registered user :-)
  - You make an own external client and send me the source and the client
    for inclusion in next release. Some more are good as well!
  The last form is the most wanted!

For programmers using xadmaster.library in own applications (f.e. in virus
scanners):
  - It would be fine, if you would tell me suggestions or bugs, as
    implementing xadmaster.library use may show you some problems.
  - You must state above conditions in your distribution.
  - And please do not forget: Most time you are users as well, so think
    about above conditions.
@endnode

@node Disclaimer
All contained files are provided "as is" without warranty of any kind,
either expressed or implied. The entire risk as to the accuracy of the
information herein is assumed by you. I do not warrant, guarantee or make
any representations regarding the use of included files in terms of
correctness, accuracy, reliability, currentness or otherwise. In no event
I will be liable for direct, indirect, incidental or consequential damages
resulting from any defect in the included files.
@endnode

@node Author
Please contact me:

************************************************************************
* snail-mail:                  * e-mail:                               *
*   Dirk Stoecker              *   stoecker@amigaworld.com             *
*   Geschwister-Scholl-Str. 10 *   stoecker@rcs.urz.tu-dresden.de      *
*   01877 Bischofswerda        * world wide web:                       *
*   GERMANY                    *   http://home.pages.de/~Gremlin/      *
* phone:                       * pgp key:                              *
*   GERMANY +49 (0)3594/706666 *   get with finger or from WWW pages   *
************************************************************************
@endnode

@node Thanks
There are some people I want to thank for their work:

  Georg Hörmann
    The former author of xfdmaster.library. This library is an interface
    for uncrunching file and disk archives and gave me the idea to produce
    xadmaster.library.

  Urban Dominik Müller
    The former author of xpkmaster.library. This library inspired may a
    lot especially in design of xadmaster.library. Thanks also that he gave
    me the sources to improve xpkmaster.library.
    Special thanks for managing Aminet and keeping the Amiga community
    alive.
@endnode