summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/lunzip.119
1 files changed, 17 insertions, 2 deletions
diff --git a/doc/lunzip.1 b/doc/lunzip.1
index 0d10c1d..76b51e1 100644
--- a/doc/lunzip.1
+++ b/doc/lunzip.1
@@ -1,12 +1,24 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
-.TH LUNZIP "1" "September 2013" "Lunzip 1.4" "User Commands"
+.TH LUNZIP "1" "October 2013" "Lunzip 1.5-rc1" "User Commands"
.SH NAME
Lunzip \- decompressor for lzip files
.SH SYNOPSIS
.B lunzip
[\fIoptions\fR] [\fIfiles\fR]
.SH DESCRIPTION
-Lunzip \- Decompressor for lzip files.
+Lunzip is a decompressor for lzip files. 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
+capabilities. Lunzip is fully compatible with lzip\-1.4 or newer.
+.PP
+If the size of the output buffer is specified with the '\-\-buffer\-size'
+option, lunzip uses the decompressed file as dictionary for distances
+beyond the buffer size and is able to decompress any file using as
+little memory as 50 kB, irrespective of the dictionary size used to
+compress the file. 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.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
@@ -36,6 +48,9 @@ suppress all messages
\fB\-t\fR, \fB\-\-test\fR
test compressed file integrity
.TP
+\fB\-u\fR, \fB\-\-buffer\-size=\fR<bytes>
+set output buffer size in bytes
+.TP
\fB\-v\fR, \fB\-\-verbose\fR
be verbose (a 2nd \fB\-v\fR gives more)
.PP