summaryrefslogtreecommitdiffstats
path: root/doc/tarlz.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/tarlz.texi')
-rw-r--r--doc/tarlz.texi54
1 files changed, 29 insertions, 25 deletions
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