8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man1 / comm.1
blob8a9a4a4c1f6630d37a7be69e4ac17864ed224fd6
1 '\" te
2 .\" Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.
3 .\" Copyright 1989 AT&T
4 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
5 .\" 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
6 .\" http://www.opengroup.org/bookstore/.
7 .\" 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.
8 .\"  This notice shall appear on any product containing this material.
9 .\" 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.
10 .\" 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.
11 .\" 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]
12 .TH COMM 1 "Mar 3, 2004"
13 .SH NAME
14 comm \- select or reject lines common to two files
15 .SH SYNOPSIS
16 .LP
17 .nf
18 \fBcomm\fR [\fB-123\fR] \fIfile1\fR \fIfile2\fR
19 .fi
21 .SH DESCRIPTION
22 .sp
23 .LP
24 The \fBcomm\fR utility reads \fIfile1\fR and \fIfile2\fR, which must be ordered
25 in the current collating sequence, and produces three text columns as output:
26 lines only in \fIfile1\fR; lines only in \fIfile2\fR; and lines in both files.
27 .sp
28 .LP
29 If the input files were ordered according to the collating sequence of the
30 current locale, the lines written will be in the collating sequence of the
31 original lines. If not, the results are unspecified.
32 .SH OPTIONS
33 .sp
34 .LP
35 The following options are supported:
36 .sp
37 .ne 2
38 .na
39 \fB\fB-1\fR\fR
40 .ad
41 .RS 6n
42 Suppresses the output column of lines unique to \fIfile1\fR.
43 .RE
45 .sp
46 .ne 2
47 .na
48 \fB\fB-2\fR\fR
49 .ad
50 .RS 6n
51 Suppresses the output column of lines unique to \fIfile2\fR.
52 .RE
54 .sp
55 .ne 2
56 .na
57 \fB\fB-3\fR\fR
58 .ad
59 .RS 6n
60 Suppresses the output column of lines duplicated in \fIfile1\fR and
61 \fIfile2\fR.
62 .RE
64 .SH OPERANDS
65 .sp
66 .LP
67 The following operands are supported:
68 .sp
69 .ne 2
70 .na
71 \fB\fIfile1\fR\fR
72 .ad
73 .RS 9n
74 A path name of the first file to be compared. If \fIfile1\fR is \fB\(mi\fR, the
75 standard input is used.
76 .RE
78 .sp
79 .ne 2
80 .na
81 \fB\fIfile2\fR\fR
82 .ad
83 .RS 9n
84 A path name of the second file to be compared. If \fIfile2\fR is \fB\(mi\fR,
85 the standard input is used.
86 .RE
88 .SH USAGE
89 .sp
90 .LP
91 See \fBlargefile\fR(5) for the description of the behavior of \fBcomm\fR when
92 encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
93 .SH EXAMPLES
94 .LP
95 \fBExample 1 \fRPrinting a list of utilities specified by files
96 .sp
97 .LP
98 If \fIfile1\fR, \fIfile2\fR, and \fIfile3\fR each contain a sorted list of
99 utilities, the command
102 .in +2
104 example% \fBcomm -23 file1 file2  | comm -23 - file3\fR
106 .in -2
111 prints a list of utilities in \fIfile1\fR not specified by either of the other
112 files. The entry:
115 .in +2
117 example% \fBcomm -12 file1 file2 | comm -12 - file3\fR
119 .in -2
124 prints a list of utilities specified by all three files. And the entry:
127 .in +2
129 example% \fBcomm -12  file2 file3 | comm -23 -file1\fR
131 .in -2
136 prints a list of utilities specified by both \fIfile2\fR and \fIfile3\fR, but
137 not specified in \fIfile1\fR.
139 .SH ENVIRONMENT VARIABLES
142 See \fBenviron\fR(5) for descriptions of the following environment variables
143 that affect the execution of \fBcomm\fR: \fBLANG\fR, \fBLC_ALL\fR,
144 \fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
145 .SH EXIT STATUS
148 The following exit values are returned:
150 .ne 2
152 \fB\fB0\fR\fR
154 .RS 6n
155 All input files were successfully output as specified.
159 .ne 2
161 \fB\fB>0\fR\fR
163 .RS 6n
164 An error occurred.
167 .SH ATTRIBUTES
170 See \fBattributes\fR(5) for descriptions of the following attributes:
175 box;
176 c | c
177 l | l .
178 ATTRIBUTE TYPE  ATTRIBUTE VALUE
180 CSI     enabled
182 Interface Stability     Standard
185 .SH SEE ALSO
188 \fBcmp\fR(1), \fBdiff\fR(1), \fBsort\fR(1), \fBuniq\fR(1), \fBattributes\fR(5),
189 \fBenviron\fR(5), \fBlargefile\fR(5), \fBstandards\fR(5)