A    Attributes

This appendix provides a description of all attributes supported by the print system. The appendix includes:

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

access-control-list *
availability
cancel-individual-document-supported
cfg-prologue-path*
configuration-attributes-visible *
conformance-levels-supported
descriptor *
enabled * (settable via pdenable/pddisable)
events-supported
file-reference-is-local-only
job-attributes-visible-to-all *
job-completion-period
locale
locales-supported
message
modify-individual-document-supported
multiple-documents-supported
notification-delivery-methods-ready
notification-delivery-methods-supported
notification-profile *
object-class
object-classes-supported
physical-printers-ready
physical-printers-supported
server-cluster-member
server-hostname
server-name
server-state
server-type
transfer-methods-supported

Spooler Attributes

hold-jobs-interrupted-by-printer-failure *
logical-printers-ready
logical-printers-supported
queues-supported

Supervisor Attributes

filter-definition *
maximum-number-of-printers-supported
number-of-printers-supported *

Logical and Physical Printer Attributes

associated-queue *
associated-server
availability
binding-edges-supported *
character-sets-supported *
content-orientations-supported *
descriptor *
document-formats-supported *
document-sheets-supported *
enabled * (settable via pdenable/pddisable)
extended-lpd-job-identifiers
finishings-supported *
fonts-supported *
highlight-colour-rendering-algorithms-supported *
highlight-colours-supported *
highlight-mapping-colours-supported *
input-trays-supported *
job-sheets-supported *
maximum-copies-supported *
media-supported *
message *
notification-profile *
numbers-up-supported *
object-class
output-bins-supported *
outputs-supported *
page-select-supported *
plexes-supported *
printer-associated-printers
printer-name * (settable only at printer creation)
printer-problem-message
printer-realization
printer-state
printers-ready
sides-supported *
thickening-supported *
x-image-shift-range-supported *
y-image-shift-range-supported *

Logical Printer Attributes

default-user-job-priority*
max-user-job-priority*
printer-creation-time
printer-initial-value-document *
printer-initial-value-job *

Physical Printer Attributes

bsd-printer-name *
character-sets-ready *
document-formats-ready *
document-sheets-ready
excluded-filters *
extended-lpd-job-identifiers
finishings-ready *
fonts-ready *
highlight-colours-ready *
input-trays-medium *
input-trays-ready *
job-sheets-ready *
maximum-printer-speed *
media-ready *
native-document-formats-ready *
output-bins-ready *
outputs-ready *
printer-address *
printer-associated-host*
printer-baud-rate *
printer-connection-level *
printer-connection-method *
printer-data-bits *
printer-input-flow-control *
printer-locations *
printer-model * (settable only at printer creation)
printer-multiple-copy-mode*
printer-output-flow-control *
printer-parity *
printer-stop-bits *
printer-tcpip-port-number *
printer-timeout-period *
sides-ready *

Queue Attributes

Settable attributes are indicated with an asterisk (*).
associated-server
availability
descriptor *
disable-backlogged-queue*
enabled * (settable via pdenable/pddisable)
logical-printers-ready
logical-printers-supported
message *
notification-profile *
object-class
physical-printers-ready
physical-printers-supported
queue-backlog-lower-limit*
queue-backlog-upper-limit*
queue-name * (settable only at queue creation)
queue-problem-message
state

Job Attributes

assigned-queue
completion-time
current-job-state
document-sheets *
initial-value-job * (settable only at job submission)
intervening-jobs
job-comment *
job-copies *
job-copies-completed
job-discard-time *
job-fault-count
job-hold *
job-identifier
job-identifier-on-client * (settable only at job submission)
job-identifier-on-printer
job-message-from-administrator *
job-name *
job-originating-host
job-originator *
job-owner * (settable only at job submission)
job-print-after *
job-priority
job-promote-time
job-retention-period *
job-sheets *
job-state-message
job-state-reasons
job-submission-complete
notification-profile *
number-of-documents
object-class
output-bin *
physical-printers-requested *
previous-job-state
printer-name-requested * (settable only at job submission)
printers-assigned
results-profile * (settable via job-copies and output-bin attributes)
started-printing-time
submission-time
total-job-octets
user-name

