summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-06-15 22:44:42 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-06-15 22:44:42 (GMT)
commit1ba9b61e4f973310a63d5406d99ec5f80934dc60 (patch)
tree56b4dfdfe4a235700abe2102aa7e9cfbb4f5b5f2
parente057c82d2989257131a482063972365bf02f1979 (diff)
downloadtk-1ba9b61e4f973310a63d5406d99ec5f80934dc60.zip
tk-1ba9b61e4f973310a63d5406d99ec5f80934dc60.tar.gz
tk-1ba9b61e4f973310a63d5406d99ec5f80934dc60.tar.bz2
Enhanced doc in manner inspired by [RFE 803060]
-rw-r--r--ChangeLog3
-rw-r--r--doc/image.n12
2 files changed, 12 insertions, 3 deletions
diff --git a/ChangeLog b/ChangeLog
index f26d5c0..9aed660 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
2004-06-15 Donal K. Fellows <donal.k.fellows@man.ac.uk>
+ * doc/image.n: Enhanced the documentation to take into account the
+ concerns raised in [RFE 803060]
+
* tests/canvas.test: Updated tests affected by the change to
ScrollFractions, which is now clean about result generation.
diff --git a/doc/image.n b/doc/image.n
index 2d28b08..813d6d5 100644
--- a/doc/image.n
+++ b/doc/image.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: image.n,v 1.6 2001/04/03 04:33:58 hobbs Exp $
+'\" RCS: @(#) $Id: image.n,v 1.7 2004/06/15 22:44:42 dkf Exp $
'\"
.so man.macros
.TH image n 4.0 Tk "Tk Built-In Commands"
@@ -24,7 +24,7 @@ It can take several different forms, depending on the
\fIoption\fR argument. The legal forms are:
.TP
\fBimage create \fItype \fR?\fIname\fR? ?\fIoption value ...\fR?
-Creates a new image and returns its name.
+Creates a new image and a command with the same name and returns its name.
\fItype\fR specifies the type of the image, which must be one of
the types currently defined (e.g., \fBbitmap\fR).
\fIname\fR specifies the name for the image; if it is omitted then
@@ -77,7 +77,10 @@ argument to \fBimage create\fR).
\fBimage width \fIname\fR
Returns a decimal string giving the width of image \fIname\fR
in pixels.
-
+.PP
+Additional operations (e.g. writing the image to a file) may be
+available as subcommands of the image instance command. See the manual
+page for the particular image type for details.
.SH "BUILT-IN IMAGE TYPES"
.PP
The following image types are defined by Tk so they will be available
@@ -94,5 +97,8 @@ Displays a variety of full-color images, using dithering to
approximate colors on displays with limited color capabilities.
See the \fBphoto\fR manual entry for more information.
+.SH "SEE ALSO"
+bitmap(n), options(n), photo(n)
+
.SH KEYWORDS
height, image, types of images, width