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