i86/elks/elkscmd/misc_utils/README.compress

   1
   2 The ELKS port of compress is limited to 12-bit compression. Build with
   3 -X-H0xe000 to set the top of the heap to a suitable value.
   4
   5 Follows the original ncompress 4.2.4 README file. See the LZW.INFO file
   6 for information regarding LZW patents.
   7
   8 Claudio
   9
  10 -----
  11
  12 This is version 4.2 of (N)compress (an improved version of compress 4.1).
  13
  14 Compress is a fast, simple LZW file compressor.  Compress does not have
  15 the highest compression rate, but it is one of the fastest programs to
  16 compress data.  Compress is the defacto standard in the UNIX community
  17 for compressing files.
  18
  19 'build' is a menu driven shell script for compiling, testing and
  20 installing (N)compress. So to build and install (N)compress all you have to
  21 do is run build.  Build will first test your system for default
  22 settings. The current compile settings are stored in a special file
  23 called compress.def.
  24
  25 For user with problems with build there is a default makefile included
  26 called 'Makefile.def'. Also build is capable te generate a Makefile with
  27 all options (option genmake).
  28
  29 (N)compress 4.2 has a special, fast compression hash algorithm.  This
  30 algorithm uses more memory than the old hash table. If you don't want
  31 the faster hash table algorithm set 'Memory free for compress' below
  32 800000.
  33
  34 zcmp, zdiff, zmore were copied from version 4.1 without any changes.
  35
  36 The output of (N)compress 4.2 is fully compatible with that of compress 3.0.
  37 In other words, the output of (N)compress 4.2 may be fed into uncompress 3.0 or
  38 the output of compress 3.0 may be fed into uncompress 4.2.
  39
  40 The output of (N)compress 4.2 is not compatible with that of
  41 compress 2.0.  However, compress 4.2 still accepts the output of
  42 compress 2.0.  To generate output that is compatible with compress
  43 2.0, use the undocumented "-C" flag.
  44
  45 Send comments, complaints and especially patches relating to
  46         peter@ncs.nl
  47
  48
  49 REMARKS
  50
  51 - Build is a bourne shell script. On some system it is nessesary to type
  52   'sh build'.
  53
  54 - The build script usages tput for nice screen handling of the script.
  55   If your system has no tput no problems.
  56
  57 - For configuration testing build uses a lot of small C programs. During
  58   those test stderr is redirected to /dev/null.
  59   During the compilation of compress output is NOT redirected.
  60
  61 - The /bin/sh under Ultrix can't handle ${var:-str} so use ksh for the
  62   build script.
  63
  64 - If there are any problems with the libary functions definitions in
  65   compress42.c define NOFUNCDEF (-DNOFUNCDEF=1) to disable the definitions.
  66   IBM AIX (RS/6000) uses a different definitions of open(), define -D_IBMRT=1
  67   to disable the open() definition.
  68
  69 - The output if (N)compress 4.2 is not exactly the same as compress 4.0
  70   because of differente table reset point. The output of (N)compress 4.2
  71   is 100% compatible with compress 4.0
  72
  73 - Some systems has performance problems with reads bigger than BUFSIZ
  74   (The read a head function is not working as expected). For those
  75   system use the default BSIZE input buffer size.
  76
  77 - (N)compress can by slower on small files (<10Kb) because of a greate
  78   table reset overhead. Use cpio or tar to make 1 bigger file if
  79   posible, it is faster and also gives a beter compression ratio most
  80   of the time.
  81
  82 - (N)compress is slower in vax systems because of removing some
  83   undocumented inline asembler.
  84
  85 - files compressed on a large machine with more bits than allowed by
  86   a version of compress on a smaller machine cannot be decompressed!  Use the
  87   "-b12" flag to generate a file on a large machine that can be uncompressed
  88   on a 16-bit machine.
  89
  90 - compatibility with compress 3.0 has not been tested in the 4.2 release of
  91   (N)compress.
  92
  93 - There has been 1 problem report in relation to GCC 2.0 on a sparc
  94   workstation. GCC 2.0 seems to generate a bad compress. Use the
  95   standard c compiler 'cc'.
  96
  97 ===============================================================================
  98 Peter Jannesen
  99 Network Communication Systems (N.C.S), The Netherlands
 100 Phone:  +31104130093                             Fax:    +31104146452
 101 Address: Westbaak 96a                            Email:  peter@ncs.nl
 102          3012 KM Rotterdam, The Netherlands