summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2019-04-12 20:15:05 (GMT)
committerYann Collet <cyan@fb.com>2019-04-12 20:15:05 (GMT)
commit352bbdb98ef6d8c5518b6c7ec7b48a40245c3a9c (patch)
treea1130ea2f5b44473833423cd761d98e7cdd239c7
parent21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0 (diff)
downloadlz4-352bbdb98ef6d8c5518b6c7ec7b48a40245c3a9c.zip
lz4-352bbdb98ef6d8c5518b6c7ec7b48a40245c3a9c.tar.gz
lz4-352bbdb98ef6d8c5518b6c7ec7b48a40245c3a9c.tar.bz2
updated man page
with --favor-decSpeed
-rw-r--r--programs/lz4.114
-rw-r--r--programs/lz4.1.md8
2 files changed, 16 insertions, 6 deletions
diff --git a/programs/lz4.1 b/programs/lz4.1
index f35e29d..d3406a5 100644
--- a/programs/lz4.1
+++ b/programs/lz4.1
@@ -1,5 +1,5 @@
.
-.TH "LZ4" "1" "September 2018" "lz4 1.8.3" "User Commands"
+.TH "LZ4" "1" "April 2019" "lz4 1.9.0" "User Commands"
.
.SH "NAME"
\fBlz4\fR \- lz4, unlz4, lz4cat \- Compress or decompress \.lz4 files
@@ -118,6 +118,14 @@ Benchmark mode, using \fB#\fR compression level\.
Compression level, with # being any value from 1 to 12\. Higher values trade compression speed for compression ratio\. Values above 12 are considered the same as 12\. Recommended values are 1 for fast compression (default), and 9 for high compression\. Speed/compression trade\-off will vary depending on data to compress\. Decompression speed remains fast at all settings\.
.
.TP
+\fB\-\-fast[=#]\fR
+Switch to ultra\-fast compression levels\. The higher the value, the faster the compression speed, at the cost of some compression ratio\. If \fB=#\fR is not present, it defaults to \fB1\fR\. This setting overrides compression level if one was set previously\. Similarly, if a compression level is set after \fB\-\-fast\fR, it overrides it\.
+.
+.TP
+\fB\-\-favor\-decSpeed\fR
+Generate compressed data optimized for decompression speed\. Compressed data will be larger as a consequence (typically by ~0\.5%), while decompression speed will be improved by 5\-20%, depending on use cases\. This option only works in combination with very high compression levels (>=10)\.
+.
+.TP
\fB\-D dictionaryName\fR
Compress, decompress or benchmark using dictionary \fIdictionaryName\fR\. Compression and decompression must use the same dictionary to be compatible\. Using a different dictionary during decompression will either abort due to decompression error, or generate a checksum error\.
.
@@ -155,10 +163,6 @@ Block size [4\-7](default : 7)
Block Dependency (improves compression ratio on small blocks)
.
.TP
-\fB\-\-fast[=#]\fR
-switch to ultra\-fast compression levels\. If \fB=#\fR is not present, it defaults to \fB1\fR\. The higher the value, the faster the compression speed, at the cost of some compression ratio\. This setting overwrites compression level if one was set previously\. Similarly, if a compression level is set after \fB\-\-fast\fR, it overrides it\.
-.
-.TP
\fB\-\-[no\-]frame\-crc\fR
Select frame checksum (default:enabled)
.
diff --git a/programs/lz4.1.md b/programs/lz4.1.md
index 12b8e29..2ee40aa 100644
--- a/programs/lz4.1.md
+++ b/programs/lz4.1.md
@@ -126,12 +126,18 @@ only the latest one will be applied.
Decompression speed remains fast at all settings.
* `--fast[=#]`:
- switch to ultra-fast compression levels.
+ Switch to ultra-fast compression levels.
The higher the value, the faster the compression speed, at the cost of some compression ratio.
If `=#` is not present, it defaults to `1`.
This setting overrides compression level if one was set previously.
Similarly, if a compression level is set after `--fast`, it overrides it.
+* `--favor-decSpeed`:
+ Generate compressed data optimized for decompression speed.
+ Compressed data will be larger as a consequence (typically by ~0.5%),
+ while decompression speed will be improved by 5-20%, depending on use cases.
+ This option only works in combination with very high compression levels (>=10).
+
* `-D dictionaryName`:
Compress, decompress or benchmark using dictionary _dictionaryName_.
Compression and decompression must use the same dictionary to be compatible.