pdset(1)

NAME

pdset — define the attribute values of the specified print object

SYNOPSIS

pdset -h

pdset [-c ObjectClass] [-g] [ -m "MessageText" ] [ -r "RequestedAttributes" ] [-s StyleName] [ -x "AttributeValuePairs" ] [-X AttributesFileName] { ServerName ... | ServerName : InitialValueDocumentName ... | ServerName : InitialValueJobName ... | ServerName : LogName ... | [ServerName :] PrinterName ... | [ServerName :] QueueName ... | LocalJobId ... | GlobalJobId ... }

DESCRIPTION

Use the pdset command to define or modify the values of the print-object attributes. Printers must be disabled before their attributes can be modified.

Table 1-1 lists the four modification operators:

Table 1-1. Four Modification Operators:
Operator	Syntax	Description
replace	`attribute=value`	Replaces the entire value of the attribute `attribute` with value or, if not already present, adds the attribute-value pair to the job.
add-values	`attribute+=value`	Adds the value `value` to the attribute `attribute`. You cannot add values to single-valued attributes. An add request that duplicates values on a multi-valued attribute has no effect on the job.
remove-values	`attribute-=value`	Removes the values `value` from the attribute `attribute`. A remove request for a nonexistent value has no effect on the object. A remove request for the last or only value of an attribute is equivalent to a set-to-default request.
reset-to-default	`attribute==`	Set the attribute `attribute` to the default values according to the job defaulting-hierarchy. If values are supplied with a reset request, they are ignored.

If you do not specify a value with a replace, add, or remove request, an error is issued and the request to change the object is rejected.

Only values for settable attributes can be changed using the pdset command. Using this command for non-settable attributes results in an error. This is determined on an object-by-object basis.

Changes made to objects are permanent and remain changed even if the print system is shutdown and then restarted.

Options

You can use the following options with the pdset command:

-h

Display a command-specific help message containing information about command syntax and options. This option cannot be used with another option or with an attribute.

-c ObjectClass

Specify the object class that the command is to operate upon. The ObjectClass can be one of the following:

printer (default)
job
server
queue
document
initial-value-job
initial-value-document
log

Within the valid classes, printer is for a logical printer or a physical printer and server is for a spooler or a supervisor.

This option is equivalent to specifying the command-attribute class.

-g

Turn off headings. This option is equivalent to specifying the command-attribute headings=false.

-m "MessageText"

Specify the message you want associated with the printer, job, server, queue, document, initial-value-job, initial-value-document, or log that is being modified.

You can use the message to give the reason for the modification or to provide other comments. If you do not specify the -m option, the message already stored with the object remains unchanged.

If the command is for a job, you can list this message by specifying requested-attributes=job-message-from-administrator with the pdls command.

If the command is for the other objects, you can list this message by specifying requested-attributes=message with the pdls command.

This option is equivalent to specifying the command-attribute message.

-r RequestedAttributes

Specify the attribute values that you want to display for the specified objects.

RequestedAttributes can be none (default), brief, or verbose.

This option is equivalent to the command-attribute requested-attributes.

-s StyleName

Specify the style in which you want the attributes displayed.

StyleName may be column (default), or line.

This option is equivalent to the command-attribute style.

-x "AttributeValuePairs"

A single attribute string, consisting of one or more attribute-value pairs. Prefix the attribute value with the replace operator, = , to replace a value, the add-value operator, += , to add a value, and the remove-value operator, -= , to remove a value. Use the reset-to-defaul operator, == , with no attribute value to set the attribute to its default value.

-X AttributesFileName

The name of a file containing attribute-value pairs to be inserted at the current point in the command line. This option is equivalent to the command-attribute attributes.

Command Attributes

You can specify these attributes in a -x "AttributeValuePairs" string or in an attributes file designated with the -X AttributesFileName option.

attributes=AttributesFileName

Cause the designated attributes file to be read.

class=ObjectClass

Specify the ObjectClass that you want for this command. Valid object class names are: printer (default), job, server, queue, document, initial-value-job, initial-value-document, and log.

headings=Boolean

Boolean can be true (default) or false. Specifies if you want headings displayed.

message="MessageText"

Specify the message that you want associated with the printer, job, server, queue, document, initial-value-job, initial-value-document, or log that is being modified.

You can use the message to give the reason for the modification or to provide other comments. If you do not specify the message attribute, the message already stored with the object remains unchanged.

If the command is for a job, you can list this message by specifying requested-attributes=job-message-from-administrator with the pdls command.

If the command is for the other objects, you can list this message by specifying requested-attributes=message with the pdls command.

requested-attributes=AttributeType

Specify which attributes you want displayed. AttributeType can be none (default), brief, or verbose.

style=StyleName

Specify the presentation format that you want for the displayed output. StyleName can be column (default) or line.

Object Attributes

There are no object attributes for this command.

Arguments

Use the arguments to identify the specific objects that you want to set or modify. If you specify multiple objects, each must be separated by spaces. You can use the following argument values with the pdset command:

ServerName

ServerName:InitialValueDocumentName

ServerName:InitialValueJobName

ServerName:LogName

[ServerName:]PrinterName

[ServerName:]QueueName

LocalJobId

GlobalJobId

EXAMPLES

Specifying a Descriptor for a Server

To set a description for the supervisor SUPER1 and identify the processor name where it is located and the TCP/IP address for the processor, enter the command:

pdset -c server -x "descriptor='Supervisor SUPER1 is installed on cowboy.  The TCP/IP address for cowboy is 9.99.9.143.'" SUPER1 

Specifying a List of Managers for a Server

To identify the people who are responsible for the server and how to contact them, enter the command:

pdset -c server -x "list-of-managers='John Smith, extension 4488, office 3-10' 'Mary Jones, extension 5562, office 110'" SUPER1 

Change the Operator to Receive Messages

To identify the new person that is to receive start and stop messages for physical printer PhysPrt1, enter the command:

pdset -c printer -x "notify-operator=electronic-mail:ro@cowboy" SUPER1:PhysPrt1 

Set the Job Size Range

To set the size of jobs that can submitted to a physical printer PhysPrt2, enter the command:

pdset -x "job-size-range-supported=0:10000 job-size-range-ready=0:10000" PhysPrt2 

To set a Message

To set the message for server SUPER2, enter:

pdset -c server -m "printing system now ok" SUPER2 

STANDARDS CONFORMANCE

pdset: POSIX 1387.4