home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 3 / Meeting_Pearls_III.iso / Pearls / arc / Packer / PPData / PPData.doc < prev    next >
Text File  |  1992-04-12  |  6KB  |  162 lines

  1.  
  2. PPData version 1.0
  3. Yet Another PowerPacker Utility
  4. -------------------------------
  5.  
  6. No, not by Nico, but made possible by his powerpacker.library.  This
  7. program is basically an intuition front-end for that library, and allows
  8. you to crunch and decrunch DATA files. "But I've already got
  9. PowerPacker!", I hear you cry. Well, if you only have the shareware
  10. version <= 2.3b, you'll know that crunching can be a time-consuming
  11. business. Later (commercial) versions use speedup-buffers to
  12. dramatically decrease the crunching time. Newer versions of
  13. powerpacker.library provide the facility to use these faster methods of
  14. crunching, and that's where PPData comes in.
  15.  
  16. The program is only for use with Kickstart 2.0 upwards. This is because
  17. it takes advantage of the many breaks programmers were given with the
  18. new OS. Yet another reason to upgrade. You should install
  19. powerpacker.library version 1.4 or higher (version 1.4 is included with
  20. this distribution). To do this, double-click the 'Install' icon.
  21.  
  22. PPData can be started from Workbench or CLI and is self-detatching if
  23. run from CLI (ie. no need to run it). No CLI interface is provided, so
  24. however you start it, you get a small window with menus attached.
  25.  
  26. These should for the most part be self-explanatory if you've used
  27. PowerPacker before, so here's a quick rundown:
  28.  
  29.  
  30. Project Menu
  31. ------------
  32.     Load    Opens up a file requester (asl from Commodore) asking
  33.         for you to select a file. Once selected, PPData
  34.         determines whether the file is already crunched. If it is,
  35.         it looks at the Control settings (see below) to decide
  36.         what to do (decrunch, recrunch with current settings or
  37.         cancel). If the file is not crunched, it is loaded and
  38.         crunched. The window displays various statistics about
  39.         the crunch process, including a progress indicator.
  40.  
  41.     Save    Once you have successfully crunched (or decrunched) a
  42.         file, choose this option to save. Again, a file
  43.         requester pops up prompting for the name. This name is
  44.         initially set to the name of the file you loaded, plus
  45.         or minus a '.pp' extension, depending on whether this is
  46.         required (see Prefs menu below).
  47.  
  48.     Batch    Batch mode. Not nearly as comprehensive as PowerPacker's, 
  49.         but should be adequate for most purposes. First of all,
  50.         it asks for the save path for processed files. Then a
  51.         file requester asks you to select files to process. This
  52.         is done using a Multi-Request asl requester. In this you
  53.         select multiple files as in Workbench way, ie. shift-clicking.
  54.         Unfortunately, all files must be in same directory (this
  55.         is a fault of asl.library, in my opinion).
  56.  
  57.         Once you've selected all your files, click the OK
  58.         gadget. PPData will then load each file, process it (in
  59.         same manner as described in Load item above) and save
  60.         work to the save path, again adding or removing '.pp'
  61.         depending on preferences.
  62.  
  63.     Delete    This lets you delete a file (file-requester pops up).
  64.  
  65.     About    Displays version and author.
  66.  
  67.     Quit    Quits PPData. If current buffer is unsaved, you are warned.
  68.  
  69.  
  70. Prefs Menu
  71. ----------
  72.     Color    Color to use when decrunching files
  73.  
  74.     Efficiency    How efficiently files should be compressed. This
  75.         has a bearing on the speed of crunching.
  76.  
  77.     Speedup        How big a buffer to use. The bigger, the faster,
  78.         but large buffer mode uses an extra 200K or so.
  79.  
  80.     Suffix    Whether to add '.pp' suffix to crunched files.
  81.         PowerPacker utilities such as PPMore automatically look
  82.         for this suffix. Eg. if you crunched this doc and saved
  83.         it as PPData.doc.pp, then typed PPMore PPData.doc,
  84.         PPMore would look for '.pp' file if it couldn't find
  85.         named file.
  86.  
  87.     Overwrite    If set, PPData will query before overwriting a file.
  88.  
  89.     Save Prefs    Saves current preferences to the file S:PPData.config.
  90.  
  91.  
  92. Control Menu
  93. ------------
  94. This controls how PPData reacts when it loads an already crunched file.
  95. 'Always decrunch' and 'Always recrunch' do what they say. 'Ignore
  96. crunched' simply passes over crunched files. 'Query decrunch' pops up a
  97. requester offering the choice of the former three options at the time of
  98. loading. Query mode is most useful in interactive sessions; however, when
  99. using batch mode, it's handy to set one of the other controls to prevent
  100. work being halted with a requester.
  101.  
  102.  
  103. That's the menus; now a few general points. I have tried to make PPData
  104. user-friendly in that it won't let you do silly things, at least without
  105. checking first. It's also preferences-friendly, adjusting window size
  106. and menus to handle currently set fonts, although proportional fonts
  107. might cause problems. But since it's probably a bad idea to use a
  108. proportional font as screen font (since so many programs would break) I
  109. won't be doing anything about it for now.
  110.  
  111. As far as I am aware, PPData frees all of its resources on exiting, and
  112. is bug-free. However, I'd be glad if you contact me if you find out otherwise
  113.  
  114.  
  115. Credits
  116. -------
  117. Well, mostly to Nico Francois for his excellent PowerPacker utilities
  118. and library - PPData's raison d'etre.
  119.  
  120. Credit must also go to Commodore, for making the programmer's life
  121. considerably easier with AmigaDOS 2.0. It's a pity they make such a mess
  122. of their marketing - just as well the product sells itself.
  123.  
  124. Finally, thanks to Steve Koren for SKsh, and Mike Meyer et al. for mg3
  125. (still the best PD text editor).
  126.  
  127.  
  128. Finally
  129. -------
  130. This product is completely public domain (which isn't to say
  131. contributions wouldn't be gratefully appreciated by a poor student
  132. hampered by an authoritarian government which thinks students are a
  133. burden to Society). Distributions should at least include unmodified
  134. binary and this document, and preferably the source too.
  135.  
  136. All suggestions for improvements/modifications, and especially bug
  137. reports are welcome (encouraged even). I'd appreciate it if you didn't
  138. distribute modified versions of PPData without checking with me first.
  139.  
  140. Things I plan:
  141.  
  142.     *    Make it an 'AppWindow' so you can just drop icons into the
  143.     window to have them processed.
  144.  
  145.     *    Enhancement of Batch mode.
  146.  
  147.     *    Add support for encrypted files (does anyone use these?).
  148.  
  149.  
  150. I can be contacted by postal mail at:
  151.  
  152.     Martin W. Scott,
  153.     23 Drum Brae North,
  154.     Edinburgh,
  155.     EH4 8AT,
  156.     (dis)United Kingdom.
  157.  
  158. or by email (preferred) - my address is mws@castle.ed.ac.uk
  159.  
  160. Enjoy!
  161.     
  162.     - Martin.