README
1The files here are from the bzip2 1.0.6 distribution, unaltered,
2from http://sources.redhat.com/bzip2, by Julian Seward, jseward@acm.org
3
4We have configured the makefiles so that this directory is compiled
5under perl, using perl compilation parameters. We have also reorganized
6the filenames. See "fixup-bzlib-src".
7Specifically,
8
9* Renamed the Makefiles with a "c-" prefix.
10* Renamed the windows specific stuff with a "win-" prefix.
11* Renamed all the standalone testing widgets with a "tst-" prefix.
12
13What follows is the README from the bzip2 1.0.6 distribution.
14
15Rob Janes
16r w j a n e s a t p r i m u s . c a
17Reini Urban
18r u r b a n @ c p a n e l . n e t
19
20-------------------------------- snip --------------------------------
21
22This is the README for bzip2/libzip2.
23This version is fully compatible with the previous public releases.
24
25------------------------------------------------------------------
26This file is part of bzip2/libbzip2, a program and library for
27lossless, block-sorting data compression.
28
29bzip2/libbzip2 version 1.0.6 of 6 September 2010
30Copyright (C) 1996-2010 Julian Seward <jseward@bzip.org>
31
32Please read the WARNING, DISCLAIMER and PATENTS sections in this file.
33
34This program is released under the terms of the license contained
35in the file LICENSE.
36------------------------------------------------------------------
37
38Complete documentation is available in Postscript form (manual.ps),
39PDF (manual.pdf) or html (manual.html). A plain-text version of the
40manual page is available as bzip2.txt.
41
42
43HOW TO BUILD -- UNIX
44
45Type 'make'. This builds the library libbz2.a and then the programs
46bzip2 and bzip2recover. Six self-tests are run. If the self-tests
47complete ok, carry on to installation:
48
49To install in /usr/local/bin, /usr/local/lib, /usr/local/man and
50/usr/local/include, type
51
52 make install
53
54To install somewhere else, eg, /xxx/yyy/{bin,lib,man,include}, type
55
56 make install PREFIX=/xxx/yyy
57
58If you are (justifiably) paranoid and want to see what 'make install'
59is going to do, you can first do
60
61 make -n install or
62 make -n install PREFIX=/xxx/yyy respectively.
63
64The -n instructs make to show the commands it would execute, but not
65actually execute them.
66
67
68HOW TO BUILD -- UNIX, shared library libbz2.so.
69
70Do 'make -f Makefile-libbz2_so'. This Makefile seems to work for
71Linux-ELF (RedHat 7.2 on an x86 box), with gcc. I make no claims
72that it works for any other platform, though I suspect it probably
73will work for most platforms employing both ELF and gcc.
74
75bzip2-shared, a client of the shared library, is also built, but not
76self-tested. So I suggest you also build using the normal Makefile,
77since that conducts a self-test. A second reason to prefer the
78version statically linked to the library is that, on x86 platforms,
79building shared objects makes a valuable register (%ebx) unavailable
80to gcc, resulting in a slowdown of 10%-20%, at least for bzip2.
81
82Important note for people upgrading .so's from 0.9.0/0.9.5 to version
831.0.X. All the functions in the library have been renamed, from (eg)
84bzCompress to BZ2_bzCompress, to avoid namespace pollution.
85Unfortunately this means that the libbz2.so created by
86Makefile-libbz2_so will not work with any program which used an older
87version of the library. I do encourage library clients to make the
88effort to upgrade to use version 1.0, since it is both faster and more
89robust than previous versions.
90
91
92HOW TO BUILD -- Windows 95, NT, DOS, Mac, etc.
93
94It's difficult for me to support compilation on all these platforms.
95My approach is to collect binaries for these platforms, and put them
96on the master web site (http://www.bzip.org). Look there. However
97(FWIW), bzip2-1.0.X is very standard ANSI C and should compile
98unmodified with MS Visual C. If you have difficulties building, you
99might want to read README.COMPILATION.PROBLEMS.
100
101At least using MS Visual C++ 6, you can build from the unmodified
102sources by issuing, in a command shell:
103
104 nmake -f makefile.msc
105
106(you may need to first run the MSVC-provided script VCVARS32.BAT
107 so as to set up paths to the MSVC tools correctly).
108
109
110VALIDATION
111
112Correct operation, in the sense that a compressed file can always be
113decompressed to reproduce the original, is obviously of paramount
114importance. To validate bzip2, I used a modified version of Mark
115Nelson's churn program. Churn is an automated test driver which
116recursively traverses a directory structure, using bzip2 to compress
117and then decompress each file it encounters, and checking that the
118decompressed data is the same as the original.
119
120
121
122Please read and be aware of the following:
123
124WARNING:
125
126 This program and library (attempts to) compress data by
127 performing several non-trivial transformations on it.
128 Unless you are 100% familiar with *all* the algorithms
129 contained herein, and with the consequences of modifying them,
130 you should NOT meddle with the compression or decompression
131 machinery. Incorrect changes can and very likely *will*
132 lead to disastrous loss of data.
133
134
135DISCLAIMER:
136
137 I TAKE NO RESPONSIBILITY FOR ANY LOSS OF DATA ARISING FROM THE
138 USE OF THIS PROGRAM/LIBRARY, HOWSOEVER CAUSED.
139
140 Every compression of a file implies an assumption that the
141 compressed file can be decompressed to reproduce the original.
142 Great efforts in design, coding and testing have been made to
143 ensure that this program works correctly. However, the complexity
144 of the algorithms, and, in particular, the presence of various
145 special cases in the code which occur with very low but non-zero
146 probability make it impossible to rule out the possibility of bugs
147 remaining in the program. DO NOT COMPRESS ANY DATA WITH THIS
148 PROGRAM UNLESS YOU ARE PREPARED TO ACCEPT THE POSSIBILITY, HOWEVER
149 SMALL, THAT THE DATA WILL NOT BE RECOVERABLE.
150
151 That is not to say this program is inherently unreliable.
152 Indeed, I very much hope the opposite is true. bzip2/libbzip2
153 has been carefully constructed and extensively tested.
154
155
156PATENTS:
157
158 To the best of my knowledge, bzip2/libbzip2 does not use any
159 patented algorithms. However, I do not have the resources
160 to carry out a patent search. Therefore I cannot give any
161 guarantee of the above statement.
162
163
164
165WHAT'S NEW IN 0.9.0 (as compared to 0.1pl2) ?
166
167 * Approx 10% faster compression, 30% faster decompression
168 * -t (test mode) is a lot quicker
169 * Can decompress concatenated compressed files
170 * Programming interface, so programs can directly read/write .bz2 files
171 * Less restrictive (BSD-style) licensing
172 * Flag handling more compatible with GNU gzip
173 * Much more documentation, i.e., a proper user manual
174 * Hopefully, improved portability (at least of the library)
175
176WHAT'S NEW IN 0.9.5 ?
177
178 * Compression speed is much less sensitive to the input
179 data than in previous versions. Specifically, the very
180 slow performance caused by repetitive data is fixed.
181 * Many small improvements in file and flag handling.
182 * A Y2K statement.
183
184WHAT'S NEW IN 1.0.0 ?
185
186 See the CHANGES file.
187
188WHAT'S NEW IN 1.0.2 ?
189
190 See the CHANGES file.
191
192WHAT'S NEW IN 1.0.3 ?
193
194 See the CHANGES file.
195
196WHAT'S NEW IN 1.0.4 ?
197
198 See the CHANGES file.
199
200WHAT'S NEW IN 1.0.5 ?
201
202 See the CHANGES file.
203
204WHAT'S NEW IN 1.0.6 ?
205
206 See the CHANGES file.
207
208
209I hope you find bzip2 useful. Feel free to contact me at
210 jseward@bzip.org
211if you have any suggestions or queries. Many people mailed me with
212comments, suggestions and patches after the releases of bzip-0.15,
213bzip-0.21, and bzip2 versions 0.1pl2, 0.9.0, 0.9.5, 1.0.0, 1.0.1,
2141.0.2 and 1.0.3, and the changes in bzip2 are largely a result of this
215feedback. I thank you for your comments.
216
217bzip2's "home" is http://www.bzip.org/
218
219Julian Seward
220jseward@bzip.org
221Cambridge, UK.
222
22318 July 1996 (version 0.15)
22425 August 1996 (version 0.21)
225 7 August 1997 (bzip2, version 0.1)
22629 August 1997 (bzip2, version 0.1pl2)
22723 August 1998 (bzip2, version 0.9.0)
228 8 June 1999 (bzip2, version 0.9.5)
229 4 Sept 1999 (bzip2, version 0.9.5d)
230 5 May 2000 (bzip2, version 1.0pre8)
23130 December 2001 (bzip2, version 1.0.2pre1)
23215 February 2005 (bzip2, version 1.0.3)
23320 December 2006 (bzip2, version 1.0.4)
23410 December 2007 (bzip2, version 1.0.5)
235 6 Sept 2010 (bzip2, version 1.0.6)
236
README.COMPILATION.PROBLEMS
1------------------------------------------------------------------
2This file is part of bzip2/libbzip2, a program and library for
3lossless, block-sorting data compression.
4
5bzip2/libbzip2 version 1.0.6 of 6 September 2010
6Copyright (C) 1996-2010 Julian Seward <jseward@bzip.org>
7
8Please read the WARNING, DISCLAIMER and PATENTS sections in the
9README file.
10
11This program is released under the terms of the license contained
12in the file LICENSE.
13------------------------------------------------------------------
14
15bzip2-1.0.6 should compile without problems on the vast majority of
16platforms. Using the supplied Makefile, I've built and tested it
17myself for x86-linux and amd64-linux. With makefile.msc, Visual C++
186.0 and nmake, you can build a native Win32 version too. Large file
19support seems to work correctly on at least on amd64-linux.
20
21When I say "large file" I mean a file of size 2,147,483,648 (2^31)
22bytes or above. Many older OSs can't handle files above this size,
23but many newer ones can. Large files are pretty huge -- most files
24you'll encounter are not Large Files.
25
26Early versions of bzip2 (0.1, 0.9.0, 0.9.5) compiled on a wide variety
27of platforms without difficulty, and I hope this version will continue
28in that tradition. However, in order to support large files, I've had
29to include the define -D_FILE_OFFSET_BITS=64 in the Makefile. This
30can cause problems.
31
32The technique of adding -D_FILE_OFFSET_BITS=64 to get large file
33support is, as far as I know, the Recommended Way to get correct large
34file support. For more details, see the Large File Support
35Specification, published by the Large File Summit, at
36
37 http://ftp.sas.com/standards/large.file
38
39As a general comment, if you get compilation errors which you think
40are related to large file support, try removing the above define from
41the Makefile, ie, delete the line
42
43 BIGFILES=-D_FILE_OFFSET_BITS=64
44
45from the Makefile, and do 'make clean ; make'. This will give you a
46version of bzip2 without large file support, which, for most
47applications, is probably not a problem.
48
49Alternatively, try some of the platform-specific hints listed below.
50
51You can use the spewG.c program to generate huge files to test bzip2's
52large file support, if you are feeling paranoid. Be aware though that
53any compilation problems which affect bzip2 will also affect spewG.c,
54alas.
55
56AIX: I have reports that for large file support, you need to specify
57-D_LARGE_FILES rather than -D_FILE_OFFSET_BITS=64. I have not tested
58this myself.
59
README.XML.STUFF
1 ----------------------------------------------------------------
2 This file is part of bzip2/libbzip2, a program and library for
3 lossless, block-sorting data compression.
4
5 bzip2/libbzip2 version 1.0.6 of 6 September 2010
6 Copyright (C) 1996-2010 Julian Seward <jseward@bzip.org>
7
8 Please read the WARNING, DISCLAIMER and PATENTS sections in the
9 README file.
10
11 This program is released under the terms of the license contained
12 in the file LICENSE.
13 ----------------------------------------------------------------
14
15The script xmlproc.sh takes an xml file as input,
16and processes it to create .pdf, .html or .ps output.
17It uses format.pl, a perl script to format <pre> blocks nicely,
18 and add CDATA tags so writers do not have to use eg. <
19
20The file "entities.xml" must be edited to reflect current
21version, year, etc.
22
23
24Usage:
25
26 ./xmlproc.sh -v manual.xml
27 Validates an xml file to ensure no dtd-compliance errors
28
29 ./xmlproc.sh -html manual.xml
30 Output: manual.html
31
32 ./xmlproc.sh -pdf manual.xml
33 Output: manual.pdf
34
35 ./xmlproc.sh -ps manual.xml
36 Output: manual.ps
37
38
39Notum bene:
40- pdfxmltex barfs if given a filename with an underscore in it
41
42- xmltex won't work yet - there's a bug in passivetex
43 which we are all waiting for Sebastian to fix.
44 So we are going the xml -> pdf -> ps route for the time being,
45 using pdfxmltex.
46