diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 43 |
1 files changed, 35 insertions, 8 deletions
| @@ -1,9 +1,9 @@ | |||
| 1 | 1 | ||
| 2 | This is the README for bzip2, a block-sorting file compressor, version | 2 | This is the README for bzip2, a block-sorting file compressor, version |
| 3 | 0.9.5d. This version is fully compatible with the previous public | 3 | 1.0. This version is fully compatible with the previous public |
| 4 | releases, bzip2-0.1pl2 and bzip2-0.9.0. | 4 | releases, bzip2-0.1pl2, bzip2-0.9.0 and bzip2-0.9.5. |
| 5 | 5 | ||
| 6 | bzip2-0.9.5 is distributed under a BSD-style license. For details, | 6 | bzip2-1.0 is distributed under a BSD-style license. For details, |
| 7 | see the file LICENSE. | 7 | see the file LICENSE. |
| 8 | 8 | ||
| 9 | Complete documentation is available in Postscript form (manual.ps) or | 9 | Complete documentation is available in Postscript form (manual.ps) or |
| @@ -30,15 +30,37 @@ The -n instructs make to show the commands it would execute, but | |||
| 30 | not actually execute them. | 30 | not actually execute them. |
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | HOW TO BUILD -- UNIX, shared library libbz2.so. | ||
| 34 | |||
| 35 | Do 'make -f Makefile-libbz2_so'. This Makefile seems to work for | ||
| 36 | Linux-ELF (RedHat 5.2 on an x86 box), with gcc. I make no claims | ||
| 37 | that it works for any other platform, though I suspect it probably | ||
| 38 | will work for most platforms employing both ELF and gcc. | ||
| 39 | |||
| 40 | bzip2-shared, a client of the shared library, is also build, but | ||
| 41 | not self-tested. So I suggest you also build using the normal | ||
| 42 | Makefile, since that conducts a self-test. | ||
| 43 | |||
| 44 | Important note for people upgrading .so's from 0.9.0/0.9.5 to | ||
| 45 | version 1.0. All the functions in the library have been renamed, | ||
| 46 | from (eg) bzCompress to BZ2_bzCompress, to avoid namespace pollution. | ||
| 47 | Unfortunately this means that the libbz2.so created by | ||
| 48 | Makefile-libbz2_so will not work with any program which used an | ||
| 49 | older version of the library. Sorry. I do encourage library | ||
| 50 | clients to make the effort to upgrade to use version 1.0, since | ||
| 51 | it is both faster and more robust than previous versions. | ||
| 52 | |||
| 53 | |||
| 33 | HOW TO BUILD -- Windows 95, NT, DOS, Mac, etc. | 54 | HOW TO BUILD -- Windows 95, NT, DOS, Mac, etc. |
| 34 | 55 | ||
| 35 | It's difficult for me to support compilation on all these platforms. | 56 | It's difficult for me to support compilation on all these platforms. |
| 36 | My approach is to collect binaries for these platforms, and put them | 57 | My approach is to collect binaries for these platforms, and put them |
| 37 | on my web page (http://www.muraroa.demon.co.uk). Look there. However | 58 | on the master web page (http://sourceware.cygnus.com/bzip2). Look |
| 38 | (FWIW), bzip2-0.9.5 is very standard ANSI C and should compile | 59 | there. However (FWIW), bzip2-1.0 is very standard ANSI C and should |
| 39 | unmodified with MS Visual C. For Win32, there is one important | 60 | compile unmodified with MS Visual C. For Win32, there is one |
| 40 | caveat: in bzip2.c, you must set BZ_UNIX to 0 and BZ_LCCWIN32 to 1 | 61 | important caveat: in bzip2.c, you must set BZ_UNIX to 0 and |
| 41 | before building. | 62 | BZ_LCCWIN32 to 1 before building. If you have difficulties building, |
| 63 | you might want to read README.COMPILATION.PROBLEMS. | ||
| 42 | 64 | ||
| 43 | 65 | ||
| 44 | VALIDATION | 66 | VALIDATION |
| @@ -116,6 +138,10 @@ WHAT'S NEW IN 0.9.5 ? | |||
| 116 | * Many small improvements in file and flag handling. | 138 | * Many small improvements in file and flag handling. |
| 117 | * A Y2K statement. | 139 | * A Y2K statement. |
| 118 | 140 | ||
| 141 | WHAT'S NEW IN 1.0 | ||
| 142 | |||
| 143 | See the CHANGES file. | ||
| 144 | |||
| 119 | I hope you find bzip2 useful. Feel free to contact me at | 145 | I hope you find bzip2 useful. Feel free to contact me at |
| 120 | jseward@acm.org | 146 | jseward@acm.org |
| 121 | if you have any suggestions or queries. Many people mailed me with | 147 | if you have any suggestions or queries. Many people mailed me with |
| @@ -137,3 +163,4 @@ Cambridge, UK | |||
| 137 | 23 August 1998 (bzip2, version 0.9.0) | 163 | 23 August 1998 (bzip2, version 0.9.0) |
| 138 | 8 June 1999 (bzip2, version 0.9.5) | 164 | 8 June 1999 (bzip2, version 0.9.5) |
| 139 | 4 Sept 1999 (bzip2, version 0.9.5d) | 165 | 4 Sept 1999 (bzip2, version 0.9.5d) |
| 166 | 5 May 2000 (bzip2, version 1.0pre8) | ||
