home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / cli / ppdecrun.lzh / PPDecrunch.Doc < prev    next >
Text File  |  1991-07-22  |  10KB  |  257 lines
  1. PPDecrunch Version 1.0  (July 22, 1991)
  2.  
  3. Pipeable PowerPacker Decruncher
  4.  
  5. Copyright (C) 1991 by Darren Ewaniuk
  6.  
  7. -----------------------------------------------------------------------------
  8.  
  9. Description:
  10.  
  11. PPDecrunch allows you to decrunch PowerPacked data files to STDOUT.  What
  12. does that mean, you say?  Why not use the plain old Decrunch program provided
  13. with PowerPacker?  Well, by sending output to STDOUT, PPDecrunch can allow
  14. you to view PowerPacked files with SOME programs that otherwise cannot
  15. decrunch PowerPacked files by themselves.  These programs MUST be able to
  16. accept input from STDIN.  For example, LESS and MORE are capable of doing
  17. this.  This comes in especially handy for remote shells and BBS'es, as most
  18. text readers except MORE open their own window, therefore they cannot display
  19. on the remote screen.  For examples of what you can do with PPDecrunch, see
  20. the Examples section.
  21.  
  22. -----------------------------------------------------------------------------
  23.  
  24. Requirements:
  25.  
  26. You should have PowerPacker.Library V33+ installed in your LIBS: directory.
  27.  
  28. If you want to use pipes, you must be using a shell that handles pipes, and
  29. have the appropriate pipe device mounted.  WShell and ArpShell both have this
  30. capability when used with the PIP: device.  (I highly recommend WShell
  31. by Bill Hawes of Wishful Thinking Software, very good stuff!)
  32.  
  33. -----------------------------------------------------------------------------
  34.  
  35. Contents:
  36.  
  37.     PPDecrunch              The executable for PPDecrunch
  38.     PPDecrunch.c            C Source code for PPDecrunch
  39.     PPDecrunch.Doc          You're reading it!
  40.     PPDecrunch.Doc.info     The icon for the documentation file
  41.     powerpacker.library     The PowerPacker library
  42.  
  43. -----------------------------------------------------------------------------
  44.  
  45. Installation:
  46.  
  47. Copy powerpacker.library to LIBS: if it isn't already there.
  48.  
  49. Copy PPDecrunch to your command path.  C: is a likely candidate for this.
  50.  
  51. -----------------------------------------------------------------------------
  52.  
  53. Usage:
  54.  
  55.     PPDecrunch <filename>
  56.  
  57.     <filename> is the file you wish to decrunch to STDOUT.
  58.  
  59.     PPDecrunch tries to open <filename> and then <filename>.pp if it
  60.     couldn't find <filename>
  61.  
  62.     The file can be crunched with PowerPacker, or it can be a plain file.
  63.     PPDecrunch (actually PowerPacker.library) doesn't care, and if the file
  64.     is a plain file, it doesn't decrunch it, just outputs it.
  65.  
  66.     Use a Control-C break to stop PPDecrunch during output.
  67.  
  68. Simple huh?
  69.  
  70. For script users, PPDecrunch will return one of these error codes:
  71.  
  72. 0:          No problem.
  73.  
  74. 1:          No file specified in command line.
  75.  
  76. 10: (ERROR) PPDecrunch could not decrunch the file for some reason.
  77.  
  78. 11: (ERROR) PPDecrunch could not open powerpacker.library or could not
  79.             open the standard error channel.
  80.  
  81. Any error message will be sent to the standard error channel, so that it
  82. will go to the window, NOT the redirected or piped file or device.
  83.  
  84. -----------------------------------------------------------------------------
  85.  
  86. Examples:
  87.  
  88.     PPDecrunch PPDecrunch.doc
  89.         Decrunches the file PPDecrunch.Doc and displays it on the shell
  90.         window (note that no paging or other filtering is used)
  91.  
  92.     PPDecrunch >File CrunchedFile
  93.         Decrunches the file "CrunchedFile" and saves it as "File".
  94.         Probably slower than Decrunch, because it works through STDOUT,
  95.         but hey it works.
  96.  
  97.     PPDecrunch >PRT: SomeProgram.Manual
  98.         Decrunches the file "SomeProgram.Manual" and prints it to PRT:
  99.  
  100.     The above can be done with any plain old shell or CLI.  Look under
  101.     "redirection" in your shell manual for more use of redirection.
  102.  
  103.     The following must be done with a pipe device and a pipeable shell.
  104.  
  105.     PPDecrunch CrunchedText | More
  106.         Decrunches the file "CrunchedText" and pages it through MORE
  107.         This one could be very handy for remote shells or BBS'es.
  108.  
  109.     There are many ways to use pipes.  Check your shell's manual for more
  110.     ideas on how to use this.
  111.  
  112. -----------------------------------------------------------------------------
  113.  
  114. Limitations:
  115.  
  116. None that I know of yet.
  117.  
  118. -----------------------------------------------------------------------------
  119.  
  120. Bugs:
  121.  
  122. No known bugs at this time.  Please notify me of any bugs, crashes,
  123. enforcer hits, or bad programming practises you notice in this program.
  124.  
  125. -----------------------------------------------------------------------------
  126.  
  127. Revision history:
  128.  
  129. 30-Jun-91 - Creation date
  130.  
  131. 22-Jul-91 - Version 1.0     First public release
  132.  
  133. -----------------------------------------------------------------------------
  134.  
  135. Disclaimer:
  136.  
  137. This program works to my knowledge.  However, bugs may indeed be lurking
  138. in this code, so if you choose to use this program, be forewarned.
  139. I am not responsible for any loss or inconvenience caused by this program,
  140. and it has no warranty or guarantee.
  141.  
  142. If you discover any bugs or missing features, I would like to know about
  143. them so that I can fix them when I have the time.
  144.  
  145. -----------------------------------------------------------------------------
  146.  
  147. Distribution:
  148.  
  149. This program is 'User Group Ware'.
  150. If you like it, join your local Amiga users group, and send me a letter
  151. telling me about your user group.  You will then be a 'registered' user
  152. of the program.  You will also benefit from being a member of a users
  153. group, so its a win-win situation.
  154.  
  155. If you feel like it, you can send money or some freely
  156. distributable software that you like, but this is purely optional.
  157.  
  158. For companies wishing to use this program for their own internal use, a
  159. donation to the local user group greater than or equivalent to membership
  160. fees for one year will suffice to become a 'registered' user.
  161.  
  162. The local user group here is AmiCUE (Amiga Commodore Users of Edmonton).
  163. Meetings are on the third Thursday of every month.
  164. Call 469-6694 for more information.
  165.  
  166. If you want updates, or request a new feature, send me a disk and enough
  167. postage to get it back to you from here and I'll send you the latest
  168. version, and anything else new I might come up with (if anything).
  169.  
  170. This program is freely distributable, with the following conditions:
  171.  
  172. 1) This program shall not be used commercially without my prior permission.
  173.    Companies using this for their own internal use are free to use it as
  174.    stated above.  All in all, this means that, without prior permission:
  175.  
  176.    a) This program cannot be used in a commercial package.
  177.  
  178.    b) This program cannot be used on disk magazines and on disks which sell
  179.       for more than what Fred Fish charges for his disk collection at the
  180.       time.  Currently, this is $6.00US.  Convert this to local currency, and
  181.       if the selling price without tax is more than this, you can't sell it!
  182.  
  183.       Permission is explicitly granted to Fred Fish and all registered
  184.       Amiga user groups to distribute this program.
  185.  
  186. 2) This program shall be distributed with all files intact.  This means that:
  187.  
  188.    a) All files must be distributed, including the executable, source code,
  189.       and documentation.
  190.  
  191.    b) This program must not be disk warped.  Disk warps are a pain for hard
  192.       drive users, are prone to virus infections, and some are not reliable.
  193.       LZH, ZIP, ZOO, ARC, PAK, and similiar file-oriented archives are fine.
  194.  
  195.    c) None of the files should be distributed in powerpacked or likewise
  196.       crunched form.  You may do so for your own use, but keep the original
  197.       uncrunched form for distribution, so that others may use it without
  198.       requiring special programs or suffering from that 'uncrunch' flash.
  199.  
  200.    d) If you modify this program and wish to distribute it, you are free to
  201.       do so as long as you include your modified source code and executable
  202.       AS WELL AS the original source code, executable, and other files in
  203.       this distribution.  Also, the conditions of the distribution must not
  204.       be changed (you still can't sell it or use it commercially).
  205.  
  206. In short, I don't want others taking credit for or making money from this
  207. software, and don't want it to be distributed with missing or hacked up
  208. files.  Remember that I can waive any of the rules if you talk to me first!
  209.  
  210. -----------------------------------------------------------------------------
  211.  
  212. How to reach me:
  213.  
  214. MAIL:    Darren Ewaniuk
  215.          Box 1262
  216.          Vegreville AB CANADA
  217.          T0B 4L0
  218.  
  219.          This is my permanent address and will not change, unlike my
  220.          present address, as I am currently a student.
  221.  
  222. PHONE:   (403)452-2658 (until end of December 1991)
  223.          (403)768-2431 (after December 1991 or if above fails)
  224.  
  225. USENET:  ewaniu@ee.ualberta.ca  -or-  ewaniu@bode.ee.ualberta.ca
  226.               (until end of December 1991)
  227.  
  228.          darrene@ersys.edmonton.ab.ca
  229.               (after December 1991 or if above fails)
  230.  
  231. BBS:     I can be reached through Devil BBS in Edmonton AB CANADA.
  232.          I'm NOT the sysop here, but I do frequent this system.
  233.          My user name is (naturally) Darren Ewaniuk.
  234.  
  235.          Its a very nice BBS with over 300 megs of Amiga files.  If
  236.          its near you or if you don't mind long distance, try it out!
  237.  
  238.          Devil BBS
  239.          Sysop Basil Barnes
  240.          (403)484-9200
  241.          Running on an Amiga 2500/30, with USRobotics Dual Standard
  242.          HST/V.32/V.42 capable modem and multi-serial card.
  243.          All Amiga files, over 300MB storage, running Skyline software.
  244.          Freely distributable software only - no pirated stuff here!
  245.  
  246. -----------------------------------------------------------------------------
  247.            _________                       _________
  248.  This is  |         |            This is  |         |         DON'T DO IT!
  249.     your  |  O   O  |               your  |  x   x  |
  250. computer  |    +    |           computer  |   ___   |         Just say NO!
  251.           |  \___/  |         on pirated  |  /  U\  | ___      to piracy
  252.           |_________|           software  |_________|    \
  253.            _________   _                   _________   _  \[Computer sick
  254.           |[][][][][| |_|                 |#&%@!%$&!| |x|   with a virus]
  255.           |][][][][]| | |                /|^!*%@&*@#| | |\
  256.           |_________| |_|   [Nasty words] |_________| |_| [Dead mouse]
  257.