summaryrefslogtreecommitdiffstats
path: root/doc/zutils.info
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zutils.info')
-rw-r--r--doc/zutils.info106
1 files changed, 88 insertions, 18 deletions
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