diff options
Diffstat (limited to 'doc/AppInit.3')
| -rw-r--r-- | doc/AppInit.3 | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/AppInit.3 b/doc/AppInit.3 index 32862c2..99e1555 100644 --- a/doc/AppInit.3 +++ b/doc/AppInit.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: AppInit.3,v 1.3.24.1 2006/07/30 16:18:41 jenglish Exp $ +'\" RCS: @(#) $Id: AppInit.3,v 1.9 2007/12/13 15:22:30 dgp Exp $ '\" .so man.macros .TH Tcl_AppInit 3 7.0 Tcl "Tcl Library Procedures" @@ -26,7 +26,9 @@ Interpreter for the application. .SH DESCRIPTION .PP -\fBTcl_AppInit\fR is a ``hook'' procedure that is invoked by +\fBTcl_AppInit\fR is a +.QW hook +procedure that is invoked by the main programs for Tcl applications such as \fBtclsh\fR and \fBwish\fR. Its purpose is to allow new Tcl applications to be created without modifying the main programs provided as part of Tcl and Tk. @@ -49,8 +51,8 @@ Tcl variables \fBargv\fR and \fBargv0\fR in \fIinterp\fR. .IP [3] Invoke a startup script to initialize the application. .LP -\fBTcl_AppInit\fR returns TCL_OK or TCL_ERROR. -If it returns TCL_ERROR then it must leave an error message in +\fBTcl_AppInit\fR returns \fBTCL_OK\fR or \fBTCL_ERROR\fR. +If it returns \fBTCL_ERROR\fR then it must leave an error message in for the interpreter's result; otherwise the result is ignored. .PP In addition to \fBTcl_AppInit\fR, your application should also contain @@ -60,7 +62,7 @@ Tcl_Main(argc, argv, Tcl_AppInit); .CE The third argument to \fBTcl_Main\fR gives the address of the application-specific initialization procedure to invoke. -This means that you don't have to use the name \fBTcl_AppInit\fR +This means that you do not have to use the name \fBTcl_AppInit\fR for the procedure, but in practice the name is nearly always \fBTcl_AppInit\fR (in versions before Tcl 7.4 the name \fBTcl_AppInit\fR was implicit; there was no way to specify the procedure explicitly). |