summaryrefslogtreecommitdiffstats
path: root/doc/fileevent.n
diff options
context:
space:
mode:
authorandreas_kupries <akupries@shaw.ca>2001-09-14 19:20:39 (GMT)
committerandreas_kupries <akupries@shaw.ca>2001-09-14 19:20:39 (GMT)
commite670c6f17e7ac704c3c6f117912e45313254d4d9 (patch)
tree601c942962a61099835ec8cca4eb537578460b9d /doc/fileevent.n
parent1aa543f158267b3810d76b69186f8aa94aec2c84 (diff)
downloadtcl-e670c6f17e7ac704c3c6f117912e45313254d4d9.zip
tcl-e670c6f17e7ac704c3c6f117912e45313254d4d9.tar.gz
tcl-e670c6f17e7ac704c3c6f117912e45313254d4d9.tar.bz2
* doc/gets.n:
* doc/read.n: * doc/puts.n: * doc/flush.n: * doc/fconfigure.n: * doc/flush.n: * doc/eof.n: * doc/seek.n: * doc/tell.n: * doc/close.n: * doc/fileevent.n: Added references to the Tcl standard channels. Item [219250], reported by David LeBlanc <whisper@oz.net>. Thanks to Christopher Nelson <chris@pinebush.com> for doing editorial work.
Diffstat (limited to 'doc/fileevent.n')
-rw-r--r--doc/fileevent.n15
1 files changed, 10 insertions, 5 deletions
diff --git a/doc/fileevent.n b/doc/fileevent.n
index f5b6b1f..037d361 100644
--- a/doc/fileevent.n
+++ b/doc/fileevent.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: fileevent.n,v 1.3 2000/09/07 14:27:47 poenitz Exp $
+'\" RCS: @(#) $Id: fileevent.n,v 1.4 2001/09/14 19:20:40 andreas_kupries Exp $
'\"
.so man.macros
.TH fileevent n 7.5 Tcl "Tcl Built-In Commands"
@@ -34,9 +34,14 @@ appear to the user to ``freeze up''. With \fBfileevent\fR, the process can
tell when data is present and only invoke \fBgets\fR or \fBread\fR when
they won't block.
.PP
-The \fIchannelId\fR argument to \fBfileevent\fR refers to an open channel,
-such as the return value from a previous \fBopen\fR or \fBsocket\fR
-command.
+.VS
+The \fIchannelId\fR argument to \fBfileevent\fR refers to 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
+.PP
If the \fIscript\fR argument is specified, then \fBfileevent\fR
creates a new event handler: \fIscript\fR will be evaluated
whenever the channel becomes readable or writable (depending on the
@@ -102,7 +107,7 @@ buggy handlers.
by Mark Diekhans.
.SH "SEE ALSO"
-bgerror(n), fconfigure(n), gets(n), puts(n), read(n)
+bgerror(n), fconfigure(n), gets(n), puts(n), read(n), Tcl_StandardChannels(3)
.SH KEYWORDS
asynchronous I/O, blocking, channel, event handler, nonblocking, readable,