From 05d7479a505584563c521822ae353d3f256c3bb8 Mon Sep 17 00:00:00 2001 From: Nick Magerko Date: Tue, 20 Aug 2019 14:08:26 -0700 Subject: [PATCH] Document --size-hint --- programs/zstd.1.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/programs/zstd.1.md b/programs/zstd.1.md index 3ab2667a..f8349fa8 100644 --- a/programs/zstd.1.md +++ b/programs/zstd.1.md @@ -144,6 +144,13 @@ the last one takes effect. Due to the chaotic nature of dynamic adaptation, compressed result is not reproducible. _note_ : at the time of this writing, `--adapt` can remain stuck at low speed when combined with multiple worker threads (>=2). +* `--size-hint=#`: + When handling input from a stream, `zstd` must guess how large the source size + will be when optimizing compression parameters. If the stream size is relatively + small, this guess may be a poor one, resulting in a higher compression ratio than + expected. This feature allows for controlling the guess when needed. + Exact guesses result in better compression ratios. Overestimates result in slightly + degraded compression ratios, while underestimates may result in significant degradation. * `--rsyncable` : `zstd` will periodically synchronize the compression state to make the compressed file more rsync-friendly. There is a negligible impact to