source: final-system/common/bzip2.xml @ 2659c74

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

r677@server (orig r675): manuel | 2005-11-10 03:13:57 -0800
Including patches.ent from general.ent

  • 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    <segmentedlist>
26      <segtitle>&dependencies;</segtitle>
27
28      <seglistitem>
29        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, and Make</seg>
30      </seglistitem>
31    </segmentedlist>
32
33  </sect2>
34
35  <sect2 role="installation">
36    <title>Installation of Bzip2</title>
37
38    <para os="j">Apply a patch to install the documentation for this
39    package:</para>
40
41<screen os="k"><userinput>patch -Np1 -i ../&bzip2-docs-patch;</userinput></screen>
42
43    <para os="l">The <command>bzgrep</command> command does not escape '|' and
44    '&amp;' in filenames passed to it. This allows arbitrary commands to be
45    executed with the privileges of the user running <command>bzgrep</command>.
46    Apply the following patch to address this:</para>
47
48<screen os="m"><userinput>patch -Np1 -i ../&bzip2-bzgrep-patch;</userinput></screen>
49
50    <para os="a">The Bzip2 package does not contain a <command>configure</command>
51    script. Compile it with:</para>
52
53<screen><userinput>make -f Makefile-libbz2_so
54make clean</userinput></screen>
55
56    <para os="b">The <parameter>-f</parameter> flag will cause Bzip2 to be built
57    using a different <filename>Makefile</filename> file, in this case the
58    <filename>Makefile-libbz2_so</filename> file, which creates a dynamic
59    <filename class="libraryfile">libbz2.so</filename> library and links the
60    Bzip2 utilities against it.</para>
61
62    <para os="c">Compile the package:</para>
63
64<screen><userinput>make</userinput></screen>
65
66    <para os="d">To test the results, issue:
67    <userinput>make test</userinput>.</para>
68
69    <para os="e">If reinstalling Bzip2, perform
70    <userinput>rm -f /usr/bin/bz*</userinput> first, otherwise the
71    following <command>make install</command> will fail.</para>
72
73    <para os="f">Install the programs:</para>
74
75<screen os="g"><userinput>make install</userinput></screen>
76
77    <para os="h">Install the shared <command>bzip2</command> binary into the
78    <filename class="directory">/bin</filename> directory, make
79    some necessary symbolic links, and clean up:</para>
80
81<screen os="i"><userinput>cp bzip2-shared /bin/bzip2
82cp -a libbz2.so* /lib
83ln -s ../../lib/libbz2.so.1.0 /usr/lib/libbz2.so
84rm /usr/bin/{bunzip2,bzcat,bzip2}
85ln -s bzip2 /bin/bunzip2
86ln -s bzip2 /bin/bzcat</userinput></screen>
87
88  </sect2>
89
90  <sect2 id="contents-bzip2" role="content">
91    <title>Contents of Bzip2</title>
92
93    <segmentedlist>
94      <segtitle>Installed programs</segtitle>
95      <segtitle>Installed libraries</segtitle>
96
97      <seglistitem>
98        <seg>bunzip2 (link to bzip2), bzcat (link to bzip2), bzcmp, bzdiff,
99        bzegrep, bzfgrep, bzgrep, bzip2, bzip2recover, bzless, and bzmore</seg>
100        <seg>libbz2.a, libbz2.so (link to libbz2.so.1.0), libbz2.so.1.0 (link to
101        libbz2.so.&bzip2-version;), and libbz2.so.&bzip2-version;</seg>
102      </seglistitem>
103    </segmentedlist>
104
105    <variablelist>
106      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
107      <?dbfo list-presentation="list"?>
108      <?dbhtml list-presentation="table"?>
109
110      <varlistentry id="bunzip2">
111        <term><command>bunzip2</command></term>
112        <listitem>
113          <para>Decompresses bzipped files</para>
114          <indexterm zone="ch-system-bzip2 bunzip2">
115            <primary sortas="b-bunzip2">bunzip2</primary>
116          </indexterm>
117        </listitem>
118      </varlistentry>
119
120      <varlistentry id="bzcat">
121        <term><command>bzcat</command></term>
122        <listitem>
123          <para>Decompresses to standard output</para>
124          <indexterm zone="ch-system-bzip2 bzcat">
125            <primary sortas="b-bzcat">bzcat</primary>
126          </indexterm>
127        </listitem>
128      </varlistentry>
129
130      <varlistentry id="bzcmp">
131        <term><command>bzcmp</command></term>
132        <listitem>
133          <para>Runs <command>cmp</command> on bzipped files</para>
134          <indexterm zone="ch-system-bzip2 bzcmp">
135            <primary sortas="b-bzcmp">bzcmp</primary>
136          </indexterm>
137        </listitem>
138      </varlistentry>
139
140      <varlistentry id="bzdiff">
141        <term><command>bzdiff</command></term>
142        <listitem>
143          <para>Runs <command>diff</command> on bzipped files</para>
144          <indexterm zone="ch-system-bzip2 bzdiff">
145            <primary sortas="b-bzdiff">bzdiff</primary>
146          </indexterm>
147        </listitem>
148      </varlistentry>
149
150      <varlistentry id="bzgrep">
151        <term><command>bzgrep</command></term>
152        <listitem>
153          <para>Runs <command>grep</command> on bzipped files</para>
154          <indexterm zone="ch-system-bzip2 bzgrep">
155            <primary sortas="b-bzgrep">bzgrep</primary>
156          </indexterm>
157        </listitem>
158      </varlistentry>
159
160      <varlistentry id="bzegrep">
161        <term><command>bzegrep</command></term>
162        <listitem>
163          <para>Runs <command>egrep</command> on bzipped files</para>
164          <indexterm zone="ch-system-bzip2 bzegrep">
165            <primary sortas="b-bzegrep">bzegrep</primary>
166          </indexterm>
167        </listitem>
168      </varlistentry>
169
170      <varlistentry id="bzfgrep">
171        <term><command>bzfgrep</command></term>
172        <listitem>
173          <para>Runs <command>fgrep</command> on bzipped files</para>
174          <indexterm zone="ch-system-bzip2 bzfgrep">
175            <primary sortas="b-bzfgrep">bzfgrep</primary>
176          </indexterm>
177        </listitem>
178      </varlistentry>
179
180      <varlistentry id="bzip2">
181        <term><command>bzip2</command></term>
182        <listitem>
183          <para>Compresses files using the Burrows-Wheeler block sorting text
184          compression algorithm with Huffman coding; the compression rate is
185          better than that achieved by more conventional compressors using
186          <quote>Lempel-Ziv</quote> algorithms, like <command>gzip</command></para>
187          <indexterm zone="ch-system-bzip2 bzip2">
188            <primary sortas="b-bzip2">bzip2</primary>
189          </indexterm>
190        </listitem>
191      </varlistentry>
192
193      <varlistentry id="bzip2recover">
194        <term><command>bzip2recover</command></term>
195        <listitem>
196          <para>Tries to recover data from damaged bzipped files</para>
197          <indexterm zone="ch-system-bzip2 bzip2recover">
198            <primary sortas="b-bzip2recover">bzip2recover</primary>
199          </indexterm>
200        </listitem>
201      </varlistentry>
202
203      <varlistentry id="bzless">
204        <term><command>bzless</command></term>
205        <listitem>
206          <para>Runs <command>less</command> on bzipped files</para>
207          <indexterm zone="ch-system-bzip2 bzless">
208            <primary sortas="b-bzless">bzless</primary>
209          </indexterm>
210        </listitem>
211      </varlistentry>
212
213      <varlistentry id="bzmore">
214        <term><command>bzmore</command></term>
215        <listitem>
216          <para>Runs <command>more</command> on bzipped files</para>
217          <indexterm zone="ch-system-bzip2 bzmore">
218            <primary sortas="b-bzmore">bzmore</primary>
219          </indexterm>
220        </listitem>
221      </varlistentry>
222
223      <varlistentry id="libbz2">
224        <term><filename class="libraryfile">libbz2*</filename></term>
225        <listitem>
226          <para>The library implementing lossless, block-sorting data
227          compression, using the Burrows-Wheeler algorithm</para>
228          <indexterm zone="ch-system-bzip2 libbz2">
229            <primary sortas="c-libbz2*">libbz2*</primary>
230          </indexterm>
231        </listitem>
232      </varlistentry>
233
234    </variablelist>
235
236  </sect2>
237
238</sect1>
Note: See TracBrowser for help on using the repository browser.