[725ef3b] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 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-zstd" role="wrap">
|
---|
| 9 | <?dbhtml filename="zstd.html"?>
|
---|
| 10 |
|
---|
| 11 | <sect1info condition="script">
|
---|
| 12 | <productname>zstd</productname>
|
---|
| 13 | <productnumber>&zstd-version;</productnumber>
|
---|
| 14 | <address>&zstd-url;</address>
|
---|
| 15 | </sect1info>
|
---|
| 16 |
|
---|
| 17 | <title>Zstd-&zstd-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="ch-system-zstd">
|
---|
| 20 | <primary sortas="a-zstd">zstd</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect2 role="package">
|
---|
| 24 | <title/>
|
---|
| 25 |
|
---|
| 26 | <para>Zstandard is a real-time compression algorithm, providing high
|
---|
| 27 | compression ratios. It offers a very wide range of compression / speed
|
---|
| 28 | trade-offs, while being backed by a very fast decoder.</para>
|
---|
| 29 |
|
---|
| 30 | <segmentedlist>
|
---|
| 31 | <segtitle>&buildtime;</segtitle>
|
---|
| 32 | <segtitle>&diskspace;</segtitle>
|
---|
| 33 |
|
---|
| 34 | <seglistitem>
|
---|
[6dfcfecc] | 35 | <seg>&zstd-fin-sbu;</seg>
|
---|
| 36 | <seg>&zstd-fin-du;</seg>
|
---|
[725ef3b] | 37 | </seglistitem>
|
---|
| 38 | </segmentedlist>
|
---|
| 39 |
|
---|
| 40 | </sect2>
|
---|
| 41 |
|
---|
| 42 | <sect2 role="installation">
|
---|
| 43 | <title>Installation of Zstd</title>
|
---|
| 44 |
|
---|
[070bc9a] | 45 | <para>Apply a patch to fix some issues identified by upstream:</para>
|
---|
| 46 |
|
---|
| 47 | <screen><userinput remap="pre">patch -Np1 -i ../&zstd-upstream-fixes-patch;</userinput></screen>
|
---|
| 48 |
|
---|
[725ef3b] | 49 | <para>Compile the package:</para>
|
---|
| 50 |
|
---|
[d54813b] | 51 | <screen><userinput remap="make">make prefix=/usr</userinput></screen>
|
---|
[725ef3b] | 52 |
|
---|
[af4f4bfa] | 53 | <note>
|
---|
| 54 | <para>In the test output there are several places that
|
---|
| 55 | indicate 'failed'. These are expected and only 'FAIL' is an actual
|
---|
| 56 | test failure. There should be no test failures.</para>
|
---|
| 57 | </note>
|
---|
| 58 |
|
---|
[edd83dc] | 59 | <para>To test the results, issue:</para>
|
---|
| 60 |
|
---|
| 61 | <screen><userinput remap="test">make check</userinput></screen>
|
---|
[725ef3b] | 62 |
|
---|
| 63 | <para>Install the package:</para>
|
---|
| 64 |
|
---|
| 65 | <screen><userinput remap="install">make prefix=/usr install</userinput></screen>
|
---|
| 66 |
|
---|
[d7a9421] | 67 | <para>Remove the static library:</para>
|
---|
| 68 | <screen><userinput remap="install">rm -v /usr/lib/libzstd.a</userinput></screen>
|
---|
[725ef3b] | 69 |
|
---|
| 70 | </sect2>
|
---|
| 71 |
|
---|
[6dfcfecc] | 72 | <!-- - - - - - - - - - -->
|
---|
| 73 | <!-- Multilib - 32bit -->
|
---|
| 74 | <!-- - - - - - - - - - -->
|
---|
| 75 |
|
---|
| 76 | <sect2 arch="ml_32,ml_all" role="installation">
|
---|
| 77 | <title>Installation of Zstd - 32bit</title>
|
---|
| 78 |
|
---|
| 79 | <para>Clean previous build:</para>
|
---|
| 80 |
|
---|
| 81 | <screen><userinput remap="pre">make clean</userinput></screen>
|
---|
| 82 |
|
---|
| 83 | <para>Compile the package:</para>
|
---|
| 84 |
|
---|
[11b1e35] | 85 | <screen><userinput remap="make">CC="gcc -m32" make prefix=/usr</userinput></screen>
|
---|
[6dfcfecc] | 86 |
|
---|
| 87 | <para>Install the package:</para>
|
---|
| 88 |
|
---|
[70aadfb] | 89 | <screen><userinput remap="install">make prefix=/usr DESTDIR=$PWD/DESTDIR install
|
---|
[0ebda11] | 90 | cp -Rv DESTDIR/usr/lib/* /usr/lib32/
|
---|
| 91 | sed -e "/^libdir/s/lib$/lib32/" -i /usr/lib32/pkgconfig/libzstd.pc
|
---|
[2d66549] | 92 | rm -rf DESTDIR</userinput></screen>
|
---|
[6dfcfecc] | 93 |
|
---|
| 94 | </sect2><!-- m32 -->
|
---|
| 95 |
|
---|
| 96 | <!-- - - - - - - - - - -->
|
---|
| 97 | <!-- Multilib - x32bit -->
|
---|
| 98 | <!-- - - - - - - - - - -->
|
---|
| 99 |
|
---|
| 100 | <sect2 arch="ml_x32,ml_all" role="installation">
|
---|
| 101 | <title>Installation of Zstd - x32bit</title>
|
---|
| 102 |
|
---|
| 103 | <para>Clean previous build:</para>
|
---|
| 104 |
|
---|
| 105 | <screen><userinput remap="pre">make clean</userinput></screen>
|
---|
| 106 |
|
---|
| 107 | <para>Compile the package:</para>
|
---|
| 108 |
|
---|
[11b1e35] | 109 | <screen><userinput remap="make">CC="gcc -mx32" make prefix=/usr</userinput></screen>
|
---|
[6dfcfecc] | 110 |
|
---|
| 111 | <para>Install the package:</para>
|
---|
| 112 |
|
---|
[70aadfb] | 113 | <screen><userinput remap="install">make prefix=/usr DESTDIR=$PWD/DESTDIR install
|
---|
[0ebda11] | 114 | cp -Rv DESTDIR/usr/lib/* /usr/libx32/
|
---|
| 115 | sed -e "/^libdir/s/lib$/libx32/" -i /usr/libx32/pkgconfig/libzstd.pc
|
---|
[2d66549] | 116 | rm -rf DESTDIR</userinput></screen>
|
---|
[6dfcfecc] | 117 |
|
---|
| 118 | </sect2><!-- mx32 -->
|
---|
| 119 |
|
---|
[725ef3b] | 120 | <sect2 id="contents-zstd" role="content">
|
---|
| 121 | <title>Contents of Zstd</title>
|
---|
| 122 |
|
---|
| 123 | <segmentedlist>
|
---|
| 124 | <segtitle>Installed programs</segtitle>
|
---|
| 125 | <segtitle>Installed library</segtitle>
|
---|
| 126 |
|
---|
| 127 | <seglistitem>
|
---|
[d672ab7] | 128 | <seg>zstd,
|
---|
| 129 | zstdcat (link to zstd),
|
---|
| 130 | zstdgrep,
|
---|
| 131 | zstdless,
|
---|
[725ef3b] | 132 | zstdmt (link to zstd), and
|
---|
| 133 | unzstd (link to zstd)
|
---|
| 134 | </seg>
|
---|
| 135 |
|
---|
| 136 | <seg>libzstd.so</seg>
|
---|
| 137 | </seglistitem>
|
---|
| 138 | </segmentedlist>
|
---|
| 139 |
|
---|
| 140 | <variablelist>
|
---|
| 141 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 142 | <?dbfo list-presentation="list"?>
|
---|
| 143 | <?dbhtml list-presentation="table"?>
|
---|
| 144 |
|
---|
| 145 | <varlistentry id="zstd">
|
---|
| 146 | <term><command>zstd</command></term>
|
---|
| 147 | <listitem>
|
---|
| 148 | <para>Compresses or decompresses files using the ZSTD format</para>
|
---|
| 149 | <indexterm zone="ch-system-zstd zstd">
|
---|
| 150 | <primary sortas="b-zstd">zstd</primary>
|
---|
| 151 | </indexterm>
|
---|
| 152 | </listitem>
|
---|
| 153 | </varlistentry>
|
---|
| 154 |
|
---|
| 155 | <varlistentry id="zstdgrep">
|
---|
| 156 | <term><command>zstdgrep</command></term>
|
---|
| 157 | <listitem>
|
---|
| 158 | <para>Runs <command>grep</command> on ZSTD compressed files</para>
|
---|
| 159 | <indexterm zone="ch-system-zstd zstdgrep">
|
---|
| 160 | <primary sortas="b-zstdgrep">zstdgrep</primary>
|
---|
| 161 | </indexterm>
|
---|
| 162 | </listitem>
|
---|
| 163 | </varlistentry>
|
---|
| 164 |
|
---|
| 165 | <varlistentry id="zstdless">
|
---|
| 166 | <term><command>zstdless</command></term>
|
---|
| 167 | <listitem>
|
---|
| 168 | <para>Runs <command>less</command> on ZSTD compressed files</para>
|
---|
| 169 | <indexterm zone="ch-system-zstd zstdless">
|
---|
| 170 | <primary sortas="b-zstdless">zstdless</primary>
|
---|
| 171 | </indexterm>
|
---|
| 172 | </listitem>
|
---|
| 173 | </varlistentry>
|
---|
| 174 |
|
---|
| 175 | <varlistentry id="libzstd">
|
---|
| 176 | <term><filename class="libraryfile">libzstd</filename></term>
|
---|
| 177 | <listitem>
|
---|
| 178 | <para>The library implementing lossless data
|
---|
| 179 | compression, using the ZSTD algorithm</para>
|
---|
| 180 | <indexterm zone="ch-system-zstd libzstd">
|
---|
| 181 | <primary sortas="c-libzstd">libzstd</primary>
|
---|
| 182 | </indexterm>
|
---|
| 183 | </listitem>
|
---|
| 184 | </varlistentry>
|
---|
| 185 |
|
---|
| 186 | </variablelist>
|
---|
| 187 |
|
---|
| 188 | </sect2>
|
---|
| 189 |
|
---|
| 190 | </sect1>
|
---|