Created
August 8, 2022 09:38
-
-
Save Jaid/0fd009c7ce240148569b8917f3b20fff to your computer and use it in GitHub Desktop.
zstd CLI documentation (--help option)
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
*** zstd command line interface 64-bits v1.5.2, by Yann Collet *** | |
Usage : | |
zstd [args] [FILE(s)] [-o file] | |
FILE : a filename | |
with no FILE, or when FILE is - , read standard input | |
Arguments : | |
-# : # compression level (1-19, default: 3) | |
-d : decompression | |
-D DICT: use DICT as Dictionary for compression or decompression | |
-o file: result stored into `file` (only 1 output file) | |
-f : disable input and output checks. Allows overwriting existing files, | |
input from console, output to stdout, operating on links, | |
block devices, etc. | |
--rm : remove source file(s) after successful de/compression | |
-k : preserve source file(s) (default) | |
-h/-H : display help/long help and exit | |
Advanced arguments : | |
-V : display Version number and exit | |
-c : write to standard output (even if it is the console) | |
-v : verbose mode; specify multiple times to increase verbosity | |
-q : suppress warnings; specify twice to suppress errors too | |
--[no-]progress : forcibly display, or never display the progress counter. | |
note: any (de)compressed output to terminal will mix with progress counter text. | |
-r : operate recursively on directories | |
--filelist FILE : read list of files to operate upon from FILE | |
--output-dir-flat DIR : processed files are stored into DIR | |
--output-dir-mirror DIR : processed files are stored into DIR respecting original directory structure | |
--[no-]check : during compression, add XXH64 integrity checksum to frame (default: enabled). If specified with -d, decompressor will ignore/validate checksums in compressed frame (default: validate). | |
--trace FILE : log tracing information to FILE. | |
-- : All arguments after "--" are treated as files | |
Advanced compression arguments : | |
--ultra : enable levels beyond 19, up to 22 (requires more memory) | |
--long[=#]: enable long distance matching with given window log (default: 27) | |
--fast[=#]: switch to very fast compression levels (default: 1) | |
--adapt : dynamically adapt compression level to I/O conditions | |
--[no-]row-match-finder : force enable/disable usage of fast row-based matchfinder for greedy, lazy, and lazy2 strategies | |
--patch-from=FILE : specify the file to be used as a reference point for zstd's diff engine. | |
-T# : spawns # compression threads (default: 1, 0==# cores) | |
-B# : select size of each job (default: 0==automatic) | |
--single-thread : use a single thread for both I/O and compression (result slightly different than -T1) | |
--auto-threads={physical,logical} (default: physical} : use either physical cores or logical cores as default when specifying -T0 | |
--rsyncable : compress using a rsync-friendly method (-B sets block size) | |
--exclude-compressed: only compress files that are not already compressed | |
--stream-size=# : specify size of streaming input from `stdin` | |
--size-hint=# optimize compression parameters for streaming input of approximately this size | |
--target-compressed-block-size=# : generate compressed block of approximately targeted size | |
--no-dictID : don't write dictID into header (dictionary compression only) | |
--[no-]compress-literals : force (un)compressed literals | |
--format=zstd : compress files to the .zst format (default) | |
--format=gzip : compress files to the .gz format | |
Advanced decompression arguments : | |
-l : print information about zstd compressed files | |
--test : test compressed file integrity | |
-M# : Set a memory usage limit for decompression | |
--[no-]sparse : sparse mode (default: enabled on file, disabled on stdout) | |
Dictionary builder : | |
--train ## : create a dictionary from a training set of files | |
--train-cover[=k=#,d=#,steps=#,split=#,shrink[=#]] : use the cover algorithm with optional args | |
--train-fastcover[=k=#,d=#,f=#,steps=#,split=#,accel=#,shrink[=#]] : use the fast cover algorithm with optional args | |
--train-legacy[=s=#] : use the legacy algorithm with selectivity (default: 9) | |
-o DICT : DICT is dictionary name (default: dictionary) | |
--maxdict=# : limit dictionary to specified size (default: 112640) | |
--dictID=# : force dictionary ID to specified value (default: random) | |
Benchmark arguments : | |
-b# : benchmark file(s), using # compression level (default: 3) | |
-e# : test all compression levels successively from -b# to -e# (default: 1) | |
-i# : minimum evaluation time in seconds (default: 3s) | |
-B# : cut file into independent blocks of size # (default: no block) | |
-S : output one benchmark result per input file (default: consolidated result) | |
--priority=rt : set process priority to real-time |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment