LPR command—Print to a remote printer

Purpose

Use the LPR command to print to a remote printer.

Notes:

Do not use the forward slash character (/) in any parameter value for this command.
The TSO LPR command uses the Pascal socket API, so VMCF must be started for the command to be successful. If VMCF is not started, an ABEND0D6 can occur.
The TSO LPR command is written in the PASCAL language, so the size of the data set to be printed is limited to 2,147,483,647 (X'7FFFFFFF') bytes.

Format


>>-LPR--data_set_name--+--------------------------------+------><
                       |    .-------------------------. |   
                       |    V                         | |   
                       '-(----| Optional parameters |-+-'   

Optional parameters

|--+-AT --host-------------+------------------------------------|
   +-BIG5------------------+   
   | .-NOBInary-.          |   
   +-+-BINary---+----------+   
   | .-BUrst---.           |   
   +-+-NOBUrst-+-----------+   
   +-CC--------------------+   
   +-NOCc------------------+   
   +-CFfirst---------------+   
   +-CLass --class---------+   
   | .-1---------------.   |   
   +-+-----------------+---+   
   | '-COpies --copies-'   |   
   +-EOFlf ----------------+   
   +-NOEOFlf --------------+   
   +-Euckanji--------------+   
   +-Filter --| filter |---+   
   +-HAngeul---------------+   
   +-HEader----------------+   
   +-NOHeader--------------+   
   +-IBmkanji--------------+   
   +-Indent --number-------+   
   +-JIS78kj--+----------+-+   
   |          +-ASCII----+ |   
   |          '-JISROMAN-' |   
   +-JIS83kj--+----------+-+   
   |          +-ASCII----+ |   
   |          '-JISROMAN-' |   
   +-JNum --number---------+   
   +-Job --| jobname |-----+   
   +-Ksc5601---------------+   
   +-LAndscape-------------+   
   +-LANDNOcz--------------+   
   +-LATEconn--------------+   
   +-LNcz------------------+   
   | .-55----------------. |   
   +-+-------------------+-+   
   | '-LInecount --count-' |   
   +-NOLincount------------+   
   +-Mail------------------+   
   +-NAme --name-----------+   
   +-POstscript------------+   
   +-NOPostscript----------+   
   '-Printer --name--------'   

More optional parameters

|--+-Host --host-----------+------------------------------------|
   +-SChinese--------------+   
   +-SJiskanji-------------+   
   +-SLowshutdown----------+   
   +-SOsi------------------+   
   +-SOsi ASCII------------+   
   +-SOsi EBCDIC-----------+   
   +-SOsi NONE-------------+   
   +-SOsi SPACE------------+   
   +-TChinese--------------+   
   +-TIMEout---------------+   
   +-Title --title---------+   
   +-TOpmargin --number----+   
   +-NOTOpmargin-----------+   
   +-TRACe-----------------+   
   +-TRANslatetable --name-+   
   +-TYpe--USCFxlate-------+   
   +-User --name-----------+   
   +-Version---------------+   
   +-Width --width---------+   
   +-Xlatetable --name-----+   
   '- -o --option----------'


filter

|--+-f-+--------------------------------------------------------|
   +-l-+   
   +-p-+   
   '-r-'   

jobname

|--+-DEST-------+-----------------------------------------------|
   +-FOR--------+   
   +-FORM-------+   
   +-IDENTIFIER-+   
   +-LINECOUNT--+   
   +-OTHERS-----+   
   +-PASS-------+   
   '-PRIORITY---'

Parameters

data_set_name

Specifies the name of the data set to be printed. This cannot be the name of a z/OS® UNIX file.

AT host

Specifies the name or IPv4 IP address of the printer host machine. If host is a name, it must resolve to an IPv4 address. Host is a synonym for this option.

BIG5

Converts data from Traditional Chinese host DBCS to Big-5 DBCS when transferring data to a remote system. LPR loads the BIG5 DBCS translation table from TCPCHBIN binary table data set.

NOBInary

Causes LPR to convert the data from EBCDIC to ASCII when it is sent to the remote system. This is the default.

BINary

Causes LPR to send the data without translation and without any indication of record boundaries. Use this option if the data set is already in ASCII.