Document Attributes

additional-production-instructions
binding-edge *
bottom-margin *
content-orientation *
copy-count *
default-character-set *
default-font *
default-input-tray *
default-medium *
document-file-name * (For a document object, settable only at job submission.)
document-format *
document-name *
document-sequence-number
document-state
finishing *
footer-text *
header-text *
highlight-colour *
highlight-colour-mismatch-action *
highlight-colour-rendering-algorithm *
highlight-mapping-colour *
initial-value-document * (settable only at job submission)
left-margin *
length *
modification-filter *
no-filtering *
number-pages *
number-up *
object-class
octet-count
output *
page-media-select *
page-order-received *
page-select *
plex *
printer-setup-module*
repeated-tab-stops *
reset-printer *
right-margin *
sides *
thickening-specification *
top-margin *
transfer-method * (settable only at job submission)
translation-filter *
width *
x-image-shift *
y-image-shift *

Initial Value Job Attributes

associated-server
descriptor *
document-sheets *
initial-value-job-identifier * (settable only at initial-value-job creation)
job-comment *
job-copies *
job-discard-time *
job-hold *
job-name *
job-print-after *
job-priority*
job-retention-period *
job-sheets *
message *
object-class
output-bin *
physical-printers-requested *
results-profile * (settable via job-copies and output-bin attributes)

Initial Value Document Attributes

associated-server
binding-edge *
bottom-margin *
content-orientation *
copy-count *
default-character-set *
default-font *
default-input-tray *
default-medium *
descriptor *
document-file-name * (For an initial-value-document object, settable only at initial-value-document creation or modification.)
document-format *
document-name *
finishing *
footer-text *
header-text *
highlight-colour *
highlight-colour-mismatch-action *
highlight-colour-rendering-algorithm *
highlight-mapping-colour *
initial-value-document-identifier * (settable only at initial-value-document creation)
left-margin *
length *
message *
number-pages *
number-up *
object-class
output *
page-media-select *
page-order-received *
page-select *
plex *
printer-setup-module*
repeated-tab-stops *
reset-printer *
right-margin *
sides *
thickening-specification *
top-margin *
width *
x-image-shift *
y-image-shift *

A.2    Attribute Descriptions

This directory contains a detailed description of every print system attribute. For each attribute, the following information is included:

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:

A.2.1    access-control-list

The access-control-list attribute specifies the privilege level of specified authorized print system users within and across domains.

Objects

Server (spooler and supervisor)

M/S

Multi-value

Settable

Yes

Valid values

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

Default value

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.

Objects

Document

M/S

Single value

Settable

Yes

Valid Values

Text string of up to 255 characters

A.2.3    assigned-queue

The queue to which the spooler assigned the job.

Objects

Job

M/S

Single value

Settable

No

Valid values

Text string of up to 255 characters

A.2.4    associated-queue

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.

Objects

Printer (logical and physical)

M/S

Single value

Settable

Yes

Valid values

Text string of up to 255 characters

A.2.5    associated-server

Name of the server with which the object is associated. It is set by object when it is created.

Objects

Initial-value-document

Initial-value-job

Printer (logical and physical)

Queue

M/S

Single value

Settable

No

Valid values

Text string of up to 4095 characters

A.2.6    attributes

This client attribute identifies one or more attributes that are to be included in an operation.

Objects

N/A

M/S

Multi-value

Settable

Yes

Valid values

Text string of up to 255 characters

A.2.7    availability

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.

Objects

Printer (logical and physical)

Queue

Server (spooler and supervisor)

M/S

Single value

Settable

No

Valid values

Normal

None (not available)

A.2.8    binding-edge

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Bottom-edge

Right-edge

Top-edge

Left-edge

A.2.9    binding-edges-supported

Identifies the binding-edge values supported by this printer.

Refer to the binding-edge attribute description for additional information.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

Bottom-edge

Right-edge

Top-edge

left-edge

A.2.10    bottom-margin

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Any positive number

A.2.11    cancel-individual-document-supported

Indicates if the server can cancel printing of an individual document within a job.

Objects

