third_party/zlib: Initial copy of zlib.
[sfrench/samba-autobuild/.git] / third_party / zlib / examples / README.examples
1 This directory contains examples of the use of zlib.
2
3 fitblk.c
4     compress just enough input to nearly fill a requested output size
5     - zlib isn't designed to do this, but fitblk does it anyway
6
7 gun.c
8     uncompress a gzip file
9     - illustrates the use of inflateBack() for high speed file-to-file
10       decompression using call-back functions
11     - is approximately twice as fast as gzip -d
12     - also provides Unix uncompress functionality, again twice as fast
13
14 gzappend.c
15     append to a gzip file
16     - illustrates the use of the Z_BLOCK flush parameter for inflate()
17     - illustrates the use of deflatePrime() to start at any bit
18
19 gzjoin.c
20     join gzip files without recalculating the crc or recompressing
21     - illustrates the use of the Z_BLOCK flush parameter for inflate()
22     - illustrates the use of crc32_combine()
23
24 gzlog.c
25 gzlog.h
26     efficiently maintain a message log file in gzip format
27     - illustrates use of raw deflate and Z_SYNC_FLUSH
28     - illustrates use of gzip header extra field
29
30 zlib_how.html
31     painfully comprehensive description of zpipe.c (see below)
32     - describes in excruciating detail the use of deflate() and inflate()
33
34 zpipe.c
35     reads and writes zlib streams from stdin to stdout
36     - illustrates the proper use of deflate() and inflate()
37     - deeply commented in zlib_how.html (see above)
38
39 zran.c
40     index a zlib or gzip stream and randomly access it
41     - illustrates the use of Z_BLOCK, inflatePrime(), and
42       inflateSetDictionary() to provide random access