DDNAME (ddname)

None

Specifies the file name to which the input data sets are currently allocated.

The program will bypass its dynamic allocation function and ignore the contents of DSNAME. If DDNAME is specified, the allocation-disposition parameter overrides any DSKEEP or DSDELETE specifications.

DSNAME (dsname)

None

Specifies the input data set to be processed

If this parameter is specified together with the DDNAME parameter, this parameter is syntax checked but is left unused.

Note:

• PRINTOFF—Is the first positional parameter. Only the operand entry should be specified and not the keyword DSNAME.
• DSPRINT—Is the first positional parameter. Only the operand entry should be specified and not the keyword DSNAME. Only one data set is allowed.
• TSO—If the data set name is not quoted, the name specified will be appended to the data set-name prefix from the TSO profile.
• Batch—A fully qualified name must be used.
• VSAM—If the cluster component is specified, the data set will be printed in key sequence. If the data component is specified, the data set will be printed in address sequence. Only one VSAM data set is allowed.

AFFINITY (system name)

None

Specifies system affinity to the CA Spool file

Use this parameter to name the CA Spool system to process this file after it is closed.

BMARGIN (lines)

BMARGIN(0)

Specifies the decimal number of blank lines to be left at the bottom of each page

If NOCC is specified, the bottom margin is actually printed as a number of blank lines. The bottom margin parameter is used only when printing data sets or members without control characters. The bottom margin parameter is not used when printing directory listings.

CCHAR | SINGLE
| DOUBLE |
TRIPLE | ASA |
MCH | NOCC

CCHAR is the default if the record format of the input data set indicates the presence of control characters; otherwise there is no default

Specifies keywords that tell ESFPRINT how to format the lines on each page. Valid keywords are as follows:

• CCHAR—Input data set contains either ASA or MACHINE control characters. Control characters are used to format print.

The specification of ASA, MCH, or CCHAR, affects the following keyword specifications:

ESFPRINT automatically determines which types of control characters are used.

TMARGIN value is ignored

BMARGIN value is ignored

• SINGLE—Prints all non-blank lines with single-line spacing
  Blank lines are not printed.
• Do not specify if the data set contains control characters.

TRUNCATE is forced

• DOUBLE—Prints all non-blank lines with double-line spacing.

PAGELEN value is ignored

• Blank lines are not printed.
• Do not specify if the data set contains control characters.

• TRIPLE—Prints all non-blank lines with triple-line spacing
• Blank lines are not printed.
• Do not specify if the data set contains control characters.

• ASA—Forces ESPRINT to assume the data set includes ASA control characters.

• MCH—Forces ESPRINT to assume the data set includes MACHINE control characters.

• NOCC—Forces ESPRINT to assume there are no control characters.

CHARS

None

Specifies up to 4 fonts (separated by commas) to be used in the print.

If this parameter is specified, the input data set is assumed to have TRC characters unless you specified the NOTRC option as well.

CLASS (class)

Assigned in the ESF startup parameters

Output class attribute to the CA Spool or JES spool file to be created.

Specify a single alphanumeric character.

COL (col1
<:col2> <,...>)

All of each input record is printed

Minor editing of input record before printing.

Specify up to 32 ranges of columns in the input data set, which will be printed. If a range is specified as one value only, the end of each input record is used as the end of that particular range.

Column 1 in this parameter is defined as being the first character following any control characters and TRC characters if present.

If this parameter is specified the PRMODE will be set to LINE.

COPIES (copycount)

COPIES(1)

Number of copies to be printed.

Specify 1 to 3 decimal characters in the range 1 to 255.

DCF | NODCF

DCF

ESFPRINT scans the first record in the input data set to determine if the data set was created by SCRIPT. If it was, the device type and fonts are extracted from the record.

The device type is used to determine if the data set contains TRC characters. If the device type is 1403, the data set does not contain TRC characters; otherwise it does. This information is not used if TRC or NOTRC is specified.

The fonts are used as the CHARS information. This information is not used if the CHARS parameter is specified.

DEST (destination
<.writer> <dest2.wtr2 ...>...)

$$NODEST if SYSOUT is not specified

Specifies one or more destinations and possibly writer names.

Usually, you would specify one or more printer names defined to ESF and omit the writer names.

Note: DSPRINT, this is the second positional parameter. Only one destination should be specified but do not use the keyword DEST.

DSKEEP | DSDELETE
DIRECT
(KEEP | DELETE) -