Server (spooler and supervisor)

M/S

Single value

Settable

No

Valid values

False or no

A.2.12    cfg-prologue-path

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.

Objects

Server (supervisor)

Printer (physical)

M/S

Single value

Settable

Yes

Valid values

Text string

A.2.13    character-sets-ready

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.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

See the default-character-set attribute

A.2.15    class

This client attribute identifies the object class of the operand.

Objects

N/A

M/S

Single value

Settable

Yes

Valid values

A.2.16    completion-time

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.

Objects

Job

M/S

Single value

Settable

No

Valid values

A.2.17    conformance-levels-supported

Specifies the conformance levels supported.

Objects

Server (spooler and supervisor)

M/S

Multi-value

Settable

No

Valid values

level-2M

A.2.18    content-orientation

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

Portrait

Landscape

Reverse-portrait

Reverse-landscape

A.2.20    copy-count

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Number greater than 1

A.2.21    copy-from

Causes the server to create a new object that is identical to an existing one specified in the copy-from attribute

Objects

Printer, queue, initial-value-job, initial-value-document

M/S

Single value

Settable

N/A

Valid values

Name of existing object of same class

A.2.22    count-limit

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.

Objects

N/A

M/S

Single value

Settable

Yes

Valid values

Number greater than 1

A.2.23    current-job-state

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.

Objects

Job

M/S

Single value

Settable

No

Valid values

Completed, printing, held, processing, paused, retained, pending, terminating, preprocessing, and unknown.

A.2.24    default-character-set

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

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

A.2.25    default-font

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Text string of up to 255 characters

A.2.26    default-input-tray

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Top, middle, bottom, envelope, manual, large-capacity, main, side

A.2.27    default-medium

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

See table

Table A-3:  default-medium

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.

Objects

Printer (logical)

M/S

Single value

Settable

Yes

Valid values

Integer values 1-100

A.2.29    descriptor

Supplies a textual description of the specified object.

Objects

Initial-value-document

Initial-value-job

Printer (logical and physical)

Queue

Server (spooler and supervisor)

M/S

Single value

Settable

Yes

Valid values

Text string of up to 4095 characters

A.2.30    disable-backlogged-queue

Indicates whether a queue is declared disabled when backlogged.

Objects

Queue

M/S

Single value

Settable

Yes

Valid values

Boolean (true or false)

A.2.31    document-file-name

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes (For a document object, only at job submission. For an initial-value-document object, only at initial-value-document creation or modification.)

Valid values

Text string of up to 4095 characters

Comments

A.2.32    document-filename

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.

Objects

N/A

M/S

Single value

Settable

Yes

Valid values

Text string of up to 4095 characters

A.2.33    document-format

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).

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

See table

Table A-4:  document-format

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 PDF

A.2.34    document-formats-ready

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.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

See document-format attribute description

A.2.36    document-name

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Text string of up to 255 characters

A.2.37    document-sequence-number

Specifies the sequence number of this document within a job.

Objects

Document

M/S

Single value

Settable

No

Valid values

Number equal to or greater than 0

A.2.38    document-sheets

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.

Objects

Initial-value-job

Job

M/S

Single value

Settable

Yes

Valid values

None

doc-set-start-copies-separate

A.2.39    document-sheets-ready

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.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

None

doc-set-start-copies-separate

A.2.41    document-state

Identifies the state of the document.

Objects

Document

M/S

Single value

Settable

No

Valid values

Transfer-pending, pending, processing, completed, printing

A.2.42    enabled

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.

Objects

Printer (logical and physical)

Queue

Server (spooler and supervisor)

M/S

Single value

Settable

Yes (via pdenable and pddisable)

Valid values

True or yes (enabled)

False or no (disabled)

A.2.43    events-supported

Specifies the event types and event classes supported by the server.

Objects

Server (spooler and supervisor)

M/S

Multi-value

Settable

No

Valid values

Refer to Appendix C for a list of valid values.

A.2.44    excluded-filters

Disallows the use of certain translation filters for a particular printer.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

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.

Objects

Printer (physical)

M/S

Single

Settable

Yes

Valid values

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.

Objects

Server (spooler and supervisor)

M/S

Single value

Settable

No

Valid values

True or yes

A.2.47    filter

Specifies the selection criteria to be used among candidate object_instances in the operand.

Objects

N/A

M/S

Single value

Settable

Yes

Valid values

Text string

Comments

A.2.48    filter-definition

Defines a program as a filter and contains the information needed to invoke the program.

Objects

Server (supervisor only)

M/S

Multi-value

Settable

Yes

Valid values

See table

A.2.49    finishing

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Table A-5:  finishing

Values
bind staple
cover staple-bottom-left
edge-stitch staple-bottom-right
punch staple-top-left
saddle-stitch staple-top-right

A.2.50    finishings-ready

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.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

See finishing table

A.2.51    finishings-supported

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

See finishing table

A.2.52    fonts-ready

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.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

Text string of up to 255 characters

A.2.53    fonts-supported

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

Text string of up to 255 characters

A.2.54    footer-text

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

A.2.55    header-text

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Text string of up to 4095 characters

A.2.56    headings

Specifies whether column headings should be included on output of requested attributes.

Objects

N/A

M/S

Single value

Settable

Yes

Valid values

False or no

True or yes

A.2.57    highlight-colour

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

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:

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:

When no value is specified, the spooler:

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

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.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

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.

Objects

Printer (logical only)

Server (spooler only)

M/S

Single value

Settable

Yes

Valid values

True or yes

False or no

A.2.66    initial-value-document

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.

Objects

Document

M/S

Single value

Settable

Yes (only at job submission)

Valid values

Name of existing initial-value-document

A.2.67    initial-value-document-identifier

Uniquely identifies an initial-value-document object.

Objects

Initial-value-document

M/S

Single value

Settable

Yes (only at initial-value-document creation)

Valid values

A.2.68    initial-value-job

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.

Objects

Job

M/S

Single value

Settable

Yes (only at job submission)

Valid values

Name of existing initial-value-job

A.2.69    initial-value-job-identifier

Uniquely identifies an initial-value-job object.

Objects

Initial-value-job

M/S

Single value

Settable

Yes (only at initial-value-job creation)

Valid values

A.2.70    input-trays-medium

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"

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

For input tray: Top, middle, bottom, envelope, manual, large-capacity, main, side

For medium: Refer to the valid values of the default-medium attribute.

A.2.71    input-trays-ready

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.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

Top, middle, bottom, envelope, manual, large-capacity, main, side

A.2.72    input-trays-supported

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

Top, middle, bottom, envelope, manual, large-capacity, main, side

A.2.73    intervening-jobs

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.

Objects

Job

M/S

Single value

Settable

No

Valid values

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.

Objects

Server (spooler and supervisor)

M/S

Multi-value

Settable

Yes

Valid values

A.2.75    job-comment

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.

Objects

Initial-value-job

Job

M/S

Single value

Settable

Yes

Valid values

A.2.76    job-completion-period

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.

Objects

Server (spooler)

M/S

Single value

Settable

Yes

Valid Values

Delta time

A.2.77    job-copies

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.

Objects

Initial-value-job

Job

M/S

Single value

Settable

Yes

Valid values

Number greater than 1

A.2.78    job-copies-completed

Indicates the number of job copies that have been printed.

Objects

Job

M/S

Single value

Settable

No

Valid values

Number equal to or greater than 0

A.2.79    job-discard-time

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

Objects

Initial-value-job

Job

M/S

Single value

Settable

Yes

Valid values

Values entered in the format dd:mm:yyyy:HH:MM:SS

A.2.80    job-fault-count

Indicates the number of times the job is returned by the supervisor due to a crash of the spooler or supervisor.

Objects

Job

M/S

Single value

Settable

No

Valid values

Number equal to or greater than 0

A.2.81    job-hold

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:

If the job-hold attribute is set to true or yes, it remains on hold indefinitely until one of following events takes place:

Objects

Initial-value-job

Job

M/S

Single value

Settable

Yes

Valid values

True or yes

False or no

A.2.82    job-identifier

A spooler-generated value unique to the spooler (not necessarily unique in a distributed environment).

Objects

Job

