summaryrefslogtreecommitdiffstats
path: root/doc/SourceRCFile.3
diff options
context:
space:
mode:
authorericm <ericm>2000-04-25 00:28:06 (GMT)
committerericm <ericm>2000-04-25 00:28:06 (GMT)
commit6a2af0e4d09b2426bf51f1a7be866271a9c40407 (patch)
treed732c60b42cbf8cdb2391b327148e9c4a0cf9a61 /doc/SourceRCFile.3
parentb4522af1fcae31bff2fa2c4aa8a8d15e030fa8e2 (diff)
downloadtcl-6a2af0e4d09b2426bf51f1a7be866271a9c40407.zip
tcl-6a2af0e4d09b2426bf51f1a7be866271a9c40407.tar.gz
tcl-6a2af0e4d09b2426bf51f1a7be866271a9c40407.tar.bz2
* unix/mkLinks:
* doc/SourceRCFile.3: Man page for Tcl_SourceRCFile [Bug: 1833].
Diffstat (limited to 'doc/SourceRCFile.3')
-rw-r--r--doc/SourceRCFile.338
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