source: clfs-sysroot/BOOK/final-system/common/xz.xml@ 2036ece

<?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</userinput></screen>

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

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

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

<screen os="f"><userinput>make DESTDIR=${CLFS} install</userinput></screen>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>lzcat (link to xz), lzcmp (link to lzdiff), lzdiff, lzegrep (link to lzgrep),
        lzfgrep (link to lzgrep), lzgrep, lzless (link to lzmore), lzma (link to xz),
        lzmadec, lzmore, unlzma (link to xz), unxz (link to xz), xz, xzdec, and
        xzcat (link to xz).</seg>
        <seg>/liblzma.a liblzma.la liblzma.so liblzma.so.0 liblzma.so.0.0.0</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 to standard output</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="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>

    </variablelist>

  </sect2>

</sect1>