annotate src/zlib-1.2.7/examples/README.examples @ 83:ae30d91d2ffe

Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +0000
parents e13257ea84a4
children
rev   line source
Chris@4 1 This directory contains examples of the use of zlib and other relevant
Chris@4 2 programs and documentation.
Chris@4 3
Chris@4 4 enough.c
Chris@4 5 calculation and justification of ENOUGH parameter in inftrees.h
Chris@4 6 - calculates the maximum table space used in inflate tree
Chris@4 7 construction over all possible Huffman codes
Chris@4 8
Chris@4 9 fitblk.c
Chris@4 10 compress just enough input to nearly fill a requested output size
Chris@4 11 - zlib isn't designed to do this, but fitblk does it anyway
Chris@4 12
Chris@4 13 gun.c
Chris@4 14 uncompress a gzip file
Chris@4 15 - illustrates the use of inflateBack() for high speed file-to-file
Chris@4 16 decompression using call-back functions
Chris@4 17 - is approximately twice as fast as gzip -d
Chris@4 18 - also provides Unix uncompress functionality, again twice as fast
Chris@4 19
Chris@4 20 gzappend.c
Chris@4 21 append to a gzip file
Chris@4 22 - illustrates the use of the Z_BLOCK flush parameter for inflate()
Chris@4 23 - illustrates the use of deflatePrime() to start at any bit
Chris@4 24
Chris@4 25 gzjoin.c
Chris@4 26 join gzip files without recalculating the crc or recompressing
Chris@4 27 - illustrates the use of the Z_BLOCK flush parameter for inflate()
Chris@4 28 - illustrates the use of crc32_combine()
Chris@4 29
Chris@4 30 gzlog.c
Chris@4 31 gzlog.h
Chris@4 32 efficiently and robustly maintain a message log file in gzip format
Chris@4 33 - illustrates use of raw deflate, Z_PARTIAL_FLUSH, deflatePrime(),
Chris@4 34 and deflateSetDictionary()
Chris@4 35 - illustrates use of a gzip header extra field
Chris@4 36
Chris@4 37 zlib_how.html
Chris@4 38 painfully comprehensive description of zpipe.c (see below)
Chris@4 39 - describes in excruciating detail the use of deflate() and inflate()
Chris@4 40
Chris@4 41 zpipe.c
Chris@4 42 reads and writes zlib streams from stdin to stdout
Chris@4 43 - illustrates the proper use of deflate() and inflate()
Chris@4 44 - deeply commented in zlib_how.html (see above)
Chris@4 45
Chris@4 46 zran.c
Chris@4 47 index a zlib or gzip stream and randomly access it
Chris@4 48 - illustrates the use of Z_BLOCK, inflatePrime(), and
Chris@4 49 inflateSetDictionary() to provide random access