Debian Codegraph @

upstream/debian-unstable/man1/pnmtorle.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 "Pnmtorle User Manual" 1 "07 March 2022" "netpbm documentation"
7
8 .SH NAME
9
10 pnmtorle - convert a Netpbm image file into an RLE image file.
11
12 .UN synopsis
13 .SH SYNOPSIS
14
15 \fBpnmtorle\fP
16
17 [\fB-header\fP]
18 [\fB-verbose\fP]
19 [\fB-alpha\fP]
20 [\fB-outfile=\fP\fIoutfile\fP]
21 [\fIpnmfile\fP]
22 .PP
23 Minimum unique abbreviation of option is acceptable. You may use
24 double hyphens instead of single hyphen to denote options. You may use
25 white space in place of the equals sign to separate an option name
26 from its value.
27
28
29 .UN description
30 .SH DESCRIPTION
31 .PP
32 This program is part of
33 .BR "Netpbm" (1)\c
34 \&.
35 .PP
36 This program converts Netpbm image files into Utah RLE image files.
37 You can include a transparency mask. If the input is a multiple image file,
38 the output consists of several concatenated RLE images.
39 .PP
40 \fIpnmfile\fP is the name of the Netpbm image input file. If you don't
41 specify this argument, input is from Standard Input.
42 .PP
43 The RLE file will contain either a three channel color image (24 bits) or a
44 single channel grayscale image (8 bits) depending upon the type of Netpbm
45 input. If the Netpbm input is color, the RLE output is 3 channel 24 bit
46 color. If the Netpbm input is grayscale or black and white, the RLE output is
47 single channel grayscale.
48
49
50 .UN options
51 .SH OPTIONS
52 .PP
53 In addition to the options common to all programs based on libnetpbm (most
54 notably \fB-quiet\fP, see
55 .UR index.html#commonoptions
56 Common Options
57 .UE
58 \&), \fBpnmtorle\fP recognizes the following command line options:
59
60
61 .TP
62 \fB-verbose\fP
63 This option will cause \fBpnmtorle\fP to operate in verbose mode. The
64 program writes header information to Standard Error. Actually, there is not
65 much header information stored in a Netpbm file, so this information is
66 minimal.
67 .sp
68 Before Netpbm 10.98 (March 2022), this option is just \fB-v\fP.
69
70 .TP
71 \fB-header\fP
72 This option causes the program to dump the header of the Netpbm image to be
73 Standard Error without converting the file. It is equivalent to using
74 the \fB-verbose\fP option except that no file conversion takes place.
75 .sp
76 Before Netpbm 10.98 (March 2022), this option is just \fB-h\fP.
77
78 .TP
79 \fB-alpha\fP
80 This option causes \fBpnmtorle\fP to include a transparency channel in the
81 output image. The transparency channel is based on the image: Wherever a
82 pixel is black, the corresponding transparency value is transparent.
83 Everywhere else, the transparency value is fully opaque.
84
85 .TP
86 \fB-outfile\fP \fIoutfile\fP
87 If you specify this option, \fBpnmtorle\fP writes the output to
88 this file. If \fIoutfile\fP is \fB-\fP or you don't specify
89 \fB-outfile\fP, \fBpnmtorle\fP writes the output to Standard Output.
90 .sp
91 Before Netpbm 10.98 (March 2022), this option is just \fB-o\fP.and
92 must be separated from its value by a space, not an equal sign.
93
94
95
96 .UN examples
97 .SH EXAMPLES
98
99 .nf
100 pnmtorle -verbose file.ppm -outfile=file.rle
101
102 .fi
103 .PP
104 While running in verbose mode, convert file.ppm to RLE format and store
105 resulting data in file.rle.
106
107 .nf
108 pnmtorle -header file.pgm
109
110 .fi
111 .PP
112 Dump the header information of the Netpbm file called file.pgm.
113
114 .UN seealso
115 .SH SEE ALSO
116 .BR "rletopnm" (1)\c
117 \&
118
119 .UN author
120 .SH AUTHOR
121
122 .nf
123 Wes Barris,
124 Army High Performance Computing Research Center (AHPCRC)
125 Minnesota Supercomputer Center, Inc.
126
127 .fi
128 .SH DOCUMENT SOURCE
129 This manual page was generated by the Netpbm tool 'makeman' from HTML
130 source. The master documentation is at
131 .IP
132 .B http://netpbm.sourceforge.net/doc/pnmtorle.html
133 .PP