summaryrefslogtreecommitdiffstats
path: root/doc/SourceRCFile.3
blob: 625b301fa0b9d02f5ca7dcb4416ad0a6228265bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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