Merging upstream version 1.3.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
ca6761125f
commit
fc6608e14a
GPG key ID:
FBB4F0E80A80222F
29 changed files with 4948 additions and 4279 deletions
|
|
@ -12,7 +12,7 @@ File: lzlib.info, Node: Top, Next: Introduction, Up: (dir)
|
|||
Lzlib Manual
|
||||
************
|
||||
|
||||
This manual is for Lzlib (version 1.2, 25 October 2011).
|
||||
This manual is for Lzlib (version 1.3, 29 February 2012).
|
||||
|
||||
* Menu:
|
||||
|
||||
|
|
@ -30,7 +30,7 @@ This manual is for Lzlib (version 1.2, 25 October 2011).
|
|||
* Concept Index:: Index of concepts
|
||||
|
||||
|
||||
Copyright (C) 2009, 2010, 2011 Antonio Diaz Diaz.
|
||||
Copyright (C) 2009, 2010, 2011, 2012 Antonio Diaz Diaz.
|
||||
|
||||
This manual is free documentation: you have unlimited permission to
|
||||
copy, distribute and modify it.
|
||||
|
|
@ -44,11 +44,11 @@ File: lzlib.info, Node: Introduction, Next: Library Version, Prev: Top, Up:
|
|||
Lzlib is a data compression library providing in-memory LZMA compression
|
||||
and decompression functions, including integrity checking of the
|
||||
decompressed data. The compressed data format used by the library is the
|
||||
lzip format.
|
||||
lzip format. Lzlib is written in C.
|
||||
|
||||
The functions and variables forming the interface of the compression
|
||||
library are declared in the file `lzlib.h'. Usage examples of the
|
||||
library are given in the files `main.cc' and `bbexample.cc' from the
|
||||
library are given in the files `main.c' and `bbexample.c' from the
|
||||
source distribution.
|
||||
|
||||
Compression/decompression is done by repeatedly calling a couple of
|
||||
|
|
@ -189,7 +189,7 @@ verified by calling `LZ_compress_errno' before using it.
|
|||
|
||||
MEMBER_SIZE sets the member size limit in bytes. Minimum member
|
||||
size limit is 100kB. Small member size may degrade compression
|
||||
ratio, so use it only when needed. To produce a single member data
|
||||
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 LLONG_MAX.
|
||||
|
||||
|
|
@ -210,7 +210,7 @@ verified by calling `LZ_compress_errno' before using it.
|
|||
|
||||
-- Function: int LZ_compress_restart_member ( struct LZ_Encoder *
|
||||
const ENCODER, const long long MEMBER_SIZE )
|
||||
Use this function to start a new member, in a multimember data
|
||||
Use this function to start a new member, in a multi-member data
|
||||
stream. Call this function only after
|
||||
`LZ_compress_member_finished' indicates that the current member
|
||||
has been fully read (with the `LZ_compress_read' function).
|
||||
|
|
@ -262,8 +262,8 @@ verified by calling `LZ_compress_errno' before using it.
|
|||
|
||||
-- Function: int LZ_compress_member_finished ( struct LZ_Encoder *
|
||||
const ENCODER )
|
||||
Returns 1 if the current member, in a multimember data stream, has
|
||||
been fully read and `LZ_compress_restart_member' can be safely
|
||||
Returns 1 if the current member, in a multi-member data stream,
|
||||
has been fully read and `LZ_compress_restart_member' can be safely
|
||||
called. Otherwise it returns 0.
|
||||
|
||||
-- Function: long long LZ_compress_data_position ( struct LZ_Encoder *
|
||||
|
|
@ -542,7 +542,7 @@ with no additional information before, between, or after them.
|
|||
|
||||
`Member size (8 bytes)'
|
||||
Total size of the member, including header and trailer. This
|
||||
facilitates safe recovery of undamaged members from multimember
|
||||
facilitates safe recovery of undamaged members from multi-member
|
||||
files.
|
||||
|
||||
|
||||
|
|
@ -554,10 +554,15 @@ File: lzlib.info, Node: Examples, Next: Problems, Prev: Data Format, Up: Top
|
|||
|
||||
This chapter shows the order in which the library functions should be
|
||||
called depending on what kind of data stream you want to compress or
|
||||
decompress. See the file `bbexample.cc' in the source distribution for
|
||||
decompress. See the file `bbexample.c' in the source distribution for
|
||||
an example of how buffer-to-buffer compression/decompression can be
|
||||
implemented using lzlib.
|
||||
|
||||
Note that lzlib's interface is symmetrical. That is, the code for
|
||||
normal compression and decompression is identical except because one
|
||||
calls LZ_compress* functions while the other calls LZ_decompress*
|
||||
functions.
|
||||
|
||||
|
||||
Example 1: Normal compression (MEMBER_SIZE > total output).
|
||||
|
||||
|
|
@ -607,7 +612,7 @@ Example 4: Decompression using LZ_decompress_write_size.
|
|||
7) LZ_decompress_close
|
||||
|
||||
|
||||
Example 5: Multimember compression (MEMBER_SIZE < total output).
|
||||
Example 5: Multi-member compression (MEMBER_SIZE < total output).
|
||||
|
||||
1) LZ_compress_open
|
||||
2) go to step 5 if LZ_compress_write_size returns 0
|
||||
|
|
@ -621,7 +626,7 @@ Example 5: Multimember compression (MEMBER_SIZE < total output).
|
|||
10) LZ_compress_close
|
||||
|
||||
|
||||
Example 6: Multimember compression (user-restarted members).
|
||||
Example 6: Multi-member compression (user-restarted members).
|
||||
|
||||
1) LZ_compress_open
|
||||
2) LZ_compress_write
|
||||
|
|
@ -704,17 +709,22 @@ Concept Index
|
|||
|
||||
Tag Table:
|
||||
Node: Top219
|
||||
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
|
||||
Node: Introduction1318
|
||||
Node: Library Version3164
|
||||
Node: Buffering3809
|
||||
Node: Parameter Limits4929
|
||||
Node: Compression Functions5886
|
||||
Node: Decompression Functions11985
|
||||
Node: Error Codes18057
|
||||
Node: Error Messages19996
|
||||
Node: Data Format20575
|
||||
Node: Examples22584
|
||||
Node: Problems26667
|
||||
Node: Concept Index27239
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
||||
Local Variables:
|
||||
coding: iso-8859-15
|
||||
End:
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
\input texinfo @c -*-texinfo-*-
|
||||
@c %**start of header
|
||||
@setfilename lzlib.info
|
||||
@documentencoding ISO-8859-15
|
||||
@settitle Lzlib Manual
|
||||
@finalout
|
||||
@c %**end of header
|
||||
|
||||
@set UPDATED 25 October 2011
|
||||
@set VERSION 1.2
|
||||
@set UPDATED 29 February 2012
|
||||
@set VERSION 1.3
|
||||
|
||||
@dircategory Data Compression
|
||||
@direntry
|
||||
|
|
@ -49,7 +50,7 @@ This manual is for Lzlib (version @value{VERSION}, @value{UPDATED}).
|
|||
@end menu
|
||||
|
||||
@sp 1
|
||||
Copyright @copyright{} 2009, 2010, 2011 Antonio Diaz Diaz.
|
||||
Copyright @copyright{} 2009, 2010, 2011, 2012 Antonio Diaz Diaz.
|
||||
|
||||
This manual is free documentation: you have unlimited permission
|
||||
to copy, distribute and modify it.
|
||||
|
|
@ -62,12 +63,12 @@ to copy, distribute and modify it.
|
|||
Lzlib is a data compression library providing in-memory LZMA compression
|
||||
and decompression functions, including integrity checking of the
|
||||
decompressed data. The compressed data format used by the library is the
|
||||
lzip format.
|
||||
lzip format. Lzlib is written in C.
|
||||
|
||||
The functions and variables forming the interface of the compression
|
||||
library are declared in the file @samp{lzlib.h}. Usage examples of the
|
||||
library are given in the files @samp{main.cc} and @samp{bbexample.cc}
|
||||
from the source distribution.
|
||||
library are given in the files @samp{main.c} and @samp{bbexample.c} from
|
||||
the source distribution.
|
||||
|
||||
Compression/decompression is done by repeatedly calling a couple of
|
||||
read/write functions until all the data has been processed by the
|
||||
|
|
@ -213,7 +214,7 @@ ratios but longer compression times.
|
|||
|
||||
@var{member_size} sets the member size limit in bytes. Minimum member
|
||||
size limit is 100kB. Small member size may degrade compression ratio, so
|
||||
use it only when needed. To produce a single member data stream, give
|
||||
use it only when needed. To produce a single-member data stream, give
|
||||
@var{member_size} a value larger than the amount of data to be produced,
|
||||
for example LLONG_MAX.
|
||||
@end deftypefun
|
||||
|
|
@ -237,7 +238,7 @@ After all the produced compressed data has been read with
|
|||
|
||||
|
||||
@deftypefun int LZ_compress_restart_member ( struct LZ_Encoder * const @var{encoder}, const long long @var{member_size} )
|
||||
Use this function to start a new member, in a multimember data stream.
|
||||
Use this function to start a new member, in a multi-member data stream.
|
||||
Call this function only after @samp{LZ_compress_member_finished}
|
||||
indicates that the current member has been fully read (with the
|
||||
@samp{LZ_compress_read} function).
|
||||
|
|
@ -297,7 +298,7 @@ be safely called. Otherwise it returns 0.
|
|||
|
||||
|
||||
@deftypefun int LZ_compress_member_finished ( struct LZ_Encoder * const @var{encoder} )
|
||||
Returns 1 if the current member, in a multimember data stream, has been
|
||||
Returns 1 if the current member, in a multi-member data stream, has been
|
||||
fully read and @samp{LZ_compress_restart_member} can be safely called.
|
||||
Otherwise it returns 0.
|
||||
@end deftypefun
|
||||
|
|
@ -612,7 +613,7 @@ 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 multimember files.
|
||||
safe recovery of undamaged members from multi-member files.
|
||||
|
||||
@end table
|
||||
|
||||
|
|
@ -623,10 +624,14 @@ safe recovery of undamaged members from multimember files.
|
|||
|
||||
This chapter shows the order in which the library functions should be
|
||||
called depending on what kind of data stream you want to compress or
|
||||
decompress. See the file @samp{bbexample.cc} in the source distribution
|
||||
decompress. See the file @samp{bbexample.c} in the source distribution
|
||||
for an example of how buffer-to-buffer compression/decompression can be
|
||||
implemented using lzlib.
|
||||
|
||||
Note that lzlib's interface is symmetrical. That is, the code for normal
|
||||
compression and decompression is identical except because one calls
|
||||
LZ_compress* functions while the other calls LZ_decompress* functions.
|
||||
|
||||
@sp 1
|
||||
@noindent
|
||||
Example 1: Normal compression (@var{member_size} > total output).
|
||||
|
|
@ -693,7 +698,7 @@ Example 4: Decompression using LZ_decompress_write_size.
|
|||
|
||||
@sp 1
|
||||
@noindent
|
||||
Example 5: Multimember compression (@var{member_size} < total output).
|
||||
Example 5: Multi-member compression (@var{member_size} < total output).
|
||||
|
||||
@example
|
||||
1) LZ_compress_open
|
||||
|
|
@ -711,7 +716,7 @@ Example 5: Multimember compression (@var{member_size} < total output).
|
|||
|
||||
@sp 1
|
||||
@noindent
|
||||
Example 6: Multimember compression (user-restarted members).
|
||||
Example 6: Multi-member compression (user-restarted members).
|
||||
|
||||
@example
|
||||
1) LZ_compress_open
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue