1Pamtowinicon User Manual(0)                        Pamtowinicon User Manual(0)
2
3
4

NAME

6       pamtowinicon  -  convert  Netpbm PAM images to a Microsoft Windows icon
7       file
8
9

SYNOPSIS

11       pamtowinicon  [-pngthreshold=threshold]  [-truetransparent]  [-verbose]
12       [pam_file]
13
14       All  options  can  be abbreviated to their shortest unique prefix.  You
15       may use two hyphens instead of one to designate an option.  You may use
16       either  white  space  or  equals  signs  between an option name and its
17       value.
18
19

DESCRIPTION

21       This program is part of Netpbm(1).
22
23       pamtowinicon reads an RGB_ALPHA Netpbm PAM file and converts  it  to  a
24       Microsoft Windows icon file.
25
26       The output goes to Standard Output.
27
28       The  input is a multi-image PAM file; each image becomes an icon in the
29       output file.  If you have input images in multiple files, you can  sim‐
30       ply combine them with cat and pass the result to pamtowinicon.
31
32
33

OPTIONS

35       In  addition  to  the options common to all programs based on libnetpbm
36       (most notably -quiet, see Common Options ⟨index.html#commonoptions⟩  ),
37       pamtowinicon recognizes the following command line options:
38
39
40
41       -pngthreshold=threshold
42              pamtowinicon  encodes  images  with  resolutions  above or equal
43              threshold by threshold as PNG  by  running  pnmtopng(1).   Other
44              images it encodes using the more traditional BMP format.
45
46              When the program uses PNG encoding for a 5-channel PAM with sep‐
47              arate AND mask (see below), it discards the AND  mask.   Because
48              PNG has always had the ability to specify transparency, the Win‐
49              dows icon format does not provide for a separate and  mask  when
50              the icon is encoded in PNG.
51
52              The default value for threshold is 128.
53
54
55       -truetransparent
56              Make  all  pixels outside the opaque area black, avoiding inver‐
57              sion and other effects on the background of the image (see  Win‐
58              dows Icons(1)).
59
60
61       -verbose
62              Print more messages
63
64
65
66
67

IMAGES

69       pamtowinicon reads a (multi-image) Netpbm PAM file as input and outputs
70       an single Windows icon file containing those images.
71
72       The images in the icon file are in the same order as in the PAM input.
73
74
75
76   PAM Input
77       pamtowinicon interprets the PAM images as follows, based on the  number
78       of channels.
79
80
81       ────────────────────────────────────────────────────────────────────
82       channels   image
83       1          fully opaque grayscale image
84       2          grayscale image with transparency channel
85       3          fully opaque color image
86       4          color image with transparency channel
87       5          color image with transparency channel and additional AND
88       mask
89
90       The tuple types of the PAMs are irrelevant.
91
92
93
94   AND Mask
95       The  so-called  "AND  mask"  is  a special feature of Microsoft Windows
96       icons.  It is required for all BMP encoded images.  At the first sight,
97       the  AND  mask is a 1-bit transparency channel, but it is also used for
98       e.g. shading  the  icon  while  dragging.   See  Windows  Icons(1)  for
99       details.
100
101       If  there  is  no explicit AND mask, but transparency data in the input
102       image, pamtowinicon sets the AND mask to opaque where the sample in the
103       transparency channel is below maxval, and to transparent elsewhere.
104
105       If  no  transparency  data  is present in the input image, pamtowinicon
106       assumes the whole image to be fully opaque.
107
108
109
110   BMP Output
111       When BMP encoding an image, pamtowinicon tries to use the most  compact
112       BI_RGB  format allowed for icon images with a color depth of eight bits
113       per channel.
114
115       pamtowinicon generates  neither  16-bit  BI_RGB  nor  BI_BITFIELDS  BMP
116       encoded images, even if the maxval of the input PAM is not 255.
117
118
119

SEE ALSO

121       ·
122
123              winicontopam(1)
124
125       ·
126
127              ppmtowinicon(1)
128
129       ·
130
131              pam(1)
132
133       ·
134
135              Windows Icons(1)
136
137
138       For   information   on   the   PNG  format,  see  http://schaik.com/png
139       ⟨http://schaik.com/png⟩ .
140
141
142

HISTORY

144       pamtowinicon was new in Netpbm 10.63 (June 2013).   It  obsoleted  ppm‐
145       towinicon  by  providing  more function and conforming better to Netpbm
146       conventions.
147
148
149

AUTHOR

151       Copyright (C) 2013 by Ludolf Holzheid.
152
153       Translated to Netpbm coding style by Bryan Henderson.
154

DOCUMENT SOURCE

156       This manual page was generated by the Netpbm tool 'makeman'  from  HTML
157       source.  The master documentation is at
158
159              http://netpbm.sourceforge.net/doc/pamtowinicon.html
160
161netpbm documentation             12 April 2013     Pamtowinicon User Manual(0)