home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / ARC521-2.ZIP / ARC.MAN < prev    next >
Text File  |  1990-01-02  |  8KB  |  188 lines
  1. NAME
  2.      arc - pc archive utility
  3.  
  4. SYNOPSIS
  5.      arc a|m|u|f|d|x|e|r|p|l|v|t|c [ biswnoq ] [ gpassword ]
  6.      archive [ filename ...]
  7.  
  8. DESCRIPTION
  9.      Arc is a general archive and file compression utility, used
  10.      to maintain a compressed archive of files.  An archive is a
  11.      single file that combines many files, reducing storage space
  12.      and allowing multiple files to be handled as one.  Arc uses
  13.      one of several compression methods for each file within the
  14.      archive, based on whichever method yields the smallest
  15.      result.
  16.  
  17. INSTRUCTIONS
  18.      Execute arc with no arguments for fairly verbose, usable
  19.      instructions.
  20.  
  21. COMMAND SWITCHES
  22.      a  add files to archive.  Copies the indicated files to the
  23.         archive.
  24.  
  25.      m  move files to archive.  Same as 'a' switch except that
  26.         the files are deleted from the directory as they are
  27.         moved to the archive.
  28.  
  29.      u  update files in archive.  This switch will replace
  30.         archived files when the named file is newer than the
  31.         archived copy.  New files will be added automatically.
  32.  
  33.      f  freshen files in archive.  Same as 'u' except that new
  34.         files will not be added.
  35.  
  36.      d  delete files in archive.  The named files are removed
  37.         from the archive.
  38.  
  39.      x,e
  40.         extract files from archive.  The named files are
  41.         extracted from the archive and created in the current
  42.         directory in an uncompressed state.
  43.  
  44.      r  run one file with arguments from archive.  Any program
  45.         may be executed directly from the archive.  The parame-
  46.         ters given after the program name are passed to the pro-
  47.         gram without modification.
  48.  
  49.      p  copy files from archive to standard output.  Useful with
  50.         I/O redirection. A form-feed is appended after each file,
  51.         to ease use with printers.
  52.  
  53.      l  list files in archive.  Limited information listing of
  54.         files contained in an archive.  Displays the filename,
  55.         original length, and date last modified.  If the 'n'
  56.         option (see below) is used, only the filename is
  57.         displayed.
  58.  
  59.      v  verbose listing of files in archive.  Complete informa-
  60.         tion listing of files contained in an archive.  Displays
  61.         the filename, original length, storage method, storage
  62.         factor (% savings), compressed size, date, time, and CRC.
  63.  
  64.      t  test archive integrity.  Computes CRC values for each
  65.         member of the archive and compares against the previously
  66.         saved value.
  67.  
  68.      c  convert entry to new packing method.  Convert files
  69.         stored with older methods to newer methods that are more
  70.         efficient. Also useful for files previously archived with
  71.         the 's' option.
  72.  
  73. OPTIONS
  74.      b  retain backup copy of archive.  Keep the original archive
  75.         file and rename to .BAK.  This switch may be used with
  76.         the following commands:  a, m, u, f, d, c.
  77.  
  78.      i  suppress image mode.  This switch causes files to be
  79.         treated as text files, and will translate their end-of-
  80.         line sequence. (Unix's '\n' vs. '\r\n' used on many other
  81.         systems.)  The default is to perform no translation when
  82.         compressing or extracting files.  This option makes deal-
  83.         ing with text files much nicer, though the 'tr' command
  84.         can also be used. ('\r' in makefiles and C source code is
  85.         such a nuisance...)
  86.  
  87.      s  suppress compression.  This forces new files to be saved
  88.         using Method 2 (no compression).  This switch may be used
  89.         with the following commands:  a, m, u, f, c.
  90.  
  91.      w  suppress warning messages.  This switch will keep warning
  92.         messages from being displayed which is the default.  Most
  93.         warnings concern the deletion or existence of files with
  94.         the same name.
  95.  
  96.      n  suppress notes and comments.  This switch will keep use-
  97.         ful notes from being displayed which is the default.
  98.         Most notes indicate what stage of compression is being
  99.         run (analyze, compaction, storage).
  100.  
  101.      o  overwrite existing files when extracting.  This switch
  102.         will make existing files silently get overwritten,
  103.         instead of asking for confirmation, which is the default.
  104.  
  105.      q  force Squash compression method.  This switch causes the
  106.         Squash compression method to be used, instead of Crunch,
  107.         which is the default.
  108.  
  109.      g  encrypt/decrypt archive entry.  This is used to encode
  110.         files so that others may not read them.  BE CAREFUL!
  111.         This must be the last parameter in the switches because
  112.         everything following is part of the password.
  113.  
  114. PROGRAMMING NOTES
  115.      Arc Version 2 differs from version 1 in that archive entries
  116.      are automatically compressed when they are added to the
  117.      archive, making a separate compression step unecessary.  The
  118.      nature of the compression is indicated by the header version
  119.      number placed in each archive entry, as follows:
  120.               1 = Old style, no compression
  121.               2 = New style, no compression
  122.               3 = Compression of repeated characters only
  123.               4 = Compression of repeated characters plus Huffman SQueezing
  124.               5 = Lempel-Zev packing of repeated strings (old style)
  125.               6 = Lempel-Zev packing of repeated strings (new style)
  126.               7 = Lempel-Zev Williams packing with improved hash function
  127.               8 = Dynamic Lempel-Zev packing with adaptive reset
  128.               9 = Squashing
  129.  
  130.      Type 5, Lempel-Zev packing, was added as of version 4.0
  131.  
  132.      Type 6 is Lempel-Zev packing where runs of repeated charac-
  133.      ters have been collapsed, and was added as of version 4.1
  134.  
  135.      Type 7 is a variation of Lempel-Zev using a different hash
  136.      function which yields speed improvements of 20-25%, and was
  137.      added as of version 4.6
  138.  
  139.      Type 8 is a different implementation of Lempel-Zev, using a
  140.      variable code size and an adaptive block reset, and was
  141.      added as of version 5.0
  142.  
  143.      Type 9 is another variation of Lempel-Zev, using a larger
  144.      hash table. This method was developed by Phil Katz, and is
  145.      not supported by the "official" ARC programs.
  146.  
  147.      Arc will look for environment variables named ARCTEMP or
  148.      TMPDIR, which, if present, indicates the pathname where tem-
  149.      porary files should be created. This is typically the loca-
  150.      tion of a RAMdisk on a microcomputer, "/tmp/" or left unset.
  151.  
  152.      See the included documentation file for more details.
  153.  
  154. HISTORY
  155.      Arc has been in use in the CP/M and MSDOS world for many
  156.      years.  Thom Henderson developed the original version, but
  157.      it is important to note that arc is based on the file
  158.      compression theories developed by Huffman, Welch, Knott,
  159.      Knuth, and many other scientists. This implementation is
  160.      based on version 5.21 of the MSDOS program.
  161.  
  162. BUGS
  163.      Arc behaves just like the PC version of the program; all
  164.      functions of the "usage" display are working.  Full compati-
  165.      bility with PC ARC files is maintained, the price for which
  166.      is that arc doesn't like long filenames, and can only
  167.      archive files with names of up to 12 characters.  It will
  168.      *sometimes* do The Right Thing with them, but I suggest you
  169.      put long-winded filenames in a "shar" before arcing them.
  170.  
  171.      There shouldn't be any problems, (hah!) but if you find any,
  172.      please send them to me at:
  173.  
  174.           hyc@umix.cc.umich.edu      {rutgers, uunet}!umix!hyc
  175.  
  176.  
  177. AUTHORS
  178.      Original MSDOS program by Thom Henderson
  179.      COPYRIGHT(C) 1985-87 by System Enhancement Associates; ALL
  180.      RIGHTS RESERVED
  181.  
  182.      Original Lempel-Zev code derived from compress 4.0.  Modi-
  183.      fied to support Squashing by Dan Lanciani (ddl@harvard.edu)
  184.      Ported from MSDOS by Howard Chu (umix!hyc), with help from
  185.      John Gilmore (hoptoad!gnu), James Turner (daisy!turner) and
  186.      others.
  187.  
  188.