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