Merging upstream version 1.0~rc6.

Signed-off-by: Daniel Baumann <mail@daniel-baumann.ch>

1 files changed, 100 insertions, 42 deletions

diff --git a/doc/zutils.info b/doc/zutils.info
index 24f9bf4..9c27308 100644
--- a/doc/zutils.info
+++ b/doc/zutils.info
@@ -12,7 +12,7 @@ File: zutils.info,  Node: Top,  Next: Introduction,  Up: (dir)
 Zutils Manual
 *************
 
-This manual is for Zutils (version 0.9, 11 January 2011).
+This manual is for Zutils (version 1.0-rc6, 15 March 2013).
 
 * Menu:
 
@@ -26,7 +26,7 @@ This manual is for Zutils (version 0.9, 11 January 2011).
 * Concept Index::       Index of concepts
 
 
-   Copyright (C) 2008, 2009, 2010, 2011 Antonio Diaz Diaz.
+   Copyright (C) 2008, 2009, 2010, 2011, 2012, 2013 Antonio Diaz Diaz.
 
    This manual is free documentation: you have unlimited permission to
 copy, distribute and modify it.
@@ -41,12 +41,17 @@ Zutils is a collection of utilities able to deal with any combination of
 compressed and non-compressed files transparently. If any given file,
 including standard input, is compressed, its uncompressed content is
 used. Compressed files are decompressed on the fly; no temporary files
-are created. These utilities are not wrapper scripts but safer and more
-efficient C++ programs. In particular the `--recursive' option is very
-efficient in those utilities supporting it.
+are created.
+
+   These utilities are not wrapper scripts but safer and more efficient
+C++ programs. In particular the `--recursive' option is very efficient
+in those utilities supporting it.
 
 The provided utilities are zcat, zcmp, zdiff, zgrep and ztest.
-The supported compressors are bzip2, gzip, lzip and xz.
+The supported formats are bzip2, gzip, lzip and xz.
+
+   Zcat, zcmp, zdiff, and zgrep are improved replacements for the shell
+scripts provided with GNU gzip. Ztest is unique to zutils.
 
 
    Numbers given as arguments to options (positions, sizes) may be
@@ -74,10 +79,12 @@ Zcat copies each given file (`-' means standard input), to standard
 output. If any given file is compressed, its uncompressed 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 compressors. If no files are specified,
-data is 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 compressed with the same compressor.
+corresponding to the supported formats.
+
+   If no files are specified, data is 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.
 
    The format for running zcat is:
 
@@ -111,6 +118,11 @@ Exit status is 0 if no errors occurred, 1 otherwise.
 `--show-ends'
      Print a `$' after the end of each line.
 
+`--format=FMT'
+     Force the given compression format. Valid values for FMT are
+     `bz2', `gz', `lz' and `xz'. If this option is used, the exact file
+     name must be given. Other names won't be tried.
+
 `-n'
 `--number'
      Number all output lines, starting with 1. The line count is
@@ -161,13 +173,18 @@ fly; no temporary files are created.
 
      zcmp [OPTIONS] FILE1 [FILE2]
 
-Compares FILE1 to FILE2. If FILE2 is omitted zcmp tries the following:
-If FILE1 is compressed, compares FILE1 to the file with the
-corresponding decompressed file name (removes the extension from FILE1).
-If FILE1 is not compressed, compares FILE1 to the uncompressed contents
-of FILE1.[bz2|gz|lz|xz] (the first one that is found).
-If no suitable file is found, compares FILE1 to data read from standard
-input.
+This compares FILE1 to FILE2. If FILE2 is omitted zcmp tries the
+following:
+
+  1. If FILE1 is compressed, compares FILE1 to the file with the
+     corresponding decompressed file name (removes the extension from
+     FILE1).
+
+  2. If FILE1 is not compressed, compares FILE1 to the uncompressed
+     contents of FILE1.[bz2|gz|lz|xz] (the first one that is found).
+
+  3. If no suitable file is found, compares FILE1 to data read from
+     standard input.
 
 An exit status of 0 means no differences were found, 1 means some
 differences were found, and 2 means trouble.
@@ -188,6 +205,14 @@ differences were found, and 2 means trouble.
      a letter, and precede bytes larger than 127 with `M-' (which stands
      for "meta").
 
+`--format=[FMT1][,FMT2]'
+     Force the given compression formats. Any of FMT1 or FMT2 may be
+     omitted and the corresponding format will be automatically
+     detected.  Valid values for FMT are `bz2', `gz', `lz' and `xz'. If
+     at least one format is specified with this option, the exact file
+     names of both FILE1 and FILE2 must be given.  Other names won't be
+     tried.
+
 `-i SIZE'
 `--ignore-initial=SIZE'
      Ignore any differences in the first SIZE bytes of the input files.
