doc/help/spec-ipp.html

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