summaryrefslogtreecommitdiffstats
path: root/doc/flush.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/flush.n')
-rw-r--r--doc/flush.n29
1 files changed, 3 insertions, 26 deletions
diff --git a/doc/flush.n b/doc/flush.n
index 1d84383..57c1c67 100644
--- a/doc/flush.n
+++ b/doc/flush.n
@@ -16,33 +16,10 @@ flush \- Flush buffered output for a channel
.BE
.SH DESCRIPTION
.PP
-Flushes any output that has been buffered for \fIchannelId\fR.
-.PP
-\fIChannelId\fR must be an identifier for an open channel such as a
-Tcl standard channel (\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. The
-channel must have been opened for writing.
-.PP
-If the channel is in blocking mode the command does not return until all the
-buffered output has been flushed to the channel. If the channel is in
-nonblocking mode, the command may return before all buffered output has been
-flushed; the remainder will be flushed in the background as fast as the
-underlying file or device is able to absorb it.
-.SH EXAMPLE
-.PP
-Prompt for the user to type some information in on the console:
-.PP
-.CS
-puts -nonewline "Please type your name: "
-\fBflush\fR stdout
-gets stdin name
-puts "Hello there, $name!"
-.CE
+The \fBflush\fR command has been superceded by the \fBchan flush\fR
+command and supports the same syntax and options.
.SH "SEE ALSO"
-file(n), open(n), socket(n), Tcl_StandardChannels(3)
-.SH KEYWORDS
-blocking, buffer, channel, flush, nonblocking, output
+chan(n)
'\" Local Variables:
'\" mode: nroff
'\" fill-column: 78