summaryrefslogtreecommitdiffstats
path: root/doc/ztest.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ztest.1')
-rw-r--r--doc/ztest.129
1 files changed, 17 insertions, 12 deletions
diff --git a/doc/ztest.1 b/doc/ztest.1
index 2f51e51..5eb3bb4 100644
--- a/doc/ztest.1
+++ b/doc/ztest.1
@@ -1,19 +1,21 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
-.TH ZTEST "1" "April 2022" "zutils 1.12-pre2" "User Commands"
+.TH ZTEST "1" "December 2022" "zutils 1.12-rc1" "User Commands"
.SH NAME
ztest \- verify the integrity of compressed files
.SH SYNOPSIS
.B ztest
[\fI\,options\/\fR] [\fI\,files\/\fR]
.SH DESCRIPTION
-ztest verifies the integrity of the compressed files specified.
-Uncompressed files are ignored. If a file is specified as '\-', the
-integrity of compressed data read from standard input is verified. Data
-read from standard input must be all in the same compressed format. If
-a file fails to decompress, does not exist, can't be opened, or is a
-terminal, ztest continues verifying the rest of the files. A final
-diagnostic is shown at verbosity level 1 or higher if any file fails the
-test when testing multiple files.
+ztest verifies the integrity of the compressed files specified. It
+also warns if an uncompressed file has a compressed file name extension, or
+if a compressed file has a wrong compressed extension. Uncompressed files
+are otherwise ignored. If a file is specified as '\-', the integrity of
+compressed data read from standard input is verified. Data read from
+standard input must be all in the same compressed format. If a file fails to
+decompress, does not exist, can't be opened, or is a terminal, ztest
+continues verifying the rest of the files. A final diagnostic is shown at
+verbosity level 1 or higher if any file fails the test when testing multiple
+files.
.PP
If no files are specified, recursive searches examine the current
working directory, and nonrecursive searches read standard input.
@@ -28,8 +30,9 @@ garbage output without issuing any warning. Therefore, xz files can't
always be verified as reliably as files in the other formats can.
.PP
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.
+problems (file not found, invalid command line options, I/O errors, etc),
+2 if any compressed file is corrupt or invalid, or if any file has an
+incorrect file name extension.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
@@ -45,7 +48,7 @@ process only the formats in <list>
don't read runtime configuration file
.TP
\fB\-O\fR, \fB\-\-force\-format=\fR<fmt>
-force the format given (bz2, gz, lz, xz, zst)
+force the input format
.TP
\fB\-q\fR, \fB\-\-quiet\fR
suppress all messages
@@ -73,6 +76,8 @@ set compressor and options for xz format
.TP
\fB\-\-zst=\fR<command>
set compressor and options for zstd format
+.PP
+Valid formats for options '\-M' and '\-O' are 'bz2', 'gz', 'lz', 'xz', and 'zst'.
.SH "REPORTING BUGS"
Report bugs to zutils\-bug@nongnu.org
.br