2015-01-24 00:58:16 +00:00
|
|
|
\"
|
|
|
|
|
\" zstd.1: This is a manual page for 'zstd' program. This file is part of the
|
2015-08-26 10:04:58 +00:00
|
|
|
\" zstd <http://www.zstd.net/> project.
|
|
|
|
|
\" Author: Yann Collet
|
2015-01-24 00:58:16 +00:00
|
|
|
\"
|
|
|
|
|
|
|
|
|
|
\" No hyphenation
|
|
|
|
|
.hy 0
|
|
|
|
|
.nr HY 0
|
|
|
|
|
|
2015-08-26 10:04:58 +00:00
|
|
|
.TH zstd "1" "2015-08-22" "zstd" "User Commands"
|
2015-01-24 00:58:16 +00:00
|
|
|
.SH NAME
|
2015-08-26 10:04:58 +00:00
|
|
|
\fBzstd, unzstd, zstdcat\fR - Compress or decompress .zst files
|
2015-01-24 00:58:16 +00:00
|
|
|
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.TP 5
|
|
|
|
|
\fBzstd\fR [\fBOPTIONS\fR] [-|INPUT-FILE] <OUTPUT-FILE>
|
2015-08-26 10:04:58 +00:00
|
|
|
.PP
|
|
|
|
|
.B unzstd
|
|
|
|
|
is equivalent to
|
|
|
|
|
.BR "zstd \-d"
|
|
|
|
|
.br
|
|
|
|
|
.B zstdcat
|
|
|
|
|
is equivalent to
|
|
|
|
|
.BR "zstd \-dc"
|
|
|
|
|
.br
|
2015-01-24 00:58:16 +00:00
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.PP
|
2015-08-26 10:04:58 +00:00
|
|
|
\fBzstd\fR is a fast lossless compression algorithm.
|
|
|
|
|
It is based on the \fBLZ77\fR family, with FSE & huff0 entropy stage.
|
|
|
|
|
zstd offers compression speed > 200 MB/s per core.
|
2015-01-24 00:58:16 +00:00
|
|
|
It also features a fast decoder, with speed > 500 MB/s per core.
|
2015-12-17 19:30:14 +00:00
|
|
|
|
|
|
|
|
\fBzstd\fR command line is generally similar to gzip, but features the following differences :
|
|
|
|
|
- Original files are preserved
|
|
|
|
|
- By default, \fBzstd file1 file2\fR means : compress file1 \fBinto\fR file2.
|
|
|
|
|
Use \fB-m\fR command if you want : compress file1 into file1.zstd and file2 into file2.zst
|
|
|
|
|
- By default, when compressing files, \fBzstd\fR displays advancement notification and result summary.
|
|
|
|
|
Use \fB-q\fR to turn them off
|
|
|
|
|
|
|
|
|
|
|
2015-01-24 00:58:16 +00:00
|
|
|
\fBzstd\fR supports the following options :
|
|
|
|
|
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
.TP
|
2015-12-17 19:30:14 +00:00
|
|
|
.B \-#
|
|
|
|
|
# compression level [1-19](default:1)
|
2015-01-24 00:58:16 +00:00
|
|
|
.TP
|
|
|
|
|
.B \-d
|
|
|
|
|
decompression
|
|
|
|
|
.TP
|
|
|
|
|
.B \-f
|
|
|
|
|
overwrite output without prompting
|
|
|
|
|
.TP
|
2015-12-17 19:30:14 +00:00
|
|
|
.BR \-m ", " --multiple
|
|
|
|
|
multiple files mode
|
|
|
|
|
In this mode, multiple files on the command line means compression or decompression of each named file
|
|
|
|
|
Notifications are also turned off by default
|
|
|
|
|
.TP
|
|
|
|
|
.B \-D
|
|
|
|
|
Use next file as dictionary content for compress / decompression
|
|
|
|
|
.TP
|
2015-08-26 10:04:58 +00:00
|
|
|
.BR \-h/\-H ", " --help
|
2015-01-24 00:58:16 +00:00
|
|
|
display help/long help and exit
|
|
|
|
|
.TP
|
2015-08-26 10:04:58 +00:00
|
|
|
.BR \-V ", " --version
|
2015-01-24 00:58:16 +00:00
|
|
|
display Version number and exit
|
|
|
|
|
.TP
|
2015-08-26 10:04:58 +00:00
|
|
|
.BR \-v ", " --verbose
|
2015-01-24 00:58:16 +00:00
|
|
|
verbose mode
|
|
|
|
|
.TP
|
2015-12-17 19:30:14 +00:00
|
|
|
.BR \-q ", " --quiet
|
|
|
|
|
suppress warnings and notifications; specify twice to suppress errors too
|
2015-01-24 00:58:16 +00:00
|
|
|
.TP
|
2015-12-17 19:30:14 +00:00
|
|
|
.B \-c
|
2015-01-24 00:58:16 +00:00
|
|
|
force write to standard output, even if it is the console
|
|
|
|
|
.TP
|
|
|
|
|
.B \-z
|
|
|
|
|
force compression
|
|
|
|
|
.TP
|
2015-12-17 19:30:14 +00:00
|
|
|
.B \-b#
|
|
|
|
|
benchmark file(s) using compression level #
|
2015-01-24 00:58:16 +00:00
|
|
|
.TP
|
|
|
|
|
.B \-i#
|
|
|
|
|
iteration loops [1-9](default : 3), benchmark mode only
|
|
|
|
|
|
|
|
|
|
.SH BUGS
|
2015-08-26 10:04:58 +00:00
|
|
|
Report bugs at:- https://github.com/Cyan4973/zstd/issues
|
2015-01-24 00:58:16 +00:00
|
|
|
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
Yann Collet
|
