diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/clzip.1 | 5 | ||||
| -rw-r--r-- | doc/clzip.info | 35 | ||||
| -rw-r--r-- | doc/clzip.texinfo | 22 |
3 files changed, 41 insertions, 21 deletions
diff --git a/doc/clzip.1 b/doc/clzip.1 index fa126e6..1b2cac8 100644 --- a/doc/clzip.1 +++ b/doc/clzip.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. -.TH CLZIP "1" "January 2011" "Clzip 1.1" "User Commands" +.TH CLZIP "1" "May 2011" "Clzip 1.2" "User Commands" .SH NAME Clzip \- reduces the size of files .SH SYNOPSIS @@ -27,6 +27,9 @@ decompress \fB\-f\fR, \fB\-\-force\fR overwrite existing output files .TP +\fB\-F\fR, \fB\-\-recompress\fR +force recompression of compressed files +.TP \fB\-k\fR, \fB\-\-keep\fR keep (don't delete) input files .TP diff --git a/doc/clzip.info b/doc/clzip.info index 861aac7..3551973 100644 --- a/doc/clzip.info +++ b/doc/clzip.info @@ -12,7 +12,7 @@ File: clzip.info, Node: Top, Next: Introduction, Up: (dir) Clzip Manual ************ -This manual is for Clzip (version 1.1, 11 January 2011). +This manual is for Clzip (version 1.2, 18 May 2011). * Menu: @@ -207,6 +207,11 @@ The format for running clzip is: `--force' Force overwrite of output file. +`-F' +`--recompress' + Force recompression of files whose name already has the `.lz' or + `.tlz' suffix. + `-k' `--keep' Keep (don't delete) input files during compression or @@ -238,7 +243,8 @@ The format for running clzip is: 4KiB to 512MiB. Clzip will use the smallest possible dictionary size for each member without exceeding this limit. Note that dictionary sizes are quantized. If the specified size does not - match one of the valid sizes, it will be rounded upwards. + match one of the valid sizes, it will be rounded upwards by adding + up to (SIZE / 16) to it. For maximum compression you should use a dictionary size limit as large as possible, but keep in mind that the decompression memory @@ -263,8 +269,11 @@ The format for running clzip is: `-v' `--verbose' - Verbose mode. Show the compression ratio for each file processed. - Further -v's increase the verbosity level. + Verbose mode. When compressing, show the compression ratio for + each file processed. When decompressing or testing, further -v's + (up to 4) increase the verbosity level, showing status, dictionary + size, compression ratio, and trailer contents (CRC, data size, + member size). `-1 .. -9' Set the compression parameters (dictionary size and match length @@ -345,8 +354,8 @@ additional information before, between, or after them. `VN (version number, 1 byte)' Just in case something needs to be modified in the future. Valid - values are 0 and 1. Version 0 files have only one member and lack - `Member size'. + values are 0 and 1. Version 0 files are deprecated. They can + contain only one member and lack the `Member size' field. `DS (coded dictionary size, 1 byte)' Bits 4-0 contain the base 2 logarithm of the base dictionary size. @@ -477,12 +486,12 @@ Concept Index Tag Table: Node: Top226 -Node: Introduction907 -Node: Algorithm4484 -Node: Invoking Clzip7008 -Node: File Format11949 -Node: Examples13905 -Node: Problems15674 -Node: Concept Index16200 +Node: Introduction903 +Node: Algorithm4480 +Node: Invoking Clzip7004 +Node: File Format12275 +Node: Examples14269 +Node: Problems16038 +Node: Concept Index16564 End Tag Table diff --git a/doc/clzip.texinfo b/doc/clzip.texinfo index 1177d8a..85396ab 100644 --- a/doc/clzip.texinfo +++ b/doc/clzip.texinfo @@ -5,8 +5,8 @@ @finalout @c %**end of header -@set UPDATED 11 January 2011 -@set VERSION 1.1 +@set UPDATED 18 May 2011 +@set VERSION 1.2 @dircategory Data Compression @direntry @@ -231,6 +231,11 @@ Decompress. @itemx --force Force overwrite of output file. +@item -F +@itemx --recompress +Force recompression of files whose name already has the @samp{.lz} or +@samp{.tlz} suffix. + @item -k @itemx --keep Keep (don't delete) input files during compression or decompression. @@ -260,7 +265,7 @@ Set the dictionary size limit in bytes. Valid values range from 4KiB to 512MiB. Clzip will use the smallest possible dictionary size for each member without exceeding this limit. Note that dictionary sizes are quantized. If the specified size does not match one of the valid sizes, -it will be rounded upwards. +it will be rounded upwards by adding up to (@var{size} / 16) to it. For maximum compression you should use a dictionary size limit as large as possible, but keep in mind that the decompression memory requirement @@ -282,8 +287,11 @@ Use it together with @samp{-v} to see information about the file. @item -v @itemx --verbose -Verbose mode. Show the compression ratio for each file processed. -Further -v's increase the verbosity level. +Verbose mode. +When compressing, show the compression ratio for each file processed. +When decompressing or testing, further -v's (up to 4) increase the +verbosity level, showing status, dictionary size, compression ratio, +and trailer contents (CRC, data size, member size). @item -1 .. -9 Set the compression parameters (dictionary size and match length limit) @@ -374,8 +382,8 @@ A four byte string, identifying the lzip format, with the value "LZIP". @item VN (version number, 1 byte) Just in case something needs to be modified in the future. Valid values -are 0 and 1. Version 0 files have only one member and lack @samp{Member -size}. +are 0 and 1. Version 0 files are deprecated. They can contain only one +member and lack the @samp{Member size} field. @item DS (coded dictionary size, 1 byte) Bits 4-0 contain the base 2 logarithm of the base dictionary size.@* |