aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README40
-rw-r--r--README.COMPILATION.PROBLEMS103
-rw-r--r--README.XML.STUFF31
3 files changed, 59 insertions, 115 deletions
diff --git a/README b/README
index 07505d8..1aff448 100644
--- a/README
+++ b/README
@@ -1,15 +1,15 @@
1 1
2This is the README for bzip2, a block-sorting file compressor, version 2This is the README for bzip2, a block-sorting file compressor, version
31.0.2. This version is fully compatible with the previous public 31.0.3. This version is fully compatible with the previous public
4releases, versions 0.1pl2, 0.9.0, 0.9.5, 1.0.0 and 1.0.1. 4releases, versions 0.1pl2, 0.9.0, 0.9.5, 1.0.0, 1.0.1 and 1.0.2.
5 5
6bzip2-1.0.2 is distributed under a BSD-style license. For details, 6bzip2-1.0.3 is distributed under a BSD-style license. For details,
7see the file LICENSE. 7see the file LICENSE.
8 8
9Complete documentation is available in Postscript form (manual.ps), 9Complete documentation is available in Postscript form (manual.ps),
10PDF (manual.pdf, amazingly enough) or html (manual_toc.html). A 10PDF (manual.pdf) or html (manual.html). A plain-text version of the
11plain-text version of the manual page is available as bzip2.txt. 11manual page is available as bzip2.txt. A statement about Y2K issues
12A statement about Y2K issues is now included in the file Y2K_INFO. 12is now included in the file Y2K_INFO.
13 13
14 14
15HOW TO BUILD -- UNIX 15HOW TO BUILD -- UNIX
@@ -78,8 +78,7 @@ importance. To validate bzip2, I used a modified version of Mark
78Nelson's churn program. Churn is an automated test driver which 78Nelson's churn program. Churn is an automated test driver which
79recursively traverses a directory structure, using bzip2 to compress 79recursively traverses a directory structure, using bzip2 to compress
80and then decompress each file it encounters, and checking that the 80and then decompress each file it encounters, and checking that the
81decompressed data is the same as the original. There are more details 81decompressed data is the same as the original.
82in Section 4 of the user guide.
83 82
84 83
85 84
@@ -119,9 +118,9 @@ DISCLAIMER:
119PATENTS: 118PATENTS:
120 119
121 To the best of my knowledge, bzip2 does not use any patented 120 To the best of my knowledge, bzip2 does not use any patented
122 algorithms. However, I do not have the resources available to 121 algorithms. However, I do not have the resources to carry out
123 carry out a full patent search. Therefore I cannot give any 122 a patent search. Therefore I cannot give any guarantee of the
124 guarantee of the above statement. 123 above statement.
125 124
126End of legalities. 125End of legalities.
127 126
@@ -153,22 +152,26 @@ WHAT'S NEW IN 1.0.2 ?
153 152
154 See the CHANGES file. 153 See the CHANGES file.
155 154
155WHAT'S NEW IN 1.0.3 ?
156
157 See the CHANGES file.
158
156 159
157I hope you find bzip2 useful. Feel free to contact me at 160I hope you find bzip2 useful. Feel free to contact me at
158 jseward@acm.org 161 jseward@bzip.org
159if you have any suggestions or queries. Many people mailed me with 162if you have any suggestions or queries. Many people mailed me with
160comments, suggestions and patches after the releases of bzip-0.15, 163comments, suggestions and patches after the releases of bzip-0.15,
161bzip-0.21, and bzip2 versions 0.1pl2, 0.9.0, 0.9.5, 1.0.0 and 1.0.1, 164bzip-0.21, and bzip2 versions 0.1pl2, 0.9.0, 0.9.5, 1.0.0, 1.0.1 and
162and the changes in bzip2 are largely a result of this feedback. 1651.0.2, and the changes in bzip2 are largely a result of this feedback.
163I thank you for your comments. 166I thank you for your comments.
164 167
165At least for the time being, bzip2's "home" is (or can be reached via) 168At least for the time being, bzip2's "home" is (or can be reached via)
166http://sources.redhat.com/bzip2. 169http://www.bzip.org
167 170
168Julian Seward 171Julian Seward
169jseward@acm.org 172jseward@bzip.org
170 173
171Cambridge, UK (and what a great town this is!) 174Cambridge, UK.
172 175
17318 July 1996 (version 0.15) 17618 July 1996 (version 0.15)
17425 August 1996 (version 0.21) 17725 August 1996 (version 0.21)
@@ -178,4 +181,5 @@ Cambridge, UK (and what a great town this is!)
178 8 June 1999 (bzip2, version 0.9.5) 181 8 June 1999 (bzip2, version 0.9.5)
179 4 Sept 1999 (bzip2, version 0.9.5d) 182 4 Sept 1999 (bzip2, version 0.9.5d)
180 5 May 2000 (bzip2, version 1.0pre8) 183 5 May 2000 (bzip2, version 1.0pre8)
18130 December 2001 (bzip2, version 1.0.2pre1) \ No newline at end of file 18430 December 2001 (bzip2, version 1.0.2pre1)
18515 February 2005 (bzip2, version 1.0.3)
diff --git a/README.COMPILATION.PROBLEMS b/README.COMPILATION.PROBLEMS
index bd1822d..f1bc396 100644
--- a/README.COMPILATION.PROBLEMS
+++ b/README.COMPILATION.PROBLEMS
@@ -1,11 +1,10 @@
1 1
2bzip2-1.0 should compile without problems on the vast majority of 2bzip2-1.0.3 should compile without problems on the vast majority of
3platforms. Using the supplied Makefile, I've built and tested it 3platforms. Using the supplied Makefile, I've built and tested it
4myself for x86-linux, sparc-solaris, alpha-linux, x86-cygwin32 and 4myself for x86-linux and x86_64-linux. With makefile.msc, Visual C++
5alpha-tru64unix. With makefile.msc, Visual C++ 6.0 and nmake, you can 56.0 and nmake, you can build a native Win32 version too. Large file
6build a native Win32 version too. Large file support seems to work 6support seems to work correctly on at least alpha-tru64unix and
7correctly on at least alpha-tru64unix and x86-cygwin32 (on Windows 7x86-cygwin32 (on Windows 2000).
82000).
9 8
10When I say "large file" I mean a file of size 2,147,483,648 (2^31) 9When I say "large file" I mean a file of size 2,147,483,648 (2^31)
11bytes or above. Many older OSs can't handle files above this size, 10bytes or above. Many older OSs can't handle files above this size,
@@ -22,7 +21,7 @@ The technique of adding -D_FILE_OFFSET_BITS=64 to get large file
22support is, as far as I know, the Recommended Way to get correct large 21support is, as far as I know, the Recommended Way to get correct large
23file support. For more details, see the Large File Support 22file support. For more details, see the Large File Support
24Specification, published by the Large File Summit, at 23Specification, published by the Large File Summit, at
25 http://www.sas.com/standard/large.file/ 24 http://ftp.sas.com/standards/large.file
26 25
27As a general comment, if you get compilation errors which you think 26As a general comment, if you get compilation errors which you think
28are related to large file support, try removing the above define from 27are related to large file support, try removing the above define from
@@ -38,93 +37,3 @@ You can use the spewG.c program to generate huge files to test bzip2's
38large file support, if you are feeling paranoid. Be aware though that 37large file support, if you are feeling paranoid. Be aware though that
39any compilation problems which affect bzip2 will also affect spewG.c, 38any compilation problems which affect bzip2 will also affect spewG.c,
40alas. 39alas.
41
42
43Known problems as of 1.0pre8:
44~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45
46* HP/UX 10.20 and 11.00, using gcc (2.7.2.3 and 2.95.2): A large
47 number of warnings appear, including the following:
48
49 /usr/include/sys/resource.h: In function `getrlimit':
50 /usr/include/sys/resource.h:168:
51 warning: implicit declaration of function `__getrlimit64'
52 /usr/include/sys/resource.h: In function `setrlimit':
53 /usr/include/sys/resource.h:170:
54 warning: implicit declaration of function `__setrlimit64'
55
56 This would appear to be a problem with large file support, header
57 files and gcc. gcc may or may not give up at this point. If it
58 fails, you might be able to improve matters by adding
59 -D__STDC_EXT__=1
60 to the BIGFILES variable in the Makefile (ie, change its definition
61 to
62 BIGFILES=-D_FILE_OFFSET_BITS=64 -D__STDC_EXT__=1
63
64 Even if gcc does produce a binary which appears to work (ie passes
65 its self-tests), you might want to test it to see if it works properly
66 on large files.
67
68
69* HP/UX 10.20 and 11.00, using HP's cc compiler.
70
71 No specific problems for this combination, except that you'll need to
72 specify the -Ae flag, and zap the gcc-specific stuff
73 -Wall -Winline -O2 -fomit-frame-pointer -fno-strength-reduce.
74 You should retain -D_FILE_OFFSET_BITS=64 in order to get large
75 file support -- which is reported to work ok for this HP/UX + cc
76 combination.
77
78
79* SunOS 4.1.X.
80
81 Amazingly, there are still people out there using this venerable old
82 banger. I shouldn't be too rude -- I started life on SunOS, and
83 it was a pretty darn good OS, way back then. Anyway:
84
85 SunOS doesn't seem to have strerror(), so you'll have to use
86 perror(), perhaps by doing adding this (warning: UNTESTED CODE):
87
88 char* strerror ( int errnum )
89 {
90 if (errnum < 0 || errnum >= sys_nerr)
91 return "Unknown error";
92 else
93 return sys_errlist[errnum];
94 }
95
96 Or you could comment out the relevant calls to strerror; they're
97 not mission-critical. Or you could upgrade to Solaris. Ha ha ha!
98 (what?? you think I've got Bad Attitude?)
99
100
101* Making a shared library on Solaris. (Not really a compilation
102 problem, but many people ask ...)
103
104 Firstly, if you have Solaris 8, either you have libbz2.so already
105 on your system, or you can install it from the Solaris CD.
106
107 Secondly, be aware that there are potential naming conflicts
108 between the .so file supplied with Solaris 8, and the .so file
109 which Makefile-libbz2_so will make. Makefile-libbz2_so creates
110 a .so which has the names which I intend to be "official" as
111 of version 1.0.0 and onwards. Unfortunately, the .so in
112 Solaris 8 appeared before I decided on the final names, so
113 the two libraries are incompatible. We have since communicated
114 and I hope that the problems will have been solved in the next
115 version of Solaris, whenever that might appear.
116
117 All that said: you might be able to get somewhere
118 by finding the line in Makefile-libbz2_so which says
119
120 $(CC) -shared -Wl,-soname -Wl,libbz2.so.1.0 -o libbz2.so.1.0.2 $(OBJS)
121
122 and replacing with
123
124 $(CC) -G -shared -o libbz2.so.1.0.2 -h libbz2.so.1.0 $(OBJS)
125
126 If gcc objects to the combination -fpic -fPIC, get rid of
127 the second one, leaving just "-fpic".
128
129
130That's the end of the currently known compilation problems.
diff --git a/README.XML.STUFF b/README.XML.STUFF
new file mode 100644
index 0000000..0ff209f
--- /dev/null
+++ b/README.XML.STUFF
@@ -0,0 +1,31 @@
1The script xmlproc.sh takes an xml file as input,
2and processes it to create .pdf, .html or .ps output.
3It uses format.pl, a perl script to format <pre> blocks nicely,
4 and add CDATA tags so writers do not have to use eg. &lt;
5
6The file "entities.xml" must be edited to reflect current
7version, year, etc.
8
9
10Usage:
11
12 xmlproc.sh -v manual.xml
13 Validates an xml file to ensure no dtd-compliance errors
14
15 xmlproc.sh -html manual.xml
16 Output: manual.html
17
18 xmlproc.sh -pdf manual.xml
19 Output: manual.pdf
20
21 xmlproc.sh -ps manual.xml
22 Output: manual.ps
23
24
25Notum bene:
26- pdfxmltex barfs if given a filename with an underscore in it
27
28- xmltex won't work yet - there's a bug in passivetex
29 which we are all waiting for Sebastian to fix.
30 So we are going the xml -> pdf -> ps route for the time being,
31 using pdfxmltex.