diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/zcat.1 | 7 | ||||
| -rw-r--r-- | doc/zdiff.1 | 6 | ||||
| -rw-r--r-- | doc/zgrep.1 | 4 | ||||
| -rw-r--r-- | doc/ztest.1 | 40 | ||||
| -rw-r--r-- | doc/zutils.info | bin | 6062 -> 7251 bytes | |||
| -rw-r--r-- | doc/zutils.texinfo | 64 |
6 files changed, 107 insertions, 14 deletions
@@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. -.TH ZCAT "1" "October 2009" "Zcat 0.6" "User Commands" +.TH ZCAT "1" "October 2009" "Zcat 0.7" "User Commands" .SH NAME Zcat \- concatenate compressed files to stdout .SH SYNOPSIS @@ -16,7 +16,7 @@ corresponding to the supported compressors. If no files are specified, data is read from standard input, decompressed if needed, and sent to stdout. Data read from standard input must be of the same type; all uncompressed or all compressed with the same compressor. -The supported compressors are gzip, bzip2, lzip and xz. +The supported compressors are bzip2, gzip, lzip and xz. .PP CAT_OPTIONS are passed directly to cat. The exit status from cat is preserved. @@ -27,6 +27,9 @@ display this help and exit .TP \fB\-V\fR, \fB\-\-version\fR output version information and exit +.TP +\fB\-r\fR, \fB\-\-recursive\fR +operate recursively on directories .SH "REPORTING BUGS" Report bugs to zutils\-bug@nongnu.org Zutils home page: http://www.nongnu.org/zutils/zutils.html diff --git a/doc/zdiff.1 b/doc/zdiff.1 index cf19d27..896d735 100644 --- a/doc/zdiff.1 +++ b/doc/zdiff.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. -.TH ZDIFF "1" "October 2009" "Zdiff 0.6" "User Commands" +.TH ZDIFF "1" "October 2009" "Zdiff 0.7" "User Commands" .SH NAME Zdiff \- compare compressed files .SH SYNOPSIS @@ -11,7 +11,7 @@ Zdiff \- Diff/cmp wrapper for compressed files. Zdiff is a wrapper script around the diff and cmp commands that allows transparent comparison of any combination of compressed and non\-compressed files. If any given file is compressed, its uncompressed -content is used. The supported compressors are gzip, bzip2, lzip and xz. +content is used. The supported compressors are bzip2, gzip, lzip and xz. .PP Zcmp is a shortcut for "zdiff \fB\-\-cmp\fR" .PP @@ -19,7 +19,7 @@ Compares FILE1 to FILE2. If FILE2 is omitted and FILE1 is compressed, compares FILE1 to the file with the corresponding decompressed file name (removes the extension from FILE1). If FILE2 is omitted and FILE1 is not compressed, compares FILE1 to the uncompressed contents of -FILE1.[gz|bz2|lz|xz] (the first one that is found). +FILE1.[bz2|gz|lz|xz] (the first one that is found). DIFF_OPTIONS are passed directly to diff or cmp. The exit status from diff or cmp is preserved. .SH OPTIONS diff --git a/doc/zgrep.1 b/doc/zgrep.1 index fc22717..92c4010 100644 --- a/doc/zgrep.1 +++ b/doc/zgrep.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. -.TH ZGREP "1" "October 2009" "Zgrep 0.6" "User Commands" +.TH ZGREP "1" "October 2009" "Zgrep 0.7" "User Commands" .SH NAME Zgrep \- search compressed files for a regular expression .SH SYNOPSIS @@ -16,7 +16,7 @@ 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. -The supported compressors are gzip, bzip2, lzip and xz. +The supported compressors are bzip2, gzip, lzip and xz. .PP Zegrep is a shortcut for "zgrep \fB\-E\fR" Zfgrep is a shortcut for "zgrep \fB\-F\fR" diff --git a/doc/ztest.1 b/doc/ztest.1 new file mode 100644 index 0000000..f32c7d7 --- /dev/null +++ b/doc/ztest.1 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. +.TH ZTEST "1" "October 2009" "Ztest 0.7" "User Commands" +.SH NAME +Ztest \- verify integrity of compressed files +.SH SYNOPSIS +.B ztest +[\fIOPTIONS\fR] [\fIFILES\fR] +.SH DESCRIPTION +Ztest \- Test integrity of compressed files. +.PP +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. +The supported compressors are bzip2, gzip, lzip and xz. +.PP +The exit status is 1 if any compressed file is corrupt, 0 otherwise. +.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\-q\fR, \fB\-\-quiet\fR +suppress all messages +.TP +\fB\-r\fR, \fB\-\-recursive\fR +operate recursively on directories +.TP +\fB\-v\fR, \fB\-\-verbose\fR +be verbose (a 2nd \fB\-v\fR gives more) +.SH "REPORTING BUGS" +Report bugs to zutils\-bug@nongnu.org +Zutils home page: http://www.nongnu.org/zutils/zutils.html +.SH COPYRIGHT +Copyright \(co 2009 Antonio Diaz Diaz. +This script is free software: you have unlimited permission +to copy, distribute and modify it. diff --git a/doc/zutils.info b/doc/zutils.info Binary files differindex 34f390b..ba5ff0a 100644 --- a/doc/zutils.info +++ b/doc/zutils.info diff --git a/doc/zutils.texinfo b/doc/zutils.texinfo index 3902270..d6f724d 100644 --- a/doc/zutils.texinfo +++ b/doc/zutils.texinfo @@ -1,12 +1,12 @@ \input texinfo @c -*-texinfo-*- @c %**start of header @setfilename zutils.info -@settitle Zutils +@settitle Zutils Manual @finalout @c %**end of header -@set UPDATED 5 October 2009 -@set VERSION 0.6 +@set UPDATED 21 October 2009 +@set VERSION 0.7 @dircategory Data Compression @direntry @@ -36,6 +36,7 @@ This manual is for Zutils (version @value{VERSION}, @value{UPDATED}). * Zcat:: Concatenating compressed files * Zcmp/Zdiff:: Comparing compressed files * Zgrep:: Searching inside compressed files +* Ztest:: Testing integrity of compressed files * Problems:: Reporting bugs * Concept Index:: Index of concepts @end menu @@ -53,10 +54,10 @@ to copy, distribute and modify it. Zutils is a collection of utilities for dealing with any combination of compressed and non-compressed files transparently. The supported -compressors are gzip, bzip2, lzip and xz. +compressors are bzip2, gzip, lzip and xz. -The currently provided utilities are zcat, zcmp, zdiff, zegrep, zfgrep -and zgrep. +The currently provided utilities are zcat, zcmp, zdiff, zegrep, zfgrep, +zgrep and ztest. @node Zcat @@ -93,6 +94,10 @@ Print an informative help message describing the options and exit. @itemx -V Print the version number of zcat on the standard output and exit. +@item --recursive +@itemx -r +Operate recursively on directories. + @end table @@ -121,7 +126,7 @@ Compares @var{file1} to @var{file2}. If @var{file2} is omitted and corresponding decompressed file name (removes the extension from @var{file1}). If @var{file2} is omitted and @var{file1} is not compressed, compares @var{file1} to the uncompressed contents of -@var{file1}.[gz|bz2|lz|xz] (the first one that is found). +@var{file1}.[bz2|gz|lz|xz] (the first one that is found). @var{diff_options} are passed directly to diff or cmp. The exit status from diff or cmp is preserved. @@ -192,6 +197,51 @@ Print the version number of zgrep on the standard output and exit. @end table +@node Ztest +@chapter Ztest +@cindex ztest + +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. + +The format for running ztest is: + +@example +ztest [@var{options}] [@var{files}] +@end example + +@noindent +The exit status is 0 if all files verify OK, 1 otherwise. + +Ztest supports the following options: + +@table @samp +@item --help +@itemx -h +Print an informative help message describing the options and exit. + +@item --version +@itemx -V +Print the version number of ztest on the standard output and exit. + +@item --quiet +@itemx -q +Quiet operation. Suppress all messages. + +@item --recursive +@itemx -r +Operate recursively on directories. + +@item --verbose +@itemx -v +Verbose mode. Show the verify status for each file processed. +Further -v's increase the verbosity level. + +@end table + + @node Problems @chapter Reporting Bugs @cindex bugs |