Return to cmp.1 CVS log

Up to [local] / src / usr.bin / cmp

Annotation of src/usr.bin/cmp/cmp.1, Revision 1.17

1.17    ! jmc         1: .\"     $OpenBSD: cmp.1,v 1.16 2014/01/25 21:58:06 jmc 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.
1.10      millert    18: .\" 3. Neither the name of the University nor the names of its contributors
1.1       deraadt    19: .\"    may be used to endorse or promote products derived from this software
                     20: .\"    without specific prior written permission.
                     21: .\"
                     22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     25: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     32: .\" SUCH DAMAGE.
                     33: .\"
                     34: .\"     @(#)cmp.1      8.1 (Berkeley) 6/6/93
                     35: .\"
1.17    ! jmc        36: .Dd $Mdocdate: January 25 2014 $
1.1       deraadt    37: .Dt CMP 1
                     38: .Os
                     39: .Sh NAME
                     40: .Nm cmp
                     41: .Nd compare two files
                     42: .Sh SYNOPSIS
                     43: .Nm cmp
                     44: .Op Fl l | Fl s
                     45: .Ar file1 file2
                     46: .Op Ar skip1 Op Ar skip2
                     47: .Sh DESCRIPTION
1.4       aaron      48: The
1.6       aaron      49: .Nm
1.4       aaron      50: utility compares two files of any type and writes the results
1.1       deraadt    51: to the standard output.
                     52: By default,
                     53: .Nm
                     54: is silent if the files are the same; if they differ, the byte
                     55: and line number at which the first difference occurred is reported.
                     56: .Pp
                     57: Bytes and lines are numbered beginning with one.
                     58: .Pp
1.7       aaron      59: The options are as follows:
1.9       aaron      60: .Bl -tag -width Ds
1.1       deraadt    61: .It Fl l
                     62: Print the byte number (decimal) and the differing
                     63: byte values (octal) for each difference.
                     64: .It Fl s
1.17    ! jmc        65: Silent.
1.1       deraadt    66: Print nothing for differing files; return exit
                     67: status only.
                     68: .El
                     69: .Pp
                     70: The optional arguments
                     71: .Ar skip1
1.5       aaron      72: and
1.1       deraadt    73: .Ar skip2
                     74: are the byte offsets from the beginning of
                     75: .Ar file1
                     76: and
                     77: .Ar file2 ,
                     78: respectively, where the comparison will begin.
1.4       aaron      79: The offset is decimal by default, but may be expressed as a hexadecimal
1.8       aaron      80: or octal value by preceding it with a leading
                     81: .Dq 0x
                     82: or
                     83: .Dq 0 .
1.15      jmc        84: .Sh EXIT STATUS
1.1       deraadt    85: The
1.6       aaron      86: .Nm
1.1       deraadt    87: utility exits with one of the following values:
1.16      jmc        88: .Bl -tag -width Ds -offset indent
1.1       deraadt    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,
1.6       aaron      98: .Nm
1.8       aaron      99: writes to standard error that
                    100: .Dv EOF
                    101: was reached in the shorter
1.1       deraadt   102: file (before any differences were found).
                    103: .It >1
                    104: An error occurred.
                    105: .El
                    106: .Sh SEE ALSO
                    107: .Xr diff 1 ,
1.11      jasper    108: .Xr diff3 1 ,
                    109: .Xr sdiff 1
1.1       deraadt   110: .Sh STANDARDS
                    111: The
1.6       aaron     112: .Nm
1.12      jmc       113: utility is compliant with the
1.14      jmc       114: .St -p1003.1-2008
1.12      jmc       115: specification.
                    116: .Pp
                    117: The arguments
                    118: .Ar skip1
                    119: and
                    120: .Ar skip2
                    121: are extensions to that specification.
1.8       aaron     122: .Sh HISTORY
                    123: A
                    124: .Nm
                    125: command appeared in
                    126: .At v1 .