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

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

r700@server (orig r698): manuel | 2005-11-13 02:06:29 -0800
Omit running Bzip2's testsuite as a separate step.

  • Property mode set to 100644
File size: 8.0 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 and test the package:</para>
63
64<screen><userinput>make</userinput></screen>
65
66    <para os="e">If reinstalling Bzip2, perform
67    <userinput>rm -f /usr/bin/bz*</userinput> first, otherwise the
68    following <command>make install</command> will fail.</para>
69
70    <para os="f">Install the programs:</para>
71
72<screen os="g"><userinput>make install</userinput></screen>
73
74    <para os="h">Install the shared <command>bzip2</command> binary into the
75    <filename class="directory">/bin</filename> directory, make
76    some necessary symbolic links, and clean up:</para>
77
78<screen os="i"><userinput>cp bzip2-shared /bin/bzip2
79cp -a libbz2.so* /lib
80ln -s ../../lib/libbz2.so.1.0 /usr/lib/libbz2.so
81rm /usr/bin/{bunzip2,bzcat,bzip2}
82ln -s bzip2 /bin/bunzip2
83ln -s bzip2 /bin/bzcat</userinput></screen>
84
85  </sect2>
86
87  <sect2 id="contents-bzip2" role="content">
88    <title>Contents of Bzip2</title>
89
90    <segmentedlist>
91      <segtitle>Installed programs</segtitle>
92      <segtitle>Installed libraries</segtitle>
93
94      <seglistitem>
95        <seg>bunzip2 (link to bzip2), bzcat (link to bzip2), bzcmp, bzdiff,
96        bzegrep, bzfgrep, bzgrep, bzip2, bzip2recover, bzless, and bzmore</seg>
97        <seg>libbz2.a, libbz2.so (link to libbz2.so.1.0), libbz2.so.1.0 (link to
98        libbz2.so.&bzip2-version;), and libbz2.so.&bzip2-version;</seg>
99      </seglistitem>
100    </segmentedlist>
101
102    <variablelist>
103      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
104      <?dbfo list-presentation="list"?>
105      <?dbhtml list-presentation="table"?>
106
107      <varlistentry id="bunzip2">
108        <term><command>bunzip2</command></term>
109        <listitem>
110          <para>Decompresses bzipped files</para>
111          <indexterm zone="ch-system-bzip2 bunzip2">
112            <primary sortas="b-bunzip2">bunzip2</primary>
113          </indexterm>
114        </listitem>
115      </varlistentry>
116
117      <varlistentry id="bzcat">
118        <term><command>bzcat</command></term>
119        <listitem>
120          <para>Decompresses to standard output</para>
121          <indexterm zone="ch-system-bzip2 bzcat">
122            <primary sortas="b-bzcat">bzcat</primary>
123          </indexterm>
124        </listitem>
125      </varlistentry>
126
127      <varlistentry id="bzcmp">
128        <term><command>bzcmp</command></term>
129        <listitem>
130          <para>Runs <command>cmp</command> on bzipped files</para>
131          <indexterm zone="ch-system-bzip2 bzcmp">
132            <primary sortas="b-bzcmp">bzcmp</primary>
133          </indexterm>
134        </listitem>
135      </varlistentry>
136
137      <varlistentry id="bzdiff">
138        <term><command>bzdiff</command></term>
139        <listitem>
140          <para>Runs <command>diff</command> on bzipped files</para>
141          <indexterm zone="ch-system-bzip2 bzdiff">
142            <primary sortas="b-bzdiff">bzdiff</primary>
143          </indexterm>
144        </listitem>
145      </varlistentry>
146
147      <varlistentry id="bzgrep">
148        <term><command>bzgrep</command></term>
149        <listitem>
150          <para>Runs <command>grep</command> on bzipped files</para>
151          <indexterm zone="ch-system-bzip2 bzgrep">
152            <primary sortas="b-bzgrep">bzgrep</primary>
153          </indexterm>
154        </listitem>
155      </varlistentry>
156
157      <varlistentry id="bzegrep">
158        <term><command>bzegrep</command></term>
159        <listitem>
160          <para>Runs <command>egrep</command> on bzipped files</para>
161          <indexterm zone="ch-system-bzip2 bzegrep">
162            <primary sortas="b-bzegrep">bzegrep</primary>
163          </indexterm>
164        </listitem>
165      </varlistentry>
166
167      <varlistentry id="bzfgrep">
168        <term><command>bzfgrep</command></term>
169        <listitem>
170          <para>Runs <command>fgrep</command> on bzipped files</para>
171          <indexterm zone="ch-system-bzip2 bzfgrep">
172            <primary sortas="b-bzfgrep">bzfgrep</primary>
173          </indexterm>
174        </listitem>
175      </varlistentry>
176
177      <varlistentry id="bzip2">
178        <term><command>bzip2</command></term>
179        <listitem>
180          <para>Compresses files using the Burrows-Wheeler block sorting text
181          compression algorithm with Huffman coding; the compression rate is
182          better than that achieved by more conventional compressors using
183          <quote>Lempel-Ziv</quote> algorithms, like <command>gzip</command></para>
184          <indexterm zone="ch-system-bzip2 bzip2">
185            <primary sortas="b-bzip2">bzip2</primary>
186          </indexterm>
187        </listitem>
188      </varlistentry>
189
190      <varlistentry id="bzip2recover">
191        <term><command>bzip2recover</command></term>
192        <listitem>
193          <para>Tries to recover data from damaged bzipped files</para>
194          <indexterm zone="ch-system-bzip2 bzip2recover">
195            <primary sortas="b-bzip2recover">bzip2recover</primary>
196          </indexterm>
197        </listitem>
198      </varlistentry>
199
200      <varlistentry id="bzless">
201        <term><command>bzless</command></term>
202        <listitem>
203          <para>Runs <command>less</command> on bzipped files</para>
204          <indexterm zone="ch-system-bzip2 bzless">
205            <primary sortas="b-bzless">bzless</primary>
206          </indexterm>
207        </listitem>
208      </varlistentry>
209
210      <varlistentry id="bzmore">
211        <term><command>bzmore</command></term>
212        <listitem>
213          <para>Runs <command>more</command> on bzipped files</para>
214          <indexterm zone="ch-system-bzip2 bzmore">
215            <primary sortas="b-bzmore">bzmore</primary>
216          </indexterm>
217        </listitem>
218      </varlistentry>
219
220      <varlistentry id="libbz2">
221        <term><filename class="libraryfile">libbz2*</filename></term>
222        <listitem>
223          <para>The library implementing lossless, block-sorting data
224          compression, using the Burrows-Wheeler algorithm</para>
225          <indexterm zone="ch-system-bzip2 libbz2">
226            <primary sortas="c-libbz2*">libbz2*</primary>
227          </indexterm>
228        </listitem>
229      </varlistentry>
230
231    </variablelist>
232
233  </sect2>
234
235</sect1>
Note: See TracBrowser for help on using the repository browser.