diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/SourceRCFile.3 | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/SourceRCFile.3 b/doc/SourceRCFile.3 new file mode 100644 index 0000000..625b301 --- /dev/null +++ b/doc/SourceRCFile.3 @@ -0,0 +1,38 @@ +'\" +'\" Copyright (c) 1998-2000 by Scriptics Corporation. +'\" All rights reserved. +'\" +'\" RCS: @(#) $Id: SourceRCFile.3,v 1.1 2000/04/25 00:28:06 ericm Exp $ +'\" +'\" +.so man.macros +.TH Tcl_SourceRCFile 3 8.3 Tcl "Tcl Library Procedures" +.BS +.SH NAME +Tcl_SourceRCFile \- source the Tcl rc file +.SH SYNOPSIS +.nf +\fB#include <tcl.h>\fR +.sp +void +\fBTcl_SourceRCFile\fR(\fIinterp\fR) +.SH ARGUMENTS +.AP Tcl_Interp *interp in +Tcl interpreter to source rc file into. +.BE + +.SH DESCRIPTION +.PP +\fBTcl_SourceRCFile\fR is used to source the Tcl rc file at startup. +It is typically invoked by Tcl_Main or Tk_Main. The name of the file +sourced is obtained from the global variable \fBtcl_rcFileName\fR in +the interpreter given by \fIinterp\fR. If this variable is not +defined, or if the file it indicates cannot be found, no action is +taken. +.PP +On the Macintosh, after sourcing the rc file, this function will +additionally source the TEXT resource indicated by the global variable +\fBtcl_rcRsrcName\fR in \fIinterp\fR. + +.SH KEYWORDS +application-specific initialization, main program, rc file |