home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / compress / xpk25usr.lha / Workbench / xDrop.doc < prev    next >
Text File  |  1992-10-02  |  14KB  |  397 lines
  1. xDrop 2.21
  2. ==========
  3.  
  4. XPK-based Workbench packer/unpacker.
  5.  
  6.  
  7. ------------------------------------------------------------------------
  8. Versions
  9. --------
  10.  
  11. 2.0  - First version, distributed with xpk 1.0
  12. 2.01 - Small bug fix (original window positioning was wrong)
  13. 2.02 - Memory leek fixed
  14. 2.1  - Layout slightly changed, larger listview, mode descriptor
  15. 2.11 - Bug causing Enforcer hit in panel disable code fixed
  16.        (Ch. Schneider)
  17. 2.12 - Bug with long filenames fixed
  18. 2.20 - New option `Keep file dates'
  19. 2.21 - Now also keeps protection bits and file comments, displays
  20.        name of selected packer if no icon name is specified in
  21.        tool types
  22.  
  23.  
  24. ------------------------------------------------------------------------
  25. Disclaimer
  26. ----------
  27.  
  28. xDrop is Copyright © 1992 by Martin A. Blatter. All rights reserved.
  29.  
  30. xDrop may be freely distributed for non-commercial purposes only!
  31.  
  32. The entire risk as to the quality and performance of this program is
  33. with you. The author assumes no responsibility or liability whatsoever
  34. with respect to your use or inability to use of this software.
  35.  
  36.  
  37. ------------------------------------------------------------------------
  38. Purpose
  39. -------
  40.  
  41. xDrop is an easy to use visual user interface to the XPK library
  42. system. It allows you to choose from different packers and
  43. different operation modes by a simple mouse click.
  44.  
  45. It sports a Style Guide compliant user interface and uses Workbench
  46. 2.0's appicon and appwindow features to make operation as simple and
  47. convenient as possible. Through the use of Commodore-Amiga's
  48. commodities.library, xDrop can be installed on any hotkey and
  49. fully controlled with the Commodities Exchange program.
  50.  
  51.  
  52. ------------------------------------------------------------------------
  53. Requirements
  54. ------------
  55.  
  56. · Any Amiga
  57. · Kickstart 2.0 or higher
  58. · The xpk package (xpkmaster.library and at least one sublibrary)
  59.  
  60.  
  61. ------------------------------------------------------------------------
  62. Start xDrop
  63. -----------
  64.  
  65. xDrop can be used either from Workbench or from the CLI.
  66.  
  67.  
  68. * Workbench use
  69.  
  70.   Double click on the xDrop icon. An appicon will appear on the
  71.   Workbench screen. If this appicon doesn't appear several things could
  72.   have gone wrong:
  73.  
  74.   · Do you use Kickstart 2.0 or higher?
  75.   · Is there any memory left on your system?
  76.   · Do you have commodities.library (supplied with Workbench 2.04)
  77.     in libs:?
  78.   · Is the xpk package properly installed?
  79.  
  80.   Requesters will try to tell you the cause if xDrop fails to run.
  81.  
  82.   If the tool type `CX_POPUP' (see below for an explanation of tool
  83.   types) is set to `yes', a configuration window will appear. See
  84.   the section entitled `Configuration Window' for more information
  85.   about this window.
  86.  
  87.  
  88. * CLI use
  89.  
  90.   Type 'xDrop' in any Shell window. An appicon will appear on the
  91.   Workbench screen.
  92.  
  93.   To remove xDrop from memory, just press CONTROL-C in the Shell
  94.   window where xDrop has been started from.
  95.  
  96.   Notice
  97.  
  98.   xDrop will use its pre-set default settings if started from the 
  99.   Shell. It is therefore recommended to launch xDrop from Workbench
  100.   or the WBStartup drawer.
  101.  
  102.  
  103. ------------------------------------------------------------------------
  104. Operation
  105. ---------
  106.  
  107. Operation of xDrop is very easy:
  108.  
  109. To compress files:
  110.  
  111.    Just select one or more file icons (no drawers) on the Workbench,
  112.    drag them to the xDrop appicon or the xDrop configuration window
  113.    (if it's open) and drop them.
  114.  
  115.    The Progress Report Window (see below) will appear and the file
  116.    will be compressed using the packer selected in the configuration
  117.    window or pre-set with the XPK_METHOD tool type (see below for
  118.    a discussion of tool types).
  119.  
  120. To uncompress files:
  121.  
  122.    To uncompress a compressed file, drag its icon on the xDrop
  123.    appicon or the xDrop configuration window (if it's open).
  124.  
  125.    You may drop arbitrary many icons (compressed or uncompressed)
  126.    simultaneously on xDrop. Note that xDrop currently only handles
  127.    single files (no drawers). You cannot concatenate several files
  128.    to one archive like with lharc or zoo.
  129.  
  130. To remove xDrop from memory:
  131.  
  132.    xDrop can be removed from memory at any time.
  133.  
  134.    - Use the `Commodities Exchange' program to kill xDrop
  135.    - Send xDrop a CTRL-C signal with the `break' command.
  136.      xDrop will exit gracefully.
  137.    - Run another copy of xDrop. Both xDrop processes will quit
  138.      immediately.
  139.  
  140.  
  141. ------------------------------------------------------------------------
  142. Configuration Window
  143. --------------------
  144.  
  145. The configuration window is divided into three visually separated
  146. parts labelled `Packer', `Settings' and `Description':
  147.  
  148.  
  149. ________________________________________________________________
  150. |                                                              |
  151. |    Packer                        Description                 |
  152. | ____________     ___________________________________________ |
  153. | |          |     |                                         | |
  154. | |          |     |                                         | |
  155. | |          |     |                                         | |
  156. | |          |     |                                         | |
  157. | |          |     |                                         | |
  158. | |          |     ------------------------------------------| |
  159. | |          |                                                 |
  160. | |          |                       Settings                  |
  161. | |          |                                                 |
  162. | |          |                        ________________________ |
  163. | ------------                        |                      | |
  164. | |          |                        |----------------------| |
  165. | ------------                        |______________________| |
  166. |                                                              |
  167. | ____________                                    ____________ |
  168. | |   Save   |                                    |   Hide   | |
  169. | ------------                                    ------------ |
  170. ----------------------------------------------------------------
  171.  
  172.  
  173. 1. Packer
  174.  
  175. The Packer list view allows you to choose from a list of available
  176. XPK packers and encryptors by clicking on its entry (the packer
  177. libraries are usually located in the drawer `libs:compressors').
  178. The recessed box below the list view shows the selected packer.
  179.  
  180.  
  181. 2. Description
  182.  
  183. This view-only box displays more information about the currently
  184. selected packer/encryptor consisting of the full name of
  185. the packer and two lines of additional information.
  186.  
  187.  
  188. 3. Settings
  189.  
  190. The Settings part of the configuration window consists of two
  191. gadgets that can be ghosted, depending on the capabilities of the
  192. currently selected packer:
  193.  
  194.    A. Efficiency
  195.  
  196.       This proportional gadget allows you to manipulate the
  197.       efficiency of the packer. The value for efficiency
  198.       can be in the range from 0 to 100%. Neither must every
  199.       packer support 100 different levels nor does every packer
  200.       have more than one level.
  201.  
  202.       An ASCII name of the current efficiency level can be obtained
  203.       by selecting the `Mode Info' menu.
  204.  
  205.       As of version 2.1, the ASCII name is now also being displayed
  206.       at the left side of the proportional gadget.
  207.  
  208.    B. Password
  209.  
  210.       This string gadget allows you to specify a password for
  211.       packers that support data encryption.
  212.  
  213.       The password may not be longer than 15 characters.
  214.  
  215.  
  216. 4. Buttons
  217.  
  218.    A. Save
  219.  
  220.       Saves the current settings to the xDrop disk icon.
  221.       Keyboard equivalent: S
  222.  
  223.    B. Hide
  224.  
  225.       Hides the configuration window but doesn't quit xDrop.
  226.       Uses the current configuration settings but doesn't save
  227.       them.
  228.       Keyboard equivalent: H
  229.  
  230.  
  231. 5. Close gadget
  232.  
  233. The window close gadget does exactly the same as the `Hide' button.
  234.  
  235.  
  236. 6. Menus
  237.  
  238.    A. Project
  239.  
  240.       About - Displays information about the program and its author.
  241.               Keyboard equivalent: Rt. Amiga - A
  242.  
  243.       Mode Info - Displays settings and additional information for
  244.                   the currently selected packer.
  245.                   Keyboard equivalent: Rt. Amiga - I
  246.  
  247.       Hide - Hides the configuration window but doesn't quit xDrop.
  248.              Uses the current configuration settings but doesn't save
  249.              them.
  250.              Keyboard equivalent: Rt. Amiga - H
  251.  
  252.       Quit - Completely removes xDrop from memory.
  253.  
  254.    B. Option
  255.  
  256.       Keep Original - If checked, xDrop will save the original
  257.                       file and append `.xpk' to the filename
  258.                       for the compressed version of the file.
  259.                       Icons will be copied as well. The `.xpk'
  260.                       extension will be deleted when the file
  261.                       is going to be decompressed.
  262.  
  263.                       If the menu item is not checked, xDrop
  264.                       will overwrite the original file with the
  265.                       compressed version.
  266.  
  267.       Keep File Info - If this option is enabled, the compressed
  268.                        file will get the same date stamp, file comment
  269.                        and protection bits as the original.
  270.                        This is very useful if you're processing
  271.                        files (e.g. different versions of a source code)
  272.                        and you're depending on the file date to tell
  273.                        which version is newer.
  274.  
  275.  
  276. ------------------------------------------------------------------------
  277. Progress Report Window
  278. ----------------------
  279.  
  280. While packing/unpacking, xDrop will show a progress report in a special
  281. window that appears in the upper left corner of your Workbench screen.
  282. A bar that moves from the left to the right shows the degree of completion.
  283. This  will not work with all packers, some will only show a change when
  284. done. The progress report also shows the amount of bytes already processed,
  285. the total amount of bytes to be processed and the (de)compression speed.
  286.  
  287. (De)compression can be aborted at any time using the close gadget;
  288. you will not lose any data. xDrop never overwrites the original file
  289. before having successfully completed the (de)compression.
  290.  
  291.  
  292. ------------------------------------------------------------------------
  293. Tool Types
  294. ----------
  295.  
  296. The following tool types are supported:
  297.  
  298.  
  299. CX_POPUP  - If you want the xDrop configuration window to pop up the
  300.             first time xDrop is started, set this to yes:
  301.                         CX_POPUP=yes
  302.  
  303.             If you want xDrop to run in the background the first
  304.             time it is being started e.g. if you're running it from the
  305.             WBStartup drawer, set this to no:
  306.                         CX_POPUP=no
  307.  
  308. CX_POPKEY - Key combination for the commodity `hotkey'. Default:
  309.                         CX_POPKEY=alt shift f9
  310.  
  311. CX_PRIORITY Commodity priority. Default value:
  312.                         CX_PRIORITY=0
  313.  
  314. XPK_METHOD - Sets the default packer. This tool type will be maintained
  315.              by the configuration window and should not be changed by
  316.              the user.
  317.                         XPK_METHOD=NUKE
  318.  
  319. XPK_PRIORITY - Sets the task priority of the packing/unpacking task.
  320.                Don't change this value unless you know what you're doing.
  321.                Default value: 0
  322.  
  323. LANGUAGE  - Determines the language to use for the user interface.
  324.             Possible values:
  325.                        LANGUAGE=German
  326.                        LANGUAGE=English
  327.             This tool type overrides global language settings. Remove
  328.             it if you want to use the system's default language...
  329.  
  330. ICONNAME  - Allows you to specify the label string of the appicon.
  331.             Example:
  332.                        ICONNAME=Slurp
  333.  
  334.             If this Tool Type is not given, the appicon will get the
  335.             name of the currently selected packer.
  336.  
  337. ICONXPOS  - Specifies the desired x coordinate of the appicon. Note that
  338.             as of Kickstart 2.0, Workbench may move your icon to another
  339.             position than specified here.
  340.             Example:
  341.                        ICONXPOS=600
  342.  
  343. ICONYPOS  - Specifies the desired y coordinate where the appicon should
  344.             appear. Note that as of Kickstart 2.0, Workbench may move your
  345.             icon to another position than specified here.
  346.                        ICONYPOS=400
  347.  
  348. KEEPORIGINAL - If this tool type is set to `yes', xDrop will save the
  349.                original file and append `.xpk' to the filename for the
  350.                compressed copy of the file. Icons will be copied as well.
  351.                The `.xpk' extension will be deleted when the file
  352.                is going to be decompressed.
  353.  
  354.                If the tool type is set to `no' (the default), xDrop
  355.                will overwrite the original with the compressed version.
  356.  
  357.                Example:
  358.                        KEEPORIGINAL=no
  359.  
  360.                If this tool type is not specified, it defaults to `no'.
  361.  
  362.  
  363. KEEPFILEINFO - If this tool type is set to `yes', the processed file
  364.                will get the same date stamp, file comment and protection
  365.                bits as the original. Otherwise, new files will get the
  366.                current date and time and default protections.
  367.  
  368.                Example:
  369.                        KEEPFILEINFO=yes
  370.  
  371.                Default value is `no'.
  372.  
  373.  
  374. ------------------------------------------------------------------------
  375. Credits
  376. -------
  377.  
  378. Author: Martin A. Blatter
  379.         Pfaffächerstr. 59
  380.         CH-8913 Ottenbach
  381.         Switzerland
  382.  
  383. E-Mail: blatter@amiga.physik.unizh.ch
  384.         cbmvax!cbmehq!cbmswi!zethos!blatter
  385.  
  386. Bug reports or suggestions are welcome but *please* use e-mail or snail
  387. mail (no phone calls!). Thanks.
  388.  
  389. This program uses Relog AG's ITools(tm), the object-oriented user
  390. interface system by Christian A. Weber.
  391.  
  392. Special thanks to 
  393.  
  394. - U. Dominik Mueller for parts of the manual.
  395. - Frank Neumann for the german manual.
  396.  
  397.