From 62a236fa8f71da3cdeb93b771342fb48fc7c31e1 Mon Sep 17 00:00:00 2001 From: dkf Date: Thu, 25 Oct 2007 09:38:45 +0000 Subject: GOOBE for command results in examples --- doc/refchan.n | 18 ++++++++++++------ doc/source.n | 6 ++---- 2 files changed, 14 insertions(+), 10 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 diff --git a/doc/source.n b/doc/source.n index 353beb3..283e5e4 100644 --- a/doc/source.n +++ b/doc/source.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: source.n,v 1.11 2007/10/24 14:29:39 dkf Exp $ +'\" RCS: @(#) $Id: source.n,v 1.12 2007/10/25 09:38:45 dkf Exp $ '\" .so man.macros .TH source n "" Tcl "Tcl Built-In Commands" @@ -21,7 +21,6 @@ source \- Evaluate a file or resource as a Tcl script \fBsource\fR \fB\-encoding \fIencodingName fileName\fR .VE 8.5 .BE - .SH DESCRIPTION .PP This command takes the contents of the specified file or resource @@ -59,15 +58,14 @@ file \fBbar.tcl\fR: \fBsource\fR foo.tcl \fBsource\fR bar.tcl .CE +.PP Alternatively: .CS foreach scriptFile {foo.tcl bar.tcl} { \fBsource\fR $scriptFile } .CE - .SH "SEE ALSO" file(n), cd(n), encoding(n), info(n) - .SH KEYWORDS file, script -- cgit v0.12