mkfs needs more memory for the boot ramdisk.
[minix3.git] / commands / bzip2-1.0.3 / README.MINIX
bloba03e17d162decccf644989dbf872a7effbc81ebf
1 ###############################################################################
2 # Quick installation
3 ###############################################################################
5 To build and install bzip into /usr/local, execute the following commands 
6 as user bin:
8 make
9 make install
11 To install into another directory use:
12 make install PREFIX=<path>
14 ###############################################################################
15 # bzip 1.0.3 for Minix
16 ###############################################################################
17 The text below is taken from the original README file. The original file is
18 available as README.ORIGINAL.
20 This is the README for bzip2, a block-sorting file compressor, version
21 1.0.3.  This version is fully compatible with the previous public
22 releases, versions 0.1pl2, 0.9.0, 0.9.5, 1.0.0, 1.0.1 and 1.0.2.
24 bzip2-1.0.3 is distributed under a BSD-style license.  For details,
25 see the file LICENSE.
27 Complete documentation is available in Postscript form (manual.ps),
28 PDF (manual.pdf) or html (manual.html).  A plain-text version of the
29 manual page is available as bzip2.txt.  A statement about Y2K issues
30 is now included in the file Y2K_INFO.
33 HOW TO BUILD -- MINIX
35 Type `make'.  This builds the library libbz2.a and then the
36 programs bzip2 and bzip2recover.  Six self-tests are run.
37 If the self-tests complete ok, carry on to installation:
39 To install in /usr/local/bin, /usr/local/lib, /usr/local/man and 
40    /usr/local/include, type
41    make install
42 To install somewhere else, eg, /xxx/yyy/{bin,lib,man,include}, type 
43    make install PREFIX=/xxx/yyy
44 If you are (justifiably) paranoid and want to see what 'make install'
45 is going to do, you can first do
46    make -n install                      or
47    make -n install PREFIX=/xxx/yyy      respectively.
48 The -n instructs make to show the commands it would execute, but
49 not actually execute them.
51 VALIDATION
53 Correct operation, in the sense that a compressed file can always be
54 decompressed to reproduce the original, is obviously of paramount
55 importance.  To validate bzip2, I used a modified version of Mark
56 Nelson's churn program.  Churn is an automated test driver which
57 recursively traverses a directory structure, using bzip2 to compress
58 and then decompress each file it encounters, and checking that the
59 decompressed data is the same as the original.
63 Please read and be aware of the following:
65 WARNING:
67    This program (attempts to) compress data by performing several
68    non-trivial transformations on it.  Unless you are 100% familiar
69    with *all* the algorithms contained herein, and with the
70    consequences of modifying them, you should NOT meddle with the
71    compression or decompression machinery.  Incorrect changes can and
72    very likely *will* lead to disastrous loss of data.
75 DISCLAIMER:
77    I TAKE NO RESPONSIBILITY FOR ANY LOSS OF DATA ARISING FROM THE
78    USE OF THIS PROGRAM, HOWSOEVER CAUSED.
80    Every compression of a file implies an assumption that the
81    compressed file can be decompressed to reproduce the original.
82    Great efforts in design, coding and testing have been made to
83    ensure that this program works correctly.  However, the complexity
84    of the algorithms, and, in particular, the presence of various
85    special cases in the code which occur with very low but non-zero
86    probability make it impossible to rule out the possibility of bugs
87    remaining in the program.  DO NOT COMPRESS ANY DATA WITH THIS
88    PROGRAM UNLESS YOU ARE PREPARED TO ACCEPT THE POSSIBILITY, HOWEVER
89    SMALL, THAT THE DATA WILL NOT BE RECOVERABLE.
91    That is not to say this program is inherently unreliable.  Indeed,
92    I very much hope the opposite is true.  bzip2 has been carefully
93    constructed and extensively tested.
96 PATENTS:
98    To the best of my knowledge, bzip2 does not use any patented
99    algorithms.  However, I do not have the resources to carry out
100    a patent search.  Therefore I cannot give any guarantee of the
101    above statement.
103 End of legalities.
106 WHAT'S NEW IN 0.9.0 (as compared to 0.1pl2) ?
108    * Approx 10% faster compression, 30% faster decompression
109    * -t (test mode) is a lot quicker
110    * Can decompress concatenated compressed files
111    * Programming interface, so programs can directly read/write .bz2 files
112    * Less restrictive (BSD-style) licensing
113    * Flag handling more compatible with GNU gzip
114    * Much more documentation, i.e., a proper user manual
115    * Hopefully, improved portability (at least of the library)
117 WHAT'S NEW IN 0.9.5 ?
119    * Compression speed is much less sensitive to the input
120      data than in previous versions.  Specifically, the very
121      slow performance caused by repetitive data is fixed.
122    * Many small improvements in file and flag handling.
123    * A Y2K statement.
125 WHAT'S NEW IN 1.0.0 ?
127    See the CHANGES file.
129 WHAT'S NEW IN 1.0.2 ?
131    See the CHANGES file.
133 WHAT'S NEW IN 1.0.3 ?
135    See the CHANGES file.
138 I hope you find bzip2 useful.  Feel free to contact me at
139    jseward@bzip.org
140 if you have any suggestions or queries.  Many people mailed me with
141 comments, suggestions and patches after the releases of bzip-0.15,
142 bzip-0.21, and bzip2 versions 0.1pl2, 0.9.0, 0.9.5, 1.0.0, 1.0.1 and
143 1.0.2, and the changes in bzip2 are largely a result of this feedback.
144 I thank you for your comments.
146 At least for the time being, bzip2's "home" is (or can be reached via)
147 http://www.bzip.org
149 Julian Seward
150 jseward@bzip.org
152 Cambridge, UK.
154 18     July 1996 (version 0.15)
155 25   August 1996 (version 0.21)
156  7   August 1997 (bzip2, version 0.1)
157 29   August 1997 (bzip2, version 0.1pl2)
158 23   August 1998 (bzip2, version 0.9.0)
159  8     June 1999 (bzip2, version 0.9.5)
160  4     Sept 1999 (bzip2, version 0.9.5d)
161  5      May 2000 (bzip2, version 1.0pre8)
162 30 December 2001 (bzip2, version 1.0.2pre1)
163 15 February 2005 (bzip2, version 1.0.3)
165 ###############################################################################
166 # Changes to the source of version 1.0.3
167 ###############################################################################
168 - Changed default installation to /usr/local
169 - Adjusted Makefile to separate testing from building, to allow chmem in
170   between
171 - Adjusted invocation of ar, as Minix ar does not support -q, even though the
172   documentation says it does