summaryrefslogtreecommitdiffstats
path: root/doc/CrtChannel.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-09-06 09:44:56 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-09-06 09:44:56 (GMT)
commit0e5952c887bd1c44ce8a13516659d6e763a2d381 (patch)
treef3df18b7b55fef1a57dbdfd4b3b9d48ee8923f16 /doc/CrtChannel.3
parente61f35c191941709a727ae6128a43b24a0ee5bff (diff)
downloadtcl-0e5952c887bd1c44ce8a13516659d6e763a2d381.zip
tcl-0e5952c887bd1c44ce8a13516659d6e763a2d381.tar.gz
tcl-0e5952c887bd1c44ce8a13516659d6e763a2d381.tar.bz2
More documentation fixes from Mikhail Kolesnitchenko. [Patch 1022527]
Diffstat (limited to 'doc/CrtChannel.3')
-rw-r--r--doc/CrtChannel.317
1 files changed, 9 insertions, 8 deletions
diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3
index e601a21..3356c9c 100644
--- a/doc/CrtChannel.3
+++ b/doc/CrtChannel.3
@@ -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: CrtChannel.3,v 1.18 2004/09/01 09:50:45 dkf Exp $
+'\" RCS: @(#) $Id: CrtChannel.3,v 1.19 2004/09/06 09:44:56 dkf Exp $
.so man.macros
.TH Tcl_CreateChannel 3 8.3 Tcl "Tcl Library Procedures"
.BS
@@ -261,8 +261,9 @@ occurred on the channel. Channel drivers are responsible for invoking
this function whenever the channel handlers need to be called for the
channel. See \fBWATCHPROC\fR below for more details.
.PP
-\fBTcl_BadChannelOption\fR is called from driver specific set or get option
-procs to generate a complete error message.
+\fBTcl_BadChannelOption\fR is called from driver specific
+\fIsetOptionProc\fR or \fIgetOptionProc\fR to generate a complete
+error message.
.PP
\fBTcl_ChannelBuffered\fR returns the number of bytes of input
currently buffered in the internal buffer (push back area) of the
@@ -463,9 +464,9 @@ return a nonzero POSIX error code. In addition, if an error occurs and
\fIinterp\fR is not NULL, the procedure should store an error message
in the interpreter's result.
.PP
-These value can be retrieved with \fBTcl_ChannelCloseProc\fR or
-\fBTcl_ChannelClose2Proc\fR, which returns a pointer to the respective
-function.
+The \fIcloseProc\fR and \fIclose2Proc\fR values can be retrieved with
+\fBTcl_ChannelCloseProc\fR or \fBTcl_ChannelClose2Proc\fR, which
+return a pointer to the respective function.
.SH INPUTPROC
.PP
@@ -790,14 +791,14 @@ a pointer to the function.
.PP
This procedure generates a "bad option" error message in an
(optional) interpreter. It is used by channel drivers when
-a invalid Set/Get option is requested. Its purpose is to concatenate
+an invalid Set/Get option is requested. Its purpose is to concatenate
the generic options list to the specific ones and factorize
the generic options error message string.
.PP
It always return \fBTCL_ERROR\fR
.PP
An error message is generated in \fIinterp\fR's result object to
-indicate that a command was invoked with the a bad option
+indicate that a command was invoked with a bad option.
The message has the form
.CS
bad option "blah": should be one of