summaryrefslogtreecommitdiffstats
path: root/doc/zupdate.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zupdate.1')
-rw-r--r--doc/zupdate.1122
1 files changed, 122 insertions, 0 deletions
diff --git a/doc/zupdate.1 b/doc/zupdate.1
new file mode 100644
index 0000000..c50a2df
--- /dev/null
+++ b/doc/zupdate.1
@@ -0,0 +1,122 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.2.
+.TH ZUPDATE "1" "January 2024" "zutils 1.13" "User Commands"
+.SH NAME
+zupdate \- recompress bzip2, gzip, xz, zstd files to lzip format
+.SH SYNOPSIS
+.B zupdate
+[\fI\,options\/\fR] [\fI\,files\/\fR]
+.SH DESCRIPTION
+zupdate recompresses files from bzip2, gzip, xz, and zstd formats to lzip
+format. Each original is compared with the new file 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 the most appropriate for
+long\-term archiving.
+.PP
+If no files are specified, recursive searches examine the current
+working directory, and nonrecursive searches do nothing.
+.PP
+If the lzip\-compressed version of a file already exists, the file is skipped
+unless the option '\-\-force' is given. In this case, if the comparison with
+the existing lzip version fails, an error is returned and the original file
+is not deleted. The operation of zupdate is meant to be safe and not cause
+any data loss. Therefore, existing lzip\-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', '.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). 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 (invalid command\-line options,
+compressor can't be run, or comparison fails).
+.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\-d\fR, \fB\-\-destdir=\fR<dir>
+write recompressed files into <dir>
+.TP
+\fB\-e\fR, \fB\-\-expand\-extensions\fR
+expand combined extensions; tgz \fB\-\-\fR> 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
+\fB\-l\fR, \fB\-\-lzip\-verbose\fR
+pass one option \fB\-v\fR to the lzip compressor
+.TP
+\fB\-M\fR, \fB\-\-format=\fR<list>
+process only the formats in <list>
+.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\-R\fR, \fB\-\-dereference\-recursive\fR
+recursively follow symbolic links
+.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
+.TP
+\fB\-\-zst=\fR<command>
+set compressor and options for zstd format
+.PP
+Valid formats for option '\-M' are 'bz2', 'gz', 'lz', 'xz', and 'zst'.
+.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 2024 Antonio Diaz Diaz.
+License GPLv2+: GNU GPL version 2 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.
+.SH "SEE ALSO"
+The full documentation for
+.B zupdate
+is maintained as a Texinfo manual. If the
+.B info
+and
+.B zupdate
+programs are properly installed at your site, the command
+.IP
+.B info zutils
+.PP
+should give you access to the complete manual.