lfs/chapter08/lz4.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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-lz4" role="wrap">
  <?dbhtml filename="lz4.html"?>

  <sect1info condition="script">
    <productname>Lz4</productname>
    <productnumber>&lz4-version;</productnumber>
    <address>&lz4-url;</address>
  </sect1info>

  <title>Lz4-&lz4-version;</title>

  <indexterm zone="ch-system-lz4">
    <primary sortas="a-lz4">Lz4</primary>
  </indexterm>

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

    <para>Lz4 is a lossless compression algorithm, providing compression speed
    greater than 500 MB/s per core. It features an extremely fast decoder, with
    speed in multiple GB/s per core. Lz4 can work with Zstandard to allow both
    algorithms to compress data faster.</para>

    <segmentedlist>
      <segtitle>&buildtime;</segtitle>
      <segtitle>&diskspace;</segtitle>

      <seglistitem>
        <seg>&lz4-fin-sbu;</seg>
        <seg>&lz4-fin-du;</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Lz4</title>

    <para>Compile the package:</para>

<screen><userinput remap="make">make BUILD_STATIC=no</userinput></screen>

    <para>To test the results, issue:</para>

    <!-- This needs to be done at -j1 because otherwise test files do not
         get generated correctly. -->

<screen><userinput remap="test">make -j1 check</userinput></screen>

    <para>Install the package:</para>

<screen><userinput remap="install">make BUILD_STATIC=no PREFIX=/usr install</userinput></screen>

  </sect2>

  <sect2 id="contents-lz4" role="content">
    <title>Contents of Lz4</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>
      <segtitle>Installed library</segtitle>

      <seglistitem>
        <seg>lz4,
             lz4c (link to lz4),
             lz4cat (link to lz4), and
             unlz4 (link to lz4)
        </seg>

        <seg>liblz4.so</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="lz4">
        <term><command>lz4</command></term>
        <listitem>
          <para>Compresses or decompresses files using the LZ4 format</para>
          <indexterm zone="ch-system-lz4 lz4">
            <primary sortas="b-lz4">lz4</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lz4c">
        <term><command>lz4c</command></term>
        <listitem>
          <para>Compresses files using the LZ4 format</para>
          <indexterm zone="ch-system-lz4 lz4c">
            <primary sortas="b-lz4c">lz4c</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lz4cat">
        <term><command>lz4cat</command></term>
        <listitem>
          <para>Lists the contents of a file compressed using the LZ4 format</para>
          <indexterm zone="ch-system-lz4 lz4cat">
            <primary sortas="b-lz4cat">lz4cat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="unlz4">
        <term><command>unlz4</command></term>
        <listitem>
          <para>Decompresses files using the LZ4 format</para>
          <indexterm zone="ch-system-lz4 unlz4">
             <primary sortas="b-unlz4">unlz4</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="liblz4">
        <term><filename class="libraryfile">liblz4</filename></term>
        <listitem>
          <para>The library implementing lossless data
          compression, using the LZ4 algorithm</para>
          <indexterm zone="ch-system-lz4 liblz4">
            <primary sortas="c-liblz4">liblz4</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>