summaryrefslogtreecommitdiffstats
path: root/doc/source.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source.n')
-rw-r--r--doc/source.n24
1 files changed, 11 insertions, 13 deletions
diff --git a/doc/source.n b/doc/source.n
index cee1312..d8eaa0c 100644
--- a/doc/source.n
+++ b/doc/source.n
@@ -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.
-'\"
+'\"
.TH source n "" Tcl "Tcl Built-In Commands"
.so man.macros
.BS
@@ -15,7 +15,9 @@ 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
@@ -37,37 +39,33 @@ allowing for files containing code and data segments (scripted documents).
If you require a
.QW ^Z
in code for string comparison, you can use
-.QW \ex1A ,
+.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, utf-16, ucs-2).
+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
-is omitted, the utf-8 encoding is assumed.
+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
-'\" Local Variables:
-'\" mode: nroff
-'\" fill-column: 78
-'\" End: