]>
Commit | Line | Data |
---|---|---|
fa73b229 | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> |
2 | <html> | |
4744bd90 | 3 | <!-- SECTION: Specifications --> |
fa73b229 | 4 | <head> |
5 | <title>CUPS Implementation of IPP</title> | |
6 | <meta name='keywords' content='Programming, Internet Printing Protocol'> | |
7 | </head> | |
8 | <body> | |
9 | <!-- | |
f7faf1f5 | 10 | "$Id$" |
fa73b229 | 11 | |
12 | CUPS IPP specification for the Common UNIX Printing System (CUPS). | |
13 | ||
f7deaa1a | 14 | Copyright 1997-2007 by Easy Software Products. |
fa73b229 | 15 | |
16 | These coded instructions, statements, and computer programs are the | |
17 | property of Easy Software Products and are protected by Federal | |
18 | copyright law. Distribution and use rights are outlined in the file | |
19 | "LICENSE.txt" which should have been included with this file. If this | |
20 | file is missing or damaged please contact Easy Software Products | |
21 | at: | |
22 | ||
23 | Attn: CUPS Licensing Information | |
24 | Easy Software Products | |
25 | 44141 Airport View Drive, Suite 204 | |
26 | Hollywood, Maryland 20636 USA | |
27 | ||
28 | Voice: (301) 373-9600 | |
29 | EMail: cups-info@cups.org | |
30 | WWW: http://www.cups.org | |
31 | --> | |
32 | ||
33 | <h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2> | |
34 | ||
35 | <p>CUPS 1.1 implements IPP/1.1 and the operations and attributes | |
36 | defined in the "IPP: Job and Printer Set Operations", "IPP/1.1: | |
37 | Output-bin Attribute Extension", and "IPP/1.1: finishings | |
38 | 'fold',' trim', and 'bale' attribute values extension" | |
39 | specifications.</p> | |
40 | ||
b94498cf | 41 | <p>CUPS also provides 15 new operations and many new attributes |
fa73b229 | 42 | to support multiple IPP printers and printer classes on a single |
43 | host.</p> | |
44 | ||
45 | <h3 class='title'><a name='IPP_URIS'>IPP URIs</a></h3> | |
46 | ||
47 | <p>CUPS supports the "http", "https", and "ipp" schemes. The | |
48 | following resource names are used:</p> | |
49 | ||
50 | <dl> | |
51 | ||
52 | <dt><tt>scheme://hostname:port/</tt></dt> | |
53 | ||
54 | <dd>Can be used for all "get" operations and for server | |
55 | subscriptions.</dd> | |
56 | ||
57 | <dt><tt>scheme://hostname:port/admin/</tt></dt> | |
58 | ||
59 | <dd>Used for all administrative operations.</dd> | |
60 | ||
61 | <dt><tt>scheme://hostname:port/classes/name</tt></dt> | |
62 | ||
63 | <dd>Specifies a printer class.</dd> | |
64 | ||
65 | <dt><tt>scheme://hostname:port/jobs/id</tt></dt> | |
66 | ||
67 | <dd>Specifies a job.</dd> | |
68 | ||
69 | <dt><tt>scheme://hostname:port/printers/name</tt></dt> | |
70 | ||
71 | <dd>Specifies a printer.</dd> | |
72 | ||
73 | </dl> | |
74 | ||
75 | <p>So a typical printer URI would be | |
76 | "ipp://foo.bar.com/printers/LaserJet". In addition, the CUPS | |
77 | server also supports normal browser access via | |
78 | "http://hostname:port/" and "https://hostname:port/".</p> | |
79 | ||
80 | <h3 class='title'><a name='IPP_OPERATIONS'>CUPS IPP Operations</a></h3> | |
81 | ||
82 | <p>CUPS provides 14 extension operations in addition to most of the | |
83 | standard IPP and registered extension operations: | |
84 | ||
85 | <div class='table'><table align='center' border='1' width='80%' | |
86 | summary='Supported Operations'> | |
87 | <thead> | |
88 | <tr> | |
89 | <TH VALIGN="TOP">Operation Name</th> | |
90 | <TH VALIGN="TOP">CUPS</th> | |
91 | <TH VALIGN="TOP">Code</th> | |
92 | <TH VALIGN="TOP">Brief Description</th> | |
93 | </tr> | |
94 | </thead> | |
95 | <tbody> | |
96 | <tr> | |
97 | <td><a href='#PRINT_JOB'>Print-Job</a></td> | |
98 | <td>1.0</td> | |
99 | <td>0x0002</td> | |
100 | <td>Print a file.</td> | |
101 | </tr> | |
102 | <tr> | |
103 | <td>Validate-Job</td> | |
104 | <td>1.0</td> | |
105 | <td>0x0004</td> | |
106 | <td>Validate job attributes.</td> | |
107 | </tr> | |
108 | <tr> | |
109 | <td><a href='#CREATE_JOB'>Create-Job</a></td> | |
110 | <td>1.1</td> | |
111 | <td>0x0005</td> | |
112 | <td>Create a print job.</td> | |
113 | </tr> | |
114 | <tr> | |
115 | <td>Send-Document</td> | |
116 | <td>1.1</td> | |
117 | <td>0x0006</td> | |
118 | <td>Send a file for a print job.</td> | |
119 | </tr> | |
120 | <tr> | |
121 | <td>Cancel-Job</td> | |
122 | <td>1.0</td> | |
123 | <td>0x0008</td> | |
124 | <td>Cancel a print job.</td> | |
125 | </tr> | |
126 | <tr> | |
127 | <td>Get-Job-Attributes</td> | |
128 | <td>1.0</td> | |
129 | <td>0x0009</td> | |
130 | <td>Get job attributes.</td> | |
131 | </tr> | |
132 | <tr> | |
133 | <td>Get-Jobs</td> | |
134 | <td>1.0</td> | |
135 | <td>0x000A</td> | |
136 | <td>Get all jobs.</td> | |
137 | </tr> | |
138 | <tr> | |
139 | <td>Get-Printer-Attributes</td> | |
140 | <td>1.0</td> | |
141 | <td>0x000B</td> | |
142 | <td>Get printer attributes.</td> | |
143 | </tr> | |
144 | <tr> | |
145 | <td>Hold-Job</td> | |
146 | <td>1.1</td> | |
147 | <td>0x000C</td> | |
148 | <td>Hold a job for printing.</td> | |
149 | </tr> | |
150 | <tr> | |
151 | <td>Release-Job</td> | |
152 | <td>1.1</td> | |
153 | <td>0x000D</td> | |
154 | <td>Release a job for printing.</td> | |
155 | </tr> | |
156 | <tr> | |
157 | <td>Restart-Job</td> | |
158 | <td>1.1</td> | |
159 | <td>0x000E</td> | |
160 | <td>Restarts a print job.</td> | |
161 | </tr> | |
162 | <tr> | |
163 | <td>Pause-Printer</td> | |
164 | <td>1.0</td> | |
165 | <td>0x0010</td> | |
166 | <td>Pause printing on a printer.</td> | |
167 | </tr> | |
168 | <tr> | |
169 | <td>Resume-Printer</td> | |
170 | <td>1.0</td> | |
171 | <td>0x0011</td> | |
172 | <td>Resume printing on a printer.</td> | |
173 | </tr> | |
174 | <tr> | |
175 | <td>Purge-Jobs</td> | |
176 | <td>1.0</td> | |
177 | <td>0x0012</td> | |
178 | <td>Purge all jobs.</td> | |
179 | </tr> | |
180 | <tr> | |
181 | <td><a href='#SET_JOB_ATTRIBUTES'>Set-Job-Attributes</a></td> | |
182 | <td>1.1</td> | |
183 | <td>0x0014</td> | |
184 | <td>Set attributes for a pending or held job.</td> | |
185 | </tr> | |
186 | <tr> | |
187 | <td><a href='#CREATE_PRINTER_SUBSCRIPTION'>Create-Printer-Subscription</a></td> | |
188 | <td>1.2</td> | |
189 | <td>0x0016</td> | |
190 | <td>Creates a subscription associated with a printer or the server.</td> | |
191 | </tr> | |
192 | <tr> | |
193 | <td>Create-Job-Subscription</td> | |
194 | <td>1.2</td> | |
195 | <td>0x0017</td> | |
196 | <td>Creates a subscription associated with a job.</td> | |
197 | </tr> | |
198 | <tr> | |
199 | <td>Get-Subscription-Attributes</td> | |
200 | <td>1.2</td> | |
201 | <td>0x0018</td> | |
202 | <td>Gets the attributes for a subscription.</td> | |
203 | </tr> | |
204 | <tr> | |
205 | <td>Get-Subscriptions</td> | |
206 | <td>1.2</td> | |
207 | <td>0x0019</td> | |
208 | <td>Gets the attributes for zero or more subscriptions.</td> | |
209 | </tr> | |
210 | <tr> | |
211 | <td>Renew-Subscription</td> | |
212 | <td>1.2</td> | |
213 | <td>0x001A</td> | |
214 | <td>Renews a subscription.</td> | |
215 | </tr> | |
216 | <tr> | |
217 | <td>Cancel-Subscription</td> | |
218 | <td>1.2</td> | |
219 | <td>0x001B</td> | |
220 | <td>Cancels a subscription.</td> | |
221 | </tr> | |
222 | <tr> | |
223 | <td>Get-Notifications</td> | |
224 | <td>1.2</td> | |
225 | <td>0x001C</td> | |
226 | <td>Get notification events for <tt>ippget</tt> subscriptions.</td> | |
227 | </tr> | |
228 | <tr> | |
229 | <td>Enable-Printer</td> | |
230 | <td>1.2</td> | |
231 | <td>0x0022</td> | |
232 | <td>Accepts jobs on a printer.</td> | |
233 | </tr> | |
234 | <tr> | |
235 | <td>Disable-Printer</td> | |
236 | <td>1.2</td> | |
237 | <td>0x0023</td> | |
238 | <td>Rejects jobs on a printer.</td> | |
239 | </tr> | |
240 | <tr> | |
241 | <td><a href='#CUPS_GET_DEFAULT'>CUPS-Get-Default</a></td> | |
242 | <td>1.0</td> | |
243 | <td>0x4001</td> | |
244 | <td>Get the default destination.</td> | |
245 | </tr> | |
246 | <tr> | |
247 | <td><a href='#CUPS_GET_PRINTERS'>CUPS-Get-Printers</a></td> | |
248 | <td>1.0</td> | |
249 | <td>0x4002</td> | |
250 | <td>Get all of the available printers.</td> | |
251 | </tr> | |
252 | <tr> | |
253 | <td><a href='#CUPS_ADD_MODIFY_PRINTER'>CUPS-Add-Modify-Printer</a></td> | |
254 | <td>1.0</td> | |
255 | <td>0x4003</td> | |
256 | <td>Add or modify a printer.</td> | |
257 | </tr> | |
258 | <tr> | |
259 | <td><a href='#CUPS_DELETE_PRINTER'>CUPS-Delete-Printer</a></td> | |
260 | <td>1.0</td> | |
261 | <td>0x4004</td> | |
262 | <td>Delete a printer.</td> | |
263 | </tr> | |
264 | <tr> | |
265 | <td><a href='#CUPS_GET_CLASSES'>CUPS-Get-Classes</a></td> | |
266 | <td>1.0</td> | |
267 | <td>0x4005</td> | |
268 | <td>Get all of the available printer classes.</td> | |
269 | </tr> | |
270 | <tr> | |
271 | <td><a href='#CUPS_ADD_MODIFY_CLASS'>CUPS-Add-Modify-Class</a></td> | |
272 | <td>1.0</td> | |
273 | <td>0x4006</td> | |
274 | <td>Add or modify a printer class.</td> | |
275 | </tr> | |
276 | <tr> | |
277 | <td><a href='#CUPS_DELETE_CLASS'>CUPS-Delete-Class</a></td> | |
278 | <td>1.0</td> | |
279 | <td>0x4007</td> | |
280 | <td>Delete a printer class.</td> | |
281 | </tr> | |
282 | <tr> | |
283 | <td><a href='#CUPS_ACCEPT_JOBS'>CUPS-Accept-Jobs</a></td> | |
284 | <td>1.0</td> | |
285 | <td>0x4008</td> | |
286 | <td>Accept jobs on a printer or printer class.</td> | |
287 | </tr> | |
288 | <tr> | |
289 | <td><a href='#CUPS_REJECT_JOBS'>CUPS-Reject-Jobs</a></td> | |
290 | <td>1.0</td> | |
291 | <td>0x4009</td> | |
292 | <td>Reject jobs on a printer or printer class.</td> | |
293 | </tr> | |
294 | <tr> | |
295 | <td><a href='#CUPS_SET_DEFAULT'>CUPS-Set-Default</a></td> | |
296 | <td>1.0</td> | |
297 | <td>0x400A</td> | |
298 | <td>Set the default destination.</td> | |
299 | </tr> | |
300 | <tr> | |
301 | <td><a href='#CUPS_GET_DEVICES'>CUPS-Get-Devices</a></td> | |
302 | <td>1.1</td> | |
303 | <td>0x400B</td> | |
304 | <td>Get all of the available devices.</td> | |
305 | </tr> | |
306 | <tr> | |
307 | <td><a href='#CUPS_GET_PPDS'>CUPS-Get-PPDs</a></td> | |
308 | <td>1.1</td> | |
309 | <td>0x400C</td> | |
310 | <td>Get all of the available PPDs.</td> | |
311 | </tr> | |
312 | <tr> | |
313 | <td><a href='#CUPS_MOVE_JOB'>CUPS-Move-Job</a></td> | |
314 | <td>1.1</td> | |
315 | <td>0x400D</td> | |
316 | <td>Move a job to a different printer.</td> | |
317 | </tr> | |
318 | <tr> | |
319 | <td><a href='#CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job</a></td> | |
320 | <td>1.2</td> | |
321 | <td>0x400E</td> | |
322 | <td>Authenticate a job for printing.</td> | |
323 | </tr> | |
b94498cf | 324 | <tr> |
325 | <td><a href='#CUPS_GET_PPD'>CUPS-Get-PPD</a></td> | |
326 | <td>1.3</td> | |
327 | <td>0x400F</td> | |
328 | <td>Get a PPD file.</td> | |
329 | </tr> | |
fa73b229 | 330 | </tbody> |
331 | </table></div> | |
332 | ||
333 | <h2 class='title'><a name='OPERATIONS'>Operations</a></h2> | |
334 | ||
335 | <p>The following sections describe the operations supported by CUPS. | |
336 | In the interest of brevity, operations which use only the standard | |
337 | IPP attributes are not described. | |
338 | ||
339 | <h3 class='title'><a name='PRINT_JOB'>Print-Job Operation</a></h3> | |
340 | ||
341 | <p>The Print-Job operation (0x0002) prints a file. | |
342 | ||
343 | <h4>Print-Job Request</h4> | |
344 | ||
345 | <p>The following groups of attributes are supplied as part of the | |
346 | Print-Job request: | |
347 | ||
348 | <p>Group 1: Operation Attributes | |
349 | ||
350 | <dl> | |
351 | ||
352 | <dt>Natural Language and Character Set: | |
353 | ||
354 | <dd>The "attributes-charset" and "attributes-natural-language" | |
355 | attributes as described in section 3.1.4.1 of the IPP Model and | |
356 | Semantics document. | |
357 | ||
358 | <dt>"printer-uri" (uri): | |
359 | ||
360 | <dd>The client MUST supply a URI for the specified printer. | |
361 | ||
362 | </dl> | |
363 | ||
364 | <p>Group 2: Job Template Attributes | |
365 | ||
366 | <dl> | |
367 | ||
f7deaa1a | 368 | <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3</span> |
369 | ||
370 | <dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute. | |
371 | ||
fa73b229 | 372 | <dt>"job-billing" (text(MAX)):<span class='info'>CUPS 1.1</span> |
373 | ||
374 | <dd>The client OPTIONALLY supplies a billing string that is logged | |
375 | with the page accounting information. | |
376 | ||
377 | <dt>"job-sheets" (1setof type3 keyword | name(MAX)):<span class='info'>CUPS 1.1</span> | |
378 | ||
379 | <dd>The client OPTIONALLY supplies one or two banner pages that | |
380 | are printed before and after any files in the print job. The | |
381 | name of "none" is reserved to indicate that no banner page | |
382 | should be printed. If the client does not specify this | |
383 | attribute then the value of the "job-sheets-default" printer | |
384 | object attribute is used. | |
385 | ||
386 | <blockquote><b>Note:</b> Standard IPP only allows | |
387 | specification of a single job-sheets attribute | |
388 | value.</blockquote> | |
389 | ||
390 | <dt>"media" (1setof type3 keyword | name(MAX)): | |
391 | ||
392 | <dd>The client OPTIONALLY supplies one or more media attributes | |
393 | specifying the size, type, source, and color of the output | |
394 | media. If the client does not specify this attribute then the | |
395 | value of the "media-default" printer object attribute is used. | |
396 | ||
397 | <blockquote><b>Note:</b> Standard IPP only allows | |
398 | specification of a single media attribute | |
399 | value.</blockquote> | |
400 | ||
401 | <dt>Other Job Template Attributes | |
402 | ||
403 | </dl> | |
404 | ||
405 | <p>The Print-Job request is followed by a file to be printed. | |
406 | ||
407 | <h4>Print-Job Response</h4> | |
408 | ||
409 | <p>The following groups of attributes are send as part of the Print-Job | |
410 | Response: | |
411 | ||
412 | <p>Group 1: Operation Attributes | |
413 | ||
414 | <dl> | |
415 | ||
416 | <dt>Status Message: | |
417 | ||
418 | <dd>The standard response status message. | |
419 | ||
420 | <dt>Natural Language and Character Set: | |
421 | ||
422 | <dd>The "attributes-charset" and "attributes-natural-language" | |
423 | attributes as described in section 3.1.4.2 of the IPP Model and | |
424 | Semantics document. | |
425 | ||
426 | </dl> | |
427 | ||
428 | <p>Group 2: Job Attributes | |
429 | ||
430 | <dl> | |
431 | ||
432 | <dt>Standard Job Attributes | |
433 | ||
434 | </dl> | |
435 | ||
f7deaa1a | 436 | <p>Group 3: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported) |
437 | ||
438 | <dl> | |
439 | ||
440 | <dt>auth-info-required (1setOf Type2 keyword) | |
441 | ||
442 | <dd>The required authentication information. | |
443 | ||
444 | </dl | |
445 | ||
fa73b229 | 446 | <h3 class='title'><span class='info'>CUPS 1.1</span><a name='CREATE_JOB'>Create-Job Operation</a></h3> |
447 | ||
448 | <p>The Create-Job operation (0x0005) creates a new, empty print job. | |
449 | ||
450 | <h4>Create-Job Request</h4> | |
451 | ||
452 | <p>The following groups of attributes are supplied as part of the | |
453 | Create-Job request: | |
454 | ||
455 | <p>Group 1: Operation Attributes | |
456 | ||
457 | <dl> | |
458 | ||
459 | <dt>Natural Language and Character Set: | |
460 | ||
461 | <dd>The "attributes-charset" and "attributes-natural-language" | |
462 | attributes as described in section 3.1.4.1 of the IPP Model and | |
463 | Semantics document. | |
464 | ||
465 | <dt>"printer-uri" (uri): | |
466 | ||
467 | <dd>The client MUST supply a URI for the specified printer. | |
468 | ||
469 | </dl> | |
470 | ||
471 | <p>Group 2: Job Template Attributes | |
472 | ||
473 | <dl> | |
474 | ||
f7deaa1a | 475 | <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3</span> |
476 | ||
477 | <dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute. | |
478 | ||
fa73b229 | 479 | <dt>"job-billing" (text(MAX)):<span class='info'>CUPS 1.1</span> |
480 | ||
481 | <dd>The client OPTIONALLY supplies a billing string that is logged | |
482 | with the page accounting information. | |
483 | ||
484 | <dt>"job-sheets" (1setof type3 keyword | name(MAX)):<span class='info'>CUPS 1.1</span> | |
485 | ||
486 | <dd>The client OPTIONALLY supplies one or two banner pages that | |
487 | are printed before and after any files in the print job. The | |
488 | name of "none" is reserved to indicate that no banner page | |
489 | should be printed. If the client does not specify this | |
490 | attribute then the value of the "job-sheets-default" printer | |
491 | object attribute is used. | |
492 | ||
493 | <blockquote><b>Note:</b> Standard IPP only allows | |
494 | specification of a single job-sheets attribute | |
495 | value.</blockquote> | |
496 | ||
497 | <dt>"media" (1setof type3 keyword | name(MAX)): | |
498 | ||
499 | <dd>The client OPTIONALLY supplies one or more media attributes | |
500 | specifying the size, type, source, and color of the output | |
501 | media. If the client does not specify this attribute then the | |
502 | value of the "media-default" printer object attribute is used. | |
503 | ||
504 | <blockquote><b>Note:</b> Standard IPP only allows | |
505 | specification of a single media attribute | |
506 | value.</blockquote> | |
507 | ||
508 | <dt>Standard Job Template Attributes | |
509 | ||
510 | </dl> | |
511 | ||
512 | <h4>Create-Job Response</h4> | |
513 | ||
514 | <p>The following groups of attributes are send as part of the | |
515 | Create-Job Response: | |
516 | ||
517 | <p>Group 1: Operation Attributes | |
518 | ||
519 | <dl> | |
520 | ||
521 | <dt>Status Message: | |
522 | ||
523 | <dd>The standard response status message. | |
524 | ||
525 | <dt>Natural Language and Character Set: | |
526 | ||
527 | <dd>The "attributes-charset" and "attributes-natural-language" | |
528 | attributes as described in section 3.1.4.2 of the IPP Model and | |
529 | Semantics document. | |
530 | ||
531 | </dl> | |
532 | ||
533 | <p>Group 2: Job Attributes | |
534 | ||
535 | <dl> | |
536 | ||
537 | <dt>Standard Job Attributes | |
538 | ||
539 | </dl> | |
540 | ||
f7deaa1a | 541 | <p>Group 3: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported) |
542 | ||
543 | <dl> | |
544 | ||
545 | <dt>auth-info-required (1setOf Type2 keyword) | |
546 | ||
547 | <dd>The required authentication information. | |
548 | ||
549 | </dl | |
550 | ||
fa73b229 | 551 | <h3 class='title'><span class='info'>CUPS 1.1</span><a name='SET_JOB_ATTRIBUTES'>Set-Job-Attributes Operation</a></h3> |
552 | ||
553 | <p>The Set-Job-Attributes operation (0x0014) changes the attributes of | |
554 | an active (not completed) job. | |
555 | ||
556 | <h4>Set-Job-Attributes Request</h4> | |
557 | ||
558 | <p>The following groups of attributes are supplied as part of the | |
559 | Set-Job-Attributes request: | |
560 | ||
561 | <p>Group 1: Operation Attributes | |
562 | ||
563 | <dl> | |
564 | ||
565 | <dt>Natural Language and Character Set: | |
566 | ||
567 | <dd>The "attributes-charset" and "attributes-natural-language" | |
568 | attributes as described in section 3.1.4.1 of the IPP Model and | |
569 | Semantics document. | |
570 | ||
571 | <dt>"printer-uri" (uri) and "job-id" (integer) | |
572 | <br><i>OR</i> | |
573 | <br>"job-uri": | |
574 | ||
575 | <dd>The client MUST supply a URI for the specified printer and | |
576 | a job ID number, or the job URI. | |
577 | ||
578 | </dl> | |
579 | ||
580 | <p>Group 2: Job Template Attributes | |
581 | ||
582 | <dl> | |
583 | ||
584 | <dt>"job-sheets" (1setof type3 keyword | name(MAX)):<span class='info'>CUPS 1.1</span> | |
585 | ||
586 | <dd>The client OPTIONALLY supplies one or two banner pages that | |
587 | are printed before and after any files in the print job. The | |
588 | name of "none" is reserved to indicate that no banner page | |
589 | should be printed. If the client does not specify this | |
590 | attribute then the value of the "job-sheets-default" printer | |
591 | object attribute is used. | |
592 | ||
593 | <blockquote><b>Note:</b> Standard IPP only allows | |
594 | specification of a single job-sheets attribute | |
595 | value.</blockquote> | |
596 | ||
597 | <dt>"media" (1setof type3 keyword | name(MAX)): | |
598 | ||
599 | <dd>The client OPTIONALLY supplies one or more media attributes | |
600 | specifying the size, type, source, and color of the output | |
601 | media. If the client does not specify this attribute then the | |
602 | value of the "media-default" printer object attribute is used. | |
603 | ||
604 | <blockquote><b>Note:</b> Standard IPP only allows | |
605 | specification of a single media attribute | |
606 | value.</blockquote> | |
607 | ||
608 | <dt>Other Job Template Attributes | |
609 | ||
610 | </dl> | |
611 | ||
612 | <h4>Set-Job-Attributes Response</h4> | |
613 | ||
614 | <p>The following groups of attributes are send as part of the Set-Job-Attributes | |
615 | Response: | |
616 | ||
617 | <p>Group 1: Operation Attributes | |
618 | ||
619 | <dl> | |
620 | ||
621 | <dt>Status Message: | |
622 | ||
623 | <dd>The standard response status message. | |
624 | ||
625 | <dt>Natural Language and Character Set: | |
626 | ||
627 | <dd>The "attributes-charset" and "attributes-natural-language" | |
628 | attributes as described in section 3.1.4.2 of the IPP Model and | |
629 | Semantics document. | |
630 | ||
631 | </dl> | |
632 | ||
633 | <h3 class='title'><span class='info'>CUPS 1.2</span><a | |
634 | name='CREATE_PRINTER_SUBSCRIPTION'>Create-Printer-Subscription</a></h3> | |
635 | ||
636 | <p>The Create-Printer-Subscription operation (0x0016) creates a | |
637 | subscription for printer or server event notifications. CUPS | |
638 | provides several additional events in addition to the standard | |
639 | events in the IPP notifications specification.</p> | |
640 | ||
f7deaa1a | 641 | <h4>Create-Printer-Subscription Request</h4> |
fa73b229 | 642 | |
643 | <p>The following groups of attributes are supplied as part of the | |
644 | request:</p> | |
645 | ||
646 | <p>Group 1: Operation Attributes</p> | |
647 | ||
648 | <dl> | |
649 | ||
650 | <dt>Natural Language and Character Set: | |
651 | ||
652 | <dd>The "attributes-charset" and "attributes-natural-language" | |
653 | attributes as described in section 3.1.4.1 of the IPP Model and | |
654 | Semantics document. | |
655 | ||
656 | <dt>"printer-uri" (uri): | |
657 | ||
658 | <dd>The printer | |
659 | (<tt>ipp://server/printers/printername</tt>), class | |
660 | (<tt>ipp://server/classes/classname</tt>), or server | |
661 | (<tt>ipp://server/</tt>) URI for event notifications. | |
662 | ||
663 | <dt>"notify-events" (1setOf keyword): | |
664 | ||
665 | <dd>The events to monitor. In addition to the standard | |
666 | events, CUPS adds the following keywords: | |
667 | <ul> | |
668 | ||
669 | <li><tt>printer-added</tt> - Get notified | |
670 | whenever a printer or class is added</li> | |
671 | ||
672 | <li><tt>printer-deleted</tt> - Get notified | |
673 | whenever a printer or class is deleted</li> | |
674 | ||
675 | <li><tt>printer-modified</tt> - Get notified | |
676 | whenever a printer or class is modified</li> | |
677 | ||
678 | <li><tt>server-audit</tt> - Get notified when a | |
679 | security condition occurs</li> | |
680 | ||
681 | <li><tt>server-restarted</tt> - Get notified when | |
682 | the server is restarted</li> | |
683 | ||
684 | <li><tt>server-started</tt> - Get notified when | |
685 | the server is started</li> | |
686 | ||
687 | <li><tt>server-stopped</tt> - Get notified when | |
688 | the server is stopped</li> | |
689 | ||
690 | </ul> | |
691 | ||
692 | </dl> | |
693 | ||
f7deaa1a | 694 | <h4>Create-Printer-Subscription Response</h4> |
fa73b229 | 695 | |
696 | <p>The following groups of attributes are send as part of the | |
697 | response:</p> | |
698 | ||
699 | <p>Group 1: Operation Attributes</p> | |
700 | ||
701 | <dl> | |
702 | ||
703 | <dt>Status Message: | |
704 | ||
705 | <dd>The standard response status message. | |
706 | ||
707 | <dt>Natural Language and Character Set: | |
708 | ||
709 | <dd>The "attributes-charset" and "attributes-natural-language" | |
710 | attributes as described in section 3.1.4.2 of the IPP Model and | |
711 | Semantics document. | |
712 | ||
713 | </dl> | |
714 | ||
715 | <p>Group 2: Subscription Object Attributes</p> | |
716 | ||
717 | <dl> | |
718 | ||
719 | <dt>"subscription-id" (integer): | |
720 | ||
721 | <dd>The subscription number. | |
722 | ||
723 | </dl> | |
724 | ||
725 | <h3 class='title'><a name='CUPS_GET_DEFAULT'>CUPS-Get-Default Operation</a></h3> | |
726 | ||
727 | <p>The CUPS-Get-Default operation (0x4001) returns the default printer | |
728 | URI and attributes. | |
729 | ||
730 | <h4>CUPS-Get-Default Request</h4> | |
731 | ||
732 | <p>The following groups of attributes are supplied as part of the | |
733 | CUPS-Get-Default request: | |
734 | ||
735 | <p>Group 1: Operation Attributes | |
736 | ||
737 | <dl> | |
738 | ||
739 | <dt>Natural Language and Character Set: | |
740 | ||
741 | <dd>The "attributes-charset" and "attributes-natural-language" | |
742 | attributes as described in section 3.1.4.1 of the IPP Model and | |
743 | Semantics document. | |
744 | ||
745 | <dt>"requested-attributes" (1setOf keyword) : | |
746 | ||
747 | <dd>The client OPTIONALLY supplies a set of attribute names | |
748 | and/or attribute group names in whose values the requester is | |
749 | interested. If the client omits this attribute, the server | |
750 | responds as if this attribute had been supplied with a value of | |
751 | 'all'. | |
752 | ||
753 | </dl> | |
754 | ||
755 | <h4>CUPS-Get-Default Response</h4> | |
756 | ||
757 | <p>The following groups of attributes are send as part of the | |
758 | CUPS-Get-Default Response: | |
759 | ||
760 | <p>Group 1: Operation Attributes | |
761 | ||
762 | <dl> | |
763 | ||
764 | <dt>Status Message: | |
765 | ||
766 | <dd>The standard response status message. | |
767 | ||
768 | <dt>Natural Language and Character Set: | |
769 | ||
770 | <dd>The "attributes-charset" and "attributes-natural-language" | |
771 | attributes as described in section 3.1.4.2 of the IPP Model and | |
772 | Semantics document. | |
773 | ||
774 | </dl> | |
775 | ||
776 | <p>Group 2: Printer Object Attributes | |
777 | ||
778 | <dl> | |
779 | ||
780 | <dt>The set of requested attributes and their current values. | |
781 | ||
782 | </dl> | |
783 | ||
784 | <h3 class='title'><a name='CUPS_GET_PRINTERS'>CUPS-Get-Printers Operation</a></h3> | |
785 | ||
786 | <p>The CUPS-Get-Printers operation (0x4002) returns the printer | |
787 | attributes for every printer known to the system. This may include | |
788 | printers that are not served directly by the server. | |
789 | ||
790 | <h4>CUPS-Get-Printers Request</h4> | |
791 | ||
792 | <p>The following groups of attributes are supplied as part of the | |
793 | CUPS-Get-Printers request: | |
794 | ||
795 | <p>Group 1: Operation Attributes | |
796 | ||
797 | <dl> | |
798 | ||
799 | <dt>Natural Language and Character Set: | |
800 | ||
801 | <dd>The "attributes-charset" and "attributes-natural-language" | |
802 | attributes as described in section 3.1.4.1 of the IPP Model and | |
803 | Semantics document. | |
804 | ||
805 | <dt>"limit" (integer (1:MAX)): | |
806 | ||
807 | <dd>The client OPTIONALLY supplies this attribute limiting the | |
808 | number of printers that are returned. | |
809 | ||
810 | <dt>"printer-info" (text(127)):<span class='info'>CUPS 1.1</span> | |
811 | ||
812 | <dd>The client OPTIONALLY supplies this attribute to | |
813 | select which printers are returned. | |
814 | ||
815 | <dt>"printer-location" (text(127)): <span class='info'>CUPS 1.1.7</span> | |
816 | ||
817 | <dd>The client OPTIONALLY supplies this attribute to | |
818 | select which printers are returned. | |
819 | ||
820 | <dt>"printer-type" (type2 enum): <span class='info'>CUPS 1.1.7</span> | |
821 | ||
822 | <dd>The client OPTIONALLY supplies a printer type enumeration to | |
823 | select which printers are returned. | |
824 | ||
825 | <dt>"printer-type-mask" (type2 enum): <span class='info'>CUPS 1.1.7</span> | |
826 | ||
827 | <dd>The client OPTIONALLY supplies a printer type mask | |
828 | enumeration to select which bits are used in the "printer-type" | |
829 | attribute. | |
830 | ||
831 | <dt>"requested-attributes" (1setOf keyword) : | |
832 | ||
833 | <dd>The client OPTIONALLY supplies a set of attribute names | |
834 | and/or attribute group names in whose values the requester is | |
835 | interested. If the client omits this attribute, the server | |
836 | responds as if this attribute had been supplied with a value of | |
837 | 'all'. | |
838 | ||
839 | </dl> | |
840 | ||
841 | <h4>CUPS-Get-Printers Response</h4> | |
842 | ||
843 | <p>The following groups of attributes are send as part of the | |
844 | CUPS-Get-Printers Response: | |
845 | ||
846 | <p>Group 1: Operation Attributes | |
847 | ||
848 | <dl> | |
849 | ||
850 | <dt>Status Message: | |
851 | ||
852 | <dd>The standard response status message. | |
853 | ||
854 | <dt>Natural Language and Character Set: | |
855 | ||
856 | <dd>The "attributes-charset" and "attributes-natural-language" | |
857 | attributes as described in section 3.1.4.2 of the IPP Model and | |
858 | Semantics document. | |
859 | ||
860 | </dl> | |
861 | ||
862 | <p>Group 2: Printer Object Attributes | |
863 | ||
864 | <dl> | |
865 | ||
866 | <dt>The set of requested attributes and their current values for | |
867 | each printer. | |
868 | ||
869 | </dl> | |
870 | ||
871 | <h3 class='title'><a name='CUPS_ADD_MODIFY_PRINTER'>CUPS-Add-Modify-Printer Operation</a></h3> | |
872 | ||
873 | <p>The CUPS-Add-Modify-Printer operation (0x4003) adds a new printer or | |
874 | modifies an existing printer on the system. | |
875 | ||
876 | <h4>CUPS-Add-Modify-Printer Request</h4> | |
877 | ||
878 | <p>The following groups of attributes are supplied as part of the | |
879 | CUPS-Add-Modify-Printer request: | |
880 | ||
881 | <p>Group 1: Operation Attributes | |
882 | ||
883 | <dl> | |
884 | ||
885 | <dt>Natural Language and Character Set: | |
886 | ||
887 | <dd>The "attributes-charset" and "attributes-natural-language" | |
888 | attributes as described in section 3.1.4.1 of the IPP Model and | |
889 | Semantics document. | |
890 | ||
891 | <dt>"printer-uri" (uri): | |
892 | ||
893 | <dd>The client MUST supply a URI for the specified printer. | |
894 | ||
895 | </dl> | |
896 | ||
897 | <p>Group 2: Printer Object Attributes | |
898 | ||
899 | <dl> | |
900 | ||
f7deaa1a | 901 | <dt>"auth-info-required" (1setOf type2 keyword):<span class='info'>CUPS 1.3</span> |
902 | ||
903 | <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue. | |
904 | ||
fa73b229 | 905 | <dt>"job-sheets-default" (1setOf name(127)): <span |
906 | class='info'>CUPS 1.1.7</span> | |
907 | ||
908 | <dd>The client OPTIONALLY supplies one or two banner page | |
909 | names that are printed before and after files in a job. | |
910 | The reserved name "none" is used to specify that no | |
911 | banner page should be printed. | |
912 | ||
913 | <dt>"device-uri" (uri): | |
914 | ||
915 | <dd>The client OPTIONALLY supplies a device URI for the | |
916 | specified printer. | |
917 | ||
09a101d6 | 918 | <dt>"port-monitor" (name(127)): |
919 | ||
920 | <dd>The client OPTIONALLY supplies a port monitor name for the | |
921 | specified printer. | |
922 | ||
fa73b229 | 923 | <dt>"ppd-name" (name(127)): |
924 | ||
925 | <dd>The client OPTIONALLY supplies a PPD name for the specified | |
926 | printer. | |
927 | ||
928 | <dt>"printer-is-accepting-jobs" (boolean): | |
929 | ||
930 | <dd>The client OPTIONALLY supplies this boolean attribute | |
931 | indicating whether or not the printer object should accept new jobs. | |
932 | ||
933 | <dt>"printer-info" (text(127)): | |
934 | ||
935 | <dd>The client OPTIONALLY supplies this attribute indicating the | |
936 | printer information string. | |
937 | ||
938 | <dt>"printer-location" (text(127)): | |
939 | ||
940 | <dd>The client OPTIONALLY supplies this attribute indicating a | |
941 | textual location of the printer. | |
942 | ||
943 | <dt>"printer-more-info" (uri): | |
944 | ||
945 | <dd>The client OPTIONALLY supplies this attribute indicating a | |
946 | URI for additional printer information. | |
947 | ||
948 | <dt>"printer-state" (type2 enum): | |
949 | ||
950 | <dd>The client OPTIONALLY supplies this attribute indicating the | |
951 | initial/current state of the printer. Only the "idle" and "stopped" | |
952 | enumerations are recognized. | |
953 | ||
954 | <dt>"printer-state-message" (text(MAX)): | |
955 | ||
956 | <dd>The client OPTIONALLY supplies this attribute indicating a | |
957 | textual reason for the current printer state. | |
958 | ||
959 | <dt>"requesting-user-name-allowed" (1setof name(127) | delete) | |
960 | <br><i>OR</i> | |
961 | <br>"requesting-user-name-denied" (1setof name(127) | delete): | |
962 | ||
963 | <dd>The client OPTIONALLY supplies one of these attributes to | |
964 | specify an access control list for incoming print jobs. To allow | |
965 | all users access to a printer, use the delete tag for the | |
966 | attribute value. | |
967 | ||
968 | </dl> | |
969 | ||
970 | <p>The CUPS-Add-Modify-Printer request can optionally be followed by a PPD | |
971 | file or System V interface script to be used for the printer. The | |
972 | "ppd-name" attribute overrides any file that is attached to the end of | |
973 | the request with a local CUPS PPD file. | |
974 | ||
975 | <h4>CUPS-Add-Modify-Printer Response</h4> | |
976 | ||
977 | <p>The following groups of attributes are send as part of the | |
978 | CUPS-Add-Modify-Printer Response: | |
979 | ||
980 | <p>Group 1: Operation Attributes | |
981 | ||
982 | <dl> | |
983 | ||
984 | <dt>Status Message: | |
985 | ||
986 | <dd>The standard response status message. | |
987 | ||
988 | <dt>Natural Language and Character Set: | |
989 | ||
990 | <dd>The "attributes-charset" and "attributes-natural-language" | |
991 | attributes as described in section 3.1.4.2 of the IPP Model and | |
992 | Semantics document. | |
993 | ||
994 | </dl> | |
995 | ||
996 | <h3 class='title'><a name='CUPS_DELETE_PRINTER'>CUPS-Delete-Printer Operation</a></h3> | |
997 | ||
998 | <p>The CUPS-Delete-Printer operation (0x4004) removes an existing | |
999 | printer from the system. | |
1000 | ||
1001 | <h4>CUPS-Delete-Printer Request</h4> | |
1002 | ||
1003 | <p>The following groups of attributes are supplied as part of the | |
1004 | CUPS-Delete-Printer request: | |
1005 | ||
1006 | <p>Group 1: Operation Attributes | |
1007 | ||
1008 | <dl> | |
1009 | ||
1010 | <dt>Natural Language and Character Set: | |
1011 | ||
1012 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1013 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1014 | Semantics document. | |
1015 | ||
1016 | <dt>"printer-uri" (uri): | |
1017 | ||
1018 | <dd>The client MUST supply a URI for the specified printer. | |
1019 | ||
1020 | </dl> | |
1021 | ||
1022 | <h4>CUPS-Delete-Printer Response</h4> | |
1023 | ||
1024 | <p>The following groups of attributes are send as part of the | |
1025 | CUPS-Delete-Printer Response: | |
1026 | ||
1027 | <p>Group 1: Operation Attributes | |
1028 | ||
1029 | <dl> | |
1030 | ||
1031 | <dt>Status Message: | |
1032 | ||
1033 | <dd>The standard response status message. | |
1034 | ||
1035 | <dt>Natural Language and Character Set: | |
1036 | ||
1037 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1038 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1039 | Semantics document. | |
1040 | ||
1041 | </dl> | |
1042 | ||
1043 | <h3 class='title'><a name='CUPS_GET_CLASSES'>CUPS-Get-Classes Operation</a></h3> | |
1044 | ||
1045 | <p>The CUPS-Get-Classes operation (0x4005) returns the printer | |
1046 | attributes for every printer class known to the system. This may | |
1047 | include printer classes that are not served directly by the server. | |
1048 | ||
1049 | <h4>CUPS-Get-Classes Request</h4> | |
1050 | ||
1051 | <p>The following groups of attributes are supplied as part of the | |
1052 | CUPS-Get-Classes request: | |
1053 | ||
1054 | <p>Group 1: Operation Attributes | |
1055 | ||
1056 | <dl> | |
1057 | ||
1058 | <dt>Natural Language and Character Set: | |
1059 | ||
1060 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1061 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1062 | Semantics document. | |
1063 | ||
1064 | <dt>"limit" (integer (1:MAX)): | |
1065 | ||
1066 | <dd>The client OPTIONALLY supplies this attribute limiting the | |
1067 | number of printer classes that are returned. | |
1068 | ||
1069 | <dt>"printer-info" (text(127)): <span class='info'>CUPS 1.1.7</span> | |
1070 | <dd>The client OPTIONALLY supplies this attribute to | |
1071 | select which printer classes are returned. | |
1072 | ||
1073 | <dt>"printer-location" (text(127)): <span class='info'>CUPS 1.1.7</span> | |
1074 | <dd>The client OPTIONALLY supplies this attribute to | |
1075 | select which printer classes are returned. | |
1076 | ||
1077 | <dt>"printer-type" (type2 enum): <span class='info'>CUPS 1.1.7</span> | |
1078 | <dd>The client OPTIONALLY supplies a printer type enumeration to | |
1079 | select which printer classes are returned. | |
1080 | ||
1081 | <dt>"printer-type-mask" (type2 enum): <span class='info'>CUPS 1.1.7</span> | |
1082 | <dd>The client OPTIONALLY supplies a printer type mask | |
1083 | enumeration to select which bits are used in the "printer-type" | |
1084 | attribute. | |
1085 | ||
1086 | <dt>"requested-attributes" (1setOf keyword) : | |
1087 | ||
1088 | <dd>The client OPTIONALLY supplies a set of attribute names | |
1089 | and/or attribute group names in whose values the requester is | |
1090 | interested. If the client omits this attribute, the server responds as | |
1091 | if this attribute had been supplied with a value of 'all'. | |
1092 | ||
1093 | </dl> | |
1094 | ||
1095 | <h4>CUPS-Get-Classes Response</h4> | |
1096 | ||
1097 | <p>The following groups of attributes are send as part of the | |
1098 | CUPS-Get-Classes Response: | |
1099 | ||
1100 | <p>Group 1: Operation Attributes | |
1101 | ||
1102 | <dl> | |
1103 | ||
1104 | <dt>Status Message: | |
1105 | ||
1106 | <dd>The standard response status message. | |
1107 | ||
1108 | <dt>Natural Language and Character Set: | |
1109 | ||
1110 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1111 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1112 | Semantics document. | |
1113 | ||
1114 | </dl> | |
1115 | ||
1116 | <p>Group 2: Printer Class Object Attributes | |
1117 | ||
1118 | <dl> | |
1119 | ||
1120 | <dt>The set of requested attributes and their current values for | |
1121 | each printer class. | |
1122 | ||
1123 | </dl> | |
1124 | ||
1125 | <h3 class='title'><a name='CUPS_ADD_MODIFY_CLASS'>CUPS-Add-Modify-Class Operation</a></h3> | |
1126 | ||
1127 | <p>The CUPS-Add-Modify-Class operation (0x4006) adds a new printer class or | |
1128 | modifies and existing printer class on the system. | |
1129 | ||
1130 | <h4>CUPS-Add-Modify-Class Request</h4> | |
1131 | ||
1132 | <p>The following groups of attributes are supplied as part of the | |
1133 | CUPS-Add-Modify-Class request: | |
1134 | ||
1135 | <p>Group 1: Operation Attributes | |
1136 | ||
1137 | <dl> | |
1138 | ||
1139 | <dt>Natural Language and Character Set: | |
1140 | ||
1141 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1142 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1143 | Semantics document. | |
1144 | ||
1145 | <dt>"printer-uri" (uri): | |
1146 | ||
1147 | <dd>The client MUST supply a URI for the specified printer class. | |
1148 | ||
1149 | </dl> | |
1150 | ||
1151 | <p>Group 2: Printer Object Attributes | |
1152 | ||
1153 | <dl> | |
1154 | ||
f7deaa1a | 1155 | <dt>"auth-info-required" (1setOf type2 keyword):<span class='info'>CUPS 1.3</span> |
1156 | ||
1157 | <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue. | |
1158 | ||
fa73b229 | 1159 | <dt>"member-uris" (1setof uri): |
1160 | ||
1161 | <dd>The client OPTIONALLY supplies the "member-uris" set | |
1162 | specifying the printers and printer classes that are part of the class. | |
1163 | ||
1164 | <dt>"printer-is-accepting-jobs" (boolean): | |
1165 | ||
1166 | <dd>The client OPTIONALLY supplies this boolean attribute | |
1167 | indicating whether or not the class object should accept new jobs. | |
1168 | ||
1169 | <dt>"printer-info" (text(127)): | |
1170 | ||
1171 | <dd>The client OPTIONALLY supplies this attribute indicating the | |
1172 | printer information string. | |
1173 | ||
1174 | <dt>"printer-location" (text(127)): | |
1175 | ||
1176 | <dd>The client OPTIONALLY supplies this attribute indicating a | |
1177 | textual location of the class. | |
1178 | ||
1179 | <dt>"printer-more-info" (uri): | |
1180 | ||
1181 | <dd>The client OPTIONALLY supplies this attribute indicating a | |
1182 | URI for additional class information. | |
1183 | ||
1184 | <dt>"printer-state" (type2 enum): | |
1185 | ||
1186 | <dd>The client OPTIONALLY supplies this attribute indicating the | |
1187 | initial/current state of the class. Only the "idle" and "stopped" | |
1188 | enumerations are recognized. | |
1189 | ||
1190 | <dt>"printer-state-message" (text(MAX)): | |
1191 | ||
1192 | <dd>The client OPTIONALLY supplies this attribute indicating a | |
1193 | textual reason for the current class state. | |
1194 | ||
1195 | <dt>"requesting-user-name-allowed" (1setof name(127)) | |
1196 | <br><i>OR</i> | |
1197 | <br>"requesting-user-name-denied" (1setof name(127)): | |
1198 | ||
1199 | <dd>The client OPTIONALLY supplies one of these attributes to | |
1200 | specify an access control list for incoming print jobs. To allow | |
1201 | all users access to a class, use the delete tag for the | |
1202 | attribute value. | |
1203 | ||
1204 | </dl> | |
1205 | ||
1206 | <h4>CUPS-Add-Modify-Class Response</h4> | |
1207 | ||
1208 | <p>The following groups of attributes are send as part of the CUPS-Add-Modify-Class Response: | |
1209 | ||
1210 | <p>Group 1: Operation Attributes | |
1211 | ||
1212 | <dl> | |
1213 | ||
1214 | <dt>Status Message: | |
1215 | ||
1216 | <dd>The standard response status message. | |
1217 | ||
1218 | <dt>Natural Language and Character Set: | |
1219 | ||
1220 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1221 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1222 | Semantics document. | |
1223 | ||
1224 | </dl> | |
1225 | ||
1226 | <h3 class='title'><a name='CUPS_DELETE_CLASS'>CUPS-Delete-Class Operation</a></h3> | |
1227 | ||
1228 | <p>The CUPS-Delete-Class operation (0x4007) removes an existing printer | |
1229 | class from the system. | |
1230 | ||
1231 | <h4>CUPS-Delete-Class Request</h4> | |
1232 | ||
1233 | <p>The following groups of attributes are supplied as part of the | |
1234 | CUPS-Delete-Class request: | |
1235 | ||
1236 | <p>Group 1: Operation Attributes | |
1237 | ||
1238 | <dl> | |
1239 | ||
1240 | <dt>Natural Language and Character Set: | |
1241 | ||
1242 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1243 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1244 | Semantics document. | |
1245 | ||
1246 | <dt>"printer-uri" (uri): | |
1247 | ||
1248 | <dd>The client MUST supply a URI for the specified printer class. | |
1249 | ||
1250 | </dl> | |
1251 | ||
1252 | <h4>CUPS-Delete-Class Response</h4> | |
1253 | ||
1254 | <p>The following groups of attributes are send as part of the | |
1255 | CUPS-Delete-Class Response: | |
1256 | ||
1257 | <p>Group 1: Operation Attributes | |
1258 | ||
1259 | <dl> | |
1260 | ||
1261 | <dt>Status Message: | |
1262 | ||
1263 | <dd>The standard response status message. | |
1264 | ||
1265 | <dt>Natural Language and Character Set: | |
1266 | ||
1267 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1268 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1269 | Semantics document. | |
1270 | ||
1271 | </dl> | |
1272 | ||
1273 | <h3 class='title'><a name='CUPS_ACCEPT_JOBS'>CUPS-Accept-Jobs Operation</a></h3> | |
1274 | ||
1275 | <p>The CUPS-Accept-Jobs operation (0x4008) sets the | |
1276 | "printer-is-accepting-jobs" attribute to true for the specified printer | |
1277 | or printer class. | |
1278 | ||
1279 | <h4>CUPS-Accept-Jobs Request</h4> | |
1280 | ||
1281 | <p>The following groups of attributes are supplied as part of the | |
1282 | CUPS-Accept-Jobs request: | |
1283 | ||
1284 | <p>Group 1: Operation Attributes | |
1285 | ||
1286 | <dl> | |
1287 | ||
1288 | <dt>Natural Language and Character Set: | |
1289 | ||
1290 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1291 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1292 | Semantics document. | |
1293 | ||
1294 | <dt>"printer-uri" (uri): | |
1295 | ||
1296 | <dd>The client MUST supply a URI for the specified printer or printer class. | |
1297 | ||
1298 | </dl> | |
1299 | ||
1300 | <h4>CUPS-Accept-Jobs Response</h4> | |
1301 | ||
1302 | <p>The following groups of attributes are send as part of the | |
1303 | CUPS-Accept-Jobs Response: | |
1304 | ||
1305 | <p>Group 1: Operation Attributes | |
1306 | ||
1307 | <dl> | |
1308 | ||
1309 | <dt>Status Message: | |
1310 | ||
1311 | <dd>The standard response status message. | |
1312 | ||
1313 | <dt>Natural Language and Character Set: | |
1314 | ||
1315 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1316 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1317 | Semantics document. | |
1318 | ||
1319 | </dl> | |
1320 | ||
1321 | <h3 class='title'><a name='CUPS_REJECT_JOBS'>CUPS-Reject-Jobs Operation</a></h3> | |
1322 | ||
1323 | <p>The CUPS-Reject-Jobs operation (0x4009) sets | |
1324 | the"printer-is-accepting-jobs" attribute to false for the specified | |
1325 | printer or printer class. | |
1326 | ||
1327 | <h4>CUPS-Reject-Jobs Request</h4> | |
1328 | ||
1329 | <p>The following groups of attributes are supplied as part of the | |
1330 | CUPS-Reject-Jobs request: | |
1331 | ||
1332 | <p>Group 1: Operation Attributes | |
1333 | ||
1334 | <dl> | |
1335 | ||
1336 | <dt>Natural Language and Character Set: | |
1337 | ||
1338 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1339 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1340 | Semantics document. | |
1341 | ||
1342 | <dt>"printer-uri" (uri): | |
1343 | ||
1344 | <dd>The client MUST supply a URI for the specified printer or printer class. | |
1345 | ||
1346 | </dl> | |
1347 | ||
1348 | <p>Group 2: Printer Object Attributes | |
1349 | ||
1350 | <dl> | |
1351 | ||
1352 | <dt>"printer-state-message" (text(MAX)): | |
1353 | ||
1354 | <dd>The client OPTIONALLY supplies this attribute indicating a | |
1355 | textual reason for the current printer state. | |
1356 | ||
1357 | </dl> | |
1358 | ||
1359 | <h4>CUPS-Reject-Jobs Response</h4> | |
1360 | ||
1361 | <p>The following groups of attributes are send as part of the | |
1362 | CUPS-Reject-Jobs Response: | |
1363 | ||
1364 | <p>Group 1: Operation Attributes | |
1365 | ||
1366 | <dl> | |
1367 | ||
1368 | <dt>Status Message: | |
1369 | ||
1370 | <dd>The standard response status message. | |
1371 | ||
1372 | <dt>Natural Language and Character Set: | |
1373 | ||
1374 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1375 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1376 | Semantics document. | |
1377 | ||
1378 | </dl> | |
1379 | ||
1380 | <h3 class='title'><a name='CUPS_SET_DEFAULT'>CUPS-Set-Default Operation</a></h3> | |
1381 | ||
1382 | <p>The CUPS-Set-Default operation (0x400A) sets the default printer | |
1383 | destination for all clients when a resource name of "/printers" is | |
1384 | specified. | |
1385 | ||
1386 | <h4>CUPS-Set-Default Request</h4> | |
1387 | ||
1388 | <p>The following groups of attributes are supplied as part of the | |
1389 | CUPS-Set-Default request: | |
1390 | ||
1391 | <p>Group 1: Operation Attributes | |
1392 | ||
1393 | <dl> | |
1394 | ||
1395 | <dt>Natural Language and Character Set: | |
1396 | ||
1397 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1398 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1399 | Semantics document. | |
1400 | ||
1401 | <dt>"printer-uri" (uri): | |
1402 | ||
1403 | <dd>The client MUST supply a URI for the specified printer or | |
1404 | printer class. | |
1405 | ||
1406 | </dl> | |
1407 | ||
1408 | <h4>CUPS-Set-Default Response</h4> | |
1409 | ||
1410 | <p>The following groups of attributes are send as part of the | |
1411 | CUPS-Set-Default Response: | |
1412 | ||
1413 | <p>Group 1: Operation Attributes | |
1414 | ||
1415 | <dl> | |
1416 | ||
1417 | <dt>Status Message: | |
1418 | ||
1419 | <dd>The standard response status message. | |
1420 | ||
1421 | <dt>Natural Language and Character Set: | |
1422 | ||
1423 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1424 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1425 | Semantics document. | |
1426 | ||
1427 | </dl> | |
1428 | ||
1429 | <h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_GET_DEVICES'>CUPS-Get-Devices Operation</a></h3> | |
1430 | ||
1431 | <p>The CUPS-Get-Devices operation (0x400B) returns all of the | |
1432 | supported device-uri's for the server.</p> | |
1433 | ||
1434 | <h4>CUPS-Get-Devices Request</h4> | |
1435 | ||
1436 | <p>The following groups of attributes are supplied as part of the | |
1437 | CUPS-Get-Devices request: | |
1438 | ||
1439 | <p>Group 1: Operation Attributes | |
1440 | ||
1441 | <dl> | |
1442 | ||
1443 | <dt>Natural Language and Character Set: | |
1444 | ||
1445 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1446 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1447 | Semantics document. | |
1448 | ||
1449 | <dt>"device-class" (type1 keyword): | |
1450 | ||
1451 | <dd>The client OPTIONALLY supplies a device class keyword to select | |
1452 | which devices are returned. | |
1453 | ||
1454 | <dt>"limit" (integer (1:MAX)): | |
1455 | ||
1456 | <dd>The client OPTIONALLY supplies this attribute limiting the number of | |
1457 | devices that are returned. | |
1458 | ||
1459 | <dt>"requested-attributes" (1setOf keyword) : | |
1460 | ||
1461 | <dd>The client OPTIONALLY supplies a set of attribute names and/or | |
1462 | attribute group names in whose values the requester is interested. If | |
1463 | the client omits this attribute, the server responds as if this | |
1464 | attribute had been supplied with a value of 'all'. | |
1465 | ||
1466 | </dl> | |
1467 | ||
1468 | <h4>CUPS-Get-Devices Response</h4> | |
1469 | ||
1470 | <p>The following groups of attributes are send as part of the | |
1471 | CUPS-Get-Devices Response: | |
1472 | ||
1473 | <p>Group 1: Operation Attributes | |
1474 | ||
1475 | <dl> | |
1476 | ||
1477 | <dt>Status Message: | |
1478 | ||
1479 | <dd>The standard response status message. | |
1480 | ||
1481 | <dt>Natural Language and Character Set: | |
1482 | ||
1483 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1484 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1485 | Semantics document. | |
1486 | ||
1487 | </dl> | |
1488 | ||
1489 | <p>Group 2: Device Object Attributes | |
1490 | ||
1491 | <dl> | |
1492 | ||
1493 | <dt>The set of requested attributes and their current values for | |
1494 | each device. | |
1495 | ||
1496 | </dl> | |
1497 | ||
1498 | <h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_GET_PPDS'>CUPS-Get-PPDs Operation</a></h3> | |
1499 | ||
1500 | <p>The CUPS-Get-PPDs operation (0x400C) returns all of the | |
1501 | locally available PPD files on the system.</p> | |
1502 | ||
1503 | <h4>CUPS-Get-PPDs Request</h4> | |
1504 | ||
1505 | <p>The following groups of attributes are supplied as part of the | |
1506 | CUPS-Get-PPDs request: | |
1507 | ||
1508 | <p>Group 1: Operation Attributes | |
1509 | ||
1510 | <dl> | |
1511 | ||
1512 | <dt>Natural Language and Character Set: | |
1513 | ||
1514 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1515 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1516 | Semantics document. | |
1517 | ||
1518 | <dt>"limit" (integer (1:MAX)): | |
1519 | ||
3d8365b8 | 1520 | <dd>The client OPTIONALLY supplies this attribute limiting the number of PPDs that are returned. |
fa73b229 | 1521 | |
1522 | <dt>"ppd-make" (text(127)): | |
1523 | ||
3d8365b8 | 1524 | <dd>The client OPTIONALLY supplies a printer manufacturer to select which PPDs are returned. |
1525 | ||
1526 | <dt>"ppd-make-and-model" (text(127)):<span class='info'>CUPS 1.3</span> | |
1527 | ||
1528 | <dd>The client OPTIONALLY supplies a make and model to select which PPDs are returned. | |
1529 | ||
1530 | <dt>"ppd-model-number" (integer):<span class='info'>CUPS 1.3</span> | |
1531 | ||
1532 | <dd>The client OPTIONALLY supplies a model number to select which PPDs are returned. | |
1533 | ||
1534 | <dt>"ppd-natural-language" (naturalLanguage):<span class='info'>CUPS 1.3</span> | |
1535 | ||
1536 | <dd>The client OPTIONALLY supplies a language to select which PPDs are returned. | |
1537 | ||
1538 | <dt>"ppd-product" (text(127)):<span class='info'>CUPS 1.3</span> | |
1539 | ||
1540 | <dd>The client OPTIONALLY supplies a PostScript product string to select which PPDs are returned. | |
1541 | ||
1542 | <dt>"ppd-psversion" (text(127)):<span class='info'>CUPS 1.3</span> | |
1543 | ||
1544 | <dd>The client OPTIONALLY supplies a PostScript version string to select which PPDs are returned. | |
1545 | ||
1546 | <dt>"ppd-type" (type1 keyword):<span class='info'>CUPS 1.3</span> | |
1547 | ||
1548 | <dd>The client OPTIONALLY supplies a driver type to select which PPDs are returned. | |
fa73b229 | 1549 | |
1550 | <dt>"requested-attributes" (1setOf keyword) : | |
1551 | ||
3d8365b8 | 1552 | <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. |
fa73b229 | 1553 | |
1554 | </dl> | |
1555 | ||
1556 | <h4>CUPS-Get-PPDs Response</h4> | |
1557 | ||
1558 | <p>The following groups of attributes are send as part of the | |
1559 | CUPS-Get-PPDs Response: | |
1560 | ||
1561 | <p>Group 1: Operation Attributes | |
1562 | ||
1563 | <dl> | |
1564 | ||
1565 | <dt>Status Message: | |
1566 | ||
1567 | <dd>The standard response status message. | |
1568 | ||
1569 | <dt>Natural Language and Character Set: | |
1570 | ||
1571 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1572 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1573 | Semantics document. | |
1574 | ||
1575 | </dl> | |
1576 | ||
1577 | <p>Group 2: PPD Attributes | |
1578 | ||
1579 | <dl> | |
1580 | ||
1581 | <dt>The set of requested attributes and their current values for each | |
1582 | PPD file. | |
1583 | ||
1584 | </dl> | |
1585 | ||
1586 | <h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_MOVE_JOB'>CUPS-Move-Job Operation</a></h3> | |
1587 | ||
1588 | <p>The CUPS-Move-Job operation (0x400D) moves an active print job | |
1589 | to a different printer.</p> | |
1590 | ||
1591 | <h4>CUPS-Move-Job Request</h4> | |
1592 | ||
1593 | <p>The following groups of attributes are supplied as part of the | |
1594 | CUPS-Move-Job request: | |
1595 | ||
1596 | <p>Group 1: Operation Attributes | |
1597 | ||
1598 | <dl> | |
1599 | ||
1600 | <dt>Natural Language and Character Set: | |
1601 | ||
1602 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1603 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1604 | Semantics document. | |
1605 | ||
1606 | <dt>"printer-uri" (uri) and "job-id" (integer) | |
1607 | <br><i>OR</i> | |
1608 | <br>"job-uri": | |
1609 | ||
1610 | <dd>The client MUST supply a URI for the specified printer and | |
1611 | a job ID number, or the job URI. | |
1612 | ||
1613 | </dl> | |
1614 | ||
1615 | <p>Group 2: Job Template Attributes | |
1616 | ||
1617 | <dl> | |
1618 | ||
1619 | <dt>"job-printer-uri" (uri) | |
1620 | ||
1621 | <dd>The client MUST supply a URI for a printer on the same server. | |
1622 | ||
1623 | </dl> | |
1624 | ||
1625 | <h4>CUPS-Move-Job Response</h4> | |
1626 | ||
1627 | <p>The following groups of attributes are send as part of the | |
1628 | CUPS-Move-Job Response: | |
1629 | ||
1630 | <p>Group 1: Operation Attributes | |
1631 | ||
1632 | <dl> | |
1633 | ||
1634 | <dt>Status Message: | |
1635 | ||
1636 | <dd>The standard response status message. | |
1637 | ||
1638 | <dt>Natural Language and Character Set: | |
1639 | ||
1640 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1641 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1642 | Semantics document. | |
1643 | ||
1644 | </dl> | |
1645 | ||
1646 | <h3 class='title'><span class='info'>CUPS 1.2</span><a name='CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job Operation</a></h3> | |
1647 | ||
1648 | <p>The CUPS-Authenticate-Job operation (0x400E) authenticate a | |
1649 | print job for printing. Typically this is used when printing to a | |
1650 | remote server. The authentication information is passed in the | |
1651 | HTTP request.</p> | |
1652 | ||
1653 | <h4>CUPS-Authenticate-Job Request</h4> | |
1654 | ||
1655 | <p>The following groups of attributes are supplied as part of the | |
1656 | CUPS-Authenticate-Job request: | |
1657 | ||
1658 | <p>Group 1: Operation Attributes | |
1659 | ||
1660 | <dl> | |
1661 | ||
1662 | <dt>Natural Language and Character Set: | |
1663 | ||
1664 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1665 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1666 | Semantics document. | |
1667 | ||
1668 | <dt>"printer-uri" (uri) and "job-id" (integer) | |
1669 | <br><i>OR</i> | |
1670 | <br>"job-uri": | |
1671 | ||
1672 | <dd>The client MUST supply a URI for the specified printer and | |
1673 | a job ID number, or the job URI. | |
1674 | ||
1675 | </dl> | |
1676 | ||
f7deaa1a | 1677 | <p>Group 2: Job Attributes |
1678 | ||
1679 | <dl> | |
1680 | ||
1681 | <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3</span> | |
1682 | ||
1683 | <dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute. | |
1684 | ||
1685 | </dl> | |
1686 | ||
fa73b229 | 1687 | <h4>CUPS-Authenticate-Job Response</h4> |
1688 | ||
1689 | <p>The following groups of attributes are send as part of the | |
1690 | CUPS-Authenticate-Job Response: | |
1691 | ||
1692 | <p>Group 1: Operation Attributes | |
1693 | ||
1694 | <dl> | |
1695 | ||
1696 | <dt>Status Message: | |
1697 | ||
1698 | <dd>The standard response status message. | |
1699 | ||
1700 | <dt>Natural Language and Character Set: | |
1701 | ||
1702 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1703 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1704 | Semantics document. | |
1705 | ||
1706 | </dl> | |
1707 | ||
f7deaa1a | 1708 | <p>Group 2: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported) |
1709 | ||
1710 | <dl> | |
1711 | ||
1712 | <dt>auth-info-required (1setOf Type2 keyword) | |
1713 | ||
1714 | <dd>The required authentication information. | |
1715 | ||
1716 | </dl | |
1717 | ||
b94498cf | 1718 | <h3 class='title'><span class='info'>CUPS 1.3</span><a name='CUPS_GET_PPD'>CUPS-Get-PPD Operation</a></h3> |
1719 | ||
1720 | <p>The CUPS-Get-PPD operation (0x400F) gets a PPD file from the | |
1721 | server. The PPD file can be specified using a <tt>ppd-name</tt> | |
1722 | returned by <a href='#CUPS_GET_PPDS'><tt>CUPS-Get-PPDs</tt></a> | |
1723 | or using the <tt>printer-uri</tt> for a queue.</p> | |
1724 | ||
1725 | <p>If the PPD file is found, <tt>successful-ok</tt> is returned with | |
1726 | the PPD file following the response data.</p> | |
1727 | ||
1728 | <p>If the PPD file cannot be served by the local server because | |
1729 | the <tt>printer-uri</tt> attribute points to an external printer, | |
1730 | a <tt>cups-see-other</tt> status is returned with the correct | |
1731 | URI to use.</p> | |
1732 | ||
1733 | <p>If the PPD file does not exist, <tt>client-error-not-found</tt> is | |
1734 | returned.</p> | |
1735 | ||
1736 | <h4>CUPS-Get-PPD Request</h4> | |
1737 | ||
1738 | <p>The following group of attributes is supplied as part of the | |
1739 | CUPS-Get-PPD request: | |
1740 | ||
1741 | <p>Group 1: Operation Attributes | |
1742 | ||
1743 | <dl> | |
1744 | ||
1745 | <dt>Natural Language and Character Set: | |
1746 | ||
1747 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1748 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1749 | Semantics document. | |
1750 | ||
1751 | <dt>"printer-uri" (uri) | |
1752 | <br><i>OR</i> | |
1753 | <br>"ppd-name" (name(255)): | |
1754 | ||
1755 | <dd>The client MUST supply a printer URI or PPD name. | |
1756 | ||
1757 | </dl> | |
1758 | ||
1759 | <h4>CUPS-Get-PPD Response</h4> | |
1760 | ||
1761 | <p>The following group of attributes is sent as part of the | |
1762 | CUPS-Get-PPD Response: | |
1763 | ||
1764 | <p>Group 1: Operation Attributes | |
1765 | ||
1766 | <dl> | |
1767 | ||
1768 | <dt>Status Message: | |
1769 | ||
1770 | <dd>The standard response status message. | |
1771 | ||
1772 | <dt>Natural Language and Character Set: | |
1773 | ||
1774 | <dd>The "attributes-charset" and "attributes-natural-language" | |
1775 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1776 | Semantics document. | |
1777 | ||
1778 | <dt>"printer-uri" (uri): | |
1779 | ||
1780 | <dd>The printer that provides the actual PPD file when | |
1781 | the status code is cups-see-other (0x280) | |
1782 | ||
1783 | </dl> | |
1784 | ||
1785 | <p>If the status code is <tt>successful-ok</tt>, the PPD file follows | |
1786 | the end of the IPP response.</p> | |
1787 | ||
1788 | ||
fa73b229 | 1789 | <h2 class='title'><a name='ATTRIBUTES'>Attributes</a></h2> |
1790 | ||
1791 | <p>CUPS provides many extension attributes to support multiple | |
1792 | devices, PPD files, standard job filters, printers, and printer | |
1793 | classes.</p> | |
1794 | ||
1795 | <h3 class='title'><a name='DEVICE_ATTRIBUTES'>Device Attributes</a></h3> | |
1796 | ||
1797 | <p>Device attributes are returned by the CUPS-Get-Devices | |
1798 | operation and enumerate all of the available hardware devices and | |
1799 | network protocols that are supported by the server.</p> | |
1800 | ||
f7deaa1a | 1801 | <h4><a name="device-class">device-class (type2 keyword)</a></h4> |
fa73b229 | 1802 | |
1803 | <p>The device-class attribute specifies the class of device and can be | |
1804 | one of the following: | |
1805 | ||
1806 | <ul> | |
1807 | ||
1808 | <li>"file" - a disk file. | |
1809 | ||
1810 | <li>"direct" - a parallel or fixed-rate serial data port, | |
1811 | currently used for Centronics, IEEE-1284, and USB printer | |
1812 | ports. | |
1813 | ||
1814 | <li>"serial" - a variable-rate serial port. | |
1815 | ||
1816 | <li>"network" - a network connection, typically via AppSocket, | |
1817 | HTTP, IPP, LPD, or SMB/CIFS protocols. | |
1818 | ||
1819 | </ul> | |
1820 | ||
f7deaa1a | 1821 | <h4><a name="device-id">device-id (text(127))</a><span class="info">CUPS 1.2</span></h4> |
fa73b229 | 1822 | |
1823 | <p>The device-id attribute specifies the IEEE-1284 device ID | |
1824 | string for the device.</p> | |
1825 | ||
f7deaa1a | 1826 | <h4><a name="device-info">device-info (text(127))</a></h4> |
fa73b229 | 1827 | |
1828 | <p>The device-info attribute specifies a human-readable string describing | |
1829 | the device, e.g. "Parallel Port #1". | |
1830 | ||
f7deaa1a | 1831 | <h4><a name="device-make-and-model">device-make-and-model (text(127))</a></h4> |
fa73b229 | 1832 | |
1833 | <p>The device-makr-and-model attribute specifies a device | |
1834 | identification string provided by the printer connected to the device. | |
1835 | If the device or printer does not support identification then this | |
1836 | attribute contains the string "unknown". | |
1837 | ||
f7deaa1a | 1838 | <h4><a name="device-uri">device-uri (uri)</a></h4> |
fa73b229 | 1839 | |
1840 | <p>The device-uri attribute specifies a unique identifier for the | |
1841 | device. The actual format of the device-uri string depends on the value | |
1842 | of the device-class attribute: | |
1843 | ||
1844 | <ul> | |
1845 | ||
1846 | <li>"file" - The device-uri will be of the form | |
1847 | "file:///path/to/filename". | |
1848 | ||
1849 | <li>"direct" - The device-uri will be of the form | |
1850 | "scheme:/dev/filename" or "scheme://vendor/identifier", | |
1851 | where scheme may be "parallel" or "usb" in the current | |
1852 | implementation. | |
1853 | ||
1854 | <li>"serial" - The device-uri will be of the form | |
1855 | "serial:/dev/filename?baud=value+parity=value+flow=value". | |
1856 | The baud value is the data rate in bits per second; the | |
1857 | supported values depend on the underlying hardware. | |
1858 | The parity value can be one of "none", "even", or "odd". | |
1859 | The flow value can be one of "none", "soft" (XON/XOFF | |
1860 | handshaking), "hard" or "rts/cts" (RTS/CTS handshaking), | |
1861 | or "dtrdsr" (DTR/DSR handshaking). | |
1862 | ||
1863 | <p>The URI returned by CUPS-Get-Devices will contain the | |
1864 | maximum baud rate supported by the device and the best | |
1865 | type of flow control available ("soft" or "hard"). | |
1866 | ||
1867 | <li>"network" - The device-uri will be of the form | |
1868 | "scheme://[username:password@]hostname[:port]/[resource]", | |
1869 | where scheme may be "http", "https", "ipp", "lpd", "smb", or | |
1870 | "socket" in the current implementation. | |
1871 | ||
1872 | <p>The URI returned by CUPS-Get-Devices will only contain | |
1873 | the scheme name ("scheme"). It is up to the client | |
1874 | application to add the appropriate host and other | |
1875 | information when adding a new printer. | |
1876 | ||
1877 | <p>The URI returned by Get-Printer-Attributes and | |
1878 | CUPS-Get-Printers has any username and password information | |
1879 | stripped; the information is still stored and used by the | |
1880 | server internally to perform any needed authentication. | |
1881 | ||
1882 | </ul> | |
1883 | ||
1884 | <h3 class='title'><a name='JOB_TEMPLATE_ATTRIBUTES'>Job Template Attributes</a></h3> | |
1885 | ||
f7deaa1a | 1886 | <h4><a name="auth-info">auth-info (1setOf text(MAX))</a><span class="info">CUPS 1.3</span></h4> |
1887 | ||
1888 | <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. | |
1889 | ||
1890 | <h4><a name="blackplot">blackplot (boolean)</a></h4> | |
fa73b229 | 1891 | |
1892 | <p>The blackplot attribute specifies whether HP-GL/2 plot files should be | |
1893 | rendered entirely in black ink (blackplot=true) or using the colors and shades | |
1894 | specified in the file (blackplot=false). The default value is false. | |
1895 | ||
f7deaa1a | 1896 | <h4><a name="brightness">brightness (integer(0:200))</a></h4> |
fa73b229 | 1897 | |
1898 | <p>The brightness attribute specifies the overall brightness of the printed | |
1899 | output in percent. A brightness of 100 is normal, while 200 is twice as | |
1900 | bright and 50 is half as bright. The default value is 100. | |
1901 | ||
1902 | <p>Brightness is applied to the Cyan, Magenta, Yellow, and Black values using | |
1903 | the function "f(x) = brightness / 100 * x". | |
1904 | ||
f7deaa1a | 1905 | <h4><a name="columns">columns (integer(1:4))</a></h4> |
fa73b229 | 1906 | |
1907 | <p>The columns attribute specifies the number of columns to generate when | |
1908 | printing text files. The default value is 1. | |
1909 | ||
f7deaa1a | 1910 | <h4><a name="cpi">cpi (type2 enum)</a></h4> |
fa73b229 | 1911 | |
1912 | <p>The cpi attribute specifies the number of characters per inch when | |
1913 | printing text files. Only the values 10, 12, and 17 are currently | |
1914 | supported. The default value is 10. | |
1915 | ||
f7deaa1a | 1916 | <h4><a name="fitplot">fitplot (boolean)</a></h4> |
fa73b229 | 1917 | |
1918 | <p>The fitplot attribute specifies whether to scale HP-GL/2 plot files to | |
1919 | fit on the selected media (fitplot=true) or use the physical scale specified | |
1920 | in the plot file (fitplot=false). The default value is false. | |
1921 | ||
f7deaa1a | 1922 | <h4><a name="gamma">gamma (integer(1:10000))</a></h4> |
fa73b229 | 1923 | |
1924 | <p>The gamma attribute specifies the luminance correction for the output. | |
1925 | A value of 1000 specifies no correction, while values of 2000 and 500 will | |
1926 | generate lighter and darker output, respectively. The default value is | |
1927 | 1000. | |
1928 | ||
1929 | <p>Gamma is applied to the Red, Green, and Blue values (or luminance for | |
1930 | grayscale output) using the function "f(x) = x<SUp>(1000/gamma)</SUp>". | |
1931 | ||
f7deaa1a | 1932 | <h4><a name="hue">hue (integer(-180:180))</a></h4> |
fa73b229 | 1933 | |
1934 | <p>The hue attribute specifies a color hue rotation when printing image | |
1935 | files. The default value is 0. | |
1936 | ||
f7deaa1a | 1937 | <h4><a name="job-billing">job-billing (text(MAX))</a><span class='info'>CUPS 1.1</span></h4> |
fa73b229 | 1938 | |
1939 | <p>The job-billing attribute provides a text value to associate with a job | |
1940 | for billing purposes. | |
1941 | ||
f7deaa1a | 1942 | <h4><a name="job-hold-until">job-hold-until (keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4> |
fa73b229 | 1943 | |
1944 | <p>The job-hold-until attribute specifies a hold time. In addition to the | |
1945 | standard IPP/1.1 keyword names, CUPS supports name values of the form | |
1946 | "HH:MM" and "HH:MM:SS" that specify a hold time. The hold time is in | |
b94498cf | 1947 | Universal Coordinated Time (UTC) and <i>not</i> in the local time zone. If the |
fa73b229 | 1948 | specified time is less than the current time, the job is held until the |
1949 | next day. | |
1950 | ||
f7deaa1a | 1951 | <h4><a name="job-sheets">job-sheets (1setof type3 keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4> |
fa73b229 | 1952 | |
1953 | <p>The job-sheets attribute specifies one or two banner files that are printed | |
1954 | before and after a job. The reserved value of "none" disables banner printing. | |
1955 | The default value is stored in the job-sheets-default attribute. | |
1956 | ||
1957 | <p>If only one value is supplied, the banner file is printed before the job. | |
1958 | If two values are supplied, the first value is used as the starting banner | |
1959 | file and the second as the ending banner file. | |
1960 | ||
f7deaa1a | 1961 | <h4><a name="job-originating-host-name">job-originating-host-name (name(MAX))</a></h4> |
fa73b229 | 1962 | |
1963 | <p><i>(CUPS 1.1.5 and higher)</i> | |
1964 | ||
1965 | <p>The job-originating-host-name attribute specifies the host | |
1966 | from which the job was queued. The value will be the hostname or | |
1967 | IP address of the client depending on whether hostname | |
1968 | resolution is enabled. The localhost address (127.0.0.1) is | |
1969 | <b>always</b> resolved to the name "localhost". | |
1970 | ||
1971 | <p>This attribute is read-only. | |
1972 | ||
f7deaa1a | 1973 | <h4><a name="lpi">lpi (type2 enum)</a></h4> |
fa73b229 | 1974 | |
1975 | <p>The lpi attribute specifies the number of lines per inch when | |
1976 | printing text files. Only the values 6 and 8 are currently supported. | |
1977 | The default value is 6. | |
1978 | ||
f7deaa1a | 1979 | <h4><a name="mirror">mirror (boolean)</a></h4> |
fa73b229 | 1980 | |
1981 | <p>The mirror attribute specifies whether pages are mirrored on | |
1982 | their X axis, which is useful for printing transfer images on | |
1983 | special media. The default value is false. | |
1984 | ||
f7deaa1a | 1985 | <h4><a name="natural-scaling">natural-scaling (integer(1:1000))</a><span class='info'>CUPS 1.1.9</span></h4> |
fa73b229 | 1986 | <p>The natural-scaling attribute specifies the scaling of image files with |
1987 | respect to the natural image size. A value of 100 specifies that the image | |
1988 | file should exactly the natural size, while 50 is half the natural size | |
1989 | and 200 is twice the natural size. The default value is 100. | |
1990 | ||
1991 | <p>The ppi option can be used to override the natural resolution of the | |
1992 | image, which controls the natural size. | |
1993 | ||
f7deaa1a | 1994 | <h4><a name="number-up-layout">number-up-layout (type2 keyword)</a><span class='info'>CUPS 1.1.15</span></h4> |
fa73b229 | 1995 | <p>The number-up-layout attribute specifies the order each input |
1996 | page is placed on each output page. The following keywords are | |
1997 | presently defined: | |
1998 | ||
1999 | <ul> | |
2000 | ||
2001 | <li><CODE>btlr</CODE> - Bottom to top, left to right</li> | |
2002 | ||
2003 | <li><CODE>btrl</CODE> - Bottom to top, right to left</li> | |
2004 | ||
2005 | <li><CODE>lrbt</CODE> - Left to right, bottom to top</li> | |
2006 | ||
2007 | <li><CODE>lrtb</CODE> - Left to right, top to bottom (default)</li> | |
2008 | ||
2009 | <li><CODE>rlbt</CODE> - Right to left, bottom to top</li> | |
2010 | ||
2011 | <li><CODE>rltb</CODE> - Right to left, top to bottom</li> | |
2012 | ||
2013 | <li><CODE>tblr</CODE> - Top to bottom, left to right</li> | |
2014 | ||
2015 | <li><CODE>tbrl</CODE> - Top to bottom, right to left</li> | |
2016 | ||
2017 | </ul> | |
2018 | ||
f7deaa1a | 2019 | <h4><a name="page-border">page-border (type2 keyword)</a><span class='info'>CUPS 1.1.15</span></h4> |
fa73b229 | 2020 | <p>The page-border attribute specifies whether a border is |
2021 | draw around each page. The following keywords are presently | |
2022 | defined: | |
2023 | ||
2024 | <ul> | |
2025 | ||
2026 | <li><CODE>double</CODE> - Two hairline borders are drawn</li> | |
2027 | ||
2028 | <li><CODE>double-thick</CODE> - Two 1pt borders are drawn</li> | |
2029 | ||
2030 | <li><CODE>none</CODE> - No border is drawn (default)</li> | |
2031 | ||
2032 | <li><CODE>single</CODE> - A single hairline border is drawn</li> | |
2033 | ||
2034 | <li><CODE>single-thick</CODE> - A single 1pt border is drawn</li> | |
2035 | ||
2036 | </ul> | |
2037 | ||
f7deaa1a | 2038 | <h4><a name="page-bottom">page-bottom (integer(0:MAX))</a></h4> |
fa73b229 | 2039 | |
2040 | <p>The page-bottom attribute specifies the bottom margin in points (72 points | |
2041 | equals 1 inch). The default value is the device physical margin. | |
2042 | ||
f7deaa1a | 2043 | <h4><a name="page-label">page-label (text(MAX))</a><span class='info'>CUPS 1.1.7</span></h4> |
fa73b229 | 2044 | <p>The page-label attribute provides a text value to place in |
2045 | the header and footer on each page. If a classification level is | |
2046 | set on the server, then this classification is printed before | |
2047 | the page label. | |
2048 | ||
f7deaa1a | 2049 | <h4><a name="page-left">page-left (integer(0:MAX))</a></h4> |
fa73b229 | 2050 | |
2051 | <p>The page-left attribute specifies the left margin in points (72 points | |
2052 | equals 1 inch). The default value is the device physical margin. | |
2053 | ||
f7deaa1a | 2054 | <h4><a name="page-right">page-right (integer(0:MAX))</a></h4> |
fa73b229 | 2055 | |
2056 | <p>The page-right attribute specifies the right margin in points (72 points | |
2057 | equals 1 inch). The default value is the device physical margin. | |
2058 | ||
f7deaa1a | 2059 | <h4><a name="page-set">page-set (type2 keyword)</a></h4> |
fa73b229 | 2060 | |
2061 | <p>The page-set attribute specifies which pages to print in a file. The | |
2062 | supported keywords are "all", "even", and "odd". The default value is | |
2063 | "all". | |
2064 | ||
f7deaa1a | 2065 | <h4><a name="page-top">page-top (integer(0:MAX))</a></h4> |
fa73b229 | 2066 | |
2067 | <p>The page-top attribute specifies the top margin in points (72 points | |
2068 | equals 1 inch). The default value is the device physical margin. | |
2069 | ||
f7deaa1a | 2070 | <h4><a name="penwidth">penwidth (integer(0:MAX))</a></h4> |
fa73b229 | 2071 | |
2072 | <p>The penwidth attribute specifies the default pen width in micrometers | |
2073 | when printing HP-GL/2 plot files. The default value is 1000 (1 millimeter). | |
2074 | ||
f7deaa1a | 2075 | <h4><a name="position">position (type2 keyword)</a></h4> |
fa73b229 | 2076 | |
2077 | <p>The position attribute specifies the location of image files on the | |
2078 | media. The following keyword values are recognized: | |
2079 | ||
2080 | <ul> | |
2081 | ||
2082 | <li><CODE>center</CODE> - Center the image on the page (default) | |
2083 | ||
2084 | <li><CODE>top</CODE> - Print the image centered at the top of the page | |
2085 | ||
2086 | <li><CODE>left</CODE> - Print the image centered on the left of page | |
2087 | ||
2088 | <li><CODE>right</CODE> - Print the image centered on the right of the page | |
2089 | ||
2090 | <li><CODE>top-left</CODE> - Print the image at the top left corner of | |
2091 | the page | |
2092 | ||
2093 | <li><CODE>top-right</CODE> - Print the image at the top right corner of | |
2094 | the page | |
2095 | ||
2096 | <li><CODE>bottom</CODE> - Print the image centered at the bottom of | |
2097 | the page | |
2098 | ||
2099 | <li><CODE>bottom-left</CODE> - Print the image at the bottom left | |
2100 | corner of the page | |
2101 | ||
2102 | <li><CODE>bottom-right</CODE> - Print the image at the bottom right | |
2103 | corner of the page | |
2104 | ||
2105 | </ul> | |
2106 | ||
f7deaa1a | 2107 | <h4><a name="ppi">ppi (integer(1:MAX))</a></h4> |
fa73b229 | 2108 | |
2109 | <p>The ppi attribute specifies the resolution of an image file in pixels | |
2110 | per inch. The default value is the resolution included with the file or | |
2111 | 128 if no resolution information is available. | |
2112 | ||
f7deaa1a | 2113 | <h4><a name="prettyprint">prettyprint (boolean)</a></h4> |
fa73b229 | 2114 | |
2115 | <p>The prettyprint attribute specifies whether text files should be printed | |
2116 | with a shaded header and keyword highlighting (prettyprint=true) or without | |
2117 | additional formatting (prettyprint=false). The default value is false. | |
2118 | ||
f7deaa1a | 2119 | <h4><a name="saturation">saturation (integer(0:200))</a></h4> |
fa73b229 | 2120 | |
2121 | <p>The saturation attribute specifies the color saturation when | |
2122 | printing image files. A saturation of 100 is normal, while values of 50 | |
2123 | and 200 will be half and twice as colorful, respectively. The default | |
2124 | value is 100. | |
2125 | ||
f7deaa1a | 2126 | <h4><a name="scaling">scaling (integer(1:1000))</a></h4> |
fa73b229 | 2127 | |
2128 | <p>The scaling attribute specifies the scaling of image files with | |
2129 | respect to the selected media. A value of 100 specifies that the image | |
2130 | file should fit 100% of the page, or as much as possible given the | |
2131 | image dimensions. The default value is unspecified. | |
2132 | ||
2133 | <p>The scaling attribute overrides the ppi attribute if specified. | |
2134 | ||
f7deaa1a | 2135 | <h4><a name="wrap">wrap (boolean)</a></h4> |
fa73b229 | 2136 | |
2137 | <p>The wrap attribute specifies whether long lines should be wrapped | |
2138 | (wrap=true) or not (wrap=false) when printing text files. The default | |
2139 | value is true. | |
2140 | ||
2141 | <h3 class='title'><a name='PPD_ATTRIBUTES'>PPD Attributes</a></h3> | |
2142 | ||
f7deaa1a | 2143 | <h4><a name="ppd-device-id">ppd-device-id (text(127))</a></h4> |
fa73b229 | 2144 | |
2145 | <p>The ppd-device-id attribute specifies the IEEE-1284 device ID | |
2146 | string for the device described by the PPD file.</p> | |
2147 | ||
f7deaa1a | 2148 | <h4><a name="ppd-make">ppd-make (text(127))</a></h4> |
fa73b229 | 2149 | |
2150 | <p>The ppd-make attribute specifies the manufacturer of the printer | |
2151 | (the Manufacturer attribute in the PPD file). If the manufacturer | |
2152 | is not specified in the PPD file then an educated guess is made using | |
2153 | the NickName attribute in the PPD file. | |
2154 | ||
f7deaa1a | 2155 | <h4><a name="ppd-make-and-model">ppd-make-and-model (text(127))</a></h4> |
fa73b229 | 2156 | |
2157 | <p>The ppd-make-and-model attribute specifies the manufacturer and model | |
2158 | name of the PPD file (the NickName attribute in the PPD file). If the | |
2159 | make and model is not specified in the PPD file then the ModelName or | |
2160 | ShortNickName attributes are used instead. | |
2161 | ||
3d8365b8 | 2162 | <h4><a name="ppd-model-number">ppd-model-number (integer)</a><span class="info">CUPS 1.3</span></h4> |
2163 | ||
2164 | <p>The ppd-model-number attribute provides the <tt>cupsModelNumber</tt> value from the PPD file. | |
2165 | ||
f7deaa1a | 2166 | <h4><a name="ppd-name">ppd-name (name(255))</a></h4> |
fa73b229 | 2167 | |
3d8365b8 | 2168 | <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. |
fa73b229 | 2169 | |
b94498cf | 2170 | <h4><a name="ppd-natural-language">ppd-natural-language (1setOf naturalLanguage)</a></h4> |
f899b121 | 2171 | |
2172 | <p>The ppd-natural-language attribute specifies the language encoding | |
2173 | of the PPD file (the LanguageVersion attribute in the PPD file). If the | |
2174 | language is unknown or undefined then "en" (English) is assumed. | |
2175 | ||
b94498cf | 2176 | <h4><a name="ppd-product">ppd-product (1setOf text(127))</a></h4> |
2177 | ||
2178 | <p>The ppd-product attribute specifies the Product attribute values in the PPD file. | |
2179 | ||
2180 | <h4><a name="ppd-psversion">ppd-psversion (1setOf text(127))</a><span class="info">CUPS 1.3</span></h4> | |
f899b121 | 2181 | |
b94498cf | 2182 | <p>The ppd-product attribute specifies the PSVersion attribute values in the PPD file. |
f899b121 | 2183 | |
3d8365b8 | 2184 | <h4><a name="ppd-type">ppd-type (type1 keyword)</a><span class="info">CUPS 1.3</span></h4> |
2185 | ||
2186 | <p>The ppd-type attribute specifies the type of driver described by the PPD file:</p> | |
2187 | ||
2188 | <ul> | |
2189 | ||
2190 | <li><tt>fax</tt> - A facsimile or multi-function device</li> | |
2191 | ||
2192 | <li><tt>pdf</tt> - A PDF printer</li> | |
2193 | ||
2194 | <li><tt>postscript</tt> - A PostScript printer (no filters)</li> | |
2195 | ||
2196 | <li><tt>raster</tt> - A CUPS raster driver</li> | |
2197 | ||
2198 | <li><tt>unknown</tt> - An unknown or hybrid driver</li> | |
2199 | ||
2200 | </ul> | |
2201 | ||
f899b121 | 2202 | |
fa73b229 | 2203 | <h3 class='title'><a name='PRINTER_ATTRIBUTES'>Printer Attributes</a></h3> |
2204 | ||
f7deaa1a | 2205 | <h4><a name="auth-info-required">auth-info-required (1setOf type2 keyword)</a><span class="info">CUPS 1.3</span></h4> |
2206 | ||
2207 | <p>The auth-info-required attribute specifies the authentication information that is required for printing a job. The following keywords are recognized:</p> | |
2208 | ||
2209 | <ul> | |
2210 | ||
2211 | <li><tt>domain</tt> - A domain name is required.</li> | |
2212 | ||
2213 | <li><tt>none</tt> - No authentication is required - this keyword can only appear by itself.</li> | |
2214 | ||
2215 | <li><tt>password</tt> - A password is required.</li> | |
2216 | ||
2217 | <li><tt>username</tt> - A username is required.</li> | |
2218 | ||
2219 | </ul> | |
2220 | ||
2221 | <h4><a name="job-k-limit">job-k-limit (integer)</a><span class='info'>CUPS 1.1</span></h4> | |
fa73b229 | 2222 | |
2223 | <p>The job-k-limit attribute specifies the maximum number of kilobytes that | |
2224 | may be printed by a user, including banner files. The default value of 0 | |
2225 | specifies that there is no limit. | |
2226 | ||
f7deaa1a | 2227 | <h4><a name="job-page-limit">job-page-limit (integer)</a><span class='info'>CUPS 1.1</span></h4> |
fa73b229 | 2228 | |
2229 | <p>The job-page-limit attribute specifies the maximum number of pages that | |
2230 | may be printed by a user, including banner files. The default value of 0 | |
2231 | specifies that there is no limit. | |
2232 | ||
f7deaa1a | 2233 | <h4><a name="job-quota-period">job-quota-period (integer)</a><span class='info'>CUPS 1.1</span></h4> |
fa73b229 | 2234 | |
2235 | <p>The job-quota-period attribute specifies the time period used for quota | |
2236 | calculations, in seconds. The default value of 0 specifies that the limits | |
2237 | apply to all jobs that have been printed by a user that are still known to | |
2238 | the system. | |
2239 | ||
09a101d6 | 2240 | <h4><a name="job-sheets-supported">job-sheets-supported (1setof type3 keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4> |
fa73b229 | 2241 | |
2242 | <p>The job-sheets-supported attribute specifies the available banner files. | |
2243 | There will always be at least one banner file available called "none". | |
2244 | ||
09a101d6 | 2245 | <h4><a name="port-monitor">port-monitor" (name(127))</a></h4> |
2246 | ||
2247 | <p>The port-monitor attribute specifies the port monitor to use when printing | |
2248 | to this printer. The default port monitor is "none". | |
2249 | ||
2250 | <h4><a name="port-monitor-supported">port-monitor-supported" (1setOf name(127))</a></h4> | |
2251 | ||
2252 | <p>The port-monitor-supported attribute specifies the available port monitors. | |
2253 | ||
f7deaa1a | 2254 | <h4><a name="printer-type">printer-type (type2 enum)</a></h4> |
fa73b229 | 2255 | |
2256 | <p>The printer-type attribute specifies printer type and | |
2257 | capability bits for the printer or class. The default value is | |
2258 | computed from internal state information and the PPD file for the | |
2259 | printer. The following bits are defined:</p> | |
2260 | ||
2261 | <div class='table'><table align='center' border='1' width='80%' | |
2262 | summary='Printer Type Bits'> | |
2263 | <thead> | |
2264 | <tr> | |
2265 | <th>Bit</th> | |
2266 | <th>Description</th> | |
2267 | </tr> | |
2268 | </thead> | |
2269 | <tbody> | |
2270 | <tr> | |
2271 | <td>0x00000001</td> | |
2272 | <td>Is a printer class.</td> | |
2273 | </tr> | |
2274 | <tr> | |
2275 | <td>0x00000002</td> | |
2276 | <td>Is a remote destination.</td> | |
2277 | </tr> | |
2278 | <tr> | |
2279 | <td>0x00000004</td> | |
2280 | <td>Can print in black.</td> | |
2281 | </tr> | |
2282 | <tr> | |
2283 | <td>0x00000008</td> | |
2284 | <td>Can print in color.</td> | |
2285 | </tr> | |
2286 | <tr> | |
2287 | <td>0x00000010</td> | |
2288 | <td>Can print on both sides of the page in hardware.</td> | |
2289 | </tr> | |
2290 | <tr> | |
2291 | <td>0x00000020</td> | |
2292 | <td>Can staple output.</td> | |
2293 | </tr> | |
2294 | <tr> | |
2295 | <td>0x00000040</td> | |
2296 | <td>Can do fast copies in hardware.</td> | |
2297 | </tr> | |
2298 | <tr> | |
2299 | <td>0x00000080</td> | |
2300 | <td>Can do fast copy collation in hardware.</td> | |
2301 | </tr> | |
2302 | <tr> | |
2303 | <td>0x00000100</td> | |
2304 | <td>Can punch output.</td> | |
2305 | </tr> | |
2306 | <tr> | |
2307 | <td>0x00000200</td> | |
2308 | <td>Can cover output.</td> | |
2309 | </tr> | |
2310 | <tr> | |
2311 | <td>0x00000400</td> | |
2312 | <td>Can bind output.</td> | |
2313 | </tr> | |
2314 | <tr> | |
2315 | <td>0x00000800</td> | |
2316 | <td>Can sort output.</td> | |
2317 | </tr> | |
2318 | <tr> | |
2319 | <td>0x00001000</td> | |
2320 | <td>Can handle media up to US-Legal/A4.</td> | |
2321 | </tr> | |
2322 | <tr> | |
2323 | <td>0x00002000</td> | |
2324 | <td>Can handle media from US-Legal/A4 to ISO-C/A2.</td> | |
2325 | </tr> | |
2326 | <tr> | |
2327 | <td>0x00004000</td> | |
2328 | <td>Can handle media larger than ISO-C/A2.</td> | |
2329 | </tr> | |
2330 | <tr> | |
2331 | <td>0x00008000</td> | |
2332 | <td>Can handle user-defined media sizes.</td> | |
2333 | </tr> | |
2334 | <tr> | |
2335 | <td>0x00010000</td> | |
2336 | <td>Is an implicit (server-generated) class.</td> | |
2337 | </tr> | |
2338 | <tr> | |
2339 | <td>0x00020000</td> | |
2340 | <td>Is the a default printer on the network.</td> | |
2341 | </tr> | |
2342 | <tr> | |
2343 | <td>0x00040000<td> | |
2344 | <td>Is a facsimile device.</td> | |
2345 | </tr> | |
2346 | <tr> | |
2347 | <td>0x00080000</td> | |
2348 | <td>Is rejecting jobs.</td> | |
2349 | </tr> | |
2350 | <tr> | |
2351 | <td>0x00100000</td> | |
2352 | <td>Delete this queue.</td> | |
2353 | </tr> | |
2354 | <tr> | |
2355 | <td>0x00200000</td> | |
2356 | <td>Queue is not shared.</td> | |
2357 | </tr> | |
2358 | <tr> | |
2359 | <td>0x00400000</td> | |
2360 | <td>Queue requires authentication.</td> | |
2361 | </tr> | |
09a101d6 | 2362 | <tr> |
2363 | <td>0x00800000</td> | |
2364 | <td>Queue supports CUPS command files.</td> | |
2365 | </tr> | |
2366 | <tr> | |
2367 | <td>0x01000000</td> | |
2368 | <td>Queue was automatically discovered and added.</td> | |
2369 | </tr> | |
fa73b229 | 2370 | </tbody> |
2371 | </table></div> | |
2372 | ||
2373 | <h4>printer-type-mask (type2 enum)<span class='info'>CUPS 1.1</span></h4> | |
2374 | ||
2375 | <p>The printer-type-mask attribute is used to choose printers or classes with | |
2376 | the CUPS-Get-Printers and CUPS-Get-Classes operations. The bits are defined | |
2377 | identically to the printer-type attribute and default to all 1's. | |
2378 | ||
2379 | <h4>requesting-user-name-allowed (1setof name(127))<span class='info'>CUPS 1.1</span></h4> | |
2380 | ||
2381 | <p>The requesting-user-name-allowed attribute lists all of the users that are | |
2382 | allowed to access a printer or class. Either this attribute or the | |
2383 | requesting-user-name-denied attribute will be defined, but not both. | |
2384 | ||
2385 | <h4>requesting-user-name-denied (1setof name(127))<span class='info'>CUPS 1.1</span></h4> | |
2386 | ||
2387 | <p>The requesting-user-name-denied attribute lists all of the users that are | |
2388 | not allowed to access a printer or class. Either this attribute or the | |
2389 | requesting-user-name-allowed attribute will be defined, but not both. | |
2390 | ||
2391 | <h3 class='title'><a name='CLASS_ATTRIBUTES'>Printer Class Attributes</a></h3> | |
2392 | ||
2393 | <h4>member-names (1setof name(127))</h4> | |
2394 | ||
2395 | <p>The member-names attribute specifies each of the printer-name attributes of | |
2396 | the member printers and classes. Each name corresponds to the same element of | |
2397 | the member-uris attribute. | |
2398 | ||
2399 | <h4>member-uris (1setof uri)</h4> | |
2400 | ||
2401 | <p>The member-uris attribute specifies each of the printer-uri attributes of | |
2402 | the member printers and classes. Each URI corresponds to the same element of | |
2403 | the member-names attribute. | |
2404 | ||
2405 | </body> | |
2406 | </html> |