summaryrefslogtreecommitdiffstats
path: root/upstream/debian-bookworm/man1/pbmtoescp2.1
blob: ac711d04956f15791bf7162d3ce5b8f055b3b72a (plain)
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
\
.\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
.\" Do not hand-hack it!  If you have bug fixes or improvements, please find
.\" the corresponding HTML page on the Netpbm website, generate a patch
.\" against that, and send it to the Netpbm maintainer.
.TH "Pbmtoescp2 User Manual" 1 "14 July 2015" "netpbm documentation"

.SH NAME

pbmtoescp2 - convert a PBM image to a ESC/P2 printer file

.UN synopsis
.SH SYNOPSIS

\fBpbmtoescp2\fP

[\fB-compress=\fP\fIcompressionmode\fP]
[\fB-resolution=\fP{\fB180\fP|\fB360\fP|\fB720\fP}]
[\fB-stripeheight=\fP\fIn\fP]
[\fB-formfeed\fP]
[\fB-raw\fP]
[\fIpbmfile\fP]
.PP
All options can be abbreviated to their shortest unique prefix.  You
may use two hyphens instead of one to designate an option.  You may
use either white space or equals signs between an option name and its
value.

.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBpbmtoescp2\fP reads a PBM image as input.  It produces an ESC/P2
raster graphic printer control stream as output.
.PP
 This program creates an output that is printable on Epson printers that
understand the ESC/P2 printer control language (e.g. the Stylus models).  For
older Epson 9-pin dot matrix printers, which use the ESC/P protocol, see
\fBpbmtoepson\fP.
.PP
The printed output has one pixel for each pixel of the input image, except
that it is padded up to the stripe size (see \fB-stripeheight\fP option)
vertically and to a multiple of 8 columns horizontally.  Before Netpbm 10.72
(September 2015), the output is instead truncated to those boundaries.
.PP
Input is read from file \fIpbmfile\fP if specified, otherwise from
stdin. Output is written to stdout.

.UN options
.SH OPTIONS
.PP
In addition to the options common to all programs based on libnetpbm
(most notably \fB-quiet\fP, see 
.UR index.html#commonoptions
 Common Options
.UE
\&), \fBpbmtoescp2\fP recognizes the following
command line options:



.TP
\fB-compress=\fP\fIcompressionmode\fP
This determines the compression mode that \fBpbmtoescp2\fP uses
in its output.  Valid values for \fIcompressionmode\fP are \fB0\fP
and \fB1\fP.  \fB-compress=0\fP results in a printer control stream
with uncompressed raster graphic data.  \fB-compress=1\fP results in
a printer control stream with RLE compressed raster graphic data
(RLE means Run Length Encoding).  The default is \fB-compress=1\fP.


.TP
\fB-resolution=\fP\fIdpi\fP
This determines the horizontal and the vertical print resolution
set in the printer control stream.  Another way of looking at it is a
declaration of what the resolution of the input image is (PBM images
don't have inherent resolution).  Valid values for \fIdpi\fP are
\fB180\fP, \fB360\fP, and \fB720\fP.  See 
.UR #hints
hints
.UE
\& for
more information on this.
.sp
The default is \fB-resolution=360\fP.
.sp
Before Netpbm 10.72 (September 2015), \fB720\fP is not valid.



.TP
\fB-stripeheight=\fP\fIn\fP
This option controls the height in lines of the stripes in the output.
.sp
The valid stripe heights in the printer language are 1, 8, and 24, but
it is capable of expressing any height up to 255 and \fBpbmtoescp2\fP
accepts any value in the range 1-255.  It issues a warning, though, if you
choose something other than 1, 8, or 24.
.sp
The default is 24.
.sp
This option was new in Netpbm 10.72 (September 2015).  Before that, the
stripe size is always 24.

.TP
\fB-formfeed\fP
This option causes \fBpbmtoescp2\fP to place a formfeed command at the
end of the output.
.sp
This option was new in Netpbm 10.72 (September 2015).


.TP
\fB-raw\fP
This option causes \fBpbmtoescp2\fP to generate only the data blocks.
It does not generate printer commands to set up the output (for example,
setting the line spacing).
.sp
You can use this to insert graphics into a larger printer command stream.
.sp
This option was new in Netpbm 10.72 (September 2015).



.UN hints
.SH HINTS
.PP
RLE compresses very well bitmaps of line drawings, preferably horizontal
oriented contents like texts, sheets of music, etc.  However, bitmaps derived
from photographs are not ideal for RLE.  In extreme cases, when no byte
repetitions occur in the input, the result will be even slightly bigger than
the input.  To avoid this, use compression mode 0 to switch off RLE.
.PP
Each pixel in the input PBM image becomes one dot in the printed output.
Therefore, you must make sure the width and height of the input are
appropriate for the print resolution you choose and the print area you want.
E.g. if you print at 180 dpi and want the image to print as 8 inches by 10,
you must supply a PBM that is 1440 pixels wide by 1800 pixels high.  You can
adjust the size of the input
with \fBpamscale\fP, \fBpamstretch\fP, \fBpbmreduce\fP, or
\fBpamenlarge\fP.


.UN seealso
.SH SEE ALSO
.BR "escp2topbm" (1)\c
\&,
.BR "pbmtoepson" (1)\c
\&,
.BR "pamscale" (1)\c
\&,
.BR "pamstretch" (1)\c
\&,
.BR "pbmreduce" (1)\c
\&,
.BR "pamenlarge" (1)\c
\&,
.BR "pbm" (1)\c
\&

.UN author
.SH AUTHOR
.PP
Copyright (C) 2003 by Ulrich Walcher (\fIu.walcher@gmx.de\fP).

.UN history
.SH HISTORY
.PP
\fBpbmtoescp2\fP was added to Netpbm in Release 10.18 (August 2003);
it was created around the same time.
.SH DOCUMENT SOURCE
This manual page was generated by the Netpbm tool 'makeman' from HTML
source.  The master documentation is at
.IP
.B http://netpbm.sourceforge.net/doc/pbmtoescp2.html
.PP