summaryrefslogtreecommitdiffstats
path: root/doc/FindExec.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/FindExec.3')
-rw-r--r--doc/FindExec.318
1 files changed, 3 insertions, 15 deletions
diff --git a/doc/FindExec.3 b/doc/FindExec.3
index 6156382..af9d9ad 100644
--- a/doc/FindExec.3
+++ b/doc/FindExec.3
@@ -3,7 +3,7 @@
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
-'\"
+'\"
.TH Tcl_FindExecutable 3 8.1 Tcl "Tcl Library Procedures"
.so man.macros
.BS
@@ -13,7 +13,7 @@ Tcl_FindExecutable, Tcl_GetNameOfExecutable \- identify or return the name of th
.nf
\fB#include <tcl.h>\fR
.sp
-const char *
+void
\fBTcl_FindExecutable\fR(\fIargv0\fR)
.sp
const char *
@@ -35,9 +35,6 @@ 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 with build
-information (e.g., \fB8.7.0+abcdef...abcdef.gcc-1002\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
@@ -48,21 +45,12 @@ application's executable, if possible. If it fails to find
the binary, then future calls to \fBinfo nameofexecutable\fR
will return an empty string.
.PP
-On Windows platforms this procedure is typically invoked as the very
-first thing in the application's main program as well; Its \fIargv[0]\fR
-argument is only used to indicate whether the executable has a stderr
-channel (any non-null value) or not (the value null). If \fBTcl_SetPanicProc\fR
-is never called and no debugger is running, this determines whether
-the panic message is sent to stderr or to a standard system dialog.
-.PP
\fBTcl_GetNameOfExecutable\fR simply returns a pointer to the
internal full path name of the executable file as computed by
\fBTcl_FindExecutable\fR. This procedure call is the C API
equivalent to the \fBinfo nameofexecutable\fR command. NULL
is returned if the internal full path name has not been
computed or unknown.
-.PP
-\fBTcl_FindExecutable\fR can not be used in stub-enabled extensions. Its symbol
-entry in the stub table is deprecated and it will be removed in Tcl 9.0.
+
.SH KEYWORDS
binary, executable file