usr.bin/cmp/cmp.1

   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 .\" $FreeBSD: src/usr.bin/cmp/cmp.1,v 1.7.2.5 2003/02/24 22:37:41 trhodes Exp $
  37 .\" $DragonFly: src/usr.bin/cmp/cmp.1,v 1.2 2003/06/17 04:29:25 dillon Exp $
  38 .\"
  39 .Dd July 23, 2009
  40 .Dt CMP 1
  41 .Os
  42 .Sh NAME
  43 .Nm cmp
  44 .Nd compare two files
  45 .Sh SYNOPSIS
  46 .Nm
  47 .Op Fl l | Fl s | Fl x
  48 .Op Fl z
  49 .Ar file1 file2
  50 .Op Ar skip1 Op Ar skip2
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 utility compares two files of any type and writes the results
  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 .It Fl x
  72 Like
  73 .Fl l
  74 but prints in hexadecimal and using zero as index
  75 for the first byte in the files.
  76 .It Fl z
  77 For regular files compare file sizes first, and fail the comparison if they
  78 are not equal.
  79 .El
  80 .Pp
  81 The optional arguments
  82 .Ar skip1
  83 and
  84 .Ar skip2
  85 are the byte offsets from the beginning of
  86 .Ar file1
  87 and
  88 .Ar file2 ,
  89 respectively, where the comparison will begin.
  90 The offset is decimal by default, but may be expressed as a hexadecimal
  91 or octal value by preceding it with a leading ``0x'' or ``0''.
  92 .Pp
  93 The
  94 .Nm
  95 utility exits with one of the following values:
  96 .Bl -tag -width 4n
  97 .It 0
  98 The files are identical.
  99 .It 1
 100 The files are different; this includes the case
 101 where one file is identical to the first part of
 102 the other.
 103 In the latter case, if the
 104 .Fl s
 105 option has not been specified,
 106 .Nm
 107 writes to standard error that EOF was reached in the shorter
 108 file (before any differences were found).
 109 .It >1
 110 An error occurred.
 111 .El
 112 .Sh COMPATIBILITY
 113 The
 114 .Fl x
 115 and
 116 .Fl z
 117 options are extensions to the standard.
 118 .Sh SEE ALSO
 119 .Xr diff 1 ,
 120 .Xr diff3 1
 121 .Sh STANDARDS
 122 The
 123 .Nm
 124 utility is expected to be
 125 .St -p1003.2
 126 compatible.
 127 .Sh HISTORY
 128 A
 129 .Nm
 130 command appeared in
 131 .At v1 .