Unleashed v1.4
[unleashed.git] / share / man / man1 / dircmp.1
blob49ef3d7941d19cca36fa2628462f8b544d6f39d2
1 .\"
2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\"
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
9 .\" documentation.
10 .\"
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
13 .\"
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document.  The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
24 .\"
25 .\" This notice shall appear on any product containing this material.
26 .\"
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
30 .\"
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Copyright 1989 AT&T
44 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved
45 .\" Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved.
46 .\"
47 .TH DIRCMP 1 "Feb 1, 1995"
48 .SH NAME
49 dircmp \- directory comparison
50 .SH SYNOPSIS
51 .LP
52 .nf
53 \fBdircmp\fR [\fB-ds\fR] [\fB-w\fR \fIn\fR] \fIdir1\fR \fIdir2\fR
54 .fi
56 .SH DESCRIPTION
57 .sp
58 .LP
59 The \fBdircmp\fR command examines \fIdir1\fR and \fIdir2\fR and generates
60 various tabulated information about the contents of the directories. Listings
61 of files that are unique to each directory are generated for all the options.
62 If no option is entered, a list is output indicating whether the file names
63 common to both directories have the same contents.
64 .SH OPTIONS
65 .sp
66 .LP
67 The following options are supported:
68 .sp
69 .ne 2
70 .na
71 \fB\fB-d\fR\fR
72 .ad
73 .RS 8n
74 Compares the contents of files with the same name in both directories and
75 output a list telling what must be changed in the two files to bring them into
76 agreement. The list format is described in \fBdiff\fR(1).
77 .RE
79 .sp
80 .ne 2
81 .na
82 \fB\fB-s\fR\fR
83 .ad
84 .RS 8n
85 Suppresses messages about identical files.
86 .RE
88 .sp
89 .ne 2
90 .na
91 \fB\fB-w\fR \fIn\fR\fR
92 .ad
93 .RS 8n
94 Changes the width of the output line to \fIn\fR characters. The default width
95 is  \fB72\fR.
96 .RE
98 .SH OPERANDS
99 .sp
101 The following operands are supported:
103 .ne 2
105 \fB\fIdir1\fR\fR
109 \fB\fIdir2\fR\fR
111 .RS 8n
112 A path name of a directory to be compared.
115 .SH ENVIRONMENT VARIABLES
118 See \fBenviron\fR(5) for descriptions of the following environment variables
119 that affect the execution of \fBdircmp\fR: \fBLC_COLLATE\fR, \fBLC_CTYPE\fR,
120 \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
121 .SH EXIT STATUS
124 The following exit values are returned:
126 .ne 2
128 \fB\fB0\fR\fR
130 .RS 6n
131 Successful completion.
135 .ne 2
137 \fB\fB>0\fR\fR
139 .RS 6n
140 An error occurred. (Differences in directory contents are not considered
141 errors.)
144 .SH SEE ALSO
147 \fBcmp\fR(1), \fBdiff\fR(1), \fBattributes\fR(5), \fBenviron\fR(5)