diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/xlunzip.1 | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/doc/xlunzip.1 b/doc/xlunzip.1 new file mode 100644 index 0000000..905b59a --- /dev/null +++ b/doc/xlunzip.1 @@ -0,0 +1,90 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1. +.TH XLUNZIP "1" "July 2018" "xlunzip 0.3" "User Commands" +.SH NAME +xlunzip \- test tool for the lunzip 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. +.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. +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +display this help and exit +.TP +\fB\-V\fR, \fB\-\-version\fR +output version information and exit +.TP +\fB\-c\fR, \fB\-\-stdout\fR +write to standard output, keep input files +.TP +\fB\-d\fR, \fB\-\-decompress\fR +decompress (this is the default) +.TP +\fB\-f\fR, \fB\-\-force\fR +overwrite existing output files +.TP +\fB\-I\fR, \fB\-\-in\-place\fR +decompress or test using only one buffer +.TP +\fB\-k\fR, \fB\-\-keep\fR +keep (don't delete) input files +.TP +\fB\-o\fR, \fB\-\-output=\fR<file> +if reading standard input, write to <file> +.TP +\fB\-q\fR, \fB\-\-quiet\fR +suppress all messages +.TP +\fB\-t\fR, \fB\-\-test\fR +test compressed file integrity +.TP +\fB\-v\fR, \fB\-\-verbose\fR +be verbose (a 2nd \fB\-v\fR gives more) +.SS "These options are ignored when --in-place is in effect:" +.TP +\fB\-\-insize[=\fR<size>] +pre\-allocate and fill inbuf [default 16 KiB] +.TP +\fB\-\-outsize[=\fR<size>] +pre\-allocate outbuf [default 512 MiB] +.TP +\fB\-\-nofill\fR +do not pass a fill function; requires \fB\-\-insize\fR +.TP +\fB\-\-noflush\fR +do not pass a flush function; requires \fB\-\-outsize\fR +.PP +If no file names are given, or if a file is '\-', xlunzip 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... +.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 +invalid input file, 3 for an internal consistency error (eg, bug) which +caused xlunzip to panic. +.SH "REPORTING BUGS" +Report bugs to lzip\-bug@nongnu.org +.br +Xlunzip home page: http://www.nongnu.org/lzip/xlunzip.html +.SH COPYRIGHT +Copyright \(co 2018 Antonio Diaz Diaz. +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. +There is NO WARRANTY, to the extent permitted by law. |