Manpages - unzstd.1

It is possible to concatenate multiple .zst files. zstd will decompress such agglomerated file as if it was a single .zst file.

In most places where an integer argument is expected, an optional suffix is supported to easily indicate large integers. There must be no space between the integer and the suffix.

KiB

Multiply the integer by 1,024 (2^10). Ki, K, and KB are accepted as synonyms for KiB.

MiB

Multiply the integer by 1,048,576 (2^20). Mi, M, and MB are accepted as synonyms for MiB.

If multiple operation mode options are given, the last one takes effect.

-z, –compress

Compress. This is the default operation mode when no operation mode option is specified and no other operation mode is implied from the command name (for example, unzstd implies –decompress).

-d, –decompress, –uncompress

Decompress.

-t, –test

Test the integrity of compressed files. This option is equivalent to –decompress –stdout > /dev/null, decompressed data is discarded and checksummed for errors. No files are created or removed.

-b#

Benchmark file(s) using compression level #. See BENCHMARK below for a description of this operation.

–train FILES

Use FILES as a training set to create a dictionary. The training set should contain a lot of small files (> 100). See DICTIONARY BUILDER below for a description of this operation.

-l, –list

Display information related to a zstd compressed file, such as size, ratio, and checksum. Some of these fields may not be available. This command's output can be augmented with the -v modifier.

