Standardize the -compound option to everywhere it ought to be. [Bug 712588]

7 files changed, 62 insertions, 70 deletions

diff --git a/ChangeLog b/ChangeLog
index 2f454e3..515b62d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2004-08-16  Donal K. Fellows  <donal.k.fellows@man.ac.uk>
 
+	* doc/button.n, doc/checkbutton.n, doc/label.n, doc/menubutton.n:
+	* doc/radiobutton.n: Added cross-reference to new standard option.
+	* doc/options.n: Added standard documentation for the -compound
+	option. [Bug 712588]
+
 	* doc/canvas.n: Spelling and grammar fixes from Mikhail
 	Kolesnitschenko. [Bug 1009636]
 
diff --git a/doc/button.n b/doc/button.n
index d2818fd..d05e76e 100644
--- a/doc/button.n
+++ b/doc/button.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: button.n,v 1.6 2000/08/25 06:58:31 ericm Exp $
+'\" RCS: @(#) $Id: button.n,v 1.7 2004/08/16 14:01:10 dkf Exp $
 '\" 
 .so man.macros
 .TH button n 4.4 Tk "Tk Built-In Commands"
@@ -16,31 +16,22 @@ button \- Create and manipulate button widgets
 .SH SYNOPSIS
 \fBbutton\fR \fIpathName \fR?\fIoptions\fR?
 .SO
-\-activebackground	\-foreground	\-repeatdelay
-\-activeforeground	\-highlightbackground	\-repeatinterval
-\-anchor	\-highlightcolor	\-takefocus
-\-background	\-highlightthickness	\-text
-\-bitmap	\-image	\-textvariable
-\-borderwidth	\-justify	\-underline
+\-activebackground	\-font	\-relief
+\-activeforeground	\-foreground	\-repeatdelay
+\-anchor	\-highlightbackground	\-repeatinterval
+\-background	\-highlightcolor	\-takefocus
+\-bitmap	\-highlightthickness	\-text
+\-borderwidth	\-image	\-textvariable
+\-compound	\-justify	\-underline
 \-cursor	\-padx	\-wraplength
 \-disabledforeground	\-pady
-\-font	\-relief
+
 .SE
 .SH "WIDGET-SPECIFIC OPTIONS"
 .OP \-command command Command
 Specifies a Tcl command to associate with the button.  This command
 is typically invoked when mouse button 1 is released over the button
 window.
-.VS 8.4
-.OP \-compound compound Compound
-Specifies whether the button should display both an image and text,
-and if so, where the image should be placed relative to the text.
-Valid values for this option are \fBbottom\fR, \fBcenter\fR,
-\fBleft\fR, \fBnone\fR, \fBright\fR and \fBtop\fR.  The default value
-is \fBnone\fR, meaning that the button will display either an image or
-text, depending on the values of the \fB\-image\fR and \fB\-bitmap\fR
-options.
-.VE
 .OP \-default default Default
 .VS
 Specifies one of three states for the default ring: \fBnormal\fR,
diff --git a/doc/checkbutton.n b/doc/checkbutton.n
index ff8d74a..b7607df 100644
--- a/doc/checkbutton.n
+++ b/doc/checkbutton.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: checkbutton.n,v 1.7 2004/02/18 00:40:23 hobbs Exp $
+'\" RCS: @(#) $Id: checkbutton.n,v 1.8 2004/08/16 14:01:10 dkf Exp $
 '\" 
 .so man.macros
 .TH checkbutton n 4.4 Tk "Tk Built-In Commands"
@@ -16,14 +16,14 @@ checkbutton \- Create and manipulate checkbutton widgets
 .SH SYNOPSIS
 \fBcheckbutton\fI pathName \fR?\fIoptions\fR?
 .SO
-\-activebackground	\-font	\-pady
-\-activeforeground	\-foreground	\-relief
-\-anchor	\-highlightbackground	\-takefocus
-\-background	\-highlightcolor	\-text
-\-bitmap	\-highlightthickness	\-textvariable
-\-borderwidth	\-image	\-underline
+\-activebackground	\-disabledforeground	\-padx
+\-activeforeground	\-font	\-pady
+\-anchor	\-foreground	\-relief
+\-background	\-highlightbackground	\-takefocus
+\-bitmap	\-highlightcolor	\-text
+\-borderwidth	\-highlightthickness	\-textvariable
+\-compound	\-image	\-underline
 \-cursor	\-justify	\-wraplength
