home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 13 / amigaformatcd13.iso / -in_the_mag- / workbench / uuhx_101 / uuhx.txt < prev    next >
Text File  |  1997-03-11  |  7KB  |  246 lines
  1.  
  2.                                 UUhx  v1.01
  3.                                By Adam Dawes
  4.                               24th June, 1995
  5.  
  6.  
  7. What is UUhx?
  8. =============
  9.  
  10. If you've ever tried to send a binary file over (for example) an electronic
  11. mail network, you'll no doubt have realised that there are a few problems.
  12. Your mail system will completely mangle any binary files that you try to
  13. send, and the result will be a corrupt file arriving at the other end.
  14.  
  15. UUhx is a utility that will convert any binary files to a purely text file,
  16. or will convert the text file back to a binary file. It uses a standard
  17. known as 'UUencoding', and programs to en-/decode UUencoded files can be
  18. found on just about every computer platform in use today (UNIX, VMS, PCs,
  19. etc.).
  20.  
  21. UUhx is compatible with all these other UUencoding/decoding utilities, so
  22. it should be very easy for you to send and receive UUencoded files to/from
  23. other computer platforms using UUhx.
  24.  
  25.  
  26.  
  27. Why use UUhx?
  28. =============
  29.  
  30. UUhx has several advantages over the other UUcoding programs available for
  31. the Amiga:
  32.  
  33.   ·  Speed
  34.  
  35.      UUhx is much faster than other UUcoders. For example, over 30% faster
  36.      at both encoding and decoding than UUxT.
  37.  
  38.  
  39.   ·  Full archiver support
  40.  
  41.      UUhx is capable of automatically archiving files before UUencoding,
  42.      and of automatically unarchiving files after decoding. Archivers
  43.      currently supported are Stefan Boberg's LhA and Jonathan Forbes'
  44.      LZX. Complete archiver configurability will be added in the next
  45.      version of UUhx so that *any* archiver can be used for both
  46.      compressing and uncompressing files.
  47.  
  48.  
  49.   .  Simple and flexible parameters.
  50.  
  51.      Using/changing archivers is very straightforward. Wildcards fully
  52.      supported for archivers.
  53.  
  54.  
  55.   ·  Freely distributable.
  56.  
  57.      Does not add stupid shareware messages to encoded files.
  58.  
  59.  
  60.  
  61. System requirements
  62. ===================
  63.  
  64. UUhx should work on any Amiga running kickstart 2 or greater.
  65.  
  66.  
  67.  
  68. Using UUhx
  69. ==========
  70.  
  71. When run with no parameters, UUhx will print the following usage summary to
  72. the screen:
  73.  
  74.  
  75.  Usage: UUhx a <uuefile> <sourcefile> ..................... encode a file
  76.         UUhx x <uuefile> .................................. decode a file
  77.         UUhx l <uuefile> <archiver> <sourcefiles> ......... archive/encode
  78.         UUhx u <uuefile> <archiver> ....................... archive/decode
  79.  
  80.  
  81. The basic options are as follows:
  82.  
  83.   'a' (encode a file)
  84.  
  85.     This option instructs UUhx to take a binary file (specified as
  86.     'sourcefile' in the usage summary) and convert it to a UUencoded text
  87.     file ('uuefile').
  88.  
  89.     For example:
  90.  
  91.       UUhx a AmigaPic.uue ram:Amiga.iff
  92.  
  93.     This will convert the binary file 'ram:Amiga.iff' to the UUencoded file
  94.     'AmigaPic.uue', in the current directory.
  95.  
  96.  
  97.   'x' (decode a file)
  98.  
  99.     The 'x' option will convert a UUencoded file back to its original
  100.     binary form.
  101.  
  102.     For example:
  103.  
  104.       UUhx x MAIL:Inbound/AmigaPic.uue
  105.  
  106.     This will convert the AmigaPic.uue file in MAIL:Inbound/ back to its
  107.     original form. The original filename ('Amiga.iff', in this case) is
  108.     contained within the UUencoded file, so there's no need for you to
  109.     specify it when extracting the binary file.
  110.  
  111.  
  112.   'l' (archive and encode file(s))
  113.  
  114.     This option is similar to the 'a' (encode) option, but allows you to
  115.     use an archiver of your choice to compress files to be encoded before
  116.     the UUencoding process takes place. You may use any supported archiver
  117.     for the compression (currently LhA and LZX are supported).
  118.  
  119.     Some examples:
  120.  
  121.       UUhx l Picture.uue LhA AmigaLogo.iff
  122.  
  123.     This will invoke LhA to compress the AmigaLogo.iff file, and then will
  124.     UUencode the resulting archive. Note that the archive is given the same
  125.     name as the resulting UUe file, but without a .uue extension if one is
  126.     present (so in this case the archive will be called 'Picture.lha').
  127.     Also, the archive is created in T: and deleted after it has been
  128.     encoded, so you never need worry about cleaning up all the archives
  129.     after they have been encoded.
  130.  
  131.       UUhx l Pictures.uue LZX ram:Pic1.iff ram:Pic2.iff ram:Pic3.iff
  132.  
  133.     This will invoke LZX to compress the three files specified to the
  134.     archive 'Pictures.LZX', and will then UUencode the archive to
  135.     'Pictures.uue'.
  136.  
  137.       UUhx l TestFile.uue LhA ~(*.info) ENV:
  138.  
  139.     This invokes LhA to archive all files in the current directory except
  140.     for icons and all of the ENV: directory to 'TestFile.lha', and to then
  141.     Uuencode the archive to TestFile.uue.
  142.  
  143.  
  144.   'u' (decode and unarchive file(s))
  145.  
  146.     The 'u' option is the reverse of the 'l' option. It first decodes the
  147.     specified UUe file, and then uses your selected archiver to decompress
  148.     the files contained within the archive. Note that this option *does*
  149.     leave the resulting archive in the directory (instead of deleting it,
  150.     as is the case for the 'l' option).
  151.  
  152.     Example:
  153.  
  154.       UUhx u MyFile.uue lzx
  155.  
  156.     This will first decode MyFile.uue, and then UnLZX the resulting
  157.     archive.
  158.  
  159.  
  160.  
  161. Legal stuff
  162. ===========
  163.  
  164. I won't accept responsibility for any damage done to your system or data
  165. lost, directly or indirectly, as a result from using this program or any of
  166. its associated files. You use the program entirely at your own risk. Of
  167. course if you *do* experience problems then I'll do what I can to sort them
  168. out, and please let me know so that I can try to cure them in a future
  169. release.
  170.  
  171. UUhx and its associated files are not public domain. They may be
  172. distributed freely as long as no unreasonable charge is imposed. They may
  173. not be included within any commercial package without express written
  174. permission from the author; the exceptions from this are the AmiNet CDs and
  175. Fred Fish's collections. UUhx may only be distributed if all files
  176. contained within the original archive are present.
  177.  
  178.  
  179.  
  180. History
  181. =======
  182.  
  183.    v1.0 (39.0) -- 19/6/95
  184.  
  185.       Initial release.
  186.  
  187.    v1.01 (39.1) -- 24/6/95
  188.  
  189.       UUdecoding now 40% faster than v1.0
  190.  
  191.       LhA and LZX (de)archiving fully supported.
  192.  
  193.       Memory deallocation problems fixed.
  194.  
  195.  
  196.  
  197. Things to do
  198. ============
  199.  
  200.    To do:
  201.  
  202.      Graphical User Interface option.
  203.  
  204.      Full archiver configurability, so that *any* archiver can be used
  205.      for encoding/decoding.
  206.  
  207.      Automatic archiver detection for decoding.
  208.  
  209.      Splitting encoded files to multiple smaller files for posting to
  210.      systems that restrict the size of mail/news messages.
  211.  
  212.      Decoding multiple split files to a single binary file.
  213.  
  214.      Output of UUdecode/dearchiving to selectable directory, not just the
  215.      current directory as at present.
  216.  
  217.  
  218.  
  219. Contacting the author
  220. =====================
  221.  
  222. If you like UUhx, have found a bug, or have suggestions for its future,
  223. please contact me! I can be contacted via electronic mail or snail mail. I
  224. can't promise to reply quickly to snail mail, but I will always reply to
  225. email messages. I won't complain if anyone decides to send money! :)
  226.  
  227.   InterNet:
  228.       ad32@brighton.ac.uk
  229.  
  230.   FidoNet:
  231.       Adam Dawes@2:441/93.5
  232.  
  233.   Snail Mail:
  234.       Adam Dawes
  235.       47 Friar Road
  236.       Brighton
  237.       BN1 6NH
  238.       England
  239.  
  240.  
  241.  
  242.                        UUhx is a "BeachWare" product
  243.               from the Beachy Head Amiga BBS, Eastbourne, UK
  244.                    2:441/93@FidoNet   +44 (0)1323 520999
  245.                   7 days/24 hours  300-28800 bps  2 lines
  246.