summaryrefslogtreecommitdiffstats
path: root/tkimg/doc/img-tiff.man
diff options
context:
space:
mode:
authorWilliam Joye <wjoye@cfa.harvard.edu>2017-01-03 21:52:18 (GMT)
committerWilliam Joye <wjoye@cfa.harvard.edu>2017-01-03 21:52:18 (GMT)
commit4302a869f0212a3e4878e66a7260b434f6584476 (patch)
treee6976e66edf648406e32b092395121e045301692 /tkimg/doc/img-tiff.man
parenta780057cc1b51dd3a557549c3cf2431f09136c0d (diff)
parent60d692811c12788ed4468d5ff680633304e8f641 (diff)
downloadblt-4302a869f0212a3e4878e66a7260b434f6584476.zip
blt-4302a869f0212a3e4878e66a7260b434f6584476.tar.gz
blt-4302a869f0212a3e4878e66a7260b434f6584476.tar.bz2
Merge commit '60d692811c12788ed4468d5ff680633304e8f641' as 'tkimg'
Diffstat (limited to 'tkimg/doc/img-tiff.man')
-rwxr-xr-xtkimg/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 100755
index 0000000..a47e731
--- /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]