summaryrefslogtreecommitdiffstats
path: root/doc/refchan.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/refchan.n')
-rw-r--r--doc/refchan.n18
1 files changed, 12 insertions, 6 deletions
diff --git a/doc/refchan.n b/doc/refchan.n
index 04b0785..89bef8f 100644
--- a/doc/refchan.n
+++ b/doc/refchan.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: refchan.n,v 1.5 2007/02/18 18:42:55 dkf Exp $
+'\" RCS: @(#) $Id: refchan.n,v 1.6 2007/10/25 09:44:22 dkf Exp $
.so man.macros
.TH reflectedchan n 8.5 Tcl "Tcl Built-In Commands"
.BS
@@ -53,8 +53,11 @@ here, then the \fBfinalize\fR subcommand will not be called.
.PP
The \fImode\fR argument tells the handler whether the channel was
opened for reading, writing, or both. It is a list containing any of
-the strings "\fBread\fR" or "\fBwrite\fR". The list will always
-contain at least one element.
+the strings
+.QW "\fBread\fR"
+or
+.QW "\fBwrite\fR" .
+The list will always contain at least one element.
.PP
The subcommand must throw an error if the chosen mode is not
supported by the \fIcmdPrefix\fR.
@@ -86,8 +89,11 @@ aborted during \fBinitialize\fR (See above).
.
This subcommand notifies the \fIcmdPrefix\fR that the specified
\fIchannelId\fR is interested in the events listed in the
-\fIeventspec\fR. This argument is a list containing any of "\fBread\fR"
-and "\fBwrite\fR". The list may be empty, which signals that the
+\fIeventspec\fR. This argument is a list containing any of
+.QW "\fBread\fR"
+and
+.QW "\fBwrite\fR" .
+The list may be empty, which signals that the
channel does not wish to be notified of any events. In that situation,
the handler should disable event generation completely.
.RS
@@ -185,7 +191,7 @@ invocation (usually \fBseek\fR, or \fBtell\fR) will appear to have
thrown this error. Any exception beyond \fIerror\fR (e.g. \fIbreak\fR,
etc.) is treated as and converted to an error.
.PP
-The offset/base combination of 0/"\fBcurrent\fR" signals a \fBtell\fR
+The offset/base combination of 0/\fBcurrent\fR signals a \fBtell\fR
request, i.e. seek nothing relative to the current location, making
the new location identical to the current one, which is then returned.
.RE