home *** CD-ROM | disk | FTP | other *** search
/ back2roots/padua / padua.7z / padua / uucp / XXpair.lzh / XXEncode.ReadMe < prev   
Text File  |  1992-02-02  |  9KB  |  209 lines
  1. XXEncode for the Amiga
  2. ----------------------
  3.  
  4.    ------------------------------------------------------------
  5.    DISCLAIMER : This work (the executables) is Freeware.
  6.         The executable files can be distributed in any
  7.         way, so long as they are the ORIGINAL programs.
  8.         That is, patches or changes to the code should
  9.         NOT be distributed.  I claim no responsibility
  10.         for any damage or problems this program may
  11.         cause.    Use at your own risk.
  12.         If at all possible, include the readme files
  13.         when distributing.
  14.    ------------------------------------------------------------
  15.  
  16.    XXEncode is used to transform files into ones such that they
  17.    can be sent via network mailers.  This encoding method is
  18.    similar to the popular UUEncode, yet is much more compatible
  19.    with various systems.  For instance, UUEncoded files cannot
  20.    be sent to or from a VM/XA system, since some of the char-
  21.    acters used in UUEncode are not translated correctly.  With
  22.    XXEncode, however, most if not all (I don't know of any that
  23.    can't use it) network systems translate properly.  Also, some
  24.    UUEncode (especially the Unix versions) implementations use
  25.    the space (' ') character in the encoding, which when
  26.    appearing at the end of a line may cause truncation problems.
  27.    XXEncode uses no spaces...the character set that XXEncode
  28.    uses contains the numbers 0 through 9, the lowercase letters
  29.    'a' through 'z', the uppercase letters 'A' through 'Z', the
  30.    plus character '+', and the minus character '-'.
  31.  
  32.    It is my sincere hope that XXEncode will be useful for those
  33.    people using systems that cannot handle UUEncoded files.  I
  34.    personally use an VM/XA system and have been extremely
  35.    irritated at UUEncode many times in the past.  Now, my E-Mail
  36.    friends and I all use XXEncode.  My hope is that XXEncode
  37.    will become popular enough so that other people requiring
  38.    this type of utility, but cannot use UUEncode because of the
  39.    reasons stated above, can find a version of XXEncode easily.
  40.    Since I have seen MSDOS and VM/XA versions, I decided to
  41.    concentrate my efforts on the Amiga.  Note that neither the
  42.    MSDOS nor the VM version featured the myriad of options and
  43.    conveniences of this version, nor did they use any checksum
  44.    method.  I plan to port the Amiga version to MSDOS soon.
  45.  
  46.    Note : You can see what version the executable is by using
  47.       AmigaDOS's "Version" command.  Just type :
  48.         Version XXEncode
  49.       at the CLI prompt.  This is for minor updates in
  50.       the future.  Readme files may or may not be updated
  51.       (NOT in the case of bug fixes...only in the case
  52.        of new usage or added features) with each new
  53.       version, so the executable is the *actual* version
  54.       if it is in question at all.
  55.  
  56.    XXEncode may only be used from the CLI.
  57.  
  58.    Usage : XXEncode [switches] input_file1 [input_file2...] [output_file]
  59.  
  60.    For switch usage, see below.
  61.  
  62.    You may supply any number of input files.  There is one case
  63.    where you **MUST** supply an output file : if you supply more
  64.    than one input file AND you do NOT use the -S switch, YOU
  65.    MUST SUPPLY an output filename is the last argument.  BE VERY
  66.    CAREFUL!!!  IF YOU USE THE -R SWITCH IN THIS CASE AND THE
  67.    LAST ARGUMENT ALREADY EXISTS, IT WILL BE OVER-WRITTEN!!!
  68.    I have included a 'catch' in the code for just such an
  69.    occurance...it will ask if you are sure you want to use that
  70.    file as the output file after all!  :->  Try it out to see
  71.    what I'm talking about.
  72.  
  73.  
  74.  
  75.  
  76.  
  77.    Switch Usage :
  78.    --------------
  79.  
  80.  
  81.       All switches must be grouped (as in "-RC") if more than
  82.       one is used ("-R -C" is not valid).  See the TODO section
  83.       for more info on this.  Also, all the switches MUST appear
  84.       BEFORE any filenames ("XXEncode file -R" is not valid).
  85.  
  86.  
  87.    -C
  88.    ===
  89.       Using -C will cause XXEncode to create a checksum character
  90.       for each line (which is appended to the end of the line).
  91.       This is so that if the file becomes damaged in such a way that
  92.       normal error checking fails, XXDecode can be more accurate in
  93.       finding corrupt lines.
  94.  
  95.    -R
  96.    ===
  97.       The -R switch will allow XXEncode to overwrite files that already
  98.       exist (the output file(s)).
  99.       Normally, overwriting of the output file(s) is prohibited.
  100.       Just a luxury to save you the task of deleting the
  101.       file yourself before running XXEncode (and a bit of safety as
  102.       well!!!).
  103.  
  104.    -M
  105.    ===
  106.       This causes XXEncode to make all output files relate to the
  107.       number of input files at a 1:1 ratio.  WHAT?!  :->  What I
  108.       mean is, there will be the same number of output files as
  109.       input files (you don't actually supply an output name...all
  110.       output files will be called '<infile>.XXE' where <infile>
  111.       is the particular input file that is being processed).  The
  112.       expected use for this is when you want to process many input
  113.       files, but don't want them all put in one output file.  Be
  114.       careful when using -R in conjunction with this...remember
  115.       that switches affect ALL files on the command line!
  116.  
  117.  
  118.  
  119.    NOTE : If a file begins with a minus sign ('-') or is enclosed
  120.       in double quotes ('"'), you must enclose the ENTIRE filename
  121.       in double quotes.
  122.       For example, if you have two files :
  123.          -file1
  124.            and
  125.          "file2"
  126.       To reference either of these types of files with XXEncode,
  127.       call them :
  128.          "-file1"
  129.            and
  130.          ""file2""
  131.       NEVER use the apostrophe ("'") to escape AmigaDOS's special
  132.       characters.  For example, if your file is named :
  133.          File#1(part2)
  134.       just type it on the command line verbatim...i.e., DON'T use
  135.          File'#1'(part2')
  136.       as the AmigaDOS manual specifies.  The only "special"
  137.       characters you need to do anything about are files that
  138.       begin with a minus sign or are enclosed in double quotes.
  139.       If this is unclear or seems strange, you probably won't have
  140.       to worry about it.  I only made this feature so that people
  141.       that had filenames with abnormal (relatively speaking)
  142.       characters wouldn't have to rename or do anything special.
  143.       This implies that pattern matching is not available.    See
  144.       more about that in the TODO section.
  145.  
  146.  
  147.    Miscellaneous Notes :
  148.    ---------------------
  149.  
  150.       If more than one input file is used on the command line, you
  151.       MUST also supply an output filename...all input files that are
  152.       processed will be put into this output file.  I can already
  153.       hear you grumbling...if you want to process multiple files but
  154.       want them put into their own separate output files, see the
  155.       '-M' switch usage above.  Also remember that when you only
  156.       encode one file, you don't have to supply an output filename
  157.       if you don't mind the automatic filename that is created (see
  158.       usage note by running the executable).
  159.  
  160.       Note that if you want to use more than one switch, they MUST be
  161.       grouped together...only one '-' symbol should be used.  For
  162.       example "-RCM" is valid while "-RC -M" is not (in this case "-M"
  163.       would try to be opened as a file).
  164.       Also note that case of the letters doesn't matter..."-m" is
  165.       the same as "-M".  See the TODO section for more on this.
  166.  
  167.       Please send any and all bugs or mistakes to one of the e-mail
  168.       addresses listed at the end of this document.  No bug is too
  169.       trivial (heck, I even want to hear about spelling mistakes in
  170.       the readme files!) !! ;^)
  171.  
  172.  
  173.    TODO :
  174.    ------
  175.  
  176.    *  Make it possible to use the switches separately (as in "-R -M")
  177.       as well as the existing grouping method.    Why is this not done
  178.       already?    Although it is a simple alteration, it will complicate
  179.       the way I process files a bit.  I'd rather not open this can of
  180.       worms just yet.  :-)
  181.  
  182.    *  Allow pattern matching for filenames.  This shouldn't be a
  183.       problem and will probably be out soon.  This may also change the
  184.       way I process files somewhat, which is why it is not already
  185.       implemented.  But as Paul Baldwin from 'Coffee Talk' would say,
  186.       "No big whup."  :~)
  187.  
  188.  
  189.    THANKS TO :
  190.    -----------
  191.  
  192.       Geoffrey Faivre-Malloy for giving me the original VMS source,
  193.      testing the beta versions, his opinions, tips, advice,
  194.      inspiration, and his undying support to make XXEncode
  195.      more popular than UUEncode !!    ;-)
  196.  
  197.       Danny Osborne for providing the checksum technique.  Without
  198.      him I would probably *still* be fiddling around with it! :~)
  199.  
  200.  
  201.  
  202.    Bug reports and correspondence :
  203.    --------------------------------
  204.  
  205.       Ernest Crvich       |      crvich@csugrad.cs.vt.edu
  206.       P.O. Box 11821       |      general@vtvm1.cc.vt.edu
  207.       Blacksburg, VA       |      general@vtvm1.bitnet
  208.       24062-1821
  209.