home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / tcl2-73c.zip / tcl7.3 / doc / source.n < prev    next >
Text File  |  1993-06-07  |  2KB  |  48 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/source.n,v 1.1 93/06/07 16:48:28 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS source tcl
  25. .BS
  26. '\" Note:  do not modify the .SH NAME line immediately below!
  27. .SH NAME
  28. source \- Evaluate a file as a Tcl script
  29. .SH SYNOPSIS
  30. \fBsource \fIfileName\fR
  31. .BE
  32.  
  33. .SH DESCRIPTION
  34. .PP
  35. Read file \fIfileName\fR and pass the contents to the Tcl interpreter
  36. as a script to evaluate in the normal fashion.  The return
  37. value from \fBsource\fR is the return value of the last command executed
  38. from the file.  If an error occurs in evaluating the contents of the
  39. file then the \fBsource\fR command will return that error.
  40. If a \fBreturn\fR command is invoked from within the file then the remainder of
  41. the file will be skipped and the \fBsource\fR command will return
  42. normally with the result from the \fBreturn\fR command.
  43. If \fIfileName\fR starts with a tilde, then it is tilde-substituted
  44. as described in the \fBTcl_TildeSubst\fR manual entry.
  45.  
  46. .SH KEYWORDS
  47. file, script
  48.