head	1.10;
access;
symbols
	core-8-5-9:1.8
	core-8-5-8:1.8
	macosx-cocoa-merge:1.9
	macosx-cocoa-premerge:1.9
	macosx-carbon-freeze:1.9
	core-8-5-7:1.8
	core-8-5-6:1.8
	core-8-6-b1:1.9
	core-8-6-a3:1.9
	core-8-5-5:1.8
	core-8-6-a2:1.9
	core-8-5-4:1.8
	core-8-5-3:1.8
	core-8-6-a1:1.8
	core-8-4-19:1.2
	core-8-5-branch:1.8.0.2
	core-8-5-2:1.8
	core-8-4-18:1.2
	core-8-5-1:1.7
	core-8-4-17:1.2
	core-8-5-0:1.7
	core-8-5-b3:1.6
	core-8-5-b2:1.5
	core-8-4-16:1.2
	core-8-5-b1:1.5
	core-stablilizer-merge:1.5
	core-stabilizer-branch:1.5.0.2
	core-stabilizer-merge:1.8
	core-8-4-15:1.2
	core-8-5-a6:1.5
	core-8-5-a5:1.4
	core-8-4-14:1.2
	core-8-5-a4:1.4
	core-8-4-13:1.2
	core-8-4-12:1.2
	core-8-4-11:1.2
	core-8-5-a3:1.4
	core-8-4-10:1.2
	core-8-4-9-branch:1.2.0.8
	core-8-5-a2:1.4
	core-8-4-9:1.2
	core-8-4-8:1.2
	core-8-4-7:1.2
	core-8-5-a1:1.2
	core-8-4-6:1.2
	core-8-4-5:1.2
	mistachkin-dev-branch:1.2.0.6
	core-8-4-4:1.2
	core-8-4-3:1.2
	core-8-4-branch:1.2.0.4
	core-8-4-2:1.2
	core-8-4-1:1.2
	core-8-3-5:1.1
	core-8-4-0:1.2
	macosx-8-4-merge-2002-08-31-trunk:1.2
	macosx-8-4-premerge-2002-08-31-branch:1.2
	macosx-8-4-premerge-2002-08-31-trunk:1.2
	macosx-8-4-merge-2002-08-30-branch:1.2
	macosx-8-4-merge-2002-08-30-trunk:1.2
	macosx-8-4-merge-2002-08-20-branch:1.2
	macosx-8-4-merge-2002-08-20-trunk:1.2
	core-8-4-b2:1.2
	core-8-4-b1:1.2
	macosx-premerge-6-9-02:1.2
	core-8-4-a4:1.2
	core-8-3-4:1.1
	macosx-8-4-branch:1.2.0.2
	macosx-8-4-branchpoint:1.2
	core-8-4-a3:1.2
	core-8-3-3:1.1
	dgp-privates-into-namespace:1.1.0.16
	tclpro-1-5-0:1.1
	core-8-4-win-speedup:1.1.0.14
	core-8-4-a2:1.1
	tclpro-1-4-1:1.1
	tclpro-1-4-0:1.1
	core-8-3-2:1.1
	ajuba-ajuba2-2-1-base:1.1
	ajuba-ajuba2-2-0:1.1
	core-8-4-a1:1.1
	core-8-3-1-branch:1.1.0.12
	core-8-3-1:1.1
	scriptics-sc-2-0-b5:1.1
	scriptics-sc-2-0-fixed:1.1
	scriptics-sc-2-0-b2:1.1
	scriptics-sc-2-0-b1:1.1
	core-8-3-0:1.1
	core-8-3-b2:1.1
	core-8-3-b1:1.1
	scriptics-sc-1-1:1.1
	scriptics-sc-1-1-b1:1.1
	core-8-2-3:1.1
	scriptics-sc-1-1-branch:1.1.0.10
	scriptics-sc-1-1-base:1.1
	scriptics-sc-1-0:1.1
	scriptics-sc-1-0-branch:1.1.0.8
	scriptics-sc-1-0-base:1.1
	core-8-2-2:1.1
	core-8-2-1:1.1
	scriptics-bc-1-0-b1:1.1
	core-8-2-1-branch:1.1.0.6
	scriptics-tclpro-1-3-0:1.1
	core-8-2-0:1.1
	core-8-2-b3-branch:1.1.0.4
	core-8-2-b3-base:1.1
	scriptics-tclpro-1-3-b4:1.1
	core-8-2-b2:1.1
	scriptics-tclpro-1-3-b3:1.1
	core-8-2-b1:1.1
	scriptics-tclpro-1-3-b2:1.1
	merge-to-mainline-5/21/99:1.1
	scriptics-tclpro-1-3-b2-branch:1.1.0.2
	core-8-1-1:1.1
	scriptics-tclpro-1-3-b1:1.1
	core-8-1-1-base:1.1;
