diff options
author | andreas_kupries <akupries@shaw.ca> | 2001-09-14 19:20:39 (GMT) |
---|---|---|
committer | andreas_kupries <akupries@shaw.ca> | 2001-09-14 19:20:39 (GMT) |
commit | e670c6f17e7ac704c3c6f117912e45313254d4d9 (patch) | |
tree | 601c942962a61099835ec8cca4eb537578460b9d /doc/fconfigure.n | |
parent | 1aa543f158267b3810d76b69186f8aa94aec2c84 (diff) | |
download | tcl-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/fconfigure.n')
-rw-r--r-- | doc/fconfigure.n | 27 |
1 files changed, 23 insertions, 4 deletions
diff --git a/doc/fconfigure.n b/doc/fconfigure.n index 77b8ec2..7689d20 100644 --- a/doc/fconfigure.n +++ b/doc/fconfigure.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: fconfigure.n,v 1.4 1999/07/07 18:59:52 stanton Exp $ +'\" RCS: @(#) $Id: fconfigure.n,v 1.5 2001/09/14 19:20:40 andreas_kupries Exp $ '\" .so man.macros .TH fconfigure n 8.1 Tcl "Tcl Built-In Commands" @@ -19,11 +19,18 @@ fconfigure \- Set and get options on a channel \fBfconfigure \fIchannelId\fR \fIname value \fR?\fIname value ...\fR? .fi .BE - .SH DESCRIPTION .PP The \fBfconfigure\fR command sets and retrieves options for channels. -\fIChannelId\fR identifies the channel for which to set or query an option. +.PP +.VS +\fIChannelId\fR identifies the channel for which to set or query an +option and must refer 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 no \fIname\fR or \fIvalue\fR arguments are supplied, the command returns a list containing alternating option names and values for the channel. If \fIname\fR is supplied but no \fIvalue\fR then the command returns @@ -192,8 +199,20 @@ platforms. .RE .PP +.VS +.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 thus support the socket options. +.VE + .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, |