diff options
Diffstat (limited to 'doc/zutils.info')
| -rw-r--r-- | doc/zutils.info | 158 |
1 files changed, 104 insertions, 54 deletions
diff --git a/doc/zutils.info b/doc/zutils.info index ac3c7a5..83f07b7 100644 --- a/doc/zutils.info +++ b/doc/zutils.info @@ -12,12 +12,12 @@ File: zutils.info, Node: Top, Next: Introduction, Up: (dir) Zutils Manual ************* -This manual is for Zutils (version 1.3, 30 August 2014). +This manual is for Zutils (version 1.4-pre2, 30 April 2015). * Menu: * Introduction:: Purpose and features of zutils -* Common options:: Common options +* Common options:: Options common to all utilities * The zutilsrc file:: The zutils configuration file * Zcat:: Concatenating compressed files * Zcmp:: Comparing compressed files byte by byte @@ -29,7 +29,7 @@ This manual is for Zutils (version 1.3, 30 August 2014). * Concept index:: Index of concepts - Copyright (C) 2009-2014 Antonio Diaz Diaz. + Copyright (C) 2009-2015 Antonio Diaz Diaz. This manual is free documentation: you have unlimited permission to copy, distribute and modify it. @@ -61,12 +61,16 @@ similar to gzip's znew. NOTE: Bzip2 and lzip provide well-defined values of exit status, which makes them safe to use with zutils. Gzip and xz may return ambiguous warning values, making them less reliable back ends for -zutils. +zutils. *Note compressor-requirements::. - FORMAT NOTE: If the '--format' option is given, the corresponding -files are passed to the decompressor without verifying their format, + FORMAT NOTE: The "-format" option allows the processing of a subset +of formats in search and recursive modes: +'zgrep foo -r --format=bz2,lz somedir'. + + FORMAT NOTE 2: If the '--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: -'zcmp --format=gz file.Z file.lz'. +'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 @@ -107,6 +111,26 @@ described here. '--version' Print the version number on the standard output and exit. +'-M FORMAT_LIST' +'--format=FORMAT_LIST' + Exclude formats not listed in the comma-separated FORMAT_LIST. + Valid formats are 'bz2', 'gz', 'lz', 'xz' and 'un' for + '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 FORMAT_LIST enables file names with the following + extensions: + + bz2 enables .bz2 .tbz .tbz2 + gz enables .gz .tgz + lz enables .lz .tlz + xz enables .xz .txz + un enables any other file name + '-N' '--no-rcfile' Don't read the runtime configuration file 'zutilsrc'. @@ -116,9 +140,9 @@ described here. '--lz=COMMAND' '--xz=COMMAND' Set program (may include arguments) to be used as (de)compressor - for the given format. These options override the values set in - 'zutilsrc'. The compression program used must meet three - requirements: + for the given format. The mane of the program can't begin with + '-'. These options override the values set in 'zutilsrc'. The + compression program used must meet three requirements: 1. When called with the '-d' option, it must read compressed data from the standard input and produce decompressed data on @@ -197,16 +221,19 @@ Exit status is 0 if no errors occurred, non-zero otherwise. '--show-ends' Print a '$' after the end of each line. -'--format=FMT' - Force the given compression format. Valid values for FMT are - 'bz2', 'gz', 'lz' and 'xz'. If this option is used, the exact file - name must be given. Other names won't be tried. - '-n' '--number' Number all output lines, starting with 1. The line count is unlimited. +'-O FORMAT' +'--force-format=FORMAT' + Force the given compression format. Valid values for FORMAT are + 'bz2', 'gz', 'lz' and 'xz'. If this option is used, the files are + passed to the corresponding decompressor without verifying their + format, and the exact file name must be given. Other names won't + be tried. + '-q' '--quiet' Quiet operation. Suppress all messages. @@ -276,14 +303,6 @@ differences were found, and 2 means trouble. a letter, and precede bytes larger than 127 with 'M-' (which stands for "meta"). -'--format=[FMT1][,FMT2]' - Force the given compression formats. Any of FMT1 or FMT2 may be - omitted and the corresponding format will be automatically - detected. Valid values for FMT are 'bz2', 'gz', 'lz' and 'xz'. If - at least one format is specified with this option, the exact file - names of both FILE1 and FILE2 must be given. Other names won't be - tried. - '-i SIZE' '--ignore-initial=SIZE' Ignore any differences in the first SIZE bytes of the input files. @@ -303,6 +322,16 @@ differences were found, and 2 means trouble. '--bytes=COUNT' Compare at most COUNT input bytes. +'-O [FORMAT1][,FORMAT2]' +'--force-format=[FORMAT1][,FORMAT2]' + Force the given compression formats. Any of FORMAT1 or FORMAT2 may + be omitted and the corresponding format will be automatically + detected. Valid values for FORMAT are 'bz2', 'gz', 'lz' and 'xz'. + If at least one format is specified with this option, the file is + passed to the corresponding decompressor without verifying its + format, and the exact file names of both FILE1 and FILE2 must be + given. Other names won't be tried. + '-q' '-s' '--quiet' @@ -321,7 +350,7 @@ Zdiff compares two files ('-' 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 the diff program and has the limitation that messages from diff refer to -temporary filenames instead of those specified. +temporary file names instead of those specified. The format for running zdiff is: @@ -372,18 +401,20 @@ differences were found, and 2 means trouble. '--ignore-tab-expansion' Ignore changes due to tab expansion. -'--format=[FMT1][,FMT2]' - Force the given compression formats. Any of FMT1 or FMT2 may be - omitted and the corresponding format will be automatically - detected. Valid values for FMT are 'bz2', 'gz', 'lz' and 'xz'. If - at least one format is specified with this option, the exact file - names of both FILE1 and FILE2 must be given. Other names won't be - tried. - '-i' '--ignore-case' Ignore case differences in file contents. +'-O [FORMAT1][,FORMAT2]' +'--force-format=[FORMAT1][,FORMAT2]' + Force the given compression formats. Any of FORMAT1 or FORMAT2 may + be omitted and the corresponding format will be automatically + detected. Valid values for FORMAT are 'bz2', 'gz', 'lz' and 'xz'. + If at least one format is specified with this option, the file is + passed to the corresponding decompressor without verifying its + format, and the exact file names of both FILE1 and FILE2 must be + given. Other names won't be tried. + '-p' '--show-c-function' Show which C function each change is in. @@ -483,19 +514,14 @@ matches were found, and 2 means trouble. '--fixed-strings' Treat PATTERN as a set of newline-separated strings. -'--format=FMT' - Force the given compression format. Valid values for FMT are - 'bz2', 'gz', 'lz' and 'xz'. If this option is used, the exact file - name must be given. Other names won't be tried. - '-h' '--no-filename' - Suppress the prefixing of filenames on output when multiple files + Suppress the prefixing of file names on output when multiple files are searched. '-H' '--with-filename' - Print the filename for each match. + Print the file name for each match. '-i' '--ignore-case' @@ -524,6 +550,14 @@ matches were found, and 2 means trouble. '--only-matching' Show only the part of matching lines that actually matches PATTERN. +'-O FORMAT' +'--force-format=FORMAT' + Force the given compression format. Valid values for FORMAT are + 'bz2', 'gz', 'lz' and 'xz'. If this option is used, the files are + passed to the corresponding decompressor without verifying their + format, and the exact file name must be given. Other names won't + be tried. + '-q' '--quiet' Suppress all messages. Exit immediately with zero status if any @@ -577,10 +611,15 @@ environmental problems (file not found, invalid flags, I/O errors, etc), Ztest supports the following options: -'--format=FMT' - Force the given compression format. Valid values for FMT are - 'bz2', 'gz', 'lz' and 'xz'. If this option is used, all files not - in the given format will fail. +'-O FORMAT' +'--force-format=FORMAT' + Force the given compression format. Valid values for FORMAT are + 'bz2', 'gz', 'lz' and 'xz'. If this option is used, the files are + passed to the corresponding decompressor without verifying their + format, and any files in a format that the decompressor can't + understand will fail. For example, '--force-format=gz' can test + gzipped (.gz) and compress'd (.Z) files if the compressor used is + GNU gzip. '-q' '--quiet' @@ -617,10 +656,20 @@ and the original file is not deleted. The operation of zupdate is meant to be safe and not produce any data loss. Therefore, existing lzip compressed files are never overwritten nor deleted. + Combining the '--force' and '--keep' options, as in +'zupdate -f -k *.gz', verifies that there are no differences between +each pair of files in a multiformat set of files. + The names of the original files must have one of the following extensions: '.bz2', '.tbz', '.tbz2', '.gz', '.tgz', '.xz', '.txz'. The files produced have the extensions '.lz' or '.tar.lz'. + Recompressing a file is much like copying or moving it; therefore +zupdate preserves the access and modification dates, permissions, and, +when possible, ownership of the file just as "cp -p" does. (If the user +ID or the group ID can't be duplicated, the file permission bits S_ISUID +and S_ISGID are cleared). + The format for running zupdate is: zupdate [OPTIONS] [FILES] @@ -708,17 +757,18 @@ Concept index Tag Table: Node: Top222 -Node: Introduction1128 -Node: Common options3475 -Node: The zutilsrc file4724 -Node: Zcat5650 -Node: Zcmp7572 -Node: Zdiff9896 -Node: Zgrep12399 -Node: Ztest15367 -Node: Zupdate16591 -Node: Problems18979 -Node: Concept index19513 +Node: Introduction1149 +Node: Common options3698 +Ref: compressor-requirements5451 +Node: The zutilsrc file5823 +Node: Zcat6749 +Node: Zcmp8796 +Node: Zdiff11256 +Node: Zgrep13896 +Node: Ztest16991 +Node: Zupdate18495 +Node: Problems21370 +Node: Concept index21904 End Tag Table |