aboutsummaryrefslogtreecommitdiff
path: root/contrib/tcl/doc/Tcl_Main.3
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/tcl/doc/Tcl_Main.3')
-rw-r--r--contrib/tcl/doc/Tcl_Main.361
1 files changed, 0 insertions, 61 deletions
diff --git a/contrib/tcl/doc/Tcl_Main.3 b/contrib/tcl/doc/Tcl_Main.3
deleted file mode 100644
index 15c0f3eee073..000000000000
--- a/contrib/tcl/doc/Tcl_Main.3
+++ /dev/null
@@ -1,61 +0,0 @@
-'\"
-'\" Copyright (c) 1994 The Regents of the University of California.
-'\" Copyright (c) 1994-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.
-'\"
-'\" SCCS: @(#) Tcl_Main.3 1.8 96/03/25 20:08:33
-'\"
-.so man.macros
-.TH Tcl_Main 3 7.4 Tcl "Tcl Library Procedures"
-.BS
-.SH NAME
-Tcl_Main \- main program for Tcl-based applications
-.SH SYNOPSIS
-.nf
-\fB#include <tcl.h>\fR
-.sp
-\fBTcl_Main\fR(\fIargc, argv, appInitProc\fR)
-.SH ARGUMENTS
-.AS Tcl_AppInitProc *appInitProc
-.AP int argc in
-Number of elements in \fIargv\fR.
-.AP char *argv[] in
-Array of strings containing command-line arguments.
-.AP Tcl_AppInitProc *appInitProc in
-Address of an application-specific initialization procedure.
-The value for this argument is usually \fBTcl_AppInit\fR.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTcl_Main\fR acts as the main program for most Tcl-based applications.
-Starting with Tcl 7.4 it is not called \fBmain\fR anymore because it
-is part of the Tcl library and having a function \fBmain\fR
-in a library (particularly a shared library) causes problems on many
-systems.
-Having \fBmain\fR in the Tcl library would also make it hard to use
-Tcl in C++ programs, since C++ programs must have special C++
-\fBmain\fR functions.
-.PP
-Normally each application contains a small \fBmain\fR function that does
-nothing but invoke \fBTcl_Main\fR.
-\fBTcl_Main\fR then does all the work of creating and running a
-\fBtclsh\fR-like application.
-.PP
-When it is 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, such as defining
-application-specific commands. The procedure must have an interface
-that matches the type \fBTcl_AppInitProc\fR:
-.CS
-typedef int Tcl_AppInitProc(Tcl_Interp *\fIinterp\fR);
-.CE
-\fIAppInitProc\fR is almost always a pointer to \fBTcl_AppInit\fR;
-for more details on this procedure, see the documentation
-for \fBTcl_AppInit\fR.
-
-.SH KEYWORDS
-application-specific initialization, command-line arguments, main program