summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-01-09 05:52:40 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-01-09 05:53:03 +0000
commit882d8d8da4a8b4a332458c4f01b03d81c2c08c78 (patch)
treed7acd130c7201183b14adfa8e095e79eb1f49bbe /doc
parentReleasing debian version 0.21-3. (diff)
downloadtarlz-882d8d8da4a8b4a332458c4f01b03d81c2c08c78.tar.xz
tarlz-882d8d8da4a8b4a332458c4f01b03d81c2c08c78.zip
Merging upstream version 0.22.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/tarlz.16
-rw-r--r--doc/tarlz.info83
-rw-r--r--doc/tarlz.texi54
3 files changed, 75 insertions, 68 deletions
diff --git a/doc/tarlz.1 b/doc/tarlz.1
index 4df1fa1..d7cc093 100644
--- a/doc/tarlz.1
+++ b/doc/tarlz.1
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
-.TH TARLZ "1" "June 2021" "tarlz 0.21" "User Commands"
+.TH TARLZ "1" "January 2022" "tarlz 0.22" "User Commands"
.SH NAME
tarlz \- creates tar archives with multimember lzip compression
.SH SYNOPSIS
@@ -150,8 +150,8 @@ Report bugs to lzip\-bug@nongnu.org
.br
Tarlz home page: http://www.nongnu.org/lzip/tarlz.html
.SH COPYRIGHT
-Copyright \(co 2021 Antonio Diaz Diaz.
-Using lzlib 1.12
+Copyright \(co 2022 Antonio Diaz Diaz.
+Using lzlib 1.13\-rc1
License GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl.html>
.br
This is free software: you are free to change and redistribute it.
diff --git a/doc/tarlz.info b/doc/tarlz.info
index c797f0b..79661cc 100644
--- a/doc/tarlz.info
+++ b/doc/tarlz.info
@@ -11,7 +11,7 @@ File: tarlz.info, Node: Top, Next: Introduction, Up: (dir)
Tarlz Manual
************
-This manual is for Tarlz (version 0.21, 14 June 2021).
+This manual is for Tarlz (version 0.22, 5 January 2022).
* Menu:
@@ -28,7 +28,7 @@ This manual is for Tarlz (version 0.21, 14 June 2021).
* Concept index:: Index of concepts
- Copyright (C) 2013-2021 Antonio Diaz Diaz.
+ Copyright (C) 2013-2022 Antonio Diaz Diaz.
This manual is free documentation: you have unlimited permission to copy,
distribute, and modify it.
@@ -101,8 +101,9 @@ The format for running tarlz is:
tarlz [OPTIONS] [FILES]
-All operations except '--concatenate' operate on whole trees if any FILE is
-a directory. Tarlz overwrites output files without warning.
+All operations except '--concatenate' and '--compress' operate on whole
+trees if any FILE is a directory. All operations except '--compress'
+overwrite output files without warning.
On archive creation or appending tarlz archives the files specified, but
removes from member names any leading and trailing slashes and any file name
@@ -432,12 +433,14 @@ to '-1 --solid'.
'--check-lib'
Compare the version of lzlib used to compile tarlz with the version
- actually being used and exit. Report any differences found. Exit with
- error status 1 if differences are found. A mismatch may indicate that
- lzlib is not correctly installed or that a different version of lzlib
- has been installed after compiling tarlz. 'tarlz -v --check-lib' shows
- the version of lzlib being used and the value of 'LZ_API_VERSION' (if
- defined). *Note Library version: (lzlib)Library version.
+ actually being used at run time and exit. Report any differences
+ found. Exit with error status 1 if differences are found. A mismatch
+ may indicate that lzlib is not correctly installed or that a different
+ version of lzlib has been installed after compiling tarlz. Exit with
+ error status 2 if LZ_API_VERSION and LZ_version_string don't match.
+ 'tarlz -v --check-lib' shows the version of lzlib being used and the
+ value of LZ_API_VERSION (if defined). *Note Library version:
+ (lzlib)Library version.
'--warn-newer'
During archive creation, warn if any file being archived has a
@@ -594,10 +597,10 @@ space, equal-sign, and newline.
representing the CRC <value> itself. The <value> is represented as 8
hexadecimal digits in big endian order, '22 GNU.crc32=00000000\n'. The
keyword of the CRC record is protected by the CRC to guarante that
- corruption is always detected (except in case of CRC collision). A CRC
- was chosen because a checksum is too weak for a potentially large list
- of variable sized records. A checksum can't detect simple errors like
- the swapping of two bytes.
+ corruption is always detected when using '--missing-crc' (except in
+ case of CRC collision). A CRC was chosen because a checksum is too
+ weak for a potentially large list of variable sized records. A
+ checksum can't detect simple errors like the swapping of two bytes.
At verbosity level 1 or higher tarlz prints a diagnostic for each unknown
@@ -844,16 +847,16 @@ workers. The workers compress the metadata received from the grouper along
with the file data read from the file system. The muxer collects processed
packets from the workers, and writes them to the archive.
-,--------,
+.--------.
| data|---> to each worker below
-| | ,------------,
+| | .------------.
| file | ,-->| worker 0 |--,
| system | | `------------' |
-| | ,---------, | ,------------, | ,-------, ,---------,
+| | .---------. | .------------. | .-------. .---------.
|metadata|--->| grouper |-+-->| worker 1 |--+-->| muxer |-->| archive |
`--------' `---------' | `------------' | `-------' `---------'
| ... |
- | ,------------, |
+ | .------------. |
`-->| worker N-1 |--'
`------------'
@@ -864,17 +867,17 @@ worker may access files in the file system either to read them (diff) or
write them (extract). As in plzip, each worker reads members directly from
the archive.
-,--------,
+.--------.
| file |<---> data to/from each worker below
| system |
-`--------' ,------------,
+`--------' .------------.
,-->| worker 0 |--,
| `------------' |
-,---------, | ,------------, | ,-------, ,--------,
+.---------. | .------------. | .-------. .--------.
| archive |-+-->| worker 1 |--+-->| muxer |-->| stdout |
`---------' | `------------' | `-------' | stderr |
| ... | `--------'
- | ,------------, |
+ | .------------. |
`-->| worker N-1 |--'
`------------'
@@ -956,7 +959,7 @@ example listing the Silesia corpus on a dual core machine:
On the other hand, multi-threaded '--list' won't detect corruption in
the tar member data because it only decodes the part of each lzip member
corresponding to the tar member header. This is another reason why the tar
-headers must provide its own integrity checking.
+headers must provide their own integrity checking.
7.1 Limitations of multi-threaded extraction
@@ -1101,7 +1104,7 @@ eternity, if not longer.
If you find a bug in tarlz, please send electronic mail to
<lzip-bug@nongnu.org>. Include the version number, which you can find by
-running 'tarlz --version'.
+running 'tarlz --version' and 'tarlz -v --check-lib'.

File: tarlz.info, Node: Concept index, Prev: Problems, Up: Top
@@ -1131,22 +1134,22 @@ Concept index

Tag Table:
Node: Top223
-Node: Introduction1212
-Node: Invoking tarlz4020
-Ref: --data-size6389
-Ref: --bsolid16341
-Node: Portable character set21079
-Node: File format21874
-Ref: key_crc3226799
-Node: Amendments to pax format32400
-Ref: crc3233064
-Ref: flawed-compat34375
-Node: Program design37176
-Node: Multi-threaded decoding41101
-Node: Minimum archive sizes45590
-Node: Examples47728
-Node: Problems49744
-Node: Concept index50272
+Node: Introduction1214
+Node: Invoking tarlz4022
+Ref: --data-size6436
+Ref: --bsolid16388
+Node: Portable character set21224
+Node: File format22019
+Ref: key_crc3226944
+Node: Amendments to pax format32572
+Ref: crc3233236
+Ref: flawed-compat34547
+Node: Program design37348
+Node: Multi-threaded decoding41273
+Node: Minimum archive sizes45764
+Node: Examples47902
+Node: Problems49918
+Node: Concept index50473

End Tag Table
diff --git a/doc/tarlz.texi b/doc/tarlz.texi
index f451e5a..bfa6d9d 100644
--- a/doc/tarlz.texi
+++ b/doc/tarlz.texi
@@ -6,8 +6,8 @@
@finalout
@c %**end of header
-@set UPDATED 14 June 2021
-@set VERSION 0.21
+@set UPDATED 5 January 2022
+@set VERSION 0.22
@dircategory Data Compression
@direntry
@@ -50,7 +50,7 @@ This manual is for Tarlz (version @value{VERSION}, @value{UPDATED}).
@end menu
@sp 1
-Copyright @copyright{} 2013-2021 Antonio Diaz Diaz.
+Copyright @copyright{} 2013-2022 Antonio Diaz Diaz.
This manual is free documentation: you have unlimited permission to copy,
distribute, and modify it.
@@ -137,8 +137,9 @@ tarlz [@var{options}] [@var{files}]
@end example
@noindent
-All operations except @samp{--concatenate} operate on whole trees if any
-@var{file} is a directory. Tarlz overwrites output files without warning.
+All operations except @samp{--concatenate} and @samp{--compress} operate on
+whole trees if any @var{file} is a directory. All operations except
+@samp{--compress} overwrite output files without warning.
On archive creation or appending tarlz archives the files specified, but
removes from member names any leading and trailing slashes and any file name
@@ -467,12 +468,13 @@ values range from 1 to 1024. The default value is 64.
@item --check-lib
Compare the
@uref{http://www.nongnu.org/lzip/manual/lzlib_manual.html#Library-version,,version of lzlib}
-used to compile tarlz with the version actually being used and exit. Report
-any differences found. Exit with error status 1 if differences are found. A
-mismatch may indicate that lzlib is not correctly installed or that a
-different version of lzlib has been installed after compiling tarlz.
-@w{@samp{tarlz -v --check-lib}} shows the version of lzlib being used and
-the value of @samp{LZ_API_VERSION} (if defined).
+used to compile tarlz with the version actually being used at run time and
+exit. Report any differences found. Exit with error status 1 if differences
+are found. A mismatch may indicate that lzlib is not correctly installed or
+that a different version of lzlib has been installed after compiling tarlz.
+Exit with error status 2 if LZ_API_VERSION and LZ_version_string don't
+match. @w{@samp{tarlz -v --check-lib}} shows the version of lzlib being used
+and the value of LZ_API_VERSION (if defined).
@ifnothtml
@xref{Library version,,,lzlib}.
@end ifnothtml
@@ -671,10 +673,11 @@ CRC32-C (Castagnoli) of the extended header data excluding the 8 bytes
representing the CRC <value> itself. The <value> is represented as 8
hexadecimal digits in big endian order,
@w{@samp{22 GNU.crc32=00000000\n}}. The keyword of the CRC record is
-protected by the CRC to guarante that corruption is always detected
-(except in case of CRC collision). A CRC was chosen because a checksum
-is too weak for a potentially large list of variable sized records. A
-checksum can't detect simple errors like the swapping of two bytes.
+protected by the CRC to guarante that corruption is always detected when
+using @samp{--missing-crc} (except in case of CRC collision). A CRC was
+chosen because a checksum is too weak for a potentially large list of
+variable sized records. A checksum can't detect simple errors like the
+swapping of two bytes.
@end table
@@ -926,16 +929,16 @@ with the file data read from the file system. The muxer collects processed
packets from the workers, and writes them to the archive.
@verbatim
-,--------,
+.--------.
| data|---> to each worker below
-| | ,------------,
+| | .------------.
| file | ,-->| worker 0 |--,
| system | | `------------' |
-| | ,---------, | ,------------, | ,-------, ,---------,
+| | .---------. | .------------. | .-------. .---------.
|metadata|--->| grouper |-+-->| worker 1 |--+-->| muxer |-->| archive |
`--------' `---------' | `------------' | `-------' `---------'
| ... |
- | ,------------, |
+ | .------------. |
`-->| worker N-1 |--'
`------------'
@end verbatim
@@ -947,17 +950,17 @@ access files in the file system either to read them (diff) or write them
(extract). As in plzip, each worker reads members directly from the archive.
@verbatim
-,--------,
+.--------.
| file |<---> data to/from each worker below
| system |
-`--------' ,------------,
+`--------' .------------.
,-->| worker 0 |--,
| `------------' |
-,---------, | ,------------, | ,-------, ,--------,
+.---------. | .------------. | .-------. .--------.
| archive |-+-->| worker 1 |--+-->| muxer |-->| stdout |
`---------' | `------------' | `-------' | stderr |
| ... | `--------'
- | ,------------, |
+ | .------------. |
`-->| worker N-1 |--'
`------------'
@end verbatim
@@ -1041,7 +1044,7 @@ time tarlz -tf silesia.tar.lz (0.020s)
On the other hand, multi-threaded @samp{--list} won't detect corruption in
the tar member data because it only decodes the part of each lzip member
corresponding to the tar member header. This is another reason why the tar
-headers must provide its own integrity checking.
+headers must provide their own integrity checking.
@sp 1
@section Limitations of multi-threaded extraction
@@ -1212,7 +1215,8 @@ for all eternity, if not longer.
If you find a bug in tarlz, please send electronic mail to
@email{lzip-bug@@nongnu.org}. Include the version number, which you can
-find by running @w{@samp{tarlz --version}}.
+find by running @w{@samp{tarlz --version}} and
+@w{@samp{tarlz -v --check-lib}}.
@node Concept index