summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/lzlib.info34
-rw-r--r--doc/lzlib.texinfo16
2 files changed, 31 insertions, 19 deletions
diff --git a/doc/lzlib.info b/doc/lzlib.info
index e688ea6..b9ddf30 100644
--- a/doc/lzlib.info
+++ b/doc/lzlib.info
@@ -12,7 +12,7 @@ File: lzlib.info, Node: Top, Next: Introduction, Up: (dir)
Lzlib
*****
-This manual is for Lzlib (version 0.5, 3 July 2009).
+This manual is for Lzlib (version 0.6, 2 September 2009).
* Menu:
@@ -53,6 +53,12 @@ read/write functions until all the data has been processed by the
library. This interface is safer and less error prone than the
traditional zlib interface.
+ Compression/decompression is done when the read function is called.
+This means the value returned by the position functions will not be
+updated until some data is read, even if you write a lot of data. If
+you want the data to be compressed in advance, just call the read
+function with a SIZE equal to 0.
+
Lzlib will correctly decompress a data stream which is the
concatenation of two or more compressed data streams. The result is the
concatenation of the corresponding uncompressed data streams. Integrity
@@ -443,7 +449,7 @@ Example 1: Normal compression (MEMBER_SIZE > total output).
4) go back to step 2 until all input data has been written
5) LZ_compress_finish
6) LZ_compress_read
- 7) go back to step 6 until LZ_compress_read returns 0
+ 7) go back to step 6 until LZ_compress_finished returns 1
8) LZ_compress_close
@@ -455,7 +461,7 @@ Example 2: Decompression.
4) go back to step 2 until all input data has been written
5) LZ_decompress_finish
6) LZ_decompress_read
- 7) go back to step 6 until LZ_decompress_read returns 0
+ 7) go back to step 6 until LZ_decompress_finished returns 1
8) LZ_decompress_close
@@ -469,7 +475,7 @@ Example 3: Multimember compression (MEMBER_SIZE < total output).
6) go back to step 2 until all input data has been written
7) LZ_compress_finish
8) LZ_compress_read
- 9) go back to step 8 until LZ_compress_read returns 0
+ 9) go back to step 8 until LZ_compress_finished returns 1
10) LZ_compress_close

@@ -513,15 +519,15 @@ Concept Index

Tag Table:
Node: Top219
-Node: Introduction1010
-Node: Library Version2477
-Node: Buffering3122
-Node: Compression Functions4229
-Node: Decompression Functions9731
-Node: Error Codes13169
-Node: Data Format15105
-Node: Examples17072
-Node: Problems18494
-Node: Concept Index19064
+Node: Introduction1015
+Node: Library Version2790
+Node: Buffering3435
+Node: Compression Functions4542
+Node: Decompression Functions10044
+Node: Error Codes13482
+Node: Data Format15418
+Node: Examples17385
+Node: Problems18819
+Node: Concept Index19389

End Tag Table
diff --git a/doc/lzlib.texinfo b/doc/lzlib.texinfo
index d0cdd2b..409b053 100644
--- a/doc/lzlib.texinfo
+++ b/doc/lzlib.texinfo
@@ -5,8 +5,8 @@
@finalout
@c %**end of header
-@set UPDATED 3 July 2009
-@set VERSION 0.5
+@set UPDATED 2 September 2009
+@set VERSION 0.6
@dircategory Data Compression
@direntry
@@ -69,6 +69,12 @@ read/write functions until all the data has been processed by the
library. This interface is safer and less error prone than the
traditional zlib interface.
+Compression/decompression is done when the read function is called. This
+means the value returned by the position functions will not be updated
+until some data is read, even if you write a lot of data. If you want
+the data to be compressed in advance, just call the read function with a
+@var{size} equal to 0.
+
Lzlib will correctly decompress a data stream which is the concatenation
of two or more compressed data streams. The result is the concatenation
of the corresponding uncompressed data streams. Integrity testing of
@@ -515,7 +521,7 @@ Example 1: Normal compression (@var{member_size} > total output).
4) go back to step 2 until all input data has been written
5) LZ_compress_finish
6) LZ_compress_read
-7) go back to step 6 until LZ_compress_read returns 0
+7) go back to step 6 until LZ_compress_finished returns 1
8) LZ_compress_close
@end example
@@ -531,7 +537,7 @@ Example 2: Decompression.
4) go back to step 2 until all input data has been written
5) LZ_decompress_finish
6) LZ_decompress_read
-7) go back to step 6 until LZ_decompress_read returns 0
+7) go back to step 6 until LZ_decompress_finished returns 1
8) LZ_decompress_close
@end example
@@ -549,7 +555,7 @@ Example 3: Multimember compression (@var{member_size} < total output).
6) go back to step 2 until all input data has been written
7) LZ_compress_finish
8) LZ_compress_read
- 9) go back to step 8 until LZ_compress_read returns 0
+ 9) go back to step 8 until LZ_compress_finished returns 1
10) LZ_compress_close
@end example