This chapter describes the object attributes that can be read or set
by end users, operators, or administrators of the print system.
This chapter
is organized by object.
Each section describes the attributes that support
a specific object.
A.1 Server ObjectAttributes
The following attributes are related to both supervisors and spoolers.
Specifies the privilege level of specified authorized print system users within and across domains.
Indicates the general availability of a server.
It is set
to
none
if the server is disabled and
normal
if the server is enabled.
Supplies a textual description of the server.
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.
Indicates whether the server is accepting print requests from
clients.
This attribute is set with the
pdenable
or
pddisable
commands.
Specifies event types and event classes supported by the server for event notification.
Specifies the list of job attributes that a nonowner of the
job will be able to see with the
pdls
command.
By default,
intervening-jobs
is the only visible attribute.
Specifies the period of time that jobs on the server can be
maintained and marked
completed
.
Note that spool files
are not maintained and completed jobs cannot be reprinted.
Contains the locale specification that the server uses when performing internationalization tasks such as constructing error, notification, and logging messages. This attribute is set by the server from the locale environment variable.
Contains a list of locales that are supported by the server.
Readable string associated with the object and intended to indicate to users something about the object state.
Indicates whether a server is capable of modifying individual documents in a multiple document job.
Indicates if the object is capable of handling multiple document jobs.
Indicates the delivery methods for object ready for event notification.
Indicates the delivery methods supported for this object for event notification.
Identifies the class of an object.
Identifies the object classes supported by the server.
Identifies enabled physical printers associated with all of a spooler's queues, or refers to a supervisor's enabled printers.
Identifies the physical printers supported by the server.
Contains the host name of the cluster member running the server process. If the server process is not running on a cluster, this attribute has no value.
Contains the name of the server host. If the server is running on a cluster, this attribute holds the default cluster alias.
Identifies the name of the server. This attribute is set when the server is created.
Identifies the state of the server.
The server states includeready, paused, and terminating
.
Specifies the type of server.
Server types include
spooler
and
supervisor
.
Identifies the print file transfer methods supported by the
server.
The valid methods are
with-request, socket
, and
file-reference
.
Specifies if jobs returned to the spooler after a restart
should be put in the
held
or
pending
state.
Specifies the period of time that completed jobs will be visible to clients before they are purged from the system.
Identifies the logical printers.
Defines a program as a filter and contains the information needed to invoke the program.
Specifies the maximum number of printers the supervisor can manage. Attempts to create physical printers on the supervisor after this limit has been met will fail.
Specifies the number of 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.
Indicates the means by which a printer can be attached to a server host.
Identifies the queue associated with the printer.
Identifies the name of the server with which the object is associated. The attribute is set by object when it is created.
Indicates the general availability of an object.
It is set
to
none
if the object is disabled and
normal
if the object is enabled.
Identifies the binding-edge values supported by this printer.
Identifies the character set encodings supported by the printer.
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.
Sets the
job-priority
attribute 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.
Supplies a textual description of the object.
Specifies the document formats supported by the printer.
Specifies the auxiliary sheets supported by the printer.
Indicates whether the specified object is enabled to accept
print requests from clients.
Objects are enabled or disabled with the
pdenable
or
pddisable
command.
Identifies the per-document finishings supported on the printer.
Identifies the font resources supported by the printer.
Indicates the highlight color-rendering algorithms supported by the printer.
Identifies the highlight colors supported by the printer.
Valid values:
red, blue, green, cyan, magenta, yellow, cardinal,
royalblue, ruby, viole
t, or
name.
Indicates the highlight mapping colors supported.
Identifies the input trays supported by the printer.
Identifies job sheets supported for the printer.
Valid values
are
none, job-copy-start
, and
job-copy-wrap
.
The maximum priority value that a user can set.
Specifies the auxiliary sheet packages supported by the printer.
Identifies the media supported by the printer.
Test string associated with the object. This string is intended to indicate to users something about the state or location of the object.
Specifies events that will be delivered and recipients notified for this object and identifies the notification method.
Identifies the number-up values supported by the printer.
Valid values:
none
or
0
,
simple-1-up
or
1
,
simple-2-up
or
2, simple-4-up
or
4
.
Identifies the class of the specific object.
Identifies the output bins supported by the printer.
Valid values: top, middle, bottom, side, face-up, left, right, large.
Unlike several other xxx-supported attributes, you cannot add values
to the
output-bins-supported
attribute using the CLI +=
operator.
Nor can you remove individual items using the -= operator.
If
you need to add or remove individual output bin values from this attribute,
you must redefine it with all values using the
=
operator.
For example, if the attribute has the value
top side
,
and you want to add bottom to this list, you must redefine the entire attribute
as follows:
#pdset -c p -x output-bins-supported="top side bottom" printer
Identifies the output methods supported by the printer.
Valid value: no-page-collate.
Identifies the type of page numbering supported by the printer.
Valid values: numeric, alphabetic.
Identifies the plexes supported by the printer.
Valid values: simplex, duplex, tumble.
Identifies the host name of a direct-connected physical printer.
Identifies the physical and logical printers associated with this logical or physical printer. The attribute is updated when the associated queue attribute is modified. It is checked for end-to-end consistency when the printer is enabled.
Stores the date and time when a printer object is created.
Enables making multiple copies of a document at the printer. This setting should be used only 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.
Unique name that identifies the printer. This attribute is set when the printer is created.
For printers capable of creating a text string that describes a problem, the supervisor places the text string in this attribute.
Identifies whether the printer is a logical printer or a physical printer.
Valid values: logical, physical.
Specifies a named module to be sent to the printer prior to printing the document. The module typically contains printer setup commands.
Identifies the current state of the printer.
Valid values:
unknown, idle, printing, needs-attention, paused,
shutdown, timed-out
, and
connecting-to-printer
.
Identifies the logical/physical printers ready for use on this physical/logical printer.
Identifies the value of sides supported on this printer.
Valid values: 1, 2.
Identifies the darkening specification algorithms supported by the printer.
Valid values:
entire-document, bitmap-images
.
Identifies the x image shift range supported by the printer.
Identifies the y image shift range supported by the printer.
Specifies whether jobs returned to the spooler after a restart should be placed in the held or pending state.
Valid values:
true
or
yes
for
the
held
state,
false
or
no
for the
pending
state.
Identifies an initial-value document object in the server for use on this logical printer. The printer's initial-value document is used if the document does not specify an initial-value document.
Identifies an initial-value job object in the server for use on this logical printer.
Text string that identifies the name of an LPD printer supported by the Outbound Gateway.
Identifies the character set encodings ready to be used on the printer.
Identifies the document formats ready to be handled by the printer and any associated translators.
Specifies the auxiliary document sheets ready for use on this printer.
Valid values:
none, doc-set-start-copies-separate
.
Disallows the use of certain translation filters or modification filters for a particular printer.
Valid values: a list of filters.
Specifies that an Outbound Gateway printer should use extended lpd job numbers when communicating to an external 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 the LPD protocol as defined by RFC 1179.
Identifies the per-document finishings ready on this printer.
Valid values:
staple, staple-top-left, staple-bottom-left,
staple-top-right, staple-bottom-right, staple-dual-left, saddle-stitch, edge-stitch,
punch, cover-bind
.
Identifies the font resources ready on the printer.
Identifies the highlight colors ready on the printer.
Valid values:
red, blue, green, cyan, magenta, yellow, cardinal,
royalblue, ruby, violet
, or
name.
Identifies the medium in each input tray of the printer.
Identifies the input trays ready to be used on this printer.
Identifies the job sheets ready on the printer.
Valid values:
none, job-copy-start
, and
job-copy-wrap
.
Specifies the maximum speed of the printer in pages per minute.
Identifies the media types ready for use on this printer.
Identifies the media types supported for use on this printer.
Identifies the document formats supported by the printer hardware.
Identifies the output bins ready on the physical printer.
A supervisor-specific string that tells the supervisor how to connect to the printer.
Baud rate for the connected printer.
Valid values: 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 76800, 115200, 153600, 230400, 307200, and 460800.
Identifies the level of connectivity supported by the printer.
Valid values: 0 - Not specified (use system default), 1 - Output only (unidirectional ), 2 - Output only (status bits returned), 3 - Bidirectional (no synchronized session control), 4 - Bidirectional (synchronized session control).
Indicates how the printer is connected to the server host.
Valid values:
serial, parallel, ip-socket, digital-printerserver
, and
bsd
.
Identifies the data bits for the connected printer.
Valid values: 5, 6, 7, and 8.
Indicates the type of input flow control used by the printer.
Valid values:
none, xoff, cts
, and
dtr
.
A text string that can be used to identify the location of the printer.
Identifies the make and model of a printer.
Indicates the type of output flow control used by the printer.
Valid values:
none, xoff, cts
, and
dtr
.
Identifies the parity used by the connected printer.
Valid values: none, even, odd, mark, and space.
Identifies the stop bits used by the printer.
Valid values: 0, 1, and 2.
Identifies the port number the connected printer uses on a TCP/IP socket connection.
Valid values: 1024 through 65535.
Identifies the period of time, in seconds, that a server waits
for a response from a printer before setting
printer-state
to
timed-out
.
Indicates the value of sides ready for the printer.
Valid values: 1, 2.
Identifies the server associated with the queue. This attribute is set when the queue is created.
Indicates the general availability of the queue. It is set to none when the queue is disabled and set to normal when the queue is enabled.
Supplies the textual description of the queue.
Indicates whether a queue is declared disabled when backlogged.
Indicates whether or not the queue will accept print requests
from clients.
This attribute is set with the
pdenable
and
pddisable
commands.
Valid values:
true
or
yes
(enabled),
false
or
no
(disabled).
Identifies the logical printers ready on the queue.
The attribute
is updated whenever a logical printer, whose
associated-queue
attribute points to the queue, is enabled or disabled.
Identifies the logical printers supported by the queue.
A text string intended to indicate the state of the queue to users.
Specifies events that will be delivered and recipients notified for this object and identifies the notification method.
Identifies the class of the object.
Identifies the associated physical printers that are enabled.
Identifies the physical printers that are supported by the queue.
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.
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.
Indicates whether a queue should be declared as disabled (unavailable) when backlogged.
Identifies the name of the queue.
Contains a message that indicates when a queue is backlogged.
Identifies the state of the queue.
Valid values:
ready, paused
.
Identifies the queue to which a job was assigned.
States the time that a job completed printing.
Identifies the current state of a job.
Valid values: unknown, pre-processing, pending, processing, printing, retained, held, paused, terminating, completed.
Specifies if the server inserts document start sheets at the beginning of each document of a job.
Valid values: none and
doc-set-start-copies-separate
.
Identifies an initial value job object to be used for attribute defaulting. The job initial value job supercedes a printer initial value job.
Indicates the number of jobs to be printed before a job is scheduled. It is set to 0 when the job is at the top of its queue.
Text associated with the job and intended to be printed on separator pages.
Indicates the number of copies of the job that are to be printed.
Indicates the number of job copies that have been printed.
Specifies the calendar time at which a job should be discarded, whether or not it has been printed. The spooler cancels or deletes the job, regardless of the job state, setting the retention period to 0.
Identifies how many times a job was returned to the supervisor due to a crash of the spooler or supervisor.
Indicates if a job is available for scheduling.
If
job-hold
is
true
, the job is not scheduled,
job-hold-set
is added to the
job-state-reasons
,
and
current-job-state
is set to
held
.
A spooler generated value unique to the spooler that identifies the job.
A client job identifier, intended for jobs submitted from
legacy systems.
When the job originates from the PPD print system,
job-identifier-on-client
contains the LPD job number.
A job identifier provided by the printer.
Provides a message intended to indicate to a user the reason for action taken on the job.
Provides a readable string for the print job intended to be printed on start sheets, notification, and logging. If the user does not specify a job name, the name of the first file is used.
Provides an attribute used by the LPD Inbound Gateway and contains the name of the host that originated the job.
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.
Identifies the name of the owner of the job.
Specifies the calendar date and time after which the job can be scheduled.
Specifies a print job scheduling priority value. Jobs with higher priorities are scheduled to print before jobs with lower priorities.
Specifies the time that a job was promoted.
Specifies the amount of time that a spooler retains a job after it has printed.
Specifies the auxiliary sheets that the supervisor prints with a job.
Valid values: none,
job-copy-start
and
job-copy-wrap
.
Supplies information about a job state. The supervisor places text in this attribute when a job is completed with errors or is aborted.
Identifies the reason that a job is in the held, terminating, retained, or completed state.
Valid values:
documents-needed, job-hold-set, job-print-after-specified,
required-resource-not-ready, successful-completion, completed-with-warnings,
completed-with-errors, cancelled-by-user, cancelled-by-operator, aborted-by-system
(cancelled-by-shutdown, printer-unavailable, wrong-printer, bad-job), logfile-pending
, and
logfile-transferring
.
Indicates that all documents in a job have been submitted.
Specifies the job events for user notification and specifies the notification delivery method.
Indicates the number of documents in a job.
Specifies the class as job.
Indicates the printer output bin for the print job.
Identifies the physical printer or printers that will be the only candidates for printing the job.
Identifies the state of the job before the last state change.
Identifies the logical printer to be used for the print request.
Indicates the physical printer that a job is assigned. This attribute is set by the spooler when the job is sent to the supervisor.
Indicates the time the job started printing.
Indicates the time the latest print request for a job was submitted.
Indicates the size of the job in octets.
Indicates the name of the user requesting access to print services.
Specifies lpd processing options that are not representable as attributes.
Intended for use only by Inbound and Outbound Gateways.
Specifies the edge of the sheet that will be bound.
Valid values: bottom-edge, right-edge, top-edge, left-edge.
Specifies the distance, in characters, between the bottom edge of the logical page and the bottom edge of the text area when held in the intended reading orientation.
Specifies the most significant orientation of the document.
Valid values: portrait, landscape, reverse-portrait, reverse-landscape.
Specifies the number of copies of the document to print.
If the value of
copy-count
exceeds the value of
maximum-copies-supported
, the job is rejected.
Identifies the coded character set that the server uses as a default for the pages of the document that require a coded character set specification.
Identifies the font that is to be used for document pages that do not otherwise specify a font.
Specifies the input tray that the supervisor sets as the default before the document begins printing.
If this attribute is unspecified, the supervisor uses the printer default.
Specifies the media type to be used for the document.
The spooler uses this attribute for scheduling, and the ASCII-to-PostScript translator uses it to determine the size of the paper to print on.
Specifies the name of the file including the complete path to the file.
Specifies the print format of the document.
Specifies a meaningful name for the document. The attribute is set by the client to be the file name or it can be set when the job is submitted to print.
Specifies the sequence number of a document within a job.
Identifies the state of a document.
Valid values: transfer-pending, pending, processing, completed, printing.
Specifies a finishing object or a sequence of finishing processes to be applied to the document.
Valid values: staple, staple-top-left, staple-bottom-left, staple-top-right, staple-bottom-right, staple-dual-left, saddle-stitch, edge-stitch, punch, cover-bind.
Specifies the text for the footer of each page.
Specifies the text for the header of each page.
Specifies the highlight printing color.
Valid values: red, blue, cyan, magenta, yellow, cardinal, royalblue, ruby, violet, black, or name.
Specifies the highlight color mismatch option.
Valid values: abort, ignore, or operator.
Specifies the highlight color rendering algorithm.
Valid values: automatic, colourToHighlight, colourTables, presentation, or pictorial.
Specifies a color to be a reference color.
Valid values: red, blue, cyan, magenta, yellow, cardinal, royalblue, ruby, violet, black, or name.
Specifies an initial value document object to be used for
attribute defaulting.
The document
initial-value-document
superscedes a printer
initial-value-document
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 orientation.
Specifies the length of the text area in characters.
Specifies the name of a modification filter that is applied to the document data prior to any translation filtering.
Disables translation or modification filtering.
Indicates whether to number pages.
Specifies the number of page images to print on a single sheet.
Valid values:
none
or 0,
simple-1-up
or 1,
simple-2-up
or 2,
simple-4-up
or 4.
Identifies the class of the object.
Specifies the size of the document in octets.
Identifies the output processing for the media that the document is printed on.
Valid values:
no-page-collate
.
Indicates that the specified pages should be printed on the specified media. Any page not specified in this attribute will be printed in the default medium.
This attribute is supported only by certain Xerox printers and the Outbound Gateway supervisor.
Specifies the page order that the pages in a document have been formatted.
Valid values: unknown, first-to-last, last-to-first.
Specifies one or more sequences of pages to be printed.
Specifies whether page images are conditioned for one or two sided printing.
Valid values: simplex, duplex, tumble.
Specifies one or more files used to set up printer modes or functions prior to printing a document.
Specifies the number of characters between tab stops.
Specifies whether the printer should be reset between adjacent documents in a job. The default behavior is that the printer is reset before each job.
Valid values: true,yes, false,no.
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 orientation.
Specifies if the job should be printed on one or two sides of the paper.
Sets the darkening parameter for the entire document or for bitmap images in the document.
Valid values: entire-document, bitmap-images.
Specifies the distance in characters between the top edge of the logical page and the text area.
Indicates how a document is transferred to a server.
Valid values:
with-request, socke
t, and
file-reference
.
Overrides the automatic invocation of a translation filter.
Specifies the width of the text area in characters.
Causes the page image to shift in position with respect to the medium on which page images are rendered. The direction of the shift is parallel to the x axis of the image.
Causes the page image to shift in position with respect to the medium on which page images are rendered. The direction of the shift is parallel to the y axis of the image.