summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/tarlz.114
-rw-r--r--doc/tarlz.info59
-rw-r--r--doc/tarlz.texi42
3 files changed, 75 insertions, 40 deletions
diff --git a/doc/tarlz.1 b/doc/tarlz.1
index 82462cd..ff418c5 100644
--- a/doc/tarlz.1
+++ b/doc/tarlz.1
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
-.TH TARLZ "1" "February 2019" "tarlz 0.11" "User Commands"
+.TH TARLZ "1" "February 2019" "tarlz 0.12" "User Commands"
.SH NAME
tarlz \- creates tar archives with multimember lzip compression
.SH SYNOPSIS
@@ -42,6 +42,12 @@ create a new archive
\fB\-C\fR, \fB\-\-directory=\fR<dir>
change to directory <dir>
.TP
+\fB\-d\fR, \fB\-\-diff\fR
+find differences between archive and file system
+.TP
+\fB\-\-ignore\-ids\fR
+ignore differences in owner and group IDs
+.TP
\fB\-f\fR, \fB\-\-file=\fR<archive>
use archive file <archive>
.TP
@@ -66,6 +72,9 @@ extract files from an archive
\fB\-0\fR .. \fB\-9\fR
set compression level [default 6]
.TP
+\fB\-\-uncompressed\fR
+don't compress the archive created
+.TP
\fB\-\-asolid\fR
create solidly compressed appendable archive
.TP
@@ -95,9 +104,6 @@ don't delete partially extracted files
.TP
\fB\-\-missing\-crc\fR
exit with error status if missing extended CRC
-.TP
-\fB\-\-uncompressed\fR
-don't compress the archive created
.PP
Exit status: 0 for a normal exit, 1 for environmental problems (file
not found, invalid flags, I/O errors, etc), 2 to indicate a corrupt or
diff --git a/doc/tarlz.info b/doc/tarlz.info
index 288c441..349e420 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.11, 13 February 2019).
+This manual is for Tarlz (version 0.12, 22 February 2019).
* Menu:
@@ -48,8 +48,8 @@ tar tools like GNU tar, which treat it like any other tar.lz archive.
Tarlz can append files to the end of such compressed archives.
Tarlz can create tar archives with five levels of compression
-granularity; per file, per block, per directory, appendable solid, and
-solid.
+granularity; per file, per block (default), per directory, appendable
+solid, and solid.
Of course, compressing each file (or each directory) individually can't
achieve a compression ratio as high as compressing solidly the whole tar
@@ -130,9 +130,9 @@ equivalent to '-1 --solid'
'-B BYTES'
'--data-size=BYTES'
Set target size of input data blocks for the '--bsolid' option.
- Valid values range from 8 KiB to 1 GiB. Default value is two times
- the dictionary size, except for option '-0' where it defaults to
- 1 MiB. *Note Minimum archive sizes::.
+ *Note --bsolid::. Valid values range from 8 KiB to 1 GiB. Default
+ value is two times the dictionary size, except for option '-0'
+ where it defaults to 1 MiB. *Note Minimum archive sizes::.
'-c'
'--create'
@@ -154,6 +154,20 @@ equivalent to '-1 --solid'
archive if a '-C' option appears after a relative filename in the
command line.
+'-d'
+'--diff'
+ Find differences between archive and file system. For each tar
+ member in the archive, verify that the corresponding file exists
+ and is of the same type (regular file, directory, etc). Report the
+ differences found in type, mode (permissions), owner and group
+ IDs, modification time, file size, file contents (of regular
+ files), target (of symlinks) and device number (of block/character
+ special files).
+
+'--ignore-ids'
+ Make '--diff' ignore differences in owner and group IDs. This
+ option is useful when comparing an '--anonymous' archive.
+
'-f ARCHIVE'
'--file=ARCHIVE'
Use archive file ARCHIVE. '-' used as an ARCHIVE argument reads
@@ -224,6 +238,10 @@ equivalent to '-1 --solid'
-8 24 MiB 132 bytes
-9 32 MiB 273 bytes
+'--uncompressed'
+ With '--create', don't compress the created tar archive. Create an
+ uncompressed tar archive instead.
+
'--asolid'
When creating or appending to a compressed archive, use appendable
solid compression. All the files being added to the archive are
@@ -296,10 +314,6 @@ equivalent to '-1 --solid'
the posix pax format; i.e., the lack of a mandatory check sequence
in the extended records. *Note crc32::.
-'--uncompressed'
- With '--create', don't compress the created tar archive. Create an
- uncompressed tar archive instead.
-
Exit status: 0 for a normal exit, 1 for environmental problems (file
not found, invalid flags, I/O errors, etc), 2 to indicate a corrupt or
@@ -822,18 +836,19 @@ Concept index
Tag Table:
Node: Top223
Node: Introduction1089
-Node: Invoking tarlz3218
-Ref: --data-size5097
-Node: File format12673
-Ref: key_crc3217493
-Node: Amendments to pax format22910
-Ref: crc3223434
-Ref: flawed-compat24459
-Node: Multi-threaded tar26826
-Node: Minimum archive sizes29365
-Node: Examples31495
-Node: Problems33164
-Node: Concept index33690
+Node: Invoking tarlz3228
+Ref: --data-size5107
+Ref: --bsolid10054
+Node: File format13298
+Ref: key_crc3218118
+Node: Amendments to pax format23535
+Ref: crc3224059
+Ref: flawed-compat25084
+Node: Multi-threaded tar27451
+Node: Minimum archive sizes29990
+Node: Examples32120
+Node: Problems33789
+Node: Concept index34315

