summaryrefslogtreecommitdiffstats
path: root/doc/plzip.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plzip.1')
-rw-r--r--doc/plzip.150
1 files changed, 29 insertions, 21 deletions
diff --git a/doc/plzip.1 b/doc/plzip.1
index 694a99d..deb0ea5 100644
--- a/doc/plzip.1
+++ b/doc/plzip.1
@@ -1,5 +1,5 @@
-.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
-.TH PLZIP "1" "January 2019" "plzip 1.8" "User Commands"
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
+.TH PLZIP "1" "January 2021" "plzip 1.9" "User Commands"
.SH NAME
plzip \- reduces the size of files
.SH SYNOPSIS
@@ -7,22 +7,24 @@ plzip \- reduces the size of files
[\fI\,options\/\fR] [\fI\,files\/\fR]
.SH DESCRIPTION
Plzip is a massively parallel (multi\-threaded) implementation of lzip, fully
-compatible with lzip 1.4 or newer. Plzip uses the lzlib compression library.
+compatible with lzip 1.4 or newer. Plzip uses the compression library lzlib.
.PP
-Lzip is a lossless data compressor with a user interface similar to the
-one of gzip or bzip2. Lzip can compress about as fast as gzip (lzip \fB\-0\fR)
-or compress most files more than bzip2 (lzip \fB\-9\fR). Decompression speed is
-intermediate between gzip and bzip2. Lzip is better than gzip and bzip2
-from a data recovery perspective. Lzip has been designed, written and
-tested with great care to replace gzip and bzip2 as the standard
-general\-purpose compressed format for unix\-like systems.
+Lzip is a lossless data compressor with a user interface similar to the one
+of gzip or bzip2. Lzip uses a simplified form of the 'Lempel\-Ziv\-Markov
+chain\-Algorithm' (LZMA) stream format, chosen to maximize safety and
+interoperability. Lzip can compress about as fast as gzip (lzip \fB\-0\fR) or
+compress most files more than bzip2 (lzip \fB\-9\fR). Decompression speed is
+intermediate between gzip and bzip2. Lzip is better than gzip and bzip2 from
+a data recovery perspective. Lzip has been designed, written, and tested
+with great care to replace gzip and bzip2 as the standard general\-purpose
+compressed format for unix\-like systems.
.PP
-Plzip can compress/decompress large files on multiprocessor machines
-much faster than lzip, at the cost of a slightly reduced compression
-ratio (0.4 to 2 percent larger compressed files). Note that the number
-of usable threads is limited by file size; on files larger than a few GB
-plzip can use hundreds of processors, but on files of only a few MB
-plzip is no faster than lzip.
+Plzip can compress/decompress large files on multiprocessor machines much
+faster than lzip, at the cost of a slightly reduced compression ratio (0.4
+to 2 percent larger compressed files). Note that the number of usable
+threads is limited by file size; on files larger than a few GB plzip can use
+hundreds of processors, but on files of only a few MB plzip is no faster
+than lzip.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
@@ -62,7 +64,7 @@ set match length limit in bytes [36]
set number of (de)compression threads [2]
.TP
\fB\-o\fR, \fB\-\-output=\fR<file>
-if reading standard input, write to <file>
+write to <file>, keep input files
.TP
\fB\-q\fR, \fB\-\-quiet\fR
suppress all messages
@@ -93,6 +95,9 @@ number of 1 MiB input packets buffered [4]
.TP
\fB\-\-out\-slots=\fR<n>
number of 1 MiB output packets buffered [64]
+.TP
+\fB\-\-check\-lib\fR
+compare version of lzlib.h with liblz.{a,so}
.PP
If no file names are given, or if a file is '\-', plzip compresses or
decompresses from standard input to standard output.
@@ -103,8 +108,11 @@ to 2^29 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\-\-dictionary\-size\fR and \fB\-\-match\-length\fR
-options directly to achieve optimal performance.
+etc, you may need to use the options \fB\-\-dictionary\-size\fR and \fB\-\-match\-length\fR
+directly to achieve optimal performance.
+.PP
+To extract all the files from archive 'foo.tar.lz', use the commands
+\&'tar \fB\-xf\fR foo.tar.lz' or 'plzip \fB\-cd\fR foo.tar.lz | tar \fB\-xf\fR \-'.
.PP
Exit status: 0 for a normal exit, 1 for environmental problems (file
not found, invalid flags, I/O errors, etc), 2 to indicate a corrupt or
@@ -117,8 +125,8 @@ Plzip home page: http://www.nongnu.org/lzip/plzip.html
.SH COPYRIGHT
Copyright \(co 2009 Laszlo Ersek.
.br
-Copyright \(co 2019 Antonio Diaz Diaz.
-Using lzlib 1.11
+Copyright \(co 2021 Antonio Diaz Diaz.
+Using lzlib 1.12
License GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl.html>
.br
This is free software: you are free to change and redistribute it.