Added documentation for the C API "Tcl_GetNameOfExecutable" which simply

  returns a pointer to the internal "tclExecutablename" char* variable.


FossilOrigin-Name: 536c7b21c3f92661f4f58a0cffe5bfe3883d9444

1 files changed, 14 insertions, 4 deletions

diff --git a/doc/FindExec.3 b/doc/FindExec.3
index b48b225..c22f0fe 100644
--- a/doc/FindExec.3
+++ b/doc/FindExec.3
@@ -10,13 +10,16 @@
 .TH Tcl_FindExecutable 3 7.5 Tcl "Tcl Library Procedures"
 .BS
 .SH NAME
-Tcl_FindExecutable \- identify the binary file containing the application
+Tcl_FindExecutable, Tcl_GetNameOfExecutable \- identify or return the name of the binary file containing the application
 .SH SYNOPSIS
 .nf
 \fB#include <tcl.h>\fR
 .sp
 char *
 \fBTcl_FindExecutable\fR(\fIargv0\fR)
+.sp
+CONST char *
+\fBTcl_GetNameOfExecutable\fR()
 .SH ARGUMENTS
 .AS char *argv0 in
 .AP char *argv0 in
@@ -26,9 +29,9 @@ application's name.
 
 .SH DESCRIPTION
 .PP
-This procedure computes the full path name of the executable file
-from which the application was invoked and saves it for Tcl's
-internal use.
+The \fBTcl_FindExecutable\fR procedure computes the full path name of
+the executable file from which the application was invoked and saves
+it for Tcl's internal use.
 The executable's path name is needed for several purposes in
 Tcl.  For example, it is needed on some platforms in the
 implementation of the \fBload\fR command.
@@ -41,6 +44,13 @@ along with the \fBPATH\fR environment variable to find the
 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
+\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.
 
 .SH KEYWORDS
 binary, executable file