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