locks; strict;
comment	@.\" @;


1.10
date	2010.01.04.22.06.47;	author patthoyts;	state Exp;
branches;
next	1.9;

1.9
date	2008.06.30.22.57.02;	author dkf;	state Exp;
branches;
next	1.8;

1.8
date	2008.03.26.09.59.56;	author dkf;	state Exp;
branches;
next	1.7;

1.7
date	2007.12.13.15.23.43;	author dgp;	state Exp;
branches;
next	1.6;

1.6
date	2007.10.29.16.04.13;	author dkf;	state Exp;
branches;
next	1.5;

1.5
date	2007.01.05.00.00.48;	author nijtmans;	state Exp;
branches
	1.5.2.1;
next	1.4;

1.4
date	2004.09.19.16.05.36;	author dkf;	state Exp;
branches;
next	1.3;

1.3
date	2004.08.20.14.15.29;	author dkf;	state Exp;
branches;
next	1.2;

1.2
date	2001.05.22.00.22.41;	author hobbs;	state Exp;
branches;
next	1.1;

1.1
date	99.05.05.21.46.27;	author hershey;	state Exp;
branches
	1.1.14.1
	1.1.16.1;
next	;

1.1.14.1
date	2002.04.02.20.57.53;	author hobbs;	state Exp;
branches;
next	;

1.1.16.1
date	2001.07.03.20.01.07;	author dgp;	state Exp;
branches;
next	;

1.5.2.1
date	2007.11.01.16.37.13;	author dgp;	state Exp;
branches;
next	1.5.2.2;

1.5.2.2
date	2008.03.26.20.09.31;	author dgp;	state Exp;
branches;
next	;


desc
@@


1.10
log
@Bug 2192104: mention the USE_TK_STUBS macro in the man page
@
text
@'\"
'\" Copyright (c) 1999 Scriptics Corporation
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\" 
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.9 2008/06/30 22:57:02 dkf Exp $
'\" 
.so man.macros
.TH Tk_InitStubs 3 8.4 Tk "Tk Library Procedures"
.BS
.SH NAME
Tk_InitStubs \- initialize the Tk stubs mechanism
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR
.sp
const char *
\fBTk_InitStubs\fR(\fIinterp, version, exact\fR)
.SH ARGUMENTS
.AS Tcl_Interp *interp in
.AP Tcl_Interp *interp in
Tcl interpreter handle.
.AP char *version in
A version string consisting of one or more decimal numbers
separated by dots.
.AP int exact in
Non-zero means that only the particular Tk version specified by
\fIversion\fR is acceptable.
Zero means that versions newer than \fIversion\fR are also
acceptable as long as they have the same major version number
as \fIversion\fR.
.BE
.SH INTRODUCTION
.PP
The Tcl stubs mechanism defines a way to dynamically bind
extensions to a particular Tcl implementation at run time.
the stubs mechanism requires no changes to applications
incoporating Tcl/Tk interpreters.  Only developers creating
C-based Tcl/Tk extensions need to take steps to use the
stubs mechanism with their extensions.
See the \fBTcl_InitStubs\fR page for more information.
.PP
Enabling the stubs mechanism for a Tcl/Tk extension requires the following
steps:
.IP 1) 5
Call \fBTcl_InitStubs\fR in the extension before calling any other
Tcl functions.
.IP 2) 5
Call \fBTk_InitStubs\fR if the extension before calling any other
Tk functions.
.IP 2) 5
Define the \fBUSE_TCL_STUBS\fR and the \fBUSE_TK_STUBS\fR
symbols. Typically, you would include the \fB\-DUSE_TCL_STUBS\fR and
the \fB\-DUSE_TK_STUBS\fR flags when compiling the extension.
.IP 3) 5
Link the extension with the Tcl and Tk stubs libraries instead of the
standard Tcl and Tk libraries.  On Unix platforms, the library names
are \fIlibtclstub8.4.a\fR and \fIlibtkstub8.4.a\fR; on Windows
platforms, the library names are \fItclstub84.lib\fR and
\fItkstub84.lib\fR. Adjust the library names with appropriate version
number but note that the extension may only be used with versions of
Tcl/Tk that have that version number or higher.
.SH DESCRIPTION
.PP
\fBTk_InitStubs\fR attempts to initialize the Tk stub table pointers
and ensure that the correct version of Tk is loaded.  In addition
to an interpreter handle, it accepts as arguments a version number
and a Boolean flag indicating whether the extension requires
an exact version match or not.  If \fIexact\fR is 0, then the
extension is indicating that newer versions of Tk are acceptable
as long as they have the same major version number as \fIversion\fR;
non-zero means that only the specified \fIversion\fR is acceptable.
\fBTcl_InitStubs\fR returns a string containing the actual version
of Tk satisfying the request, or NULL if the Tk version is not
acceptable, does not support the stubs mechanism, or any other
error condition occurred.
.SH "SEE ALSO"
\fBTcl_InitStubs\fR
.SH KEYWORDS
stubs
@


