home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 3 / CDPDIII.bin / fish / 761-770 / ff766 / ppdo / ppdo.doc < prev    next >
Text File  |  1992-11-21  |  7KB  |  196 lines
  1.  
  2.                       PPDO (PowerPackerDataOnly) 1.21
  3.                       *******************************
  4.  
  5.                       Documentation by Thies Wellpott
  6.                       (excuse my bad English, please)
  7.  
  8.  
  9. 1. Copyright
  10. ************
  11.  
  12. PPDO is FreeWare (c) 1992 Thies Wellpott. You may copy it for free provided
  13. that
  14.         - no profit is made with it
  15.         - PPDO is not included with commercial software without written
  16.           agreement from the owner of the copyright
  17.         - PPDO is distributed with this documentation file, "PPDO.doc"
  18.           and both files are unmodified
  19.  
  20. The source code is for personal use only. It need not to be distributed
  21. along with the program, but if it is the whole source code must be kept
  22. with it (currently only "PPDO.c").
  23.  
  24.  
  25. 1.1. Warrenty
  26. *************
  27.  
  28. YOU USE THIS PROGRAM COMPLETELY ON YOUR OWN RISK! If you destroy any file,
  29. your computer, your car or even the whole universe or any part of it while
  30. using it, do not blame me, it is not my fault!
  31.  
  32.  
  33. 1.2. Note to Nico François
  34. **************************
  35.  
  36. This program should be no competition to your PowerPacker. There is no GUI,
  37. no ARexx-port, no ability to crunch executables, etc. I use this tool to
  38. crunch doc-files and song modules, and I thought it is nice enough to be
  39. used by other Amiga users, so I spread it around. I think this is ok!?
  40.  
  41.  
  42. 2. Introduction
  43. ***************
  44.  
  45. The PowerPacker by Nico François is a nice tool, but the non-commercial
  46. version (2.3b) is a bit slow. Because the PowerPacker file format is a kind
  47. of pseudo-standard which is supported by many programs (text viewer, module
  48. player, etc.) and is easily accessable via the powerpacker.library; it is
  49. worth being used. Since version 35 the powerpacker.library supports
  50. crunching using speedup buffers, so crunching is much faster than
  51. PowerPacker 2.3b`s. For these reasons I wrote this little tool which
  52. crunches files using the powerpacker.library.
  53.  
  54. PPDO requires the powerpacker.library V35+ (c) Nico François.
  55.  
  56.  
  57. 3. Usage
  58. ********
  59.  
  60. PPDO is runnable only from the CLI/Shell. It runs with Kickstart 1.2/1.3
  61. and OS 2.0. If you start PPDO with no or wrong arguments or with a "?" as
  62. the first argument you will get a usage info.
  63.  
  64.  
  65. PPDO [FAST|MEDIOCRE|GOOD|VERYGOOD|BEST] [SMALL|MEDIUM|LARGE]
  66.      [COLOR0|COLOR1|POINTER|SCROLL|NONE] [CRUNCH|RECRUNCH|DECRUNCH]
  67.      [SUFFIX] [DESTDIR dir] [MINSIZE size] [PRI pri] File/M
  68.  
  69.  
  70. FAST .. BEST   specifies the crunch speed/efficiency; FAST is the fastest
  71.   but least efficient mode, BEST the slowest but most efficient mode.
  72.  
  73. SMALL .. LARGE   specifies the size of the speedup buffer. The following
  74.   table shows the needed memory:
  75.  
  76.                  FAST   MEDIOCRE - VERYGOOD   BEST
  77.         SMALL      3K        somewhere         33K
  78.         MEDIUM     5K        inbetween         65K
  79.         LARGE    196K                         256K
  80.  
  81.   I recommend that you use LARGE because of the great speed improvement.
  82.  
  83. COLOR0 .. NONE   specifies the flash type during decrunching. COLOR0 is the
  84.   background color, COLOR1 the first color (black with OS 2.0), POINTER
  85.   flashes the mouse pointer, SCROLL kills your monitor :^) (try it and you
  86.   will see), NONE will flash nothing.
  87.  
  88. CRUNCH   If you pass this argument to PPDO it will crunch uncrunched files
  89.   and skip files already crunched with PPDO (or PowerPacker).
  90.  
  91. RECRUNCH   crunches uncrunched files and recrunches (that means decrunching
  92.   and then crunching with the specified parameters (FAST, BEST, etc.))
  93.   crunched files.
  94.  
  95. DECRUNCH   decrunches crunched files and skips uncrunched files.
  96.  
  97. SUFFIX   adds ".pp" suffix to uncrunched files if there is not already this
  98.   suffix, removes ".pp" suffix from crunched files if it is there; examples
  99.   follow later.
  100.  
  101. DESTDIR dir   this option will save the files to dir instead of their
  102.   original directory; examples follow later.
  103.  
  104. MINSIZE size   a file must at least have size bytes to be crunched, a file
  105.   with a few hundred bytes for example is not worth being crunched.
  106.  
  107. PRI pri   sets the task priority to pri during program execution (defaults
  108.   to -1).
  109.  
  110. File   one or more filenames. Patterns are not allowed (yet). You may use
  111.   patterns with help of SPat: SPat PPDO #?/#?.doc will crunch all files
  112.   ending with .doc in all subdirectories of the current directory.
  113.  
  114.  
  115. The default is: BEST LARGE POINTER CRUNCH MINSIZE 0 PRI -1.
  116.  
  117.  
  118. Some examples:
  119.  
  120. PPDO abc.doc textfile
  121.   crunches the files abc.doc and textfile with the default options and saves
  122.   them to abc.doc and textfile
  123.  
  124. PPDO util/prg.man FAST SUFFIX
  125.   crunches the file util/prg.man with the fastest mode and saves it to
  126.   util/prg.man.pp
  127.  
  128. SPat PPDO #?/#?.(doc|dok|man) RECRUNCH MINSIZE 2000
  129.   recrunches all files ending with ".doc", ".dok" or ".man" which have at
  130.   least 2000 bytes.
  131.  
  132.  
  133.  
  134. In the following tables name is the original name of the file and
  135. in the next columns you find the name the file will be saved to.
  136.  
  137. CRUNCH
  138.  
  139. name                 | no SUFFIX              SUFFIX
  140. ---------------------+-----------------------------------------
  141. abc                  | abc                    abc.pp
  142. abc.pp               | abc.pp                 abc.pp
  143. dir/abc              | dir/abc                dir/abc.pp
  144. dev:dir1/dir2/abc.pp | dev:dir1/dir2/abc.pp   dev:dir1/dir2/abc.pp
  145.  
  146. DECRUNCH
  147.  
  148. name      | no SUFFIX   SUFFIX
  149. ----------+--------------------
  150. abc       | abc         abc
  151. abc.pp    | abc.pp      abc
  152. abc.pp.pp | abc.pp.pp   abc.pp
  153.  
  154. DESTDIR
  155.  
  156. name              | DESTDIR ram:   DESTDIR dev:dir   DESTDIR ""
  157. ------------------+---------------------------------------------
  158. abc               | ram:abc        dev:dir/abc       abc
  159. dir/abc           | ram:abc        dev:dir/abc       abc
  160. dev:abc           | ram:abc        dev:dir/abc       abc
  161. dev:dir1/dir2/abc | ram:abc        dev:dir/abc       abc
  162.  
  163.  
  164. Ctrl-C / Ctrl-D handling:
  165. During crunching the program is interruptable via Ctrl-C, PPDO will quit
  166. immediately. If you press Ctrl-D the current crunch process will be
  167. aborted, the next file will be loaded and processed (if their is any).
  168.  
  169.  
  170. 4. History
  171. **********
  172.  
  173. V0.90  4.8.92
  174.   first code, first working version
  175. V1.00  4.8.92
  176.   de-/recrunching added
  177. V1.10  4.8.92
  178.   MINSIZE, PRI option added; Ctrl-C/D handling changed; minor fixes
  179. V1.20  5.9.92
  180.   DESTDIR option added; text output changed a bit
  181. V1.21  6.9.92
  182.   DESTDIR "" possible
  183.  
  184.  
  185.  
  186. Send bug reports, hints, ideas and 68040-cards :-) to:
  187.  
  188.         Thies Wellpott
  189.         Moorhauser Weg 14
  190.         2948 Schortens 1
  191.  
  192.         Germany
  193.  
  194.         (no e-mail, sorry)
  195.  
  196.