freebsd-dev/usr.bin/uniq/uniq.1

.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     From: @(#)uniq.1	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd December 17, 2009
.Dt UNIQ 1
.Os
.Sh NAME
.Nm uniq
.Nd report or filter out repeated lines in a file
.Sh SYNOPSIS
.Nm
.Op Fl c | Fl d | Fl u
.Op Fl i
.Op Fl f Ar num
.Op Fl s Ar chars
.Oo
.Ar input_file
.Op Ar output_file
.Oc
.Sh DESCRIPTION
The
.Nm
utility reads the specified
.Ar input_file
comparing adjacent lines, and writes a copy of each unique input line to
the
.Ar output_file .
If
.Ar input_file
is a single dash
.Pq Sq Fl
or absent, the standard input is read.
If
.Ar output_file
is absent, standard output is used for output.
The second and succeeding copies of identical adjacent input lines are
not written.
Repeated lines in the input will not be detected if they are not adjacent,
so it may be necessary to sort the files first.
.Pp
The following options are available:
.Bl -tag -width Ds
.It Fl c
Precede each output line with the count of the number of times the line
occurred in the input, followed by a single space.
.It Fl d
Only output lines that are repeated in the input.
.It Fl f Ar num
Ignore the first
.Ar num
fields in each input line when doing comparisons.
A field is a string of non-blank characters separated from adjacent fields
by blanks.
Field numbers are one based, i.e., the first field is field one.
.It Fl s Ar chars
Ignore the first
.Ar chars
characters in each input line when doing comparisons.
If specified in conjunction with the
.Fl f
option, the first
.Ar chars
characters after the first
.Ar num
fields will be ignored.
Character numbers are one based, i.e., the first character is character one.
.It Fl u
Only output lines that are not repeated in the input.
.It Fl i
Case insensitive comparison of lines.
.\".It Fl Ns Ar n
.\"(Deprecated; replaced by
.\".Fl f ) .
.\"Ignore the first n
.\"fields on each input line when doing comparisons,
.\"where n is a number.
.\"A field is a string of non-blank
.\"characters separated from adjacent fields
.\"by blanks.
.\".It Cm \&\(pl Ns Ar n
.\"(Deprecated; replaced by
.\".Fl s ) .
.\"Ignore the first
.\".Ar m
.\"characters when doing comparisons, where
.\".Ar m
.\"is a
.\"number.
.El
.Sh ENVIRONMENT
The
.Ev LANG ,
.Ev LC_ALL ,
.Ev LC_COLLATE
and
.Ev LC_CTYPE
environment variables affect the execution of
.Nm
as described in
.Xr environ 7 .
.Sh EXIT STATUS
.Ex -std
.Sh COMPATIBILITY
The historic
.Cm \&\(pl Ns Ar number
and
.Fl Ns Ar number
options have been deprecated but are still supported in this implementation.
.Sh SEE ALSO
.Xr sort 1
.Sh STANDARDS
The
.Nm
utility conforms to
.St -p1003.1-2001
as amended by Cor.\& 1-2002.
.Sh HISTORY
A
.Nm
command appeared in
.At v3 .
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" This code is derived from software contributed to Berkeley by`
			`.\" the Institute of Electrical and Electronics Engineers, Inc.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
Teach comm(1) and uniq(1) about an option for case-insensitive work. PR: 3042 Submitted by: graphix@iastate.edu (Kent Vander Velden) 1997-09-07 15:09:22 +00:00			`.\" From: @(#)uniq.1 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
The input line length limit mentioned on the manual page was removed by r176119. Approved by: trasz (mentor) 2009-12-17 16:59:19 +00:00			`.Dd December 17, 2009`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt UNIQ 1`
			`.Os`
			`.Sh NAME`
			`.Nm uniq`
			`.Nd report or filter out repeated lines in a file`
			`.Sh SYNOPSIS`
Use err(3) instead of local redefinition. 1997-08-21 06:51:10 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl c \| Fl d \| Fl u`
Teach comm(1) and uniq(1) about an option for case-insensitive work. PR: 3042 Submitted by: graphix@iastate.edu (Kent Vander Velden) 1997-09-07 15:09:22 +00:00			`.Op Fl i`
Add the word ``fields'' to the description, and change an instance from fields to num in the SYNOPSIS Noticed by: keramida 2002-05-24 19:12:02 +00:00			`.Op Fl f Ar num`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl s Ar chars`
			`.Oo`
			`.Ar input_file`
			`.Op Ar output_file`
			`.Oc`
			`.Sh DESCRIPTION`
			`The`
Use err(3) instead of local redefinition. 1997-08-21 06:51:10 +00:00			`.Nm`
Accept an input file name of "-" to mean standard input, as required by P1003.2. 2002-05-30 00:07:14 +00:00			`utility reads the specified`
			`.Ar input_file`
			`comparing adjacent lines, and writes a copy of each unique input line to`
			`the`
			`.Ar output_file .`
			`If`
			`.Ar input_file`
			`is a single dash`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 17:33:37 +00:00			`.Pq Sq Fl`
Accept an input file name of "-" to mean standard input, as required by P1003.2. 2002-05-30 00:07:14 +00:00			`or absent, the standard input is read.`
			`If`
			`.Ar output_file`
			`is absent, standard output is used for output.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`The second and succeeding copies of identical adjacent input lines are`
			`not written.`
			`Repeated lines in the input will not be detected if they are not adjacent,`
			`so it may be necessary to sort the files first.`
			`.Pp`
			`The following options are available:`
			`.Bl -tag -width Ds`
			`.It Fl c`
			`Precede each output line with the count of the number of times the line`
			`occurred in the input, followed by a single space.`
			`.It Fl d`
Grammar nits, double negatives PR: docs/10491 Submitted By: Tom Hukins <tom@eborcom.com> 1999-03-15 02:57:29 +00:00			`Only output lines that are repeated in the input.`
Reword a small part of the uniq(1) manual page to help reduce word duplication (ie: fields fields). PR: 38161 Reviewed by: keramida MFC after: 3 days 2002-05-21 16:54:58 +00:00			`.It Fl f Ar num`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`Ignore the first`
Reword a small part of the uniq(1) manual page to help reduce word duplication (ie: fields fields). PR: 38161 Reviewed by: keramida MFC after: 3 days 2002-05-21 16:54:58 +00:00			`.Ar num`
Add the word ``fields'' to the description, and change an instance from fields to num in the SYNOPSIS Noticed by: keramida 2002-05-24 19:12:02 +00:00			`fields in each input line when doing comparisons.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`A field is a string of non-blank characters separated from adjacent fields`
			`by blanks.`
Mechanically kill hard sentence breaks. 2004-07-02 22:22:35 +00:00			`Field numbers are one based, i.e., the first field is field one.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl s Ar chars`
			`Ignore the first`
			`.Ar chars`
			`characters in each input line when doing comparisons.`
			`If specified in conjunction with the`
			`.Fl f`
			`option, the first`
			`.Ar chars`
			`characters after the first`
Reword a small part of the uniq(1) manual page to help reduce word duplication (ie: fields fields). PR: 38161 Reviewed by: keramida MFC after: 3 days 2002-05-21 16:54:58 +00:00			`.Ar num`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`fields will be ignored.`
Mechanically kill hard sentence breaks. 2004-07-02 22:22:35 +00:00			`Character numbers are one based, i.e., the first character is character one.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl u`
Grammar nits, double negatives PR: docs/10491 Submitted By: Tom Hukins <tom@eborcom.com> 1999-03-15 02:57:29 +00:00			`Only output lines that are not repeated in the input.`
Teach comm(1) and uniq(1) about an option for case-insensitive work. PR: 3042 Submitted by: graphix@iastate.edu (Kent Vander Velden) 1997-09-07 15:09:22 +00:00			`.It Fl i`
			`Case insensitive comparison of lines.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\".It Fl Ns Ar n`
			`.\"(Deprecated; replaced by`
			`.\".Fl f ) .`
			`.\"Ignore the first n`
			`.\"fields on each input line when doing comparisons,`
			`.\"where n is a number.`
			`.\"A field is a string of non-blank`
			`.\"characters separated from adjacent fields`
			`.\"by blanks.`
			`.\".It Cm \&\(pl Ns Ar n`
			`.\"(Deprecated; replaced by`
			`.\".Fl s ) .`
			`.\"Ignore the first`
			`.\".Ar m`
			`.\"characters when doing comparisons, where`
			`.\".Ar m`
			`.\"is a`
			`.\"number.`
			`.El`
Mention the environment variables that affect the execution of uniq. Of particular interest is the fact that LC_COLLATE affects how uniq determines whether lines are equal. This was the subject of a fairly heated debate a year or so ago, and it turns out that the current behaviour is correct and that the standard contained an error. Now that the standard has been corrected by Cor. 1-2002, refer to 1003.1-2001 instead of the 1992 edition in the Standards section. 2003-04-12 04:17:14 +00:00			`.Sh ENVIRONMENT`
			`The`
			`.Ev LANG ,`
			`.Ev LC_ALL ,`
			`.Ev LC_COLLATE`
			`and`
			`.Ev LC_CTYPE`
			`environment variables affect the execution of`
			`.Nm`
			`as described in`
			`.Xr environ 7 .`
Added the EXIT STATUS section where appropriate. 2005-01-17 07:44:44 +00:00			`.Sh EXIT STATUS`
mdoc(7) police: utilize the new .Ex macro. 2001-08-15 09:09:47 +00:00			`.Ex -std`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh COMPATIBILITY`
			`The historic`
			`.Cm \&\(pl Ns Ar number`
			`and`
			`.Fl Ns Ar number`
			`options have been deprecated but are still supported in this implementation.`
			`.Sh SEE ALSO`
			`.Xr sort 1`
			`.Sh STANDARDS`
			`The`
Use err(3) instead of local redefinition. 1997-08-21 06:51:10 +00:00			`.Nm`
Mention the environment variables that affect the execution of uniq. Of particular interest is the fact that LC_COLLATE affects how uniq determines whether lines are equal. This was the subject of a fairly heated debate a year or so ago, and it turns out that the current behaviour is correct and that the standard contained an error. Now that the standard has been corrected by Cor. 1-2002, refer to 1003.1-2001 instead of the 1992 edition in the Standards section. 2003-04-12 04:17:14 +00:00			`utility conforms to`
			`.St -p1003.1-2001`
Mechanically kill hard sentence breaks. 2004-07-02 22:22:35 +00:00			`as amended by Cor.\& 1-2002.`
Correct the History section; uniq(1) appeared at least as early as V3. Move the section to after Standards. 2002-07-05 09:44:47 +00:00			`.Sh HISTORY`
			`A`
			`.Nm`
			`command appeared in`
			`.At v3 .`