Lines Matching +full:- +full:- +full:with +full:- +full:zstd
6 - `zstd` : default CLI supporting gzip-like arguments; includes dictionary builder, benchmark, and …
7 - `zstd_nolegacy` : Same as `zstd` but without support for legacy zstd formats
8 - `zstd-small` : CLI optimized for minimal size; no dictionary builder, no benchmark, and no suppor…
9 - `zstd-compress` : version of CLI which can only compress into zstd format
10 - `zstd-decompress` : version of CLI which can only decompress zstd format
14 `zstd` scope can be altered by modifying the following `make` variables :
16 - __HAVE_THREAD__ : multithreading is automatically enabled when `pthread` is detected.
18 Example : `make zstd HAVE_THREAD=0`
23 - __ZSTD_LEGACY_SUPPORT__ : `zstd` can decompress files compressed by older versions of `zstd`.
24 …Starting v0.8.0, all versions of `zstd` produce frames compliant with the [specification](../doc/z…
26 By default, `zstd` supports decoding legacy formats >= v0.4.0 (`ZSTD_LEGACY_SUPPORT=4`).
32 Note : `zstd` only supports decoding older formats, and cannot generate any legacy format.
34 - __HAVE_ZLIB__ : `zstd` can compress and decompress files in `.gz` format.
35 This is ordered through command `--format=gzip`.
39 Example : `make zstd HAVE_ZLIB=0`
40 It's also possible to force compilation with zlib support, using `HAVE_ZLIB=1`.
44 - __HAVE_LZMA__ : `zstd` can compress and decompress files in `.xz` and `.lzma` formats.
45 This is ordered through commands `--format=xz` and `--format=lzma` respectively.
49 Example : `make zstd HAVE_LZMA=0`
50 It's also possible to force compilation with lzma support, using `HAVE_LZMA=1`.
54 - __HAVE_LZ4__ : `zstd` can compress and decompress files in `.lz4` formats.
55 This is ordered through commands `--format=lz4`.
59 Example : `make zstd HAVE_LZ4=0`
60 It's also possible to force compilation with lz4 support, using `HAVE_LZ4=1`.
64 - __ZSTD_NOBENCH__ : `zstd` cli will be compiled without its integrated benchmark module.
68 - __ZSTD_NODICT__ : `zstd` cli will be compiled without support for the integrated dictionary build…
72 - __ZSTD_NOCOMPRESS__ : `zstd` cli will be compiled without support for compression.
75 A corresponding `Makefile` target using this ability is `zstd-decompress`.
77 - __ZSTD_NODECOMPRESS__ : `zstd` cli will be compiled without support for decompression.
80 A corresponding `Makefile` target using this ability is `zstd-compress`.
82 - __BACKTRACE__ : `zstd` can display a stack backtrace when execution
87 Example : `make zstd BACKTRACE=1`
91 CLI supports aggregation of parameters i.e. `-b1`, `-e18`, and `-i1` can be joined into `-b1e18i1`.
95 It's possible to invoke `zstd` through a symlink.
97 - `zstdmt` : compress using all cores available on local system.
98 - `zcat` : will decompress and output target file using any of the supported formats. `gzcat` and `…
99 - `gzip` : if zlib support is enabled, will mimic `gzip` by compressing file using `.gz` format, re…
100 - `xz` : if lzma support is enabled, will mimic `xz` by compressing file using `.xz` format, removi…
101 - `lzma` : if lzma support is enabled, will mimic `lzma` by compressing file using `.lzma` format, …
102 - `lz4` : if lz4 support is enabled, will mimic `lz4` by compressing file using `.lz4` format. If l…
103 - `unzstd` and `unlz4` will decompress any of the supported format.
104 - `ungz`, `unxz` and `unlzma` will do the same, and will also remove source file by default (use `-…
108 Zstd offers a training mode, which can be used to tune the algorithm for a selected
109 type of data, by providing it with a few samples. The result of the training is stored
110 in a file selected with the `-o` option (default name is `dictionary`),
120 Usage of the dictionary builder and created dictionaries with CLI:
122 1. Create the dictionary : `zstd --train PathToTrainingSet/* -o dictionaryName`
123 2. Compress with the dictionary: `zstd FILE -D dictionaryName`
124 3. Decompress with the dictionary: `zstd --decompress FILE.zst -D dictionaryName`
128 CLI includes in-memory compression benchmark module for zstd.
131 Multiple filenames can be supplied, as multiple parameters, with wildcards,
132 or directory names can be used with `-r` option.
136 One can select compression levels starting from `-b` and ending with `-e`.
137 The `-i` parameter selects minimal time used for each of tested levels.
140 such as number of threads (`-T#`), or advanced parameters (`--zstd=#`), or dictionary compression (…
145 The full list of options can be obtained with `-h` or `-H` parameter:
147 *** Zstandard CLI (64-bit) v1.5.6, by Yann Collet ***
149 Compress or decompress the INPUT file(s); reads from STDIN if INPUT is `-` or not provided.
151 Usage: zstd [OPTIONS...] [INPUT... | -] [-o OUTPUT]
154 -o OUTPUT Write output to a single file, OUTPUT.
155 -k, --keep Preserve INPUT file(s). [Default]
156 --rm Remove INPUT file(s) after successful (de)compression.
158 -# Desired compression level, where `#` is a number between 1 and 19;
162 -d, --decompress Perform decompression.
163 -D DICT Use DICT as the dictionary for compression or decompression.
165 -f, --force Disable input and output checks. Allows overwriting existing files,
168 passed-through through as-is.
170 -h Display short usage and exit.
171 -H, --help Display full help and exit.
172 -V, --version Display the program version and exit.
175 …-c, --stdout Write to STDOUT (even if it is a console) and keep the INPUT file(s).
177 -v, --verbose Enable verbose output; pass multiple times to increase verbosity.
178 -q, --quiet Suppress warnings; pass twice to suppress errors.
179 --trace LOG Log tracing information to LOG.
181 --[no-]progress Forcibly show/hide the progress counter. NOTE: Any (de)compressed
182 output to terminal will mix with progress counter text.
184 -r Operate recursively on directories.
185 --filelist LIST Read a list of files to operate on from LIST.
186 --output-dir-flat DIR Store processed files in DIR.
187 …--output-dir-mirror DIR Store processed files in DIR, respecting original directory structur…
188 --[no-]asyncio Use asynchronous IO. [Default: Enabled]
190 …--[no-]check Add XXH64 integrity checksums during compression. [Default: Add, Val…
191 If `-d` is present, ignore/validate checksums during decompression.
193 -- Treat remaining arguments after `--` as files.
196 --ultra Enable levels beyond 19, up to 22; requires more memory.
197 --fast[=#] Use to very fast compression levels. [Default: 1]
198 --adapt Dynamically adapt compression level to I/O conditions.
199 --long[=#] Enable long distance matching with window log #. [Default: 27]
200 --patch-from=REF Use REF as the reference point for Zstandard's diff engine.
202 -T# Spawn # compression threads. [Default: 1; pass 0 for core count.]
203 …--single-thread Share a single thread for I/O and compression (slightly different th…
204 --auto-threads={physical|logical}
205 Use physical/logical cores when using `-T0`. [Default: Physical]
207 -B# Set job size to #. [Default: 0 (automatic)]
208 --rsyncable Compress using a rsync-friendly method (`-B` sets block size).
210 --exclude-compressed Only compress files that are not already compressed.
212 --stream-size=# Specify size of streaming input from STDIN.
213 …--size-hint=# Optimize compression parameters for streaming input of approximately…
214 --target-compressed-block-size=#
217 --no-dictID Don't write `dictID` into the header (dictionary compression only).
218 --[no-]compress-literals Force (un)compressed literals.
219 --[no-]row-match-finder Explicitly enable/disable the fast, row-based matchfinder for
222 --format=zstd Compress files to the `.zst` format. [Default]
223 …--[no-]mmap-dict Memory-map dictionary file rather than mallocing and loading all at …
224 --format=gzip Compress files to the `.gz` format.
225 --format=xz Compress files to the `.xz` format.
226 --format=lzma Compress files to the `.lzma` format.
227 --format=lz4 Compress files to the `.lz4` format.
230 -l Print information about Zstandard-compressed files.
231 --test Test compressed file integrity.
232 -M# Set the memory usage limit to # megabytes.
233 …--[no-]sparse Enable sparse mode. [Default: Enabled for files, disabled for STDOUT…
234 --[no-]pass-through Pass through uncompressed files as-is. [Default: Disabled]
237 --train Create a dictionary from a training set of files.
239 --train-cover[=k=#,d=#,steps=#,split=#,shrink[=#]]
240 Use the cover algorithm (with optional arguments).
241 --train-fastcover[=k=#,d=#,f=#,steps=#,split=#,accel=#,shrink[=#]]
242 Use the fast cover algorithm (with optional arguments).
244 --train-legacy[=s=#] Use the legacy algorithm with selectivity #. [Default: 9]
245 -o NAME Use NAME as dictionary name. [Default: dictionary]
246 --maxdict=# Limit dictionary to specified size #. [Default: 112640]
247 --dictID=# Force dictionary ID to #. [Default: Random]
250 -b# Perform benchmarking with compression level #. [Default: 3]
251 …-e# Test all compression levels up to #; starting level is `-b#`. [Defau…
252 -i# Set the minimum evaluation to time # seconds. [Default: 3]
253 -B# Cut file into independent chunks of size #. [Default: No chunking]
254 …-S Output one benchmark result per input file. [Default: Consolidated r…
255 -D dictionary Benchmark using dictionary
256 --priority=rt Set process priority to real-time.
260 There is no "generic" way to pass "any kind of parameter" to `zstd` in a pass-through manner.
264 `ZSTD_CLEVEL` can be used to modify the default compression level of `zstd`
268 that `zstd` will use for compression, which by default is `1`.
269 This functionality only exists when `zstd` is compiled with multithread support.
272 which is either 64 in 32-bit mode, or 256 for 64-bit environments.
274 This functionality can be useful when `zstd` CLI is invoked in a way that doesn't allow passing arg…
275 One such scenario is `tar --zstd`.
278 `-#` for compression level and `-T#` for number of threads.
282 The long distance matching mode, enabled with `--long`, is designed to improve
283 the compression ratio for files with long matches at a large distance (up to the
293 decompression speed with and without long distance matching on an ideal use
295 `3.5.1`) with a total size of `244889600 B`. This is an ideal use case as there
300 ---------------------------|---------------------
301 …cebook/zstd/v1.3.3/doc/images/ldmCspeed.png "Compression Speed vs Ratio") | ![Decompression Speed]…
304 |:-------|------------------:|-------------------------:|---------------------------:|
305 | `zstd -1` | `5.065` | `284.8 MB/s` | `759.3 MB/s` |
306 | `zstd -5` | `5.826` | `124.9 MB/s` | `674.0 MB/s` |
307 | `zstd -10` | `6.504` | `29.5 MB/s` | `771.3 MB/s` |
308 | `zstd -1 --long` | `17.426` | `220.6 MB/s` | `1638.4 MB/s` |
309 | `zstd -5 --long` | `19.661` | `165.5 MB/s` | `1530.6 MB/s` |
310 | `zstd -10 --long`| `21.949` | `75.6 MB/s` | `1632.6 MB/s` |
312 On this file, the compression ratio improves significantly with minimal impact
315 On the other extreme, compressing a file with few long distance matches (such as
317 compression speed (for lower levels) with minimal change in compression ratio.
324 |:-------|------------------:|------------------:|---------------------:|
325 | `zstd -1` | `2.878` | `231.7 MB/s` | `594.4 MB/s` |
326 | `zstd -1 --long` | `2.929` | `106.5 MB/s` | `517.9 MB/s` |
327 | `zstd -5` | `3.274` | `77.1 MB/s` | `464.2 MB/s` |
328 | `zstd -5 --long` | `3.319` | `51.7 MB/s` | `371.9 MB/s` |
329 | `zstd -10` | `3.523` | `16.4 MB/s` | `489.2 MB/s` |
330 | `zstd -10 --long`| `3.566` | `16.2 MB/s` | `415.7 MB/s` |
339 `zstdgrep` is _not_ compatible with dictionary compression.
341 To search into a file compressed with a dictionary,
342 it's necessary to decompress it using `zstd` or `zstdcat`,
344 `zstdcat -D dictionary -qc -- file.zst | grep pattern`