From ddf39e91c5d02cbaf872f27ff821f10897adaa46 Mon Sep 17 00:00:00 2001
From: Yann Collet <yann.collet.73@gmail.com>
Date: Wed, 26 Aug 2015 12:04:58 +0200
Subject: [PATCH] modified man page

---
 programs/unzstd.1  | 32 +-------------------------------
 programs/zstd.1    | 31 ++++++++++++++++++++-----------
 programs/zstdcat.1 | 33 +--------------------------------
 3 files changed, 22 insertions(+), 74 deletions(-)
 mode change 100644 => 120000 programs/unzstd.1
 mode change 100644 => 120000 programs/zstdcat.1

diff --git a/programs/unzstd.1 b/programs/unzstd.1
deleted file mode 100644
index 157fab76..00000000
--- a/programs/unzstd.1
+++ /dev/null
@@ -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
diff --git a/programs/unzstd.1 b/programs/unzstd.1
new file mode 120000
index 00000000..e66191d7
--- /dev/null
+++ b/programs/unzstd.1
@@ -0,0 +1 @@
+zstd.1
\ No newline at end of file
diff --git a/programs/zstd.1 b/programs/zstd.1
index ce360272..fdc8cc46 100644
--- a/programs/zstd.1
+++ b/programs/zstd.1
@@ -1,26 +1,35 @@
 \"
 \" 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
 .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
-\fBzstd\fR - standard compression algorithm
+\fBzstd, unzstd, zstdcat\fR - Compress or decompress .zst files
 
 .SH SYNOPSIS
 .TP 5
 \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
 .PP
-\fBzstd\fR is a fast lossless compression algorithm
-with highly parametrable compression strength and memory usage.
-It is based on the \fBLZ77\fR family, coupled with FSE entropy stage.
-zstd offers compression speed of 200 MB/s per core.
+\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.
 It also features a fast decoder, with speed > 500 MB/s per core.
 \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
  overwrite output without prompting
 .TP
-.B \-h/\-H
+.BR \-h/\-H ", " --help
  display help/long help and exit
 .TP
-.B \-V
+.BR \-V ", " --version
  display Version number and exit
 .TP
-.B \-v
+.BR \-v ", " --verbose
  verbose mode
 .TP
 .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
 
 .SH BUGS
-Report bugs at:- https://github.com/Cyan4973/zstd
+Report bugs at:- https://github.com/Cyan4973/zstd/issues
 
 .SH AUTHOR
 Yann Collet
diff --git a/programs/zstdcat.1 b/programs/zstdcat.1
deleted file mode 100644
index 036ac071..00000000
--- a/programs/zstdcat.1
+++ /dev/null
@@ -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
diff --git a/programs/zstdcat.1 b/programs/zstdcat.1
new file mode 120000
index 00000000..e66191d7
--- /dev/null
+++ b/programs/zstdcat.1
@@ -0,0 +1 @@
+zstd.1
\ No newline at end of file