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$
  37 .\"
  38 .Dd December 19, 2006
  39 .Dt CMP 1
  40 .Os
  41 .Sh NAME
  42 .Nm cmp
  43 .Nd compare two files
  44 .Sh SYNOPSIS
  45 .Nm
  46 .Op Fl l | s | x
  47 .Op Fl hz
  48 .Ar file1 file2
  49 .Op Ar skip1 Op Ar skip2
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 utility compares two files of any type and writes the results
  54 to the standard output.
  55 By default,
  56 .Nm
  57 is silent if the files are the same; if they differ, the byte
  58 and line number at which the first difference occurred is reported.
  59 .Pp
  60 Bytes and lines are numbered beginning with one.
  61 .Pp
  62 The following options are available:
  63 .Bl -tag -width indent
  64 .It Fl h
  65 Do not follow symbolic links.
  66 .It Fl l
  67 Print the byte number (decimal) and the differing
  68 byte values (octal) for each difference.
  69 .It Fl s
  70 Print nothing for differing files; return exit
  71 status only.
  72 .It Fl x
  73 Like
  74 .Fl l
  75 but prints in hexadecimal and using zero as index
  76 for the first byte in the files.
  77 .It Fl z
  78 For regular files compare file sizes first, and fail the comparison if they
  79 are not equal.
  80 .El
  81 .Pp
  82 The optional arguments
  83 .Ar skip1
  84 and
  85 .Ar skip2
  86 are the byte offsets from the beginning of
  87 .Ar file1
  88 and
  89 .Ar file2 ,
  90 respectively, where the comparison will begin.
  91 The offset is decimal by default, but may be expressed as a hexadecimal
  92 or octal value by preceding it with a leading ``0x'' or ``0''.
  93 .Sh EXIT STATUS
  94 The
  95 .Nm
  96 utility exits with one of the following values:
  97 .Bl -tag -width 4n
  98 .It 0
  99 The files are identical.
 100 .It 1
 101 The files are different; this includes the case
 102 where one file is identical to the first part of
 103 the other.
 104 In the latter case, if the
 105 .Fl s
 106 option has not been specified,
 107 .Nm
 108 writes to standard error that EOF was reached in the shorter
 109 file (before any differences were found).
 110 .It >1
 111 An error occurred.
 112 .El
 113 .Sh SEE ALSO
 114 .Xr diff 1 ,
 115 .Xr diff3 1
 116 .Sh STANDARDS
 117 The
 118 .Nm
 119 utility is expected to be
 120 .St -p1003.2
 121 compatible.
 122 .Sh HISTORY
 123 A
 124 .Nm
 125 command appeared in
 126 .At v1 .