summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/xlunzip.133
1 files changed, 16 insertions, 17 deletions
diff --git a/doc/xlunzip.1 b/doc/xlunzip.1
index ea83510..2f7ccb1 100644
--- a/doc/xlunzip.1
+++ b/doc/xlunzip.1
@@ -1,27 +1,26 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
-.TH XLUNZIP "1" "April 2020" "xlunzip 0.5" "User Commands"
+.TH XLUNZIP "1" "June 2020" "xlunzip 0.6" "User Commands"
.SH NAME
xlunzip \- test tool for the lzip_decompress linux module
.SH SYNOPSIS
.B xlunzip
[\fI\,options\/\fR] [\fI\,files\/\fR]
.SH DESCRIPTION
-Xlunzip is a test tool for the lzip decompression code of my lzip patch
-for linux. Xlunzip is similar to lunzip, but it uses the lzip_decompress
-linux module as a backend. Xlunzip tests the module for stream,
-buffer\-to\-buffer and mixed decompression modes, including in\-place
-decompression (using the same buffer for input and output). You can use
-xlunzip to verify that the module produces correct results when
-decompressing single member files, multimember files, or the
-concatenation of two or more compressed files. Xlunzip can be used with
-unzcrash to test the robustness of the module to the decompression of
-corrupted data.
+Xlunzip is a test tool for the lzip decompression code of my lzip patch for
+linux. Xlunzip is similar to lunzip, but it uses the lzip_decompress linux
+module as a backend. Xlunzip tests the module for stream, buffer\-to\-buffer,
+and mixed decompression modes, including in\-place decompression (using the
+same buffer for input and output). You can use xlunzip to verify that the
+module produces correct results when decompressing single member files,
+multimember files, or the concatenation of two or more compressed files.
+Xlunzip can be used with unzcrash to test the robustness of the module to
+the decompression of corrupted data.
.PP
-Note that the in\-place decompression of concatenated files can't be
-guaranteed to work because an arbitrarily low compression ratio of the
-last part of the data can be achieved by appending enough empty
-compressed members to a file, masking a high compression ratio at the
-beginning of the data.
+The distributed index feature of the lzip format allows xlunzip to
+decompress concatenated files in place. This can't be guaranteed to work
+with formats like gzip or bzip2 because they can't detect whether a high
+compression ratio in the first members of the multimember data is being
+masked by a low compression ratio in the last members.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
@@ -46,7 +45,7 @@ decompress or test using only one buffer
keep (don't delete) input files
.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