-\-disabledforeground	\-padx
 .SE
 .SH "WIDGET-SPECIFIC OPTIONS"
 .OP \-command command Command
diff --git a/doc/label.n b/doc/label.n
index 4b53889..cc377c4 100644
--- a/doc/label.n
+++ b/doc/label.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: label.n,v 1.6 2002/12/18 21:46:48 tmh Exp $
+'\" RCS: @(#) $Id: label.n,v 1.7 2004/08/16 14:01:10 dkf Exp $
 '\" 
 .so man.macros
 .TH label n 4.0 Tk "Tk Built-In Commands"
@@ -16,24 +16,16 @@ label \- Create and manipulate label widgets
 .SH SYNOPSIS
 \fBlabel\fR \fIpathName \fR?\fIoptions\fR?
 .SO
-\-activebackground	\-font	\-pady
-\-activeforeground	\-foreground	\-relief
-\-anchor	\-highlightbackground	\-takefocus
-\-background	\-highlightcolor	\-text
-\-bitmap	\-highlightthickness	\-textvariable
-\-borderwidth	\-image	\-underline
+\-activebackground	\-disabledforeground	\-padx
+\-activeforeground	\-font	\-pady
+\-anchor	\-foreground	\-relief
+\-background	\-highlightbackground	\-takefocus
+\-bitmap	\-highlightcolor	\-text
+\-borderwidth	\-highlightthickness	\-textvariable
+\-compound	\-image	\-underline
 \-cursor	\-justify	\-wraplength
-\-disabledforeground	\-padx	
 .SE
 .SH "WIDGET-SPECIFIC OPTIONS"
-.OP \-compound compound Compound
-Specifies whether the label should display both an image and text,
-and if so, where the image should be placed relative to the text.
-Valid values for this option are \fBbottom\fR, \fBcenter\fR,
-\fBleft\fR, \fBnone\fR, \fBright\fR and \fBtop\fR.  The default value
-is \fBnone\fR, meaning that the label will display either an image or
-text, depending on the values of the \fB\-image\fR and \fB\-bitmap\fR
-options.
 .OP \-height height Height
 Specifies a desired height for the label.
 If an image or bitmap is being displayed in the label then the value is in
diff --git a/doc/menubutton.n b/doc/menubutton.n
index 8ae4fcf..2f0bef8 100644
--- a/doc/menubutton.n
+++ b/doc/menubutton.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: menubutton.n,v 1.5 2004/02/04 00:25:13 hobbs Exp $
+'\" RCS: @(#) $Id: menubutton.n,v 1.6 2004/08/16 14:01:10 dkf Exp $
 '\" 
 .so man.macros
 .TH menubutton n 4.0 Tk "Tk Built-In Commands"
@@ -16,24 +16,16 @@ menubutton \- Create and manipulate menubutton widgets
 .SH SYNOPSIS
 \fBmenubutton\fR \fIpathName \fR?\fIoptions\fR?
 .SO
-\-activebackground	\-font	\-pady
-\-activeforeground	\-foreground	\-relief
-\-anchor	\-highlightbackground	\-takefocus
-\-background	\-highlightcolor	\-text
-\-bitmap	\-highlightthickness	\-textvariable
-\-borderwidth	\-image	\-underline
-\-cursor	\-justify	\-wraplength
-\-disabledforeground	\-padx
+\-activebackground	\-disabledforeground	\-padx
+\-activeforeground	\-font	\-pady
+\-anchor	\-foreground	\-relief
+\-background	\-highlightbackground	\-takefocus
+\-bitmap	\-highlightcolor	\-text
+\-borderwidth	\-highlightthickness	\-textvariable
+\-cursor	\-image	\-underline
+\-compound	\-justify	\-wraplength
 .SE
 .SH "WIDGET-SPECIFIC OPTIONS"
-.OP \-compound compound Compound
-Specifies whether the menubutton should display both an image and text,
-and if so, where the image should be placed relative to the text.
-Valid values for this option are \fBbottom\fR, \fBcenter\fR,
-\fBleft\fR, \fBnone\fR, \fBright\fR and \fBtop\fR.  The default value
-is \fBnone\fR, meaning that the menubutton will display either an image or
-text, depending on the values of the \fB\-image\fR and \fB\-bitmap\fR
-options.
 .OP \-direction direction Height
 Specifies where the menu is going to be popup up. \fBabove\fR tries to
 pop the menu above the menubutton. \fBbelow\fR tries to pop the menu
