summaryrefslogtreecommitdiffstats
path: root/doc/Tk_Init.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/Tk_Init.3')
-rw-r--r--doc/Tk_Init.347
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/Tk_Init.3 b/doc/Tk_Init.3
new file mode 100644
index 0000000..20ed41d
--- /dev/null
+++ b/doc/Tk_Init.3
@@ -0,0 +1,47 @@
+'\"
+'\" 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.
+'\"
+'\" SCCS: @(#) Tk_Init.3 1.3 96/03/26 18:19:08
+'\"
+.so man.macros
+.TH Tk_Init 3 4.1 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_Init \- add Tk to an interpreter and make a new Tk application.
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+int
+\fBTk_Init\fR(\fIinterp\fR)
+.SH ARGUMENTS
+.AS Tcl_Interp *interp
+.AP Tcl_Interp *interp in
+Interpreter in which to load Tk. Tk should not already be loaded
+in this interpreter.
+.BE
+
+.SH DESCRIPTION
+.PP
+\fBTk_Init\fR is the package initialization procedure for Tk.
+It is normally invoked by the \fBTcl_AppInit\fR procedure
+for an application or by the \fBload\fR command.
+\fBTk_Init\fR adds all of Tk's commands to \fIinterp\fR
+and creates a new Tk application, including its main window.
+If the initialization is successful \fBTk_Init\fR returns
+\fBTCL_OK\fR; if there is an error it returns \fBTCL_ERROR\fR.
+\fBTk_Init\fR also leaves a result or error message
+in \fIinterp->result\fR.
+.PP
+If there is a variable \fBargv\fR in \fIinterp\fR, \fBTk_Init\fR
+treats the contents of this variable as a list of options for the
+new Tk application.
+The options may have any of the forms documented for the
+\fBwish\fR application (in fact, \fBwish\fR uses Tk_Init to process
+its command-line arguments).
+
+.SH KEYWORDS
+application, initialization, load, main window