.\" $Header:
.TA p
.TH pdpause 1
.SH NAME
pdpause \- pauses jobs, physical printers, servers, or
queues
.SH SYNOPSIS
.tr ~"
.C pdpause 
.RC [ -c \f2\0ObjectClass\f4 \|\f1]
.RC [ -m \f2\0\~MessageText\f4~ \|\f1]
.RC [ -x \f2\0\~AttributeValuePairs\f4~ \|\f1]
.RC [ -X \f2\0AttributesFileName\f4 \|\f1]
{\f2LocalJobId...\f4\0| 
\f2GlobalJobId ...\f4\0| 
\f2ServerName ...\f4\0|
\f2[ServerName:]PrinterName ...\f4\0|
\f2[ServerName:]QueueName ...\f2 }
.PP
.C pdpause -j 
.RC [ -m\f2\0\~MessageText\f4~]
.RC [ -x\f2\0\~AttributeValuePairs\f4~]
.RC [ -X\0\f2AttributesFileName\f4]\0\f2[ServerName:]PrinterName\f4
.tr ~~
.PP
.C pdpause -h
.PP
.SH DESCRIPTION
.PP
You use this administrative command 
.C \f2(\f4pdpause\f2)\f4 
to pause an object that holds jobs or to pause a job.
.PP
Object that can be paused, are:
.PP
.IP
\(bu   pending print jobs
.PP
.IP
\(bu   held print jobs
.PP
.IP
\(bu   currently-processing print jobs
.PP
.IP
\(bu   physical printers
.PP
.IP
\(bu   queues
.PP
.IP
\(bu   servers (pauses all of the queues contained in a spooler or all
physical printers contained in a supervisor)
.PP
.IP
To resume a paused object, use the 
.C pdresume 
command. 
.PP
.CR Note:   
The 
.C pdpause 
and 
.C pdresume 
commands control output, whereas 
.C pdenable
and 
.C pddisable 
commands control input.
.PP
.SS Options
.PP
You can use the following options with the 
.C pdpause 
command:
.PP
.C -c \f2ObjectClass
.ft
.IP
Where \f2ObjectClass
.ft
may be
.C printer 
(default),
.C queue 
,
.C job
, or
.C server.
.IP
Specifies the object class you want to pause.  Within the valid
classes, 
.C printer 
is a physical printer, and a 
.C server 
is either a spooler or a supervisor.  Using this option is equivalent to 
specifying the command-attribute 
.CR 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 with an
attribute.
.PP
.TP
.C -j    
Only valid when used with object-class 
.CR printer .  
Use this option
to pause the currently printing job on the specified physical
printer.
.PP
.TP
.tr ~"
.C -m \f2\~MessageText\f4~
.tr ~~
Specifies the message you want associated with the specified
printer , 
queue , 
job , 
or 
server 
that is being paused.  You can
use this message to indicate the reason that a pause has taken
place or to provide other comments.
.PP
.IP
When pausing a supervisor, 
.CR HPDPS 
propagates the message to the
.C message 
attribute of the physical printers residing in a
supervisor.  The 
.C message 
attribute for the supervisor is not
changed.
.PP
.IP
When pausing a spooler, the message is propagated to the 
.C message
attribute of the queues residing in the spooler.  The 
.C message
attribute for the spooler is not changed.
.PP
.IP
If the command operates on a 
.C printer 
or a 
.CR queue,
you can list
this message by specifying 
.CR requested-attributes=message 
with the
.CR pdls 
command.
.PP
.IP
When the command operates on a job, the specified text becomes
the value of the 
.C job-message-from-administrator 
attribute.  
You can list this message by specifying
.CR requested-attributes=job-message-from-administrator 
with the
.C pdls 
command.
.PP
.IP
If the 
.C -m 
option is not specified, the message already stored with
the 
.CR printer , 
.CR queue , 
.CR job , 
or 
.CR server 
remains unchanged.
Using this option is equivalent to specifying the
command-attribute 
.CR message .
.tr ~"
.PP
.TP
.C -x \f2\~AttributeValuePairs\f4~
A single attribute string, consisting of one or more
attribute-value pairs.
.PP
.TP
.C -X \f2AttributesFileName\f4
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 
.tr ~~ 
.CR attributes .
.PP
.SS Command Attributes
.PP
.tr ~"
You can specify these attributes in a 
.C -x \f2\~AttributeValuePairs\f4~
string or
.tr ~~ 
in an attributes file designated with the 
.C -X \f2AttributesFileName\f4
option.
.PP
.TP
.C attributes\f2=AttributesFileName\f4
Causes the designated attributes file to be read.
.PP
.C class\f2=ObjectClass
.ft
.IP
Where \f2ObjectClass\f1
may be
.C printer
,
.C queue
,
.C job
, or
.C server.
.IP
Specifies the object class that you want to pause.  Within the
valid classes, 
.C printer 
is a physical printer, and a 
.C server 
is
either a spooler or a supervisor.
.PP
.TP
.tr ~"
.CR message\f2=\~MessageText\f4~
.tr ~~
Specifies the message you want associated with the specified
.CR printer , 
.CR queue , 
.CR job , 
or 
.C server 
that is being paused.  You may use this message to indicate the reason that 
a pause has taken place or to provide other comments.
.PP
.IP
When pausing a supervisor, 
.CR HPDPS 
propagates the message to the
.C message 
attribute of the physical printers residing in a
supervisor.  The 
.C message 
attribute for the supervisor is not
changed.  When pausing a spooler, the message is propagated to
the message attribute of the queues residing in the spooler.
The 
.C message 
attribute for the spooler is not changed.
.PP
.IP
If the command operates on a 
.C printer 
or a 
.C queue 
you can list 
this message by specifying 
.CR requested-attributes=message 
with the
.C  pdls 
command.
.PP
.IP
When the command operates on a 
.CR job , 
the specified text becomes
the value of the 
.C job-message-from-administrator 
attribute.  You can list this message by specifying
.CR requested-attributes=job-message-from-administrator 
with the
.C pdls 
command.
.PP
.IP
If the message attribute is not specified, the message already
stored with the 
.CR printer , 
.CR queue , 
.CR job , 
or 
.C server 
remains
unchanged.
.PP
.SS Object Attribute        
.PP
There are no object attributes for this command.
.PP
.SS Arguments
You use the arguments to identify the specific object you want to pause.
If you specify multiple objects, all of the objects must be of the same
class, and each must be separated by spaces.
.PP
You can use the following argument values with the 
.C pdpause 
command:
.PP
\f2LocalJobId... | GlobalJobId...\f4
.PP
.IP
Specifies the jobs you want to pause as determined by a local
job identifier or global job identifier.  Only you as an
administrator have the authority to pause jobs and would
generally use the global job identifier.  However, for your own
jobs, you can use the local job identifier.  The following
actions take place when:
.PP
.TP
.C \ \ \ \ \ A currently printing job is paused:
.PP
.tr ~"
    \ \(bu   The job stops at a \~pause\~ point,
.tr ~"
.PP
.CR \ \ \ \ \ NOTE :  
.IP
A pause point may be the next page, sheet,
document, or job boundary depending on the type of
printer on which the job is being printed
.PP
    \ \(bu   The job-state changes to paused
.PP
    \ \(bu   The printer remains available to accept work
.PP
    \ \(bu   Other jobs can be assigned to the printer
.PP
.TP
.C \ \ \ \ \ A pending job is paused:
The job is prevented from being scheduled but does not affect any printer.
.PP
.TP
.C \ \ \ \ \ A held job is paused:
The job is prevented from becoming pending, even if the reasons for the 
job being held are removed.  For example, the specified 
.C print-after 
time expires.
.IP
Paused jobs remain in the queue until they are resumed or
cancelled.  A paused job can be modified, but it cannot be
resubmitted until a 
.C pdresume 
command is issued for the job.
.PP
.TP
\f2[ServerName:]PrinterName\f4
Specifies the printers you want to pause.  The action taken
differs whether the 
.C -j 
option is included in the command.
.PP 
.IP
Without the 
.C -j 
option: 
.PP
.IP
\(bu   Any currently-printing job stops at a "pause" point
.PP
.IP
\(bu   The printer-state is changed to paused
.PP
.IP
\(bu   The job-state is left at processing; the job is still
assigned to the printer.
.PP
.IP
The physical printer still accepts print jobs from its
associated queue up to the 
.C maximum-concurrent-jobs 
limit,
but will not print them.
.IP
With the 
.C -j 
option:
.PP
     \(bu   The job stops at a "pause" point,
.PP
.TP
.CR \ \ \ \ \ NOTE :  
A pause point may be the next page, sheet, document, or job boundary depending on the type of printer on which the job is being printed
.PP
     \(bu   The job-state changes to paused
.PP
     \(bu   The printer remains available to accept work
.PP
     \(bu   Other jobs can be assigned to the printer
.PP
.IP
The physical printer may still accept print jobs from its
associated queue and process them.
.PP
.TP
.CR \ \ \ \ \ NOTE :  
.IP
Logical printers cannot be paused because they do not
hold jobs.
.PP
.TP
\f2[ServerName:]QueueName\f4
Specifies the queues you want to pause.
.PP
.IP
Pausing a queue halts the distribution of jobs from the queue to
the physical printers associated with the queue.  Pausing a
queue does not prevent it from accepting jobs from its
associated logical printers.
.PP
.TP
\f2ServerName\f4
Specifies the server on which you want the command to operate.
A server does not have a paused state.  Issuing the command
against a spooler pauses all queues contained within the
spooler.
Issuing the command against a supervisor pauses all of physical
printers contained within the supervisor.
.PP
.SH EXAMPLES
.PP
.SS Pause a Physical Printer  
.PP
\(bu   To pause physical printer 3828C and include a printer message as 
to why the printer is being paused, enter the following command:
.PP
.IP
.C "pdpause -m ""Toner is low, refilling"" 3828C"
.PP
.TP
.SS Pause a Currently Printing Job
.PP
.TP
\(bu   To pause the currently-printing job on printer 3828C, enter the
following command:
.PP
.C    pdpause -j 3828C
.PP
.SS Pause a Queue     
.PP
.TP
\(bu   To pause the queue Div1Q2, enter the following command:
.PP
.C     pdpause -c queue  Div1Q2
.PP
.TP
\(bu   To pause all of the queues in spooler DivSpool1, enter the 
following command:
.PP
.C    pdpause -c server  DivSpool1
.PP
.SH SEE ALSO
pdclean(1), pdcreate(1), pddelete(1), pddisable(1), pdenable(1), pdls(1), pdmod(1),
pdpr(1), pdpromote(1), pdq(1), pdresubmit(1), pdresume(1), pdrm(1), pdset(1),
pdshutdown(1)
.PP
.SH STANDARDS CONFORMANCE
.CR pdpause ": POSIX 1387.4"
.\" index@\f4pdpause\f1 \- pauses jobs, physical printers, servers, or queues@@@\f3pdpause(1)\f1
.\" index@\f1pauses jobs, physical printers, servers, or queues@@@\f3pdpause(1)\f1
.\" index@\f1HP Distributed Printer System, pauses jobs, physical printers, servers, or queues@@@\f3pdpause(1)\f1
.\"
.\" toc@\f3pdpause(1)\f1:\0\0\f4pdpause\f1@@@pauses jobs, physical printers, servers, or queues
.\"
.\"
.\"
