Debian Codegraph @

upstream/debian-unstable/man1/rletopnm.1

raw
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 "Rletopnm User Manual" 1 "13 April 2000" "netpbm documentation"
7
8 .SH NAME
9 rletopnm - convert a Utah Raster Tools RLE image file to a PNM image file.
10
11 .UN synopsis
12 .SH SYNOPSIS
13
14 \fBrletopnm\fP
15
16 [\fB--alphaout=\fP{\fIalpha-filename\fP,\fB-\fP}]
17 [\fB--headerdump\fP|\fB-h\fP]
18
19 [\fB--verbose\fP|\fB-v\fP]
20
21 [\fIrlefile\fP|\fB-\fP]
22 .PP
23 All options may be abbreviated to their minimum unique abbreviation
24 and options and arguments may be in any order.
25
26 .UN description
27 .SH DESCRIPTION
28 .PP
29 This program is part of
30 .BR "Netpbm" (1)\c
31 \&.
32 .PP
33 \fBrletopnm\fP converts Utah Raster Toolkit RLE image files to PNM
34 image files. \fBrletopnm\fP handles four types of RLE files:
35 Grayscale (8 bit data, no color map), Pseudocolor (8 bit data with a
36 color map), Truecolor (24 bit data with color map), and Directcolor
37 (24 bit data, no color map). \fBrletopnm\fP generates a PPM file for
38 all these cases except for the Grayscale file, for which
39 \fBrletopnm\fP generates a PGM file.
40 .PP
41 \fIrlefile\fP is the RLE input file. If it is absent or \fB-\fP,
42 the input comes from Standard Input.
43
44 .UN options
45 .SH OPTIONS
46 .PP
47 In addition to the options common to all programs based on libnetpbm
48 (most notably \fB-quiet\fP, see
49 .UR index.html#commonoptions
50 Common Options
51 .UE
52 \&), \fBrletopnm\fP recognizes the following
53 command line options:
54
55
56 .TP
57 \fB--alphaout=\fP\fIalpha-filename\fP
58 \fBrletopnm \fP creates a PGM (portable graymap) file containing the
59 transparency channel values in the input image. If the input image doesn't
60 contain an transparency channel, the \fIalpha-filename\fP file contains all
61 zero (transparent) transparency values. If you don't specify
62 \fB--alphaout\fP, \fBrletopnm\fP does not generate a transparency file,
63 and if the input image has a transparency channel, \fBrletopnm\fP simply
64 discards it.
65 .sp
66 If you specify \fB-\fP as the filename, \fBrletopnm\fP writes the
67 transparency output to Standard Output and discards the image.
68 .sp
69 See
70 .BR "pamcomp" (1)\c
71 \& for one way to use
72 the transparency output file.
73
74 .TP
75 \fB--verbose\fP
76 This option causes \fBrletopnm \fP to operate in verbose mode.
77 It prints messages about what it's doing, including the contents of
78 the RLE image header, to Standard Error.
79
80 .TP
81 \fB--headerdump\fP
82 This option causes \fBrletopnm\fP to operate in header dump mode.
83 It prints the contents of the RLE image header to Standard Error, but
84 does not produce any other output.
85
86
87
88 .UN examples
89 .SH EXAMPLES
90
91
92 .IP \(bu
93 While running in verbose mode, convert lenna.rle to PPM format and
94 store the resulting image as lenna.ppm:
95
96 .nf
97 \f(CW
98 rletopnm --verbose lenna.rle >lenna.ppm
99 \fP
100
101 .fi
102
103 .IP \(bu
104 Dump the header information of the RLE file called file.rle:
105
106 .nf
107 \f(CW
108 rletopnm --headerdump file.rle
109 \fP
110
111 .fi
112
113 .IP \(bu
114 Convert RLE file dart.rle to PPM format as dart.ppm. Store the
115 transparency channel of dart.rle as dartalpha.pgm (if dart.rle doesn't have
116 a transparency channel, store a fully transparent transparency mask as
117 dartalpha.pgm):
118
119 .nf
120 \f(CW
121 rletopnm --alphaout=dartalpha.pgm dart.rle >dart.ppm
122 \fP
123
124 .fi
125
126
127
128 .UN seealso
129 .SH SEE ALSO
130 .BR "pnmtorle" (1)\c
131 \&,
132 .BR "pnmconvol" (1)\c
133 \&,
134 .BR "pnm" (1)\c
135 \&,
136 .BR "ppm" (1)\c
137 \&,
138 .BR "pgm" (1)\c
139 \&,
140
141 .UN author
142 .SH AUTHOR
143
144 Wes Barris
145 Army High Performance Computing Research Center (AHPCRC)
146 Minnesota Supercomputer Center, Inc.
147 .PP
148 Modifications by Eric Haines to produce raw and plain formats.
149 .PP
150 Modifications by Bryan Henderson to create transparency files and use
151 mnemonic options.
152 .SH DOCUMENT SOURCE
153 This manual page was generated by the Netpbm tool 'makeman' from HTML
154 source. The master documentation is at
155 .IP
156 .B http://netpbm.sourceforge.net/doc/rletopnm.html
157 .PP