M/S

Single value

Settable

No

Valid values

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.

Objects

Job

M/S

Single value

Settable

Yes (only at job submission)

Valid values

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.

Objects

Job

M/S

Single value

Settable

Yes

Valid values

Text string of up to 4095 characters

A.2.85    job-name

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.

Objects

Initial-value-job

Job

M/S

Single value

Settable

Yes

Valid values

Text string of up to 255 characters

A.2.86    job-originating-host

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.

Objects

Job

M/S

Single value

Settable

No

Valid values

Text string of up to 255 characters

A.2.87    job-originator

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.

Objects

Job

M/S

Single value

Settable

Yes

Valid values

Text string of up to 4095 characters

A.2.88    job-owner

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.

Objects

Job

M/S

Single value

Settable

Yes (only at job submission)

Valid values

Text string of up to 4095 characters

A.2.89    job-priority

Specifies a print job scheduling priority value. Jobs with higher priorities are scheduled to print before jobs with lower priorities.

Objects

Job

Initial-value-job

M/S

Single value

Settable

Yes

Valid values

Integer values 1-100

A.2.90    job-print-after

Specifies the calendar date and time after which the job can be scheduled. If the date is in the future:

When the specified time has passed:

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

Objects

Initial-value-job

Job

M/S

Single value

Settable

Yes

Valid values

Values entered in the format dd:mm:yyyy:HH:MM:SS

A.2.91    job-promote-time

The time when the job was promoted.

Objects

Job

M/S

Single value

Settable

No

Valid values

A.2.92    job-retention-period

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.

Objects

Initial-value-job

Job

M/S

Single value

Settable

Yes

Valid values

Values entered in the format [HH:]mm[:SS]

A.2.93    job-sheets

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.

Objects

Initial-value-job

Job

M/S

Single value

Settable

Yes

Valid values

none

job-copy-start

job-copy-wrap

A.2.94    job-sheets-ready

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.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

none

job-copy-start

job-copy-wrap

A.2.95    job-sheets-supported

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

none

job-copy-start

job-copy-wrap

A.2.96    job-state-message

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.

Objects

Job

M/S

Single value

Settable

No

Valid values

See table

A.2.97    job-state-reasons

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.

Objects

Job

M/S

Multi-value

Settable

No

Valid values

Table A-6:  job-state-reasons

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.

Objects

Job

M/S

Single value

Settable

No

Valid values

True or yes

False or no

A.2.99    left-margin

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Any positive number

A.2.100    length

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 .

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Any positive number

A.2.101    locale

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.

Objects

Server (spooler and supervisor)

M/S

Single value

Settable

No

Valid values

A.2.102    locales-supported

Contains the list of locales supported by the server.

Objects

Server (spooler and supervisor)

M/S

Multi-value

Settable

No

Valid values

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.

Objects

Queue

Server (spooler only)

M/S

Multi-value

Settable

No

Valid values

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.

Objects

Queue

Server (spooler only)

M/S

Multi-value

Settable

No

Valid values

Text string of up to 4095 characters

A.2.105    max-user-job-priority

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.

Objects

Printer (logical)

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Printer (logical and physical)

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Server (supervisor only)

M/S

Single value

Settable

No

Valid values

Number equal to or greater than 0

A.2.108    maximum-printer-speed

Specifies the maximum speed of the printer in pages per minute.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid values

Number greater than 1

A.2.109    media-ready

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.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

See default-medium

A.2.110    media-supported

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

See default-medium

A.2.111    message

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.

Objects

Initial-value-document

Initial-value-job

Printer (logical and physical)

Queue

Server (spooler and supervisor)

M/S

Single value

Settable

Yes

Valid values

Text string of up to 4095 characters

A.2.112    modification-filter

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.

Objects

Document

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Server (spooler and supervisor)

M/S

Single value

Settable

No

Valid values

True or yes

False or no

A.2.114    multiple-documents-supported

Indicates if the object is capable of handling multiple document jobs.

Objects

Server (spooler and supervisor)

M/S

Single value

Settable

No

Valid values

True or yes

False or no

A.2.115    native-document-formats-ready

