ddidderr/zstd-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor documentation update

Browse Source
This commit is contained in:
Nick Magerko
2019-08-22 09:13:28 -07:00
parent b3540507f5
commit 2cdda8b3c4
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
programs/zstd.1.md
+5 -6
View File
@@ -144,6 +144,11 @@ the last one takes effect.
Due to the chaotic nature of dynamic adaptation, compressed result is not reproducible. 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 _note_ : at the time of this writing, `--adapt` can remain stuck at low speed
when combined with multiple worker threads (>=2). when combined with multiple worker threads (>=2).
* `--stream-size=#` :
When handling input from a stream, `zstd` must guess how large the source size
will be when optimizing compression parameters. This option sets the pledged source
size of a stream to eliminate that guesswork. Note that the pledged size must be exact;
incorrect stream sizes will cause an error.
* `--rsyncable` : * `--rsyncable` :
`zstd` will periodically synchronize the compression state to make the `zstd` will periodically synchronize the compression state to make the
compressed file more rsync-friendly. There is a negligible impact to compressed file more rsync-friendly. There is a negligible impact to
@@ -152,12 +157,6 @@ the last one takes effect.
This feature does not work with `--single-thread`. You probably don't want This feature does not work with `--single-thread`. You probably don't want
to use it with long range mode, since it will decrease the effectiveness of to use it with long range mode, since it will decrease the effectiveness of
the synchronization points, but your milage may vary. the synchronization points, but your milage may vary.
* `--stream-size` :
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 will set the source size of a stream. Note that it must
be exact; incorrect stream sizes will cause an error.
* `-D file`: * `-D file`:
use `file` as Dictionary to compress or decompress FILE(s) use `file` as Dictionary to compress or decompress FILE(s)
* `--no-dictID`: * `--no-dictID`: