home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / compress / extracto.lzh / extractor.doc < prev    next >
Text File  |  1991-11-22  |  9KB  |  208 lines
  1.  
  2.                             Extractor v1.0
  3.                by Kerry Cianos and Geoffrey Faivre-Malloy
  4.         Copyright 1991 Impress Technologies.  All rights reserved.
  5.  
  6. ----------------------------------------------------------------------------
  7.  
  8.      Welcome to Extractor!  We are pleased to present a versatile and
  9. efficient tool for making your usage of the networks easier and faster.  With
  10. Extractor you will be able to make maximum use of both your time and network
  11. resources.
  12.  
  13.      What is Extractor?  Extractor is a powerful utility that lets you
  14. perform operations that are essential to using any network for data/file
  15. transfer.  When a binary file is sent through a network it must first be
  16. processed into ASCII format.  Since a binary file may contain unreadable
  17. characters, a special process called UUencoding is done.  This process turns
  18. the binary file into a file of readable (but gibberish) characters.  UUdecoding
  19. is the inverse process to return an encoded file back into its original state.
  20. Extractor does both UUencoding and UUdecoding.  In addition, large files may
  21. be split into parts for tranfer along the network.  Extractor will decode these
  22. multiple parts back into original form for you.  In addition to the UU form of
  23. encoding/decodng, Extractor will also do XXencoding/decoding.  XX is a special
  24. form that is used to transfer files between certain Bitnet configurations.
  25. Whereas a UUencoded file contains characters like @, * and !, XX doesn't.  The
  26. only allowable characters are the 52 upper and lowercase letters, and the plus
  27. and minus signs (+ -).  Binhex 4.0 decoding for Macintosh .hqx files may 
  28. be added in the future.
  29.  
  30.      In addition to encoding and decoding functions Extractor offers a very
  31. powerful archive lister.  Available as a seperate program (Lister), Extractor
  32. will "look" inside files and try to determine what archive they are.
  33. Extractor/Lister currently support seven formats: Arc-, Cpio, LhArc, LHA, 
  34. StuffIt-, Tar, Zip, and Zoo.  Compactor Pro- support may be offered in the
  35. future.  Once an archive has been found a listing of the filename, compressed
  36. and uncompressed sizes, time and date, and the compression ration will be
  37. shown. Extractor / Lister can try and auto-detect the archive type or you
  38. may specify the archive type.
  39.  
  40.      Extractor also offers many complementary features.  Online help is only
  41. one letter away!  The -h command will display a mini-help file that describes
  42. all available commands.  There are two options to delete files as the are
  43. processed (to free up disk space) or delete all the processed files at the end.
  44. A join option is included to just join the files without doing any special
  45. processing of the files.  A pause option is included for when you would like a
  46. browse an archive listing.  An option to decode the file to the output screen
  47. instead of a disk file is useful for viewing READ.ME files.  All output can be
  48. disabled with the quiet option.
  49.  
  50. Legal Stuff:
  51.  
  52.      The usage of this program is free.  We, Kerry Cianos and Geoffrey
  53. Faivre-Malloy still retain the copyrights to the source code.  It is therefore
  54. not public-domain, but freeware.  If you use this program we would like to hear
  55. from you (come on, its not that hard to do!).  Just email us at any address
  56. below or send us a postcard (please!! :)).  Of course, any bug reports and
  57. suggestions/comments would be greatly appreciated.  The source is not
  58. included in this distribution.  If you obtained a copy of the source from
  59. another source (no pun intended) then it is an illegal copy.  To obtain
  60. the source from us, simply send us a letter stating how much you love
  61. extractor (or if you hate it) and tell us you want the source.  Please
  62. include a disk and postage to mail it back to you.  If you are on the
  63. networks, send us some E-Mail and we will respond as quickly as possible. 
  64. Keep in mind that our accounts are deactivated during the summer and
  65. christmas breaks.
  66.  
  67.      Extractor can be placed on BIX, Genie, CompuServ, and other
  68. commercial networks.  It cannot be placed on networks that *specifically*
  69. charge for Extractor.  I.E.  If file access is a standard charge, then it
  70. is ok to put it there but Extractor *CANNOT* be sold for profit.  It can
  71. be placed on Public Domain disks such as Fred Fish but in no case can any
  72. disk that Extractor is placed in cost more than Fred Fish charges for
  73. copying costs.  Don't ya hate all this legalese?  Me too...I wish it
  74. wasn't necessary...
  75.  
  76. P.S.  If I contradicted myself in any of the above statements, let me know
  77. and I'll correct ASAP :)
  78.  
  79. Bitnet:   ktc0440csci@apsu         Kerry Cianos
  80. BIX:      mduck                    P.O. Box 5771
  81. AOL:      Kerry C6                 Clarksville TN 37044
  82.  
  83.  
  84. Bitnet:   gf7609csci@apsu          Geoffrey Faivre-Malloy
  85. BIX:      mduck                    P.O. Box 5272
  86.                                    Clarksville TN 37044
  87.  
  88.  
  89.  
  90. Installation
  91. ------------
  92.  
  93.      Put Extractor in your path and you are ready to go.
  94.  
  95. Extractor v1.0  Copyright 1991 Impress Technologies
  96.  
  97. Usage : Extractor -dehjklopqxyz <InFile> [OutFile]
  98. Type Extractor -h for mini-help.
  99.  
  100.  
  101.  
  102.  
  103. Extractor Options
  104.  
  105.      This section describes the option switches and their use in Extractor:
  106.  
  107. Decoding: Extractor -{D, X} <InFile> [OutFile]
  108.  
  109.      Extractor will attempt to decode the file(s) specified.  All input files
  110. must end with a number.  The first part (and if the only part) must end with .1
  111. (ie. testfile.1).  To decode a multi-part file, each piece should end with a
  112. number specify which part it is.  The numbers should range from 1 to the number
  113. of pieces.  For example, if Bigfile was in three parts, you should have three
  114. files named Bigfile.1, Bigfile.2, and Bigfile.3.  Use these switches to decode:
  115.  
  116.   -D  -=> UUDecoding
  117.   -X  -=> XXDecoding
  118.  
  119. The InFile is the file that you want to UU or XX decode.  OutFile is optional.
  120. If one is not entered then the OutFile name will be the taken from the encoded
  121. file itself (the filename is stored on the begin line).
  122.  
  123. Example:  Extractor -d main.1
  124.  
  125. This will UUDncode all parts of main using the filename specified in the
  126. uuencoded file as the OutFile.  An error message will be displayed if a part is
  127. missing.
  128.  
  129. Example:  Extractor -d main.1 whyme.zoo
  130.  
  131. This will UUDncode all parts of main using whyme.zoo as the OutFile.  An error
  132. message will be displayed if a part is missing.
  133.  
  134. Encoding: Extractor -{E, Y} <InFile> [OutFile]
  135.  
  136.      Extractor is capable of XXEncoding and UUEncoding files.  UUEncoded
  137. files will have a checksum computer and stored at the end of each line.  Both of
  138. these formats are a way to take a binary file and turn it into ASCII.  To encode
  139. a file use:
  140.  
  141.   -E  -=> UUEncoding
  142.   -Y  -=> XXEncoding
  143.  
  144. The InFile is the file that you want to UU or XX encode.  OutFile is optional.
  145. If one is not entered then the OutFile name will be the InFile name + '.uue' or
  146. '.xxe' depending upon the format used.
  147.  
  148. Example:  Extractor -e main.zoo whyme.uue
  149.  
  150. This will UUEncode a file named main.zoo into whyme.uue.
  151.  
  152. Example:  Extractor -e main.zoo
  153.  
  154. This will UUEncode a file named main.zoo into main.uue.
  155.  
  156.      The total number of bytes processed will be displayed as Extractor encodes.
  157. At the end Extractor will display the number of bytes read in and the number of
  158. bytes written.
  159.  
  160. Listing: Extractor -l InFile      OR
  161.          Extractor -l InFile.ext
  162.  
  163.      Extractor can also list the contents of the following archives:  Arc,
  164. Cpio, LHA, LhArc, Sit, Tar, Zip, and Zoo.
  165.  
  166.  
  167. Extractor is smart enough to auto-detect the type of file if an extension is not
  168. given.  If the filetype is not recognized then an error message will be
  169. displayed.
  170.  
  171. Example 1:  Extractor -l stuff.lzh
  172.  
  173. This will list the contents of stuff.lzh
  174.  
  175. Example 2:  Extractor -l stuff
  176.  
  177. This will list the contents of ALL files that start with stuff and end with a
  178. recognizable extension.  I.E.  Arc, Cpio, LHA, LhArc, SIT, Tar, Zip, and Zoo.
  179.  
  180. Miscellaneous Options:
  181.  
  182. -h   Mini-help feature to describe the commands.  To access this help use
  183. must type $ Extractor -h.  The -h must  be the first letter and all subsequent
  184. switches will be ignored.
  185.  
  186. -j   This option is to be used for BinHex files.  It will concatenate the
  187. files together into one large file.  Once BinHex Decoding is supported, this
  188. option will probably be removed.
  189.  
  190. -k   This option is used when you are running low on disk space.  It is for
  191. use  with the Decode options.  When entered, as each file is read into memory
  192. and processed, the files will be deleted.  Use this only if you can afford to
  193. lose the files in case something happens!
  194.  
  195. -o   Will send the decoded file to stdout instead of a diskfile.  Must be
  196. used in conjunction with the d or x option (ie. $ Extractor -do readme.1)
  197.  
  198. -p   This is the pause option.  It has no effect unless used in conjunction
  199. with the list (-l) option.  It will pause the archive printout every 20 lines
  200. and wait for a RETURN.
  201.  
  202. -q   This turns off all messages.  With the quiet option on Extractor will
  203. not produce and output.  All decoding messages and even errors will not be
  204. echoed to the screen.
  205.  
  206. -z   This is the same as the -k option with the exception that the files will
  207. be deleted when decoding is finished.  Much safer but takes more disk space.
  208.