summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDaniel Baumann <mail@daniel-baumann.ch>2015-11-07 09:59:28 +0000
committerDaniel Baumann <mail@daniel-baumann.ch>2015-11-07 09:59:28 +0000
commita12430a7bff80cea63fa05ffd716f0d5e91ddb6d (patch)
tree8dfed744f7334264782fa74b40386eec0061d03d /doc
parentAdding debian version 1.15~pre2-4. (diff)
downloadlzip-a12430a7bff80cea63fa05ffd716f0d5e91ddb6d.tar.xz
lzip-a12430a7bff80cea63fa05ffd716f0d5e91ddb6d.zip
Merging upstream version 1.15~pre3.
Signed-off-by: Daniel Baumann <mail@daniel-baumann.ch>
Diffstat (limited to 'doc')
-rw-r--r--doc/lzip.14
-rw-r--r--doc/lzip.info109
-rw-r--r--doc/lzip.texinfo74
3 files changed, 97 insertions, 90 deletions
diff --git a/doc/lzip.1 b/doc/lzip.1
index 3baec79..b7ea022 100644
--- a/doc/lzip.1
+++ b/doc/lzip.1
@@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
-.TH LZIP "1" "May 2013" "Lzip 1.15-pre2" "User Commands"
+.TH LZIP "1" "July 2013" "Lzip 1.15-pre3" "User Commands"
.SH NAME
Lzip \- reduces the size of files
.SH SYNOPSIS
.B lzip
[\fIoptions\fR] [\fIfiles\fR]
.SH DESCRIPTION
-Lzip \- Data compressor based on the LZMA algorithm.
+Lzip \- LZMA lossless data compressor.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
diff --git a/doc/lzip.info b/doc/lzip.info
index 9c4e874..97d2bbb 100644
--- a/doc/lzip.info
+++ b/doc/lzip.info
@@ -2,7 +2,7 @@ This is lzip.info, produced by makeinfo version 4.13 from lzip.texinfo.
INFO-DIR-SECTION Data Compression
START-INFO-DIR-ENTRY
-* Lzip: (lzip). Data compressor based on the LZMA algorithm
+* Lzip: (lzip). LZMA lossless data compressor
END-INFO-DIR-ENTRY

@@ -11,19 +11,19 @@ File: lzip.info, Node: Top, Next: Introduction, Up: (dir)
Lzip Manual
***********
-This manual is for Lzip (version 1.15-pre2, 11 May 2013).
+This manual is for Lzip (version 1.15-pre3, 15 July 2013).
* Menu:
* Introduction:: Purpose and features of lzip
* Algorithm:: How lzip compresses the data
-* Invoking Lzip:: Command line interface
-* File Format:: Detailed format of the compressed file
-* Stream Format:: Format of the LZMA stream in lzip files
+* Invoking lzip:: Command line interface
+* File format:: Detailed format of the compressed file
+* Stream format:: Format of the LZMA stream in lzip files
* Examples:: A small tutorial with examples
* Problems:: Reporting bugs
* Reference source code:: Source code illustrating stream format
-* Concept Index:: Index of concepts
+* Concept index:: Index of concepts
Copyright (C) 2008, 2009, 2010, 2011, 2012, 2013 Antonio Diaz Diaz.
@@ -37,18 +37,33 @@ File: lzip.info, Node: Introduction, Next: Algorithm, Prev: Top, Up: Top
1 Introduction
**************
-Lzip is a lossless data compressor based on the LZMA algorithm, with
-very safe integrity checking and a user interface similar to the one of
-gzip or bzip2. Lzip decompresses almost as fast as gzip and compresses
-better than bzip2, which makes it well suited for software distribution
-and data archiving.
+Lzip is a lossless data compressor with a user interface similar to the
+one of gzip or bzip2. Lzip decompresses almost as fast as gzip and
+compresses more than bzip2, which makes it well suited for software
+distribution and data archiving. Lzip is a clean implementation of the
+LZMA algorithm.
Lzip uses the same well-defined exit status values used by bzip2,
which makes it safer when used in pipes or scripts than compressors
returning ambiguous warning values, like gzip.
+ The lzip file format is designed for long-term data archiving and
+provides very safe integrity checking. The member trailer stores the
+32-bit CRC of the original data, the size of the original data and the
+size of the member. These values, together with the value remaining in
+the range decoder and the end-of-stream marker, provide a 4 factor
+integrity checking which guarantees that the decompressed version of the
+data is identical to the original. This guards against corruption of the
+compressed data, and against undetected bugs in lzip (hopefully very
+unlikely). The chances of data corruption going undetected are
+microscopic. Be aware, though, that the check occurs upon decompression,
+so it can only tell you that something is wrong. It can't help you
+recover the original uncompressed data.
+
If you ever need to recover data from a damaged lzip file, try the
-lziprecover program.
+lziprecover program. Lziprecover makes lzip files resistant to bit-flip
+(one of the most common forms of data corruption), and provides data
+recovery capabilities, including error-checked merging of damaged files.
Lzip replaces every file given in the command line with a compressed
version of itself, with the name "original_name.lz". Each compressed
@@ -96,20 +111,8 @@ filename.lz becomes filename
filename.tlz becomes filename.tar
anyothername becomes anyothername.out
- As a self-check for your protection, lzip stores in the member
-trailer the 32-bit CRC of the original data, the size of the original
-data and the size of the member. These values, together with the value
-remaining in the range decoder and the end-of-stream marker, provide a
-very safe 4 factor integrity checking which guarantees that the
-decompressed version of the data is identical to the original. This
-guards against corruption of the compressed data, and against
-undetected bugs in lzip (hopefully very unlikely). The chances of data
-corruption going undetected are microscopic. Be aware, though, that the
-check occurs upon decompression, so it can only tell you that something
-is wrong. It can't help you recover the original uncompressed data.
-

