\
.\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
.\" Do not hand-hack it!  If you have bug fixes or improvements, please find
.\" the corresponding HTML page on the Netpbm website, generate a patch
.\" against that, and send it to the Netpbm maintainer.
.TH "Ppmtowinicon User Manual" 0 "01 May 2004" "netpbm documentation"

.SH NAME

ppmtowinicon - convert PPM image into a Windows .ico file

.UN synopsis
.SH SYNOPSIS

\fBppmtowinicon\fP

[\fB-andpgms\fP]

[\fB-output=\fP\fIoutput.ico\fP]

[\fIppmfile\fP [\fIandfile\fP] ...]

.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR Netpbm (1)
.
.PP
This program is essentially obsolete; The newer \fBpamtowinicon\fP is
better.
.PP
\fBppmtowinicon\fP reads one or more PPM images as input and
produces a Microsoft Windows .ico file as output.
.PP
A Windows icon contains 1 or more images, at different resolutions
and color depths.  When Windows wants to display the icon, it searches
through the images to find the one that best matches the number of colors
and resolution of the display.
.PP
Microsoft recommends including at least the following formats in each
icon.


.IP \(bu
16 x 16 - 4 bpp
.IP \(bu
32 x 32 - 4 bpp
.IP \(bu
48 x 48 - 8 bpp

.PP
If you don't specify any input files, input is from Standard Input.
.PP
Output is to Standard Output unless you specify \fB-output\fP.

.UN transparency
.SS Transparency
.PP
If you specify the \fB-andmask\fP option, you get (partly)
transparent icons.  In that case, your arguments are pairs of file
names, with the first file name being that of the image and the second
file name being that of a standard Netpbm PGM transparency mask (see
the
.BR pgm format specification (5)
).
.PP
In a .ico file, there is no such thing as partial transparency
(translucency).  Where the PGM mask says completely opaque, the icon will
be opaque.  Everywhere else, the icon will be transparent.  Note that
as with any Netpbm program, you can use a PBM image for the transparency
mask and \fBppmtowinicon\fP will treat it like a PGM.
.PP
The and mask is like an alpha mask, except for what it signifies in
the "not opaque" areas.  In the usual case, the foreground image is
black in those areas, and in that case the areas are fully transparent
-- the background shows through the icon.  But in general, a not
opaque pixel signifies that the background and foreground should be
merged as follows: The intensities of the color components in the
foreground and background are represented as binary numbers, then
corresponding bits of the background and foreground intensities are
exclusive-or'ed together.  So there is a sort of reverse video effect.
.PP
If you don't want this special effect and instead want
straightforward transparency, use the \fB-truetransparent\fP option.
This causes \fBppmtowinicon\fP to make the base image black
everywhere your transparency mask says transparent, regardless of what
color your input image is at that location.
.PP
If you don't specify \fB-andmask\fP, \fBppmtowinicon\fP puts
all-opaque and masks into the .ico file.

.UN options
.SH OPTIONS


.TP
\fB-andpgms\fP
Include transparency information in the icons.
See the 
.UR #transparency
transparency section
.UE
\&.
     
.TP
\fB-output=\fP\fIoutput.ico\fP
Name of output file.  By default, \fBppmtowinicon\fP writes the
icon to Standard Output.

.TP
\fB-truetransparent\fP
Make transparency in the icon normal instead of the special reverse
video effect.  See the 
.UR #transparency
transparency section
.UE
\&.
     


.UN seealso
.SH SEE ALSO
.BR pamtowinicon (1)
,
.BR winicontoppm (1)
,
.BR ppm (5)

.BR pgm (5)


.UN author
.SH AUTHOR

Copyright (C) 2000 by Lee Benfield.