summaryrefslogtreecommitdiffstats
path: root/doc/source.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source.n')
-rw-r--r--doc/source.n34
1 files changed, 21 insertions, 13 deletions
diff --git a/doc/source.n b/doc/source.n
index c60c86e..69d383e 100644
--- a/doc/source.n
+++ b/doc/source.n
@@ -15,11 +15,10 @@ source \- Evaluate a file or resource as a Tcl script
.SH SYNOPSIS
\fBsource \fIfileName\fR
.sp
-\fBsource\fR \fB\-rsrc \fIresourceName \fR?\fIfileName\fR?
-.sp
-\fBsource\fR \fB\-rsrcid \fIresourceId \fR?\fIfileName\fR?
+.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
@@ -31,15 +30,26 @@ 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
-.VS 8.4
-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''.
-.VE 8.4
+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
+.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 system encoding is assumed.
+.VE 8.5
.SH EXAMPLE
Run the script in the file \fBfoo.tcl\fR and then the script in the
file \fBbar.tcl\fR:
@@ -53,9 +63,7 @@ foreach scriptFile {foo.tcl bar.tcl} {
\fBsource\fR $scriptFile
}
.CE
-
.SH "SEE ALSO"
-file(n), cd(n), info(n)
-
+file(n), cd(n), encoding(n), info(n)
.SH KEYWORDS
file, script