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