This appendix provides a description of all attributes supported by the print system. The appendix includes:
Lists of attributes grouped by object class. Within each object class, settable attributes are indicated with an asterisk (*).
A detailed attribute directory, organized alphabetically. Each attribute entry includes the following components:
Brief description of the attribute
Objects with which the attribute is associated
Whether the attribute can contain one value (single value) or multiple values (multi-value)
Whether the attribute is settable
Valid values for the attribute
A.1 Attributes Grouped by Object Class
The following sections list attributes for each class of object.
All
settable attributes are indicated with an asterisk (*).
Spooler and Supervisor Attributes
Spooler Attributes
Supervisor Attributes
Logical and Physical Printer Attributes
Logical Printer Attributes
Physical Printer Attributes
Queue Attributes
Job Attributes
Document Attributes
Initial Value Job Attributes
Initial Value Document Attributes
This directory contains a detailed description of every print system attribute. For each attribute, the following information is included:
A brief description of the attribute. Each description categorizes the attribute's functionality. You may refer to the "Attributes grouped by function" section of this appendix to compare functionally similar attributes across different object classes.
A list of objects with which the attribute is associated.
A field indicating if the attribute can contain one value (single value) or multiple values (multi-value).
A field indicating if the user can set or modify the attribute. Some attributes are settable only at object creation.
A list of valid values for the attribute. For complex attributes, valid values for each element are shown.
This section includes client attributes. These attributes specify parameters for the operation of CLI commands and are not communicated to the server. Client attributes are:
attributes
class
copy-from
count-limit
document-filename
filter
headings
requested-attributes
scope
style
time-limit
when
The
access-control-list
attribute specifies the privilege
level of specified authorized print system users within and across domains.
Server (spooler and supervisor)
Multi-value
Yes
See table
Table A-1: access-control-list
Element | Data Type | Valid Values |
name | text | [UserName] @ (valid only for name-type=all-users) [UserName]@domain (valid only for name-type=all-users) [UserName]@host (valid only for name-type=all-users) |
name-type | objectIdentifier | all-users user group (default if name and name-type not specified) netgroup |
privilege-level | objectIdentifier | end-user (default if privilege-level not specified) operator administrator |
The default ACL has two values:
name-type=all-users; privilege-level=end-user
name-sysadmin; name-type=group, privilege-level=administrator
When an administrator creates a server, the server sets the two values for its ACL. (The only exception is if you set an administrator value ACL with the -A with startup option.) If the domain does not include a group named sysadmin, the local-root user needs to set the server's ACL to a locally correct value.
You may reset
access-control-list
to its default
values by typing:
pdset -c server -x "access-control-list==" spooler_name
Resetting to the default values replaces the specified object's ACL with the two default values listed above, regardless of what is locally correct.
A.2.2 additional-production-instructions
Specifies lpd processing options that are not representable as attributes.
Document
Single value
Yes
Text string of up to 255 characters
The queue to which the spooler assigned the job.
Job
Single value
No
Text string of up to 255 characters
On logical printers: Identifies the single queue the logical printer feeds.
On physical printers: Identifies the single queue (and, therefore, the single spooler) from which the physical printer receives jobs.
A user must first disable the relevant logical or physical printer before
setting the corresponding value for
associated-queue
.
Printer (logical and physical)
Single value
Yes
Text string of up to 255 characters
Name of the server with which the object is associated. It is set by object when it is created.
Initial-value-document
Initial-value-job
Printer (logical and physical)
Queue
Single value
No
Text string of up to 4095 characters
This client attribute identifies one or more attributes that are to be included in an operation.
N/A
Multi-value
Yes
Text string of up to 255 characters
Indicates the general availability of an object. It is set to none if the object is disabled and to normal if the object is enabled.
Printer (logical and physical)
Queue
Server (spooler and supervisor)
Single value
No
Normal
None (not available)
Specifies the edge of the sheet on which binding will occur from the perspective of the first sheet imaged.
The attribute determines the edge to which the
binding-edge-image-shift
attribute is applied.
Destination logical and physical printers must contain the specified
document's binding-edge as a value of their
binding-edges-supported
attribute.
If the client does not specify binding-edge, the default value is top-edge
if
plex=tumble
.
Otherwise, the default edge is left-edge
(for
plex=simplex
and
plex=duplex
).
If the client specifies a document (or range of pages) where the first page is a back side of a sheet, the client must specify the binding-edge from the perspective of that first page. That is, on a document to be bound on the left edge, the client would specify right-edge because the back page would be bound on its right edge.
Document
Initial-value-document
Single value
Yes
Bottom-edge
Right-edge
Top-edge
Left-edge
Identifies the binding-edge values supported by this printer.
Refer to the
binding-edge
attribute description for
additional information.
Printer (logical and physical)
Multi-value
Yes
Bottom-edge
Right-edge
Top-edge
left-edge
Provides more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the number of lines between the bottom edge of the logical page and the bottom edge of the text area when held in the intended reading orientation.
(Some document formats, such as PostScript, specify the margin as part of the document content; simple-text does not.)
The value bottom-margin=6 specifies a bottom margin of six lines. The actual distance is dependent on the size of the character set specified for the document.
Because of its use with simple-text format,
bottom-margin
is typically part of a simple-text translation filter as defined with the
attribute
filter-definition
.
Document
Initial-value-document
Single value
Yes
Any positive number
A.2.11 cancel-individual-document-supported
Indicates if the server can cancel printing of an individual document within a job.
Server (spooler and supervisor)
Single value
No
False or no
Specifies a system directory where printer setup modules and prologues
can be found.
The pdspvr supervisor searches directories in the following
order:
printer-specific cfg-prologue-path
,
server-specific cfg-prologue-path
,
/usr/local/pd/setup,
and /usr/pd/share/prologues
.
Server (supervisor)
Printer (physical)
Single value
Yes
Text string
Identifies the character set encodings ready to be used on the printer.
On job submission, the spooler checks the character set specified for
a document against the logical printer'scharacter-sets-supported
attribute.
If there is no match, the spooler rejects the print
request.
In addition, the spooler checks for a match with the physical printer's
character-sets-ready
attribute.
If there is no match, the spooler
leaves the job pending.
Printer (physical only)
Multi-value
Yes
See default-character-set
A.2.14 character-sets-supported
Identifies the character set encodings supported by the printer
On job submission, the spooler checks the character set specified for
a document against the logical printer'scharacter-sets-supported
attribute.
If there is no match, the spooler rejects the print
request.
In addition, the spooler checks for a match with the physical printer's
character-sets-ready
attribute.
If there is no match, the spooler
leaves the job pending.
Printer (logical and physical)
Multi-value
Yes
See the
default-character-set
attribute
This client attribute identifies the object class of the operand.
N/A
Single value
Yes
Time at which the job completed printing.
If job end sheets are in use via the
job-sheets
attribute,
the value of the
completion-time
attribute prints on job
end sheets.
Job
Single value
No
A.2.17 conformance-levels-supported
Specifies the conformance levels supported.
Server (spooler and supervisor)
Multi-value
No
level-2M
Provides you with more control over the placement of text in a document with simple-text format. Specifically, the attribute enables you to specify the most significant orientation of the document.
(Some document formats, such as PostScript, specify the document orientation as part of the document content; simple-text does not.)
A document's orientation (whether specified via
content-orientation
or as part of the document content) works together with the value
of the
number-up
attribute to determine the orientation
and number of images that will print on the output page.
Destination logical and physical printers must contain the specified
document's
content-orientation
value as a value of their
content-orientations-supported
attribute.
Because of its use with simple-text format,
content-orientation
is typically a part of a simple-text translation filter as defined
with the attribute
filter-definition
.
Document
Initial-value-document
Single value
Yes
Portrait
Landscape
Reverse-portrait
Reverse-landscape
A.2.19 content-orientations-supported
Specifies the document content orientations supported by the printer. The attribute values must include any content orientation for a document directed to the printer.
If
content-orientations-supported
for the logical
printer does not contain a value match to the document's orientation, the
spooler rejects the print request.
If
content-orientations-supported
for the physical printer does not contain a value match to the
document's orientation, the spooler leaves the job pending.
Printer (logical and physical)
Multi-value
Yes
Portrait
Landscape
Reverse-portrait
Reverse-landscape
Specifies the number of copies of the document to be printed.
The
copy-count
can also apply to selected pages, if supported (see
page-select
and
page-select-supported
attributes).
The value of the
copy-count
attribute should not
exceed the value of the logical or physical printer's
maximum-copies-supported
attribute.
If it does, the spooler rejects the job.
Document
Initial-value-document
Single value
Yes
Number greater than 1
Causes the server to create a new object that is identical to an existing one specified in the copy-from attribute
Printer, queue, initial-value-job, initial-value-document
Single value
N/A
Name of existing object of same class
Specifies the number of objects to be included in groupings for pdls output. Setting this attribute causes the output of pdls command to be segmented, so that the information is displayed in stages.
N/A
Single value
Yes
Number greater than 1
Identifies the current state of the job.
If a job's
job-print-after
attribute is set for a
date or time in the future, its
current-job-state
attribute
is set to held.
When the specified time has elapsed,
current-job-state
is set to pending so the job becomes a candidate for being scheduled
for printing.
If a job's
job-hold
attribute is set to true or yes,
its
current-job-state
attribute is set to held.
Job
Single value
No
Completed, printing, held, processing, paused, retained, pending, terminating, preprocessing, and unknown.
Identifies a coded character set that the spooler uses as the coded character set default for document pages not otherwise specifying a character set.
If the document data itself specifies a character set, such specification
overrides the
default-character-set
in use by the spooler.
On job submission, the spooler checks the character set specified for
a document against the logical printer's
character-sets-supported
attribute.
If there is no match, the spooler rejects the print
request.
In addition, the spooler checks for a match with the physical printer's
character-sets-ready
attribute.
If there is no match, the spooler
leaves the job pending.
Document
Initial-value-document
Single value
Yes
See table
Table A-2: default-character-set
Values | ||
Adobe-Standard-Encoding | ISO-Latin2 | PC-page-852-Latin2 |
ASCII | ISO-Latin3 | PC-page-862-Latin-Hebrew |
Big5 | ISO-Latin4 | Shift-JIS |
DEC-MCS | ISO-Latin5 | UCS4 |
EUC-Fixed-Width-Japanese | ISO-Latin6 | Unicode |
EUC-Packed-Format-Japanese | ISO-reg11-Swedish-for-Names | Unicode-ASCII |
GB-2312 | ISO-reg15-Italian | Unicode-IBM-1264 |
Half-Width-Katakana | ISO-reg17-Spanish | Unicode-IBM-1265 |
HP-Desktop | ISO-reg21-German | Unicode-IBM-1268 |
HP-Legal | ISO-reg4-United-Kingdom | Unicode-IBM-1276 |
HP-Math8 | ISO-reg60-Danish-Norwegian | Unicode-IBM-1261 |
HP-PiFont | ISO-reg69-French | Unicode-IBM-2039 |
HP-PS-Math | ISO-Text-Communication | Unicode-Latin1 |
HP-Roman8 | iso-ucs-2-level2 | Ventura-International |
IBM-Symbols | JIS-Encoding | Ventura-Math |
IBM-Thai | Microsoft-Publishing | Ventura-US |
ISO-Latin-Arabic | Other | Windows30-Latin1 |
ISO-Latin-Cyrillic | PC8-Danish-Norwegian | Windows31-Latin1 |
ISO-Latin-Greek | PC8-page-437-US | Windows31-Latin2 |
ISO-Latin-Hebrew | PC8-Turkish | Windows31J |
ISO-Latin1 | PC-page-850-Multilingual | Windows31-Latin5 |
Identifies the font to be used for document pages not otherwise specifying a font.
If the document data itself specifies a font, such specification overrides
the
default-font
in use by the spooler.
On job submission, the spooler checks the font specified for a document
against the logical printer's
fonts-supported
attribute.
If there is no match, the spooler rejects the print request.
In addition, the spooler checks for a match with the physical printer's
fonts-ready
attribute.
If there is no match, the spooler leaves
the job pending.
Document
Initial-value-document
Single value
Yes
Text string of up to 255 characters
Specifies the input tray that the supervisor sets as the default before the document begins printing.
Destination logical and physical printers
input-trays-supported
attributes must contain a value corresponding to the value of the
default-input-tray
attribute of a document to be printed.
The physical
printer's
input-trays-ready
attribute
must also contain a value corresponding to the value of the
default-input-tray
attribute of the document to be printed.
Document
Initial-value-document
Single value
Yes
Top, middle, bottom, envelope, manual, large-capacity, main, side
Specifies the medium used for pages that require specification.
If the
page-media-select
attribute is specified,
its value overrides the
default-medium
value on a page-by-page
basis.
On job submission, the spooler checks the medium specified for a document
against the logical printer's
media-supported
attribute.
If there is no match, the spooler rejects the print request.
In addition, the spooler checks for a match with the physical printer's
media-ready
attribute.
If there is no match, the spooler leaves
the job pending.
Document
Initial-value-document
Single value
Yes
See table
Values | ||
a | iso-b10-white | jis-b4-white |
b | iso-b1-white | jis-b5-coloured |
c | iso-b2-white | jis-b5-white |
d | iso-b3-white | jis-b6-white |
default | iso-b4-coloured | jis-b7-white |
e | iso-b4-envelope | jis-b8-white |
executive | iso-b4-white | jis-b9-white |
folio | iso-b5-coloured | ledger |
invoice | iso-b5-envelope | monarch-envelope |
iso-a0-white | iso-b5-white | na-10x13-envelope |
iso-a10-white | iso-b6-white | na-10x14-envelope |
iso-a1-white | iso-b7-white | na-10x15-envelope |
iso-a2-white | iso-b8-white | na-6x9-envelope |
iso-a3-coloured | iso-b9-white | na-7x9-envelope |
iso-a3-white | iso-c3-envelope | na-9x11-envelope |
iso-a4-coloured | iso-c4-envelope | na-9x12-envelope |
iso-a4-transparent | iso-c5-envelope | na-legal-coloured |
iso-a4-white | iso-c6-envelope | na-legal-white |
iso-a5-coloured | iso-designated-long-envelope | na-letter-coloured |
iso-a5-white | jis-b0-white | na-letter-transparent |
iso-a6-white | jis-b10-white | na-letter-white |
iso-a7-white | jis-b1-white | na-number-10-envelope |
iso-a8-white | jis-b2-white | na-number-9-envelope |
iso-a9-white | jis-b3-white | quarto |
iso-b0-white | jis-b4-coloured |
A.2.28 default-user-job-priority
Sets the job-priority when the job-priority is not explicitly set. The value must be less than or equal to the value of the max-user-job-priority attribute.
Printer (logical)
Single value
Yes
Integer values 1-100
Supplies a textual description of the specified object.
Initial-value-document
Initial-value-job
Printer (logical and physical)
Queue
Server (spooler and supervisor)
Single value
Yes
Text string of up to 4095 characters
A.2.30 disable-backlogged-queue
Indicates whether a queue is declared disabled when backlogged.
Queue
Single value
Yes
Boolean (true or false)
Specifies the name of the file, if any, with complete path.
Do not confuse
this attribute with the client
document-filename
attribute.
If document start sheets are in use via the
document-sheets
attribute, the value of the
document-file-name
attribute prints on document start sheets.
Document
Initial-value-document
Single value
Yes (For a document object, only at job submission. For an initial-value-document object, only at initial-value-document creation or modification.)
Text string of up to 4095 characters
Identifies the input file name to be printed as a document in a print
job.
The name may or may not include the complete path specification.
Do not
confuse this attribute with the
initial-value-document
and
document-file-name
attributes.
N/A
Single value
Yes
Text string of up to 4095 characters
Identifies the data format of a document.
Destination logical and physical printers must contain the specified
document's
document-format
value as a value of their
document-formats-supported
attribute.
The physical printer must
also contain the document's document-format value as a value of its
document-formats-ready
attribute.
Examples:
document-format=PostScript
document-format="{document-format=PostScript document-format-variants='level2' document-format-version='48.13'}"
Note that if the optional elements are not included, the value does not require the braces {} (document-format=PostScript).
Document
Initial-value-document
Single value
Yes
See table
Values | ||
201PL | fortra | Pinwriter |
ART | HPGL | PJL |
automatic | IGP | plot |
CaPSL | imPRESS | PostScript |
CCITT | Interpress | PPDS |
cif | IPDS | PSPrinter |
CodeV | ISO6429 | QUIC |
CPAP | LCDS | raster |
DDIF | line-data | ReGIS |
DEC-PPL | LIPS | SCS |
Diagnostic | LN03 | simple-text |
ditroff | MODCA | SPDL |
DOC | NPAP | Tek4014 |
DPC | NPDL | TIFF |
DSC-DSE | Other | troff |
dvi | PAGES | Unknown |
Epson | PCL | WPS |
EscapeP | PCL-XL | XES |
EXCL | PDS |
Specifies the document formats that can be handled by the printer and any associated translators. For example, on a LaserWriter with the standard supervisor, the value of this attribute is PostScript and simple-text.
The
document-formats-ready
attribute must contain
a value corresponding to the value of the
document-format
attribute of a document to be printed on this printer.
Also, checking takes place to compare the values of
document-formats-ready
with the printer's
native-document-formats-ready
attribute.
If there is a mismatch, the print system may abort the job.
Ask
your system administrator for details.
Printer (physical only)
Multi-value
Yes
See
document-format
attribute description
A.2.35 document-formats-supported
Specifies the document formats supported by the printer.
The
document-formats-supported
attribute must contain
a value corresponding to the value of the
document-format
attribute of a document submitted to this printer.
Printer (logical and physical)
Multi-value
Yes
See
document-format
attribute description
Specifies a meaningful or base name for the document. This attribute is set to be the file name, if not otherwise specified by the submitter.
A path specification is not included in the value of this attribute. If the system provides the full path name, the file name is only used by this attribute.
If document start sheets are in use via the
document-sheets
attribute, the value of the
document-name
attribute
prints on document start sheets.
Document
Initial-value-document
Single value
Yes
Text string of up to 255 characters
A.2.37 document-sequence-number
Specifies the sequence number of this document within a job.
Document
Single value
No
Number equal to or greater than 0
Specifies the auxiliary sheets the server should insert into the job.
If you specify a value of
doc-set-start-copies-separate
,
a separator sheet precedes every copy of the document.
Destination logical and physical printers must contain the specified
job's
document-sheets
value as a value of their
document-sheets-supported
attribute.
The physical printer must also
contain the specified job's
document-sheets
value as a
value of its
document-sheets-ready
attribute.
Initial-value-job
Job
Single value
Yes
None
doc-set-start-copies-separate
Specifies the auxiliary sheets ready for use on the printer.
The
document-sheets-ready
attribute must contain
a value corresponding to the value of the
document-sheets
attribute of a job to be printed on this printer.
Printer (physical only)
Multi-value
Yes
None
doc-set-start-copies-separate
A.2.40 document-sheets-supported
Specifies the auxiliary sheets supported by this printer.
The
document-sheets-supported
attribute must contain
a value corresponding to the value of the
document-sheets
attribute of a job submitted to this printer.
Printer (logical and physical)
Multi-value
Yes
None
doc-set-start-copies-separate
Identifies the state of the document.
Document
Single value
No
Transfer-pending, pending, processing, completed, printing
Indicates whether the specified object is enabled to accept print requests. This attribute is set with pdenable/pddisable. When an object is created, it is disabled by default.
The default value is disabled.
Printer (logical and physical)
Queue
Server (spooler and supervisor)
Single value
Yes (via
pdenable
and
pddisable
)
True or yes (enabled)
False or no (disabled)
Specifies the event types and event classes supported by the server.
Server (spooler and supervisor)
Multi-value
No
Refer to Appendix C for a list of valid values.
Disallows the use of certain translation filters for a particular printer.
Printer (physical only)
Multi-value
Yes
Text string of up to 255 characters
A.2.45 extended-lpd-job-identifiers
Specifies that an outbound gateway printer should use extended lpd job numbers when communicating to an external HP Tru64 UNIX lpd print queue, when set to yes. This extends the maximum outgoing job number from 999 to 999999, which reduces the chance of job overflow or job loss on the target server. However, it does so at the expense of compliance with LPD protocol as defined by RFC1179.
Printer (physical)
Single
Yes
Boolean
A.2.46 file-reference-is-local-only
Specifies whether the server using the file-reference transfer method is allowed to access non-local document files.
Server (spooler and supervisor)
Single value
No
True or yes
Specifies the selection criteria to be used among candidate object_instances in the operand.
N/A
Single value
Yes
Text string
Defines a program as a filter and contains the information needed to invoke the program.
Server (supervisor only)
Multi-value
Yes
See table
Specifies a finishing process to be applied to the document.
Destination logical and physical printers must contain the specified
document's finishing value as a value of their finishings-supported attribute.
The physical printer must also contain the specified document's finishing
value as a value of its
finishings-ready
attribute.
Document
Initial-value-document
Single value
Yes
Values | |
bind | staple |
cover | staple-bottom-left |
edge-stitch | staple-bottom-right |
punch | staple-top-left |
saddle-stitch | staple-top-right |
Identifies the per-document finishings ready on the printer.
The
finishings-ready
attribute must contain a value
corresponding to the value of the
finishing
attribute of
a document to be printed on this printer.
Printer (physical only)
Multi-value
Yes
See finishing table
Identifies the per-document finishings supported on the printer.
The
finishings-supported
attribute must contain a
value corresponding to the value of the
finishing
attribute
of a document submitted to this printer.
Printer (logical and physical)
Multi-value
Yes
See finishing table
Identifies the font resources ready on the printer.
On job submission, the spooler checks the font specified for a document
against the logical printer's
fonts-supported
attribute.
If there is no match, the spooler rejects the print request.
In addition, the spooler checks for a match with the physical printer's
fonts-ready
attribute.
If there is no match, the spooler leaves
the job pending.
Printer (physical only)
Multi-value
Yes
Text string of up to 255 characters
Identifies the font resources supported by the printer.
On job submission, the spooler checks the font specified for a document
against the logical printer's
fonts-supported
attribute.
If there is no match, the spooler rejects the print request.
In addition, the spooler checks for a match with the physical printer's
fonts-ready
attribute.
If there is no match, the spooler leaves
the job pending.
Printer (logical and physical)
Multi-value
Yes
Text string of up to 255 characters
Provides more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the text that is to be printed on the last line of each page.
Because of its use with simple-text format,
footer-text
is typically part of a simple-text translation filter as defined with the
attribute
filter-definition
.
Document
Initial-value-document
Single value
Yes
Provides more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the text that is to be printed on the first line of each page.
Because of its use with simple-text format,
header-text
is typically part of a simple-text translation filter as defined with the
attribute
filter-definition
.
Document
Initial-value-document
Single value
Yes
Text string of up to 4095 characters
Specifies whether column headings should be included on output of requested attributes.
N/A
Single value
Yes
False or no
True or yes
Sets the highlight printing color for the document.
Destination logical and physical printers must contain the specified
document's
highlight-colour
value as a value of their
highlight-colours-supported
attribute.
The physical printer must
also contain the specified document's
highlight-colour
value as a value of its
highlight-colours-ready
attribute.
Document
Initial-value-document
Single value
Yes
Red, blue, green, cyan, magenta, yellow, cardinal, royalblue, ruby, violet, black, or name
A.2.58 highlight-colour-mismatch-action
Determines how the print system handles highlight color jobs when there
is a mismatch between the color specified for the document and the highlight
color supported or ready at the printer (highlight-colours-supported
and
highlight-colours-ready
attributes).
When the value is abort, the spooler rejects the document/job if the:
matching highlight color is not supported
matching highlight color is supported but is not ready
When the value is ignore, the spooler ignores the highlight color mismatch and continues to accept and schedule the document/job for printing.
When the value is operator, operator intervention is required to resolve the mismatch. The spooler:
rejects the document or job if the matching highlight color is not supported
accepts but does not schedule the document or job if the matching highlight color is supported but is not ready
When no value is specified, the spooler:
rejects the document or job if the matching highlight color is not supported
accepts but does not schedule the document or job if the matching highlight color is supported but is not ready
Document
Initial-value-document
Single value
Yes
Abort, ignore, operator
A.2.59 highlight-colour-rendering-algorithm
Sets the highlight color rendering algorithm for the document.
Destination logical and physical printers must contain the specified
document's
highlight-colour-rendering-algorithm
value
as a value of their
highlight-colour-rendering-algorithms-supported
attribute.
Document
Initial-value-document
Single value
Yes
Automatic, colourToHighlight, colourTables, presentation, pictorial
A.2.60 highlight-colour-rendering-algorithms-supported
Indicates the highlight color rendering algorithms supported on this printer.
The
highlight-colour-rendering-algorithms-supported
attribute must contain a value corresponding to the value of the
highlight-colour-rendering-algorithm
of a document submitted to
this printer.
Printer (logical and physical)
Multi-value
Yes
Automatic, colourToHighlight, colourTables, presentation, pictorial
A.2.61 highlight-colours-ready
Indicates the values of highlight colors ready on this printer.
The
highlight-colours-ready
attribute must contain
a value corresponding to the value of the
highlight-colour
attribute of a document to be printed on this printer.
Printer (physical only)
Multi-value
Yes
Red, blue, green, cyan, magenta, yellow, cardinal, royalblue, ruby, violet, black, or name
A.2.62 highlight-colours-supported
Indicates the values of highlight colors supported on this printer.
The
highlight-colours-supported
attribute must contain
a value corresponding to the value of the
highlight-colour
attribute of a document submitted to this printer.
Printer (logical and physical)
Multi-value
Yes
Red, blue, green, cyan, magenta, yellow, cardinal, royalblue, ruby, violet, black, or name
A.2.63 highlight-mapping-colour
The
highlight-mapping-colour
attribute sets the specified
color to be the reference color.
Destination logical and physical printers must contain the specified
document's
highlight-mapping-colour
value as a value of
their
highlight-mapping-colours-supported
attribute.
Document
Initial-value-document
Single value
Yes
Red, blue, green, cyan, magenta, yellow cardinal, royalblue, ruby, violet, black, or name
A.2.64 highlight-mapping-colours-supported
Indicates the values of highlight colors supported on this printer that can be used as reference colors.
The
highlight-mapping-colours-supported
attribute
must contain a value corresponding to the value of the
highlight-mapping-colour
attribute of a document submitted to this printer.
Printer (logical and physical)
Multi-value
Yes
Red, blue, green, cyan, magenta, yellow, cardinal, royalblue, ruby, violet, black, or name
A.2.65 hold-jobs-interrupted-by-printer-failure
Specifies whether jobs returned to the spooler after a restart should be put in the held (true or yes) or pending (false or no) state.
Printer (logical only)
Server (spooler only)
Single value
Yes
True or yes
False or no
Identifies an initial-value-document object that contains default document attributes to be used when constructing the document object during print job submission.
The document's
initial-value-document
takes precedence
over the printer's
initial-value-document
.
Document
Single value
Yes (only at job submission)
Name of existing initial-value-document
A.2.67 initial-value-document-identifier
Uniquely identifies an initial-value-document object.
Initial-value-document
Single value
Yes (only at initial-value-document creation)
Identifies an initial-value-job object that contains default job attributes to be used when constructing the job object during print job submission.
The job's
initial-value-job
takes precedence over
the printer's
initial-value-job
.
Job
Single value
Yes (only at job submission)
Name of existing initial-value-job
A.2.69 initial-value-job-identifier
Uniquely identifies an initial-value-job object.
Initial-value-job
Single value
Yes (only at initial-value-job creation)
Identifies the medium in each input tray of the printer. Each input tray object identifier should appear only once in the values of the attribute (one medium per tray). However, medium identifiers may appear several times (same medium in multiple trays).
Destination logical and physical printers must contain the specified
document's
input-trays-medium
value as a value of their
input-trays-supported
and
media-supported
attributes.
The physical printer must also contain the specified document's
input-trays-medium
value as a value of its
input-trays-ready
and
media-ready
attributes.
Examples:
input-trays-medium=top:a
"input-trays-medium='top:na-letter-white `bottom:na-legal-white"
Printer (physical only)
Multi-value
Yes
For input tray: Top, middle, bottom, envelope, manual, large-capacity, main, side
For medium: Refer to the valid values of the
default-medium
attribute.
Identifies the input tray ready to be used on this printer.
The
input-trays-ready
attribute must contain a value
corresponding to the value of the
default-input-tray
attribute
of a document to be printed on this printer.
Printer (physical only)
Multi-value
Yes
Top, middle, bottom, envelope, manual, large-capacity, main, side
Identifies the input trays supported on this printer.
The
input-trays-supported
attribute must contain
a value corresponding to the value of the
default-input-tray
attribute of a document submitted to this printer.
Printer (logical and physical)
Multi-value
Yes
Top, middle, bottom, envelope, manual, large-capacity, main, side
Indicates the number of jobs to be printed before this job will be scheduled. It is set to 0 (zero) when the job begins printing.
Job
Single value
No
Number equal to or greater than 0
A.2.74 job-attributes-visible-to-all
Specifies the list of job and document attributes that a non-owner of the job will be able to see with the pdls operation. This can be set by an administrator. By default, only intervening jobs are visible.
Server (spooler and supervisor)
Multi-value
Yes
Supplies a human readable string for a print job.
If job start sheets are in use by way of the
job-sheets
attribute, the value of the
job-comment
attribute prints
on job start sheets.
This is the only attribute that is printed on the job
sheet.
Initial-value-job
Job
Single value
Yes
Specifies the amount of time the spooler maintains job objects after jobs are completed and retained. This is different from job retention because the document files are not kept. When the retention period is over and the completion period has begun, a job can not be resubmitted for re-print.
Server (spooler)
Single value
Yes
Delta time
Specifies the number of copies of the job to be printed.
The product of
job-copies
and
copy-count
should not exceed the value of the logical or physical printer's
maximum-copies-supported
attribute.
If it does, the spooler rejects
the job.
The
job-copies
and
output-bin
client attributes are part of the
results-profile
attribute.
The
results-profile
attribute is supported but is not visible
to the user.
Its value is specified via the
job-copies
and
output-bin
attributes.
Initial-value-job
Job
Single value
Yes
Number greater than 1
Indicates the number of job copies that have been printed.
Job
Single value
No
Number equal to or greater than 0
Specifies the calendar date and time of day at which a job should be
discarded, regardless of whether it has printed.
When the date and time of
day at which a job should be discarded occurs, the spooler sets the job's
job-retention-period
attribute to zero, regardless of
the job state.
The spooler then deletes the job.
The
job-retention-period
attribute specifies a lower
bound on how long the spooler retains a job, its attributes, and data.
The
job-discard-time
attribute specifies an upper bound on retention,
regardless of whether the job has printed.
To specify that job budget should be deleted if it does not print by August 25, 1997, use:
pdmod -x "job-discard-time=25:08:1997:17:00:00" budget
Initial-value-job
Job
Single value
Yes
Values entered in the format dd:mm:yyyy:HH:MM:SS
Indicates the number of times the job is returned by the supervisor due to a crash of the spooler or supervisor.
Job
Single value
No
Number equal to or greater than 0
Specifies whether a print job is a candidate for being scheduled for printing. The default value of this attribute is false or no.
When the value is false or no, the spooler does not hold the job from
being scheduled for printing, unless there are other reasons (see the
current-job-state
and
job-state-reasons
attributes).
When the value is true or yes, the spooler holds the job from being scheduled for printing. Specifically:
the value
job-hold-set
is added to the
job's
job-state-reasons
attribute, and
the value held is added to the job's
current-job-state
attribute.
If the
job-hold
attribute is set to true or yes,
it remains on hold indefinitely until one of following events takes place:
You set the
job-hold
attribute to false
or no
The
job-discard-time
that you previously
set passes
You cleaned the associated queue or spooler. The spooler deletes all jobs in the queue or spooler, including jobs in the held state.
Initial-value-job
Job
Single value
Yes
True or yes
False or no
A spooler-generated value unique to the spooler (not necessarily unique in a distributed environment).
Job
Single value
No
Text string of up to 255 characters
A.2.83 job-identifier-on-client
A client job identifier; intended for jobs submitted from legacy servers.
Job
Single value
Yes (only at job submission)
Text string of up to 255 characters
A.2.84 job-message-from-administrator
Supplies a human readable string intended to indicate to users the reason for some action taken on a job.
The -m option can also be used to attach a human readable message to a job. Users can retrieve the message with the pdls utility.
The
-m
option is equivalent to including the
job-message-from-administrator
attribute with a job.
If job start sheets are in use via the
job-sheets
attribute, the value of the
job-message-from-administrator
attribute prints on job start sheets.
Job
Single value
Yes
Text string of up to 4095 characters
Supplies a human readable string for a print job.
This string may be
printed on job start sheets or used in notification and logging messages.
If you do not specify
job-name
, it defaults to the file
name or to the name of the first file in a multi-document job.
If job start or end sheets are in use via the
job-sheets
attribute, the value of the
job-name
attribute prints on
job start or end sheets.
Initial-value-job
Job
Single value
Yes
Text string of up to 255 characters
Contains the name of the host from which the print job originated. The BSD inbound gateway uses this attribute.
If job start sheets are in use via the
job-sheets
attribute, the value of the
job-originating-host
attribute
prints on job start sheets.
Job
Single value
No
Text string of up to 255 characters
Supplies the name of the human originator of the print request; generally the same as job owner. It differs if the job was submitted by the originator on behalf of the owner.
Job
Single value
Yes
Text string of up to 4095 characters
Supplies the name of the human owner of the print job.
The value of
job-owner
will often be the same as
job-originator
.
The
job-owner
attribute is different
from
job-originator
when a job is submitted by the originator
on behalf of the owner.
During the authentication process, the spooler determines job ownership
with the
job-owner
attribute.
Job
Single value
Yes (only at job submission)
Text string of up to 4095 characters
Specifies a print job scheduling priority value. Jobs with higher priorities are scheduled to print before jobs with lower priorities.
Job
Initial-value-job
Single value
Yes
Integer values 1-100
Specifies the calendar date and time after which the job can be scheduled. If the date is in the future:
the job's
current-job-state
is set to held
job-print-after-specified
is added to the
job's
job-state-reasons
When the specified time has passed:
the job's
current-job-state
is set to pending
so the job becomes a candidate for being scheduled for printing
To specify a print after time for a job, use:
pdpr -x "job-print-after=date_and_time" [filename]
or
pdmod -x "job-print-after=date_and_time" [spooler_name:] job_identifier
or
pdset -c job -x "job-print-after=date_and_time" [spooler_name:] job_identifier
Initial-value-job
Job
Single value
Yes
Values entered in the format dd:mm:yyyy:HH:MM:SS
The time when the job was promoted.
Job
Single value
No
Specifies the minimum amount of time following the completion of a job that the spooler will retain a job, its attributes, and data.
The
job-retention-period
attribute specifies a lower
bound on how long the spooler retains a job, its attributes, and data.
The
job-discard-time
attribute specifies an upper bound on retention,
regardless of whether the job has printed.
In addition to providing status information to a user after a job has
printed, the
job-retention-period
attribute provides the
mechanism for retaining the job's document data after it has been printed.
This enables the job to be printed again, possibly with modified attributes.
If a job has a value specified for its
job-discard-time
attribute, the spooler sets the
job-retention-period
to zero when the
job-discard-time
occurs.
Initial-value-job
Job
Single value
Yes
Values entered in the format [HH:]mm[:SS]
Specifies the auxiliary sheets the supervisor will print with the job.
If you specify a value of
job-copy-start
, a start
sheet prints in front of every copy of the job.
If you specify a value of
job-copy-wrap
, a start
sheet and end sheet prints for every copy of the job.
Destination logical and physical printers must contain the specified
job's
job-sheets
value as a value of their
job-sheets-supported
attribute.
The physical printer must also contain
the specified job's
job-sheets
value as a value of its
job-sheets-ready
attribute.
Initial-value-job
Job
Single value
Yes
none
job-copy-start
job-copy-wrap
Specifies the auxiliary sheets ready on this printer.
The
job-sheets-ready
attribute must contain a value
corresponding to the value of the
job-sheets
attribute
of a job to be printed on this printer.
Printer (physical only)
Multi-value
Yes
none
job-copy-start
job-copy-wrap
Specifies the auxiliary sheets supported by this printer.
The
job-sheets-supported
attribute must contain a
value corresponding to the value of the
job-sheets
attribute
of a job submitted to this printer.
Printer (logical and physical)
Multi-value
Yes
none
job-copy-start
job-copy-wrap
Gives additional text information about a job's state. The reference supervisor places user-readable text in this attribute when a job is completed with errors or is aborted.
Job
Single value
No
See table
Identifies the reasons that the job is in held, terminating, retained, or completed state. If the job is not in any of these states, this attribute is set to empty.
Job
Multi-value
No
Values | |
aborted-by-system |
job-hold-set |
cancelled-by-operator | job-print-after-specified |
cancelled-by-user | logfile-pending |
completed-with-errors | logfile-transferring |
completed-with-warnings | required-resource-not-ready |
documents-needed | successful-completion |
A.2.98 job-submission-complete
Specifies whether all documents in the print job have been submitted, indicating the job has been closed.
Job
Single value
No
True or yes
False or no
Provides control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the distance in characters between the left edge of the logical page and the left edge of the text area when held in the intended reading position.
(Some document formats, such as PostScript, specify the margin as part of the document content, simple-text does not.)
The value left-margin=12 specifies a left margin of twelve characters.
Because of its use with simple-text format, left-margin is typically
part of a simple-text translation filter as defined with the
filter-definition
attribute.
Document
Initial-value-document
Single value
Yes
Any positive number
Provides more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the length of the text area in characters.
(Some document formats, such as PostScript, specify the margin as part of the document content; simple-text does not.)
The value length=60 specifies a text area length of sixty lines.
Because of its use with simple-text format, length is typically part
of a simple-text translation filter as defined with the
filter-definition
attribute .
Document
Initial-value-document
Single value
Yes
Any positive number
Contains a locale specification that the server uses when performing internationalization tasks such as constructing error/notification/logging messages. It is set by the server from the locale environment variable.
Server (spooler and supervisor)
Single value
No
Contains the list of locales supported by the server.
Server (spooler and supervisor)
Multi-value
No
A.2.103 logical-printers-ready
Identifies the logical printers ready on this queue or spooler; it is empty on a supervisor. This attribute is updated whenever a logical printer is enabled or disabled.
Queue
Server (spooler only)
Multi-value
No
The names of the logical printers that are ready.
A.2.104 logical-printers-supported
Identifies the logical printers supported on this queue or spooler; it is empty on a supervisor.
Queue
Server (spooler only)
Multi-value
No
Text string of up to 4095 characters
The maximum priority value that a user can set. Operators and administrators can set a job's priority to any value within the range of 1- 100.
Printer (logical)
Single value
Yes
Integer values 1-100
A.2.106 maximum-copies-supported
Indicates the maximum number of copies of a document that can be printed
on this printer.
This includes document copies specified via the attributes
copy-count
and
job-copies
.
This attribute can be used to limit the number of copies of a job that can be printed.
Printer (logical and physical)
Single value
Yes
Number equal to or greater than 0
A.2.107 maximum-number-of-printers-supported
Specifies how many actual printers the supervisor will drive. Attempts to create physical printers on the supervisor after this limit has been met will fail.
Server (supervisor only)
Single value
No
Number equal to or greater than 0
Specifies the maximum speed of the printer in pages per minute.
Printer (physical only)
Single value
Yes
Number greater than 1
Identifies the media currently ready to be used on this printer.
On job submission, the spooler checks the medium specified for a document
against the logical printer's
media-supported
attribute.
If there is no match, the spooler rejects the print request.
In addition, the spooler checks for a match with the physical printer's
media-ready
attribute.
If there is no match, the spooler leaves
the job pending.
Printer (physical only)
Multi-value
Yes
See
default-medium
Identifies the media supported by the printer
On job submission, the spooler checks the medium specified for a document
against the logical printer's
media-supported
attribute.
If there is no match, the spooler rejects the print request.
In addition, the spooler checks for a match with the physical printer's
media-ready
attribute.
If there is no match, the spooler leaves
the job pending.
Printer (logical and physical)
Multi-value
Yes
See
default-medium
Supplies a human readable string intended to indicate to users something about an object's state. This attribute may be used to indicate to users why an object is unavailable or when it is expected to be ready.
The -m option can also be used to attach a human readable message to a job. Users can retrieve the message with the pdls utility.
The
-m
option is equivalent to including the
message
attribute with initial-value-document, initial-value-job,
printer, queue, and server objects.
Initial-value-document
Initial-value-job
Printer (logical and physical)
Queue
Server (spooler and supervisor)
Single value
Yes
Text string of up to 4095 characters
Controls modification filtering. The value of the attribute is the name of the filter to be applied to the document data prior to translation filtering.
Document
Single value
Yes
Text string of up to 255 characters
A.2.113 modify-individual-document-supported
Indicates whether a server is capable of modifying individual documents in a multiple document job.
Server (spooler and supervisor)
Single value
No
True or yes
False or no
A.2.114 multiple-documents-supported
Indicates if the object is capable of handling multiple document jobs.
Server (spooler and supervisor)
Single value
No
True or yes
False or no
A.2.115 native-document-formats-ready
Identifies the document formats supported directly by printer hardware.
Printer (physical only)
Multi-value
Yes
Disables translation and modification filtering.
Document
Single value
Yes
True or yes (no filtering)
False or no
A.2.117 notification-delivery-methods-ready
Identifies the delivery methods ready on this server for event notification.
Server (spooler and supervisor)
Multi-value
No
electronic-mail
notification-service
A.2.118 notification-delivery-methods-supported
Identifies the delivery methods supported on this object for event notification.
Server (spooler and supervisor)
Multi-value
No
electronic-mail
notification-service
Specifies the events on whose occurrence users will be notified. Also specifies how the notifications are to be delivered.
Only administrators can specify
notification-profile
for printer, queue, and server objects with the pdcreate and pdset operations.
End users can specify
notification-profile
for a job with
the
pdmod
,
pdpr
, and
pdset
operations.
Events can be specified by class or by specific events. If the notification-profile attribute specifies a class, the corresponding notification service reports all events of that class. Refer to Appendix C for a list of classes and events.
The print system supports three notification delivery methods: electronic-mail (and the CLI alias email), notification-service (and the CLI alias message), and none.
Job
Printer (logical and physical)
Queue
Server (spooler and supervisor)
Multi-value
Yes
Indicates the number of documents in the job.
Job
Single value
No
Number equal to or greater than 0
A.2.121 number-of-printers-supported
Specifies the number of actual printers the administrator has set the
supervisor to control.
Attempts to set the value of
number-of-printers-supported
to a value exceeding the limit set by
maximum-number-of-
printers-supported
will fail.
Server (supervisor only)
Single value
Yes
Number equal to or greater than 0
Provides more control over the placement of text in a document with simple-text format. Specifically, the attribute indicates whether to print page numbers on the document pages.
Because of its use with simple-text format,
number-pages
is typically part of a simple-text translation filter as defined with the
attribute
filter-definition
.
Document
Initial-value-document
Single value
Yes
True or yes
False or no
Specifies the number of page images to impose on a single instance of a selected medium.
An empty attribute value is the same as a value of none or 0 (zero)
Together with a document's orientation,
number-up
controls the translation, scaling, and rotation of page images.
Content orientation
refers to the orientation of the actual print data, given the relative dimensions
of the area for the page image on the medium.
Portrait orientation specifies
that, from a human reader's point of view, the height of the image area is
longer than the width; in landscape orientation, the width is longer than
the height.
For example: For 8-1/2-inches wide x 11-inches high media and with number-up=2 in portrait orientation, the image area for the medium is divided into two along the short axis and then rotated 90 degrees or 270 degrees, such that two page images appear side by side. The height of each image area is longer than the width. The physical orientation of the medium, however, has a landscape orientation (11-inches wide x 8-1/2-inches high).
For number-up=2 in landscape orientation, the image area is also divided into two along the short axis but with no rotation (or 180 degree rotation), such that the two image areas appear one on top of the other. The height of each image area is shorter than the width. The physical orientation of the medium has a portrait orientation (8-1/2-inches wide x 11-inches high).
Document
Initial-value-document
Single value
Yes
0
1
2
4
Identifies the number-up values supported by this printer.
An empty attribute value is the same as a value of none or 0 (zero).
The settings shown in the following examples are equivalent:
numbers-up-supported=1 2 4
numbers-up-supported=simple-1-up simple-2-up simple-4-up
Printer (logical and physical)
Multi-value
Yes
none or 0
simple-1-up or 1
simple-2-up or 2
simple-4-up or 4
Identifies the object class for this object.
Document
Initial-value-document
Initial-value-job
Job
Printer (logical and physical)
Queue
Server (spooler and supervisor)
Single value
No
A.2.126 object-classes-supported
Identifies the object classes supported by this server.
Server (spooler and supervisor)
Multi-value
No
Specifies the size of the document in octets.
Document
Single value
No
Identifies the output processing for the media on which the document is to be printed.
Destination logical and physical printers must contain the specified
document's
output
value as a value of their
outputs-supported
attribute.
The physical printer must also contain
the specified document's output value as a value of its
outputs-ready
attribute.
Document
Initial-value-document
Single value
Yes
Page-collate, no-page-collate, decollate, no-decollate, burst, no-burst, stacking-default
Specifies the printer output bin into which the job is placed.
Initial-value-job
Job
Single value
Yes
Top, middle, bottom, side, face-up, left, right, large, private, face-down, collator
Identifies the output bins ready to be used on this printer. The value of this attribute may be an OID, a name, or a number.
The
output-bins-ready
attribute must contain a value
corresponding to the value of the
output-bin
attribute
of a job to be printed on this printer.
Printer (physical only)
Single value
Yes
Top, middle, bottom, side, face-up, left, right, large, private, face-down, collator
Identifies the output bins supported on this printer. The value of this attribute may be an OID, a name, or a number.
The
output-bins-supported
attribute must contain
a value corresponding to the value of the
output-bins
attribute
of a job submitted to this printer.
Printer (logical and physical)
Single value
Yes
Top, middle, bottom, side, face-up, left, right, large, private, face-down, collator
Identifies the output methods currently ready to be used on this printer.
The
outputs-ready
attribute must contain a value
corresponding to the value of the
output
attribute of a
document to be printed on this printer.
Printer (physical only)
Multi-value
Yes
no-page-collate
Identifies the output methods currently supported on this printer.
The outputs-supported attribute must contain a value corresponding to the value of the output attribute of a document submitted to this printer.
Printer (logical and physical)
Multi-value
Yes
no-page-collate
Indicates that the specified pages will be printed on the identified media. Any page not specified in this attribute will be printed as per the default-media attribute.
The print system supports this attribute only for certain printers. Ask your system administrator for details.
Document
Initial-value-document
Single value
Yes
Specifies the page order for which pages in the document have been formatted.
Document
Initial-value-document
Single value
Yes
unknown
first-to-last
last-to-first
Specifies one or more sequences of pages to be printed.
Destination logical and physical printers must support the same type of page selection as the document via the printer page-select-supported attribute.
The pageSelectSyntax allows two types of page identifiers to specify the page selection:
Numeric (positive integer values - numbers greater than 0) to specify the nominal page number identifying the in-sequence number in the document in the order that the pages are presented to the spooler, starting with 1.
Example: page-select=15
Alphanumeric page number as indicated by page identifiers of the document format.
Example: page-select=chapter1
The syntax allows page range selections.
Examples:
page-select=15:21
page-select="'chapter 1:chapter 5'"
Document
Initial-value-document
Single value
Yes
numeric
alphanumeric
Indicates the types of page identifiers supported by the printer. This attribute applies only for the outbound gateway.
The values for page-select-supported must include the value of page-select used by a document submitted to this printer.
Printer (logical and physical)
Multi-value
Yes
numeric
alphanumeric
A.2.138 physical-printers-ready
Identifies the physical-printers ready on this object. On a spooler, the attribute refers to physical printers that are associated with all the spooler's queues. On a supervisor, the attribute refers to all the supervisor's printers. On a queue, the attribute refers to printers associated with the queue. This attribute is only used for scheduling on queues. It is maintained by the system and updated when physical printers are enabled/disabled.
Queue
Server (spooler and supervisor)
Multi-value
No
Text string of up to 4095 characters
A.2.139 physical-printers-requested
Identifies the physical printer or printers that can be the only candidates for printing the job.
The destination logical printer must contain the specified job's physical-printers-requested values as values of its physical-printers-supported attribute.
Initial-value-job
Job
Multi-value
Yes
Text string of up to 255 characters
A.2.140 physical-printers-supported
Identifies the physical-printers supported on this object. See physical-printers-ready.
Queue
Server (spooler and supervisor)
Multi-value
No
Text string of up to 4095 characters
Indicates whether the page images should be conditioned for eventual one or two sided printing. In other words, printing that will take into account extra space for binding margins.
The attribute also specifies whether the relative orientation between consecutive page images is to be altered (as with tumble, or head-to-toe printing).
The print system supports this attribute only for certain printers. Ask your system administrator for details.
Destination logical and physical printers must contain the specified document's plex value as a value of their plexes-supported attribute.
Duplex and tumble are both two-sided printing. The difference between the two is (for portrait or landscape orientation):
For duplex, the binding edge is parallel to the y-axis
For tumble, the binding edge is parallel to the x-axis
Document
Initial-value-document
Single value
Yes
simplex
duplex
tumble
Identifies the plexes supported by this printer.
Printer (logical and physical)
Multi-value
Yes
simplex
duplex
tumble
Identifies the state of the job before the last state change.
Job
Single value
No
unknown, pre-processing, pending, processing, retained, held, paused, terminating, completed, printing
A supervisor-specific string that tells the supervisor how to connect to the printer.
Printer (physical only)
Single value
Yes
Text string or number greater than 0
A.2.145 printer-associated-host
Identifies the host name of a direct-connected physical printer.
Printer (physical)
Single
Yes
Test string
A.2.146 printer-associated-printers
Identifies the physical/logical printers associated with this logical/physical printer. This attribute is updated when the printer's associated-queue attribute is modified. It is checked for end-to-end consistency when the printer is enabled.
Printer (logical and physical)
Multi-value
No
Text string of up to 4095 characters
Baud rate for the connected printer.
Printer (physical only)
Single value
Yes
300, 1200, 2400, 4800, 9600, 19200, 38400
A.2.148 printer-connection-level
Indicates the level of connectivity supported by the connected printer.
Printer (physical only)
Single value
Yes
0 = Not specified (use system default)
1 = Output only data (unidirectional)
2 = Output only data (status bits returned)
3 = Bidirectional (without synchronized session control)
4 = Bidirectional (with synchronized session control)
5 = Printer session control
A.2.149 printer-connection-method
Indicates how a printer is attached to a server host.
Printer (physical only)
Single value
Yes
serial, parallel, ip-socket, bsd, digital-printserver
A.2.150 printer-connection-methods-supported
Indicates the connection methods supported by the connected printer.
Server (supervisor only)
Multi-value
No
serial, parallel, ip-socket, bsd, digital-printserver
Stores the date and time when a printer object is created.
Printer
Single value
No
Generalized time
Identifies the data bits for the connected printer.
Printer (physical only)
Single value
Yes
5, 6, 7, 8
A.2.153 printer-initial-value-document
Identifies an initial-value-document in the server for use on this logical printer.
This attribute is used when the document does not specify an
initial-value-document
.
Printer (logical only)
Single value
Yes
A.2.154 printer-initial-value-job
Identifies an initial-value-job in the server for use on this logical printer.
The printer-initial-value-job is used if the job does not specify an initial-value-job.
Printer (logical only)
Single value
Yes
A.2.155 printer-input-flow-control
Indicates the type of input flow control used by the connected printer.
Printer (physical only)
Single value
Yes
none, xoff, cts, dtr
Identifies the location of the printer.
Printer (physical only)
Multi-value
Yes
Text string of up to 4095 characters
Identifies the make and model of the printer.
Printer (physical only)
Single value
Yes (only at printer creation)
Text string of up to 4095 characters
A.2.158 printer-multiple-copy-mode
Allows multiple copies of a document. This setting should only be used with printers that have a hard disk that can store the entire contents of a document. When set false, or not defined (the default), the supervisor sends document data to the printer for each requested copy.
Printer (physical)
Single value
Yes
Boolean
Specifies a unique name for a printer.
Printer (logical and physical)
Single value
Yes (only at printer creation)
Text string of up to 255 characters
A.2.160 printer-name-requested
Identifies the logical printer to which you are submitting a job. You may specify a logical printer via this attribute or via the -p switch in the pdpr command.
If you do not specify the -p switch, pdpr uses the logical printer identified by the value of the printer-name-requested attribute. If printer-name-requested is also not specified, pdpr uses the logical printer identified with the PDPRINTER environment variable.
If you specify both -p and printer-name-requested on the command line, pdpr uses the last logical printer name specified in the command line syntax.
If job start sheets are in use via the job-sheets attribute, the value of the printer-name-requested attribute prints on job start sheets.
Job
Single value
Yes (only at job submission)
Text string of up to 255 characters
A.2.161 printer-output-flow-control
Identifies the output flow control used by the connected printer.
Printer (physical only)
Single value
Yes
none, xoff, cts, dtr
Identifies the parity used by the connected printer.
Printer (physical only)
Single value
Yes
none, even, odd, mark, space
A.2.163 printer-problem-message
Contains a message describing a problem. Use only with printers that produce a text string when there is a problem.
Printer (logical and physical)
Single value
No
Text
Identifies if the printer is logical or physical. A printer created on a spooler is logical. A printer created on a supervisor is physical.
Printer (logical and physical)
Single value
No
logical
physical
Specifies a named module to be sent to the printer prior to printing the document. The module typically contains printer setup commands.
Document
Initial-value-document
Multi-value
Yes
Test string
Identifies the current state of the printer.
Printer (logical and physical)
Single value
No
unknown, idle, printing, needs-attention, paused, shutdown, timed-out, connecting-to-printer
Identifies the stop bits used by the connected printer.
Printer (physical only)
Single value
Yes
0, 1, 2
A.2.168 printer-tcpip-port-number
Identifies the port number that the connected printer uses on a TCP/ IP socket connection.
Printer (physical only)
Single value
Yes
1024 through 65535
A.2.169 printer-timeout-period
Identifies the time period (in seconds) for which the server waits for a response from a printer before setting the printer's printer-state attribute to timed-out.
Although the printer-timeout-period attribute does not have a default value, the reference supervisor uses 300 seconds if no value has been specified. If an administrator enters 0 for the attribute value, then the supervisor does not monitor input/output activity on the printer.
Printer (physical only)
Single value
Yes
Values entered in the format [HH:]mm[:SS]
Indicates the physical printer to which the job was assigned. This attribute is set by the spooler at the time the job is sent to the supervisor.
If job start sheets are in use via the job-sheets attribute, the value of the printers-assigned attribute prints on job start sheets.
Job
Single value
No
Text string of up to 4095 characters
Identifies the logical/physical printers ready to be used on this physical/logical printer.
When you enable a logical printer with the pdenable operation, the associated spooler adds the name of the logical printer to the printers-ready attribute for all associated physical printers.
Printer (logical and physical)
Multi-value
No
Text string of up to 4095 characters
A.2.172 queue-backlog-lower-limit
Lower bound limit for backlogged queue. When the number of pending jobs decreases to match the specified value of the lower bound limit, the queue is declared not backlogged, and the report-queue-not-backlogged event is generated.
Queue
Single value
Yes
Integer
A.2.173 queue-backlog-upper-limit
Upper bound limit for backlogged queue. When the number of pending jobs increases to match the specified value of the upper bound limit, the queue is declared backlogged, and the warning-queue-backlogged event is generated.
Queue
Single value
Yes
Integer
A.2.174 queue-backlogged-queue
Indicates whether a queue should be declared as disabled (unavailable) when backlogged.
Queue
Identifies the name of the queue
Queue
Single value
Yes (only at queue creation)
Text string of up to 255 characters
Contains a message that indicates when a queue is backlogged.
Queue
Single
No
Text string
Lists the queues supported by the spooler. Automatically updated by creation and deletion of queues.
Server (spooler only)
Multi-value
No
Text string of up to 255 characters
Provides more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the number of character spaces between tab stops.
Because of its use with simple-text format, repeated-tab-stops is typically part of a simple-text translation filter as defined with the attribute filter-definition.
Document
Initial-value-document
Single value
Yes
Number greater than 0
Identifies the attributes that should be included in an operation.
N/A
Multi-value
Yes
Indicates whether the printer should be reset between documents within a job (the printer is always reset between jobs).
This attribute causes the reset sequence to be sent to the printer after the document with which it is associated. For example, to condition a PostScript printer with font data, use a command such as the following:
pdpr -p lp1 -x "reset-printer=no" -f fonts.dat -x "reset-printer=yes" file.ps
Printing document auxiliary sheets requires a printer reset. So, if the job has a value for the attribute document-sheets, the printer will always be reset between documents regardless of the value of reset-printer.
Also, attributes that would cause the printer to be reconfigured (such as sides, default-input-tray, and output-bin) also require that the printer be reset. Therefore, if the document following a document with reset-printer=no specifies document attributes that are different, the server ignores the reset.
Document
Initial-value-document
Single value
Yes
true|yes
false|no
The results-profile attribute is supported but cannot be directly specified by a user. Instead, the following two client attributes are available for specifying results-profile:
job-copies (default=1)
output-bin (no default)
The supported client attributes are visible to the user; results-profile is not.
Initial-value-job
Job
Multi-value
Yes (only via job-copies and output-bin attributes)
Specifies the amount of time a server should keep a job in the retained state after the job has been terminated. This is the equivalent of the job object attribute job-retention-period.
N/A
Single value
Yes
Provides more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the distance in characters between the right edge of the logical page and the right edge of the text area when held in the intended reading position.
(Some document formats, such as PostScript, specify the margin as part of the document content; simple-text does not.)
The value right-margin=12 specifies a right margin of twelve characters. The actual distance is dependent on the size of the character set specified for the document.
Because of its use with simple-text format, right-margin is typically part of a simple-text translation filter as defined with the attribute filter-definition.
Document
Initial-value-document
Single value
Yes
Any positive number
Indicates whether document attributes are to be included on a job attributes list operation.
N/A
Single value
Yes
0 = List only job attributes
1 = List job and document attributes
Contains the name of the server host. If the server is running on a cluster, this attribute holds the default cluster alias.
Server
Single value
No
Text string of up to 255 characters
Contains the name of the server host. If the server is running on a cluster, this attribute holds the default cluster alias.
Server (spooler and supervisor)
Single value
No
Text string of up to 255 characters
Identifies a server. An administrator specifies the server name when creating the server. Once the server name is specified, the system does not allow any user to change it.
Server (spooler and supervisor)
Single value
Yes (only at server creation)
Text string of up to 255 characters
Specifies the current state of the specified server.
Server (spooler and supervisor)
Single value
No
ready
paused
terminating
Specifies the type of server.
Server (spooler and supervisor)
Single value
No
spooler, supervisor, notification-server, proto-server
Specifies if the job should be printed on one or two sides of the paper.
The default is determined by the printer.
Destination logical and physical printers must contain the value of the specified document's sides attribute as a value of their sides-supported attribute. The physical printer must also contain the value of the specified document's sides attribute as a value of its sides-ready attribute.
Document
Initial-value-document
Single value
Yes
1
2
Indicates the values of sides ready on this printer.
The sides-ready attribute must contain a value corresponding to the value of the sides attribute of a document to be printed on this printer. The default is determined by the printer.
Printer (physical only)
Multi-value
Yes
1
2
Indicates the values of sides supported by this printer.
The sides-supported attribute must contain a value corresponding to the value of the sides attribute of a document submitted to this printer. The default is determined by the printer.
Printer (logical and physical)
Multi-value
Yes
1
2
Indicates the time at which this job started printing.
Job
Single value
No
Identifies the current state of the queue.
Queue
Single value
No
ready
paused
Indicates the format in which data specified with the
-r
requested_attributes
option is written to standard output.
N/A
Single value
Yes
column
line
Indicates the time at which the latest print request for this job was submitted. This value is changed by pdresubmit.
If job start sheets are in use via the job-sheets attribute, the value of the submission-time attribute prints on job start sheets.
Job
Single value
No
A.2.197 thickening-specification
Sets the darkening parameter for the entire document or for bitmap images in the document.
Destination logical and physical printers must contain the specified document's thickening-specification value as a value of their thickening-supported attribute.
Document
Initial-value-document
Single value
Yes
entire-document
bitmap-images
Indicates darkening specification algorithms supported on this printer.
The thickening-supported attribute must contain a value corresponding to the value of the thickening-specification attribute of a document submitted to this printer.
Printer (logical and physical)
Multi-value
Yes
entire-document
bitmap-images
Specifies the frequency in seconds in which
pdls
writes output.
N/A
Single value
Yes
Provides more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the distance in lines between the top edge of the logical page and the top edge of the text area when held in the intended reading orientation.
(Some document formats, such as PostScript, specify the margin as part of the document content; simple-text does not.)
The value top-margin=6 specifies a top margin of six character lines. The actual distance is dependent on the size of the character set specified for the document.
Because of its use with simple-text format, top-margin is typically part of a simple-text translation filter as defined with the attribute filter-definition.
Document
Initial-value-document
Single value
Yes
Any negative or positive number
Indicates the size of the job in bytes (including copies). This is computed by the spooler from the document attribute octet-count.
Job
Single value
No
Indicates how the document will be transferred to or acquired by the server.
Document
Single value
Yes (only at job submission)
with-request, socket, file-transfer
A.2.203 transfer-methods-supported
Indicates the transfer methods supported by the server.
Server (spooler and supervisor)
Multi-value
No
with-request, socket, file-reference
Overrides the automatic invocation of a translation filter.
Document
Single value
Yes
Specifies the name of the user requesting access to print service operations.
As part of the authentication process, the spooler compares a user's name against entries in the spooler's access-control-list attribute. On a print operation, the spooler writes the user name that it retrieved during authentication into the job's user-name attribute.
Job
Single value
No
Text string of up to 4095 characters
Specifies how much processing can occur before a server can shut down.
N/A
Single value
Yes
now
after-current
after-all
Provides more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the width of the text area in characters. This is the maximum line width before wrapping.
(Some document formats, such as PostScript, specify the margin as part of the document content; simple-text does not.)
The value width=80 specifies a text area width of eighty characters.
Because of its use with simple-text format, width is typically part of a simple-text translation filter as defined with the attribute filter-definition.
Document
Initial-value-document
Single value
Yes
Any positive number
Causes page images to be shifted in position with respect to the medium on which the page images are to be rendered. The direction of shift is parallel to the x-axis of the Reference Coordinate System (RCS).
The attribute enables requests for a different margin, possibly to correct a misalignment.
The print system supports this attribute only for certain printers. Ask your system administrator for details.
The physical and logical printer attribute x-image-shift-range-supported identifies the range supported by the printer.
The sign of the attribute value indicates the direction of shift. A positive value indicates that the shift is in the positive x- direction. A negative value indicates that the shift is in the negative x- direction. The shift direction is the same for all pages, regardless of the value of the plex attribute.
Document
Initial-value-document
Single value
Yes
Any negative or positive number
A.2.209 x-image-shift-range-supported
Identifies the x-image-shift range supported by the printer.
The print system supports this attribute only for certain printers. Ask your system administrator for details.
Printer (logical and physical)
Single value
Yes
A range specified by any two negative or positive numbers
Causes page images to be shifted in position with respect to the medium on which the page images are to be rendered. The direction of shift is parallel to the y-axis of the Reference Coordinate System (RCS).
The attribute enables requests for a different margin, possibly to correct a misalignment.
The print system supports this attribute only for certain printers. Ask your system administrator for details.
The physical and logical printer attribute y-image-shift-range-supported identifies the range supported by the printer.
The sign of the attribute value indicates the direction of shift. A positive value indicates that the shift is in the positive y- direction. A negative value indicates that the shift is in the negative y- direction. The shift direction is the same for all pages, regardless of the value of the plex attribute.
Document
Initial-value-document
Single value
Yes
Any negative or positive number
A.2.211 y-image-shift-range-supported
Identifies the y-image-shift range supported by the printer.
The print system supports this attribute only for certain printers. Ask your system administrator for details.
Printer (logical and physical)
Single value
Yes
A range specified by any two negative or positive numbers