diff options
Diffstat (limited to 'doc/zutils.info')
| -rw-r--r-- | doc/zutils.info | 417 |
1 files changed, 212 insertions, 205 deletions
diff --git a/doc/zutils.info b/doc/zutils.info index b8a77da..59c7af2 100644 --- a/doc/zutils.info +++ b/doc/zutils.info @@ -1,4 +1,4 @@ -This is zutils.info, produced by makeinfo version 4.13 from +This is zutils.info, produced by makeinfo version 4.13+ from zutils.texinfo. INFO-DIR-SECTION Data Compression @@ -12,7 +12,7 @@ File: zutils.info, Node: Top, Next: Introduction, Up: (dir) Zutils Manual ************* -This manual is for Zutils (version 1.2-pre2, 4 September 2013). +This manual is for Zutils (version 1.2-pre3, 11 October 2013). * Menu: @@ -47,7 +47,7 @@ used. Compressed files are decompressed on the fly; no temporary files are created. These utilities are not wrapper scripts but safer and more efficient -C++ programs. In particular the `--recursive' option is very efficient +C++ programs. In particular the '--recursive' option is very efficient in those utilities supporting it. The provided utilities are zcat, zcmp, zdiff, zgrep, ztest and zupdate. @@ -60,7 +60,8 @@ 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 backends for zutils. +ambiguous warning values, making them less reliable back ends for +zutils. LANGUAGE NOTE: Uncompressed = not compressed = plain data; it may never have been compressed. Decompressed is used to refer to data which @@ -68,7 +69,7 @@ has undergone the process of decompression. Numbers given as arguments to options (positions, sizes) may be -followed by a multiplier and an optional `B' for "byte". +followed by a multiplier and an optional 'B' for "byte". Table of SI and binary prefixes (unit multipliers): @@ -92,33 +93,33 @@ The following options are available in all the utilities. Rather than writing identical descriptions for each of the programs, they are described here. -`-h' -`--help' +'-h' +'--help' Print an informative help message describing the options and exit. - Zgrep only supports the `--help' form of this option. + Zgrep only supports the '--help' form of this option. -`-V' -`--version' +'-V' +'--version' Print the version number on the standard output and exit. -`-N' -`--no-rcfile' - Don't read the runtime configuration file `zutilsrc'. +'-N' +'--no-rcfile' + Don't read the runtime configuration file 'zutilsrc'. -`--bz2=COMMAND' -`--gz=COMMAND' -`--lz=COMMAND' -`--xz=COMMAND' +'--bz2=COMMAND' +'--gz=COMMAND' +'--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 + 'zutilsrc'. The compression program used must meet three requirements: - 1. When called with the `-d' option, it must read compressed + 1. When called with the '-d' option, it must read compressed data from the standard input and produce decompressed data on the standard output. - 2. If the `-q' option is passed to zutils, the compression + 2. If the '-q' option is passed to zutils, the compression program must also accept it. 3. It must return 0 if no errors occurred, and a non-zero value @@ -131,24 +132,24 @@ File: zutils.info, Node: The zutilsrc file, Next: Zcat, Prev: Common options, 3 The zutilsrc file ******************* -`zutilsrc' is the runtime configuration file for zutils. In it you may +'zutilsrc' is the runtime configuration file for zutils. In it you may define the compressor name and options to be used for each format. The -`zutilsrc' file is optional; you do not need to install it in order to +'zutilsrc' file is optional; you do not need to install it in order to run zutils. The compressors specified in the command line override those -specified in the `zutilsrc' file. +specified in the 'zutilsrc' file. - You may copy the system `zutilsrc' file `${sysconfdir}/zutilsrc' to -`$HOME/.zutilsrc' and customize these options as you like. The file + You may copy the system 'zutilsrc' file '${sysconfdir}/zutilsrc' to +'$HOME/.zutilsrc' and customize these options as you like. The file syntax is fairly obvious (and there are further instructions in it): - 1. Any line beginning with `#' is a comment line. + 1. Any line beginning with '#' is a comment line. 2. Each non-comment line defines the command to be used for the given format, with the syntax: <format> = <compressor> [options] - where <format> is one of `bz2', `gz', `lz' or `xz'. + where <format> is one of 'bz2', 'gz', 'lz' or 'xz'. File: zutils.info, Node: Zcat, Next: Zcmp, Prev: The zutilsrc file, Up: Top @@ -156,7 +157,7 @@ File: zutils.info, Node: Zcat, Next: Zcmp, Prev: The zutilsrc file, Up: Top 4 Zcat ****** -Zcat copies each given file (`-' means standard input), to standard +Zcat copies each given file ('-' 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 @@ -175,58 +176,58 @@ Exit status is 0 if no errors occurred, non-zero otherwise. Zcat supports the following options: -`-A' -`--show-all' - Equivalent to `-vET'. +'-A' +'--show-all' + Equivalent to '-vET'. -`-b' -`--number-nonblank' +'-b' +'--number-nonblank' Number all nonblank output lines, starting with 1. The line count is unlimited. -`-e' - Equivalent to `-vE'. +'-e' + Equivalent to '-vE'. -`-E' -`--show-ends' - Print a `$' after the end of each line. +'-E' +'--show-ends' + Print a '$' after the end of each line. -`--format=FMT' +'--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 + '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' +'-n' +'--number' Number all output lines, starting with 1. The line count is unlimited. -`-q' -`--quiet' +'-q' +'--quiet' Quiet operation. Suppress all messages. -`-r' -`--recursive' +'-r' +'--recursive' Operate recursively on directories. -`-s' -`--squeeze-blank' +'-s' +'--squeeze-blank' Replace multiple adjacent blank lines with a single blank line. -`-t' - Equivalent to `-vT'. +'-t' + Equivalent to '-vT'. -`-T' -`--show-tabs' - Print TAB characters as `^I'. +'-T' +'--show-tabs' + Print TAB characters as '^I'. -`-v' -`--show-nonprinting' - Print control characters except for LF (newline) and TAB using `^' - notation and precede characters larger than 127 with `M-' (which +'-v' +'--show-nonprinting' + Print control characters except for LF (newline) and TAB using '^' + notation and precede characters larger than 127 with 'M-' (which stands for "meta"). -`--verbose' +'--verbose' Verbose mode. Show error messages. @@ -236,7 +237,7 @@ File: zutils.info, Node: Zcmp, Next: Zdiff, Prev: Zcat, Up: Top 5 Zcmp ****** -Zcmp compares two files (`-' means standard input), and if they differ, +Zcmp compares two files ('-' 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 the @@ -264,43 +265,43 @@ differences were found, and 2 means trouble. Zcmp supports the following options: -`-b' -`--print-bytes' - Print the differing bytes. Print control bytes as a `^' followed by - a letter, and precede bytes larger than 127 with `M-' (which stands +'-b' +'--print-bytes' + Print the differing bytes. Print control bytes as a '^' followed by + a letter, and precede bytes larger than 127 with 'M-' (which stands for "meta"). -`--format=[FMT1][,FMT2]' +'--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 + 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' +'-i SIZE' +'--ignore-initial=SIZE' Ignore any differences in the first SIZE bytes of the input files. Treat files with fewer than SIZE bytes as if they were empty. If - SIZE is in the form `SIZE1,SIZE2', ignore the first SIZE1 bytes of + SIZE is in the form 'SIZE1,SIZE2', ignore the first SIZE1 bytes of the first input file and the first SIZE2 bytes of the second input file. -`-l' -`-v' -`--list' -`--verbose' +'-l' +'-v' +'--list' +'--verbose' Print the byte numbers (in decimal) and values (in octal) of all differing bytes. -`-n COUNT' -`--bytes=COUNT' +'-n COUNT' +'--bytes=COUNT' Compare at most COUNT input bytes. -`-q' -`-s' -`--quiet' -`--silent' +'-q' +'-s' +'--quiet' +'--silent' Do not print anything; only return an exit status indicating whether the files differ. @@ -311,7 +312,7 @@ File: zutils.info, Node: Zdiff, Next: Zgrep, Prev: Zcmp, Up: Top 6 Zdiff ******* -Zdiff compares two files (`-' means standard input), and if they +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 @@ -339,74 +340,74 @@ differences were found, and 2 means trouble. Zdiff supports the following options: -`-a' -`--text' +'-a' +'--text' Treat all files as text. -`-b' -`--ignore-space-change' +'-b' +'--ignore-space-change' Ignore changes in the amount of white space. -`-B' -`--ignore-blank-lines' +'-B' +'--ignore-blank-lines' Ignore changes whose lines are all blank. -`-c' +'-c' Use the context output format. -`-C N' -`--context=N' +'-C N' +'--context=N' Same as -c but use N lines of context. -`-d' -`--minimal' +'-d' +'--minimal' Try hard to find a smaller set of changes. -`-E' -`--ignore-tab-expansion' +'-E' +'--ignore-tab-expansion' Ignore changes due to tab expansion. -`--format=[FMT1][,FMT2]' +'--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 + 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' +'-i' +'--ignore-case' Ignore case differences in file contents. -`-p' -`--show-c-function' +'-p' +'--show-c-function' Show which C function each change is in. -`-q' -`--brief' +'-q' +'--brief' Output only whether files differ. -`-s' -`--report-identical-files' +'-s' +'--report-identical-files' Report when two files are identical. -`-t' -`--expand-tabs' +'-t' +'--expand-tabs' Expand tabs to spaces in output. -`-T' -`--initial-tab' +'-T' +'--initial-tab' Make tabs line up by prepending a tab. -`-u' +'-u' Use the unified output format. -`-U N' -`--unified=N' +'-U N' +'--unified=N' Same as -u but use N lines of context. -`-w' -`--ignore-all-space' +'-w' +'--ignore-all-space' Ignore all white space. @@ -437,112 +438,113 @@ matches were found, and 2 means trouble. Zgrep supports the following options: -`-a' -`--text' +'-a' +'--text' Treat all files as text. -`-A N' -`--after-context=N' +'-A N' +'--after-context=N' Print N lines of trailing context. -`-b' -`--byte-offset' +'-b' +'--byte-offset' Print the byte offset of each line. -`-B N' -`--before-context=N' +'-B N' +'--before-context=N' Print N lines of leading context. -`-c' -`--count' +'-c' +'--count' Only print a count of matching lines per file. -`-C N' -`--context=N' +'-C N' +'--context=N' Print N lines of output context. -`-e PATTERN' -`--regexp=PATTERN' +'-e PATTERN' +'--regexp=PATTERN' Use PATTERN as the pattern to match. -`-E' -`--extended-regexp' +'-E' +'--extended-regexp' Treat PATTERN as an extended regular expression. -`-f FILE' -`--file=FILE' +'-f FILE' +'--file=FILE' Obtain patterns from FILE, one per line. -`-F' -`--fixed-strings' +'-F' +'--fixed-strings' Treat PATTERN as a set of newline-separated strings. -`--format=FMT' +'--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 + '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' +'-h' +'--no-filename' Suppress the prefixing of filenames on output when multiple files are searched. -`-H' -`--with-filename' +'-H' +'--with-filename' Print the filename for each match. -`-i' -`--ignore-case' +'-i' +'--ignore-case' Ignore case distinctions. -`-I' +'-I' Ignore binary files. -`-l' -`--files-with-matches' +'-l' +'--files-with-matches' Only print names of files containing at least one match. -`-L' -`--files-without-match' +'-L' +'--files-without-match' Only print names of files not containing any matches. -`-m N' -`--max-count=N' +'-m N' +'--max-count=N' Stop after N matches. -`-n' -`--line-number' +'-n' +'--line-number' Prefix each matched line with its line number in the input file. -`-o' -`--only-matching' +'-o' +'--only-matching' Show only the part of matching lines that actually matches PATTERN. -`-q' -`--quiet' - Suppress all messages. +'-q' +'--quiet' + Suppress all messages. Exit immediately with zero status if any + match is found, even if an error was detected. -`-r' -`--recursive' +'-r' +'--recursive' Operate recursively on directories. -`-s' -`--no-messages' - Suppress error messages. +'-s' +'--no-messages' + Suppress error messages about nonexistent or unreadable files. -`-v' -`--invert-match' +'-v' +'--invert-match' Select non-matching lines. -`--verbose' +'--verbose' Verbose mode. Show error messages. -`-w' -`--word-regexp' +'-w' +'--word-regexp' Match only whole words. -`-x' -`--line-regexp' +'-x' +'--line-regexp' Match only whole lines. @@ -570,21 +572,21 @@ environmental problems (file not found, invalid flags, I/O errors, etc), Ztest supports the following options: -`--format=FMT' +'--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 + 'bz2', 'gz', 'lz' and 'xz'. If this option is used, all files not in the given format will fail. -`-q' -`--quiet' +'-q' +'--quiet' Quiet operation. Suppress all messages. -`-r' -`--recursive' +'-r' +'--recursive' Operate recursively on directories. -`-v' -`--verbose' +'-v' +'--verbose' Verbose mode. Show the verify status for each file processed. Further -v's increase the verbosity level. @@ -604,15 +606,15 @@ is chosen as destination because it is by far the most appropriate for long-term data archiving. If the lzip compressed version of a file already exists, the file is -skipped unless the `--force' option is given. In this case, if the +skipped unless the '--force' option is given. In this case, if the comparison fails, an error is returned 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. 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'. +extensions: '.bz2', '.tbz', '.tbz2', '.gz', '.tgz', '.xz', '.txz'. The +files produced have the extensions '.lz' or '.tar.lz'. The format for running zupdate is: @@ -623,35 +625,40 @@ recompressed (if needed), compared and deleted. Non-zero otherwise. Zupdate supports the following options: -`-f' -`--force' +'-f' +'--force' Do not skip a file for which a lzip compressed version already - exists. `--force' compares the content of the input file with the + exists. '--force' compares the content of the input file with the content of the lzip file and deletes the input file if both contents are identical. -`-l' -`--lzip-verbose' - Pass a `-v' option to the lzip compressor so that it shows the +'-k' +'--keep' + Keep (don't delete) the input file after comparing it with the + lzip file. + +'-l' +'--lzip-verbose' + Pass a '-v' option to the lzip compressor so that it shows the compression ratio for each file processed. Using lzip 1.15 and - newer, a second `-l' shows the progress of compression. Use it - together with `-v' to see the name of the file. + newer, a second '-l' shows the progress of compression. Use it + together with '-v' to see the name of the file. -`-q' -`--quiet' +'-q' +'--quiet' Quiet operation. Suppress all messages. -`-r' -`--recursive' +'-r' +'--recursive' Operate recursively on directories. -`-v' -`--verbose' - Verbose mode. Show the files being processed. A second `-v' also +'-v' +'--verbose' + Verbose mode. Show the files being processed. A second '-v' also shows the files being ignored. -`-0 .. -9' - Set the compression level of lzip. By default zupdate passes `-9' +'-0 .. -9' + Set the compression level of lzip. By default zupdate passes '-9' to lzip. @@ -668,7 +675,7 @@ for all eternity, if not longer. If you find a bug in zutils, please send electronic mail to <zutils-bug@nongnu.org>. Include the version number, which you can find -by running `zutils --version'. +by running 'zcmp --version'. File: zutils.info, Node: Concept index, Prev: Problems, Up: Top @@ -694,18 +701,18 @@ Concept index Tag Table: -Node: Top224 +Node: Top225 Node: Introduction1156 -Node: Common options3258 -Node: The zutilsrc file4507 -Node: Zcat5433 -Node: Zcmp7355 -Node: Zdiff9679 -Node: Zgrep12182 -Node: Ztest15019 -Node: Zupdate16243 -Node: Problems18477 -Node: Concept index19010 +Node: Common options3259 +Node: The zutilsrc file4508 +Node: Zcat5434 +Node: Zcmp7356 +Node: Zdiff9680 +Node: Zgrep12183 +Node: Ztest15151 +Node: Zupdate16375 +Node: Problems18708 +Node: Concept index19239 End Tag Table |