diff options
Diffstat (limited to 'doc/Tcl_Main.3')
| -rw-r--r-- | doc/Tcl_Main.3 | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/doc/Tcl_Main.3 b/doc/Tcl_Main.3 index 4f29c82..54b2e84 100644 --- a/doc/Tcl_Main.3 +++ b/doc/Tcl_Main.3 @@ -19,7 +19,7 @@ Tcl_Main, Tcl_SetMainLoop \- main program and event loop definition for Tcl-base .sp \fBTcl_SetMainLoop\fR(\fImainLoopProc\fR) .SH ARGUMENTS -.AS Tcl_AppInitProc *appInitProc +.AS Tcl_MainLoopProc *mainLoopProc .AP int argc in Number of elements in \fIargv\fR. .AP char *argv[] in @@ -34,7 +34,9 @@ Address of an application-specific event loop procedure. .SH DESCRIPTION .PP \fBTcl_Main\fR can serve as the main program for Tcl-based shell -applications. A ``shell application'' is a program +applications. A +.QW "shell application" +is a program like tclsh or wish that supports both interactive interpretation of Tcl and evaluation of a script contained in a file given as a command line argument. \fBTcl_Main\fR is offered as a convenience @@ -74,9 +76,12 @@ channels to their default values. See \fBTcl_StandardChannels\fR for more information. .PP \fBTcl_Main\fR supports two modes of operation, depending on the -values of \fIargc\fR and \fIargv\fR. If \fIargv[1]\fR exists and -does not begin with the character \fI-\fR, it is taken to be the -name of a file containing a \fIstartup script\fR, which \fBTcl_Main\fR +values of \fIargc\fR and \fIargv\fR. If the first few arguments +in \fIargv\fR match ?\fB\-encoding \fIname\fR? \fIfileName\fR, +where \fIfileName\fR does not begin with the character \fI\-\fR, +then \fIfileName\fR is taken to be the name of a file containing +a \fIstartup script\fR, and \fIname\fR is taken to be the name +of the encoding of the contents of that file, which \fBTcl_Main\fR will attempt to evaluate. Otherwise, \fBTcl_Main\fR will enter an interactive mode. .PP @@ -86,8 +91,9 @@ the Tcl variables \fIargc\fR, \fIargv\fR, \fIargv0\fR, and .PP When it has finished its own initialization, but before it processes commands, \fBTcl_Main\fR calls the procedure given by the -\fIappInitProc\fR argument. This procedure provides a ``hook'' for -the application to perform its own initialization of the interpreter +\fIappInitProc\fR argument. This procedure provides a +.QW hook +for the application to perform its own initialization of the interpreter created by \fBTcl_Main\fR, such as defining application-specific commands. The procedure must have an interface that matches the type \fBTcl_AppInitProc\fR: @@ -114,7 +120,6 @@ The prompts and command evaluation results are written to the standard output channel only if the Tcl variable \fItcl_interactive\fR in the master interpreter holds a non-zero integer value. .PP -.VS 8.4 \fBTcl_SetMainLoop\fR allows setting an event loop procedure to be run. This allows, for example, Tk to be dynamically loaded and set its event loop. The event loop will run following the startup script. If you @@ -127,7 +132,6 @@ The main loop procedure must have an interface that matches the type .CS typedef void Tcl_MainLoopProc(void); .CE -.VE 8.4 .PP \fBTcl_Main\fR does not return. Normally a program based on \fBTcl_Main\fR will terminate when the \fBexit\fR command is |