Seth Woolley's Man Viewer

source(n) - source, source - Evaluate a file or resource as a Tcl script - man n source

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

source(n)                    Tcl Built-In Commands                   source(n)



NAME
       source - Evaluate a file(1,n) or resource as a Tcl script

SYNOPSIS
       source fileName

       source -rsrc resourceName ?fileName?

       source -rsrcid resourceId ?fileName?


DESCRIPTION
       This  command  takes the contents of the specified file(1,n) or resource and
       passes it to the Tcl interpreter as a text script.   The  return  value
       from  source  is  the  return value of the last command executed in(1,8) the
       script.  If an error(8,n) occurs in(1,8) evaluating the contents  of  the  script
       then the source command will return that error.  If a return command is
       invoked from within the script then the remainder of the file(1,n)  will  be
       skipped  and  the  source  command will return normally with the result
       from the return command.

       The end-of-file character for files is '\32' (^Z)  for  all  platforms.
       The source command will read(2,n,1 builtins) files up to this character.  This restric-
       tion does not exist for the read(2,n,1 builtins) or gets(3,n) commands, allowing  for  files
       containing code and data segments (scripted documents).  If you require
       a ``^Z'' in(1,8) code  for  string(3,n)  comparison,  you  can  use  ``\032''  or
       ``\u001a'',  which  will  be  safely substituted by the Tcl interpreter
       into ``^Z''.

       The -rsrc and -rsrcid forms of this command are only available on  Mac-
       intosh  computers.  These versions of the command allow you to source a
       script from a TEXT resource.  You may specify  what  TEXT  resource  to
       source by either name or id.  By default Tcl searches all open(2,3,n) resource
       files, which include the current application and any  loaded  C  exten-
       sions.   Alternatively,  you  may  specify  the fileName where the TEXT
       resource can be found.


SEE ALSO
       file(1,n)(n), cd(n)


KEYWORDS
       file(1,n), script



Tcl                                                                  source(n)

References for this manual (incoming links)