about summary refs log tree commit diff
path: root/palmtopnm.html
blob: c8965f730dfb6b6e622725dabc53360e22461be0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML><HEAD><TITLE>Palmtopnm User Manual</TITLE></HEAD>
<BODY>
<H1>palmtopnm</H1>
Updated: 26 January 2005
<BR>
<A HREF="#index">Table Of Contents</A>

<H2>NAME</H2>

palmtopnm - convert a Palm Bitmap to a PNM image

<H2 id="synopsis">SYNOPSIS</H2>

<B>palmtopnm</B>

[<B>-verbose</B>]

[<B>-rendition</B> <I>N</I>]

[<B>-showhist</B>]

<BR>

[<I>palmfile</I>]

<BR>

<B>palmtopnm</B>

<B>-transparent</B>

[<B>-verbose</B>]

[<I>palmfile</I>]

<H2 id="description">DESCRIPTION</H2>

<p>This program is part of <a href="index.html">Netpbm</a>.

<p><b>palmtopnm</b> reads a Palm Bitmap as input, from Standard Input or
<I>palmfile</I> and produces a PPM image as output.

<p>Alternatively (when you specify <b>-transparent</b>),
<b>palmtopnm</b> writes the value of the transparent color in the Palm
Bitmap to Standard Output.


<p><b>Palmtopnm</b> can convert Palm Bitmaps with the following features.
This does not mean that it doesn't handle other features.  These are just
the ones we found worth mentioning.
<ul>
<li>Version 0
<li>Version 1
<li>Version 2
<li>Version 3 (new in Netpbm 10.27 (March 2005))
<li>Scanline compression
<li>RLE compression
<li>Packbits compression (new in Netpbm 10.27 (March 2005))
</ul>

<H2 id="options">OPTIONS</H2>

<DL COMPACT>
<DT><B>-verbose</B>

<DD>
Display various interesting information about the input file and process.

<DT><B>-transparent</B>

<DD>
If the Palm Bitmap has a transparent color set, 
<b>palmtopnm</b> writes the value for that
color to Standard Output in the form #RRGGBB, where
RR, GG, and BB are two-digit hexadecimal numbers
indicating a value in the range 0 through 255.  If no transparent color is set
in the Bitmap, <b>palmtopnm</b> writes nothing.  <b>palmtopnm</b> does not
generate any output image when you specify <b>-transparent</b>.

<DT><B>-rendition N</B>

<DD>
Palm Bitmaps may contain several different renditions of the same
image, with different depths.  By default, <B>palmtopnm </B> operates
on the first rendition (rendition number 1) in the image.  This
switch allows you to operate on a different rendition.  The value must
be between 1 and the number of renditions in the image, inclusive.

<DT><B>-showhist</B>

<DD>
This option causes <b>palmtopnm</b> to 
write a histogram of colors in the input file to Standard Error.

</DL>

<H2 id="seealso">SEE ALSO</H2>

<B><A HREF="pnmtopalm.html">pnmtopalm</A></B>,
<B><A HREF="pamtopdbimg.html">pamtopdbimg</A></B>,

<A HREF="pnm.html">pnm</A>,

<H2 id="limitations">LIMITATIONS</H2>

<P>You cannot generate a transparency mask if the Palm Bitmap has a
transparent color.  However, you can still do this with
<B>ppmcolormask</B> with a Netpbm pipe similar to:

<P>
<B>palmtopnm bitmap.palm | 
ppmcolormask `palmtopnm -transparent bitmap.palm`</B>

<h2 id="history">HISTORY</h2>

<p>Before Netpbm 10.23 (July 2004), there was a <b>-forceplain</b>
option.  But that had been redundant for a long time, since the Netpbm 
common option <b>-plain</b> does the same thing.

<H2 id="authors">AUTHORS</H2>

This program was originally written as Tbmptopnm.c, by Ian Goldberg.
It was heavily modified by Bill Janssen to add color, compression, and
transparency function.

<p>Copyright 1995-2001 by Ian Goldberg and Bill Janssen.

<HR>
<H2 id="index">Table Of Contents</H2>
<UL>
<LI><A HREF="#synopsis">SYNOPSIS</A>
<LI><A HREF="#description">DESCRIPTION</A>
<LI><A HREF="#options">OPTIONS</A>
<LI><A HREF="#seealso">SEE ALSO</A>
<LI><A HREF="#limitations">LIMITATIONS</A>
<LI><A HREF="#history">HISTORY</A>
<LI><A HREF="#authors">AUTHORS</A>
</UL>
</BODY>
</HTML>