diff options
author | Yann Collet <cyan@fb.com> | 2018-09-05 21:05:08 (GMT) |
---|---|---|
committer | Yann Collet <cyan@fb.com> | 2018-09-05 21:05:08 (GMT) |
commit | 0fea528e3a70f8578ca6e7f15d922dab8aa9ff25 (patch) | |
tree | 75d8c00fc7fa2857a49d5d5c2466e33586ba7afc /programs/lz4.1.md | |
parent | c4dbc37b3ce085a05441124fee4a8144dc149b05 (diff) | |
download | lz4-0fea528e3a70f8578ca6e7f15d922dab8aa9ff25.zip lz4-0fea528e3a70f8578ca6e7f15d922dab8aa9ff25.tar.gz lz4-0fea528e3a70f8578ca6e7f15d922dab8aa9ff25.tar.bz2 |
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.md')
-rw-r--r-- | programs/lz4.1.md | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/programs/lz4.1.md b/programs/lz4.1.md index d4eaf8a..12b8e29 100644 --- a/programs/lz4.1.md +++ b/programs/lz4.1.md @@ -125,6 +125,19 @@ only the latest one will be applied. Speed/compression trade-off will vary depending on data to compress. Decompression speed remains fast at all settings. +* `--fast[=#]`: + 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. + +* `-D dictionaryName`: + Compress, decompress or benchmark using dictionary _dictionaryName_. + 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. + * `-f` `--[no-]force`: This option has several effects: @@ -156,13 +169,6 @@ only the latest one will be applied. * `-BD`: Block Dependency (improves compression ratio on small blocks) -* `--fast[=#]`: - switch to ultra-fast compression levels. - If `=#` is not present, it defaults to `1`. - 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 `--fast`, it overrides it. - * `--[no-]frame-crc`: Select frame checksum (default:enabled) |