doc/help/spec-ipp.html

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