diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/clzip.1 | 4 | ||||
| -rw-r--r-- | doc/clzip.info | 62 | ||||
| -rw-r--r-- | doc/clzip.texinfo | 45 |
3 files changed, 67 insertions, 44 deletions
diff --git a/doc/clzip.1 b/doc/clzip.1 index 48401e2..02181a7 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" "February 2012" "Clzip 1.3" "User Commands" +.TH CLZIP "1" "February 2013" "Clzip 1.4" "User Commands" .SH NAME Clzip \- reduces the size of files .SH SYNOPSIS @@ -76,7 +76,7 @@ Report bugs to lzip\-bug@nongnu.org .br Clzip home page: http://www.nongnu.org/lzip/clzip.html .SH COPYRIGHT -Copyright \(co 2012 Antonio Diaz Diaz. +Copyright \(co 2013 Antonio Diaz Diaz. 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. diff --git a/doc/clzip.info b/doc/clzip.info index e4b9d3e..ccec058 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.3, 25 February 2012). +This manual is for Clzip (version 1.4, 18 February 2013). * Menu: @@ -25,7 +25,7 @@ This manual is for Clzip (version 1.3, 25 February 2012). * Concept Index:: Index of concepts - Copyright (C) 2010, 2011, 2012 Antonio Diaz Diaz. + Copyright (C) 2010, 2011, 2012, 2013 Antonio Diaz Diaz. This manual is free documentation: you have unlimited permission to copy, distribute and modify it. @@ -73,11 +73,15 @@ also split the compressed output in volumes of a given size, even when reading from standard input. This allows the direct creation of multivolume compressed tar archives. - The amount of memory required for compression is about 5 MiB plus 1 -or 2 times the dictionary size limit (1 if input file size is less than -dictionary size limit, else 2) plus 8 times the dictionary size really -used. The amount of memory required for decompression is only a few tens -of KiB larger than the dictionary size really used. + Clzip is able to compress and decompress streams of unlimited size by +automatically creating multi-member output. The members so created are +large (about 2^60 bytes each). + + The amount of memory required for compression is about 1 or 2 times +the dictionary size limit (1 if input file size is less than dictionary +size limit, else 2) plus 9 times the dictionary size really used. The +amount of memory required for decompression is only a few tens of KiB +larger than the dictionary size really used. Clzip will automatically use the smallest possible dictionary size without exceeding the given limit. Keep in mind that the decompression @@ -328,7 +332,12 @@ File: clzip.info, Node: File Format, Next: Examples, Prev: Invoking Clzip, U 4 File Format ************* -In the diagram below, a box like this: +Perfection is reached, not when there is no longer anything to add, but +when there is no longer anything to take away. +-- Antoine de Saint-Exupery + + + In the diagram below, a box like this: +---+ | | <-- the vertical bars might be missing +---+ @@ -357,15 +366,18 @@ additional information before, between, or after them. "LZIP". `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 are deprecated. They can - contain only one member and lack the `Member size' field. + Just in case something needs to be modified in the future. 1 for + 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. Valid values for dictionary size range from 4KiB to 512MiB. `Lzma stream' @@ -379,9 +391,9 @@ additional information before, between, or after them. Size of the uncompressed original data. `Member size (8 bytes)' - Total size of the member, including header and trailer. This - facilitates safe recovery of undamaged members from multi-member - files. + 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. @@ -496,13 +508,13 @@ Concept Index Tag Table: Node: Top226 -Node: Introduction914 -Node: Algorithm4584 -Node: Invoking Clzip7108 -Node: File Format12380 -Node: Examples14375 -Node: Problems16336 -Node: Concept Index16862 +Node: Introduction920 +Node: Algorithm4755 +Node: Invoking Clzip7279 +Node: File Format12551 +Node: Examples14860 +Node: Problems16821 +Node: Concept Index17347 End Tag Table diff --git a/doc/clzip.texinfo b/doc/clzip.texinfo index 284ed3f..1d0479f 100644 --- a/doc/clzip.texinfo +++ b/doc/clzip.texinfo @@ -6,8 +6,8 @@ @finalout @c %**end of header -@set UPDATED 25 February 2012 -@set VERSION 1.3 +@set UPDATED 18 February 2013 +@set VERSION 1.4 @dircategory Data Compression @direntry @@ -45,7 +45,7 @@ This manual is for Clzip (version @value{VERSION}, @value{UPDATED}). @end menu @sp 1 -Copyright @copyright{} 2010, 2011, 2012 Antonio Diaz Diaz. +Copyright @copyright{} 2010, 2011, 2012, 2013 Antonio Diaz Diaz. This manual is free documentation: you have unlimited permission to copy, distribute and modify it. @@ -92,11 +92,15 @@ also split the compressed output in volumes of a given size, even when reading from standard input. This allows the direct creation of multivolume compressed tar archives. -The amount of memory required for compression is about 5 MiB plus 1 or 2 -times the dictionary size limit (1 if input file size is less than -dictionary size limit, else 2) plus 8 times the dictionary size really -used. The amount of memory required for decompression is only a few tens -of KiB larger than the dictionary size really used. +Clzip is able to compress and decompress streams of unlimited size by +automatically creating multi-member output. The members so created are +large (about 2^60 bytes each). + +The amount of memory required for compression is about 1 or 2 times the +dictionary size limit (1 if input file size is less than dictionary size +limit, else 2) plus 9 times the dictionary size really used. The amount +of memory required for decompression is only a few tens of KiB larger +than the dictionary size really used. Clzip will automatically use the smallest possible dictionary size without exceeding the given limit. Keep in mind that the decompression @@ -350,6 +354,11 @@ Table of SI and binary prefixes (unit multipliers): @chapter File Format @cindex file format +Perfection is reached, not when there is no longer anything to add, but +when there is no longer anything to take away.@* +--- Antoine de Saint-Exupery + +@sp 1 In the diagram below, a box like this: @verbatim +---+ @@ -385,15 +394,16 @@ All multibyte values are stored in little endian order. 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 are deprecated. They can contain only one -member and lack the @samp{Member size} field. +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.@* Valid values for dictionary size range from 4KiB to 512MiB. @item Lzma stream @@ -407,8 +417,9 @@ CRC of the uncompressed original data. Size of the uncompressed original data. @item Member size (8 bytes) -Total size of the member, including header and trailer. This facilitates -safe recovery of undamaged members from multi-member files. +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. @end table |