home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d8xx / d812 / ppmc.lha / PPMC / Doc / PPMC.doc next >
Text File  |  1993-02-14  |  12KB  |  345 lines
  1.  
  2.  
  3.                                 PPMC  v1.2b
  4.  
  5.                         The Powerpacker Mini Clone
  6.  
  7.                      Copyright (c) 1992,1993 REELSOFT
  8.  
  9.  
  10.         Both this program and its source are freely distributable,
  11.         but remain Copyright (c) REELSOFT.
  12.  
  13.  
  14.  
  15.         Table of Contents :
  16.         ~~~~~~~~~~~~~~~~~~~
  17.             1. Introduction
  18.             2. Installation
  19.                2.1 Under OS 2.0
  20.                2.2 Under OS 2.1 & OS 3.0
  21.             3. Usage from the Shell
  22.                3.1 Syntax
  23.                3.2 Template
  24.                3.3 Notes
  25.                3.4 Examples
  26.             4. Usage from Workbench
  27.                4.1 Tool Types
  28.                4.2 Notes
  29.             5. Changes
  30.             6. Future improvements
  31.             7. Author
  32.             8. Acknowledgments
  33.  
  34. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  35. 1.Introduction :
  36. ~~~~~~~~~~~~~~~~
  37.         PPMC is powerpacker.library meeting gadtools.library.
  38.   It's a utility, useful for packing and unpacking text and data files.
  39.   Unlike the original Powerpacker, PPMC won't insert a decrunch header
  40.   in the packed file, so it would be useless to crunch an executable file
  41.   (except for an archival purpose)
  42.  
  43.   PPMC works under 2.0(V37), 2.1(V38) and 3.0(V39) systems
  44.   and can be invoked either from the Shell or from the Workbench.
  45.  
  46. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  47. 2.Installation :
  48. ~~~~~~~~~~~~~~~~
  49.   PPMC obviously requires the powerpacker.library.
  50.   That is the only library to install, in order to use the Shell interface.
  51.   As for the Intuition interface, the reqtools.library is needed too.
  52.  
  53.   2.1 Under OS 2.0 :
  54.   ~~~~~~~~~~~~~~~~~~
  55.   The installation program allows you first of all to compare the version
  56.   number of the provided libraries with those already installed in your
  57.   system.
  58.   It will then update your Libs: assignement with the libraries you had
  59.   previously checked.
  60.  
  61.   Note :
  62.   ~~~~~~
  63.   - Pressing the Esc key will quit the program.
  64.  
  65.  
  66.   2.2 Under OS 2.1 & OS 3.0 :
  67.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  68.   To execute the installation script, double-click on your language icon.
  69.  
  70.   Notes :
  71.   ~~~~~~~
  72.   - You will need Commodore's Installer program in your C: assignement.
  73.   - I'm sorry if your native language isn't provided.
  74.     Feel free to do the translation and don't forget to send me a copy
  75.     of the `.ct' file...
  76.  
  77. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  78. 3.Usage from the Shell :
  79. ~~~~~~~~~~~~~~~~~~~~~~~~
  80.   If you wish to use an Intuition interface, just type `PPMC' with
  81.   no argument.
  82.   (skip to "Usage from the Workbench" for more details)
  83.  
  84.   You may otherwise be interested in a CLI-only interface.
  85.   In that case, type `PPMC ?' to display the template.
  86.  
  87.   3.1 Syntax :
  88.   ~~~~~~~~~~~~
  89.         PPMC FROM <source> TO <destination>
  90.         [EFFECT] {1|2|3|4|5} [BUFFER] {1|2|3} [DECRUNCHING] {1|2|3|4|5}
  91.         [ENCRYPT] [FORCE] [QUIET] [VER] [HELP]
  92.  
  93.   3.2 Template :
  94.   ~~~~~~~~~~~~~~
  95.         PPMC
  96.         FROM/A,TO/K,EFF=EFFICIENCY/K/N,BUF=BUFFER/K/N,DEC=DECRUNCHING/K/N,
  97.         ENCRYPT/S,FORCE/S,QUIET/S,VER/S,HELP/S
  98.  
  99.  
  100.   FROM        = This is the path and name of the file to be crunched.
  101.  
  102.   TO          = This is the path and name of the destination file.
  103.                 If this argument is omitted, the destination file name
  104.                 would be equal to :
  105.  
  106.               - The source name plus  the `.pp' extension if packing.
  107.               - The source name minus the `.pp' extension if unpacking.
  108.               ( Be careful: if the source file has no `.pp' extension,
  109.                 it will be overwritten ! )
  110.  
  111.   EFFICIENCY  = The packing efficiency :
  112.                 1 = FAST
  113.                 2 = MEDIOCRE
  114.                 3 = GOOD
  115.                 4 = VERY GOOD
  116.   (default)     5 = BEST
  117.  
  118.   BUFFER      = The size of the speedup buffer used while packing :
  119.                 1 = LARGE       from   3K (FAST) to  33K (BEST)
  120.                 2 = MEDIUM      from   5K (FAST) to  65K (BEST)
  121.   (default)     3 = SMALL       from 196K (FAST) to 256K (BEST)
  122.  
  123.   DECRUNCHING = The effect to be used during decrunching :
  124.                 1 = Flash color 0
  125.                 2 = Flash color 2
  126.                 3 = Flash mouse pointer
  127.                 4 = Background color scrolling
  128.   (default)     5 = No decrunching effect
  129.  
  130.   ENCRYPT     = This switch enables encryption of packed files.
  131.                 You will then be asked for a password.
  132.  
  133.   FORCE       = Use this switch to disable the confirmation request
  134.                 before the crunching of an executable file.
  135.  
  136.   QUIET       = When this switch is on, no information is displayed
  137.                 during the packing or the unpacking operation.
  138.  
  139.   VER         = This switch will ask PPMC to display its current version.
  140.  
  141.               - Same as the `-v' option on previous versions of PPMC.
  142.  
  143.   HELP        = A very useful switch which will make PPMC display
  144.                 the packing parameter's values.
  145.  
  146.               - This option is localized.
  147.               - Same as the `-h' option on previous versions of PPMC.
  148.  
  149.   3.3 Notes :
  150.   ~~~~~~~~~~~
  151.   - The program firstly checks if the source file is already packed
  152.     and encrypted and will in that case decrunch it.
  153.     So use the same syntax to unpack a file.
  154.   - You may abort any packing or unpacking operation by hitting Ctrl-C
  155.     or Ctrl-D.
  156.   - The display of messages can be avoided by adding >NIL: at the end
  157.     of the command line.
  158.  
  159.   3.4 Examples :
  160.   ~~~~~~~~~~~~~~
  161.   > PPMC file1 file2 EFF=3 BUF=2 DEC=3 ENCRYPT
  162.  
  163.   - Pack and encrypt `file1' with a GOOD efficiency,
  164.     using a MEDIUM speedup buffer, and a decrunching effect on
  165.     the mouse pointer, then save it to `file2'.
  166.  
  167.  
  168.   > PPMC file FORCE
  169.  
  170.   - Pack `file' with the default parameters (EFF=BEST, BUF=LARGE, DEC=NONE),
  171.     without encrypting it, then save it as `file.pp', even if it's an
  172.     executable file.
  173.     If the file is already packed, it will be unpacked and saved.
  174.  
  175. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  176. 4.Usage from Workbench :
  177. ~~~~~~~~~~~~~~~~~~~~~~~~
  178.   To run PPMC from Workbench, simply double-click on its icon,
  179.   which has several Tool Types that you may want to set before.
  180.  
  181.   To load a file, you can either :
  182.   - Drop an icon on PPMC window (the fastest way),
  183.   - Click on the GetFile gadget, then select a file in the requester,
  184.   - Use the Load item from the Project menu (right Amiga + L).
  185.  
  186.   Once the file is chosen, the program analyses it and whether it's already
  187.   packed or not, enables the appropriate button.
  188.  
  189.   4.1 Tool Types :
  190.   ~~~~~~~~~~~~~~~~
  191.   PUBSCREEN   :       The public screen name on which PPMC should open
  192.                       its window
  193.   Default     :       Default public screen (or Workbench)
  194.  
  195.   LANGUAGE    :       The language to use for localization (OS 2.1+ only)
  196.   Default     :       System default if available, English otherwise
  197.  
  198.   EFFICIENCY  :       Sets the crunching efficiency at startup
  199.   Range       :       1-5
  200.   Default     :       5 (BEST)
  201.  
  202.   BUFFER      :       Sets the speedup buffer at startup
  203.   Range       :       1-3
  204.   Default     :       1 (LARGE)
  205.  
  206.   DECRUNCHING :       Sets the decrunching effect at startup
  207.   Range       :       1-5
  208.   Default     :       5 (NONE)
  209.  
  210.   ENCRYPT     :       Sets encryption at startup
  211.   Default     :       OFF
  212.  
  213.   VERBOSE     :       When this tool type is OFF, the `size', `% gain' and
  214.                       `%' gadgets, as well as the percentage gauge will be
  215.                       disabled during the packing operation.
  216.   Default     :       ON
  217.  
  218.   ASL         :       PPMC will use the reqtools.library file-requester
  219.                       by default.
  220.                       If you prefer using the asl.library file-requester
  221.                       or any other library providing an ASL patch program
  222.                       (KDfreq,MFR,etc..), set this tool type to ON.
  223.   Default     :       OFF
  224.  
  225.   PATTERN     :       You may avoid the use of a backfill pattern by
  226.                       launching PPMC with this tooltype OFF.
  227.   Note        :       This is particularly appropriate for owners of a
  228.                       slow processor Amiga, who use an 8 or 16 color
  229.                       Workbench screen under Kickstart 2.0 or 2.1.
  230.                       (Intuition windows are sped up a lot under V39).
  231.   Default     :       ON
  232.  
  233.   COLOR       :       Sets the window pattern color.
  234.   Range       :       0-255
  235.   Default     :       3
  236.  
  237.   4.2 Notes :
  238.   ~~~~~~~~~~~
  239.   - The Esc button aborts the crunching operation.
  240.   - Decrunching is too fast to be aborted.
  241.   - You will be warned by a requester, every time you will attempt
  242.     to load an executable file.
  243.  
  244. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  245. 5.Changes :
  246. ~~~~~~~~~~~
  247.                 v1.2b   - Dutch catalog
  248.                         - Icon Tool Type parsing
  249.                         - Invisible password prompting from CLI
  250.                         - All UNIX style options replaced by new switches
  251.                         - Recompiled with SAS/C 6.1
  252.  
  253.                 v1.2a   - File overwritting detection
  254.                         - Gadget shortcuts corrected
  255.                         - `-b' option
  256.  
  257.                 v1.2    - Localized
  258.                         - Unpacking possibility
  259.                         - Complete CLI/Shell interface
  260.                         - ASL file requester
  261.                         - Custom Password prompting
  262.                         - New look
  263.                         - Internal font changed
  264.                         - Hypertext documentation
  265.                         - bugs fixed
  266.  
  267.                 v1.1    - Encrypts files
  268.                         - Warns the user if an executable file is loaded
  269.                         - Internal font purged
  270.                         - Few bugs fixed
  271.  
  272.                 v1.0    - First released version
  273.  
  274. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  275. 6.Future improvements :
  276. ~~~~~~~~~~~~~~~~~~~~~~~
  277.         - Pack and unpack multiple files
  278.         - Scan a directory for a recursive packing and unpacking
  279.         - Make window & gadgets sizable
  280.         - Add an icon to the destination file(s)
  281.         - Optimize the code with a custom startup
  282.         - Replace ppErrorMessage() with a localized function
  283.         - Translate the documentation to French
  284.  
  285.   Note :
  286.   ~~~~~~
  287.   Theese improvements will mostly depend on the needs of PPMC users...
  288.  
  289. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  290. 7.Author :
  291. ~~~~~~~~~~
  292.         PPMC was written by
  293.  
  294.         Reza ELGHAZI
  295.         35, av Mac Mahon
  296.         75017 Paris
  297.         FRANCE
  298.  
  299.         Using a very slow Amiga 500+ (1Mb CHIP),
  300.         a GVP A500-HD8+ 52Mb SCSI hard drive (4Mb FAST),
  301.         under Kickstart 39.106 (loaded in RAM with SKick)
  302.         and Workbench 39.29
  303.  
  304.         Comments, suggestions, bug reports, flames, gifts, etc...
  305.         are welcome.
  306.  
  307.                 ...AND SOMEONE SAID FAIR WARNING
  308.                    LORD WILL STRIKE THAT POOR BOY DOWN,
  309.                    TURNED FROM HUNTED INTO HUNTER
  310.                    WENT TO HUNT SOMEBODY DOWN...                (VAN HALEN)
  311.  
  312. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  313. 8.Acknowledgments :
  314. ~~~~~~~~~~~~~~~~~~~
  315.  
  316.   Thanks to :
  317.   ~~~~~~~~~~~
  318.         Nico Francois                   Fred (Torchi) Servant
  319.         Jan van den Baard               Alex Tsopeis
  320.         Michael Berg                    Denis Gounelle
  321.  
  322.   SPECIAL Thanks to :
  323.   ~~~~~~~~~~~~~~~~~~~
  324.         Jan van den Baard for his awesome GadToolsBox,
  325.         the Dutch localization and for helping me on several bugs.
  326.  
  327.         Michael Berg for the Danish localization.
  328.  
  329.         Nico Francois for having resolved the password problem
  330.         and of course his exceptional reqtools and powerpacker libraries.
  331.  
  332.         Fred Fish for his prodigious PD collection.
  333.  
  334.         Alice in Chains for the music.
  335.  
  336.   PPMC was written with :
  337.   ~~~~~~~~~~~~~~~~~~~~~~~
  338.         SAS/C Compiler v6.1             (c) SAS Institute Inc.
  339.         CygnusEd Pro v2.12              (c) CygnusSoft Software
  340.         GadToolsBox v1.4                (c) Jaba Development
  341.         powerpacker.library v35         (c) Nico Francois
  342.         reqtools.library v38            (c) Nico Francois
  343.  
  344. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  345.