| 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 "Xpmtoppm User Manual" 1 "31 December 2011" "netpbm documentation" |
| 7 |
|
| 8 |
.SH NAME |
| 9 |
xpmtoppm - convert an X11 pixmap to a PPM image |
| 10 |
|
| 11 |
.UN synopsis |
| 12 |
.SH SYNOPSIS |
| 13 |
|
| 14 |
\fBxpmtoppm\fP |
| 15 |
|
| 16 |
[\fB--alphaout=\fP{\fIalpha-filename\fP,\fB-\fP}] |
| 17 |
[\fB-verbose\fP] |
| 18 |
|
| 19 |
[\fIxpmfile\fP] |
| 20 |
|
| 21 |
.UN description |
| 22 |
.SH DESCRIPTION |
| 23 |
.PP |
| 24 |
This program is part of |
| 25 |
.BR "Netpbm" (1)\c |
| 26 |
\&. |
| 27 |
.PP |
| 28 |
\fBxpbtoppm\fP reads an X11 pixmap (XPM version 1 or 3) as input |
| 29 |
and produces a PPM image as output. |
| 30 |
|
| 31 |
.UN options |
| 32 |
.SH OPTIONS |
| 33 |
.PP |
| 34 |
In addition to the options common to all programs based on libnetpbm |
| 35 |
(most notably \fB-quiet\fP, see |
| 36 |
.UR index.html#commonoptions |
| 37 |
Common Options |
| 38 |
.UE |
| 39 |
\&), \fBxpmtoppm\fP recognizes the following |
| 40 |
command line options: |
| 41 |
|
| 42 |
|
| 43 |
.TP |
| 44 |
\fB--alphaout=\fP\fIalpha-filename\fP |
| 45 |
This option causes \fBxpmtoppm\fP to create a PBM file containing the |
| 46 |
transparency mask for the image. If the input image doesn't contain |
| 47 |
transparency information, the \fIalpha-filename\fP file contains all white |
| 48 |
(opaque) transparency values. |
| 49 |
.sp |
| 50 |
If you don't specify \fB--alphaout\fP, \fBxpmtoppm\fP does not generate a |
| 51 |
transparency file, and \fBxpmtoppm\fP discards any transparency information |
| 52 |
the input image contains. |
| 53 |
.sp |
| 54 |
If you specify \fB-\fP as the filename, \fBxpmtoppm\fP writes the |
| 55 |
transparency output to Standard Output and discards the image. |
| 56 |
.sp |
| 57 |
See |
| 58 |
.BR "pamcomp" (1)\c |
| 59 |
\& for one way to use |
| 60 |
the transparency output file. |
| 61 |
.sp |
| 62 |
\fBxpmtoppm\fP can't handle a line longer than 8K characters in |
| 63 |
the XPM input. If an input line exceeds this limit, |
| 64 |
\fBxpmtoppm\fP quits with an error message to that effect. Before |
| 65 |
Netpbm 10.30 (October 2005), the limit was 2K. |
| 66 |
|
| 67 |
.TP |
| 68 |
\fB--verbose\fP |
| 69 |
\fBxpmtoppm\fP prints information about its processing on Standard Error. |
| 70 |
|
| 71 |
|
| 72 |
|
| 73 |
.UN limitations |
| 74 |
.SH LIMITATIONS |
| 75 |
.PP |
| 76 |
\fBxpmtoppm\fP recognizes only a limited set of the features of XPM |
| 77 |
Version 3; i.e. it rejects many valid XPM images as invalid. |
| 78 |
.PP |
| 79 |
The only place a comment block is valid is starting in Column 1 of the |
| 80 |
line immediately after "static char ...". |
| 81 |
.PP |
| 82 |
In addition, \fBppmtoxpm\fP properly recognizes any single-line |
| 83 |
comment that begins in Column 1 in the color table part of the file. |
| 84 |
.PP |
| 85 |
There must be for every pixel a default colorname for a color type visual. |
| 86 |
.PP |
| 87 |
Before Netpbm 10.58 (March 2012), zero bytes per pixel causes the program |
| 88 |
to fail with a message about premature EOF on input. |
| 89 |
|
| 90 |
.UN seealso |
| 91 |
.SH SEE ALSO |
| 92 |
.BR "ppmtoxpm" (1)\c |
| 93 |
\&, |
| 94 |
.BR "pamcomp" (1)\c |
| 95 |
\&, |
| 96 |
.BR "ppm" (1)\c |
| 97 |
\& |
| 98 |
|
| 99 |
.UN author |
| 100 |
.SH AUTHOR |
| 101 |
.PP |
| 102 |
Copyright (C) 1991 by Jef Poskanzer. |
| 103 |
.PP |
| 104 |
Upgraded to work with XPM version 3 by Arnaud Le |
| 105 |
Hors<\[email protected]\fP>, |
| 106 |
Tue Apr 9 1991. |
| 107 |
.SH DOCUMENT SOURCE |
| 108 |
This manual page was generated by the Netpbm tool 'makeman' from HTML |
| 109 |
source. The master documentation is at |
| 110 |
.IP |
| 111 |
.B http://netpbm.sourceforge.net/doc/xpmtoppm.html |
| 112 |
.PP |