| 1 |
\ |
| 2 |
.\" This man page was generated by the Netpbm tool 'makeman' from HTML source. |
| 3 |
.\" Do not hand-hack it! If you have bug fixes or improvements, please find |
| 4 |
.\" the corresponding HTML page on the Netpbm website, generate a patch |
| 5 |
.\" against that, and send it to the Netpbm maintainer. |
| 6 |
.TH "Pamtowinicon User Manual" 1 "12 April 2013" "netpbm documentation" |
| 7 |
|
| 8 |
.SH NAME |
| 9 |
|
| 10 |
pamtowinicon - convert Netpbm PAM images to a Microsoft Windows icon file |
| 11 |
|
| 12 |
.UN synopsis |
| 13 |
.SH SYNOPSIS |
| 14 |
|
| 15 |
\fBpamtowinicon\fP |
| 16 |
[\fB-pngthreshold=\fP\fIthreshold\fP] |
| 17 |
[\fB-truetransparent\fP] |
| 18 |
[\fB-verbose\fP] |
| 19 |
[\fIpam_file\fP] |
| 20 |
.PP |
| 21 |
All options can be abbreviated to their shortest unique prefix. |
| 22 |
You may use two hyphens instead of one to designate an option. You |
| 23 |
may use either white space or equals signs between an option name and |
| 24 |
its value. |
| 25 |
|
| 26 |
.UN description |
| 27 |
.SH DESCRIPTION |
| 28 |
.PP |
| 29 |
This program is part of |
| 30 |
.BR "Netpbm" (1)\c |
| 31 |
\&. |
| 32 |
.PP |
| 33 |
\fBpamtowinicon\fP reads an RGB_ALPHA Netpbm PAM file and converts it to a |
| 34 |
Microsoft Windows icon file. |
| 35 |
.PP |
| 36 |
The output goes to Standard Output. |
| 37 |
.PP |
| 38 |
The input is a multi-image PAM file; each image becomes an icon in the |
| 39 |
output file. If you have input images in multiple files, you can simply |
| 40 |
combine them with \fBcat\fP and pass the result to \fBpamtowinicon\fP. |
| 41 |
|
| 42 |
|
| 43 |
.UN options |
| 44 |
.SH OPTIONS |
| 45 |
.PP |
| 46 |
In addition to the options common to all programs based on libnetpbm (most |
| 47 |
notably \fB-quiet\fP, see |
| 48 |
.UR index.html#commonoptions |
| 49 |
Common Options |
| 50 |
.UE |
| 51 |
\&), \fBpamtowinicon\fP recognizes the following command |
| 52 |
line options: |
| 53 |
|
| 54 |
|
| 55 |
.TP |
| 56 |
\fB-pngthreshold=\fP\fIthreshold\fP |
| 57 |
\fBpamtowinicon\fP encodes images with resolutions above or |
| 58 |
equal \fIthreshold\fP by \fIthreshold\fP as PNG by running |
| 59 |
.BR "\fBpnmtopng\fP" (1)\c |
| 60 |
\&. Other images it encodes |
| 61 |
using the more traditional BMP format. |
| 62 |
.sp |
| 63 |
When the program uses PNG encoding for a 5-channel PAM with separate AND |
| 64 |
mask (see below), it discards the AND mask. Because PNG has always had the |
| 65 |
ability to specify transparency, the Windows icon format does not provide for |
| 66 |
a separate and mask when the icon is encoded in PNG. |
| 67 |
.sp |
| 68 |
The default value for \fIthreshold\fP is 128. |
| 69 |
|
| 70 |
.TP |
| 71 |
\fB-truetransparent\fP |
| 72 |
Make all pixels outside the opaque area black, avoiding inversion |
| 73 |
and other effects on the background of the image |
| 74 |
(see |
| 75 |
.BR "Windows Icons" (1)\c |
| 76 |
\&). |
| 77 |
|
| 78 |
.TP |
| 79 |
\fB-verbose\fP |
| 80 |
Print more messages |
| 81 |
|
| 82 |
|
| 83 |
|
| 84 |
|
| 85 |
.UN images |
| 86 |
.SH IMAGES |
| 87 |
.PP |
| 88 |
\fBpamtowinicon\fP reads a (multi-image) Netpbm PAM file |
| 89 |
as input and outputs an single Windows icon file containing those images. |
| 90 |
.PP |
| 91 |
The images in the icon file are in the same order as in the PAM input. |
| 92 |
|
| 93 |
|
| 94 |
.UN paminput |
| 95 |
.SS PAM Input |
| 96 |
.PP |
| 97 |
\fBpamtowinicon\fP interprets the PAM images as follows, based on the number |
| 98 |
of channels. |
| 99 |
|
| 100 |
.TS |
| 101 |
l l. |
| 102 |
_ |
| 103 |
channels image |
| 104 |
1 fully opaque grayscale image |
| 105 |
2 grayscale image with transparency channel |
| 106 |
3 fully opaque color image |
| 107 |
4 color image with transparency channel |
| 108 |
5 color image with transparency channel and additional AND |
| 109 |
mask |
| 110 |
.TE |
| 111 |
.PP |
| 112 |
The tuple types of the PAMs are irrelevant. |
| 113 |
|
| 114 |
|
| 115 |
.UN andmask |
| 116 |
.SS AND Mask |
| 117 |
|
| 118 |
The so-called "AND mask" is a special feature of Microsoft |
| 119 |
Windows icons. It is required for all BMP encoded images. At the |
| 120 |
first sight, the AND mask is a 1-bit transparency channel, but it is also |
| 121 |
used for e.g. shading the icon while dragging. See |
| 122 |
.BR "Windows Icons" (1)\c |
| 123 |
\& for details. |
| 124 |
.PP |
| 125 |
If there is no explicit AND mask, but transparency data in the |
| 126 |
input image, \fBpamtowinicon\fP sets the AND mask to opaque where the |
| 127 |
sample in the transparency channel is below maxval, and to transparent |
| 128 |
elsewhere. |
| 129 |
.PP |
| 130 |
If no transparency data is present in the input image, |
| 131 |
\fBpamtowinicon\fP assumes the whole image to be fully opaque. |
| 132 |
|
| 133 |
|
| 134 |
.UN bmpoutput |
| 135 |
.SS BMP Output |
| 136 |
|
| 137 |
When BMP encoding an image, \fBpamtowinicon\fP tries to use the most |
| 138 |
compact \fBBI_RGB\fP format allowed for icon images with a color |
| 139 |
depth of eight bits per channel. |
| 140 |
.PP |
| 141 |
\fBpamtowinicon\fP generates neither 16-bit \fBBI_RGB\fP nor |
| 142 |
\fBBI_BITFIELDS\fP BMP encoded images, even if the maxval of the input |
| 143 |
PAM is not 255. |
| 144 |
|
| 145 |
|
| 146 |
.UN seealso |
| 147 |
.SH SEE ALSO |
| 148 |
|
| 149 |
|
| 150 |
.IP \(bu |
| 151 |
.BR "\fBwinicontopam\fP" (1)\c |
| 152 |
\& |
| 153 |
.IP \(bu |
| 154 |
.BR "\fBppmtowinicon\fP" (1)\c |
| 155 |
\& |
| 156 |
.IP \(bu |
| 157 |
.BR "\fBpam\fP" (1)\c |
| 158 |
\& |
| 159 |
.IP \(bu |
| 160 |
.BR "\fBWindows Icons\fP" (1)\c |
| 161 |
\& |
| 162 |
|
| 163 |
.PP |
| 164 |
For information on the PNG format, see |
| 165 |
.UR http://schaik.com/png |
| 166 |
http://schaik.com/png |
| 167 |
.UE |
| 168 |
\&. |
| 169 |
|
| 170 |
|
| 171 |
.UN history |
| 172 |
.SH HISTORY |
| 173 |
.PP |
| 174 |
\fBpamtowinicon\fP was new in Netpbm 10.63 (June 2013). It obsoleted |
| 175 |
\fBppmtowinicon\fP by providing more function and conforming better to |
| 176 |
Netpbm conventions. |
| 177 |
|
| 178 |
|
| 179 |
.UN author |
| 180 |
.SH AUTHOR |
| 181 |
.PP |
| 182 |
Copyright (C) 2013 by Ludolf Holzheid. |
| 183 |
.PP |
| 184 |
Translated to Netpbm coding style by Bryan Henderson. |
| 185 |
.SH DOCUMENT SOURCE |
| 186 |
This manual page was generated by the Netpbm tool 'makeman' from HTML |
| 187 |
source. The master documentation is at |
| 188 |
.IP |
| 189 |
.B http://netpbm.sourceforge.net/doc/pamtowinicon.html |
| 190 |
.PP |