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 .Ar file1 file2
  45 .Op Ar skip1 Op Ar skip2
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility compares two files of any type and writes the results
  50 to the standard output.
  51 By default,
  52 .Nm
  53 is silent if the files are the same; if they differ, the byte
  54 and line number at which the first difference occurred is reported.
  55 .Pp
  56 Bytes and lines are numbered beginning with one.
  57 .Pp
  58 The following options are available:
  59 .Bl -tag -width indent
  60 .It Fl h
  61 Do not follow symbolic links.
  62 .It Fl l , Fl -verbose
  63 Print the byte number (decimal) and the differing
  64 byte values (octal) for each difference.
  65 .It Fl s , Fl -silent , Fl -quiet
  66 Print nothing for differing files; return exit
  67 status only.
  68 .It Fl x
  69 Like
  70 .Fl l
  71 but prints in hexadecimal and using zero as index
  72 for the first byte in the files.
  73 .It Fl z
  74 For regular files compare file sizes first, and fail the comparison if they
  75 are not equal.
  76 .El
  77 .Pp
  78 The optional arguments
  79 .Ar skip1
  80 and
  81 .Ar skip2
  82 are the byte offsets from the beginning of
  83 .Ar file1
  84 and
  85 .Ar file2 ,
  86 respectively, where the comparison will begin.
  87 The offset is decimal by default, but may be expressed as a hexadecimal
  88 or octal value by preceding it with a leading ``0x'' or ``0''.
  89 .Pp
  90 .Ar skip1
  91 and
  92 .Ar skip2
  93 may also be specified with SI size suffixes.
  94 .Sh EXIT STATUS
  95 The
  96 .Nm
  97 utility exits with one of the following values:
  98 .Bl -tag -width 4n
  99 .It 0
 100 The files are identical.
 101 .It 1
 102 The files are different; this includes the case
 103 where one file is identical to the first part of
 104 the other.
 105 In the latter case, if the
 106 .Fl s
 107 option has not been specified,
 108 .Nm
 109 writes to standard error that EOF was reached in the shorter
 110 file (before any differences were found).
 111 .It >1
 112 An error occurred.
 113 .El
 114 .Sh EXAMPLES
 115 Assuming a file named
 116 .Pa example.txt
 117 with the following contents:
 118 .Bd -literal -offset indent
 119 a
 120 b
 121 c
 122 .Ed
 123 .Pp
 124 Compare stdin with
 125 .Pa example.txt :
 126 .Bd -literal -offset indent
 127 $ echo -e "a\\nb\\nc" | cmp - example.txt
 128 .Ed
 129 .Pp
 130 Same as above but introducing a change in the third byte of stdin.
 131 Show the byte number (decimal) and differing byte (octal):
 132 .Bd -literal -offset indent
 133 $ echo -e "a\\nR\\nc" | cmp -l - example.txt
 134      3 122 142
 135 .Ed
 136 .Pp
 137 Compare file sizes of
 138 .Pa example.txt
 139 and
 140 .Pa /boot/loader.conf
 141 and return 1 if they are not equal.
 142 Note that
 143 .Fl z
 144 can only be used with regular files:
 145 .Bd -literal -offset indent
 146 $ cmp -z example.txt /boot/loader.conf
 147 example.txt /boot/loader.conf differ: size
 148 .Ed
 149 .Pp
 150 Compare stdin with
 151 .Pa example.txt
 152 omitting the first 4 bytes from stdin and the first 2 bytes from
 153 .Pa example.txt :
 154 .Bd -literal -offset indent
 155 $ echo -e "a\\nR\\nb\\nc" | cmp - example.txt 4 2
 156 .Ed
 157 .Sh SEE ALSO
 158 .Xr diff 1 ,
 159 .Xr diff3 1
 160 .Sh STANDARDS
 161 The
 162 .Nm
 163 utility is expected to be
 164 .St -p1003.2
 165 compatible.
 166 The
 167 .Fl h ,
 168 .Fl x ,
 169 and
 170 .Fl z
 171 options are extensions to the standard.
 172 .Ar skip1
 173 and
 174 .Ar skip2
 175 arguments are extensions to the standard.
 176 .Sh HISTORY
 177 A
 178 .Nm
 179 command appeared in
 180 .At v1 .
 181 .Sh BUGS
 182 The phrase
 183 .Dq SI size suffixes
 184 above refers to the traditional power of two convention, as described in
 185 .Xr expand_number 3 .