diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/zutils.texi | 78 |
1 files changed, 39 insertions, 39 deletions
diff --git a/doc/zutils.texi b/doc/zutils.texi index 4624d8c..236265c 100644 --- a/doc/zutils.texi +++ b/doc/zutils.texi @@ -6,8 +6,8 @@ @finalout @c %**end of header -@set UPDATED 30 April 2015 -@set VERSION 1.4-pre2 +@set UPDATED 29 May 2015 +@set VERSION 1.4 @dircategory Data Compression @direntry @@ -74,8 +74,8 @@ The provided utilities are zcat, zcmp, zdiff, zgrep, ztest and zupdate.@* The supported formats are bzip2, gzip, lzip and xz.@* The compressor to be used for each format is configurable at runtime. -Zcat, zcmp, zdiff, and zgrep are improved replacements for the shell -scripts provided by GNU gzip. Ztest is unique to zutils. Zupdate is +zcat, zcmp, zdiff, and zgrep are improved replacements for the shell +scripts provided by GNU gzip. ztest is unique to zutils. zupdate is similar to gzip's znew. NOTE: Bzip2 and lzip provide well-defined values of exit status, which @@ -83,14 +83,14 @@ makes them safe to use with zutils. Gzip and xz may return ambiguous warning values, making them less reliable back ends for zutils. @xref{compressor-requirements}. -FORMAT NOTE: The "--format" option allows the processing of a subset of -formats in search and recursive modes: +FORMAT NOTE: The @samp{--format} option allows the processing of a +subset of formats in search and recursive modes: @w{@samp{zgrep foo -r --format=bz2,lz somedir}}. -FORMAT NOTE 2: If the @samp{--force-format} option is given, the files are -passed to the corresponding decompressor without verifying their format, -allowing for example the processing of compress'd (.Z) files with gzip: -@w{@samp{zcmp --force-format=gz file.Z file.lz}}. +FORMAT NOTE 2: If the @samp{--force-format} option is given, the files +are passed to the corresponding decompressor without verifying their +format, allowing for example the processing of compress'd (.Z) files +with gzip: @w{@samp{zcmp --force-format=gz file.Z file.lz}}. LANGUAGE NOTE: Uncompressed = not compressed = plain data; it may never have been compressed. Decompressed is used to refer to data which has @@ -123,10 +123,10 @@ The following options are available in all the utilities. Rather than writing identical descriptions for each of the programs, they are described here. -@table @samp +@table @code @item -h @itemx --help -Print an informative help message describing the options and exit. Zgrep +Print an informative help message describing the options and exit. zgrep only supports the @samp{--help} form of this option. @item -V @@ -135,14 +135,14 @@ Print the version number on the standard output and exit. @item -M @var{format_list} @itemx --format=@var{format_list} -Exclude formats not listed in the comma-separated @var{format_list}. -Valid formats are @samp{bz2}, @samp{gz}, @samp{lz}, @samp{xz} and -@samp{un} for @samp{uncompressed}, meaning "any file name without a -known extension". This option excludes files based on extension, instead -of format, because it is more efficient. The exclusion only applies to -names generated automatically (for example when adding extensions to a -file name or when operating recursively on directories). Files given in -the command line are always processed. +Process only the formats listed in the comma-separated +@var{format_list}. Valid formats are @samp{bz2}, @samp{gz}, @samp{lz}, +@samp{xz} and @samp{un} for @samp{uncompressed}, meaning "any file name +without a known extension". This option excludes files based on +extension, instead of format, because it is more efficient. The +exclusion only applies to names generated automatically (for example +when adding extensions to a file name or when operating recursively on +directories). Files given in the command line are always processed. Each format in @var{format_list} enables file names with the following extensions: @@ -217,7 +217,7 @@ where <format> is one of @samp{bz2}, @samp{gz}, @samp{lz} or @samp{xz}. @chapter Zcat @cindex zcat -Zcat copies each given file (@samp{-} means standard input), to standard +zcat copies each given file (@samp{-} means standard input), to standard output. If any given file is compressed, its decompressed 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 @@ -237,9 +237,9 @@ zcat [@var{options}] [@var{files}] @noindent Exit status is 0 if no errors occurred, non-zero otherwise. -Zcat supports the following options: +zcat supports the following options: -@table @samp +@table @code @item -A @itemx --show-all Equivalent to @samp{-vET}. @@ -303,7 +303,7 @@ Verbose mode. Show error messages. @chapter Zcmp @cindex zcmp -Zcmp compares two files (@samp{-} means standard input), and if they +zcmp compares two files (@samp{-} means standard input), and if they differ, tells the first byte and line number where they differ. Bytes and lines are numbered starting with 1. If any given file is compressed, its decompressed content is used. Compressed files are decompressed on @@ -336,9 +336,9 @@ standard input. An exit status of 0 means no differences were found, 1 means some differences were found, and 2 means trouble. -Zcmp supports the following options: +zcmp supports the following options: -@table @samp +@table @code @item -b @itemx --print-bytes Print the differing bytes. Print control bytes as a @samp{^} followed by @@ -388,9 +388,9 @@ files differ. @chapter Zdiff @cindex zdiff -Zdiff compares two files (@samp{-} means standard input), and if they +zdiff compares two files (@samp{-} means standard input), and if they differ, shows the differences line by line. If any given file is -compressed, its decompressed content is used. Zdiff is a front end to +compressed, its decompressed content is used. zdiff is a front end to the diff program and has the limitation that messages from diff refer to temporary file names instead of those specified. @@ -421,9 +421,9 @@ standard input. An exit status of 0 means no differences were found, 1 means some differences were found, and 2 means trouble. -Zdiff supports the following options: +zdiff supports the following options: -@table @samp +@table @code @item -a @itemx --text Treat all files as text. @@ -503,7 +503,7 @@ Ignore all white space. @chapter Zgrep @cindex zgrep -Zgrep is a front end to the grep program that allows transparent search +zgrep is a front end to the grep program that allows transparent search on any combination of compressed and uncompressed files. If any given file is compressed, its decompressed content is used. If a given file does not exist, and its name does not end with one of the known @@ -525,9 +525,9 @@ zgrep [@var{options}] @var{pattern} [@var{files}] An exit status of 0 means at least one match was found, 1 means no matches were found, and 2 means trouble. -Zgrep supports the following options: +zgrep supports the following options: -@table @samp +@table @code @item -a @itemx --text Treat all files as text. @@ -647,7 +647,7 @@ Match only whole lines. @chapter Ztest @cindex ztest -Ztest verifies the integrity of the specified compressed files. +ztest verifies the integrity of the specified compressed files. Uncompressed 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 in the same compression format. @@ -666,9 +666,9 @@ 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: +ztest supports the following options: -@table @samp +@table @code @item -O @var{format} @itemx --force-format=@var{format} Force the given compression format. Valid values for @var{format} are @@ -699,7 +699,7 @@ Further -v's increase the verbosity level. @chapter Zupdate @cindex zupdate -Zupdate recompresses files from bzip2, gzip, and xz formats to lzip +zupdate recompresses files from bzip2, gzip, and xz formats to lzip format. The originals are compared with the new files and then deleted. Only regular files with standard file name extensions are recompressed, other files are ignored. Compressed files are decompressed and then @@ -740,9 +740,9 @@ Exit status is 0 if all the compressed files were successfully recompressed (if needed), compared and deleted (if requested). Non-zero otherwise. -Zupdate supports the following options: +zupdate supports the following options: -@table @samp +@table @code @item -f @itemx --force Do not skip a file for which a lzip compressed version already exists. |