Identifies the document formats supported directly by printer hardware.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

A.2.116    no-filtering

Disables translation and modification filtering.

Objects

Document

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Server (spooler and supervisor)

M/S

Multi-value

Settable

No

Valid values

electronic-mail

notification-service

A.2.118    notification-delivery-methods-supported

Identifies the delivery methods supported on this object for event notification.

Objects

Server (spooler and supervisor)

M/S

Multi-value

Settable

No

Valid values

electronic-mail

notification-service

A.2.119    notification-profile

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.

Objects

Job

Printer (logical and physical)

Queue

Server (spooler and supervisor)

M/S

Multi-value

Settable

Yes

Valid values

A.2.120    number-of-documents

Indicates the number of documents in the job.

Objects

Job

M/S

Single value

Settable

No

Valid values

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.

Objects

Server (supervisor only)

M/S

Single value

Settable

Yes

Valid values

Number equal to or greater than 0

A.2.122    number-pages

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

True or yes

False or no

A.2.123    number-up

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).

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

0

1

2

4

A.2.124    numbers-up-supported

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

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

none or 0

simple-1-up or 1

simple-2-up or 2

simple-4-up or 4

A.2.125    object-class

Identifies the object class for this object.

Objects

Document

Initial-value-document

Initial-value-job

Job

Printer (logical and physical)

Queue

Server (spooler and supervisor)

M/S

Single value

Settable

No

Valid values

A.2.126    object-classes-supported

Identifies the object classes supported by this server.

Objects

Server (spooler and supervisor)

M/S

Multi-value

Settable

No

Valid values

A.2.127    octet-count

Specifies the size of the document in octets.

Objects

Document

M/S

Single value

Settable

No

Valid values

A.2.128    output

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Page-collate, no-page-collate, decollate, no-decollate, burst, no-burst, stacking-default

A.2.129    output-bin

Specifies the printer output bin into which the job is placed.

Objects

Initial-value-job

Job

M/S

Single value

Settable

Yes

Valid values

Top, middle, bottom, side, face-up, left, right, large, private, face-down, collator

A.2.130    output-bins-ready

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.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid values

Top, middle, bottom, side, face-up, left, right, large, private, face-down, collator

A.2.131    output-bins-supported

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.

Objects

Printer (logical and physical)

M/S

Single value

Settable

Yes

Valid values

Top, middle, bottom, side, face-up, left, right, large, private, face-down, collator

A.2.132    outputs-ready

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.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

no-page-collate

A.2.133    outputs-supported

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

no-page-collate

A.2.134    page-media-select

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

A.2.135    page-order-received

Specifies the page order for which pages in the document have been formatted.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

unknown

first-to-last

last-to-first

A.2.136    page-select

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:

The syntax allows page range selections.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

numeric

alphanumeric

A.2.137    page-select-supported

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

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.

Objects

Queue

Server (spooler and supervisor)

M/S

Multi-value

Settable

No

Valid values

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.

Objects

Initial-value-job

Job

M/S

Multi-value

Settable

Yes

Valid values

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.

Objects

Queue

Server (spooler and supervisor)

M/S

Multi-value

Settable

No

Valid values

Text string of up to 4095 characters

A.2.141    plex

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):

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

simplex

duplex

tumble

A.2.142    plexes-supported

Identifies the plexes supported by this printer.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

simplex

duplex

tumble

A.2.143    previous-job-state

Identifies the state of the job before the last state change.

Objects

Job

M/S

Single value

Settable

No

Valid values

unknown, pre-processing, pending, processing, retained, held, paused, terminating, completed, printing

A.2.144    printer-address

A supervisor-specific string that tells the supervisor how to connect to the printer.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid values

Text string or number greater than 0

A.2.145    printer-associated-host

Identifies the host name of a direct-connected physical printer.

Objects

Printer (physical)

M/S

Single

Settable

Yes

Valid Value

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

No

Valid values

Text string of up to 4095 characters

A.2.147    printer-baud-rate

Baud rate for the connected printer.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid values

300, 1200, 2400, 4800, 9600, 19200, 38400

A.2.148    printer-connection-level

Indicates the level of connectivity supported by the connected printer.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid values

