summary refs log tree commit diff
path: root/xpmtoppm.html
blob: dad8dfdca9f5b01c82d9805d6c536f2094498333 (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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML><HEAD><TITLE>Xpmtoppm User Manual</TITLE></HEAD>
<BODY>
<H1>xpmtoppm</H1>
Updated: 30 December 2011
<BR>
<A HREF="#index">Table Of Contents</A>

<H2>NAME</H2>

xpmtoppm - convert an X11 pixmap to a PPM image

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

<B>xpmtoppm</B>

[<B>--alphaout=</B>{<I>alpha-filename</I>,<B>-</B>}]
[<B>-verbose</B>]

[<I>xpmfile</I>]

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

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

<p><b>xpbtoppm</b> reads an X11 pixmap (XPM version 1 or 3) as input
and produces a PPM image as output.

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

<DL COMPACT>
<DT><B>--alphaout=</B><I>alpha-filename</I>

<DD><B>xpmtoppm</B> creates a PBM file containing the transparency
mask for the image.  If the input image doesn't contain transparency
information, the <I>alpha-filename</I> file contains all white
(opaque) alpha values.  If you don't specify <B>--alphaout</B>,
<B>xpmtoppm</B> does not generate an alpha file, and if the input
image has transparency information, <B>xpmtoppm</B> simply discards
it.

<P>If you specify <B>-</B> as the filename, <B>xpmtoppm</B> writes the
alpha output to Standard Output and discards the image.

<P>See <B><A HREF="pamcomp.html">pamcomp</A></B> for one way to use
the alpha output file.

<p><b>xpmtoppm</b> can't handle a line longer than 8K characters in
the the XPM input.  If an input line exceeds this limit,
<b>xpmtoppm</b> quits with an error message to that effect.  Before
Netpbm 10.30 (October 2005), the limit was 2K.

<DT><B>--verbose</B>

<DD>
<B>xpmtoppm</B> prints information about its processing on Standard Error.

</DL>

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

<p><b>xpmtoppm</b> recognizes only a limited set of the features of XPM
Version 3; i.e. it rejects as invalid many valid XPM images.

<p>The only place a comment block is valid is starting in Column 1 of the
line immediately after &quot;static char ...&quot;.

<p>In addition, <b>ppmtoxpm</b> properly recognizes any single-line
comment that begins in Column 1 in the color table part of the file.

<p>There must be for every pixel a default colorname for a color type visual.

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

<B><A HREF="ppmtoxpm.html">ppmtoxpm</A></B>,
<B><A HREF="pamcomp.html">pamcomp</A></B>,
<B><A HREF="ppm.html">ppm</A></B>

<H2 id="author">AUTHOR</H2>

<P>Copyright (C) 1991 by Jef Poskanzer.

<P>Upgraded to work with XPM version 3 by Arnaud Le
Hors&lt;<A HREF="mailto:lehors@mirsa.inria.fr">lehors@mirsa.inria.fr</A>&gt;,
Tue Apr 9 1991.

<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="#limitations">LIMITATIONS</A>
<LI><A HREF="#seealso">SEE ALSO</A>
<LI><A HREF="#author">AUTHOR</A>
</UL>
</BODY>
</HTML>