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
|
<!DOCTYPE HTML>
<html>
<!-- SECTION: Specifications -->
<head>
<title>CUPS Implementation of IPP</title>
<meta name='keywords' content='Programming, Internet Printing Protocol'>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
</head>
<body>
<!--
IPP specification for CUPS.
Copyright 2007-2016 by Apple Inc.
Copyright 1997-2007 by Easy Software Products.
These coded instructions, statements, and computer programs are the
property of Apple Inc. 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
file is missing or damaged, see the license at "http://www.cups.org/".
-->
<H1 CLASS="title">CUPS Implementation of IPP</H1>
<h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2>
<p>CUPS implements <a href="http://ftp.pwg.org/pub/pwg/standards/std-ipp20-20151030-5100.12.pdf">IPP/2.1</a> and the operations and attributes defined in the following specifications:</p>
<ul>
<li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext10-20101030-5100.11.pdf">PWG 5100.11: IPP Job and Printer Extensions - Set 2 (JPS2)</a> (all operations plus the "job-creation-attributes-supported", "job-ids", "job-password", "job-password-encryption", "media-col-database", and "which-jobs" attributes)</li>
<li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext3v10-20120727-5100.13.pdf">PWG 5100.13: IPP Job and Printer Extensions - Set 3 (JPS3)</a> (all operations/attributes required for IPP Everywhere except "printer-geo-location" and "printer-icc-profiles")</li>
<li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ippeve10-20130128-5100.14.pdf">PWG 5100.14: IPP Everywhere</a> (conforming to the Client and most of the Printer requirements)</li>
<li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ippfaxout10-20140618-5100.15.pdf">PWG 5100.15: IPP FaxOut Service</a> (for facsimile queues)</li>
<li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ipptrans10-20131108-5100.16.pdf">PWG 5100.16: IPP Transaction-Based Printing Extensions</a></li>
<li><a href="http://tools.ietf.org/html/rfc3998">RFC 3998: IPP Job and Printer Administrative Operations</a> (Disable-Printer, Enable-Printer, Hold-New-Jobs, and Release-Held-New-Jobs operations)</li>
<li><a href="http://tools.ietf.org/html/rfc7472">RFC 7472: IPP over HTTPS Transport Binding and 'ipps' URI Scheme</a></li>
</ul>
<p>CUPS also provides 17 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", "ipp", and "ipps" 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.example.com/printers/LaserJet". In addition, the CUPS scheduler also supports (when enabled) normal browser access via "http://foo.example.com:port/" and "https://foo.example.com:port/".</p>
<h3 class='title'><a name='IPP_OPERATIONS'>CUPS IPP Operations</a></h3>
<p>CUPS provides 17 vendor extension operations in addition to most of the standard IPP and registered extension operations:</p>
<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>Print-Job</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>Create-Job</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>Set-Printer-Attributes</td>
<td>1.4</td>
<td>0x0013</td>
<td>Set attributes for a printer.</td>
</tr>
<tr>
<td>Set-Job-Attributes</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>Hold-New-Jobs</td>
<td>1.4</td>
<td>0x0025</td>
<td>Hold new jobs by default.</td>
</tr>
<tr>
<td>Release-Held-New-Jobs</td>
<td>1.4</td>
<td>0x0026</td>
<td>Releases all jobs that were previously held.</td>
</tr>
<tr>
<td>Cancel-Jobs</td>
<td>1.5</td>
<td>0x0038</td>
<td>Cancel all jobs (administrator).</td>
</tr>
<tr>
<td>Cancel-My-Jobs</td>
<td>1.5</td>
<td>0x0039</td>
<td>Cancel all jobs (user).</td>
</tr>
<tr>
<td>Close-Job</td>
<td>1.5</td>
<td>0x003b</td>
<td>Close a created job.</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>CUPS-Accept-Jobs</td>
<td>1.0</td>
<td>0x4008</td>
<td>Accept jobs on a printer or printer class. This operation is deprecated - use the Enable-Printer operation instead.</td>
</tr>
<tr>
<td>CUPS-Reject-Jobs</td>
<td>1.0</td>
<td>0x4009</td>
<td>Reject jobs on a printer or printer class. This operation is deprecated - use the Disable-Printer operation instead.</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>
<tr>
<td><a href='#CUPS_CREATE_LOCAL_PRINTER'>CUPS-Create-Local-Printer</a></td>
<td>2.2</td>
<td>0x4028</td>
<td>Creates a local (temporary) print queue pointing to a remote IPP Everywhere printer.</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='CANCEL_JOB'>Cancel Job Operation (Extension)</a></h3>
<p>The Cancel-Job operation (0x0008) cancels the specified job. CUPS 1.4 added support for the <tt>purge-job (boolean)</tt> operation attribute that (if 'true') removes all history and document files for the job as well.</p>
<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. CUPS 1.2 added support for the <tt>purge-job (boolean)</tt> operation attribute that (if 'false') retains all history and document files for the canceled jobs.</p>
<blockquote><b>Note:</b>
<p>The Cancel-Jobs and Cancel-My-Jobs operations should be used instead of Purge-Jobs.</p>
</blockquote>
<h3 class='title'><span class='info'>CUPS 1.2/macOS 10.5</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. CUPS adds the following <tt>notify-events (1setOf type2 keyword)</tt> values:<p>
<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>
<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>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>Status Message:
<dd>The standard response status message.
</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>"first-printer-name" (name(127)): <span class='info'>CUPS 1.2/macOS 10.5</span>
<dd>The client OPTIONALLY supplies this attribute to select the first printer that is returned.
<dt>"limit" (integer (1:MAX)):
<dd>The client OPTIONALLY supplies this attribute limiting the number of printers that are returned.
<dt>"printer-id" (integer(0:65535)): <span class='info'>CUPS 2.2</span>
<dd>The client OPTIONALLY supplies this attribute to select which printer is 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'.
<dt>"requested-user-name" (name(127)): <span class='info'>CUPS 1.2/macOS 10.5</span>
<dd>The client OPTIONALLY supplies a user name that is used to filter the returned printers.
</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>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>Status Message:
<dd>The standard response status message.
</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/macOS 10.5</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(255)):
<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 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(3)' and 'stopped(5)' 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 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>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>Status Message:
<dd>The standard response status message.
</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>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>Status Message:
<dd>The standard response status message.
</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>"first-printer-name" (name(127)): <span class='info'>CUPS 1.2/macOS 10.5</span>
<dd>The client OPTIONALLY supplies this attribute to select the first printer that is returned.
<dt>"limit" (integer (1:MAX)):
<dd>The client OPTIONALLY supplies this attribute limiting the number of printer classes that 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'.
<dt>"requested-user-name" (name(127)): <span class='info'>CUPS 1.2/macOS 10.5</span>
<dd>The client OPTIONALLY supplies a user name that is used to filter the returned printers.
</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>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>Status Message:
<dd>The standard response status message.
</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/macOS 10.5</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 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(3)' and 'stopped(5)' 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>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>Status Message:
<dd>The standard response status message.
</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>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>Status Message:
<dd>The standard response status message.
</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>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>Status Message:
<dd>The standard response status message.
</dl>
<h3 class='title'><span class='info'>Deprecated</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/macOS 10.6</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 specified by the "include-schemes" attribute.
<dt>"include-schemes" (1setOf name): <span class='info'>CUPS 1.4/macOS 10.6</span>
<dd>The client OPTIONALLY supplies a set of scheme names that the requestor wants to discover. If the client omits this attribute, the server responds with devices of all schemes except those specified by the "exclude-schemes" attribute.
<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/macOS 10.6</span>
<dd>The client OPTIONALLY supplies this attribute to limit the duration of the lookup. The default timeout is 15 seconds.
</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>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>Status Message:
<dd>The standard response status message.
</dl>
<p>Groups 2-N: Device Object Attributes (using printer-attributes-tag group)
<dl>
<dt>The set of requested attributes and their current values for
each device.
</dl>
<h3 class='title'><span class='info'>Deprecated</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>"exclude-schemes" (1setOf name): <span class='info'>CUPS 1.4/macOS 10.6</span>
<dd>The client OPTIONALLY supplies a set of scheme names that the requestor does not want to list. If the client omits this attribute, the server responds with PPDs of all schemes specified by the "include-schemes" attribute.
<dt>"include-schemes" (1setOf name): <span class='info'>CUPS 1.4/macOS 10.6</span>
<dd>The client OPTIONALLY supplies a set of scheme names that the requestor wants to list. If the client omits this attribute, the server responds with PPDs of all schemes except those specified by the "exclude-schemes" attribute.
<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/macOS 10.5</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/macOS 10.5</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/macOS 10.5</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/macOS 10.5</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/macOS 10.5</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/macOS 10.5</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>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>Status Message:
<dd>The standard response status message.
</dl>
<p>Groups 2-N: PPD Attributes (using printer-attributes-tag group)
<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 or all print jobs for a printer 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)
<br><i>OR</i>
<dt>"printer-uri" (uri) and "job-id" (integer)
<br><i>OR</i>
<br>"job-uri" (uri):
<dd>The client MUST supply a URI for the specified printer, the URI for the specified printer and a job ID number, or the job URI.
</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/macOS 10.5</span><a name='CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job Operation</a></h3>
<p>The CUPS-Authenticate-Job operation (0x400E) authenticates a print job for printing, releasing the job if it is held. Typically this is used when printing to a remote server. The authentication information is passed in the HTTP request; the HTTP connection is normally encrypted for this type of request.</p>
<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" (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/macOS 10.5</span>
<dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute.
<dt>"job-hold-until" (keyword | name(MAX)): <span class='info'>CUPS 1.3/macOS 10.5</span>
<dd>The client OPTIONALLY supplies a new job-hold-until value for the job. If specified and not the "no-hold" value, the job is held instead of released for printing.
</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>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>Status Message:
<dd>The standard response status message.
</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'>Deprecated</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>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>Status Message:
<dd>The standard response status message.
<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/macOS 10.6</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>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>Status Message:
<dd>The standard response status message.
<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>
<h3 class='title'><a name='CUPS_CREATE_LOCAL_PRINTER'>CUPS-Create-Local-Printer</a></h3>
<p>The CUPS-Create-Local-Printer operation (0x4028) creates a local (temporary) print queue pointing to a remote IPP Everywhere Printer. The queue will remain until the scheduler idle exits, is restarted, or the system is restarted or shutdown. Temporary print queues can be made permanent by an administrator by setting the "printer-is-shared" attribute to 'true'.</p>
<p>At a minimum, the scheduler requires a name and URI for the Printer to add. When successful, the local "printer-uri" values are returned and may be used by the Client to submit Job Creation Requests, monitor for state changes, and so forth.</p>
<p>If the named printer already exists, the scheduler will reject the request with the 'client-error-not-possible' status code.</p>
<p>Access Rights: The authenticated user performing this operation MUST be a Local User of the system, and the request MUST be made over a local (domain socket or loopback interface) address. Otherwise, the request will be rejected with the 'client-error-forbidden' status code.</p>
<h4>CUPS-Create-Local-Printer Request</h4>
<p>The following group of attributes is supplied as part of the CUPS-Create-Local-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.
</dl>
<p>Group 2: Printer Attributes
<dl>
<dt>"printer-name" (name(127)):
<dd>The Client MUST supply this attribute which provides the name for the new Printer.
<dt>"device-uri" (uri):
<dd>The Client MUST supply this attribute which provides an "ipp" or "ipps" URI pointing to an IPP Everywhere Printer.
<dt>"printer-device-id" (text(1023)):
<dd>The Client OPTIONALLY supplies this attribute which provides the IEEE 1284 device ID for the new Printer.
<dt>"printer-geo-location" (uri):
<dd>The Client OPTIONALLY supplies this attribute which provides the geo-location of the new Printer as a "geo" URI.
<dt>"printer-info" (text(127)):
<dd>The Client OPTIONALLY supplies this attribute which provides the description for the new Printer.
<dt>"printer-location" (text(127)):
<dd>The Client OPTIONALLY supplies this attribute which provides the location of the new Printer.
</dl>
<h4>CUPS-Create-Local-Printer Response</h4>
<p>The following group of attributes is sent as part of the CUPS-Create-Local-Printer Response:
<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.2 of the IPP Model and Semantics document.
<dt>Status Message:
<dd>The standard response status message.
</dl>
<p>Group 2: Printer Attributes
<dl>
<dt>"printer-id" (integer(0:65535)):
<dd>The numeric identifier for the created Printer.
<dt>"printer-is-accepting-jobs" (boolean):
<dd>Whether the created Printer is accepting jobs at the time of the response.
<dt>"printer-state" (type1 enum):
<dd>The state of the created Printer at the time of the response.
<dt>"printer-state-reasons" (1setOf type2 keyword):
<dd>The state keywords for the created Printer at the time of the response.
<dt>"printer-uri-supported" (1setOf uri):
<dd>The URIs for the created Printer.
</dl>
<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><span class="info">Deprecated</span></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. Device attributes are reported in the printer-attributes-tag group.</p>
<h4><a name="device-class">device-class (type2 keyword)</a><span class="info">Deprecated</span></h4>
<p>The "device-class" attribute provides 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(1023))</a><span class="info">Deprecated</span></h4>
<p>The "device-id" attribute provides the IEEE-1284 device ID string for the device.</p>
<h4><a name="device-info">device-info (text(127))</a><span class="info">Deprecated</span></h4>
<p>The "device-info" attribute specifies a human-readable string describing the device, e.g., 'Parallel Port #1'.
<h4><a name="device-location">device-location (text(127))</a><span class="info">Deprecated</span></h4>
<p>The "device-location" attribute specifies the physical location of the printer, e.g., '2nd Floor Computer Lab'.
<h4><a name="device-make-and-model">device-make-and-model (text(127))</a><span class="info">Deprecated</span></h4>
<p>The "device-make-and-model" attribute specifies a device identification string provided by the printer connected to the device. If the device or printer does not support identification then this attribute contains the string 'unknown'.
<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 MAY only contain the scheme name ('scheme'). It is up to the client application to add the appropriate host and other information when adding a new printer.
<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_ATTRIBUTES'>Job Attributes</a></h3>
<h4><a name="auth-info">auth-info (1setOf text(MAX))</a><span class="info">CUPS 1.3/macOS 10.5</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="job-cancel-after">job-cancel-after (integer(1:MAX))</a><span class='info'>CUPS 2.0</span></h4>
<p>The "job-cancel-after" attribute provides the maximum number of seconds that are allowed for processing a job.</p>
<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-media-progress">job-media-progress (integer(0:100))</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
<p>The "job-media-progress" status attribute specifies the percentage of completion of the current page. It is only valid when the "job-state" attribute has the 'processing(5)' value.</p>
<h4><a name="job-printer-state-message">job-printer-state-message (text(MAX))</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
<p>The "job-printer-state-message" status attribute provides the last known value of the "printer-state-message" attribute for the printer that processed (or is processing) the job.</p>
<h4><a name="job-printer-state-reasons">job-printer-state-reasons (1setOf type2 keyword)</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
<p>The "job-printer-state-reasons" status attribute provides the last known value of the "printer-state-reasons" attribute for the printer that processed (or is processing) the job.</p>
<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><span class='info'>CUPS 1.1.5/macOS 10.2</span></h4>
<p>The "job-originating-host-name" status attribute specifies the host from which the job was queued. The value will be the hostname or IP address of the client depending on whether hostname resolution is enabled. The localhost address (127.0.0.1) is <b>always</b> resolved to the name "localhost".
<p>This attribute is read-only.
<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>'double': Two hairline borders are drawn</li>
<li>'double-thick': Two 1pt borders are drawn</li>
<li>'none': No border is drawn (default)</li>
<li>'single': A single hairline border is drawn</li>
<li>'single-thick': A single 1pt border is drawn</li>
</ul>
<h4><a name="page-set">page-set (type2 keyword)</a><span class="info">Deprecated</span></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'.
<h3 class='title'><a name='PPD_ATTRIBUTES'>PPD Attributes</a><span class="info">Deprecated</span></h3>
<p>PPD attributes are returned in the printer-attributes-tag group.
<h4><a name="ppd-device-id">ppd-device-id (text(127))</a><span class="info">Deprecated</span></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><span class="info">Deprecated</span></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><span class="info">Deprecated</span></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">Deprecated</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><span class="info">Deprecated</span></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><span class="info">Deprecated</span></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><span class="info">Deprecated</span></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">Deprecated</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">Deprecated</span></h4>
<p>The "ppd-type" attribute specifies the type of driver described by the PPD file:</p>
<ul>
<li>'fax': A facsimile or multi-function device</li>
<li>'pdf': A PDF printer</li>
<li>'postscript': A PostScript printer (no filters)</li>
<li>'raster': A CUPS raster driver</li>
<li>'unknown': 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/macOS 10.5</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>'domain': A domain name is required.</li>
<li>'none': No authentication is required - this keyword can only appear by itself.</li>
<li>'password': A password is required.</li>
<li>'username': 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="marker-change-time">marker-change-time (integer)</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
<p>The "marker-change-time" status attribute specifies the "printer-up-time" value when the last change to the marker-colors, marker-levels, marker-message, marker-names, or marker-types attributes was made.</p>
<h4><a name="marker-colors">marker-colors (1setof name(MAX))</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
<p>The "marker-colors" status attribute specifies the color(s) for each supply in the printer. It is only available when the driver provides supply levels. The color is either 'none' or one or more hex-encoded sRGB colors of the form '#RRGGBB'.</p>
<h4><a name="marker-high-levels">marker-high-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
<p>The "marker-high-levels" status attribute specifies the supply levels that indicate a near-full condition. A value of 100 should be used for supplies that are consumed/emptied, e.g. ink cartridges.</p>
<h4><a name="marker-levels">marker-levels (1setof integer(-3:100))</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
<p>The "marker-levels" status attribute specifies the current supply levels for the printer. It is only available when the driver provides supply levels. A value of -1 indicates the level is unavailable, -2 indicates unknown, and -3 indicates the level is unknown but has not yet reached capacity. Values from 0 to 100 indicate the corresponding percentage.</p>
<h4><a name="marker-low-levels">marker-low-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
<p>The "marker-low-levels" status attribute specifies the supply levels that indicate a near-empty condition. A value of 0 should be used for supplies that are filled, e.g. waste ink tanks.</p>
<h4><a name="marker-message">marker-message (text(MAX))</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
<p>The "marker-message" status attribute provides a human-readable status message for the current supply levels, e.g. "12 pages of ink remaining." It is only available when the driver provides supply levels.</p>
<h4><a name="marker-names">marker-names (1setof name(MAX))</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
<p>The "marker-names" status attribute specifies the name(s) for each supply in the printer. It is only available when the driver provides supply levels.</p>
<h4><a name="marker-types">marker-types (1setof type3 keyword)</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
<p>The "marker-types" status attribute specifies the type(s) of each supply in the printer. It is only available when the driver provides supply levels. The following (RFC 3805) types are currently supported:</p>
<ul>
<li>'toner'</li>
<li>'waste-toner'</li>
<li>'ink'</li>
<li>'ink-cartridge'</li>
<li>'ink-ribbon'</li>
<li>'waste-ink'</li>
<li>'opc'</li>
<li>'developer'</li>
<li>'fuser-oil'</li>
<li>'solid-wax'</li>
<li>'ribbon-wax'</li>
<li>'waste-wax'</li>
<li>'fuser'</li>
<li>'corona-wire'</li>
<li>'fuser-oil-wick'</li>
<li>'cleaner-unit'</li>
<li>'fuser-cleaning-pad'</li>
<li>'transfer-unit'</li>
<li>'toner-cartridge'</li>
<li>'fuser-oiler'</li>
<li>'water'</li>
<li>'waste-water'</li>
<li>'binding-supply'</li>
<li>'banding-supply'</li>
<li>'stiching-wire'</li>
<li>'shrink-wrap'</li>
<li>'paper-wrap'</li>
<li>'staples'</li>
<li>'inserts'</li>
<li>'covers'</li>
</ul>
<h4><a name="port-monitor">port-monitor" (name(127))</a><span class="info">Deprecated</span></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><span class="info">Deprecated</span></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'>Deprecated</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/macOS 10.6</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 no-value value.</p>
<h4><a name="printer-id">printer-id (integer(0:65535)</a><span class="info">CUPS 2.2</span></h4>
<p>The "printer-id" status attribute provides a unique integer identifying the printer. It is used when only an IP address and integer are provided for identifying a print queue.</p>
<h4><a name="printer-type">printer-type (type2 enum)</a></h4>
<p>The "printer-type" status attribute specifies printer type and capability bits for the printer or class. The default value is computed from internal state information and the PPD file for the printer. The following bits are defined:</p>
<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>
<tr>
<td>0x02000000</td>
<td>Queue is a scanner with no printing capabilities.</td>
</tr>
<tr>
<td>0x04000000</td>
<td>Queue is a printer with scanning capabilities.</td>
</tr>
<tr>
<td>0x08000000</td>
<td>Queue is a printer with 3D capabilities.</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>
<p>Printer class attributes are placed in the printer-attributes-tag group.</p>
<h4>member-names (1setof name(127))</h4>
<p>The "member-names" attribute specifies the "printer-name" attributes for each the member printer and class. Each name corresponds to the same element of the "member-uris" attribute.
<h4>member-uris (1setof uri)</h4>
<p>The "member-uris" attribute specifies the "printer-uri-supported" values for each member printer and class. Each URI corresponds to the same element of the "member-names" attribute.
</body>
</html>
|