• -#: selects # compression level [1-19] (default: 3). Higher compression levels generally produce higher compression ratio at the expense of speed and memory. A rough rule of thumb is that compression speed is expected to be divided by 2 every 2 levels. Technically, each level is mapped to a set of advanced parameters (that can also be modified individually, see below). Because the compressor's behavior highly depends on the content to compress, there's no guarantee of a smooth progression from one level to another.
• –ultra: unlocks high compression levels 20+ (maximum 22), using a lot more memory. Note that decompression will also require more memory when using these levels.
• –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.
• -T#, –threads=#: Compress using # working threads (default: 1). If # is 0, attempt to detect and use the number of physical CPU cores. In all cases, the nb of threads is capped to ZSTDMT_NBWORKERS_MAX, which is either 64 in 32-bit mode, or 256 for 64-bit environments. This modifier does nothing if zstd is compiled without multithread support.
• –single-thread: Use a single thread for both I/O and compression. As compression is serialized with I/O, this can be slightly slower. Single-thread mode features significantly lower memory usage, which can be useful for systems with limited amount of memory, such as 32-bit systems. Note 1: this mode is the only available one when multithread support is disabled. Note 2: this mode is different from -T1, which spawns 1 compression thread in parallel with I/O. Final compressed result is also slightly different from -T1.
• –auto-threads={physical,logical} (default: physical): When using a default amount of threads via -T0, choose the default based on the number of detected physical or logical cores.
• –adapt[=min=#,max=#]: zstd will dynamically adapt compression level to perceived I/O conditions. Compression level adaptation can be observed live by using command -v. Adaptation can be constrained between supplied min and max levels. The feature works when combined with multi-threading and –long mode. It does not work with –single-thread. It sets window size to 8 MiB by default (can be changed manually, see wlog). 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).
• –long[=#]: enables long distance matching with # windowLog, if # is not present it defaults to 27. This increases the window size (windowLog) and memory usage for both the compressor and decompressor. This setting is designed to improve the compression ratio for files with long matches at a large distance. Note: If windowLog is set to larger than 27, –long=windowLog or –memory=windowSize needs to be passed to the decompressor.
• -D DICT: use DICT as Dictionary to compress or decompress FILE(s)
• –patch-from FILE: Specify the file to be used as a reference point for zstd's diff engine. This is effectively dictionary compression with some convenient parameter selection, namely that windowSize > srcSize. Note: cannot use both this and -D together. Note: –long mode will be automatically activated if chainLog < fileLog (fileLog being the windowLog required to cover the whole file). You can also manually force it. Note: for all levels, you can use –patch-from in –single-thread mode to improve compression ratio at the cost of speed. Note: for level 19, you can get increased compression ratio at the cost of speed by specifying –zstd=targetLength= to be something large (i.e. 4096), and by setting a large –zstd=chainLog=.
• –rsyncable: zstd will periodically synchronize the compression state to make the compressed file more rsync-friendly. There is a negligible impact to compression ratio, and a potential impact to compression speed, perceptible at higher speeds, for example when combining –rsyncable with many parallel worker threads. 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 the synchronization points, but your mileage may vary.
• -C, –[no-]check: add integrity check computed from uncompressed data (default: enabled)
• –[no-]content-size: enable / disable whether or not the original size of the file is placed in the header of the compressed file. The default option is –content-size (meaning that the original size will be placed in the header).
• –no-dictID: do not store dictionary ID within frame header (dictionary compression). The decoder will have to rely on implicit knowledge about which dictionary to use, it won't be able to check if it's correct.
• -M#, –memory=#: Set a memory usage limit. By default, zstd uses 128 MiB for decompression as the maximum amount of memory the decompressor is allowed to use, but you can override this manually if need be in either direction (i.e. you can increase or decrease it). This is also used during compression when using with –patch-from=. In this case, this parameter overrides that maximum size allowed for a dictionary. (128 MiB). Additionally, this can be used to limit memory for dictionary training. This parameter overrides the default limit of 2 GiB. zstd will load training samples up to the memory limit and ignore the rest.
• –stream-size=#: Sets the pledged source size of input coming from a stream. This value must be exact, as it will be included in the produced frame header. Incorrect stream sizes will cause an error. This information will be used to better optimize compression parameters, resulting in better and potentially faster compression, especially for smaller source sizes.
• –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.
• –target-compressed-block-size=#: Attempt to produce compressed blocks of approximately this size. This will split larger blocks in order to approach this target. This feature is notably useful for improved latency, when the receiver can leverage receiving early incomplete data. This parameter defines a loose target: compressed blocks will target this size "on average", but individual blocks can still be larger or smaller. Enabling this feature can decrease compression speed by up to ~10% at level 1. Higher levels will see smaller relative speed regression, becoming invisible at higher settings.
• -f, –force: disable input and output checks. Allows overwriting existing files, input from console, output to stdout, operating on links, block devices, etc. During decompression and when the output destination is stdout, pass-through unrecognized formats as-is.
• -c, –stdout: write to standard output (even if it is the console); keep original files (disable –rm).
• -o FILE: save result into FILE. Note that this operation is in conflict with -c. If both operations are present on the command line, the last expressed one wins.
• –[no-]sparse: enable / disable sparse FS support, to make files with many zeroes smaller on disk. Creating sparse files may save disk space and speed up decompression by reducing the amount of disk I/O. default: enabled when output is into a file, and disabled when output is stdout. This setting overrides default and can force sparse mode over stdout.
• –[no-]pass-through enable / disable passing through uncompressed files as-is. During decompression when pass-through is enabled, unrecognized formats will be copied as-is from the input to the output. By default, pass-through will occur when the output destination is stdout and the force (-f) option is set.
• –rm: remove source file(s) after successful compression or decompression. This command is silently ignored if output is stdout. If used in combination with -o, triggers a confirmation prompt (which can be silenced with -f), as this is a destructive operation.
• -k, –keep: keep source file(s) after successful compression or decompression. This is the default behavior.
• -r: operate recursively on directories. It selects all files in the named directory and all its subdirectories. This can be useful both to reduce command line typing, and to circumvent shell expansion limitations, when there are a lot of files and naming breaks the maximum size of a command line.
• –filelist FILE read a list of files to process as content from FILE. Format is compatible with ls output, with one file per line.
• –output-dir-flat DIR: resulting files are stored into target DIR directory, instead of same directory as origin file. Be aware that this command can introduce name collision issues, if multiple files, from different directories, end up having the same name. Collision resolution ensures first file with a given name will be present in DIR, while in combination with -f, the last file will be present instead.
• –output-dir-mirror DIR: similar to –output-dir-flat, the output files are stored underneath target DIR directory, but this option will replicate input directory hierarchy into output DIR. If input directory contains "..", the files in this directory will be ignored. If input directory is an absolute directory (i.e. "/var/tmp/abc"), it will be stored into the "output-dir/var/tmp/abc". If there are multiple input files or directories, name collision resolution will follow the same rules as –output-dir-flat.
• –format=FORMAT: compress and decompress in other formats. If compiled with support, zstd can compress to or decompress from other compression algorithm formats. Possibly available options are zstd, gzip, xz, lzma, and lz4. If no such format is provided, zstd is the default.
• -h*/-H*, –help: display help/long help and exit
• -V, –version: display version number and immediately exit. note that, since it exits, flags specified after -V are effectively ignored. Advanced: -vV also displays supported formats. -vvV also displays POSIX support. -qV will only display the version number, suitable for machine reading.
• -v, –verbose: verbose mode, display more information
• -q, –quiet: suppress warnings, interactivity, and notifications. specify twice to suppress errors too.
• –no-progress: do not display the progress bar, but keep all other messages.
• –show-default-cparams: shows the default compression parameters that will be used for a particular input file, based on the provided compression level and the input size. If the provided file is not a regular file (e.g. a pipe), this flag will output the parameters used for inputs of unknown size.
• –exclude-compressed: only compress files that are not already compressed.
• –: All arguments after – are treated as files
• ::

When invoked via a gzip symlink, zstd will support further options that intend to mimic the gzip behavior:

-n, –no-name

do not store the original filename and timestamps when compressing a file. This is the default behavior and hence a no-op.

–best

alias to the option -9.

Employing environment variables to set parameters has security implications. Therefore, this avenue is intentionally limited. Only ZSTD_CLEVEL and ZSTD_NBTHREADS are currently supported. They set the default compression level and number of threads to use during compression, respectively.

ZSTD_CLEVEL can be used to set the level between 1 and 19 (the "normal" range). If the value of ZSTD_CLEVEL is not a valid integer, it will be ignored with a warning message. ZSTD_CLEVEL just replaces the default compression level (3).

ZSTD_NBTHREADS can be used to set the number of threads zstd will attempt to use during compression. If the value of ZSTD_NBTHREADS is not a valid unsigned integer, it will be ignored with a warning message. ZSTD_NBTHREADS has a default value of (1), and is capped at ZSTDMT_NBWORKERS_MAX==200. zstd must be compiled with multithread support for this variable to have any effect.

They can both be overridden by corresponding command line arguments: -# for compression level and -T# for number of compression threads.

The options are provided as a comma-separated list. You may specify only the options you want to change and the rest will be taken from the selected or default compression level. The list of available options:

*strategy*=/strat/, *strat*=/strat/

Specify a strategy used by a match finder. There are 9 strategies numbered from 1 to 9, from fastest to strongest: 1=*ZSTD_fast*, 2=*ZSTD_dfast*, 3=*ZSTD_greedy*, 4=*ZSTD_lazy*, 5=*ZSTD_lazy2*, 6=*ZSTD_btlazy2*, 7=*ZSTD_btopt*, 8=*ZSTD_btultra*, 9=*ZSTD_btultra2*.

*windowLog*=/wlog/, *wlog*=/wlog/

Specify the maximum number of bits for a match distance. The higher number of increases the chance to find a match which usually improves compression ratio. It also increases memory requirements for the compressor and decompressor. The minimum wlog is 10 (1 KiB) and the maximum is 30 (1 GiB) on 32-bit platforms and 31 (2 GiB) on 64-bit platforms. Note: If windowLog is set to larger than 27, –long=windowLog or –memory=windowSize needs to be passed to the decompressor.

*hashLog*=/hlog/, *hlog*=/hlog/

Specify the maximum number of bits for a hash table. Bigger hash tables cause fewer collisions which usually makes compression faster, but requires more memory during compression. The minimum hlog is 6 (64 entries / 256 B) and the maximum is 30 (1B entries / 4 GiB).

*chainLog*=/clog/, *clog*=/clog/

Specify the maximum number of bits for the secondary search structure, whose form depends on the selected strategy. Higher numbers of bits increases the chance to find a match which usually improves compression ratio. It also slows down compression speed and increases memory requirements for compression. This option is ignored for the ZSTD_fast strategy, which only has the primary hash table. The minimum clog is 6 (64 entries / 256 B) and the maximum is 29 (512M entries / 2 GiB) on 32-bit platforms and 30 (1B entries / 4 GiB) on 64-bit platforms.

*searchLog*=/slog/, *slog*=/slog/

Specify the maximum number of searches in a hash chain or a binary tree using logarithmic scale. More searches increases the chance to find a match which usually increases compression ratio but decreases compression speed. The minimum slog is 1 and the maximum is 'windowLog' - 1.

*minMatch*=/mml/, *mml*=/mml/

Specify the minimum searched length of a match in a hash table. Larger search lengths usually decrease compression ratio but improve decompression speed. The minimum mml is 3 and the maximum is 7.

*targetLength*=/tlen/, *tlen*=/tlen/

The impact of this field vary depending on selected strategy. For ZSTD_btopt, ZSTD_btultra and ZSTD_btultra2, it specifies the minimum match length that causes match finder to stop searching. A larger targetLength usually improves compression ratio but decreases compression speed. For ZSTD_fast, it triggers ultra-fast mode when > 0. The value represents the amount of data skipped between match sampling. Impact is reversed: a larger targetLength increases compression speed but decreases compression ratio. For all other strategies, this field has no impact. The minimum tlen is 0 and the maximum is 128 KiB.

*overlapLog*=/ovlog/, *ovlog*=/ovlog/

Determine overlapSize, amount of data reloaded from previous job. This parameter is only available when multithreading is enabled. Reloading more data improves compression ratio, but decreases speed. The minimum ovlog is 0, and the maximum is 9. 1 means "no overlap", hence completely independent jobs. 9 means "full overlap", meaning up to windowSize is reloaded from previous job. Reducing ovlog by 1 reduces the reloaded amount by a factor 2. For example, 8 means "windowSize/2", and 6 means "windowSize/8". Value 0 is special and means "default": ovlog is automatically determined by zstd. In which case, ovlog will range from 6 to 9, depending on selected strat.

*ldmHashLog*=/lhlog/, *lhlog*=/lhlog/

Specify the maximum size for a hash table used for long distance matching. This option is ignored unless long distance matching is enabled. Bigger hash tables usually improve compression ratio at the expense of more memory during compression and a decrease in compression speed. The minimum lhlog is 6 and the maximum is 30 (default: 20).

*ldmMinMatch*=/lmml/, *lmml*=/lmml/

Specify the minimum searched length of a match for long distance matching. This option is ignored unless long distance matching is enabled. Larger/very small values usually decrease compression ratio. The minimum lmml is 4 and the maximum is 4096 (default: 64).

*ldmBucketSizeLog*=/lblog/, *lblog*=/lblog/

Specify the size of each bucket for the hash table used for long distance matching. This option is ignored unless long distance matching is enabled. Larger bucket sizes improve collision resolution but decrease compression speed. The minimum lblog is 1 and the maximum is 8 (default: 3).

*ldmHashRateLog*=/lhrlog/, *lhrlog*=/lhrlog/

Specify the frequency of inserting entries into the long distance matching hash table. This option is ignored unless long distance matching is enabled. Larger values will improve compression speed. Deviating far from the default value will likely result in a decrease in compression ratio. The default value is wlog - lhlog.

The following parameters sets advanced compression options to something similar to predefined level 19 for files bigger than 256 KB:

*–zstd*=wlog=23,clog=23,hlog=22,slog=6,mml=3,tlen=48,strat=6

Specify the size of each compression job. This parameter is only available when multi-threading is enabled. Each compression job is run in parallel, so this value indirectly impacts the nb of active threads. Default job size varies depending on compression level (generally 4 * windowSize). -B# makes it possible to manually select a custom size. Note that job size must respect a minimum value which is enforced transparently. This minimum is either 512 KB, or overlapSize, whichever is largest. Different job sizes will lead to non-identical compressed frames.