diff options
Diffstat (limited to 'doc/close.n')
| -rw-r--r-- | doc/close.n | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/close.n b/doc/close.n index 86b07ca..501d282 100644 --- a/doc/close.n +++ b/doc/close.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: close.n,v 1.3 2000/09/07 14:27:46 poenitz Exp $ +'\" RCS: @(#) $Id: close.n,v 1.4 2001/09/14 19:20:40 andreas_kupries Exp $ '\" .so man.macros .TH close n 7.5 Tcl "Tcl Built-In Commands" @@ -19,9 +19,15 @@ close \- Close an open channel. .SH DESCRIPTION .PP -Closes the channel given by \fIchannelId\fR. \fIChannelId\fR must be a -channel identifier such as the return value from a previous \fBopen\fR -or \fBsocket\fR command. +Closes the channel given by \fIchannelId\fR. +.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 +.PP All buffered output is flushed to the channel's output device, any buffered input is discarded, the underlying file or device is closed, and \fIchannelId\fR becomes unavailable for use. @@ -56,7 +62,7 @@ The command returns an empty string, and may generate an error if an error occurs while flushing output. .SH "SEE ALSO" -file(n), open(n), socket(n), eof(n) +file(n), open(n), socket(n), eof(n), Tcl_StandardChannels(3) .SH KEYWORDS blocking, channel, close, nonblocking |