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