serial, parallel, ip-socket, bsd, digital-printserver

A.2.150    printer-connection-methods-supported

Indicates the connection methods supported by the connected printer.

Objects

Server (supervisor only)

M/S

Multi-value

Settable

No

Valid values

serial, parallel, ip-socket, bsd, digital-printserver

A.2.151    printer-creation-time

Stores the date and time when a printer object is created.

Objects

Printer

M/S

Single value

Settable

No

Valid Value

Generalized time

A.2.152    printer-data-bits

Identifies the data bits for the connected printer.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Printer (logical only)

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Printer (logical only)

M/S

Single value

Settable

Yes

Valid values

A.2.155    printer-input-flow-control

Indicates the type of input flow control used by the connected printer.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid values

none, xoff, cts, dtr

A.2.156    printer-locations

Identifies the location of the printer.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

Text string of up to 4095 characters

A.2.157    printer-model

Identifies the make and model of the printer.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes (only at printer creation)

Valid values

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.

Objects

Printer (physical)

M/S

Single value

Settable

Yes

Valid Value

Boolean

A.2.159    printer-name

Specifies a unique name for a printer.

Objects

Printer (logical and physical)

M/S

Single value

Settable

Yes (only at printer creation)

Valid values

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.

Objects

Job

M/S

Single value

Settable

Yes (only at job submission)

Valid values

Text string of up to 255 characters

A.2.161    printer-output-flow-control

Identifies the output flow control used by the connected printer.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid values

none, xoff, cts, dtr

A.2.162    printer-parity

Identifies the parity used by the connected printer.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Printer (logical and physical)

M/S

Single value

Settable

No

Valid values

Text

A.2.164    printer-realization

Identifies if the printer is logical or physical. A printer created on a spooler is logical. A printer created on a supervisor is physical.

Objects

Printer (logical and physical)

M/S

Single value

Settable

No

Valid values

logical

physical

A.2.165    printer-setup-module

Specifies a named module to be sent to the printer prior to printing the document. The module typically contains printer setup commands.

Objects

Document

Initial-value-document

M/S

Multi-value

Settable

Yes

Valid Value

Test string

A.2.166    printer-state

Identifies the current state of the printer.

Objects

Printer (logical and physical)

M/S

Single value

Settable

No

Valid values

unknown, idle, printing, needs-attention, paused, shutdown, timed-out, connecting-to-printer

A.2.167    printer-stop-bits

Identifies the stop bits used by the connected printer.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid Value

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.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Printer (physical only)

M/S

Single value

Settable

Yes

Valid values

Values entered in the format [HH:]mm[:SS]

A.2.170    printers-assigned

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.

Objects

Job

M/S

Single value

Settable

No

Valid values

Text string of up to 4095 characters

A.2.171    printers-ready

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

No

Valid values

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.

Objects

Queue

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Queue

M/S

Single value

Settable

Yes

Valid values

Integer

A.2.174    queue-backlogged-queue

Indicates whether a queue should be declared as disabled (unavailable) when backlogged.

Objects

Queue

M/S

Settable

Valid values

A.2.175    queue-name

Identifies the name of the queue

Objects

Queue

M/S

Single value

Settable

Yes (only at queue creation)

Valid values

Text string of up to 255 characters

A.2.176    queue-problem-message

Contains a message that indicates when a queue is backlogged.

Objects

Queue

M/S

Single

Settable

No

Valid values

Text string

A.2.177    queues-supported

Lists the queues supported by the spooler. Automatically updated by creation and deletion of queues.

Objects

Server (spooler only)

M/S

Multi-value

Settable

No

Valid values

Text string of up to 255 characters

A.2.178    repeated-tab-stops

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Number greater than 0

A.2.179    requested-attributes

Identifies the attributes that should be included in an operation.

Objects

N/A

M/S

Multi-value

Settable

Yes

Valid values

A.2.180    reset-printer

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

true|yes

false|no

A.2.181    results-profile

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:

The supported client attributes are visible to the user; results-profile is not.

Objects

Initial-value-job

Job

M/S

Multi-value

Settable

