zlib/examples
Dimitri Papadopoulos c7ddcc2e0e Fix some spelling errors. 2023-08-03 13:53:24 -07:00
..
README.examples Fix the zran.c example to work on a multiple-member gzip file. 2018-10-14 09:57:34 -07:00
enough.c Fix some typos. 2022-08-23 15:35:13 -07:00
fitblk.c Fix some spelling errors. 2023-08-03 13:53:24 -07:00
gun.c Fix some typos. 2022-08-23 15:35:13 -07:00
gzappend.c Fix some typos. 2022-08-23 15:35:13 -07:00
gzjoin.c Clean up examples/gzjoin.c for z_const usage. 2012-08-14 00:30:44 -07:00
gzlog.c Fix memory leak on error in gzlog.c. 2019-05-25 22:23:20 -07:00
gzlog.h Fix some typos. 2022-08-23 15:35:13 -07:00
gznorm.c Add gznorm.c example, which normalizes gzip files. 2018-10-07 13:55:00 -07:00
zlib_how.html Update zlib_how.html to match the web page, and add a license. 2023-01-24 20:43:19 -08:00
zpipe.c zlib 1.2.3.1 2011-09-09 23:25:27 -07:00
zran.c Add a NOPRIME #define to zran.c to not use inflatePrime(). 2023-04-13 15:41:32 -07:00
zran.h Rewrite of zran in examples. See version history in zran.c. 2023-02-18 20:53:39 -08:00

README.examples

This directory contains examples of the use of zlib and other relevant
programs and documentation.

enough.c
    calculation and justification of ENOUGH parameter in inftrees.h
    - calculates the maximum table space used in inflate tree
      construction over all possible Huffman codes

fitblk.c
    compress just enough input to nearly fill a requested output size
    - zlib isn't designed to do this, but fitblk does it anyway

gun.c
    uncompress a gzip file
    - illustrates the use of inflateBack() for high speed file-to-file
      decompression using call-back functions
    - is approximately twice as fast as gzip -d
    - also provides Unix uncompress functionality, again twice as fast

gzappend.c
    append to a gzip file
    - illustrates the use of the Z_BLOCK flush parameter for inflate()
    - illustrates the use of deflatePrime() to start at any bit

gzjoin.c
    join gzip files without recalculating the crc or recompressing
    - illustrates the use of the Z_BLOCK flush parameter for inflate()
    - illustrates the use of crc32_combine()

gzlog.c
gzlog.h
    efficiently and robustly maintain a message log file in gzip format
    - illustrates use of raw deflate, Z_PARTIAL_FLUSH, deflatePrime(),
      and deflateSetDictionary()
    - illustrates use of a gzip header extra field

gznorm.c
    normalize a gzip file by combining members into a single member
    - demonstrates how to concatenate deflate streams using Z_BLOCK

zlib_how.html
    painfully comprehensive description of zpipe.c (see below)
    - describes in excruciating detail the use of deflate() and inflate()

zpipe.c
    reads and writes zlib streams from stdin to stdout
    - illustrates the proper use of deflate() and inflate()
    - deeply commented in zlib_how.html (see above)

zran.c
zran.h
    index a zlib or gzip stream and randomly access it
    - illustrates the use of Z_BLOCK, inflatePrime(), and
      inflateSetDictionary() to provide random access