source: general/sysutils/lzma-utils.xml@ 104733c

<?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;

  <!ENTITY lzma-utils-download-http "http://tukaani.org/lzma/lzma-&lzma-utils-version;.tar.gz">
  <!ENTITY lzma-utils-download-ftp  "ftp://ftp.openbsd.org/pub/OpenBSD/distfiles/lzma-&lzma-utils-version;.tar.gz">
  <!ENTITY lzma-utils-md5sum        "2a748b77a2f8c3cbc322dbd0b4c9d06a">
  <!ENTITY lzma-utils-size          "479 KB">
  <!ENTITY lzma-utils-buildsize     "6 MB">
  <!ENTITY lzma-utils-time          "0.2 SBU">
]>

<sect1 id="lzma-utils" xreflabel="LZMA-Utils-&lzma-utils-version;">
  <?dbhtml filename="lzma-utils.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>LZMA-Utils-&lzma-utils-version;</title>

  <indexterm zone="lzma-utils">
    <primary sortas="a-LZMA-Utils">LZMA-Utils</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to LZMA-Utils</title>

    <para>The <application>LZMA-Utils</application> package contains
    compression/decompression tools for files using the LZMA format. This is
    useful as more and more Gnu Linux packages are being delivered in the
    LZMA format.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&lzma-utils-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&lzma-utils-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &lzma-utils-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &lzma-utils-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &lzma-utils-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &lzma-utils-time;</para>
      </listitem>
    </itemizedlist>

  </sect2>

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

    <para>Install <application>LZMA-Utils</application> by running the
    following commands:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>lzcat, lzcmp, lzdiff, lzegrep, lzfgrep, lzgrep, lzless, lzma,
        lzmadec, lzmainfo, lzmore and unlzma</seg>
        <seg>liblzmadec.{so,a}</seg>
        <seg>/usr/share/doc/lzma-&lzma-utils-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>is a symbolic link to <command>lzma</command> used to invoke
          <command>lzma</command> with the <parameter>-cd</parameter>
          parameter.</para>
          <indexterm zone="lzma-utils lzcat">
            <primary sortas="b-lzcat">lzcat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzcmp">
        <term><command>lzcmp</command></term>
        <listitem>
          <para>is a symbolic link to <command>lzdiff</command></para>
          <indexterm zone="lzma-utils lzcmp">
            <primary sortas="b-lzcmp">lzcmp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzdiff">
        <term><command>lzdiff</command></term>
        <listitem>
          <para>is used to compare LZMA compressed files.</para>
          <indexterm zone="lzma-utils lzdiff">
            <primary sortas="b-lzdiff">lzdiff</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzegrep">
        <term><command>lzegrep</command></term>
        <listitem>
          <para>is a symbolic link to <command>lzgrep</command> and uses
          <command>egrep</command> instead of <command>grep</command>.</para>
          <indexterm zone="lzma-utils lzegrep">
            <primary sortas="b-lzegrep">lzegrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzfgrep">
        <term><command>lzfgrep</command></term>
        <listitem>
          <para>is a symbolic link to <command>lzgrep</command> and uses
          <command>fgrep</command> instead of <command>grep</command>.</para>
          <indexterm zone="lzma-utils lzfgrep">
            <primary sortas="b-lzfgrep">lzfgrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzgrep">
        <term><command>lzgrep</command></term>
        <listitem>
          <para>is used to search LZMA compressed files for a regular
          expression.</para>
          <indexterm zone="lzma-utils lzgrep">
            <primary sortas="b-lzgrep">lzgrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzless">
        <term><command>lzless</command></term>
        <listitem>
          <para>is a symbolic link to <command>lzmore</command> which uses
          <command>less</command> instead of <command>more</command>.</para>
          <indexterm zone="lzma-utils lzless">
            <primary sortas="b-lzless">lzless</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzma">
        <term><command>lzma</command></term>
        <listitem>
          <para>is an LZMA compression and decompression tool.</para>
          <indexterm zone="lzma-utils lzma">
            <primary sortas="b-lzma">lzma</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzmadec">
        <term><command>lzmadec</command></term>
        <listitem>
          <para>is a small and fast decoder for LZMA compressed files which
          does not provide command-line arguments other than
          <parameter>--help</parameter>.</para>
          <indexterm zone="lzma-utils lzmadec">
            <primary sortas="b-lzmadec">lzmadec</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzmainfo">
        <term><command>lzmainfo</command></term>
        <listitem>
          <para>is used to show information stored in the LZMA compressed file
          header.</para>
          <indexterm zone="lzma-utils lzmainfo">
            <primary sortas="b-lzmainfo">lzmainfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lzmore">
        <term><command>lzmore</command></term>
        <listitem>
          <para>is a filter which allows examination of LZMA compressed text
          files one screenful at a time.</para>
          <indexterm zone="lzma-utils lzmore">
            <primary sortas="b-lzmore">lzmore</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="unlzma">
        <term><command>unlzma</command></term>
        <listitem>
          <para>is a symbolic link to <command>lzma</command> used to invoke
          <command>lzma</command> with the <parameter>-d</parameter>
          parameter.</para>
          <indexterm zone="lzma-utils unlzma">
            <primary sortas="b-unlzma">unlzma</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="liblzmadec">
        <term><filename class='libraryfile'>liblzmadec.{so,a}</filename></term>
        <listitem>
          <para>contains functions to support compression and decompression of
          LZMA files.</para>
          <indexterm zone="lzma-utils liblzmadec">
            <primary sortas="c-liblzmadec">liblzmadec.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>