Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Copyright 1989 AT&T
Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures
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
http://www.opengroup.org/bookstore/.
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.
This notice shall appear on any product containing this material.
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.
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.
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]
/usr/bin/read [-r] var...
read name...
set variable= $<
read [-prsu [n]] [name ? prompt] [name]...
read [-Aprs] [-d delim] [-n nsize] [-N nsize] [-t timeout][-u unit] [vname?prompt] [vname... ]
The read utility reads a single line from standard input.
By default, unless the -r option is specified, backslash (\e) acts as an escape character. If standard input is a terminal device and the invoking shell is interactive, read prompts for a continuation line when:
The shell reads an input line ending with a backslash, unless the -r option is specified.
A here-document is not terminated after a NEWLINE character is entered.
The line is split into fields as in the shell. The first field is assigned to the first variable var, the second field to the second variable var, and so forth. If there are fewer var operands specified than there are fields, the leftover fields and their intervening separators is assigned to the last var. If there are fewer fields than vars, the remaining vars is set to empty strings.
The setting of variables specified by the var operands affects the current shell execution environment. If it is called in a sub-shell or separate utility execution environment, such as one of the following:
(read foo)
nohup read ...
find . -exec read ... \e;
it does not affect the shell variables in the caller's environment.
The standard input must be a text file.
One line is read from the standard input and, using the internal field separator, IFS (normally space or tab), to delimit word boundaries, the first word is assigned to the first name, the second word to the second name, and so on, with leftover words assigned to the last name. Lines can be continued using \enewline. Characters other than NEWLINE can be quoted by preceding them with a backslash. These backslashes are removed before words are assigned to names, and no interpretation is done on the character that follows the backslash. The return code is 0, unless an end-of-file is encountered.
The notation:
set variable = $<
loads one line of standard input as the value for variable. (See csh(1)).
The shell input mechanism. One line is read and is broken up into fields using the characters in IFS as separators. The escape character, (\e), is used to remove any special meaning for the next character and for line continuation. In raw mode, the -r, the , and the \e character are not treated specially. The first field is assigned to the first name, the second field to the second name, and so on, with leftover fields assigned to the last name. The -p option causes the input line to be taken from the input pipe of a process spawned by the shell using |&. If the -s flag is present, the input is saved as a command in the history file. The flag -u can be used to specify a one digit file descriptor unit n to read from. The file descriptor can be opened with the exec special command. The default value of n is 0. If name is omitted, REPLY is used as the default name. The exit status is 0 unless the input file is not open for reading or an end-of-file is encountered. An end-of-file with the -p option causes cleanup for this process so that another can be spawned. If the first argument contains a ?, the remainder of this word is used as a prompt on standard error when the shell is interactive. The exit status is 0 unless an end-of-file is encountered.
read reads a line from standard input and breaks it into fields using the characters in the value of the IFS variable as separators. The escape character, \e, is used to remove any special meaning for the next character and for line continuation unless the -r option is specified.
If there are more variables than fields, the remaining variables are set to empty strings. If there are fewer variables than fields, the leftover fields and their intervening separators are assigned to the last variable. If no var is specified, the variable REPLY is used.
When var has the binary attribute and -n or -N is specified, the bytes that are read are stored directly into var.
If you specify ?prompt after the first var, read displays a prompt on standard error when standard input is a terminal or pipe.
The following option is supported by /usr/bin/read and ksh:
-r
Do not treat a backslash character in any special way. Considers each backslash to be part of the input line.
The following options are supported by ksh93:
-A
Unset var, and create an indexed array containing each field in the line starting at index 0.
-d delim
Read until delimiter delim instead of to the end of line.
-n nsize
Read at most nsize bytes. Binary field size is in bytes.
-N nsize
Read exactly nsize bytes. Binary field size is in bytes.
-p
Read from the current co-process instead of standard input. An end of file causes read to disconnect the co-process so that another can be created.
-r
Do not treat \e specially when processing the input line.
-s
Save a copy of the input as an entry in the shell history file.
-t timeout
Specify a timeout in seconds when reading from a terminal or pipe.
-u fd
Read from file descriptor number fd instead of standard input. The default value is 0.
-v
When reading from a terminal, display the value of the first variable and use it as a default value.
The following operand is supported:
var
The name of an existing or non-existing shell variable.
Example 1 Using the read Command
The following example for /usr/bin/read prints a file with the first field of each line moved to the end of the line:
example% while read -r xx yy
do
printf "%s %s\en" "$yy" "$xx"
done < input_file
See environ(5) for descriptions of the following environment variables that affect the execution of read: LANG, LC_ALL, LC_CTYPE, LC_MESSAGES, and NLSPATH.
IFS
Determines the internal field separators used to delimit fields.
PS2
Provides the prompt string that an interactive shell writes to standard error when a line ending with a backslash is read and the -r option was not specified, or if a here-document is not terminated after a NEWLINE character is entered.
The following exit values are returned:
0
Successful completion.
>0
End-of-file was detected or an error occurred.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
| Interface Stability | Committed |
| Standard | See standards(5). |
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
| Interface Stability | Uncommitted |
csh(1), ksh(1), ksh93(1), line(1), set(1), sh(1), attributes(5), environ(5), standards(5)