home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Tools / Docs / compress < prev    next >
Encoding:
Text File  |  1994-06-30  |  4.9 KB  |  199 lines
  1.  
  2.  
  3.  
  4. COMPRESS(1)              USER COMMANDS                COMPRESS(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      compress, uncompress,  zcat  -  compress  or  expand  files,
  10.      display expanded contents
  11.  
  12. SYNOPSIS
  13.      compress [ -cfv ] [ -b bits ] [ filename...  ]
  14.  
  15.      uncompress [ -cv ] [ filename...  ]
  16.  
  17.      zcat [ filename...  ]
  18.  
  19. DESCRIPTION
  20.      compress reduces the size of the named files using  adaptive
  21.      Lempel-Ziv coding.  Whenever possible, each file is replaced
  22.      by one with the extension .Z, while keeping the same  owner-
  23.      ship  modes,   as well as access and modification times.  If
  24.      no files are specified, the standard input is compressed  to
  25.      the standard output.
  26.  
  27.      The amount of compression obtained depends on  the  size  of
  28.      the input, the number of bits per code, and the distribution
  29.      of common substrings.  Typically, text such as  source  code
  30.      or  English  is reduced by 50-60%.  Compression is generally
  31.      much better than that achieved by Huffman coding (as used in
  32.      sys-unconfig(8)),   or   adaptive   Huffman   coding   (old-
  33.      compact(1)), and takes  less  time  to  compute.   The  bits
  34.      parameter specified during compression is encoded within the
  35.      compressed file, along with a magic number  to  ensure  that
  36.      neither  decompression  of  random data nor recompression of
  37.      compressed data is subsequently allowed.
  38.  
  39.      Compressed files can be  restored  to  their  original  form
  40.      using uncompress.
  41.  
  42.      zcat produces uncompressed output on  the  standard  output,
  43.      but leaves the compressed .Z file intact.
  44.  
  45. OPTIONS
  46.      -c   Write to the standard output;  no  files  are  changed.
  47.           The  nondestructive  behavior  of  zcat is identical to
  48.           that of `uncompress -c'.
  49.  
  50.      -f   Force compression, even if the file does  not  actually
  51.           shrink,  or  the  corresponding .Z file already exists.
  52.           Except when running in the background (under sh(1)), if
  53.           -f  is  not given, prompt to verify whether an existing
  54.           .Z file should be overwritten.
  55.  
  56.      -v   Verbose.  Display the  percentage  reduction  for  each
  57.           file compressed.
  58.  
  59.      -b bits
  60.  
  61.  
  62.  
  63. Sun Release 4.1   Last change: 9 September 1987                 1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. COMPRESS(1)              USER COMMANDS                COMPRESS(1)
  71.  
  72.  
  73.  
  74.           Set the upper limit  (in  bits)  for  common  substring
  75.           codes.   bits  must  be  between  9  and  16 (16 is the
  76.           default).
  77.  
  78. SEE ALSO
  79.      ln(1V), old-compact(1), sh(1), sys-unconfig(8)
  80.  
  81.      A Technique for High Performance Data Compression, Terry  A.
  82.      Welch, computer, vol. 17, no. 6 (June 1984), pp. 8-19.
  83.  
  84. DIAGNOSTICS
  85.      Exit status is  normally  0.   If  the  last  file  was  not
  86.      compressed because it became larger, the status is 2.  If an
  87.      error occurs, exit status is 1.
  88.  
  89.      Usage: compress [-fvc] [-b maxbits] [filename...]
  90.                Invalid options  were  specified  on  the  command
  91.                line.
  92.  
  93.      Missing maxbits
  94.                Maxbits must follow -b .
  95.  
  96.      filename: not in compressed format
  97.                The file specified  to  uncompress  has  not  been
  98.                compressed.
  99.  
  100.      filename: compressed with xxbits, can only handle yybits
  101.                filename was compressed by a  program  that  could
  102.                deal with more bits than the compress code on this
  103.                machine.  Recompress the file with smaller bits.
  104.  
  105.      filename: already has .Z suffix -- no change
  106.                The file is  assumed  to  be  already  compressed.
  107.                Rename the file and try again.
  108.  
  109.      filename: already exists; do you wish to overwrite (y or n)?
  110.                Respond y if  you  want  the  output  file  to  be
  111.                replaced; n if not.
  112.  
  113.      uncompress: corrupt input
  114.                A SIGSEGV violation was  detected,  which  usually
  115.                means that the input file is corrupted.
  116.  
  117.      Compression:  xx.xx%
  118.                Percentage of  the  input  saved  by  compression.
  119.                (Relevant only for -v.)
  120.  
  121.      -- not a regular file: unchanged
  122.                When the input file is not a regular  file,  (such
  123.                as a directory), it is left unaltered.
  124.  
  125.      -- has xx other links: unchanged
  126.  
  127.  
  128.  
  129. Sun Release 4.1   Last change: 9 September 1987                 2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. COMPRESS(1)              USER COMMANDS                COMPRESS(1)
  137.  
  138.  
  139.  
  140.                The input file has links; it  is  left  unchanged.
  141.                See ln(1V) for more information.
  142.  
  143.      -- file unchanged
  144.                No savings are achieved by compression.  The input
  145.                remains uncompressed.
  146.  
  147. BUGS
  148.      Although compressed files are  compatible  between  machines
  149.      with  large memory, -b12 should be used for file transfer to
  150.      architectures with a  small  process  data  space  (64KB  or
  151.      less).
  152.  
  153.      compress should be more flexible about the existence of  the
  154.      .Z suffix.
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. Sun Release 4.1   Last change: 9 September 1987                 3
  196.  
  197.  
  198.  
  199.