.\" $Header:
.TA p
.TH pdmod 1
.SH NAME
pdmod \- modifies attributes of submitted print jobs
.SH SYNOPSIS
.tr ~"
.C pdmod 
.RC [ -g ] 
.RC [ -m \0\~\f2MessageText\f4~ \|\f1] 
.RC [ -n \0\f2CopyCount \|\f1]
.RC [ -r \0\~\f2RequestedAttributes\f4~ \|\f1]
.RC [ -s \0\f2StyleName \|\f1]
.RC [ -t \0\f2JobName \|\f1]
.RC [ -x \0\~\f2AttributeValuePairs\f4~ \|\f1]
.RC [ -X \0\f2AttributesFileName \|\f1]
.RI \f2LocalJobID \f1...\0|\0\f2GlobalJobID \f1...
.PP
.tr ~~
.C pdmod -h
.SH DESCRIPTION
You enter the 
.C pdmod 
command to modify the values of job and document
attributes of previously submitted print jobs.
.PP
You can only modify preprocessing, pending, held, paused, or retained
jobs.  You cannot modify any jobs that are currently printing.
.PP
Modifying an existing job may affect the scheduling of the job.
.PP
Table 1-1 
lists the four modification operators:
.\".nf
.\"
.\"|------------------------------------------------------------------------|
.\"| Table  1-1. pdmod Syntax                                               |
.\"|------------------------------------------------------------------------|
.\"| 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==| Sets the attribute attribute to   |
.\"|                 |                  | the default values according to   |
.\"|                 |                  | the job defaulting-hierarchy.  If |
.\"|                 |                  | values are supplied with a reset  |
.\"|                 |                  | request, they are ignored.        |
.\"|------------------------------------------------------------------------|
.\".fi
.PP
.TS
lfB s s
lw(1i) lw(1i) lw(3.7i)
l l l.
Table  1-1. Four Modification Operators:

