summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2021-04-29 11:28:50 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2021-04-29 11:28:50 (GMT)
commit15ba6741cfdbedfb264478ebef44ba013cf9fd97 (patch)
treefe7b8f6c6f8017e4b9ded3e4c570dac6cfeaf8b1 /doc
parentbe928297ad4c42c8888db9ed25a137d162fef621 (diff)
downloadtcl-15ba6741cfdbedfb264478ebef44ba013cf9fd97.zip
tcl-15ba6741cfdbedfb264478ebef44ba013cf9fd97.tar.gz
tcl-15ba6741cfdbedfb264478ebef44ba013cf9fd97.tar.bz2
doc update
Diffstat (limited to 'doc')
-rw-r--r--doc/FindExec.33
-rw-r--r--doc/InitSubSyst.35
-rw-r--r--doc/Panic.33
-rw-r--r--doc/zipfs.33
4 files changed, 12 insertions, 2 deletions
diff --git a/doc/FindExec.3 b/doc/FindExec.3
index 60b2cec..7f8c8a4 100644
--- a/doc/FindExec.3
+++ b/doc/FindExec.3
@@ -35,6 +35,9 @@ Tcl. For example, it is needed on some platforms in the
implementation of the \fBload\fR command.
It is also returned by the \fBinfo nameofexecutable\fR command.
.PP
+The result of \fBTcl_FindExecutable\fR is the full Tcl version (e.g.,
+\fB8.7.0+abcdef...abcdef.gcc-1002.utf16\fR).
+.PP
On UNIX platforms this procedure is typically invoked as the very
first thing in the application's main program; it must be passed
\fIargv[0]\fR as its argument. It is important not to change the
diff --git a/doc/InitSubSyst.3 b/doc/InitSubSyst.3
index 28e5f40..89f2b88 100644
--- a/doc/InitSubSyst.3
+++ b/doc/InitSubSyst.3
@@ -21,10 +21,13 @@ 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
+The result of \fBTcl_InitSubsystems\fR is the full Tcl version (e.g.,
+\fB8.7.0+abcdef...abcdef.gcc-1002.utf16\fR).
+.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
+iso8859-1 or utf-16 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.
.SH KEYWORDS
diff --git a/doc/Panic.3 b/doc/Panic.3
index 881ed2e..bd019db 100644
--- a/doc/Panic.3
+++ b/doc/Panic.3
@@ -82,6 +82,9 @@ making calls into the Tcl library, or into other libraries that may
call the Tcl library, since the original call to \fBTcl_Panic\fR
indicates the Tcl library is not in a state of reliable operation.
.PP
+The result of \fBTcl_SetPanicProc\fR is the full Tcl version (e.g.,
+\fB8.7.0+abcdef...abcdef.gcc-1002.utf16\fR).
+.PP
The typical use of \fBTcl_SetPanicProc\fR arranges for the error message
to be displayed or reported in a manner more suitable for the
application or the platform.
diff --git a/doc/zipfs.3 b/doc/zipfs.3
index cce6fb6..3b13cd9 100644
--- a/doc/zipfs.3
+++ b/doc/zipfs.3
@@ -87,7 +87,8 @@ it uses WCHAR instead of char. As a result, it requires your application to
be compiled with the UNICODE preprocessor symbol defined (e.g., via the
\fB-DUNICODE\fR compiler flag).
.PP
-The result of \fBTclZipfs_AppHook\fR is the Tcl version (e.g., \fB8.7.0\fR).
+The result of \fBTclZipfs_AppHook\fR is the full Tcl version (e.g.,
+\fB8.7.0+abcdef...abcdef.gcc-1002.utf16\fR).
The function \fImay\fR modify the variables pointed to by \fIargcPtr\fR and
\fIargvPtr\fR to remove arguments; the current implementation does not do so,
but callers \fIshould not\fR assume that this will be true in the future.