DSKEEP or DIRECT
(KEEP)

Specifies the final disposition of the input data set (not the member).

These options are ignored if the DDNAME keyword is used.

(DSPRINT only)

Valid keywords are:

• DSKEEP—Specifies the input data set is to be freed and kept when it is unallocated (default). Applies to the ESFPRINT command only; if any execution errors are found, DSKEEP is forced.
• DSDELETE—Specifies the Input data set is to be deleted (and uncataloged) when it is freed. Applies to the ESFPRINT command only.
• DIRECT (KEEP)—Applies to the DSPRINT command only and is the functional equivalent of the DSKEEP keyword.
• DIRECT (DELETE)—Applies to the DSPRINT command only and is the functional equivalent of the DSDELETE keyword.

EKEEP | EDELETE

EKEEP

Specifies whether a CA Spool file with no records should be scheduled for delete processing (EDELETE) or be kept (EKEEP). If any execution errors are detected, EKEEP is forced.

EJEct | NOEJEct

These keywords initiate no actions and are provided only for compatibility reasons.

FCB (fcbname)

Installation- assigned for each printer node in the ESF startup parameters

Specifies form control buffer to be used for the print file. Specify 1 to 4 alphanumeric characters.

FDEF (formdefinition)

Specifies form definition to the print file. Use this parameter for CA Spool files only.

FOLD<(width)> | TRUNCATE <(width)>

FOLD(132)

Specifies record length of the print, and what is to be done if that length is exceeded.

If FOLD is specified, that part of the data, which is unable to fit in the width of the output record, is printed on one or more separate lines.

If TRUNCATE is specified, that part of the data, which is unable to fit in the width of the output record, is truncated. The TRUNCATE option is forced if control character spacing is used. If this parameter is specified, PRMODE will be set to LINE.

FOLD | NOFOLD (PRINTOFF only)

NOFOLD

Specifies whether the characters of the input file will be translated into uppercase or not.

The FOLD translation will not translate national characters; these will remain lowercase.

FORMS (form number)

Installation- assigned in ESF start-up parameters

Specifies the form number to be used when CA Spool or JES physically prints the spool file. Specify 1 to 8 alphanumeric characters.

HOLD | NOHOLD

NOHOLD

Specifies if the spool file should be held when closed (and not scheduled for printing). The default is NOHOLD, but HOLD is forced for CA Spool files if execution irregularities are encountered. (Output limit exceeded, and so on.)

LINES (linenum1
<:linenum2>)

All records are to be printed

Limits the records from the input data set to be processed.

The parameter has two sub-parameters: number of first line to be printed and number of last line to be printed. If the data set records contain sequence numbers (one of the options NUM or SNUM), the strings supplied with this parameter are used in an alphanumeric comparison to determine the first and last record to be processed. The strings may contain any value up to 8 characters. If the data set records don't contain sequence numbers (option NONUM in effect), the supplied sequence numbers must be numeric and represent relative record numbers in the data set.

If sequence number 2 is omitted, processing will end with the last line in the input data set. If this parameter is specified, PRMODE will be set to LINE.

LMARGIN (left margin)

0

Specifies the number of spaces to be inserted at the left in each print record preceding the data from the input record.

This parameter is used only when printing records from the input data set. It is not used when printing titles or directory listings.

If the input data set contains control characters or TRC characters, the spaces are inserted after those.

If this parameter is specified, PRMODE will be set to LINE.

MEMBERS | DIRECTORY | ALL or

PRINT | NOPRINT (DSPRINT only)

LIST | NOLIST (DSPRINT only)

ALL

Specifies how ESFPRINT should handle partitioned input data sets.

Use this parameter only to specify if the input is one or more partitioned data sets.

MEMBERS or "PRINT NOLIST" means that all of the members in the data set are to be printed.

DIRECTORY or "NOPRINT LIST" means that a directory listing is to be printed for each input data set.

ALL or "PRINT LIST" means that each member and a directory listing is to be printed for each of the input data sets.

