diff options
Diffstat (limited to 'doc/lzlib.info')
| -rw-r--r-- | doc/lzlib.info | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/doc/lzlib.info b/doc/lzlib.info index 47460f9..683b18e 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.5-rc1, 28 July 2013). +This manual is for Lzlib (version 1.5, 15 September 2013). * Menu: @@ -126,17 +126,17 @@ minimum sizes: * Input compression buffer. Written to by the `LZ_compress_write' function. Its size is two times the dictionary size set with the - `LZ_compress_open' function or 64KiB, whichever is larger. + `LZ_compress_open' function or 64 KiB, whichever is larger. * Output compression buffer. Read from by the `LZ_compress_read' - function. Its size is 64KiB. + function. Its size is 64 KiB. * Input decompression buffer. Written to by the - `LZ_decompress_write' function. Its size is 64KiB. + `LZ_decompress_write' function. Its size is 64 KiB. * Output decompression buffer. Read from by the `LZ_decompress_read' function. Its size is the dictionary size set in the header of the - member currently being decompressed or 64KiB, whichever is larger. + member currently being decompressed or 64 KiB, whichever is larger. File: lzlib.info, Node: Parameter limits, Next: Compression functions, Prev: Buffering, Up: Top @@ -152,14 +152,14 @@ Current values are shown in square brackets. [12]. -- Function: int LZ_min_dictionary_size ( void ) - Returns the smallest valid dictionary size [4KiB]. + Returns the smallest valid dictionary size [4 KiB]. -- Function: int LZ_max_dictionary_bits ( void ) Returns the base 2 logarithm of the largest valid dictionary size [29]. -- Function: int LZ_max_dictionary_size ( void ) - Returns the largest valid dictionary size [512MiB]. + Returns the largest valid dictionary size [512 MiB]. -- Function: int LZ_min_match_len_limit ( void ) Returns the smallest valid match length limit [5]. @@ -192,9 +192,9 @@ calling `LZ_compress_errno' before using it. should be freed with `LZ_compress_close' to avoid memory leaks. 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 by adding up to + Valid values range from 4 KiB to 512 MiB. Note that dictionary + sizes are quantized. If the specified size does not match one of + the 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 @@ -202,7 +202,7 @@ calling `LZ_compress_errno' before using it. ratios but longer compression times. MEMBER_SIZE sets the member size limit in bytes. Minimum member - size limit is 100kB. Small member size may degrade compression + size limit is 100 kB. Small member size may degrade compression ratio, so use it only when needed. To produce a single-member data stream, give MEMBER_SIZE a value larger than the amount of data to be produced, for example INT64_MAX. @@ -536,7 +536,7 @@ with no additional information before, between, or after them. `ID string' A four byte string, identifying the lzip format, with the value - "LZIP". + "LZIP" (0x4C, 0x5A, 0x49, 0x50). `VN (version number, 1 byte)' Just in case something needs to be modified in the future. 1 for @@ -551,8 +551,8 @@ with no additional information before, between, or after them. 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. + Example: 0xD3 = 2^19 - 6 * 2^15 = 512 KiB - 6 * 32 KiB = 320 KiB + Valid values for dictionary size range from 4 KiB to 512 MiB. `Lzma stream' The lzma stream, finished by an end of stream marker. Uses default @@ -697,7 +697,7 @@ next member in case of data error. File: lzlib.info, Node: Problems, Next: Concept index, Prev: Examples, Up: Top -11 Reporting Bugs +11 Reporting bugs ***************** There are probably bugs in Lzlib. There are certainly errors and @@ -737,18 +737,18 @@ Concept index Tag Table: Node: Top217 -Node: Introduction1322 -Node: Library version3903 -Node: Buffering4548 -Node: Parameter limits5667 -Node: Compression functions6624 -Node: Decompression functions12834 -Node: Error codes18995 -Node: Error messages20934 -Node: Data format21513 -Node: Examples24136 -Node: Problems28219 -Node: Concept index28791 +Node: Introduction1323 +Node: Library version3904 +Node: Buffering4549 +Node: Parameter limits5672 +Node: Compression functions6631 +Node: Decompression functions12844 +Node: Error codes19005 +Node: Error messages20944 +Node: Data format21523 +Node: Examples24172 +Node: Problems28255 +Node: Concept index28827 End Tag Table |