summaryrefslogtreecommitdiffstats
path: root/doc/zcmp.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zcmp.1')
-rw-r--r--doc/zcmp.1108
1 files changed, 108 insertions, 0 deletions
diff --git a/doc/zcmp.1 b/doc/zcmp.1
new file mode 100644
index 0000000..09af2a5
--- /dev/null
+++ b/doc/zcmp.1
@@ -0,0 +1,108 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.2.
+.TH ZCMP "1" "January 2024" "zutils 1.13" "User Commands"
+.SH NAME
+zcmp \- decompress and compare two files byte by byte
+.SH SYNOPSIS
+.B zcmp
+[\fI\,options\/\fR] \fI\,file1 \/\fR[\fI\,file2\/\fR]
+.SH DESCRIPTION
+zcmp compares two files and, if they differ, writes to standard output the
+first byte and line number where they differ. Bytes and lines are numbered
+starting with 1. A hyphen '\-' used as a file argument means standard input.
+If any file given is compressed, its decompressed content is used. Compressed
+files are decompressed on the fly; no temporary files are created.
+.PP
+The formats supported are bzip2, gzip, lzip, xz, and zstd.
+.PP
+zcmp compares file1 to file2. The standard input is used only if file1 or
+file2 refers to standard input. If file2 is omitted zcmp tries to compare
+file1 with the corresponding uncompressed file (if file1 is compressed), and
+then with the corresponding compressed files of the remaining formats until
+one is found.
+.PP
+Exit status is 0 if inputs are identical, 1 if different, 2 if trouble.
+.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\-b\fR, \fB\-\-print\-bytes\fR
+print differing bytes
+.TP
+\fB\-H\fR, \fB\-\-hexadecimal\fR
+print hexadecimal values instead of octal
+.TP
+\fB\-i\fR, \fB\-\-ignore\-initial=\fR<n>[:<n2>]
+ignore differences in the first <n> bytes
+.TP
+\fB\-l\fR, \fB\-\-list\fR
+list position, value of all differing bytes
+.TP
+\fB\-M\fR, \fB\-\-format=\fR<list>
+process only the formats in <list>
+.TP
+\fB\-n\fR, \fB\-\-bytes=\fR<n>
+compare at most <n> bytes
+.TP
+\fB\-N\fR, \fB\-\-no\-rcfile\fR
+don't read runtime configuration file
+.TP
+\fB\-O\fR, \fB\-\-force\-format\fR=\fI\,[\/\fR<f1>][,<f2>]
+force one or both input formats
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR, \fB\-\-silent\fR
+suppress diagnostics written to stderr
+.TP
+\fB\-s\fR, \fB\-\-script\fR
+suppress messages about file differences
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+verbose mode (opposite of \fB\-\-quiet\fR)
+.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 options '\-M' and '\-O' are 'bz2', 'gz', 'lz', 'xz', 'zst',
+and 'un' for uncompressed.
+.PP
+Byte counts given as arguments to options may be expressed in decimal,
+hexadecimal, or octal (using the same syntax as integer constants in C++),
+and may be followed by a multiplier: k = kB = 10^3 = 1000,
+Ki = KiB = 2^10 = 1024, M = 10^6, Mi = 2^20, G = 10^9, Gi = 2^30, etc.
+.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 zcmp
+is maintained as a Texinfo manual. If the
+.B info
+and
+.B zcmp
+programs are properly installed at your site, the command
+.IP
+.B info zutils
+.PP
+should give you access to the complete manual.