summaryrefslogtreecommitdiffstats
path: root/doc/zupdate.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zupdate.1')
-rw-r--r--doc/zupdate.176
1 files changed, 76 insertions, 0 deletions
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.