diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lzlib.info | 47 | ||||
| -rw-r--r-- | doc/lzlib.texinfo | 22 | ||||
| -rw-r--r-- | doc/minilzip.1 | 9 |
3 files changed, 47 insertions, 31 deletions
diff --git a/doc/lzlib.info b/doc/lzlib.info index 511fda5..84e0501 100644 --- a/doc/lzlib.info +++ b/doc/lzlib.info @@ -12,7 +12,7 @@ File: lzlib.info, Node: Top, Next: Introduction, Up: (dir) Lzlib Manual ************ -This manual is for Lzlib (version 1.4-rc2, 7 February 2013). +This manual is for Lzlib (version 1.4, 28 May 2013). * Menu: @@ -530,15 +530,21 @@ with no additional information before, between, or after them. now. `DS (coded dictionary size, 1 byte)' - Bits 4-0 contain the base 2 logarithm of the base dictionary size. - Bits 7-5 contain the number of "wedges" to substract from the base - dictionary size to obtain the dictionary size. The size of a wedge - is (base dictionary size / 16). + Lzip divides the distance between any two powers of 2 into 8 + equally spaced intervals, named "wedges". The dictionary size is + calculated by taking a power of 2 (the base size) and substracting + from it a number of wedges between 0 and 7. The size of a wedge is + (base_size / 16). + Bits 4-0 contain the base 2 logarithm of the base size (12 to 29). + Bits 7-5 contain the number of wedges (0 to 7) to substract from + the base size to obtain the dictionary size. + Example: 0xD3 = (2^19 - 6 * 2^15) = (512KiB - 6 * 32KiB) = 320KiB Valid values for dictionary size range from 4KiB to 512MiB. `Lzma stream' The lzma stream, finished by an end of stream marker. Uses default - values for encoder properties. + values for encoder properties. See the lzip manual for a full + description. `CRC32 (4 bytes)' CRC of the uncompressed original data. @@ -548,8 +554,9 @@ with no additional information before, between, or after them. `Member size (8 bytes)' Total size of the member, including header and trailer. This field - acts as a distributed index, and facilitates safe recovery of - undamaged members from multi-member files. + acts as a distributed index, allows the verification of stream + integrity, and facilitates safe recovery of undamaged members from + multi-member files. @@ -715,18 +722,18 @@ Concept Index Tag Table: Node: Top219 -Node: Introduction1327 -Node: Library Version3173 -Node: Buffering3818 -Node: Parameter Limits4937 -Node: Compression Functions5894 -Node: Decompression Functions12104 -Node: Error Codes18265 -Node: Error Messages20204 -Node: Data Format20783 -Node: Examples22864 -Node: Problems26947 -Node: Concept Index27519 +Node: Introduction1319 +Node: Library Version3165 +Node: Buffering3810 +Node: Parameter Limits4929 +Node: Compression Functions5886 +Node: Decompression Functions12096 +Node: Error Codes18257 +Node: Error Messages20196 +Node: Data Format20775 +Node: Examples23268 +Node: Problems27351 +Node: Concept Index27923 End Tag Table diff --git a/doc/lzlib.texinfo b/doc/lzlib.texinfo index eeae174..c08303e 100644 --- a/doc/lzlib.texinfo +++ b/doc/lzlib.texinfo @@ -6,8 +6,8 @@ @finalout @c %**end of header -@set UPDATED 7 February 2013 -@set VERSION 1.4-rc2 +@set UPDATED 28 May 2013 +@set VERSION 1.4 @dircategory Data Compression @direntry @@ -600,15 +600,19 @@ A four byte string, identifying the lzip format, with the value "LZIP". Just in case something needs to be modified in the future. 1 for now. @item DS (coded dictionary size, 1 byte) -Bits 4-0 contain the base 2 logarithm of the base dictionary size.@* -Bits 7-5 contain the number of "wedges" to substract from the base -dictionary size to obtain the dictionary size. The size of a wedge is -(base dictionary size / 16).@* +Lzip divides the distance between any two powers of 2 into 8 equally +spaced intervals, named "wedges". The dictionary size is calculated by +taking a power of 2 (the base size) and substracting from it a number of +wedges between 0 and 7. The size of a wedge is (base_size / 16).@* +Bits 4-0 contain the base 2 logarithm of the base size (12 to 29).@* +Bits 7-5 contain the number of wedges (0 to 7) to substract from the +base size to obtain the dictionary size.@* +Example: 0xD3 = (2^19 - 6 * 2^15) = (512KiB - 6 * 32KiB) = 320KiB@* Valid values for dictionary size range from 4KiB to 512MiB. @item Lzma stream The lzma stream, finished by an end of stream marker. Uses default values -for encoder properties. +for encoder properties. See the lzip manual for a full description. @item CRC32 (4 bytes) CRC of the uncompressed original data. @@ -618,8 +622,8 @@ Size of the uncompressed original data. @item Member size (8 bytes) Total size of the member, including header and trailer. This field acts -as a distributed index, and facilitates safe recovery of undamaged -members from multi-member files. +as a distributed index, allows the verification of stream integrity, and +facilitates safe recovery of undamaged members from multi-member files. @end table diff --git a/doc/minilzip.1 b/doc/minilzip.1 index a7f6d21..eba916d 100644 --- a/doc/minilzip.1 +++ b/doc/minilzip.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. -.TH MINILZIP "1" "February 2013" "Minilzip 1.4-rc2" "User Commands" +.TH MINILZIP "1" "May 2013" "Minilzip 1.4" "User Commands" .SH NAME Minilzip \- reduces the size of files .SH SYNOPSIS @@ -71,13 +71,18 @@ The bidimensional parameter space of LZMA can't be mapped to a linear scale optimal for all files. If your files are large, very repetitive, etc, you may need to use the \fB\-\-match\-length\fR and \fB\-\-dictionary\-size\fR options directly to achieve optimal performance. +.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 minilzip to panic. .SH "REPORTING BUGS" Report bugs to lzip\-bug@nongnu.org .br Lzlib home page: http://www.nongnu.org/lzip/lzlib.html .SH COPYRIGHT Copyright \(co 2013 Antonio Diaz Diaz. -Using Lzlib 1.4\-rc2 +Using Lzlib 1.4 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> .br This is free software: you are free to change and redistribute it. |