From 3fd4b536bad552d17839d8e8ff95d05e5adf8ac9 Mon Sep 17 00:00:00 2001 From: Kevin Murray Date: Tue, 22 Dec 2015 12:24:27 +1100 Subject: [PATCH] Add symlinks for extra manpages Gbp-Pq: Name 0003-Add-symlinks-for-extra-manpages.patch --- programs/unzstd.1 | 92 ++++++++++++++++++++++++++++++++++++++++++++++ programs/zstdcat.1 | 92 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 184 insertions(+) create mode 100644 programs/unzstd.1 create mode 100644 programs/zstdcat.1 diff --git a/programs/unzstd.1 b/programs/unzstd.1 new file mode 100644 index 0000000..5ccdf8a --- /dev/null +++ b/programs/unzstd.1 @@ -0,0 +1,92 @@ +\" +\" zstd.1: This is a manual page for 'zstd' program. This file is part of the +\" zstd project. +\" Author: Yann Collet +\" + +\" No hyphenation +.hy 0 +.nr HY 0 + +.TH zstd "1" "2015-08-22" "zstd" "User Commands" +.SH NAME +\fBzstd, unzstd, zstdcat\fR - Compress or decompress .zst files + +.SH SYNOPSIS +.TP 5 +\fBzstd\fR [\fBOPTIONS\fR] [-|INPUT-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. +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 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 + + +\fBzstd\fR supports the following options : + +.SH OPTIONS +.TP +.B \-# + # compression level [1-19](default:1) +.TP +.B \-d + decompression +.TP +.B \-f + overwrite output without prompting +.TP +.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 +.BR \-h/\-H ", " --help + display help/long help and exit +.TP +.BR \-V ", " --version + display Version number and exit +.TP +.BR \-v ", " --verbose + verbose mode +.TP +.BR \-q ", " --quiet + suppress warnings and notifications; specify twice to suppress errors too +.TP +.B \-c + force write to standard output, even if it is the console +.TP +.B \-z + force compression +.TP +.B \-b# + benchmark file(s) using compression level # +.TP +.B \-i# + iteration loops [1-9](default : 3), benchmark mode only + +.SH BUGS +Report bugs at:- https://github.com/facebook/zstd/issues + +.SH AUTHOR +Yann Collet diff --git a/programs/zstdcat.1 b/programs/zstdcat.1 new file mode 100644 index 0000000..5ccdf8a --- /dev/null +++ b/programs/zstdcat.1 @@ -0,0 +1,92 @@ +\" +\" zstd.1: This is a manual page for 'zstd' program. This file is part of the +\" zstd project. +\" Author: Yann Collet +\" + +\" No hyphenation +.hy 0 +.nr HY 0 + +.TH zstd "1" "2015-08-22" "zstd" "User Commands" +.SH NAME +\fBzstd, unzstd, zstdcat\fR - Compress or decompress .zst files + +.SH SYNOPSIS +.TP 5 +\fBzstd\fR [\fBOPTIONS\fR] [-|INPUT-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. +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 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 + + +\fBzstd\fR supports the following options : + +.SH OPTIONS +.TP +.B \-# + # compression level [1-19](default:1) +.TP +.B \-d + decompression +.TP +.B \-f + overwrite output without prompting +.TP +.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 +.BR \-h/\-H ", " --help + display help/long help and exit +.TP +.BR \-V ", " --version + display Version number and exit +.TP +.BR \-v ", " --verbose + verbose mode +.TP +.BR \-q ", " --quiet + suppress warnings and notifications; specify twice to suppress errors too +.TP +.B \-c + force write to standard output, even if it is the console +.TP +.B \-z + force compression +.TP +.B \-b# + benchmark file(s) using compression level # +.TP +.B \-i# + iteration loops [1-9](default : 3), benchmark mode only + +.SH BUGS +Report bugs at:- https://github.com/facebook/zstd/issues + +.SH AUTHOR +Yann Collet -- 2.30.2