diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/zcat.1 | 2 | ||||
| -rw-r--r-- | doc/zcmp.1 | 2 | ||||
| -rw-r--r-- | doc/zdiff.1 | 2 | ||||
| -rw-r--r-- | doc/zgrep.1 | 2 | ||||
| -rw-r--r-- | doc/ztest.1 | 2 | ||||
| -rw-r--r-- | doc/zupdate.1 | 76 | ||||
| -rw-r--r-- | doc/zutils.info | 106 | ||||
| -rw-r--r-- | doc/zutils.texinfo | 88 |
8 files changed, 249 insertions, 31 deletions
@@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. -.TH ZCAT "1" "August 2013" "Zcat (zutils) 1.1" "User Commands" +.TH ZCAT "1" "September 2013" "Zcat (zutils) 1.2-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.37.1. -.TH ZCMP "1" "August 2013" "Zcmp (zutils) 1.1" "User Commands" +.TH ZCMP "1" "September 2013" "Zcmp (zutils) 1.2-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 4cdcdb3..7ef4be9 100644 --- a/doc/zdiff.1 +++ b/doc/zdiff.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. -.TH ZDIFF "1" "August 2013" "Zdiff (zutils) 1.1" "User Commands" +.TH ZDIFF "1" "September 2013" "Zdiff (zutils) 1.2-pre2" "User Commands" .SH NAME Zdiff \- decompress and compare two files line by line .SH SYNOPSIS diff --git a/doc/zgrep.1 b/doc/zgrep.1 index 275221f..7293471 100644 --- a/doc/zgrep.1 +++ b/doc/zgrep.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. -.TH ZGREP "1" "August 2013" "Zgrep (zutils) 1.1" "User Commands" +.TH ZGREP "1" "September 2013" "Zgrep (zutils) 1.2-pre2" "User Commands" .SH NAME Zgrep \- search compressed files for a regular expression .SH SYNOPSIS diff --git a/doc/ztest.1 b/doc/ztest.1 index 02b15e2..e0de3f2 100644 --- a/doc/ztest.1 +++ b/doc/ztest.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. -.TH ZTEST "1" "August 2013" "Ztest (zutils) 1.1" "User Commands" +.TH ZTEST "1" "September 2013" "Ztest (zutils) 1.2-pre2" "User Commands" .SH NAME Ztest \- verify integrity of compressed files .SH SYNOPSIS diff --git a/doc/zupdate.1 b/doc/zupdate.1 new file mode 100644 index 0000000..947e73a --- /dev/null +++ b/doc/zupdate.1 @@ -0,0 +1,76 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH ZUPDATE "1" "September 2013" "Zupdate (zutils) 1.2-pre2" "User Commands" +.SH NAME +Zupdate \- recompress bzip2, gzip, xz files to lzip files +.SH SYNOPSIS +.B zupdate +[\fIoptions\fR] [\fIfiles\fR] +.SH DESCRIPTION +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 recompressed on the fly; no +temporary files are created. +The lzip format is chosen as destination because it is by far the most +appropriate for long\-term data archiving. +.PP +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 +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. +.PP +Exit status is 0 if all the compressed files were successfully +recompressed (if needed), compared and deleted. Non\-zero otherwise. +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +display this help and exit +.TP +\fB\-V\fR, \fB\-\-version\fR +output version information and exit +.TP +\fB\-f\fR, \fB\-\-force\fR +do not skip a file even if the .lz exists +.TP +\fB\-l\fR, \fB\-\-lzip\-verbose\fR +pass a \fB\-v\fR option to the lzip compressor +.TP +\fB\-N\fR, \fB\-\-no\-rcfile\fR +don't read runtime configuration file +.TP +\fB\-q\fR, \fB\-\-quiet\fR +suppress all messages +.TP +\fB\-r\fR, \fB\-\-recursive\fR +operate recursively on directories +.TP +\fB\-v\fR, \fB\-\-verbose\fR +be verbose (a 2nd \fB\-v\fR gives more) +.TP +\fB\-0\fR .. \fB\-9\fR +set compression level [default 9] +.TP +\fB\-\-bz2=\fR<command> +set compressor and options for bzip2 format +.TP +\fB\-\-gz=\fR<command> +set compressor and options for gzip format +.TP +\fB\-\-lz=\fR<command> +set compressor and options for lzip format +.TP +\fB\-\-xz=\fR<command> +set compressor and options for xz format +.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 2013 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. diff --git a/doc/zutils.info b/doc/zutils.info index 4cba8af..b8a77da 100644 --- a/doc/zutils.info +++ b/doc/zutils.info @@ -12,7 +12,7 @@ File: zutils.info, Node: Top, Next: Introduction, Up: (dir) Zutils Manual ************* -This manual is for Zutils (version 1.1, 2 August 2013). +This manual is for Zutils (version 1.2-pre2, 4 September 2013). * Menu: @@ -24,11 +24,12 @@ This manual is for Zutils (version 1.1, 2 August 2013). * Zdiff:: Comparing compressed files line by line * Zgrep:: Searching inside compressed files * Ztest:: Testing integrity of compressed files +* Zupdate:: Recompressing files to lzip format * Problems:: Reporting bugs * Concept index:: Index of concepts - Copyright (C) 2008, 2009, 2010, 2011, 2012, 2013 Antonio Diaz Diaz. + Copyright (C) 2009, 2010, 2011, 2012, 2013 Antonio Diaz Diaz. This manual is free documentation: you have unlimited permission to copy, distribute and modify it. @@ -49,12 +50,13 @@ are created. C++ programs. In particular the `--recursive' option is very efficient in those utilities supporting it. -The provided utilities are zcat, zcmp, zdiff, zgrep and ztest. +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 with GNU gzip. Ztest is unique to zutils. +scripts provided with 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 makes them safe to use with zutils. Gzip and xz may return @@ -545,7 +547,7 @@ matches were found, and 2 means trouble. -File: zutils.info, Node: Ztest, Next: Problems, Prev: Zgrep, Up: Top +File: zutils.info, Node: Ztest, Next: Zupdate, Prev: Zgrep, Up: Top 8 Ztest ******* @@ -588,10 +590,76 @@ environmental problems (file not found, invalid flags, I/O errors, etc), -File: zutils.info, Node: Problems, Next: Concept index, Prev: Ztest, Up: Top +File: zutils.info, Node: Zupdate, Next: Problems, Prev: Ztest, Up: Top -9 Reporting Bugs -**************** +9 Zupdate +********* + +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 +recompressed on the fly; no temporary files are created. The lzip format +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 +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'. + + 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. Non-zero otherwise. + + Zupdate supports the following options: + +`-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 + 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 + 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. + +`-q' +`--quiet' + Quiet operation. Suppress all messages. + +`-r' +`--recursive' + Operate recursively on directories. + +`-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' + to lzip. + + + +File: zutils.info, Node: Problems, Next: Concept index, Prev: Zupdate, Up: Top + +10 Reporting bugs +***************** There are probably bugs in zutils. There are certainly errors and omissions in this manual. If you report them, they will get fixed. If @@ -621,21 +689,23 @@ Concept index * zdiff: Zdiff. (line 6) * zgrep: Zgrep. (line 6) * ztest: Ztest. (line 6) +* zupdate: Zupdate. (line 6) Tag Table: Node: Top224 -Node: Introduction1095 -Node: Common options3153 -Node: The zutilsrc file4402 -Node: Zcat5328 -Node: Zcmp7250 -Node: Zdiff9574 -Node: Zgrep12077 -Node: Ztest14914 -Node: Problems16139 -Node: Concept index16668 +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 End Tag Table diff --git a/doc/zutils.texinfo b/doc/zutils.texinfo index ea635ba..5bbc692 100644 --- a/doc/zutils.texinfo +++ b/doc/zutils.texinfo @@ -6,8 +6,8 @@ @finalout @c %**end of header -@set UPDATED 2 August 2013 -@set VERSION 1.1 +@set UPDATED 4 September 2013 +@set VERSION 1.2-pre2 @dircategory Data Compression @direntry @@ -43,13 +43,13 @@ This manual is for Zutils (version @value{VERSION}, @value{UPDATED}). * Zdiff:: Comparing compressed files line by line * Zgrep:: Searching inside compressed files * Ztest:: Testing integrity of compressed files +* Zupdate:: Recompressing files to lzip format * Problems:: Reporting bugs * Concept index:: Index of concepts @end menu @sp 1 -Copyright @copyright{} 2008, 2009, 2010, 2011, 2012, 2013 -Antonio Diaz Diaz. +Copyright @copyright{} 2009, 2010, 2011, 2012, 2013 Antonio Diaz Diaz. This manual is free documentation: you have unlimited permission to copy, distribute and modify it. @@ -70,12 +70,13 @@ programs. In particular the @samp{--recursive} option is very efficient in those utilities supporting it. @noindent -The provided utilities are zcat, zcmp, zdiff, zgrep and ztest.@* +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 with GNU gzip. Ztest is unique to zutils. +scripts provided with 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 makes them safe to use with zutils. Gzip and xz may return ambiguous @@ -638,14 +639,85 @@ Operate recursively on directories. @item -v @itemx --verbose -Verbose mode. Show the verify status for each file processed. +Verbose mode. Show the verify status for each file processed.@* Further -v's increase the verbosity level. @end table +@node Zupdate +@chapter Zupdate +@cindex zupdate + +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 +recompressed on the fly; no temporary files are created. The lzip format +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 @samp{--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: @samp{.bz2}, @samp{.tbz}, @samp{.tbz2}, @samp{.gz}, +@samp{.tgz}, @samp{.xz}, @samp{.txz}. The files produced have the +extensions @samp{.lz} or @samp{.tar.lz}. + +The format for running zupdate is: + +@example +zupdate [@var{options}] [@var{files}] +@end example + +@noindent +Exit status is 0 if all the compressed files were successfully +recompressed (if needed), compared and deleted. Non-zero otherwise. + +Zupdate supports the following options: + +@table @samp +@item -f +@itemx --force +Do not skip a file for which a lzip compressed version already exists. +@samp{--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. + +@item -l +@itemx --lzip-verbose +Pass a @samp{-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 @samp{-l} shows the progress of compression. Use it together with +@samp{-v} to see the name of the file. + +@item -q +@itemx --quiet +Quiet operation. Suppress all messages. + +@item -r +@itemx --recursive +Operate recursively on directories. + +@item -v +@itemx --verbose +Verbose mode. Show the files being processed. A second @samp{-v} also +shows the files being ignored. + +@item -0 .. -9 +Set the compression level of lzip. By default zupdate passes @samp{-9} +to lzip. + +@end table + + @node Problems -@chapter Reporting Bugs +@chapter Reporting bugs @cindex bugs @cindex getting help |