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

.\" Copyright (c) 1989, 1990, 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 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.
.\"
.\"     @(#)cut.1	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd June 28, 2004
.Dt CUT 1
.Os
.Sh NAME
.Nm cut
.Nd select portions of each line of a file
.Sh SYNOPSIS
.Nm
.Fl b Ar list
.Op Fl n
.Op Ar
.Nm
.Fl c Ar list
.Op Ar
.Nm
.Fl f Ar list
.Op Fl d Ar delim
.Op Fl s
.Op Ar
.Sh DESCRIPTION
The
.Nm
utility selects portions of each line (as specified by
.Ar list  )
from each
.Ar file
and writes them to the standard output.
If no
.Ar file
arguments are specified, or a file argument is a single dash
.Pq Sq Fl ,
.Nm
reads from the standard input.
The items specified by
.Ar list
can be in terms of column position or in terms of fields delimited
by a special character.
Column numbering starts from 1.
.Pp
The
.Ar list
option argument
is a comma or whitespace separated set of increasing numbers and/or
number ranges.
Number ranges consist of a number, a dash
.Pq Sq \- ,
and a second number
and select the fields or columns from the first number to the second,
inclusive.
Numbers or number ranges may be preceded by a dash, which selects all
fields or columns from 1 to the first number.
Numbers or number ranges may be followed by a dash, which selects all
fields or columns from the last number to the end of the line.
Numbers and number ranges may be repeated, overlapping, and in any order.
It is not an error to select fields or columns not present in the
input line.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl b Ar list
The
.Ar list
specifies byte positions.
.It Fl c Ar list
The
.Ar list
specifies character positions.
.It Fl d Ar delim
Use the first character of
.Ar delim
as the field delimiter character instead of the tab character.
.It Fl f Ar list
The
.Ar list
specifies fields, delimited in the input by a single tab character.
Output fields are separated by a single tab character.
.It Fl n
Do not split multi-byte characters.
.It Fl s
Suppress lines with no field delimiter characters.
Unless specified, lines with no delimiters are passed through unmodified.
.El
.Sh ENVIRONMENT
The
.Ev LANG , LC_ALL
and
.Ev LC_CTYPE
environment variables affect the execution of the
.Nm
utility.
Their effect is described in
.Xr environ 7 .
.Sh EXAMPLES
Extract users' login names and shells from the system
.Xr passwd 5
file as
.Dq name:shell
pairs:
.Pp
.Dl "cut -d : -f 1,7 /etc/passwd"
.Pp
Show the names and login times of the currently logged in users:
.Pp
.Dl "who | cut -c 1-16,26-38"
.Sh DIAGNOSTICS
.Ex -std
.Sh SEE ALSO
.Xr paste 1
.Sh STANDARDS
The
.Nm
utility conforms to
.St -p1003.2-92 .
.Sh HISTORY
A
.Nm
command appeared in
.Tn AT&T
System III
.Ux .
.Sh BUGS
When operating on fields
.Fl ( f
option is specified),
.Nm
does not recognise multibyte characters, and the
.Ar delim
character is recognised in the middle of multibyte sequences.
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1989, 1990, 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.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 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.`
			`.\"`
			`.\" @(#)cut.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			`.\"`
Implement the -c option correctly in locales with multibyte characters instead of treating it as a synonym for -b. 2004-06-27 14:55:07 +00:00			`.Dd June 28, 2004`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt CUT 1`
			`.Os`
			`.Sh NAME`
			`.Nm cut`
			`.Nd select portions of each line of a file`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Merge from NetBSD cut.1 rev 1.6 and cut.c rev 1.9, respectively. This makes us conform to IEEE Std1003.2-1992 (``POSIX.2''). Obtained from: NetBSD (but with slight modifications). 1999-02-02 14:26:39 +00:00			`.Fl b Ar list`
			`.Op Fl n`
			`.Op Ar`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Fl c Ar list`
