home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / compress / pkax.lha / Pkax.doc < prev    next >
Text File  |  1988-09-24  |  9KB  |  299 lines
  1. PKAX   FAST!   Archive Extract Utility   Version 1.0   12-08-87    Page 1
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                         Table of Contents
  8.                         -----------------
  9.  
  10.  
  11.  Topic                                                 Page
  12.  -----                                                 ----
  13.  
  14.    Features and Overview .............................. 2
  15.  
  16.    Using PKAX ......................................... 3
  17.  
  18.    Examples ........................................... 4
  19.  
  20.    PKAX messages ...................................... 5
  21.  
  22.    PKAX Revision history .............................. 6
  23.  
  24.    General Information ................................ 6
  25.  
  26.    Software License ................................... 7
  27.  
  28.    Registration ....................................... 8
  29.  
  30. PKAX   FAST!   Archive Extract Utility   Version 1.0   12-08-87    Page 2
  31.  
  32.  
  33.  
  34. Features
  35. --------
  36.  
  37.   o THE FASTEST ARCHIVE EXTRACTION - EVER.
  38.  
  39.   o Data integrity ensured by 16 bit Cyclic Redundancy Check.
  40.  
  41.   o Supports the PKARC file squashing algorithm.
  42.  
  43.   o Superior file buffering.
  44.  
  45.   o Not Copy Protected
  46.  
  47.  
  48.  
  49. Overview
  50. --------
  51.  
  52. An  archive  is  a  collection  of  one or more files placed into a
  53. single archive file.  A file extension of .ARC is usually  used  to
  54. denote  an  archive.  Each file in an archive is compressed to save
  55. disk space, backup storage space, and file transfer time.   When  a
  56. file  is  archived,  it  is  analyzed  and compressed with the most
  57. optimal data compression method for that file.  Every  file  in  an
  58. archive  is  stored  with a 16-bit Cyclic Redundancy Check (CRC) to
  59. ensure data integrity when the file is extracted from the archive.
  60.  
  61. PKAX is a FAST! archive extraction utility that extracts files from
  62. an archive and restores them to their original name, size, time and
  63. date.  It is completely compatible with all other ARC type programs
  64. including  PKWARE's FAST!  archive create/update utility PKARC, but
  65. is faster than  than  ANY  OTHER  archive  extract  utility.   PKAX
  66. achieves  its  speed  through  the  use of optimized algorithms and
  67. advanced file buffering techniques.
  68.  
  69. PKAX   FAST!   Archive Extract Utility   Version 1.0   12-08-87    Page 3
  70.  
  71.  
  72.  
  73. Usage: PKAX   [options] archive [file...]
  74.  
  75.  
  76. Options are:
  77.  
  78.  -r = replace existing file(s)         -v = verbose listing of archive(s)
  79.  -c = extract file(s) to the screen    -p = extract file(s) to the printer
  80.  -t = test archive integrity           -l = display software license
  81.  -e,-x = extract file(s)
  82.  
  83.   archive  Archive file name, wildcards *,? ok.  Default extension
  84.            is .ARC
  85.  
  86.   file     Name(s) of files to extract, list, or test.
  87.            Wildcards *,? okay.  Default is ALL files.
  88.  
  89.  
  90. -r    Normally,  PKAX    will  prompt  you  with  "Overwrite?"   if
  91.       extracting  a file from an archive will overwrite an existing
  92.       file.  The  Replace  option  will  overwrite  existing  files
  93.       without query.
  94.  
  95. -c    This option will extract files to the screen.
  96.  
  97. -p    This  option  will extract files to the printer.  PKAX   will
  98.       print a form feed after each file.
  99.  
  100. -t    This option  will  test  archive  integrity.   Particularily,
  101.       PKAX    will  calculate  each  files CRC value and compare it
  102.       with the stored value within the archive.  A message will  be
  103.       displayed to indicate the integrity of each file.
  104.  
  105. -v    This option is used to list the contents of an  archive.   It
  106.       will  list  the  filename, length of file before compression,
  107.       method of compression, size  after  compression,  compression
  108.       ratio, and the stored CRC value.
  109.  
  110. -l    This option  will display  the  software  license  for  PKAX.
  111.  
  112. -e    These options will extract files from an  archive.   This  is
  113. -x    the  default for PKAX if no other options are specified.  The
  114.       -e and -x options do not have to be specified for this.  They
  115.       are  only  present  for  compatibility with SEA's ARC program
  116.       syntax.  The -e and -x options can not  be  used  with  other
  117.       options.
  118.  
  119. PKAX   FAST!   Archive Extract Utility   Version 1.0   12-08-87    Page 4
  120.  
  121.  
  122.  
  123. Examples:
  124.  
  125. PKAX df0:*
  126.   - Extract all files from all archives on DF0:
  127.  
  128. PKAX sigdir1
  129.   - Extract all files from the archive SIGDIR1.ARC in  the  current
  130.     drive & subdirectory.
  131.  
  132. PKAX -r public/* *.doc *.txt
  133.   - Extract  all  .DOC  and  .TXT  files  from  all archives in the
  134.     directory /PUBLIC.  Overwrites existing  files  without  query.
  135.  
  136. PKAX -v *
  137.   - Display a verbose listing of all the archives  in  the  current
  138.     directory.
  139.  
  140. PKAX -c utility *.doc
  141.   - Extract  all .DOC files from the archive UTILITY.ARC displaying
  142.     extracted files on the console.
  143.  
  144. PKAX -p utility *.doc
  145.   - Same as above, except extracted files  are sent to the printer.
  146.  
  147. PKAX -t utility
  148.   -Test the integrity of the archive UTILITY.ARC.
  149.  
  150. PKAX -t df1:*
  151.   -Test the validity of all archives in the directory df1:
  152.  
  153.  
  154. PKAX   FAST!   Archive Extract Utility   Version 1.0   12-08-87    Page 5
  155.  
  156.  
  157.  
  158. PKAX messages
  159. -------------
  160.  
  161. Warning!  File XXXXXXXX.YYY already exists!  overwrite (y/n)?
  162.   - A file to be extracted from the archive already exists on disk.
  163.     Answer  "y"  to  extract  the  file from the archive anyway and
  164.     overwrite the existing file, "n" to not extract the  file  from
  165.     the archive.  Use the "-r" command line option to suppress this
  166.     warning.
  167.  
  168. Unknown packing method for: XXXXXXXX.YYY
  169.   - The file is compressed  or  encoded  in  a  unknown  way.   The
  170.     archive  is  either corrupt or requires a later version of PKAX
  171.     for proper extraction.
  172.  
  173. Warning!  File XXXXXXXX.YYY fails CRC check
  174.   - The Cyclic Redundancy  Check  calculation  did  not  match  the
  175.     stored value.  The file is probably corrupt.
  176.  
  177. PKAmigaXarc: XXXXXXXX.YYY is not an archive
  178.   - The file specified is either not an archive, or is corrupt.
  179.  
  180. PKAmigaXarc: Archive length error
  181.   - A end of file token  was  not  found  for  a  file  within  the
  182.     archive.  The archive is corrupt.
  183.  
  184. PKAmigaXarc: can't find XXXXXXXX.YYY
  185.   - The given archive filename could not be found.
  186.  
  187. PKAmigaXarc: Can't read archive: XXXXXXXX.YYY
  188.   - The archive could not be opened.
  189.  
  190. PKAmigaXarc: Can't create: XXXXXXXX.YYY
  191.   - The output file could not be created.
  192.  
  193. PKAmigaXarc: File has invalid decode tree
  194.   - The Huffman decode tree for the file is invalid.   The  archive
  195.     is corrupt.
  196.  
  197. PKAmigaXarc: Disk full
  198.   - The destination disk is full.
  199.  
  200. PKAX   FAST!   Archive Extract Utility   Version 1.0   12-08-87    Page 6
  201.  
  202.  
  203.  
  204. PKAX version 1.0  12-08-87
  205. --------------------------
  206.  
  207. Initial  release.   Old style static "crunched" files (types 5 & 6)
  208. created by SEA's ARC program prior version 5.0 are  not  supported. 
  209. Dynamic  Crunched  and  Squashed  files  created  by  PKARC and all
  210. current MS-DOS archivers  and  the  Amiga  version  of  ARC  should
  211. extract correctly with PKAX.
  212.  
  213.  
  214. General Information
  215. -------------------
  216.  
  217. PKAX will run on any Amiga computer running AmigaDos 1.2 or later.
  218.  
  219.  
  220. If  you have any questions or comments about PKAX send them to Phil
  221. Katz at:
  222.  
  223. PKWARE BBS, Wisconsin
  224. 414-352-7176
  225.  
  226. Comm-Link BBS, Wisconsin
  227. 414-784-2096
  228.  
  229. AMuse BBS, New York
  230. 212-269-4879
  231.  
  232.  
  233. Special thanks to Dennis Hoffman who authored PKAX and  ported  the
  234. software  from  the  MS-DOS  versions  of  PKXARC.  Dennis also has
  235. inspired many of  the  algorithm  optimizations  incorporated  into
  236. PKXARC and PKARC in the past.  Additional thanks to  Mike  Shawaluk
  237. who has also helped with the PKAX effort.
  238.  
  239. PKAX    FAST!   Archive Extract Utility   Version 1.0   12-08-87    Page 7
  240.  
  241.  
  242.  
  243. License
  244. -------
  245.  
  246. Copyright (c) 1987 PKWARE, Inc.  All Rights Reserved.
  247.  
  248. You are free to use, copy and distribute PKAX for noncommercial use IF:
  249.  
  250.         NO FEE IS CHARGED FOR USE, COPYING OR DISTRIBUTION.
  251.  
  252.         IT IS NOT MODIFIED IN ANY WAY.
  253.  
  254. Clubs  and user groups may charge a nominal fee (less than $10) for
  255. expenses and handling while distributing PKAX.
  256.  
  257. Site licenses and commercial licenses of PKAX are available.  Write
  258. to the address below for more information.
  259.  
  260. This program is provided AS IS without any warranty,  expressed  or
  261. implied,  including  but  not  limited  to fitness for a particular
  262. purpose.
  263.  
  264. PKAX   FAST!   Archive Extract Utility   Version 1.0   12-08-87    Page 8
  265.  
  266.  
  267.  
  268. Registration
  269. ------------
  270.  
  271. If  you find PKAX fast, easy, and convenient to use, a registration
  272. of $25 would be appreciated.  With each registration of $50 or more
  273. you  will be registered to receive a diskette with the next version
  274. of PKAX and PKARC when available.  Please state the current version
  275. of  PKAX  that  you  have.  If you do not want to receive an MS-DOS
  276. 5.25" diskette, be sure to state that this is for the Amiga!!
  277.  
  278. Only  if the Amiga software is supported through your registrations
  279. can we afford to produce new releases of PKAX  and  also  an  Amiga
  280. equivalent of the MS-DOS program PKARC.
  281.  
  282.  
  283. Possible future enhancements include:
  284.  
  285.   o PKARC for the Amiga, a FAST! archive create/update program.
  286.   o Support for long Amiga filenames!!
  287.   o Support for output drives/paths for PKAX.
  288.   o Support for the ARC "garble" encryption option.
  289.   o Support for all new functions and options that are introduced
  290.     in the PKARC/PKXARC programs for MS-DOS.
  291.  
  292.  
  293. Send registrations to:
  294.  
  295. PKWARE, Inc.
  296. 7032 Ardara Avenue
  297. Glendale, WI 53209
  298.  
  299.