.\" $Header: 
.TA p
.TH pdclean 1
.SH NAME
pdclean \- removes all jobs from the specified object
.SH SYNOPSIS
.tr ~"
.C pdclean
.RC [ -c \0\f2ObjectClass \|\f1]
.RC [ -m \0~\f2MessageText\f4~ \|\f1]
.RC [ -x\0 ~\f2AttributeValuePairs\f4~ \|\f1]
./" Right here is where there is too much spaces between options. 
./" If I delete the next line, then everything is okay. -- amy
.RC [ -X \0\f2AttributesFileName \|\f1]
.IR ServerName ... \| | 
.RI [ ServerName: \|\f1] \f2PrinterName\f1... |
.RI [ ServerName: \|\f1] \f2QueueName\f1...
.PP
.tr ~~
.C pdclean -h
.SH DESCRIPTION
Use the administrative command, 
.CR pdclean ,
to remove all jobs from the
specified servers, logical printers, queues, 
or physical printers.  
If you are removing jobs from a server, any 
.C "job-retention-period"
attribute values
are ignored.  For all other conditions, the 
.C job-retention-period 
is honored.   
If you are removing jobs from a logical printer, all jobs that
have been submitted to it are removed from the queue.  If you are removing
jobs from a queue, all jobs that are contained in that queue are removed
from the queue.
.PP
Jobs that are in the middle of printing are aborted, if possible.
.PP
.CR HPDPS
issues a confirmation message prior to cleaning the object,
unless your environment variable
.C PD_CONFIRM_DELETE 
has value of
.CR no .
.SS Options
You can use the following options with the 
.CR pdclean 
command:
.PP
.TP
.C "-c ObjectClass"
where \f2ObjectClass\fP is:
.CR printer " (default),"
.CR queue ,
or
.CR server .
Specifies the object class you want for this command.
Within the valid classes, 
.C server 
is for a spooler or a supervisor, and
.C printer
is for a logical or physical printer.
.br
Using this option is equivalent to specifying the command-attribute
.CR class .
.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.
.TP
.C "-m ""\f2MessageText\fP"" "
Specifies the message you want associated with the specified
printer, queue, or server. You can use this message to indicate
the reason why the printer, queue, or server is being cleaned
or other comments. Using this option is equivalent to specifying
the command-attribute 
.CR message .
.br
You can list this message by specifying
.CR "requested-attributes=message"
with the
.C pdls
command.
.TP
.C "-x ""\f2AttributeValuePairs\fP"" "
A single attribute string, consisting of one or more
attribute-value pairs.
.TP
.CI -X\0 "AttributesFileName"
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 
.C attributes.
.SS Command Attributes
You may specify these attributes in a 
.\" .br
.C "-x ""\f2AttributeValuePairs\fP"" "
string or in an attributes file designated with the 
.C "-X AttributesFileName"
option.
.TP
.C attributes=\f2AttributesFileName\f1
Causes the designated attributes file to be read.
.TP
.CR class=\f2ObjectClass\fP
Specifies the 
.CR printer , 
.CR queue 
, or 
.CR server 
you want for this command. Within the valid classes, 
.C server
is for a spooler or supervisor, and
.C printer 
is for a logical or physical printer.
.TP
.C "message=""\f2message text\fP"" "
Specifies the message you want associated with the
printer, queue, or server. You can use this 
message to indicate the reason why the printer, queue, or server
is being cleaned or other comments.
.br
You can list this message by specifying 
.CR requested-attributes=message 
with the 
.C pdls 
command.
.SS Object Attributes
There are no object attributes for this command.
.SS Arguments
Use the argument value to specify the printer, queue, or server
that you want cleaned. If you specify multiple objects, all must be
of the same object class, and each must be separated by spaces.
.PP
You can use the following arguments with 
.C pdclean
command:
.TP
[\f2ServerName\f1:]\f2PrinterName\f1
Specifies which printers you want cleaned of jobs.
.br
Cleaning a physical printer removes only those jobs that have
been assigned to that physical printer.
.br
Cleaning a logical printer removes all jobs that were submitted
through that logical printer that have not yet been completed.
They are removed from the queue associated with the logical printer.
Any jobs currently printing are aborted if this is supported by the physical
printer device.
.TP
[\f2ServerName\f1:]\f2QueueName\f1
Specifies which queues you want cleaned of jobs.  
.br
Cleaning a queue deletes all jobs that reside in that queue.  Any jobs
currently printing will be aborted if this is supported by the
physical printer device.
.TP
.IR ServerName 
Specifies which servers you want cleaned of jobs.
.br
Cleaning a spooler deletes all jobs that have been submitted to
any of the logical printers residing in that spooler including any
retained jobs. Any jobs currently printing are aborted if this is supported
by the physical printer device.
.br
Cleaning a supervisor deletes all jobs that are assigned to any
of the physical printers residing in that supervisor. 
Any jobs currently printing are aborted, if this is supported by the 
physical printer device.
.SH EXAMPLES
.SS Clean a Printer
To clean printer lj4si of all jobs, enter the command:
.PP
.CR "pdclean lj4si"
.SS Clean a Server
To clean server DSuper1, enter the command:
.PP
.CR "pdclean -c server DSuper1"
.SS Clean a Physical Printer
To clean printer PhysPrt2 of all jobs and leave a message 
enter the command:
.PP
.C "pdclean -m ""Printer PhysPrt2 is down for repairs"" SUPER1:PhysPrt2"
.SH SEE ALSO
pdcreate(1), pddelete(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)
.SH STANDARDS CONFORMANCE
.CR pdclean ": POSIX 1387.4"
.\" index@\f4pdclean\f1 \- removes all jobs from the specified object@@@\f3pdclean(1)\f1
.\" index@\f1removes all jobs from the specified object@@@\f3pdclean(1)\f1
.\" index@\f1Distributed Print Service, removes all jobs from the specified object@@@\f3pdclean(1)\f1
.\"
.\" toc@\f3pdclean(1)\f1:\0\0\f4pdclean\f1@@@remove jobs from specified object
.\"
.\"
.\"
