summaryrefslogtreecommitdiffstats
path: root/tkimg/doc/format-header.inc
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/format-header.inc
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/format-header.inc')
-rwxr-xr-xtkimg/doc/format-header.inc30
1 files changed, 30 insertions, 0 deletions
diff --git a/tkimg/doc/format-header.inc b/tkimg/doc/format-header.inc
new file mode 100755
index 0000000..db77dc1
--- /dev/null
+++ b/tkimg/doc/format-header.inc
@@ -0,0 +1,30 @@
+[comment {-*- tcl -*- doctools = format-header.inc}]
+
+[manpage_begin img-[vset FORMATNAME] n 1.4]
+[moddesc Img]
+[titledesc "Img, [vset FORMATFULLNAME] ([vset FORMATNAME])"]
+[copyright {1995-2009 Jan Nijtmans <nijtmans@users.sourceforge.net>}]
+[require Tk]
+[require img::[vset FORMATNAME] [opt 1.4]]
+[description]
+
+The package [package img::[vset FORMATNAME]] is a sub-package of
+[package Img]. It can be loaded as a part of the complete Img support,
+via [cmd {package require Img}], or on its own, via
+
+[cmd "package require img::[vset FORMATNAME]"].
+
+[para]
+
+Like all packages of [package Img] it does [emph not] provide new
+commands, but extends the existing [package Tk] command [cmd image] so
+that it supports files containing raster images in the
+
+[vset FORMATFULLNAME] ([vset FORMATNAME]). More specifically
+
+[package img::[vset FORMATNAME]] extends [package Tk]'s [cmd photo]
+image type.
+
+[para]
+
+The name of the new format handler is [const [vset FORMATNAME]].