usr/src/man/man1/cmp.1

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2006, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH CMP 1 "Jul 19, 2006"
  11 .SH NAME
  12 cmp \- compare two files
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBcmp\fR [\fB-l\fR | \fB-s\fR] \fIfile1\fR \fIfile2\fR [\fIskip1\fR] [\fIskip2\fR]
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBcmp\fR utility compares two files. \fBcmp\fR writes no output if the
  23 files are the same. Under default options, if they differ, it writes to
  24 standard output the byte and line numbers at which the first difference
  25 occurred. Bytes and lines are numbered beginning with 1. If one file is an
  26 initial subsequence of the other, that fact is noted. \fIskip1\fR and
  27 \fIskip2\fR are initial byte offsets into \fIfile1\fR and \fIfile2\fR
  28 respectively, and can be either octal or decimal. A leading 0 denotes octal.
  29 .SH OPTIONS
  30 .sp
  31 .LP
  32 The following options are supported:
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fB-l\fR\fR
  37 .ad
  38 .RS 6n
  39 Write the byte number (decimal) and the differing bytes (octal) for each
  40 difference.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fB-s\fR\fR
  47 .ad
  48 .RS 6n
  49 Write nothing for differing files. Return exit status only.
  50 .RE
  51
  52 .SH OPERANDS
  53 .sp
  54 .LP
  55 The following operands are supported:
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fIfile1\fR\fR
  60 .ad
  61 .RS 9n
  62 A path name of the first file to be compared. If \fIfile1\fR is \fB\(mi\fR, the
  63 standard input is used.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fIfile2\fR\fR
  70 .ad
  71 .RS 9n
  72 A path name of the second file to be compared. If \fIfile2\fR is \fB\(mi\fR,
  73 the standard input is used.
  74 .RE
  75
  76 .sp
  77 .LP
  78 If both \fIfile1\fR and \fIfile2\fR refer to standard input or refer to the
  79 same \fBFIFO\fR special, block special or character special file, an error
  80 results.
  81 .SH USAGE
  82 .sp
  83 .LP
  84 See \fBlargefile\fR(5) for the description of the behavior of \fBcmp\fR when
  85 encountering files greater than or equal to 2 Gbyte (2^31 bytes).
  86 .SH EXAMPLES
  87 .LP
  88 \fBExample 1 \fRComparing Files Byte for Byte
  89 .sp
  90 .LP
  91 The following example does a byte for byte comparison of \fIfile1\fR and
  92 \fIfile2\fR:
  93
  94 .sp
  95 .in +2
  96 .nf
  97 example% \fBcmp file1 file2 0 1024\fR
  98 .fi
  99 .in -2
 100 .sp
 101
 102 .sp
 103 .LP
 104 It skips the first 1024 bytes in \fIfile2\fR before starting the comparison.
 105
 106 .SH ENVIRONMENT VARIABLES
 107 .sp
 108 .LP
 109 See \fBenviron\fR(5) for descriptions of the following environment variables
 110 that affect the execution of \fBcmp\fR: \fBLANG\fR, \fBLC_ALL\fR,
 111 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
 112 .SH EXIT STATUS
 113 .sp
 114 .LP
 115 The following error values are returned:
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fB0\fR\fR
 120 .ad
 121 .RS 6n
 122 The files are identical.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fB1\fR\fR
 129 .ad
 130 .RS 6n
 131 The files are different. This includes the case where one file is identical to
 132 the first part of the other.
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fB>1\fR\fR
 139 .ad
 140 .RS 6n
 141 An error occurred.
 142 .RE
 143
 144 .SH ATTRIBUTES
 145 .sp
 146 .LP
 147 See \fBattributes\fR(5) for descriptions of the following attributes:
 148 .sp
 149
 150 .sp
 151 .TS
 152 box;
 153 c | c
 154 l | l .
 155 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 156 _
 157 CSI     Enabled
 158 _
 159 Interface Stability     Standard
 160 .TE
 161
 162 .SH SEE ALSO
 163 .sp
 164 .LP
 165 \fBcomm\fR(1), \fBdiff\fR(1), \fBattributes\fR(5), \fBenviron\fR(5),
 166 \fBlargefile\fR(5), \fBstandards\fR(5)