[unix-history] / usr.bin / cmp / cmp.1

.\" Copyright (c) 1987, 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)cmp.1	6.7 (Berkeley) 6/27/91
.\"
.Dd June 27, 1991
.Dt CMP 1
.Os
.Sh NAME
.Nm cmp
.Nd Compare two files.
.Sh SYNOPSIS
.Nm cmp
.Op Fl l Li \&| Fl s
.Ar file1 file2
.Sh DESCRIPTION
The cmp utility compares two files of any type and
writes the results to the standard output.
By default,
.Nm
is silent if the files are the same; if they differ, the byte
and line number at which the first difference occurred is reported.
.Pp
Bytes and lines are numbered beginning with one.
.Pp
The following options are available:
.Bl -tag -width Ds
.It Fl l
Print the byte number (decimal) and the differing
byte values (octal) for each difference.
.It Fl s
Print nothing for differing files; return exit
status only.
.El
.Pp
If
.Ar file1
or
.Ar file2
is ``-'', the the standard input is used.
.Pp
The
.Nm cmp
utility exits with one of the following values:
.Bl -tag -width 4n
.It 0
The files are identical.
.It 1
The files are different; this includes the case
where one file is identical to the first part of
the other.
In the latter case, if the
.Fl s
option has
not been specified, cmp writes to standard error
that EOF was reached in the shorter file (before
any differences were found).
.It >1
An error occurred.
.El
.Sh SEE ALSO
.Xr diff 1 ,
.Xr diff3 1
.Sh STANDARDS
The
.Nm cmp
function is expected to be POSIX 1003.2 compatible.
Commit	Line	Data
15637ed4 RG	1	.\" Copyright (c) 1987, 1990 The Regents of the University of California.
	2	.\" 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 6.7 (Berkeley) 6/27/91
	36	.\"
	37	.Dd June 27, 1991
	38	.Dt CMP 1
	39	.Os
	40	.Sh NAME
	41	.Nm cmp
	42	.Nd Compare two files.
	43	.Sh SYNOPSIS
	44	.Nm cmp
	45	.Op Fl l Li \&\| Fl s
	46	.Ar file1 file2
	47	.Sh DESCRIPTION
	48	The cmp utility compares two files of any type and
	49	writes the results to the standard output.
	50	By default,
	51	.Nm
	52	is silent if the files are the same; if they differ, the byte
	53	and line number at which the first difference occurred is reported.
	54	.Pp
	55	Bytes and lines are numbered beginning with one.
	56	.Pp
	57	The following options are available:
	58	.Bl -tag -width Ds
	59	.It Fl l
	60	Print the byte number (decimal) and the differing
	61	byte values (octal) for each difference.
	62	.It Fl s
	63	Print nothing for differing files; return exit
	64	status only.
65	.El
66	.Pp
67	If
68	.Ar file1
69	or
70	.Ar file2
71	is ``-'', the the standard input is used.
72	.Pp
73	The
74	.Nm cmp
75	utility exits with one of the following values:
76	.Bl -tag -width 4n
77	.It 0
78	The files are identical.
79	.It 1
80	The files are different; this includes the case
81	where one file is identical to the first part of
82	the other.
83	In the latter case, if the
84	.Fl s
85	option has
86	not been specified, cmp writes to standard error
87	that EOF was reached in the shorter file (before
88	any differences were found).
89	.It >1
90	An error occurred.
91	.El
92	.Sh SEE ALSO
93	.Xr diff 1 ,
94	.Xr diff3 1
95	.Sh STANDARDS
96	The
97	.Nm cmp
98	function is expected to be POSIX 1003.2 compatible.