1.9
log
@Minor doc updates (removing out of date changebars, improving typedef formatting,
 etc.)
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.8 2008/03/26 09:59:56 dkf Exp $
d53 3
a55 2
Define the \fBUSE_TCL_STUBS\fR symbol. Typically, you would include the
\fB\-DUSE_TCL_STUBS\fR flag when compiling the extension.
d57 7
a63 5
Link the extension with the Tcl and Tk stubs libraries instead of
the standard Tcl and Tk libraries.  On Unix platforms, the library
names are \fIlibtclstub8.4.a\fR and \fIlibtkstub8.4.a\fR; on Windows
platforms, the library names are \fItclstub84.lib\fR and \fItkstub84.lib\fR
(adjust names with appropriate version number).
@


1.8
log
@Minor fixes to copyright declarations (spelling, consistency)
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.7 2007/12/13 15:23:43 dgp Exp $
d62 1
@


1.7
log
@merge stable branch onto HEAD
@
text
@d2 1
a2 1
'\" Copyright (c) 1999 Scriptics Corportation
d7 1
a7 1
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.5.2.1 2007/11/01 16:37:13 dgp Exp $
@


1.6
log
@Lots more GOOBE stuff. Now works with 'make html'!
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.5 2007/01/05 00:00:48 nijtmans Exp $
@


1.5
log
@various "const" additions, in line with TIP #27
fix bug #1627732
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.4 2004/09/19 16:05:36 dkf Exp $
d54 1
a54 1
\fB-DUSE_TCL_STUBS\fR flag when compiling the extension.
@


1.5.2.1
log
@merge updates from HEAD
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.5 2007/01/05 00:00:48 nijtmans Exp $
d54 1
a54 1
\fB\-DUSE_TCL_STUBS\fR flag when compiling the extension.
@


1.5.2.2
log
@merge updates from HEAD
@
text
@d2 1
a2 1
'\" Copyright (c) 1999 Scriptics Corporation
d7 1
a7 1
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.5.2.1 2007/11/01 16:37:13 dgp Exp $
@


1.4
log
@Standardize style of section refs & public symbols. Remove displayed tabs
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.3 2004/08/20 14:15:29 dkf Exp $
d18 1
a18 1
CONST char *
@


1.3
log
@More doc fixes. [Patch 1012837]
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.2 2001/05/22 00:22:41 hobbs Exp $
d53 2
a54 2
Define the USE_TCL_STUBS symbol.  Typically, you would include the
-DUSE_TCL_STUBS flag when compiling the extension.
@


1.2
log
@	* doc/TkInitStubs.3:
	* generic/tk.h:
	* generic/tkStubLib.c: CONST'ified Tk_InitStubs to match CONST
	changes to Tcl_PkgRequireEx.
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.1 1999/05/05 21:46:27 hershey Exp $
d72 1
a72 1
acceptable, does not support the stubs mechansim, or any other
@


1.1
log
@renamed to avoid conflict with tcl's InitStubs doc.
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: InitStubs.3,v 1.2 1999/04/30 22:49:54 stanton Exp $
d10 1
a10 1
.TH Tk_InitStubs 3 8.1 Tk "Tk Library Procedures"
d18 1
a18 1
char *
d58 3
a60 3
names are \fIlibtclstub8.1.a\fR and \fIlibtkstub8.1.a\fR; on Windows
platforms, the library names are
\fItclstub81.lib\fR and \fItkstub81.lib\fR.
@


1.1.14.1
log
@sync with head
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.2 2001/05/22 00:22:41 hobbs Exp $
d10 1
a10 1
.TH Tk_InitStubs 3 8.4 Tk "Tk Library Procedures"
d18 1
a18 1
CONST char *
d58 3
a60 3
names are \fIlibtclstub8.4.a\fR and \fIlibtkstub8.4.a\fR; on Windows
platforms, the library names are \fItclstub84.lib\fR and \fItkstub84.lib\fR
(adjust names with appropriate version number).
@


1.1.16.1
log
@        * Merged in updates from HEAD branch.
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: TkInitStubs.3,v 1.2 2001/05/22 00:22:41 hobbs Exp $
d10 1
a10 1
.TH Tk_InitStubs 3 8.4 Tk "Tk Library Procedures"
d18 1
a18 1
CONST char *
d58 3
a60 3
names are \fIlibtclstub8.4.a\fR and \fIlibtkstub8.4.a\fR; on Windows
platforms, the library names are \fItclstub84.lib\fR and \fItkstub84.lib\fR
(adjust names with appropriate version number).
@


