diff options
author | jan.nijtmans <nijtmans@users.sourceforge.net> | 2013-04-03 21:24:39 (GMT) |
---|---|---|
committer | jan.nijtmans <nijtmans@users.sourceforge.net> | 2013-04-03 21:24:39 (GMT) |
commit | 9ce336b3d1888299ce52e15fc458bb816d66e04d (patch) | |
tree | e479818aa2b7f9aa45d4d5954b6f1c8b4d37eff6 /doc | |
parent | bce112e4250eecd1e75a2f77ec51ed51bf3f281d (diff) | |
parent | 07af7d5337d813d6bd0ce15b62b1b04de5db9e06 (diff) | |
download | tcl-9ce336b3d1888299ce52e15fc458bb816d66e04d.zip tcl-9ce336b3d1888299ce52e15fc458bb816d66e04d.tar.gz tcl-9ce336b3d1888299ce52e15fc458bb816d66e04d.tar.bz2 |
rebase
Diffstat (limited to 'doc')
-rw-r--r-- | doc/InitSubSyst.3 | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/InitSubSyst.3 b/doc/InitSubSyst.3 new file mode 100644 index 0000000..08b3154 --- /dev/null +++ b/doc/InitSubSyst.3 @@ -0,0 +1,53 @@ +'\" +'\" Copyright (c) 2013 Tcl Core Team +'\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +.so man.macros +.TH Tcl_InitSubsystems 3 8.6.1 Tcl "Tcl Library Procedures" +.BS +.SH NAME +Tcl_InitSubsystems \- initialize the Tcl library. +.SH SYNOPSIS +.nf +\fB#include <tcl.h>\fR +.sp +const char * +\fBTcl_InitSubsystems\fR(\fIpanicProc\fR) +.SH ARGUMENTS +.SH ARGUMENTS +.AS Tcl_PanicProc *panicProc +.AP Tcl_PanicProc *panicProc in +Desired panic function, for error reporting. If NULL, the default +panicProc is used, which normally writes the message to stderr. +.BE + +.SH DESCRIPTION +.PP +The \fBTcl_InitSubsystems\fR procedure initializes the Tcl +library. This procedure is typically invoked as the very +first thing in the application's main program. +.PP +\fBTcl_InitSubsystems\fR is very similar in use to +\fBTcl_FindExecutable\fR. It can be used when Tcl is +used as utility library, no other encodings than utf8, +iso8859-1 or unicode are used, and no interest exists in the +value of \fBinfo nameofexecutable\fR. The system encoding will not +be extracted from the environment, but falls back to iso8859-1. +.PP +The return value is the Tcl version. +.PP +If \fBTcl_InitSubsystems()\fR is called in code where +\fBUSE_TCL_STUBS\fR is set, it does one additional thing: +initialize the Stub table for using Tcl as utility +library, without needing a Tcl interpreter. For example: +.CS +const char *version = Tcl_InitSubSystems(NULL); +/* At this point, Tcl C API calls without interp are ready for use */ +int major, minor, patch; +Tcl_GetVersion(&major, &minor, &patch); +.CE +This will work as expected, both with and without stubs. +.SH KEYWORDS +binary, executable file |