NAME (programmer's name)

Input data set name

Specifies the programmer's name attribute of the spool file. Prints on the separator page to identify the file. Any characters may be used; the number of characters that may be entered is installation-specific.

NUM
<(location
<,length>)> | SNUM
<(lopc
<,len>)> | NONUM

NONUM

Specifies whether the input data set contains sequence numbers, and what to do with them if they exist. It is also possible to specify the location and length of the sequence numbers in the input record.

Length is 1 decimal digit with a maximum value of 8, which is also the default value if NUM or SNUM is specified without the length operand.

If the location value is not given, the default depends on the record format:

RECFM=V and RECFM=U:

Beginning of the record.

RECFM=F:

End of the record.

NUM tells ESFPRINT to print the sequence numbers from each input record leftmost in each print line, following the left margin.

If the width specified with FOLD or TRUNCATE is not large enough to contain the sequence number field, one blank, and at least one data byte, NONUM will be forced.

SNUM tells ESFPRINT to remove the sequence number from the input records before printing them.

NONUM tells ESFPRINT to ignore all sequence number processing. If, in fact, the records contain sequence numbers, they are treated as data.

If this parameter is specified, PRMODE will be set to LINE.

OUTLIMIT (linecount)

Installation defined default for the receiving CA Spool system, if it is active. Otherwise, 16777215

Specifies the maximum number of lines to be printed.

When estimating this value, remember to include any top- and bottom-margin-area lines.

Enter an integer in the range 1-16777215.

OWNER (file name)

Jobname when executing batch. Otherwise, TSO user ID

Specifies the CA Spool file being created. When this parameter is specified together with the SYSOUT parameter, it is syntax is checked but is left unused. Specify 1 to 8 alphanumeric characters.

PAGELEN (linecount)

Taken from the FCB defined for each printer in the ESF start-up parameters

Specifies the number of lines to be printed on each page if the input data set does not contain control characters.

The value is not used if CCHAR is in effect.

If this parameter is specified, PRMODE will be set to LINE.

PDEF (pagedefinition)

Specifies page definition to the print file.

This parameter should be specified only for CA Spool files.

PRMODE
(LINE | PAGE | INPUT)

Specifies print mode to the print file. Use this parameter for CA Spool files only.

If LINE is specified, line mode is forced for this file; if PAGE is specified, page mode is forced for the file.

If INPUT is specified, CA Spool will determine the print mode from a combination of the keywords specified for this command and the record length of the input file. Put simply, an input file with a record length exceeding 253 bytes, where printing is not limited by any other keywords, will be assigned a print mode of PAGE.

RETAIN (retain time)

Value from printer definition

Specifies the number of hours the file should be retained after being printed. If a value of 0 is specified, the file will be purged immediately after it is printed.

SUBSYS (system name)

ESF

Specifies the CA Spool subsystem to process this request.

If this parameter is omitted any CA Spool subsystem is eligible to process the request.

If no CA Spool subsystems are active, the SYSOUT parameter must be specified.

SYSIN

None

Specifies that parameters are to be taken from a pre-allocated data set with a ddname of SYSIN.

This data set must contain 80-byte fixed blocked or unblocked records with parameters in the format described.

Any cards with all spaces in columns 1 through 71, and comment cards with an asterisk in column 1, are ignored. Any number of keywords may be specified on a record.

One keyword including all operands must be contained in one card.

This parameter is valid only for the TSO call format and batch processing.

SYSOUT

None

Specifies that printed output is to go to JES. If you want output spooled to JES, and transferred to CA Spool afterwards, use SYSOUT and DEST. For example, DEST(esfname.printer).

TITLE | NOTITLE or HDR | NOH (DSPRINT only)

TITLE

Specifies headings at the top of each page in the output.

The title contains information such as data set name, member name, date, and time. The parameter applies only to the pages of printed data sets and members. Pages with directory listings are always printed with titles. Titles are not moved as a result of a left margin specification. Titles are not printed if the input data set contains control characters. If this parameter is specified, PRMODE will be set to LINE.

TMARGIN (lines)

TMARGIN(0)

Specifies the decimal number of blank lines to be printed at the top of each page.

If this parameter is omitted, no top margin is printed. This operand is ignored if the embedded control characters in the data records are set to control the spacing. If this parameter is specified, PRMODE will be set to LINE.

TRC | NOTRC

Typically, NOTRC. If CHARS is specified, or input data set is SCRIPT - formatted and contains TRC, default is TRC

Specifies whether the input data set contains TRC characters.

UCS (ucs)

None

Specifies universal character sets. It is recommended to use the CHARS parameter instead. If this parameter is specified the PRMODE will be set to LINE.

WRITER (writer name)

None

Specifies writer to print this data set. It is recommended to use the DEST parameter instead.

VOLUME (volume serial)

None

Specifies the keyword, which must be used if the data set to be printed is not cataloged. Specify a 1-6 alphanumeric volume serial number to name the device where the data set resides.