license header and line ending fixups
[pngwrite.git] / readme.paszlib
1 _____________________________________________________________________________\r
2 \r
3 PASZLIB 1.0                                                   May 11th, 1998\r
4 \r
5 Based on the zlib 1.1.2, a general purpose data compression library.\r
6 \r
7 Copyright (C) 1998,1999,2000 by NOMSSI NZALI Jacques H. C. \r
8 [kn&n DES]         See "Legal issues" for conditions of distribution and use.\r
9 _____________________________________________________________________________\r
10 \r
11 \r
12 Introduction\r
13 ============\r
14 \r
15 The 'zlib' compression library provides in-memory compression and\r
16 decompression functions, including integrity checks of the uncompressed\r
17 data.  This version of the library supports only one compression method\r
18 (deflation) but other algorithms will be added later and will have the same\r
19 stream interface.\r
20 \r
21 Compression can be done in a single step if the buffers are large\r
22 enough (for example if an input file is mmap'ed), or can be done by\r
23 repeated calls of the compression function.  In the latter case, the\r
24 application must provide more input and/or consume the output\r
25 (providing more output space) before each call.\r
26 \r
27 The default memory requirements for deflate are 256K plus a few kilobytes\r
28 for small objects. The default memory requirements for inflate are 32K\r
29 plus a few kilobytes for small objects.\r
30 \r
31 Change Log\r
32 ==========\r
33 \r
34 March 24th 2000 - minizip code by Gilles Vollant ported to Pascal. \r
35                   z_stream.msg defined as string[255] to avoid problems\r
36                   with Delphi 2+ dynamic string handling.\r
37                   changes to silence Delphi 5 compiler warning. If you\r
38                   have Delphi 5, defines Delphi5 in zconf.inc\r
39                               \r
40 May 7th 1999    - Some changes for FPC\r
41                   deflateCopy() has new parameters\r
42                   trees.pas - record constant definition\r
43 June 17th 1998  - Applied official 1.1.2 patch. \r
44                   Memcheck turned off by default.\r
45                   zutil.pas patch for Delphi 1 memory allocation corrected.\r
46                   dzlib.txt file added.\r
47                   compress2() is now exported\r
48 \r
49 June 25th 1998 -  fixed a conversion bug: in inftrees.pas, ZFREE(z, v) was\r
50                   missing in line 574;\r
51 \r
52 File list\r
53 =========\r
54 \r
55 Here is a road map to the files in the Paszlib distribution.\r
56 \r
57 readme.txt      Introduction, Documentation\r
58 dzlib.txt       Changes to Delphi sources for Paszlib stream classes \r
59 \r
60 include file\r
61 \r
62 zconf.inc       Configuration declarations.\r
63 \r
64 Pascal source code files:\r
65 \r
66 adler.pas      compute the Adler-32 checksum of a data stream\r
67 crc.pas        compute the CRC-32 of a data stream\r
68 gzio.pas       IO on .gz files\r
69 infblock.pas   interpret and process block types to last block\r
70 infcodes.pas   process literals and length/distance pairs\r
71 inffast.pas    process literals and length/distance pairs fast\r
72 inftrees.pas   generate Huffman trees for efficient decoding\r
73 infutil.pas    types and macros common to blocks and codes\r
74 strutils.pas   string utilities\r
75 trees.pas      output deflated data using Huffman coding\r
76 zcompres.pas   compress a memory buffer\r
77 zdeflate.pas   compress data using the deflation algorithm\r
78 zinflate.pas   zlib interface to inflate modules\r
79 zlib.pas       zlib data structures. read the comments there!\r
80 zuncompr.pas   decompress a memory buffer\r
81 zutil.pas\r
82 \r
83 minizip/ziputils.pas data structure and IO on .zip file \r
84 minizip/unzip.pas  \r
85 minizip/zip.pas\r
86       \r
87 Test applications\r
88 \r
89 example.pas    usage example of the zlib compression library\r
90 minigzip.pas   simulate gzip using the zlib compression library\r
91 minizip/miniunz.pas  simulates unzip using the zlib compression library\r
92 minizip/minizip.pas  simulates zip using the zlib compression library\r
93 \r
94 Legal issues\r
95 ============\r
96 \r
97 Copyright (C) 1998,1999,2000 by Jacques Nomssi Nzali\r
98 \r
99   This software is provided 'as-is', without any express or implied\r
100   warranty.  In no event will the author be held liable for any damages\r
101   arising from the use of this software.\r
102 \r
103   Permission is granted to anyone to use this software for any purpose,\r
104   including commercial applications, and to alter it and redistribute it\r
105   freely, subject to the following restrictions:\r
106 \r
107   1. The origin of this software must not be misrepresented; you must not\r
108      claim that you wrote the original software. If you use this software\r
109      in a product, an acknowledgment in the product documentation would be\r
110      appreciated but is not required.\r
111   2. Altered source versions must be plainly marked as such, and must not be\r
112      misrepresented as being the original software.\r
113   3. This notice may not be removed or altered from any source distribution.\r
114 \r
115 \r
116 Archive Locations:\r
117 ==================\r
118 \r
119 Check the Paszlib home page with links\r
120 \r
121       http://www.tu-chemnitz.de/~nomssi/paszlib.html\r
122 \r
123 The data format used by the zlib library is described by RFCs (Request for\r
124 Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt\r
125 (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).\r
126 These documents are also available in other formats from\r
127 ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html.\r
128 ____________________________________________________________________________\r
129 Jacques Nomssi Nzali <mailto:nomssi@physik.tu-chemnitz.de> March 24th, 2000