summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2019-04-12 11:27:44 -0700
committerYann Collet <cyan@fb.com>2019-04-12 11:27:44 -0700
commit21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0 (patch)
tree4318e6bcebc94455ed166cea1b096b7d9bc93fdb /doc
parent780aac520b69d6369f4e3995624c37e56d75498d (diff)
downloadlz4-21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0.tar.gz
lz4-21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0.tar.bz2
lz4-21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0.zip
updated doc to underline difference between block and frame
as this is a very frequent source of confusion for new users.
Diffstat (limited to 'doc')
-rw-r--r--doc/lz4_manual.html18
1 files changed, 11 insertions, 7 deletions
diff --git a/doc/lz4_manual.html b/doc/lz4_manual.html
index 4cd21fc..356a60d 100644
--- a/doc/lz4_manual.html
+++ b/doc/lz4_manual.html
@@ -26,19 +26,23 @@
multiple GB/s per core, typically reaching RAM speed limits on multi-core systems.
The LZ4 compression library provides in-memory compression and decompression functions.
+ It gives full buffer control to user.
Compression can be done in:
- a single step (described as Simple Functions)
- a single step, reusing a context (described in Advanced Functions)
- unbounded multiple steps (described as Streaming compression)
- lz4.h provides block compression functions. It gives full buffer control to user.
- Decompressing an lz4-compressed block also requires metadata (such as compressed size).
- Each application is free to encode such metadata in whichever way it wants.
+ lz4.h generates and decodes LZ4-compressed blocks (doc/lz4_Block_format.md).
+ Decompressing a block requires additional metadata, such as its compressed size.
+ Each application is free to encode and pass such metadata in whichever way it wants.
- An additional format, called LZ4 frame specification (doc/lz4_Frame_format.md),
- take care of encoding standard metadata alongside LZ4-compressed blocks.
- Frame format is required for interoperability.
- It is delivered through a companion API, declared in lz4frame.h.
+ lz4.h only handle blocks, it can not generate Frames.
+
+ Blocks are different from Frames (doc/lz4_Frame_format.md).
+ Frames bundle both blocks and metadata in a specified manner.
+ This are required for compressed data to be self-contained and portable.
+ Frame format is delivered through a companion API, declared in lz4frame.h.
+ Note that the `lz4` CLI can only manage frames.
<BR></pre>
<a name="Chapter2"></a><h2>Version</h2><pre></pre>