]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | <HTML> |
2 | <HEAD> | |
3 | <META NAME="COPYRIGHT" CONTENT="Copyright 1997-2003 All Rights Reserved"> | |
4 | <META NAME="DOCNUMBER" CONTENT="CUPS-IPP-1.2"> | |
5 | <META NAME="Author" CONTENT="Easy Software Products"> | |
6 | <TITLE>CUPS Implementation of IPP</TITLE> | |
7 | </HEAD> | |
8 | <BODY> | |
9 | ||
10 | <H1>Scope</H1> | |
11 | ||
12 | <H2>Identification</H2> | |
13 | ||
14 | <P>This document provides an overview of the Internet Printing Protocol | |
15 | ("IPP") version 1.1 as implemented in the Common UNIX Printing System | |
16 | ("CUPS") version 1.2. | |
17 | ||
18 | <EMBED SRC="system-overview.shtml"> | |
19 | ||
20 | <H2>Document Overview</H2> | |
21 | ||
22 | <P>This document is organized into the following sections: | |
23 | ||
24 | <UL> | |
25 | <LI><A HREF="#1">1 - Scope</A> | |
26 | <LI><A HREF="#2">2 - References</A> | |
27 | <LI><A HREF="#3">3 - Overview</A> | |
28 | <LI><A HREF="#4">4 - Operations</A> | |
29 | <LI><A HREF="#5">5 - Attributes</A> | |
30 | <LI><A HREF="#6">A - Glossary</A> | |
31 | </UL> | |
32 | ||
33 | <EMBED SRC="references.shtml"> | |
34 | ||
35 | <H1>Overview</H1> | |
36 | ||
37 | <P>CUPS 1.1 implements IPP/1.1 and the operations and attributes | |
38 | defined in the "IPP: Job and Printer Set Operations", | |
39 | "IPP/1.1: Output-bin Attribute Extension", and "IPP/1.1: finishings | |
40 | 'fold',' trim', and 'bale' attribute values extension" specifications. | |
41 | ||
42 | <P>CUPS also provides 13 new operations and many new attributes to | |
43 | support multiple IPP printers and printer classes on a single host. | |
44 | ||
45 | <H2>IPP URIs</H2> | |
46 | ||
47 | <P>CUPS supports both the "http" and "ipp" methods. The following | |
48 | resource names are used: | |
49 | ||
50 | <DL> | |
51 | ||
52 | <DT>method://hostname:port/ | |
53 | ||
54 | <DD>Can be used for all "get" operations. | |
55 | ||
56 | <DT>method://hostname:port/admin | |
57 | ||
58 | <DD>Used for all administrative operations. | |
59 | ||
60 | <DT>method://hostname:port/classes/name | |
61 | ||
62 | <DD>Specifies a printer class. | |
63 | ||
64 | <DT>method://hostname:port/jobs/id | |
65 | ||
66 | <DD>Specifies a job. | |
67 | ||
68 | <DT>method://hostname:port/printers/name | |
69 | ||
70 | <DD>Specifies a printer. | |
71 | ||
72 | </DL> | |
73 | ||
74 | <P>So a typical printer URI would be "ipp://foo.bar.com/printers/LaserJet". | |
75 | ||
76 | <P>In addition, the CUPS server also supports normal browser access to | |
77 | "method://hostname:port/admin/", "method://hostname:port/classes/", | |
78 | "method://hostname:port/jobs/", and "method://hostname:port/printers/" | |
79 | to view and manage resources on the server dynamically. | |
80 | ||
81 | <H2>CUPS IPP Operations</H2> | |
82 | ||
83 | <P>CUPS provides 13 extension operations in addition to most of the | |
84 | standard IPP and registered extension operations: | |
85 | ||
86 | <CENTER><TABLE BORDER WIDTH="80%"> | |
87 | <TR> | |
88 | <TH VALIGN="TOP">Operation Name</TH> | |
89 | <TH VALIGN="TOP">CUPS</TH> | |
90 | <TH VALIGN="TOP">Code</TH> | |
91 | <TH VALIGN="TOP">Brief Description</TH> | |
92 | </TR> | |
93 | <TR> | |
94 | <TD VALIGN="TOP">Print-Job</TD> | |
95 | <TD VALIGN="TOP">1.0</TD> | |
96 | <TD VALIGN="TOP">0x0002</TD> | |
97 | <TD VALIGN="TOP">Print a file.</TD> | |
98 | </TR> | |
99 | <TR> | |
100 | <TD VALIGN="TOP">Validate-Job</TD> | |
101 | <TD VALIGN="TOP">1.0</TD> | |
102 | <TD VALIGN="TOP">0x0004</TD> | |
103 | <TD VALIGN="TOP">Validate job attributes.</TD> | |
104 | </TR> | |
105 | <TR> | |
106 | <TD VALIGN="TOP">Create-Job</TD> | |
107 | <TD VALIGN="TOP">1.2</TD> | |
108 | <TD VALIGN="TOP">0x0005</TD> | |
109 | <TD VALIGN="TOP">Create a print job.</TD> | |
110 | </TR> | |
111 | <TR> | |
112 | <TD VALIGN="TOP">Send-Document</TD> | |
113 | <TD VALIGN="TOP">1.2</TD> | |
114 | <TD VALIGN="TOP">0x0006</TD> | |
115 | <TD VALIGN="TOP">Send a file for a print job.</TD> | |
116 | </TR> | |
117 | <TR> | |
118 | <TD VALIGN="TOP">Cancel-Job</TD> | |
119 | <TD VALIGN="TOP">1.0</TD> | |
120 | <TD VALIGN="TOP">0x0008</TD> | |
121 | <TD VALIGN="TOP">Cancel a print job.</TD> | |
122 | </TR> | |
123 | <TR> | |
124 | <TD VALIGN="TOP">Get-Job-Attributes</TD> | |
125 | <TD VALIGN="TOP">1.0</TD> | |
126 | <TD VALIGN="TOP">0x0009</TD> | |
127 | <TD VALIGN="TOP">Get job attributes.</TD> | |
128 | </TR> | |
129 | <TR> | |
130 | <TD VALIGN="TOP">Get-Jobs</TD> | |
131 | <TD VALIGN="TOP">1.0</TD> | |
132 | <TD VALIGN="TOP">0x000A</TD> | |
133 | <TD VALIGN="TOP">Get all jobs.</TD> | |
134 | </TR> | |
135 | <TR> | |
136 | <TD VALIGN="TOP">Get-Printer-Attributes</TD> | |
137 | <TD VALIGN="TOP">1.0</TD> | |
138 | <TD VALIGN="TOP">0x000B</TD> | |
139 | <TD VALIGN="TOP">Get printer attributes.</TD> | |
140 | </TR> | |
141 | <TR> | |
142 | <TD VALIGN="TOP">Hold-Job</TD> | |
143 | <TD VALIGN="TOP">1.2</TD> | |
144 | <TD VALIGN="TOP">0x000C</TD> | |
145 | <TD VALIGN="TOP">Hold a job for printing.</TD> | |
146 | </TR> | |
147 | <TR> | |
148 | <TD VALIGN="TOP">Release-Job</TD> | |
149 | <TD VALIGN="TOP">1.2</TD> | |
150 | <TD VALIGN="TOP">0x000D</TD> | |
151 | <TD VALIGN="TOP">Release a job for printing.</TD> | |
152 | </TR> | |
153 | <TR> | |
154 | <TD VALIGN="TOP">Pause-Printer</TD> | |
155 | <TD VALIGN="TOP">1.0</TD> | |
156 | <TD VALIGN="TOP">0x0010</TD> | |
157 | <TD VALIGN="TOP">Pause printing on a printer.</TD> | |
158 | </TR> | |
159 | <TR> | |
160 | <TD VALIGN="TOP">Resume-Printer</TD> | |
161 | <TD VALIGN="TOP">1.0</TD> | |
162 | <TD VALIGN="TOP">0x0011</TD> | |
163 | <TD VALIGN="TOP">Resume printing on a printer.</TD> | |
164 | </TR> | |
165 | <TR> | |
166 | <TD VALIGN="TOP">Purge-Jobs</TD> | |
167 | <TD VALIGN="TOP">1.0</TD> | |
168 | <TD VALIGN="TOP">0x0012</TD> | |
169 | <TD VALIGN="TOP">Purge all jobs.</TD> | |
170 | </TR> | |
171 | <TR> | |
172 | <TD VALIGN="TOP">Set-Job-Attributes</TD> | |
173 | <TD VALIGN="TOP">1.2</TD> | |
174 | <TD VALIGN="TOP">0x0014</TD> | |
175 | <TD VALIGN="TOP">Set attributes for a pending or held job.</TD> | |
176 | </TR> | |
177 | <TR> | |
178 | <TD VALIGN="TOP">CUPS-Get-Default</TD> | |
179 | <TD VALIGN="TOP">1.0</TD> | |
180 | <TD VALIGN="TOP">0x4001</TD> | |
181 | <TD VALIGN="TOP">Get the default destination.</TD> | |
182 | </TR> | |
183 | <TR> | |
184 | <TD VALIGN="TOP">CUPS-Get-Printers</TD> | |
185 | <TD VALIGN="TOP">1.0</TD> | |
186 | <TD VALIGN="TOP">0x4002</TD> | |
187 | <TD VALIGN="TOP">Get all of the available printers.</TD> | |
188 | </TR> | |
189 | <TR> | |
190 | <TD VALIGN="TOP">CUPS-Add-Modify-Printer</TD> | |
191 | <TD VALIGN="TOP">1.0</TD> | |
192 | <TD VALIGN="TOP">0x4003</TD> | |
193 | <TD VALIGN="TOP">Add or modify a printer.</TD> | |
194 | </TR> | |
195 | <TR> | |
196 | <TD VALIGN="TOP">CUPS-Delete-Printer</TD> | |
197 | <TD VALIGN="TOP">1.0</TD> | |
198 | <TD VALIGN="TOP">0x4004</TD> | |
199 | <TD VALIGN="TOP">Delete a printer.</TD> | |
200 | </TR> | |
201 | <TR> | |
202 | <TD VALIGN="TOP">CUPS-Get-Classes</TD> | |
203 | <TD VALIGN="TOP">1.0</TD> | |
204 | <TD VALIGN="TOP">0x4005</TD> | |
205 | <TD VALIGN="TOP">Get all of the available printer classes.</TD> | |
206 | </TR> | |
207 | <TR> | |
208 | <TD VALIGN="TOP">CUPS-Add-Modify-Class</TD> | |
209 | <TD VALIGN="TOP">1.0</TD> | |
210 | <TD VALIGN="TOP">0x4006</TD> | |
211 | <TD VALIGN="TOP">Add or modify a printer class.</TD> | |
212 | </TR> | |
213 | <TR> | |
214 | <TD VALIGN="TOP">CUPS-Delete-Class</TD> | |
215 | <TD VALIGN="TOP">1.0</TD> | |
216 | <TD VALIGN="TOP">0x4007</TD> | |
217 | <TD VALIGN="TOP">Delete a printer class.</TD> | |
218 | </TR> | |
219 | <TR> | |
220 | <TD VALIGN="TOP">CUPS-Accept-Jobs</TD> | |
221 | <TD VALIGN="TOP">1.0</TD> | |
222 | <TD VALIGN="TOP">0x4008</TD> | |
223 | <TD VALIGN="TOP">Accept jobs on a printer or printer class.</TD> | |
224 | </TR> | |
225 | <TR> | |
226 | <TD VALIGN="TOP">CUPS-Reject-Jobs</TD> | |
227 | <TD VALIGN="TOP">1.0</TD> | |
228 | <TD VALIGN="TOP">0x4009</TD> | |
229 | <TD VALIGN="TOP">Reject jobs on a printer or printer class.</TD> | |
230 | </TR> | |
231 | <TR> | |
232 | <TD VALIGN="TOP">CUPS-Set-Default</TD> | |
233 | <TD VALIGN="TOP">1.0</TD> | |
234 | <TD VALIGN="TOP">0x400A</TD> | |
235 | <TD VALIGN="TOP">Set the default destination.</TD> | |
236 | </TR> | |
237 | <TR> | |
238 | <TD VALIGN="TOP">CUPS-Get-Devices</TD> | |
239 | <TD VALIGN="TOP">1.2</TD> | |
240 | <TD VALIGN="TOP">0x400B</TD> | |
241 | <TD VALIGN="TOP">Get all of the available devices.</TD> | |
242 | </TR> | |
243 | <TR> | |
244 | <TD VALIGN="TOP">CUPS-Get-PPDs</TD> | |
245 | <TD VALIGN="TOP">1.2</TD> | |
246 | <TD VALIGN="TOP">0x400C</TD> | |
247 | <TD VALIGN="TOP">Get all of the available PPDs.</TD> | |
248 | </TR> | |
249 | <TR> | |
250 | <TD VALIGN="TOP">CUPS-Move-Job</TD> | |
251 | <TD VALIGN="TOP">1.2</TD> | |
252 | <TD VALIGN="TOP">0x400D</TD> | |
253 | <TD VALIGN="TOP">Move a job to a different printer.</TD> | |
254 | </TR> | |
255 | </TABLE> | |
256 | </CENTER> | |
257 | ||
258 | <H1>Operations</H1> | |
259 | ||
260 | <P>The following sections describe the operations supported by CUPS. | |
261 | In the interest of brevity, operations which use only the standard | |
262 | IPP attributes are not described. | |
263 | ||
264 | <H2>Print-Job Operation</H2> | |
265 | ||
266 | <P>The Print-Job operation (0x0002) prints a file. | |
267 | ||
268 | <H3>Print-Job Request</H3> | |
269 | ||
270 | <P>The following groups of attributes are supplied as part of the | |
271 | Print-Job request: | |
272 | ||
273 | <P>Group 1: Operation Attributes | |
274 | ||
275 | <UL> | |
276 | ||
277 | <P>Natural Language and Character Set: | |
278 | ||
279 | <P>The "attributes-charset" and "attributes-natural-language" | |
280 | attributes as described in section 3.1.4.1 of the IPP Model and | |
281 | Semantics document. | |
282 | ||
283 | <P>"printer-uri" (uri): | |
284 | ||
285 | <P>The client MUST supply a URI for the specified printer. | |
286 | ||
287 | </UL> | |
288 | ||
289 | <P>Group 2: Job Template Attributes | |
290 | ||
291 | <UL> | |
292 | ||
293 | <P>"job-billing" (text(MAX)): | |
294 | ||
295 | <P><I>(CUPS 1.1 and higher)</I> | |
296 | ||
297 | <P>The client OPTIONALLY supplies a billing string that is logged | |
298 | with the page accounting information. | |
299 | ||
300 | <P>"job-sheets" (1setof type3 keyword | name(MAX)): | |
301 | ||
302 | <P><I>(CUPS 1.1 and higher)</I> | |
303 | ||
304 | <P>The client OPTIONALLY supplies one or two banner pages that | |
305 | are printed before and after any files in the print job. The | |
306 | name of "none" is reserved to indicate that no banner page | |
307 | should be printed. If the client does not specify this | |
308 | attribute then the value of the "job-sheets-default" printer | |
309 | object attribute is used. | |
310 | ||
311 | <P><B>Note:</B> Standard IPP only allows specification of a single | |
312 | job-sheets attribute value. | |
313 | ||
314 | <P>"media" (1setof type3 keyword | name(MAX)): | |
315 | ||
316 | <P>The client OPTIONALLY supplies one or more media attributes | |
317 | specifying the size, type, source, and color of the output | |
318 | media. If the client does not specify this attribute then the | |
319 | value of the "media-default" printer object attribute is used. | |
320 | ||
321 | <P><B>Note:</B> Standard IPP only allows specification of a single | |
322 | media attribute value. | |
323 | ||
324 | <P>Other Job Template Attributes | |
325 | ||
326 | </UL> | |
327 | ||
328 | <P>The Print-Job request is followed by a file to be printed. | |
329 | ||
330 | <H3>Print-Job Response</H3> | |
331 | ||
332 | <P>The following groups of attributes are send as part of the Print-Job | |
333 | Response: | |
334 | ||
335 | <P>Group 1: Operation Attributes | |
336 | ||
337 | <UL> | |
338 | ||
339 | <P>Status Message: | |
340 | ||
341 | <P>The standard response status message. | |
342 | ||
343 | <P>Natural Language and Character Set: | |
344 | ||
345 | <P>The "attributes-charset" and "attributes-natural-language" | |
346 | attributes as described in section 3.1.4.2 of the IPP Model and | |
347 | Semantics document. | |
348 | ||
349 | </UL> | |
350 | ||
351 | <P>Group 2: Job Attributes | |
352 | ||
353 | <UL> | |
354 | ||
355 | <P>Standard Job Attributes | |
356 | ||
357 | </UL> | |
358 | ||
359 | <H2>Create-Job Operation</H2> | |
360 | ||
361 | <P>The Create-Job operation (0x0005) creates a new, empty print job. | |
362 | ||
363 | <H3>Create-Job Request</H3> | |
364 | ||
365 | <P>The following groups of attributes are supplied as part of the | |
366 | Create-Job request: | |
367 | ||
368 | <P>Group 1: Operation Attributes | |
369 | ||
370 | <UL> | |
371 | ||
372 | <P>Natural Language and Character Set: | |
373 | ||
374 | <P>The "attributes-charset" and "attributes-natural-language" | |
375 | attributes as described in section 3.1.4.1 of the IPP Model and | |
376 | Semantics document. | |
377 | ||
378 | <P>"printer-uri" (uri): | |
379 | ||
380 | <P>The client MUST supply a URI for the specified printer. | |
381 | ||
382 | </UL> | |
383 | ||
384 | <P>Group 2: Job Template Attributes | |
385 | ||
386 | <UL> | |
387 | ||
388 | <P>"job-billing" (text(MAX)): | |
389 | ||
390 | <P><I>(CUPS 1.1 and higher)</I> | |
391 | ||
392 | <P>The client OPTIONALLY supplies a billing string that is logged | |
393 | with the page accounting information. | |
394 | ||
395 | <P>"job-sheets" (1setof type3 keyword | name(MAX)): | |
396 | ||
397 | <P><I>(CUPS 1.1 and higher)</I> | |
398 | ||
399 | <P>The client OPTIONALLY supplies one or two banner pages that | |
400 | are printed before and after any files in the print job. The | |
401 | name of "none" is reserved to indicate that no banner page | |
402 | should be printed. If the client does not specify this | |
403 | attribute then the value of the "job-sheets-default" printer | |
404 | object attribute is used. | |
405 | ||
406 | <P><B>Note:</B> Standard IPP only allows specification of a single | |
407 | job-sheets attribute value. | |
408 | ||
409 | <P>"media" (1setof type3 keyword | name(MAX)): | |
410 | ||
411 | <P>The client OPTIONALLY supplies one or more media attributes | |
412 | specifying the size, type, source, and color of the output | |
413 | media. If the client does not specify this attribute then the | |
414 | value of the "media-default" printer object attribute is used. | |
415 | ||
416 | <P><B>Note:</B> Standard IPP only allows specification of a single | |
417 | media attribute value. | |
418 | ||
419 | <P>Standard Job Template Attributes | |
420 | ||
421 | </UL> | |
422 | ||
423 | <H3>Create-Job Response</H3> | |
424 | ||
425 | <P>The following groups of attributes are send as part of the | |
426 | Create-Job Response: | |
427 | ||
428 | <P>Group 1: Operation Attributes | |
429 | ||
430 | <UL> | |
431 | ||
432 | <P>Status Message: | |
433 | ||
434 | <P>The standard response status message. | |
435 | ||
436 | <P>Natural Language and Character Set: | |
437 | ||
438 | <P>The "attributes-charset" and "attributes-natural-language" | |
439 | attributes as described in section 3.1.4.2 of the IPP Model and | |
440 | Semantics document. | |
441 | ||
442 | </UL> | |
443 | ||
444 | <P>Group 2: Job Attributes | |
445 | ||
446 | <UL> | |
447 | ||
448 | <P>Standard Job Attributes | |
449 | ||
450 | </UL> | |
451 | ||
452 | <H2>Set-Job-Attributes Operation</H2> | |
453 | ||
454 | <P>The Set-Job-Attributes operation (0x0014) changes the attributes of | |
455 | an active (not completed) job. | |
456 | ||
457 | <H3>Set-Job-Attributes Request</H3> | |
458 | ||
459 | <P>The following groups of attributes are supplied as part of the | |
460 | Set-Job-Attributes request: | |
461 | ||
462 | <P>Group 1: Operation Attributes | |
463 | ||
464 | <UL> | |
465 | ||
466 | <P>Natural Language and Character Set: | |
467 | ||
468 | <P>The "attributes-charset" and "attributes-natural-language" | |
469 | attributes as described in section 3.1.4.1 of the IPP Model and | |
470 | Semantics document. | |
471 | ||
472 | <P>"printer-uri" (uri) and "job-id" (integer) | |
473 | <P><I>OR</I> | |
474 | <P>"job-uri": | |
475 | ||
476 | <P>The client MUST supply a URI for the specified printer and | |
477 | a job ID number, or the job URI. | |
478 | ||
479 | </UL> | |
480 | ||
481 | <P>Group 2: Job Template Attributes | |
482 | ||
483 | <UL> | |
484 | ||
485 | <P>"job-sheets" (1setof type3 keyword | name(MAX)): | |
486 | ||
487 | <P><I>(CUPS 1.1 and higher)</I> | |
488 | ||
489 | <P>The client OPTIONALLY supplies one or two banner pages that | |
490 | are printed before and after any files in the print job. The | |
491 | name of "none" is reserved to indicate that no banner page | |
492 | should be printed. If the client does not specify this | |
493 | attribute then the value of the "job-sheets-default" printer | |
494 | object attribute is used. | |
495 | ||
496 | <P><B>Note:</B> Standard IPP only allows specification of a single | |
497 | job-sheets attribute value. | |
498 | ||
499 | <P>"media" (1setof type3 keyword | name(MAX)): | |
500 | ||
501 | <P>The client OPTIONALLY supplies one or more media attributes | |
502 | specifying the size, type, source, and color of the output | |
503 | media. If the client does not specify this attribute then the | |
504 | value of the "media-default" printer object attribute is used. | |
505 | ||
506 | <P><B>Note:</B> Standard IPP only allows specification of a single | |
507 | media attribute value. | |
508 | ||
509 | <P>Other Job Template Attributes | |
510 | ||
511 | </UL> | |
512 | ||
513 | <H3>Set-Job-Attributes Response</H3> | |
514 | ||
515 | <P>The following groups of attributes are send as part of the Set-Job-Attributes | |
516 | Response: | |
517 | ||
518 | <P>Group 1: Operation Attributes | |
519 | ||
520 | <UL> | |
521 | ||
522 | <P>Status Message: | |
523 | ||
524 | <P>The standard response status message. | |
525 | ||
526 | <P>Natural Language and Character Set: | |
527 | ||
528 | <P>The "attributes-charset" and "attributes-natural-language" | |
529 | attributes as described in section 3.1.4.2 of the IPP Model and | |
530 | Semantics document. | |
531 | ||
532 | </UL> | |
533 | ||
534 | <H2>CUPS-Get-Default Operation</H2> | |
535 | ||
536 | <P>The CUPS-Get-Default operation (0x4001) returns the default printer | |
537 | URI and attributes. | |
538 | ||
539 | <H3>CUPS-Get-Default Request</H3> | |
540 | ||
541 | <P>The following groups of attributes are supplied as part of the | |
542 | CUPS-Get-Default request: | |
543 | ||
544 | <P>Group 1: Operation Attributes | |
545 | ||
546 | <UL> | |
547 | ||
548 | <P>Natural Language and Character Set: | |
549 | ||
550 | <P>The "attributes-charset" and "attributes-natural-language" | |
551 | attributes as described in section 3.1.4.1 of the IPP Model and | |
552 | Semantics document. | |
553 | ||
554 | <P>"requested-attributes" (1setOf keyword) : | |
555 | ||
556 | <P>The client OPTIONALLY supplies a set of attribute names | |
557 | and/or attribute group names in whose values the requester is | |
558 | interested. If the client omits this attribute, the server | |
559 | responds as if this attribute had been supplied with a value of | |
560 | 'all'. | |
561 | ||
562 | </UL> | |
563 | ||
564 | <H3>CUPS-Get-Default Response</H3> | |
565 | ||
566 | <P>The following groups of attributes are send as part of the | |
567 | CUPS-Get-Default Response: | |
568 | ||
569 | <P>Group 1: Operation Attributes | |
570 | ||
571 | <UL> | |
572 | ||
573 | <P>Status Message: | |
574 | ||
575 | <P>The standard response status message. | |
576 | ||
577 | <P>Natural Language and Character Set: | |
578 | ||
579 | <P>The "attributes-charset" and "attributes-natural-language" | |
580 | attributes as described in section 3.1.4.2 of the IPP Model and | |
581 | Semantics document. | |
582 | ||
583 | </UL> | |
584 | ||
585 | <P>Group 2: Printer Object Attributes | |
586 | ||
587 | <UL> | |
588 | ||
589 | <P>The set of requested attributes and their current values. | |
590 | ||
591 | </UL> | |
592 | ||
593 | <H2>CUPS-Get-Printers Operation</H2> | |
594 | ||
595 | <P>The CUPS-Get-Printers operation (0x4002) returns the printer | |
596 | attributes for every printer known to the system. This may include | |
597 | printers that are not served directly by the server. | |
598 | ||
599 | <H3>CUPS-Get-Printers Request</H3> | |
600 | ||
601 | <P>The following groups of attributes are supplied as part of the | |
602 | CUPS-Get-Printers request: | |
603 | ||
604 | <P>Group 1: Operation Attributes | |
605 | ||
606 | <UL> | |
607 | ||
608 | <P>Natural Language and Character Set: | |
609 | ||
610 | <P>The "attributes-charset" and "attributes-natural-language" | |
611 | attributes as described in section 3.1.4.1 of the IPP Model and | |
612 | Semantics document. | |
613 | ||
614 | <P>"limit" (integer (1:MAX)): | |
615 | ||
616 | <P>The client OPTIONALLY supplies this attribute limiting the | |
617 | number of printers that are returned. | |
618 | ||
619 | <P>"printer-info" (text(127)): | |
620 | ||
621 | <P><I>(CUPS 1.1 and higher)</I> | |
622 | ||
623 | <P>The client OPTIONALLY supplies this attribute to | |
624 | select which printers are returned. | |
625 | ||
626 | <P>"printer-location" (text(127)): | |
627 | ||
628 | <P><I>(CUPS 1.1 and higher)</I> | |
629 | ||
630 | <P>The client OPTIONALLY supplies this attribute to | |
631 | select which printers are returned. | |
632 | ||
633 | <P>"printer-type" (type2 enum): | |
634 | ||
635 | <P><I>(CUPS 1.1 and higher)</I> | |
636 | ||
637 | <P>The client OPTIONALLY supplies a printer type enumeration to | |
638 | select which printers are returned. | |
639 | ||
640 | <P>"printer-type-mask" (type2 enum): | |
641 | ||
642 | <P><I>(CUPS 1.1 and higher)</I> | |
643 | ||
644 | <P>The client OPTIONALLY supplies a printer type mask | |
645 | enumeration to select which bits are used in the "printer-type" | |
646 | attribute. | |
647 | ||
648 | <P>"requested-attributes" (1setOf keyword) : | |
649 | ||
650 | <P>The client OPTIONALLY supplies a set of attribute names | |
651 | and/or attribute group names in whose values the requester is | |
652 | interested. If the client omits this attribute, the server | |
653 | responds as if this attribute had been supplied with a value of | |
654 | 'all'. | |
655 | ||
656 | </UL> | |
657 | ||
658 | <H3>CUPS-Get-Printers Response</H3> | |
659 | ||
660 | <P>The following groups of attributes are send as part of the | |
661 | CUPS-Get-Printers Response: | |
662 | ||
663 | <P>Group 1: Operation Attributes | |
664 | ||
665 | <UL> | |
666 | ||
667 | <P>Status Message: | |
668 | ||
669 | <P>The standard response status message. | |
670 | ||
671 | <P>Natural Language and Character Set: | |
672 | ||
673 | <P>The "attributes-charset" and "attributes-natural-language" | |
674 | attributes as described in section 3.1.4.2 of the IPP Model and | |
675 | Semantics document. | |
676 | ||
677 | </UL> | |
678 | ||
679 | <P>Group 2: Printer Object Attributes | |
680 | ||
681 | <UL> | |
682 | ||
683 | <P>The set of requested attributes and their current values for | |
684 | each printer. | |
685 | ||
686 | </UL> | |
687 | ||
688 | <H2>CUPS-Add-Modify-Printer Operation</H2> | |
689 | ||
690 | <P>The CUPS-Add-Modify-Printer operation (0x4003) adds a new printer or | |
691 | modifies an existing printer on the system. | |
692 | ||
693 | <H3>CUPS-Add-Modify-Printer Request</H3> | |
694 | ||
695 | <P>The following groups of attributes are supplied as part of the | |
696 | CUPS-Add-Modify-Printer request: | |
697 | ||
698 | <P>Group 1: Operation Attributes | |
699 | ||
700 | <UL> | |
701 | ||
702 | <P>Natural Language and Character Set: | |
703 | ||
704 | <P>The "attributes-charset" and "attributes-natural-language" | |
705 | attributes as described in section 3.1.4.1 of the IPP Model and | |
706 | Semantics document. | |
707 | ||
708 | <P>"printer-uri" (uri): | |
709 | ||
710 | <P>The client MUST supply a URI for the specified printer. | |
711 | ||
712 | </UL> | |
713 | ||
714 | <P>Group 2: Printer Object Attributes | |
715 | ||
716 | <UL> | |
717 | ||
718 | <P>"banner-end-default" (name(127)): | |
719 | ||
720 | <P><I>(CUPS 1.1 and higher)</I> | |
721 | ||
722 | <P>The client OPTIONALLY supplies a banner page name that is | |
723 | printed after files in a job. The reserved name "none" is used to | |
724 | specify that no banner page should be printed. | |
725 | ||
726 | <P>"banner-start-default" (name(127)): | |
727 | ||
728 | <P><I>(CUPS 1.1 and higher)</I> | |
729 | ||
730 | <P>The client OPTIONALLY supplies a banner page name that is | |
731 | printed before files in a job. The reserved name "none" is used to | |
732 | specify that no banner page should be printed. | |
733 | ||
734 | <P>"device-uri" (uri): | |
735 | ||
736 | <P>The client OPTIONALLY supplies a device URI for the | |
737 | specified printer. | |
738 | ||
739 | <P>"ppd-name" (name(127)): | |
740 | ||
741 | <P>The client OPTIONALLY supplies a PPD name for the specified | |
742 | printer. | |
743 | ||
744 | <P>"printer-is-accepting-jobs" (boolean): | |
745 | ||
746 | <P>The client OPTIONALLY supplies this boolean attribute | |
747 | indicating whether or not the printer object should accept new jobs. | |
748 | ||
749 | <P>"printer-info" (text(127)): | |
750 | ||
751 | <P>The client OPTIONALLY supplies this attribute indicating the | |
752 | printer information string. | |
753 | ||
754 | <P>"printer-location" (text(127)): | |
755 | ||
756 | <P>The client OPTIONALLY supplies this attribute indicating a | |
757 | textual location of the printer. | |
758 | ||
759 | <P>"printer-more-info" (uri): | |
760 | ||
761 | <P>The client OPTIONALLY supplies this attribute indicating a | |
762 | URI for additional printer information. | |
763 | ||
764 | <P>"printer-state" (type2 enum): | |
765 | ||
766 | <P>The client OPTIONALLY supplies this attribute indicating the | |
767 | initial/current state of the printer. Only the "idle" and "stopped" | |
768 | enumerations are recognized. | |
769 | ||
770 | <P>"printer-state-message" (text(MAX)): | |
771 | ||
772 | <P>The client OPTIONALLY supplies this attribute indicating a | |
773 | textual reason for the current printer state. | |
774 | ||
775 | <P>"requesting-user-name-allowed" (1setof name(127) | delete) | |
776 | <P><I>OR</I> | |
777 | <P>"requesting-user-name-denied" (1setof name(127) | delete): | |
778 | ||
779 | <P>The client OPTIONALLY supplies one of these attributes to | |
780 | specify an access control list for incoming print jobs. To allow | |
781 | all users access to a printer, use the delete tag for the | |
782 | attribute value. | |
783 | ||
784 | </UL> | |
785 | ||
786 | <P>The CUPS-Add-Modify-Printer request can optionally be followed by a PPD | |
787 | file or System V interface script to be used for the printer. The | |
788 | "ppd-name" attribute overrides any file that is attached to the end of | |
789 | the request with a local CUPS PPD file. | |
790 | ||
791 | <H3>CUPS-Add-Modify-Printer Response</H3> | |
792 | ||
793 | <P>The following groups of attributes are send as part of the | |
794 | CUPS-Add-Modify-Printer Response: | |
795 | ||
796 | <P>Group 1: Operation Attributes | |
797 | ||
798 | <UL> | |
799 | ||
800 | <P>Status Message: | |
801 | ||
802 | <P>The standard response status message. | |
803 | ||
804 | <P>Natural Language and Character Set: | |
805 | ||
806 | <P>The "attributes-charset" and "attributes-natural-language" | |
807 | attributes as described in section 3.1.4.2 of the IPP Model and | |
808 | Semantics document. | |
809 | ||
810 | </UL> | |
811 | ||
812 | <H2>CUPS-Delete-Printer Operation</H2> | |
813 | ||
814 | <P>The CUPS-Delete-Printer operation (0x4004) removes an existing | |
815 | printer from the system. | |
816 | ||
817 | <H3>CUPS-Delete-Printer Request</H3> | |
818 | ||
819 | <P>The following groups of attributes are supplied as part of the | |
820 | CUPS-Delete-Printer request: | |
821 | ||
822 | <P>Group 1: Operation Attributes | |
823 | ||
824 | <UL> | |
825 | ||
826 | <P>Natural Language and Character Set: | |
827 | ||
828 | <P>The "attributes-charset" and "attributes-natural-language" | |
829 | attributes as described in section 3.1.4.1 of the IPP Model and | |
830 | Semantics document. | |
831 | ||
832 | <P>"printer-uri" (uri): | |
833 | ||
834 | <P>The client MUST supply a URI for the specified printer. | |
835 | ||
836 | </UL> | |
837 | ||
838 | <H3>CUPS-Delete-Printer Response</H3> | |
839 | ||
840 | <P>The following groups of attributes are send as part of the | |
841 | CUPS-Delete-Printer Response: | |
842 | ||
843 | <P>Group 1: Operation Attributes | |
844 | ||
845 | <UL> | |
846 | ||
847 | <P>Status Message: | |
848 | ||
849 | <P>The standard response status message. | |
850 | ||
851 | <P>Natural Language and Character Set: | |
852 | ||
853 | <P>The "attributes-charset" and "attributes-natural-language" | |
854 | attributes as described in section 3.1.4.2 of the IPP Model and | |
855 | Semantics document. | |
856 | ||
857 | </UL> | |
858 | ||
859 | <H2>CUPS-Get-Classes Operation</H2> | |
860 | ||
861 | <P>The CUPS-Get-Classes operation (0x4005) returns the printer | |
862 | attributes for every printer class known to the system. This may | |
863 | include printer classes that are not served directly by the server. | |
864 | ||
865 | <H3>CUPS-Get-Classes Request</H3> | |
866 | ||
867 | <P>The following groups of attributes are supplied as part of the | |
868 | CUPS-Get-Classes request: | |
869 | ||
870 | <P>Group 1: Operation Attributes | |
871 | ||
872 | <UL> | |
873 | ||
874 | <P>Natural Language and Character Set: | |
875 | ||
876 | <P>The "attributes-charset" and "attributes-natural-language" | |
877 | attributes as described in section 3.1.4.1 of the IPP Model and | |
878 | Semantics document. | |
879 | ||
880 | <P>"limit" (integer (1:MAX)): | |
881 | ||
882 | <P>The client OPTIONALLY supplies this attribute limiting the | |
883 | number of printer classes that are returned. | |
884 | ||
885 | <P>"printer-info" (text(127)): | |
886 | ||
887 | <P><I>(CUPS 1.1 and higher)</I> | |
888 | ||
889 | <P>The client OPTIONALLY supplies this attribute to | |
890 | select which printer classes are returned. | |
891 | ||
892 | <P>"printer-location" (text(127)): | |
893 | ||
894 | <P><I>(CUPS 1.1 and higher)</I> | |
895 | ||
896 | <P>The client OPTIONALLY supplies this attribute to | |
897 | select which printer classes are returned. | |
898 | ||
899 | <P>"printer-type" (type2 enum): | |
900 | ||
901 | <P><I>(CUPS 1.1 and higher)</I> | |
902 | ||
903 | <P>The client OPTIONALLY supplies a printer type enumeration to | |
904 | select which printer classes are returned. | |
905 | ||
906 | <P>"printer-type-mask" (type2 enum): | |
907 | ||
908 | <P><I>(CUPS 1.1 and higher)</I> | |
909 | ||
910 | <P>The client OPTIONALLY supplies a printer type mask | |
911 | enumeration to select which bits are used in the "printer-type" | |
912 | attribute. | |
913 | ||
914 | <P>"requested-attributes" (1setOf keyword) : | |
915 | ||
916 | <P>The client OPTIONALLY supplies a set of attribute names | |
917 | and/or attribute group names in whose values the requester is | |
918 | interested. If the client omits this attribute, the server responds as | |
919 | if this attribute had been supplied with a value of 'all'. | |
920 | ||
921 | </UL> | |
922 | ||
923 | <H3>CUPS-Get-Classes Response</H3> | |
924 | ||
925 | <P>The following groups of attributes are send as part of the | |
926 | CUPS-Get-Classes Response: | |
927 | ||
928 | <P>Group 1: Operation Attributes | |
929 | ||
930 | <UL> | |
931 | ||
932 | <P>Status Message: | |
933 | ||
934 | <P>The standard response status message. | |
935 | ||
936 | <P>Natural Language and Character Set: | |
937 | ||
938 | <P>The "attributes-charset" and "attributes-natural-language" | |
939 | attributes as described in section 3.1.4.2 of the IPP Model and | |
940 | Semantics document. | |
941 | ||
942 | </UL> | |
943 | ||
944 | <P>Group 2: Printer Class Object Attributes | |
945 | ||
946 | <UL> | |
947 | ||
948 | <P>The set of requested attributes and their current values for | |
949 | each printer class. | |
950 | ||
951 | </UL> | |
952 | ||
953 | <H2>CUPS-Add-Modify-Class Operation</H2> | |
954 | ||
955 | <P>The CUPS-Add-Modify-Class operation (0x4006) adds a new printer class or | |
956 | modifies and existing printer class on the system. | |
957 | ||
958 | <H3>CUPS-Add-Modify-Class Request</H3> | |
959 | ||
960 | <P>The following groups of attributes are supplied as part of the | |
961 | CUPS-Add-Modify-Class request: | |
962 | ||
963 | <P>Group 1: Operation Attributes | |
964 | ||
965 | <UL> | |
966 | ||
967 | <P>Natural Language and Character Set: | |
968 | ||
969 | <P>The "attributes-charset" and "attributes-natural-language" | |
970 | attributes as described in section 3.1.4.1 of the IPP Model and | |
971 | Semantics document. | |
972 | ||
973 | <P>"printer-uri" (uri): | |
974 | ||
975 | <P>The client MUST supply a URI for the specified printer class. | |
976 | ||
977 | </UL> | |
978 | ||
979 | <P>Group 2: Printer Object Attributes | |
980 | ||
981 | <UL> | |
982 | ||
983 | <P>"member-uris" (1setof uri): | |
984 | ||
985 | <P>The client OPTIONALLY supplies the "member-uris" set | |
986 | specifying the printers and printer classes that are part of the class. | |
987 | ||
988 | <P>"printer-is-accepting-jobs" (boolean): | |
989 | ||
990 | <P>The client OPTIONALLY supplies this boolean attribute | |
991 | indicating whether or not the class object should accept new jobs. | |
992 | ||
993 | <P>"printer-info" (text(127)): | |
994 | ||
995 | <P>The client OPTIONALLY supplies this attribute indicating the | |
996 | printer information string. | |
997 | ||
998 | <P>"printer-location" (text(127)): | |
999 | ||
1000 | <P>The client OPTIONALLY supplies this attribute indicating a | |
1001 | textual location of the class. | |
1002 | ||
1003 | <P>"printer-more-info" (uri): | |
1004 | ||
1005 | <P>The client OPTIONALLY supplies this attribute indicating a | |
1006 | URI for additional class information. | |
1007 | ||
1008 | <P>"printer-state" (type2 enum): | |
1009 | ||
1010 | <P>The client OPTIONALLY supplies this attribute indicating the | |
1011 | initial/current state of the class. Only the "idle" and "stopped" | |
1012 | enumerations are recognized. | |
1013 | ||
1014 | <P>"printer-state-message" (text(MAX)): | |
1015 | ||
1016 | <P>The client OPTIONALLY supplies this attribute indicating a | |
1017 | textual reason for the current class state. | |
1018 | ||
1019 | <P>"requesting-user-name-allowed" (1setof name(127)) | |
1020 | <P><I>OR</I> | |
1021 | <P>"requesting-user-name-denied" (1setof name(127)): | |
1022 | ||
1023 | <P>The client OPTIONALLY supplies one of these attributes to | |
1024 | specify an access control list for incoming print jobs. To allow | |
1025 | all users access to a class, use the delete tag for the | |
1026 | attribute value. | |
1027 | ||
1028 | </UL> | |
1029 | ||
1030 | <H3>CUPS-Add-Modify-Class Response</H3> | |
1031 | ||
1032 | <P>The following groups of attributes are send as part of the CUPS-Add-Modify-Class Response: | |
1033 | ||
1034 | <P>Group 1: Operation Attributes | |
1035 | ||
1036 | <UL> | |
1037 | ||
1038 | <P>Status Message: | |
1039 | ||
1040 | <P>The standard response status message. | |
1041 | ||
1042 | <P>Natural Language and Character Set: | |
1043 | ||
1044 | <P>The "attributes-charset" and "attributes-natural-language" | |
1045 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1046 | Semantics document. | |
1047 | ||
1048 | </UL> | |
1049 | ||
1050 | <H2>CUPS-Delete-Class Operation</H2> | |
1051 | ||
1052 | <P>The CUPS-Delete-Class operation (0x4007) removes an existing printer | |
1053 | class from the system. | |
1054 | ||
1055 | <H3>CUPS-Delete-Class Request</H3> | |
1056 | ||
1057 | <P>The following groups of attributes are supplied as part of the | |
1058 | CUPS-Delete-Class request: | |
1059 | ||
1060 | <P>Group 1: Operation Attributes | |
1061 | ||
1062 | <UL> | |
1063 | ||
1064 | <P>Natural Language and Character Set: | |
1065 | ||
1066 | <P>The "attributes-charset" and "attributes-natural-language" | |
1067 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1068 | Semantics document. | |
1069 | ||
1070 | <P>"printer-uri" (uri): | |
1071 | ||
1072 | <P>The client MUST supply a URI for the specified printer class. | |
1073 | ||
1074 | </UL> | |
1075 | ||
1076 | <H3>CUPS-Delete-Class Response</H3> | |
1077 | ||
1078 | <P>The following groups of attributes are send as part of the | |
1079 | CUPS-Delete-Class Response: | |
1080 | ||
1081 | <P>Group 1: Operation Attributes | |
1082 | ||
1083 | <UL> | |
1084 | ||
1085 | <P>Status Message: | |
1086 | ||
1087 | <P>The standard response status message. | |
1088 | ||
1089 | <P>Natural Language and Character Set: | |
1090 | ||
1091 | <P>The "attributes-charset" and "attributes-natural-language" | |
1092 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1093 | Semantics document. | |
1094 | ||
1095 | </UL> | |
1096 | ||
1097 | <H2>CUPS-Accept-Jobs Operation</H2> | |
1098 | ||
1099 | <P>The CUPS-Accept-Jobs operation (0x4008) sets the | |
1100 | "printer-is-accepting-jobs" attribute to true for the specified printer | |
1101 | or printer class. | |
1102 | ||
1103 | <H3>CUPS-Accept-Jobs Request</H3> | |
1104 | ||
1105 | <P>The following groups of attributes are supplied as part of the | |
1106 | CUPS-Accept-Jobs request: | |
1107 | ||
1108 | <P>Group 1: Operation Attributes | |
1109 | ||
1110 | <UL> | |
1111 | ||
1112 | <P>Natural Language and Character Set: | |
1113 | ||
1114 | <P>The "attributes-charset" and "attributes-natural-language" | |
1115 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1116 | Semantics document. | |
1117 | ||
1118 | <P>"printer-uri" (uri): | |
1119 | ||
1120 | <P>The client MUST supply a URI for the specified printer or printer class. | |
1121 | ||
1122 | </UL> | |
1123 | ||
1124 | <H3>CUPS-Accept-Jobs Response</H3> | |
1125 | ||
1126 | <P>The following groups of attributes are send as part of the | |
1127 | CUPS-Accept-Jobs Response: | |
1128 | ||
1129 | <P>Group 1: Operation Attributes | |
1130 | ||
1131 | <UL> | |
1132 | ||
1133 | <P>Status Message: | |
1134 | ||
1135 | <P>The standard response status message. | |
1136 | ||
1137 | <P>Natural Language and Character Set: | |
1138 | ||
1139 | <P>The "attributes-charset" and "attributes-natural-language" | |
1140 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1141 | Semantics document. | |
1142 | ||
1143 | </UL> | |
1144 | ||
1145 | <H2>CUPS-Reject-Jobs Operation</H2> | |
1146 | ||
1147 | <P>The CUPS-Reject-Jobs operation (0x4009) sets | |
1148 | the"printer-is-accepting-jobs" attribute to false for the specified | |
1149 | printer or printer class. | |
1150 | ||
1151 | <H3>CUPS-Reject-Jobs Request</H3> | |
1152 | ||
1153 | <P>The following groups of attributes are supplied as part of the | |
1154 | CUPS-Reject-Jobs request: | |
1155 | ||
1156 | <P>Group 1: Operation Attributes | |
1157 | ||
1158 | <UL> | |
1159 | ||
1160 | <P>Natural Language and Character Set: | |
1161 | ||
1162 | <P>The "attributes-charset" and "attributes-natural-language" | |
1163 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1164 | Semantics document. | |
1165 | ||
1166 | <P>"printer-uri" (uri): | |
1167 | ||
1168 | <P>The client MUST supply a URI for the specified printer or printer class. | |
1169 | ||
1170 | </UL> | |
1171 | ||
1172 | <P>Group 2: Printer Object Attributes | |
1173 | ||
1174 | <UL> | |
1175 | ||
1176 | <P>"printer-state-message" (text(MAX)): | |
1177 | ||
1178 | <P>The client OPTIONALLY supplies this attribute indicating a | |
1179 | textual reason for the current printer state. | |
1180 | ||
1181 | </UL> | |
1182 | ||
1183 | <H3>CUPS-Reject-Jobs Response</H3> | |
1184 | ||
1185 | <P>The following groups of attributes are send as part of the | |
1186 | CUPS-Reject-Jobs Response: | |
1187 | ||
1188 | <P>Group 1: Operation Attributes | |
1189 | ||
1190 | <UL> | |
1191 | ||
1192 | <P>Status Message: | |
1193 | ||
1194 | <P>The standard response status message. | |
1195 | ||
1196 | <P>Natural Language and Character Set: | |
1197 | ||
1198 | <P>The "attributes-charset" and "attributes-natural-language" | |
1199 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1200 | Semantics document. | |
1201 | ||
1202 | </UL> | |
1203 | ||
1204 | <H2>CUPS-Set-Default Operation</H2> | |
1205 | ||
1206 | <P>The CUPS-Set-Default operation (0x400A) sets the default printer | |
1207 | destination for all clients when a resource name of "/printers" is | |
1208 | specified. | |
1209 | ||
1210 | <H3>CUPS-Set-Default Request</H3> | |
1211 | ||
1212 | <P>The following groups of attributes are supplied as part of the | |
1213 | CUPS-Set-Default request: | |
1214 | ||
1215 | <P>Group 1: Operation Attributes | |
1216 | ||
1217 | <UL> | |
1218 | ||
1219 | <P>Natural Language and Character Set: | |
1220 | ||
1221 | <P>The "attributes-charset" and "attributes-natural-language" | |
1222 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1223 | Semantics document. | |
1224 | ||
1225 | <P>"printer-uri" (uri): | |
1226 | ||
1227 | <P>The client MUST supply a URI for the specified printer or | |
1228 | printer class. | |
1229 | ||
1230 | </UL> | |
1231 | ||
1232 | <H3>CUPS-Set-Default Response</H3> | |
1233 | ||
1234 | <P>The following groups of attributes are send as part of the | |
1235 | CUPS-Set-Default Response: | |
1236 | ||
1237 | <P>Group 1: Operation Attributes | |
1238 | ||
1239 | <UL> | |
1240 | ||
1241 | <P>Status Message: | |
1242 | ||
1243 | <P>The standard response status message. | |
1244 | ||
1245 | <P>Natural Language and Character Set: | |
1246 | ||
1247 | <P>The "attributes-charset" and "attributes-natural-language" | |
1248 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1249 | Semantics document. | |
1250 | ||
1251 | </UL> | |
1252 | ||
1253 | <H2>CUPS-Get-Devices Operation</H2> | |
1254 | ||
1255 | <P>The CUPS-Get-Devices operation (0x400B) returns all of the supported | |
1256 | device-uri's for the server (CUPS 1.1 and higher). | |
1257 | ||
1258 | <H3>CUPS-Get-Devices Request</H3> | |
1259 | ||
1260 | <P>The following groups of attributes are supplied as part of the | |
1261 | CUPS-Get-Devices request: | |
1262 | ||
1263 | <P>Group 1: Operation Attributes | |
1264 | ||
1265 | <UL> | |
1266 | ||
1267 | <P>Natural Language and Character Set: | |
1268 | ||
1269 | <P>The "attributes-charset" and "attributes-natural-language" | |
1270 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1271 | Semantics document. | |
1272 | ||
1273 | <P>"device-class" (type1 keyword): | |
1274 | ||
1275 | <P>The client OPTIONALLY supplies a device class keyword to select | |
1276 | which devices are returned. | |
1277 | ||
1278 | <P>"limit" (integer (1:MAX)): | |
1279 | ||
1280 | <P>The client OPTIONALLY supplies this attribute limiting the number of | |
1281 | devices that are returned. | |
1282 | ||
1283 | <P>"requested-attributes" (1setOf keyword) : | |
1284 | ||
1285 | <P>The client OPTIONALLY supplies a set of attribute names and/or | |
1286 | attribute group names in whose values the requester is interested. If | |
1287 | the client omits this attribute, the server responds as if this | |
1288 | attribute had been supplied with a value of 'all'. | |
1289 | ||
1290 | </UL> | |
1291 | ||
1292 | <H3>CUPS-Get-Devices Response</H3> | |
1293 | ||
1294 | <P>The following groups of attributes are send as part of the | |
1295 | CUPS-Get-Devices Response: | |
1296 | ||
1297 | <P>Group 1: Operation Attributes | |
1298 | ||
1299 | <UL> | |
1300 | ||
1301 | <P>Status Message: | |
1302 | ||
1303 | <P>The standard response status message. | |
1304 | ||
1305 | <P>Natural Language and Character Set: | |
1306 | ||
1307 | <P>The "attributes-charset" and "attributes-natural-language" | |
1308 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1309 | Semantics document. | |
1310 | ||
1311 | </UL> | |
1312 | ||
1313 | <P>Group 2: Device Object Attributes | |
1314 | ||
1315 | <UL> | |
1316 | ||
1317 | <P>The set of requested attributes and their current values for | |
1318 | each device. | |
1319 | ||
1320 | </UL> | |
1321 | ||
1322 | <H2>CUPS-Get-PPDs Operation</H2> | |
1323 | ||
1324 | <P>The CUPS-Get-PPDs operation (0x400C) returns all of the locally | |
1325 | available PPD files on the system (CUPS 1.1 and higher). | |
1326 | ||
1327 | <H3>CUPS-Get-PPDs Request</H3> | |
1328 | ||
1329 | <P>The following groups of attributes are supplied as part of the | |
1330 | CUPS-Get-PPDs request: | |
1331 | ||
1332 | <P>Group 1: Operation Attributes | |
1333 | ||
1334 | <UL> | |
1335 | ||
1336 | <P>Natural Language and Character Set: | |
1337 | ||
1338 | <P>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 | <P>"limit" (integer (1:MAX)): | |
1343 | ||
1344 | <P>The client OPTIONALLY supplies this attribute limiting the number of | |
1345 | PPDs that are returned. | |
1346 | ||
1347 | <P>"ppd-make" (text(127)): | |
1348 | ||
1349 | <P>The client OPTIONALLY supplies a printer manufacturer to select | |
1350 | which PPDs are returned. | |
1351 | ||
1352 | <P>"requested-attributes" (1setOf keyword) : | |
1353 | ||
1354 | <P>The client OPTIONALLY supplies a set of attribute names and/or | |
1355 | attribute group names in whose values the requester is interested. If | |
1356 | the client omits this attribute, the server responds as if this | |
1357 | attribute had been supplied with a value of 'all'. | |
1358 | ||
1359 | </UL> | |
1360 | ||
1361 | <H3>CUPS-Get-PPDs Response</H3> | |
1362 | ||
1363 | <P>The following groups of attributes are send as part of the | |
1364 | CUPS-Get-PPDs Response: | |
1365 | ||
1366 | <P>Group 1: Operation Attributes | |
1367 | ||
1368 | <UL> | |
1369 | ||
1370 | <P>Status Message: | |
1371 | ||
1372 | <P>The standard response status message. | |
1373 | ||
1374 | <P>Natural Language and Character Set: | |
1375 | ||
1376 | <P>The "attributes-charset" and "attributes-natural-language" | |
1377 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1378 | Semantics document. | |
1379 | ||
1380 | </UL> | |
1381 | ||
1382 | <P>Group 2: PPD Attributes | |
1383 | ||
1384 | <UL> | |
1385 | ||
1386 | <P>The set of requested attributes and their current values for each | |
1387 | PPD file. | |
1388 | ||
1389 | </UL> | |
1390 | ||
1391 | <H2>CUPS-Move-Job Operation</H2> | |
1392 | ||
1393 | <P>The CUPS-Move-Job operation (0x400D) moves an active print job to a | |
1394 | different printer (CUPS 1.1 and higher). | |
1395 | ||
1396 | <H3>CUPS-Move-Job Request</H3> | |
1397 | ||
1398 | <P>The following groups of attributes are supplied as part of the | |
1399 | CUPS-Move-Job request: | |
1400 | ||
1401 | <P>Group 1: Operation Attributes | |
1402 | ||
1403 | <UL> | |
1404 | ||
1405 | <P>Natural Language and Character Set: | |
1406 | ||
1407 | <P>The "attributes-charset" and "attributes-natural-language" | |
1408 | attributes as described in section 3.1.4.1 of the IPP Model and | |
1409 | Semantics document. | |
1410 | ||
1411 | <P>"printer-uri" (uri) and "job-id" (integer) | |
1412 | <P><I>OR</I> | |
1413 | <P>"job-uri": | |
1414 | ||
1415 | <P>The client MUST supply a URI for the specified printer and | |
1416 | a job ID number, or the job URI. | |
1417 | ||
1418 | </UL> | |
1419 | ||
1420 | <P>Group 2: Job Template Attributes | |
1421 | ||
1422 | <UL> | |
1423 | ||
1424 | <P>"job-printer-uri" (uri) | |
1425 | ||
1426 | <P>The client MUST supply a URI for a printer on the same server. | |
1427 | ||
1428 | </UL> | |
1429 | ||
1430 | <H3>CUPS-Move-Job Response</H3> | |
1431 | ||
1432 | <P>The following groups of attributes are send as part of the | |
1433 | CUPS-Move-Job Response: | |
1434 | ||
1435 | <P>Group 1: Operation Attributes | |
1436 | ||
1437 | <UL> | |
1438 | ||
1439 | <P>Status Message: | |
1440 | ||
1441 | <P>The standard response status message. | |
1442 | ||
1443 | <P>Natural Language and Character Set: | |
1444 | ||
1445 | <P>The "attributes-charset" and "attributes-natural-language" | |
1446 | attributes as described in section 3.1.4.2 of the IPP Model and | |
1447 | Semantics document. | |
1448 | ||
1449 | </UL> | |
1450 | ||
1451 | <H1>Attributes</H1> | |
1452 | ||
1453 | <P>CUPS provides many extension attributes to support multiple devices, | |
1454 | PPD files, standard job filters, printers, and printer classes. | |
1455 | ||
1456 | <H2>Device Attributes</H2> | |
1457 | ||
1458 | <P>Device attributes are returned by the CUPS-Get-Devices operation and | |
1459 | enumerate all of the available hardware devices and network protocols | |
1460 | that are supported by the server. | |
1461 | ||
1462 | <H3>device-class (type2 keyword)</H3> | |
1463 | ||
1464 | <P>The device-class attribute specifies the class of device and can be | |
1465 | one of the following: | |
1466 | ||
1467 | <UL> | |
1468 | ||
1469 | <LI>"file" - a disk file. | |
1470 | ||
1471 | <LI>"direct" - a parallel or fixed-rate serial data port, | |
1472 | currently used for Centronics, IEEE-1284, and USB printer | |
1473 | ports. | |
1474 | ||
1475 | <LI>"serial" - a variable-rate serial port. | |
1476 | ||
1477 | <LI>"network" - a network connection, typically via AppSocket, | |
1478 | HTTP, IPP, LPD, or SMB/CIFS protocols. | |
1479 | ||
1480 | </UL> | |
1481 | ||
1482 | <H3>device-info (text(127))</H3> | |
1483 | ||
1484 | <P>The device-info attribute specifies a human-readable string describing | |
1485 | the device, e.g. "Parallel Port #1". | |
1486 | ||
1487 | <H3>device-make-and-model (text(127))</H3> | |
1488 | ||
1489 | <P>The device-makr-and-model attribute specifies a device | |
1490 | identification string provided by the printer connected to the device. | |
1491 | If the device or printer does not support identification then this | |
1492 | attribute contains the string "unknown". | |
1493 | ||
1494 | <H3>device-uri (uri)</H3> | |
1495 | ||
1496 | <P>The device-uri attribute specifies a unique identifier for the | |
1497 | device. The actual format of the device-uri string depends on the value | |
1498 | of the device-class attribute: | |
1499 | ||
1500 | <UL> | |
1501 | ||
1502 | <LI>"file" - The device-uri will be of the form | |
1503 | "file:/path/to/filename". | |
1504 | ||
1505 | <LI>"direct" - The device-uri will be of the form | |
1506 | "method:/dev/filename", where method may be "parallel" or "usb" | |
1507 | in the current implementation. | |
1508 | ||
1509 | <LI>"serial" - The device-uri will be of the form | |
1510 | "serial:/dev/filename?baud=value+parity=value+flow=value". | |
1511 | The baud value is the data rate in bits per second; the | |
1512 | supported values depend on the underlying hardware. | |
1513 | The parity value can be one of "none", "even", or "odd". | |
1514 | The flow value can be one of "none", "soft" (XON/XOFF | |
1515 | handshaking), "hard" or "rts/cts" (RTS/CTS handshaking), | |
1516 | or "dtrdsr" (DTR/DSR handshaking). | |
1517 | ||
1518 | <P>The URI returned by CUPS-Get-Devices will contain the | |
1519 | maximum baud rate supported by the device and the best | |
1520 | type of flow control available ("soft" or "hard"). | |
1521 | ||
1522 | <LI>"network" - The device-uri will be of the form | |
1523 | "method://[username:password@]hostname[:port]/[resource]", | |
1524 | where method may be "http", "ipp", "lpd", "smb", or | |
1525 | "socket" in the current implementation. | |
1526 | ||
1527 | <P>The URI returned by CUPS-Get-Devices will only contain | |
1528 | the method name followed by two slashes ("method://"). | |
1529 | It is up to the client application to add the appropriate | |
1530 | host and other information when adding a new printer. | |
1531 | ||
1532 | <P>The URI returned by Get-Printer-Attributes and | |
1533 | CUPS-Get-Printers has any username and password information | |
1534 | stripped; the information is still stored and used by the | |
1535 | server internally to perform any needed authentication. | |
1536 | ||
1537 | </UL> | |
1538 | ||
1539 | <H2>Job Template Attributes</H2> | |
1540 | ||
1541 | <H3>blackplot (boolean)</H3> | |
1542 | ||
1543 | <P>The blackplot attribute specifies whether HP-GL/2 plot files should be | |
1544 | rendered entirely in black ink (blackplot=true) or using the colors and shades | |
1545 | specified in the file (blackplot=false). The default value is false. | |
1546 | ||
1547 | <H3>brightness (integer(0:200))</H3> | |
1548 | ||
1549 | <P>The brightness attribute specifies the overall brightness of the printed | |
1550 | output in percent. A brightness of 100 is normal, while 200 is twice as | |
1551 | bright and 50 is half as bright. The default value is 100. | |
1552 | ||
1553 | <P>Brightness is applied to the Cyan, Magenta, Yellow, and Black values using | |
1554 | the function "f(x) = brightness / 100 * x". | |
1555 | ||
1556 | <H3>columns (integer(1:4))</H3> | |
1557 | ||
1558 | <P>The columns attribute specifies the number of columns to generate when | |
1559 | printing text files. The default value is 1. | |
1560 | ||
1561 | <H3>cpi (type2 enum)</H3> | |
1562 | ||
1563 | <P>The cpi attribute specifies the number of characters per inch when | |
1564 | printing text files. Only the values 10, 12, and 17 are currently | |
1565 | supported. The default value is 10. | |
1566 | ||
1567 | <H3>fitplot (boolean)</H3> | |
1568 | ||
1569 | <P>The fitplot attribute specifies whether to scale HP-GL/2 plot files to | |
1570 | fit on the selected media (fitplot=true) or use the physical scale specified | |
1571 | in the plot file (fitplot=false). The default value is false. | |
1572 | ||
1573 | <H3>gamma (integer(1:10000))</H3> | |
1574 | ||
1575 | <P>The gamma attribute specifies the luminance correction for the output. | |
1576 | A value of 1000 specifies no correction, while values of 2000 and 500 will | |
1577 | generate lighter and darker output, respectively. The default value is | |
1578 | 1000. | |
1579 | ||
1580 | <P>Gamma is applied to the Red, Green, and Blue values (or luminance for | |
1581 | grayscale output) using the function "f(x) = x<SUP>(1000/gamma)</SUP>". | |
1582 | ||
1583 | <H3>hue (integer(-180:180))</H3> | |
1584 | ||
1585 | <P>The hue attribute specifies a color hue rotation when printing image | |
1586 | files. The default value is 0. | |
1587 | ||
1588 | <H3>job-billing (text(MAX))</H3> | |
1589 | ||
1590 | <P><I>(CUPS 1.1 and higher)</I> | |
1591 | ||
1592 | <P>The job-billing attribute provides a text value to associate with a job | |
1593 | for billing purposes. | |
1594 | ||
1595 | <H3>job-hold-until (keyword | name(MAX))</H3> | |
1596 | ||
1597 | <P><I>(CUPS 1.1 and higher)</I> | |
1598 | ||
1599 | <P>The job-hold-until attribute specifies a hold time. In addition to the | |
1600 | standard IPP/1.1 keyword names, CUPS supports name values of the form | |
1601 | "HH:MM" and "HH:MM:SS" that specify a hold time. The hold time is in | |
1602 | Greenwich Mean Time (GMT) and <I>not</I> in the local time zone. If the | |
1603 | specified time is less than the current time, the job is held until the | |
1604 | next day. | |
1605 | ||
1606 | <H3>job-sheets (1setof type3 keyword | name(MAX))</H3> | |
1607 | ||
1608 | <P><I>(CUPS 1.1 and higher)</I> | |
1609 | ||
1610 | <P>The job-sheets attribute specifies one or two banner files that are printed | |
1611 | before and after a job. The reserved value of "none" disables banner printing. | |
1612 | The default value is stored in the job-sheets-default attribute. | |
1613 | ||
1614 | <P>If only one value is supplied, the banner file is printed before the job. | |
1615 | If two values are supplied, the first value is used as the starting banner | |
1616 | file and the second as the ending banner file. | |
1617 | ||
1618 | <H3>job-originating-host-name (name(MAX))</H3> | |
1619 | ||
1620 | <P><I>(CUPS 1.1.5 and higher)</I> | |
1621 | ||
1622 | <P>The job-originating-host-name attribute specifies the host | |
1623 | from which the job was queued. The value will be the hostname or | |
1624 | IP address of the client depending on whether hostname | |
1625 | resolution is enabled. The localhost address (127.0.0.1) is | |
1626 | <B>always</B> resolved to the name "localhost". | |
1627 | ||
1628 | <P>This attribute is read-only. | |
1629 | ||
1630 | <H3>lpi (type2 enum)</H3> | |
1631 | ||
1632 | <P>The lpi attribute specifies the number of lines per inch when | |
1633 | printing text files. Only the values 6 and 8 are currently supported. | |
1634 | The default value is 6. | |
1635 | ||
1636 | <H3>mirror (boolean)</H3> | |
1637 | ||
1638 | <P>The mirror attribute specifies whether pages are mirrored on | |
1639 | their X axis, which is useful for printing transfer images on | |
1640 | special media. The default value is false. | |
1641 | ||
1642 | <H3>natural-scaling (integer(1:1000))</H3> | |
1643 | ||
1644 | <P><I>(CUPS 1.1.9 and higher)</I> | |
1645 | ||
1646 | <P>The natural-scaling attribute specifies the scaling of image files with | |
1647 | respect to the natural image size. A value of 100 specifies that the image | |
1648 | file should exactly the natural size, while 50 is half the natural size | |
1649 | and 200 is twice the natural size. The default value is 100. | |
1650 | ||
1651 | <P>The ppi option can be used to override the natural resolution of the | |
1652 | image, which controls the natural size. | |
1653 | ||
1654 | <H3>number-up-layout (type2 keyword)</H3> | |
1655 | ||
1656 | <P><I>(CUPS 1.1.15 and higher)</I> | |
1657 | ||
1658 | <P>The number-up-layout attribute specifies the order each input | |
1659 | page is placed on each output page. The following keywords are | |
1660 | presently defined: | |
1661 | ||
1662 | <UL> | |
1663 | ||
1664 | <LI><CODE>btlr</CODE> - Bottom to top, left to right</LI> | |
1665 | ||
1666 | <LI><CODE>btrl</CODE> - Bottom to top, right to left</LI> | |
1667 | ||
1668 | <LI><CODE>lrbt</CODE> - Left to right, bottom to top</LI> | |
1669 | ||
1670 | <LI><CODE>lrtb</CODE> - Left to right, top to bottom (default)</LI> | |
1671 | ||
1672 | <LI><CODE>rlbt</CODE> - Right to left, bottom to top</LI> | |
1673 | ||
1674 | <LI><CODE>rltb</CODE> - Right to left, top to bottom</LI> | |
1675 | ||
1676 | <LI><CODE>tblr</CODE> - Top to bottom, left to right</LI> | |
1677 | ||
1678 | <LI><CODE>tbrl</CODE> - Top to bottom, right to left</LI> | |
1679 | ||
1680 | </UL> | |
1681 | ||
1682 | <H3>page-border (type2 keyword)</H3> | |
1683 | ||
1684 | <P><I>(CUPS 1.1.15 and higher)</I> | |
1685 | ||
1686 | <P>The page-border attribute specifies whether a border is | |
1687 | draw around each page. The following keywords are presently | |
1688 | defined: | |
1689 | ||
1690 | <UL> | |
1691 | ||
1692 | <LI><CODE>double</CODE> - Two hairline borders are drawn</LI> | |
1693 | ||
1694 | <LI><CODE>double-thick</CODE> - Two 1pt borders are drawn</LI> | |
1695 | ||
1696 | <LI><CODE>none</CODE> - No border is drawn (default)</LI> | |
1697 | ||
1698 | <LI><CODE>single</CODE> - A single hairline border is drawn</LI> | |
1699 | ||
1700 | <LI><CODE>single-thick</CODE> - A single 1pt border is drawn</LI> | |
1701 | ||
1702 | </UL> | |
1703 | ||
1704 | <H3>page-bottom (integer(0:MAX))</H3> | |
1705 | ||
1706 | <P>The page-bottom attribute specifies the bottom margin in points (72 points | |
1707 | equals 1 inch). The default value is the device physical margin. | |
1708 | ||
1709 | <H3>page-label (text(MAX))</H3> | |
1710 | ||
1711 | <P><I>(CUPS 1.1.7 and higher)</I> | |
1712 | ||
1713 | <P>The page-label attribute provides a text value to place in | |
1714 | the header and footer on each page. If a classification level is | |
1715 | set on the server, then this classification is printed before | |
1716 | the page label. | |
1717 | ||
1718 | <H3>page-left (integer(0:MAX))</H3> | |
1719 | ||
1720 | <P>The page-left attribute specifies the left margin in points (72 points | |
1721 | equals 1 inch). The default value is the device physical margin. | |
1722 | ||
1723 | <H3>page-right (integer(0:MAX))</H3> | |
1724 | ||
1725 | <P>The page-right attribute specifies the right margin in points (72 points | |
1726 | equals 1 inch). The default value is the device physical margin. | |
1727 | ||
1728 | <H3>page-set (type2 keyword)</H3> | |
1729 | ||
1730 | <P>The page-set attribute specifies which pages to print in a file. The | |
1731 | supported keywords are "all", "even", and "odd". The default value is | |
1732 | "all". | |
1733 | ||
1734 | <H3>page-top (integer(0:MAX))</H3> | |
1735 | ||
1736 | <P>The page-top attribute specifies the top margin in points (72 points | |
1737 | equals 1 inch). The default value is the device physical margin. | |
1738 | ||
1739 | <H3>penwidth (integer(0:MAX))</H3> | |
1740 | ||
1741 | <P>The penwidth attribute specifies the default pen width in micrometers | |
1742 | when printing HP-GL/2 plot files. The default value is 1000 (1 millimeter). | |
1743 | ||
1744 | <H3>position (type2 keyword)</H3> | |
1745 | ||
1746 | <P>The position attribute specifies the location of image files on the | |
1747 | media. The following keyword values are recognized: | |
1748 | ||
1749 | <UL> | |
1750 | ||
1751 | <LI><CODE>center</CODE> - Center the image on the page (default) | |
1752 | ||
1753 | <LI><CODE>top</CODE> - Print the image centered at the top of the page | |
1754 | ||
1755 | <LI><CODE>left</CODE> - Print the image centered on the left of page | |
1756 | ||
1757 | <LI><CODE>right</CODE> - Print the image centered on the right of the page | |
1758 | ||
1759 | <LI><CODE>top-left</CODE> - Print the image at the top left corner of | |
1760 | the page | |
1761 | ||
1762 | <LI><CODE>top-right</CODE> - Print the image at the top right corner of | |
1763 | the page | |
1764 | ||
1765 | <LI><CODE>bottom</CODE> - Print the image centered at the bottom of | |
1766 | the page | |
1767 | ||
1768 | <LI><CODE>bottom-left</CODE> - Print the image at the bottom left | |
1769 | corner of the page | |
1770 | ||
1771 | <LI><CODE>bottom-right</CODE> - Print the image at the bottom right | |
1772 | corner of the page | |
1773 | ||
1774 | </UL> | |
1775 | ||
1776 | <H3>ppi (integer(1:MAX))</H3> | |
1777 | ||
1778 | <P>The ppi attribute specifies the resolution of an image file in pixels | |
1779 | per inch. The default value is the resolution included with the file or | |
1780 | 128 if no resolution information is available. | |
1781 | ||
1782 | <H3>prettyprint (boolean)</H3> | |
1783 | ||
1784 | <P>The prettyprint attribute specifies whether text files should be printed | |
1785 | with a shaded header and keyword highlighting (prettyprint=true) or without | |
1786 | additional formatting (prettyprint=false). The default value is false. | |
1787 | ||
1788 | <H3>saturation (integer(0:200))</H3> | |
1789 | ||
1790 | <P>The saturation attribute specifies the color saturation when | |
1791 | printing image files. A saturation of 100 is normal, while values of 50 | |
1792 | and 200 will be half and twice as colorful, respectively. The default | |
1793 | value is 100. | |
1794 | ||
1795 | <H3>scaling (integer(1:1000))</H3> | |
1796 | ||
1797 | <P>The scaling attribute specifies the scaling of image files with | |
1798 | respect to the selected media. A value of 100 specifies that the image | |
1799 | file should fit 100% of the page, or as much as possible given the | |
1800 | image dimensions. The default value is unspecified. | |
1801 | ||
1802 | <P>The scaling attribute overrides the ppi attribute if specified. | |
1803 | ||
1804 | <H3>wrap (boolean)</H3> | |
1805 | ||
1806 | <P>The wrap attribute specifies whether long lines should be wrapped | |
1807 | (wrap=true) or not (wrap=false) when printing text files. The default | |
1808 | value is true. | |
1809 | ||
1810 | <H2>PPD Attributes</H2> | |
1811 | ||
1812 | <H3>ppd-natural-language (naturalLanguage)</H3> | |
1813 | ||
1814 | <P>The ppd-natural-language attribute specifies the language encoding | |
1815 | of the PPD file (the LanguageVersion attribute in the PPD file). If the | |
1816 | language is unknown or undefined then "en" (English) is assumed. | |
1817 | ||
1818 | <H3>ppd-make (text(127))</H3> | |
1819 | ||
1820 | <P>The ppd-make attribute specifies the manufacturer of the printer | |
1821 | (the Manufacturer attribute in the PPD file). If the manufacturer | |
1822 | is not specified in the PPD file then an educated guess is made using | |
1823 | the NickName attribute in the PPD file. | |
1824 | ||
1825 | <H3>ppd-make-and-model (text(127))</H3> | |
1826 | ||
1827 | <P>The ppd-make-and-model attribute specifies the manufacturer and model | |
1828 | name of the PPD file (the NickName attribute in the PPD file). If the | |
1829 | make and model is not specified in the PPD file then the ModelName or | |
1830 | ShortNickName attributes are used instead. | |
1831 | ||
1832 | <H3>ppd-name (name(255))</H3> | |
1833 | ||
1834 | <P>The ppd-name attribute specifies the PPD filename on the server | |
1835 | relative to the model directory. The forward slash (/) is used to | |
1836 | delineate directories. | |
1837 | ||
1838 | <H2>Printer Attributes</H2> | |
1839 | ||
1840 | <H3>job-k-limit (integer)</H3> | |
1841 | ||
1842 | <P><I>(CUPS 1.1 and higher)</I> | |
1843 | ||
1844 | <P>The job-k-limit attribute specifies the maximum number of kilobytes that | |
1845 | may be printed by a user, including banner files. The default value of 0 | |
1846 | specifies that there is no limit. | |
1847 | ||
1848 | <H3>job-page-limit (integer)</H3> | |
1849 | ||
1850 | <P><I>(CUPS 1.1 and higher)</I> | |
1851 | ||
1852 | <P>The job-page-limit attribute specifies the maximum number of pages that | |
1853 | may be printed by a user, including banner files. The default value of 0 | |
1854 | specifies that there is no limit. | |
1855 | ||
1856 | <H3>job-quota-period (integer)</H3> | |
1857 | ||
1858 | <P><I>(CUPS 1.1 and higher)</I> | |
1859 | ||
1860 | <P>The job-quota-period attribute specifies the time period used for quota | |
1861 | calculations, in seconds. The default value of 0 specifies that the limits | |
1862 | apply to all jobs that have been printed by a user that are still known to | |
1863 | the system. | |
1864 | ||
1865 | <H3>job-sheets-supported (1setof type3 keyword | name(MAX))</H3> | |
1866 | ||
1867 | <P><I>(CUPS 1.1 and higher)</I> | |
1868 | ||
1869 | <P>The job-sheets-supported attribute specifies the available banner files. | |
1870 | There will always be at least one banner file available called "none". | |
1871 | ||
1872 | <H3>printer-type (type2 enum)</H3> | |
1873 | ||
1874 | <P>The printer-type attribute specifies printer type and capability bits for | |
1875 | the printer or class. The default value is computed from internal state | |
1876 | information and the PPD file for the printer. The following bits are defined: | |
1877 | ||
1878 | <CENTER><TABLE WIDTH="80%" BORDER> | |
1879 | <TR> | |
1880 | <TH>Bit</TH> | |
1881 | <TH>Description</TH> | |
1882 | </TR> | |
1883 | <TR> | |
1884 | <TD VALIGN="TOP">0x00000001</TD> | |
1885 | <TD VALIGN="TOP">Is a printer class.</TD> | |
1886 | </TR> | |
1887 | <TR> | |
1888 | <TD VALIGN="TOP">0x00000002</TD> | |
1889 | <TD VALIGN="TOP">Is a remote destination.</TD> | |
1890 | </TR> | |
1891 | <TR> | |
1892 | <TD VALIGN="TOP">0x00000004</TD> | |
1893 | <TD VALIGN="TOP">Can print in black.</TD> | |
1894 | </TR> | |
1895 | <TR> | |
1896 | <TD VALIGN="TOP">0x00000008</TD> | |
1897 | <TD VALIGN="TOP">Can print in color.</TD> | |
1898 | </TR> | |
1899 | <TR> | |
1900 | <TD VALIGN="TOP">0x00000010</TD> | |
1901 | <TD VALIGN="TOP">Can print on both sides of the page in hardware.</TD> | |
1902 | </TR> | |
1903 | <TR> | |
1904 | <TD VALIGN="TOP">0x00000020</TD> | |
1905 | <TD VALIGN="TOP">Can staple output.</TD> | |
1906 | </TR> | |
1907 | <TR> | |
1908 | <TD VALIGN="TOP">0x00000040</TD> | |
1909 | <TD VALIGN="TOP">Can do fast copies in hardware.</TD> | |
1910 | </TR> | |
1911 | <TR> | |
1912 | <TD VALIGN="TOP">0x00000080</TD> | |
1913 | <TD VALIGN="TOP">Can do fast copy collation in hardware.</TD> | |
1914 | </TR> | |
1915 | <TR> | |
1916 | <TD VALIGN="TOP">0x00000100</TD> | |
1917 | <TD VALIGN="TOP">Can punch output.</TD> | |
1918 | </TR> | |
1919 | <TR> | |
1920 | <TD VALIGN="TOP">0x00000200</TD> | |
1921 | <TD VALIGN="TOP">Can cover output.</TD> | |
1922 | </TR> | |
1923 | <TR> | |
1924 | <TD VALIGN="TOP">0x00000400</TD> | |
1925 | <TD VALIGN="TOP">Can bind output.</TD> | |
1926 | </TR> | |
1927 | <TR> | |
1928 | <TD VALIGN="TOP">0x00000800</TD> | |
1929 | <TD VALIGN="TOP">Can sort output.</TD> | |
1930 | </TR> | |
1931 | <TR> | |
1932 | <TD VALIGN="TOP">0x00001000</TD> | |
1933 | <TD VALIGN="TOP">Can handle media up to US-Legal/A4.</TD> | |
1934 | </TR> | |
1935 | <TR> | |
1936 | <TD VALIGN="TOP">0x00002000</TD> | |
1937 | <TD VALIGN="TOP">Can handle media from US-Legal/A4 to ISO-C/A2.</TD> | |
1938 | </TR> | |
1939 | <TR> | |
1940 | <TD VALIGN="TOP">0x00004000</TD> | |
1941 | <TD VALIGN="TOP">Can handle media larger than ISO-C/A2.</TD> | |
1942 | </TR> | |
1943 | <TR> | |
1944 | <TD VALIGN="TOP">0x00008000</TD> | |
1945 | <TD VALIGN="TOP">Can handle user-defined media sizes.</TD> | |
1946 | </TR> | |
1947 | <TR> | |
1948 | <TD VALIGN="TOP">0x00010000</TD> | |
1949 | <TD VALIGN="TOP">Is an implicit (server-generated) class.</TD> | |
1950 | </TR> | |
1951 | </TABLE></CENTER> | |
1952 | ||
1953 | <H3>printer-type-mask (type2 enum)</H3> | |
1954 | ||
1955 | <P><I>(CUPS 1.1 and higher)</I> | |
1956 | ||
1957 | <P>The printer-type-mask attribute is used to choose printers or classes with | |
1958 | the CUPS-Get-Printers and CUPS-Get-Classes operations. The bits are defined | |
1959 | identically to the printer-type attribute and default to all 1's. | |
1960 | ||
1961 | <H3>requesting-user-name-allowed (1setof name(127))</H3> | |
1962 | ||
1963 | <P><I>(CUPS 1.1 and higher)</I> | |
1964 | ||
1965 | <P>The requesting-user-name-allowed attribute lists all of the users that are | |
1966 | allowed to access a printer or class. Either this attribute or the | |
1967 | requesting-user-name-denied attribute will be defined, but not both. | |
1968 | ||
1969 | <H3>requesting-user-name-denied (1setof name(127))</H3> | |
1970 | ||
1971 | <P><I>(CUPS 1.1 and higher)</I> | |
1972 | ||
1973 | <P>The requesting-user-name-denied attribute lists all of the users that are | |
1974 | not allowed to access a printer or class. Either this attribute or the | |
1975 | requesting-user-name-allowed attribute will be defined, but not both. | |
1976 | ||
1977 | <H2>Printer Class Attributes</H2> | |
1978 | ||
1979 | <H3>member-names (1setof name(127))</H3> | |
1980 | ||
1981 | <P>The member-names attribute specifies each of the printer-name attributes of | |
1982 | the member printers and classes. Each name corresponds to the same element of | |
1983 | the member-uris attribute. | |
1984 | ||
1985 | <H3>member-uris (1setof uri)</H3> | |
1986 | ||
1987 | <P>The member-uris attribute specifies each of the printer-uri attributes of | |
1988 | the member printers and classes. Each URI corresponds to the same element of | |
1989 | the member-names attribute. | |
1990 | ||
1991 | <EMBED SRC="glossary.shtml"> | |
1992 | ||
1993 | </BODY> | |
1994 | </HTML> |