diff options
| author | Julian Seward <jseward@acm.org> | 2006-12-20 22:13:13 +0100 |
|---|---|---|
| committer | Julian Seward <jseward@acm.org> | 2006-12-20 22:13:13 +0100 |
| commit | f10a33538e9bab6deb61779b3d8aae168824ef48 (patch) | |
| tree | ecd1c2ed553ced58a090e0d8b7b7a20bb7c95c80 /README | |
| parent | 4d540bfc95a4b0eefc1d1f388ec33534aaeb3a2f (diff) | |
| download | bzip2-1.0.4.tar.gz bzip2-1.0.4.tar.bz2 bzip2-1.0.4.zip | |
bzip2-1.0.4bzip2-1.0.4
Diffstat (limited to 'README')
| -rw-r--r-- | README | 100 |
1 files changed, 60 insertions, 40 deletions
| @@ -1,33 +1,48 @@ | |||
| 1 | 1 | ||
| 2 | This is the README for bzip2, a block-sorting file compressor, version | 2 | This is the README for bzip2/libzip2. |
| 3 | 1.0.3. This version is fully compatible with the previous public | 3 | This version is fully compatible with the previous public releases. |
| 4 | releases, versions 0.1pl2, 0.9.0, 0.9.5, 1.0.0, 1.0.1 and 1.0.2. | ||
| 5 | 4 | ||
| 6 | bzip2-1.0.3 is distributed under a BSD-style license. For details, | 5 | ------------------------------------------------------------------ |
| 7 | see the file LICENSE. | 6 | This file is part of bzip2/libbzip2, a program and library for |
| 7 | lossless, block-sorting data compression. | ||
| 8 | |||
| 9 | bzip2/libbzip2 version 1.0.4 of 20 December 2006 | ||
| 10 | Copyright (C) 1996-2006 Julian Seward <jseward@bzip.org> | ||
| 11 | |||
| 12 | Please read the WARNING, DISCLAIMER and PATENTS sections in this file. | ||
| 13 | |||
| 14 | This program is released under the terms of the license contained | ||
| 15 | in the file LICENSE. | ||
| 16 | ------------------------------------------------------------------ | ||
| 8 | 17 | ||
| 9 | Complete documentation is available in Postscript form (manual.ps), | 18 | Complete documentation is available in Postscript form (manual.ps), |
| 10 | PDF (manual.pdf) or html (manual.html). A plain-text version of the | 19 | PDF (manual.pdf) or html (manual.html). A plain-text version of the |
| 11 | manual page is available as bzip2.txt. A statement about Y2K issues | 20 | manual page is available as bzip2.txt. |
| 12 | is now included in the file Y2K_INFO. | ||
| 13 | 21 | ||
| 14 | 22 | ||
| 15 | HOW TO BUILD -- UNIX | 23 | HOW TO BUILD -- UNIX |
| 16 | 24 | ||
| 17 | Type `make'. This builds the library libbz2.a and then the | 25 | Type 'make'. This builds the library libbz2.a and then the programs |
| 18 | programs bzip2 and bzip2recover. Six self-tests are run. | 26 | bzip2 and bzip2recover. Six self-tests are run. If the self-tests |
| 19 | If the self-tests complete ok, carry on to installation: | 27 | complete ok, carry on to installation: |
| 28 | |||
| 29 | To install in /usr/local/bin, /usr/local/lib, /usr/local/man and | ||
| 30 | /usr/local/include, type | ||
| 20 | 31 | ||
| 21 | To install in /usr/bin, /usr/lib, /usr/man and /usr/include, type | ||
| 22 | make install | 32 | make install |
| 23 | To install somewhere else, eg, /xxx/yyy/{bin,lib,man,include}, type | 33 | |
| 34 | To install somewhere else, eg, /xxx/yyy/{bin,lib,man,include}, type | ||
| 35 | |||
| 24 | make install PREFIX=/xxx/yyy | 36 | make install PREFIX=/xxx/yyy |
| 37 | |||
| 25 | If you are (justifiably) paranoid and want to see what 'make install' | 38 | If you are (justifiably) paranoid and want to see what 'make install' |
| 26 | is going to do, you can first do | 39 | is going to do, you can first do |
| 40 | |||
| 27 | make -n install or | 41 | make -n install or |
| 28 | make -n install PREFIX=/xxx/yyy respectively. | 42 | make -n install PREFIX=/xxx/yyy respectively. |
| 29 | The -n instructs make to show the commands it would execute, but | 43 | |
| 30 | not actually execute them. | 44 | The -n instructs make to show the commands it would execute, but not |
| 45 | actually execute them. | ||
| 31 | 46 | ||
| 32 | 47 | ||
| 33 | HOW TO BUILD -- UNIX, shared library libbz2.so. | 48 | HOW TO BUILD -- UNIX, shared library libbz2.so. |
| @@ -49,23 +64,25 @@ Important note for people upgrading .so's from 0.9.0/0.9.5 to version | |||
| 49 | bzCompress to BZ2_bzCompress, to avoid namespace pollution. | 64 | bzCompress to BZ2_bzCompress, to avoid namespace pollution. |
| 50 | Unfortunately this means that the libbz2.so created by | 65 | Unfortunately this means that the libbz2.so created by |
| 51 | Makefile-libbz2_so will not work with any program which used an older | 66 | Makefile-libbz2_so will not work with any program which used an older |
| 52 | version of the library. Sorry. I do encourage library clients to | 67 | version of the library. I do encourage library clients to make the |
| 53 | make the effort to upgrade to use version 1.0, since it is both faster | 68 | effort to upgrade to use version 1.0, since it is both faster and more |
| 54 | and more robust than previous versions. | 69 | robust than previous versions. |
| 55 | 70 | ||
| 56 | 71 | ||
| 57 | HOW TO BUILD -- Windows 95, NT, DOS, Mac, etc. | 72 | HOW TO BUILD -- Windows 95, NT, DOS, Mac, etc. |
| 58 | 73 | ||
| 59 | It's difficult for me to support compilation on all these platforms. | 74 | It's difficult for me to support compilation on all these platforms. |
| 60 | My approach is to collect binaries for these platforms, and put them | 75 | My approach is to collect binaries for these platforms, and put them |
| 61 | on the master web page (http://sources.redhat.com/bzip2). Look there. | 76 | on the master web site (http://www.bzip.org). Look there. However |
| 62 | However (FWIW), bzip2-1.0.X is very standard ANSI C and should compile | 77 | (FWIW), bzip2-1.0.X is very standard ANSI C and should compile |
| 63 | unmodified with MS Visual C. If you have difficulties building, you | 78 | unmodified with MS Visual C. If you have difficulties building, you |
| 64 | might want to read README.COMPILATION.PROBLEMS. | 79 | might want to read README.COMPILATION.PROBLEMS. |
| 65 | 80 | ||
| 66 | At least using MS Visual C++ 6, you can build from the unmodified | 81 | At least using MS Visual C++ 6, you can build from the unmodified |
| 67 | sources by issuing, in a command shell: | 82 | sources by issuing, in a command shell: |
| 83 | |||
| 68 | nmake -f makefile.msc | 84 | nmake -f makefile.msc |
| 85 | |||
| 69 | (you may need to first run the MSVC-provided script VCVARS32.BAT | 86 | (you may need to first run the MSVC-provided script VCVARS32.BAT |
| 70 | so as to set up paths to the MSVC tools correctly). | 87 | so as to set up paths to the MSVC tools correctly). |
| 71 | 88 | ||
| @@ -86,18 +103,19 @@ Please read and be aware of the following: | |||
| 86 | 103 | ||
| 87 | WARNING: | 104 | WARNING: |
| 88 | 105 | ||
| 89 | This program (attempts to) compress data by performing several | 106 | This program and library (attempts to) compress data by |
| 90 | non-trivial transformations on it. Unless you are 100% familiar | 107 | performing several non-trivial transformations on it. |
| 91 | with *all* the algorithms contained herein, and with the | 108 | Unless you are 100% familiar with *all* the algorithms |
| 92 | consequences of modifying them, you should NOT meddle with the | 109 | contained herein, and with the consequences of modifying them, |
| 93 | compression or decompression machinery. Incorrect changes can and | 110 | you should NOT meddle with the compression or decompression |
| 94 | very likely *will* lead to disastrous loss of data. | 111 | machinery. Incorrect changes can and very likely *will* |
| 112 | lead to disastrous loss of data. | ||
| 95 | 113 | ||
| 96 | 114 | ||
| 97 | DISCLAIMER: | 115 | DISCLAIMER: |
| 98 | 116 | ||
| 99 | I TAKE NO RESPONSIBILITY FOR ANY LOSS OF DATA ARISING FROM THE | 117 | I TAKE NO RESPONSIBILITY FOR ANY LOSS OF DATA ARISING FROM THE |
| 100 | USE OF THIS PROGRAM, HOWSOEVER CAUSED. | 118 | USE OF THIS PROGRAM/LIBRARY, HOWSOEVER CAUSED. |
| 101 | 119 | ||
| 102 | Every compression of a file implies an assumption that the | 120 | Every compression of a file implies an assumption that the |
| 103 | compressed file can be decompressed to reproduce the original. | 121 | compressed file can be decompressed to reproduce the original. |
| @@ -110,19 +128,18 @@ DISCLAIMER: | |||
| 110 | PROGRAM UNLESS YOU ARE PREPARED TO ACCEPT THE POSSIBILITY, HOWEVER | 128 | PROGRAM UNLESS YOU ARE PREPARED TO ACCEPT THE POSSIBILITY, HOWEVER |
| 111 | SMALL, THAT THE DATA WILL NOT BE RECOVERABLE. | 129 | SMALL, THAT THE DATA WILL NOT BE RECOVERABLE. |
| 112 | 130 | ||
| 113 | That is not to say this program is inherently unreliable. Indeed, | 131 | That is not to say this program is inherently unreliable. |
| 114 | I very much hope the opposite is true. bzip2 has been carefully | 132 | Indeed, I very much hope the opposite is true. bzip2/libbzip2 |
| 115 | constructed and extensively tested. | 133 | has been carefully constructed and extensively tested. |
| 116 | 134 | ||
| 117 | 135 | ||
| 118 | PATENTS: | 136 | PATENTS: |
| 119 | 137 | ||
| 120 | To the best of my knowledge, bzip2 does not use any patented | 138 | To the best of my knowledge, bzip2/libbzip2 does not use any |
| 121 | algorithms. However, I do not have the resources to carry out | 139 | patented algorithms. However, I do not have the resources |
| 122 | a patent search. Therefore I cannot give any guarantee of the | 140 | to carry out a patent search. Therefore I cannot give any |
| 123 | above statement. | 141 | guarantee of the above statement. |
| 124 | 142 | ||
| 125 | End of legalities. | ||
| 126 | 143 | ||
| 127 | 144 | ||
| 128 | WHAT'S NEW IN 0.9.0 (as compared to 0.1pl2) ? | 145 | WHAT'S NEW IN 0.9.0 (as compared to 0.1pl2) ? |
| @@ -156,21 +173,23 @@ WHAT'S NEW IN 1.0.3 ? | |||
| 156 | 173 | ||
| 157 | See the CHANGES file. | 174 | See the CHANGES file. |
| 158 | 175 | ||
| 176 | WHAT'S NEW IN 1.0.4 ? | ||
| 177 | |||
| 178 | See the CHANGES file. | ||
| 179 | |||
| 159 | 180 | ||
| 160 | I hope you find bzip2 useful. Feel free to contact me at | 181 | I hope you find bzip2 useful. Feel free to contact me at |
| 161 | jseward@bzip.org | 182 | jseward@bzip.org |
| 162 | if you have any suggestions or queries. Many people mailed me with | 183 | if you have any suggestions or queries. Many people mailed me with |
| 163 | comments, suggestions and patches after the releases of bzip-0.15, | 184 | comments, suggestions and patches after the releases of bzip-0.15, |
| 164 | bzip-0.21, and bzip2 versions 0.1pl2, 0.9.0, 0.9.5, 1.0.0, 1.0.1 and | 185 | bzip-0.21, and bzip2 versions 0.1pl2, 0.9.0, 0.9.5, 1.0.0, 1.0.1, |
| 165 | 1.0.2, and the changes in bzip2 are largely a result of this feedback. | 186 | 1.0.2 and 1.0.3, and the changes in bzip2 are largely a result of this |
| 166 | I thank you for your comments. | 187 | feedback. I thank you for your comments. |
| 167 | 188 | ||
| 168 | At least for the time being, bzip2's "home" is (or can be reached via) | 189 | bzip2's "home" is http://www.bzip.org/ |
| 169 | http://www.bzip.org | ||
| 170 | 190 | ||
| 171 | Julian Seward | 191 | Julian Seward |
| 172 | jseward@bzip.org | 192 | jseward@bzip.org |
| 173 | |||
| 174 | Cambridge, UK. | 193 | Cambridge, UK. |
| 175 | 194 | ||
| 176 | 18 July 1996 (version 0.15) | 195 | 18 July 1996 (version 0.15) |
| @@ -183,3 +202,4 @@ Cambridge, UK. | |||
| 183 | 5 May 2000 (bzip2, version 1.0pre8) | 202 | 5 May 2000 (bzip2, version 1.0pre8) |
| 184 | 30 December 2001 (bzip2, version 1.0.2pre1) | 203 | 30 December 2001 (bzip2, version 1.0.2pre1) |
| 185 | 15 February 2005 (bzip2, version 1.0.3) | 204 | 15 February 2005 (bzip2, version 1.0.3) |
| 205 | 20 December 2006 (bzip2, version 1.0.4) | ||
