1 files changed, 102 insertions, 0 deletions
diff --git a/doc/ztest.1 b/doc/ztest.1
new file mode 100644
index 0000000..caa0b2a
--- /dev/null
+++ b/doc/ztest.1
@@ -0,0 +1,102 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
+.TH ZTEST "1" "January 2024" "zutils 1.13" "User Commands"
+.SH NAME
+ztest \- check the integrity of compressed files
+.SH SYNOPSIS
+.B ztest
+[\fI\,options\/\fR] [\fI\,files\/\fR]
+.SH DESCRIPTION
+ztest checks 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 checked. 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 testing 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.
+.PP
+The formats supported are bzip2, gzip, lzip, xz, and zstd.
+.PP
+Note that error detection in the xz format is broken. First, some xz files
+lack integrity information. Second, not all xz decompressors can check the
+integrity of all xz files. Third, section 2.1.1.2 'Stream Flags' of the
+xz format specification allows xz decompressors to produce garbage output
+without issuing any warning. Therefore, xz files can't always be checked as
+reliably as files in the other formats can.
+.PP
+Exit status is 0 if all compressed files check OK, 1 if environmental
+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
+display this help and exit
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+output version information and exit
+.TP
+\fB\-M\fR, \fB\-\-format=\fR<list>
+process only the formats in <list>
+.TP
+\fB\-N\fR, \fB\-\-no\-rcfile\fR
+don't read runtime configuration file
+.TP
+\fB\-O\fR, \fB\-\-force\-format=\fR<fmt>
+force the input format
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+suppress all messages
+.TP
+\fB\-r\fR, \fB\-\-recursive\fR
+operate recursively on directories
+.TP
+\fB\-R\fR, \fB\-\-dereference\-recursive\fR
+recursively follow symbolic links
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+be verbose (a 2nd \fB\-v\fR gives more)
+.TP
+\fB\-\-bz2=\fR<command>
+set compressor and options for bzip2 format
+.TP
+\fB\-\-gz=\fR<command>
+set compressor and options for gzip format
+.TP
+\fB\-\-lz=\fR<command>
+set compressor and options for lzip format
+.TP
+\fB\-\-xz=\fR<command>
+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
+Zutils home page: http://www.nongnu.org/zutils/zutils.html
+.SH COPYRIGHT
+Copyright \(co 2024 Antonio Diaz Diaz.
+License GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl.html>
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.SH "SEE ALSO"
+The full documentation for
+.B ztest
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B ztest
+programs are properly installed at your site, the command
+.IP
+.B info zutils
+.PP
+should give you access to the complete manual.