]> Sergey Matveev's repositories - tofuproxy.git/blobdiff - cmd/zstd/README
Refactor C-code building, use pkgconf
[tofuproxy.git] / cmd / zstd / README
diff --git a/cmd/zstd/README b/cmd/zstd/README
new file mode 100644 (file)
index 0000000..7a1612c
--- /dev/null
@@ -0,0 +1,11 @@
+enzstd creates Zstandard compressed stream of frames, where each frame
+holds exactly single WARC record. It also explicitly adds checksum.
+Utility takes records from stdin, where each record has 64-bit
+big-endian length prefix.
+
+unzstd decompressed Zstandard frames stream from stdin to stdout. If
+stream starts with the dictionary (either compressed, or uncompressed)
+it is loaded first. If 3rd file descriptor is opened, then each frame's
+offset (its size) with decompressed data size is printed in
+tab-separated format. If the stream contains dictionary, then first
+frame's data size equals to zero.