Note: The MVS™ LPD server always converts data sets in ASCII to EBCDIC, and there is no option to disable this conversion.

BUrst

Causes a burst (banner) page to be printed on the remote printer. This is the default.

NOBUrst

Prevents a burst (banner) page from being printed on the remote printer.

CC

Causes the remote system to interpret the first character of each line as carriage control.

Records containing control characters that are not valid are deleted. If all records in the file are deleted, LPR processes the empty file.

CC is the default if the record format is FA, FBA, FBM, FM, VA, VBA, VBM, or VM. The characters used to specify these record formats have the following meanings:

F	Fixed record length
V	Variable record length
B	Blocked records
A	Records containing ISO/ANSI control characters
M	Records containing machine code control characters

NOCc

Prevents the remote system from interpreting the first character of each line as an ASA carriage control.

CFfirst

Specifies that LPR will send the ControlFile describing the data before it sends the DataFile that contains the data. This option enables some LPD servers to print larger jobs since the data can be printed as it is received.

Specify this option when small jobs print, but large jobs do not.

Note: Even when this option is specified, the print job might still be too complex to print.

CLass class

Specifies the class name to the remote system. The class name is printed on the banner pages. The default is the sending host name.

To override the SYSOUT CLASS of a job, the CLASS value must be only a single alphanumeric character . For example, CLASS c.

COpies copies

Specifies the number of copies to be printed. The default is one copy.

EOFlf

Causes an ASCII line feed after the last line of data of a file formatted by ANSI carriage control. Since ANSI carriage control positions the paper before the line is printed, you cannot specify how the paper should be positioned after the last line prints. The normal network standard is to terminate every file with a line feed. Some LPDs do not print the last line if the line feed is not added. For example, in ANSI carriage control, a 'F1'X means eject to a new page before printing the lines. ANSI or ASA CC is used in files with RECFM=FBA.

EOFlf is the default for ANSI CC files. Specify NOEOFlf if your paper is positioned incorrectly and an extra line is printed because LPR adds a line feed.

This parameter does not impact files that are not ANSI CC. For example, BINary, POstscript, LAndscape and Machine CC files are not affected by EOFlf.

NOEOFlf

Inhibits adding the ASCII line feed after the last line of a file that is formatted by ANSI carriage control. Since ANSI carriage control positions the paper before the line is printed, how the paper should be positioned after the last line cannot be specified by the carriage control characters. The normal network standard is to terminate every file with a line feed. Specifying this parameter causes the last byte of data to be the last byte sent; a line feed is not added.

For example, an ANSI carriage control 'F1'X means eject to a new page before printing the line. ANSI or ASA CC is used, for example, in files with RECFM=FBA.

Specify NOEOFlf if your paper is positioned wrong because an extra line is being printed at the end of the file. Some applications specify the positioning and do not have the extra line feed sent by LPR.

For example, BINary, POstscript, and Machine CC files are not affected by this parameter. This option does not apply when you specify LAndscape.

Euckanji

Causes the data to be converted from EBCDIC DBCS to Extended UNIX Code kanji ASCII DBCS when it is sent to the remote system. LPR loads the EUCKANJI DBCS translation table from the TCPKJBIN binary translate table data set.

Filter filter

Specifies the type of processing to be done on the data by the remote system. The filter is written as a single letter. Both uppercase and lowercase letters are accepted, but uppercase letters are converted to lowercase.

Note: The filter values must also be defined in the SERVICE statement of the configuration data set for the MVS LPD server. See the z/OS Communications Server: IP Configuration Reference for more information on the LPD server configuration data set.

In addition to the following list of filter codes, there are filters supported by other servers described in RFC 1179. [For a list of Requests for Comments (RFCs), see Related protocol specifications.]

Filter code	Description
f	Print as a sequence of lines
l	Print, passing through all control characters
p	Print with pagination
r	Print, interpreting the first column as FORTRAN carriage control characters. The supported IBM® FORTRAN carriage control characters are `1`, `0`, `+`, and `-`. When using the MVS LPD server to print files with filter code r, the PAGESIZE parameter on the SERVICE statement for the printer you are printing to also affects pagination. See Usage for further information.

HAngeul

