xref: /aosp_15_r20/external/libcups/doc/help/spec-ipp.html (revision 5e7646d21f1134fb0638875d812ef646c12ab91e)
1*5e7646d2SAndroid Build Coastguard Worker<!DOCTYPE HTML>
2*5e7646d2SAndroid Build Coastguard Worker<html>
3*5e7646d2SAndroid Build Coastguard Worker<!-- SECTION: Specifications -->
4*5e7646d2SAndroid Build Coastguard Worker<head>
5*5e7646d2SAndroid Build Coastguard Worker	<title>CUPS Implementation of IPP</title>
6*5e7646d2SAndroid Build Coastguard Worker	<meta name='keywords' content='Programming, Internet Printing Protocol'>
7*5e7646d2SAndroid Build Coastguard Worker	<LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
8*5e7646d2SAndroid Build Coastguard Worker</head>
9*5e7646d2SAndroid Build Coastguard Worker<body>
10*5e7646d2SAndroid Build Coastguard Worker<!--
11*5e7646d2SAndroid Build Coastguard Worker  IPP specification for CUPS.
12*5e7646d2SAndroid Build Coastguard Worker
13*5e7646d2SAndroid Build Coastguard Worker  Copyright © 2007-2016 by Apple Inc.
14*5e7646d2SAndroid Build Coastguard Worker  Copyright © 1997-2007 by Easy Software Products.
15*5e7646d2SAndroid Build Coastguard Worker
16*5e7646d2SAndroid Build Coastguard Worker  Licensed under Apache License v2.0.  See the file "LICENSE" for more
17*5e7646d2SAndroid Build Coastguard Worker  information.
18*5e7646d2SAndroid Build Coastguard Worker-->
19*5e7646d2SAndroid Build Coastguard Worker
20*5e7646d2SAndroid Build Coastguard Worker<H1 CLASS="title">CUPS Implementation of IPP</H1>
21*5e7646d2SAndroid Build Coastguard Worker
22*5e7646d2SAndroid Build Coastguard Worker<h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2>
23*5e7646d2SAndroid Build Coastguard Worker
24*5e7646d2SAndroid Build Coastguard Worker<p>CUPS implements <a href="http://ftp.pwg.org/pub/pwg/standards/std-ipp20-20151030-5100.12.pdf">IPP/2.1</a> and the operations and attributes defined in the following specifications:</p>
25*5e7646d2SAndroid Build Coastguard Worker
26*5e7646d2SAndroid Build Coastguard Worker<ul>
27*5e7646d2SAndroid Build Coastguard Worker
28*5e7646d2SAndroid Build Coastguard Worker	<li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext10-20101030-5100.11.pdf">PWG 5100.11: IPP Job and Printer Extensions - Set 2 (JPS2)</a> (all operations plus the "job-creation-attributes-supported", "job-ids", "job-password", "job-password-encryption", "media-col-database", and "which-jobs" attributes)</li>
29*5e7646d2SAndroid Build Coastguard Worker
30*5e7646d2SAndroid Build Coastguard Worker	<li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext3v10-20120727-5100.13.pdf">PWG 5100.13: IPP Job and Printer Extensions - Set 3 (JPS3)</a> (all operations/attributes required for IPP Everywhere except "printer-geo-location" and "printer-icc-profiles")</li>
31*5e7646d2SAndroid Build Coastguard Worker
32*5e7646d2SAndroid Build Coastguard Worker	<li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ippeve10-20130128-5100.14.pdf">PWG 5100.14: IPP Everywhere</a> (conforming to the Client and most of the Printer requirements)</li>
33*5e7646d2SAndroid Build Coastguard Worker
34*5e7646d2SAndroid Build Coastguard Worker	<li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ippfaxout10-20140618-5100.15.pdf">PWG 5100.15: IPP FaxOut Service</a> (for facsimile queues)</li>
35*5e7646d2SAndroid Build Coastguard Worker
36*5e7646d2SAndroid Build Coastguard Worker	<li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ipptrans10-20131108-5100.16.pdf">PWG 5100.16: IPP Transaction-Based Printing Extensions</a></li>
37*5e7646d2SAndroid Build Coastguard Worker
38*5e7646d2SAndroid Build Coastguard Worker	<li><a href="http://tools.ietf.org/html/rfc3995">RFC 3995: IPP: Event Notifications and Subscriptions</a></li>
39*5e7646d2SAndroid Build Coastguard Worker
40*5e7646d2SAndroid Build Coastguard Worker	<li><a href="http://tools.ietf.org/html/rfc3996">RFC 3996: IPP: The 'ippget' Delivery Method for Event Notifications</li>
41*5e7646d2SAndroid Build Coastguard Worker
42*5e7646d2SAndroid Build Coastguard Worker	<li><a href="http://tools.ietf.org/html/rfc3998">RFC 3998: IPP: Job and Printer Administrative Operations</a> (Disable-Printer, Enable-Printer, Hold-New-Jobs, and Release-Held-New-Jobs operations)</li>
43*5e7646d2SAndroid Build Coastguard Worker
44*5e7646d2SAndroid Build Coastguard Worker	<li><a href="http://tools.ietf.org/html/rfc7472">RFC 7472: IPP over HTTPS Transport Binding and 'ipps' URI Scheme</a></li>
45*5e7646d2SAndroid Build Coastguard Worker
46*5e7646d2SAndroid Build Coastguard Worker</ul>
47*5e7646d2SAndroid Build Coastguard Worker
48*5e7646d2SAndroid Build Coastguard Worker<p>CUPS also provides 17 new operations and many new attributes to support multiple IPP printers and printer classes on a single host.</p>
49*5e7646d2SAndroid Build Coastguard Worker
50*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='IPP_URIS'>IPP URIs</a></h3>
51*5e7646d2SAndroid Build Coastguard Worker
52*5e7646d2SAndroid Build Coastguard Worker<p>CUPS supports the "http", "https", "ipp", and "ipps" schemes. The following resource names are used:</p>
53*5e7646d2SAndroid Build Coastguard Worker
54*5e7646d2SAndroid Build Coastguard Worker<dl>
55*5e7646d2SAndroid Build Coastguard Worker
56*5e7646d2SAndroid Build Coastguard Worker	<dt><tt>scheme://hostname:port/</tt></dt>
57*5e7646d2SAndroid Build Coastguard Worker
58*5e7646d2SAndroid Build Coastguard Worker	<dd>Can be used for all "get" operations and for server subscriptions.</dd>
59*5e7646d2SAndroid Build Coastguard Worker
60*5e7646d2SAndroid Build Coastguard Worker	<dt><tt>scheme://hostname:port/admin/</tt></dt>
61*5e7646d2SAndroid Build Coastguard Worker
62*5e7646d2SAndroid Build Coastguard Worker	<dd>Used for all administrative operations.</dd>
63*5e7646d2SAndroid Build Coastguard Worker
64*5e7646d2SAndroid Build Coastguard Worker	<dt><tt>scheme://hostname:port/classes/name</tt></dt>
65*5e7646d2SAndroid Build Coastguard Worker
66*5e7646d2SAndroid Build Coastguard Worker	<dd>Specifies a printer class.</dd>
67*5e7646d2SAndroid Build Coastguard Worker
68*5e7646d2SAndroid Build Coastguard Worker	<dt><tt>scheme://hostname:port/jobs/id</tt></dt>
69*5e7646d2SAndroid Build Coastguard Worker
70*5e7646d2SAndroid Build Coastguard Worker	<dd>Specifies a job.</dd>
71*5e7646d2SAndroid Build Coastguard Worker
72*5e7646d2SAndroid Build Coastguard Worker	<dt><tt>scheme://hostname:port/printers/name</tt></dt>
73*5e7646d2SAndroid Build Coastguard Worker
74*5e7646d2SAndroid Build Coastguard Worker	<dd>Specifies a printer.</dd>
75*5e7646d2SAndroid Build Coastguard Worker
76*5e7646d2SAndroid Build Coastguard Worker</dl>
77*5e7646d2SAndroid Build Coastguard Worker
78*5e7646d2SAndroid Build Coastguard Worker<p>So a typical printer URI would be "ipp://foo.example.com/printers/LaserJet". In addition, the CUPS scheduler also supports (when enabled) normal browser access via "http://foo.example.com:port/" and "https://foo.example.com:port/".</p>
79*5e7646d2SAndroid Build Coastguard Worker
80*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='IPP_OPERATIONS'>CUPS IPP Operations</a></h3>
81*5e7646d2SAndroid Build Coastguard Worker
82*5e7646d2SAndroid Build Coastguard Worker<p>CUPS provides 17 vendor extension operations in addition to most of the standard IPP and registered extension operations:</p>
83*5e7646d2SAndroid Build Coastguard Worker
84*5e7646d2SAndroid Build Coastguard Worker<div class='table'><table align='center' border='1' width='80%'
85*5e7646d2SAndroid Build Coastguard Workersummary='Supported Operations'>
86*5e7646d2SAndroid Build Coastguard Worker<thead>
87*5e7646d2SAndroid Build Coastguard Worker<tr>
88*5e7646d2SAndroid Build Coastguard Worker	<TH VALIGN="TOP">Operation Name</th>
89*5e7646d2SAndroid Build Coastguard Worker	<TH VALIGN="TOP">CUPS</th>
90*5e7646d2SAndroid Build Coastguard Worker	<TH VALIGN="TOP">Code</th>
91*5e7646d2SAndroid Build Coastguard Worker	<TH VALIGN="TOP">Brief Description</th>
92*5e7646d2SAndroid Build Coastguard Worker</tr>
93*5e7646d2SAndroid Build Coastguard Worker</thead>
94*5e7646d2SAndroid Build Coastguard Worker<tbody>
95*5e7646d2SAndroid Build Coastguard Worker<tr>
96*5e7646d2SAndroid Build Coastguard Worker	<td>Print-Job</td>
97*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
98*5e7646d2SAndroid Build Coastguard Worker	<td>0x0002</td>
99*5e7646d2SAndroid Build Coastguard Worker	<td>Print a file.</td>
100*5e7646d2SAndroid Build Coastguard Worker</tr>
101*5e7646d2SAndroid Build Coastguard Worker<tr>
102*5e7646d2SAndroid Build Coastguard Worker	<td>Validate-Job</td>
103*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
104*5e7646d2SAndroid Build Coastguard Worker	<td>0x0004</td>
105*5e7646d2SAndroid Build Coastguard Worker	<td>Validate job attributes.</td>
106*5e7646d2SAndroid Build Coastguard Worker</tr>
107*5e7646d2SAndroid Build Coastguard Worker<tr>
108*5e7646d2SAndroid Build Coastguard Worker	<td>Create-Job</td>
109*5e7646d2SAndroid Build Coastguard Worker	<td>1.1</td>
110*5e7646d2SAndroid Build Coastguard Worker	<td>0x0005</td>
111*5e7646d2SAndroid Build Coastguard Worker	<td>Create a print job.</td>
112*5e7646d2SAndroid Build Coastguard Worker</tr>
113*5e7646d2SAndroid Build Coastguard Worker<tr>
114*5e7646d2SAndroid Build Coastguard Worker	<td>Send-Document</td>
115*5e7646d2SAndroid Build Coastguard Worker	<td>1.1</td>
116*5e7646d2SAndroid Build Coastguard Worker	<td>0x0006</td>
117*5e7646d2SAndroid Build Coastguard Worker	<td>Send a file for a print job.</td>
118*5e7646d2SAndroid Build Coastguard Worker</tr>
119*5e7646d2SAndroid Build Coastguard Worker<tr>
120*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CANCEL_JOB'>Cancel-Job</a></td>
121*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
122*5e7646d2SAndroid Build Coastguard Worker	<td>0x0008</td>
123*5e7646d2SAndroid Build Coastguard Worker	<td>Cancel a print job.</td>
124*5e7646d2SAndroid Build Coastguard Worker</tr>
125*5e7646d2SAndroid Build Coastguard Worker<tr>
126*5e7646d2SAndroid Build Coastguard Worker	<td>Get-Job-Attributes</td>
127*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
128*5e7646d2SAndroid Build Coastguard Worker	<td>0x0009</td>
129*5e7646d2SAndroid Build Coastguard Worker	<td>Get job attributes.</td>
130*5e7646d2SAndroid Build Coastguard Worker</tr>
131*5e7646d2SAndroid Build Coastguard Worker<tr>
132*5e7646d2SAndroid Build Coastguard Worker	<td>Get-Jobs</td>
133*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
134*5e7646d2SAndroid Build Coastguard Worker	<td>0x000A</td>
135*5e7646d2SAndroid Build Coastguard Worker	<td>Get all jobs.</td>
136*5e7646d2SAndroid Build Coastguard Worker</tr>
137*5e7646d2SAndroid Build Coastguard Worker<tr>
138*5e7646d2SAndroid Build Coastguard Worker	<td>Get-Printer-Attributes</td>
139*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
140*5e7646d2SAndroid Build Coastguard Worker	<td>0x000B</td>
141*5e7646d2SAndroid Build Coastguard Worker	<td>Get printer attributes.</td>
142*5e7646d2SAndroid Build Coastguard Worker</tr>
143*5e7646d2SAndroid Build Coastguard Worker<tr>
144*5e7646d2SAndroid Build Coastguard Worker	<td>Hold-Job</td>
145*5e7646d2SAndroid Build Coastguard Worker	<td>1.1</td>
146*5e7646d2SAndroid Build Coastguard Worker	<td>0x000C</td>
147*5e7646d2SAndroid Build Coastguard Worker	<td>Hold a job for printing.</td>
148*5e7646d2SAndroid Build Coastguard Worker</tr>
149*5e7646d2SAndroid Build Coastguard Worker<tr>
150*5e7646d2SAndroid Build Coastguard Worker	<td>Release-Job</td>
151*5e7646d2SAndroid Build Coastguard Worker	<td>1.1</td>
152*5e7646d2SAndroid Build Coastguard Worker	<td>0x000D</td>
153*5e7646d2SAndroid Build Coastguard Worker	<td>Release a job for printing.</td>
154*5e7646d2SAndroid Build Coastguard Worker</tr>
155*5e7646d2SAndroid Build Coastguard Worker<tr>
156*5e7646d2SAndroid Build Coastguard Worker	<td>Restart-Job</td>
157*5e7646d2SAndroid Build Coastguard Worker	<td>1.1</td>
158*5e7646d2SAndroid Build Coastguard Worker	<td>0x000E</td>
159*5e7646d2SAndroid Build Coastguard Worker	<td>Restarts a print job.</td>
160*5e7646d2SAndroid Build Coastguard Worker</tr>
161*5e7646d2SAndroid Build Coastguard Worker<tr>
162*5e7646d2SAndroid Build Coastguard Worker	<td>Pause-Printer</td>
163*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
164*5e7646d2SAndroid Build Coastguard Worker	<td>0x0010</td>
165*5e7646d2SAndroid Build Coastguard Worker	<td>Pause printing on a printer.</td>
166*5e7646d2SAndroid Build Coastguard Worker</tr>
167*5e7646d2SAndroid Build Coastguard Worker<tr>
168*5e7646d2SAndroid Build Coastguard Worker	<td>Resume-Printer</td>
169*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
170*5e7646d2SAndroid Build Coastguard Worker	<td>0x0011</td>
171*5e7646d2SAndroid Build Coastguard Worker	<td>Resume printing on a printer.</td>
172*5e7646d2SAndroid Build Coastguard Worker</tr>
173*5e7646d2SAndroid Build Coastguard Worker<tr>
174*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#PURGE_JOBS'>Purge-Jobs</a></td>
175*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
176*5e7646d2SAndroid Build Coastguard Worker	<td>0x0012</td>
177*5e7646d2SAndroid Build Coastguard Worker	<td>Purge all jobs.</td>
178*5e7646d2SAndroid Build Coastguard Worker</tr>
179*5e7646d2SAndroid Build Coastguard Worker<tr>
180*5e7646d2SAndroid Build Coastguard Worker	<td>Set-Printer-Attributes</td>
181*5e7646d2SAndroid Build Coastguard Worker	<td>1.4</td>
182*5e7646d2SAndroid Build Coastguard Worker	<td>0x0013</td>
183*5e7646d2SAndroid Build Coastguard Worker	<td>Set attributes for a printer.</td>
184*5e7646d2SAndroid Build Coastguard Worker</tr>
185*5e7646d2SAndroid Build Coastguard Worker<tr>
186*5e7646d2SAndroid Build Coastguard Worker	<td>Set-Job-Attributes</td>
187*5e7646d2SAndroid Build Coastguard Worker	<td>1.1</td>
188*5e7646d2SAndroid Build Coastguard Worker	<td>0x0014</td>
189*5e7646d2SAndroid Build Coastguard Worker	<td>Set attributes for a pending or held job.</td>
190*5e7646d2SAndroid Build Coastguard Worker</tr>
191*5e7646d2SAndroid Build Coastguard Worker<tr>
192*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CREATE_PRINTER_SUBSCRIPTION'>Create-Printer-Subscription</a></td>
193*5e7646d2SAndroid Build Coastguard Worker	<td>1.2</td>
194*5e7646d2SAndroid Build Coastguard Worker	<td>0x0016</td>
195*5e7646d2SAndroid Build Coastguard Worker	<td>Creates a subscription associated with a printer or the server.</td>
196*5e7646d2SAndroid Build Coastguard Worker</tr>
197*5e7646d2SAndroid Build Coastguard Worker<tr>
198*5e7646d2SAndroid Build Coastguard Worker	<td>Create-Job-Subscription</td>
199*5e7646d2SAndroid Build Coastguard Worker	<td>1.2</td>
200*5e7646d2SAndroid Build Coastguard Worker	<td>0x0017</td>
201*5e7646d2SAndroid Build Coastguard Worker	<td>Creates a subscription associated with a job.</td>
202*5e7646d2SAndroid Build Coastguard Worker</tr>
203*5e7646d2SAndroid Build Coastguard Worker<tr>
204*5e7646d2SAndroid Build Coastguard Worker	<td>Get-Subscription-Attributes</td>
205*5e7646d2SAndroid Build Coastguard Worker	<td>1.2</td>
206*5e7646d2SAndroid Build Coastguard Worker	<td>0x0018</td>
207*5e7646d2SAndroid Build Coastguard Worker	<td>Gets the attributes for a subscription.</td>
208*5e7646d2SAndroid Build Coastguard Worker</tr>
209*5e7646d2SAndroid Build Coastguard Worker<tr>
210*5e7646d2SAndroid Build Coastguard Worker	<td>Get-Subscriptions</td>
211*5e7646d2SAndroid Build Coastguard Worker	<td>1.2</td>
212*5e7646d2SAndroid Build Coastguard Worker	<td>0x0019</td>
213*5e7646d2SAndroid Build Coastguard Worker	<td>Gets the attributes for zero or more subscriptions.</td>
214*5e7646d2SAndroid Build Coastguard Worker</tr>
215*5e7646d2SAndroid Build Coastguard Worker<tr>
216*5e7646d2SAndroid Build Coastguard Worker	<td>Renew-Subscription</td>
217*5e7646d2SAndroid Build Coastguard Worker	<td>1.2</td>
218*5e7646d2SAndroid Build Coastguard Worker	<td>0x001A</td>
219*5e7646d2SAndroid Build Coastguard Worker	<td>Renews a subscription.</td>
220*5e7646d2SAndroid Build Coastguard Worker</tr>
221*5e7646d2SAndroid Build Coastguard Worker<tr>
222*5e7646d2SAndroid Build Coastguard Worker	<td>Cancel-Subscription</td>
223*5e7646d2SAndroid Build Coastguard Worker	<td>1.2</td>
224*5e7646d2SAndroid Build Coastguard Worker	<td>0x001B</td>
225*5e7646d2SAndroid Build Coastguard Worker	<td>Cancels a subscription.</td>
226*5e7646d2SAndroid Build Coastguard Worker</tr>
227*5e7646d2SAndroid Build Coastguard Worker<tr>
228*5e7646d2SAndroid Build Coastguard Worker	<td>Get-Notifications</td>
229*5e7646d2SAndroid Build Coastguard Worker	<td>1.2</td>
230*5e7646d2SAndroid Build Coastguard Worker	<td>0x001C</td>
231*5e7646d2SAndroid Build Coastguard Worker	<td>Get notification events for <tt>ippget</tt> subscriptions.</td>
232*5e7646d2SAndroid Build Coastguard Worker</tr>
233*5e7646d2SAndroid Build Coastguard Worker<tr>
234*5e7646d2SAndroid Build Coastguard Worker	<td>Enable-Printer</td>
235*5e7646d2SAndroid Build Coastguard Worker	<td>1.2</td>
236*5e7646d2SAndroid Build Coastguard Worker	<td>0x0022</td>
237*5e7646d2SAndroid Build Coastguard Worker	<td>Accepts jobs on a printer.</td>
238*5e7646d2SAndroid Build Coastguard Worker</tr>
239*5e7646d2SAndroid Build Coastguard Worker<tr>
240*5e7646d2SAndroid Build Coastguard Worker	<td>Disable-Printer</td>
241*5e7646d2SAndroid Build Coastguard Worker	<td>1.2</td>
242*5e7646d2SAndroid Build Coastguard Worker	<td>0x0023</td>
243*5e7646d2SAndroid Build Coastguard Worker	<td>Rejects jobs on a printer.</td>
244*5e7646d2SAndroid Build Coastguard Worker</tr>
245*5e7646d2SAndroid Build Coastguard Worker<tr>
246*5e7646d2SAndroid Build Coastguard Worker	<td>Hold-New-Jobs</td>
247*5e7646d2SAndroid Build Coastguard Worker	<td>1.4</td>
248*5e7646d2SAndroid Build Coastguard Worker	<td>0x0025</td>
249*5e7646d2SAndroid Build Coastguard Worker	<td>Hold new jobs by default.</td>
250*5e7646d2SAndroid Build Coastguard Worker</tr>
251*5e7646d2SAndroid Build Coastguard Worker<tr>
252*5e7646d2SAndroid Build Coastguard Worker	<td>Release-Held-New-Jobs</td>
253*5e7646d2SAndroid Build Coastguard Worker	<td>1.4</td>
254*5e7646d2SAndroid Build Coastguard Worker	<td>0x0026</td>
255*5e7646d2SAndroid Build Coastguard Worker	<td>Releases all jobs that were previously held.</td>
256*5e7646d2SAndroid Build Coastguard Worker</tr>
257*5e7646d2SAndroid Build Coastguard Worker<tr>
258*5e7646d2SAndroid Build Coastguard Worker	<td>Cancel-Jobs</td>
259*5e7646d2SAndroid Build Coastguard Worker	<td>1.5</td>
260*5e7646d2SAndroid Build Coastguard Worker	<td>0x0038</td>
261*5e7646d2SAndroid Build Coastguard Worker	<td>Cancel all jobs (administrator).</td>
262*5e7646d2SAndroid Build Coastguard Worker</tr>
263*5e7646d2SAndroid Build Coastguard Worker<tr>
264*5e7646d2SAndroid Build Coastguard Worker	<td>Cancel-My-Jobs</td>
265*5e7646d2SAndroid Build Coastguard Worker	<td>1.5</td>
266*5e7646d2SAndroid Build Coastguard Worker	<td>0x0039</td>
267*5e7646d2SAndroid Build Coastguard Worker	<td>Cancel all jobs (user).</td>
268*5e7646d2SAndroid Build Coastguard Worker</tr>
269*5e7646d2SAndroid Build Coastguard Worker<tr>
270*5e7646d2SAndroid Build Coastguard Worker	<td>Close-Job</td>
271*5e7646d2SAndroid Build Coastguard Worker	<td>1.5</td>
272*5e7646d2SAndroid Build Coastguard Worker	<td>0x003b</td>
273*5e7646d2SAndroid Build Coastguard Worker	<td>Close a created job.</td>
274*5e7646d2SAndroid Build Coastguard Worker</tr>
275*5e7646d2SAndroid Build Coastguard Worker<tr>
276*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_GET_DEFAULT'>CUPS-Get-Default</a></td>
277*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
278*5e7646d2SAndroid Build Coastguard Worker	<td>0x4001</td>
279*5e7646d2SAndroid Build Coastguard Worker	<td>Get the default destination.</td>
280*5e7646d2SAndroid Build Coastguard Worker</tr>
281*5e7646d2SAndroid Build Coastguard Worker<tr>
282*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_GET_PRINTERS'>CUPS-Get-Printers</a></td>
283*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
284*5e7646d2SAndroid Build Coastguard Worker	<td>0x4002</td>
285*5e7646d2SAndroid Build Coastguard Worker	<td>Get all of the available printers.</td>
286*5e7646d2SAndroid Build Coastguard Worker</tr>
287*5e7646d2SAndroid Build Coastguard Worker<tr>
288*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_ADD_MODIFY_PRINTER'>CUPS-Add-Modify-Printer</a></td>
289*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
290*5e7646d2SAndroid Build Coastguard Worker	<td>0x4003</td>
291*5e7646d2SAndroid Build Coastguard Worker	<td>Add or modify a printer.</td>
292*5e7646d2SAndroid Build Coastguard Worker</tr>
293*5e7646d2SAndroid Build Coastguard Worker<tr>
294*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_DELETE_PRINTER'>CUPS-Delete-Printer</a></td>
295*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
296*5e7646d2SAndroid Build Coastguard Worker	<td>0x4004</td>
297*5e7646d2SAndroid Build Coastguard Worker	<td>Delete a printer.</td>
298*5e7646d2SAndroid Build Coastguard Worker</tr>
299*5e7646d2SAndroid Build Coastguard Worker<tr>
300*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_GET_CLASSES'>CUPS-Get-Classes</a></td>
301*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
302*5e7646d2SAndroid Build Coastguard Worker	<td>0x4005</td>
303*5e7646d2SAndroid Build Coastguard Worker	<td>Get all of the available printer classes.</td>
304*5e7646d2SAndroid Build Coastguard Worker</tr>
305*5e7646d2SAndroid Build Coastguard Worker<tr>
306*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_ADD_MODIFY_CLASS'>CUPS-Add-Modify-Class</a></td>
307*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
308*5e7646d2SAndroid Build Coastguard Worker	<td>0x4006</td>
309*5e7646d2SAndroid Build Coastguard Worker	<td>Add or modify a printer class.</td>
310*5e7646d2SAndroid Build Coastguard Worker</tr>
311*5e7646d2SAndroid Build Coastguard Worker<tr>
312*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_DELETE_CLASS'>CUPS-Delete-Class</a></td>
313*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
314*5e7646d2SAndroid Build Coastguard Worker	<td>0x4007</td>
315*5e7646d2SAndroid Build Coastguard Worker	<td>Delete a printer class.</td>
316*5e7646d2SAndroid Build Coastguard Worker</tr>
317*5e7646d2SAndroid Build Coastguard Worker<tr>
318*5e7646d2SAndroid Build Coastguard Worker	<td>CUPS-Accept-Jobs</td>
319*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
320*5e7646d2SAndroid Build Coastguard Worker	<td>0x4008</td>
321*5e7646d2SAndroid Build Coastguard Worker	<td>Accept jobs on a printer or printer class. This operation is deprecated - use the Enable-Printer operation instead.</td>
322*5e7646d2SAndroid Build Coastguard Worker</tr>
323*5e7646d2SAndroid Build Coastguard Worker<tr>
324*5e7646d2SAndroid Build Coastguard Worker	<td>CUPS-Reject-Jobs</td>
325*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
326*5e7646d2SAndroid Build Coastguard Worker	<td>0x4009</td>
327*5e7646d2SAndroid Build Coastguard Worker	<td>Reject jobs on a printer or printer class. This operation is deprecated - use the Disable-Printer operation instead.</td>
328*5e7646d2SAndroid Build Coastguard Worker</tr>
329*5e7646d2SAndroid Build Coastguard Worker<tr>
330*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_SET_DEFAULT'>CUPS-Set-Default</a></td>
331*5e7646d2SAndroid Build Coastguard Worker	<td>1.0</td>
332*5e7646d2SAndroid Build Coastguard Worker	<td>0x400A</td>
333*5e7646d2SAndroid Build Coastguard Worker	<td>Set the default destination.</td>
334*5e7646d2SAndroid Build Coastguard Worker</tr>
335*5e7646d2SAndroid Build Coastguard Worker<tr>
336*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_GET_DEVICES'>CUPS-Get-Devices</a></td>
337*5e7646d2SAndroid Build Coastguard Worker	<td>1.1</td>
338*5e7646d2SAndroid Build Coastguard Worker	<td>0x400B</td>
339*5e7646d2SAndroid Build Coastguard Worker	<td>Get all of the available devices.</td>
340*5e7646d2SAndroid Build Coastguard Worker</tr>
341*5e7646d2SAndroid Build Coastguard Worker<tr>
342*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_GET_PPDS'>CUPS-Get-PPDs</a></td>
343*5e7646d2SAndroid Build Coastguard Worker	<td>1.1</td>
344*5e7646d2SAndroid Build Coastguard Worker	<td>0x400C</td>
345*5e7646d2SAndroid Build Coastguard Worker	<td>Get all of the available PPDs.</td>
346*5e7646d2SAndroid Build Coastguard Worker</tr>
347*5e7646d2SAndroid Build Coastguard Worker<tr>
348*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_MOVE_JOB'>CUPS-Move-Job</a></td>
349*5e7646d2SAndroid Build Coastguard Worker	<td>1.1</td>
350*5e7646d2SAndroid Build Coastguard Worker	<td>0x400D</td>
351*5e7646d2SAndroid Build Coastguard Worker	<td>Move a job to a different printer.</td>
352*5e7646d2SAndroid Build Coastguard Worker</tr>
353*5e7646d2SAndroid Build Coastguard Worker<tr>
354*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job</a></td>
355*5e7646d2SAndroid Build Coastguard Worker	<td>1.2</td>
356*5e7646d2SAndroid Build Coastguard Worker	<td>0x400E</td>
357*5e7646d2SAndroid Build Coastguard Worker	<td>Authenticate a job for printing.</td>
358*5e7646d2SAndroid Build Coastguard Worker</tr>
359*5e7646d2SAndroid Build Coastguard Worker<tr>
360*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_GET_PPD'>CUPS-Get-PPD</a></td>
361*5e7646d2SAndroid Build Coastguard Worker	<td>1.3</td>
362*5e7646d2SAndroid Build Coastguard Worker	<td>0x400F</td>
363*5e7646d2SAndroid Build Coastguard Worker	<td>Get a PPD file.</td>
364*5e7646d2SAndroid Build Coastguard Worker</tr>
365*5e7646d2SAndroid Build Coastguard Worker<tr>
366*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_GET_DOCUMENT'>CUPS-Get-Document</a></td>
367*5e7646d2SAndroid Build Coastguard Worker	<td>1.4</td>
368*5e7646d2SAndroid Build Coastguard Worker	<td>0x4027</td>
369*5e7646d2SAndroid Build Coastguard Worker	<td>Get a document file from a job.</td>
370*5e7646d2SAndroid Build Coastguard Worker</tr>
371*5e7646d2SAndroid Build Coastguard Worker<tr>
372*5e7646d2SAndroid Build Coastguard Worker	<td><a href='#CUPS_CREATE_LOCAL_PRINTER'>CUPS-Create-Local-Printer</a></td>
373*5e7646d2SAndroid Build Coastguard Worker	<td>2.2</td>
374*5e7646d2SAndroid Build Coastguard Worker	<td>0x4028</td>
375*5e7646d2SAndroid Build Coastguard Worker	<td>Creates a local (temporary) print queue pointing to a remote IPP Everywhere printer.</td>
376*5e7646d2SAndroid Build Coastguard Worker</tr>
377*5e7646d2SAndroid Build Coastguard Worker</tbody>
378*5e7646d2SAndroid Build Coastguard Worker</table></div>
379*5e7646d2SAndroid Build Coastguard Worker
380*5e7646d2SAndroid Build Coastguard Worker<h2 class='title'><a name='OPERATIONS'>Operations</a></h2>
381*5e7646d2SAndroid Build Coastguard Worker
382*5e7646d2SAndroid Build Coastguard Worker<p>The following sections describe the operations supported by CUPS. In the interest of brevity, operations which use only the standard IPP attributes are not described.
383*5e7646d2SAndroid Build Coastguard Worker
384*5e7646d2SAndroid Build Coastguard Worker
385*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='CANCEL_JOB'>Cancel Job Operation (Extension)</a></h3>
386*5e7646d2SAndroid Build Coastguard Worker
387*5e7646d2SAndroid Build Coastguard Worker<p>The Cancel-Job operation (0x0008) cancels the specified job. CUPS 1.4 added support for the <tt>purge-job (boolean)</tt> operation attribute that (if 'true') removes all history and document files for the job as well.</p>
388*5e7646d2SAndroid Build Coastguard Worker
389*5e7646d2SAndroid Build Coastguard Worker
390*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='PURGE_JOBS'>Purge-Jobs Operation</a></h3>
391*5e7646d2SAndroid Build Coastguard Worker
392*5e7646d2SAndroid Build Coastguard Worker<p>The Purge-Jobs operation (0x0012) cancels all of the jobs on a given destination and optionally removes all history and document files for the jobs as well. CUPS 1.2 added support for the <tt>purge-job (boolean)</tt> operation attribute that (if 'false') retains all history and document files for the canceled jobs.</p>
393*5e7646d2SAndroid Build Coastguard Worker
394*5e7646d2SAndroid Build Coastguard Worker<blockquote><b>Note:</b>
395*5e7646d2SAndroid Build Coastguard Worker	<p>The Cancel-Jobs and Cancel-My-Jobs operations should be used instead of Purge-Jobs.</p>
396*5e7646d2SAndroid Build Coastguard Worker</blockquote>
397*5e7646d2SAndroid Build Coastguard Worker
398*5e7646d2SAndroid Build Coastguard Worker
399*5e7646d2SAndroid Build Coastguard Worker
400*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><span class='info'>CUPS 1.2/macOS 10.5</span><a
401*5e7646d2SAndroid Build Coastguard Workername='CREATE_PRINTER_SUBSCRIPTION'>Create-Printer-Subscription</a></h3>
402*5e7646d2SAndroid Build Coastguard Worker
403*5e7646d2SAndroid Build Coastguard Worker<p>The Create-Printer-Subscription operation (0x0016) creates a subscription for printer or server event notifications. CUPS provides several additional events in addition to the standard events in the IPP notifications specification. CUPS adds the following <tt>notify-events (1setOf type2 keyword)</tt> values:<p>
404*5e7646d2SAndroid Build Coastguard Worker
405*5e7646d2SAndroid Build Coastguard Worker<ul>
406*5e7646d2SAndroid Build Coastguard Worker
407*5e7646d2SAndroid Build Coastguard Worker	<li><tt>printer-added</tt> - Get notified whenever a printer or class is added</li>
408*5e7646d2SAndroid Build Coastguard Worker
409*5e7646d2SAndroid Build Coastguard Worker	<li><tt>printer-deleted</tt> - Get notified whenever a printer or class is deleted</li>
410*5e7646d2SAndroid Build Coastguard Worker
411*5e7646d2SAndroid Build Coastguard Worker	<li><tt>printer-modified</tt> - Get notified whenever a printer or class is modified</li>
412*5e7646d2SAndroid Build Coastguard Worker
413*5e7646d2SAndroid Build Coastguard Worker	<li><tt>server-audit</tt> - Get notified when a security condition occurs</li>
414*5e7646d2SAndroid Build Coastguard Worker
415*5e7646d2SAndroid Build Coastguard Worker	<li><tt>server-restarted</tt> - Get notified when the server is restarted</li>
416*5e7646d2SAndroid Build Coastguard Worker
417*5e7646d2SAndroid Build Coastguard Worker	<li><tt>server-started</tt> - Get notified when the server is started</li>
418*5e7646d2SAndroid Build Coastguard Worker
419*5e7646d2SAndroid Build Coastguard Worker	<li><tt>server-stopped</tt> - Get notified when the server is stopped</li>
420*5e7646d2SAndroid Build Coastguard Worker
421*5e7646d2SAndroid Build Coastguard Worker</ul>
422*5e7646d2SAndroid Build Coastguard Worker
423*5e7646d2SAndroid Build Coastguard Worker
424*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='CUPS_GET_DEFAULT'>CUPS-Get-Default Operation</a></h3>
425*5e7646d2SAndroid Build Coastguard Worker
426*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Get-Default operation (0x4001) returns the default printer URI and attributes.
427*5e7646d2SAndroid Build Coastguard Worker
428*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-Default Request</h4>
429*5e7646d2SAndroid Build Coastguard Worker
430*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are supplied as part of the CUPS-Get-Default request:
431*5e7646d2SAndroid Build Coastguard Worker
432*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
433*5e7646d2SAndroid Build Coastguard Worker
434*5e7646d2SAndroid Build Coastguard Worker<dl>
435*5e7646d2SAndroid Build Coastguard Worker
436*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
437*5e7646d2SAndroid Build Coastguard Worker
438*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
439*5e7646d2SAndroid Build Coastguard Worker
440*5e7646d2SAndroid Build Coastguard Worker	<dt>"requested-attributes" (1setOf keyword):
441*5e7646d2SAndroid Build Coastguard Worker
442*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a set of attribute names and/or attribute group names in whose values the requester is interested. If the client omits this attribute, the server responds as if this attribute had been supplied with a value of 'all'.
443*5e7646d2SAndroid Build Coastguard Worker
444*5e7646d2SAndroid Build Coastguard Worker</dl>
445*5e7646d2SAndroid Build Coastguard Worker
446*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-Default Response</h4>
447*5e7646d2SAndroid Build Coastguard Worker
448*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are send as part of the CUPS-Get-Default Response:
449*5e7646d2SAndroid Build Coastguard Worker
450*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
451*5e7646d2SAndroid Build Coastguard Worker
452*5e7646d2SAndroid Build Coastguard Worker<dl>
453*5e7646d2SAndroid Build Coastguard Worker
454*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
455*5e7646d2SAndroid Build Coastguard Worker
456*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
457*5e7646d2SAndroid Build Coastguard Worker
458*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
459*5e7646d2SAndroid Build Coastguard Worker
460*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
461*5e7646d2SAndroid Build Coastguard Worker
462*5e7646d2SAndroid Build Coastguard Worker</dl>
463*5e7646d2SAndroid Build Coastguard Worker
464*5e7646d2SAndroid Build Coastguard Worker<p>Group 2: Printer Object Attributes
465*5e7646d2SAndroid Build Coastguard Worker
466*5e7646d2SAndroid Build Coastguard Worker<dl>
467*5e7646d2SAndroid Build Coastguard Worker
468*5e7646d2SAndroid Build Coastguard Worker	<dt>The set of requested attributes and their current values.
469*5e7646d2SAndroid Build Coastguard Worker
470*5e7646d2SAndroid Build Coastguard Worker</dl>
471*5e7646d2SAndroid Build Coastguard Worker
472*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='CUPS_GET_PRINTERS'>CUPS-Get-Printers Operation</a></h3>
473*5e7646d2SAndroid Build Coastguard Worker
474*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Get-Printers operation (0x4002) returns the printer attributes for every printer known to the system. This may include printers that are not served directly by the server.
475*5e7646d2SAndroid Build Coastguard Worker
476*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-Printers Request</h4>
477*5e7646d2SAndroid Build Coastguard Worker
478*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are supplied as part of the CUPS-Get-Printers request:
479*5e7646d2SAndroid Build Coastguard Worker
480*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
481*5e7646d2SAndroid Build Coastguard Worker
482*5e7646d2SAndroid Build Coastguard Worker<dl>
483*5e7646d2SAndroid Build Coastguard Worker
484*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
485*5e7646d2SAndroid Build Coastguard Worker
486*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
487*5e7646d2SAndroid Build Coastguard Worker
488*5e7646d2SAndroid Build Coastguard Worker	<dt>"first-printer-name" (name(127)): <span class='info'>CUPS 1.2/macOS 10.5</span>
489*5e7646d2SAndroid Build Coastguard Worker
490*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute to select the first printer that is returned.
491*5e7646d2SAndroid Build Coastguard Worker
492*5e7646d2SAndroid Build Coastguard Worker	<dt>"limit" (integer (1:MAX)):
493*5e7646d2SAndroid Build Coastguard Worker
494*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute limiting the number of printers that are returned.
495*5e7646d2SAndroid Build Coastguard Worker
496*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-id" (integer(0:65535)): <span class='info'>CUPS 2.2</span>
497*5e7646d2SAndroid Build Coastguard Worker
498*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute to select which printer is returned.
499*5e7646d2SAndroid Build Coastguard Worker
500*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-location" (text(127)): <span class='info'>CUPS 1.1.7</span>
501*5e7646d2SAndroid Build Coastguard Worker
502*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute to select which printers are returned.
503*5e7646d2SAndroid Build Coastguard Worker
504*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-type" (type2 enum): <span class='info'>CUPS 1.1.7</span>
505*5e7646d2SAndroid Build Coastguard Worker
506*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a printer type enumeration to select which printers are returned.
507*5e7646d2SAndroid Build Coastguard Worker
508*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-type-mask" (type2 enum): <span class='info'>CUPS 1.1.7</span>
509*5e7646d2SAndroid Build Coastguard Worker
510*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a printer type mask enumeration to select which bits are used in the "printer-type" attribute.
511*5e7646d2SAndroid Build Coastguard Worker
512*5e7646d2SAndroid Build Coastguard Worker	<dt>"requested-attributes" (1setOf keyword):
513*5e7646d2SAndroid Build Coastguard Worker
514*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a set of attribute names and/or attribute group names in whose values the requester is interested. If the client omits this attribute, the server responds as if this attribute had been supplied with a value of 'all'.
515*5e7646d2SAndroid Build Coastguard Worker
516*5e7646d2SAndroid Build Coastguard Worker	<dt>"requested-user-name" (name(127)): <span class='info'>CUPS 1.2/macOS 10.5</span>
517*5e7646d2SAndroid Build Coastguard Worker
518*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a user name that is used to filter the returned printers.
519*5e7646d2SAndroid Build Coastguard Worker
520*5e7646d2SAndroid Build Coastguard Worker</dl>
521*5e7646d2SAndroid Build Coastguard Worker
522*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-Printers Response</h4>
523*5e7646d2SAndroid Build Coastguard Worker
524*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are send as part of the CUPS-Get-Printers Response:
525*5e7646d2SAndroid Build Coastguard Worker
526*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
527*5e7646d2SAndroid Build Coastguard Worker
528*5e7646d2SAndroid Build Coastguard Worker<dl>
529*5e7646d2SAndroid Build Coastguard Worker
530*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
531*5e7646d2SAndroid Build Coastguard Worker
532*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
533*5e7646d2SAndroid Build Coastguard Worker
534*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
535*5e7646d2SAndroid Build Coastguard Worker
536*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
537*5e7646d2SAndroid Build Coastguard Worker
538*5e7646d2SAndroid Build Coastguard Worker</dl>
539*5e7646d2SAndroid Build Coastguard Worker
540*5e7646d2SAndroid Build Coastguard Worker<p>Group 2: Printer Object Attributes
541*5e7646d2SAndroid Build Coastguard Worker
542*5e7646d2SAndroid Build Coastguard Worker<dl>
543*5e7646d2SAndroid Build Coastguard Worker
544*5e7646d2SAndroid Build Coastguard Worker	<dt>The set of requested attributes and their current values for each printer.
545*5e7646d2SAndroid Build Coastguard Worker
546*5e7646d2SAndroid Build Coastguard Worker</dl>
547*5e7646d2SAndroid Build Coastguard Worker
548*5e7646d2SAndroid Build Coastguard Worker
549*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='CUPS_ADD_MODIFY_PRINTER'>CUPS-Add-Modify-Printer Operation</a></h3>
550*5e7646d2SAndroid Build Coastguard Worker
551*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Add-Modify-Printer operation (0x4003) adds a new printer or modifies an existing printer on the system.
552*5e7646d2SAndroid Build Coastguard Worker
553*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Add-Modify-Printer Request</h4>
554*5e7646d2SAndroid Build Coastguard Worker
555*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are supplied as part of the CUPS-Add-Modify-Printer request:
556*5e7646d2SAndroid Build Coastguard Worker
557*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
558*5e7646d2SAndroid Build Coastguard Worker
559*5e7646d2SAndroid Build Coastguard Worker<dl>
560*5e7646d2SAndroid Build Coastguard Worker
561*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
562*5e7646d2SAndroid Build Coastguard Worker
563*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
564*5e7646d2SAndroid Build Coastguard Worker
565*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-uri" (uri):
566*5e7646d2SAndroid Build Coastguard Worker
567*5e7646d2SAndroid Build Coastguard Worker	<dd>The client MUST supply a URI for the specified printer.
568*5e7646d2SAndroid Build Coastguard Worker
569*5e7646d2SAndroid Build Coastguard Worker</dl>
570*5e7646d2SAndroid Build Coastguard Worker
571*5e7646d2SAndroid Build Coastguard Worker<p>Group 2: Printer Object Attributes
572*5e7646d2SAndroid Build Coastguard Worker
573*5e7646d2SAndroid Build Coastguard Worker<dl>
574*5e7646d2SAndroid Build Coastguard Worker
575*5e7646d2SAndroid Build Coastguard Worker	<dt>"auth-info-required" (1setOf type2 keyword): <span class='info'>CUPS 1.3/macOS 10.5</span>
576*5e7646d2SAndroid Build Coastguard Worker
577*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
578*5e7646d2SAndroid Build Coastguard Worker
579*5e7646d2SAndroid Build Coastguard Worker	<dt>"job-sheets-default" (1setOf name(127)): <span class='info'>CUPS 1.1.7</span>
580*5e7646d2SAndroid Build Coastguard Worker
581*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies one or two banner page names that are printed before and after files in a job. The reserved name "none" is used to specify that no banner page should be printed.
582*5e7646d2SAndroid Build Coastguard Worker
583*5e7646d2SAndroid Build Coastguard Worker	<dt>"device-uri" (uri):
584*5e7646d2SAndroid Build Coastguard Worker
585*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a device URI for the specified printer.
586*5e7646d2SAndroid Build Coastguard Worker
587*5e7646d2SAndroid Build Coastguard Worker	<dt>"port-monitor" (name(127)):
588*5e7646d2SAndroid Build Coastguard Worker
589*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a port monitor name for the specified printer.
590*5e7646d2SAndroid Build Coastguard Worker
591*5e7646d2SAndroid Build Coastguard Worker	<dt>"ppd-name" (name(255)):
592*5e7646d2SAndroid Build Coastguard Worker
593*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a PPD name for the specified printer.
594*5e7646d2SAndroid Build Coastguard Worker
595*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-is-accepting-jobs" (boolean):
596*5e7646d2SAndroid Build Coastguard Worker
597*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this boolean attribute indicating whether the printer object should accept new jobs.
598*5e7646d2SAndroid Build Coastguard Worker
599*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-info" (text(127)):
600*5e7646d2SAndroid Build Coastguard Worker
601*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute indicating the printer information string.
602*5e7646d2SAndroid Build Coastguard Worker
603*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-location" (text(127)):
604*5e7646d2SAndroid Build Coastguard Worker
605*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute indicating a textual location of the printer.
606*5e7646d2SAndroid Build Coastguard Worker
607*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-more-info" (uri):
608*5e7646d2SAndroid Build Coastguard Worker
609*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute indicating a URI for additional printer information.
610*5e7646d2SAndroid Build Coastguard Worker
611*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-state" (type2 enum):
612*5e7646d2SAndroid Build Coastguard Worker
613*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute indicating the initial/current state of the printer. Only the 'idle(3)' and 'stopped(5)' enumerations are recognized.
614*5e7646d2SAndroid Build Coastguard Worker
615*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-state-message" (text(MAX)):
616*5e7646d2SAndroid Build Coastguard Worker
617*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute indicating a textual reason for the current printer state.
618*5e7646d2SAndroid Build Coastguard Worker
619*5e7646d2SAndroid Build Coastguard Worker	<dt>"requesting-user-name-allowed" (1setof name(127) | delete)
620*5e7646d2SAndroid Build Coastguard Worker	<br><i>OR</i>
621*5e7646d2SAndroid Build Coastguard Worker	<br>"requesting-user-name-denied" (1setof name(127) | delete):
622*5e7646d2SAndroid Build Coastguard Worker
623*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies one of these attributes to specify an access control list for incoming print jobs. To allow all users access to a printer, use the delete tag for the attribute value.
624*5e7646d2SAndroid Build Coastguard Worker
625*5e7646d2SAndroid Build Coastguard Worker</dl>
626*5e7646d2SAndroid Build Coastguard Worker
627*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Add-Modify-Printer request can optionally be followed by a PPD file to be used for the printer. The "ppd-name" attribute overrides any file that is attached to the end of the request with a local CUPS PPD file.
628*5e7646d2SAndroid Build Coastguard Worker
629*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Add-Modify-Printer Response</h4>
630*5e7646d2SAndroid Build Coastguard Worker
631*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are send as part of the
632*5e7646d2SAndroid Build Coastguard WorkerCUPS-Add-Modify-Printer Response:
633*5e7646d2SAndroid Build Coastguard Worker
634*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
635*5e7646d2SAndroid Build Coastguard Worker
636*5e7646d2SAndroid Build Coastguard Worker<dl>
637*5e7646d2SAndroid Build Coastguard Worker
638*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
639*5e7646d2SAndroid Build Coastguard Worker
640*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
641*5e7646d2SAndroid Build Coastguard Worker
642*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
643*5e7646d2SAndroid Build Coastguard Worker
644*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
645*5e7646d2SAndroid Build Coastguard Worker
646*5e7646d2SAndroid Build Coastguard Worker</dl>
647*5e7646d2SAndroid Build Coastguard Worker
648*5e7646d2SAndroid Build Coastguard Worker
649*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='CUPS_DELETE_PRINTER'>CUPS-Delete-Printer Operation</a></h3>
650*5e7646d2SAndroid Build Coastguard Worker
651*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Delete-Printer operation (0x4004) removes an existing printer from the system.
652*5e7646d2SAndroid Build Coastguard Worker
653*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Delete-Printer Request</h4>
654*5e7646d2SAndroid Build Coastguard Worker
655*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are supplied as part of the CUPS-Delete-Printer request:
656*5e7646d2SAndroid Build Coastguard Worker
657*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
658*5e7646d2SAndroid Build Coastguard Worker
659*5e7646d2SAndroid Build Coastguard Worker<dl>
660*5e7646d2SAndroid Build Coastguard Worker
661*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
662*5e7646d2SAndroid Build Coastguard Worker
663*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
664*5e7646d2SAndroid Build Coastguard Worker
665*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-uri" (uri):
666*5e7646d2SAndroid Build Coastguard Worker
667*5e7646d2SAndroid Build Coastguard Worker	<dd>The client MUST supply a URI for the specified printer.
668*5e7646d2SAndroid Build Coastguard Worker
669*5e7646d2SAndroid Build Coastguard Worker</dl>
670*5e7646d2SAndroid Build Coastguard Worker
671*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Delete-Printer Response</h4>
672*5e7646d2SAndroid Build Coastguard Worker
673*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are send as part of the CUPS-Delete-Printer Response:
674*5e7646d2SAndroid Build Coastguard Worker
675*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
676*5e7646d2SAndroid Build Coastguard Worker
677*5e7646d2SAndroid Build Coastguard Worker<dl>
678*5e7646d2SAndroid Build Coastguard Worker
679*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
680*5e7646d2SAndroid Build Coastguard Worker
681*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
682*5e7646d2SAndroid Build Coastguard Worker
683*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
684*5e7646d2SAndroid Build Coastguard Worker
685*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
686*5e7646d2SAndroid Build Coastguard Worker
687*5e7646d2SAndroid Build Coastguard Worker</dl>
688*5e7646d2SAndroid Build Coastguard Worker
689*5e7646d2SAndroid Build Coastguard Worker
690*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='CUPS_GET_CLASSES'>CUPS-Get-Classes Operation</a></h3>
691*5e7646d2SAndroid Build Coastguard Worker
692*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Get-Classes operation (0x4005) returns the printer attributes for every printer class known to the system. This may include printer classes that are not served directly by the server.
693*5e7646d2SAndroid Build Coastguard Worker
694*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-Classes Request</h4>
695*5e7646d2SAndroid Build Coastguard Worker
696*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are supplied as part of the CUPS-Get-Classes request:
697*5e7646d2SAndroid Build Coastguard Worker
698*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
699*5e7646d2SAndroid Build Coastguard Worker
700*5e7646d2SAndroid Build Coastguard Worker<dl>
701*5e7646d2SAndroid Build Coastguard Worker
702*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
703*5e7646d2SAndroid Build Coastguard Worker
704*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
705*5e7646d2SAndroid Build Coastguard Worker
706*5e7646d2SAndroid Build Coastguard Worker	<dt>"first-printer-name" (name(127)): <span class='info'>CUPS 1.2/macOS 10.5</span>
707*5e7646d2SAndroid Build Coastguard Worker
708*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute to select the first printer that is returned.
709*5e7646d2SAndroid Build Coastguard Worker
710*5e7646d2SAndroid Build Coastguard Worker	<dt>"limit" (integer (1:MAX)):
711*5e7646d2SAndroid Build Coastguard Worker
712*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute limiting the number of printer classes that are returned.
713*5e7646d2SAndroid Build Coastguard Worker
714*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-location" (text(127)): <span class='info'>CUPS 1.1.7</span>
715*5e7646d2SAndroid Build Coastguard Worker
716*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute to select which printer classes are returned.
717*5e7646d2SAndroid Build Coastguard Worker
718*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-type" (type2 enum): <span class='info'>CUPS 1.1.7</span>
719*5e7646d2SAndroid Build Coastguard Worker
720*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a printer type enumeration to select which printer classes are returned.
721*5e7646d2SAndroid Build Coastguard Worker
722*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-type-mask" (type2 enum): <span class='info'>CUPS 1.1.7</span>
723*5e7646d2SAndroid Build Coastguard Worker
724*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a printer type mask enumeration to select which bits are used in the "printer-type" attribute.
725*5e7646d2SAndroid Build Coastguard Worker
726*5e7646d2SAndroid Build Coastguard Worker	<dt>"requested-attributes" (1setOf keyword):
727*5e7646d2SAndroid Build Coastguard Worker
728*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a set of attribute names and/or attribute group names in whose values the requester is interested. If the client omits this attribute, the server responds as if this attribute had been supplied with a value of 'all'.
729*5e7646d2SAndroid Build Coastguard Worker
730*5e7646d2SAndroid Build Coastguard Worker	<dt>"requested-user-name" (name(127)): <span class='info'>CUPS 1.2/macOS 10.5</span>
731*5e7646d2SAndroid Build Coastguard Worker
732*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a user name that is used to filter the returned printers.
733*5e7646d2SAndroid Build Coastguard Worker
734*5e7646d2SAndroid Build Coastguard Worker</dl>
735*5e7646d2SAndroid Build Coastguard Worker
736*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-Classes Response</h4>
737*5e7646d2SAndroid Build Coastguard Worker
738*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are send as part of the CUPS-Get-Classes Response:
739*5e7646d2SAndroid Build Coastguard Worker
740*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
741*5e7646d2SAndroid Build Coastguard Worker
742*5e7646d2SAndroid Build Coastguard Worker<dl>
743*5e7646d2SAndroid Build Coastguard Worker
744*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
745*5e7646d2SAndroid Build Coastguard Worker
746*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
747*5e7646d2SAndroid Build Coastguard Worker
748*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
749*5e7646d2SAndroid Build Coastguard Worker
750*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
751*5e7646d2SAndroid Build Coastguard Worker
752*5e7646d2SAndroid Build Coastguard Worker</dl>
753*5e7646d2SAndroid Build Coastguard Worker
754*5e7646d2SAndroid Build Coastguard Worker<p>Group 2: Printer Class Object Attributes
755*5e7646d2SAndroid Build Coastguard Worker
756*5e7646d2SAndroid Build Coastguard Worker<dl>
757*5e7646d2SAndroid Build Coastguard Worker
758*5e7646d2SAndroid Build Coastguard Worker	<dt>The set of requested attributes and their current values for each printer class.
759*5e7646d2SAndroid Build Coastguard Worker
760*5e7646d2SAndroid Build Coastguard Worker</dl>
761*5e7646d2SAndroid Build Coastguard Worker
762*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='CUPS_ADD_MODIFY_CLASS'>CUPS-Add-Modify-Class Operation</a></h3>
763*5e7646d2SAndroid Build Coastguard Worker
764*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Add-Modify-Class operation (0x4006) adds a new printer class or modifies and existing printer class on the system.
765*5e7646d2SAndroid Build Coastguard Worker
766*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Add-Modify-Class Request</h4>
767*5e7646d2SAndroid Build Coastguard Worker
768*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are supplied as part of the CUPS-Add-Modify-Class request:
769*5e7646d2SAndroid Build Coastguard Worker
770*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
771*5e7646d2SAndroid Build Coastguard Worker
772*5e7646d2SAndroid Build Coastguard Worker<dl>
773*5e7646d2SAndroid Build Coastguard Worker
774*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
775*5e7646d2SAndroid Build Coastguard Worker
776*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
777*5e7646d2SAndroid Build Coastguard Worker
778*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-uri" (uri):
779*5e7646d2SAndroid Build Coastguard Worker
780*5e7646d2SAndroid Build Coastguard Worker	<dd>The client MUST supply a URI for the specified printer class.
781*5e7646d2SAndroid Build Coastguard Worker
782*5e7646d2SAndroid Build Coastguard Worker</dl>
783*5e7646d2SAndroid Build Coastguard Worker
784*5e7646d2SAndroid Build Coastguard Worker<p>Group 2: Printer Object Attributes
785*5e7646d2SAndroid Build Coastguard Worker
786*5e7646d2SAndroid Build Coastguard Worker<dl>
787*5e7646d2SAndroid Build Coastguard Worker
788*5e7646d2SAndroid Build Coastguard Worker	<dt>"auth-info-required" (1setOf type2 keyword): <span class='info'>CUPS 1.3/macOS 10.5</span>
789*5e7646d2SAndroid Build Coastguard Worker
790*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
791*5e7646d2SAndroid Build Coastguard Worker
792*5e7646d2SAndroid Build Coastguard Worker	<dt>"member-uris" (1setof uri):
793*5e7646d2SAndroid Build Coastguard Worker
794*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies the "member-uris" set specifying the printers and printer classes that are part of the class.
795*5e7646d2SAndroid Build Coastguard Worker
796*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-is-accepting-jobs" (boolean):
797*5e7646d2SAndroid Build Coastguard Worker
798*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this boolean attribute indicating whether the class object should accept new jobs.
799*5e7646d2SAndroid Build Coastguard Worker
800*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-info" (text(127)):
801*5e7646d2SAndroid Build Coastguard Worker
802*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute indicating the printer information string.
803*5e7646d2SAndroid Build Coastguard Worker
804*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-location" (text(127)):
805*5e7646d2SAndroid Build Coastguard Worker
806*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute indicating a textual location of the class.
807*5e7646d2SAndroid Build Coastguard Worker
808*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-more-info" (uri):
809*5e7646d2SAndroid Build Coastguard Worker
810*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute indicating a URI for additional class information.
811*5e7646d2SAndroid Build Coastguard Worker
812*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-state" (type2 enum):
813*5e7646d2SAndroid Build Coastguard Worker
814*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute indicating the initial/current state of the class. Only the 'idle(3)' and 'stopped(5)' enumerations are recognized.
815*5e7646d2SAndroid Build Coastguard Worker
816*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-state-message" (text(MAX)):
817*5e7646d2SAndroid Build Coastguard Worker
818*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute indicating a textual reason for the current class state.
819*5e7646d2SAndroid Build Coastguard Worker
820*5e7646d2SAndroid Build Coastguard Worker	<dt>"requesting-user-name-allowed" (1setof name(127))
821*5e7646d2SAndroid Build Coastguard Worker	<br><i>OR</i>
822*5e7646d2SAndroid Build Coastguard Worker	<br>"requesting-user-name-denied" (1setof name(127)):
823*5e7646d2SAndroid Build Coastguard Worker
824*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies one of these attributes to specify an access control list for incoming print jobs. To allow all users access to a class, use the delete tag for the attribute value.
825*5e7646d2SAndroid Build Coastguard Worker
826*5e7646d2SAndroid Build Coastguard Worker</dl>
827*5e7646d2SAndroid Build Coastguard Worker
828*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Add-Modify-Class Response</h4>
829*5e7646d2SAndroid Build Coastguard Worker
830*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are send as part of the CUPS-Add-Modify-Class Response:
831*5e7646d2SAndroid Build Coastguard Worker
832*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
833*5e7646d2SAndroid Build Coastguard Worker
834*5e7646d2SAndroid Build Coastguard Worker<dl>
835*5e7646d2SAndroid Build Coastguard Worker
836*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
837*5e7646d2SAndroid Build Coastguard Worker
838*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
839*5e7646d2SAndroid Build Coastguard Worker
840*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
841*5e7646d2SAndroid Build Coastguard Worker
842*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
843*5e7646d2SAndroid Build Coastguard Worker
844*5e7646d2SAndroid Build Coastguard Worker</dl>
845*5e7646d2SAndroid Build Coastguard Worker
846*5e7646d2SAndroid Build Coastguard Worker
847*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='CUPS_DELETE_CLASS'>CUPS-Delete-Class Operation</a></h3>
848*5e7646d2SAndroid Build Coastguard Worker
849*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Delete-Class operation (0x4007) removes an existing printer class from the system.
850*5e7646d2SAndroid Build Coastguard Worker
851*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Delete-Class Request</h4>
852*5e7646d2SAndroid Build Coastguard Worker
853*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are supplied as part of the CUPS-Delete-Class request:
854*5e7646d2SAndroid Build Coastguard Worker
855*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
856*5e7646d2SAndroid Build Coastguard Worker
857*5e7646d2SAndroid Build Coastguard Worker<dl>
858*5e7646d2SAndroid Build Coastguard Worker
859*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
860*5e7646d2SAndroid Build Coastguard Worker
861*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
862*5e7646d2SAndroid Build Coastguard Worker
863*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-uri" (uri):
864*5e7646d2SAndroid Build Coastguard Worker
865*5e7646d2SAndroid Build Coastguard Worker	<dd>The client MUST supply a URI for the specified printer class.
866*5e7646d2SAndroid Build Coastguard Worker
867*5e7646d2SAndroid Build Coastguard Worker</dl>
868*5e7646d2SAndroid Build Coastguard Worker
869*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Delete-Class Response</h4>
870*5e7646d2SAndroid Build Coastguard Worker
871*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are send as part of the CUPS-Delete-Class Response:
872*5e7646d2SAndroid Build Coastguard Worker
873*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
874*5e7646d2SAndroid Build Coastguard Worker
875*5e7646d2SAndroid Build Coastguard Worker<dl>
876*5e7646d2SAndroid Build Coastguard Worker
877*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
878*5e7646d2SAndroid Build Coastguard Worker
879*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
880*5e7646d2SAndroid Build Coastguard Worker
881*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
882*5e7646d2SAndroid Build Coastguard Worker
883*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
884*5e7646d2SAndroid Build Coastguard Worker
885*5e7646d2SAndroid Build Coastguard Worker</dl>
886*5e7646d2SAndroid Build Coastguard Worker
887*5e7646d2SAndroid Build Coastguard Worker
888*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='CUPS_SET_DEFAULT'>CUPS-Set-Default Operation</a></h3>
889*5e7646d2SAndroid Build Coastguard Worker
890*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Set-Default operation (0x400A) sets the default printer destination for all clients when a resource name of "/printers" is specified.
891*5e7646d2SAndroid Build Coastguard Worker
892*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Set-Default Request</h4>
893*5e7646d2SAndroid Build Coastguard Worker
894*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are supplied as part of the CUPS-Set-Default request:
895*5e7646d2SAndroid Build Coastguard Worker
896*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
897*5e7646d2SAndroid Build Coastguard Worker
898*5e7646d2SAndroid Build Coastguard Worker<dl>
899*5e7646d2SAndroid Build Coastguard Worker
900*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
901*5e7646d2SAndroid Build Coastguard Worker
902*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
903*5e7646d2SAndroid Build Coastguard Worker
904*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-uri" (uri):
905*5e7646d2SAndroid Build Coastguard Worker
906*5e7646d2SAndroid Build Coastguard Worker	<dd>The client MUST supply a URI for the specified printer or printer class.
907*5e7646d2SAndroid Build Coastguard Worker
908*5e7646d2SAndroid Build Coastguard Worker</dl>
909*5e7646d2SAndroid Build Coastguard Worker
910*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Set-Default Response</h4>
911*5e7646d2SAndroid Build Coastguard Worker
912*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are send as part of the CUPS-Set-Default Response:
913*5e7646d2SAndroid Build Coastguard Worker
914*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
915*5e7646d2SAndroid Build Coastguard Worker
916*5e7646d2SAndroid Build Coastguard Worker<dl>
917*5e7646d2SAndroid Build Coastguard Worker
918*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
919*5e7646d2SAndroid Build Coastguard Worker
920*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
921*5e7646d2SAndroid Build Coastguard Worker
922*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
923*5e7646d2SAndroid Build Coastguard Worker
924*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
925*5e7646d2SAndroid Build Coastguard Worker
926*5e7646d2SAndroid Build Coastguard Worker</dl>
927*5e7646d2SAndroid Build Coastguard Worker
928*5e7646d2SAndroid Build Coastguard Worker
929*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><span class='info'>Deprecated</span><a name='CUPS_GET_DEVICES'>CUPS-Get-Devices Operation</a></h3>
930*5e7646d2SAndroid Build Coastguard Worker
931*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Get-Devices operation (0x400B) returns all of the supported device-uri's for the server.</p>
932*5e7646d2SAndroid Build Coastguard Worker
933*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-Devices Request</h4>
934*5e7646d2SAndroid Build Coastguard Worker
935*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are supplied as part of the CUPS-Get-Devices request:
936*5e7646d2SAndroid Build Coastguard Worker
937*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
938*5e7646d2SAndroid Build Coastguard Worker
939*5e7646d2SAndroid Build Coastguard Worker<dl>
940*5e7646d2SAndroid Build Coastguard Worker
941*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
942*5e7646d2SAndroid Build Coastguard Worker
943*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
944*5e7646d2SAndroid Build Coastguard Worker
945*5e7646d2SAndroid Build Coastguard Worker	<dt>"device-class" (type1 keyword):
946*5e7646d2SAndroid Build Coastguard Worker
947*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a device class keyword to select which devices are returned.
948*5e7646d2SAndroid Build Coastguard Worker
949*5e7646d2SAndroid Build Coastguard Worker	<dt>"exclude-schemes" (1setOf name): <span class='info'>CUPS 1.4/macOS 10.6</span>
950*5e7646d2SAndroid Build Coastguard Worker
951*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a set of scheme names that the requestor does not want to discover. If the client omits this attribute, the server responds with devices of all schemes specified by the "include-schemes" attribute.
952*5e7646d2SAndroid Build Coastguard Worker
953*5e7646d2SAndroid Build Coastguard Worker	<dt>"include-schemes" (1setOf name): <span class='info'>CUPS 1.4/macOS 10.6</span>
954*5e7646d2SAndroid Build Coastguard Worker
955*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a set of scheme names that the requestor wants to discover. If the client omits this attribute, the server responds with devices of all schemes except those specified by the "exclude-schemes" attribute.
956*5e7646d2SAndroid Build Coastguard Worker
957*5e7646d2SAndroid Build Coastguard Worker	<dt>"limit" (integer (1:MAX)):
958*5e7646d2SAndroid Build Coastguard Worker
959*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute limiting the number of devices that are returned.
960*5e7646d2SAndroid Build Coastguard Worker
961*5e7646d2SAndroid Build Coastguard Worker	<dt>"requested-attributes" (1setOf keyword):
962*5e7646d2SAndroid Build Coastguard Worker
963*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a set of attribute names and/or attribute group names in whose values the requester is interested. If the client omits this attribute, the server responds as if this attribute had been supplied with a value of 'all'.
964*5e7646d2SAndroid Build Coastguard Worker
965*5e7646d2SAndroid Build Coastguard Worker	<dt>"timeout" (integer (1:MAX)): <span class='info'>CUPS 1.4/macOS 10.6</span>
966*5e7646d2SAndroid Build Coastguard Worker
967*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute to limit the duration of the lookup. The default timeout is 15 seconds.
968*5e7646d2SAndroid Build Coastguard Worker
969*5e7646d2SAndroid Build Coastguard Worker</dl>
970*5e7646d2SAndroid Build Coastguard Worker
971*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-Devices Response</h4>
972*5e7646d2SAndroid Build Coastguard Worker
973*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are send as part of the CUPS-Get-Devices Response:
974*5e7646d2SAndroid Build Coastguard Worker
975*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
976*5e7646d2SAndroid Build Coastguard Worker
977*5e7646d2SAndroid Build Coastguard Worker<dl>
978*5e7646d2SAndroid Build Coastguard Worker
979*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
980*5e7646d2SAndroid Build Coastguard Worker
981*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
982*5e7646d2SAndroid Build Coastguard Worker
983*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
984*5e7646d2SAndroid Build Coastguard Worker
985*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
986*5e7646d2SAndroid Build Coastguard Worker
987*5e7646d2SAndroid Build Coastguard Worker</dl>
988*5e7646d2SAndroid Build Coastguard Worker
989*5e7646d2SAndroid Build Coastguard Worker<p>Groups 2-N: Device Object Attributes (using printer-attributes-tag group)
990*5e7646d2SAndroid Build Coastguard Worker
991*5e7646d2SAndroid Build Coastguard Worker<dl>
992*5e7646d2SAndroid Build Coastguard Worker
993*5e7646d2SAndroid Build Coastguard Worker	<dt>The set of requested attributes and their current values for
994*5e7646d2SAndroid Build Coastguard Worker	each device.
995*5e7646d2SAndroid Build Coastguard Worker
996*5e7646d2SAndroid Build Coastguard Worker</dl>
997*5e7646d2SAndroid Build Coastguard Worker
998*5e7646d2SAndroid Build Coastguard Worker
999*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><span class='info'>Deprecated</span><a name='CUPS_GET_PPDS'>CUPS-Get-PPDs Operation</a></h3>
1000*5e7646d2SAndroid Build Coastguard Worker
1001*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Get-PPDs operation (0x400C) returns all of the locally available PPD files on the system.</p>
1002*5e7646d2SAndroid Build Coastguard Worker
1003*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-PPDs Request</h4>
1004*5e7646d2SAndroid Build Coastguard Worker
1005*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are supplied as part of the CUPS-Get-PPDs request:
1006*5e7646d2SAndroid Build Coastguard Worker
1007*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
1008*5e7646d2SAndroid Build Coastguard Worker
1009*5e7646d2SAndroid Build Coastguard Worker<dl>
1010*5e7646d2SAndroid Build Coastguard Worker
1011*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
1012*5e7646d2SAndroid Build Coastguard Worker
1013*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
1014*5e7646d2SAndroid Build Coastguard Worker
1015*5e7646d2SAndroid Build Coastguard Worker	<dt>"exclude-schemes" (1setOf name): <span class='info'>CUPS 1.4/macOS 10.6</span>
1016*5e7646d2SAndroid Build Coastguard Worker
1017*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a set of scheme names that the requestor does not want to list. If the client omits this attribute, the server responds with PPDs of all schemes specified by the "include-schemes" attribute.
1018*5e7646d2SAndroid Build Coastguard Worker
1019*5e7646d2SAndroid Build Coastguard Worker	<dt>"include-schemes" (1setOf name): <span class='info'>CUPS 1.4/macOS 10.6</span>
1020*5e7646d2SAndroid Build Coastguard Worker
1021*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a set of scheme names that the requestor wants to list. If the client omits this attribute, the server responds with PPDs of all schemes except those specified by the "exclude-schemes" attribute.
1022*5e7646d2SAndroid Build Coastguard Worker
1023*5e7646d2SAndroid Build Coastguard Worker	<dt>"limit" (integer (1:MAX)):
1024*5e7646d2SAndroid Build Coastguard Worker
1025*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies this attribute limiting the number of PPDs that are returned.
1026*5e7646d2SAndroid Build Coastguard Worker
1027*5e7646d2SAndroid Build Coastguard Worker	<dt>"ppd-make" (text(127)):
1028*5e7646d2SAndroid Build Coastguard Worker
1029*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a printer manufacturer to select which PPDs are returned.
1030*5e7646d2SAndroid Build Coastguard Worker
1031*5e7646d2SAndroid Build Coastguard Worker	<dt>"ppd-make-and-model" (text(127)): <span class='info'>CUPS 1.3/macOS 10.5</span>
1032*5e7646d2SAndroid Build Coastguard Worker
1033*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a make and model to select which PPDs are returned.
1034*5e7646d2SAndroid Build Coastguard Worker
1035*5e7646d2SAndroid Build Coastguard Worker	<dt>"ppd-model-number" (integer): <span class='info'>CUPS 1.3/macOS 10.5</span>
1036*5e7646d2SAndroid Build Coastguard Worker
1037*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a model number to select which PPDs are returned.
1038*5e7646d2SAndroid Build Coastguard Worker
1039*5e7646d2SAndroid Build Coastguard Worker	<dt>"ppd-natural-language" (naturalLanguage): <span class='info'>CUPS 1.3/macOS 10.5</span>
1040*5e7646d2SAndroid Build Coastguard Worker
1041*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a language to select which PPDs are returned.
1042*5e7646d2SAndroid Build Coastguard Worker
1043*5e7646d2SAndroid Build Coastguard Worker	<dt>"ppd-product" (text(127)): <span class='info'>CUPS 1.3/macOS 10.5</span>
1044*5e7646d2SAndroid Build Coastguard Worker
1045*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a PostScript product string to select which PPDs are returned.
1046*5e7646d2SAndroid Build Coastguard Worker
1047*5e7646d2SAndroid Build Coastguard Worker	<dt>"ppd-psversion" (text(127)): <span class='info'>CUPS 1.3/macOS 10.5</span>
1048*5e7646d2SAndroid Build Coastguard Worker
1049*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a PostScript version string to select which PPDs are returned.
1050*5e7646d2SAndroid Build Coastguard Worker
1051*5e7646d2SAndroid Build Coastguard Worker	<dt>"ppd-type" (type1 keyword): <span class='info'>CUPS 1.3/macOS 10.5</span>
1052*5e7646d2SAndroid Build Coastguard Worker
1053*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a driver type to select which PPDs are returned.
1054*5e7646d2SAndroid Build Coastguard Worker
1055*5e7646d2SAndroid Build Coastguard Worker	<dt>"requested-attributes" (1setOf keyword):
1056*5e7646d2SAndroid Build Coastguard Worker
1057*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a set of attribute names and/or attribute group names in whose values the requester is interested. If the client omits this attribute, the server responds as if this attribute had been supplied with a value of 'all'. Specify "ppd-make" to get a list of manufacturers.
1058*5e7646d2SAndroid Build Coastguard Worker
1059*5e7646d2SAndroid Build Coastguard Worker</dl>
1060*5e7646d2SAndroid Build Coastguard Worker
1061*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-PPDs Response</h4>
1062*5e7646d2SAndroid Build Coastguard Worker
1063*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are send as part of the
1064*5e7646d2SAndroid Build Coastguard WorkerCUPS-Get-PPDs Response:
1065*5e7646d2SAndroid Build Coastguard Worker
1066*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
1067*5e7646d2SAndroid Build Coastguard Worker
1068*5e7646d2SAndroid Build Coastguard Worker<dl>
1069*5e7646d2SAndroid Build Coastguard Worker
1070*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
1071*5e7646d2SAndroid Build Coastguard Worker
1072*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
1073*5e7646d2SAndroid Build Coastguard Worker
1074*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
1075*5e7646d2SAndroid Build Coastguard Worker
1076*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
1077*5e7646d2SAndroid Build Coastguard Worker
1078*5e7646d2SAndroid Build Coastguard Worker</dl>
1079*5e7646d2SAndroid Build Coastguard Worker
1080*5e7646d2SAndroid Build Coastguard Worker<p>Groups 2-N: PPD Attributes (using printer-attributes-tag group)
1081*5e7646d2SAndroid Build Coastguard Worker
1082*5e7646d2SAndroid Build Coastguard Worker<dl>
1083*5e7646d2SAndroid Build Coastguard Worker
1084*5e7646d2SAndroid Build Coastguard Worker	<dt>The set of requested attributes and their current values for each PPD file.
1085*5e7646d2SAndroid Build Coastguard Worker
1086*5e7646d2SAndroid Build Coastguard Worker</dl>
1087*5e7646d2SAndroid Build Coastguard Worker
1088*5e7646d2SAndroid Build Coastguard Worker
1089*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_MOVE_JOB'>CUPS-Move-Job Operation</a></h3>
1090*5e7646d2SAndroid Build Coastguard Worker
1091*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Move-Job operation (0x400D) moves an active print job or all print jobs for a printer to a different printer.</p>
1092*5e7646d2SAndroid Build Coastguard Worker
1093*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Move-Job Request</h4>
1094*5e7646d2SAndroid Build Coastguard Worker
1095*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are supplied as part of the CUPS-Move-Job request:
1096*5e7646d2SAndroid Build Coastguard Worker
1097*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
1098*5e7646d2SAndroid Build Coastguard Worker
1099*5e7646d2SAndroid Build Coastguard Worker<dl>
1100*5e7646d2SAndroid Build Coastguard Worker
1101*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
1102*5e7646d2SAndroid Build Coastguard Worker
1103*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
1104*5e7646d2SAndroid Build Coastguard Worker
1105*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-uri" (uri)
1106*5e7646d2SAndroid Build Coastguard Worker	<br><i>OR</i>
1107*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-uri" (uri) and "job-id" (integer)
1108*5e7646d2SAndroid Build Coastguard Worker	<br><i>OR</i>
1109*5e7646d2SAndroid Build Coastguard Worker	<br>"job-uri" (uri):
1110*5e7646d2SAndroid Build Coastguard Worker
1111*5e7646d2SAndroid Build Coastguard Worker	<dd>The client MUST supply a URI for the specified printer, the URI for the specified printer and a job ID number, or the job URI.
1112*5e7646d2SAndroid Build Coastguard Worker
1113*5e7646d2SAndroid Build Coastguard Worker</dl>
1114*5e7646d2SAndroid Build Coastguard Worker
1115*5e7646d2SAndroid Build Coastguard Worker<p>Group 2: Job Template Attributes
1116*5e7646d2SAndroid Build Coastguard Worker
1117*5e7646d2SAndroid Build Coastguard Worker<dl>
1118*5e7646d2SAndroid Build Coastguard Worker
1119*5e7646d2SAndroid Build Coastguard Worker	<dt>"job-printer-uri" (uri):
1120*5e7646d2SAndroid Build Coastguard Worker
1121*5e7646d2SAndroid Build Coastguard Worker	<dd>The client MUST supply a URI for a printer on the same server.
1122*5e7646d2SAndroid Build Coastguard Worker
1123*5e7646d2SAndroid Build Coastguard Worker</dl>
1124*5e7646d2SAndroid Build Coastguard Worker
1125*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Move-Job Response</h4>
1126*5e7646d2SAndroid Build Coastguard Worker
1127*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are send as part of the CUPS-Move-Job Response:
1128*5e7646d2SAndroid Build Coastguard Worker
1129*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
1130*5e7646d2SAndroid Build Coastguard Worker
1131*5e7646d2SAndroid Build Coastguard Worker<dl>
1132*5e7646d2SAndroid Build Coastguard Worker
1133*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
1134*5e7646d2SAndroid Build Coastguard Worker
1135*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
1136*5e7646d2SAndroid Build Coastguard Worker
1137*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
1138*5e7646d2SAndroid Build Coastguard Worker
1139*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
1140*5e7646d2SAndroid Build Coastguard Worker
1141*5e7646d2SAndroid Build Coastguard Worker</dl>
1142*5e7646d2SAndroid Build Coastguard Worker
1143*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><span class='info'>CUPS 1.2/macOS 10.5</span><a name='CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job Operation</a></h3>
1144*5e7646d2SAndroid Build Coastguard Worker
1145*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Authenticate-Job operation (0x400E) authenticates a print job for printing, releasing the job if it is held. Typically this is used when printing to a remote server. The authentication information is passed in the HTTP request; the HTTP connection is normally encrypted for this type of request.</p>
1146*5e7646d2SAndroid Build Coastguard Worker
1147*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Authenticate-Job Request</h4>
1148*5e7646d2SAndroid Build Coastguard Worker
1149*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are supplied as part of the CUPS-Authenticate-Job request:
1150*5e7646d2SAndroid Build Coastguard Worker
1151*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
1152*5e7646d2SAndroid Build Coastguard Worker
1153*5e7646d2SAndroid Build Coastguard Worker<dl>
1154*5e7646d2SAndroid Build Coastguard Worker
1155*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
1156*5e7646d2SAndroid Build Coastguard Worker
1157*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
1158*5e7646d2SAndroid Build Coastguard Worker
1159*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-uri" (uri) and "job-id" (integer)
1160*5e7646d2SAndroid Build Coastguard Worker	<br><i>OR</i>
1161*5e7646d2SAndroid Build Coastguard Worker	<br>"job-uri" (uri):
1162*5e7646d2SAndroid Build Coastguard Worker
1163*5e7646d2SAndroid Build Coastguard Worker	<dd>The client MUST supply a URI for the specified printer and a job ID number, or the job URI.
1164*5e7646d2SAndroid Build Coastguard Worker
1165*5e7646d2SAndroid Build Coastguard Worker</dl>
1166*5e7646d2SAndroid Build Coastguard Worker
1167*5e7646d2SAndroid Build Coastguard Worker<p>Group 2: Job Attributes
1168*5e7646d2SAndroid Build Coastguard Worker
1169*5e7646d2SAndroid Build Coastguard Worker<dl>
1170*5e7646d2SAndroid Build Coastguard Worker
1171*5e7646d2SAndroid Build Coastguard Worker	<dt>"auth-info" (1setOf text(MAX)): <span class='info'>CUPS 1.3/macOS 10.5</span>
1172*5e7646d2SAndroid Build Coastguard Worker
1173*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute.
1174*5e7646d2SAndroid Build Coastguard Worker
1175*5e7646d2SAndroid Build Coastguard Worker	<dt>"job-hold-until" (keyword | name(MAX)): <span class='info'>CUPS 1.3/macOS 10.5</span>
1176*5e7646d2SAndroid Build Coastguard Worker
1177*5e7646d2SAndroid Build Coastguard Worker	<dd>The client OPTIONALLY supplies a new job-hold-until value for the job. If specified and not the "no-hold" value, the job is held instead of released for printing.
1178*5e7646d2SAndroid Build Coastguard Worker
1179*5e7646d2SAndroid Build Coastguard Worker</dl>
1180*5e7646d2SAndroid Build Coastguard Worker
1181*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Authenticate-Job Response</h4>
1182*5e7646d2SAndroid Build Coastguard Worker
1183*5e7646d2SAndroid Build Coastguard Worker<p>The following groups of attributes are send as part of the CUPS-Authenticate-Job Response:
1184*5e7646d2SAndroid Build Coastguard Worker
1185*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
1186*5e7646d2SAndroid Build Coastguard Worker
1187*5e7646d2SAndroid Build Coastguard Worker<dl>
1188*5e7646d2SAndroid Build Coastguard Worker
1189*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
1190*5e7646d2SAndroid Build Coastguard Worker
1191*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
1192*5e7646d2SAndroid Build Coastguard Worker
1193*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
1194*5e7646d2SAndroid Build Coastguard Worker
1195*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
1196*5e7646d2SAndroid Build Coastguard Worker
1197*5e7646d2SAndroid Build Coastguard Worker</dl>
1198*5e7646d2SAndroid Build Coastguard Worker
1199*5e7646d2SAndroid Build Coastguard Worker<p>Group 2: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
1200*5e7646d2SAndroid Build Coastguard Worker
1201*5e7646d2SAndroid Build Coastguard Worker<dl>
1202*5e7646d2SAndroid Build Coastguard Worker
1203*5e7646d2SAndroid Build Coastguard Worker	<dt>auth-info-required (1setOf Type2 keyword)
1204*5e7646d2SAndroid Build Coastguard Worker
1205*5e7646d2SAndroid Build Coastguard Worker	<dd>The required authentication information.
1206*5e7646d2SAndroid Build Coastguard Worker
1207*5e7646d2SAndroid Build Coastguard Worker</dl>
1208*5e7646d2SAndroid Build Coastguard Worker
1209*5e7646d2SAndroid Build Coastguard Worker
1210*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><span class='info'>Deprecated</span><a name='CUPS_GET_PPD'>CUPS-Get-PPD Operation</a></h3>
1211*5e7646d2SAndroid Build Coastguard Worker
1212*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Get-PPD operation (0x400F) gets a PPD file from the server. The PPD file can be specified using a <tt>ppd-name</tt> returned by <a href='#CUPS_GET_PPDS'><tt>CUPS-Get-PPDs</tt></a> or using the <tt>printer-uri</tt> for a queue.</p>
1213*5e7646d2SAndroid Build Coastguard Worker
1214*5e7646d2SAndroid Build Coastguard Worker<p>If the PPD file is found, <tt>successful-ok</tt> is returned with the PPD file following the response data.</p>
1215*5e7646d2SAndroid Build Coastguard Worker
1216*5e7646d2SAndroid Build Coastguard Worker<p>If the PPD file cannot be served by the local server because the <tt>printer-uri</tt> attribute points to an external printer, a <tt>cups-see-other</tt> status is returned with the correct URI to use.</p>
1217*5e7646d2SAndroid Build Coastguard Worker
1218*5e7646d2SAndroid Build Coastguard Worker<p>If the PPD file does not exist, <tt>client-error-not-found</tt> is returned.</p>
1219*5e7646d2SAndroid Build Coastguard Worker
1220*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-PPD Request</h4>
1221*5e7646d2SAndroid Build Coastguard Worker
1222*5e7646d2SAndroid Build Coastguard Worker<p>The following group of attributes is supplied as part of the CUPS-Get-PPD request:
1223*5e7646d2SAndroid Build Coastguard Worker
1224*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
1225*5e7646d2SAndroid Build Coastguard Worker
1226*5e7646d2SAndroid Build Coastguard Worker<dl>
1227*5e7646d2SAndroid Build Coastguard Worker
1228*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
1229*5e7646d2SAndroid Build Coastguard Worker
1230*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
1231*5e7646d2SAndroid Build Coastguard Worker
1232*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-uri" (uri)
1233*5e7646d2SAndroid Build Coastguard Worker	<br><i>OR</i>
1234*5e7646d2SAndroid Build Coastguard Worker	<br>"ppd-name" (name(255)):
1235*5e7646d2SAndroid Build Coastguard Worker
1236*5e7646d2SAndroid Build Coastguard Worker	<dd>The client MUST supply a printer URI or PPD name.
1237*5e7646d2SAndroid Build Coastguard Worker
1238*5e7646d2SAndroid Build Coastguard Worker</dl>
1239*5e7646d2SAndroid Build Coastguard Worker
1240*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-PPD Response</h4>
1241*5e7646d2SAndroid Build Coastguard Worker
1242*5e7646d2SAndroid Build Coastguard Worker<p>The following group of attributes is sent as part of the CUPS-Get-PPD Response:
1243*5e7646d2SAndroid Build Coastguard Worker
1244*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
1245*5e7646d2SAndroid Build Coastguard Worker
1246*5e7646d2SAndroid Build Coastguard Worker<dl>
1247*5e7646d2SAndroid Build Coastguard Worker
1248*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
1249*5e7646d2SAndroid Build Coastguard Worker
1250*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
1251*5e7646d2SAndroid Build Coastguard Worker
1252*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
1253*5e7646d2SAndroid Build Coastguard Worker
1254*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
1255*5e7646d2SAndroid Build Coastguard Worker
1256*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-uri" (uri):
1257*5e7646d2SAndroid Build Coastguard Worker
1258*5e7646d2SAndroid Build Coastguard Worker	<dd>The printer that provides the actual PPD file when the status code is cups-see-other (0x280).
1259*5e7646d2SAndroid Build Coastguard Worker
1260*5e7646d2SAndroid Build Coastguard Worker</dl>
1261*5e7646d2SAndroid Build Coastguard Worker
1262*5e7646d2SAndroid Build Coastguard Worker<p>If the status code is <tt>successful-ok</tt>, the PPD file follows the end of the IPP response.</p>
1263*5e7646d2SAndroid Build Coastguard Worker
1264*5e7646d2SAndroid Build Coastguard Worker
1265*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><span class='info'>CUPS 1.4/macOS 10.6</span><a name='CUPS_GET_DOCUMENT'>CUPS-Get-Document Operation</a></h3>
1266*5e7646d2SAndroid Build Coastguard Worker
1267*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Get-Document operation (0x4027) gets a document file from a job on the server. The document file is specified using the <tt>document-number</tt> and either the <tt>job-uri</tt> or <tt>printer-uri</tt> and <tt>job-id</tt> identifying the job.</p>
1268*5e7646d2SAndroid Build Coastguard Worker
1269*5e7646d2SAndroid Build Coastguard Worker<p>If the document file is found, <tt>successful-ok</tt> is returned with the document file following the response data.</p>
1270*5e7646d2SAndroid Build Coastguard Worker
1271*5e7646d2SAndroid Build Coastguard Worker<p>If the document file does not exist, <tt>client-error-not-found</tt> is returned.</p>
1272*5e7646d2SAndroid Build Coastguard Worker
1273*5e7646d2SAndroid Build Coastguard Worker<p>If the requesting user does not have access to the document file, <tt>client-error-not-authorized</tt> is returned.
1274*5e7646d2SAndroid Build Coastguard Worker
1275*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-Document Request</h4>
1276*5e7646d2SAndroid Build Coastguard Worker
1277*5e7646d2SAndroid Build Coastguard Worker<p>The following group of attributes is supplied as part of the CUPS-Get-Document request:
1278*5e7646d2SAndroid Build Coastguard Worker
1279*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
1280*5e7646d2SAndroid Build Coastguard Worker
1281*5e7646d2SAndroid Build Coastguard Worker<dl>
1282*5e7646d2SAndroid Build Coastguard Worker
1283*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
1284*5e7646d2SAndroid Build Coastguard Worker
1285*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
1286*5e7646d2SAndroid Build Coastguard Worker
1287*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-uri" (uri) and "job-id" (integer)
1288*5e7646d2SAndroid Build Coastguard Worker	<br><i>OR</i>
1289*5e7646d2SAndroid Build Coastguard Worker	<br>"job-uri" (uri):
1290*5e7646d2SAndroid Build Coastguard Worker
1291*5e7646d2SAndroid Build Coastguard Worker	<dd>The client MUST supply a printer URI and job ID or job URI.
1292*5e7646d2SAndroid Build Coastguard Worker
1293*5e7646d2SAndroid Build Coastguard Worker	<dt>"document-number" (integer(1:MAX)):
1294*5e7646d2SAndroid Build Coastguard Worker
1295*5e7646d2SAndroid Build Coastguard Worker	<dd>The client MUST supply a document number to retrieve. The <tt>document-count</tt> attribute for the job defines the maximum document number that can be specified. In the case of jobs with banners (<tt>job-sheets</tt> is not "none"), document number 1 will typically contain the start banner and document number N will typically contain the end banner.
1296*5e7646d2SAndroid Build Coastguard Worker
1297*5e7646d2SAndroid Build Coastguard Worker</dl>
1298*5e7646d2SAndroid Build Coastguard Worker
1299*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Get-Document Response</h4>
1300*5e7646d2SAndroid Build Coastguard Worker
1301*5e7646d2SAndroid Build Coastguard Worker<p>The following group of attributes is sent as part of the CUPS-Get-Document Response:
1302*5e7646d2SAndroid Build Coastguard Worker
1303*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
1304*5e7646d2SAndroid Build Coastguard Worker
1305*5e7646d2SAndroid Build Coastguard Worker<dl>
1306*5e7646d2SAndroid Build Coastguard Worker
1307*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
1308*5e7646d2SAndroid Build Coastguard Worker
1309*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
1310*5e7646d2SAndroid Build Coastguard Worker
1311*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
1312*5e7646d2SAndroid Build Coastguard Worker
1313*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
1314*5e7646d2SAndroid Build Coastguard Worker
1315*5e7646d2SAndroid Build Coastguard Worker	<dt>"document-format" (mimeType):
1316*5e7646d2SAndroid Build Coastguard Worker
1317*5e7646d2SAndroid Build Coastguard Worker	<dd>The format of the document file.
1318*5e7646d2SAndroid Build Coastguard Worker
1319*5e7646d2SAndroid Build Coastguard Worker	<dt>"document-number" (integer(1:MAX)):
1320*5e7646d2SAndroid Build Coastguard Worker
1321*5e7646d2SAndroid Build Coastguard Worker	<dd>The requested document number.
1322*5e7646d2SAndroid Build Coastguard Worker
1323*5e7646d2SAndroid Build Coastguard Worker	<dt>"document-name" (name(MAX)):
1324*5e7646d2SAndroid Build Coastguard Worker
1325*5e7646d2SAndroid Build Coastguard Worker	<dd>The name that was supplied with the document, if any.
1326*5e7646d2SAndroid Build Coastguard Worker
1327*5e7646d2SAndroid Build Coastguard Worker</dl>
1328*5e7646d2SAndroid Build Coastguard Worker
1329*5e7646d2SAndroid Build Coastguard Worker<p>If the status code is <tt>successful-ok</tt>, the document file follows the end of the IPP response.</p>
1330*5e7646d2SAndroid Build Coastguard Worker
1331*5e7646d2SAndroid Build Coastguard Worker
1332*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='CUPS_CREATE_LOCAL_PRINTER'>CUPS-Create-Local-Printer</a></h3>
1333*5e7646d2SAndroid Build Coastguard Worker
1334*5e7646d2SAndroid Build Coastguard Worker<p>The CUPS-Create-Local-Printer operation (0x4028) creates a local (temporary) print queue pointing to a remote IPP Everywhere Printer. The queue will remain until the scheduler idle exits, is restarted, or the system is restarted or shutdown. Temporary print queues can be made permanent by an administrator by setting the "printer-is-shared" attribute to 'true'.</p>
1335*5e7646d2SAndroid Build Coastguard Worker
1336*5e7646d2SAndroid Build Coastguard Worker<p>At a minimum, the scheduler requires a name and URI for the Printer to add. When successful, the local "printer-uri" values are returned and may be used by the Client to submit Job Creation Requests, monitor for state changes, and so forth.</p>
1337*5e7646d2SAndroid Build Coastguard Worker
1338*5e7646d2SAndroid Build Coastguard Worker<p>If the named printer already exists, the scheduler will reject the request with the 'client-error-not-possible' status code.</p>
1339*5e7646d2SAndroid Build Coastguard Worker
1340*5e7646d2SAndroid Build Coastguard Worker<p>Access Rights: The authenticated user performing this operation MUST be a Local User of the system, and the request MUST be made over a local (domain socket or loopback interface) address. Otherwise, the request will be rejected with the 'client-error-forbidden' status code.</p>
1341*5e7646d2SAndroid Build Coastguard Worker
1342*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Create-Local-Printer Request</h4>
1343*5e7646d2SAndroid Build Coastguard Worker
1344*5e7646d2SAndroid Build Coastguard Worker<p>The following group of attributes is supplied as part of the CUPS-Create-Local-Printer request:
1345*5e7646d2SAndroid Build Coastguard Worker
1346*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
1347*5e7646d2SAndroid Build Coastguard Worker
1348*5e7646d2SAndroid Build Coastguard Worker<dl>
1349*5e7646d2SAndroid Build Coastguard Worker
1350*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
1351*5e7646d2SAndroid Build Coastguard Worker
1352*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
1353*5e7646d2SAndroid Build Coastguard Worker
1354*5e7646d2SAndroid Build Coastguard Worker</dl>
1355*5e7646d2SAndroid Build Coastguard Worker
1356*5e7646d2SAndroid Build Coastguard Worker<p>Group 2: Printer Attributes
1357*5e7646d2SAndroid Build Coastguard Worker
1358*5e7646d2SAndroid Build Coastguard Worker<dl>
1359*5e7646d2SAndroid Build Coastguard Worker
1360*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-name" (name(127)):
1361*5e7646d2SAndroid Build Coastguard Worker
1362*5e7646d2SAndroid Build Coastguard Worker	<dd>The Client MUST supply this attribute which provides the name for the new Printer.
1363*5e7646d2SAndroid Build Coastguard Worker
1364*5e7646d2SAndroid Build Coastguard Worker	<dt>"device-uri" (uri):
1365*5e7646d2SAndroid Build Coastguard Worker
1366*5e7646d2SAndroid Build Coastguard Worker	<dd>The Client MUST supply this attribute which provides an "ipp" or "ipps" URI pointing to an IPP Everywhere Printer.
1367*5e7646d2SAndroid Build Coastguard Worker
1368*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-device-id" (text(1023)):
1369*5e7646d2SAndroid Build Coastguard Worker
1370*5e7646d2SAndroid Build Coastguard Worker	<dd>The Client OPTIONALLY supplies this attribute which provides the IEEE 1284 device ID for the new Printer.
1371*5e7646d2SAndroid Build Coastguard Worker
1372*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-geo-location" (uri):
1373*5e7646d2SAndroid Build Coastguard Worker
1374*5e7646d2SAndroid Build Coastguard Worker	<dd>The Client OPTIONALLY supplies this attribute which provides the geo-location of the new Printer as a "geo" URI.
1375*5e7646d2SAndroid Build Coastguard Worker
1376*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-info" (text(127)):
1377*5e7646d2SAndroid Build Coastguard Worker
1378*5e7646d2SAndroid Build Coastguard Worker	<dd>The Client OPTIONALLY supplies this attribute which provides the description for the new Printer.
1379*5e7646d2SAndroid Build Coastguard Worker
1380*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-location" (text(127)):
1381*5e7646d2SAndroid Build Coastguard Worker
1382*5e7646d2SAndroid Build Coastguard Worker	<dd>The Client OPTIONALLY supplies this attribute which provides the location of the new Printer.
1383*5e7646d2SAndroid Build Coastguard Worker
1384*5e7646d2SAndroid Build Coastguard Worker</dl>
1385*5e7646d2SAndroid Build Coastguard Worker
1386*5e7646d2SAndroid Build Coastguard Worker<h4>CUPS-Create-Local-Printer Response</h4>
1387*5e7646d2SAndroid Build Coastguard Worker
1388*5e7646d2SAndroid Build Coastguard Worker<p>The following group of attributes is sent as part of the CUPS-Create-Local-Printer Response:
1389*5e7646d2SAndroid Build Coastguard Worker
1390*5e7646d2SAndroid Build Coastguard Worker<p>Group 1: Operation Attributes
1391*5e7646d2SAndroid Build Coastguard Worker
1392*5e7646d2SAndroid Build Coastguard Worker<dl>
1393*5e7646d2SAndroid Build Coastguard Worker
1394*5e7646d2SAndroid Build Coastguard Worker	<dt>Natural Language and Character Set:
1395*5e7646d2SAndroid Build Coastguard Worker
1396*5e7646d2SAndroid Build Coastguard Worker	<dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
1397*5e7646d2SAndroid Build Coastguard Worker
1398*5e7646d2SAndroid Build Coastguard Worker	<dt>Status Message:
1399*5e7646d2SAndroid Build Coastguard Worker
1400*5e7646d2SAndroid Build Coastguard Worker	<dd>The standard response status message.
1401*5e7646d2SAndroid Build Coastguard Worker
1402*5e7646d2SAndroid Build Coastguard Worker</dl>
1403*5e7646d2SAndroid Build Coastguard Worker
1404*5e7646d2SAndroid Build Coastguard Worker<p>Group 2: Printer Attributes
1405*5e7646d2SAndroid Build Coastguard Worker
1406*5e7646d2SAndroid Build Coastguard Worker<dl>
1407*5e7646d2SAndroid Build Coastguard Worker
1408*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-id" (integer(0:65535)):
1409*5e7646d2SAndroid Build Coastguard Worker
1410*5e7646d2SAndroid Build Coastguard Worker	<dd>The numeric identifier for the created Printer.
1411*5e7646d2SAndroid Build Coastguard Worker
1412*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-is-accepting-jobs" (boolean):
1413*5e7646d2SAndroid Build Coastguard Worker
1414*5e7646d2SAndroid Build Coastguard Worker	<dd>Whether the created Printer is accepting jobs at the time of the response.
1415*5e7646d2SAndroid Build Coastguard Worker
1416*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-state" (type1 enum):
1417*5e7646d2SAndroid Build Coastguard Worker
1418*5e7646d2SAndroid Build Coastguard Worker	<dd>The state of the created Printer at the time of the response.
1419*5e7646d2SAndroid Build Coastguard Worker
1420*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-state-reasons" (1setOf type2 keyword):
1421*5e7646d2SAndroid Build Coastguard Worker
1422*5e7646d2SAndroid Build Coastguard Worker	<dd>The state keywords for the created Printer at the time of the response.
1423*5e7646d2SAndroid Build Coastguard Worker
1424*5e7646d2SAndroid Build Coastguard Worker	<dt>"printer-uri-supported" (1setOf uri):
1425*5e7646d2SAndroid Build Coastguard Worker
1426*5e7646d2SAndroid Build Coastguard Worker	<dd>The URIs for the created Printer.
1427*5e7646d2SAndroid Build Coastguard Worker
1428*5e7646d2SAndroid Build Coastguard Worker</dl>
1429*5e7646d2SAndroid Build Coastguard Worker
1430*5e7646d2SAndroid Build Coastguard Worker
1431*5e7646d2SAndroid Build Coastguard Worker<h2 class='title'><a name='ATTRIBUTES'>Attributes</a></h2>
1432*5e7646d2SAndroid Build Coastguard Worker
1433*5e7646d2SAndroid Build Coastguard Worker<p>CUPS provides many extension attributes to support multiple devices, PPD files, standard job filters, printers, and printer classes.</p>
1434*5e7646d2SAndroid Build Coastguard Worker
1435*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='DEVICE_ATTRIBUTES'>Device Attributes</a><span class="info">Deprecated</span></h3>
1436*5e7646d2SAndroid Build Coastguard Worker
1437*5e7646d2SAndroid Build Coastguard Worker<p>Device attributes are returned by the CUPS-Get-Devices operation and enumerate all of the available hardware devices and network protocols that are supported by the server. Device attributes are reported in the printer-attributes-tag group.</p>
1438*5e7646d2SAndroid Build Coastguard Worker
1439*5e7646d2SAndroid Build Coastguard Worker<h4><a name="device-class">device-class (type2 keyword)</a><span class="info">Deprecated</span></h4>
1440*5e7646d2SAndroid Build Coastguard Worker
1441*5e7646d2SAndroid Build Coastguard Worker<p>The "device-class" attribute provides the class of device and can be one of the following:
1442*5e7646d2SAndroid Build Coastguard Worker
1443*5e7646d2SAndroid Build Coastguard Worker<ul>
1444*5e7646d2SAndroid Build Coastguard Worker
1445*5e7646d2SAndroid Build Coastguard Worker	<li>'file': A disk file.
1446*5e7646d2SAndroid Build Coastguard Worker
1447*5e7646d2SAndroid Build Coastguard Worker	<li>'direct': A parallel or fixed-rate serial data port,
1448*5e7646d2SAndroid Build Coastguard Worker	currently used for Centronics, IEEE-1284, and USB printer
1449*5e7646d2SAndroid Build Coastguard Worker	ports.
1450*5e7646d2SAndroid Build Coastguard Worker
1451*5e7646d2SAndroid Build Coastguard Worker	<li>'serial': A variable-rate serial port.
1452*5e7646d2SAndroid Build Coastguard Worker
1453*5e7646d2SAndroid Build Coastguard Worker	<li>'network': A network connection, typically via AppSocket, HTTP, IPP, LPD, or SMB/CIFS protocols.
1454*5e7646d2SAndroid Build Coastguard Worker
1455*5e7646d2SAndroid Build Coastguard Worker</ul>
1456*5e7646d2SAndroid Build Coastguard Worker
1457*5e7646d2SAndroid Build Coastguard Worker<h4><a name="device-id">device-id (text(1023))</a><span class="info">Deprecated</span></h4>
1458*5e7646d2SAndroid Build Coastguard Worker
1459*5e7646d2SAndroid Build Coastguard Worker<p>The "device-id" attribute provides the IEEE-1284 device ID string for the device.</p>
1460*5e7646d2SAndroid Build Coastguard Worker
1461*5e7646d2SAndroid Build Coastguard Worker<h4><a name="device-info">device-info (text(127))</a><span class="info">Deprecated</span></h4>
1462*5e7646d2SAndroid Build Coastguard Worker
1463*5e7646d2SAndroid Build Coastguard Worker<p>The "device-info" attribute specifies a human-readable string describing the device, e.g., 'Parallel Port #1'.
1464*5e7646d2SAndroid Build Coastguard Worker
1465*5e7646d2SAndroid Build Coastguard Worker<h4><a name="device-location">device-location (text(127))</a><span class="info">Deprecated</span></h4>
1466*5e7646d2SAndroid Build Coastguard Worker
1467*5e7646d2SAndroid Build Coastguard Worker<p>The "device-location" attribute specifies the physical location of the printer, e.g., '2nd Floor Computer Lab'.
1468*5e7646d2SAndroid Build Coastguard Worker
1469*5e7646d2SAndroid Build Coastguard Worker<h4><a name="device-make-and-model">device-make-and-model (text(127))</a><span class="info">Deprecated</span></h4>
1470*5e7646d2SAndroid Build Coastguard Worker
1471*5e7646d2SAndroid Build Coastguard Worker<p>The "device-make-and-model" attribute specifies a device identification string provided by the printer connected to the device. If the device or printer does not support identification then this attribute contains the string 'unknown'.
1472*5e7646d2SAndroid Build Coastguard Worker
1473*5e7646d2SAndroid Build Coastguard Worker<h4><a name="device-uri">device-uri (uri)</a></h4>
1474*5e7646d2SAndroid Build Coastguard Worker
1475*5e7646d2SAndroid Build Coastguard Worker<p>The "device-uri" attribute specifies a unique identifier for the device. The actual format of the "device-uri" string depends on the value of the "device-class" attribute:
1476*5e7646d2SAndroid Build Coastguard Worker
1477*5e7646d2SAndroid Build Coastguard Worker<ul>
1478*5e7646d2SAndroid Build Coastguard Worker
1479*5e7646d2SAndroid Build Coastguard Worker	<li>'file': The "device-uri" will be of the form 'file:///path/to/filename'.
1480*5e7646d2SAndroid Build Coastguard Worker
1481*5e7646d2SAndroid Build Coastguard Worker	<li>'direct': The "device-uri" will be of the form 'scheme:/dev/filename' or 'scheme://vendor/identifier', where scheme may be 'parallel' or 'usb' in the current implementation.
1482*5e7646d2SAndroid Build Coastguard Worker
1483*5e7646d2SAndroid Build Coastguard Worker	<li>'serial': The "device-uri" will be of the form 'serial:/dev/filename?baud=value+parity=value+flow=value'. The baud value is the data rate in bits per second; the supported values depend on the underlying hardware. The parity value can be one of "none", "even", or "odd". The flow value can be one of "none", "soft" (XON/XOFF handshaking), "hard" or "rts/cts" (RTS/CTS handshaking), or "dtrdsr" (DTR/DSR handshaking).
1484*5e7646d2SAndroid Build Coastguard Worker
1485*5e7646d2SAndroid Build Coastguard Worker	<p>The URI returned by CUPS-Get-Devices will contain the maximum baud rate supported by the device and the best type of flow control available ("soft" or "hard").
1486*5e7646d2SAndroid Build Coastguard Worker
1487*5e7646d2SAndroid Build Coastguard Worker	<li>'network': The "device-uri" will be of the form 'scheme://[username:password@]hostname[:port]/[resource]', where scheme may be "http", "https", "ipp", "lpd", "smb", or "socket" in the current implementation.
1488*5e7646d2SAndroid Build Coastguard Worker
1489*5e7646d2SAndroid Build Coastguard Worker	<p>The URI returned by CUPS-Get-Devices MAY only contain the scheme name ('scheme'). It is up to the client application to add the appropriate host and other information when adding a new printer.
1490*5e7646d2SAndroid Build Coastguard Worker
1491*5e7646d2SAndroid Build Coastguard Worker	<p>The URI returned by Get-Printer-Attributes and CUPS-Get-Printers has any username and password information stripped; the information is still stored and used by the server internally to perform any needed authentication.
1492*5e7646d2SAndroid Build Coastguard Worker
1493*5e7646d2SAndroid Build Coastguard Worker</ul>
1494*5e7646d2SAndroid Build Coastguard Worker
1495*5e7646d2SAndroid Build Coastguard Worker
1496*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='JOB_ATTRIBUTES'>Job Attributes</a></h3>
1497*5e7646d2SAndroid Build Coastguard Worker
1498*5e7646d2SAndroid Build Coastguard Worker<h4><a name="auth-info">auth-info (1setOf text(MAX))</a><span class="info">CUPS 1.3/macOS 10.5</span></h4>
1499*5e7646d2SAndroid Build Coastguard Worker
1500*5e7646d2SAndroid Build Coastguard Worker<p>The "auth-info" attribute specifies the authentication information to use when printing to a remote device. The order and content of each text value is specifed by the <a href="#auth-info-required">auth-info-required</a> printer attribute.
1501*5e7646d2SAndroid Build Coastguard Worker
1502*5e7646d2SAndroid Build Coastguard Worker<h4><a name="job-cancel-after">job-cancel-after (integer(1:MAX))</a><span class='info'>CUPS 2.0</span></h4>
1503*5e7646d2SAndroid Build Coastguard Worker
1504*5e7646d2SAndroid Build Coastguard Worker<p>The "job-cancel-after" attribute provides the maximum number of seconds that are allowed for processing a job.</p>
1505*5e7646d2SAndroid Build Coastguard Worker
1506*5e7646d2SAndroid Build Coastguard Worker<h4><a name="job-hold-until">job-hold-until (keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4>
1507*5e7646d2SAndroid Build Coastguard Worker
1508*5e7646d2SAndroid Build Coastguard Worker<p>The "job-hold-until" attribute specifies a hold time. In addition to the standard IPP/1.1 keyword names, CUPS supports name values of the form "HH:MM" and "HH:MM:SS" that specify a hold time. The hold time is in Universal Coordinated Time (UTC) and <i>not</i> in the local time zone. If the specified time is less than the current time, the job is held until the next day.
1509*5e7646d2SAndroid Build Coastguard Worker
1510*5e7646d2SAndroid Build Coastguard Worker<h4><a name="job-media-progress">job-media-progress (integer(0:100))</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
1511*5e7646d2SAndroid Build Coastguard Worker
1512*5e7646d2SAndroid Build Coastguard Worker<p>The "job-media-progress" status attribute specifies the percentage of completion of the current page. It is only valid when the "job-state" attribute has the 'processing(5)' value.</p>
1513*5e7646d2SAndroid Build Coastguard Worker
1514*5e7646d2SAndroid Build Coastguard Worker<h4><a name="job-printer-state-message">job-printer-state-message (text(MAX))</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
1515*5e7646d2SAndroid Build Coastguard Worker
1516*5e7646d2SAndroid Build Coastguard Worker<p>The "job-printer-state-message" status attribute provides the last known value of the "printer-state-message" attribute for the printer that processed (or is processing) the job.</p>
1517*5e7646d2SAndroid Build Coastguard Worker
1518*5e7646d2SAndroid Build Coastguard Worker<h4><a name="job-printer-state-reasons">job-printer-state-reasons (1setOf type2 keyword)</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
1519*5e7646d2SAndroid Build Coastguard Worker
1520*5e7646d2SAndroid Build Coastguard Worker<p>The "job-printer-state-reasons" status attribute provides the last known value of the "printer-state-reasons" attribute for the printer that processed (or is processing) the job.</p>
1521*5e7646d2SAndroid Build Coastguard Worker
1522*5e7646d2SAndroid Build Coastguard Worker<h4><a name="job-sheets">job-sheets (1setof type3 keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4>
1523*5e7646d2SAndroid Build Coastguard Worker
1524*5e7646d2SAndroid Build Coastguard Worker<p>The "job-sheets" attribute specifies one or two banner files that are printed before and after a job. The reserved value of "none" disables banner printing. The default value is stored in the "job-sheets-default" attribute.
1525*5e7646d2SAndroid Build Coastguard Worker
1526*5e7646d2SAndroid Build Coastguard Worker<p>If only one value is supplied, the banner file is printed before the job. If two values are supplied, the first value is used as the starting banner file and the second as the ending banner file.
1527*5e7646d2SAndroid Build Coastguard Worker
1528*5e7646d2SAndroid Build Coastguard Worker<h4><a name="job-originating-host-name">job-originating-host-name (name(MAX))</a><span class='info'>CUPS 1.1.5/macOS 10.2</span></h4>
1529*5e7646d2SAndroid Build Coastguard Worker
1530*5e7646d2SAndroid Build Coastguard Worker<p>The "job-originating-host-name" status attribute specifies the host from which the job was queued. The value will be the hostname or IP address of the client depending on whether hostname resolution is enabled.  The localhost address (127.0.0.1) is <b>always</b> resolved to the name "localhost".
1531*5e7646d2SAndroid Build Coastguard Worker
1532*5e7646d2SAndroid Build Coastguard Worker<p>This attribute is read-only.
1533*5e7646d2SAndroid Build Coastguard Worker
1534*5e7646d2SAndroid Build Coastguard Worker<h4><a name="page-border">page-border (type2 keyword)</a><span class='info'>CUPS 1.1.15</span></h4>
1535*5e7646d2SAndroid Build Coastguard Worker
1536*5e7646d2SAndroid Build Coastguard Worker<p>The "page-border" attribute specifies whether a border is draw around each page. The following keywords are presently defined:
1537*5e7646d2SAndroid Build Coastguard Worker
1538*5e7646d2SAndroid Build Coastguard Worker<ul>
1539*5e7646d2SAndroid Build Coastguard Worker
1540*5e7646d2SAndroid Build Coastguard Worker	<li>'double': Two hairline borders are drawn</li>
1541*5e7646d2SAndroid Build Coastguard Worker
1542*5e7646d2SAndroid Build Coastguard Worker	<li>'double-thick': Two 1pt borders are drawn</li>
1543*5e7646d2SAndroid Build Coastguard Worker
1544*5e7646d2SAndroid Build Coastguard Worker	<li>'none': No border is drawn (default)</li>
1545*5e7646d2SAndroid Build Coastguard Worker
1546*5e7646d2SAndroid Build Coastguard Worker	<li>'single': A single hairline border is drawn</li>
1547*5e7646d2SAndroid Build Coastguard Worker
1548*5e7646d2SAndroid Build Coastguard Worker	<li>'single-thick': A single 1pt border is drawn</li>
1549*5e7646d2SAndroid Build Coastguard Worker
1550*5e7646d2SAndroid Build Coastguard Worker</ul>
1551*5e7646d2SAndroid Build Coastguard Worker
1552*5e7646d2SAndroid Build Coastguard Worker<h4><a name="page-set">page-set (type2 keyword)</a><span class="info">Deprecated</span></h4>
1553*5e7646d2SAndroid Build Coastguard Worker
1554*5e7646d2SAndroid Build Coastguard Worker<p>The "page-set" attribute specifies which pages to print in a file. The supported keywords are 'all', 'even', and 'odd'. The default value is 'all'.
1555*5e7646d2SAndroid Build Coastguard Worker
1556*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='PPD_ATTRIBUTES'>PPD Attributes</a><span class="info">Deprecated</span></h3>
1557*5e7646d2SAndroid Build Coastguard Worker
1558*5e7646d2SAndroid Build Coastguard Worker<p>PPD attributes are returned in the printer-attributes-tag group.
1559*5e7646d2SAndroid Build Coastguard Worker
1560*5e7646d2SAndroid Build Coastguard Worker<h4><a name="ppd-device-id">ppd-device-id (text(127))</a><span class="info">Deprecated</span></h4>
1561*5e7646d2SAndroid Build Coastguard Worker
1562*5e7646d2SAndroid Build Coastguard Worker<p>The "ppd-device-id" attribute specifies the IEEE-1284 device ID string for the device described by the PPD file.</p>
1563*5e7646d2SAndroid Build Coastguard Worker
1564*5e7646d2SAndroid Build Coastguard Worker<h4><a name="ppd-make">ppd-make (text(127))</a><span class="info">Deprecated</span></h4>
1565*5e7646d2SAndroid Build Coastguard Worker
1566*5e7646d2SAndroid Build Coastguard Worker<p>The "ppd-make" attribute specifies the manufacturer of the printer (the Manufacturer attribute in the PPD file). If the manufacturer is not specified in the PPD file then an educated guess is made using the NickName attribute in the PPD file.
1567*5e7646d2SAndroid Build Coastguard Worker
1568*5e7646d2SAndroid Build Coastguard Worker<h4><a name="ppd-make-and-model">ppd-make-and-model (text(127))</a><span class="info">Deprecated</span></h4>
1569*5e7646d2SAndroid Build Coastguard Worker
1570*5e7646d2SAndroid Build Coastguard Worker<p>The "ppd-make-and-model" attribute specifies the manufacturer and model name of the PPD file (the NickName attribute in the PPD file). If the make and model is not specified in the PPD file then the ModelName or ShortNickName attributes are used instead.
1571*5e7646d2SAndroid Build Coastguard Worker
1572*5e7646d2SAndroid Build Coastguard Worker<h4><a name="ppd-model-number">ppd-model-number (integer)</a><span class="info">Deprecated</span></h4>
1573*5e7646d2SAndroid Build Coastguard Worker
1574*5e7646d2SAndroid Build Coastguard Worker<p>The "ppd-model-number" attribute provides the <tt>cupsModelNumber</tt> value from the PPD file.
1575*5e7646d2SAndroid Build Coastguard Worker
1576*5e7646d2SAndroid Build Coastguard Worker<h4><a name="ppd-name">ppd-name (name(255))</a><span class="info">Deprecated</span></h4>
1577*5e7646d2SAndroid Build Coastguard Worker
1578*5e7646d2SAndroid Build Coastguard Worker<p>The "ppd-name" attribute specifies either the PPD filename on the server relative to the model directory or a URI that maps to a specific driver interface in the driver directory. The forward slash (/) is used to delineate directories.
1579*5e7646d2SAndroid Build Coastguard Worker
1580*5e7646d2SAndroid Build Coastguard Worker<h4><a name="ppd-natural-language">ppd-natural-language (1setOf naturalLanguage)</a><span class="info">Deprecated</span></h4>
1581*5e7646d2SAndroid Build Coastguard Worker
1582*5e7646d2SAndroid Build Coastguard Worker<p>The "ppd-natural-language" attribute specifies the language encoding of the PPD file (the LanguageVersion attribute in the PPD file). If the language is unknown or undefined then "en" (English) is assumed.
1583*5e7646d2SAndroid Build Coastguard Worker
1584*5e7646d2SAndroid Build Coastguard Worker<h4><a name="ppd-product">ppd-product (1setOf text(127))</a><span class="info">Deprecated</span></h4>
1585*5e7646d2SAndroid Build Coastguard Worker
1586*5e7646d2SAndroid Build Coastguard Worker<p>The "ppd-product" attribute specifies the Product attribute values in the PPD file.
1587*5e7646d2SAndroid Build Coastguard Worker
1588*5e7646d2SAndroid Build Coastguard Worker<h4><a name="ppd-psversion">ppd-psversion (1setOf text(127))</a><span class="info">Deprecated</span></h4>
1589*5e7646d2SAndroid Build Coastguard Worker
1590*5e7646d2SAndroid Build Coastguard Worker<p>The "ppd-product" attribute specifies the PSVersion attribute values in the PPD file.
1591*5e7646d2SAndroid Build Coastguard Worker
1592*5e7646d2SAndroid Build Coastguard Worker<h4><a name="ppd-type">ppd-type (type1 keyword)</a><span class="info">Deprecated</span></h4>
1593*5e7646d2SAndroid Build Coastguard Worker
1594*5e7646d2SAndroid Build Coastguard Worker<p>The "ppd-type" attribute specifies the type of driver described by the PPD file:</p>
1595*5e7646d2SAndroid Build Coastguard Worker
1596*5e7646d2SAndroid Build Coastguard Worker<ul>
1597*5e7646d2SAndroid Build Coastguard Worker
1598*5e7646d2SAndroid Build Coastguard Worker	<li>'fax': A facsimile or multi-function device</li>
1599*5e7646d2SAndroid Build Coastguard Worker
1600*5e7646d2SAndroid Build Coastguard Worker	<li>'pdf': A PDF printer</li>
1601*5e7646d2SAndroid Build Coastguard Worker
1602*5e7646d2SAndroid Build Coastguard Worker	<li>'postscript': A PostScript printer (no filters)</li>
1603*5e7646d2SAndroid Build Coastguard Worker
1604*5e7646d2SAndroid Build Coastguard Worker	<li>'raster': A CUPS raster driver</li>
1605*5e7646d2SAndroid Build Coastguard Worker
1606*5e7646d2SAndroid Build Coastguard Worker	<li>'unknown': An unknown or hybrid driver</li>
1607*5e7646d2SAndroid Build Coastguard Worker
1608*5e7646d2SAndroid Build Coastguard Worker</ul>
1609*5e7646d2SAndroid Build Coastguard Worker
1610*5e7646d2SAndroid Build Coastguard Worker
1611*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='PRINTER_ATTRIBUTES'>Printer Attributes</a></h3>
1612*5e7646d2SAndroid Build Coastguard Worker
1613*5e7646d2SAndroid Build Coastguard Worker<h4><a name="auth-info-required">auth-info-required (1setOf type2 keyword)</a><span class="info">CUPS 1.3/macOS 10.5</span></h4>
1614*5e7646d2SAndroid Build Coastguard Worker
1615*5e7646d2SAndroid Build Coastguard Worker<p>The "auth-info-required" attribute specifies the authentication information that is required for printing a job. The following keywords are recognized:</p>
1616*5e7646d2SAndroid Build Coastguard Worker
1617*5e7646d2SAndroid Build Coastguard Worker<ul>
1618*5e7646d2SAndroid Build Coastguard Worker
1619*5e7646d2SAndroid Build Coastguard Worker	<li>'domain': A domain name is required.</li>
1620*5e7646d2SAndroid Build Coastguard Worker
1621*5e7646d2SAndroid Build Coastguard Worker	<li>'negotiate': Kerberos is required - this keyword can only appear by itself and causes cupsd to collect the UID of the printing user.</li>
1622*5e7646d2SAndroid Build Coastguard Worker
1623*5e7646d2SAndroid Build Coastguard Worker	<li>'none': No authentication is required - this keyword can only appear by itself.</li>
1624*5e7646d2SAndroid Build Coastguard Worker
1625*5e7646d2SAndroid Build Coastguard Worker	<li>'password': A password is required.</li>
1626*5e7646d2SAndroid Build Coastguard Worker
1627*5e7646d2SAndroid Build Coastguard Worker	<li>'username': A username is required. Some protocols (like SMB) prefix the username with the domain, for example "DOMAIN\user".</li>
1628*5e7646d2SAndroid Build Coastguard Worker
1629*5e7646d2SAndroid Build Coastguard Worker</ul>
1630*5e7646d2SAndroid Build Coastguard Worker
1631*5e7646d2SAndroid Build Coastguard Worker<h4><a name="job-k-limit">job-k-limit (integer)</a><span class='info'>CUPS 1.1</span></h4>
1632*5e7646d2SAndroid Build Coastguard Worker
1633*5e7646d2SAndroid Build Coastguard Worker<p>The "job-k-limit" attribute specifies the maximum number of kilobytes that may be printed by a user, including banner files. The default value of 0 specifies that there is no limit.
1634*5e7646d2SAndroid Build Coastguard Worker
1635*5e7646d2SAndroid Build Coastguard Worker<h4><a name="job-page-limit">job-page-limit (integer)</a><span class='info'>CUPS 1.1</span></h4>
1636*5e7646d2SAndroid Build Coastguard Worker
1637*5e7646d2SAndroid Build Coastguard Worker<p>The "job-page-limit" attribute specifies the maximum number of pages that may be printed by a user, including banner files. The default value of 0 specifies that there is no limit.
1638*5e7646d2SAndroid Build Coastguard Worker
1639*5e7646d2SAndroid Build Coastguard Worker<h4><a name="job-quota-period">job-quota-period (integer)</a><span class='info'>CUPS 1.1</span></h4>
1640*5e7646d2SAndroid Build Coastguard Worker
1641*5e7646d2SAndroid Build Coastguard Worker<p>The "job-quota-period" attribute specifies the time period used for quota calculations, in seconds. The default value of 0 specifies that the limits apply to all jobs that have been printed by a user that are still known to the system.
1642*5e7646d2SAndroid Build Coastguard Worker
1643*5e7646d2SAndroid Build Coastguard Worker<h4><a name="marker-change-time">marker-change-time (integer)</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
1644*5e7646d2SAndroid Build Coastguard Worker
1645*5e7646d2SAndroid Build Coastguard Worker<p>The "marker-change-time" status attribute specifies the "printer-up-time" value when the last change to the marker-colors, marker-levels, marker-message, marker-names, or marker-types attributes was made.</p>
1646*5e7646d2SAndroid Build Coastguard Worker
1647*5e7646d2SAndroid Build Coastguard Worker<h4><a name="marker-colors">marker-colors (1setof name(MAX))</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
1648*5e7646d2SAndroid Build Coastguard Worker
1649*5e7646d2SAndroid Build Coastguard Worker<p>The "marker-colors" status attribute specifies the color(s) for each supply in the printer. It is only available when the driver provides supply levels. The color is either 'none' or one or more hex-encoded sRGB colors of the form '#RRGGBB'.</p>
1650*5e7646d2SAndroid Build Coastguard Worker
1651*5e7646d2SAndroid Build Coastguard Worker<h4><a name="marker-high-levels">marker-high-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
1652*5e7646d2SAndroid Build Coastguard Worker
1653*5e7646d2SAndroid Build Coastguard Worker<p>The "marker-high-levels" status attribute specifies the supply levels that indicate a near-full condition. A value of 100 should be used for supplies that are consumed/emptied, e.g. ink cartridges.</p>
1654*5e7646d2SAndroid Build Coastguard Worker
1655*5e7646d2SAndroid Build Coastguard Worker<h4><a name="marker-levels">marker-levels (1setof integer(-3:100))</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
1656*5e7646d2SAndroid Build Coastguard Worker
1657*5e7646d2SAndroid Build Coastguard Worker<p>The "marker-levels" status attribute specifies the current supply levels for the printer. It is only available when the driver provides supply levels. A value of -1 indicates the level is unavailable, -2 indicates unknown, and -3 indicates the level is unknown but has not yet reached capacity. Values from 0 to 100 indicate the corresponding percentage.</p>
1658*5e7646d2SAndroid Build Coastguard Worker
1659*5e7646d2SAndroid Build Coastguard Worker<h4><a name="marker-low-levels">marker-low-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
1660*5e7646d2SAndroid Build Coastguard Worker
1661*5e7646d2SAndroid Build Coastguard Worker<p>The "marker-low-levels" status attribute specifies the supply levels that indicate a near-empty condition. A value of 0 should be used for supplies that are filled, e.g. waste ink tanks.</p>
1662*5e7646d2SAndroid Build Coastguard Worker
1663*5e7646d2SAndroid Build Coastguard Worker<h4><a name="marker-message">marker-message (text(MAX))</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
1664*5e7646d2SAndroid Build Coastguard Worker
1665*5e7646d2SAndroid Build Coastguard Worker<p>The "marker-message" status attribute provides a human-readable status message for the current supply levels, e.g. "12 pages of ink remaining." It is only available when the driver provides supply levels.</p>
1666*5e7646d2SAndroid Build Coastguard Worker
1667*5e7646d2SAndroid Build Coastguard Worker<h4><a name="marker-names">marker-names (1setof name(MAX))</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
1668*5e7646d2SAndroid Build Coastguard Worker
1669*5e7646d2SAndroid Build Coastguard Worker<p>The "marker-names" status attribute specifies the name(s) for each supply in the printer. It is only available when the driver provides supply levels.</p>
1670*5e7646d2SAndroid Build Coastguard Worker
1671*5e7646d2SAndroid Build Coastguard Worker<h4><a name="marker-types">marker-types (1setof type3 keyword)</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
1672*5e7646d2SAndroid Build Coastguard Worker
1673*5e7646d2SAndroid Build Coastguard Worker<p>The "marker-types" status attribute specifies the type(s) of each supply in the printer. It is only available when the driver provides supply levels. The following (RFC 3805) types are currently supported:</p>
1674*5e7646d2SAndroid Build Coastguard Worker
1675*5e7646d2SAndroid Build Coastguard Worker<ul>
1676*5e7646d2SAndroid Build Coastguard Worker
1677*5e7646d2SAndroid Build Coastguard Worker	<li>'toner'</li>
1678*5e7646d2SAndroid Build Coastguard Worker
1679*5e7646d2SAndroid Build Coastguard Worker	<li>'waste-toner'</li>
1680*5e7646d2SAndroid Build Coastguard Worker
1681*5e7646d2SAndroid Build Coastguard Worker	<li>'ink'</li>
1682*5e7646d2SAndroid Build Coastguard Worker
1683*5e7646d2SAndroid Build Coastguard Worker	<li>'ink-cartridge'</li>
1684*5e7646d2SAndroid Build Coastguard Worker
1685*5e7646d2SAndroid Build Coastguard Worker	<li>'ink-ribbon'</li>
1686*5e7646d2SAndroid Build Coastguard Worker
1687*5e7646d2SAndroid Build Coastguard Worker	<li>'waste-ink'</li>
1688*5e7646d2SAndroid Build Coastguard Worker
1689*5e7646d2SAndroid Build Coastguard Worker	<li>'opc'</li>
1690*5e7646d2SAndroid Build Coastguard Worker
1691*5e7646d2SAndroid Build Coastguard Worker	<li>'developer'</li>
1692*5e7646d2SAndroid Build Coastguard Worker
1693*5e7646d2SAndroid Build Coastguard Worker	<li>'fuser-oil'</li>
1694*5e7646d2SAndroid Build Coastguard Worker
1695*5e7646d2SAndroid Build Coastguard Worker	<li>'solid-wax'</li>
1696*5e7646d2SAndroid Build Coastguard Worker
1697*5e7646d2SAndroid Build Coastguard Worker	<li>'ribbon-wax'</li>
1698*5e7646d2SAndroid Build Coastguard Worker
1699*5e7646d2SAndroid Build Coastguard Worker	<li>'waste-wax'</li>
1700*5e7646d2SAndroid Build Coastguard Worker
1701*5e7646d2SAndroid Build Coastguard Worker	<li>'fuser'</li>
1702*5e7646d2SAndroid Build Coastguard Worker
1703*5e7646d2SAndroid Build Coastguard Worker	<li>'corona-wire'</li>
1704*5e7646d2SAndroid Build Coastguard Worker
1705*5e7646d2SAndroid Build Coastguard Worker	<li>'fuser-oil-wick'</li>
1706*5e7646d2SAndroid Build Coastguard Worker
1707*5e7646d2SAndroid Build Coastguard Worker	<li>'cleaner-unit'</li>
1708*5e7646d2SAndroid Build Coastguard Worker
1709*5e7646d2SAndroid Build Coastguard Worker	<li>'fuser-cleaning-pad'</li>
1710*5e7646d2SAndroid Build Coastguard Worker
1711*5e7646d2SAndroid Build Coastguard Worker	<li>'transfer-unit'</li>
1712*5e7646d2SAndroid Build Coastguard Worker
1713*5e7646d2SAndroid Build Coastguard Worker	<li>'toner-cartridge'</li>
1714*5e7646d2SAndroid Build Coastguard Worker
1715*5e7646d2SAndroid Build Coastguard Worker	<li>'fuser-oiler'</li>
1716*5e7646d2SAndroid Build Coastguard Worker
1717*5e7646d2SAndroid Build Coastguard Worker	<li>'water'</li>
1718*5e7646d2SAndroid Build Coastguard Worker
1719*5e7646d2SAndroid Build Coastguard Worker	<li>'waste-water'</li>
1720*5e7646d2SAndroid Build Coastguard Worker
1721*5e7646d2SAndroid Build Coastguard Worker	<li>'binding-supply'</li>
1722*5e7646d2SAndroid Build Coastguard Worker
1723*5e7646d2SAndroid Build Coastguard Worker	<li>'banding-supply'</li>
1724*5e7646d2SAndroid Build Coastguard Worker
1725*5e7646d2SAndroid Build Coastguard Worker	<li>'stiching-wire'</li>
1726*5e7646d2SAndroid Build Coastguard Worker
1727*5e7646d2SAndroid Build Coastguard Worker	<li>'shrink-wrap'</li>
1728*5e7646d2SAndroid Build Coastguard Worker
1729*5e7646d2SAndroid Build Coastguard Worker	<li>'paper-wrap'</li>
1730*5e7646d2SAndroid Build Coastguard Worker
1731*5e7646d2SAndroid Build Coastguard Worker	<li>'staples'</li>
1732*5e7646d2SAndroid Build Coastguard Worker
1733*5e7646d2SAndroid Build Coastguard Worker	<li>'inserts'</li>
1734*5e7646d2SAndroid Build Coastguard Worker
1735*5e7646d2SAndroid Build Coastguard Worker	<li>'covers'</li>
1736*5e7646d2SAndroid Build Coastguard Worker
1737*5e7646d2SAndroid Build Coastguard Worker</ul>
1738*5e7646d2SAndroid Build Coastguard Worker
1739*5e7646d2SAndroid Build Coastguard Worker<h4><a name="port-monitor">port-monitor" (name(127))</a><span class="info">Deprecated</span></h4>
1740*5e7646d2SAndroid Build Coastguard Worker
1741*5e7646d2SAndroid Build Coastguard Worker<p>The "port-monitor" attribute specifies the port monitor to use when printing to this printer. The default port monitor is 'none'.
1742*5e7646d2SAndroid Build Coastguard Worker
1743*5e7646d2SAndroid Build Coastguard Worker<h4><a name="port-monitor-supported">port-monitor-supported" (1setOf name(127))</a><span class="info">Deprecated</span></h4>
1744*5e7646d2SAndroid Build Coastguard Worker
1745*5e7646d2SAndroid Build Coastguard Worker<p>The "port-monitor-supported" attribute specifies the available port monitors.
1746*5e7646d2SAndroid Build Coastguard Worker
1747*5e7646d2SAndroid Build Coastguard Worker<h4><a name="printer-commands">printer-commands (1setOf Type3 keyword)</a><span class='info'>Deprecated</span></h4>
1748*5e7646d2SAndroid Build Coastguard Worker
1749*5e7646d2SAndroid Build Coastguard Worker<p>The "printer-commands" attribute specifies the commands that are supported by the CUPS command file filter. The keyword 'none' indicates that no commands are supported.</p>
1750*5e7646d2SAndroid Build Coastguard Worker
1751*5e7646d2SAndroid Build Coastguard Worker<h4><a name="printer-dns-sd-name">printer-dns-sd-name (name(MAX) | noValue)</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
1752*5e7646d2SAndroid Build Coastguard Worker
1753*5e7646d2SAndroid Build Coastguard Worker<p>The "printer-dns-sd-name" attribute specifies the registered DNS-SD service name for the printer. If the printer is not being shared using this protocol, "printer-dns-sd-name" will have the no-value value.</p>
1754*5e7646d2SAndroid Build Coastguard Worker
1755*5e7646d2SAndroid Build Coastguard Worker<h4><a name="printer-id">printer-id (integer(0:65535)</a><span class="info">CUPS 2.2</span></h4>
1756*5e7646d2SAndroid Build Coastguard Worker
1757*5e7646d2SAndroid Build Coastguard Worker<p>The "printer-id" status attribute provides a unique integer identifying the printer. It is used when only an IP address and integer are provided for identifying a print queue.</p>
1758*5e7646d2SAndroid Build Coastguard Worker
1759*5e7646d2SAndroid Build Coastguard Worker<h4><a name="printer-type">printer-type (type2 enum)</a></h4>
1760*5e7646d2SAndroid Build Coastguard Worker
1761*5e7646d2SAndroid Build Coastguard Worker<p>The "printer-type" status attribute specifies printer type and capability bits for the printer or class. The default value is computed from internal state information and the PPD file for the printer. The following bits are defined:</p>
1762*5e7646d2SAndroid Build Coastguard Worker
1763*5e7646d2SAndroid Build Coastguard Worker<div class='table'><table align='center' border='1' width='80%' summary='Printer Type Bits'>
1764*5e7646d2SAndroid Build Coastguard Worker<thead>
1765*5e7646d2SAndroid Build Coastguard Worker<tr>
1766*5e7646d2SAndroid Build Coastguard Worker	<th>Bit</th>
1767*5e7646d2SAndroid Build Coastguard Worker	<th>Description</th>
1768*5e7646d2SAndroid Build Coastguard Worker</tr>
1769*5e7646d2SAndroid Build Coastguard Worker</thead>
1770*5e7646d2SAndroid Build Coastguard Worker<tbody>
1771*5e7646d2SAndroid Build Coastguard Worker<tr>
1772*5e7646d2SAndroid Build Coastguard Worker	<td>0x00000001</td>
1773*5e7646d2SAndroid Build Coastguard Worker	<td>Is a printer class.</td>
1774*5e7646d2SAndroid Build Coastguard Worker</tr>
1775*5e7646d2SAndroid Build Coastguard Worker<tr>
1776*5e7646d2SAndroid Build Coastguard Worker	<td>0x00000002</td>
1777*5e7646d2SAndroid Build Coastguard Worker	<td>Is a remote destination.</td>
1778*5e7646d2SAndroid Build Coastguard Worker</tr>
1779*5e7646d2SAndroid Build Coastguard Worker<tr>
1780*5e7646d2SAndroid Build Coastguard Worker	<td>0x00000004</td>
1781*5e7646d2SAndroid Build Coastguard Worker	<td>Can print in black.</td>
1782*5e7646d2SAndroid Build Coastguard Worker</tr>
1783*5e7646d2SAndroid Build Coastguard Worker<tr>
1784*5e7646d2SAndroid Build Coastguard Worker	<td>0x00000008</td>
1785*5e7646d2SAndroid Build Coastguard Worker	<td>Can print in color.</td>
1786*5e7646d2SAndroid Build Coastguard Worker</tr>
1787*5e7646d2SAndroid Build Coastguard Worker<tr>
1788*5e7646d2SAndroid Build Coastguard Worker	<td>0x00000010</td>
1789*5e7646d2SAndroid Build Coastguard Worker	<td>Can print on both sides of the page in hardware.</td>
1790*5e7646d2SAndroid Build Coastguard Worker</tr>
1791*5e7646d2SAndroid Build Coastguard Worker<tr>
1792*5e7646d2SAndroid Build Coastguard Worker	<td>0x00000020</td>
1793*5e7646d2SAndroid Build Coastguard Worker	<td>Can staple output.</td>
1794*5e7646d2SAndroid Build Coastguard Worker</tr>
1795*5e7646d2SAndroid Build Coastguard Worker<tr>
1796*5e7646d2SAndroid Build Coastguard Worker	<td>0x00000040</td>
1797*5e7646d2SAndroid Build Coastguard Worker	<td>Can do fast copies in hardware.</td>
1798*5e7646d2SAndroid Build Coastguard Worker</tr>
1799*5e7646d2SAndroid Build Coastguard Worker<tr>
1800*5e7646d2SAndroid Build Coastguard Worker	<td>0x00000080</td>
1801*5e7646d2SAndroid Build Coastguard Worker	<td>Can do fast copy collation in hardware.</td>
1802*5e7646d2SAndroid Build Coastguard Worker</tr>
1803*5e7646d2SAndroid Build Coastguard Worker<tr>
1804*5e7646d2SAndroid Build Coastguard Worker	<td>0x00000100</td>
1805*5e7646d2SAndroid Build Coastguard Worker	<td>Can punch output.</td>
1806*5e7646d2SAndroid Build Coastguard Worker</tr>
1807*5e7646d2SAndroid Build Coastguard Worker<tr>
1808*5e7646d2SAndroid Build Coastguard Worker	<td>0x00000200</td>
1809*5e7646d2SAndroid Build Coastguard Worker	<td>Can cover output.</td>
1810*5e7646d2SAndroid Build Coastguard Worker</tr>
1811*5e7646d2SAndroid Build Coastguard Worker<tr>
1812*5e7646d2SAndroid Build Coastguard Worker	<td>0x00000400</td>
1813*5e7646d2SAndroid Build Coastguard Worker	<td>Can bind output.</td>
1814*5e7646d2SAndroid Build Coastguard Worker</tr>
1815*5e7646d2SAndroid Build Coastguard Worker<tr>
1816*5e7646d2SAndroid Build Coastguard Worker	<td>0x00000800</td>
1817*5e7646d2SAndroid Build Coastguard Worker	<td>Can sort output.</td>
1818*5e7646d2SAndroid Build Coastguard Worker</tr>
1819*5e7646d2SAndroid Build Coastguard Worker<tr>
1820*5e7646d2SAndroid Build Coastguard Worker	<td>0x00001000</td>
1821*5e7646d2SAndroid Build Coastguard Worker	<td>Can handle media up to US-Legal/A4.</td>
1822*5e7646d2SAndroid Build Coastguard Worker</tr>
1823*5e7646d2SAndroid Build Coastguard Worker<tr>
1824*5e7646d2SAndroid Build Coastguard Worker	<td>0x00002000</td>
1825*5e7646d2SAndroid Build Coastguard Worker	<td>Can handle media from US-Legal/A4 to ISO-C/A2.</td>
1826*5e7646d2SAndroid Build Coastguard Worker</tr>
1827*5e7646d2SAndroid Build Coastguard Worker<tr>
1828*5e7646d2SAndroid Build Coastguard Worker	<td>0x00004000</td>
1829*5e7646d2SAndroid Build Coastguard Worker	<td>Can handle media larger than ISO-C/A2.</td>
1830*5e7646d2SAndroid Build Coastguard Worker</tr>
1831*5e7646d2SAndroid Build Coastguard Worker<tr>
1832*5e7646d2SAndroid Build Coastguard Worker	<td>0x00008000</td>
1833*5e7646d2SAndroid Build Coastguard Worker	<td>Can handle user-defined media sizes.</td>
1834*5e7646d2SAndroid Build Coastguard Worker</tr>
1835*5e7646d2SAndroid Build Coastguard Worker<tr>
1836*5e7646d2SAndroid Build Coastguard Worker	<td>0x00010000</td>
1837*5e7646d2SAndroid Build Coastguard Worker	<td>Is an implicit (server-generated) class.</td>
1838*5e7646d2SAndroid Build Coastguard Worker</tr>
1839*5e7646d2SAndroid Build Coastguard Worker<tr>
1840*5e7646d2SAndroid Build Coastguard Worker	<td>0x00020000</td>
1841*5e7646d2SAndroid Build Coastguard Worker	<td>Is the a default printer on the network.</td>
1842*5e7646d2SAndroid Build Coastguard Worker</tr>
1843*5e7646d2SAndroid Build Coastguard Worker<tr>
1844*5e7646d2SAndroid Build Coastguard Worker	<td>0x00040000</td>
1845*5e7646d2SAndroid Build Coastguard Worker	<td>Is a facsimile device.</td>
1846*5e7646d2SAndroid Build Coastguard Worker</tr>
1847*5e7646d2SAndroid Build Coastguard Worker<tr>
1848*5e7646d2SAndroid Build Coastguard Worker	<td>0x00080000</td>
1849*5e7646d2SAndroid Build Coastguard Worker	<td>Is rejecting jobs.</td>
1850*5e7646d2SAndroid Build Coastguard Worker</tr>
1851*5e7646d2SAndroid Build Coastguard Worker<tr>
1852*5e7646d2SAndroid Build Coastguard Worker	<td>0x00100000</td>
1853*5e7646d2SAndroid Build Coastguard Worker	<td>Delete this queue.</td>
1854*5e7646d2SAndroid Build Coastguard Worker</tr>
1855*5e7646d2SAndroid Build Coastguard Worker<tr>
1856*5e7646d2SAndroid Build Coastguard Worker	<td>0x00200000</td>
1857*5e7646d2SAndroid Build Coastguard Worker	<td>Queue is not shared.</td>
1858*5e7646d2SAndroid Build Coastguard Worker</tr>
1859*5e7646d2SAndroid Build Coastguard Worker<tr>
1860*5e7646d2SAndroid Build Coastguard Worker	<td>0x00400000</td>
1861*5e7646d2SAndroid Build Coastguard Worker	<td>Queue requires authentication.</td>
1862*5e7646d2SAndroid Build Coastguard Worker</tr>
1863*5e7646d2SAndroid Build Coastguard Worker<tr>
1864*5e7646d2SAndroid Build Coastguard Worker	<td>0x00800000</td>
1865*5e7646d2SAndroid Build Coastguard Worker	<td>Queue supports CUPS command files.</td>
1866*5e7646d2SAndroid Build Coastguard Worker</tr>
1867*5e7646d2SAndroid Build Coastguard Worker<tr>
1868*5e7646d2SAndroid Build Coastguard Worker	<td>0x01000000</td>
1869*5e7646d2SAndroid Build Coastguard Worker	<td>Queue was automatically discovered and added.</td>
1870*5e7646d2SAndroid Build Coastguard Worker</tr>
1871*5e7646d2SAndroid Build Coastguard Worker<tr>
1872*5e7646d2SAndroid Build Coastguard Worker	<td>0x02000000</td>
1873*5e7646d2SAndroid Build Coastguard Worker	<td>Queue is a scanner with no printing capabilities.</td>
1874*5e7646d2SAndroid Build Coastguard Worker</tr>
1875*5e7646d2SAndroid Build Coastguard Worker<tr>
1876*5e7646d2SAndroid Build Coastguard Worker	<td>0x04000000</td>
1877*5e7646d2SAndroid Build Coastguard Worker	<td>Queue is a printer with scanning capabilities.</td>
1878*5e7646d2SAndroid Build Coastguard Worker</tr>
1879*5e7646d2SAndroid Build Coastguard Worker<tr>
1880*5e7646d2SAndroid Build Coastguard Worker	<td>0x08000000</td>
1881*5e7646d2SAndroid Build Coastguard Worker	<td>Queue is a printer with 3D capabilities.</td>
1882*5e7646d2SAndroid Build Coastguard Worker</tr>
1883*5e7646d2SAndroid Build Coastguard Worker</tbody>
1884*5e7646d2SAndroid Build Coastguard Worker</table></div>
1885*5e7646d2SAndroid Build Coastguard Worker
1886*5e7646d2SAndroid Build Coastguard Worker<h4>printer-type-mask (type2 enum)<span class='info'>CUPS 1.1</span></h4>
1887*5e7646d2SAndroid Build Coastguard Worker
1888*5e7646d2SAndroid Build Coastguard Worker<p>The "printer-type-mask" attribute is used to choose printers or classes with the CUPS-Get-Printers and CUPS-Get-Classes operations. The bits are defined identically to the printer-type attribute and default to all 1's.
1889*5e7646d2SAndroid Build Coastguard Worker
1890*5e7646d2SAndroid Build Coastguard Worker<h4>requesting-user-name-allowed (1setof name(127))<span class='info'>CUPS 1.1</span></h4>
1891*5e7646d2SAndroid Build Coastguard Worker
1892*5e7646d2SAndroid Build Coastguard Worker<p>The "requesting-user-name-allowed" attribute lists all of the users that are allowed to access a printer or class. Either this attribute or the "requesting-user-name-denied" attribute will be defined, but not both.
1893*5e7646d2SAndroid Build Coastguard Worker
1894*5e7646d2SAndroid Build Coastguard Worker<h4>requesting-user-name-denied (1setof name(127))<span class='info'>CUPS 1.1</span></h4>
1895*5e7646d2SAndroid Build Coastguard Worker
1896*5e7646d2SAndroid Build Coastguard Worker<p>The "requesting-user-name-denied" attribute lists all of the users that are not allowed to access a printer or class. Either this attribute or the "requesting-user-name-allowed" attribute will be defined, but not both.
1897*5e7646d2SAndroid Build Coastguard Worker
1898*5e7646d2SAndroid Build Coastguard Worker<h3 class='title'><a name='CLASS_ATTRIBUTES'>Printer Class Attributes</a></h3>
1899*5e7646d2SAndroid Build Coastguard Worker
1900*5e7646d2SAndroid Build Coastguard Worker<p>Printer class attributes are placed in the printer-attributes-tag group.</p>
1901*5e7646d2SAndroid Build Coastguard Worker
1902*5e7646d2SAndroid Build Coastguard Worker<h4>member-names (1setof name(127))</h4>
1903*5e7646d2SAndroid Build Coastguard Worker
1904*5e7646d2SAndroid Build Coastguard Worker<p>The "member-names" attribute specifies the "printer-name" attributes for each the member printer and class. Each name corresponds to the same element of the "member-uris" attribute.
1905*5e7646d2SAndroid Build Coastguard Worker
1906*5e7646d2SAndroid Build Coastguard Worker<h4>member-uris (1setof uri)</h4>
1907*5e7646d2SAndroid Build Coastguard Worker
1908*5e7646d2SAndroid Build Coastguard Worker<p>The "member-uris" attribute specifies the "printer-uri-supported" values for each member printer and class. Each URI corresponds to the same element of the "member-names" attribute.
1909*5e7646d2SAndroid Build Coastguard Worker
1910*5e7646d2SAndroid Build Coastguard Worker</body>
1911*5e7646d2SAndroid Build Coastguard Worker</html>
1912