diff options
Diffstat (limited to 'doc/close.n')
| -rw-r--r-- | doc/close.n | 8 |
1 files changed, 1 insertions, 7 deletions
diff --git a/doc/close.n b/doc/close.n index a1c5f01..4ef3c7d 100644 --- a/doc/close.n +++ b/doc/close.n @@ -10,7 +10,7 @@ .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -close \- Close an open channel. +close \- Close an open channel .SH SYNOPSIS \fBclose \fIchannelId\fR .BE @@ -19,17 +19,14 @@ close \- Close an open channel. .PP 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. -.VS "" br .PP If the channel is blocking, the command does not return until all output is flushed. @@ -37,11 +34,9 @@ If the channel is nonblocking and there is unflushed output, the channel remains open and the command returns immediately; output will be flushed in the background and the channel will be closed when all the flushing is complete. -.VE .PP If \fIchannelId\fR is a blocking channel for a command pipeline then \fBclose\fR waits for the child processes to complete. -.VS "" br .PP If the channel is shared between interpreters, then \fBclose\fR makes \fIchannelId\fR unavailable in the invoking interpreter but has no @@ -54,7 +49,6 @@ When the last interpreter in which the channel is registered invokes Channels are automatically closed when an interpreter is destroyed and when the process exits. Channels are switched to blocking mode, to ensure that all output is correctly flushed before the process exits. -.VE .PP The command returns an empty string, and may generate an error if an error occurs while flushing output. If a command in a command |