summary refs log tree commit diff
path: root/pnmtorle.html
blob: f488edb9ee80e0267a1c7bf8c6dec862cd9b0c24 (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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.3//EN">
<html><head><title>Pnmtorle User Manual</title></head>
<body>

<h1>pnmtorle</h1>
Updated: 31 March 1994
<br>
<a href="#index">Table Of Contents</a>

<h2>NAME</h2>

pnmtorle - convert a Netpbm image file into an RLE image file.

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

<b>pnmtorle</b>

[<b>-h</b>]
[<b>-v</b>]
[<b>-a</b>]
[<b>-o</b> <i>outfile</i>]
[<i>pnmfile</i>]

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

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

<p>This program converts Netpbm image files into Utah RLE image files.
You can include a transparency mask.  If the input is a multiple image file,
the output consists of several concatenated RLE images.

<p>The RLE file will contain either a three channel color image (24
bits) or a single channel grayscale image (8 bits) depending upon the
pnm file depth.  If a converted ppm is displayed on an 8 bit display,
the image must be dithered.  In order to produce a better looking
image (on 8 bit displays), it is recommended that the image be
quantizing (to 8 bit mapped color) prior to its display.  This may be
done by piping the output of this program into the Utah <b>mcut</b> or
<b>rlequant</b> utilities.  We show an example of this later.

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

<p>In addition to the options common to all programs based on libnetpbm
(most notably <b>-quiet</b>, see <a href="index.html#commonoptions">
Common Options</a>), <b>pnmtorle</b> recognizes the following
command line options:

<dl compact>
<dt><b>-v</b>

<dd>
This option will cause <b>pnmtorle</b> to operate in verbose mode.  The header
information is written to "stderr".  Actually, there is not much header
information stored in a Netpbm file, so this information is minimal.
<dt><b>-h</b>

<dd>
This option allows the header of the Netpbm image to be dumped to "stderr"
without converting the file.  It is equivalent to using the -v option except
that no file conversion takes place.
<dt><b>-a</b>

<dd>
This option causes <b>pnmtorle</b> to include an transparency channel in the
output image.  The transparency channel is based on the image: Wherever a
pixel is black, the corresponding trasparency value is transparent.
Everywhere else, the transparency value is fully opaque.

<dt><b>-o</b> <i>outfile</i>

<dd>If you specify this option, <b>pnmtorle</b> writes the output to
this file.  If <i>outfile</i> is <b>-</b> or you don't specify
<b>-o</b>, <b>pnmtorle</b> writes the output to Standard Output.

<dt><i>pnmfile</i>

<dd>
The name of the Netpbm image data file to be converted.  If not specified,
standard input is assumed.
</dl>

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

<pre>
   pnmtorle -v file.ppm -o file.rle
</pre>

<p>While running in verbose mode, convert file.ppm to RLE format and store
resulting data in file.rle.

<pre>
   pnmtorle -h file.pgm
</pre>

<p>Dump the header information of the Netpbm file called file.pgm.

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

<b><a href="rletopnm.html">rletopnm</a></b>

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

<pre>
Wes Barris,
Army High Performance Computing Research Center (AHPCRC)
Minnesota Supercomputer Center, Inc.
</pre>

<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>