source: BOOK/final-system/common/xz.xml@ ca39770

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;
]>

<sect1 id="ch-system-xz" role="wrap">
  <?dbhtml filename="xz.html"?>

  <title>XZ Utils-&xz-version;</title>

  <indexterm zone="ch-system-xz">
    <primary sortas="a-XZ Utils">XZ Utils</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The XZ Utils package contains programs for compressing and
    decompressing files. Compressing text files with <command>XZ Utils</command>
    yields a much better compression percentage than with the traditional
    <command>gzip</command>.</para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of XZ Utils</title>

    <para os="a">Prepare XZ Utils for compilation:</para>

<screen os="b"><userinput>./configure \
    --prefix=/usr \
    --docdir=/usr/share/doc/xz-&xz-version;</userinput></screen>

    <para os="c">Compile the package:</para>

<screen os="d"><userinput>make</userinput></screen>

    <para os="e">To test the results, issue:</para>

<screen os="e2"><userinput remap="test">make check</userinput></screen>

    <para os="f">Install the programs:</para>

<screen os="g"><userinput>make install</userinput></screen>

    <para os="h">Move the <filename>xz</filename> binary, and several symlinks
    that point to it, into the /bin directory:</para>

<screen os="i"><userinput>mv -v /usr/bin/{xz,lzma,lzcat,unlzma,unxz,xzcat} /bin</userinput></screen>

    <para os="j">Finally, move the shared library to a more appropriate
    location, and recreate the symlink pointing to it:</para>

