Annotation of src/usr.bin/cmp/cmp.1, Revision 1.4
1.4 ! aaron 1: .\" $OpenBSD: cmp.1,v 1.3 1998/05/26 07:22:21 deraadt Exp $
1.1 deraadt 2: .\" $NetBSD: cmp.1,v 1.4 1995/09/08 03:22:55 tls Exp $
3: .\"
4: .\" Copyright (c) 1987, 1990, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" This code is derived from software contributed to Berkeley by
8: .\" the Institute of Electrical and Electronics Engineers, Inc.
9: .\"
10: .\" Redistribution and use in source and binary forms, with or without
11: .\" modification, are permitted provided that the following conditions
12: .\" are met:
13: .\" 1. Redistributions of source code must retain the above copyright
14: .\" notice, this list of conditions and the following disclaimer.
15: .\" 2. Redistributions in binary form must reproduce the above copyright
16: .\" notice, this list of conditions and the following disclaimer in the
17: .\" documentation and/or other materials provided with the distribution.
18: .\" 3. All advertising materials mentioning features or use of this software
19: .\" must display the following acknowledgement:
20: .\" This product includes software developed by the University of
21: .\" California, Berkeley and its contributors.
22: .\" 4. Neither the name of the University nor the names of its contributors
23: .\" may be used to endorse or promote products derived from this software
24: .\" without specific prior written permission.
25: .\"
26: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36: .\" SUCH DAMAGE.
37: .\"
38: .\" @(#)cmp.1 8.1 (Berkeley) 6/6/93
39: .\"
40: .Dd June 6, 1993
41: .Dt CMP 1
42: .Os
43: .Sh NAME
44: .Nm cmp
45: .Nd compare two files
46: .Sh SYNOPSIS
47: .Nm cmp
48: .Op Fl l | Fl s
49: .Ar file1 file2
50: .Op Ar skip1 Op Ar skip2
51: .Sh DESCRIPTION
1.4 ! aaron 52: The
! 53: .Nm cmp
! 54: utility compares two files of any type and writes the results
1.1 deraadt 55: to the standard output.
56: By default,
57: .Nm
58: is silent if the files are the same; if they differ, the byte
59: and line number at which the first difference occurred is reported.
60: .Pp
61: Bytes and lines are numbered beginning with one.
62: .Pp
63: The following options are available:
64: .Bl -tag -width flag
65: .It Fl l
66: Print the byte number (decimal) and the differing
67: byte values (octal) for each difference.
68: .It Fl s
69: Print nothing for differing files; return exit
70: status only.
71: .El
72: .Pp
73: The optional arguments
74: .Ar skip1
75: and
76: .Ar skip2
77: are the byte offsets from the beginning of
78: .Ar file1
79: and
80: .Ar file2 ,
81: respectively, where the comparison will begin.
1.4 ! aaron 82: The offset is decimal by default, but may be expressed as a hexadecimal
1.1 deraadt 83: or octal value by preceding it with a leading ``0x'' or ``0''.
84: .Pp
85: The
86: .Nm cmp
87: utility exits with one of the following values:
88: .Bl -tag -width 4n
89: .It 0
90: The files are identical.
91: .It 1
92: The files are different; this includes the case
93: where one file is identical to the first part of
94: the other.
95: In the latter case, if the
96: .Fl s
97: option has not been specified,
98: .Nm cmp
1.3 deraadt 99: writes to standard error that EOF was reached in the shorter
1.1 deraadt 100: file (before any differences were found).
101: .It >1
102: An error occurred.
103: .El
104: .Sh SEE ALSO
105: .Xr diff 1 ,
106: .Xr diff3 1
107: .Sh STANDARDS
108: The
109: .Nm cmp
110: utility is expected to be
111: .St -p1003.2
112: compatible.