2 '\" Copyright (c) 1993 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
4 '\" Copyright (c) 2000 Scriptics Corporation.
6 '\" See the file "license.terms" for information on usage and redistribution
7 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
9 '\" RCS: @(#) $Id: source.n,v 1.5 2000/09/07 14:27:51 poenitz Exp $
11 '\" The definitions below are for supplemental macros used in Tcl/Tk
14 '\" .AP type name in/out ?indent?
15 '\" Start paragraph describing an argument to a library procedure.
16 '\" type is type of argument (int, etc.), in/out is either "in", "out",
17 '\" or "in/out" to describe whether procedure reads or modifies arg,
18 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
19 '\" needed; use .AS below instead)
22 '\" Give maximum sizes of arguments for setting tab stops. Type and
23 '\" name are examples of largest possible arguments that will be passed
24 '\" to .AP later. If args are omitted, default tab stops are used.
27 '\" Start box enclosure. From here until next .BE, everything will be
28 '\" enclosed in one large box.
31 '\" End of box enclosure.
34 '\" Begin code excerpt.
39 '\" .VS ?version? ?br?
40 '\" Begin vertical sidebar, for use in marking newly-changed parts
41 '\" of man pages. The first argument is ignored and used for recording
42 '\" the version when the .VS was added, so that the sidebars can be
43 '\" found and removed when they reach a certain age. If another argument
44 '\" is present, then a line break is forced before starting the sidebar.
47 '\" End of vertical sidebar.
50 '\" Begin an indented unfilled display.
53 '\" End of indented unfilled display.
56 '\" Start of list of standard options for a Tk widget. The
57 '\" options follow on successive lines, in four columns separated
61 '\" End of list of standard options for a Tk widget.
63 '\" .OP cmdName dbName dbClass
64 '\" Start of description of a specific option. cmdName gives the
65 '\" option's name as specified in the class command, dbName gives
66 '\" the option's name in the option database, and dbClass gives
67 '\" the option's class in the option database.
70 '\" Print arg1 underlined, then print arg2 normally.
72 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
74 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
78 '\" # Start an argument description
82 . ie !"\\$2"" .TP \\n()Cu
87 \&\\$1 \\fI\\$2\\fP (\\$3)
100 '\" # define tabbing values for .AP
103 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
106 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
107 .nr )C \\n()Bu+\\w'(in/out)'u+2n
109 .AS Tcl_Interp Tcl_CreateInterp in/out
110 '\" # BS - start boxed text
111 '\" # ^y = starting y location
119 .if n \l'\\n(.lu\(ul'
122 '\" # BE - end boxed text (draw box now)
127 .ie n \l'\\n(^lu\(ul'
129 .\" Draw four-sided box normally, but don't draw top of
130 .\" box if the box started on an earlier page.
132 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
135 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
142 '\" # VS - start vertical sidebar
143 '\" # ^Y = starting y location
144 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
148 .ie n 'mc \s12\(br\s0
151 '\" # VE - end of vertical sidebar
159 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
166 '\" # Special macro to handle page bottom: finish off current
167 '\" # box/sidebar if in box/sidebar mode, then invoked standard
168 '\" # page bottom macro.
175 .\" Draw three-sided box if this is the box's first page,
176 .\" draw two sides but no top otherwise.
177 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
178 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
181 .nr ^x \\n(^tu+1v-\\n(^Yu
182 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
195 '\" # DS - begin display
201 '\" # DE - end display
207 '\" # SO - start of list of standard options
209 .SH "STANDARD OPTIONS"
215 '\" # SE - end of list of standard options
220 See the \\fBoptions\\fR manual entry for details on the standard options.
222 '\" # OP - start of full description for a single option
227 Command-Line Name: \\fB\\$1\\fR
228 Database Name: \\fB\\$2\\fR
229 Database Class: \\fB\\$3\\fR
233 '\" # CS - begin code excerpt
239 '\" # CE - end code excerpt
247 .TH source n "" Tcl "Tcl Built-In Commands"
249 '\" Note: do not modify the .SH NAME line immediately below!
251 source \- Evaluate a file or resource as a Tcl script
253 \fBsource \fIfileName\fR
255 \fBsource\fR \fB\-rsrc \fIresourceName \fR?\fIfileName\fR?
257 \fBsource\fR \fB\-rsrcid \fIresourceId \fR?\fIfileName\fR?
262 This command takes the contents of the specified file or resource
263 and passes it to the Tcl interpreter as a text script. The return
264 value from \fBsource\fR is the return value of the last command
265 executed in the script. If an error occurs in evaluating the contents
266 of the script then the \fBsource\fR command will return that error.
267 If a \fBreturn\fR command is invoked from within the script then the
268 remainder of the file will be skipped and the \fBsource\fR command
269 will return normally with the result from the \fBreturn\fR command.
272 The end-of-file character for files is '\\32' (^Z) for all platforms.
273 The source command will read files up to this character. This
274 restriction does not exist for the \fBread\fR or \fBgets\fR commands,
275 allowing for files containing code and data segments (scripted documents).
276 If you require a ``^Z'' in code for string comparison, you can use
277 ``\\032'' or ``\\u001a'', which will be safely substituted by the Tcl
278 interpreter into ``^Z''.
281 The \fI\-rsrc\fR and \fI\-rsrcid\fR forms of this command are only
282 available on Macintosh computers. These versions of the command
283 allow you to source a script from a \fBTEXT\fR resource. You may specify
284 what \fBTEXT\fR resource to source by either name or id. By default Tcl
285 searches all open resource files, which include the current
286 application and any loaded C extensions. Alternatively, you may
287 specify the \fIfileName\fR where the \fBTEXT\fR resource can be found.