summaryrefslogtreecommitdiffstats
path: root/doc/chan.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2006-05-23 15:35:01 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2006-05-23 15:35:01 (GMT)
commitcddc896fb5c3b992f549072e61acc000d912e3b6 (patch)
treeadcf929ea6991fafdcdb826db86e01a41776ccfd /doc/chan.n
parente536a582d0f19342df23dd5b267573cfe9158935 (diff)
downloadtcl-cddc896fb5c3b992f549072e61acc000d912e3b6.zip
tcl-cddc896fb5c3b992f549072e61acc000d912e3b6.tar.gz
tcl-cddc896fb5c3b992f549072e61acc000d912e3b6.tar.bz2
Minor doc improvements
Diffstat (limited to 'doc/chan.n')
-rw-r--r--doc/chan.n10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/chan.n b/doc/chan.n
index 73d9c09..cc6eec3 100644
--- a/doc/chan.n
+++ b/doc/chan.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: chan.n,v 1.3 2006/03/17 17:24:10 andreas_kupries Exp $
+'\" RCS: @(#) $Id: chan.n,v 1.4 2006/05/23 15:35:02 dkf Exp $
.so man.macros
.TH chan n 8.5 Tcl "Tcl Built-In Commands"
.BS
@@ -493,11 +493,11 @@ Produces a list of all channel names. If \fIpattern\fR is specified,
only those channel names that match it (according to the rules of
\fBstring match\fR) will be returned.
.TP
-\fBchan postevent \fIchannel eventspec\fR
+\fBchan postevent \fIchannelId eventSpec\fR
.
This subcommand is used by command handlers specified with \fBchan
create\fR. It notifies the channel represented by the handle
-\fIchannel\fR that the event(s) listed in the \fIeventspec\fR have
+\fIchannelId\fR that the event(s) listed in the \fIeventSpec\fR have
occurred. The argument has to be a list containing any of the strings
"\fBread\fR" and "\fBwrite\fR". The list must contain at least one
element as it does not make sense to invoke the command if there are
@@ -606,12 +606,12 @@ most serial ports are comparatively slow; it is entirely possible to
get a \fBreadable\fR event for each character read from them. Care
must be taken when using \fBchan read\fR on blocking serial ports:
.TP
-\fBchan read \fIchannelId numChars\fR
+\fBchan read \fIchannelId numChars\fR
.
In this form \fBchan read\fR blocks until \fInumChars\fR have been
received from the serial port.
.TP
-\fBchan read \fIchannelId\fR
+\fBchan read \fIchannelId\fR
.
In this form \fBchan read\fR blocks until the reception of the
end-of-file character, see \fBchan configure -eofchar\fR. If there no