From 2a7c0444ca9f1dfca772c4f694d4501c69e62632 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 7 Nov 2015 15:05:37 +0100 Subject: Merging upstream version 1.6. Signed-off-by: Daniel Baumann --- doc/lzlib.info | 41 +++++++++++++++++++++++++---------------- doc/lzlib.texi | 20 ++++++++++++++------ doc/minilzip.1 | 8 ++++---- 3 files changed, 43 insertions(+), 26 deletions(-) (limited to 'doc') diff --git a/doc/lzlib.info b/doc/lzlib.info index 2b4aaf7..6814d19 100644 --- a/doc/lzlib.info +++ b/doc/lzlib.info @@ -11,7 +11,7 @@ File: lzlib.info, Node: Top, Next: Introduction, Up: (dir) Lzlib Manual ************ -This manual is for Lzlib (version 1.6-rc2, 19 June 2014). +This manual is for Lzlib (version 1.6, 27 August 2014). * Menu: @@ -29,7 +29,7 @@ This manual is for Lzlib (version 1.6-rc2, 19 June 2014). * Concept index:: Index of concepts - Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Antonio Diaz Diaz. + Copyright (C) 2009-2014 Antonio Diaz Diaz. This manual is free documentation: you have unlimited permission to copy, distribute and modify it. @@ -64,6 +64,11 @@ into account both data integrity and decoder availability: * Additionally lzip is copylefted, which guarantees that it will remain free forever. + A nice feature of the lzip format is that a corrupt byte is easier to +repair the nearer it is from the beginning of the file. Therefore, with +the help of lziprecover, losing an entire archive just because of a +corrupt byte near the beginning is a thing of the past. + 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.c' and 'bbexample.c' from the @@ -143,7 +148,7 @@ File: lzlib.info, Node: Buffering, Next: Parameter limits, Prev: Library vers Lzlib internal functions need access to a memory chunk at least as large as the dictionary size (sliding window). For efficiency reasons, the input buffer for compression is twice as large as the dictionary size. -Finally, for security reasons, lzlib uses two more internal buffers. +Finally, for safety reasons, lzlib uses two more internal buffers. These are the four buffers used by lzlib, and their guaranteed minimum sizes: @@ -256,7 +261,11 @@ calling 'LZ_compress_errno' before using it. -- Function: int LZ_compress_sync_flush ( struct LZ_Encoder * const ENCODER ) Use this function to make available to 'LZ_compress_read' all the - data already written with the 'LZ_compress_write' function. + data already written with the 'LZ_compress_write' function. First + call 'LZ_compress_read' until it returns 0. Then call + 'LZ_compress_sync_flush'. Finally, call 'LZ_compress_read' again + to read the remaining data. + Repeated use of 'LZ_compress_sync_flush' may degrade compression ratio, so use it only when needed. @@ -761,18 +770,18 @@ Concept index  Tag Table: Node: Top220 -Node: Introduction1331 -Node: Library version5244 -Node: Buffering5889 -Node: Parameter limits7012 -Node: Compression functions7971 -Node: Decompression functions14184 -Node: Error codes20345 -Node: Error messages22284 -Node: Data format22863 -Node: Examples25512 -Node: Problems29595 -Node: Concept index30167 +Node: Introduction1304 +Node: Library version5487 +Node: Buffering6132 +Node: Parameter limits7253 +Node: Compression functions8212 +Node: Decompression functions14594 +Node: Error codes20755 +Node: Error messages22694 +Node: Data format23273 +Node: Examples25922 +Node: Problems30005 +Node: Concept index30577  End Tag Table diff --git a/doc/lzlib.texi b/doc/lzlib.texi index 378e630..1a9d9b6 100644 --- a/doc/lzlib.texi +++ b/doc/lzlib.texi @@ -6,8 +6,8 @@ @finalout @c %**end of header -@set UPDATED 19 June 2014 -@set VERSION 1.6-rc2 +@set UPDATED 27 August 2014 +@set VERSION 1.6 @dircategory Data Compression @direntry @@ -50,8 +50,7 @@ This manual is for Lzlib (version @value{VERSION}, @value{UPDATED}). @end menu @sp 1 -Copyright @copyright{} 2009, 2010, 2011, 2012, 2013, 2014 -Antonio Diaz Diaz. +Copyright @copyright{} 2009-2014 Antonio Diaz Diaz. This manual is free documentation: you have unlimited permission to copy, distribute and modify it. @@ -90,6 +89,11 @@ Additionally lzip is copylefted, which guarantees that it will remain free forever. @end itemize +A nice feature of the lzip format is that a corrupt byte is easier to +repair the nearer it is from the beginning of the file. Therefore, with +the help of lziprecover, losing an entire archive just because of a +corrupt byte near the beginning is a thing of the past. + 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.c} and @samp{bbexample.c} from @@ -170,7 +174,7 @@ if( LZ_version()[0] != LZ_version_string[0] ) Lzlib internal functions need access to a memory chunk at least as large as the dictionary size (sliding window). For efficiency reasons, the input buffer for compression is twice as large as the dictionary size. -Finally, for security reasons, lzlib uses two more internal buffers. +Finally, for safety reasons, lzlib uses two more internal buffers. These are the four buffers used by lzlib, and their guaranteed minimum sizes: @@ -292,7 +296,11 @@ indicates that the current member has been fully read (with the @deftypefun int LZ_compress_sync_flush ( struct LZ_Encoder * const @var{encoder} ) Use this function to make available to @samp{LZ_compress_read} all the -data already written with the @samp{LZ_compress_write} function. +data already written with the @samp{LZ_compress_write} function. First +call @samp{LZ_compress_read} until it returns 0. Then call +@samp{LZ_compress_sync_flush}. Finally, call @samp{LZ_compress_read} +again to read the remaining data. + Repeated use of @samp{LZ_compress_sync_flush} may degrade compression ratio, so use it only when needed. @end deftypefun diff --git a/doc/minilzip.1 b/doc/minilzip.1 index e69cda5..93ee47f 100644 --- a/doc/minilzip.1 +++ b/doc/minilzip.1 @@ -1,10 +1,10 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. -.TH MINILZIP "1" "June 2014" "minilzip 1.6-rc2" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1. +.TH MINILZIP "1" "August 2014" "minilzip 1.6" "User Commands" .SH NAME minilzip \- reduces the size of files .SH SYNOPSIS .B minilzip -[\fIoptions\fR] [\fIfiles\fR] +[\fI\,options\/\fR] [\fI\,files\/\fR] .SH DESCRIPTION Minilzip \- Test program for the lzlib library. .SH OPTIONS @@ -83,7 +83,7 @@ Report bugs to lzip\-bug@nongnu.org Lzlib home page: http://www.nongnu.org/lzip/lzlib.html .SH COPYRIGHT Copyright \(co 2014 Antonio Diaz Diaz. -Using lzlib 1.6\-rc2 +Using lzlib 1.6 License GPLv2+: GNU GPL version 2 or later .br This is free software: you are free to change and redistribute it. -- cgit v1.2.3