Causes the data to be converted from EBCDIC DBCS to Hangeul ASCII DBCS when it is sent to the remote system. LPR loads the HANGEUL DBCS translation table from the TCPHGBIN binary translate table data set.

HEader

Causes a page header to be inserted by the client at the top of every printed page if the NOCc and NOBInary options are in effect. To cause the server to insert page headers, use p as the value of filter and specify the NOHeader option.

NOHeader

Prevents the client from inserting page headers.

IBmkanji

Causes the data to be sent without translation as IBM (EBCDIC) kanji. This parameter performs the same function as the BINary parameter.

Indent number

Specifies the number of columns the remote system indents the output when f or p is specified as the value of filter.

JIS78kj ASCII

Causes the data to be converted from EBCDIC DBCS to JIS 1978 kanji ASCII DBCS, using the ASCII shift-in escape sequence ESC ( B, when it is sent to the remote system. LPR loads the JIS78KJ DBCS translation table from the TCPKJBIN binary translate table data set.

JIS78kj JISROMAN

Causes the data to be converted from EBCDIC DBCS to JIS 1978 kanji ASCII DBCS, using the JISROMAN shift-in escape sequence ESC ( J, when it is sent to the remote system. LPR loads the JIS78KJ DBCS translation table from the TCPKJBIN binary translate table data set.

JIS83kj ASCII

Causes the data to be converted from EBCDIC DBCS to JIS 1983 kanji ASCII DBCS, using the ASCII shift-in escape sequence ESC ( B, when it is sent to the remote system. LPR loads the JIS83KJ DBCS translation table from the TCPKJBIN binary translate table data set.

JIS83kj JISROMAN

Causes the data to be converted from EBCDIC DBCS to JIS 1983 kanji ASCII DBCS, using the JISROMAN shift-in escape sequence ESC ( J, when it is sent to the remote system. LPR loads the JIS83KJ DBCS translation table from the TCPKJBIN binary translate table data set.

JNum number

Specifies a specific job number for the print request, where number is a unique, 3-digit number in the range 000 - 999. This job number is used by LPR to name the temporary data and control files, such as:

dFA123hostname   cFA123hostname

The JNum parameter is not valid from NPF; do not specify JNum in the NPF OPTIONS file.

If JNum is not specified for LPR, the three-digit number is randomly generated by LPR.

Job jobname

Specifies the job name to the remote system. The default name is the full data set name. The job name is printed on the banner pages.

The following parameters are available with the Job parameter and are entered as PARAMETER=value. When you use these parameters, you must separate them from Job or jobname by a blank and from other options by a comma and no blank. For example,

Job PASS=password,FOR=userid

DEST: Sets the destination node. The default is the node on which the LPR client is running.
FOR: Specifies a user ID other than the sending user ID for which the output is to be spooled. The default is the sender’s ID.
FORM: Identifies the form on which the data is printed. This is the equivalent of the form-name subparameter in the MVS SYSOUT parameter on the DD card. Therefore, the form name specified can be 1 through 4 alphanumeric or national ($, #, @) characters.
IDENTIFIER: Sets the destination ID. The default is SYSTEM.
LINECOUNT: Specifies a numeric field indicating the number of lines on a page. This option overrides the PAGESIZE parameter of LPD.
OTHERS: Causes all subsequent options to be ignored. This option is ignored by the MVS LPD server.
PASS: Specifies the password. The default is no password, which causes the job to fail if the RACF® option is specified for the service.
PRIORITY: Specifies the transmission priority. The default is 50.

Ksc5601

Causes the data to be converted from EBCDIC DBCS to Korean Standard Code KSC-5601 ASCII DBCS when it is sent to the remote system. LPR loads the KSC5601 DBCS translation table from the TCPHGBIN binary translate table data set.

LAndscape

Converts a non-PostScript data set to a PostScript data set for printing with print lines parallel to the long edge of the paper. If the remote printer can process PostScript output, the data set is printed in landscape format (rotated 90 degrees). Some nonprinting EBCDIC characters below X'3F' are changed to blanks.

Note: An ASCII cntl-Z X'1A' is sent after the data. If this dos-EOF character causes problems, use the LANDNOcz option instead.

LANDNOcz/LNcz

Note: Normally, you should use the LAndscape option, unless the dos-EOF character (X'1A') sent after the file causes problems. LN and LNcz are abbreviations for LANDNOcz.

LATEconn

Causes LPR to process the input data file before making any TCPIP connection with the printer. When this option is not specified, the TCPIP connection is made before the data file processing begins. This option can be specified when the initial processing of very large files causes the connection with a printer to be dropped because of a timeout.

LInecount count

Determines the number of lines to be printed before a new heading is printed. This option is meaningful only for a data set that does not have the CC option specified either explicitly or by default.

The valid range for LInecount is 0 to the Pascal integer MAX number 2 147 483 647. The default value is 55. To suppress printing a header before each new page, specify LInecount 0. Specifying LInecount 0 has the same effect as specifying the NOLinecount option.

NOLinecount

Prevents a header being printed before each new page. Specifying NOLinecount has the same effect as specifying LInecount 0.

Mail

Causes mail to be sent to the user when the printing operation ends (for those servers that support this).

NAme name

Specifies the job information to be provided by the remote system in response to a query. Only the name or files portion of the query is displayed. This option is not honored by all remote printing servers.

POstscript

Inserts the header required by some systems to recognize a PostScript data set.

NOPostscript

Prevents a PostScript data set from being recognized as a PostScript data set.

Printer name

Specifies the name of the printer on which you want the data set printed. The printer name is case sensitive.

Host host

Specifies the name or IPv4 IP address of the printer host machine. If host is a name, it must resolve to an IPv4 address. AT is a synonym for this option.

SChinese

Converts data from Simplified Chinese host DBCS to Simplified Chinese PC DBCS when transferring data to a remote system. LPR loads the SCHINESE DBCS translation table from TCPSCBIN binary table data set.

SJiskanji

Causes the data to be converted from EBCDIC DBCS to Shift JIS kanji ASCII DBCS when it is sent to the remote system. LPR loads the SJISKANJI DBCS translation table from the TCPKJBIN binary translate table data set.

SLowshutdown

Causes slower TCP/IP connection termination after the job is sent to the printer. This option is rarely needed. This option is provided for print servers which discard the print job just successfully received when LPR uses the fast shutdown. Before using this option, check the print server for errors (such as spool file full) that might be causing the job to be discarded instead of printed.

SOsi

Determines how any EBCDIC DBCS shift-out ('0E'X) and shift-in ('0F'X) characters in the input file are handled. The ASCII, EBCDIC, or SPACE parameters specifies what is used as shift characters in the ASCII output from LPR. If SOsi is specified without a following parameter, ASCII is used as the default.

If you do not specify SOsi, shift-out/shift-in characters are not used in the ASCII data stream. Therefore, the EBCDIC DBCS shift characters are just removed during the translation to ASCII. This is the same as specifying SOsi NONE.

SOsi has no effect on DBCS translations JIS78KJ, JIS83KJ, and IBMKANJI. It is used with other DBCS translation such as BIG5, EUCKANJI, HANGEUL, KSC5601, SCHINESE, SJISKANJI, and TCHINESE.

SOsi ASCII

Specifies that DBCS data strings in the ASCII output are delimited by special shift-out/shift-in characters. As the data is translated from EBCDIC to ASCII, input EBCDIC shift-out ('0E'X) becomes ('1E'X), and '0F'X becomes '1F'X.

SOsi EBCDIC

Specifies that DBCS data strings in the ASCII output are delimited by EBCDIC shift-out/shift-in characters. As the data is translated from EBCDIC to ASCII, input EBCDIC shift-out ('0E'X) remains EBCDIC shift-out ('0E'X), and '0F'X remains '0F'X.

SOsi NONE

Specifies that DBCS data strings in the ASCII output are not delimited by any shift-out/shift-in characters. As the data is translated from EBCDIC to ASCII, any EBCDIC DBCS shift characters are removed.

SOsi SPACE

Specifies that DBCS data strings in the ASCII output are delimited by ASCII space ('20'X) characters. As the data is translated from EBCDIC to ASCII, input EBCDIC shift-out ('0E'X) becomes ASCII space ('20'X) and EBCDIC shift-in ('0F'X) also becomes '20'X.

TChinese

Causes the data to be converted from EBCDIC DBCS to Traditional Chinese (5550) ASCII DBCS when it is sent to the remote system. LPR loads the TCHINESE DBCS translation table from the TCPCHBIN binary translate table data set.

TIMEout

Specifies that LPR wait 5 minutes for an ACK or NACK from the LPD printer. If ACK or NACK does not arrive, LPR terminates the connection with Error Number=73. Since LPR waits for ACK in several places, this error can occur in different LPR messages, such as EZB1048E.

For some printers, the ACK is not returned until the job has printed. For these printers, specifying the TIMEout option can cause long jobs to stop printing.

When the TIMEout option is not specified, LPR waits as long as the TCP/IP connection exists. For some printers, this could tie up the PORT (and any NPF thread using LPR on that PORT) until an operator intervenes to fix the printer. For NPF users, TIMEout should be added as an LPR option for these printers. See the z/OS Communications Server: IP Network Print Facility for information about configuring LPR options in NPF.

Title title

Specifies the title assigned to a data set printed with the FILTER p option.

TOpmargin number

Specifies the number of lines designated for the top margin.

NOTOpmargin

Indicates that blank lines are not inserted at the top of each page.

TRACe

Turns on the trace details for interaction with the remote printer. TRace always overrides TYpe because TYpe is a subset of TRace.

TRANslatetable name

Specifies the SBCS translate table to be used by the client. The name parameter is preceded by either the userid or the hlq and followed by TCPXLBIN to form the data set name of the translate table (userid.name.TCPXLBIN or hlq.name.TCPXLBIN). If both data sets exist, a search order hierarchy determines which one is to be used.

See the z/OS Communications Server: IP Configuration Reference for more information about search order hierarchy, loading, and customizing SBCS translation tables. XLatetable is a synonym for this option.

TYpe

Displays the progress of the command as the data set is being processed.

USCFxlate

Specifies that a single byte translation table such as JPNKANA be used for the print data. The control file generated by LPR and sent to LPD contains upper- and lowercase alphanumeric characters. Specify this option if any of them are being translated incorrectly, causing the LPD to reject the print jobs.

User name

Specifies a name that overrides the user identification of the program that is requesting the print job, prints on the banner page, and becomes the user identification of the mail option. The name field cannot be longer than eight characters. If you do not enter the user name parameter, it defaults to the system user identification or to the job name.

Version

Displays the version of the program.

Width width

Specifies the line width of a data set printed with the FILTER options f, l, p, or r.

Xlatetable name

See the z/OS Communications Server: IP Configuration Reference for more information about search order hierarchy, loading, and customizing of SBCS translation tables. TRANslatetable is a synonym for this option.

-o option

Specifies an option that the control file in PSF for AIX® (PSF/6000) or InfoPrint uses to format the print job. Any -o option honored by PSF/6000 can be passed to the control file using this parameter of the LPR command. This parameter must be issued without a blank between the -o and the option.

Below are some sample options. None of these options are standard LDP options. They are not honored by most LPD print servers.

-ochars=GT15: Sets the value of the CHARS parameter to GT15.
-obin=2: Sets the input bin to 2 (use alternate input bin).
-opagedef=P13700: Sets the value of PAGEDEF parameter to P13700.
-oformdef=F1SEPA: Sets the value of the FORMDEF parameter to F1SEPA.
-ocopies=002: Sets the JCL COPIES count to 2. This parameter is not honored by most LPD servers. Other LPD servers ignore all control file information and print one copy. For these printers, issue the LPR command multiple times to get multiple copies.

IBM Print Services for AIX (S544-3878-03) contains detailed descriptions of the -o options for PSF/6000.

Examples

Print the data set TEST.LISTING on a printer named lp0 on the system mvs1:
```
LPR TEST.LISTING (PRINTER lp0 HOST mvs1
```
If TEST.LISTING has a record format that contains carriage control such as VBA, the first character of each line is interpreted as carriage control. To prevent the first character of each line from being interpreted as carriage control, use the following command:
```
LPR TEST.LISTING (PRINTER lp0 HOST mvs1 NOCC
```
If this LPRSET command was issued:
```
LPRSET lp0@mvs1
```
the following LPR command would also print the data set on printer LP0 on the host MVS1 and prevent the first character of each line from being interpreted as carriage control:
```
LPR TEST.LISTING (NOCC
```

Print the data set TEST.LISTING in landscape mode:

LPR TEST.LISTING (LANDSCAPE

The following example shows the PostScript attributes used in the LAndscape option:

    614 25 translate 90 rotate .88 .76 scale
    /n 1 def
    /fs 10 def
    /ls 11.2 def
    /ld ls 2 mul def
    /lt ls 3 mul def
    /t 740 fs sub def
    /y t def /ff t def /os 20 def
    /s 512 string def
    /Courier-Bold findfont
    fs scalefont setfont
    /p {n {copypage} repeat erasepage} def
    /i (%stdin) (r) file def
    /{/c i read not {p stop} if def
    c 26 eq {p stop} if
    /x 20 def
    /y c 43 eq {y /x os def}
    {c 32 eq {y ls sub}
    {c 48 eq {y ld sub}
    {c 45 eq {y lt sub}
    {c 49 eq {ff} {y} ifelse}
    ifelse} ifelse} ifelse} ifelse def
    /ff 0 def
    y 65 le {p /y t def} if x y moveto
    /os i s readline not {p stop} if dup show
    length 0 eq {20} {20.72} ifelse def } loop

To understand these attributes you might need to reference a PostScript manual.

If a data set TEST has a low-level qualifier of LISTPS (PostScript), use the following command to send TEST to a PostScript-capable printer without specifying the PostScript option:
```
LPR TEST.LISTPS (PRINTER lp0 HOST mvs1
```
Print a FORTRAN source program with 57 lines on each page:
```
LPR TEST.FORTRAN (LINECOUNT 57
```

Usage

The input string for parameters is limited to 255 bytes. To use the input string effectively, remove any extra embedded blanks and use shorter parameter labels. For example, use P instead of the full word Printer as a parameter.
When sending a print job to a printer that has RACF in its definition in the LPD.CONFIG data set, you must specify the password. If it is for a different user ID, you must specify that password and user ID as follows:
```
Job PASS=password,FOR=userid
```
If the printer or host name are not specified in the LPR command, the last LASTING.GLOBALV variables for PRINTER and PRTHOST in the user_id.LASTING.GLOBALV data set are used as the defaults. You can specify these variables with the LPRSET command.
LPR normally issues messages only if there is an error. If you want to track the progress of the command, use the TYpe or TRACe parameter.
You can use the LPR command to send PostScript data sets to a printer that can print documents in that language. LPR checks that no incompatible options were given, if it is a PostScript data set. You can override this check, if you want to print a PostScript program with the NOPostscript option. UNIX systems examine the first few characters of a data set (looking for %!) to determine if a data set is a PostScript data set. If you have PostScript data sets that do not contain the characters %!, use the POstscript parameter to add them.
Carriage control is interpreted line by line. A data set can mix ASA and machine carriage control. Interpretation is done by converting the controls to the appropriate ASCII sequences, before the data set is sent to the remote system. Lines that have incorrect carriage control are not printed.
When a data set is printed without carriage control, LPR adds a heading line that shows the name of the data set, the title of the system on which the LPR command is running, and a page number. You can specify the number of lines to be printed (excluding the 3 heading lines) with the LInecount parameter.

When you specify a filter code, LPR ignores CC, HEader, NOCc, NOHeader, and TOpmargin. When a filter code of f, l, p, or r is specified, LPR stops paginating the data set it is printing. Instead, it sends the data in the data set as plain lines. The following list provides a description of these filter codes:

Filter code	Description
f	Print as a sequence of lines.
l	Print, passing through all control characters.
p	Print with pagination.
r	Print, interpreting the first column as FORTRAN carriage control characters. The supported IBM FORTRAN carriage control characters are `1`, `0`, `+`, and `-`.

When using the MVS LPD server to print files with filter code r, the PAGESIZE parameter on the SERVICE statement for that printer is ignored in the LPD CONFIG file. The PAGESIZE parameter defaults to 60 if it is not specified. To prevent unwanted page ejects, change the value specified on the PAGESIZE parameter to a number greater than the actual number of lines on the pages being printed. For example, you can specify 100 000 for the PAGESIZE parameter.

When you specify a filter code of c, d, g, n, t, or v, LPR transmits the data as a byte stream (as though you specified the BINary option).