<screen os="k"><userinput>mv -v /usr/lib/liblzma.so.* /lib
ln -sfv ../../lib/$(readlink /usr/lib/liblzma.so) /usr/lib/liblzma.so</userinput></screen>

  </sect2>

  <sect2 id="contents-xz" role="content">
    <title>Contents of XZ Utils</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>
      <segtitle>Installed libraries</segtitle>
      <segtitle>Installed directories</segtitle>

      <seglistitem>
        <seg>lzcat (link to xz), lzcmp (link to xzdiff), lzdiff (link to
        xzdiff), lzegrep (link to xzgrep), lzfgrep (link to xzgrep), lzgrep
        (link to xzgrep), lzless (link to xzless), lzma (link to xz), lzmadec,
        lzmainfo, lzmore (link to xzmore), unlzma (link to xz), unxz (link to
        xz), xz, xzcat (link to xz), xzcmp (link to xzdiff), xzdec, xzdiff,
        xzegrep (link to xzgrep), xzfgrep (link to xzgrep), xzgrep, xzless,
        xzmore</seg>
        <seg>liblzma.[a,so]</seg>
        <seg>/usr/include/lzma, /usr/share/doc/xz-&xz-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="lzcat">
        <term><command>lzcat</command></term>
        <listitem>
          <para>Decompresses LZMA and xz files</para>
          <indexterm zone="ch-system-xz lzcat">
            <primary sortas="b-lzcat">lzcat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzcmp">
        <term><command>lzcmp</command></term>
        <listitem>
          <para>Compares lzma compressed files</para>
          <indexterm zone="ch-system-xz lzcmp">
            <primary sortas="b-lzcmp">lzcmp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzdiff">
        <term><command>lzdiff</command></term>
        <listitem>
          <para>Compares lzma compressed files</para>
          <indexterm zone="ch-system-xz lzdiff">
            <primary sortas="b-lzdiff">lzdiff</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzegrep">
        <term><command>lzegrep</command></term>
        <listitem>
          <para>Runs <command>egrep</command> on lzma compressed files</para>
          <indexterm zone="ch-system-xz lzegrep">
            <primary sortas="b-lzegrep">lzegrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzfgrep">
        <term><command>lzfgrep</command></term>
        <listitem>
          <para>Runs <command>fgrep</command> on lzma compressed files</para>
          <indexterm zone="ch-system-xz lzfgrep">
            <primary sortas="b-lzfgrep">lzfgrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzgrep">
        <term><command>lzgrep</command></term>
        <listitem>
          <para>Runs <command>grep</command> on lzma compressed files</para>
          <indexterm zone="ch-system-xz lzgrep">
            <primary sortas="b-lzgrep">lzgrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzless">
        <term><command>lzless</command></term>
        <listitem>
          <para>Runs <command>less</command> on lzma files</para>
          <indexterm zone="ch-system-xz lzless">
            <primary sortas="b-lzless">lzless</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzma">
        <term><command>lzma</command></term>
        <listitem>
          <para>Compresses lzma files</para>
          <indexterm zone="ch-system-xz lzma">
            <primary sortas="b-lzma">lzma</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzmadec">
        <term><command>lzmadec</command></term>
        <listitem>
          <para>Decompresses lzma files</para>
          <indexterm zone="ch-system-xz lzmadec">
            <primary sortas="b-lzmadec">lzmadec</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzmainfo">
        <term><command>lzmainfo</command></term>
        <listitem>
          <para>Displays information stored in an .lzma file header</para>
          <indexterm zone="ch-system-xz lzmainfo">
            <primary sortas="b-lzmainfo">lzmainfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzmore">
        <term><command>lzmore</command></term>
        <listitem>
          <para>Runs <command>more</command> on lzma files</para>
          <indexterm zone="ch-system-xz lzmore">
            <primary sortas="b-lzmore">lzmore</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="unlzma">
        <term><command>unlzma</command></term>
        <listitem>
          <para>Uncompresses lzma files</para>
          <indexterm zone="ch-system-xz unlzma">
            <primary sortas="b-unlzma">unlzma</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="unxz">
        <term><command>unxz</command></term>
        <listitem>
          <para>Uncompresses xz files</para>
          <indexterm zone="ch-system-xz unxz">
            <primary sortas="b-unxz">unxz</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xz">
        <term><command>xz</command></term>
        <listitem>
          <para>Creates xz compressed files</para>
          <indexterm zone="ch-system-xz xz">
            <primary sortas="b-xz">xz</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xzcat">
        <term><command>xzcat</command></term>
        <listitem>
          <para>Decompresses xz files</para>
          <indexterm zone="ch-system-xz xzcat">
            <primary sortas="b-xzcat">xzcat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xzcmp">
        <term><command>xzcmp</command></term>
        <listitem>
          <para>Compares xz compressed files</para>
          <indexterm zone="ch-system-xz xzcmp">
            <primary sortas="b-xzcmp">xzcmp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xzdec">
        <term><command>xzdec</command></term>
        <listitem>
          <para>Decompresses to standard output</para>
          <indexterm zone="ch-system-xz xzdec">
            <primary sortas="b-xzdec">xzdec</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xzdiff">
        <term><command>xzdiff</command></term>
        <listitem>
          <para>Compares xz compressed files</para>
          <indexterm zone="ch-system-xz xzdiff">
            <primary sortas="b-xzdiff">xzdiff</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xzegrep">
        <term><command>xzegrep</command></term>
        <listitem>
          <para>Runs <command>egrep</command> on xz compressed files</para>
          <indexterm zone="ch-system-xz xzegrep">
            <primary sortas="b-xzegrep">xzegrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xzfgrep">
        <term><command>xzfgrep</command></term>
        <listitem>
          <para>Runs <command>fgrep</command> on xz compressed files</para>
          <indexterm zone="ch-system-xz xzfgrep">
            <primary sortas="b-xzfgrep">xzfgrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xzgrep">
        <term><command>xzgrep</command></term>
        <listitem>
          <para>Runs <command>grep</command> on xz compressed files</para>
          <indexterm zone="ch-system-xz xzgrep">
            <primary sortas="b-xzgrep">xzgrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xzless">
        <term><command>xzless</command></term>
        <listitem>
          <para>Runs <command>less</command> on xz files</para>
          <indexterm zone="ch-system-xz xzless">
            <primary sortas="b-xzless">xzless</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xzmore">
        <term><command>xzmore</command></term>
        <listitem>
          <para>Runs <command>more</command> on xz files</para>
          <indexterm zone="ch-system-xz xzmore">
            <primary sortas="b-xzmore">xzmore</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="liblzma">
        <term><filename class="libraryfile">liblzma</filename></term>
        <listitem>
          <para>The LZMA library</para>
          <indexterm zone="ch-system-xz liblzma">
            <primary sortas="c-liblzma">liblzma</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>