summaryrefslogtreecommitdiffstats
path: root/doc/FindExec.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/FindExec.3')
-rw-r--r--doc/FindExec.312
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/FindExec.3 b/doc/FindExec.3
index f9d6d14..af9d9ad 100644
--- a/doc/FindExec.3
+++ b/doc/FindExec.3
@@ -4,10 +4,8 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: FindExec.3,v 1.4 2000/03/03 02:57:37 hobbs Exp $
-'\"
-.so man.macros
.TH Tcl_FindExecutable 3 8.1 Tcl "Tcl Library Procedures"
+.so man.macros
.BS
.SH NAME
Tcl_FindExecutable, Tcl_GetNameOfExecutable \- identify or return the name of the binary file containing the application
@@ -18,10 +16,10 @@ Tcl_FindExecutable, Tcl_GetNameOfExecutable \- identify or return the name of th
void
\fBTcl_FindExecutable\fR(\fIargv0\fR)
.sp
-CONST char *
+const char *
\fBTcl_GetNameOfExecutable\fR()
.SH ARGUMENTS
-.AS char *argv0 in
+.AS char *argv0
.AP char *argv0 in
The first command-line argument to the program, which gives the
application's name.
@@ -39,7 +37,9 @@ It is also returned by the \fBinfo nameofexecutable\fR command.
.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. \fBTcl_FindExecutable\fR uses \fIargv0\fR
+\fIargv[0]\fR as its argument. It is important not to change the
+working directory before the invocation.
+\fBTcl_FindExecutable\fR uses \fIargv0\fR
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