examples/README.examples

   1 This directory contains examples of the use of zlib and other relevant
   2 programs and documentation.
   3
   4 enough.c
   5     calculation and justification of ENOUGH parameter in inftrees.h
   6     - calculates the maximum table space used in inflate tree
   7       construction over all possible Huffman codes
   8
   9 example.c
  10     usage examples of zlib
  11     - used in zlib build Makefile for testing
  12
  13 fitblk.c
  14     compress just enough input to nearly fill a requested output size
  15     - zlib isn't designed to do this, but fitblk does it anyway
  16
  17 gun.c
  18     uncompress a gzip file
  19     - illustrates the use of inflateBack() for high speed file-to-file
  20       decompression using call-back functions
  21     - is approximately twice as fast as gzip -d
  22     - also provides Unix uncompress functionality, again twice as fast
  23
  24 gzappend.c
  25     append to a gzip file
  26     - illustrates the use of the Z_BLOCK flush parameter for inflate()
  27     - illustrates the use of deflatePrime() to start at any bit
  28
  29 gzjoin.c
  30     join gzip files without recalculating the crc or recompressing
  31     - illustrates the use of the Z_BLOCK flush parameter for inflate()
  32     - illustrates the use of crc32_combine()
  33
  34 gzlog.c
  35 gzlog.h
  36     efficiently and robustly maintain a message log file in gzip format
  37     - illustrates use of raw deflate, Z_PARTIAL_FLUSH, deflatePrime(),
  38       and deflateSetDictionary()
  39     - illustrates use of a gzip header extra field
  40
  41 minigzip.c
  42     minimal implementation of gzip-like functionality using zlib
  43     - used in zlib build Makefile for testing
  44     - is not meant for and should not be used as a gzip replacement
  45
  46 zlib_how.html
  47     painfully comprehensive description of zpipe.c (see below)
  48     - describes in excruciating detail the use of deflate() and inflate()
  49
  50 zpipe.c
  51     reads and writes zlib streams from stdin to stdout
  52     - illustrates the proper use of deflate() and inflate()
  53     - deeply commented in zlib_how.html (see above)
  54
  55 zran.c
  56     index a zlib or gzip stream and randomly access it
  57     - illustrates the use of Z_BLOCK, inflatePrime(), and
  58       inflateSetDictionary() to provide random access