Merge from NetBSD cut.1 rev 1.6 and cut.c rev 1.9, respectively. This makes us conform to IEEE Std1003.2-1992 (``POSIX.2''). Obtained from: NetBSD (but with slight modifications). 1999-02-02 14:26:39 +00:00			`.Op Ar`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Fl f Ar list`
Use err(3) instead of local redefinition. Change argument name in man page to sync with usage string. 1997-06-30 06:48:46 +00:00			`.Op Fl d Ar delim`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl s`
Merge from NetBSD cut.1 rev 1.6 and cut.c rev 1.9, respectively. This makes us conform to IEEE Std1003.2-1992 (``POSIX.2''). Obtained from: NetBSD (but with slight modifications). 1999-02-02 14:26:39 +00:00			`.Op Ar`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh DESCRIPTION`
			`The`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`utility selects portions of each line (as specified by`
			`.Ar list )`
			`from each`
			`.Ar file`
Revert previous delta for cut(1) and calendar(1) as they were not applied correctly. My fault, forgot that -current was checked out. 2002-07-23 15:09:56 +00:00			`and writes them to the standard output.`
			`If no`
			`.Ar file`
			`arguments are specified, or a file argument is a single dash`
			`.Pq Sq Fl ,`
			`.Nm`
Duplicate "from". PR: docs/51724 Submitted by: Christopher Nehren <apeiron@comcast.net 2003-05-03 15:55:23 +00:00			`reads from the standard input.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`The items specified by`
			`.Ar list`
			`can be in terms of column position or in terms of fields delimited`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 12:20:22 +00:00			`by a special character.`
			`Column numbering starts from 1.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Pp`
Revert previous delta for cut(1) and calendar(1) as they were not applied correctly. My fault, forgot that -current was checked out. 2002-07-23 15:09:56 +00:00			`The`
Bring in use of strsep() to handle bad input better, and clean up some text. Obtained from: Merge from OpenBSD (cut.1 up to OpenBSD rev 1.3, cut.c up to OpenBSD rev 1.6) 1999-02-02 14:56:55 +00:00			`.Ar list`
Revert previous delta for cut(1) and calendar(1) as they were not applied correctly. My fault, forgot that -current was checked out. 2002-07-23 15:09:56 +00:00			`option argument`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`is a comma or whitespace separated set of increasing numbers and/or`
			`number ranges.`
			`Number ranges consist of a number, a dash`
Bring in use of strsep() to handle bad input better, and clean up some text. Obtained from: Merge from OpenBSD (cut.1 up to OpenBSD rev 1.3, cut.c up to OpenBSD rev 1.6) 1999-02-02 14:56:55 +00:00			`.Pq Sq \- ,`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`and a second number`
			`and select the fields or columns from the first number to the second,`
			`inclusive.`
			`Numbers or number ranges may be preceded by a dash, which selects all`
			`fields or columns from 1 to the first number.`
			`Numbers or number ranges may be followed by a dash, which selects all`
			`fields or columns from the last number to the end of the line.`
			`Numbers and number ranges may be repeated, overlapping, and in any order.`
			`It is not an error to select fields or columns not present in the`
			`input line.`
			`.Pp`
			`The options are as follows:`
Remove duplicate FreeBSD Id Remoce unused #include Use imperative mode to start flag description 2001-02-06 20:03:48 +00:00			`.Bl -tag -width indent`
Merge from NetBSD cut.1 rev 1.6 and cut.c rev 1.9, respectively. This makes us conform to IEEE Std1003.2-1992 (``POSIX.2''). Obtained from: NetBSD (but with slight modifications). 1999-02-02 14:26:39 +00:00			`.It Fl b Ar list`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`The`
Merge from NetBSD cut.1 rev 1.6 and cut.c rev 1.9, respectively. This makes us conform to IEEE Std1003.2-1992 (``POSIX.2''). Obtained from: NetBSD (but with slight modifications). 1999-02-02 14:26:39 +00:00			`.Ar list`
			`specifies byte positions.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl c Ar list`
			`The`
			`.Ar list`
			`specifies character positions.`
