| 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 "Ppmtowinicon User Manual" 1 "01 May 2004" "netpbm documentation" |
| 7 |
|
| 8 |
.SH NAME |
| 9 |
ppmtowinicon - convert PPM image into a Windows .ico file |
| 10 |
|
| 11 |
.UN synopsis |
| 12 |
.SH SYNOPSIS |
| 13 |
|
| 14 |
\fBppmtowinicon\fP |
| 15 |
|
| 16 |
[\fB-andpgms\fP] |
| 17 |
|
| 18 |
[\fB-output=\fP\fIoutput.ico\fP] |
| 19 |
|
| 20 |
[\fIppmfile\fP [\fIandfile\fP] ...] |
| 21 |
|
| 22 |
.UN description |
| 23 |
.SH DESCRIPTION |
| 24 |
.PP |
| 25 |
This program is part of |
| 26 |
.BR "Netpbm" (1)\c |
| 27 |
\&. |
| 28 |
.PP |
| 29 |
This program is essentially obsolete; The newer \fBpamtowinicon\fP is |
| 30 |
better. |
| 31 |
.PP |
| 32 |
\fBppmtowinicon\fP reads one or more PPM images as input and |
| 33 |
produces a Microsoft Windows .ico file as output. |
| 34 |
.PP |
| 35 |
A Windows icon contains 1 or more images, at different resolutions |
| 36 |
and color depths. When Windows wants to display the icon, it searches |
| 37 |
through the images to find the one that best matches the number of colors |
| 38 |
and resolution of the display. |
| 39 |
.PP |
| 40 |
Microsoft recommends including at least the following formats in each |
| 41 |
icon. |
| 42 |
|
| 43 |
|
| 44 |
.IP \(bu |
| 45 |
16 x 16 - 4 bpp |
| 46 |
.IP \(bu |
| 47 |
32 x 32 - 4 bpp |
| 48 |
.IP \(bu |
| 49 |
48 x 48 - 8 bpp |
| 50 |
|
| 51 |
.PP |
| 52 |
If you don't specify any input files, input is from Standard Input. |
| 53 |
.PP |
| 54 |
Output is to Standard Output unless you specify \fB-output\fP. |
| 55 |
|
| 56 |
.UN transparency |
| 57 |
.SS Transparency |
| 58 |
.PP |
| 59 |
If you specify the \fB-andmask\fP option, you get (partly) |
| 60 |
transparent icons. In that case, your arguments are pairs of file |
| 61 |
names, with the first file name being that of the image and the second |
| 62 |
file name being that of a standard Netpbm PGM transparency mask (see |
| 63 |
the |
| 64 |
.BR "pgm format specification" (1)\c |
| 65 |
\&). |
| 66 |
.PP |
| 67 |
In a .ico file, there is no such thing as partial transparency |
| 68 |
(translucency). Where the PGM mask says completely opaque, the icon will |
| 69 |
be opaque. Everywhere else, the icon will be transparent. Note that |
| 70 |
as with any Netpbm program, you can use a PBM image for the transparency |
| 71 |
mask and \fBppmtowinicon\fP will treat it like a PGM. |
| 72 |
.PP |
| 73 |
The and mask is like a transparency mask, except for what it signifies in |
| 74 |
the "not opaque" areas. In the usual case, the foreground image is |
| 75 |
black in those areas, and in that case the areas are fully transparent |
| 76 |
-- the background shows through the icon. But in general, a not |
| 77 |
opaque pixel signifies that the background and foreground should be |
| 78 |
merged as follows: The intensities of the color components in the |
| 79 |
foreground and background are represented as binary numbers, then |
| 80 |
corresponding bits of the background and foreground intensities are |
| 81 |
exclusive-or'ed together. So there is a sort of reverse video effect. |
| 82 |
.PP |
| 83 |
If you don't want this special effect and instead want |
| 84 |
straightforward transparency, use the \fB-truetransparent\fP option. |
| 85 |
This causes \fBppmtowinicon\fP to make the base image black |
| 86 |
everywhere your transparency mask says transparent, regardless of what |
| 87 |
color your input image is at that location. |
| 88 |
.PP |
| 89 |
If you don't specify \fB-andmask\fP, \fBppmtowinicon\fP puts |
| 90 |
all-opaque and masks into the .ico file. |
| 91 |
|
| 92 |
.UN options |
| 93 |
.SH OPTIONS |
| 94 |
.PP |
| 95 |
In addition to the options common to all programs based on libnetpbm |
| 96 |
(most notably \fB-quiet\fP, see |
| 97 |
.UR index.html#commonoptions |
| 98 |
Common Options |
| 99 |
.UE |
| 100 |
\&), \fBppmtowinicon\fP recognizes the following |
| 101 |
command line options: |
| 102 |
|
| 103 |
|
| 104 |
.TP |
| 105 |
\fB-andpgms\fP |
| 106 |
Include transparency information in the icons. |
| 107 |
See the |
| 108 |
.UR #transparency |
| 109 |
transparency section |
| 110 |
.UE |
| 111 |
\&. |
| 112 |
|
| 113 |
.TP |
| 114 |
\fB-output=\fP\fIoutput.ico\fP |
| 115 |
Name of output file. By default, \fBppmtowinicon\fP writes the |
| 116 |
icon to Standard Output. |
| 117 |
|
| 118 |
.TP |
| 119 |
\fB-truetransparent\fP |
| 120 |
Make transparency in the icon normal instead of the special reverse |
| 121 |
video effect. See the |
| 122 |
.UR #transparency |
| 123 |
transparency section |
| 124 |
.UE |
| 125 |
\&. |
| 126 |
|
| 127 |
|
| 128 |
|
| 129 |
.UN seealso |
| 130 |
.SH SEE ALSO |
| 131 |
.BR "pamtowinicon" (1)\c |
| 132 |
\&, |
| 133 |
.BR "winicontoppm" (1)\c |
| 134 |
\&, |
| 135 |
.BR "ppm" (1)\c |
| 136 |
\& |
| 137 |
.BR "pgm" (1)\c |
| 138 |
\& |
| 139 |
|
| 140 |
.UN author |
| 141 |
.SH AUTHOR |
| 142 |
|
| 143 |
Copyright (C) 2000 by Lee Benfield. |
| 144 |
.SH DOCUMENT SOURCE |
| 145 |
This manual page was generated by the Netpbm tool 'makeman' from HTML |
| 146 |
source. The master documentation is at |
| 147 |
.IP |
| 148 |
.B http://netpbm.sourceforge.net/doc/ppmtowinicon.html |
| 149 |
.PP |