zstd.xml 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  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. <sect1 id="ch-system-zstd" role="wrap">
  8. <?dbhtml filename="zstd.html"?>
  9. <sect1info condition="script">
  10. <productname>zstd</productname>
  11. <productnumber>&zstd-version;</productnumber>
  12. <address>&zstd-url;</address>
  13. </sect1info>
  14. <title>Zstd-&zstd-version;</title>
  15. <indexterm zone="ch-system-zstd">
  16. <primary sortas="a-zstd">zstd</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>Zstandard is a real-time compression algorithm, providing high
  21. compression ratios. It offers a very wide range of compression / speed
  22. trade-offs, while being backed by a very fast decoder.</para>
  23. <segmentedlist>
  24. <segtitle>&buildtime;</segtitle>
  25. <segtitle>&diskspace;</segtitle>
  26. <seglistitem>
  27. <seg>&zstd-fin-sbu;</seg>
  28. <seg>&zstd-fin-du;</seg>
  29. </seglistitem>
  30. </segmentedlist>
  31. </sect2>
  32. <sect2 role="installation">
  33. <title>Installation of Zstd</title>
  34. <para>Compile the package:</para>
  35. <screen><userinput remap="make">make</userinput></screen>
  36. <para>This package does not come with a test suite.</para>
  37. <para>Install the package:</para>
  38. <screen><userinput remap="install">make prefix=/usr install</userinput></screen>
  39. <para>Remove the static library and move the shared library to
  40. <filename class="directory">/lib</filename>. Also, the
  41. <filename class="extension">.so</filename> file in
  42. <filename class="directory">/usr/lib</filename> will need to be recreated:</para>
  43. <screen><userinput remap="install">rm -v /usr/lib/libzstd.a
  44. mv -v /usr/lib/libzstd.so.* /lib
  45. ln -sfv ../../lib/$(readlink /usr/lib/libzstd.so) /usr/lib/libzstd.so</userinput></screen>
  46. </sect2>
  47. <sect2 id="contents-zstd" role="content">
  48. <title>Contents of Zstd</title>
  49. <segmentedlist>
  50. <segtitle>Installed programs</segtitle>
  51. <segtitle>Installed library</segtitle>
  52. <seglistitem>
  53. <seg>zstd,
  54. zstdcat (link to zstd),
  55. zstdgrep,
  56. zstdless,
  57. zstdmt (link to zstd), and
  58. unzstd (link to zstd)
  59. </seg>
  60. <seg>libzstd.so</seg>
  61. </seglistitem>
  62. </segmentedlist>
  63. <variablelist>
  64. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  65. <?dbfo list-presentation="list"?>
  66. <?dbhtml list-presentation="table"?>
  67. <varlistentry id="zstd">
  68. <term><command>zstd</command></term>
  69. <listitem>
  70. <para>Compresses or decompresses files using the ZSTD format</para>
  71. <indexterm zone="ch-system-zstd zstd">
  72. <primary sortas="b-zstd">zstd</primary>
  73. </indexterm>
  74. </listitem>
  75. </varlistentry>
  76. <varlistentry id="zstdgrep">
  77. <term><command>zstdgrep</command></term>
  78. <listitem>
  79. <para>Runs <command>grep</command> on ZSTD compressed files</para>
  80. <indexterm zone="ch-system-zstd zstdgrep">
  81. <primary sortas="b-zstdgrep">zstdgrep</primary>
  82. </indexterm>
  83. </listitem>
  84. </varlistentry>
  85. <varlistentry id="zstdless">
  86. <term><command>zstdless</command></term>
  87. <listitem>
  88. <para>Runs <command>less</command> on ZSTD compressed files</para>
  89. <indexterm zone="ch-system-zstd zstdless">
  90. <primary sortas="b-zstdless">zstdless</primary>
  91. </indexterm>
  92. </listitem>
  93. </varlistentry>
  94. <varlistentry id="libzstd">
  95. <term><filename class="libraryfile">libzstd</filename></term>
  96. <listitem>
  97. <para>The library implementing lossless data
  98. compression, using the ZSTD algorithm</para>
  99. <indexterm zone="ch-system-zstd libzstd">
  100. <primary sortas="c-libzstd">libzstd</primary>
  101. </indexterm>
  102. </listitem>
  103. </varlistentry>
  104. </variablelist>
  105. </sect2>
  106. </sect1>