diff options
Diffstat (limited to 'doc/FindExec.3')
| -rw-r--r-- | doc/FindExec.3 | 56 |
1 files changed, 0 insertions, 56 deletions
diff --git a/doc/FindExec.3 b/doc/FindExec.3 deleted file mode 100644 index 098c7a2..0000000 --- a/doc/FindExec.3 +++ /dev/null @@ -1,56 +0,0 @@ -'\" -'\" Copyright (c) 1995-1996 Sun Microsystems, Inc. -'\" -'\" 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.3 1998/09/14 18:39:48 stanton Exp $ -'\" -.so man.macros -.TH Tcl_FindExecutable 3 7.5 Tcl "Tcl Library Procedures" -.BS -.SH NAME -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 -The first command-line argument to the program, which gives the -application's name. -.BE - -.SH DESCRIPTION -.PP -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. -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 -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 |