summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjenglish <jenglish@flightlab.com>2007-12-10 16:21:48 (GMT)
committerjenglish <jenglish@flightlab.com>2007-12-10 16:21:48 (GMT)
commit5c8f2ae9ffd186404e2a20ae2ccf84a940b68e3a (patch)
tree0ee94da3d693347342e32e793d31e0bf84d910b4 /doc
parentf617bac301ba7c2a99d135217b39fc1545d80915 (diff)
downloadtk-5c8f2ae9ffd186404e2a20ae2ccf84a940b68e3a.zip
tk-5c8f2ae9ffd186404e2a20ae2ccf84a940b68e3a.tar.gz
tk-5c8f2ae9ffd186404e2a20ae2ccf84a940b68e3a.tar.bz2
Various markup fixes
(mostly: missing quotes on .SH arguments, extraneous .PPs)
Diffstat (limited to 'doc')
-rw-r--r--doc/AddOption.315
-rw-r--r--doc/CrtImgType.35
-rw-r--r--doc/CrtPhImgFmt.35
-rw-r--r--doc/InternAtom.34
-rw-r--r--doc/TextLayout.35
-rw-r--r--doc/chooseColor.n3
-rw-r--r--doc/chooseDirectory.n3
-rw-r--r--doc/loadTk.n6
-rw-r--r--doc/palette.n4
9 files changed, 19 insertions, 31 deletions
diff --git a/doc/AddOption.3 b/doc/AddOption.3
index eccc8f2..a461f89 100644
--- a/doc/AddOption.3
+++ b/doc/AddOption.3
@@ -2,7 +2,7 @@
'\" Copyright (c) 1998-2000 by Scriptics Corporation.
'\" All rights reserved.
'\"
-'\" RCS: @(#) $Id: AddOption.3,v 1.4 2007/01/05 00:00:49 nijtmans Exp $
+'\" RCS: @(#) $Id: AddOption.3,v 1.5 2007/12/10 16:21:48 jenglish Exp $
'\"
'\"
.so man.macros
@@ -39,22 +39,17 @@ this value will be returned in calls to \fBTk_GetOption\fR.
queried using \fBTk_GetOption\fR, the value with the highest priority
is returned. \fIPriority\fR must be between 0 and \fBTK_MAX_PRIO\fR. Some
common priority values are:
-.TP
-20
+.IP 20
Used for default values hard-coded into widgets.
-.TP
-40
+.IP 40
Used for options specified in application-specific startup files.
-.TP
-60
+.IP 60
Used for options specified in user-specific defaults files, such as
\fB.Xdefaults\fR, resource databases loaded into the X server, or
user-specific startup files.
-.TP
-80
+.IP 80
Used for options specified interactively after the application starts
running.
-.PP
.SH KEYWORDS
class, name, option, add
diff --git a/doc/CrtImgType.3 b/doc/CrtImgType.3
index 88b9b82..5598d23 100644
--- a/doc/CrtImgType.3
+++ b/doc/CrtImgType.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: CrtImgType.3,v 1.11 2007/05/14 20:58:25 dgp Exp $
+'\" RCS: @(#) $Id: CrtImgType.3,v 1.12 2007/12/10 16:21:48 jenglish Exp $
'\"
.so man.macros
.TH Tk_CreateImageType 3 8.5 Tk "Tk Library Procedures"
@@ -250,8 +250,7 @@ and the return value is the ClientData value returned by the
pointer to the image master data structure). If no such image exists
then NULL is returned and NULL is stored at \fI*typePtrPtr\fR.
-.SH LEGACY INTERFACE SUPPORT
-.PP
+.SH "LEGACY INTERFACE SUPPORT"
In Tk 8.2 and earlier, the definition of \fBTk_ImageCreateProc\fR
was incompatibly different, with the following prototype:
.CS
diff --git a/doc/CrtPhImgFmt.3 b/doc/CrtPhImgFmt.3
index d640315..e34d1b0 100644
--- a/doc/CrtPhImgFmt.3
+++ b/doc/CrtPhImgFmt.3
@@ -9,7 +9,7 @@
'\" Department of Computer Science,
'\" Australian National University.
'\"
-'\" RCS: @(#) $Id: CrtPhImgFmt.3,v 1.8 2007/05/14 20:58:25 dgp Exp $
+'\" RCS: @(#) $Id: CrtPhImgFmt.3,v 1.9 2007/12/10 16:21:48 jenglish Exp $
'\"
.so man.macros
.TH Tk_CreatePhotoImageFormat 3 8.5 Tk "Tk Library Procedures"
@@ -231,8 +231,7 @@ after the name of the format. If appropriate, the
characters to specify further details about the image file.
The return value is a standard Tcl return value.
-.SH LEGACY INTERFACE SUPPORT
-.PP
+.SH "LEGACY INTERFACE SUPPORT"
In Tk 8.2 and earlier, the definition of all the function pointer
types stored in fields of a \fBTk_PhotoImageFormat\fR struct were
incompatibly different. Legacy programs and libraries dating from
diff --git a/doc/InternAtom.3 b/doc/InternAtom.3
index d63c014..a07a5f6 100644
--- a/doc/InternAtom.3
+++ b/doc/InternAtom.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: InternAtom.3,v 1.7 2007/10/29 16:04:12 dkf Exp $
+'\" RCS: @(#) $Id: InternAtom.3,v 1.8 2007/12/10 16:21:48 jenglish Exp $
'\"
.so man.macros
.TH Tk_InternAtom 3 "" Tk "Tk Library Procedures"
@@ -45,7 +45,7 @@ not free this space when finished with the string, and the caller
should not modify the contents of the returned string.
If there is no atom \fIatom\fR on \fItkwin\fR's display,
then \fBTk_GetAtomName\fR returns the string
-.QW ?bad atom? .
+.QW "?bad atom?" .
.PP
Tk caches
the information returned by \fBTk_InternAtom\fR and \fBTk_GetAtomName\fR
diff --git a/doc/TextLayout.3 b/doc/TextLayout.3
index f25706c..075598d 100644
--- a/doc/TextLayout.3
+++ b/doc/TextLayout.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: TextLayout.3,v 1.8 2007/10/29 16:04:13 dkf Exp $
+'\" RCS: @(#) $Id: TextLayout.3,v 1.9 2007/12/10 16:21:48 jenglish Exp $
'\"
.so man.macros
.TH Tk_ComputeTextLayout 3 8.1 Tk "Tk Library Procedures"
@@ -234,8 +234,7 @@ is the responsibility of the caller to take the Postscript array of
strings and add some Postscript function operate on the array to render
each of the lines. The code that represents the Postscript array of
strings is appended to \fIinterp->result\fR.
-.PP
-.SH DISPLAY MODEL
+.SH "DISPLAY MODEL"
When measuring a text layout, space characters that occur at the end of a
line are ignored. The space characters still exist and the insertion point
can be positioned amongst them, but their additional width is ignored when
diff --git a/doc/chooseColor.n b/doc/chooseColor.n
index afff881..48ba673 100644
--- a/doc/chooseColor.n
+++ b/doc/chooseColor.n
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: chooseColor.n,v 1.3 2002/10/02 21:12:41 hobbs Exp $
+'\" RCS: @(#) $Id: chooseColor.n,v 1.4 2007/12/10 16:21:48 jenglish Exp $
'\"
.so man.macros
.TH tk_chooseColor n 4.2 Tk "Tk Built-In Commands"
@@ -12,7 +12,6 @@
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
tk_chooseColor \- pops up a dialog box for the user to select a color.
-.PP
.SH SYNOPSIS
\fBtk_chooseColor \fR?\fIoption value ...\fR?
.BE
diff --git a/doc/chooseDirectory.n b/doc/chooseDirectory.n
index 9fac1d0..e377dd3 100644
--- a/doc/chooseDirectory.n
+++ b/doc/chooseDirectory.n
@@ -2,7 +2,7 @@
'\" Copyright (c) 1998-2000 by Scriptics Corporation.
'\" All rights reserved.
'\"
-'\" RCS: @(#) $Id: chooseDirectory.n,v 1.9 2007/11/04 10:37:50 das Exp $
+'\" RCS: @(#) $Id: chooseDirectory.n,v 1.10 2007/12/10 16:21:48 jenglish Exp $
'\"
.so man.macros
.TH tk_chooseDirectory n 8.3 Tk "Tk Built-In Commands"
@@ -10,7 +10,6 @@
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
tk_chooseDirectory \- pops up a dialog box for the user to select a directory.
-.PP
.SH SYNOPSIS
\fBtk_chooseDirectory \fR?\fIoption value ...\fR?
.BE
diff --git a/doc/loadTk.n b/doc/loadTk.n
index f38bf37..0f71d23 100644
--- a/doc/loadTk.n
+++ b/doc/loadTk.n
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: loadTk.n,v 1.10 2007/10/29 16:04:13 dkf Exp $
+'\" RCS: @(#) $Id: loadTk.n,v 1.11 2007/12/10 16:21:48 jenglish Exp $
'\"
.so man.macros
.TH "Safe Tk" n 8.0 Tk "Tk Built-In Commands"
@@ -15,15 +15,13 @@ loadTk \- Load Tk into a safe interpreter.
.SH SYNOPSIS
\fB::safe::loadTk \fIslave\fR ?\fB\-use\fR \fIwindowId\fR? ?\fB\-display\fR \fIdisplayName\fR?
.BE
-
+.SH DESCRIPTION
Safe Tk is based on Safe Tcl, which provides a mechanism
that allows restricted and mediated
access to auto-loading and packages for safe interpreters.
Safe Tk adds the ability to configure the interpreter
for safe Tk operations and load Tk into safe
interpreters.
-
-.SH DESCRIPTION
.PP
The \fB::safe::loadTk\fR command initializes the required data structures
in the named safe interpreter and then loads Tk into it.
diff --git a/doc/palette.n b/doc/palette.n
index 08d5cab..7b00d6e 100644
--- a/doc/palette.n
+++ b/doc/palette.n
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: palette.n,v 1.6 2007/11/01 23:03:54 dkf Exp $
+'\" RCS: @(#) $Id: palette.n,v 1.7 2007/12/10 16:21:48 jenglish Exp $
'\"
.so man.macros
.TH tk_setPalette n 4.0 Tk "Tk Built-In Commands"
@@ -34,7 +34,7 @@ of \fIname\fR\-\fIvalue\fR pairs, where the first argument of the pair
is the name of an option in the Tk option database and the second
argument is the new value to use for that option. The following
database names are currently supported:
-.DS L
+.DS
.ta 4c 8c
\fBactiveBackground\fR \fBforeground\fR \fBselectColor\fR
\fBactiveForeground\fR \fBhighlightBackground\fR \fBselectBackground\fR