diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-26 05:52:19 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-26 05:52:47 +0000 |
commit | 274c86b0397198011756479218dd14262d9421ff (patch) | |
tree | 47cd5cedf3cfcbba77d127200852a21d03502e7c /doc | |
parent | Releasing debian version 1.11-5. (diff) | |
download | zutils-274c86b0397198011756479218dd14262d9421ff.tar.xz zutils-274c86b0397198011756479218dd14262d9421ff.zip |
Merging upstream version 1.12~pre2.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/zcat.1 | 2 | ||||
-rw-r--r-- | doc/zcmp.1 | 2 | ||||
-rw-r--r-- | doc/zdiff.1 | 4 | ||||
-rw-r--r-- | doc/zgrep.1 | 25 | ||||
-rw-r--r-- | doc/ztest.1 | 2 | ||||
-rw-r--r-- | doc/zupdate.1 | 15 | ||||
-rw-r--r-- | doc/zutils.info | 118 | ||||
-rw-r--r-- | doc/zutils.texi | 97 |
8 files changed, 202 insertions, 63 deletions
@@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16. -.TH ZCAT "1" "January 2022" "zutils 1.11" "User Commands" +.TH ZCAT "1" "April 2022" "zutils 1.12-pre2" "User Commands" .SH NAME zcat \- decompress and concatenate files to standard output .SH SYNOPSIS @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16. -.TH ZCMP "1" "January 2022" "zutils 1.11" "User Commands" +.TH ZCMP "1" "April 2022" "zutils 1.12-pre2" "User Commands" .SH NAME zcmp \- decompress and compare two files byte by byte .SH SYNOPSIS diff --git a/doc/zdiff.1 b/doc/zdiff.1 index 784ef7b..55342c6 100644 --- a/doc/zdiff.1 +++ b/doc/zdiff.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16. -.TH ZDIFF "1" "January 2022" "zutils 1.11" "User Commands" +.TH ZDIFF "1" "April 2022" "zutils 1.12-pre2" "User Commands" .SH NAME zdiff \- decompress and compare two files line by line .SH SYNOPSIS @@ -98,7 +98,7 @@ verbose mode (for \fB\-\-version\fR) ignore all white space .TP \fB\-W\fR, \fB\-\-width=\fR<n> -output at most <n> print columns +output at most <n> print columns (for \fB\-y\fR) .TP \fB\-y\fR, \fB\-\-side\-by\-side\fR output in two columns diff --git a/doc/zgrep.1 b/doc/zgrep.1 index f3177bb..bbe311c 100644 --- a/doc/zgrep.1 +++ b/doc/zgrep.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16. -.TH ZGREP "1" "January 2022" "zutils 1.11" "User Commands" +.TH ZGREP "1" "April 2022" "zutils 1.12-pre2" "User Commands" .SH NAME zgrep \- search compressed files for a regular expression .SH SYNOPSIS @@ -69,6 +69,9 @@ obtain patterns from <file> \fB\-F\fR, \fB\-\-fixed\-strings\fR <pattern> is a set of newline\-separated strings .TP +\fB\-G\fR, \fB\-\-basic\-regexp\fR +<pattern> is a basic regular expression (default) +.TP \fB\-h\fR, \fB\-\-no\-filename\fR suppress the prefixing file name on output .TP @@ -87,6 +90,12 @@ only print names of files containing matches \fB\-L\fR, \fB\-\-files\-without\-match\fR only print names of files containing no matches .TP +\fB\-\-label=\fR<label> +use <label> as file name for standard input +.TP +\fB\-\-line\-buffered\fR +flush output on every line +.TP \fB\-m\fR, \fB\-\-max\-count=\fR<n> stop after <n> matches .TP @@ -105,7 +114,10 @@ show only the part of a line matching <pattern> \fB\-O\fR, \fB\-\-force\-format=\fR<fmt> force the format given (bz2, gz, lz, xz, zst) .TP -\fB\-q\fR, \fB\-\-quiet\fR +\fB\-P\fR, \fB\-\-perl\-regexp\fR +<pattern> is a Perl regular expression +.TP +\fB\-q\fR, \fB\-\-quiet\fR, \fB\-\-silent\fR suppress all messages .TP \fB\-r\fR, \fB\-\-recursive\fR @@ -117,6 +129,12 @@ recursively follow symbolic links \fB\-s\fR, \fB\-\-no\-messages\fR suppress error messages .TP +\fB\-T\fR, \fB\-\-initial\-tab\fR +make tabs line up (if needed) +.TP +\fB\-U\fR, \fB\-\-binary\fR +don't strip CR characters at EOL (DOS/Windows) +.TP \fB\-v\fR, \fB\-\-invert\-match\fR select non\-matching lines .TP @@ -129,6 +147,9 @@ match only whole words \fB\-x\fR, \fB\-\-line\-regexp\fR match only whole lines .TP +\fB\-Z\fR, \fB\-\-null\fR +print 0 byte (ASCII NUL) after file name +.TP \fB\-\-bz2=\fR<command> set compressor and options for bzip2 format .TP diff --git a/doc/ztest.1 b/doc/ztest.1 index 210948e..2f51e51 100644 --- a/doc/ztest.1 +++ b/doc/ztest.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16. -.TH ZTEST "1" "January 2022" "zutils 1.11" "User Commands" +.TH ZTEST "1" "April 2022" "zutils 1.12-pre2" "User Commands" .SH NAME ztest \- verify the integrity of compressed files .SH SYNOPSIS diff --git a/doc/zupdate.1 b/doc/zupdate.1 index b1e6472..8519088 100644 --- a/doc/zupdate.1 +++ b/doc/zupdate.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16. -.TH ZUPDATE "1" "January 2022" "zutils 1.11" "User Commands" +.TH ZUPDATE "1" "April 2022" "zutils 1.12-pre2" "User Commands" .SH NAME zupdate \- recompress bzip2, gzip, xz, zstd files to lzip format .SH SYNOPSIS @@ -26,12 +26,15 @@ compressed files are never overwritten nor deleted. .PP The names of the original files must have one of the following extensions: .PP -\&'.bz2', '.gz', '.xz', or '.zst', which are recompressed to '.lz'. +\&'.bz2', '.gz', '.xz', '.zst', or '.Z', which are recompressed to '.lz'. .PP \&'.tbz', '.tbz2', '.tgz', '.txz', or '.tzst', which are recompressed to '.tlz'. .PP Exit status is 0 if all the compressed files were successfully recompressed -(if needed), compared, and deleted (if requested). Non\-zero otherwise. +(if needed), compared, and deleted (if requested). 1 if a non\-fatal error +occurred (file not found or not regular, or has invalid format, or can't be +deleted). 2 if a fatal error occurred (compressor can't be run, or +comparison fails). .SH OPTIONS .TP \fB\-h\fR, \fB\-\-help\fR @@ -40,9 +43,15 @@ display this help and exit \fB\-V\fR, \fB\-\-version\fR output version information and exit .TP +\fB\-e\fR, \fB\-\-expand\-extensions\fR +expand combined extensions; tgz \-> tar.lz +.TP \fB\-f\fR, \fB\-\-force\fR don't skip a file even if the .lz exists .TP +\fB\-i\fR, \fB\-\-ignore\-errors\fR +ignore non\-fatal errors +.TP \fB\-k\fR, \fB\-\-keep\fR keep (don't delete) input files .TP diff --git a/doc/zutils.info b/doc/zutils.info index a75b183..9a9ca05 100644 --- a/doc/zutils.info +++ b/doc/zutils.info @@ -11,7 +11,7 @@ File: zutils.info, Node: Top, Next: Introduction, Up: (dir) Zutils Manual ************* -This manual is for Zutils (version 1.11, 25 January 2022). +This manual is for Zutils (version 1.12-pre2, 12 April 2022). * Menu: @@ -69,10 +69,9 @@ of formats in recursive mode and when trying compressed file names. For example, use the following command to search for the string 'foo' in gzip and lzip files only: 'zgrep foo -r --format=gz,lz somedir somefile.tar'. - FORMAT NOTE 2: If the option '--force-format' 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 --force-format=gz file.Z file.lz'. + FORMAT NOTE 2: The standard POSIX compress format (.Z) is obsolete and is +only supported through gzip. For this to work, the gzip program used (for +example GNU gzip) must be able to decompress .Z files. LANGUAGE NOTE: Uncompressed = not compressed = plain data; it may never have been compressed. Decompressed is used to refer to data which have @@ -131,7 +130,7 @@ here. *Note Argument syntax: (arg_parser)Argument syntax. extensions: bz2 enables .bz2 .tbz .tbz2 - gz enables .gz .tgz + gz enables .gz .tgz .Z lz enables .lz .tlz xz enables .xz .txz zst enables .zst .tzst @@ -468,6 +467,15 @@ program used supports them): '--ignore-all-space' Ignore all white space. +'-W COLUMNS' +'--width=COLUMNS' + Output at most the specified number of print columns per line in side + by side format. + +'-y' +'--side-by-side' + Use the side by side output format. + File: zutils.info, Node: Zgrep, Next: Ztest, Prev: Zdiff, Up: Top @@ -496,8 +504,9 @@ directory, and nonrecursive searches read standard input. 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 (some options only work if the grep -program used supports them): + zgrep supports the following options (Some options only work if the grep +program used supports them. Options -h, -H, -r, -R, and -Z are managed by +zgrep and not passed to grep): '-a' '--text' @@ -532,7 +541,7 @@ program used supports them): '-E' '--extended-regexp' - Treat PATTERN as an extended regular expression. + Interpret PATTERN as an extended regular expression (ERE). '-f FILE' '--file=FILE' @@ -543,7 +552,12 @@ program used supports them): '-F' '--fixed-strings' - Treat PATTERN as a set of newline-separated strings. + Interpret PATTERN as a set of newline-separated strings. + +'-G' +'--basic-regexp' + Interpret PATTERN as a basic regular expression (BRE). This is the + default. '-h' '--no-filename' @@ -573,6 +587,13 @@ program used supports them): of a wrong change in the exit status of grep, which was reverted in GNU grep 3.5. +'--label=LABEL' + Display input actually coming from standard input as input coming from + file LABEL. + +'--line-buffered' + Use line buffering on output. This may cause a performance penalty. + '-m N' '--max-count=N' Stop after N matches. @@ -593,8 +614,13 @@ program used supports them): format, and the exact file name must be given. Other names won't be tried. +'-P' +'--perl-regexp' + Interpret PATTERN as a Perl-compatible regular expression (PCRE). + '-q' '--quiet' +'--silent' Suppress all messages. Exit immediately with zero status if any match is found, even if an error was detected. @@ -613,6 +639,16 @@ program used supports them): '--no-messages' Suppress error messages about nonexistent or unreadable files. +'-T' +'--initial-tab' + Make sure that the first character of actual line content lies on a tab + stop, so that the alignment of tabs looks normal. + +'-U' +'--binary' + Use binary I/O on platforms affected by the bug known as "text mode + I/O". (MS-DOS, MS-Windows, OS/2). + '-v' '--invert-match' Select non-matching lines. @@ -629,6 +665,14 @@ program used supports them): '--line-regexp' Match only whole lines. +'-Z' +'--null' + Output a zero byte (the ASCII NUL character) instead of the character + that normally follows a file name. For example, 'zgrep -lZ' outputs a + zero byte after each file name instead of the usual newline. This + option makes the output unambiguous, even in the presence of file + names containing unusual characters like newlines. + File: zutils.info, Node: Ztest, Next: Zupdate, Prev: Zgrep, Up: Top @@ -675,9 +719,7 @@ compressed file is corrupt or invalid. 'gz', 'lz', 'xz', and 'zst'. 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. + understand will fail. '-q' '--quiet' @@ -735,7 +777,7 @@ pair of files in a multiformat set of files. The names of the original files must have one of the following extensions: -'.bz2', '.gz', '.xz', or '.zst', which are recompressed to '.lz'; +'.bz2', '.gz', '.xz', '.zst', or '.Z', which are recompressed to '.lz'; '.tbz', '.tbz2', '.tgz', '.txz', or '.tzst', which are recompressed to '.tlz'. Keeping the combined extensions ('.tgz' -> '.tlz') may be useful when @@ -745,21 +787,29 @@ recompressing Slackware packages, for example. If the decompressor for the xz or zstd formats is not found, the corresponding files are ignored. - 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). + Recompressing a file is much like copying or moving it. Therefore zupdate +preserves the access and modification dates, permissions, and, if you have +appropriate privileges, 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] Exit status is 0 if all the compressed files were successfully recompressed -(if needed), compared, and deleted (if requested). Non-zero otherwise. +(if needed), compared, and deleted (if requested). 1 if a non-fatal error +occurred (file not found or not regular, or has invalid format, or can't be +deleted). 2 if a fatal error occurred (compressor can't be run, or +comparison fails). zupdate supports the following options: +'-e' +'--expand-extensions' + Expand combined file name extensions; recompress '.tbz', '.tbz2', + '.tgz', '.txz', and '.tzst' to 'tar.lz'. + '-f' '--force' Don't skip a file for which a lzip compressed version already exists. @@ -767,6 +817,10 @@ Exit status is 0 if all the compressed files were successfully recompressed the existing lzip file and deletes the input file if both contents are identical. +'-i' +'--ignore-errors' + Ignore non-fatal errors. (See exit status above). + '-k' '--keep' Keep (don't delete) the input file after comparing it with the lzip @@ -845,18 +899,18 @@ Concept index Tag Table: Node: Top217 -Node: Introduction1147 -Node: Common options3947 -Ref: compressor-requirements6181 -Node: The zutilsrc file6576 -Node: Zcat7544 -Node: Zcmp10119 -Node: Zdiff12620 -Node: Zgrep15478 -Node: Ztest19819 -Node: Zupdate22513 -Node: Problems26607 -Node: Concept index27141 +Node: Introduction1150 +Node: Common options3897 +Ref: compressor-requirements6134 +Node: The zutilsrc file6529 +Node: Zcat7497 +Node: Zcmp10072 +Node: Zdiff12573 +Node: Zgrep15623 +Node: Ztest21115 +Node: Zupdate23681 +Node: Problems28191 +Node: Concept index28725 End Tag Table diff --git a/doc/zutils.texi b/doc/zutils.texi index 34a3128..6324814 100644 --- a/doc/zutils.texi +++ b/doc/zutils.texi @@ -6,8 +6,8 @@ @finalout @c %**end of header -@set UPDATED 25 January 2022 -@set VERSION 1.11 +@set UPDATED 12 April 2022 +@set VERSION 1.12-pre2 @dircategory Compression @direntry @@ -94,10 +94,9 @@ example, use the following command to search for the string @samp{foo} in gzip and lzip files only: @w{@samp{zgrep foo -r --format=gz,lz somedir somefile.tar}}. -FORMAT NOTE 2: If the option @samp{--force-format} 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: The standard POSIX compress format (.Z) is obsolete and is +only supported through gzip. For this to work, the gzip program used (for +example GNU gzip) must be able to decompress .Z files. LANGUAGE NOTE: Uncompressed = not compressed = plain data; it may never have been compressed. Decompressed is used to refer to data which have undergone @@ -163,7 +162,7 @@ extensions: @multitable {bz2} {enables} {any other file name} @item bz2 @tab enables @tab .bz2 .tbz .tbz2 -@item gz @tab enables @tab .gz .tgz +@item gz @tab enables @tab .gz .tgz .Z @item lz @tab enables @tab .lz .tlz @item xz @tab enables @tab .xz .txz @item zst @tab enables @tab .zst .tzst @@ -531,6 +530,15 @@ program used. @itemx --ignore-all-space Ignore all white space. +@item -W @var{columns} +@itemx --width=@var{columns} +Output at most the specified number of print columns per line in side by +side format. + +@item -y +@itemx --side-by-side +Use the side by side output format. + @end table @@ -564,8 +572,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 (some options only work if the grep -program used supports them): +zgrep supports the following options (Some options only work if the grep +program used supports them. Options -h, -H, -r, -R, and -Z are managed by +zgrep and not passed to grep): @table @code @item -a @@ -602,7 +611,7 @@ Use @var{pattern} as the pattern to match. @item -E @itemx --extended-regexp -Treat @var{pattern} as an extended regular expression. +Interpret @var{pattern} as an extended regular expression (ERE). @item -f @var{file} @itemx --file=@var{file} @@ -614,7 +623,12 @@ used with @samp{-e} to read @var{file} only once, for example if @item -F @itemx --fixed-strings -Treat @var{pattern} as a set of newline-separated strings. +Interpret @var{pattern} as a set of newline-separated strings. + +@item -G +@itemx --basic-regexp +Interpret @var{pattern} as a basic regular expression (BRE). This is the +default. @item -h @itemx --no-filename @@ -643,6 +657,13 @@ Note: option -L fails (prints wrong results, returns wrong status, and even hangs) when using GNU grep versions 3.2 to 3.4 inclusive because of a wrong change in the exit status of grep, which was reverted in GNU grep 3.5. +@item --label=@var{label} +Display input actually coming from standard input as input coming from file +@var{label}. + +@item --line-buffered +Use line buffering on output. This may cause a performance penalty. + @item -m @var{n} @itemx --max-count=@var{n} Stop after @var{n} matches. @@ -663,8 +684,13 @@ 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. +@item -P +@itemx --perl-regexp +Interpret @var{pattern} as a Perl-compatible regular expression (PCRE). + @item -q @itemx --quiet +@itemx --silent Suppress all messages. Exit immediately with zero status if any match is found, even if an error was detected. @@ -683,6 +709,16 @@ recursively, following all symbolic links. @itemx --no-messages Suppress error messages about nonexistent or unreadable files. +@item -T +@itemx --initial-tab +Make sure that the first character of actual line content lies on a tab +stop, so that the alignment of tabs looks normal. + +@item -U +@itemx --binary +Use binary I/O on platforms affected by the bug known as "text mode I/O". +(MS-DOS, MS-Windows, OS/2). + @item -v @itemx --invert-match Select non-matching lines. @@ -699,6 +735,14 @@ Match only whole words. @itemx --line-regexp Match only whole lines. +@item -Z +@itemx --null +Output a zero byte (the ASCII NUL character) instead of the character that +normally follows a file name. For example, 'zgrep -lZ' outputs a zero byte +after each file name instead of the usual newline. This option makes the +output unambiguous, even in the presence of file names containing unusual +characters like newlines. + @end table @@ -752,8 +796,7 @@ Force the compressed format given. Valid values for @var{format} are @samp{bz2}, @samp{gz}, @samp{lz}, @samp{xz}, and @samp{zst}. 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, @samp{--force-format=gz} can test -gzipped (.gz) and compress'd (.Z) files if the compressor used is GNU gzip. +can't understand will fail. @item -q @itemx --quiet @@ -810,8 +853,8 @@ Combining the options @samp{--force} and @samp{--keep}, as in between each pair of files in a multiformat set of files. The names of the original files must have one of the following extensions:@* -@samp{.bz2}, @samp{.gz}, @samp{.xz}, or @samp{.zst}, which are recompressed -to @samp{.lz};@* +@samp{.bz2}, @samp{.gz}, @samp{.xz}, @samp{.zst}, or @samp{.Z}, which are +recompressed to @samp{.lz};@* @samp{.tbz}, @samp{.tbz2}, @samp{.tgz}, @samp{.txz}, or @samp{.tzst}, which are recompressed to @samp{.tlz}.@* Keeping the combined extensions (@samp{.tgz} --> @samp{.tlz}) may be useful @@ -821,11 +864,11 @@ Bzip2, gzip, and lzip are the primary formats. Xz and zstd are optional. If the decompressor for the xz or zstd formats is not found, the corresponding files are ignored. -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 @w{@samp{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). +Recompressing a file is much like copying or moving it. Therefore zupdate +preserves the access and modification dates, permissions, and, if you have +appropriate privileges, ownership of the file just as @w{@samp{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: @@ -835,11 +878,19 @@ zupdate [@var{options}] [@var{files}] @noindent Exit status is 0 if all the compressed files were successfully recompressed -(if needed), compared, and deleted (if requested). Non-zero otherwise. +(if needed), compared, and deleted (if requested). 1 if a non-fatal error +occurred (file not found or not regular, or has invalid format, or can't be +deleted). 2 if a fatal error occurred (compressor can't be run, or +comparison fails). zupdate supports the following options: @table @code +@item -e +@itemx --expand-extensions +Expand combined file name extensions; recompress @samp{.tbz}, @samp{.tbz2}, +@samp{.tgz}, @samp{.txz}, and @samp{.tzst} to @samp{tar.lz}. + @item -f @itemx --force Don't skip a file for which a lzip compressed version already exists. @@ -847,6 +898,10 @@ Don't skip a file for which a lzip compressed version already exists. of the existing lzip file and deletes the input file if both contents are identical. +@item -i +@itemx --ignore-errors +Ignore non-fatal errors. (See exit status above). + @item -k @itemx --keep Keep (don't delete) the input file after comparing it with the lzip file. |