chapter06/xz.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-xz" role="wrap">
   9   <?dbhtml filename="xz.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>xz</productname>
  13     <productnumber>&xz-version;</productnumber>
  14     <address>&xz-url;</address>
  15   </sect1info>
  16
  17   <title>Xz-&xz-version;</title>
  18
  19   <indexterm zone="ch-system-xz">
  20     <primary sortas="a-xz">Xz</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Xz package contains programs for compressing and decompressing
  27     files. It provides capabilities for the lzma and the newer xz compression
  28     formats.  Compressing text files with <command>xz</command> yields a better
  29     compression percentage than with the traditional <command>gzip</command> or
  30     <command>bzip2</command> commands.</para>
  31
  32     <segmentedlist>
  33       <segtitle>&buildtime;</segtitle>
  34       <segtitle>&diskspace;</segtitle>
  35
  36       <seglistitem>
  37         <seg>&xz-ch6-sbu;</seg>
  38         <seg>&xz-ch6-du;</seg>
  39       </seglistitem>
  40     </segmentedlist>
  41
  42   </sect2>
  43
  44   <sect2 role="installation">
  45     <title>Installation of Xz</title>
  46
  47     <para>First, fix an internal problem:</para>
  48
  49 <screen><userinput remap="pre">sed -e '/mf\.buffer = NULL/a next->coder->mf.size = 0;' \
  50      -i src/liblzma/lz/lz_encoder.c</userinput></screen>
  51
  52
  53
  54     <para>Prepare Xz for compilation with:</para>
  55
  56 <screen><userinput remap="configure">./configure --prefix=/usr    \
  57             --disable-static \
  58             --docdir=/usr/share/doc/xz-&xz-version;</userinput></screen>
  59
  60     <para>Compile the package:</para>
  61
  62 <screen><userinput remap="make">make</userinput></screen>
  63
  64     <para>To test the results, issue:</para>
  65
  66 <screen><userinput remap="test">make check</userinput></screen>
  67
  68   <para>Install the package and make sure that all essential files are in the
  69   correct directory:</para>
  70
  71 <screen><userinput remap="install">make install
  72 mv -v   /usr/bin/{lzma,unlzma,lzcat,xz,unxz,xzcat} /bin
  73 mv -v /usr/lib/liblzma.so.* /lib
  74 ln -svf ../../lib/$(readlink /usr/lib/liblzma.so) /usr/lib/liblzma.so</userinput></screen>
  75
  76   </sect2>
  77
  78   <sect2 id="contents-xz" role="content">
  79     <title>Contents of Xz</title>
  80
  81     <segmentedlist>
  82       <segtitle>Installed programs</segtitle>
  83       <segtitle>Installed libraries</segtitle>
  84       <segtitle>Installed directories</segtitle>
  85
  86       <seglistitem>
  87         <seg>
  88           lzcat (link to xz),
  89           lzcmp (link to xzdiff),
  90           lzdiff (link to xzdiff),
  91           lzegrep (link to xzgrep),
  92           lzfgrep (link to xzgrep),
  93           lzgrep (link to xzgrep),
  94           lzless (link to xzless),
  95           lzma (link to xz),
  96           lzmadec,
  97           lzmainfo,
  98           lzmore (link to xzmore),
  99           unlzma (link to xz),
 100           unxz (link to xz),
 101           xz,
 102           xzcat (link to xz),
 103           xzcmp (link to xzdiff),
 104           xzdec,
 105           xzdiff,
 106           xzegrep (link to xzgrep),
 107           xzfgrep (link to xzgrep),
 108           xzgrep,
 109           xzless, and
 110           xzmore</seg>
 111         <seg>
 112           liblzma.so
 113         </seg>
 114         <seg>
 115           /usr/include/lzma and
 116           /usr/share/doc/xz-&xz-version;
 117          </seg>
 118       </seglistitem>
 119     </segmentedlist>
 120
 121     <variablelist>
 122       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 123       <?dbfo list-presentation="list"?>
 124       <?dbhtml list-presentation="table"?>
 125
 126       <varlistentry id="lzcat">
 127         <term><command>lzcat</command></term>
 128         <listitem>
 129           <para>Decompresses to standard output</para>
 130           <indexterm zone="ch-system-xz lzcat">
 131             <primary sortas="b-lzcat">lzcat</primary>
 132           </indexterm>
 133         </listitem>
 134       </varlistentry>
 135
 136       <varlistentry id="lzcmp">
 137         <term><command>lzcmp</command></term>
 138         <listitem>
 139           <para>Runs <command>cmp</command> on LZMA compressed files</para>
 140           <indexterm zone="ch-system-xz lzcmp">
 141             <primary sortas="b-lzcmp">lzcmp</primary>
 142           </indexterm>
 143         </listitem>
 144       </varlistentry>
 145
 146       <varlistentry id="lzdiff">
 147         <term><command>lzdiff</command></term>
 148         <listitem>
 149           <para>Runs <command>diff</command> on LZMA compressed files</para>
 150           <indexterm zone="ch-system-xz lzdiff">
 151             <primary sortas="b-lzdiff">lzdiff</primary>
 152           </indexterm>
 153         </listitem>
 154       </varlistentry>
 155
 156       <varlistentry id="lzegrep">
 157         <term><command>lzegrep</command></term>
 158         <listitem>
 159           <para>Runs <command>egrep</command> on LZMA compressed files</para>
 160           <indexterm zone="ch-system-xz lzegrep">
 161             <primary sortas="b-lzegrep">lzegrep</primary>
 162           </indexterm>
 163         </listitem>
 164       </varlistentry>
 165
 166       <varlistentry id="lzfgrep">
 167         <term><command>lzfgrep</command></term>
 168         <listitem>
 169           <para>Runs <command>fgrep</command> on LZMA compressed files</para>
 170           <indexterm zone="ch-system-xz lzfgrep">
 171             <primary sortas="b-lzfgrep">lzfgrep</primary>
 172           </indexterm>
 173         </listitem>
 174       </varlistentry>
 175
 176       <varlistentry id="lzgrep">
 177         <term><command>lzgrep</command></term>
 178         <listitem>
 179           <para>Runs <command>grep</command> on LZMA compressed files</para>
 180           <indexterm zone="ch-system-xz lzgrep">
 181             <primary sortas="b-lzgrep">lzgrep</primary>
 182           </indexterm>
 183         </listitem>
 184       </varlistentry>
 185
 186       <varlistentry id="lzless">
 187         <term><command>lzless</command></term>
 188         <listitem>
 189           <para>Runs <command>less</command> on LZMA compressed files</para>
 190           <indexterm zone="ch-system-xz lzless">
 191             <primary sortas="b-lzless">lzless</primary>
 192           </indexterm>
 193         </listitem>
 194       </varlistentry>
 195
 196       <varlistentry id="lzma">
 197         <term><command>lzma</command></term>
 198         <listitem>
 199           <para>Compresses or decompresses files using the LZMA format</para>
 200           <indexterm zone="ch-system-xz lzma">
 201             <primary sortas="b-lzma">lzma</primary>
 202           </indexterm>
 203         </listitem>
 204       </varlistentry>
 205
 206       <varlistentry id="lzmadec">
 207         <term><command>lzmadec</command></term>
 208         <listitem>
 209           <para>A small and fast decoder for LZMA compressed files</para>
 210           <indexterm zone="ch-system-xz lzmadec">
 211             <primary sortas="b-lzmadec">lzmadec</primary>
 212           </indexterm>
 213         </listitem>
 214       </varlistentry>
 215
 216       <varlistentry id="lzmainfo">
 217         <term><command>lzmainfo</command></term>
 218         <listitem>
 219           <para>Shows information stored in the LZMA compressed file header</para>
 220           <indexterm zone="ch-system-xz lzmainfo">
 221             <primary sortas="b-lzmainfo">lzmainfo</primary>
 222           </indexterm>
 223         </listitem>
 224       </varlistentry>
 225
 226       <varlistentry id="lzmore">
 227         <term><command>lzmore</command></term>
 228         <listitem>
 229           <para>Runs <command>more</command> on LZMA compressed files</para>
 230           <indexterm zone="ch-system-xz lzmore">
 231             <primary sortas="b-lzmamore">lzmore</primary>
 232           </indexterm>
 233         </listitem>
 234       </varlistentry>
 235
 236       <varlistentry id="unlzma">
 237         <term><command>unlzma</command></term>
 238         <listitem>
 239           <para>Decompresses files using the LZMA format</para>
 240           <indexterm zone="ch-system-xz unlzma">
 241             <primary sortas="b-unlzma">unlzma</primary>
 242           </indexterm>
 243         </listitem>
 244       </varlistentry>
 245
 246       <varlistentry id="unxz">
 247         <term><command>unxz</command></term>
 248         <listitem>
 249           <para>Decompresses files using the XZ format</para>
 250           <indexterm zone="ch-system-xz unxz">
 251             <primary sortas="b-unxz">unxz</primary>
 252           </indexterm>
 253         </listitem>
 254       </varlistentry>
 255
 256       <varlistentry id="xz">
 257         <term><command>xz</command></term>
 258         <listitem>
 259           <para>Compresses or decompresses files using the XZ format</para>
 260           <indexterm zone="ch-system-xz xz">
 261             <primary sortas="b-xz">xz</primary>
 262           </indexterm>
 263         </listitem>
 264       </varlistentry>
 265
 266       <varlistentry id="xzcat">
 267         <term><command>xzcat</command></term>
 268         <listitem>
 269           <para>Decompresses to standard output</para>
 270           <indexterm zone="ch-system-xz xzcat">
 271             <primary sortas="b-xzcat">xzcat</primary>
 272           </indexterm>
 273         </listitem>
 274       </varlistentry>
 275
 276       <varlistentry id="xzcmp">
 277         <term><command>xzcmp</command></term>
 278         <listitem>
 279           <para>Runs <command>cmp</command> on XZ compressed files</para>
 280           <indexterm zone="ch-system-xz xzcmp">
 281             <primary sortas="b-xzcmp">xzcmp</primary>
 282           </indexterm>
 283         </listitem>
 284       </varlistentry>
 285
 286       <varlistentry id="xzdec">
 287         <term><command>xzdec</command></term>
 288         <listitem>
 289           <para>A small and fast decoder for XZ compressed files</para>
 290           <indexterm zone="ch-system-xz xzdec">
 291             <primary sortas="b-xzdec">xzdec</primary>
 292           </indexterm>
 293         </listitem>
 294       </varlistentry>
 295
 296       <varlistentry id="xzdiff">
 297         <term><command>xzdiff</command></term>
 298         <listitem>
 299           <para>Runs <command>diff</command> on XZ compressed files</para>
 300           <indexterm zone="ch-system-xz xzdiff">
 301             <primary sortas="b-xzdiff">xzdiff</primary>
 302           </indexterm>
 303         </listitem>
 304       </varlistentry>
 305
 306       <varlistentry id="xzegrep">
 307         <term><command>xzegrep</command></term>
 308         <listitem>
 309           <para>Runs <command>egrep</command> on XZ compressed files files</para>
 310           <indexterm zone="ch-system-xz xzegrep">
 311             <primary sortas="b-xzegrep">xzegrep</primary>
 312           </indexterm>
 313         </listitem>
 314       </varlistentry>
 315
 316       <varlistentry id="xzfgrep">
 317         <term><command>xzfgrep</command></term>
 318         <listitem>
 319           <para>Runs <command>fgrep</command> on XZ compressed files</para>
 320           <indexterm zone="ch-system-xz xzfgrep">
 321             <primary sortas="b-xzfgrep">xzfgrep</primary>
 322           </indexterm>
 323         </listitem>
 324       </varlistentry>
 325
 326       <varlistentry id="xzgrep">
 327         <term><command>xzgrep</command></term>
 328         <listitem>
 329           <para>Runs <command>grep</command> on XZ compressed files</para>
 330           <indexterm zone="ch-system-xz xzgrep">
 331             <primary sortas="b-xzgrep">xzgrep</primary>
 332           </indexterm>
 333         </listitem>
 334       </varlistentry>
 335
 336       <varlistentry id="xzless">
 337         <term><command>xzless</command></term>
 338         <listitem>
 339           <para>Runs <command>less</command> on XZ compressed files</para>
 340           <indexterm zone="ch-system-xz xzless">
 341             <primary sortas="b-xzless">xzless</primary>
 342           </indexterm>
 343         </listitem>
 344       </varlistentry>
 345
 346       <varlistentry id="xzmore">
 347         <term><command>xzmore</command></term>
 348         <listitem>
 349           <para>Runs <command>more</command> on XZ compressed files</para>
 350           <indexterm zone="ch-system-xz xzmore">
 351             <primary sortas="b-xzmore">xzmore</primary>
 352           </indexterm>
 353         </listitem>
 354       </varlistentry>
 355
 356       <varlistentry id="liblzma">
 357         <term><filename class="libraryfile">liblzma</filename></term>
 358         <listitem>
 359           <para>The library implementing lossless, block-sorting data
 360           compression, using the Lempel-Ziv-Markov chain algorithm</para>
 361           <indexterm zone="ch-system-xz liblzma">
 362             <primary sortas="c-liblzma">liblzma</primary>
 363           </indexterm>
 364         </listitem>
 365       </varlistentry>
 366
 367     </variablelist>
 368
 369   </sect2>
 370
 371 </sect1>