.\" $Header:
.TA p
.TH pddelete 1
.SH NAME
pddelete \- deletes print objects
.SH SYNOPSIS
.tr ~"
.C pddelete
.RC [ -c \0\f2ObjectClass\f4\0\|\f1]
.RC [ -m \0\~\f2MessageText\f4~\0\|\f1]
.RC [ -x \0\~\f2AttributeValuePairs\f4~\0\|\f1]
.RC [ -X \0\f2AttributesFileName\f4\0\|\f1]
.RI \0\f2ServerName\f4\0|
.RI \0\f2ServerName:InitialValueDocumentName...\f4\0|
.RI \0\f2ServerName:InitialValueJobName...\f4\0|
.RI \0\f2[ServerName:]PrinterName...\f4\0|
.RI \0\f2[ServerName:]QueueName...\f4\0	
.PP
.C pddelete \0-c\0 job 
.RC [ -m \0\~\f2MessageText\f4~\0\|\f1]
.RC [ -r \0\f2JobRetentionPeriod\f4\0\|\f1]
.RC [ -x \0\~\f2AttributeValuePairs\f4~\0\|\f1]
.RC [ -X \0\f2AttributesFileName\f4\0\|\f1]
.RI \0\f2LocalJobId...\f4\0|
.RI \0\f2GlobalJobId...\f4
.tr ~~
.PP
.C pddelete\0 -h		
.PP
.SH DESCRIPTION
You use this administrative command
.C pddelete
to permanently delete print objects from the printing system.
.PP
A confirmation message is issued before deleting objects, unless the
.C PD_CONFIRM_DELETE 
environment variable is set to 
.CR no . 
.PP
.SS Options
You can use the following options with the 
.C pdpelete 
command:
.PP
.TP
.C -c \f2ObjectClass\f4
The object class that the command is to operate upon. 
Valid \f2ClassName\f4
.ft
s are:
.CR printer " (default),"
.CR job ,
.CR queue , 
.CR initial-value-job ,
.CR initial-value-document ,
and
.CR server .
Equivalent to specifying the 
command-attribute
.C class.
.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 an attribute.
.PP
.TP
.tr ~"
.C -m \f2\~MessageText\f4~
.tr ~~
Specifies the message you want associated with the specified
.CR printer , 
.CR job , 
.CR queue , 
.CR initial-value-job ,
or 
.CR initial-value-document , 
that is being deleted.  You can use this message to indicate the
reason for deleting the 
.CR printer , 
.CR job , 
.CR queue , 
.CR initial-value-job , 
or
.CR initial-value-document , 
or other comments.
.IP
If the command is to operate on a job with a non-zero
.CR job-retention-period , 
list this message by specifying
.CR requested-attributes=job-message-from-administrator 
with the
.CR pdls 
command.  If the command is to operate on a 
.CR printer , 
.CR queue ,
.CR initial-value-job , 
.CR initial-value-document ,
or 
.CR job 
with a
.CR job-retention-period 
of zero (0), this message is deleted with
the object and cannot be retrieved.
.PP
.IP
If the 
.C -m 
is not specified, the message already stored with the
object remains unchanged and is deleted as just described.
Equivalent to specifying the command-attribute 
.CR message .
.PP
.TP
.C -r \f2JobRetentionPeriod\f4 
Can only be used if object-class is 
.C job
; command will be
rejected if used with any other class.
If the job currently has a retention-period or is currently
retained, this  option must be specified with a zero (0) value to
delete the job.  If not specified, the present retention-period
for the job is used.
Equivalent to specifying the object-attribute
.C job-retention-period.
.PP
.TP
.tr ~"
.C -x \f2\~AttributeValuePairs\f4~
A single attribute string, consisting of one or more
attribute-value pairs.
.tr ~"
.PP
.TP
.C -X \f2AttributesFileName\f4 
The name of a file containing attribute-value pairs to be
inserted at the current point in the command line.  Equivalent
to specifying the command-attribute 
.C attributes.
.PP
.SS Command Attributes
.PP
You may specify these attributes in a 
.CR -x\0"\c
"\f2AttributeValuePairs\f4\c"
"
.ft
string or in an attributes file designated with the 
.C -X 
attributes file name  option.
.PP
.TP
.CR attributes\f2=AttributesFileName\f4
Causes the designated attributes file to be read.
.PP
.TP
.CR class=\f2ObjectClass\f4
Specifies the object class you want for this command. 
Valid object class names for the 
.C pddelete 
command are:
.CR printer " (default),"
.CR job ,
.CR queue ,
.CR initial-value-job ,
.CR initial-value-document ,
and
.CR server .
.PP
.tr ~"
.TP
.C   message\f2=\~MessageText\f4~
.tr ~~
Specifies the message you want associated with the 
.CR printer ,
.CR job ,
.CR queue ,
.CR initial-value-job ,
or
.CR initial-value-document ,
that is being deleted.  You
can use this message to indicate the reason for deleting the
.CR printer ,
.CR job ,
.CR queue ,
.CR initial-value-job ,
.CR initial-value-document ,
or other comments.
.IP
If the command is to operate on a 
.C job 
with a non-zero
job-retention-period , 
you can list this message by specifying a
value of 
.CR requested-attributes=job-message-from-administrator
with the 
.C pdls 
command.  If the command is to operate on 
.CR printer ,
.CR job ,
.CR queue ,
.CR initial-value-job ,
.CR initial-value-document ,
or 
.C job 
with
job-retention-period 
of zero (0), this message is deleted with
the object and cannot be retrieved.
.PP
If the 
.C message 
attribute is not specified, the message stored
with the object remains unchanged and is deleted as just
described.
.PP
.SS Object Attribute
You can only use the object-attribute if object-class is
.C job
; command will be rejected if used with any other class.
You may specify this attribute in a 
.C -x 
\f2AttributeValuePairs
.ft
string or in an attributes file designated with the 
.C -X 
\f2AttributesFileName 
.ft
option.
.PP
.TP
.CR job-retention-period=\f2time\f4
If the job currently has a retention-period or is currently
retained, this attribute must be specified with a zero (0) value
to delete the job.  If not specified, the present
retention-period for the job is used.
.PP
.SS Arguments
You use the argument to identify the specific object you want to delete.
If you specify multiple objects, each must be separated by spaces.
.PP
You can use the following arguments with the 
.C pddelete 
command:
.PP
.TP
\f2ServerName\f4
You must remove all jobs contained within the named server
before you can delete the server.
.PP
.TP
\f2ServerName:InitialValueDocumentName\f4
.ft
If any of the logical printers that reference this initial
value document are enabled, you cannot delete this 
.C initial value
document.
.PP
.TP
\f2ServerName:InitialValueJobName\f4
If any of the logical printers that reference this initial
value 
.C job
are enabled, you cannot delete this initial value
.C job.
.PP
.TP
\f2LocalJobID\f4 or \f2GlobalJobId\f4
A job object is deleted based on the specified value in its
.C job-retention-period 
attribute.
.PP
.TP
\f2[ServerName:]PrinterName\f4
All the jobs must be removed from physical printers.  Physical
and logical printers must be disabled before they can be
deleted.
.PP
.TP
\f2[ServerName:]QueueName\f4
You must disable all logical and physical printers associated
with the queue before you can delete the queue.  (Before
disabling physical printers, you must first remove all of the
jobs from them.)  All of the jobs (including paused jobs) must
be removed from the queue before the queue can be deleted.
.PP
.SH EXAMPLES
.C Delete a Job Using a Local 
.C ID 
.PP
\(bu   To delete job 5, enter the command:
.PP
.C    pddelete -c job 5
.PP
.SS Delete Logical Printers         
.PP
\(bu   To delete logical printers lp11 and lp15, enter the command:
.PP
.C    pddelete  lp11  lp15
.PP
.SS Delete an IVO             
.PP
\(bu   To delete the initial-value-job object IVJ_2 from the spooler
    DivSPOOL2, enter the command:
.PP
.C    pddelete -c initial-value-job  DivSPOOL2:IVJ_2
.PP
.SS Delete a Server          
.PP
\(bu   To delete the server SPOOL1, enter the command:
.PP
.C    pddelete -c server SPOOL1
.PP
.SH  SEE ALSO
pdclean(1), pdcreate(1), pddisable(1), pdenable(1), pdls(1), pdmod(1),
pdpause(1), pdpr(1), pdpromote(1), pdq(1), pdresubmit(1), pdresume(1), pdrm(1), pdset(1),
pdshutdown(1)
.PP
.SH STANDARDS CONFORMANCE
.CR pddelete ": POSIX 1387.4"
.\" index@\f4pddelete\f1 \- deletes print objects@@@\f3pddelete(1)\f1
.\" index@\f1deletes print objects@@@\f3pddelete(1)\f1
.\" index@\f1HP Distributed Printer System, deletes print objects@@@\f3pddelete(1)\f1
.\"
.\" toc@\f3pddelete(1)\f1:\0\0\f4pddelete\f1@@@deletes print objects
.\"
.\"
.\"
