cannam@128: This directory contains examples of the use of zlib and other relevant
cannam@128: programs and documentation.
cannam@128: 
cannam@128: enough.c
cannam@128:     calculation and justification of ENOUGH parameter in inftrees.h
cannam@128:     - calculates the maximum table space used in inflate tree
cannam@128:       construction over all possible Huffman codes
cannam@128: 
cannam@128: fitblk.c
cannam@128:     compress just enough input to nearly fill a requested output size
cannam@128:     - zlib isn't designed to do this, but fitblk does it anyway
cannam@128: 
cannam@128: gun.c
cannam@128:     uncompress a gzip file
cannam@128:     - illustrates the use of inflateBack() for high speed file-to-file
cannam@128:       decompression using call-back functions
cannam@128:     - is approximately twice as fast as gzip -d
cannam@128:     - also provides Unix uncompress functionality, again twice as fast
cannam@128: 
cannam@128: gzappend.c
cannam@128:     append to a gzip file
cannam@128:     - illustrates the use of the Z_BLOCK flush parameter for inflate()
cannam@128:     - illustrates the use of deflatePrime() to start at any bit
cannam@128: 
cannam@128: gzjoin.c
cannam@128:     join gzip files without recalculating the crc or recompressing
cannam@128:     - illustrates the use of the Z_BLOCK flush parameter for inflate()
cannam@128:     - illustrates the use of crc32_combine()
cannam@128: 
cannam@128: gzlog.c
cannam@128: gzlog.h
cannam@128:     efficiently and robustly maintain a message log file in gzip format
cannam@128:     - illustrates use of raw deflate, Z_PARTIAL_FLUSH, deflatePrime(),
cannam@128:       and deflateSetDictionary()
cannam@128:     - illustrates use of a gzip header extra field
cannam@128: 
cannam@128: zlib_how.html
cannam@128:     painfully comprehensive description of zpipe.c (see below)
cannam@128:     - describes in excruciating detail the use of deflate() and inflate()
cannam@128: 
cannam@128: zpipe.c
cannam@128:     reads and writes zlib streams from stdin to stdout
cannam@128:     - illustrates the proper use of deflate() and inflate()
cannam@128:     - deeply commented in zlib_how.html (see above)
cannam@128: 
cannam@128: zran.c
cannam@128:     index a zlib or gzip stream and randomly access it
cannam@128:     - illustrates the use of Z_BLOCK, inflatePrime(), and
cannam@128:       inflateSetDictionary() to provide random access