2 '\" Copyright (c) 1995-1996 Sun Microsystems, Inc.
4 '\" See the file "license.terms" for information on usage and redistribution
5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7 '\" RCS: @(#) $Id: StaticPkg.3,v 1.4 2002/01/09 19:09:28 kennykb Exp $
9 '\" The definitions below are for supplemental macros used in Tcl/Tk
12 '\" .AP type name in/out ?indent?
13 '\" Start paragraph describing an argument to a library procedure.
14 '\" type is type of argument (int, etc.), in/out is either "in", "out",
15 '\" or "in/out" to describe whether procedure reads or modifies arg,
16 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
17 '\" needed; use .AS below instead)
20 '\" Give maximum sizes of arguments for setting tab stops. Type and
21 '\" name are examples of largest possible arguments that will be passed
22 '\" to .AP later. If args are omitted, default tab stops are used.
25 '\" Start box enclosure. From here until next .BE, everything will be
26 '\" enclosed in one large box.
29 '\" End of box enclosure.
32 '\" Begin code excerpt.
37 '\" .VS ?version? ?br?
38 '\" Begin vertical sidebar, for use in marking newly-changed parts
39 '\" of man pages. The first argument is ignored and used for recording
40 '\" the version when the .VS was added, so that the sidebars can be
41 '\" found and removed when they reach a certain age. If another argument
42 '\" is present, then a line break is forced before starting the sidebar.
45 '\" End of vertical sidebar.
48 '\" Begin an indented unfilled display.
51 '\" End of indented unfilled display.
54 '\" Start of list of standard options for a Tk widget. The
55 '\" options follow on successive lines, in four columns separated
59 '\" End of list of standard options for a Tk widget.
61 '\" .OP cmdName dbName dbClass
62 '\" Start of description of a specific option. cmdName gives the
63 '\" option's name as specified in the class command, dbName gives
64 '\" the option's name in the option database, and dbClass gives
65 '\" the option's class in the option database.
68 '\" Print arg1 underlined, then print arg2 normally.
70 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
72 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
76 '\" # Start an argument description
80 . ie !"\\$2"" .TP \\n()Cu
85 \&\\$1 \\fI\\$2\\fP (\\$3)
98 '\" # define tabbing values for .AP
101 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
104 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
105 .nr )C \\n()Bu+\\w'(in/out)'u+2n
107 .AS Tcl_Interp Tcl_CreateInterp in/out
108 '\" # BS - start boxed text
109 '\" # ^y = starting y location
117 .if n \l'\\n(.lu\(ul'
120 '\" # BE - end boxed text (draw box now)
125 .ie n \l'\\n(^lu\(ul'
127 .\" Draw four-sided box normally, but don't draw top of
128 .\" box if the box started on an earlier page.
130 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
133 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
140 '\" # VS - start vertical sidebar
141 '\" # ^Y = starting y location
142 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
146 .ie n 'mc \s12\(br\s0
149 '\" # VE - end of vertical sidebar
157 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
164 '\" # Special macro to handle page bottom: finish off current
165 '\" # box/sidebar if in box/sidebar mode, then invoked standard
166 '\" # page bottom macro.
173 .\" Draw three-sided box if this is the box's first page,
174 .\" draw two sides but no top otherwise.
175 .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
176 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
179 .nr ^x \\n(^tu+1v-\\n(^Yu
180 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
193 '\" # DS - begin display
199 '\" # DE - end display
205 '\" # SO - start of list of standard options
207 .SH "STANDARD OPTIONS"
213 '\" # SE - end of list of standard options
218 See the \\fBoptions\\fR manual entry for details on the standard options.
220 '\" # OP - start of full description for a single option
225 Command-Line Name: \\fB\\$1\\fR
226 Database Name: \\fB\\$2\\fR
227 Database Class: \\fB\\$3\\fR
231 '\" # CS - begin code excerpt
237 '\" # CE - end code excerpt
245 .TH Tcl_StaticPackage 3 7.5 Tcl "Tcl Library Procedures"
248 Tcl_StaticPackage \- make a statically linked package available via the \fBload\fR command
251 \fB#include <tcl.h>\fR
253 \fBTcl_StaticPackage\fR(\fIinterp, pkgName, initProc, safeInitProc\fR)
255 .AS Tcl_PackageInitProc *safeInitProc
256 .AP Tcl_Interp *interp in
257 If not NULL, points to an interpreter into which the package has
258 already been loaded (i.e., the caller has already invoked the
259 appropriate initialization procedure). NULL means the package
260 hasn't yet been incorporated into any interpreter.
261 .AP "CONST char" *pkgName in
262 Name of the package; should be properly capitalized (first letter
263 upper-case, all others lower-case).
264 .AP Tcl_PackageInitProc *initProc in
265 Procedure to invoke to incorporate this package into a trusted
267 .AP Tcl_PackageInitProc *safeInitProc in
268 Procedure to call to incorporate this package into a safe interpreter
269 (one that will execute untrusted scripts). NULL means the package
270 can't be used in safe interpreters.
275 This procedure may be invoked to announce that a package has been
276 linked statically with a Tcl application and, optionally, that it
277 has already been loaded into an interpreter.
278 Once \fBTcl_StaticPackage\fR has been invoked for a package, it
279 may be loaded into interpreters using the \fBload\fR command.
280 \fBTcl_StaticPackage\fR is normally invoked only by the \fBTcl_AppInit\fR
281 procedure for the application, not by packages for themselves
282 (\fBTcl_StaticPackage\fR should only be invoked for statically
283 loaded packages, and code in the package itself should not need
284 to know whether the package is dynamically or statically loaded).
286 When the \fBload\fR command is used later to load the package into
287 an interpreter, one of \fIinitProc\fR and \fIsafeInitProc\fR will
288 be invoked, depending on whether the target interpreter is safe
290 \fIinitProc\fR and \fIsafeInitProc\fR must both match the
293 typedef int Tcl_PackageInitProc(Tcl_Interp *\fIinterp\fR);
295 The \fIinterp\fR argument identifies the interpreter in which the package
296 is to be loaded. The initialization procedure must return \fBTCL_OK\fR or
297 \fBTCL_ERROR\fR to indicate whether or not it completed successfully; in
298 the event of an error it should set the interpreter's result to point to an
299 error message. The result or error from the initialization procedure will
300 be returned as the result of the \fBload\fR command that caused the
301 initialization procedure to be invoked.
304 initialization procedure, package, static linking