.sp .5v
Operator	Syntax	Description
_
.sp .5v
replace	\f2attribute=value\f1	T{
.na 
Replaces the entire value of the
attribute \f2attribute\f1 with value
or, if not already present, adds
the attribute-value pair to the
job.
.ad
T}
_
.sp .5v
add-values	\f2attribute+=value\f1	T{
.na
Adds the value \f2value\f1 to the attribute \f2attribute\f1.  
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.
.ad
T}
_
.sp .5v
remove-values	\f2attribute-=value\f1	T{
.na
Removes the values \f2value\f1 from the attribute \f2attribute\f1.  
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 
sseett--ttoo--ddeeffaauuulltt
request.
.ad
T}
_
.sp .5v
reset-to-default	\f2attribute==\f1	T{
Set the attribute \f2attribute\f1 to
the default values according to
the job defaulting-hierarchy.  If
values are supplied with a reset
request, they are ignored.
.ad
T}
_
.TE
.PP
If you do not specify a value with a replace, add, or remove request, an
error is issued and the request to change the attribute value for the
object is rejected.  Processing continues with the next argument on the
command line, if any.
.PP
.CR Note :  
If any modification is not accepted, then the whole request is
rejected and the job continues as before.
.PP
You must be authorized to modify a job belonging to another person.  Use
the global job identifier to identify the job belonging to another person.
.PP
.SS Options
.PP
You can use the following options with the 
.C pdmod 
command:
.PP
.TP
.C -g    
Turns off headings.
Using this option is equivalent to specifying the
command-attribute 
.CR headings=false .
.PP
.TP
.C -h    
Displays a command-specific help message containing information
about command syntax and options.  This option is mutually
exclusive; cannot be used with another option or with an
attribute.
.PP
.TP
.tr ~"
.C -m \f2\~MessageText\f4~
.tr ~~
Specifies the message you want stored in the
.C job-message-from-administrator 
attribute.  You can use the
message to give the reason the job is being modified or other
comments.  If you do not specify the 
.C -m 
option, the message
already stored with the job remains unchanged.
.PP
.IP
You can list this message by specifying
.CR requested-attributes=job-message-from-administrator 
with the
.C pdls 
command.
Using this option is equivalent to specifying the
command-attribute 
.CR message .
.PP
.TP
.C -n \f2CopyCount\f4
Specifies the number of document copies.  A copy count of zero
(0) is an error.
Using this option is equivalent to specifying the object-attribute
.CR copy-count .
.PP
.C -r \f2RequestedAttributes
.IP
.ft
Where 
\f2RequestedAttributes
.ft
can be 
.C none
(default),
.C brief
, or
.C verbose.
.IP 
Specifies the attribute values you want to display for the
specified objects.
Using this option is equivalent to specifying the
command-attribute 
.CR requested-attributes .
.PP
.CR -s \f2\0StyleName
.IP
.ft
Where \f2StyleName
.ft
may be
.C column 
(default), or
.C line.      			
.br
Specifies the style in which you want the attributes displayed.
Using this option is equivalent to specifying the
command-attribute 
.CR style .
.PP
.TP
.C -t \f2JobName\f4
Specifies the new name you want for the job.
Using this option is equivalent to specifying the object-attribute
.CR job-name .
.PP
.TP
.tr ~"
.C -x \f2\~AttributeValuePairs\f4~
.tr ~~
Consists of a single attribute string, containing one or more
attribute-value pairs.  Prefix the attribute value with the 
.C =
character to replace a value, the 
.C +=
characters to add a value,
and the 
.C -=
characters to remove a value.  Use the 
.C ==
characters
with no attribute value to set the attribute to its default
value.
.PP
.TP
.C -X \f2AttributeFileName\f4
Specifies the name of a file containing attribute-value pairs
you want inserted at the current point in the command line.
Using this option is equivalent to specifying the
command-attribute 
.CR attributes .
.PP
.PP
.SS Command Attributes
.PP
These attributes can be specified in a 
.C -x "\c
"\f2AttributeValuePairs\f4\c"
"
.ft
string
or in an attributes file designated with the 
.C -X 
\f2AttributeFileName
.ft
option.
.PP
.C attributes\f2=AttributesFileName
.ft
.IP
Causes the designated attributes file to be read.  This file
contains attribute-value pairs that are used to expand on the
command being issued.
.PP
.CR headings\f2=Boolean
.ft
.IP
.ft
Where \f2Boolean
.ft
can be
.C true
(default), or
.C false. 	
Specifies if you want headings displayed.
.PP
.C message\f2="MessageText\f4"
.IP
Specifies the message you want stored in the
.C job-message-from-administrator 
attribute.  You can use the
message to give the reason the job is being modified or other
comments.  If you do not specify the
.C message
attribute, the
message already stored with the job remains unchanged.
.PP
.IP
You can list this message by specifying
.CR requested-attributes=job-message-from-administrator 
with the
.C pdls 
command.
.PP
.C requested-attributes\f2=ObjectAttribute
.ft
.IP
\f2ObjectAttribute
.ft
can be
.C none
(default),
.C brief 
, or
.C verbose.
.IP
Specifies which attributes you want displayed.
.PP
.CR style=\f2StyleName
.ft
.IP
Where \f2StyleName
.ft
may be
.C column
(default) or
.C line.   
.IP
Specifies the presentation format you want for the displayed
output.
.PP
.SS Object Attributes        
.PP
You can specify these attributes in a 
.C -x \f2"AttributeValuePairs\f4"
string or in an attributes file designated with the 
.C -X 
\f2AttributesFileName 
.ft
option.
.PP
.CR copy-count\f2=number
.ft
.IP
Specifies the number of document copies you want.  A copy count
of zero (0) is an error.
.PP
.CR job-hold\f2=Boolean
.ft
.IP
Where \f2
.ft
can equal
.C true 
, or
.C false
(default).  
.IP
Specifies whether you want to put the job in hold state.
.PP
.CR job-name\f2=name
.ft
.IP
Specifies the new name you want for the job.
.PP
Also, you may specify any other settable attributes for the job or
document.
.PP
.CR Note :  
You can set the value for a settable attribute with either the
.C pdset
or
.C pdmod 
command.
.PP
.SS Arguments
.PP
You use the arguments to identify the specific objects you want to modify.
If you specify multiple objects, each must be separated by spaces.
.PP 
\f2job_id\f4 
.ft
... 
.IP
Specifies the local or global job identifier.  If you modify
more than one job with a single command, each 
must be separated with one or more white spaces.
.PP
.SH EXAMPLES
.PP
.SS Modify Content Orientation    
.PP
\(bu   To modify the job (local id of 10) and change the orientation to
landscape, enter the command:
.PP
.C    pdmod -x content-orientation=landscape 10
.PP
.SS Modify Job Hold Condition    
.PP
\(bu   To modify the job-attribute 
.C job-hold 
to 
.C false 
for job 10, so that the
job (which was previously submitted with 
.C job-hold
set to 
.C true
) can be scheduled, enter the command:
.PP
.C    pdmod -x job-hold=false 10
.PP
.SS Modify Job Comment    
.PP
\(bu   To modify the job-attribute
.C job-comment
.tr ~"
to be \~Test Results 100\~ for job
.tr ~~
10, enter:
.PP
.C    pdmod -x job-comment="Test Results 100" 10
.PP
.SS "Modify Number of Sides to be Printed"
.PP
\(bu   To modify the document-attribute
.C sides
to be 2 for all documents in
the global job 1011222243 on server DivSpool2, enter:
.PP
.C    pdmod -x sides=2 DivSpool2:1011222243
.PP
\(bu   To modify the sides document attribute to specify to print documents
on both sides for jobs 10 and 20, enter:
.PP
.C    pdmod -x sides=2 10 20
.PP
.SS Add a Value             
.PP
\(bu   To add the value 
.C building47 
to the attribute
.C Printer-locations-requested
for job 10, enter:
.PP
.C    pdmod -x Printer-locations-requested+=building47 10
.PP
.SS Remove a Value           
.PP
\(bu   To remove the value 
.C building47 
from the
.C Printer-locations-requested
attribute in my job 10, enter:
.PP
.C    pdmod -x Printer-locations-requested-=building47 10
.PP
.SS Reset to Default Values        
.PP
\(bu   To reset the
.C job-originator
job attribute to the default values in my
job 10, enter:
.PP
.C    pdmod -x job-originator==10
.PP
.SS Combining Modifications  
.PP
\(bu   To modify job 17, notifying the operator,
and placing the job on hold, enter the command:
.PP
.tr ~"
.ta 1i
./"
.C    pdmod -x \~job-message-to-operator=
.C 'This job requires blue legal-sized paper.  
.C Please advise when the paper is
.C available'
.C job-hold=yes" 
.C 17
.tr ~~
.PP
.SH SEE ALSO
pdclean(1), pdcreate(1), pddelete(1), pddisable(1), pdenable(1), pdls(1), pdpause(1), pdpr(1), pdpromote(1), pdq(1), pdresubmit(1), pdresume(1), pdrm(1), pdset(1),
pdshutdown(1)
.PP
For information about:
.PP
\(bu   Headings, see the 
.C pdls 
command-attribute 
.C style
.PP
\(bu   Requested attributes, the 
.C pdls 
command-attribute 
.br
.C requested-attributes
.PP
\(bu   Style, see the 
.C pdls 
command-attribute 
.C style
.PP
\(bu   Job defaulting-hierarchy, see the 
.C pdpr 
command
.PP
\(bu   To view information about all supported attributes, enter the
command:
.PP
.C    man pd_att
.PP
.IP
This will display a list of files by object from which you can select
the attribute listing you want.
.PP
.SH STANDARDS CONFORMANCE
.CR pdmod ": POSIX 1387.4"
.\" index@\f4pdmod\f1 \- modifies attributes of submitted print jobs@@@\f3pdmod(1)\f1
.\" index@\f1modifies attributes of submitted print jobs@@@\f3pdmod(1)\f1
.\" index@\f1HP Distributed Printer System, modifies attributes of submitted print jobs@@@\f3pdmod(1)\f1
.\"
.\" toc@\f3pdmod(1)\f1:\0\0\f4pdmod\f1@@@modifies attributes of submitted print jobs
.\"
.\"
.\"