Use err(3) instead of local redefinition. Change argument name in man page to sync with usage string. 1997-06-30 06:48:46 +00:00			`.It Fl d Ar delim`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`Use the first character of`
Use err(3) instead of local redefinition. Change argument name in man page to sync with usage string. 1997-06-30 06:48:46 +00:00			`.Ar delim`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`as the field delimiter character instead of the tab character.`
			`.It Fl f Ar list`
			`The`
			`.Ar list`
			`specifies fields, delimited in the input by a single tab character.`
			`Output fields are separated by a single tab character.`
Merge from NetBSD cut.1 rev 1.6 and cut.c rev 1.9, respectively. This makes us conform to IEEE Std1003.2-1992 (``POSIX.2''). Obtained from: NetBSD (but with slight modifications). 1999-02-02 14:26:39 +00:00			`.It Fl n`
			`Do not split multi-byte characters.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl s`
Remove duplicate FreeBSD Id Remoce unused #include Use imperative mode to start flag description 2001-02-06 20:03:48 +00:00			`Suppress lines with no field delimiter characters.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`Unless specified, lines with no delimiters are passed through unmodified.`
			`.El`
Don't split multibyte characters when the -n option is specified. 2002-06-08 07:27:21 +00:00			`.Sh ENVIRONMENT`
			`The`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 10:51:47 +00:00			`.Ev LANG , LC_ALL`
Don't split multibyte characters when the -n option is specified. 2002-06-08 07:27:21 +00:00			`and`
			`.Ev LC_CTYPE`
Implement the -c option correctly in locales with multibyte characters instead of treating it as a synonym for -b. 2004-06-27 14:55:07 +00:00			`environment variables affect the execution of the`
Don't split multibyte characters when the -n option is specified. 2002-06-08 07:27:21 +00:00			`.Nm`
Implement the -c option correctly in locales with multibyte characters instead of treating it as a synonym for -b. 2004-06-27 14:55:07 +00:00			`utility.`
Don't split multibyte characters when the -n option is specified. 2002-06-08 07:27:21 +00:00			`Their effect is described in`
			`.Xr environ 7 .`
Add an examples section. Avoid beginning a sentence with a lowercase letter. 2002-06-08 08:37:27 +00:00			`.Sh EXAMPLES`
			`Extract users' login names and shells from the system`
			`.Xr passwd 5`
			`file as`
			`.Dq name:shell`
			`pairs:`
			`.Pp`
			`.Dl "cut -d : -f 1,7 /etc/passwd"`
			`.Pp`
			`Show the names and login times of the currently logged in users:`
			`.Pp`
			`.Dl "who \| cut -c 1-16,26-38"`
Move exit status info into Diagnostics section. 2002-05-30 00:46:00 +00:00			`.Sh DIAGNOSTICS`
			`.Ex -std`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh SEE ALSO`
			`.Xr paste 1`
			`.Sh STANDARDS`
			`The`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Merge from NetBSD cut.1 rev 1.6 and cut.c rev 1.9, respectively. This makes us conform to IEEE Std1003.2-1992 (``POSIX.2''). Obtained from: NetBSD (but with slight modifications). 1999-02-02 14:26:39 +00:00			`utility conforms to`
			`.St -p1003.2-92 .`
cut(1) appeared at least as early as System III. 2002-06-11 08:11:12 +00:00			`.Sh HISTORY`
			`A`
			`.Nm`
			`command appeared in`
			`.Tn AT&T`
			`System III`
			`.Ux .`
Document cut(1)'s deficiencies in dealing with multibyte characters in the BUGS section. These will be easy to fix when we have wide character stdio. 2002-06-08 08:08:47 +00:00			`.Sh BUGS`
			`When operating on fields`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 10:51:47 +00:00			`.Fl ( f`
			`option is specified),`
Document cut(1)'s deficiencies in dealing with multibyte characters in the BUGS section. These will be easy to fix when we have wide character stdio. 2002-06-08 08:08:47 +00:00			`.Nm`
			`does not recognise multibyte characters, and the`
			`.Ar delim`
			`character is recognised in the middle of multibyte sequences.`