Attachment "219250.diff" to
ticket [219250ffff]
added by
andreas_kupries
2001-09-14 06:00:41.
Index: ChangeLog
===================================================================
RCS file: /cvsroot/tcl/tcl/ChangeLog,v
retrieving revision 1.610
diff -u -r1.610 ChangeLog
--- ChangeLog 2001/09/13 19:58:35 1.610
+++ ChangeLog 2001/09/13 22:59:31
@@ -1,3 +1,19 @@
+2001-09-13 Andreas Kupries <[email protected]>
+
+ * 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
+ <[email protected]>.
+
2001-09-13 Jeff Hobbs <[email protected]>
* ChangeLog.1999:
Index: doc/close.n
===================================================================
RCS file: /cvsroot/tcl/tcl/doc/close.n,v
retrieving revision 1.3
diff -u -r1.3 close.n
--- doc/close.n 2000/09/07 14:27:46 1.3
+++ doc/close.n 2001/09/13 22:59:31
@@ -19,9 +19,14 @@
.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
+\fIChannelId\fR must be a channel identifier such as returned from a
+previous invocation of \fBopen\fR, \fBsocket\fR, or any other channel
+creation command provided by a loaded extension. The tcl standard
+channels (\fBstdin\fR, \fBstdout\fR, and \fBstderr\fR) are also
+allowed here.
+.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.
Index: doc/eof.n
===================================================================
RCS file: /cvsroot/tcl/tcl/doc/eof.n,v
retrieving revision 1.3
diff -u -r1.3 eof.n
--- doc/eof.n 2000/09/07 14:27:47 1.3
+++ doc/eof.n 2001/09/13 22:59:31
@@ -22,6 +22,12 @@
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
+\fIChannelId\fR must be a channel identifier such as returned from a
+previous invocation of \fBopen\fR, \fBsocket\fR, or any other channel
+creation command provided by a loaded extension. The tcl standard
+channels (\fBstdin\fR, \fBstdout\fR, and \fBstderr\fR) are also
+allowed here.
.SH "SEE ALSO"
file(n), open(n), close(n), fblocked(n)
Index: doc/fblocked.n
===================================================================
RCS file: /cvsroot/tcl/tcl/doc/fblocked.n,v
retrieving revision 1.3
diff -u -r1.3 fblocked.n
--- doc/fblocked.n 2000/09/07 14:27:47 1.3
+++ doc/fblocked.n 2001/09/13 22:59:31
@@ -25,6 +25,12 @@
returns an empty string and a subsequent call to \fBfblocked\fR will
return 1.
.PP
+\fIChannelId\fR must be a channel identifier such as returned from a
+previous invocation of \fBopen\fR, \fBsocket\fR, or any other channel
+creation command provided by a loaded extension. The tcl standard
+channels (\fBstdin\fR, \fBstdout\fR, and \fBstderr\fR) are also
+allowed here.
+.PP
.SH "SEE ALSO"
gets(n), open(n), read(n)
Index: doc/fconfigure.n
===================================================================
RCS file: /cvsroot/tcl/tcl/doc/fconfigure.n,v
retrieving revision 1.4
diff -u -r1.4 fconfigure.n
--- doc/fconfigure.n 1999/07/07 18:59:52 1.4
+++ doc/fconfigure.n 2001/09/13 22:59:31
@@ -192,8 +192,18 @@
.RE
.PP
+.SH "STANDARD CHANNELS"
+.PP
+The tcl standard channels (\fBstdin\fR, \fBstdout\fR, and
+\fBstderr\fR) can be configured through this command like every other
+channel opened by the tcl library. Beyond the standard options
+described above they will also support any special option according to
+their current type. If, for example, a tcl application is started by
+the \fBinet\fR super-server common on Unix system its tcl standard
+channels will be sockets and support the socket options.
+
.SH "SEE ALSO"
-close(n), flush(n), gets(n), puts(n), read(n), socket(n)
+close(n), flush(n), gets(n), puts(n), read(n), socket(n), Tcl_StandardChannels(3)
.SH KEYWORDS
blocking, buffering, carriage return, end of line, flushing, linemode,
Index: doc/fileevent.n
===================================================================
RCS file: /cvsroot/tcl/tcl/doc/fileevent.n,v
retrieving revision 1.3
diff -u -r1.3 fileevent.n
--- doc/fileevent.n 2000/09/07 14:27:47 1.3
+++ doc/fileevent.n 2001/09/13 22:59:31
@@ -34,9 +34,12 @@
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.
+The \fIchannelId\fR argument to \fBfileevent\fR refers to an open
+channel, such as returned from a previous invocation of \fBopen\fR,
+\fBsocket\fR, or any other channel creation command provided by a
+loaded extension. The tcl standard channels (\fBstdin\fR,
+\fBstdout\fR, and \fBstderr\fR) are also allowed here.
+.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
Index: doc/flush.n
===================================================================
RCS file: /cvsroot/tcl/tcl/doc/flush.n,v
retrieving revision 1.3
diff -u -r1.3 flush.n
--- doc/flush.n 2000/09/07 14:27:48 1.3
+++ doc/flush.n 2001/09/13 22:59:31
@@ -21,7 +21,11 @@
.PP
Flushes any output that has been buffered for \fIchannelId\fR.
\fIChannelId\fR must be a channel identifier such as returned by a previous
-\fBopen\fR or \fBsocket\fR command, and it must have been opened for writing.
+\fBopen\fR or \fBsocket\fR command, or any other channel
+creation command provided by a loaded extension. The tcl standard
+channels \fBstdout\fR and \fBstderr\fR are also allowed here. 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
Index: doc/gets.n
===================================================================
RCS file: /cvsroot/tcl/tcl/doc/gets.n,v
retrieving revision 1.3
diff -u -r1.3 gets.n
--- doc/gets.n 2000/09/07 14:27:48 1.3
+++ doc/gets.n 2001/09/13 22:59:31
@@ -22,6 +22,13 @@
This command reads the next line from \fIchannelId\fR, returns everything
in the line up to (but not including) the end-of-line character(s), and
discards the end-of-line character(s).
+.PP
+\fIChannelId\fR must be a channel identifier such as returned from a
+previous invocation of \fBopen\fR, \fBsocket\fR, or any other channel
+creation command provided by a loaded extension. The tcl standard
+channel \fBstdin\fR is also allowed here. The channel must have been
+opened for input.
+.PP
If \fIvarName\fR is omitted the line is returned as the result of the
command.
If \fIvarName\fR is specified then the line is placed in the variable by
Index: doc/puts.n
===================================================================
RCS file: /cvsroot/tcl/tcl/doc/puts.n,v
retrieving revision 1.4
diff -u -r1.4 puts.n
--- doc/puts.n 2000/09/07 14:27:50 1.4
+++ doc/puts.n 2001/09/13 22:59:31
@@ -21,12 +21,15 @@
.PP
Writes the characters given by \fIstring\fR to the channel given
by \fIchannelId\fR.
+.PP
\fIChannelId\fR must be a channel identifier such as returned from a
-previous invocation of \fBopen\fR or \fBsocket\fR. It must have been opened
-for output. If no \fIchannelId\fR is specified then it defaults to
-\fBstdout\fR. \fBPuts\fR normally outputs a newline character after
-\fIstring\fR, but this feature may be suppressed by specifying the
-\fB\-nonewline\fR switch.
+previous invocation of \fBopen\fR, \fBsocket\fR, or any other channel
+creation command provided by a loaded extension. The tcl standard
+channels \fBstdout\fR and \fBstderr\fR are also allowed here. The
+channel must have been opened for output. If no \fIchannelId\fR is
+specified then it defaults to \fBstdout\fR. \fBPuts\fR normally
+outputs a newline character after \fIstring\fR, but this feature may
+be suppressed by specifying the \fB\-nonewline\fR switch.
.PP
Newline characters in the output are translated by \fBputs\fR to
platform-specific end-of-line sequences according to the current
Index: doc/read.n
===================================================================
RCS file: /cvsroot/tcl/tcl/doc/read.n,v
retrieving revision 1.6
diff -u -r1.6 read.n
--- doc/read.n 2001/04/06 14:27:51 1.6
+++ doc/read.n 2001/09/13 22:59:31
@@ -32,6 +32,12 @@
number of characters read may not be the same as the number of bytes
read.
.PP
+\fIChannelId\fR must be a channel identifier such as returned from a
+previous invocation of \fBopen\fR, \fBsocket\fR, or any other channel
+creation command provided by a loaded extension. The tcl standard
+channel \fBstdin\fR is also allowed here. The channel must have been
+opened for input.
+.PP
If \fIchannelId\fR is in nonblocking mode, the command may not read as
many characters as requested: once all available input has been read,
the command will return the data that is available rather than
Index: doc/seek.n
===================================================================
RCS file: /cvsroot/tcl/tcl/doc/seek.n,v
retrieving revision 1.4
diff -u -r1.4 seek.n
--- doc/seek.n 2000/09/07 14:27:51 1.4
+++ doc/seek.n 2001/09/13 22:59:31
@@ -20,8 +20,13 @@
.SH DESCRIPTION
.PP
Changes the current access position for \fIchannelId\fR.
+.PP
\fIChannelId\fR must be a channel identifier such as returned from a
-previous invocation of \fBopen\fR or \fBsocket\fR.
+previous invocation of \fBopen\fR, \fBsocket\fR, or any other channel
+creation command provided by a loaded extension. The tcl standard
+channels (\fBstdin\fR, \fBstdout\fR, and \fBstderr\fR) are also
+allowed here.
+.PP
The \fIoffset\fR and \fIorigin\fR
arguments specify the position at which the next read or write will occur
for \fIchannelId\fR. \fIOffset\fR must be an integer (which may be
Index: doc/tell.n
===================================================================
RCS file: /cvsroot/tcl/tcl/doc/tell.n,v
retrieving revision 1.4
diff -u -r1.4 tell.n
--- doc/tell.n 2000/09/07 14:27:52 1.4
+++ doc/tell.n 2001/09/13 22:59:31
@@ -27,6 +27,12 @@
.VE 8.1
The value returned is -1 for channels that do not support
seeking.
+.PP
+\fIChannelId\fR must be a channel identifier such as returned from a
+previous invocation of \fBopen\fR, \fBsocket\fR, or any other channel
+creation command provided by a loaded extension. The tcl standard
+channels (\fBstdin\fR, \fBstdout\fR, and \fBstderr\fR) are also
+allowed here.
.SH "SEE ALSO"
file(n), open(n), close(n), gets(n), seek(n)
