diff options
Diffstat (limited to 'doc/source.n')
| -rw-r--r-- | doc/source.n | 40 |
1 files changed, 22 insertions, 18 deletions
diff --git a/doc/source.n b/doc/source.n index 6469286..82fefa6 100644 --- a/doc/source.n +++ b/doc/source.n @@ -5,11 +5,9 @@ '\" '\" 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.10 2004/10/27 14:24:37 dkf Exp $ -'\" -.so man.macros +'\" .TH source n "" Tcl "Tcl Built-In Commands" +.so man.macros .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME @@ -17,11 +15,8 @@ source \- Evaluate a file or resource as a Tcl script .SH SYNOPSIS \fBsource \fIfileName\fR .sp -.VS 8.5 \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 @@ -33,35 +28,44 @@ If a \fBreturn\fR command is invoked from within the script then the remainder of the file will be skipped and the \fBsource\fR command will return normally with the result from the \fBreturn\fR command. .PP -The end-of-file character for files is '\\32' (^Z) for all platforms. +The end-of-file character for files is +.QW \e32 +(^Z) for all platforms. The source command will read files up to this character. This restriction does not exist for the \fBread\fR or \fBgets\fR commands, allowing for files containing code and data segments (scripted documents). -If you require a ``^Z'' in code for string comparison, you can use -``\\032'' or ``\\u001a'', which will be safely substituted by the Tcl -interpreter into ``^Z''. +If you require a +.QW ^Z +in code for string comparison, you can use +.QW \e032 +or +.QW \eu001a , +which will be safely substituted by the Tcl interpreter into +.QW ^Z . +.PP +A leading BOM (Byte order mark) contained in the file is ignored for unicode encodings (utf-8, unicode). .PP -.VS 8.5 -The \fB-encoding\fR option is used to specify the encoding of -the data stored in \fIfileName\fR. When the \fB-encoding\fR option +The \fB\-encoding\fR option is used to specify the encoding of +the data stored in \fIfileName\fR. When the \fB\-encoding\fR option is omitted, the system encoding is assumed. -.VE 8.5 .SH EXAMPLE +.PP Run the script in the file \fBfoo.tcl\fR and then the script in the file \fBbar.tcl\fR: +.PP .CS \fBsource\fR foo.tcl \fBsource\fR bar.tcl .CE +.PP Alternatively: +.PP .CS foreach scriptFile {foo.tcl bar.tcl} { - \fBsource\fR $scriptFile + \fBsource\fR $scriptFile } .CE - .SH "SEE ALSO" file(n), cd(n), encoding(n), info(n) - .SH KEYWORDS file, script |