BOOK/chapter08/bzip2.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/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   <sect1info condition="script">
  12     <productname>bzip2</productname>
  13     <productnumber>&bzip2-version;</productnumber>
  14     <address>&bzip2-url;</address>
  15   </sect1info>
  16
  17   <title>Bzip2-&bzip2-version;</title>
  18
  19   <indexterm zone="ch-system-bzip2">
  20     <primary sortas="a-Bzip2">Bzip2</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Bzip2 package contains programs for compressing and decompressing
  27     files. Compressing text files with <command>bzip2</command> yields a much
  28     better compression percentage than with the traditional
  29     <command>gzip</command>.</para>
  30
  31     <segmentedlist>
  32       <segtitle>&buildtime;</segtitle>
  33       <segtitle>&diskspace;</segtitle>
  34
  35       <seglistitem>
  36         <seg>&bzip2-fin-sbu;</seg>
  37         <seg>&bzip2-fin-du;</seg>
  38       </seglistitem>
  39     </segmentedlist>
  40
  41   </sect2>
  42
  43   <sect2 role="installation">
  44     <title>Installation of Bzip2</title>
  45
  46     <para>Apply a patch that will install the documentation for this package:</para>
  47
  48 <screen><userinput remap="pre">patch -Np1 -i ../&bzip2-docs-patch;</userinput></screen>
  49
  50    <para>The following command ensures installation of symbolic links are relative:</para>
  51
  52 <screen><userinput remap="pre">sed -i 's@\(ln -s -f \)$(PREFIX)/bin/@\1@' Makefile</userinput></screen>
  53
  54     <para>Ensure the man pages are installed into the correct location:</para>
  55
  56 <screen><userinput remap="pre">sed -i "s@(PREFIX)/man@(PREFIX)/share/man@g" Makefile</userinput></screen>
  57
  58     <para>Prepare Bzip2 for compilation with:</para>
  59
  60 <screen><userinput remap="make">make -f Makefile-libbz2_so
  61 make clean</userinput></screen>
  62
  63     <variablelist>
  64       <title>The meaning of the make parameter:</title>
  65
  66       <varlistentry>
  67         <term><parameter>-f Makefile-libbz2_so</parameter></term>
  68         <listitem>
  69           <para>This will cause Bzip2 to be built using a different
  70           <filename>Makefile</filename> file, in this case the
  71           <filename>Makefile-libbz2_so</filename> file, which creates a dynamic
  72           <filename class="libraryfile">libbz2.so</filename> library and links
  73           the Bzip2 utilities against it.</para>
  74         </listitem>
  75       </varlistentry>
  76
  77     </variablelist>
  78
  79     <para>Compile and test the package:</para>
  80
  81 <screen><userinput remap="make">make</userinput></screen>
  82
  83     <para>Install the programs:</para>
  84
  85 <screen><userinput remap="install">make PREFIX=/usr install</userinput></screen>
  86
  87     <para>Install the shared <command>bzip2</command> binary into the
  88     <filename class="directory">/bin</filename> directory, make
  89     some necessary symbolic links, and clean up:</para>
  90
  91 <screen><userinput remap="install">cp -v bzip2-shared /bin/bzip2
  92 cp -av libbz2.so* /lib
  93 ln -sv ../../lib/libbz2.so.1.0 /usr/lib/libbz2.so
  94 rm -v /usr/bin/{bunzip2,bzcat,bzip2}
  95 ln -sv bzip2 /bin/bunzip2
  96 ln -sv bzip2 /bin/bzcat</userinput></screen>
  97
  98   </sect2>
  99
 100   <sect2 id="contents-bzip2" role="content">
 101     <title>Contents of Bzip2</title>
 102
 103     <segmentedlist>
 104       <segtitle>Installed programs</segtitle>
 105       <segtitle>Installed libraries</segtitle>
 106       <segtitle>Installed directory</segtitle>
 107
 108       <seglistitem>
 109         <seg>bunzip2 (link to bzip2), bzcat (link to bzip2), bzcmp (link to
 110         bzdiff), bzdiff, bzegrep (link to bzgrep), bzfgrep (link to bzgrep),
 111         bzgrep, bzip2, bzip2recover, bzless (link to bzmore), and bzmore</seg>
 112         <seg>libbz2.{a,so}</seg>
 113         <seg>/usr/share/doc/bzip2-&bzip2-version;</seg>
 114       </seglistitem>
 115     </segmentedlist>
 116
 117     <variablelist>
 118       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 119       <?dbfo list-presentation="list"?>
 120       <?dbhtml list-presentation="table"?>
 121
 122       <varlistentry id="bunzip2">
 123         <term><command>bunzip2</command></term>
 124         <listitem>
 125           <para>Decompresses bzipped files</para>
 126           <indexterm zone="ch-system-bzip2 bunzip2">
 127             <primary sortas="b-bunzip2">bunzip2</primary>
 128           </indexterm>
 129         </listitem>
 130       </varlistentry>
 131
 132       <varlistentry id="bzcat">
 133         <term><command>bzcat</command></term>
 134         <listitem>
 135           <para>Decompresses to standard output</para>
 136           <indexterm zone="ch-system-bzip2 bzcat">
 137             <primary sortas="b-bzcat">bzcat</primary>
 138           </indexterm>
 139         </listitem>
 140       </varlistentry>
 141
 142       <varlistentry id="bzcmp">
 143         <term><command>bzcmp</command></term>
 144         <listitem>
 145           <para>Runs <command>cmp</command> on bzipped files</para>
 146           <indexterm zone="ch-system-bzip2 bzcmp">
 147             <primary sortas="b-bzcmp">bzcmp</primary>
 148           </indexterm>
 149         </listitem>
 150       </varlistentry>
 151
 152       <varlistentry id="bzdiff">
 153         <term><command>bzdiff</command></term>
 154         <listitem>
 155           <para>Runs <command>diff</command> on bzipped files</para>
 156           <indexterm zone="ch-system-bzip2 bzdiff">
 157             <primary sortas="b-bzdiff">bzdiff</primary>
 158           </indexterm>
 159         </listitem>
 160       </varlistentry>
 161
 162       <varlistentry id="bzegrep">
 163         <term><command>bzegrep</command></term>
 164         <listitem>
 165           <para>Runs <command>egrep</command> on bzipped files</para>
 166           <indexterm zone="ch-system-bzip2 bzegrep">
 167             <primary sortas="b-bzegrep">bzegrep</primary>
 168           </indexterm>
 169         </listitem>
 170       </varlistentry>
 171
 172       <varlistentry id="bzfgrep">
 173         <term><command>bzfgrep</command></term>
 174         <listitem>
 175           <para>Runs <command>fgrep</command> on bzipped files</para>
 176           <indexterm zone="ch-system-bzip2 bzfgrep">
 177             <primary sortas="b-bzfgrep">bzfgrep</primary>
 178           </indexterm>
 179         </listitem>
 180       </varlistentry>
 181
 182       <varlistentry id="bzgrep">
 183         <term><command>bzgrep</command></term>
 184         <listitem>
 185           <para>Runs <command>grep</command> on bzipped files</para>
 186           <indexterm zone="ch-system-bzip2 bzgrep">
 187             <primary sortas="b-bzgrep">bzgrep</primary>
 188           </indexterm>
 189         </listitem>
 190       </varlistentry>
 191
 192       <varlistentry id="bzip2">
 193         <term><command>bzip2</command></term>
 194         <listitem>
 195           <para>Compresses files using the Burrows-Wheeler block sorting text
 196           compression algorithm with Huffman coding; the compression rate is
 197           better than that achieved by more conventional compressors using
 198           <quote>Lempel-Ziv</quote> algorithms, like <command>gzip</command></para>
 199           <indexterm zone="ch-system-bzip2 bzip2">
 200             <primary sortas="b-bzip2">bzip2</primary>
 201           </indexterm>
 202         </listitem>
 203       </varlistentry>
 204
 205       <varlistentry id="bzip2recover">
 206         <term><command>bzip2recover</command></term>
 207         <listitem>
 208           <para>Tries to recover data from damaged bzipped files</para>
 209           <indexterm zone="ch-system-bzip2 bzip2recover">
 210             <primary sortas="b-bzip2recover">bzip2recover</primary>
 211           </indexterm>
 212         </listitem>
 213       </varlistentry>
 214
 215       <varlistentry id="bzless">
 216         <term><command>bzless</command></term>
 217         <listitem>
 218           <para>Runs <command>less</command> on bzipped files</para>
 219           <indexterm zone="ch-system-bzip2 bzless">
 220             <primary sortas="b-bzless">bzless</primary>
 221           </indexterm>
 222         </listitem>
 223       </varlistentry>
 224
 225       <varlistentry id="bzmore">
 226         <term><command>bzmore</command></term>
 227         <listitem>
 228           <para>Runs <command>more</command> on bzipped files</para>
 229           <indexterm zone="ch-system-bzip2 bzmore">
 230             <primary sortas="b-bzmore">bzmore</primary>
 231           </indexterm>
 232         </listitem>
 233       </varlistentry>
 234
 235       <varlistentry id="libbz2">
 236         <term><filename class="libraryfile">libbz2</filename></term>
 237         <listitem>
 238           <para>The library implementing lossless, block-sorting data
 239           compression, using the Burrows-Wheeler algorithm</para>
 240           <indexterm zone="ch-system-bzip2 libbz2">
 241             <primary sortas="c-libbz2">libbz2</primary>
 242           </indexterm>
 243         </listitem>
 244       </varlistentry>
 245
 246     </variablelist>
 247
 248   </sect2>
 249
 250 </sect1>