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