diff options
| author | Yann Collet <cyan@fb.com> | 2018-09-05 14:05:08 -0700 |
|---|---|---|
| committer | Yann Collet <cyan@fb.com> | 2018-09-05 14:05:08 -0700 |
| commit | 0fea528e3a70f8578ca6e7f15d922dab8aa9ff25 (patch) | |
| tree | 75d8c00fc7fa2857a49d5d5c2466e33586ba7afc /programs/lz4.1 | |
| parent | c4dbc37b3ce085a05441124fee4a8144dc149b05 (diff) | |
| download | lz4-0fea528e3a70f8578ca6e7f15d922dab8aa9ff25.tar.gz lz4-0fea528e3a70f8578ca6e7f15d922dab8aa9ff25.tar.bz2 lz4-0fea528e3a70f8578ca6e7f15d922dab8aa9ff25.zip | |
updated documentation regarding dictionary compression
following suggestion from @stbrumme (#558)
Also : bumped version number, regenerated man page and html doc
Diffstat (limited to 'programs/lz4.1')
| -rw-r--r-- | programs/lz4.1 | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/programs/lz4.1 b/programs/lz4.1 index e0f6a81..f35e29d 100644 --- a/programs/lz4.1 +++ b/programs/lz4.1 @@ -1,5 +1,5 @@ . -.TH "LZ4" "1" "2018-01-13" "lz4 1.8.1" "User Commands" +.TH "LZ4" "1" "September 2018" "lz4 1.8.3" "User Commands" . .SH "NAME" \fBlz4\fR \- lz4, unlz4, lz4cat \- Compress or decompress \.lz4 files @@ -115,7 +115,11 @@ Benchmark mode, using \fB#\fR compression level\. . .TP \fB\-#\fR -Compression level, with # being any value from 1 to 16\. Higher values trade compression speed for compression ratio\. Values above 16 are considered the same as 16\. 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\. +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\-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\. . .TP \fB\-f\fR \fB\-\-[no\-]force\fR @@ -151,6 +155,10 @@ 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) . @@ -214,7 +222,7 @@ Benchmark multiple compression levels, from b# to e# (included) . .TP \fB\-i#\fR -Minimum evaluation in seconds [1\-9] (default : 3) +Minimum evaluation time in seconds [1\-9] (default : 3) . .SH "BUGS" Report bugs at: https://github\.com/lz4/lz4/issues |