summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/lunzip.125
1 files changed, 15 insertions, 10 deletions
diff --git a/doc/lunzip.1 b/doc/lunzip.1
index 7a35eb5..53b3faf 100644
--- a/doc/lunzip.1
+++ b/doc/lunzip.1
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
-.TH LUNZIP "1" "July 2015" "lunzip 1.8-pre1" "User Commands"
+.TH LUNZIP "1" "May 2016" "lunzip 1.8" "User Commands"
.SH NAME
lunzip \- decompressor for the lzip format
.SH SYNOPSIS
@@ -8,7 +8,7 @@ lunzip \- decompressor for the lzip format
.SH DESCRIPTION
Lunzip is a decompressor for the lzip format. It is written in C and its
small size makes it well suited for embedded devices or software
-installers that need to decompress files but do not need compression
+installers that need to decompress files but don't need compression
capabilities. Lunzip is fully compatible with lzip\-1.4 or newer.
.PP
Lunzip provides a 'low memory' mode able to decompress any file using as
@@ -16,9 +16,11 @@ little memory as 50 kB, irrespective of the dictionary size used to
compress the file. To activate it, specify the size of the output buffer
with the '\-\-buffer\-size' option and lunzip will use the decompressed
file as dictionary for distances beyond the buffer size. Of course, the
-smaller the output buffer size used in relation to the dictionary size,
-the more accesses to disk are needed and the slower the decompression is.
-This 'low memory' mode only works when decompressing to a regular file.
+smaller the buffer size used in relation to the dictionary size, the
+more accesses to disk are needed and the slower the decompression is.
+This 'low memory' mode only works when decompressing to a regular file
+and is intended for systems without enough memory (RAM + swap) to keep
+the whole dictionary at once.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
@@ -27,8 +29,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 (this is the default)
@@ -40,7 +45,7 @@ overwrite existing output files
keep (don't delete) input files
.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
@@ -54,8 +59,8 @@ set output buffer size in bytes
\fB\-v\fR, \fB\-\-verbose\fR
be verbose (a 2nd \fB\-v\fR gives more)
.PP
-If no file names are given, lunzip decompresses from standard input to
-standard output.
+If no file names are given, or if a file is '\-', lunzip 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
@@ -68,7 +73,7 @@ Report bugs to lzip\-bug@nongnu.org
.br
Lunzip home page: http://www.nongnu.org/lzip/lunzip.html
.SH COPYRIGHT
-Copyright \(co 2015 Antonio Diaz Diaz.
+Copyright \(co 2016 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.