-File: lzip.info, Node: Algorithm, Next: Invoking Lzip, Prev: Introduction, Up: Top
+File: lzip.info, Node: Algorithm, Next: Invoking lzip, Prev: Introduction, Up: Top
2 Algorithm
***********
@@ -170,9 +173,9 @@ range encoding), Igor Pavlov (for putting all the above together in
LZMA), and Julian Seward (for bzip2's CLI and the idea of unzcrash).

-File: lzip.info, Node: Invoking Lzip, Next: File Format, Prev: Algorithm, Up: Top
+File: lzip.info, Node: Invoking lzip, Next: File format, Prev: Algorithm, Up: Top
-3 Invoking Lzip
+3 Invoking lzip
***************
The format for running lzip is:
@@ -275,10 +278,10 @@ The format for running lzip is:
`--verbose'
Verbose mode.
When compressing, show the compression ratio for each file
- processed.
+ processed. A second -v shows the progress of compression.
When decompressing or testing, further -v's (up to 4) increase the
- verbosity level, showing status, dictionary size, compression
- ratio, trailer contents (CRC, data size, member size), and up to 6
+ verbosity level, showing status, compression ratio, dictionary
+ size, trailer contents (CRC, data size, member size), and up to 6
bytes of trailing garbage (if any).
`-0 .. -9'
@@ -332,9 +335,9 @@ invalid input file, 3 for an internal consistency error (eg, bug) which
caused lzip to panic.

-File: lzip.info, Node: File Format, Next: Stream Format, Prev: Invoking Lzip, Up: Top
+File: lzip.info, Node: File format, Next: Stream format, Prev: Invoking lzip, Up: Top
-4 File Format
+4 File format
*************
Perfection is reached, not when there is no longer anything to add, but
@@ -404,7 +407,7 @@ additional information before, between, or after them.

-File: lzip.info, Node: Stream Format, Next: Examples, Prev: File Format, Up: Top
+File: lzip.info, Node: Stream format, Next: Examples, Prev: File format, Up: Top
5 Format of the LZMA stream in lzip files
*****************************************
@@ -596,7 +599,7 @@ with the appropiate contexts to decode the different coding sequences
Stream" marker is decoded.

-File: lzip.info, Node: Examples, Next: Problems, Prev: Stream Format, Up: Top
+File: lzip.info, Node: Examples, Next: Problems, Prev: Stream format, Up: Top
6 A small tutorial with examples
********************************
@@ -684,7 +687,7 @@ for all eternity, if not longer.
by running `lzip --version'.

-File: lzip.info, Node: Reference source code, Next: Concept Index, Prev: Problems, Up: Top
+File: lzip.info, Node: Reference source code, Next: Concept index, Prev: Problems, Up: Top
Appendix A Reference source code
********************************
@@ -1137,9 +1140,9 @@ int main( const int argc, const char * const argv[] )
}

-File: lzip.info, Node: Concept Index, Prev: Reference source code, Up: Top
+File: lzip.info, Node: Concept index, Prev: Reference source code, Up: Top
-Concept Index
+Concept index
*************
@@ -1148,29 +1151,29 @@ Concept Index
* algorithm: Algorithm. (line 6)
* bugs: Problems. (line 6)
* examples: Examples. (line 6)
-* file format: File Format. (line 6)
-* format of the LZMA stream: Stream Format. (line 6)
+* file format: File format. (line 6)
+* format of the LZMA stream: Stream format. (line 6)
* getting help: Problems. (line 6)
* introduction: Introduction. (line 6)
-* invoking: Invoking Lzip. (line 6)
-* options: Invoking Lzip. (line 6)
+* invoking: Invoking lzip. (line 6)
+* options: Invoking lzip. (line 6)
* reference source code: Reference source code. (line 6)
-* usage: Invoking Lzip. (line 6)
-* version: Invoking Lzip. (line 6)
+* usage: Invoking lzip. (line 6)
+* version: Invoking lzip. (line 6)

Tag Table:
-Node: Top224
-Node: Introduction1065
-Node: Algorithm4786
-Node: Invoking Lzip7304
-Node: File Format12895
-Node: Stream Format15328
-Node: Examples24042
-Node: Problems25991
-Node: Reference source code26521
-Node: Concept Index39768
+Node: Top210
+Node: Introduction1052
+Node: Algorithm5006
+Node: Invoking lzip7524
+Node: File format13162
+Node: Stream format15595
+Node: Examples24309
+Node: Problems26258
+Node: Reference source code26788
+Node: Concept index40035

End Tag Table
diff --git a/doc/lzip.texinfo b/doc/lzip.texinfo
index 484b5ac..1c04f2c 100644
--- a/doc/lzip.texinfo
+++ b/doc/lzip.texinfo
@@ -6,19 +6,19 @@
@finalout
@c %**end of header
-@set UPDATED 11 May 2013
-@set VERSION 1.15-pre2
+@set UPDATED 15 July 2013
+@set VERSION 1.15-pre3
@dircategory Data Compression
@direntry
-* Lzip: (lzip). Data compressor based on the LZMA algorithm
+* Lzip: (lzip). LZMA lossless data compressor
@end direntry
@ifnothtml
@titlepage
@title Lzip
-@subtitle Data compressor based on the LZMA algorithm
+@subtitle LZMA lossless data compressor
@subtitle for Lzip version @value{VERSION}, @value{UPDATED}
@author by Antonio Diaz Diaz
@@ -37,13 +37,13 @@ This manual is for Lzip (version @value{VERSION}, @value{UPDATED}).
@menu
* Introduction:: Purpose and features of lzip
* Algorithm:: How lzip compresses the data
-* Invoking Lzip:: Command line interface
-* File Format:: Detailed format of the compressed file
-* Stream Format:: Format of the LZMA stream in lzip files
+* Invoking lzip:: Command line interface
+* File format:: Detailed format of the compressed file
+* Stream format:: Format of the LZMA stream in lzip files
* Examples:: A small tutorial with examples
* Problems:: Reporting bugs
* Reference source code:: Source code illustrating stream format
-* Concept Index:: Index of concepts
+* Concept index:: Index of concepts
@end menu
@sp 1
@@ -58,18 +58,33 @@ to copy, distribute and modify it.
@chapter Introduction
@cindex introduction
-Lzip is a lossless data compressor based on the LZMA algorithm, with
-very safe integrity checking and a user interface similar to the one of
-gzip or bzip2. Lzip decompresses almost as fast as gzip and compresses
-better than bzip2, which makes it well suited for software distribution
-and data archiving.
+Lzip is a lossless data compressor with a user interface similar to the
+one of gzip or bzip2. Lzip decompresses almost as fast as gzip and
+compresses more than bzip2, which makes it well suited for software
+distribution and data archiving. Lzip is a clean implementation of the
+LZMA algorithm.
Lzip uses the same well-defined exit status values used by bzip2, which
makes it safer when used in pipes or scripts than compressors returning
ambiguous warning values, like gzip.
+The lzip file format is designed for long-term data archiving and
+provides very safe integrity checking. The member trailer stores the
+32-bit CRC of the original data, the size of the original data and the
+size of the member. These values, together with the value remaining in
+the range decoder and the end-of-stream marker, provide a 4 factor
+integrity checking which guarantees that the decompressed version of the
+data is identical to the original. This guards against corruption of the
+compressed data, and against undetected bugs in lzip (hopefully very
+unlikely). The chances of data corruption going undetected are
+microscopic. Be aware, though, that the check occurs upon decompression,
+so it can only tell you that something is wrong. It can't help you
+recover the original uncompressed data.
+
If you ever need to recover data from a damaged lzip file, try the
-lziprecover program.
+lziprecover program. Lziprecover makes lzip files resistant to bit-flip
+(one of the most common forms of data corruption), and provides data
+recovery capabilities, including error-checked merging of damaged files.
Lzip replaces every file given in the command line with a compressed
version of itself, with the name "original_name.lz". Each compressed
@@ -119,18 +134,6 @@ file from that of the compressed file as follows:
@item anyothername @tab becomes @tab anyothername.out
@end multitable
-As a self-check for your protection, lzip stores in the member trailer
-the 32-bit CRC of the original data, the size of the original data and
-the size of the member. These values, together with the value remaining
-in the range decoder and the end-of-stream marker, provide a very safe 4
-factor integrity checking which guarantees that the decompressed version
-of the data is identical to the original. This guards against corruption
-of the compressed data, and against undetected bugs in lzip (hopefully
-very unlikely). The chances of data corruption going undetected are
-microscopic. Be aware, though, that the check occurs upon decompression,
-so it can only tell you that something is wrong. It can't help you
-recover the original uncompressed data.
-
@node Algorithm
@chapter Algorithm
@@ -193,8 +196,8 @@ range encoding), Igor Pavlov (for putting all the above together in
LZMA), and Julian Seward (for bzip2's CLI and the idea of unzcrash).
-@node Invoking Lzip
-@chapter Invoking Lzip
+@node Invoking lzip
+@chapter Invoking lzip
@cindex invoking
@cindex options
@cindex usage
@@ -295,9 +298,10 @@ Use it together with @samp{-v} to see information about the file.
@item -v
@itemx --verbose
Verbose mode.@*
-When compressing, show the compression ratio for each file processed.@*
+When compressing, show the compression ratio for each file processed. A
+second -v shows the progress of compression.@*
When decompressing or testing, further -v's (up to 4) increase the
-verbosity level, showing status, dictionary size, compression ratio,
+verbosity level, showing status, compression ratio, dictionary size,
trailer contents (CRC, data size, member size), and up to 6 bytes of
trailing garbage (if any).
@@ -357,8 +361,8 @@ invalid input file, 3 for an internal consistency error (eg, bug) which
caused lzip to panic.
-@node File Format
-@chapter File Format
+@node File format
+@chapter File format
@cindex file format
Perfection is reached, not when there is no longer anything to add, but
@@ -432,7 +436,7 @@ facilitates safe recovery of undamaged members from multi-member files.
@end table
-@node Stream Format
+@node Stream format
@chapter Format of the LZMA stream in lzip files
@cindex format of the LZMA stream
@@ -1204,8 +1208,8 @@ int main( const int argc, const char * const argv[] )
@end verbatim
-@node Concept Index
-@unnumbered Concept Index
+@node Concept index
+@unnumbered Concept index
@printindex cp