Yes (only via job-copies and output-bin attributes)

Valid values

A.2.182    retention-period

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.

Objects

N/A

M/S

Single value

Settable

Yes

Valid values

A.2.183    right-margin

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Any positive number

A.2.184    scope

Indicates whether document attributes are to be included on a job attributes list operation.

Objects

N/A

M/S

Single value

Settable

Yes

Valid values

0 = List only job attributes

1 = List job and document attributes

A.2.185    server-cluster-member

Contains the name of the server host. If the server is running on a cluster, this attribute holds the default cluster alias.

Objects

Server

M/S

Single value

Settable

No

Valid values

Text string of up to 255 characters

A.2.186    server-hostname

Contains the name of the server host. If the server is running on a cluster, this attribute holds the default cluster alias.

Objects

Server (spooler and supervisor)

M/S

Single value

Settable

No

Valid values

Text string of up to 255 characters

A.2.187    server-name

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.

Objects

Server (spooler and supervisor)

M/S

Single value

Settable

Yes (only at server creation)

Valid values

Text string of up to 255 characters

A.2.188    server-state

Specifies the current state of the specified server.

Objects

Server (spooler and supervisor)

M/S

Single value

Settable

No

Valid values

ready

paused

terminating

A.2.189    server-type

Specifies the type of server.

Objects

Server (spooler and supervisor)

M/S

Single value

Settable

No

Valid values

spooler, supervisor, notification-server, proto-server

A.2.190    sides

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

1

2

A.2.191    sides-ready

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.

Objects

Printer (physical only)

M/S

Multi-value

Settable

Yes

Valid values

1

2

A.2.192    sides-supported

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid values

1

2

A.2.193    started-printing-time

Indicates the time at which this job started printing.

Objects

Job

M/S

Single value

Settable

No

Valid values

A.2.194    state

Identifies the current state of the queue.

Objects

Queue

M/S

Single value

Settable

No

Valid values

ready

paused

A.2.195    style

Indicates the format in which data specified with the -r requested_attributes option is written to standard output.

Objects

N/A

M/S

Single value

Settable

Yes

Valid values

column

line

A.2.196    submission-time

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.

Objects

Job

M/S

Single value

Settable

No

Valid values

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

entire-document

bitmap-images

A.2.198    thickening-supported

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.

Objects

Printer (logical and physical)

M/S

Multi-value

Settable

Yes

Valid Value

entire-document

bitmap-images

A.2.199    time-limit

Specifies the frequency in seconds in which pdls writes output.

Objects

N/A

M/S

Single value

Settable

Yes

Valid values

A.2.200    top-margin

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Any negative or positive number

A.2.201    total-job-octets

Indicates the size of the job in bytes (including copies). This is computed by the spooler from the document attribute octet-count.

Objects

Job

M/S

Single value

Settable

No

Valid values

A.2.202    transfer-method

Indicates how the document will be transferred to or acquired by the server.

Objects

Document

M/S

Single value

Settable

Yes (only at job submission)

Valid values

with-request, socket, file-transfer

A.2.203    transfer-methods-supported

Indicates the transfer methods supported by the server.

Objects

Server (spooler and supervisor)

M/S

Multi-value

Settable

No

Valid values

with-request, socket, file-reference

A.2.204    translation-filter

Overrides the automatic invocation of a translation filter.

Objects

Document

M/S

Single value

Settable

Yes

Valid values

A.2.205    user-name

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.

Objects

Job

M/S

Single value

Settable

No

Valid values

Text string of up to 4095 characters

A.2.206    when

Specifies how much processing can occur before a server can shut down.

Objects

N/A

M/S

Single value

Settable

Yes

Valid values

now

after-current

after-all

A.2.207    width

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

Any positive number

A.2.208    x-image-shift

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Printer (logical and physical)

M/S

Single value

Settable

Yes

Valid values

A range specified by any two negative or positive numbers

A.2.210    y-image-shift

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.

Objects

Document

Initial-value-document

M/S

Single value

Settable

Yes

Valid values

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.

Objects

Printer (logical and physical)

M/S

Single value

Settable

Yes

Valid values

A range specified by any two negative or positive numbers