End Tag Table
diff --git a/doc/tarlz.texi b/doc/tarlz.texi
index 6026fe3..56c4dab 100644
--- a/doc/tarlz.texi
+++ b/doc/tarlz.texi
@@ -6,8 +6,8 @@
@finalout
@c %**end of header
-@set UPDATED 13 February 2019
-@set VERSION 0.11
+@set UPDATED 22 February 2019
+@set VERSION 0.12
@dircategory Data Compression
@direntry
@@ -69,7 +69,7 @@ tar, which treat it like any other tar.lz archive. Tarlz can append files to
the end of such compressed archives.
Tarlz can create tar archives with five levels of compression granularity;
-per file, per block, per directory, appendable solid, and solid.
+per file, per block (default), per directory, appendable solid, and solid.
@noindent
Of course, compressing each file (or each directory) individually can't
@@ -130,7 +130,7 @@ appended or concatenated, and skips it.
On extraction and listing, tarlz removes leading @samp{./} strings from
member names in the archive or given in the command line, so that
-@w{@code{tarlz -xf foo ./bar baz}} extracts members @samp{bar} and
+@w{@samp{tarlz -xf foo ./bar baz}} extracts members @samp{bar} and
@samp{./baz} from archive @samp{foo}.
If several compression levels or @samp{--*solid} options are given, the last
@@ -162,10 +162,10 @@ specified. Tarlz can't concatenate uncompressed tar archives.
@anchor{--data-size}
@item -B @var{bytes}
@itemx --data-size=@var{bytes}
-Set target size of input data blocks for the @samp{--bsolid} option. Valid
-values range from @w{8 KiB} to @w{1 GiB}. Default value is two times the
-dictionary size, except for option @samp{-0} where it defaults to @w{1 MiB}.
-@xref{Minimum archive sizes}.
+Set target size of input data blocks for the @samp{--bsolid} option.
+@xref{--bsolid}. Valid values range from @w{8 KiB} to @w{1 GiB}. Default
+value is two times the dictionary size, except for option @samp{-0} where it
+defaults to @w{1 MiB}. @xref{Minimum archive sizes}.
@item -c
@itemx --create
@@ -186,6 +186,19 @@ Note that a process can only have one current working directory (CWD).
Therefore multi-threading can't be used to create an archive if a @samp{-C}
option appears after a relative filename in the command line.
+@item -d
+@itemx --diff
+Find differences between archive and file system. For each tar member in the
+archive, verify that the corresponding file exists and is of the same type
+(regular file, directory, etc). Report the differences found in type, mode
+(permissions), owner and group IDs, modification time, file size, file
+contents (of regular files), target (of symlinks) and device number (of
+block/character special files).
+
+@item --ignore-ids
+Make @samp{--diff} ignore differences in owner and group IDs. This option is
+useful when comparing an @samp{--anonymous} archive.
+
@item -f @var{archive}
@itemx --file=@var{archive}
Use archive file @var{archive}. @samp{-} used as an @var{archive}
@@ -205,7 +218,7 @@ Multi-threaded extraction of files from an archive is not yet implemented.
Note that the number of usable threads is limited during compression to
@w{ceil( uncompressed_size / data_size )} (@pxref{Minimum archive sizes}),
and during decompression to the number of lzip members in the tar.lz
-archive, which you can find by running @w{@code{lzip -lv archive.tar.lz}}.
+archive, which you can find by running @w{@samp{lzip -lv archive.tar.lz}}.
@item -q
@itemx --quiet
@@ -255,6 +268,10 @@ it creates, reducing the amount of memory required for decompression.
@item -9 @tab 32 MiB @tab 273 bytes
@end multitable
+@item --uncompressed
+With @samp{--create}, don't compress the created tar archive. Create an
+uncompressed tar archive instead.
+
@item --asolid
When creating or appending to a compressed archive, use appendable solid
compression. All the files being added to the archive are compressed into a
@@ -262,6 +279,7 @@ single lzip member, but the end-of-file blocks are compressed into a
separate lzip member. This creates a solidly compressed appendable archive.
Solid archives can't be created nor decoded in parallel.
+@anchor{--bsolid}
@item --bsolid
When creating or appending to a compressed archive, use block compression.
Tar members are compressed together in a lzip member until they approximate
@@ -329,10 +347,6 @@ headers preceding a ustar header, or several records with the same
keyword appearing in the same block of extended records.
@end ignore
-@item --uncompressed
-With @samp{--create}, don't compress the created tar archive. Create an
-uncompressed tar archive instead.
-
@end table
Exit status: 0 for a normal exit, 1 for environmental problems (file not
@@ -871,7 +885,7 @@ 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{@code{tarlz --version}}.
+find by running @w{@samp{tarlz --version}}.
@node Concept index