diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lzlib.info | 39 | ||||
| -rw-r--r-- | doc/lzlib.texinfo | 17 |
2 files changed, 29 insertions, 27 deletions
diff --git a/doc/lzlib.info b/doc/lzlib.info index 4fddce8..e502f6b 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.1, 3 January 2011). +This manual is for Lzlib (version 1.2, 25 October 2011). * Menu: @@ -180,7 +180,8 @@ verified by calling `LZ_compress_errno' before using it. DICTIONARY_SIZE sets the dictionary size to be used, in bytes. Valid values range from 4KiB to 512MiB. Note that dictionary sizes are quantized. If the specified size does not match one of the - valid sizes, it will be rounded upwards. + valid sizes, it will be rounded upwards by adding up to + (DICTIONARY_SIZE / 16) to it. MATCH_LEN_LIMIT sets the match length limit in bytes. Valid values range from 5 to 273. Larger values usually give better compression @@ -252,7 +253,7 @@ verified by calling `LZ_compress_errno' before using it. -- Function: enum LZ_Errno LZ_compress_errno ( struct LZ_Encoder * const ENCODER ) - Returns the current error code for ENCODER (*note Error Codes::) + Returns the current error code for ENCODER (*note Error Codes::). -- Function: int LZ_compress_finished ( struct LZ_Encoder * const ENCODER ) @@ -367,7 +368,7 @@ be verified by calling `LZ_decompress_errno' before using it. -- Function: enum LZ_Errno LZ_decompress_errno ( struct LZ_Decoder * const DECODER ) - Returns the current error code for DECODER (*note Error Codes::) + Returns the current error code for DECODER (*note Error Codes::). -- Function: int LZ_decompress_finished ( struct LZ_Decoder * const DECODER ) @@ -514,13 +515,13 @@ with no additional information before, between, or after them. All multibyte values are stored in little endian order. `ID string' - A four byte string, identifying the member type, with the value + A four byte string, identifying the lzip format, with the value "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 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. @@ -703,17 +704,17 @@ Concept Index Tag Table: Node: Top219 -Node: Introduction1310 -Node: Library Version3135 -Node: Buffering3780 -Node: Parameter Limits4900 -Node: Compression Functions5857 -Node: Decompression Functions11903 -Node: Error Codes17974 -Node: Error Messages19913 -Node: Data Format20492 -Node: Examples22462 -Node: Problems26328 -Node: Concept Index26900 +Node: Introduction1311 +Node: Library Version3136 +Node: Buffering3781 +Node: Parameter Limits4901 +Node: Compression Functions5858 +Node: Decompression Functions11955 +Node: Error Codes18027 +Node: Error Messages19966 +Node: Data Format20545 +Node: Examples22553 +Node: Problems26419 +Node: Concept Index26991 End Tag Table diff --git a/doc/lzlib.texinfo b/doc/lzlib.texinfo index d03d817..55e5fa6 100644 --- a/doc/lzlib.texinfo +++ b/doc/lzlib.texinfo @@ -5,8 +5,8 @@ @finalout @c %**end of header -@set UPDATED 3 January 2011 -@set VERSION 1.1 +@set UPDATED 25 October 2011 +@set VERSION 1.2 @dircategory Data Compression @direntry @@ -204,7 +204,8 @@ should be freed with @samp{LZ_compress_close} to avoid memory leaks. @var{dictionary_size} sets the dictionary size to be used, in bytes. Valid values range from 4KiB to 512MiB. 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{dictionary_size} / 16) +to it. @var{match_len_limit} sets the match length limit in bytes. Valid values range from 5 to 273. Larger values usually give better compression @@ -285,7 +286,7 @@ accept a @var{size} up to the returned number of bytes. @deftypefun {enum LZ_Errno} LZ_compress_errno ( struct LZ_Encoder * const @var{encoder} ) -Returns the current error code for @var{encoder} (@pxref{Error Codes}) +Returns the current error code for @var{encoder} (@pxref{Error Codes}). @end deftypefun @@ -417,7 +418,7 @@ will accept a @var{size} up to the returned number of bytes. @deftypefun {enum LZ_Errno} LZ_decompress_errno ( struct LZ_Decoder * const @var{decoder} ) -Returns the current error code for @var{decoder} (@pxref{Error Codes}) +Returns the current error code for @var{decoder} (@pxref{Error Codes}). @end deftypefun @@ -585,12 +586,12 @@ All multibyte values are stored in little endian order. @table @samp @item ID string -A four byte string, identifying the member type, with the value "LZIP". +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.@* |