diff options
| author | William Joye <wjoye@cfa.harvard.edu> | 2017-01-03 21:51:01 (GMT) |
|---|---|---|
| committer | William Joye <wjoye@cfa.harvard.edu> | 2017-01-03 21:51:01 (GMT) |
| commit | a780057cc1b51dd3a557549c3cf2431f09136c0d (patch) | |
| tree | 717f78052c55596449b27743171d7e170c4d39a0 /tkimg/doc | |
| parent | 7749430b9352c1eaf5dca7d8a89a6d35f565ef24 (diff) | |
| download | blt-a780057cc1b51dd3a557549c3cf2431f09136c0d.zip blt-a780057cc1b51dd3a557549c3cf2431f09136c0d.tar.gz blt-a780057cc1b51dd3a557549c3cf2431f09136c0d.tar.bz2 | |
upgrade tkimg to 1.4.6
Diffstat (limited to 'tkimg/doc')
| -rw-r--r-- | tkimg/doc/default.css | 24 | ||||
| -rw-r--r-- | tkimg/doc/format-footer.inc | 6 | ||||
| -rw-r--r-- | tkimg/doc/format-header.inc | 30 | ||||
| -rw-r--r-- | tkimg/doc/format-middle.inc | 16 | ||||
| -rw-r--r-- | tkimg/doc/formats.htm | 212 | ||||
| -rw-r--r-- | tkimg/doc/img-bmp.man | 106 | ||||
| -rw-r--r-- | tkimg/doc/img-dted.man | 88 | ||||
| -rw-r--r-- | tkimg/doc/img-gif.man | 65 | ||||
| -rw-r--r-- | tkimg/doc/img-ico.man | 63 | ||||
| -rw-r--r-- | tkimg/doc/img-jpeg.man | 75 | ||||
| -rw-r--r-- | tkimg/doc/img-pcx.man | 67 | ||||
| -rw-r--r-- | tkimg/doc/img-pixmap.man | 98 | ||||
| -rw-r--r-- | tkimg/doc/img-png.man | 73 | ||||
| -rw-r--r-- | tkimg/doc/img-ppm.man | 100 | ||||
| -rw-r--r-- | tkimg/doc/img-ps.man | 97 | ||||
| -rw-r--r-- | tkimg/doc/img-raw.man | 175 | ||||
| -rw-r--r-- | tkimg/doc/img-sgi.man | 76 | ||||
| -rw-r--r-- | tkimg/doc/img-sun.man | 73 | ||||
| -rw-r--r-- | tkimg/doc/img-tga.man | 70 | ||||
| -rw-r--r-- | tkimg/doc/img-tiff.man | 60 | ||||
| -rw-r--r-- | tkimg/doc/img-window.man | 68 | ||||
| -rw-r--r-- | tkimg/doc/img-xbm.man | 10 | ||||
| -rw-r--r-- | tkimg/doc/img-xpm.man | 10 | ||||
| -rw-r--r-- | tkimg/doc/img.man | 103 | ||||
| -rw-r--r-- | tkimg/doc/index.htm | 80 | ||||
| -rw-r--r-- | tkimg/doc/install.htm | 201 | ||||
| -rw-r--r-- | tkimg/doc/library.htm | 68 |
27 files changed, 0 insertions, 2114 deletions
diff --git a/tkimg/doc/default.css b/tkimg/doc/default.css deleted file mode 100644 index 3b716f1..0000000 --- a/tkimg/doc/default.css +++ /dev/null @@ -1,24 +0,0 @@ -body { - background: white; - color: black; -} - -h1 { - align: center; -} - -h2 { - align: center; -} - -h3 { - align: center; -} - -img.right { - float: right; -} - -img.left { - float: left; -}
\ No newline at end of file diff --git a/tkimg/doc/format-footer.inc b/tkimg/doc/format-footer.inc deleted file mode 100644 index dde044d..0000000 --- a/tkimg/doc/format-footer.inc +++ /dev/null @@ -1,6 +0,0 @@ -[comment {-*- tcl -*- doctools = format-footer.inc}] -[list_end] - -[see_also img-intro img-bmp img-dted img-gif img-ico img-jpeg img-pcx img-pixmap img-png img-ppm img-ps img-raw img-sgi img-sun img-tga img-tiff img-window img-xbm img-xpm] -[keywords {image handling} tk [vset FORMATNAME]] -[manpage_end] diff --git a/tkimg/doc/format-header.inc b/tkimg/doc/format-header.inc deleted file mode 100644 index 5479113..0000000 --- a/tkimg/doc/format-header.inc +++ /dev/null @@ -1,30 +0,0 @@ -[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]]. diff --git a/tkimg/doc/format-middle.inc b/tkimg/doc/format-middle.inc deleted file mode 100644 index f217e94..0000000 --- a/tkimg/doc/format-middle.inc +++ /dev/null @@ -1,16 +0,0 @@ -[comment {-*- tcl -*- doctools = format-middle.inc}] -[para] - -All of the above means that in a call like - -[list_begin definitions] -[call [cmd image] [method {create photo}] [opt [arg name]] [opt [arg options]]] -[list_end] - -[list_begin enum] -[enum] -Image data in [vset FORMATNAME] format (options [option -data] and [option -file]) is -detected automatically. - -[enum] -The format name [const [vset FORMATNAME]] is recognized by the option [option -format]. diff --git a/tkimg/doc/formats.htm b/tkimg/doc/formats.htm deleted file mode 100644 index b1f9d9a..0000000 --- a/tkimg/doc/formats.htm +++ /dev/null @@ -1,212 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <title>Img Documentation</title> - <meta http-equiv="Content-Type" content="text/html" /> -</head> - -<body> -<h1>Img Manual</h1> - -<table width="100%"> - <tbody> - <tr> - <td><a href="index.htm">Introduction</a></td> - <td><a href="install.htm">Installation</a></td> - <td><a href="formats.htm">Format handlers</a></td> - <td><a href="library.htm">External libraries</a></td> - </tr> - </tbody> -</table> - -<h3>Format handlers</h3> -<dl> - <dt>The pixmap image type can be used as follows:</dt> - <dd>image create pixmap -file </dd> - <dt>or</dt> - <dd>image create pixmap -data ;#(in XPM format)</dd> -</dl> -<dl> - <dt>The photo image type works the same:</dt> - <dd>image create photo -file </dd> - <dt>or</dt> - <dd>image create photo -data ;#(base-64 encoding required with Tk8.2 and lower)</dd> -</dl> - -<p>Valid format specifiers for reading photo's:</p> - -<table width="100%"> - <tbody> - <tr> - <td width="10%"> </td> - <td>"bmp"</td> - <td></td> - </tr> - <tr> - <td> </td> - <td>"gif -index <n>"</td> - <td></td> - </tr> - <tr> - <td> </td> - <td>"jpeg -fast -grayscale"</td> - <td></td> - </tr> - <tr> - <td> </td> - <td>"png"</td> - <td></td> - </tr> - <tr> - <td> </td> - <td>"tiff"</td> - <td></td> - </tr> - <tr> - <td> </td> - <td>"xbm"</td> - <td></td> - </tr> - <tr> - <td> </td> - <td>"xpm"</td> - <td></td> - </tr> - <tr> - <td> </td> - <td>"postscript -index <n> -zoom <x> <y>"</td> - <td>(-index not yet implemented) <!--<tr><td> <td>"pdf -index <n> -zoom <x> <y>"<td>(-index not yet implemented)--> - </td> - </tr> - <tr> - <td> </td> - <td>"window"</td> - <td>(works only with "-data", not "-file")</td> - </tr> - </tbody> -</table> - -<p>Valid format specifiers for writing photo's:</p> - -<table width="100%"> - <tbody> - <tr> - <td width="10%"> </td> - <td>"bmp"</td> - <td></td> - </tr> - <tr> - <td> </td> - <td>"gif -interlaced <bool>"</td> - <td>(-interlaced not yet implemented)</td> - </tr> - <tr> - <td> </td> - <td>"jpeg -quality <n> -smooth <n> -grayscale -optimize - -progressive"</td> - <td></td> - </tr> - <tr> - <td> </td> - <td>"png Author <name> Title <title> Description ....."<br /> - Each pair of arguments will add a named text chunk to the file.</td> - <td></td> - </tr> - <tr> - <td> </td> - <td>"tiff -compression <compression> -byteorder <byteorder>"</td> - <td></td> - </tr> - <tr> - <td> </td> - <td>"xbm"</td> - <td></td> - </tr> - <tr> - <td> </td> - <td>"xpm"</td> - <td></td> - </tr> - </tbody> -</table> - -<p>The format options have the following meaning:</p> - -<table width="100%"> - <tbody> - <tr> - <td width="10%"> </td> - <td>-background C:</td> - <td>use color C as background color for transparent parts of the - image.</td> - </tr> - <tr> - <td> </td> - <td>-byteorder:</td> - <td>Byteorder for TIFF file. Should be one of bigendian, littleendian, - network, smallendian or {}. Default: {}</td> - </tr> - <tr> - <td> </td> - <td>-compression:</td> - <td>Compression for TIFF file. Should be one of none, jpeg, packbits or - deflate. Default: none.</td> - </tr> - <tr> - <td> </td> - <td>-fast:</td> - <td>Fast, low-quality processing.</td> - </tr> - <tr> - <td> </td> - <td>-grayscale:</td> - <td>Force incoming image to grayscale/ Create monochrome file.</td> - </tr> - <tr> - <td> </td> - <td>-index N:</td> - <td>Select one of the sub-images (GIF and postscript only, not yet - implemented for postscript). Default value: 0</td> - </tr> - <tr> - <td> </td> - <td>-interlaced N:</td> - <td>N=1: interlaced. N=0: non-interlaced (not yet implemented).</td> - </tr> - <tr> - <td> </td> - <td>-optimize:</td> - <td>Optimize Huffman table.</td> - </tr> - <tr> - <td> </td> - <td>-progressive:</td> - <td>Create progressive file (JPEG only).</td> - </tr> - <tr> - <td> </td> - <td>-quality N:</td> - <td>Compression quality (0..100; 5-95 is useful range). Default value: - 75</td> - </tr> - <tr> - <td> </td> - <td>-smooth N:</td> - <td>Perform smoothing (10-30 is enough for most GIF's). Default value: - 0</td> - </tr> - <tr> - <td> </td> - <td>-zoom X Y:</td> - <td>Multiply image size by given scale factors. If Y is missing, the - default is the same as X. X and Y are allowed to be in floating point - format, but they are rounded to the nearest practically possible - value. For postscript this means the zoom factors should be multiples - of 1/72.</td> - </tr> - </tbody> -</table> -</body> -</html> diff --git a/tkimg/doc/img-bmp.man b/tkimg/doc/img-bmp.man deleted file mode 100644 index 49a4840..0000000 --- a/tkimg/doc/img-bmp.man +++ /dev/null @@ -1,106 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME bmp] -[vset FORMATFULLNAME {Windows Bitmap Format}] - -[include format-header.inc] - -This handler provides new additional configuration options. See -section [sectref {BMP 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 {BMP OPTIONS}]. - -[list_end] - - - -[section {BMP OPTIONS}] - -The handler provides an option to influence the writing of a BMP image. - -[list_begin definitions] - -[lst_item "[option -resolution] [arg res]"] - -The display resulation and/or aspect ratio property of the outputted bmp -file may be set using this option. -The default values are an x and y resolution of 74 dpi. - -[arg res] is a list of 2 or 3 elements and may have one of the following formats. -The values [arg xres], [arg yres] and [arg unit] are specified after the formats. - -[list_begin definitions] - -[lst_item "[arg res] = [arg xres] [arg unit]"] - -Set the same resolution for x and y. - -Example: Write image with a resolution of 300dpi: -[example_begin] -img write out.bmp -format {bmp -resolution {300 i}} -[example_end] - -[lst_item "[arg res] = [arg xres] [arg yres]"] - -Set the aspect ratio only. -The x resolution remains to the default value 74dpi, as the bmp format does not allow to specify the aspect ratio only. The y resolution is set to 74*[arg yres]/[arg xres]. - -Example: Write image with an aspect ratio of 1/3: -[example_begin] -img write out.bmp -format {bmp -resolution {1 3}} -[example_end] - -[lst_item "[arg res] = [arg xres] [arg yres] [arg unit]"] - -Set an independent resolution for x and y direction. - -Example: Write image with a resolution of x=300dpi and y=150dpi: -[example_begin] -img write out.bmp -format {bmp -resolution {300 100 i}} -[example_end] - -[list_end] - - -The used parameters are: - -[list_begin arg] - -[arg_def float xres input] - -The output resolution in x direction as a float number. - -[arg_def float yres input] - -The output resolution in x direction as a float number. - -[arg_def string unit input] - -Unit of the given resolution numbers similar to Tk_GetPixel. -Possible units are: - -[list_begin definitions] - -[lst_item "c"] -pixel per centimeter. -[lst_item "m"] -pixel per meter. -[lst_item "i"] -pixel per inch. -[lst_item "p"] -pixel per inch/72 (Printer points). - -[list_end] - -[list_end] - -[list_end] - -[list_begin definitions] -[include format-footer.inc] diff --git a/tkimg/doc/img-dted.man b/tkimg/doc/img-dted.man deleted file mode 100644 index eb9556a..0000000 --- a/tkimg/doc/img-dted.man +++ /dev/null @@ -1,88 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME dted] -[vset FORMATFULLNAME {DTED Format}] - -[include format-header.inc] - -This handler provides new additional configuration options. See -section [sectref {DTED 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 {DTED OPTIONS}]. - -[list_end] - - -[section {NOTE}] - -This format handler must be loaded explicitly with -[cmd "package require img::[vset FORMATNAME]"]. - - -[section {SUPPORTED DTED TYPES}] - -[example_begin] - Interpret DTED terrain elevation data as a grayscale image. - - List of currently supported features: - - Type | Read | Write | - | -file | -data | -file | -data | - ---------------------------------------- - Gray | Yes | Yes | No | No | - -[example_end] - - -[section {DTED OPTIONS}] - -The handler provides the following options: - -[list_begin definitions] - -[lst_item "[option -verbose] [arg bool]"] - -If set to [const true], additional information about the loaded image -is printed to stdout. Default is [const false]. - -[lst_item "[option -nchan] [arg int]"] - -Specify the number of channels of the generated image. -Default is [const 1], i.e. generate a grayscale image. - -[lst_item "[option -gamma] [arg float]"] - -Specify a gamma correction to be applied when mapping -the input data to 8-bit image values. -Default is [const 1.0]. - -[lst_item "[option -nomap] [arg bool]"] - -If set to [const true], no mapping of input values is done. -Use this option, if your elevation file contains -values in the range of [const 0] .. [const 255] only. -Default is [const false]. - -[lst_item "[option -min] [arg short]"] - -Specify the minimum pixel value to be used for mapping -the input data to 8-bit image values. -Default is the minimum value found in the elevation data. - -[lst_item "[option -max] [arg short]"] - -This option is supported for reading only. -[nl] -Specify the maximum pixel value to be used for mapping -the input data to 8-bit image values. -Default is the maximum value found in the elevation data. - -[list_end] - -[list_begin definitions] -[include format-footer.inc] diff --git a/tkimg/doc/img-gif.man b/tkimg/doc/img-gif.man deleted file mode 100644 index 3d8af86..0000000 --- a/tkimg/doc/img-gif.man +++ /dev/null @@ -1,65 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME gif] -[vset FORMATFULLNAME {Graphics Interchange Format}] - -[include format-header.inc] - -This handler provides new additional configuration options. See -section [sectref {GIF 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 {GIF OPTIONS}]. - -[list_end] - - - -[section {GIF OPTIONS}] - -The handler provides two options, one for reading from a GIF image, -the other influencing the writing of such. - -[list_begin definitions] - -[lst_item "[option -index] [arg n]"] - -This option is for reading from GIF files containing more than one -image ([term {animated GIF's}], [term {GIF movies}]. 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 -interlaced] [arg bool]"] - -If the value of this option is set to true the image will be written -using the interlaced sub-format of GIF. The default is to write -non-interlaced files. [emph {This option is not implemented yet.}] - -[list_end] - -[section {IMAGE COMPRESSION}] - -Instead of LZW the run-length encoding of Hutchison Avenue Software -Corporation is used, also known as [term miGIF] compression. The miGIF -compression routines do not, strictly speaking, generate files -conforming to the GIF spec, since the image data is not LZW-compressed -(this is the point: in order to avoid transgression of the Unisys -patent on the LZW algorithm.) However, miGIF generates data streams -that any reasonably sane LZW decompresser will decompress to what we -want. - -[section TRANSPARENCY] - -If you want to write images to disk which contain transparency -information (e.g. GIF89) you need at least [package Tk] 8.3. - - - -[list_begin definitions] -[include format-footer.inc] diff --git a/tkimg/doc/img-ico.man b/tkimg/doc/img-ico.man deleted file mode 100644 index 594360f..0000000 --- a/tkimg/doc/img-ico.man +++ /dev/null @@ -1,63 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME ico] -[vset FORMATFULLNAME {Windows Icon Format}] - -[include format-header.inc] - -This handler provides new additional configuration options. See -section [sectref {ICO 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 {ICO OPTIONS}]. - -[list_end] - - -[section {SUPPORTED ICO TYPES}] - -[example_begin] - 1-bit pixels: Black and White. - 4-bit pixels: Grayscale or indexed. - 8-bit pixels: True-color (RGB, each channel 8 bit). - - List of currently supported features: - - Type | Read | Write | - | -file | -data | -file | -data | - ---------------------------------------- - 1-bit | Yes | Yes | No | No | - 4-bit | Yes | Yes | No | No | - 8-bit | Yes | Yes | Yes | Yes | -[example_end] - - -[section {ICO OPTIONS}] - -The handler provides the following options: - -[list_begin definitions] - -[lst_item "[option -verbose] [arg bool]"] - -This option is supported for reading and writing. -[nl] -If set to [const true], additional information about the loaded/stored image -is printed to stdout. Default is [const false]. - -[lst_item "[option -index] [arg n]"] - -This option is supported for reading only. -[nl] -Read the [arg n]'th image. The first image is at index [const 0]. -Default is [const 0]. - -[list_end] - - -[list_begin definitions] -[include format-footer.inc] diff --git a/tkimg/doc/img-jpeg.man b/tkimg/doc/img-jpeg.man deleted file mode 100644 index e529151..0000000 --- a/tkimg/doc/img-jpeg.man +++ /dev/null @@ -1,75 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME jpeg] -[vset FORMATFULLNAME {Joint Picture Expert Group format}] - -[include format-header.inc] - -This handler provides new additional configuration options. See -section [sectref {JPEG 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 {JPEG OPTIONS}]. - -[list_end] - - - -[section {JPEG OPTIONS}] - -The handler provides six options, two effective when reading from a -JPEG image, and five influencing the writing of such. One option is -usable for both reading an writing. - -[list_begin definitions] - -[lst_item [option -fast]] - -This option is for reading from JPEG data. It usage activates a -processing mode which is fast, but also provides only low-quality -information. - - -[lst_item [option -grayscale]] - -This option can be used for both reading and writing of JPEG -data. Usage of this option forces incoming images to grayscale, and -written images will be monochrome. - - -[lst_item "[option -quality] [arg n]"] - -This option is for writing JPEG data. It specifies the compression -level as a quality percentage. The higher the quality, the less the -compression. The nominal range for [arg n] is - -[const 0]...[const 100]. Useful values are in the range -[const 5]...[const 95]. The default value is [const 75]. - - -[lst_item "[option -smooth] [arg n]"] - -This option is for writing JPEG data. When used the writer will smooth -the image before performing the compression. Values in the - -[const 10]...[const 30] are usually enough. The default is [const 0], -i.e no smoothing. - - -[lst_item [option -optimize]] - -This option is for writing JPEG data. It usage causes the writer to -optimize the huffman table used to encode the jpeg coefficients. - - -[lst_item [option -progressive]] - -This option is for writing JPEG data. It usage causes the creation of -a [term progressive] JPEG file. - - -[include format-footer.inc] diff --git a/tkimg/doc/img-pcx.man b/tkimg/doc/img-pcx.man deleted file mode 100644 index 655f819..0000000 --- a/tkimg/doc/img-pcx.man +++ /dev/null @@ -1,67 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME pcx] -[vset FORMATFULLNAME {Paintbrush Format}] - -[include format-header.inc] - -This handler provides new additional configuration options. See -section [sectref {PCX 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 {PCX OPTIONS}]. - -[list_end] - - -[section {SUPPORTED PCX TYPES}] - -[example_begin] - 1-bit pixels: Black and White. - 8-bit pixels: Grayscale or indexed. - 24-bit pixels: True-color (RGB, each channel 8 bit). - - List of currently supported features: - - Type | Read | Write | - | -file | -data | -file | -data | - ---------------------------------------- - 1-bit | Yes | Yes | No | No | - 8-bit | Yes | Yes | No | No | - 24-bit | Yes | Yes | Yes | Yes | - - All images types may be either uncompressed or run-length encoded. -[example_end] - - -[section {PCX OPTIONS}] - -The handler provides the following options: - -[list_begin definitions] - -[lst_item "[option -verbose] [arg bool]"] - -This option is supported for reading and writing. -[nl] -If set to [const true], additional information about the loaded/stored image -is printed to stdout. Default is [const false]. - -[lst_item "[option -compression] [arg type]"] - -This option is supported for writing only. -[nl] -Set the compression mode to either [const none] or [const rle]. -Default is [const rle]. - -[list_end] - - - -[list_begin definitions] -[include format-footer.inc] diff --git a/tkimg/doc/img-pixmap.man b/tkimg/doc/img-pixmap.man deleted file mode 100644 index 2617a7f..0000000 --- a/tkimg/doc/img-pixmap.man +++ /dev/null @@ -1,98 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME pixmap] -[vset FORMATFULLNAME {Pixmap Image type}] - -[manpage_begin img-[vset FORMATNAME] n 1.3] -[moddesc Img] -[titledesc "Img, [vset FORMATFULLNAME] ([vset FORMATNAME])"] -[copyright {1995-2003 Jan Nijtmans <nijtmans@users.sourceforge.net>}] -[require Tk] -[require img::[vset FORMATNAME] [opt 1.3]] -[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]. - -[para] - -In contrast to all other sub packages this packages does [emph not] -extend [package Tk]'s [cmd photo] image type, but rather provides a -completely new image type, on the same level as [cmd photo] and -[cmd bitmap]. - -[section {CREATING PIXMAPS}] - -Like all images, pixmaps are created using the [cmd {image create}] -command. - -[list_begin definitions] -[call [cmd image] [method {create pixmap}] [opt [arg name]] [opt [arg options]]] - -Pixmaps support the following options: - -[list_begin definitions] -[lst_item "[option -data] [arg string]"] - -Specifies the contents of the source pixmap as a string. The string -must adhere to X11 pixmap format (e.g., as generated by the pixmap -program). If both the [option -data] and [option -file] options are -specified, the [option -data] option takes precedence. - -[lst_item "[option -file] [arg name]"] - -[arg name] gives the name of a file whose contents define the source -pixmap. The file must adhere to X11 pixmap format (e.g., as generated -by the pixmap program). - -[list_end] -[list_end] - -[section {IMAGE COMMAND}] - -When a pixmap image is created, Tk also creates a new com mand whose -name is the same as the image. This command may be used to invoke -various operations on the image. It has the following general form: - -[list_begin definitions] -[call [arg imageName] [method option] [opt [arg {arg arg ...}]]] -[list_end] - -[method Option] and the args determine the exact behavior of the -command. The following commands are possible for pixmap images: - -[list_begin definitions] - -[call [arg imageName] [method cget] [arg option]] - -Returns the current value of the configuration option given by - -[arg option]. [arg Option] may have any of the values accepted by the -[cmd {image create pixmap}] command. - - -[call [arg imageName] [method configure] [opt [option option]] [opt [arg {value option value ...}]]] - -Query or modify the configuration options for the image. If no option -is specified, returns a list describing all of the available options -for [arg imageName] (see [cmd Tk_ConfigureInfo] for information on the -format of this list). If [arg option] is specified with no - -[arg value], then the command returns a list describing the one named -option (this list will be identi cal to the corresponding sublist of -the value returned if no option is specified). If one or more - -[arg option-value] pairs are specified, then the command modifies the -given option(s) to have the given value(s); in this case the command -returns an empty string. [option Option] may have any of the values -accepted by the [cmd {image create pixmap}] command. - - -[include format-footer.inc] diff --git a/tkimg/doc/img-png.man b/tkimg/doc/img-png.man deleted file mode 100644 index 1acf491..0000000 --- a/tkimg/doc/img-png.man +++ /dev/null @@ -1,73 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME png] -[vset FORMATFULLNAME {Portable Network Graphics format}] - -[include format-header.inc] - -This handler provides new additional configuration options. See -section [sectref {PNG 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 {PNG OPTIONS}]. - -[list_end] - - - -[section {PNG OPTIONS}] - -The handler provides the following options: - -[list_begin definitions] - -[lst_item "[option -matte] [arg bool]"] - -This option is supported for reading only. -[nl] -If set to [const false], a matte (alpha) channel is ignored -during reading or writing. Default is [const true]. - - -[lst_item "[option -alpha] [arg float]"] - -This option is supported for reading only. -[nl] -An additional alpha filtering for the overall image, which -allows the background on which the image is displayed to show through. -This usually also has the effect of desaturating the image. -The alphaValue must be between 0.0 and 1.0. -Specifying an alpha value, overrides the setting of the matte flag, -i.e. reading a file which has no alpha channel (Greyscale, RGB) will -add an alpha channel to the image independent of the matte flag setting. - -[list_end] - -The handler provides no true write options at all, but accepts pairs of keys -and values when writing a PNG file. Each pair will be written as a -named text chunk where the key provides the name of the chunk and the -value its contents. - -For example - -[example { - png Author <name> Title <title> Description ... -}] - - -[section TRANSPARENCY] - -If you want to write images to disk which contain transparency -information (e.g. PNG with alpha channel) you need at least - -[package Tk] 8.3. - - - -[list_begin definitions] -[include format-footer.inc] diff --git a/tkimg/doc/img-ppm.man b/tkimg/doc/img-ppm.man deleted file mode 100644 index ff604b4..0000000 --- a/tkimg/doc/img-ppm.man +++ /dev/null @@ -1,100 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME ppm] -[vset FORMATFULLNAME {Portable Pixmap format}] - -[include format-header.inc] - -This handler provides additional configuration options. See -section [sectref {PPM 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 {PPM OPTIONS}]. - -[list_end] - -[section {SUPPORTED PPM TYPES}] - -This handler supports the PPM (Truecolor) and PGM (Greyscale) image formats. -There are two types of PPM/PGM files: RAW (binary) and ASCII. -The values stored in PPM/PGM files can be unsigned 8-bit or unsigned 16-bit -values. - -[example_begin] - - Grayscale (PGM): 8-bit and 16-bit, 1 channel per pixel. - Truecolor (PPM): 8-bit and 16-bit, 3 channels per pixel. - - List of currently supported features: - - Type | Read | Write | - | -file | -data | -file | -data | - --------------------------------------------------- - PGM 8-bit ASCII | Yes | Yes | No | No | - PGM 8-bit BINARY | Yes | Yes | No | No | - PGM 16-bit ASCII | Yes | Yes | No | No | - PGM 16-bit BINARY | Yes | Yes | No | No | - PPM 8-bit ASCII | Yes | Yes | Yes | Yes | - PPM 8-bit BINARY | Yes | Yes | Yes | Yes | - PPM 16-bit ASCII | Yes | Yes | No | No | - PPM 16-bit BINARY | Yes | Yes | No | No | - -[example_end] - -[section {PPM OPTIONS}] - -The handler provides the following options: - -[list_begin definitions] - -[lst_item "[option -verbose] [arg bool]"] - -This option is supported for reading and writing. -[nl] -If set to [const true], additional information about the loaded/stored image -is printed to stdout. Default is [const false]. - -[lst_item "[option -scanorder] [arg string]"] - -This option is supported for reading only. -[nl] -Specify the scanline order of the input image. -Possible values: [const TopDown] or [const BottomUp]. Default is [const TopDown]. - -[lst_item "[option -gamma] [arg float]"] - -This option is supported for reading only. -[nl] -Specify a gamma correction to be applied when mapping -16-bit input data to 8-bit image values. -Default is [const 1.0]. - -[lst_item "[option -min] [arg float]"] - -This option is supported for reading only. -[nl] -Specify the minimum pixel value to be used for mapping -16-bit input data to 8-bit image values. -Default is the minimum value found in the image data. - -[lst_item "[option -max] [arg float]"] - -This option is supported for reading only. -[nl] -Specify the maximum pixel value to be used for mapping -16-bit input data to 8-bit image values. -Default is the maximum value found in the image data. - -[lst_item "[option -ascii] [arg bool]"] - -This option is supported for writing only. -If set to [const true], the file is written in PPM 8-bit ASCII format (P3). -Default is [const false], i.e. write in PPM 8-bit binary format (P6). - -[list_end] - -[list_begin definitions] -[include format-footer.inc] diff --git a/tkimg/doc/img-ps.man b/tkimg/doc/img-ps.man deleted file mode 100644 index 96b4a6b..0000000 --- a/tkimg/doc/img-ps.man +++ /dev/null @@ -1,97 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME ps] -[vset FORMATFULLNAME {Adobe PostScript Format}] - -[include format-header.inc] - -This handler provides new additional configuration options. See -section [sectref {PostScript OPTIONS}] for more detailed explanations. - -[para] - -Note that this package provides a [const pdf] handler too, i.e. a -handler for the Adobe Portable Document Format. That handler accepts -the same options as the [const [vset FORMATNAME]] handler. - -[para] - -The package delegates the actual conversion of data in PostScript and -PDF format into a raster image to the [syscmd ghostscript] -application. It therefore depends upon the presence of said -application and is non-functional is [syscmd ghostscript] is not -present. - -[para] - -All of the above means that in a call like - -[list_begin definitions] -[call [cmd image] [method {create photo}] [opt [arg name]] [opt [arg options]]] -[list_end] - -[list_begin enum] -[enum] -Image data in [vset FORMATNAME] and PDF format (options [option -data] -and [option -file]) is detected automatically. - -[enum] - -The format names [const [vset FORMATNAME]] and [const pdf] are -recognized by the option [option -format]. - - -In addition the value for the option is treated as list and may -contain any of the special options listed in section - -[sectref {PostScript OPTIONS}]. - -[list_end] - - - -[section {PostScript OPTIONS}] - -The handler provides two options, both influencing the reading of -PostScript or PDF images. The handler is [emph not] able to write -images in PostScript or PDF. - - -[list_begin definitions] - -[lst_item "[option -index] [arg n]"] - -This option is for reading from PostScript/PDF data containing more -than one page. When specified it will read the [arg n]'th page in the -data. The first page is at index [const 0] and will be read by -default, i.e. when the option is not specified. - -[nl] - -[emph Note:] This option is not yet implemented. - - -[lst_item "[option -zoom] [arg X] [arg Y]"] - -Multiply image size by the given scale factors. If [arg Y] is missing, -the default is the same as [arg X]. [arg X] and [arg Y] are allowed to -be in floating point format, but they are rounded to the nearest -practically possible value. For postscript this means the zoom factors -should be multiples of 1/72. - - -[list_end] - -[section REQUIREMENTS] - -The code provided by Img does not perform the interpretation and -rasterizing of the input by itself but delegates this to the -[syscmd gs] application. This is the GhostScript implementation -of PostScript (and PDF). - -[para] - -If [syscmd gs] is not installed this format handler cannot be used. - -[see_also img-intro img-bmp img-gif img-ico img-jpeg img-pcx img-pixmap img-png img-ppm img-ps img-sgi img-sun img-tga img-tiff img-window img-xbm img-xpm] -[keywords {image handling} tk [vset FORMATNAME] pdf postscript gs ghostscript] -[manpage_end] diff --git a/tkimg/doc/img-raw.man b/tkimg/doc/img-raw.man deleted file mode 100644 index 85bfc98..0000000 --- a/tkimg/doc/img-raw.man +++ /dev/null @@ -1,175 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME raw] -[vset FORMATFULLNAME {Raw Data Format}] - -[include format-header.inc] - -This handler provides new additional configuration options. See -section [sectref {RAW 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 {RAW OPTIONS}]. - -[list_end] - - -[section {NOTE}] - -This format handler must be loaded explicitly with -[cmd "package require img::[vset FORMATNAME]"]. - - -[section {SUPPORTED RAW TYPES}] - -[example_begin] - Grayscale image: 1 channel of 32-bit floating point values. - 1 channel of 16-bit unsigned integer values. - 1 channel of 8-bit unsigned integer values. - True-color image: 3 channels of 32-bit floating point values. - 3 channels of 16-bit unsigned integer values. - 3 channels of 8-bit unsigned integer values. - - List of currently supported features: - - Type | Read | Write | - | -file | -data | -file | -data | - ---------------------------------------- - Gray | Yes | Yes | Yes | Yes | - RGB | Yes | Yes | Yes | Yes | - - There are 2 supported file formats: - One with the pure raw data only, the other with a 7 line ASCII header - of the following form: - - Magic=RAW\n File format identifier. Fixed value. - Width=128\n Image width in pixels. - Height=128\n Image height in pixels. - NumChan=1\n Possible values: 1 or 3. - ByteOrder=Intel\n Possible values: "Intel" or "Motorola". - ScanOrder=TopDown\n Possible values: "TopDown" or "BottomUp". - PixelType=byte\n Possible values: "float", "short" or "byte". - -[example_end] - - -[section {RAW OPTIONS}] - -The handler provides the following options: - -[list_begin definitions] - -[lst_item "[option -verbose] [arg bool]"] - -This option is supported for reading and writing. -[nl] -If set to [const true], additional information about the loaded/stored image -is printed to stdout. Default is [const false]. - -[lst_item "[option -useheader] [arg bool]"] - -This option is supported for reading and writing. -[nl] -If set to [const true], use the file header information for reading and writing. -Default is [const true]. - -[lst_item "[option -nchan] [arg int]"] - -This option is supported for reading and writing image data without header. -[nl] -Specify the number of channels of the input image. -Default is [const 1]. - -[lst_item "[option -width] [arg int]"] - -This option is supported for reading image data without header only. -[nl] -Specify the width of the input image. -Default is [const 128]. - -[lst_item "[option -height] [arg int]"] - -This option is supported for reading image data without header only. -[nl] -Specify the height of the input image. -Default is [const 128]. - -[lst_item "[option -byteorder] [arg string]"] - -This option is supported for reading image data without header only. -[nl] -Specify the byteorder of the input image data. -Possible values: [const Intel] or [const Motorola]. -Default is assuming the same byteorder as that of the host computer. - -[lst_item "[option -uuencode] [arg bool]"] -This option is supported for reading image data without header only. -[nl] -If set to [const false], do not assume, that the image data stored in a -Tcl variable is uuencoded. Default is [const true], i.e. the image data in -a Tcl variable is assumed to be uuencoded. - -[lst_item "[option -scanorder] [arg string]"] - -This option is supported for reading and writing image data without header. -[nl] -Specify the scanline order of the input image. -Possible values: [const TopDown] or [const BottomUp]. -Default is assuming the same byteorder as that of the host computer. - -[lst_item "[option -pixeltype] [arg string]"] - -This option is supported for reading image data without header only. -[nl] -Specify the type of the pixel values. -Possible values: [const float] or [const short] or [const byte]. -Default is [const byte]. -[nl] -RAW files are always written in [const byte] pixel format. - -[lst_item "[option -gamma] [arg float]"] - -This option is supported for reading only. -[nl] -Specify a gamma correction to be applied when mapping -the input data to 8-bit image values. -Default is [const 1.0]. - -[lst_item "[option -nomap] [arg bool]"] - -This option is supported for reading only. -[nl] -If set to [const true], no mapping of input values is done. -Use this option, if your image already contains RGB -values in the range of [const 0] .. [const 255]. -When using the nomap mode, no information about the -minimum and maximum pixel values is gathered during -reading and therefore no verbose output is printed. -On the other hand reading the image is faster. - -Default is [const false]. - -[lst_item "[option -min] [arg float]"] - -This option is supported for reading only. -[nl] -Specify the minimum pixel value to be used for mapping -the input data to 8-bit image values. -Default is the minimum value found in the image data. - -[lst_item "[option -max] [arg float]"] - -This option is supported for reading only. -[nl] -Specify the maximum pixel value to be used for mapping -the input data to 8-bit image values. -Default is the maximum value found in the image data. - -[list_end] - -[list_begin definitions] -[include format-footer.inc] diff --git a/tkimg/doc/img-sgi.man b/tkimg/doc/img-sgi.man deleted file mode 100644 index a6ce4e9..0000000 --- a/tkimg/doc/img-sgi.man +++ /dev/null @@ -1,76 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME sgi] -[vset FORMATFULLNAME {SGI Native Format}] - -[include format-header.inc] - -This handler provides new additional configuration options. See -section [sectref {SGI 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 {SGI OPTIONS}]. - -[list_end] - - -[section {SUPPORTED SGI TYPES}] - -[example_begin] - 24-bit pixels: True-color (RGB, each channel 8 bit). - 32-bit pixels: True-color with alpha channel (RGBA, each channel 8 bit). - 48-bit pixels: True-color (RGB, each channel 16 bit). - 64-bit pixels: True-color with alpha channel (RGBA, each channel 16 bit). - - List of currently supported features: - - Type | Read | Write | - | -file | -data | -file | -data | - ---------------------------------------- - 24-bit | Yes | Yes* | Yes | Yes* | - 32-bit | Yes | Yes* | Yes | Yes* | - 48-bit | Yes | Yes* | No | No | - 64-bit | Yes | Yes* | No | No | - - *: Implemented by reading/writing from/to a temporary file. This will - be slow for larger images. - - All images types may be either uncompressed or run-length encoded. -[example_end] - - -[section {SGI OPTIONS}] - -The handler provides the following options: - -[list_begin definitions] - -[lst_item "[option -verbose] [arg bool]"] - -This option is supported for reading and writing. -[nl] -If set to [const true], additional information about the loaded/stored image -is printed to stdout. Default is [const false]. - -[lst_item "[option -compression] [arg type]"] - -This option is supported for writing only. -[nl] -Set the compression mode to either [const none] or [const rle]. -Default is [const rle]. - -[lst_item "[option -matte] [arg bool]"] - -This option is supported for reading and writing. -[nl] -If set to [const false], a matte (alpha) channel is ignored -during reading or writing. Default is [const true]. - -[list_end] - -[list_begin definitions] -[include format-footer.inc] diff --git a/tkimg/doc/img-sun.man b/tkimg/doc/img-sun.man deleted file mode 100644 index f324fb4..0000000 --- a/tkimg/doc/img-sun.man +++ /dev/null @@ -1,73 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME sun] -[vset FORMATFULLNAME {Sun Raster Format}] - -[include format-header.inc] - -This handler provides new additional configuration options. See -section [sectref {SUN 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 {SUN OPTIONS}]. - -[list_end] - - -[section {SUPPORTED SUN TYPES}] - -[example_begin] - 1-bit pixels: Black and White. - 8-bit pixels: Grayscale or indexed. - 24-bit pixels: True-color (RGB, each channel 8 bit). - 32-bit pixels: True-color with alpha channel (RGBA, each channel 8 bit). - - List of currently supported features: - - Type | Read | Write | - | -file | -data | -file | -data | - ---------------------------------------- - 1-bit | Yes | Yes | No | No | - 8-bit | Yes | Yes | No | No | - 24-bit | Yes | Yes | Yes | Yes | - 32-bit | Yes | Yes | Yes | Yes | - - All images types may be either uncompressed or run-length encoded. -[example_end] - - -[section {SUN OPTIONS}] - -The handler provides the following options: - -[list_begin definitions] - -[lst_item "[option -verbose] [arg bool]"] - -This option is supported for reading and writing. -[nl] -If set to [const true], additional information about the loaded/stored image -is printed to stdout. Default is [const false]. - -[lst_item "[option -compression] [arg type]"] - -This option is supported for writing only. -[nl] -Set the compression mode to either [const none] or [const rle]. -Default is [const rle]. - -[lst_item "[option -matte] [arg bool]"] - -This option is supported for reading and writing. -[nl] -If set to [const false], a matte (alpha) channel is ignored -during reading or writing. Default is [const true]. - -[list_end] - -[list_begin definitions] -[include format-footer.inc] diff --git a/tkimg/doc/img-tga.man b/tkimg/doc/img-tga.man deleted file mode 100644 index b673619..0000000 --- a/tkimg/doc/img-tga.man +++ /dev/null @@ -1,70 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME tga] -[vset FORMATFULLNAME {Truevision Targa Format}] - -[include format-header.inc] - -This handler provides new additional configuration options. See -section [sectref {TGA 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 {TGA OPTIONS}]. - -[list_end] - - -[section {SUPPORTED TGA TYPES}] - -[example_begin] - 24-bit pixels: True-color (RGB, each channel 8 bit). - 32-bit pixels: True-color with alpha channel (RGBA, each channel 8 bit). - - List of currently supported features: - - Type | Read | Write | - | -file | -data | -file | -data | - ---------------------------------------- - 24-bit | Yes | Yes | Yes | Yes | - 32-bit | Yes | Yes | Yes | Yes | - - All images types may be either uncompressed (Targa-Type 2) or - run-length encoded (Targa-Type 10). -[example_end] - - -[section {TGA OPTIONS}] - -The handler provides the following options: - -[list_begin definitions] - -[lst_item "[option -verbose] [arg bool]"] - -This option is supported for reading and writing. -[nl] -If set to [const true], additional information about the loaded/stored image -is printed to stdout. Default is [const false]. - -[lst_item "[option -compression] [arg type]"] - -This option is supported for writing only. -[nl] -Set the compression mode to either [const none] or [const rle]. -Default is [const rle]. - -[lst_item "[option -matte] [arg bool]"] - -This option is supported for reading and writing. -[nl] -If set to [const false], a matte (alpha) channel is ignored -during reading or writing. Default is [const true]. - -[list_end] - -[list_begin definitions] -[include format-footer.inc] diff --git a/tkimg/doc/img-tiff.man b/tkimg/doc/img-tiff.man deleted file mode 100644 index 1513eb8..0000000 --- a/tkimg/doc/img-tiff.man +++ /dev/null @@ -1,60 +0,0 @@ -[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] diff --git a/tkimg/doc/img-window.man b/tkimg/doc/img-window.man deleted file mode 100644 index fa20bbe..0000000 --- a/tkimg/doc/img-window.man +++ /dev/null @@ -1,68 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME window] -[vset FORMATFULLNAME {Tk Windows}] - -[manpage_begin img-[vset FORMATNAME] n 1.3] -[moddesc Img] -[titledesc "Img, [vset FORMATFULLNAME] ([vset FORMATNAME])"] -[copyright {1995-2003 Jan Nijtmans <nijtmans@users.sourceforge.net>}] -[require Tk] -[require img::[vset FORMATNAME] [opt 1.3]] -[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]. -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]]. - -[para] - -This handler does not provide additional configuration options. - -This handler is special. Instead of reading or writing image data from -a file or string it allows the embedding of a Tk widget into the photo -image. In other words, it takes a snapshot of the contents of a Tk -window. - -[para] - -All of the above means that in a call like - -[list_begin definitions] -[call [cmd image] [method {create photo}] [opt [arg name]] [opt [arg options]]] -[list_end] - -[list_begin enum] -[enum] - -Image data in [vset FORMATNAME] format (option [option -data]) is -detected automatically. Image data is considered to be in the - -[const [vset FORMATNAME]] format if the value given to option -[option -data] is the name of an existing Tk window. - -[nl] - -Note that the standard option [option -file] is not supported by this -handler. - - -[enum] -The format name [const [vset FORMATNAME]] is recognized by the option [option -format]. - - -[include format-footer.inc] diff --git a/tkimg/doc/img-xbm.man b/tkimg/doc/img-xbm.man deleted file mode 100644 index 21b4754..0000000 --- a/tkimg/doc/img-xbm.man +++ /dev/null @@ -1,10 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME xbm] -[vset FORMATFULLNAME {X Windows Bitmap Format}] - -[include format-header.inc] - -This handler does not provide additional configuration options. - -[include format-middle.inc] -[include format-footer.inc] diff --git a/tkimg/doc/img-xpm.man b/tkimg/doc/img-xpm.man deleted file mode 100644 index 506267b..0000000 --- a/tkimg/doc/img-xpm.man +++ /dev/null @@ -1,10 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[vset FORMATNAME xpm] -[vset FORMATFULLNAME {X Windows Pixmap Format}] - -[include format-header.inc] - -This handler does not provide additional configuration options. - -[include format-middle.inc] -[include format-footer.inc] diff --git a/tkimg/doc/img.man b/tkimg/doc/img.man deleted file mode 100644 index fd166f2..0000000 --- a/tkimg/doc/img.man +++ /dev/null @@ -1,103 +0,0 @@ -[comment {-*- tcl -*- doctools}] -[manpage_begin img-intro n 1.4] -[moddesc Img] -[titledesc {Introduction to Img}] -[copyright {1995-2009 Jan Nijtmans <nijtmans@users.sourceforge.net>}] -[require Tk] -[require Img [opt 1.4]] -[description] - -[package Img] is a [package Tk] extension, adding support for many -other Image formats, as listed below. The individual formats are -described in more detail on their own pages. - -[list_begin definitions] - -[lst_item [term bmp]] -Windows bitmap format. -See [cmd img-bmp]. - -[lst_item [term dted]] -DTED terrain elevation data interpreted as image. -See [cmd img-dted]. - -[lst_item [term gif]] -The venerable graphics interchange format (with transparency, but -without LZW. The latter due to patent issues). -See [cmd img-gif]. - -[lst_item [term ico]] -Windows icon files. -See [cmd img-ico]. - -[lst_item [term jpeg]] -The format for lossy compressed still pictures specified by the Joint -Picture Experts Group. -See [cmd img-jpeg]. - -[lst_item [term pcx]] -Paintbrush image format. -See [cmd img-pcx]. - -[lst_item [term pixmap]] -While the other formats are handlers for the [package Tk] photo image -type this is a new image type for [package Tk]. -See [cmd img-pixmap]. - -[lst_item [term png]] -Portable Network Graphics, successor to GIF. -See [cmd img-png]. - -[lst_item [term ppm]] -Portable Pixmaps. -See [cmd img-ppm]. - -[lst_item [term ps]] -Postscript and PDF (Portable document format). Requires an external -application, [syscmd ghostview], for its operation. -See [cmd img-ps]. - -[lst_item [term raw]] -Raw matrix data interpreted as image. -See [cmd img-raw]. - -[lst_item [term sgi]] -Native SGI format. -See [cmd img-sgi]. - -[lst_item [term sun]] -Sun raster images. -See [cmd img-sun]. - -[lst_item [term tga]] -Targa files. -See [cmd img-tga]. - -[lst_item [term tiff]] -Tagged Interchange File Format. -See [cmd img-tiff]. - -[lst_item [term window]] -Put the content of a Tk window into an image. -See [cmd img-window]. - -[lst_item [term xbm]] -X Bitmaps. -See [cmd img-xbm]. - -[lst_item [term xpm]] -X Pixmaps. -See [cmd img-xpm]. - -[list_end] - -This version only works with Tcl/Tk 8.3 or higher. -If you are using Tk 8.2, please use Img 1.3. -If you are using Tk 8.1 or lower please stick with Img 1.2.4 (which is still -available). -And if you are using Tk4.2 or lower, please stick with Img -1.1.4 (which is also still available). - -[see_also img-bmp img-dted img-gif img-ico img-jpeg img-pcx img-pixmap img-png img-ppm img-ps img-raw img-sgi img-sun img-tga img-tiff img-window img-xbm img-xpm] -[keywords {image handling} tk xpm xbm gif png ppm tiff tga sun sgi postscript ps pdf pixmap pcx ico bmp window jpeg] -[manpage_end] diff --git a/tkimg/doc/index.htm b/tkimg/doc/index.htm deleted file mode 100644 index c74378d..0000000 --- a/tkimg/doc/index.htm +++ /dev/null @@ -1,80 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <title>Img Documentation</title> - <meta http-equiv="Content-Type" content="text/html" /> -</head> - -<body> -<h1>Img Manual</h1> - -<table width="100%"> - <tbody> - <tr> - <td><a href="index.htm">Introduction</a></td> - <td><a href="install.htm">Installation</a></td> - <td><a href="formats.htm">Format handlers</a></td> - <td><a href="library.htm">External libraries</a></td> - </tr> - </tbody> -</table> - -<h3>Introduction</h3> - -<p>Img is a Tk extension, adding support for many other Image formats: BMP, -XBM, XPM, GIF (with transparency, but without LZW), PNG, JPEG, TIFF and -postscript. This version only works with Tcl/Tk 8.0 or higher (any patchlevel, -tested up to 8.4a1). If you are using Tk4.2 or lower, please stick with -Img1.1.4 (which is still available).</p> - -<p>Currently there are two identical source distributions:</p> - -<table width="100%"> - <tbody> - <tr> - <td width="10%"> </td> - <td><a - href="ftp://ftp.neosoft.com/pub/tcl/sorted/packages-8.0/graphics/img/1.2/img124.zip">img124.zip</a></td> - <td>(for Windows)</td> - <td>(about 1.8 Mb)</td> - </tr> - <tr> - <td> </td> - <td><a - href="ftp://ftp.neosoft.com/pub/tcl/sorted/packages-8.0/graphics/img/1.2/img1.2.4.tar.gz">img1.2.4.tar.gz</a></td> - <td>(for Unix)</td> - <td>(about 1.6 Mb)</td> - </tr> - </tbody> -</table> - -<p>And a binary distribution</p> - -<table width="100%"> - <tbody> - <tr> - <td width="10%"> </td> - <td><a - href="ftp://ftp.neosoft.com/pub/tcl/sorted/packages-8.0/graphics/img/1.2/img124.exe">img124.exe</a></td> - <td>(for Windows)</td> - <td>(about 800 kb)</td> - </tr> - <tr> - </tr> - </tbody> -</table> - -<p>If you want to write images to disk which contain transparency information -(e.g. GIF89 or PNG with alpha channel), you need at least Tk8.3.</p> - -<p>In stead of LZW the run-length encoding of Hutchison Avenue Software -Corporation is used, also known as miGIF compression. The miGIF compression -routines do not, strictly speaking, generate files conforming to the GIF spec, -since the image data is not LZW-compressed (this is the point: in order to -avoid transgression of the Unisys patent on the LZW algorithm.) However, -miGIF generates data streams that any reasonably sane LZW decompresser will -decompress to what we want.</p> -</body> -</html> diff --git a/tkimg/doc/install.htm b/tkimg/doc/install.htm deleted file mode 100644 index 2d188fc..0000000 --- a/tkimg/doc/install.htm +++ /dev/null @@ -1,201 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <title>Img Documentation</title> - <meta http-equiv="Content-Type" content="text/html" /> -</head> - -<body> -<h1>Img Manual</h1> - -<table width="100%"> - <tbody> - <tr> - <td><a href="index.htm">Introduction</a></td> - <td><a href="install.htm">Installation</a></td> - <td><a href="formats.htm">Format handlers</a></td> - <td><a href="library.htm">External libraries</a></td> - </tr> - </tbody> -</table> - -<h3>Installation</h3> - -<p>For Windows, just run the executable.</p> - -<p>For UNIX, you have to compile the sources yourself, but that shouldn't give -you many problems. In the future, hopefully, binary distributions for various -UNIX systems will become available as well.</p> - -<h3>Configure</h3> - -<p>The source distributions have "configure", which has the following -possibilities:</p> - -<table width="100%"> - <tbody> - <tr> - <td width="10%"> </td> - <td>configure ?options?</td> - <td></td> - </tr> - <tr> - <td colspan="3">Some possible options:</td> - </tr> - <tr> - <td> </td> - <td>--prefix=<dir></td> - <td>Install headers in <dir>/include.<br /> - Default: "/usr/local"</td> - </tr> - <tr> - <td> </td> - <td>--exec-prefix=<dir></td> - <td>Install libraries in <dir>/lib.<br /> - Default: "${prefix}"</td> - </tr> - <tr> - <td> </td> - <td>--with-tcl=<dir></td> - <td>Find Tcl libraries in <dir> and include files in - <dir>/../include or <dir>/../generic.<br /> - Default: "${exec-prefix}/lib" or a sibling directory of the Img build - directory.</td> - </tr> - <tr> - <td> </td> - <td>--with-tk=<dir></td> - <td>Find Tk libraries in <dir> and include files in - <dir>/../include or <dir>/../generic.<br /> - Default: the same values as given by --with-tcl or a sibling directory - of the Img build directory.</td> - </tr> - <tr> - <td> </td> - <td>--disable-shared</td> - <td>Force the creation of static libraries.</td> - </tr> - <tr> - <td> </td> - <td>--disable-stubs</td> - <td>Disable stub support. This is necessary if you want to run Img 1.2 - with Tcl/Tk 8.0 up to 8.0.5.</td> - </tr> - </tbody> -</table> - -<p>Configuration of libz, libpng, libtiff, libjpeg and libttf will be done -automatically.</p> - -<h3>make</h3> - -<p>By default only libimg1.2.so will be built. Further on:</p> - -<table width="100%"> - <tbody> - <tr> - <td width="10%"> </td> - <td>make</td> - <td>build libimg1.2.so only</td> - </tr> - <tr> - <td> </td> - <td>make z</td> - <td>build libz.so.1.1.3</td> - </tr> - <tr> - <td> </td> - <td>make png</td> - <td>build libpng.so.2.1.0.7</td> - </tr> - <tr> - <td> </td> - <td>make jpeg</td> - <td>build libjpeg.so.62.0.0</td> - </tr> - <tr> - <td> </td> - <td>make tiff</td> - <td>build libtiff.so.3.5.5</td> - </tr> - <tr> - <td> </td> - <td>make all</td> - <td>build all of above</td> - </tr> - <tr> - <td> </td> - <td>make test</td> - <td>run tests for all image formats.</td> - </tr> - </tbody> -</table> - -<p>Best is to start with "make". If a test fails for one of the PNG, JPEG or -TIFF formats, the error message will indicate what is wrong. If a library is -missing in your system, you can always build it later. If a crash occurs, this -might also indicate that you better upgrade one of these libraries.</p> - -<p>If you prefer to use different versions numbers after the extension, you -can manually adapt the Makefile. On Irix, you can use the "ifl" libraries -which are already part of the operating system. The top of the Makefile shows -which file names to use.</p> - -<h3>Install (source distributions only)</h3> - -<p>You can install whatever you like:</p> - -<table width="100%"> - <tbody> - <tr> - <td> </td> - <td>make install</td> - <td>install libimg1.2.so only</td> - </tr> - <tr> - <td> </td> - <td>make install-z</td> - <td>install libz.so.1.1.3</td> - </tr> - <tr> - <td> </td> - <td>make install-png</td> - <td>install libpng.so.2.1.0.7</td> - </tr> - <tr> - <td> </td> - <td>make install-jpeg</td> - <td>install libjpeg.so.62.0.0</td> - </tr> - <tr> - <td> </td> - <td>make install-tiff</td> - <td>install libtiff.so.3.5.5</td> - </tr> - <tr> - <td> </td> - <td>make install-all</td> - <td>install all of above</td> - </tr> - </tbody> -</table> - -<h3>Use</h3> - -<p>If you want to use the new image formats to be available in your own -scripts, add the following line somewhere in your script:</p> - -<p></p> -<dl> - <dt></dt> - <dd>package require Img</dd> -</dl> - -<p>This will load the library into memory and register the format handlers -into Tk.</p> - -<p>As an example, have a look at the file "demo.tcl"</p> -</body> -</html> diff --git a/tkimg/doc/library.htm b/tkimg/doc/library.htm deleted file mode 100644 index 6c7a41c..0000000 --- a/tkimg/doc/library.htm +++ /dev/null @@ -1,68 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <title>Img Documentation</title> - <meta http-equiv="Content-Type" content="text/html" /> -</head> - -<body> -<h1>Img Manual</h1> - -<table width="100%"> - <tbody> - <tr> - <td><a href="index.htm">Introduction</a></td> - <td><a href="install.htm">Installation</a></td> - <td><a href="formats.htm">Format handlers</a></td> - <td><a href="library.htm">External libraries</a></td> - </tr> - </tbody> -</table> - -<h3>External libraries</h3> - -<p>Included in this distribution are the most recent versions (as of july -2006) of the libz, libpng, libjpeg and libtiff libraries. These are not -required for compilation of libimg, unless you need support for the PNG, JPEG -or TIFF formats. If your system already has shared libraries for these -formats, probably it will already work with this package. Otherwise the tools -are here to build it any time later.</p> - -<p>If your system already has later versions than the ones distributed -together with Img, it is recommended that you always use the latest available -version. In the case of JPEG no promise is made that future versions of the -JPEG library keep binary compatiblility, so it might be that you need to -recompile Img using the latest JPEG header files. If you don't want the -trouble of recompiling Img, it's problably best to stick with libjpeg 6b.</p> - -<p>If you want more information about the external libraries, all of them have -the latest information readily available on the internet. Img uses unmodified -versions of those libraries, except that it provides its own set of makefiles. -The reason for this is that not all libraries supply very good support for -building them as a shared library. But if you already have them available as a -shared library, there should be no need to rebuild them. Here is an -overview.</p> -<dl> - <dt>zlib</dt> - <dd><a - href="http://www.zlib.net/">http://www.zlib.net/</a></dd> - <dt>libpng</dt> - <dd><a - href="http://www.libpng.org/pub/png/libpng.html">http://www.libpng.org/pub/png/libpng.html</a></dd> - <dt>libtiff</dt> - <dd><a href="http://www.libtiff.org/">http://www.libtiff.org/</a></dd> - <dt>libjpeg</dt> - <dd><a - href="http://www.ijg.org/files/jpegsrc.v6b.tar.gz">http://www.ijg.org/files/jpegsrc.v6b.tar.gz</a></dd> - <dt>ghostscript (needed for Postscipt reading)</dt> - <dd><a href="http://www.cs.wisc.edu/~ghost/">http://www.cs.wisc.edu/~ghost/</a></dd> -</dl> - -<p>If you have a problems with any of those libraries, please first try to -recompile them using the makefiles supplied by Img. If that works, it's an -indication that something is wrong with the original distribution of the -libraries, and you better report it to the instance where you got it.</p> -</body> -</html> |