summaryrefslogtreecommitdiff
path: root/tcl/doc/eof.n
diff options
context:
space:
mode:
Diffstat (limited to 'tcl/doc/eof.n')
-rw-r--r--tcl/doc/eof.n10
1 files changed, 10 insertions, 0 deletions
diff --git a/tcl/doc/eof.n b/tcl/doc/eof.n
index f1435f7f818..0f59574322b 100644
--- a/tcl/doc/eof.n
+++ b/tcl/doc/eof.n
@@ -22,6 +22,16 @@ eof \- Check for end of file condition on channel
Returns 1 if an end of file condition occurred during the most
recent input operation on \fIchannelId\fR (such as \fBgets\fR),
0 otherwise.
+.PP
+.VS
+\fIChannelId\fR must be an identifier for an open channel such as a
+Tcl standard channel (\fBstdin\fR, \fBstdout\fR, or \fBstderr\fR),
+the return value from an invocation of \fBopen\fR or \fBsocket\fR, or
+the result of a channel creation command provided by a Tcl extension.
+.VE
+
+.SH "SEE ALSO"
+file(n), open(n), close(n), fblocked(n), Tcl_StandardChannels(3)
.SH KEYWORDS
channel, end of file