home *** CD-ROM | disk | FTP | other *** search
/ World of A1200 / World_Of_A1200.iso / programs / compress / misc / xpk / filesys / xpkhandler / readme < prev    next >
Text File  |  1995-02-27  |  4KB  |  120 lines
  1.         Xpk File System Handler
  2.         =======================
  3.  
  4. Copyright:
  5. ----------
  6.  
  7.       © Copyright 1992, Freeware, All rights reserved
  8.  
  9.    Distribution EXCLUSIVELY permitted to the XPK authors as part of their XPK
  10.    package. Other forms of distribution need the permission of the author.
  11.  
  12.    No guarantee of any kind is made that this program is 100% reliable.
  13.    You use it on your own risk.
  14.  
  15. Notes:
  16. ------
  17.  
  18.    This package contains a file system handler similar to Kristian Nielsen's
  19.    XFH. Due to the similarities only the differences to XFH will be stated
  20.    here. For a detailed description of the basics consult the XFH.doc.
  21.  
  22.    The xpk-handler needs arp.library v39+ in libs: to run.
  23.  
  24.    Complete source code for Aztec C v5.2a included.
  25.  
  26. Differences to XFH:
  27. -------------------
  28.  
  29.    The xpk-handler uses another mechanism as XFH to pass the option the
  30.    handler needs to run. Instead of external config files a special field of
  31.    the mountlist entry is used (heavy magic). This field (Startup) contains
  32.    an argument string as ONE WORD with all necessary data the handler needs
  33.    to know at startup time. All spaces MUST be represented by an underscore
  34.    due to the limitations of the mount comand. To insert an underscore as
  35.    normal character in the parameter string you have to use two underscores.
  36.    This command line will be parsed according to the following standard
  37.    AmigaDOS template:
  38.  
  39.     ROOTDIR/A,VOLUMENAME/K,AUTOCOMPRESS/S,STEPDOWN/S,XPKPRIORITY/K,
  40.     PACKMETHOD/K,PASSWORD/K
  41.  
  42.    The available options are detailed below:
  43.  
  44.       Option ROOTDIR:
  45.     This option is used to set the path to the root directory for the
  46.     handler. For example `ROOTDIR_"ram:"' will cause the handler to use
  47.     the ram disk as root directory.
  48.  
  49.       Option VOLUMENAME:
  50.     This option is used to set the volume name for the handler. This
  51.     name will be shown by the AmigaDOS command Info and the workbench
  52.     uses it for the handler's icon. For example `VOLUMENAME_"Xpk_Test"'
  53.     causes the volume `Xpk Test:' to appear.
  54.     Default: `Xpk handler'
  55.  
  56.       Option AUTOCOMPRESS:
  57.     This option enables the handler to compress files written through it.
  58.     Default: turned off
  59.     
  60.       Option STEPDOWN:
  61.     This option enables XPK to reduce the pack efficieny if necessary to
  62.     save memory.
  63.     Default: turned off
  64.     
  65.       Option XPKPRIORITY:
  66.     This option is used to set the task priority the handler should use
  67.     when doing XPK operations (pack, unpack, ...).
  68.     Default: 0
  69.  
  70.       Option PACKMETHOD:
  71.     This option is used to select the mode XPK should use for compressing
  72.     files. For example `PACKMETHOD_"BLZW.12"'will cause the handler to
  73.     use 12-bit BLZW compression.
  74.     Default: `NUKE'
  75.  
  76.       Option PASSWORD:
  77.     This option is used to set the password that the handler should pass
  78.     to XPK when compressing or decompressing. For example
  79.     `PASSWORD_"Magic_word"' will cause the handler to use the password
  80.     `Magic word'.
  81.     Default: none
  82.  
  83.    So the startup field could looks like:
  84.  
  85.     Startup = ROOTDIR_"ram:"_VOLUMENAME_"Xpk_Test"_AUTOCOMPRESS_PACKMETHOD_"NUKE"
  86.  
  87.    In the `c' subdirectory a small tool called `kill' can be found to remove
  88.    the handler from within memory and unlink the device node from AmigaDOS
  89.    device list.
  90.  
  91.    Syntax: kill <device name>
  92.    Example: kill xpk:
  93.  
  94. Caveats:
  95. --------
  96.  
  97.    Due to the (mis)usage of the startup field some tools, eg. DiskX or
  98.    DosList, misinterprets this as a pointer to an FileSysStartupMsg structure.
  99.    So an invalid device name, unit number and environment vector will be used.
  100.  
  101. Author:
  102. -------
  103.  
  104.    Torsten Jürgeleit
  105.    Am Sandberg 4
  106.    W-5270 Gummersbach
  107.    Germany
  108.  
  109.    Phone: ++49 2261 27400
  110.  
  111.    eMail: bj030@aix370.rrz.uni-koeln.de   (Fast, but matter of change)
  112.       mike@miba.obb.sub.org           (Slow and unsafe)
  113.  
  114.    Bug reports, flames, donations etc. are welcome !
  115.  
  116. History:
  117. --------
  118.  
  119. v1.0 - first public release
  120.