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