← Back to branch summary

~ubuntu-branches/ubuntu/raring/codeblocks/raring-proposed

« back to all changes in this revision

Viewing changes to src/plugins/contrib/help_plugin/bzip2/README

  • Committer: Bazaar Package Importer
  • Author(s): Cosme Domínguez Díaz
  • Date: 2010-08-09 04:38:38 UTC
  • mfrom: (1.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20100809043838-a59ygguym4eg0jgw
Tags: 10.05-0ubuntu1
https://launchpad.net/bugs/322350
* New upstream release. Closes (LP: #322350)
 - Switch to dpkg-source 3.0 (quilt) format
 - Remove unneeded README.source
 - Add debian/get-source-orig script that removes all
   Windows prebuilt binaries
* Bump Standards-Version to 3.9.1
 - Stop shipping *.la files
* debian/control
 - Add cdbs package as Build-Depend
 - Add libbz2-dev and zlib1g-dev packages as
   Build-Depends (needed by libhelp_plugin.so)
 - Remove dpatch package of Build-Depends
 - Add codeblocks-contrib-debug package
 - Split architecture-independent files of codeblocks
   package in codeblocks-common package
* debian/rules
 - Switch to CDBS rules system
 - Add parallel build support
 - Add a call to debian/get-source-orig script
 - Use lzma compression (saves 23,5 MB of free space)
* debian/patches
 - Refresh 01_codeblocks_plugin_path
 - Add 02_no_Makefiles_in_debian_dir to remove any link
   in codeblocks build system to deleted Makefiles of debian directory
 - Drop 02_ftbfs_gcc44 and 03_ftbfs_glib221 (merged in upstream)
* debian/watch
 - Update to use the new host (berlios.de)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/plugins/contrib/help_plugin/bzip2/README
1
1
 
2
 
This is the README for bzip2, a block-sorting file compressor, version
3
 
1.0.  This version is fully compatible with the previous public
4
 
releases, bzip2-0.1pl2, bzip2-0.9.0 and bzip2-0.9.5.
5
 
 
6
 
bzip2-1.0 is distributed under a BSD-style license.  For details,
7
 
see the file LICENSE.
8
 
 
9
 
Complete documentation is available in Postscript form (manual.ps) or
10
 
html (manual_toc.html).  A plain-text version of the manual page is
11
 
available as bzip2.txt.  A statement about Y2K issues is now included
12
 
in the file Y2K_INFO.
 
2
This is the README for bzip2/libzip2.
 
3
This version is fully compatible with the previous public releases.
 
4
 
 
5
------------------------------------------------------------------
 
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.5 of 10 December 2007
 
10
Copyright (C) 1996-2007 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
------------------------------------------------------------------
 
17
 
 
18
Complete documentation is available in Postscript form (manual.ps),
 
19
PDF (manual.pdf) or html (manual.html).  A plain-text version of the
 
20
manual page is available as bzip2.txt.
13
21
 
14
22
 
15
23
HOW TO BUILD -- UNIX
16
24
 
17
 
Type `make'.  This builds the library libbz2.a and then the
18
 
programs bzip2 and bzip2recover.  Six self-tests are run.
19
 
If the self-tests complete ok, carry on to installation:
20
 
 
21
 
To install in /usr/bin, /usr/lib, /usr/man and /usr/include, type
 
25
Type 'make'.  This builds the library libbz2.a and then the programs
 
26
bzip2 and bzip2recover.  Six self-tests are run.  If the self-tests
 
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
 
31
 
22
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
36
   make install PREFIX=/xxx/yyy
 
37
 
25
38
If you are (justifiably) paranoid and want to see what 'make install'
26
39
is going to do, you can first do
 
40
 
27
41
   make -n install                      or
28
42
   make -n install PREFIX=/xxx/yyy      respectively.
29
 
The -n instructs make to show the commands it would execute, but
30
 
not actually execute them.
 
43
 
 
44
The -n instructs make to show the commands it would execute, but not
 
45
actually execute them.
31
46
 
32
47
 
33
48
HOW TO BUILD -- UNIX, shared library libbz2.so.
34
49
 
35
50
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
 
51
Linux-ELF (RedHat 7.2 on an x86 box), with gcc.  I make no claims
37
52
that it works for any other platform, though I suspect it probably
38
53
will work for most platforms employing both ELF and gcc.
39
54
 
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.
 
55
bzip2-shared, a client of the shared library, is also built, but not
 
56
self-tested.  So I suggest you also build using the normal Makefile,
 
57
since that conducts a self-test.  A second reason to prefer the
 
58
version statically linked to the library is that, on x86 platforms,
 
59
building shared objects makes a valuable register (%ebx) unavailable
 
60
to gcc, resulting in a slowdown of 10%-20%, at least for bzip2.
43
61
 
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.
 
62
Important note for people upgrading .so's from 0.9.0/0.9.5 to version
 
63
1.0.X.  All the functions in the library have been renamed, from (eg)
 
64
bzCompress to BZ2_bzCompress, to avoid namespace pollution.
47
65
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.
 
66
Makefile-libbz2_so will not work with any program which used an older
 
67
version of the library.  I do encourage library clients to make the
 
68
effort to upgrade to use version 1.0, since it is both faster and more
 
69
robust than previous versions.
52
70
 
53
71
 
54
72
HOW TO BUILD -- Windows 95, NT, DOS, Mac, etc.
55
73
 
56
74
It's difficult for me to support compilation on all these platforms.
57
75
My approach is to collect binaries for these platforms, and put them
58
 
on the master web page (http://sourceware.cygnus.com/bzip2).  Look
59
 
there.  However (FWIW), bzip2-1.0 is very standard ANSI C and should
60
 
compile unmodified with MS Visual C.  For Win32, there is one
61
 
important caveat: in bzip2.c, you must set BZ_UNIX to 0 and
62
 
BZ_LCCWIN32 to 1 before building.  If you have difficulties building,
63
 
you might want to read README.COMPILATION.PROBLEMS.
 
76
on the master web site (http://www.bzip.org).  Look there.  However
 
77
(FWIW), bzip2-1.0.X is very standard ANSI C and should compile
 
78
unmodified with MS Visual C.  If you have difficulties building, you
 
79
might want to read README.COMPILATION.PROBLEMS.
 
80
 
 
81
At least using MS Visual C++ 6, you can build from the unmodified
 
82
sources by issuing, in a command shell: 
 
83
 
 
84
   nmake -f makefile.msc
 
85
 
 
86
(you may need to first run the MSVC-provided script VCVARS32.BAT
 
87
 so as to set up paths to the MSVC tools correctly).
64
88
 
65
89
 
66
90
VALIDATION
71
95
Nelson's churn program.  Churn is an automated test driver which
72
96
recursively traverses a directory structure, using bzip2 to compress
73
97
and then decompress each file it encounters, and checking that the
74
 
decompressed data is the same as the original.  There are more details
75
 
in Section 4 of the user guide.
 
98
decompressed data is the same as the original.
76
99
 
77
100
 
78
101
 
80
103
 
81
104
WARNING:
82
105
 
83
 
   This program (attempts to) compress data by performing several
84
 
   non-trivial transformations on it.  Unless you are 100% familiar
85
 
   with *all* the algorithms contained herein, and with the
86
 
   consequences of modifying them, you should NOT meddle with the
87
 
   compression or decompression machinery.  Incorrect changes can and
88
 
   very likely *will* lead to disastrous loss of data.
 
106
   This program and library (attempts to) compress data by 
 
107
   performing several non-trivial transformations on it.  
 
108
   Unless you are 100% familiar with *all* the algorithms 
 
109
   contained herein, and with the consequences of modifying them, 
 
110
   you should NOT meddle with the compression or decompression 
 
111
   machinery.  Incorrect changes can and very likely *will* 
 
112
   lead to disastrous loss of data.
89
113
 
90
114
 
91
115
DISCLAIMER:
92
116
 
93
117
   I TAKE NO RESPONSIBILITY FOR ANY LOSS OF DATA ARISING FROM THE
94
 
   USE OF THIS PROGRAM, HOWSOEVER CAUSED.
 
118
   USE OF THIS PROGRAM/LIBRARY, HOWSOEVER CAUSED.
95
119
 
96
120
   Every compression of a file implies an assumption that the
97
121
   compressed file can be decompressed to reproduce the original.
104
128
   PROGRAM UNLESS YOU ARE PREPARED TO ACCEPT THE POSSIBILITY, HOWEVER
105
129
   SMALL, THAT THE DATA WILL NOT BE RECOVERABLE.
106
130
 
107
 
   That is not to say this program is inherently unreliable.  Indeed,
108
 
   I very much hope the opposite is true.  bzip2 has been carefully
109
 
   constructed and extensively tested.
 
131
   That is not to say this program is inherently unreliable.  
 
132
   Indeed, I very much hope the opposite is true.  bzip2/libbzip2 
 
133
   has been carefully constructed and extensively tested.
110
134
 
111
135
 
112
136
PATENTS:
113
137
 
114
 
   To the best of my knowledge, bzip2 does not use any patented
115
 
   algorithms.  However, I do not have the resources available to
116
 
   carry out a full patent search.  Therefore I cannot give any
 
138
   To the best of my knowledge, bzip2/libbzip2 does not use any 
 
139
   patented algorithms.  However, I do not have the resources 
 
140
   to carry out a patent search.  Therefore I cannot give any 
117
141
   guarantee of the above statement.
118
142
 
119
 
End of legalities.
120
143
 
121
144
 
122
145
WHAT'S NEW IN 0.9.0 (as compared to 0.1pl2) ?
138
161
   * Many small improvements in file and flag handling.
139
162
   * A Y2K statement.
140
163
 
141
 
WHAT'S NEW IN 1.0
142
 
 
143
 
   See the CHANGES file.
 
164
WHAT'S NEW IN 1.0.0 ?
 
165
 
 
166
   See the CHANGES file.
 
167
 
 
168
WHAT'S NEW IN 1.0.2 ?
 
169
 
 
170
   See the CHANGES file.
 
171
 
 
172
WHAT'S NEW IN 1.0.3 ?
 
173
 
 
174
   See the CHANGES file.
 
175
 
 
176
WHAT'S NEW IN 1.0.4 ?
 
177
 
 
178
   See the CHANGES file.
 
179
 
 
180
WHAT'S NEW IN 1.0.5 ?
 
181
 
 
182
   See the CHANGES file.
 
183
 
144
184
 
145
185
I hope you find bzip2 useful.  Feel free to contact me at
146
 
   jseward@acm.org
 
186
   jseward@bzip.org
147
187
if you have any suggestions or queries.  Many people mailed me with
148
188
comments, suggestions and patches after the releases of bzip-0.15,
149
 
bzip-0.21, bzip2-0.1pl2 and bzip2-0.9.0, and the changes in bzip2 are
150
 
largely a result of this feedback.  I thank you for your comments.
 
189
bzip-0.21, and bzip2 versions 0.1pl2, 0.9.0, 0.9.5, 1.0.0, 1.0.1,
 
190
1.0.2 and 1.0.3, and the changes in bzip2 are largely a result of this
 
191
feedback.  I thank you for your comments.
151
192
 
152
 
At least for the time being, bzip2's "home" is (or can be reached via)
153
 
http://www.muraroa.demon.co.uk.
 
193
bzip2's "home" is http://www.bzip.org/
154
194
 
155
195
Julian Seward
156
 
jseward@acm.org
 
196
jseward@bzip.org
 
197
Cambridge, UK.
157
198
 
158
 
Cambridge, UK
159
 
18   July 1996 (version 0.15)
160
 
25 August 1996 (version 0.21)
161
 
 7 August 1997 (bzip2, version 0.1)
162
 
29 August 1997 (bzip2, version 0.1pl2)
163
 
23 August 1998 (bzip2, version 0.9.0)
164
 
 8   June 1999 (bzip2, version 0.9.5)
165
 
 4   Sept 1999 (bzip2, version 0.9.5d)
166
 
 5    May 2000 (bzip2, version 1.0pre8)
 
199
18     July 1996 (version 0.15)
 
200
25   August 1996 (version 0.21)
 
201
 7   August 1997 (bzip2, version 0.1)
 
202
29   August 1997 (bzip2, version 0.1pl2)
 
203
23   August 1998 (bzip2, version 0.9.0)
 
204
 8     June 1999 (bzip2, version 0.9.5)
 
205
 4     Sept 1999 (bzip2, version 0.9.5d)
 
206
 5      May 2000 (bzip2, version 1.0pre8)
 
207
30 December 2001 (bzip2, version 1.0.2pre1)
 
208
15 February 2005 (bzip2, version 1.0.3)
 
209
20 December 2006 (bzip2, version 1.0.4)
 
210
10 December 2007 (bzip2, version 1.0.5)