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