doc/help/spec-ipp.html

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