3 <!-- This HTML file has been created by texi2html 1.54
4 from manual.texi on 23 March 2000 -->
6 <TITLE>bzip2 and libbzip2 - Table of Contents</TITLE>
10 <H1>bzip2 and libbzip2</H1>
11 <H2>a program and library for data compression</H2>
12 <H2>copyright (C) 1996-2000 Julian Seward</H2>
13 <H2>version 1.0 of 21 March 2000</H2>
14 <ADDRESS>Julian Seward</ADDRESS>
19 This program, <CODE>bzip2</CODE>,
20 and associated library <CODE>libbzip2</CODE>, are
21 Copyright (C) 1996-2000 Julian R Seward. All rights reserved.
25 Redistribution and use in source and binary forms, with or without
26 modification, are permitted provided that the following conditions
32 Redistributions of source code must retain the above copyright
33 notice, this list of conditions and the following disclaimer.
36 The origin of this software must not be misrepresented; you must
37 not claim that you wrote the original software. If you use this
38 software in a product, an acknowledgment in the product
39 documentation would be appreciated but is not required.
42 Altered source versions must be plainly marked as such, and must
43 not be misrepresented as being the original software.
46 The name of the author may not be used to endorse or promote
47 products derived from this software without specific prior written
52 THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS
53 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
54 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
55 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
56 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
57 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
58 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
59 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
60 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
61 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
62 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
66 Julian Seward, Cambridge, UK.
70 <CODE>jseward@acm.org</CODE>
74 <CODE>http://sourceware.cygnus.com/bzip2</CODE>
78 <CODE>http://www.cacheprof.org</CODE>
82 <CODE>http://www.muraroa.demon.co.uk</CODE>
86 <CODE>bzip2</CODE>/<CODE>libbzip2</CODE> version 1.0 of 21 March 2000.
90 PATENTS: To the best of my knowledge, <CODE>bzip2</CODE> does not use any patented
91 algorithms. However, I do not have the resources available to carry out
92 a full patent search. Therefore I cannot give any guarantee of the
98 <LI><A NAME="TOC1" HREF="manual_1.html#SEC1">Introduction</A>
99 <LI><A NAME="TOC2" HREF="manual_2.html#SEC2">How to use <CODE>bzip2</CODE></A>
103 <LI><A NAME="TOC3" HREF="manual_2.html#SEC3">NAME</A>
104 <LI><A NAME="TOC4" HREF="manual_2.html#SEC4">SYNOPSIS</A>
105 <LI><A NAME="TOC5" HREF="manual_2.html#SEC5">DESCRIPTION</A>
106 <LI><A NAME="TOC6" HREF="manual_2.html#SEC6">OPTIONS</A>
107 <LI><A NAME="TOC7" HREF="manual_2.html#SEC7">MEMORY MANAGEMENT</A>
108 <LI><A NAME="TOC8" HREF="manual_2.html#SEC8">RECOVERING DATA FROM DAMAGED FILES</A>
109 <LI><A NAME="TOC9" HREF="manual_2.html#SEC9">PERFORMANCE NOTES</A>
110 <LI><A NAME="TOC10" HREF="manual_2.html#SEC10">CAVEATS</A>
111 <LI><A NAME="TOC11" HREF="manual_2.html#SEC11">AUTHOR</A>
115 <LI><A NAME="TOC12" HREF="manual_3.html#SEC12">Programming with <CODE>libbzip2</CODE></A>
117 <LI><A NAME="TOC13" HREF="manual_3.html#SEC13">Top-level structure</A>
119 <LI><A NAME="TOC14" HREF="manual_3.html#SEC14">Low-level summary</A>
120 <LI><A NAME="TOC15" HREF="manual_3.html#SEC15">High-level summary</A>
121 <LI><A NAME="TOC16" HREF="manual_3.html#SEC16">Utility functions summary</A>
123 <LI><A NAME="TOC17" HREF="manual_3.html#SEC17">Error handling</A>
124 <LI><A NAME="TOC18" HREF="manual_3.html#SEC18">Low-level interface</A>
126 <LI><A NAME="TOC19" HREF="manual_3.html#SEC19"><CODE>BZ2_bzCompressInit</CODE></A>
127 <LI><A NAME="TOC20" HREF="manual_3.html#SEC20"><CODE>BZ2_bzCompress</CODE></A>
128 <LI><A NAME="TOC21" HREF="manual_3.html#SEC21"><CODE>BZ2_bzCompressEnd</CODE></A>
129 <LI><A NAME="TOC22" HREF="manual_3.html#SEC22"><CODE>BZ2_bzDecompressInit</CODE></A>
130 <LI><A NAME="TOC23" HREF="manual_3.html#SEC23"><CODE>BZ2_bzDecompress</CODE></A>
131 <LI><A NAME="TOC24" HREF="manual_3.html#SEC24"><CODE>BZ2_bzDecompressEnd</CODE></A>
133 <LI><A NAME="TOC25" HREF="manual_3.html#SEC25">High-level interface</A>
135 <LI><A NAME="TOC26" HREF="manual_3.html#SEC26"><CODE>BZ2_bzReadOpen</CODE></A>
136 <LI><A NAME="TOC27" HREF="manual_3.html#SEC27"><CODE>BZ2_bzRead</CODE></A>
137 <LI><A NAME="TOC28" HREF="manual_3.html#SEC28"><CODE>BZ2_bzReadGetUnused</CODE></A>
138 <LI><A NAME="TOC29" HREF="manual_3.html#SEC29"><CODE>BZ2_bzReadClose</CODE></A>
139 <LI><A NAME="TOC30" HREF="manual_3.html#SEC30"><CODE>BZ2_bzWriteOpen</CODE></A>
140 <LI><A NAME="TOC31" HREF="manual_3.html#SEC31"><CODE>BZ2_bzWrite</CODE></A>
141 <LI><A NAME="TOC32" HREF="manual_3.html#SEC32"><CODE>BZ2_bzWriteClose</CODE></A>
142 <LI><A NAME="TOC33" HREF="manual_3.html#SEC33">Handling embedded compressed data streams</A>
143 <LI><A NAME="TOC34" HREF="manual_3.html#SEC34">Standard file-reading/writing code</A>
145 <LI><A NAME="TOC35" HREF="manual_3.html#SEC35">Utility functions</A>
147 <LI><A NAME="TOC36" HREF="manual_3.html#SEC36"><CODE>BZ2_bzBuffToBuffCompress</CODE></A>
148 <LI><A NAME="TOC37" HREF="manual_3.html#SEC37"><CODE>BZ2_bzBuffToBuffDecompress</CODE></A>
150 <LI><A NAME="TOC38" HREF="manual_3.html#SEC38"><CODE>zlib</CODE> compatibility functions</A>
151 <LI><A NAME="TOC39" HREF="manual_3.html#SEC39">Using the library in a <CODE>stdio</CODE>-free environment</A>
153 <LI><A NAME="TOC40" HREF="manual_3.html#SEC40">Getting rid of <CODE>stdio</CODE></A>
154 <LI><A NAME="TOC41" HREF="manual_3.html#SEC41">Critical error handling</A>
156 <LI><A NAME="TOC42" HREF="manual_3.html#SEC42">Making a Windows DLL</A>
158 <LI><A NAME="TOC43" HREF="manual_4.html#SEC43">Miscellanea</A>
160 <LI><A NAME="TOC44" HREF="manual_4.html#SEC44">Limitations of the compressed file format</A>
161 <LI><A NAME="TOC45" HREF="manual_4.html#SEC45">Portability issues</A>
162 <LI><A NAME="TOC46" HREF="manual_4.html#SEC46">Reporting bugs</A>
163 <LI><A NAME="TOC47" HREF="manual_4.html#SEC47">Did you get the right package?</A>
164 <LI><A NAME="TOC48" HREF="manual_4.html#SEC48">Testing</A>
165 <LI><A NAME="TOC49" HREF="manual_4.html#SEC49">Further reading</A>
169 This document was generated on 23 March 2000 using the
170 <A HREF="http://wwwcn.cern.ch/dci/texi2html/">texi2html</A>
171 translator version 1.51a.</P>