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 the Common UNIX Printing System (CUPS).
  14
  15   Copyright 2007-2008 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/1.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</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</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 Set-Job-Attributes 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</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</span>"purge-jobs" (boolean):
 636
 637         <dd>The client OPTIONALLY supplies this attribute to specify
 638         whether the jobs are purged (true) or just canceled (false).
 639         The default is true.
 640
 641 </dl>
 642
 643 <h4>Purge-Jobs Response</h4>
 644
 645 <p>The following groups of attributes are send as part of the Purge-Jobs
 646 Response:
 647
 648 <p>Group 1: Operation Attributes
 649
 650 <dl>
 651
 652         <dt>Status Message:
 653
 654         <dd>The standard response status message.
 655
 656         <dt>Natural Language and Character Set:
 657
 658         <dd>The "attributes-charset" and "attributes-natural-language"
 659         attributes as described in section 3.1.4.2 of the IPP Model and
 660         Semantics document.
 661
 662 </dl>
 663
 664 <h3 class='title'><span class='info'>CUPS 1.1</span><a name='SET_JOB_ATTRIBUTES'>Set-Job-Attributes Operation</a></h3>
 665
 666 <p>The Set-Job-Attributes operation (0x0014) changes the attributes of
 667 an active (not completed) job.
 668
 669 <h4>Set-Job-Attributes Request</h4>
 670
 671 <p>The following groups of attributes are supplied as part of the
 672 Set-Job-Attributes request:
 673
 674 <p>Group 1: Operation Attributes
 675
 676 <dl>
 677
 678         <dt>Natural Language and Character Set:
 679
 680         <dd>The "attributes-charset" and "attributes-natural-language"
 681         attributes as described in section 3.1.4.1 of the IPP Model and
 682         Semantics document.
 683
 684         <dt>"printer-uri" (uri) and "job-id" (integer)
 685         <br><i>OR</i>
 686         <br>"job-uri":
 687
 688         <dd>The client MUST supply a URI for the specified printer and
 689         a job ID number, or the job URI.
 690
 691 </dl>
 692
 693 <p>Group 2: Job Template Attributes
 694
 695 <dl>
 696
 697         <dt>"job-sheets" (1setof type3 keyword | name(MAX)):<span class='info'>CUPS 1.1</span>
 698
 699         <dd>The client OPTIONALLY supplies one or two banner pages that
 700         are printed before and after any files in the print job. The
 701         name of "none" is reserved to indicate that no banner page
 702         should be printed. If the client does not specify this
 703         attribute then the value of the "job-sheets-default" printer
 704         object attribute is used.
 705
 706         <blockquote><b>Note:</b> Standard IPP only allows
 707         specification of a single job-sheets attribute
 708         value.</blockquote>
 709
 710         <dt>"media" (1setof type3 keyword | name(MAX)):
 711
 712         <dd>The client OPTIONALLY supplies one or more media attributes
 713         specifying the size, type, source, and color of the output
 714         media. If the client does not specify this attribute then the
 715         value of the "media-default" printer object attribute is used.
 716
 717         <blockquote><b>Note:</b> Standard IPP only allows
 718         specification of a single media attribute
 719         value.</blockquote>
 720
 721         <dt>Other Job Template Attributes
 722
 723 </dl>
 724
 725 <h4>Set-Job-Attributes Response</h4>
 726
 727 <p>The following groups of attributes are send as part of the Set-Job-Attributes
 728 Response:
 729
 730 <p>Group 1: Operation Attributes
 731
 732 <dl>
 733
 734         <dt>Status Message:
 735
 736         <dd>The standard response status message.
 737
 738         <dt>Natural Language and Character Set:
 739
 740         <dd>The "attributes-charset" and "attributes-natural-language"
 741         attributes as described in section 3.1.4.2 of the IPP Model and
 742         Semantics document.
 743
 744 </dl>
 745
 746 <h3 class='title'><span class='info'>CUPS 1.2</span><a
 747 name='CREATE_PRINTER_SUBSCRIPTION'>Create-Printer-Subscription</a></h3>
 748
 749 <p>The Create-Printer-Subscription operation (0x0016) creates a
 750 subscription for printer or server event notifications. CUPS
 751 provides several additional events in addition to the standard
 752 events in the IPP notifications specification.</p>
 753
 754 <h4>Create-Printer-Subscription Request</h4>
 755
 756 <p>The following groups of attributes are supplied as part of the
 757 request:</p>
 758
 759 <p>Group 1: Operation Attributes</p>
 760
 761 <dl>
 762
 763         <dt>Natural Language and Character Set:
 764
 765         <dd>The "attributes-charset" and "attributes-natural-language"
 766         attributes as described in section 3.1.4.1 of the IPP Model and
 767         Semantics document.
 768
 769         <dt>"printer-uri" (uri):
 770
 771         <dd>The printer
 772         (<tt>ipp://server/printers/printername</tt>), class
 773         (<tt>ipp://server/classes/classname</tt>), or server
 774         (<tt>ipp://server/</tt>) URI for event notifications.
 775
 776         <dt>"notify-events" (1setOf keyword):
 777
 778         <dd>The events to monitor. In addition to the standard
 779         events, CUPS adds the following keywords:
 780         <ul>
 781
 782                 <li><tt>printer-added</tt> - Get notified
 783                 whenever a printer or class is added</li>
 784
 785                 <li><tt>printer-deleted</tt> - Get notified
 786                 whenever a printer or class is deleted</li>
 787
 788                 <li><tt>printer-modified</tt> - Get notified
 789                 whenever a printer or class is modified</li>
 790
 791                 <li><tt>server-audit</tt> - Get notified when a
 792                 security condition occurs</li>
 793
 794                 <li><tt>server-restarted</tt> - Get notified when
 795                 the server is restarted</li>
 796
 797                 <li><tt>server-started</tt> - Get notified when
 798                 the server is started</li>
 799
 800                 <li><tt>server-stopped</tt> - Get notified when
 801                 the server is stopped</li>
 802
 803         </ul>
 804
 805 </dl>
 806
 807 <h4>Create-Printer-Subscription Response</h4>
 808
 809 <p>The following groups of attributes are send as part of the
 810 response:</p>
 811
 812 <p>Group 1: Operation Attributes</p>
 813
 814 <dl>
 815
 816         <dt>Status Message:
 817
 818         <dd>The standard response status message.
 819
 820         <dt>Natural Language and Character Set:
 821
 822         <dd>The "attributes-charset" and "attributes-natural-language"
 823         attributes as described in section 3.1.4.2 of the IPP Model and
 824         Semantics document.
 825
 826 </dl>
 827
 828 <p>Group 2: Subscription Object Attributes</p>
 829
 830 <dl>
 831
 832         <dt>"subscription-id" (integer):
 833
 834         <dd>The subscription number.
 835
 836 </dl>
 837
 838 <h3 class='title'><a name='CUPS_GET_DEFAULT'>CUPS-Get-Default Operation</a></h3>
 839
 840 <p>The CUPS-Get-Default operation (0x4001) returns the default printer
 841 URI and attributes.
 842
 843 <h4>CUPS-Get-Default Request</h4>
 844
 845 <p>The following groups of attributes are supplied as part of the
 846 CUPS-Get-Default request:
 847
 848 <p>Group 1: Operation Attributes
 849
 850 <dl>
 851
 852         <dt>Natural Language and Character Set:
 853
 854         <dd>The "attributes-charset" and "attributes-natural-language"
 855         attributes as described in section 3.1.4.1 of the IPP Model and
 856         Semantics document.
 857
 858         <dt>"requested-attributes" (1setOf keyword) :
 859
 860         <dd>The client OPTIONALLY supplies a set of attribute names
 861         and/or attribute group names in whose values the requester is
 862         interested. If the client omits this attribute, the server
 863         responds as if this attribute had been supplied with a value of
 864         'all'.
 865
 866 </dl>
 867
 868 <h4>CUPS-Get-Default Response</h4>
 869
 870 <p>The following groups of attributes are send as part of the
 871 CUPS-Get-Default Response:
 872
 873 <p>Group 1: Operation Attributes
 874
 875 <dl>
 876
 877         <dt>Status Message:
 878
 879         <dd>The standard response status message.
 880
 881         <dt>Natural Language and Character Set:
 882
 883         <dd>The "attributes-charset" and "attributes-natural-language"
 884         attributes as described in section 3.1.4.2 of the IPP Model and
 885         Semantics document.
 886
 887 </dl>
 888
 889 <p>Group 2: Printer Object Attributes
 890
 891 <dl>
 892
 893         <dt>The set of requested attributes and their current values.
 894
 895 </dl>
 896
 897 <h3 class='title'><a name='CUPS_GET_PRINTERS'>CUPS-Get-Printers Operation</a></h3>
 898
 899 <p>The CUPS-Get-Printers operation (0x4002) returns the printer
 900 attributes for every printer known to the system. This may include
 901 printers that are not served directly by the server.
 902
 903 <h4>CUPS-Get-Printers Request</h4>
 904
 905 <p>The following groups of attributes are supplied as part of the
 906 CUPS-Get-Printers request:
 907
 908 <p>Group 1: Operation Attributes
 909
 910 <dl>
 911
 912         <dt>Natural Language and Character Set:
 913
 914         <dd>The "attributes-charset" and "attributes-natural-language"
 915         attributes as described in section 3.1.4.1 of the IPP Model and
 916         Semantics document.
 917
 918         <dt>"first-printer-name" (name(127)):<span class='info'>CUPS 1.2</span>
 919
 920         <dd>The client OPTIONALLY supplies this attribute to
 921         select the first printer that is returned.
 922
 923         <dt>"limit" (integer (1:MAX)):
 924
 925         <dd>The client OPTIONALLY supplies this attribute limiting the
 926         number of printers that are returned.
 927
 928         <dt>"printer-location" (text(127)): <span class='info'>CUPS 1.1.7</span>
 929
 930         <dd>The client OPTIONALLY supplies this attribute to
 931         select which printers are returned.
 932
 933         <dt>"printer-type" (type2 enum): <span class='info'>CUPS 1.1.7</span>
 934
 935         <dd>The client OPTIONALLY supplies a printer type enumeration to
 936         select which printers are returned.
 937
 938         <dt>"printer-type-mask" (type2 enum): <span class='info'>CUPS 1.1.7</span>
 939
 940         <dd>The client OPTIONALLY supplies a printer type mask
 941         enumeration to select which bits are used in the "printer-type"
 942         attribute.
 943
 944         <dt>"requested-attributes" (1setOf keyword) :
 945
 946         <dd>The client OPTIONALLY supplies a set of attribute names
 947         and/or attribute group names in whose values the requester is
 948         interested. If the client omits this attribute, the server
 949         responds as if this attribute had been supplied with a value of
 950         'all'.
 951
 952         <dt>"requested-user-name" (name(127)) : <span class='info'>CUPS 1.2</span>
 953
 954         <dd>The client OPTIONALLY supplies a user name that is used to filter
 955         the returned printers.
 956
 957 </dl>
 958
 959 <h4>CUPS-Get-Printers Response</h4>
 960
 961 <p>The following groups of attributes are send as part of the
 962 CUPS-Get-Printers Response:
 963
 964 <p>Group 1: Operation Attributes
 965
 966 <dl>
 967
 968         <dt>Status Message:
 969
 970         <dd>The standard response status message.
 971
 972         <dt>Natural Language and Character Set:
 973
 974         <dd>The "attributes-charset" and "attributes-natural-language"
 975         attributes as described in section 3.1.4.2 of the IPP Model and
 976         Semantics document.
 977
 978 </dl>
 979
 980 <p>Group 2: Printer Object Attributes
 981
 982 <dl>
 983
 984         <dt>The set of requested attributes and their current values for
 985         each printer.
 986
 987 </dl>
 988
 989 <h3 class='title'><a name='CUPS_ADD_MODIFY_PRINTER'>CUPS-Add-Modify-Printer Operation</a></h3>
 990
 991 <p>The CUPS-Add-Modify-Printer operation (0x4003) adds a new printer or
 992 modifies an existing printer on the system.
 993
 994 <h4>CUPS-Add-Modify-Printer Request</h4>
 995
 996 <p>The following groups of attributes are supplied as part of the
 997 CUPS-Add-Modify-Printer request:
 998
 999 <p>Group 1: Operation Attributes
1000
1001 <dl>
1002
1003         <dt>Natural Language and Character Set:
1004
1005         <dd>The "attributes-charset" and "attributes-natural-language"
1006         attributes as described in section 3.1.4.1 of the IPP Model and
1007         Semantics document.
1008
1009         <dt>"printer-uri" (uri):
1010
1011         <dd>The client MUST supply a URI for the specified printer.
1012
1013 </dl>
1014
1015 <p>Group 2: Printer Object Attributes
1016
1017 <dl>
1018
1019         <dt>"auth-info-required" (1setOf type2 keyword):<span class='info'>CUPS 1.3</span>
1020
1021         <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
1022
1023         <dt>"job-sheets-default" (1setOf name(127)): <span
1024         class='info'>CUPS 1.1.7</span>
1025
1026         <dd>The client OPTIONALLY supplies one or two banner page
1027         names that are printed before and after files in a job.
1028         The reserved name "none" is used to specify that no
1029         banner page should be printed.
1030
1031         <dt>"device-uri" (uri):
1032
1033         <dd>The client OPTIONALLY supplies a device URI for the
1034         specified printer.
1035
1036         <dt>"port-monitor" (name(127)):
1037
1038         <dd>The client OPTIONALLY supplies a port monitor name for the
1039         specified printer.
1040
1041         <dt>"ppd-name" (name(127)):
1042
1043         <dd>The client OPTIONALLY supplies a PPD name for the specified
1044         printer.
1045
1046         <dt>"printer-is-accepting-jobs" (boolean):
1047
1048         <dd>The client OPTIONALLY supplies this boolean attribute
1049         indicating whether or not the printer object should accept new jobs.
1050
1051         <dt>"printer-info" (text(127)):
1052
1053         <dd>The client OPTIONALLY supplies this attribute indicating the
1054         printer information string.
1055
1056         <dt>"printer-location" (text(127)):
1057
1058         <dd>The client OPTIONALLY supplies this attribute indicating a
1059         textual location of the printer.
1060
1061         <dt>"printer-more-info" (uri):
1062
1063         <dd>The client OPTIONALLY supplies this attribute indicating a
1064         URI for additional printer information.
1065
1066         <dt>"printer-state" (type2 enum):
1067
1068         <dd>The client OPTIONALLY supplies this attribute indicating the
1069         initial/current state of the printer. Only the "idle" and "stopped"
1070         enumerations are recognized.
1071
1072         <dt>"printer-state-message" (text(MAX)):
1073
1074         <dd>The client OPTIONALLY supplies this attribute indicating a
1075         textual reason for the current printer state.
1076
1077         <dt>"requesting-user-name-allowed" (1setof name(127) | delete)
1078         <br><i>OR</i>
1079         <br>"requesting-user-name-denied" (1setof name(127) | delete):
1080
1081         <dd>The client OPTIONALLY supplies one of these attributes to
1082         specify an access control list for incoming print jobs. To allow
1083         all users access to a printer, use the delete tag for the
1084         attribute value.
1085
1086 </dl>
1087
1088 <p>The CUPS-Add-Modify-Printer request can optionally be followed by a PPD
1089 file or System V interface script to be used for the printer. The
1090 "ppd-name" attribute overrides any file that is attached to the end of
1091 the request with a local CUPS PPD file.
1092
1093 <h4>CUPS-Add-Modify-Printer Response</h4>
1094
1095 <p>The following groups of attributes are send as part of the
1096 CUPS-Add-Modify-Printer Response:
1097
1098 <p>Group 1: Operation Attributes
1099
1100 <dl>
1101
1102         <dt>Status Message:
1103
1104         <dd>The standard response status message.
1105
1106         <dt>Natural Language and Character Set:
1107
1108         <dd>The "attributes-charset" and "attributes-natural-language"
1109         attributes as described in section 3.1.4.2 of the IPP Model and
1110         Semantics document.
1111
1112 </dl>
1113
1114 <h3 class='title'><a name='CUPS_DELETE_PRINTER'>CUPS-Delete-Printer Operation</a></h3>
1115
1116 <p>The CUPS-Delete-Printer operation (0x4004) removes an existing
1117 printer from the system.
1118
1119 <h4>CUPS-Delete-Printer Request</h4>
1120
1121 <p>The following groups of attributes are supplied as part of the
1122 CUPS-Delete-Printer request:
1123
1124 <p>Group 1: Operation Attributes
1125
1126 <dl>
1127
1128         <dt>Natural Language and Character Set:
1129
1130         <dd>The "attributes-charset" and "attributes-natural-language"
1131         attributes as described in section 3.1.4.1 of the IPP Model and
1132         Semantics document.
1133
1134         <dt>"printer-uri" (uri):
1135
1136         <dd>The client MUST supply a URI for the specified printer.
1137
1138 </dl>
1139
1140 <h4>CUPS-Delete-Printer Response</h4>
1141
1142 <p>The following groups of attributes are send as part of the
1143 CUPS-Delete-Printer Response:
1144
1145 <p>Group 1: Operation Attributes
1146
1147 <dl>
1148
1149         <dt>Status Message:
1150
1151         <dd>The standard response status message.
1152
1153         <dt>Natural Language and Character Set:
1154
1155         <dd>The "attributes-charset" and "attributes-natural-language"
1156         attributes as described in section 3.1.4.2 of the IPP Model and
1157         Semantics document.
1158
1159 </dl>
1160
1161 <h3 class='title'><a name='CUPS_GET_CLASSES'>CUPS-Get-Classes Operation</a></h3>
1162
1163 <p>The CUPS-Get-Classes operation (0x4005) returns the printer
1164 attributes for every printer class known to the system. This may
1165 include printer classes that are not served directly by the server.
1166
1167 <h4>CUPS-Get-Classes Request</h4>
1168
1169 <p>The following groups of attributes are supplied as part of the
1170 CUPS-Get-Classes request:
1171
1172 <p>Group 1: Operation Attributes
1173
1174 <dl>
1175
1176         <dt>Natural Language and Character Set:
1177
1178         <dd>The "attributes-charset" and "attributes-natural-language"
1179         attributes as described in section 3.1.4.1 of the IPP Model and
1180         Semantics document.
1181
1182         <dt>"first-printer-name" (name(127)):<span class='info'>CUPS 1.2</span>
1183
1184         <dd>The client OPTIONALLY supplies this attribute to
1185         select the first printer that is returned.
1186
1187         <dt>"limit" (integer (1:MAX)):
1188
1189         <dd>The client OPTIONALLY supplies this attribute limiting the
1190         number of printer classes that are returned.
1191
1192         <dt>"printer-location" (text(127)): <span class='info'>CUPS 1.1.7</span>
1193         <dd>The client OPTIONALLY supplies this attribute to
1194         select which printer classes are returned.
1195
1196         <dt>"printer-type" (type2 enum): <span class='info'>CUPS 1.1.7</span>
1197         <dd>The client OPTIONALLY supplies a printer type enumeration to
1198         select which printer classes are returned.
1199
1200         <dt>"printer-type-mask" (type2 enum): <span class='info'>CUPS 1.1.7</span>
1201         <dd>The client OPTIONALLY supplies a printer type mask
1202         enumeration to select which bits are used in the "printer-type"
1203         attribute.
1204
1205         <dt>"requested-attributes" (1setOf keyword) :
1206
1207         <dd>The client OPTIONALLY supplies a set of attribute names
1208         and/or attribute group names in whose values the requester is
1209         interested. If the client omits this attribute, the server responds as
1210         if this attribute had been supplied with a value of 'all'.
1211
1212         <dt>"requested-user-name" (name(127)) : <span class='info'>CUPS 1.2</span>
1213
1214         <dd>The client OPTIONALLY supplies a user name that is used to filter
1215         the returned printers.
1216
1217 </dl>
1218
1219 <h4>CUPS-Get-Classes Response</h4>
1220
1221 <p>The following groups of attributes are send as part of the
1222 CUPS-Get-Classes Response:
1223
1224 <p>Group 1: Operation Attributes
1225
1226 <dl>
1227
1228         <dt>Status Message:
1229
1230         <dd>The standard response status message.
1231
1232         <dt>Natural Language and Character Set:
1233
1234         <dd>The "attributes-charset" and "attributes-natural-language"
1235         attributes as described in section 3.1.4.2 of the IPP Model and
1236         Semantics document.
1237
1238 </dl>
1239
1240 <p>Group 2: Printer Class Object Attributes
1241
1242 <dl>
1243
1244         <dt>The set of requested attributes and their current values for
1245         each printer class.
1246
1247 </dl>
1248
1249 <h3 class='title'><a name='CUPS_ADD_MODIFY_CLASS'>CUPS-Add-Modify-Class Operation</a></h3>
1250
1251 <p>The CUPS-Add-Modify-Class operation (0x4006) adds a new printer class or
1252 modifies and existing printer class on the system.
1253
1254 <h4>CUPS-Add-Modify-Class Request</h4>
1255
1256 <p>The following groups of attributes are supplied as part of the
1257 CUPS-Add-Modify-Class request:
1258
1259 <p>Group 1: Operation Attributes
1260
1261 <dl>
1262
1263         <dt>Natural Language and Character Set:
1264
1265         <dd>The "attributes-charset" and "attributes-natural-language"
1266         attributes as described in section 3.1.4.1 of the IPP Model and
1267         Semantics document.
1268
1269         <dt>"printer-uri" (uri):
1270
1271         <dd>The client MUST supply a URI for the specified printer class.
1272
1273 </dl>
1274
1275 <p>Group 2: Printer Object Attributes
1276
1277 <dl>
1278
1279         <dt>"auth-info-required" (1setOf type2 keyword):<span class='info'>CUPS 1.3</span>
1280
1281         <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
1282
1283         <dt>"member-uris" (1setof uri):
1284
1285         <dd>The client OPTIONALLY supplies the "member-uris" set
1286         specifying the printers and printer classes that are part of the class.
1287
1288         <dt>"printer-is-accepting-jobs" (boolean):
1289
1290         <dd>The client OPTIONALLY supplies this boolean attribute
1291         indicating whether or not the class object should accept new jobs.
1292
1293         <dt>"printer-info" (text(127)):
1294
1295         <dd>The client OPTIONALLY supplies this attribute indicating the
1296         printer information string.
1297
1298         <dt>"printer-location" (text(127)):
1299
1300         <dd>The client OPTIONALLY supplies this attribute indicating a
1301         textual location of the class.
1302
1303         <dt>"printer-more-info" (uri):
1304
1305         <dd>The client OPTIONALLY supplies this attribute indicating a
1306         URI for additional class information.
1307
1308         <dt>"printer-state" (type2 enum):
1309
1310         <dd>The client OPTIONALLY supplies this attribute indicating the
1311         initial/current state of the class. Only the "idle" and "stopped"
1312         enumerations are recognized.
1313
1314         <dt>"printer-state-message" (text(MAX)):
1315
1316         <dd>The client OPTIONALLY supplies this attribute indicating a
1317         textual reason for the current class state.
1318
1319         <dt>"requesting-user-name-allowed" (1setof name(127))
1320         <br><i>OR</i>
1321         <br>"requesting-user-name-denied" (1setof name(127)):
1322
1323         <dd>The client OPTIONALLY supplies one of these attributes to
1324         specify an access control list for incoming print jobs. To allow
1325         all users access to a class, use the delete tag for the
1326         attribute value.
1327
1328 </dl>
1329
1330 <h4>CUPS-Add-Modify-Class Response</h4>
1331
1332 <p>The following groups of attributes are send as part of the CUPS-Add-Modify-Class Response:
1333
1334 <p>Group 1: Operation Attributes
1335
1336 <dl>
1337
1338         <dt>Status Message:
1339
1340         <dd>The standard response status message.
1341
1342         <dt>Natural Language and Character Set:
1343
1344         <dd>The "attributes-charset" and "attributes-natural-language"
1345         attributes as described in section 3.1.4.2 of the IPP Model and
1346         Semantics document.
1347
1348 </dl>
1349
1350 <h3 class='title'><a name='CUPS_DELETE_CLASS'>CUPS-Delete-Class Operation</a></h3>
1351
1352 <p>The CUPS-Delete-Class operation (0x4007) removes an existing printer
1353 class from the system.
1354
1355 <h4>CUPS-Delete-Class Request</h4>
1356
1357 <p>The following groups of attributes are supplied as part of the
1358 CUPS-Delete-Class request:
1359
1360 <p>Group 1: Operation Attributes
1361
1362 <dl>
1363
1364         <dt>Natural Language and Character Set:
1365
1366         <dd>The "attributes-charset" and "attributes-natural-language"
1367         attributes as described in section 3.1.4.1 of the IPP Model and
1368         Semantics document.
1369
1370         <dt>"printer-uri" (uri):
1371
1372         <dd>The client MUST supply a URI for the specified printer class.
1373
1374 </dl>
1375
1376 <h4>CUPS-Delete-Class Response</h4>
1377
1378 <p>The following groups of attributes are send as part of the
1379 CUPS-Delete-Class Response:
1380
1381 <p>Group 1: Operation Attributes
1382
1383 <dl>
1384
1385         <dt>Status Message:
1386
1387         <dd>The standard response status message.
1388
1389         <dt>Natural Language and Character Set:
1390
1391         <dd>The "attributes-charset" and "attributes-natural-language"
1392         attributes as described in section 3.1.4.2 of the IPP Model and
1393         Semantics document.
1394
1395 </dl>
1396
1397 <h3 class='title'><a name='CUPS_ACCEPT_JOBS'>CUPS-Accept-Jobs Operation</a></h3>
1398
1399 <p>The CUPS-Accept-Jobs operation (0x4008) sets the
1400 "printer-is-accepting-jobs" attribute to true for the specified printer
1401 or printer class.
1402
1403 <h4>CUPS-Accept-Jobs Request</h4>
1404
1405 <p>The following groups of attributes are supplied as part of the
1406 CUPS-Accept-Jobs request:
1407
1408 <p>Group 1: Operation Attributes
1409
1410 <dl>
1411
1412         <dt>Natural Language and Character Set:
1413
1414         <dd>The "attributes-charset" and "attributes-natural-language"
1415         attributes as described in section 3.1.4.1 of the IPP Model and
1416         Semantics document.
1417
1418         <dt>"printer-uri" (uri):
1419
1420         <dd>The client MUST supply a URI for the specified printer or printer class.
1421
1422 </dl>
1423
1424 <h4>CUPS-Accept-Jobs Response</h4>
1425
1426 <p>The following groups of attributes are send as part of the
1427 CUPS-Accept-Jobs Response:
1428
1429 <p>Group 1: Operation Attributes
1430
1431 <dl>
1432
1433         <dt>Status Message:
1434
1435         <dd>The standard response status message.
1436
1437         <dt>Natural Language and Character Set:
1438
1439         <dd>The "attributes-charset" and "attributes-natural-language"
1440         attributes as described in section 3.1.4.2 of the IPP Model and
1441         Semantics document.
1442
1443 </dl>
1444
1445 <h3 class='title'><a name='CUPS_REJECT_JOBS'>CUPS-Reject-Jobs Operation</a></h3>
1446
1447 <p>The CUPS-Reject-Jobs operation (0x4009) sets
1448 the"printer-is-accepting-jobs" attribute to false for the specified
1449 printer or printer class.
1450
1451 <h4>CUPS-Reject-Jobs Request</h4>
1452
1453 <p>The following groups of attributes are supplied as part of the
1454 CUPS-Reject-Jobs request:
1455
1456 <p>Group 1: Operation Attributes
1457
1458 <dl>
1459
1460         <dt>Natural Language and Character Set:
1461
1462         <dd>The "attributes-charset" and "attributes-natural-language"
1463         attributes as described in section 3.1.4.1 of the IPP Model and
1464         Semantics document.
1465
1466         <dt>"printer-uri" (uri):
1467
1468         <dd>The client MUST supply a URI for the specified printer or printer class.
1469
1470 </dl>
1471
1472 <p>Group 2: Printer Object Attributes
1473
1474 <dl>
1475
1476         <dt>"printer-state-message" (text(MAX)):
1477
1478         <dd>The client OPTIONALLY supplies this attribute indicating a
1479         textual reason for the current printer state.
1480
1481 </dl>
1482
1483 <h4>CUPS-Reject-Jobs Response</h4>
1484
1485 <p>The following groups of attributes are send as part of the
1486 CUPS-Reject-Jobs Response:
1487
1488 <p>Group 1: Operation Attributes
1489
1490 <dl>
1491
1492         <dt>Status Message:
1493
1494         <dd>The standard response status message.
1495
1496         <dt>Natural Language and Character Set:
1497
1498         <dd>The "attributes-charset" and "attributes-natural-language"
1499         attributes as described in section 3.1.4.2 of the IPP Model and
1500         Semantics document.
1501
1502 </dl>
1503
1504 <h3 class='title'><a name='CUPS_SET_DEFAULT'>CUPS-Set-Default Operation</a></h3>
1505
1506 <p>The CUPS-Set-Default operation (0x400A) sets the default printer
1507 destination for all clients when a resource name of "/printers" is
1508 specified.
1509
1510 <h4>CUPS-Set-Default Request</h4>
1511
1512 <p>The following groups of attributes are supplied as part of the
1513 CUPS-Set-Default request:
1514
1515 <p>Group 1: Operation Attributes
1516
1517 <dl>
1518
1519         <dt>Natural Language and Character Set:
1520
1521         <dd>The "attributes-charset" and "attributes-natural-language"
1522         attributes as described in section 3.1.4.1 of the IPP Model and
1523         Semantics document.
1524
1525         <dt>"printer-uri" (uri):
1526
1527         <dd>The client MUST supply a URI for the specified printer or
1528         printer class.
1529
1530 </dl>
1531
1532 <h4>CUPS-Set-Default Response</h4>
1533
1534 <p>The following groups of attributes are send as part of the
1535 CUPS-Set-Default Response:
1536
1537 <p>Group 1: Operation Attributes
1538
1539 <dl>
1540
1541         <dt>Status Message:
1542
1543         <dd>The standard response status message.
1544
1545         <dt>Natural Language and Character Set:
1546
1547         <dd>The "attributes-charset" and "attributes-natural-language"
1548         attributes as described in section 3.1.4.2 of the IPP Model and
1549         Semantics document.
1550
1551 </dl>
1552
1553 <h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_GET_DEVICES'>CUPS-Get-Devices Operation</a></h3>
1554
1555 <p>The CUPS-Get-Devices operation (0x400B) returns all of the
1556 supported device-uri's for the server.</p>
1557
1558 <h4>CUPS-Get-Devices Request</h4>
1559
1560 <p>The following groups of attributes are supplied as part of the
1561 CUPS-Get-Devices request:
1562
1563 <p>Group 1: Operation Attributes
1564
1565 <dl>
1566
1567         <dt>Natural Language and Character Set:
1568
1569         <dd>The "attributes-charset" and "attributes-natural-language"
1570         attributes as described in section 3.1.4.1 of the IPP Model and
1571         Semantics document.
1572
1573         <dt>"device-class" (type1 keyword):
1574
1575         <dd>The client OPTIONALLY supplies a device class keyword to select
1576         which devices are returned.
1577
1578         <dt>"exclude-schemes" (1setOf name) :<span class='info'>CUPS 1.4</span>
1579
1580         <dd>The client OPTIONALLY supplies a set of scheme names that the
1581         requestor does not want to discover. If the client omits this attribute,
1582         the server responds with devices of all schemes specified by
1583         the "include-schemes" attribute.
1584
1585         <dt>"include-schemes" (1setOf name) :<span class='info'>CUPS 1.4</span>
1586
1587         <dd>The client OPTIONALLY supplies a set of scheme names that the
1588         requestor wants to discover. If the client omits this attribute,
1589         the server responds with devices of all schemes except those specified
1590         by the "exclude-schemes" attribute.
1591
1592         <dt>"limit" (integer (1:MAX)):
1593
1594         <dd>The client OPTIONALLY supplies this attribute limiting the number of
1595         devices that are returned.
1596
1597         <dt>"requested-attributes" (1setOf keyword) :
1598
1599         <dd>The client OPTIONALLY supplies a set of attribute names and/or
1600         attribute group names in whose values the requester is interested. If
1601         the client omits this attribute, the server responds as if this
1602         attribute had been supplied with a value of 'all'.
1603
1604         <dt>"timeout" (integer (1:MAX)) :<span class='info'>CUPS 1.4</span>
1605
1606         <dd>The client OPTIONALLY supplies this attribute limiting the number of
1607         devices that are returned.
1608
1609 </dl>
1610
1611 <h4>CUPS-Get-Devices Response</h4>
1612
1613 <p>The following groups of attributes are send as part of the
1614 CUPS-Get-Devices Response:
1615
1616 <p>Group 1: Operation Attributes
1617
1618 <dl>
1619
1620         <dt>Status Message:
1621
1622         <dd>The standard response status message.
1623
1624         <dt>Natural Language and Character Set:
1625
1626         <dd>The "attributes-charset" and "attributes-natural-language"
1627         attributes as described in section 3.1.4.2 of the IPP Model and
1628         Semantics document.
1629
1630 </dl>
1631
1632 <p>Group 2: Device Object Attributes
1633
1634 <dl>
1635
1636         <dt>The set of requested attributes and their current values for
1637         each device.
1638
1639 </dl>
1640
1641 <h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_GET_PPDS'>CUPS-Get-PPDs Operation</a></h3>
1642
1643 <p>The CUPS-Get-PPDs operation (0x400C) returns all of the
1644 locally available PPD files on the system.</p>
1645
1646 <h4>CUPS-Get-PPDs Request</h4>
1647
1648 <p>The following groups of attributes are supplied as part of the
1649 CUPS-Get-PPDs request:
1650
1651 <p>Group 1: Operation Attributes
1652
1653 <dl>
1654
1655         <dt>Natural Language and Character Set:
1656
1657         <dd>The "attributes-charset" and "attributes-natural-language"
1658         attributes as described in section 3.1.4.1 of the IPP Model and
1659         Semantics document.
1660
1661         <dt>"exclude-schemes" (1setOf name) :<span class='info'>CUPS 1.4</span>
1662
1663         <dd>The client OPTIONALLY supplies a set of scheme names that the
1664         requestor does not want to list. If the client omits this attribute,
1665         the server responds with PPDs of all schemes specified by the
1666         "include-schemes" attribute.
1667
1668         <dt>"include-schemes" (1setOf name) :<span class='info'>CUPS 1.4</span>
1669
1670         <dd>The client OPTIONALLY supplies a set of scheme names that the
1671         requestor wants to list. If the client omits this attribute, the server
1672         responds with PPDs of all schemes except those specified by the
1673         "exclude-schemes" attribute.
1674
1675         <dt>"limit" (integer (1:MAX)):
1676
1677         <dd>The client OPTIONALLY supplies this attribute limiting the number of PPDs that are returned.
1678
1679         <dt>"ppd-make" (text(127)):
1680
1681         <dd>The client OPTIONALLY supplies a printer manufacturer to select which PPDs are returned.
1682
1683         <dt>"ppd-make-and-model" (text(127)):<span class='info'>CUPS 1.3</span>
1684
1685         <dd>The client OPTIONALLY supplies a make and model to select which PPDs are returned.
1686
1687         <dt>"ppd-model-number" (integer):<span class='info'>CUPS 1.3</span>
1688
1689         <dd>The client OPTIONALLY supplies a model number to select which PPDs are returned.
1690
1691         <dt>"ppd-natural-language" (naturalLanguage):<span class='info'>CUPS 1.3</span>
1692
1693         <dd>The client OPTIONALLY supplies a language to select which PPDs are returned.
1694
1695         <dt>"ppd-product" (text(127)):<span class='info'>CUPS 1.3</span>
1696
1697         <dd>The client OPTIONALLY supplies a PostScript product string to select which PPDs are returned.
1698
1699         <dt>"ppd-psversion" (text(127)):<span class='info'>CUPS 1.3</span>
1700
1701         <dd>The client OPTIONALLY supplies a PostScript version string to select which PPDs are returned.
1702
1703         <dt>"ppd-type" (type1 keyword):<span class='info'>CUPS 1.3</span>
1704
1705         <dd>The client OPTIONALLY supplies a driver type to select which PPDs are returned.
1706
1707         <dt>"requested-attributes" (1setOf keyword) :
1708
1709         <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.
1710
1711 </dl>
1712
1713 <h4>CUPS-Get-PPDs Response</h4>
1714
1715 <p>The following groups of attributes are send as part of the
1716 CUPS-Get-PPDs Response:
1717
1718 <p>Group 1: Operation Attributes
1719
1720 <dl>
1721
1722         <dt>Status Message:
1723
1724         <dd>The standard response status message.
1725
1726         <dt>Natural Language and Character Set:
1727
1728         <dd>The "attributes-charset" and "attributes-natural-language"
1729         attributes as described in section 3.1.4.2 of the IPP Model and
1730         Semantics document.
1731
1732 </dl>
1733
1734 <p>Group 2: PPD Attributes
1735
1736 <dl>
1737
1738         <dt>The set of requested attributes and their current values for each
1739         PPD file.
1740
1741 </dl>
1742
1743 <h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_MOVE_JOB'>CUPS-Move-Job Operation</a></h3>
1744
1745 <p>The CUPS-Move-Job operation (0x400D) moves an active print job
1746 to a different printer.</p>
1747
1748 <h4>CUPS-Move-Job Request</h4>
1749
1750 <p>The following groups of attributes are supplied as part of the
1751 CUPS-Move-Job request:
1752
1753 <p>Group 1: Operation Attributes
1754
1755 <dl>
1756
1757         <dt>Natural Language and Character Set:
1758
1759         <dd>The "attributes-charset" and "attributes-natural-language"
1760         attributes as described in section 3.1.4.1 of the IPP Model and
1761         Semantics document.
1762
1763         <dt>"printer-uri" (uri) and "job-id" (integer)
1764         <br><i>OR</i>
1765         <br>"job-uri":
1766
1767         <dd>The client MUST supply a URI for the specified printer and
1768         a job ID number, or the job URI.
1769
1770 </dl>
1771
1772 <p>Group 2: Job Template Attributes
1773
1774 <dl>
1775
1776         <dt>"job-printer-uri" (uri)
1777
1778         <dd>The client MUST supply a URI for a printer on the same server.
1779
1780 </dl>
1781
1782 <h4>CUPS-Move-Job Response</h4>
1783
1784 <p>The following groups of attributes are send as part of the
1785 CUPS-Move-Job Response:
1786
1787 <p>Group 1: Operation Attributes
1788
1789 <dl>
1790
1791         <dt>Status Message:
1792
1793         <dd>The standard response status message.
1794
1795         <dt>Natural Language and Character Set:
1796
1797         <dd>The "attributes-charset" and "attributes-natural-language"
1798         attributes as described in section 3.1.4.2 of the IPP Model and
1799         Semantics document.
1800
1801 </dl>
1802
1803 <h3 class='title'><span class='info'>CUPS 1.2</span><a name='CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job Operation</a></h3>
1804
1805 <p>The CUPS-Authenticate-Job operation (0x400E) authenticates a print job for
1806 printing, releasing the job if it is held. Typically this is used when printing
1807 to a remote server. The authentication information is passed in the HTTP
1808 request; the HTTP connection is normally encrypted for this type of request.</p>
1809
1810 <h4>CUPS-Authenticate-Job Request</h4>
1811
1812 <p>The following groups of attributes are supplied as part of the
1813 CUPS-Authenticate-Job request:
1814
1815 <p>Group 1: Operation Attributes
1816
1817 <dl>
1818
1819         <dt>Natural Language and Character Set:
1820
1821         <dd>The "attributes-charset" and "attributes-natural-language"
1822         attributes as described in section 3.1.4.1 of the IPP Model and
1823         Semantics document.
1824
1825         <dt>"printer-uri" (uri) and "job-id" (integer)
1826         <br><i>OR</i>
1827         <br>"job-uri":
1828
1829         <dd>The client MUST supply a URI for the specified printer and
1830         a job ID number, or the job URI.
1831
1832 </dl>
1833
1834 <p>Group 2: Job Attributes
1835
1836 <dl>
1837
1838         <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3</span>
1839
1840         <dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute.
1841
1842         <dt>"job-hold-until" (keyword | name(MAX)):<span class='info'>CUPS 1.3</span>
1843
1844         <dd>The client OPTIONALLY supplies a new job-hold-until value for the
1845         job. If specified and not the "no-hold" value, the job is held instead
1846         of released for printing.
1847
1848 </dl>
1849
1850 <h4>CUPS-Authenticate-Job Response</h4>
1851
1852 <p>The following groups of attributes are send as part of the
1853 CUPS-Authenticate-Job Response:
1854
1855 <p>Group 1: Operation Attributes
1856
1857 <dl>
1858
1859         <dt>Status Message:
1860
1861         <dd>The standard response status message.
1862
1863         <dt>Natural Language and Character Set:
1864
1865         <dd>The "attributes-charset" and "attributes-natural-language"
1866         attributes as described in section 3.1.4.2 of the IPP Model and
1867         Semantics document.
1868
1869 </dl>
1870
1871 <p>Group 2: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
1872
1873 <dl>
1874
1875         <dt>auth-info-required (1setOf Type2 keyword)
1876
1877         <dd>The required authentication information.
1878
1879 </dl>
1880
1881 <h3 class='title'><span class='info'>CUPS 1.3</span><a name='CUPS_GET_PPD'>CUPS-Get-PPD Operation</a></h3>
1882
1883 <p>The CUPS-Get-PPD operation (0x400F) gets a PPD file from the
1884 server. The PPD file can be specified using a <tt>ppd-name</tt>
1885 returned by <a href='#CUPS_GET_PPDS'><tt>CUPS-Get-PPDs</tt></a>
1886 or using the <tt>printer-uri</tt> for a queue.</p>
1887
1888 <p>If the PPD file is found, <tt>successful-ok</tt> is returned with
1889 the PPD file following the response data.</p>
1890
1891 <p>If the PPD file cannot be served by the local server because
1892 the <tt>printer-uri</tt> attribute points to an external printer,
1893 a <tt>cups-see-other</tt> status is returned with the correct
1894 URI to use.</p>
1895
1896 <p>If the PPD file does not exist, <tt>client-error-not-found</tt> is
1897 returned.</p>
1898
1899 <h4>CUPS-Get-PPD Request</h4>
1900
1901 <p>The following group of attributes is supplied as part of the
1902 CUPS-Get-PPD request:
1903
1904 <p>Group 1: Operation Attributes
1905
1906 <dl>
1907
1908         <dt>Natural Language and Character Set:
1909
1910         <dd>The "attributes-charset" and "attributes-natural-language"
1911         attributes as described in section 3.1.4.1 of the IPP Model and
1912         Semantics document.
1913
1914         <dt>"printer-uri" (uri)
1915         <br><i>OR</i>
1916         <br>"ppd-name" (name(255)):
1917
1918         <dd>The client MUST supply a printer URI or PPD name.
1919
1920 </dl>
1921
1922 <h4>CUPS-Get-PPD Response</h4>
1923
1924 <p>The following group of attributes is sent as part of the
1925 CUPS-Get-PPD Response:
1926
1927 <p>Group 1: Operation Attributes
1928
1929 <dl>
1930
1931         <dt>Status Message:
1932
1933         <dd>The standard response status message.
1934
1935         <dt>Natural Language and Character Set:
1936
1937         <dd>The "attributes-charset" and "attributes-natural-language"
1938         attributes as described in section 3.1.4.2 of the IPP Model and
1939         Semantics document.
1940
1941         <dt>"printer-uri" (uri):
1942
1943         <dd>The printer that provides the actual PPD file when
1944         the status code is cups-see-other (0x280)
1945
1946 </dl>
1947
1948 <p>If the status code is <tt>successful-ok</tt>, the PPD file follows
1949 the end of the IPP response.</p>
1950
1951 <h3 class='title'><span class='info'>CUPS 1.4</span><a name='CUPS_GET_DOCUMENT'>CUPS-Get-Document Operation</a></h3>
1952
1953 <p>The CUPS-Get-Document operation (0x4027) gets a document file from a
1954 job on the server. The document file is specified using the
1955 <tt>document-number</tt> and either the <tt>job-uri</tt> or <tt>printer-uri</tt>
1956 and <tt>job-id</tt> identifying the job.</p>
1957
1958 <p>If the document file is found, <tt>successful-ok</tt> is returned with
1959 the document file following the response data.</p>
1960
1961 <p>If the document file does not exist, <tt>client-error-not-found</tt> is
1962 returned.</p>
1963
1964 <p>If the requesting user does not have access to the document file,
1965 <tt>client-error-not-authorized</tt> is returned.
1966
1967 <h4>CUPS-Get-Document Request</h4>
1968
1969 <p>The following group of attributes is supplied as part of the
1970 CUPS-Get-Document request:
1971
1972 <p>Group 1: Operation Attributes
1973
1974 <dl>
1975
1976         <dt>Natural Language and Character Set:
1977
1978         <dd>The "attributes-charset" and "attributes-natural-language"
1979         attributes as described in section 3.1.4.1 of the IPP Model and
1980         Semantics document.
1981
1982         <dt>"printer-uri" (uri) and "job-id" (integer)
1983         <br><i>OR</i>
1984         <br>"job-uri" (uri):
1985
1986         <dd>The client MUST supply a printer URI and job ID or job URI.
1987
1988         <dt>"document-number" (integer(1:MAX)):
1989
1990         <dd>The client MUST supply a document number to retrieve. The
1991         <tt>document-count</tt> attribute for the job defines the maximum
1992         document number that can be specified. In the case of jobs with
1993         banners (<tt>job-sheets</tt> is not "none"), document number 1
1994         will typically contain the start banner and document number N
1995         will typically contain the end banner.
1996
1997 </dl>
1998
1999 <h4>CUPS-Get-Document Response</h4>
2000
2001 <p>The following group of attributes is sent as part of the
2002 CUPS-Get-Document Response:
2003
2004 <p>Group 1: Operation Attributes
2005
2006 <dl>
2007
2008         <dt>Status Message:
2009
2010         <dd>The standard response status message.
2011
2012         <dt>Natural Language and Character Set:
2013
2014         <dd>The "attributes-charset" and "attributes-natural-language"
2015         attributes as described in section 3.1.4.2 of the IPP Model and
2016         Semantics document.
2017
2018         <dt>"document-format" (mimeType):
2019
2020         <dd>The format of the document file.
2021
2022         <dt>"document-number" (integer(1:MAX)):
2023
2024         <dd>The requested document number.
2025
2026         <dt>"document-name" (name(MAX)):
2027
2028         <dd>The name that was supplied with the document, if any.
2029
2030 </dl>
2031
2032 <p>If the status code is <tt>successful-ok</tt>, the document file follows
2033 the end of the IPP response.</p>
2034
2035
2036 <h2 class='title'><a name='ATTRIBUTES'>Attributes</a></h2>
2037
2038 <p>CUPS provides many extension attributes to support multiple
2039 devices, PPD files, standard job filters, printers, and printer
2040 classes.</p>
2041
2042 <h3 class='title'><a name='DEVICE_ATTRIBUTES'>Device Attributes</a></h3>
2043
2044 <p>Device attributes are returned by the CUPS-Get-Devices
2045 operation and enumerate all of the available hardware devices and
2046 network protocols that are supported by the server.</p>
2047
2048 <h4><a name="device-class">device-class (type2 keyword)</a></h4>
2049
2050 <p>The device-class attribute specifies the class of device and can be
2051 one of the following:
2052
2053 <ul>
2054
2055         <li>"file" - a disk file.
2056
2057         <li>"direct" - a parallel or fixed-rate serial data port,
2058         currently used for Centronics, IEEE-1284, and USB printer
2059         ports.
2060
2061         <li>"serial" - a variable-rate serial port.
2062
2063         <li>"network" - a network connection, typically via AppSocket,
2064         HTTP, IPP, LPD, or SMB/CIFS protocols.
2065
2066 </ul>
2067
2068 <h4><a name="device-id">device-id (text(127))</a><span class="info">CUPS 1.2</span></h4>
2069
2070 <p>The device-id attribute specifies the IEEE-1284 device ID
2071 string for the device.</p>
2072
2073 <h4><a name="device-info">device-info (text(127))</a></h4>
2074
2075 <p>The device-info attribute specifies a human-readable string describing
2076 the device, e.g. "Parallel Port #1".
2077
2078 <h4><a name="device-location">device-location (text(127))</a><span class="info">CUPS 1.4</span></h4>
2079
2080 <p>The device-location attribute specifies the physical location of the
2081 printer.
2082
2083 <h4><a name="device-make-and-model">device-make-and-model (text(127))</a></h4>
2084
2085 <p>The device-make-and-model attribute specifies a device
2086 identification string provided by the printer connected to the device.
2087 If the device or printer does not support identification then this
2088 attribute contains the string "unknown".
2089
2090 <h4><a name="device-uri">device-uri (uri)</a></h4>
2091
2092 <p>The device-uri attribute specifies a unique identifier for the
2093 device. The actual format of the device-uri string depends on the value
2094 of the device-class attribute:
2095
2096 <ul>
2097
2098         <li>"file" - The device-uri will be of the form
2099         "file:///path/to/filename".
2100
2101         <li>"direct" - The device-uri will be of the form
2102         "scheme:/dev/filename" or "scheme://vendor/identifier",
2103         where scheme may be "parallel" or "usb" in the current
2104         implementation.
2105
2106         <li>"serial" - The device-uri will be of the form
2107         "serial:/dev/filename?baud=value+parity=value+flow=value".
2108         The baud value is the data rate in bits per second; the
2109         supported values depend on the underlying hardware.
2110         The parity value can be one of "none", "even", or "odd".
2111         The flow value can be one of "none", "soft" (XON/XOFF
2112         handshaking), "hard" or "rts/cts" (RTS/CTS handshaking),
2113         or "dtrdsr" (DTR/DSR handshaking).
2114
2115         <p>The URI returned by CUPS-Get-Devices will contain the
2116         maximum baud rate supported by the device and the best
2117         type of flow control available ("soft" or "hard").
2118
2119         <li>"network" - The device-uri will be of the form
2120         "scheme://[username:password@]hostname[:port]/[resource]",
2121         where scheme may be "http", "https", "ipp", "lpd", "smb", or
2122         "socket" in the current implementation.
2123
2124         <p>The URI returned by CUPS-Get-Devices will only contain
2125         the scheme name ("scheme"). It is up to the client
2126         application to add the appropriate host and other
2127         information when adding a new printer.
2128
2129         <p>The URI returned by Get-Printer-Attributes and
2130         CUPS-Get-Printers has any username and password information
2131         stripped; the information is still stored and used by the
2132         server internally to perform any needed authentication.
2133
2134 </ul>
2135
2136 <h3 class='title'><a name='JOB_TEMPLATE_ATTRIBUTES'>Job Template Attributes</a></h3>
2137
2138 <h4><a name="auth-info">auth-info (1setOf text(MAX))</a><span class="info">CUPS 1.3</span></h4>
2139
2140 <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.
2141
2142 <h4><a name="blackplot">blackplot (boolean)</a></h4>
2143
2144 <p>The blackplot attribute specifies whether HP-GL/2 plot files should be
2145 rendered entirely in black ink (blackplot=true) or using the colors and shades
2146 specified in the file (blackplot=false). The default value is false.
2147
2148 <h4><a name="brightness">brightness (integer(0:200))</a><span class="info">Deprecated</span></h4>
2149
2150 <p>The brightness attribute specifies the overall brightness of the printed
2151 output in percent. A brightness of 100 is normal, while 200 is twice as
2152 bright and 50 is half as bright. The default value is 100.
2153
2154 <p>Brightness is applied to the Cyan, Magenta, Yellow, and Black values using
2155 the function "f(x) = brightness / 100 * x".
2156
2157 <blockquote><b>Note:</b>
2158
2159 <p>This attribute is deprecated and will be removed from a future CUPS
2160 release.</p>
2161
2162 </blockquote>
2163
2164 <h4><a name="columns">columns (integer(1:4))</a> <span class='info'>Deprecated</span></h4>
2165
2166 <p>The columns attribute specifies the number of columns to generate when
2167 printing text files. The default value is 1.
2168
2169 <h4><a name="cpi">cpi (type2 enum)</a></h4>
2170
2171 <p>The cpi attribute specifies the number of characters per inch when
2172 printing text files. Only the values 10, 12, and 17 are currently
2173 supported. The default value is 10.
2174
2175 <h4><a name="document-count">document-count (integer(1:MAX))</a></h4>
2176
2177 <p>The document-count attribute specifies the number of documents that
2178 are present in the job.
2179
2180 <h4><a name="fit-to-page">fit-to-page (boolean)</a><span class="info">CUPS 1.4</span></h4>
2181
2182 <p>The fit-to-page attribute specifies whether to scale documents to fit on the
2183 selected media (fit-to-page=true) or use the physical size specified in the
2184 document (fit-to-page=false). The default value is false.
2185
2186 <h4><a name="fitplot">fitplot (boolean)</a><span class="info">Deprecated</span></h4>
2187
2188 <p>The fitplot attribute specifies whether to scale HP-GL/2 plot files to
2189 fit on the selected media (fitplot=true) or use the physical scale specified
2190 in the plot file (fitplot=false). The default value is false.
2191
2192 <h4><a name="gamma">gamma (integer(1:10000))</a><span class="info">Deprecated</span></h4>
2193
2194 <p>The gamma attribute specifies the luminance correction for the output.
2195 A value of 1000 specifies no correction, while values of 2000 and 500 will
2196 generate lighter and darker output, respectively. The default value is
2197 1000.
2198
2199 <p>Gamma is applied to the Red, Green, and Blue values (or luminance for
2200 grayscale output) using the function "f(x) = x<sup>(1000/gamma)</sup>".
2201
2202 <blockquote><b>Note:</b>
2203
2204 <p>This attribute is deprecated and will be removed from a future CUPS
2205 release.</p>
2206
2207 </blockquote>
2208
2209 <h4><a name="hue">hue (integer(-180:180))</a><span class="info">Deprecated</span></h4>
2210
2211 <p>The hue attribute specifies a color hue rotation when printing image
2212 files. The default value is 0.
2213
2214 <blockquote><b>Note:</b>
2215
2216 <p>This attribute is deprecated and will be removed from a future CUPS
2217 release.</p>
2218
2219 </blockquote>
2220
2221 <h4><a name="job-billing">job-billing (text(MAX))</a><span class='info'>CUPS 1.1</span></h4>
2222
2223 <p>The job-billing attribute provides a text value to associate with a job
2224 for billing purposes.
2225
2226 <h4><a name="job-hold-until">job-hold-until (keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4>
2227
2228 <p>The job-hold-until attribute specifies a hold time. In addition to the
2229 standard IPP/1.1 keyword names, CUPS supports name values of the form
2230 "HH:MM" and "HH:MM:SS" that specify a hold time. The hold time is in
2231 Universal Coordinated Time (UTC) and <i>not</i> in the local time zone. If the
2232 specified time is less than the current time, the job is held until the
2233 next day.
2234
2235 <h4><a name="job-media-progress">job-media-progress (integer(0:100))</a><span class='info'>CUPS 1.4</span></h4>
2236
2237 <p>The job-media-progress attribute specifies the percentage of completion of
2238 the current page. It is only valid when the job-state attribute has the
2239 "processing" value (5).</p>
2240
2241 <h4><a name="job-printer-state-message">job-printer-state-message (text(MAX))</a><span class='info'>CUPS 1.3</span></h4>
2242
2243 <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>
2244
2245 <h4><a name="job-printer-state-reasons">job-printer-state-reasons (1setOf type2 keyword)</a><span class='info'>CUPS 1.3</span></h4>
2246
2247 <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>
2248
2249 <h4><a name="job-sheets">job-sheets (1setof type3 keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4>
2250
2251 <p>The job-sheets attribute specifies one or two banner files that are printed
2252 before and after a job. The reserved value of "none" disables banner printing.
2253 The default value is stored in the job-sheets-default attribute.
2254
2255 <p>If only one value is supplied, the banner file is printed before the job.
2256 If two values are supplied, the first value is used as the starting banner
2257 file and the second as the ending banner file.
2258
2259 <h4><a name="job-originating-host-name">job-originating-host-name (name(MAX))</a></h4>
2260
2261 <p><i>(CUPS 1.1.5 and higher)</i>
2262
2263 <p>The job-originating-host-name attribute specifies the host
2264 from which the job was queued. The value will be the hostname or
2265 IP address of the client depending on whether hostname
2266 resolution is enabled.  The localhost address (127.0.0.1) is
2267 <b>always</b> resolved to the name "localhost".
2268
2269 <p>This attribute is read-only.
2270
2271 <h4><a name="lpi">lpi (type2 enum)</a></h4>
2272
2273 <p>The lpi attribute specifies the number of lines per inch when
2274 printing text files. Only the values 6 and 8 are currently supported.
2275 The default value is 6.
2276
2277 <h4><a name="mirror">mirror (boolean)</a></h4>
2278
2279 <p>The mirror attribute specifies whether pages are mirrored on
2280 their X axis, which is useful for printing transfer images on
2281 special media. The default value is false.
2282
2283 <h4><a name="natural-scaling">natural-scaling (integer(1:1000))</a><span class='info'>CUPS 1.1.9</span></h4>
2284 <p>The natural-scaling attribute specifies the scaling of image files with
2285 respect to the natural image size. A value of 100 specifies that the image
2286 file should exactly the natural size, while 50 is half the natural size
2287 and 200 is twice the natural size. The default value is 100.
2288
2289 <p>The ppi option can be used to override the natural resolution of the
2290 image, which controls the natural size.
2291
2292 <h4><a name="number-up-layout">number-up-layout (type2 keyword)</a><span class='info'>CUPS 1.1.15</span></h4>
2293 <p>The number-up-layout attribute specifies the order each input
2294 page is placed on each output page. The following keywords are
2295 presently defined:
2296
2297 <ul>
2298
2299         <li><CODE>btlr</CODE> - Bottom to top, left to right</li>
2300
2301         <li><CODE>btrl</CODE> - Bottom to top, right to left</li>
2302
2303         <li><CODE>lrbt</CODE> - Left to right, bottom to top</li>
2304
2305         <li><CODE>lrtb</CODE> - Left to right, top to bottom (default)</li>
2306
2307         <li><CODE>rlbt</CODE> - Right to left, bottom to top</li>
2308
2309         <li><CODE>rltb</CODE> - Right to left, top to bottom</li>
2310
2311         <li><CODE>tblr</CODE> - Top to bottom, left to right</li>
2312
2313         <li><CODE>tbrl</CODE> - Top to bottom, right to left</li>
2314
2315 </ul>
2316
2317 <h4><a name="page-border">page-border (type2 keyword)</a><span class='info'>CUPS 1.1.15</span></h4>
2318 <p>The page-border attribute specifies whether a border is
2319 draw around each page. The following keywords are presently
2320 defined:
2321
2322 <ul>
2323
2324         <li><CODE>double</CODE> - Two hairline borders are drawn</li>
2325
2326         <li><CODE>double-thick</CODE> - Two 1pt borders are drawn</li>
2327
2328         <li><CODE>none</CODE> - No border is drawn (default)</li>
2329
2330         <li><CODE>single</CODE> - A single hairline border is drawn</li>
2331
2332         <li><CODE>single-thick</CODE> - A single 1pt border is drawn</li>
2333
2334 </ul>
2335
2336 <h4><a name="page-bottom">page-bottom (integer(0:MAX))</a></h4>
2337
2338 <p>The page-bottom attribute specifies the bottom margin in points (72 points
2339 equals 1 inch). The default value is the device physical margin.
2340
2341 <h4><a name="page-label">page-label (text(MAX))</a><span class='info'>CUPS 1.1.7</span></h4>
2342 <p>The page-label attribute provides a text value to place in
2343 the header and footer on each page. If a classification level is
2344 set on the server, then this classification is printed before
2345 the page label.
2346
2347 <h4><a name="page-left">page-left (integer(0:MAX))</a></h4>
2348
2349 <p>The page-left attribute specifies the left margin in points (72 points
2350 equals 1 inch). The default value is the device physical margin.
2351
2352 <h4><a name="page-right">page-right (integer(0:MAX))</a></h4>
2353
2354 <p>The page-right attribute specifies the right margin in points (72 points
2355 equals 1 inch). The default value is the device physical margin.
2356
2357 <h4><a name="page-set">page-set (type2 keyword)</a></h4>
2358
2359 <p>The page-set attribute specifies which pages to print in a file. The
2360 supported keywords are "all", "even", and "odd". The default value is
2361 "all".
2362
2363 <h4><a name="page-top">page-top (integer(0:MAX))</a></h4>
2364
2365 <p>The page-top attribute specifies the top margin in points (72 points
2366 equals 1 inch). The default value is the device physical margin.
2367
2368 <h4><a name="penwidth">penwidth (integer(0:MAX))</a></h4>
2369
2370 <p>The penwidth attribute specifies the default pen width in micrometers
2371 when printing HP-GL/2 plot files. The default value is 1000 (1 millimeter).
2372
2373 <h4><a name="position">position (type2 keyword)</a></h4>
2374
2375 <p>The position attribute specifies the location of image files on the
2376 media. The following keyword values are recognized:
2377
2378 <ul>
2379
2380         <li><CODE>center</CODE> - Center the image on the page (default)
2381
2382         <li><CODE>top</CODE> - Print the image centered at the top of the page
2383
2384         <li><CODE>left</CODE> - Print the image centered on the left of page
2385
2386         <li><CODE>right</CODE> - Print the image centered on the right of the page
2387
2388         <li><CODE>top-left</CODE> - Print the image at the top left corner of
2389         the page
2390
2391         <li><CODE>top-right</CODE> - Print the image at the top right corner of
2392         the page
2393
2394         <li><CODE>bottom</CODE> - Print the image centered at the bottom of
2395         the page
2396
2397         <li><CODE>bottom-left</CODE> - Print the image at the bottom left
2398         corner of the page
2399
2400         <li><CODE>bottom-right</CODE> - Print the image at the bottom right
2401         corner of the page
2402
2403 </ul>
2404
2405 <h4><a name="ppi">ppi (integer(1:MAX))</a></h4>
2406
2407 <p>The ppi attribute specifies the resolution of an image file in pixels
2408 per inch. The default value is the resolution included with the file or
2409 128 if no resolution information is available.
2410
2411 <h4><a name="prettyprint">prettyprint (boolean)</a></h4>
2412
2413 <p>The prettyprint attribute specifies whether text files should be printed
2414 with a shaded header and keyword highlighting (prettyprint=true) or without
2415 additional formatting (prettyprint=false). The default value is false.
2416
2417 <h4><a name="saturation">saturation (integer(0:200))</a><span class="info">Deprecated</span></h4>
2418
2419 <p>The saturation attribute specifies the color saturation when
2420 printing image files. A saturation of 100 is normal, while values of 50
2421 and 200 will be half and twice as colorful, respectively. The default
2422 value is 100.
2423
2424 <blockquote><b>Note:</b>
2425
2426 <p>This attribute is deprecated and will be removed from a future CUPS
2427 release.</p>
2428
2429 </blockquote>
2430
2431 <h4><a name="scaling">scaling (integer(1:1000))</a></h4>
2432
2433 <p>The scaling attribute specifies the scaling of image files with
2434 respect to the selected media. A value of 100 specifies that the image
2435 file should fit 100% of the page, or as much as possible given the
2436 image dimensions. The default value is unspecified.
2437
2438 <p>The scaling attribute overrides the ppi attribute if specified.
2439
2440 <h4><a name="wrap">wrap (boolean)</a></h4>
2441
2442 <p>The wrap attribute specifies whether long lines should be wrapped
2443 (wrap=true) or not (wrap=false) when printing text files. The default
2444 value is true.
2445
2446 <h3 class='title'><a name='PPD_ATTRIBUTES'>PPD Attributes</a></h3>
2447
2448 <h4><a name="ppd-device-id">ppd-device-id (text(127))</a></h4>
2449
2450 <p>The ppd-device-id attribute specifies the IEEE-1284 device ID
2451 string for the device described by the PPD file.</p>
2452
2453 <h4><a name="ppd-make">ppd-make (text(127))</a></h4>
2454
2455 <p>The ppd-make attribute specifies the manufacturer of the printer
2456 (the Manufacturer attribute in the PPD file). If the manufacturer
2457 is not specified in the PPD file then an educated guess is made using
2458 the NickName attribute in the PPD file.
2459
2460 <h4><a name="ppd-make-and-model">ppd-make-and-model (text(127))</a></h4>
2461
2462 <p>The ppd-make-and-model attribute specifies the manufacturer and model
2463 name of the PPD file (the NickName attribute in the PPD file). If the
2464 make and model is not specified in the PPD file then the ModelName or
2465 ShortNickName attributes are used instead.
2466
2467 <h4><a name="ppd-model-number">ppd-model-number (integer)</a><span class="info">CUPS 1.3</span></h4>
2468
2469 <p>The ppd-model-number attribute provides the <tt>cupsModelNumber</tt> value from the PPD file.
2470
2471 <h4><a name="ppd-name">ppd-name (name(255))</a></h4>
2472
2473 <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.
2474
2475 <h4><a name="ppd-natural-language">ppd-natural-language (1setOf naturalLanguage)</a></h4>
2476
2477 <p>The ppd-natural-language attribute specifies the language encoding
2478 of the PPD file (the LanguageVersion attribute in the PPD file). If the
2479 language is unknown or undefined then "en" (English) is assumed.
2480
2481 <h4><a name="ppd-product">ppd-product (1setOf text(127))</a></h4>
2482
2483 <p>The ppd-product attribute specifies the Product attribute values in the PPD file.
2484
2485 <h4><a name="ppd-psversion">ppd-psversion (1setOf text(127))</a><span class="info">CUPS 1.3</span></h4>
2486
2487 <p>The ppd-product attribute specifies the PSVersion attribute values in the PPD file.
2488
2489 <h4><a name="ppd-type">ppd-type (type1 keyword)</a><span class="info">CUPS 1.3</span></h4>
2490
2491 <p>The ppd-type attribute specifies the type of driver described by the PPD file:</p>
2492
2493 <ul>
2494
2495         <li><tt>fax</tt> - A facsimile or multi-function device</li>
2496
2497         <li><tt>pdf</tt> - A PDF printer</li>
2498
2499         <li><tt>postscript</tt> - A PostScript printer (no filters)</li>
2500
2501         <li><tt>raster</tt> - A CUPS raster driver</li>
2502
2503         <li><tt>unknown</tt> - An unknown or hybrid driver</li>
2504
2505 </ul>
2506
2507
2508 <h3 class='title'><a name='PRINTER_ATTRIBUTES'>Printer Attributes</a></h3>
2509
2510 <h4><a name="auth-info-required">auth-info-required (1setOf type2 keyword)</a><span class="info">CUPS 1.3</span></h4>
2511
2512 <p>The auth-info-required attribute specifies the authentication information that is required for printing a job. The following keywords are recognized:</p>
2513
2514 <ul>
2515
2516         <li><tt>domain</tt> - A domain name is required.</li>
2517
2518         <li><tt>none</tt> - No authentication is required - this keyword can only appear by itself.</li>
2519
2520         <li><tt>password</tt> - A password is required.</li>
2521
2522         <li><tt>username</tt> - A username is required.</li>
2523
2524 </ul>
2525
2526 <h4><a name="job-k-limit">job-k-limit (integer)</a><span class='info'>CUPS 1.1</span></h4>
2527
2528 <p>The job-k-limit attribute specifies the maximum number of kilobytes that
2529 may be printed by a user, including banner files. The default value of 0
2530 specifies that there is no limit.
2531
2532 <h4><a name="job-page-limit">job-page-limit (integer)</a><span class='info'>CUPS 1.1</span></h4>
2533
2534 <p>The job-page-limit attribute specifies the maximum number of pages that
2535 may be printed by a user, including banner files. The default value of 0
2536 specifies that there is no limit.
2537
2538 <h4><a name="job-quota-period">job-quota-period (integer)</a><span class='info'>CUPS 1.1</span></h4>
2539
2540 <p>The job-quota-period attribute specifies the time period used for quota
2541 calculations, in seconds. The default value of 0 specifies that the limits
2542 apply to all jobs that have been printed by a user that are still known to
2543 the system.
2544
2545 <h4><a name="job-sheets-supported">job-sheets-supported (1setof type3 keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4>
2546
2547 <p>The job-sheets-supported attribute specifies the available banner files.
2548 There will always be at least one banner file available called "none".
2549
2550 <h4><a name="marker-change-time">marker-change-time (integer)</a><span class='info'>CUPS 1.3</span></h4>
2551
2552 <p>The marker-change-time attribute specifies the printer-up-time value when
2553 the last change to the marker-colors, marker-levels, marker-message,
2554 marker-names, or marker-types attributes was made.</p>
2555
2556 <h4><a name="marker-colors">marker-colors (1setof name(MAX))</a><span class='info'>CUPS 1.3</span></h4>
2557
2558 <p>The marker-colors attribute specifies the color(s) for each supply in the
2559 printer. It is only available when the driver provides supply levels. The
2560 color is either "none" or one or more hex-encoded sRGB colors of the form
2561 "#RRGGBB".</p>
2562
2563 <h4><a name="marker-high-levels">marker-high-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4</span></h4>
2564
2565 <p>The marker-high-levels attribute specifies the supply levels that indicate
2566 a near-full condition. A value of 100 should be used for supplies that are
2567 consumed/emptied, e.g. ink cartridges.</p>
2568
2569 <h4><a name="marker-levels">marker-levels (1setof integer(-1:100))</a><span class='info'>CUPS 1.3</span></h4>
2570
2571 <p>The marker-levels attribute specifies the current supply levels for the
2572 printer. It is only available when the driver provides supply levels. A
2573 value of -1 indicates the level is unknown, while values from 0 to 100
2574 indicate the corresponding percentage.</p>
2575
2576 <h4><a name="marker-low-levels">marker-low-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4</span></h4>
2577
2578 <p>The marker-low-levels attribute specifies the supply levels that indicate
2579 a near-empty condition. A value of 0 should be used for supplies that are
2580 filled, e.g. waste ink tanks.</p>
2581
2582 <h4><a name="marker-message">marker-message (text(MAX))</a><span class='info'>CUPS 1.4</span></h4>
2583
2584 <p>The marker-message attribute provides a human-readable status message
2585 for the current supply levels, e.g. "12 pages of ink remaining." It is only
2586 available when the driver provides supply levels.</p>
2587
2588 <h4><a name="marker-names">marker-names (1setof name(MAX))</a><span class='info'>CUPS 1.3</span></h4>
2589
2590 <p>The marker-names attribute specifies the name(s) for each supply in the
2591 printer. It is only available when the driver provides supply levels.</p>
2592
2593 <h4><a name="marker-types">marker-types (1setof type3 keyword)</a><span class='info'>CUPS 1.3</span></h4>
2594
2595 <p>The marker-types attribute specifies the type(s) of each supply in the
2596 printer. It is only available when the driver provides supply levels. The
2597 following (RFC 3805) types are currently supported:</p>
2598
2599 <ul>
2600
2601         <li><tt>toner</tt></li>
2602
2603         <li><tt>wasteToner</tt></li>
2604
2605         <li><tt>ink</tt></li>
2606
2607         <li><tt>inkCartridge</tt></li>
2608
2609         <li><tt>inkRibbon</tt></li>
2610
2611         <li><tt>wasteInk</tt></li>
2612
2613         <li><tt>opc</tt></li>
2614
2615         <li><tt>developer</tt></li>
2616
2617         <li><tt>fuserOil</tt></li>
2618
2619         <li><tt>solidWax</tt></li>
2620
2621         <li><tt>ribbonWax</tt></li>
2622
2623         <li><tt>wasteWax</tt></li>
2624
2625         <li><tt>fuser</tt></li>
2626
2627         <li><tt>coronaWire</tt></li>
2628
2629         <li><tt>fuserOilWick</tt></li>
2630
2631         <li><tt>cleanerUnit</tt></li>
2632
2633         <li><tt>fuserCleaningPad</tt></li>
2634
2635         <li><tt>transferUnit</tt></li>
2636
2637         <li><tt>tonerCartridge</tt></li>
2638
2639         <li><tt>fuserOiler</tt></li>
2640
2641         <li><tt>water</tt></li>
2642
2643         <li><tt>wasteWater</tt></li>
2644
2645         <li><tt>bindingSupply</tt></li>
2646
2647         <li><tt>bandingSupply</tt></li>
2648
2649         <li><tt>stichingWire</tt></li>
2650
2651         <li><tt>shrinkWrap</tt></li>
2652
2653         <li><tt>paperWrap</tt></li>
2654
2655         <li><tt>staples</tt></li>
2656
2657         <li><tt>inserts</tt></li>
2658
2659         <li><tt>covers</tt></li>
2660
2661 </ul>
2662
2663 <h4><a name="port-monitor">port-monitor" (name(127))</a></h4>
2664
2665 <p>The port-monitor attribute specifies the port monitor to use when printing
2666 to this printer. The default port monitor is "none".
2667
2668 <h4><a name="port-monitor-supported">port-monitor-supported" (1setOf name(127))</a></h4>
2669
2670 <p>The port-monitor-supported attribute specifies the available port monitors.
2671
2672 <h4><a name="printer-commands">printer-commands (1setOf Type3 keyword)</a><span class='info'>CUPS 1.4</span></h4>
2673
2674 <p>The printer-commands attribute specifies the commands that are supported
2675 by the CUPS command file filter. The keyword "none" indicates that no commands
2676 are supported.</p>
2677
2678 <h4><a name="printer-dns-sd-name">printer-dns-sd-name (name(MAX) | noValue)</a><span class='info'>CUPS 1.4</span></h4>
2679
2680 <p>The printer-dns-sd-name attribute specifies the registered DNS-SD service
2681 name for the printer. If the printer is not being shared using this protocol,
2682 printer-dns-sd-name will have the noValue value.</p>
2683
2684 <h4><a name="printer-state-reasons">printer-state-reasons (1setOf type2 keyword)</a></h4>
2685
2686 <p>The printer-state-reasons attribute provides additional persistent state
2687 information for a printer. In addition to the keywords defined in RFC 2911,
2688 CUPS supports vendor-specific keywords with a domain prefix ("com.vendor.foo")
2689 and the following CUPS-specific keywords:</p>
2690
2691 <ul>
2692
2693         <li><tt>cups-insecure-filter-warning</tt> - a filter or backend (or the
2694         directory containing the filter or backend) has insecure file
2695         permissions. CUPS will not execute programs with world write permissions
2696         or setuid programs. When run as root (the default), CUPS also does not
2697         execute programs that are not owned by root.
2698         <span class='info'>CUPS 1.4</span></li>
2699
2700         <li><tt>cups-missing-filter-warning</tt> - a filter or backend is not
2701         installed. <span class='info'>CUPS 1.4</span></li>
2702
2703 </ul>
2704
2705 <h4><a name="printer-type">printer-type (type2 enum)</a></h4>
2706
2707 <p>The printer-type attribute specifies printer type and
2708 capability bits for the printer or class. The default value is
2709 computed from internal state information and the PPD file for the
2710 printer. The following bits are defined:</p>
2711
2712 <div class='table'><table align='center' border='1' width='80%'
2713 summary='Printer Type Bits'>
2714 <thead>
2715 <tr>
2716         <th>Bit</th>
2717         <th>Description</th>
2718 </tr>
2719 </thead>
2720 <tbody>
2721 <tr>
2722         <td>0x00000001</td>
2723         <td>Is a printer class.</td>
2724 </tr>
2725 <tr>
2726         <td>0x00000002</td>
2727         <td>Is a remote destination.</td>
2728 </tr>
2729 <tr>
2730         <td>0x00000004</td>
2731         <td>Can print in black.</td>
2732 </tr>
2733 <tr>
2734         <td>0x00000008</td>
2735         <td>Can print in color.</td>
2736 </tr>
2737 <tr>
2738         <td>0x00000010</td>
2739         <td>Can print on both sides of the page in hardware.</td>
2740 </tr>
2741 <tr>
2742         <td>0x00000020</td>
2743         <td>Can staple output.</td>
2744 </tr>
2745 <tr>
2746         <td>0x00000040</td>
2747         <td>Can do fast copies in hardware.</td>
2748 </tr>
2749 <tr>
2750         <td>0x00000080</td>
2751         <td>Can do fast copy collation in hardware.</td>
2752 </tr>
2753 <tr>
2754         <td>0x00000100</td>
2755         <td>Can punch output.</td>
2756 </tr>
2757 <tr>
2758         <td>0x00000200</td>
2759         <td>Can cover output.</td>
2760 </tr>
2761 <tr>
2762         <td>0x00000400</td>
2763         <td>Can bind output.</td>
2764 </tr>
2765 <tr>
2766         <td>0x00000800</td>
2767         <td>Can sort output.</td>
2768 </tr>
2769 <tr>
2770         <td>0x00001000</td>
2771         <td>Can handle media up to US-Legal/A4.</td>
2772 </tr>
2773 <tr>
2774         <td>0x00002000</td>
2775         <td>Can handle media from US-Legal/A4 to ISO-C/A2.</td>
2776 </tr>
2777 <tr>
2778         <td>0x00004000</td>
2779         <td>Can handle media larger than ISO-C/A2.</td>
2780 </tr>
2781 <tr>
2782         <td>0x00008000</td>
2783         <td>Can handle user-defined media sizes.</td>
2784 </tr>
2785 <tr>
2786         <td>0x00010000</td>
2787         <td>Is an implicit (server-generated) class.</td>
2788 </tr>
2789 <tr>
2790         <td>0x00020000</td>
2791         <td>Is the a default printer on the network.</td>
2792 </tr>
2793 <tr>
2794         <td>0x00040000</td>
2795         <td>Is a facsimile device.</td>
2796 </tr>
2797 <tr>
2798         <td>0x00080000</td>
2799         <td>Is rejecting jobs.</td>
2800 </tr>
2801 <tr>
2802         <td>0x00100000</td>
2803         <td>Delete this queue.</td>
2804 </tr>
2805 <tr>
2806         <td>0x00200000</td>
2807         <td>Queue is not shared.</td>
2808 </tr>
2809 <tr>
2810         <td>0x00400000</td>
2811         <td>Queue requires authentication.</td>
2812 </tr>
2813 <tr>
2814         <td>0x00800000</td>
2815         <td>Queue supports CUPS command files.</td>
2816 </tr>
2817 <tr>
2818         <td>0x01000000</td>
2819         <td>Queue was automatically discovered and added.</td>
2820 </tr>
2821 <tr>
2822         <td>0x02000000</td>
2823         <td>Queue is a scanner with no printing capabilities.</td>
2824 </tr>
2825 <tr>
2826         <td>0x04000000</td>
2827         <td>Queue is a printer with scanning capabilities.</td>
2828 </tr>
2829 </tbody>
2830 </table></div>
2831
2832 <h4>printer-type-mask (type2 enum)<span class='info'>CUPS 1.1</span></h4>
2833
2834 <p>The printer-type-mask attribute is used to choose printers or classes with
2835 the CUPS-Get-Printers and CUPS-Get-Classes operations. The bits are defined
2836 identically to the printer-type attribute and default to all 1's.
2837
2838 <h4>requesting-user-name-allowed (1setof name(127))<span class='info'>CUPS 1.1</span></h4>
2839
2840 <p>The requesting-user-name-allowed attribute lists all of the users that are
2841 allowed to access a printer or class. Either this attribute or the
2842 requesting-user-name-denied attribute will be defined, but not both.
2843
2844 <h4>requesting-user-name-denied (1setof name(127))<span class='info'>CUPS 1.1</span></h4>
2845
2846 <p>The requesting-user-name-denied attribute lists all of the users that are
2847 not allowed to access a printer or class. Either this attribute or the
2848 requesting-user-name-allowed attribute will be defined, but not both.
2849
2850 <h3 class='title'><a name='CLASS_ATTRIBUTES'>Printer Class Attributes</a></h3>
2851
2852 <h4>member-names (1setof name(127))</h4>
2853
2854 <p>The member-names attribute specifies each of the printer-name attributes of
2855 the member printers and classes. Each name corresponds to the same element of
2856 the member-uris attribute.
2857
2858 <h4>member-uris (1setof uri)</h4>
2859
2860 <p>The member-uris attribute specifies each of the printer-uri attributes of
2861 the member printers and classes. Each URI corresponds to the same element of
2862 the member-names attribute.
2863
2864 </body>
2865 </html>