Debian Codegraph @

upstream/debian-unstable/man1/pbmtoescp2.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 "Pbmtoescp2 User Manual" 1 "14 July 2015" "netpbm documentation"
7
8 .SH NAME
9
10 pbmtoescp2 - convert a PBM image to a ESC/P2 printer file
11
12 .UN synopsis
13 .SH SYNOPSIS
14
15 \fBpbmtoescp2\fP
16
17 [\fB-compress=\fP\fIcompressionmode\fP]
18 [\fB-resolution=\fP{\fB180\fP|\fB360\fP|\fB720\fP}]
19 [\fB-stripeheight=\fP\fIn\fP]
20 [\fB-formfeed\fP]
21 [\fB-raw\fP]
22 [\fIpbmfile\fP]
23 .PP
24 All options can be abbreviated to their shortest unique prefix. You
25 may use two hyphens instead of one to designate an option. You may
26 use either white space or equals signs between an option name and its
27 value.
28
29 .UN description
30 .SH DESCRIPTION
31 .PP
32 This program is part of
33 .BR "Netpbm" (1)\c
34 \&.
35 .PP
36 \fBpbmtoescp2\fP reads a PBM image as input. It produces an ESC/P2
37 raster graphic printer control stream as output.
38 .PP
39 This program creates an output that is printable on Epson printers that
40 understand the ESC/P2 printer control language (e.g. the Stylus models). For
41 older Epson 9-pin dot matrix printers, which use the ESC/P protocol, see
42 \fBpbmtoepson\fP.
43 .PP
44 The printed output has one pixel for each pixel of the input image, except
45 that it is padded up to the stripe size (see \fB-stripeheight\fP option)
46 vertically and to a multiple of 8 columns horizontally. Before Netpbm 10.72
47 (September 2015), the output is instead truncated to those boundaries.
48 .PP
49 Input is read from file \fIpbmfile\fP if specified, otherwise from
50 stdin. Output is written to stdout.
51
52 .UN options
53 .SH OPTIONS
54 .PP
55 In addition to the options common to all programs based on libnetpbm
56 (most notably \fB-quiet\fP, see
57 .UR index.html#commonoptions
58 Common Options
59 .UE
60 \&), \fBpbmtoescp2\fP recognizes the following
61 command line options:
62
63
64
65 .TP
66 \fB-compress=\fP\fIcompressionmode\fP
67 This determines the compression mode that \fBpbmtoescp2\fP uses
68 in its output. Valid values for \fIcompressionmode\fP are \fB0\fP
69 and \fB1\fP. \fB-compress=0\fP results in a printer control stream
70 with uncompressed raster graphic data. \fB-compress=1\fP results in
71 a printer control stream with RLE compressed raster graphic data
72 (RLE means Run Length Encoding). The default is \fB-compress=1\fP.
73
74
75 .TP
76 \fB-resolution=\fP\fIdpi\fP
77 This determines the horizontal and the vertical print resolution
78 set in the printer control stream. Another way of looking at it is a
79 declaration of what the resolution of the input image is (PBM images
80 don't have inherent resolution). Valid values for \fIdpi\fP are
81 \fB180\fP, \fB360\fP, and \fB720\fP. See
82 .UR #hints
83 hints
84 .UE
85 \& for
86 more information on this.
87 .sp
88 The default is \fB-resolution=360\fP.
89 .sp
90 Before Netpbm 10.72 (September 2015), \fB720\fP is not valid.
91
92
93
94 .TP
95 \fB-stripeheight=\fP\fIn\fP
96 This option controls the height in lines of the stripes in the output.
97 .sp
98 The valid stripe heights in the printer language are 1, 8, and 24, but
99 it is capable of expressing any height up to 255 and \fBpbmtoescp2\fP
100 accepts any value in the range 1-255. It issues a warning, though, if you
101 choose something other than 1, 8, or 24.
102 .sp
103 The default is 24.
104 .sp
105 This option was new in Netpbm 10.72 (September 2015). Before that, the
106 stripe size is always 24.
107
108 .TP
109 \fB-formfeed\fP
110 This option causes \fBpbmtoescp2\fP to place a formfeed command at the
111 end of the output.
112 .sp
113 This option was new in Netpbm 10.72 (September 2015).
114
115
116 .TP
117 \fB-raw\fP
118 This option causes \fBpbmtoescp2\fP to generate only the data blocks.
119 It does not generate printer commands to set up the output (for example,
120 setting the line spacing).
121 .sp
122 You can use this to insert graphics into a larger printer command stream.
123 .sp
124 This option was new in Netpbm 10.72 (September 2015).
125
126
127
128 .UN hints
129 .SH HINTS
130 .PP
131 RLE compresses very well bitmaps of line drawings, preferably horizontal
132 oriented contents like texts, sheets of music, etc. However, bitmaps derived
133 from photographs are not ideal for RLE. In extreme cases, when no byte
134 repetitions occur in the input, the result will be even slightly bigger than
135 the input. To avoid this, use compression mode 0 to switch off RLE.
136 .PP
137 Each pixel in the input PBM image becomes one dot in the printed output.
138 Therefore, you must make sure the width and height of the input are
139 appropriate for the print resolution you choose and the print area you want.
140 E.g. if you print at 180 dpi and want the image to print as 8 inches by 10,
141 you must supply a PBM that is 1440 pixels wide by 1800 pixels high. You can
142 adjust the size of the input
143 with \fBpamscale\fP, \fBpamstretch\fP, \fBpbmreduce\fP, or
144 \fBpamenlarge\fP.
145
146
147 .UN seealso
148 .SH SEE ALSO
149 .BR "escp2topbm" (1)\c
150 \&,
151 .BR "pbmtoepson" (1)\c
152 \&,
153 .BR "pamscale" (1)\c
154 \&,
155 .BR "pamstretch" (1)\c
156 \&,
157 .BR "pbmreduce" (1)\c
158 \&,
159 .BR "pamenlarge" (1)\c
160 \&,
161 .BR "pbm" (1)\c
162 \&
163
164 .UN author
165 .SH AUTHOR
166 .PP
167 Copyright (C) 2003 by Ulrich Walcher (\[email protected]\fP).
168
169 .UN history
170 .SH HISTORY
171 .PP
172 \fBpbmtoescp2\fP was added to Netpbm in Release 10.18 (August 2003);
173 it was created around the same time.
174 .SH DOCUMENT SOURCE
175 This manual page was generated by the Netpbm tool 'makeman' from HTML
176 source. The master documentation is at
177 .IP
178 .B http://netpbm.sourceforge.net/doc/pbmtoescp2.html
179 .PP