summaryrefslogtreecommitdiffstats
path: root/doc/zcat.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zcat.1')
-rw-r--r--doc/zcat.167
1 files changed, 50 insertions, 17 deletions
diff --git a/doc/zcat.1 b/doc/zcat.1
index 407e270..244aaad 100644
--- a/doc/zcat.1
+++ b/doc/zcat.1
@@ -1,25 +1,22 @@
-.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
-.TH ZCAT "1" "December 2009" "Zcat (zutils) 0.8-rc1" "User Commands"
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
+.TH ZCAT "1" "November 2010" "Zcat (zutils) 0.8" "User Commands"
.SH NAME
-Zcat \- concatenate compressed files to stdout
+Zcat \- decompress and concatenate files to standard output
.SH SYNOPSIS
.B zcat
-[\fIOPTIONS\fR] [\fICAT_OPTIONS\fR] [\fIFILES\fR]
+[\fIoptions\fR] [\fIfiles\fR]
.SH DESCRIPTION
-Zcat \- Cat wrapper for compressed files.
-.PP
-Zcat is a wrapper script around the cat command that allows transparent
-concatenation of 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, zcat tries the compressed file names
+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
-stdout. Data read from standard input must be of the same type; all
-uncompressed or all compressed with the same compressor.
+standard output. Data read from standard input must be of the same type;
+all uncompressed or all compressed with the same compressor.
The supported compressors are bzip2, gzip, lzip and xz.
.PP
-CAT_OPTIONS are passed directly to cat.
-The exit status from cat is preserved.
+Exit status is 0 if no errors occurred, 1 otherwise.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
@@ -28,12 +25,48 @@ display this help and exit
\fB\-V\fR, \fB\-\-version\fR
output version information and exit
.TP
+\fB\-A\fR, \fB\-\-show\-all\fR
+equivalent to `\-vET'
+.TP
+\fB\-b\fR, \fB\-\-number\-nonblank\fR
+number nonblank output lines
+.TP
+\fB\-e\fR
+equivalent to `\-vE'
+.TP
+\fB\-E\fR, \fB\-\-show\-ends\fR
+display `$' at end of each line
+.TP
+\fB\-n\fR, \fB\-\-number\fR
+number all output lines
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+suppress all messages
+.TP
\fB\-r\fR, \fB\-\-recursive\fR
operate recursively on directories
+.TP
+\fB\-s\fR, \fB\-\-squeeze\-blank\fR
+never more than one single blank line
+.TP
+\fB\-t\fR
+equivalent to `\-vT'
+.TP
+\fB\-T\fR, \fB\-\-show\-tabs\fR
+display TAB characters as `^I'
+.TP
+\fB\-v\fR, \fB\-\-show\-nonprinting\fR
+use `^' and `M\-' notation, except for LF and TAB
+.TP
+\fB\-\-verbose\fR
+verbose mode (show error messages)
.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 2009 Antonio Diaz Diaz.
-This script is free software: you have unlimited permission
-to copy, distribute and modify it.
+Copyright \(co 2010 Antonio Diaz Diaz.
+License GPLv3+: GNU GPL version 3 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.