summaryrefslogtreecommitdiffstats
path: root/doc/message.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2013-09-23 19:51:51 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2013-09-23 19:51:51 (GMT)
commitc23066514482f0e8e2b176b7e4d1703f31c66afb (patch)
tree41393445b6b2b0c31971f570d09b0d4220d4c83b /doc/message.n
parentfda5a92486b6dbcc21fa7a92de8cde9615f315a8 (diff)
downloadtk-c23066514482f0e8e2b176b7e4d1703f31c66afb.zip
tk-c23066514482f0e8e2b176b7e4d1703f31c66afb.tar.gz
tk-c23066514482f0e8e2b176b7e4d1703f31c66afb.tar.bz2
Documentation tweaks to make index entries more informative.
Diffstat (limited to 'doc/message.n')
-rw-r--r--doc/message.n7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/message.n b/doc/message.n
index 61be2f0..7fb4d04 100644
--- a/doc/message.n
+++ b/doc/message.n
@@ -10,7 +10,7 @@
.BS
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
-message \- Create and manipulate message widgets
+message \- Create and manipulate 'message' non-interactive text widgets
.SH SYNOPSIS
\fBmessage\fR \fIpathName \fR?\fIoptions\fR?
.SO
@@ -74,7 +74,8 @@ there must not exist a window named \fIpathName\fR, but
\fIpathName\fR's parent must exist.
.PP
A message is a widget that displays a textual string. A message
-widget has three special features. First, it breaks up
+widget has three special features that differentiate it from a
+\fBlabel\fR widget. First, it breaks up
its string into lines in order to produce a given aspect ratio
for the window. The line breaks are chosen at word boundaries
wherever possible (if not even a single word would fit on a
@@ -112,12 +113,14 @@ determine the exact behavior of the command. The following
commands are possible for message widgets:
.TP
\fIpathName \fBcget \fIoption\fR
+.
Returns the current value of the configuration option given
by \fIoption\fR.
\fIOption\fR may have any of the values accepted by the \fBmessage\fR
command.
.TP
\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
+.
Query or modify the configuration options of the widget.
If no \fIoption\fR is specified, returns a list describing all of
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for