summaryrefslogtreecommitdiffstats
path: root/doc/pdlzip.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/pdlzip.1')
-rw-r--r--doc/pdlzip.131
1 files changed, 20 insertions, 11 deletions
diff --git a/doc/pdlzip.1 b/doc/pdlzip.1
index 0c97f2c..8e76b32 100644
--- a/doc/pdlzip.1
+++ b/doc/pdlzip.1
@@ -1,15 +1,18 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
-.TH PDLZIP "1" "May 2015" "pdlzip 1.6" "User Commands"
+.TH PDLZIP "1" "May 2016" "pdlzip 1.7" "User Commands"
.SH NAME
pdlzip \- reduces the size of files
.SH SYNOPSIS
.B pdlzip
[\fI\,options\/\fR] [\fI\,files\/\fR]
.SH DESCRIPTION
-Pdlzip \- A "public domain" version of the lzip data compressor
-also able to decompress legacy lzma\-alone (.lzma) files.
-Lzma\-alone is a very bad format. If you keep any lzma\-alone files, it is
-advisable to recompress them to lzip format.
+Pdlzip \- A permissively licensed implementation of the lzip data
+compressor also able to decompress legacy lzma\-alone (.lzma) files.
+.PP
+Lzma\-alone is a very bad format; it is essentially a raw LZMA stream.
+If you keep any lzma\-alone files, it is advisable to recompress them to
+lzip format. Lziprecover can convert lzma\-alone files to lzip format
+without recompressing.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
@@ -18,8 +21,11 @@ display this help and exit
\fB\-V\fR, \fB\-\-version\fR
output version information and exit
.TP
+\fB\-a\fR, \fB\-\-trailing\-error\fR
+exit with error status if trailing data
+.TP
\fB\-c\fR, \fB\-\-stdout\fR
-send output to standard output
+write to standard output, keep input files
.TP
\fB\-d\fR, \fB\-\-decompress\fR
decompress
@@ -37,7 +43,7 @@ keep (don't delete) input files
set match length limit in bytes [36]
.TP
\fB\-o\fR, \fB\-\-output=\fR<file>
-if reading stdin, place the output into <file>
+if reading standard input, write to <file>
.TP
\fB\-q\fR, \fB\-\-quiet\fR
suppress all messages
@@ -60,13 +66,16 @@ alias for \fB\-1\fR
\fB\-\-best\fR
alias for \fB\-9\fR
.PP
-If no file names are given, pdlzip compresses or decompresses
-from standard input to standard output.
+If no file names are given, or if a file is '\-', pdlzip compresses or
+decompresses from standard input to standard output.
Numbers may be followed by a multiplier: k = kB = 10^3 = 1000,
Ki = KiB = 2^10 = 1024, M = 10^6, Mi = 2^20, G = 10^9, Gi = 2^30, etc...
+Dictionary sizes 12 to 27 are interpreted as powers of two, meaning 2^12
+to 2^27 bytes.
+.PP
The bidimensional parameter space of LZMA can't be mapped to a linear
scale optimal for all files. If your files are large, very repetitive,
-etc, you may need to use the \fB\-\-match\-length\fR and \fB\-\-dictionary\-size\fR
+etc, you may need to use the \fB\-\-dictionary\-size\fR and \fB\-\-match\-length\fR
options directly to achieve optimal performance. For example, \fB\-9m64\fR
usually compresses executables more (and faster) than \fB\-9\fR.
.PP
@@ -79,7 +88,7 @@ Report bugs to lzip\-bug@nongnu.org
.br
Pdlzip home page: http://www.nongnu.org/lzip/pdlzip.html
.SH COPYRIGHT
-Copyright \(co 2015 Antonio Diaz Diaz.
+Copyright \(co 2016 Antonio Diaz Diaz.
Public Domain 2009 Igor Pavlov.
License 2\-clause BSD.
.br