OSDN Git Service

touched all tk files to ease next import
[pf3gnuchains/pf3gnuchains4x.git] / tk / doc / tkvars.n
1 '\"
2 '\" Copyright (c) 1990-1994 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
4 '\"
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7 '\" 
8 '\" RCS: @(#) $Id$
9 '\" 
10 .so man.macros
11 .TH tkvars n 4.1 Tk "Tk Built-In Commands"
12 .BS
13 '\" Note:  do not modify the .SH NAME line immediately below!
14 .SH NAME
15 tkvars \- Variables used or set by Tk
16 .BE
17
18 .SH DESCRIPTION
19 .PP
20 The following Tcl variables are either set or used by Tk at various times
21 in its execution:
22 .TP 15
23 \fBtk_library\fR
24 This variable holds the file name for a directory containing a library
25 of Tcl scripts related to Tk.  These scripts include an initialization
26 file that is normally processed whenever a Tk application starts up,
27 plus other files containing procedures that implement default behaviors
28 for widgets.
29 The initial value of \fBtcl_library\fR is set when Tk is added to
30 an interpreter;  this is done by searching several different directories
31 until one is found that contains an appropriate Tk startup script.
32 If the \fBTK_LIBRARY\fR environment variable exists, then
33 the directory it names is checked first.
34 If \fBTK_LIBRARY\fR isn't set or doesn't refer to an appropriate
35 directory, then Tk checks several other directories based on a
36 compiled-in default location, the location of the Tcl library directory,
37 the location of the binary containing the application, and the current
38 working directory.
39 The variable can be modified by an application to switch to a different
40 library.
41 .TP
42 \fBtk_patchLevel\fR
43 Contains a decimal integer giving the current patch level for Tk.
44 The patch level is incremented for each new release or patch, and
45 it uniquely identifies an official version of Tk.
46 .TP
47 \fBtkPriv\fR
48 This variable is an array containing several pieces of information
49 that are private to Tk.  The elements of \fBtkPriv\fR are used by
50 Tk library procedures and default bindings.
51 They should not be accessed by any code outside Tk.
52 .TP
53 \fBtk_strictMotif\fR
54 This variable is set to zero by default.
55 If an application sets it to one, then Tk attempts to adhere as
56 closely as possible to Motif look-and-feel standards.
57 For example, active elements such as buttons and scrollbar
58 sliders will not change color when the pointer passes over them.
59 .TP 15
60 \fBtk_version\fR
61 Tk sets this variable in the interpreter for each application.
62 The variable holds the current version number of the Tk
63 library in the form \fImajor\fR.\fIminor\fR.  \fIMajor\fR and
64 \fIminor\fR are integers.  The major version number increases in
65 any Tk release that includes changes that are not backward compatible
66 (i.e. whenever existing Tk applications and scripts may have to change to
67 work with the new release).  The minor version number increases with
68 each new release of Tk, except that it resets to zero whenever the
69 major version number changes.
70
71 .SH KEYWORDS
72 variables, version
73