about summary refs log tree commit diff
path: root/rletopnm.html
blob: 0213231113da36494883b7c390fd427901db33fe (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
142
143
144
145
146
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML><HEAD><TITLE>Rletopnm User Manual</TITLE></HEAD>
<BODY>
<H1>RLETOPNM</H1>
Updated: 13 April 2000
<BR>
<A HREF="#index">Table Of Contents</A>
<H2>NAME</H2>

rletopnm - convert a Utah Raster Tools RLE image file to a PNM image file.

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

<B>rletopnm</B>

[<B>--alphaout=</B>{<I>alpha-filename</I>,<B>-</B>}]
[<B>--headerdump</B>|<B>-h</B>]

[<B>--verbose</B>|<B>-v</B>]

[<I>rlefile</I>|<B>-</B>]

<P>All options may be abbreviated to their minimum unique abbreviation
and options and arguments may be in any order.

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

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

<p><b>rletopnm</b> converts Utah Raster Toolkit RLE image files to PNM
image files.  <B>rletopnm</B> handles four types of RLE files:
Grayscale (8 bit data, no color map), Pseudocolor (8 bit data with a
color map), Truecolor (24 bit data with color map), and Directcolor
(24 bit data, no color map).  <B>rletopnm</B> generates a PPM file for
all these cases except for the Grayscale file, for which
<B>rletopnm</B> generates a PGM file.

<P><I>rlefile</I> is the RLE input file.  If it is absent or <B>-</B>,
the input comes from Standard Input.

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

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

<DD>
<B>rletopnm </B> creates a PGM (portable graymap) file containing the
transparency channel values in the input image.  If the input image doesn't
contain an transparency channel, the <I>alpha-filename</I> file contains all
zero (transparent) transparency values.  If you don't specify
<B>--alphaout</B>, <B>rletopnm</B> does not generate a transparency file,
and if the input image has a transparency channel, <B>rletopnm</B> simply
discards it.

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

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

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

<DD>This option causes <B>rletopnm </B> to operate in verbose mode.
It prints messages about what it's doing, including the contents of
the RLE image header, to Standard Error.

<DT><B>--headerdump</B>

<DD>This option causes <B>rletopnm</B> to operate in header dump mode.
It prints the contents of the RLE image header to Standard Error, but
does not produce any other output.

</DL>

<H2 id="examples">EXAMPLES</H2>

<ul>
<li>While running in verbose mode, convert lenna.rle to PPM format and
store the resulting image as lenna.ppm:

<pre>
<kbd>
    rletopnm --verbose lenna.rle &gt;lenna.ppm
</kbd>
</pre>

<li>Dump the header information of the RLE file called file.rle:

<pre>
<kbd>
    rletopnm --headerdump file.rle
</kbd>
</pre>

<li>Convert RLE file dart.rle to PPM format as dart.ppm.  Store the
transparency channel of dart.rle as dartalpha.pgm (if dart.rle doesn't have
a transparency channel, store a fully transparent transparency mask as
dartalpha.pgm):

<pre>
<kbd>
    rletopnm --alphaout=dartalpha.pgm dart.rle &gt;dart.ppm
</kbd>
</pre>

</ul>

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

<B><A HREF="pnmtorle.html">pnmtorle</A></B>,

<B><A HREF="pnmconvol.html">pnmconvol</A></B>,

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

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

<B><A HREF="pgm.html">pgm</A></B>,

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

Wes Barris
<BR>

Army High Performance Computing Research Center (AHPCRC)
<BR>

Minnesota Supercomputer Center, Inc.

<P>Modifications by Eric Haines to support raw and plain formats.

<P>Modifications by Bryan Henderson to create transparency files and use
mnemonic options.

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