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. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)cmp.1       8.1 (Berkeley) 6/6/93
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd September 23, 2021
  35 .Dt CMP 1
  36 .Os
  37 .Sh NAME
  38 .Nm cmp
  39 .Nd compare two files
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl l | s | x
  43 .Op Fl hz
  44 .Op Fl -bytes Ns Cm = Ns Ar num
  45 .Ar file1 file2
  46 .Op Ar skip1 Op Ar skip2
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility compares two files of any type and writes the results
  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
  59 The following options are available:
  60 .Bl -tag -width indent
  61 .It Fl h
  62 Do not follow symbolic links.
  63 .It Fl l , Fl -verbose
  64 Print the byte number (decimal) and the differing
  65 byte values (octal) for each difference.
  66 .It Fl n Ar num , Fl -bytes= Ns num
  67 Only compare up to
  68 .Ar num
  69 bytes.
  70 .It Fl s , Fl -silent , Fl -quiet
  71 Print nothing for differing files; return exit
  72 status only.
  73 .It Fl x
  74 Like
  75 .Fl l
  76 but prints in hexadecimal and using zero as index
  77 for the first byte in the files.
  78 .It Fl z
  79 For regular files compare file sizes first, and fail the comparison if they
  80 are not equal.
  81 .El
  82 .Pp
  83 The optional arguments
  84 .Ar skip1
  85 and
  86 .Ar skip2
  87 are the byte offsets from the beginning of
  88 .Ar file1
  89 and
  90 .Ar file2 ,
  91 respectively, where the comparison will begin.
  92 The offset is decimal by default, but may be expressed as a hexadecimal
  93 or octal value by preceding it with a leading ``0x'' or ``0''.
  94 .Pp
  95 .Ar skip1
  96 and
  97 .Ar skip2
  98 may also be specified with SI size suffixes.
  99 .Sh EXIT STATUS
 100 The
 101 .Nm
 102 utility exits with one of the following values:
 103 .Bl -tag -width 4n
 104 .It 0
 105 The files are identical.
 106 .It 1
 107 The files are different; this includes the case
 108 where one file is identical to the first part of
 109 the other.
 110 In the latter case, if the
 111 .Fl s
 112 option has not been specified,
 113 .Nm
 114 writes to standard error that EOF was reached in the shorter
 115 file (before any differences were found).
 116 .It >1
 117 An error occurred.
 118 .El
 119 .Sh EXAMPLES
 120 Assuming a file named
 121 .Pa example.txt
 122 with the following contents:
 123 .Bd -literal -offset indent
 124 a
 125 b
 126 c
 127 .Ed
 128 .Pp
 129 Compare stdin with
 130 .Pa example.txt :
 131 .Bd -literal -offset indent
 132 $ echo -e "a\\nb\\nc" | cmp - example.txt
 133 .Ed
 134 .Pp
 135 Same as above but introducing a change in the third byte of stdin.
 136 Show the byte number (decimal) and differing byte (octal):
 137 .Bd -literal -offset indent
 138 $ echo -e "a\\nR\\nc" | cmp -l - example.txt
 139      3 122 142
 140 .Ed
 141 .Pp
 142 Compare file sizes of
 143 .Pa example.txt
 144 and
 145 .Pa /boot/loader.conf
 146 and return 1 if they are not equal.
 147 Note that
 148 .Fl z
 149 can only be used with regular files:
 150 .Bd -literal -offset indent
 151 $ cmp -z example.txt /boot/loader.conf
 152 example.txt /boot/loader.conf differ: size
 153 .Ed
 154 .Pp
 155 Compare stdin with
 156 .Pa example.txt
 157 omitting the first 4 bytes from stdin and the first 2 bytes from
 158 .Pa example.txt :
 159 .Bd -literal -offset indent
 160 $ echo -e "a\\nR\\nb\\nc" | cmp - example.txt 4 2
 161 .Ed
 162 .Sh SEE ALSO
 163 .Xr diff 1 ,
 164 .Xr diff3 1
 165 .Sh STANDARDS
 166 The
 167 .Nm
 168 utility is expected to be
 169 .St -p1003.2
 170 compatible.
 171 The
 172 .Fl h ,
 173 .Fl n ,
 174 .Fl x ,
 175 and
 176 .Fl z
 177 options are extensions to the standard.
 178 .Ar skip1
 179 and
 180 .Ar skip2
 181 arguments are extensions to the standard.
 182 .Sh HISTORY
 183 A
 184 .Nm
 185 command appeared in
 186 .At v1 .
 187 .Sh BUGS
 188 The phrase
 189 .Dq SI size suffixes
 190 above refers to the traditional power of two convention, as described in
 191 .Xr expand_number 3 .