Reorganize to split "interesting" variables from internal/debug ones.

Improved the list of keywords.

1 files changed, 39 insertions, 17 deletions

diff --git a/doc/tkvars.n b/doc/tkvars.n
index c5492b0..f5b1f7c 100644
--- a/doc/tkvars.n
+++ b/doc/tkvars.n
@@ -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: tkvars.n,v 1.7 2008/09/23 13:36:55 dkf Exp $
+'\" RCS: @(#) $Id: tkvars.n,v 1.8 2010/01/13 15:24:29 dkf Exp $
 '\" 
 .so man.macros
 .TH tkvars n 4.1 Tk "Tk Built-In Commands"
@@ -20,11 +20,14 @@ The following Tcl variables are either set or used by Tk at various times
 in its execution:
 .TP 15
 \fBtk_library\fR
+.
 This variable holds the file name for a directory containing a library
 of Tcl scripts related to Tk.  These scripts include an initialization
 file that is normally processed whenever a Tk application starts up,
 plus other files containing procedures that implement default behaviors
 for widgets.
+.RS
+.PP
 The initial value of \fBtcl_library\fR is set when Tk is added to
 an interpreter;  this is done by searching several different directories
 until one is found that contains an appropriate Tk startup script.
@@ -35,36 +38,34 @@ directory, then Tk checks several other directories based on a
 compiled-in default location, the location of the Tcl library directory,
 the location of the binary containing the application, and the current
 working directory.
+.PP
 The variable can be modified by an application to switch to a different
 library.
+.RE
 .TP
 \fBtk_patchLevel\fR
-Contains a decimal integer giving the current patch level for Tk.
+.
+Contains a dot-separated sequence of decimal integers giving the
+current patch level for Tk.
 The patch level is incremented for each new release or patch, and
 it uniquely identifies an official version of Tk.
-.TP
-\fBtk::Priv\fR
-This variable is an array containing several pieces of information
-that are private to Tk.  The elements of \fBtk::Priv\fR are used by
-Tk library procedures and default bindings.
-They should not be accessed by any code outside Tk.
+.RS
+.PP
+This value is normally the same as the result of
+.QW "\fBpackage require\fR \fBTk\fR" .
+.RE
 .TP
 \fBtk_strictMotif\fR
+.
 This variable is set to zero by default.
 If an application sets it to one, then Tk attempts to adhere as
 closely as possible to Motif look-and-feel standards.
 For example, active elements such as buttons and scrollbar
 sliders will not change color when the pointer passes over them.
-.TP
-\fBtk_textRedraw\fR
-.TP
-\fBtk_textRelayout\fR
-These variables are set by text widgets when they have debugging
-turned on.  The values written to these variables can be used to
-test or debug text widget operations.  These variables are mostly
-used by Tk's test suite.
+Modern applications should not normally set this variable.
 .TP 15
 \fBtk_version\fR
+.
 Tk sets this variable in the interpreter for each application.
 The variable holds the current version number of the Tk
 library in the form \fImajor\fR.\fIminor\fR.  \fIMajor\fR and
@@ -74,8 +75,29 @@ any Tk release that includes changes that are not backward compatible
 work with the new release).  The minor version number increases with
 each new release of Tk, except that it resets to zero whenever the
 major version number changes.
+.SS "INTERNAL AND DEBUGGING VARIABLES"
+.PP
+These variables should not normally be set by user code.
+.TP
+\fBtk::Priv\fR
+.
+This variable is an array containing several pieces of information
+that are private to Tk.  The elements of \fBtk::Priv\fR are used by
+Tk library procedures and default bindings.
+They should not be accessed by any code outside Tk.
+.TP
+\fBtk_textRedraw\fR
+.TP
+\fBtk_textRelayout\fR
+.
+These variables are set by text widgets when they have debugging
+turned on.  The values written to these variables can be used to
+test or debug text widget operations.  These variables are mostly
+used by Tk's test suite.
+.SH "SEE ALSO"
+package(n), tclvars(n)
 .SH KEYWORDS
-variables, version, text
+environment, text, variables, version
 '\" Local Variables:
 '\" mode: nroff
 '\" End: