summaryrefslogtreecommitdiffstats
path: root/tkimg/doc/img-tiff.man
diff options
context:
space:
mode:
authorWilliam Joye <wjoye@cfa.harvard.edu>2016-10-27 20:28:26 (GMT)
committerWilliam Joye <wjoye@cfa.harvard.edu>2016-10-27 20:28:26 (GMT)
commitb184baa1234c2143e488d1796ae98afab118b891 (patch)
tree686b0a47b272296205c7fa2bc789f62a03d20df6 /tkimg/doc/img-tiff.man
parentf7560d0a451a793441216d76eb4d9475aab61740 (diff)
parent5aad878400425d3af44433a47c13824385689e1d (diff)
downloadblt-b184baa1234c2143e488d1796ae98afab118b891.zip
blt-b184baa1234c2143e488d1796ae98afab118b891.tar.gz
blt-b184baa1234c2143e488d1796ae98afab118b891.tar.bz2
Merge commit '5aad878400425d3af44433a47c13824385689e1d' as 'tkimg'
Diffstat (limited to 'tkimg/doc/img-tiff.man')
-rw-r--r--tkimg/doc/img-tiff.man60
1 files changed, 60 insertions, 0 deletions
diff --git a/tkimg/doc/img-tiff.man b/tkimg/doc/img-tiff.man
new file mode 100644
index 0000000..1513eb8
--- /dev/null
+++ b/tkimg/doc/img-tiff.man
@@ -0,0 +1,60 @@
+[comment {-*- tcl -*- doctools}]
+[vset FORMATNAME tiff]
+[vset FORMATFULLNAME {Tagged Image File Format}]
+
+[include format-header.inc]
+
+This handler provides new additional configuration options. See
+section [sectref {TIFF OPTIONS}] for more detailed explanations.
+
+
+[include format-middle.inc]
+
+
+In addition the value for the option is treated as list and may
+contain any of the special options listed in section
+
+[sectref {TIFF OPTIONS}].
+
+[list_end]
+
+
+
+[section {TIFF OPTIONS}]
+
+The handler provides three options, one for reading from a TIFF image,
+the other two influencing the writing of such.
+
+
+[list_begin definitions]
+
+[lst_item "[option -index] [arg n]"]
+
+This option is for reading from TIFF files containing more than one
+image ([term {multi-page TIFF}]. When specified it
+will read the [arg n]'th image in the data. The first image is at
+index [const 0] and will be read by default, i.e. when the option is
+not specified.
+
+[lst_item "[option -compression] [arg type]"]
+
+This option specifies the type of compression to use when writing TIFF
+data. It has to be one of [const none], [const jpeg],
+[const packbits], or [const deflate]. The default is [const none].
+
+
+[lst_item "[option -byteorder] [arg type]"]
+
+This option specifies the byteorder to use when writing TIFF data. It
+has to be one of [const bigendian], [const littleendian],
+
+[const network], [const smallendian], or the empty string. The default
+is the empty string.
+
+[nl]
+
+The values [const bigendian] and [const network] are aliases of each
+other, as are [const littleendian] and [const smallendian].
+
+
+[include format-footer.inc]