home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 225.lha / compress.doc < prev    next >
Text File  |  1989-03-29  |  3KB  |  79 lines
  1.  
  2. COMPRESS                                                                COMPRESS
  3.  
  4.  
  5. NAME
  6.      compress, uncompress, zcat--file compression utility
  7.  
  8. SYNOPSIS
  9.      compress [-dhHfvcV] [-b maxbits] [file ...]
  10.  
  11. DESCRIPTION
  12.      Compress is a file compression utility like (and completely compatible
  13.      with) the UNIX compress(1) program.  It can be used to compress files by
  14.      name, or from standard input to standard output.  As UNIX-style pipes are
  15.      not available on the Amiga, the latter capability is of dubious value, but
  16.      is included for the sake of completeness.  Compress is able to function
  17.      with any output code maximum size from 12 bits to 16 bits.  The higher the
  18.      maximum code size, the more efficient the compression, and the smaller the
  19.      resultant file, but higher sizes require more memory (e. g.:  16 bits
  20.      uses approximately 450K of RAM, most of which must be contiguous).  For
  21.      systems with 1 Meg or less, 13 bits is the most useful for common use.
  22.      For systems with 1.5 Meg to 2.5 Meg, 15 bits is practical.  The bitsize
  23.      can be selected in several ways:  the -b command line option (more on this
  24.      below), a Manx-style environment variable, or the compiled-in default of
  25.      13 bits.
  26.  
  27.      The environment variable, named COMPBITS, must have a value between 12 and
  28.      16, inclusive.  It can be created using the "set" command supplied with
  29.      the Manx Aztec C compiler (for those who have it) or a variety of public-
  30.      domain commands that do the same thing.
  31.  
  32.      Compress will take its input list of file names and, after compression,
  33.      deposit the compressed date in a file of the same name with a ".Z" appended
  34.      to the end of the file name.  Thus, input file names are limited to 28
  35.      characters (to leave room for the terminating ".Z") due to the AmigaDOS
  36.      file name length limit.
  37.  
  38.      Compress is a completely self-contained program, in that it can uncompress
  39.      any file it compressed.  Decompression can be done by either using the -d
  40.      command line option or by naming the binary "uncompress" (the program
  41.      checks the value of argv[0]).  Files can be catenated to standard output
  42.      by the use of the -c option or by naming the binary "zcat" (this property
  43.      is most useful when file links are available).
  44.  
  45.      Compress will accept the following command line options:
  46.  
  47.           -d:  toggle decompression (uncompress) mode,
  48.           -h:  usage diagnostic,
  49.           -H:  more detailed help,
  50.           -f:  force output to file regardless of conditions,
  51.           -v:  toggle verbose mode on,
  52.           -c:  toggle catenation (zcat) mode,
  53.           -V:  print version,
  54.           -b:  select maximum bit size.
  55.  
  56.  
  57. SEE ALSO
  58.      arc, zoo.
  59.  
  60. DIAGNOSTICS
  61.      Prints help information with -h or -H options, prints message if one of
  62.      its calls to malloc() fails, prints a message if asked to uncompress a
  63.      file compressed with a higher bit size than it is currently using, and
  64.      prints messages concerning any problems with file names (file names are
  65.      limited to 28 characters, to leave room for the terminating ".Z").  Error
  66.      messages are generally unambiguous and informative, though the message
  67.      returned when one of the calls to malloc() fails are somewhat whimsical.
  68.  
  69. BUGS
  70.      None known.  Please direct any questions, comments, or bug reports to:
  71.  
  72.      Brent Woods
  73.      320 Brown St., #406
  74.      West Lafayette, IN  47906
  75.  
  76.      Phone:  (317) 743-8421
  77.  
  78.  
  79.