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