62 lines
2.5 KiB
Plaintext
62 lines
2.5 KiB
Plaintext
'\"
|
|
'\" Copyright (c) 1993 The Regents of the University of California.
|
|
'\" All rights reserved.
|
|
'\"
|
|
'\" Permission is hereby granted, without written agreement and without
|
|
'\" license or royalty fees, to use, copy, modify, and distribute this
|
|
'\" documentation for any purpose, provided that the above copyright
|
|
'\" notice and the following two paragraphs appear in all copies.
|
|
'\"
|
|
'\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
|
|
'\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
|
|
'\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
|
|
'\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
'\"
|
|
'\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
|
|
'\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
'\" AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
|
|
'\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
|
|
'\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
|
|
'\"
|
|
'\" $Header: /user6/ouster/tcl/man/RCS/gets.n,v 1.2 93/10/04 16:01:09 ouster Exp $ SPRITE (Berkeley)
|
|
'\"
|
|
.so man.macros
|
|
.HS gets tcl
|
|
.BS
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
|
.SH NAME
|
|
gets \- Read a line from a file
|
|
.SH SYNOPSIS
|
|
\fBgets \fIfileId\fR ?\fIvarName\fR?
|
|
.BE
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
This command reads the next line from the file given by \fIfileId\fR
|
|
and discards the terminating newline character.
|
|
If \fIvarName\fR is specified then the line is placed in the variable
|
|
by that name and the return value is a count of the number of characters
|
|
read (not including the newline).
|
|
If the end of the file is reached before reading
|
|
any characters then \-1 is returned and \fIvarName\fR is set to an
|
|
empty string.
|
|
If \fIvarName\fR is not specified then the return value will be
|
|
the line (minus the newline character) or an empty string if
|
|
the end of the file is reached before reading any characters.
|
|
An empty string will also be returned if a line contains no characters
|
|
except the newline, so \fBeof\fR may have to be used to determine
|
|
what really happened.
|
|
If the last character in the file is not a newline character then
|
|
\fBgets\fR behaves as if there were an additional newline character
|
|
at the end of the file.
|
|
\fIFileId\fR must be \fBstdin\fR or the return value from a previous
|
|
call to \fBopen\fR; it must refer to a file that was opened
|
|
for reading.
|
|
.VS
|
|
Any existing end-of-file or error condition on the file is cleared at
|
|
the beginning of the \fBgets\fR command.
|
|
.VE
|
|
|
|
.SH KEYWORDS
|
|
file, line, read
|