Doc: Rename Doxygen HTML doc directory name liblzma => api.
[xz/debian.git] / src / scripts / xzdiff.1
blob24fed68062173a9df2b2106b070a747f14e46570
1 .\"
2 .\" Original zdiff.1 for gzip: Jean-loup Gailly
3 .\"
4 .\" Modifications for XZ Utils: Lasse Collin
5 .\"                             Andrew Dudman
6 .\"
7 .\" License: GNU GPLv2+
8 .\"
9 .TH XZDIFF 1 "2021-06-04" "Tukaani" "XZ Utils"
10 .SH NAME
11 xzcmp, xzdiff, lzcmp, lzdiff \- compare compressed files
12 .SH SYNOPSIS
13 .B xzcmp
14 .RI [ cmp_options "] " file1 " [" file2 ]
15 .br
16 .B xzdiff
17 .RI [ diff_options "] " file1 " [" file2 ]
18 .br
19 .B lzcmp
20 .RI [ cmp_options "] " file1 " [" file2 ]
21 .br
22 .B lzdiff
23 .RI [ diff_options "] " file1 " [" file2 ]
24 .SH DESCRIPTION
25 .B xzcmp
26 and
27 .B xzdiff
28 invoke
29 .BR cmp (1)
31 .BR diff (1)
32 on files compressed with
33 .BR xz (1),
34 .BR lzma (1),
35 .BR gzip (1),
36 .BR bzip2 (1),
37 .BR lzop (1),
39 .BR zstd (1).
40 All options specified are passed directly to
41 .BR cmp (1)
43 .BR diff (1).
44 If only one file is specified, then the files compared are
45 .I file1
46 (which must have a suffix of a supported compression format) and
47 .I file1
48 from which the compression format suffix has been stripped.
49 If two files are specified,
50 then they are uncompressed if necessary and fed to
51 .BR cmp (1)
53 .BR diff (1).
54 The exit status from
55 .BR cmp (1)
57 .BR diff (1)
58 is preserved unless a decompression error occurs; then exit status is 2.
59 .PP
60 The names
61 .B lzcmp
62 and
63 .B lzdiff
64 are provided for backward compatibility with LZMA Utils.
65 .SH "SEE ALSO"
66 .BR cmp (1),
67 .BR diff (1),
68 .BR xz (1),
69 .BR gzip (1),
70 .BR bzip2 (1),
71 .BR lzop (1),
72 .BR zstd (1),
73 .BR zdiff (1)
74 .SH BUGS
75 Messages from the
76 .BR cmp (1)
78 .BR diff (1)
79 programs refer to temporary filenames instead of those specified.