home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 602a.lha / XX_(en)Decode / XXDecode.ReadMe.pp / XXDecode.ReadMe
Text File  |  1992-02-09  |  8KB  |  194 lines
  1. XXDecode for the Amiga
  2. ----------------------
  3.  
  4.    XXDecode is used to transform files created by XXEncode back
  5.    into their original forms.  (see the XXEncode readme file
  6.    for typical use and reasons for choosing xxencoding)
  7.  
  8.  
  9.    ------------------------------------------------------------
  10.    DISCLAIMER : This work (the executables) is Freeware.
  11.         The executable files can be distributed in any
  12.         way, so long as they are the ORIGINAL programs.
  13.         That is, patches or changes to the code should
  14.         NOT be distributed.  I claim no responsibility
  15.         for any damage or problems this program may
  16.         cause.    Use at your own risk.
  17.         If at all possible, include the readme files
  18.         when distributing.
  19.    ------------------------------------------------------------
  20.  
  21.  
  22.    XXDecode may only be used from the CLI.
  23.  
  24.    Usage : XXDecode [switches] input_file1 [input_file2...]
  25.  
  26.    For switch usage, see below.
  27.  
  28.    Any number of input files (XXEncoded files) may be given on
  29.    the command line (wildcards are not supported, however...see the
  30.    TODO section for more on this).  Note that I have tested
  31.    how XXDecode reacts to NON-XXEncoded files (archives, executables,
  32.    etc.) so that weird things (gurus, freezing, etc.) don't happen.
  33.    A beta version of XXDecode once crashed if I gave it a ".lzh"
  34.    archive, but this is of course fixed now.  (Hi Geoffrey! ;-)
  35.  
  36.  
  37.    Switch Usage :
  38.    --------------
  39.  
  40.  
  41.       All switches must be grouped (as in "-RC") if more than
  42.       one is used ("-R -C" is not valid).  See the TODO section
  43.       for more info on this.  Also, all the switches MUST appear
  44.       BEFORE any filenames ("XXDecode file -R" is not valid).
  45.  
  46.  
  47.    -E
  48.    ===
  49.       Using the -E switch causes XXDecode to restart the search for
  50.       'begin' lines when an error is found.  That is, if for any
  51.       reason (except for complete failure to open), an input file
  52.       contains an error, we will just start looking for another
  53.       'begin' line in it (instead of quitting that file).  This comes
  54.       in handy when you have several encoded files concatenated into
  55.       one file...turn this switch on and you'll be guaranteed to get
  56.       every valid file extracted that it possibly can (note that error
  57.       files are deleted along the way unless you also use -D).
  58.  
  59.    -D
  60.    ===
  61.       If extraction of a file has begun, and an error is found,
  62.       the partially extracted file will be deleted.  You can turn
  63.       on the -D switch to override this...if you do, it will indeed
  64.       stop processing when it finds an error, but it won't destroy
  65.       it.  This feature is just to provide a way to salvage as much
  66.       as possible from a damaged file (pretty useless, except for
  67.       text files perhaps).
  68.  
  69.    -C
  70.    ===
  71.       Using -C will cause XXDecode to interpret the last character
  72.       in each input line as a checksum.  This is so that if the
  73.       file was damaged in such a way that normal error checking
  74.       fails, you will know.
  75.       If the -C flag is NOT used on file that contains checksum characters,
  76.       no errors should be reported...they are ignored.    Note that this
  77.       relaxed feature may not catch a few errors in the encoded file.
  78.       Using -C on a file that does NOT contain checksum characters
  79.       will fail...in this case, you'll just have to not use the -C
  80.       switch and hope the other miscellaneous error checking will
  81.       catch everything.
  82.  
  83.    -R
  84.    ===
  85.       The -R switch will allow you to extract files that already exist
  86.       at the time.  Normally, overwriting of the files you are decoding
  87.       is prohibited.  Just a luxury to save you the task of deleting the
  88.       file yourself before running XXDecode.
  89.  
  90.  
  91.    NOTE : If a file begins with a minus sign ('-') or is enclosed
  92.       in double quotes ('"'), you must enclose the ENTIRE filename
  93.       in double quotes.
  94.       For example, if you have two files :
  95.          -file1
  96.            and
  97.          "file2"
  98.       To reference either of these types of files with XXDecode,
  99.       call them :
  100.          "-file1"
  101.            and
  102.          ""file2""
  103.       NEVER use the apostrophe ("'") to escape AmigaDOS's special
  104.       characters.  For example, if your file is named :
  105.          File#1(part2)
  106.       just type it on the command line verbatim...i.e., DON'T use
  107.          File'#1'(part2')
  108.       as the AmigaDOS manual states.
  109.       If this is unclear or seems strange, you probably won't have
  110.       to worry about it.  I only made this feature so that people
  111.       that had filenames with abnormal (relatively speaking) char-
  112.       acters wouldn't have to rename or do anything special.
  113.  
  114.  
  115.    Miscellaneous Notes :
  116.    ---------------------
  117.  
  118.       Multiple input files (separated by spaces) are supported.
  119.       Each input file is tried to be opened in the following manner :
  120.      1. 'file'.XXE is tried first
  121.      2. if (1) failed, 'file' is tried
  122.       This is so that if you have two files 'File1' and 'File1.XXE'
  123.       you can still simply leave off the '.XXE' extension, even though
  124.       the non-XXE version exists.  If (2) had been done first, this
  125.       would not be possible, since 'File1' (which in most circumstances
  126.       would NOT be an XXEncoded file) would be tried first.
  127.  
  128.       You may of course have many begin-end sequences in one file...they
  129.       will all be processed independently.  This is an alternative
  130.       to typing in many filenames on the command line...just join all
  131.       the input files into one, and XXDecode.  All will be extracted!
  132.  
  133.       Also note that any switches apply to ALL files, both the individual
  134.       files listed on the command line, and every encoded file within
  135.       those files.  Remember this when using -R with more than one input
  136.       file -- it applies globally!
  137.  
  138.       Note that if you want to use more than one switch, they MUST be
  139.       grouped together...only one '-' symbol should be used.  For
  140.       example "-RCD" is valid while "-RC -D" is not (in this case "-D"
  141.       would try to be opened as a file).
  142.       Also note that case of the letters doesn't matter..."-e" is
  143.       the same as "-E".
  144.  
  145.       Line numbers given in the error messages (during program
  146.       execution) correspond to the number of actual ENCODED lines.
  147.       That is, line #1 is the first encoded line after the 'begin'
  148.       line.
  149.  
  150.       Send all bug reports and spelling mistakes to one of the e-mail
  151.       addresses listed at the end of this document.  No matter how
  152.       trivial it seems!
  153.  
  154.  
  155.    TODO :
  156.    ------
  157.  
  158.    *   Make it possible to use the switches separately (as in "-R -E")
  159.        as well as the existing grouping method.  Why is this not done
  160.        already?  Although it is a simple alteration, it will complicate
  161.        the way I process files a bit.  I'd rather not open this can of
  162.        worms just yet.    :-)  Next version...I promise.    :-)
  163.  
  164.    *   Allow pattern matching for filenames.  This shouldn't be a
  165.        problem and will probably be out soon.  This may also change the
  166.        way I process files somewhat, which is why it is not already
  167.        implemented.  But as Paul Baldwin from 'Coffee Talk' would say,
  168.        "No big whup."  :~)
  169.  
  170.    *   Join the two readme files into one so I don't have all this
  171.        unneccessary repetition of the same instructions!!!!!!!!! ;~)
  172.  
  173.  
  174.    THANKS TO :
  175.    -----------
  176.  
  177.       Geoffrey Faivre-Malloy for giving me the original VMS source,
  178.      testing the beta versions, his opinions, tips, advice,
  179.      inspiration, and his undying support to make XXEncode
  180.      more popular than UUEncode !!    ;-)
  181.  
  182.       Danny Osborne for providing the checksum technique.  Without
  183.      him I would probably still be fiddling around with it! :~)
  184.  
  185.  
  186.  
  187.    Bug reports and correspondence :
  188.    --------------------------------
  189.  
  190.       Ernest Crvich       |      crvich@csugrad.cs.vt.edu
  191.       P.O. Box 11821       |      general@vtvm1.cc.vt.edu
  192.       Blacksburg, VA       |      general@vtvm1.bitnet
  193.       24062-1821
  194.