xref: /openbsd-src/usr.bin/compress/zdiff.1 (revision bf198cc6eba0ca1f6d79f71e8e2243d386241fa8)
1*bf198cc6Smillert.\"	$OpenBSD: zdiff.1,v 1.7 2019/01/25 00:19:26 millert Exp $
2479fbb82Smillert.\"
3*bf198cc6Smillert.\" Copyright (c) 2003 Todd C. Miller <millert@openbsd.org>
4479fbb82Smillert.\"
5479fbb82Smillert.\" Permission to use, copy, modify, and distribute this software for any
6479fbb82Smillert.\" purpose with or without fee is hereby granted, provided that the above
7479fbb82Smillert.\" copyright notice and this permission notice appear in all copies.
8479fbb82Smillert.\"
9479fbb82Smillert.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10479fbb82Smillert.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11479fbb82Smillert.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12479fbb82Smillert.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13479fbb82Smillert.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14479fbb82Smillert.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15479fbb82Smillert.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16479fbb82Smillert.\"
17479fbb82Smillert.\" Sponsored in part by the Defense Advanced Research Projects
18479fbb82Smillert.\" Agency (DARPA) and Air Force Research Laboratory, Air Force
19479fbb82Smillert.\" Materiel Command, USAF, under agreement number F39502-99-1-0512.
20479fbb82Smillert.\"
21*bf198cc6Smillert.Dd $Mdocdate: January 25 2019 $
22479fbb82Smillert.Dt ZDIFF 1
23479fbb82Smillert.Os
24479fbb82Smillert.Sh NAME
25479fbb82Smillert.Nm zcmp ,
26479fbb82Smillert.Nm zdiff
27479fbb82Smillert.Nd compare compressed files
28479fbb82Smillert.Sh SYNOPSIS
29479fbb82Smillert.Nm zcmp
30479fbb82Smillert.Op Ar options
3104f3c49bSjmc.Ar file1
32479fbb82Smillert.Op Ar file2
33479fbb82Smillert.Nm zdiff
34479fbb82Smillert.Op Ar options
3504f3c49bSjmc.Ar file1
36479fbb82Smillert.Op Ar file2
37479fbb82Smillert.Sh DESCRIPTION
38479fbb82Smillert.Nm zcmp
39479fbb82Smillertand
40479fbb82Smillert.Nm zdiff
41479fbb82Smillertare filters that invoke
42479fbb82Smillert.Xr cmp 1
43479fbb82Smillertor
44479fbb82Smillert.Xr diff 1
45479fbb82Smillertrespectively to compare compressed files.
46479fbb82SmillertSuch files generally have a
47479fbb82Smillert.Dq Z
48479fbb82Smillertor
49479fbb82Smillert.Dq gz
50479fbb82Smillertextension (both the
51479fbb82Smillert.Xr compress 1
52479fbb82Smillertand
53479fbb82Smillert.Xr gzip 1
54479fbb82Smillertformats are supported).
55479fbb82SmillertAny
56479fbb82Smillert.Ar options
57479fbb82Smillertthat are specified are passed to
58479fbb82Smillert.Xr cmp 1
59479fbb82Smillertor
60479fbb82Smillert.Xr diff 1 .
61479fbb82Smillert.Pp
62479fbb82SmillertIf only
63479fbb82Smillert.Ar file1
64479fbb82Smillertis specified, it is compared against a file with the same name, but
65479fbb82Smillertwith the extension removed.
66479fbb82SmillertWhen both
67479fbb82Smillert.Ar file1
68479fbb82Smillertor
69479fbb82Smillert.Ar file2
70479fbb82Smillertare specified, either file may be compressed.
71479fbb82Smillert.Sh ENVIRONMENT
72479fbb82Smillert.Bl -tag -width "TMPDIR"
73479fbb82Smillert.It Ev TMPDIR
74479fbb82SmillertDirectory in which to place temporary files.
75479fbb82SmillertIf unset,
76479fbb82Smillert.Pa /tmp
77479fbb82Smillertis used.
78479fbb82Smillert.El
79479fbb82Smillert.Sh FILES
8080a04055Smillert.Bl -tag -width "/tmp/zdiff.XXXXXXXXXX" -compact
81479fbb82Smillert.It Pa /tmp/zcmp.XXXXXXXXXX
82479fbb82SmillertTemporary file for
83479fbb82Smillert.Nm zcmp .
84479fbb82Smillert.It Pa /tmp/zdiff.XXXXXXXXXX
85479fbb82SmillertTemporary file for
86479fbb82Smillert.Nm zdiff .
87479fbb82Smillert.El
88479fbb82Smillert.Sh SEE ALSO
89479fbb82Smillert.Xr cmp 1 ,
90479fbb82Smillert.Xr compress 1 ,
913a68a017Sjmc.Xr diff 1 ,
923a68a017Sjmc.Xr gzip 1
93479fbb82Smillert.Sh CAVEATS
94479fbb82Smillert.Nm zcmp
95479fbb82Smillertand
96479fbb82Smillert.Nm zdiff
9780a04055Smillertrely solely on the file extension to determine what is, or is not,
98479fbb82Smillerta compressed file.
99479fbb82SmillertConsequently, the following are not supported as arguments:
10004f3c49bSjmc.Pp
10104f3c49bSjmc.Bl -dash -offset indent -compact
102479fbb82Smillert.It
103479fbb82Smillertdirectories
104479fbb82Smillert.It
105479fbb82Smillertdevice special files
106479fbb82Smillert.It
10732fc61b3Sjmcfilenames indicating the standard input
10804f3c49bSjmc.Pq Sq -
109479fbb82Smillert.El
110