summaryrefslogtreecommitdiffstats
path: root/doc/zutils.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zutils.texi')
-rw-r--r--doc/zutils.texi101
1 files changed, 74 insertions, 27 deletions
diff --git a/doc/zutils.texi b/doc/zutils.texi
index 343c297..789643a 100644
--- a/doc/zutils.texi
+++ b/doc/zutils.texi
@@ -6,8 +6,8 @@
@finalout
@c %**end of header
-@set UPDATED 13 February 2018
-@set VERSION 1.7
+@set UPDATED 1 January 2019
+@set VERSION 1.8
@dircategory Data Compression
@direntry
@@ -49,7 +49,7 @@ This manual is for Zutils (version @value{VERSION}, @value{UPDATED}).
@end menu
@sp 1
-Copyright @copyright{} 2009-2018 Antonio Diaz Diaz.
+Copyright @copyright{} 2009-2019 Antonio Diaz Diaz.
This manual is free documentation: you have unlimited permission
to copy, distribute and modify it.
@@ -70,8 +70,8 @@ programs. In particular the @samp{--recursive} option is very efficient
in those utilities supporting it.
@noindent
-The provided utilities are zcat, zcmp, zdiff, zgrep, ztest and zupdate.@*
-The supported formats are bzip2, gzip, lzip and xz.@*
+The utilities provided are zcat, zcmp, zdiff, zgrep, ztest and zupdate.@*
+The formats supported are bzip2, gzip, lzip and xz.@*
Zutils uses external compressors. The compressor to be used for each
format is configurable at runtime.
@@ -133,6 +133,7 @@ only supports the @samp{--help} form of this option.
@item -V
@itemx --version
Print the version number on the standard output and exit.
+This version number should be included in all bug reports.
@item -M @var{format_list}
@itemx --format=@var{format_list}
@@ -221,12 +222,17 @@ where <format> is one of @samp{bz2}, @samp{gz}, @samp{lz} or @samp{xz}.
zcat copies each given file to standard output. If any given file is
compressed, its decompressed content is used. If a given file does not
exist, and its name does not end with one of the known extensions, zcat
-tries the compressed file names corresponding to the supported formats.
+tries the compressed file names corresponding to the formats supported.
+If a file fails to decompress, zcat continues copying the rest of the
+files.
-If no files are specified, or if a file is specified as @samp{-}, data
-are read from standard input, decompressed if needed, and sent to
-standard output. Data read from standard input must be of the same type;
-all uncompressed or all in the same compression format.
+If a file is specified as @samp{-}, data are read from standard input,
+decompressed if needed, and sent to standard output. Data read from
+standard input must be of the same type; all uncompressed or all in the
+same compression format.
+
+If no files are specified, recursive searches examine the current
+working directory, and nonrecursive searches read standard input.
The format for running zcat is:
@@ -274,7 +280,14 @@ Quiet operation. Suppress all messages.
@item -r
@itemx --recursive
-Operate recursively on directories.
+For each directory operand, read and process all files in that
+directory, recursively. Follow symbolic links in the command line, but
+skip symlinks that are encountered recursively.
+
+@item -R
+@itemx --dereference-recursive
+For each directory operand, read and process all files in that
+directory, recursively, following all symbolic links.
@item -s
@itemx --squeeze-blank
@@ -509,12 +522,16 @@ on any combination of compressed and uncompressed files. If any given
file is compressed, its decompressed content is used. If a given file
does not exist, and its name does not end with one of the known
extensions, zgrep tries the compressed file names corresponding to the
-supported formats.
+formats supported. If a file fails to decompress, zgrep continues
+searching the rest of the files.
-If no files are specified, or if a file is specified as @samp{-}, data
-are read from standard input, decompressed if needed, and fed to grep.
-Data read from standard input must be of the same type; all uncompressed
-or all in the same compression format.
+If a file is specified as @samp{-}, data are read from standard input,
+decompressed if needed, and fed to grep. Data read from standard input
+must be of the same type; all uncompressed or all in the same
+compression format.
+
+If no files are specified, recursive searches examine the current
+working directory, and nonrecursive searches read standard input.
The format for running zgrep is:
@@ -629,7 +646,14 @@ found, even if an error was detected.
@item -r
@itemx --recursive
-Operate recursively on directories.
+For each directory operand, read and process all files in that
+directory, recursively. Follow symbolic links in the command line, but
+skip symlinks that are encountered recursively.
+
+@item -R
+@itemx --dereference-recursive
+For each directory operand, read and process all files in that
+directory, recursively, following all symbolic links.
@item -s
@itemx --no-messages
@@ -658,10 +682,14 @@ Match only whole lines.
@cindex ztest
ztest verifies the integrity of the specified compressed files.
-Uncompressed files are ignored. If no files are specified, or if a file
-is specified as @samp{-}, the integrity of compressed data read from
-standard input is verified. Data read from standard input must be all in
-the same compression format.
+Uncompressed files are ignored. If a file is specified as @samp{-}, the
+integrity of compressed data read from standard input is verified. Data
+read from standard input must be all in the same compression format. If
+a file fails to decompress, ztest continues verifying the rest of the
+files.
+
+If no files are specified, recursive searches examine the current
+working directory, and nonrecursive searches read standard input.
Note that error detection in the xz format is broken. First, some xz
files lack integrity information. Second, not all xz decompressors can
@@ -703,7 +731,14 @@ Quiet operation. Suppress all messages.
@item -r
@itemx --recursive
-Operate recursively on directories.
+For each directory operand, read and process all files in that
+directory, recursively. Follow symbolic links in the command line, but
+skip symlinks that are encountered recursively.
+
+@item -R
+@itemx --dereference-recursive
+For each directory operand, read and process all files in that
+directory, recursively, following all symbolic links.
@item -v
@itemx --verbose
@@ -721,9 +756,14 @@ zupdate recompresses files from bzip2, gzip, and xz formats to lzip
format. Each original is compared with the new file and then deleted.
Only regular files with standard file name extensions are recompressed,
other files are ignored. Compressed files are decompressed and then
-recompressed on the fly; no temporary files are created. The lzip format
-is chosen as destination because it is by far the most appropriate for
-long-term data archiving.
+recompressed on the fly; no temporary files are created. If an error
+happens while recompressing a file, zupdate exits immediately without
+recompressing the rest of the files. The lzip format is chosen as
+destination because it is the most appropriate for long-term data
+archiving.
+
+If no files are specified, recursive searches examine the current
+working directory, and nonrecursive searches do nothing.
If the lzip compressed version of a file already exists, the file is
skipped unless the @samp{--force} option is given. In this case, if the
@@ -743,7 +783,7 @@ extensions @samp{.lz} or @samp{.tar.lz}.
Recompressing a file is much like copying or moving it; therefore
zupdate preserves the access and modification dates, permissions, and,
-when possible, ownership of the file just as "cp -p" does. (If the user
+when possible, ownership of the file just as @samp{cp -p} does. (If the user
ID or the group ID can't be duplicated, the file permission bits S_ISUID
and S_ISGID are cleared).
@@ -785,7 +825,14 @@ Quiet operation. Suppress all messages.
@item -r
@itemx --recursive
-Operate recursively on directories.
+For each directory operand, read and process all files in that
+directory, recursively. Follow symbolic links in the command line, but
+skip symlinks that are encountered recursively.
+
+@item -R
+@itemx --dereference-recursive
+For each directory operand, read and process all files in that
+directory, recursively, following all symbolic links.
@item -v
@itemx --verbose