[comment {-*- tcl -*- doctools}]
[vset FORMATNAME sun]
[vset FORMATFULLNAME {Sun raster format}]
[manpage_begin img-[vset FORMATNAME] n 2.1]

[include format-header.inc]

This handler provides new additional configuration options. See
section [sectref {Options}] for more detailed explanations.

[include format-middle.inc]

In addition the value of option [option -format] is treated as a list and may
contain any of the special options listed in section [sectref {Options}].

[include format-package.inc]


[section {Supported Types}]

This format handler supports the following image types:

[list_begin itemized]
[item]  1-bit pixels: Black and White.
[item]  8-bit pixels: Grayscale or indexed.
[item] 24-bit pixels: Truecolor (RGB, 8-bit channels).
[item] 32-bit pixels: Truecolor with alpha channel (RGBA, 8-bit channels).
[list_end]

All images types may be either uncompressed or run-length encoded.

[example_begin]

 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   |

[example_end]


[section {Options}]

The handler provides the following options:

[list_begin definitions]

[def "[option -verbose] [arg bool]"]

This option is supported for reading and writing. Available since version 1.3.
[para]

If set to [const true], additional information about the read or written image
is printed to stdout. Default is [const false].


[def "[option -withalpha] [arg bool]"]

This option is supported for reading and writing. Available since version 1.3.
[para]

If set to [const false], an alpha channel is ignored
during reading or writing. Default is [const true].
[para]
[emph Note:] This option was named [option -matte] in previous versions and is still recognized.


[def "[option -compression] [arg string]"]

This option is supported for writing only. Available since version 1.3.
[para]

Set the compression mode to either [const none] or [const rle].
Default is [const rle].

[list_end]

[include format-footer.inc]
