home *** CD-ROM | disk | FTP | other *** search
/ The Best of the Best / _.img / 02192 / pkxarc.doc < prev    next >
Text File  |  1987-04-27  |  19KB  |  542 lines
  1. PKXARC   FAST!   Archive Extract Utility   Version 3.5  04-27-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 PKXARC ....................................... 3
  17.    
  18.    Examples ........................................... 4
  19.    
  20.    Using PKXARC in a batch file ....................... 5
  21.  
  22.    Multitasking and Network support ................... 5
  23.    
  24.    PKXARC messages .................................... 6
  25.    
  26.    PKXARC Revision history ............................ 7
  27.  
  28.    General Information ................................ 11
  29.  
  30.    Software License ................................... 12
  31.  
  32. PKXARC   FAST!   Archive Extract Utility   Version 3.5  04-27-87    Page 2
  33.  
  34.  
  35.  
  36. Features
  37. --------
  38.  
  39.   o THE FASTEST ARCHIVE EXTRACTION - EVER.
  40.  
  41.   o Data integrity ensured by 16 bit Cyclic Redundancy Check.
  42.  
  43.   o Supports the PKARC file squashing and archive comment features.
  44.   
  45.   o Decrypts files encrypted with the PKARC encryption option.
  46.   
  47.   o Superior file buffering.
  48.  
  49.   o Multitasking and Network support.
  50.  
  51.   o Not Copy Protected
  52.  
  53.  
  54.  
  55. Overview
  56. --------
  57.  
  58. An  archive  is  a  collection  of  one or more files placed into a 
  59. single archive file.  A file extension of .ARC is usually  used  to 
  60. denote  an  archive.  Each file in an archive is compressed to save 
  61. disk space, backup storage space, and file transfer time.   When  a 
  62. file  is  archived,  it  is  analyzed  and compressed with the most 
  63. optimal data compression method for that file.  Every  file  in  an 
  64. archive  is  stored  with a 16-bit Cyclic Redundancy Check (CRC) to 
  65. ensure data integrity when the file is extracted from the archive.
  66.  
  67. PKXARC  is  a  FAST! archive extraction utility that extracts files 
  68. from an archive and restores them to their original name, size, time 
  69. and  date.   It  is  completely  compatible  with  SEA's  (Software 
  70. Enhancement Associate's) ARC program and  PKWARE's  FAST!   archive 
  71. create/update  utility  PKARC,  but is many times faster than SEA's 
  72. ARC program and faster than  ANY  OTHER  archive  extract  utility.  
  73. PKXARC achieves its speed through the use of C language with highly 
  74. optimized assembly language routines, and advanced  file  buffering 
  75. techniques.
  76.  
  77. PKXARC   FAST!   Archive Extract Utility   Version 3.5  04-27-87    Page 3
  78.  
  79.  
  80.  
  81. Usage: PKXARC [options] archive [d:\path] [file...]
  82.  
  83.  
  84. Options are:
  85.  
  86.   -r = replace existing file(s)         -v = verbose listing of archive(s)
  87.   -c = extract file(s) to the screen    -p = extract file(s) to the printer
  88.   -t = test archive integrity           -l = display software license
  89.   -e,-x = extract file(s) 
  90.   -g<password> = extract garbled file with password
  91.  
  92.   archive  Archive file name, wildcards *,? ok.  Default extension 
  93.        is .ARC
  94.  
  95.   d:path\  Output drive and/or path.  Note that only one output
  96.        path can be specified, and it must be seperated from the 
  97.        list of files to extract by one or more spaces.  The
  98.        output path can be anywhere on the command line after
  99.        the options though.
  100.  
  101.   file     Name(s) of files to extract, list, or test.
  102.        Wildcards *,? okay.  Default is ALL files.
  103.  
  104.  
  105. -r    Normally,  PKXARC  will  prompt  you  with  "Overwrite?"   if 
  106.       extracting  a file from an archive will overwrite an existing 
  107.       file.  The  Replace  option  will  overwrite  existing  files 
  108.       without query.
  109.  
  110. -c    This option will extract files to the screen.
  111.  
  112. -p    This  option  will extract files to the printer.  PKXARC will 
  113.       print a form feed after each file.
  114.  
  115. -t    This option  will  test  archive  integrity.   Particularily, 
  116.       PKXARC  will  calculate  each  files CRC value and compare it 
  117.       with the stored value within the archive.  A message will  be
  118.       displayed to indicate the integrity of each file.
  119.         
  120. -v    This option is used to list the contents of an  archive.   It 
  121.       will  list  the  filename, length of file before compression, 
  122.       method of compression, size  after  compression,  compression 
  123.       ratio, and the stored CRC value.
  124.       
  125. -l    This option will display PKWARE's software license and address.
  126.  
  127. -e    These options will extract files from an archive.  This is the
  128. -x    default for PKXARC if no other options are specified.  The -e
  129.       and -x options do not have to be specified for this.  They are
  130.       only present for compatibility with SEA's ARC  program  syntax.
  131.       The -e and -x options can not be used with other options.
  132.  
  133. -g<password>
  134.       Extract encrypted (garbled) files with the given password.
  135.  
  136. PKXARC   FAST!   Archive Extract Utility   Version 3.5  04-27-87    Page 4
  137.  
  138.  
  139.         
  140. Examples:
  141.  
  142. PKXARC a:* b:
  143.   - Extract  all  files  from  all  archives  on  drive  A: storing 
  144.     extracted files on drive B:.
  145.  
  146. PKXARC sigdir1 c:
  147.   - Extract all files from the archive SIGDIR1.ARC in  the  current 
  148.     drive  &  subdirectory  storing  extracted files in the current
  149.     directory on drive C:.
  150.  
  151. PKXARC c:\lotus\tax *.wks
  152.   - Extract  all  .WKS  files from archive C:\LOTUS\TAX.ARC storing 
  153.     extracted files in the current drive & subdirectory.
  154.  
  155. PKXARC -r c:\public\* d:\ *.doc *.txt
  156.   - Extract all .DOC and  .TXT  files  from  all  archives  in  the 
  157.     directory  C:\PUBLIC,  storing  the extracted files in the root 
  158.     directory of  drive  D:.   Overwrites  existing  files  in  D:\ 
  159.     without query.
  160.  
  161. PKXARC -v c:\download\*
  162.   - Display a verbose listing of  all  archives  in  the  directory 
  163.     C:\DOWNLOAD.
  164.  
  165. PKXARC -c utility *.doc
  166.   - Extract  all .DOC files form the archive UTILITY.ARC displaying 
  167.     extracted files on the console.
  168.  
  169. PKXARC -p utility *.doc
  170.   - Same as above, except extracted files  are sent to the printer.
  171.  
  172. PKXARC -t utility
  173.   -Test the integrity of the archive UTILITY.ARC.
  174.  
  175. PKXARC -t c:\download\*
  176.   -Test the validity of all archives in the directory C:\DOWNLOAD.
  177.   
  178. PKXARC -gsecret private
  179.   - Extract all the files from the archive PRIVATE.ARC using SECRET 
  180.     as the decryption password.  Note that the password is NOT case 
  181.     sensitive.   The "-g" option must be the last option specified, 
  182.     and must  be  immediately  followed  by  the  password  without 
  183.     intervening spaces.
  184.  
  185. PKXARC   FAST!   Archive Extract Utility   Version 3.5  04-27-87    Page 5
  186.  
  187.  
  188.  
  189. Using PKXARC in a batch file
  190. ---------------------------
  191.  
  192. If you are using PKXARC from a batch file, you can test  if  PKXARC 
  193. experienced  an  error  using  the DOS errorlevel variable.  PKXARC 
  194. returns zero errorlevel if no errors have occurred.   If  an  error 
  195. occurred, PKXARC will return the following error codes:
  196.  
  197. abort exit codes:
  198.   2 - out of memory
  199.   3 - no archives found to extract
  200.   4 - can't open archive file
  201.   5 - read error on archive
  202.   6 - internal table overflow
  203.   7 - disk full
  204.  
  205. non-abort (warning) exit codes:
  206.   1 - bad CRC, file is not an archive, unknown compression method,
  207.       can't create a file, squeeze table is invalid or no files
  208.       found to extract.
  209.  
  210.  
  211. Mulitasking and Network Support
  212. -------------------------------
  213.  
  214. PKXARC  automatically  opens  all  archives  with SHARE "deny write 
  215. access"  under  DOS  3.0  or  above,  so  that  they  can  be  read 
  216. concurrently  by other tasks.  This is especially useful when using 
  217. PKXARC on Local Area Networks (LANs) or with multi-tasking software.
  218.  
  219. PKXARC   FAST!   Archive Extract Utility   Version 3.5  04-27-87    Page 6
  220.  
  221.  
  222.  
  223. PKXARC messages
  224. ---------------
  225.  
  226. Warning!  File XXXXXXXX.YYY already exists!  overwrite (y/n)?
  227.   - A file to be extracted from the archive already exists on disk.  
  228.     Answer  "y"  to  extract  the  file from the archive anyway and 
  229.     overwrite the existing file, "n" to not extract the  file  from 
  230.     the archive.  Use the "-r" command line option to suppress this 
  231.     warning.
  232.  
  233. Unknown packing method for: XXXXXXXX.YYY
  234.   - The file is compressed  or  encoded  in  a  unknown  way.   The 
  235.     archive is either corrupt or requires a later version of PKXARC 
  236.     for proper extraction.
  237.  
  238. Warning!  File XXXXXXXX.YYY fails CRC check
  239.   - The Cyclic Redundancy  Check  calculation  did  not  match  the 
  240.     stored value.  The file is probably corrupt.
  241.  
  242. XXXXXXXX.YYY is not an archive
  243.   - The file specified is either not an archive, or is corrupt.
  244.  
  245. Archive length error
  246.   - A end of file token  was  not  found  for  a  file  within  the 
  247.     archive.  The archive is corrupt.
  248.  
  249. PKXARC: can't find XXXXXXXX.YYY
  250.   - The given archive filename could not be found.
  251.  
  252. PKXARC: Can't read archive: XXXXXXXX.YYY
  253.   - The archive could not be opened.
  254.  
  255. PKXARC: Can't create: XXXXXXXX.YYY
  256.   - The  output file could not be created.  The output directory is 
  257.     invalid or full.
  258.  
  259. PKXARC: File has invalid decode tree
  260.   - The Huffman decode tree for the file is invalid.   The  archive 
  261.     is corrupt.
  262.  
  263. PKXARC: Disk full
  264.   - The destination disk is full.
  265.  
  266. PKXARC: Internal table overflow
  267.   - An internal decode table overflowed.  The archive is corrupt.
  268.  
  269. PKXARC   FAST!   Archive Extract Utility   Version 3.5  04-27-87    Page 7
  270.  
  271.  
  272.  
  273. PKXARC history
  274. --------------
  275.  
  276. Soon  after  the archive file format was introduced into the public 
  277. domain, it became popular and many BBS files were  transfered  this 
  278. way.   The  archive format is a convenient way to put several files 
  279. into one and compress them for effecient disk storage  and  reduced 
  280. transfer time, in one step.
  281.  
  282. However, the archive utility was much slower  at  extracting  files 
  283. than  equivalent  UnSQueeze type programs.  In the inevitable quest 
  284. for faster archive file extraction, PKXARC was created.
  285.  
  286.  
  287. Changes in PKXARC version 3.5
  288. -----------------------------
  289.  
  290. Extraction of Crunched files are up to 25% faster  and  unSquashing 
  291. is up to 50% faster than ever before.
  292.  
  293. New -e and -x options have been added for ARC compatibility.
  294.  
  295. The  DOS  switch  character  is  now  supported  as  a valid option 
  296. seperator.
  297.  
  298. The '-' character can  be  used  in  addition  to  the  DOS  switch 
  299. character for options.
  300.  
  301. The -g "arc garble" decryption option is supported.
  302.  
  303. Both '/' and '\' characters are allowed in pathnames.
  304.  
  305. Multitasking and Network support has been added to PKXARC.
  306.  
  307. Wildcard file matching using '?' in the extension now works exactly 
  308. like DOS directory wildcard matching.
  309.  
  310. To  help  facilitate  the  automated  use of PKXARC, PKXARC will no 
  311. longer abort to DOS when a bad archive  is  encountered,  but  will 
  312. continue  on  to the next archive.  PKXARC's return codes have been 
  313. extended to include errors  that  do  not  cause  PKXARC  to  abort 
  314. immediately (warnings).
  315.  
  316. Damaged archive handling has been vastly improved.  PKXARC will  no 
  317. longer  hang up on badly damaged, truncated, or encrypted archives.  
  318. In addition, PKXARC will automatically skip bad archive headers and 
  319. will  attempt  to  extract  as many files from a damaged archive as 
  320. possible.
  321.  
  322. PKXARC   FAST!   Archive Extract Utility   Version 3.5  04-27-87    Page 8
  323.  
  324.  
  325.  
  326. Changes in PKXARC version 3.4
  327. -----------------------------
  328.  
  329. Support of "squashed" files created by PKARC 2.0  has  been  added.  
  330. Squashing is a variation of Dynamic Ziv-Lempel-Welch encoding which 
  331. can yield a 10% or better compression ratio for large  text  files.  
  332. Squashed  files  typically  unsquash  15%  faster  than  equivalent 
  333. crunched files.
  334.  
  335. In order to be consistent with the command  syntax  of  PKARC,  the 
  336. requirement   for  dashes  ("-")  to  be  given  before  individual 
  337. filenames to extract or list has been removed.
  338.  
  339. Error  recovery  for  damaged archives has been improved.  Previous 
  340. versions of PKXARC would  occasionally  hang  up  while  processing 
  341. damaged  archives.   PKXARC version 3.4 has improved error recovery 
  342. allowing at least the partial extraction of files  from  a  damaged 
  343. archive.
  344.  
  345.  
  346. Changes in PKXARC version 3.3
  347. -----------------------------
  348.  
  349. Support of the PKARC archive comment  feature  was  added.   PKXARC 
  350. will  automatically  display an archive comment if it is present in 
  351. an archive.
  352.  
  353. When extracting files to the  printer,  PKXARC  will  now  print  a 
  354. form-feed character after each file.
  355.  
  356. Extraction speed has been increased by 5% for Crunched files.
  357.  
  358.  
  359. Changes in PKXARC version 3.2
  360. -----------------------------
  361.  
  362. The  archive test function "/t" was added to PKXARC.  This function 
  363. tests the integrity of the archive without extracting the files  to 
  364. disk.  Specifically, the CRC for each file is computed and compared 
  365. against the correct value stored in the archive.
  366.  
  367. Extraction speed has been increased by 5% for most files.
  368.  
  369. PKXARC   FAST!   Archive Extract Utility   Version 3.5  04-27-87    Page 9
  370.  
  371.  
  372.  
  373. Changes in PKXARC version 3.1
  374. -----------------------------
  375.  
  376. A  minor  bug  in  the  pattern  matching  code for individual file 
  377. specifications when using the wildcard "*" was fixed.  For example, 
  378. previous versions of PKXARC would not correctly match "flight*.com" 
  379. to the exact filename "flight.com".  This  has  been  corrected  in 
  380. PKXARC version 3.1.
  381.  
  382. The  verbose archive listing now displays the total number of files 
  383. in the archive.
  384.  
  385. Extraction speed has been increased  5-10%  for  all  decompression 
  386. methods.
  387.  
  388. A  "jr"  version  of  PKXARC was created for computers with limited 
  389. memory.  PKXARCjr requires only 74K of free memory to run,  but  is 
  390. slightly  slower than the standard version for most archives.  Both 
  391. versions will run on  any  type  of  computer  providing  there  is 
  392. sufficient free memory.
  393.  
  394.  
  395. Changes in PKXARC version 3.0
  396. -----------------------------
  397.  
  398. The following functions have been added to PKXARC version 3.0:
  399.  
  400. Extraction of files to the console or printer.
  401. The ability to display a verbose archive listing.
  402.  
  403.  
  404. Changes in PKXARC version 2.7
  405. -----------------------------
  406.  
  407. Extraction performance of Squeezed files  has  been  improved  more 
  408. than 60%.  PKXARC version 2.7 can extract a Squeezed file more than 
  409. 8 times faster than ARC 5.1.
  410.  
  411. The message displayed when a  file  is  being  extracted  has  been 
  412. enhanced to indicate the compression method used to store the file.
  413.  
  414. Message                 Meaning
  415. -------                 -------
  416. Extracting   The file was Stored.
  417. un-Packing   The file was Packed with non-repeat packing.
  418. uncrunching  The file was crunched with old style Ziv-Lempel-Welch compression.
  419. unSqueezing  The file was Squeezed with Huffman encoding.
  420. unCrunching  The file was Crunched with Dynamic Ziv-Lempel-Welch compression.
  421. unSquashing  The file was Squashed with Dynamic Ziv-Lempel-Welch compression.
  422.  
  423. PKXARC   FAST!   Archive Extract Utility   Version 3.5  04-27-87    Page 10
  424.  
  425.  
  426.  
  427. Changes in PKXARC version 2.6
  428. -----------------------------
  429.  
  430. Extraction  performance  for  all  compression   types   has   been 
  431. significantly  improved  over  PKXARC  version 2.5.  Files that are 
  432. crunched with older versions of ARC (pre 5.x)  extract  5%  faster.  
  433. Squeezed  files  extract  15% faster.  Files that are Crunched with 
  434. ARC 5.x extract 20% faster.
  435.  
  436.  
  437. Changes in PKXARC version 2.5
  438. -----------------------------
  439.  
  440. The ability to extract specific files was added.  PKXARC can now be 
  441. passed  the specific names of files to be extracted from an archive 
  442. on the command line.
  443.  
  444.  
  445. Changes in PKXARC version 2.4
  446. -----------------------------
  447.  
  448. Performance  for  extracting  dynamic  Ziv-Lempel  files  has  been 
  449. improved. Files which are identified as "Crunched" (with a  capital 
  450. C) on the ARC verbose listing extract 15-20% faster than before.
  451.  
  452. When  a  "Disk  full"  error  occurred, previous versions of PKXARC 
  453. would leave an empty or incomplete file on the  disk.   PKXARC  now 
  454. deletes  any  incomplete  files  before aborting with a "Disk full" 
  455. error.
  456.  
  457.  
  458.  
  459. Changes in PKXARC version 2.3
  460. -----------------------------
  461.  
  462. The  ability  to extract dynamic Ziv-Lempel-Welch encoded files was 
  463. added.  Version  5.0  of  ARC  introduced  a  new,  more  efficient 
  464. variation  of Ziv-Lempel "Crunching".  PKXARC can now extract files 
  465. Crunched with this method, approximately 3 times  faster  than  ARC 
  466. 5.1.
  467.  
  468. PKXARC   FAST!   Archive Extract Utility   Version 3.5  04-27-87    Page 11
  469.  
  470.  
  471.  
  472. General Information
  473. -------------------
  474.  
  475. PKXARC  will  run on any IBM PC/XT/AT/RT/jr/Portable/Convertible or 
  476. any MS-DOS compatible computer running PC/MS-DOS 2.0 or higher with 
  477. a minimum of 128K free RAM.
  478.  
  479. IBM is a registered trademark of the International Business Machine
  480. Corporation.
  481. MS-DOS is a registered trademark of Microsoft Inc.
  482.  
  483.  
  484. If you have any questions or comments about PKARC send them to Phil 
  485. Katz at:
  486.  
  487. RBBS-PC of FARGO, Loren Jones SYSOP
  488. Fargo, North Dakota
  489. 701-293-5973
  490. 300/1200/2400 baud, 24 hours a day
  491.  
  492. or
  493.  
  494. Exec-PC IBM BBS, Bob Mahoney SYSOP
  495. Shorewood, Wisconsin
  496. 414-964-5160
  497. 300/1200/2400 baud, 24 hours a day
  498.  
  499.  
  500. Special  thanks to Loren Jones, Bob Mahoney, Alan Losoff, Gene Alm, 
  501. Mike Shawaluk, Paul Waldinger,  Arny  Krueger,  Mark  Tellier,  Joe 
  502. Vincent,  David Wyatt and all those who have helped with the PKXARC 
  503. effort.
  504.  
  505. PKXARC   FAST!   Archive Extract Utility   Version 3.5  04-27-87    Page 12
  506.  
  507.  
  508.  
  509. License
  510. -------
  511.  
  512. Copyright (c) 1986,1987 PKWARE, Inc.  All Rights Reserved.
  513.  
  514. You are free to use, copy and distribute PKXARC for noncommercial use IF:
  515.  
  516.         NO FEE IS CHARGED FOR USE, COPYING OR DISTRIBUTION.
  517.  
  518.         IT IS NOT MODIFIED IN ANY WAY.
  519.  
  520. Clubs  and user groups may charge a nominal fee (less than $10) for 
  521. expenses and handling while distributing PKARC.
  522.  
  523. Site licenses, commercial licenses and custom versions of PKARC and 
  524. PKXARC  are  available.   Write  to  the  address  below  for  more 
  525. information.
  526.  
  527. This program is provided AS IS without any warranty,  expressed  or 
  528. implied,  including  but  not  limited  to fitness for a particular 
  529. purpose.
  530.  
  531. If  you  find  PKXARC  fast,  easy,  and  convenient  to   use,   a 
  532. contribution  of  $20 would be appreciated.  With each contribution 
  533. of $45 or more you will be registered to receive  a  diskette  with 
  534. the  next version of PKARC and PKXARC when available.  Please state 
  535. the current versions of PKARC  and  PKXARC  that  you  have.   Send 
  536. contributions to:
  537.  
  538. PKWARE, Inc.
  539. 7032 Ardara Avenue
  540. Glendale, WI 53209
  541.  
  542.