path: root/upstream/debian-unstable/man1/pnmtopclxl.1

\
.\" 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 "Pnmtopclxl User Manual" 1 "22 March 2011" "netpbm documentation"

.SH NAME
pnmtopclxl - convert a PNM image to an HP LaserJet PCL XL printer stream

.UN synopsis
.SH SYNOPSIS

\fBpnmtopclxl\fP

{
[\fB-dpi=\fP\fIN\fP]
[\fB-xoffs=\fP\fIN\fP]
[\fB-yoffs=\fP\fIN\fP]
[\fB-center\fP]
[\fB-duplex=\fP{\fBvertical\fP|\fBhorizontal\fP}]
[\fB-format=\fP\fIpaperformat\fP]
[\fB-feeder=\fP\fIN\fP]
[\fB-copies=\fP\fIN\fP]
[\fB-rendergray\fP]
[\fB-jobsetup=\fP\fIfilename\fP]

|
\fB-embedded\fP

}
[\fB-colorok\fP]
\fIpnmfile1\fP \fIpnmfile2\fP ...
.PP
Minimum unique abbreviation of option is acceptable.  You may use double
hyphens instead of single hyphen to denote options.  You may use white
space in place of the equals sign to separate an option name from its value.


.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBpnmtopclxl\fP reads one or more PNM input streams, each containing one
or more PNM images, and generates a sequence of output pages in the
HP PCL-XL (formerly named PCL 6) printer control language.  You can send
this stream to a PCL-XL printer to print the images.
.PP
Alternatively, you can make \fBpnmtopclxl\fP generate just the PCL-XL
instructions to print an image, which you can embed in your own PCL-XL
stream to place an image on one of your pages.  (\fB-embedded\fP option).
.PP
If the input is PPM, the output is a color printer stream (the PCL
color space is RGB).  Otherwise, the output is grayscale (the PCL color space
is grayscale).  If you want a grayscale output from a color input, run your
input through
.BR "ppmtopgm" (1)\c
\&.  See the 
\fB-colorok\fP option for more information about choosing between color
and grayscale.
.PP
The output goes to Standard Output.  All of the pages go to one
file, concatenated in the same order as the input images.


.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
\&), \fBpnmtopclxl\fP recognizes the following
command line options:



.TP
\fB-dpi=\fP\fIN\fP
This option selects the resolution of the image (not the printer!).
\fIN\fP is the resolution in dots per inch, from 1 to 65535.  The default
is 300.

.TP
\fB-xoffs=\fP\fIN\fP
This option and \fB-yoffs\fP determine the location on the page of the
upper left corner of each image.  Note that the image may have built in
borders too, which would make the main image within more left and down 
that what you specify here.
.sp
\fB-xoffs\fP and \fB-yoffs\fP specify the distance from the left of the
page and from the top of the page, respectively, in inches, of the upper left
corner of the image.  The default for each is zero.
.sp
These options are meaningless if you specify \fB-center\fP.

.TP
\fB-yoffs\fP \fIN\fP
See \fB-xoffs\fP.

.TP
\fB-center\fP
This option tells \fBpnmtopclxl\fP to center each image on the page.
If you don't specify this option, the position of an image on the page is
determined by \fB-xoffs\fP and \fB-yoffs\fP (or their defaults).

.TP
\fB-duplex=\fP{\fBvertical\fP|\fBhorizontal\fP} 
This option
causes \fBpnmtopclxl\fP to create a printer stream that prints pages
on both sides of the sheet of paper.  \fBvertical\fP means to print
them so that the left edge of both pages is on the same edge of the
sheet, while \fBhorizontal\fP means the more usual duplexing where the
top of both pages is on the same edge of the sheet.

.TP
\fB-format=\fP\fIpaperformat\fP
This option selects the media (e.g. paper size) that the printer
control stream specifies.  \fIpaperformat\fP is one of the following
self-explanatory keywords:


.IP \(bu
letter
.IP \(bu
legal
.IP \(bu
a3
.IP \(bu
a4
.IP \(bu
a5
.IP \(bu
a6
.IP \(bu
jb4
.IP \(bu
jb5
.IP \(bu
jb6
.IP \(bu
exec
.IP \(bu
ledger
.IP \(bu
b5envelope
.IP \(bu
c5envelope
.IP \(bu
com10envelope
.IP \(bu
monarchenvelope
.IP \(bu
dlenvelope
.IP \(bu
jpostcard
.IP \(bu
jdoublepostcard

.sp
The default is \fBletter\fP.

.TP
\fB-feeder=\fP\fIN\fP
This options selects the media source (e.g. paper tray) that the
printer control stream specifies.

.TP
\fB-copies=\fP\fIN\fP
This option specifies the number of copies that the printer control
stream tells the printer to print.

.TP
\fB-rendergray\fP
This option causes \fBpnmtopclxl\fP to include in the output
stream a command to set the RENDERMODE environment variable to
GRAYSCALE, which typically causes the printer to print in grayscale
regardless of the colors in the input, and may cause it to run much
faster even if the image is grayscale anyway.
.sp
This option was new in Netpbm 10.29 (August 2005).

.TP
\fB-jobsetup=\fP\fIfilename\fP
This option causes \fBpnmtopclxl\fP to include arbitrary job setup
PJL commands at the beginning of the output stream.  It reads them from
the named file.
.sp
\fBpnmtopclxl\fP does not inspect these commands in any way, but it
does expect them to be job setup commands.  If you have garbage in your
file, you will hear from the printer.
.sp
This option was new in Netpbm 10.29 (August 2005).

.TP
\fB-colorok\fP
This option simply tells \fBpnmtopclxl\fP not to warn you if you supply
a color input and therefore get color output.  By default, \fBpnmtopclxl\fP
issues a warning any time it produces a color printer stream because it is
usually a mistake.  It's a mistake because PCL XL is mainly used for laser
printers, and laser printers are mainly black and white.  If you send a color
print stream to a black and white printer, it typically refuses to print
anything, and even if it manages to convert it to black and white and print
it, it takes 3 times as long to transmit a color stream to the printer than
to transmit the grayscale image that gives the same result.

.TP
\fB-embedded\fP
Without this option, \fBpnmtopclxl\fP generates an entire printer control
stream that sets up the printer, ejects pages, and places a lone image on
each page.  With the option, \fBpnmtopclxl\fP generates only the instructions
to generate the image itself.  This is not useful all by itself, but you
can embed it in a suitable PCL-XL stream in order to add an image to it.
.sp
This makes sense only for a single image, so you cannot specify multiple
input files and if an input file has multiple images in it, \fBpnmtopclxl\fP
ignores any after the first (it won't even read them).
.sp
All the options that control the printer control stream outside the image
itself, such as \fB-xoffs\fP and \fB-feeder\fP are invalid
with \fB-embedded\fP.
.sp
This option was new in Netpbm 10.54 (March 2011).




.UN seealso
.SH SEE ALSO
.BR "\fBppmtolj\fP" (1)\c
\&,
.BR "\fBpbmtolj\fP" (1)\c
\&,
.BR "\fBppmtopj\fP" (1)\c
\&,
.BR "\fBppmtopjxl\fP" (1)\c
\&,
.BR "\fBthinkjettopbm\fP" (1)\c
\&,
.BR "\fBppm\fP" (1)\c
\&

.UN history
.SH HISTORY
.PP
\fBpnmtopclxl\fP was added to Netpbm in Release 10.6 (July 2002).
It was contributed by
\fIJochen Karrer\fP.
.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/pnmtopclxl.html
.PP