From 83892355ab18e4509d6b2a3dc6a1e9a8c2943033 Mon Sep 17 00:00:00 2001 From: hershey Date: Wed, 5 May 1999 21:45:17 +0000 Subject: renamed to avoid conflict with tk's InitStubs doc. --- doc/InitStubs.3 | 91 ------------------------------------------------------ doc/TclInitStubs.3 | 91 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 91 insertions(+), 91 deletions(-) delete mode 100644 doc/InitStubs.3 create mode 100644 doc/TclInitStubs.3 diff --git a/doc/InitStubs.3 b/doc/InitStubs.3 deleted file mode 100644 index 266a955..0000000 --- a/doc/InitStubs.3 +++ /dev/null @@ -1,91 +0,0 @@ -'\" -'\" Copyright (c) 1999 Scriptics Corportation -'\" -'\" See the file "license.terms" for information on usage and redistribution -'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: InitStubs.3,v 1.2 1999/04/30 22:45:00 stanton Exp $ -'\" -.so man.macros -.TH Tcl_InitStubs 3 8.1 Tcl "Tcl Library Procedures" -.BS -.SH NAME -Tcl_InitStubs \- initialize the Tcl stubs mechanism -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -char * -\fBTcl_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 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. -This provides two significant benefits to Tcl users: -.IP 1) 5 -Extensions that use the stubs mechanism can be loaded into -multiple versions of Tcl without being recompiled or -relinked. -.IP 2) 5 -Extensions that use the stubs mechanism can be dynamically -loaded into statically-linked Tcl applications. -.PP -The stubs mechanism accomplishes this by exporting function tables -that define an interface to the Tcl API. The extension then accesses -the Tcl API through offsets into the function table, so there are no -direct references to any of the Tcl library's symbols. This -redirection is transparent to the extension, so an extension writer -can continue to use all public Tcl functions as documented. -.PP -The stubs mechanism requires no changes to applications incorporating -Tcl interpreters. Only developers creating C-based Tcl extensions -need to take steps to use the stubs mechanism with their extensions. -.PP -Enabling the stubs mechanism for an extension requires the following -steps: -.IP 1) 5 -Call \fBTcl_InitStubs\fR in the extension before calling any other -Tcl functions. -.IP 2) 5 -Define the USE_TCL_STUBS symbol. Typically, you would include the --DUSE_TCL_STUBS flag when compiling the extension. -.IP 3) 5 -Link the extension with the Tcl stubs library instead of the standard -Tcl library. On Unix platforms, the library name is -\fIlibtclstub8.1.a\fR; on Windows platforms, the library name is -\fItclstub81.lib\fR. -.PP -If the extension also requires the Tk API, it must also call -\fBTk_InitStubs\fR to initialize the Tk stubs interface and link -with the Tk stubs libraries. See the \fBTk_InitStubs\fR page for -more information. -.SH DESCRIPTION -\fBTcl_InitStubs\fR attempts to initialize the stub table pointers -and ensure that the correct version of Tcl 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 Tcl 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 Tcl satisfying the request, or NULL if the Tcl version is not -acceptable, does not support stubs, or any other error condition occurred. -.SH "SEE ALSO" -\fBTk_InitStubs\fR -.SH KEYWORDS -stubs diff --git a/doc/TclInitStubs.3 b/doc/TclInitStubs.3 new file mode 100644 index 0000000..720286b --- /dev/null +++ b/doc/TclInitStubs.3 @@ -0,0 +1,91 @@ +'\" +'\" Copyright (c) 1999 Scriptics Corportation +'\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +'\" RCS: @(#) $Id: TclInitStubs.3,v 1.1 1999/05/05 21:45:17 hershey Exp $ +'\" +.so man.macros +.TH Tcl_InitStubs 3 8.1 Tcl "Tcl Library Procedures" +.BS +.SH NAME +Tcl_InitStubs \- initialize the Tcl stubs mechanism +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +char * +\fBTcl_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 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. +This provides two significant benefits to Tcl users: +.IP 1) 5 +Extensions that use the stubs mechanism can be loaded into +multiple versions of Tcl without being recompiled or +relinked. +.IP 2) 5 +Extensions that use the stubs mechanism can be dynamically +loaded into statically-linked Tcl applications. +.PP +The stubs mechanism accomplishes this by exporting function tables +that define an interface to the Tcl API. The extension then accesses +the Tcl API through offsets into the function table, so there are no +direct references to any of the Tcl library's symbols. This +redirection is transparent to the extension, so an extension writer +can continue to use all public Tcl functions as documented. +.PP +The stubs mechanism requires no changes to applications incorporating +Tcl interpreters. Only developers creating C-based Tcl extensions +need to take steps to use the stubs mechanism with their extensions. +.PP +Enabling the stubs mechanism for an extension requires the following +steps: +.IP 1) 5 +Call \fBTcl_InitStubs\fR in the extension before calling any other +Tcl functions. +.IP 2) 5 +Define the USE_TCL_STUBS symbol. Typically, you would include the +-DUSE_TCL_STUBS flag when compiling the extension. +.IP 3) 5 +Link the extension with the Tcl stubs library instead of the standard +Tcl library. On Unix platforms, the library name is +\fIlibtclstub8.1.a\fR; on Windows platforms, the library name is +\fItclstub81.lib\fR. +.PP +If the extension also requires the Tk API, it must also call +\fBTk_InitStubs\fR to initialize the Tk stubs interface and link +with the Tk stubs libraries. See the \fBTk_InitStubs\fR page for +more information. +.SH DESCRIPTION +\fBTcl_InitStubs\fR attempts to initialize the stub table pointers +and ensure that the correct version of Tcl 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 Tcl 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 Tcl satisfying the request, or NULL if the Tcl version is not +acceptable, does not support stubs, or any other error condition occurred. +.SH "SEE ALSO" +\fBTk_InitStubs\fR +.SH KEYWORDS +stubs -- cgit v0.12