summaryrefslogtreecommitdiffstats
path: root/doc/photo.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2011-09-01 10:30:42 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2011-09-01 10:30:42 (GMT)
commit8c0a195e79b922a086df06f05411c3de11db7a90 (patch)
treec9c0b3c4742f4e3530e1d09150ad1caa86e40107 /doc/photo.n
parentcc3219518774013dd7fb5cbdd1b19728b98b1556 (diff)
downloadtk-8c0a195e79b922a086df06f05411c3de11db7a90.zip
tk-8c0a195e79b922a086df06f05411c3de11db7a90.tar.gz
tk-8c0a195e79b922a086df06f05411c3de11db7a90.tar.bz2
Correctly documented what the [$ph data] command produces without the -format option.
Diffstat (limited to 'doc/photo.n')
-rw-r--r--doc/photo.n11
1 files changed, 8 insertions, 3 deletions
diff --git a/doc/photo.n b/doc/photo.n
index 101d2ca..c14abe3 100644
--- a/doc/photo.n
+++ b/doc/photo.n
@@ -210,9 +210,14 @@ the specified color.
Specifies the name of the image file format handler to be used.
Specifically, this subcommand searches
for the first handler whose name matches an initial substring of
-\fIformat-name\fR and which has the capability to read this image data.
-If this option is not given, this subcommand uses the first
-handler that has the capability to read the image data.
+\fIformat-name\fR and which has the capability to write a string
+containing this image data.
+If this option is not given, this subcommand uses a format that
+consists of a list (one element per row) of lists (one element per
+pixel/column) of colors in
+.QW \fB#\fIrrggbb\fR
+format (where \fIrr\fR is a pair of hexadecimal digits for the red
+channel, \fIgg\fR for green, and \fIbb\fR for blue).
.TP
\fB\-from \fIx1 y1 x2 y2\fR
Specifies a rectangular region of \fIimageName\fR to be returned.