[c5ae777] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 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-lz4" role="wrap">
|
---|
| 9 | <?dbhtml filename="lz4.html"?>
|
---|
| 10 |
|
---|
| 11 | <sect1info condition="script">
|
---|
| 12 | <productname>Lz4</productname>
|
---|
| 13 | <productnumber>&lz4-version;</productnumber>
|
---|
| 14 | <address>&lz4-url;</address>
|
---|
| 15 | </sect1info>
|
---|
| 16 |
|
---|
| 17 | <title>Lz4-&lz4-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="ch-system-lz4">
|
---|
| 20 | <primary sortas="a-lz4">Lz4</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect2 role="package">
|
---|
| 24 | <title/>
|
---|
| 25 |
|
---|
| 26 | <para>Lz4 is a lossless compression algorithm, providing compression speed
|
---|
| 27 | greater than 500 MB/s per core. It features an extremely fast decoder, with
|
---|
| 28 | speed in multiple GB/s per core. Lz4 can work with Zstandard to allow both
|
---|
| 29 | algorithms to compress data faster.</para>
|
---|
| 30 |
|
---|
| 31 | <segmentedlist>
|
---|
| 32 | <segtitle>&buildtime;</segtitle>
|
---|
| 33 | <segtitle>&diskspace;</segtitle>
|
---|
| 34 |
|
---|
| 35 | <seglistitem>
|
---|
| 36 | <seg>&lz4-fin-sbu;</seg>
|
---|
| 37 | <seg>&lz4-fin-du;</seg>
|
---|
| 38 | </seglistitem>
|
---|
| 39 | </segmentedlist>
|
---|
| 40 |
|
---|
| 41 | </sect2>
|
---|
| 42 |
|
---|
| 43 | <sect2 role="installation">
|
---|
| 44 | <title>Installation of Lz4</title>
|
---|
| 45 |
|
---|
| 46 | <para>Compile the package:</para>
|
---|
| 47 |
|
---|
[7119cf2a] | 48 | <screen><userinput remap="make">make BUILD_STATIC=no PREFIX=/usr</userinput></screen>
|
---|
[c5ae777] | 49 |
|
---|
| 50 | <para>To test the results, issue:</para>
|
---|
| 51 |
|
---|
| 52 | <!-- This needs to be done at -j1 because otherwise test files do not
|
---|
| 53 | get generated correctly. -->
|
---|
| 54 |
|
---|
| 55 | <screen><userinput remap="test">make -j1 check</userinput></screen>
|
---|
| 56 |
|
---|
| 57 | <para>Install the package:</para>
|
---|
| 58 |
|
---|
| 59 | <screen><userinput remap="install">make BUILD_STATIC=no PREFIX=/usr install</userinput></screen>
|
---|
| 60 |
|
---|
| 61 | </sect2>
|
---|
| 62 |
|
---|
| 63 | <sect2 id="contents-lz4" role="content">
|
---|
| 64 | <title>Contents of Lz4</title>
|
---|
| 65 |
|
---|
| 66 | <segmentedlist>
|
---|
| 67 | <segtitle>Installed programs</segtitle>
|
---|
| 68 | <segtitle>Installed library</segtitle>
|
---|
| 69 |
|
---|
| 70 | <seglistitem>
|
---|
| 71 | <seg>lz4,
|
---|
| 72 | lz4c (link to lz4),
|
---|
| 73 | lz4cat (link to lz4), and
|
---|
| 74 | unlz4 (link to lz4)
|
---|
| 75 | </seg>
|
---|
| 76 |
|
---|
| 77 | <seg>liblz4.so</seg>
|
---|
| 78 | </seglistitem>
|
---|
| 79 | </segmentedlist>
|
---|
| 80 |
|
---|
| 81 | <variablelist>
|
---|
| 82 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 83 | <?dbfo list-presentation="list"?>
|
---|
| 84 | <?dbhtml list-presentation="table"?>
|
---|
| 85 |
|
---|
| 86 | <varlistentry id="lz4">
|
---|
| 87 | <term><command>lz4</command></term>
|
---|
| 88 | <listitem>
|
---|
| 89 | <para>Compresses or decompresses files using the LZ4 format</para>
|
---|
| 90 | <indexterm zone="ch-system-lz4 lz4">
|
---|
| 91 | <primary sortas="b-lz4">lz4</primary>
|
---|
| 92 | </indexterm>
|
---|
| 93 | </listitem>
|
---|
| 94 | </varlistentry>
|
---|
| 95 |
|
---|
| 96 | <varlistentry id="lz4c">
|
---|
| 97 | <term><command>lz4c</command></term>
|
---|
| 98 | <listitem>
|
---|
| 99 | <para>Compresses files using the LZ4 format</para>
|
---|
| 100 | <indexterm zone="ch-system-lz4 lz4c">
|
---|
| 101 | <primary sortas="b-lz4c">lz4c</primary>
|
---|
| 102 | </indexterm>
|
---|
| 103 | </listitem>
|
---|
| 104 | </varlistentry>
|
---|
| 105 |
|
---|
| 106 | <varlistentry id="lz4cat">
|
---|
| 107 | <term><command>lz4cat</command></term>
|
---|
| 108 | <listitem>
|
---|
| 109 | <para>Lists the contents of a file compressed using the LZ4 format</para>
|
---|
| 110 | <indexterm zone="ch-system-lz4 lz4cat">
|
---|
| 111 | <primary sortas="b-lz4cat">lz4cat</primary>
|
---|
| 112 | </indexterm>
|
---|
| 113 | </listitem>
|
---|
| 114 | </varlistentry>
|
---|
| 115 |
|
---|
| 116 | <varlistentry id="unlz4">
|
---|
| 117 | <term><command>unlz4</command></term>
|
---|
| 118 | <listitem>
|
---|
| 119 | <para>Decompresses files using the LZ4 format</para>
|
---|
| 120 | <indexterm zone="ch-system-lz4 unlz4">
|
---|
| 121 | <primary sortas="b-unlz4">unlz4</primary>
|
---|
| 122 | </indexterm>
|
---|
| 123 | </listitem>
|
---|
| 124 | </varlistentry>
|
---|
| 125 |
|
---|
| 126 | <varlistentry id="liblz4">
|
---|
| 127 | <term><filename class="libraryfile">liblz4</filename></term>
|
---|
| 128 | <listitem>
|
---|
| 129 | <para>The library implementing lossless data
|
---|
| 130 | compression, using the LZ4 algorithm</para>
|
---|
| 131 | <indexterm zone="ch-system-lz4 liblz4">
|
---|
| 132 | <primary sortas="c-liblz4">liblz4</primary>
|
---|
| 133 | </indexterm>
|
---|
| 134 | </listitem>
|
---|
| 135 | </varlistentry>
|
---|
| 136 |
|
---|
| 137 | </variablelist>
|
---|
| 138 |
|
---|
| 139 | </sect2>
|
---|
| 140 |
|
---|
| 141 | </sect1>
|
---|