source: final-system/common/bzip2.xml @ 8444553

Last change on this file since 8444553 was 8444553, checked in by Jim Gifford <clfs@…>, 16 years ago

r3583@server: jim | 2006-05-22 01:16:46 -0700
Updates to Bzip2 text and build for multilib

  • Property mode set to 100644
File size: 8.1 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4  <!ENTITY % general-entities SYSTEM "../../general.ent">
5  %general-entities;
6]>
7
8<sect1 id="ch-system-bzip2" role="wrap">
9  <?dbhtml filename="bzip2.html"?>
10
11  <title>Bzip2-&bzip2-version;</title>
12
13  <indexterm zone="ch-system-bzip2">
14    <primary sortas="a-Bzip2">Bzip2</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The Bzip2 package contains programs for compressing and
21    decompressing files. Compressing text files with <command>bzip2</command>
22    yields a much better compression percentage than with the traditional
23    <command>gzip</command>.</para>
24
25  </sect2>
26
27  <sect2 role="installation">
28    <title>Installation of Bzip2</title>
29
30    <para os="p1">Apply a patch to install the documentation for this
31    package:</para>
32
33<screen os="p2"><userinput>patch -Np1 -i ../&bzip2-docs-patch;</userinput></screen>
34
35    <para os="p3">The <command>bzgrep</command> command does not escape '|' and
36    '&amp;' in filenames passed to it. This allows arbitrary commands to be
37    executed with the privileges of the user running <command>bzgrep</command>.
38    Apply the following patch to address this:</para>
39
40<screen os="p4"><userinput>patch -Np1 -i ../&bzip2-bzgrep-patch;</userinput></screen>
41
42    <para os="p5">The <command>bzdiff</command> script depends on tempfile.
43    We remove that dependency with this patch:</para>
44
45<screen os="p6"><userinput>patch -Np1 -i ../&bzip2-remove_tempfile-patch;</userinput></screen>
46
47    <para os="a">The Bzip2 package does not contain a <command>configure</command>
48    script. Compile it with:</para>
49
50<screen os="b"><userinput>make -f Makefile-libbz2_so
51make clean</userinput></screen>
52
53    <para os="c">The <parameter>-f</parameter> flag will cause Bzip2 to be built
54    using a different <filename>Makefile</filename> file, in this case the
55    <filename>Makefile-libbz2_so</filename> file, which creates a dynamic
56    <filename class="libraryfile">libbz2.so</filename> library and links the
57    Bzip2 utilities against it.</para>
58
59    <para os="d">Recompile the package using a non-shared library and test it.</para>
60
61<screen os="e"><userinput>make</userinput></screen>
62
63    <note os="f">
64    <para>If reinstalling Bzip2, perform
65    <userinput>rm -vf /usr/bin/bz*</userinput> first, otherwise the
66    following <command>make install</command> will fail.</para>
67    </note>
68
69    <para os="g">Install the programs:</para>
70
71<screen os="h"><userinput>make install</userinput></screen>
72
73    <para os="i">Install the shared <command>bzip2</command> binary into the
74    <filename class="directory">/bin</filename> directory, make
75    some necessary symbolic links, and clean up:</para>
76
77<screen os="j"><userinput>cp -v bzip2-shared /bin/bzip2
78cp -av libbz2.so* /lib
79ln -sv ../../lib/libbz2.so.1.0 /usr/lib/libbz2.so
80rm -v /usr/bin/{bunzip2,bzcat,bzip2}
81ln -sv bzip2 /bin/bunzip2
82ln -sv bzip2 /bin/bzcat</userinput></screen>
83
84  </sect2>
85
86  <sect2 id="contents-bzip2" role="content">
87    <title>Contents of Bzip2</title>
88
89    <segmentedlist>
90      <segtitle>Installed programs</segtitle>
91      <segtitle>Installed libraries</segtitle>
92
93      <seglistitem>
94        <seg>bunzip2 (link to bzip2), bzcat (link to bzip2), bzcmp, bzdiff,
95        bzegrep, bzfgrep, bzgrep, bzip2, bzip2recover, bzless, and bzmore</seg>
96        <seg>libbz2.a, libbz2.so (link to libbz2.so.1.0), libbz2.so.1.0 (link to
97        libbz2.so.&bzip2-version;), and libbz2.so.&bzip2-version;</seg>
98      </seglistitem>
99    </segmentedlist>
100
101    <variablelist>
102      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
103      <?dbfo list-presentation="list"?>
104      <?dbhtml list-presentation="table"?>
105
106      <varlistentry id="bunzip2">
107        <term><command>bunzip2</command></term>
108        <listitem>
109          <para>Decompresses bzipped files</para>
110          <indexterm zone="ch-system-bzip2 bunzip2">
111            <primary sortas="b-bunzip2">bunzip2</primary>
112          </indexterm>
113        </listitem>
114      </varlistentry>
115
116      <varlistentry id="bzcat">
117        <term><command>bzcat</command></term>
118        <listitem>
119          <para>Decompresses to standard output</para>
120          <indexterm zone="ch-system-bzip2 bzcat">
121            <primary sortas="b-bzcat">bzcat</primary>
122          </indexterm>
123        </listitem>
124      </varlistentry>
125
126      <varlistentry id="bzcmp">
127        <term><command>bzcmp</command></term>
128        <listitem>
129          <para>Runs <command>cmp</command> on bzipped files</para>
130          <indexterm zone="ch-system-bzip2 bzcmp">
131            <primary sortas="b-bzcmp">bzcmp</primary>
132          </indexterm>
133        </listitem>
134      </varlistentry>
135
136      <varlistentry id="bzdiff">
137        <term><command>bzdiff</command></term>
138        <listitem>
139          <para>Runs <command>diff</command> on bzipped files</para>
140          <indexterm zone="ch-system-bzip2 bzdiff">
141            <primary sortas="b-bzdiff">bzdiff</primary>
142          </indexterm>
143        </listitem>
144      </varlistentry>
145
146      <varlistentry id="bzgrep">
147        <term><command>bzgrep</command></term>
148        <listitem>
149          <para>Runs <command>grep</command> on bzipped files</para>
150          <indexterm zone="ch-system-bzip2 bzgrep">
151            <primary sortas="b-bzgrep">bzgrep</primary>
152          </indexterm>
153        </listitem>
154      </varlistentry>
155
156      <varlistentry id="bzegrep">
157        <term><command>bzegrep</command></term>
158        <listitem>
159          <para>Runs <command>egrep</command> on bzipped files</para>
160          <indexterm zone="ch-system-bzip2 bzegrep">
161            <primary sortas="b-bzegrep">bzegrep</primary>
162          </indexterm>
163        </listitem>
164      </varlistentry>
165
166      <varlistentry id="bzfgrep">
167        <term><command>bzfgrep</command></term>
168        <listitem>
169          <para>Runs <command>fgrep</command> on bzipped files</para>
170          <indexterm zone="ch-system-bzip2 bzfgrep">
171            <primary sortas="b-bzfgrep">bzfgrep</primary>
172          </indexterm>
173        </listitem>
174      </varlistentry>
175
176      <varlistentry id="bzip2">
177        <term><command>bzip2</command></term>
178        <listitem>
179          <para>Compresses files using the Burrows-Wheeler block sorting text
180          compression algorithm with Huffman coding; the compression rate is
181          better than that achieved by more conventional compressors using
182          <quote>Lempel-Ziv</quote> algorithms, like <command>gzip</command></para>
183          <indexterm zone="ch-system-bzip2 bzip2">
184            <primary sortas="b-bzip2">bzip2</primary>
185          </indexterm>
186        </listitem>
187      </varlistentry>
188
189      <varlistentry id="bzip2recover">
190        <term><command>bzip2recover</command></term>
191        <listitem>
192          <para>Tries to recover data from damaged bzipped files</para>
193          <indexterm zone="ch-system-bzip2 bzip2recover">
194            <primary sortas="b-bzip2recover">bzip2recover</primary>
195          </indexterm>
196        </listitem>
197      </varlistentry>
198
199      <varlistentry id="bzless">
200        <term><command>bzless</command></term>
201        <listitem>
202          <para>Runs <command>less</command> on bzipped files</para>
203          <indexterm zone="ch-system-bzip2 bzless">
204            <primary sortas="b-bzless">bzless</primary>
205          </indexterm>
206        </listitem>
207      </varlistentry>
208
209      <varlistentry id="bzmore">
210        <term><command>bzmore</command></term>
211        <listitem>
212          <para>Runs <command>more</command> on bzipped files</para>
213          <indexterm zone="ch-system-bzip2 bzmore">
214            <primary sortas="b-bzmore">bzmore</primary>
215          </indexterm>
216        </listitem>
217      </varlistentry>
218
219      <varlistentry id="libbz2">
220        <term><filename class="libraryfile">libbz2*</filename></term>
221        <listitem>
222          <para>The library implementing lossless, block-sorting data
223          compression, using the Burrows-Wheeler algorithm</para>
224          <indexterm zone="ch-system-bzip2 libbz2">
225            <primary sortas="c-libbz2*">libbz2*</primary>
226          </indexterm>
227        </listitem>
228      </varlistentry>
229
230    </variablelist>
231
232  </sect2>
233
234</sect1>
Note: See TracBrowser for help on using the repository browser.