summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2013-04-03 12:38:46 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2013-04-03 12:38:46 (GMT)
commit07af7d5337d813d6bd0ce15b62b1b04de5db9e06 (patch)
tree7912a9f86c18588134250781a5558c58ee7e2f64 /doc
parent696a9ba3f9a7c0ed882dc6a3b878970f8a94d27c (diff)
downloadtcl-07af7d5337d813d6bd0ce15b62b1b04de5db9e06.zip
tcl-07af7d5337d813d6bd0ce15b62b1b04de5db9e06.tar.gz
tcl-07af7d5337d813d6bd0ce15b62b1b04de5db9e06.tar.bz2
better comments
Diffstat (limited to 'doc')
-rw-r--r--doc/InitSubSyst.322
1 files changed, 10 insertions, 12 deletions
diff --git a/doc/InitSubSyst.3 b/doc/InitSubSyst.3
index 4fd99c7..2d5c2bc 100644
--- a/doc/InitSubSyst.3
+++ b/doc/InitSubSyst.3
@@ -5,7 +5,7 @@
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
.so man.macros
-.TH Tcl_InitSubsystems 3 8.7 Tcl "Tcl Library Procedures"
+.TH Tcl_InitSubsystems 3 8.6.1 Tcl "Tcl Library Procedures"
.BS
.SH NAME
Tcl_InitSubsystems \- initialize the Tcl library.
@@ -19,9 +19,8 @@ const char *
.SH ARGUMENTS
.AS Tcl_PanicProc *panicProc
.AP Tcl_PanicProc *panicProc in
-Desired panic function, for error reporting. The value NULL is used
-when the default panicProc is desired, which normally writes the
-message to stderr.
+Desired panic function, for error reporting. If NULL, the default
+panicProc is used, which normally writes the message to stderr.
.BE
.SH DESCRIPTION
@@ -35,11 +34,12 @@ called once by Tcl embedders. Tcl_SetPanicProc is in the stub
table, meant for Tcl extenders, and can be called at any time
later to change the panic proc.
.PP
-\fBTcl_InitSubsystems\fR can be used in stead of
-\fBTcl_FindExecutable\fR when Tcl is used as utility library
-only, and no other encodings than utf8, iso8859-1 or unicode
-are used. The system encoding will not be determined
-correctly but being set to iso8859-1.
+\fBTcl_InitSubsystems\fR is very similar to
+\fBTcl_FindExecutable\fR as well. 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
@@ -53,8 +53,6 @@ const char *version = Tcl_InitSubSystems(NULL);
int major, minor, patch;
Tcl_GetVersion(&major, &minor, &patch);
.CE
-This will work as expected, both with and without stubs. When
-using stubs, this code must be linked with both the normal
-Tcl library (static or shared) and the stub library.
+This will work as expected, both with and without stubs.
.SH KEYWORDS
binary, executable file