2 '\" Copyright (c) 1998-2000 by Scriptics Corporation.
3 '\" All rights reserved.
5 '\" RCS: @(#) $Id: SourceRCFile.3,v 1.1 2000/04/25 00:28:06 ericm Exp $
8 '\" The definitions below are for supplemental macros used in Tcl/Tk
11 '\" .AP type name in/out ?indent?
12 '\" Start paragraph describing an argument to a library procedure.
13 '\" type is type of argument (int, etc.), in/out is either "in", "out",
14 '\" or "in/out" to describe whether procedure reads or modifies arg,
15 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
16 '\" needed; use .AS below instead)
19 '\" Give maximum sizes of arguments for setting tab stops. Type and
20 '\" name are examples of largest possible arguments that will be passed
21 '\" to .AP later. If args are omitted, default tab stops are used.
24 '\" Start box enclosure. From here until next .BE, everything will be
25 '\" enclosed in one large box.
28 '\" End of box enclosure.
31 '\" Begin code excerpt.
36 '\" .VS ?version? ?br?
37 '\" Begin vertical sidebar, for use in marking newly-changed parts
38 '\" of man pages. The first argument is ignored and used for recording
39 '\" the version when the .VS was added, so that the sidebars can be
40 '\" found and removed when they reach a certain age. If another argument
41 '\" is present, then a line break is forced before starting the sidebar.
44 '\" End of vertical sidebar.
47 '\" Begin an indented unfilled display.
50 '\" End of indented unfilled display.
53 '\" Start of list of standard options for a Tk widget. The
54 '\" options follow on successive lines, in four columns separated
58 '\" End of list of standard options for a Tk widget.
60 '\" .OP cmdName dbName dbClass
61 '\" Start of description of a specific option. cmdName gives the
62 '\" option's name as specified in the class command, dbName gives
63 '\" the option's name in the option database, and dbClass gives
64 '\" the option's class in the option database.
67 '\" Print arg1 underlined, then print arg2 normally.
69 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
71 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
75 '\" # Start an argument description
79 . ie !"\\$2"" .TP \\n()Cu
84 \&\\$1 \\fI\\$2\\fP (\\$3)
97 '\" # define tabbing values for .AP
100 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
103 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
104 .nr )C \\n()Bu+\\w'(in/out)'u+2n
106 .AS Tcl_Interp Tcl_CreateInterp in/out
107 '\" # BS - start boxed text
108 '\" # ^y = starting y location
116 .if n \l'\\n(.lu\(ul'
119 '\" # BE - end boxed text (draw box now)
124 .ie n \l'\\n(^lu\(ul'
126 .\" Draw four-sided box normally, but don't draw top of
127 .\" box if the box started on an earlier page.
129 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
132 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
139 '\" # VS - start vertical sidebar
140 '\" # ^Y = starting y location
141 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
145 .ie n 'mc \s12\(br\s0
148 '\" # VE - end of vertical sidebar
156 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
163 '\" # Special macro to handle page bottom: finish off current
164 '\" # box/sidebar if in box/sidebar mode, then invoked standard
165 '\" # page bottom macro.
172 .\" Draw three-sided box if this is the box's first page,
173 .\" draw two sides but no top otherwise.
174 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
175 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
178 .nr ^x \\n(^tu+1v-\\n(^Yu
179 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
192 '\" # DS - begin display
198 '\" # DE - end display
204 '\" # SO - start of list of standard options
206 .SH "STANDARD OPTIONS"
212 '\" # SE - end of list of standard options
217 See the \\fBoptions\\fR manual entry for details on the standard options.
219 '\" # OP - start of full description for a single option
224 Command-Line Name: \\fB\\$1\\fR
225 Database Name: \\fB\\$2\\fR
226 Database Class: \\fB\\$3\\fR
230 '\" # CS - begin code excerpt
236 '\" # CE - end code excerpt
244 .TH Tcl_SourceRCFile 3 8.3 Tcl "Tcl Library Procedures"
247 Tcl_SourceRCFile \- source the Tcl rc file
250 \fB#include <tcl.h>\fR
253 \fBTcl_SourceRCFile\fR(\fIinterp\fR)
255 .AP Tcl_Interp *interp in
256 Tcl interpreter to source rc file into.
261 \fBTcl_SourceRCFile\fR is used to source the Tcl rc file at startup.
262 It is typically invoked by Tcl_Main or Tk_Main. The name of the file
263 sourced is obtained from the global variable \fBtcl_rcFileName\fR in
264 the interpreter given by \fIinterp\fR. If this variable is not
265 defined, or if the file it indicates cannot be found, no action is
268 On the Macintosh, after sourcing the rc file, this function will
269 additionally source the TEXT resource indicated by the global variable
270 \fBtcl_rcRsrcName\fR in \fIinterp\fR.
273 application-specific initialization, main program, rc file