modified man page

This commit is contained in:
Yann Collet
2015-08-26 12:04:58 +02:00
parent 50b6f941e8
commit ddf39e91c5
3 changed files with 22 additions and 74 deletions
-31
View File
@@ -1,31 +0,0 @@
\"
\" unzstd.1: This is a manual page for 'unzstd' program. This file is part of
\" the zstd <https://github.com/Cyan4973/zstd/> project.
\"
\" No hyphenation
.hy 0
.nr HY 0
.TH unzstd "1" "2014-06-20" "unzstd" "User Commands"
.SH NAME
\fBunzstd\fR - Utility based on zstd
.SH SYNOPSIS
.TP 5
\fBunzstd\fR [\fBOPTIONS\fR] [-|INPUT-FILE]
.SH DESCRIPTION
.PP
\fBunzstd\fR is an utility based on \fBzstd\fR, a fast lossless compression algorithm.
\fBunzstd\fR decompress input file, it is equivalent to \fBzstd -d\fR,
Available options are the same as \fBzstd\fR ones (man zstd).
.SH BUGS
Report bugs at:- https://github.com/Cyan4973/zstd/
.SH AUTHOR
Yann Collet
+1
View File
@@ -0,0 +1 @@
zstd.1
+20 -11
View File
@@ -1,26 +1,35 @@
\" \"
\" zstd.1: This is a manual page for 'zstd' program. This file is part of the \" zstd.1: This is a manual page for 'zstd' program. This file is part of the
\" zstd <https://github.com/Cyan4973/zstd> project. \" zstd <http://www.zstd.net/> project.
\" Author: Yann Collet
\" \"
\" No hyphenation \" No hyphenation
.hy 0 .hy 0
.nr HY 0 .nr HY 0
.TH zstd "1" "2015-01-22" "zstd" "User Commands" .TH zstd "1" "2015-08-22" "zstd" "User Commands"
.SH NAME .SH NAME
\fBzstd\fR - standard compression algorithm \fBzstd, unzstd, zstdcat\fR - Compress or decompress .zst files
.SH SYNOPSIS .SH SYNOPSIS
.TP 5 .TP 5
\fBzstd\fR [\fBOPTIONS\fR] [-|INPUT-FILE] <OUTPUT-FILE> \fBzstd\fR [\fBOPTIONS\fR] [-|INPUT-FILE] <OUTPUT-FILE>
.PP
.B unzstd
is equivalent to
.BR "zstd \-d"
.br
.B zstdcat
is equivalent to
.BR "zstd \-dc"
.br
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
\fBzstd\fR is a fast lossless compression algorithm \fBzstd\fR is a fast lossless compression algorithm.
with highly parametrable compression strength and memory usage. It is based on the \fBLZ77\fR family, with FSE & huff0 entropy stage.
It is based on the \fBLZ77\fR family, coupled with FSE entropy stage. zstd offers compression speed > 200 MB/s per core.
zstd offers compression speed of 200 MB/s per core.
It also features a fast decoder, with speed > 500 MB/s per core. It also features a fast decoder, with speed > 500 MB/s per core.
\fBzstd\fR supports the following options : \fBzstd\fR supports the following options :
@@ -35,13 +44,13 @@ It also features a fast decoder, with speed > 500 MB/s per core.
.B \-f .B \-f
overwrite output without prompting overwrite output without prompting
.TP .TP
.B \-h/\-H .BR \-h/\-H ", " --help
display help/long help and exit display help/long help and exit
.TP .TP
.B \-V .BR \-V ", " --version
display Version number and exit display Version number and exit
.TP .TP
.B \-v .BR \-v ", " --verbose
verbose mode verbose mode
.TP .TP
.B \-q .B \-q
@@ -63,7 +72,7 @@ It also features a fast decoder, with speed > 500 MB/s per core.
iteration loops [1-9](default : 3), benchmark mode only iteration loops [1-9](default : 3), benchmark mode only
.SH BUGS .SH BUGS
Report bugs at:- https://github.com/Cyan4973/zstd Report bugs at:- https://github.com/Cyan4973/zstd/issues
.SH AUTHOR .SH AUTHOR
Yann Collet Yann Collet
-32
View File
@@ -1,32 +0,0 @@
\"
\" zstdcat.1: This is a manual page for 'zstdcat' program. This file is part of
\" the zstd <https://github.com/Cyan4973/zstd/> project.
\"
\" No hyphenation
.hy 0
.nr HY 0
.TH zstdcat "1" "2014-06-20" "zstdcat" "User Commands"
.SH NAME
\fBzstdcat\fR - Utility based on zstd
.SH SYNOPSIS
.TP 5
\fBzstdcat\fR [\fBOPTIONS\fR] [-|INPUT-FILE]
.SH DESCRIPTION
.PP
\fBzstdcat\fR is an utility based on \fBzstd\fR, a fast lossless compression algorithm.
\fBzstdcat\fR decompress input file or stream, redirecting its output to the console.
It is equivalent to \fBzstd -cd\fR,
Available options are the same as \fBzstd\fR ones (man zstd).
.SH BUGS
Report bugs at:- https://github.com/Cyan4973/zstd/
.SH AUTHOR
Yann Collet
+1
View File
@@ -0,0 +1 @@
zstd.1