Lines Matching +full:- +full:- +full:with +full:- +full:zstd

1 .TH "ZSTD" "1" "October 2024" "zstd 1.5.6" "User Commands"
3 \fBzstd\fR \- zstd, zstdmt, unzstd, zstdcat \- Compress or decompress \.zst files
7 \fBzstd\fR [\fIOPTIONS\fR] [\-	\fIINPUT\-FILE\fR] [\-o \fIOUTPUT\-FILE\fR]
10 \fBzstdmt\fR is equivalent to \fBzstd \-T0\fR
12 \fBunzstd\fR is equivalent to \fBzstd \-d\fR
14 \fBzstdcat\fR is equivalent to \fBzstd \-dcf\fR
16 …zstd\fR is a fast lossless compression algorithm and data compression tool, with command line synt…
18 \fBzstd\fR command line syntax is generally similar to gzip, but features the following few differe…
20 …eserved by default\. It's possible to remove them automatically by using the \fB\-\-rm\fR command\.
22 When compressing a single file, \fBzstd\fR displays progress notifications and result summary by de…
24 \fBzstd\fR displays a short help page when command line is an error\. Use \fB\-q\fR to turn it off\.
26 \fBzstd\fR does not accept input from console, though it does accept \fBstdin\fR when it's not the …
28 \fBzstd\fR does not store the input's filename or attributes, only its contents\.
31 …zstd\fR processes each \fIfile\fR according to the selected operation mode\. If no \fIfiles\fR are…
33 Unless \fB\-\-stdout\fR or \fB\-o\fR is specified, \fIfiles\fR are written to a new file whose name…
39 .SS "Concatenation with \.zst Files"
40 It is possible to concatenate multiple \fB\.zst\fR files\. \fBzstd\fR will decompress such agglomer…
53 \fB\-z\fR, \fB\-\-compress\fR
54 …on mode is implied from the command name (for example, \fBunzstd\fR implies \fB\-\-decompress\fR)\.
56 \fB\-d\fR, \fB\-\-decompress\fR, \fB\-\-uncompress\fR
59 \fB\-t\fR, \fB\-\-test\fR
60 Test the integrity of compressed \fIfiles\fR\. This option is equivalent to \fB\-\-decompress \-\-s…
62 \fB\-b#\fR
65 \fB\-\-train FILES\fR
68 \fB\-l\fR, \fB\-\-list\fR
69 …zstd compressed file, such as size, ratio, and checksum\. Some of these fields may not be availabl…
72 \fB\-#\fR: selects \fB#\fR compression level [1\-19] (default: 3)\. Higher compression levels \fIge…
74 \fB\-\-ultra\fR: unlocks high compression levels 20+ (maximum 22), using a lot more memory\. Note t…
76 …-\-fast[=#]\fR: switch to ultra\-fast compression levels\. If \fB=#\fR is not present, it defaults…
78 …-T#\fR, \fB\-\-threads=#\fR: Compress using \fB#\fR working threads (default: 1)\. If \fB#\fR is 0…
80 …-\-single\-thread\fR: Use a single thread for both I/O and compression\. As compression is seriali…
84 …ent from \fB\-T1\fR, which spawns 1 compression thread in parallel with I/O\. Final compressed res…
86 \fB\-\-auto\-threads={physical,logical} (default: physical)\fR: When using a default amount of thre…
88 …-\-adapt[=min=#,max=#]\fR: \fBzstd\fR will dynamically adapt compression level to perceived I/O co…
90 \fINote\fR: at the time of this writing, \fB\-\-adapt\fR can remain stuck at low speed when combine…
92 …-\-long[=#]\fR: enables long distance matching with \fB#\fR \fBwindowLog\fR, if \fB#\fR is not pre…
94 Note: If \fBwindowLog\fR is set to larger than 27, \fB\-\-long=windowLog\fR or \fB\-\-memory=window…
96 \fB\-D DICT\fR: use \fBDICT\fR as Dictionary to compress or decompress FILE(s)
98 \fB\-\-patch\-from FILE\fR: Specify the file to be used as a reference point for zstd's diff engine…
100 Note: cannot use both this and \fB\-D\fR together\.
102 Note: \fB\-\-long\fR mode will be automatically activated if \fIchainLog\fR < \fIfileLog\fR (\fIfil…
104 …n use \fB\-\-patch\-from\fR in \fB\-\-single\-thread\fR mode to improve compression ratio marginal…
106 … of speed by specifying \fB\-\-zstd=targetLength=\fR to be something large (i\.e\. 4096), and by s…
108 …-\-rsyncable\fR: \fBzstd\fR will periodically synchronize the compression state to make the compre…
110 \fB\-C\fR, \fB\-\-[no\-]check\fR: add integrity check computed from uncompressed data (default: ena…
112 …-\-[no\-]content\-size\fR: enable / disable whether or not the original size of the file is placed…
114 \fB\-\-no\-dictID\fR: do not store dictionary ID within frame header (dictionary compression)\. The…
116 \fB\-M#\fR, \fB\-\-memory=#\fR: Set a memory usage limit\. By default, \fBzstd\fR uses 128 MiB for …
118 This is also used during compression when using with \fB\-\-patch\-from=\fR\. In this case, this pa…
120 …ctionary training\. This parameter overrides the default limit of 2 GiB\. zstd will load training …
122 \fB\-\-stream\-size=#\fR: Sets the pledged source size of input coming from a stream\. This value m…
124 \fB\-\-size\-hint=#\fR: When handling input from a stream, \fBzstd\fR must guess how large the sour…
126 \fB\-\-target\-compressed\-block\-size=#\fR: Attempt to produce compressed blocks of approximately …
128 …-f\fR, \fB\-\-force\fR: disable input and output checks\. Allows overwriting existing files, input…
130 \fB\-c\fR, \fB\-\-stdout\fR: write to standard output (even if it is the console); keep original fi…
132 \fB\-o FILE\fR: save result into \fBFILE\fR\. Note that this operation is in conflict with \fB\-c\f…
134 \fB\-\-[no\-]sparse\fR: enable / disable sparse FS support, to make files with many zeroes smaller …
136 …-\-[no\-]pass\-through\fR enable / disable passing through uncompressed files as\-is\. During deco…
138 …-\-rm\fR: remove source file(s) after successful compression or decompression\. This command is si…
140 \fB\-k\fR, \fB\-\-keep\fR: keep source file(s) after successful compression or decompression\. This…
142 \fB\-r\fR: operate recursively on directories\. It selects all files in the named directory and all…
144 \fB\-\-filelist FILE\fR read a list of files to process as content from \fBFILE\fR\. Format is comp…
146 …-\-output\-dir\-flat DIR\fR: resulting files are stored into target \fBDIR\fR directory, instead o…
148 \fB\-\-output\-dir\-mirror DIR\fR: similar to \fB\-\-output\-dir\-flat\fR, the output files are sto…
150 …ut\-dir/var/tmp/abc"\. If there are multiple input files or directories, name collision resolution…
152 …-\-format=FORMAT\fR: compress and decompress in other formats\. If compiled with support, zstd can…
154 \fB\-h\fR/\fB\-H\fR, \fB\-\-help\fR: display help/long help and exit
156 …-V\fR, \fB\-\-version\fR: display version number and immediately exit\. note that, since it exits,…
158 \fB\-v\fR, \fB\-\-verbose\fR: verbose mode, display more information
160 \fB\-q\fR, \fB\-\-quiet\fR: suppress warnings, interactivity, and notifications\. specify twice to …
162 \fB\-\-no\-progress\fR: do not display the progress bar, but keep all other messages\.
164 \fB\-\-show\-default\-cparams\fR: shows the default compression parameters that will be used for a …
166 \fB\-\-exclude\-compressed\fR: only compress files that are not already compressed\.
168 \fB\-\-\fR: All arguments after \fB\-\-\fR are treated as files
171 When invoked via a \fBgzip\fR symlink, \fBzstd\fR will support further options that intend to mimic…
173 \fB\-n\fR, \fB\-\-no\-name\fR
174 …filename and timestamps when compressing a file\. This is the default behavior and hence a no\-op\.
176 \fB\-\-best\fR
177 alias to the option \fB\-9\fR\.
181 …the value of \fBZSTD_CLEVEL\fR is not a valid integer, it will be ignored with a warning message\.…
183 …zstd\fR will attempt to use during compression\. If the value of \fBZSTD_NBTHREADS\fR is not a val…
185 …e overridden by corresponding command line arguments: \fB\-#\fR for compression level and \fB\-T#\…
187 …zstd\fR provides 22 predefined regular compression levels plus the fast levels\. A compression lev…
188 .SS "\-\-zstd[=options]:"
189 The \fIoptions\fR are provided as a comma\-separated list\. You may specify only the options you wa…
199 …wlog\fR is 10 (1 KiB) and the maximum is 30 (1 GiB) on 32\-bit platforms and 31 (2 GiB) on 64\-bit…
201 Note: If \fBwindowLog\fR is set to larger than 27, \fB\-\-long=windowLog\fR or \fB\-\-memory=window…
215 …and the maximum is 29 (512M entries / 2 GiB) on 32\-bit platforms and 30 (1B entries / 4 GiB) on 6…
222 The minimum \fIslog\fR is 1 and the maximum is 'windowLog' \- 1\.
236 For \fBZSTD_fast\fR, it triggers ultra\-fast mode when > 0\. The value represents the amount of dat…
245 …pecial and means "default": \fIovlog\fR is automatically determined by \fBzstd\fR\. In which case,…
281 The default value is \fBwlog \- lhlog\fR\.
285 \fB\-\-zstd\fR=wlog=23,clog=23,hlog=22,slog=6,mml=3,tlen=48,strat=6
286 .SS "\-B#:"
287 …-threading is enabled\. Each compression job is run in parallel, so this value indirectly impacts …
289 …zstd\fR offers \fIdictionary\fR compression, which greatly improves efficiency on small files and …
291 \fB\-\-train FILEs\fR
292 …size (for example, ~10 MB for a 100 KB dictionary)\. \fB\-\-train\fR can be combined with \fB\-r\f…
296 …-\-train\fR supports multithreading if \fBzstd\fR is compiled with threading support (default)\. A…
298 \fB\-o FILE\fR
301 \fB\-\-maxdict=#\fR
304 \fB\-#\fR
307 \fB\-B#\fR
310 \fB\-M#\fR, \fB\-\-memory=#\fR
313 …omization process is deterministic, so training of the same list of files with the same parameters…
315 \fB\-\-dictID=#\fR
316 …s value to verify it is using the right dictionary\. By default, zstd will create a 4\-bytes rando…
320 \fB\-\-train\-cover[=k#,d=#,steps=#,split=#,shrink[=#]]\fR
323 …with highest score to put in the dictionary\. The score of a segment is computed by the sum of the…
327 \fBzstd \-\-train\-cover FILEs\fR
329 \fBzstd \-\-train\-cover=k=50,d=8 FILEs\fR
331 \fBzstd \-\-train\-cover=d=8,steps=500 FILEs\fR
333 \fBzstd \-\-train\-cover=k=50 FILEs\fR
335 \fBzstd \-\-train\-cover=k=50,split=60 FILEs\fR
337 \fBzstd \-\-train\-cover=shrink FILEs\fR
339 \fBzstd \-\-train\-cover=shrink=2 FILEs\fR
341 \fB\-\-train\-fastcover[=k#,d=#,f=#,steps=#,split=#,accel=#]\fR
342 Same as cover but with extra parameters \fIf\fR and \fIaccel\fR and different default value of spli…
344 …e \fId\fR\. The subsegment is hashed to an index in the range [0,2^\fIf\fR \- 1]\. It is possible …
348 \fBzstd \-\-train\-fastcover FILEs\fR
350 \fBzstd \-\-train\-fastcover=d=8,f=15,accel=2 FILEs\fR
352 \fB\-\-train\-legacy[=selectivity=#]\fR
353 …with the given dictionary \fIselectivity\fR (default: 9)\. The smaller the \fIselectivity\fR value…
357 \fBzstd \-\-train\-legacy FILEs\fR
359 \fBzstd \-\-train\-legacy=selectivity=8 FILEs\fR
361 …zstd\fR CLI provides a benchmarking mode that can be used to easily find suitable compression para…
363 \fB\-b#\fR: benchmark file(s) using compression level #
365 \fB\-e#\fR: benchmark file(s) using multiple compression levels, from \fB\-b#\fR to \fB\-e#\fR (inc…
367 \fB\-d\fR: benchmark decompression speed only (requires providing a zstd\-compressed content)
369 \fB\-i#\fR: minimum evaluation time, in seconds (default: 3s), benchmark mode only
371 \fB\-B#\fR, \fB\-\-block\-size=#\fR: cut file(s) into independent chunks of size # (default: no chu…
373 \fB\-S\fR: output one benchmark result per input file (default: consolidated result)
375 \fB\-D dictionary\fR benchmark using dictionary
377 \fB\-\-priority=rt\fR: set process priority to real\-time (Windows)
380 …le with other parameters, such as number of threads (\fB\-T#\fR), advanced compression parameters …
382 \fBOutput Format:\fR CompressionLevel#Filename: InputSize \-> OutputSize (CompressionRatio), Compre…
384 \fBMethodology:\fR For speed measurement, the entire input is compressed/decompressed in\-memory to…
388 …t is specified in Y\. Collet, "Zstandard Compression and the 'application/zstd' Media Type", https…
390 Report bugs at: https://github\.com/facebook/zstd/issues