diff --git a/doc/options.n b/doc/options.n
index 1801a42..95d1af1 100644
--- a/doc/options.n
+++ b/doc/options.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: options.n,v 1.6 2000/07/25 21:14:35 jenglish Exp $
+'\" RCS: @(#) $Id: options.n,v 1.7 2004/08/16 14:01:10 dkf Exp $
 '\" 
 .so man.macros
 .TH options n 4.4 Tk "Tk Built-In Commands"
@@ -75,7 +75,8 @@ acceptable to \fBTk_GetBitmap\fR.
 The exact way in which the bitmap is displayed may be affected by
 other options such as \fBanchor\fR or \fBjustify\fR.
 Typically, if this option is specified then it overrides other
-options that specify a textual value to display in the widget;
+options that specify a textual value to display in the widget
+but this is controlled by the \fBcompound\fR option;
 the \fBbitmap\fR option may be reset to an empty string to re-enable
 a text display.
 In widgets that support both \fBbitmap\fR and \fBimage\fR options,
@@ -90,6 +91,16 @@ The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
 .OP \-cursor cursor Cursor
 Specifies the mouse cursor to be used for the widget.
 The value may have any of the forms acceptable to \fBTk_GetCursor\fR.
+.OP \-compound compound Compound
+Specifies if the widget should display text and bitmaps/images at the
+same time, and if so, where the bitmap/image should be placed relative
+to the text.  Must be one of the values \fBnone\fR, \fBbottom\fR,
+\fBtop\fR, \fBleft\fR, \fBright\fR, or \fBcenter\fR.  For example, the
+(default) value \fBnone\fR specifies that the bitmap or image should
+(if defined) be displayed instead of the text, the value \fBleft\fR
+specifies that the bitmap or image should be displayed to the left of
+the text, and the value \fBcenter\fR specifies that the bitmap or
+image should be displayed on top of the text.
 .OP \-disabledforeground disabledForeground DisabledForeground
 Specifies foreground color to use when drawing a disabled element.
 If the option is specified as an empty string (which is typically the
@@ -127,7 +138,8 @@ If the value is zero, no focus highlight is drawn around the widget.
 Specifies an image to display in the widget, which must have been
 created with the \fBimage create\fR command.
 Typically, if the \fBimage\fR option is specified then it overrides other
-options that specify a bitmap or textual value to display in the widget;
+options that specify a bitmap or textual value to display in the
+widget, though this is controlled by the \fBcompound\fR option;
 the \fBimage\fR option may be reset to an empty string to re-enable
 a bitmap or text display.
 .OP \-insertbackground insertBackground Foreground
diff --git a/doc/radiobutton.n b/doc/radiobutton.n
index 239d07a..73bb98e 100644
--- a/doc/radiobutton.n
+++ b/doc/radiobutton.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: radiobutton.n,v 1.7 2004/02/18 00:40:24 hobbs Exp $
+'\" RCS: @(#) $Id: radiobutton.n,v 1.8 2004/08/16 14:01:09 dkf Exp $
 '\" 
 .so man.macros
 .TH radiobutton n 4.4 Tk "Tk Built-In Commands"
@@ -16,14 +16,14 @@ radiobutton \- Create and manipulate radiobutton widgets
 .SH SYNOPSIS
 \fBradiobutton\fR \fIpathName \fR?\fIoptions\fR?
 .SO
-\-activebackground	\-font	\-pady
-\-activeforeground	\-foreground	\-relief
-\-anchor	\-highlightbackground	\-takefocus
-\-background	\-highlightcolor	\-text
-\-bitmap	\-highlightthickness	\-textvariable
-\-borderwidth	\-image	\-underline
+\-activebackground	\-disabledforeground	\-padx
+\-activeforeground	\-font	\-pady
+\-anchor	\-foreground	\-relief
+\-background	\-highlightbackground	\-takefocus
+\-bitmap	\-highlightcolor	\-text
+\-borderwidth	\-highlightthickness	\-textvariable
+\-compound	\-image	\-underline
 \-cursor	\-justify	\-wraplength
-\-disabledforeground	\-padx
 .SE
 .SH "WIDGET-SPECIFIC OPTIONS"
 .OP \-command command Command