@@ -231,13 +256,18 @@ temporary filenames instead of those specified.
 
      zdiff [OPTIONS] FILE1 [FILE2]
 
-Compares FILE1 to FILE2. If FILE2 is omitted zdiff tries the following:
-If FILE1 is compressed, compares FILE1 to the file with the
-corresponding decompressed file name (removes the extension from FILE1).
-If FILE1 is not compressed, compares FILE1 to the uncompressed contents
-of FILE1.[bz2|gz|lz|xz] (the first one that is found).
-If no suitable file is found, compares FILE1 to data read from standard
-input.
+This compares FILE1 to FILE2. If FILE2 is omitted zdiff tries the
+following:
+
+  1. If FILE1 is compressed, compares FILE1 to the file with the
+     corresponding decompressed file name (removes the extension from
+     FILE1).
+
+  2. If FILE1 is not compressed, compares FILE1 to the uncompressed
+     contents of FILE1.[bz2|gz|lz|xz] (the first one that is found).
+
+  3. If no suitable file is found, compares FILE1 to data read from
+     standard input.
 
 An exit status of 0 means no differences were found, 1 means some
 differences were found, and 2 means trouble.
@@ -279,6 +309,14 @@ differences were found, and 2 means trouble.
 `--ignore-tab-expansion'
      Ignore changes due to tab expansion.
 
+`--format=[FMT1][,FMT2]'
+     Force the given compression formats. Any of FMT1 or FMT2 may be
+     omitted and the corresponding format will be automatically
+     detected.  Valid values for FMT are `bz2', `gz', `lz' and `xz'. If
+     at least one format is specified with this option, the exact file
+     names of both FILE1 and FILE2 must be given.  Other names won't be
+     tried.
+
 `-i'
 `--ignore-case'
      Ignore case differences in file contents.
@@ -326,10 +364,12 @@ on any combination of compressed and non-compressed files. If any given
 file is compressed, its uncompressed 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 compressors. If no files are specified, data is 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
-compressed with the same compressor.
+supported formats.
+
+   If no files are specified, data is 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.
 
    The format for running zgrep is:
 
@@ -387,9 +427,15 @@ matches were found, and 2 means trouble.
 `--fixed-strings'
      Treat PATTERN as a set of newline-separated strings.
 
+`--format=FMT'
+     Force the given compression format. Valid values for FMT are
+     `bz2', `gz', `lz' and `xz'. If this option is used, the exact file
+     name must be given. Other names won't be tried.
+
 `-h'
 `--no-filename'
-     Suppress the prefixing filename on output.
+     Suppress the prefixing of filenames on output when multiple files
+     are searched.
 
 `-H'
 `--with-filename'
@@ -459,16 +505,18 @@ File: zutils.info,  Node: Ztest,  Next: Problems,  Prev: Zgrep,  Up: Top
 Ztest verifies the integrity of the specified compressed files.
 Non-compressed files are ignored. If no files are specified, the
 integrity of compressed data read from standard input is verified. Data
-read from standard input must be all compressed with the same
-compressor.
+read from standard input must be all in the same compression format.
+
+   Note that some xz files lack integrity information, and therefore
+can't be verified as reliably as the other formats can.
 
    The format for running ztest is:
 
      ztest [OPTIONS] [FILES]
 
-The exit status is 0 if all files verify OK, 1 for environmental
-problems (file not found, invalid flags, I/O errors, etc), 2 to indicate
-a corrupt or invalid input file.
+The exit status is 0 if all compressed files verify OK, 1 if
+environmental problems (file not found, invalid flags, I/O errors, etc),
+2 if any compressed file is corrupt or invalid.
 
    Ztest supports the following options:
 
@@ -480,6 +528,11 @@ a corrupt or invalid input file.
 `--version'
      Print the version number of ztest on the standard output and exit.
 
+`--format=FMT'
+     Force the given compression format. Valid values for FMT are
+     `bz2', `gz', `lz' and `xz'. If this option is used, all files not
+     in the given format will fail.
+
 `-q'
 `--quiet'
      Quiet operation. Suppress all messages.
@@ -531,13 +584,18 @@ Concept Index
 
 Tag Table:
 Node: Top224
-Node: Introduction992
-Node: Zcat2447
-Node: Zcmp4331
-Node: Zdiff6388
-Node: Zgrep8625
-Node: Ztest11392
-Node: Problems12475
-Node: Concept Index13004
+Node: Introduction1006
+Node: Zcat2593
+Node: Zcmp4679
+Node: Zdiff7165
+Node: Zgrep9831
+Node: Ztest12842
+Node: Problems14246
+Node: Concept Index14775
 
 End Tag Table
+
+
+Local Variables:
+coding: iso-8859-15
+End: