aboutsummaryrefslogtreecommitdiffstats
path: root/chapter08/zstd.xml
blob: 1d0c603f62ae41d8dd7a7bc6eeaa2322911a2ad6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<?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-zstd" role="wrap">
  <?dbhtml filename="zstd.html"?>

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

  <title>Zstd-&zstd-version;</title>

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

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

    <para>Zstandard is a real-time compression algorithm, providing high
    compression ratios. It offers a very wide range of compression / speed
    trade-offs, while being backed by a very fast decoder.</para>

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

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

  </sect2>

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

    <para>Compile the package:</para>

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

    <note>
       <para>In the test output there are several places that
       indicate 'failed'. These are expected and only 'FAIL' is an actual
       test failure. There should be no test failures.</para>
    </note>

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

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

    <para>Install the package:</para>

<screen><userinput remap="install">make prefix=/usr install</userinput></screen>

    <para>Remove the static library:</para>
<screen><userinput remap="install">rm -v /usr/lib/libzstd.a</userinput></screen>

  </sect2>

  <sect2 id="contents-zstd" role="content">
    <title>Contents of Zstd</title>

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

      <seglistitem>
        <seg>zstd, 
             zstdcat (link to zstd), 
             zstdgrep, 
             zstdless, 
             zstdmt (link to zstd), and
             unzstd (link to zstd)
        </seg>

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

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

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

      <varlistentry id="zstdgrep">
        <term><command>zstdgrep</command></term>
        <listitem>
          <para>Runs <command>grep</command> on ZSTD compressed files</para>
          <indexterm zone="ch-system-zstd zstdgrep">
            <primary sortas="b-zstdgrep">zstdgrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="zstdless">
        <term><command>zstdless</command></term>
        <listitem>
          <para>Runs <command>less</command> on ZSTD compressed files</para>
          <indexterm zone="ch-system-zstd zstdless">
            <primary sortas="b-zstdless">zstdless</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>