updated to -mdoc version 3
[unix-history] / usr / src / usr.bin / comm / comm.1
index 675d812..d2baea5 100644 (file)
@@ -1,43 +1,67 @@
-.\"    @(#)comm.1      6.1 (Berkeley) %G%
+.\" Copyright (c) 1989, 1990 The Regents of the University of California.
+.\" All rights reserved.
 .\"
 .\"
-.TH COMM 1 ""
-.AT 3
-.SH NAME
-comm \- select or reject lines common to two sorted files
-.SH SYNOPSIS
-.B comm
-[
-.B \-
-[
-.B 123
-]
-] file1 file2
-.SH DESCRIPTION
-.I Comm
-reads
-.I file1
+.\" %sccs.include.redist.man%
+.\"
+.\"     @(#)comm.1     6.5 (Berkeley) %G%
+.\"
+.Dd 
+.Os
+.Dt COMM 1
+.Sh NAME
+.Nm comm
+.Nd select or reject lines common to two files
+.Sh SYNOPSIS
+.Nm comm
+.Op Fl 123
+.Ar file1 file2
+.Sh DESCRIPTION
+The
+.Nm comm
+utility reads
+.Ar file1
 and
 and
-.I file2,
-which should be ordered in ASCII collating sequence,
-and produces a three column output: lines only in
-.I file1;
+.Ar file2 ,
+which should be
+sorted lexically, and produces three text
+columns as output: lines only in
+.Ar file1 ;
 lines only in
 lines only in
-.I file2;
+.Ar file2 ;
 and lines in both files.
 and lines in both files.
-The filename `\-' means the standard input.
-.PP
-Flags 1, 2, or 3 suppress printing of the corresponding
-column.
-Thus
-.B comm
-.B \-12
-prints only the lines common to the two files;
-.B comm
-.B \-23
-prints only lines in the first file but not in the second;
-.B comm
-.B \-123
-is a no-op.
-.PP
-.SH "SEE ALSO"
-cmp(1), diff(1), uniq(1)
+.Pp
+The filename
+.Ql Fl
+means the standard input.
+.Pp
+The following options are available:
+.Bl -tag -width Ds
+.It Fl 1
+Suppress printing of column 1.
+.It Fl 2
+Suppress printing of column 2.
+.It Fl 3
+Suppress printing of column 3.
+.El
+.Pp
+Each column will have a number of tab characters prepended to it
+equal to the number of lower numbered columns that are being printed.
+For example, if column number two is being suppressed, lines printed
+in column number one will not have any tabs preceding them, and lines
+printed in column number three will have one.
+.Pp
+.Nm Comm
+assumes that the files are lexically sorted; all characters
+participate in line comparisons.
+.Pp
+.Nm Comm
+exits 0 on success, >0 if an error occurred.
+.Sh SEE ALSO
+.Xr cmp 1 ,
+.Xr diff 1 ,
+.Xr sort 1 ,
+.Xr uniq 1
+.Sh STANDARDS
+The
+.Nm comm
+command is expected to be POSIX 1003.2 compatible.