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

FossilOrigin-Name: cb766997828a1394b6ca4c6ce6f138c4a1e2ce68

1 files changed, 15 insertions, 3 deletions

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