home *** CD-ROM | disk | FTP | other *** search
/ The Best Internet Programs / BESTINTERNET.bin / internet / uudo15 / uudo15.doc < prev   
Encoding:
Text File  |  1994-08-06  |  8.1 KB  |  170 lines
  1. UUDO v1.5  (c) 1994, Ryan Kim.  -  Multi-file/Multi-part uudecoder
  2.  
  3.  
  4. DESCRIPTION:
  5.  
  6. - UUDO is an "Smart" uudecoder for DOS for generating binary files from
  7.   uuencoded files that may be split into many parts.
  8. - The only requirement is that, for multi-part files, each uuencoded part must
  9.   be in its own file and has a "Subject: ..." line indicating the part number.
  10.   (Assuming the uuencoded files are coming from the Usenet:
  11.   This can be done easily by issuing "s" command without filename inside rn.
  12.   Make sure to start rn with -N and -/ options.)
  13. - UUDO supports the subject line with part numbers in the format of "xx/yy" or
  14.   "xx of yy", where xx is the part number, and the yy is the total part number.
  15.   If none of these is found, it is assumed that the file contains the entire
  16.   uuencoded text for a binary.
  17. - If any error is found in generating a binary file, UUDO will copy all the
  18.   uuencoded part files for that binary to the error directory which can be
  19.   specified in the command line.  If none is specified, it will be asked
  20.   when any error occures.
  21. - A report is generated describing which uuencoded texts were decoded into
  22.   which binary files.
  23.  
  24.  
  25. DISCLAIMER:
  26.  
  27. - This is a FREEWARE.  Although the program is copyrighted by me, Ryan Kim,
  28.   you're allowed to use, copy, and distribute this program for FREE
  29.   as long as nothing is modified in any way, this document is
  30.   always present with the program, and you're not gaining any profit
  31.   with this program.
  32. - There is no warranty whatsoever.  Use it at your own risk!
  33.  
  34. - Please read the section marked "FINAL NOTES" at the end of this document
  35.   for a small (non-obligatory) favour I ask from the users of UUDO program.
  36.  
  37.  
  38. QUICK START:
  39.  
  40. UUDO requires the input files (wildcards allowed).
  41. So something like "UUDO *.*" should work, assuming the uuencoded files are
  42. in the current directory.
  43. Make sure each uuencoded part is in a separate file.
  44.  
  45.  
  46. HOW TO:
  47.  
  48. Typing UUDO by itself gives the following help screen:
  49.  
  50. UUDO v1.5  (c) 1994, Ryan Kim.  -  Multi-file/Multi-part uudecoder
  51.  
  52. Usage:  UUDO input_files [options] [error_directory]
  53.              where options are
  54.              /b:   Batch mode
  55.              /c:   Do not copy input files with error to error directory
  56.              /d:   Delete successfully decoded files
  57.              /k:   Keep incomplete binary files
  58.              /n:   No report file "UUDO.REP" generated
  59.              /r1:  Relaxed format-checking level 1
  60.              /r2:  Relaxed format-checking level 2 (See Doc)
  61.              /s:   Smart (?) mode
  62.  
  63. 1. If you're getting the uuencoded files from the Usenet:
  64.    In 'rn', save each article in different files by doing, say, "1650-1759 s".
  65.    This will save different articles in files 1650, 1651, 1652, ..., 1759,
  66.    provided that you turned on -N and -/ switches in 'rn' command line.
  67. 2. Move these files to a DOS machine.  This may be either in text or
  68.    binary mode file transfer.
  69. 3. Assuming you have a path to UUDO.EXE, or UUDO is available somewhere,
  70.    and all the above files are in the current directory:
  71.    Create a subdirectory called ERROR, from the current directory.
  72.    i.e.  md error
  73. 4. Type "UUDO *.* error"
  74.  
  75. Now, UUDO will extract all the binary files to the current directory.
  76. Any files that cannot be decoded properly will be copied to
  77. the "error" directory, you just created.
  78. UUDO will also create a file called "UUDO.REP" in the current directory
  79. and report which files are decoded to which.  This is very handy way of
  80. checking where the binaries came from and how UUDO read the subject line.
  81.  
  82. UUDO has a few options to accomodate some uuencoded files that may contain
  83. errors or may not use the standard uuencode format:
  84.  
  85. /k option:   By default, UUDO deletes any binary files that were not decoded
  86.              properly to the end.  If this option is specified, UUDO will keep
  87.              all the binary files with error, even though they're incomplete.
  88. /r1 option:  With this option, UUDO will not do most of the uuencode format
  89.              checking.  This is useful when the uuencoded file uses some
  90.              non-standard uuencode format and UUDO stops at certain line.
  91.              NOTE:  /r1 and /r2 options may generate incorrect binary file
  92.                     because many format checkings are not done.  Use these
  93.                     options only on files that UUDO has trouble decoding.
  94. /r2 option:  This option may be used when /r1 option generates the correct
  95.              binary file except the last few bytes.  Use this after you tried
  96.              /r1 option.  You may have to put all the parts together manually.
  97. If all these do not work, the uuencoded file probably contains
  98. some unrecoverable errors.  If you are _really_ desperate, you may try
  99. to concatenate all uuencoded parts together in a file (deleting all
  100. non-uuencoded texts) and use /r2 option, although, it may still not work.
  101.  
  102. UUDO uses two file names (which may be different) to indicate the name of
  103. the binary file.  The first is the name UUDO found in the subject line
  104. and the second is the name UUDO found in "begin xxx zzzz" line of
  105. the uuencoded text.  UUDO will use the first name until the real name
  106. (the second name) is found.
  107.  
  108. You can press ESC key at any time to stop UUDO.  There will be slight delay
  109. while UUDO finishes off its current operation.
  110.  
  111.  
  112. HISTORY:
  113.  
  114. v1.0     - Initial Release to a few testers for some first-impressions.
  115. v1.1     - The first general public release of UUDO!
  116.          - Minor changes in command-line options and the document.
  117. v1.2     - Asks if the user wants to overwrite the existing file or change
  118.            the filename.
  119.          - Better algorithm in finding the part and total parts number
  120.          - /s option (NOTE:  This option will be removed in the future!):
  121.            If /s is specified and there are additional files with the same name
  122.            and part number, you will be asked if UUDO should ignore them.
  123.            These are useful if there are several repost of the same parts.
  124.            Use this option with care because you could be ignoring files
  125.            that may be intended for different binary files.
  126.            This option will be removed in the future and UUDO will automatically
  127.            detect if the files are reposts or not.
  128. v1.3     - Scans for part number throughout the entire subject line, instead of
  129.            only after the filename.
  130.          - Increased input buffer size.  Some long subject lines didn't work
  131.            properly before.
  132.          - The error directory parameter in the comand line is now optional.
  133.            The user will be asked for the error directory when error occures.
  134.          - Added /c option.
  135. v1.4     - Added /b option.  All the questions will be answered as 'No'.
  136.          - Added /d option.  Deletes the successfully decoded source files.
  137. v1.5     - Now removes any path info in the output filename
  138.            i.e. "begin 644 f:\temp\output.bin" creates "output.bin"
  139.            in the current directory
  140.          - Does isatty(fileno(outputfile)) check
  141.          - Changes invalid characters (i.e. '+', '/' etc) in
  142.            the output filename to '_' character
  143.            i.e. "begin 644 test+1" creates "test_1"
  144.          IMPORTANT: Please see the end of this document for 
  145.                     my new e-mail address!
  146.  
  147.  
  148. FUTURE WORKS
  149. I am currently extremely busy, but, when I find some time I'd like to do:
  150. - Automatic detection of redundant parts
  151. - Support of alt.binaries standard of multi-part file format
  152. - Include multi-part uuencode capability
  153. - Support for VM/CMS uuencoded text
  154. - Allow all the uuencoded parts in one file
  155. - Smarter detection of parts (even with the same filenames... But how?)
  156.  
  157.  
  158. FINAL NOTES:
  159.  
  160. I wrote this program for my personal use (to save my precious time from
  161. looking through files, trying to fit pieces together, and decoding),
  162. and I hope you will find it useful also.
  163.  
  164. I can be reached by e-mail at ryank@cyberspace.org
  165.  
  166.                                                        Ryan
  167.                                           from ??
  168.                                           (I'm currently in process of
  169.                                            moving to Seattle, WA, USA)
  170.