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