1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
3 <!-- SECTION: Specifications -->
5 <title>CUPS Implementation of IPP
</title>
6 <meta name='keywords' content='Programming, Internet Printing Protocol'
>
7 <LINK REL=
"STYLESHEET" TYPE=
"text/css" HREF=
"../cups-printable.css">
13 CUPS IPP specification for CUPS.
15 Copyright 2007-2013 by Apple Inc.
16 Copyright 1997-2007 by Easy Software Products.
18 These coded instructions, statements, and computer programs are the
19 property of Apple Inc. and are protected by Federal copyright
20 law. Distribution and use rights are outlined in the file "LICENSE.txt"
21 which should have been included with this file. If this file is
22 file is missing or damaged, see the license at "http://www.cups.org/".
25 <H1 CLASS=
"title">CUPS Implementation of IPP
</H1>
27 <h2 class='title'
><a name='INTRODUCTION'
>Introduction
</a></h2>
29 <p>CUPS implements IPP/
2.1 and the operations and attributes
30 defined in the
"IPP: Job and Printer Set Operations",
"IPP/1.1:
31 Output-bin Attribute Extension", and
"IPP/1.1: finishings
32 'fold',' trim', and 'bale' attribute values extension"
35 <p>CUPS also provides
16 new operations and many new attributes
36 to support multiple IPP printers and printer classes on a single
39 <h3 class='title'
><a name='IPP_URIS'
>IPP URIs
</a></h3>
41 <p>CUPS supports the
"http",
"https", and
"ipp" schemes. The
42 following resource names are used:
</p>
46 <dt><tt>scheme://hostname:port/
</tt></dt>
48 <dd>Can be used for all
"get" operations and for server
51 <dt><tt>scheme://hostname:port/admin/
</tt></dt>
53 <dd>Used for all administrative operations.
</dd>
55 <dt><tt>scheme://hostname:port/classes/name
</tt></dt>
57 <dd>Specifies a printer class.
</dd>
59 <dt><tt>scheme://hostname:port/jobs/id
</tt></dt>
61 <dd>Specifies a job.
</dd>
63 <dt><tt>scheme://hostname:port/printers/name
</tt></dt>
65 <dd>Specifies a printer.
</dd>
69 <p>So a typical printer URI would be
70 "ipp://foo.bar.com/printers/LaserJet". In addition, the CUPS
71 server also supports normal browser access via
72 "http://hostname:port/" and
"https://hostname:port/".
</p>
74 <h3 class='title'
><a name='IPP_OPERATIONS'
>CUPS IPP Operations
</a></h3>
76 <p>CUPS provides
16 extension operations in addition to most of the
77 standard IPP and registered extension operations:
79 <div class='table'
><table align='center' border='
1' width='
80%'
80 summary='Supported Operations'
>
83 <TH VALIGN=
"TOP">Operation Name
</th>
84 <TH VALIGN=
"TOP">CUPS
</th>
85 <TH VALIGN=
"TOP">Code
</th>
86 <TH VALIGN=
"TOP">Brief Description
</th>
91 <td><a href='#PRINT_JOB'
>Print-Job
</a></td>
94 <td>Print a file.
</td>
100 <td>Validate job attributes.
</td>
103 <td><a href='#CREATE_JOB'
>Create-Job
</a></td>
106 <td>Create a print job.
</td>
109 <td>Send-Document
</td>
112 <td>Send a file for a print job.
</td>
115 <td><a href='#CANCEL_JOB'
>Cancel-Job
</a></td>
118 <td>Cancel a print job.
</td>
121 <td>Get-Job-Attributes
</td>
124 <td>Get job attributes.
</td>
130 <td>Get all jobs.
</td>
133 <td>Get-Printer-Attributes
</td>
136 <td>Get printer attributes.
</td>
142 <td>Hold a job for printing.
</td>
148 <td>Release a job for printing.
</td>
154 <td>Restarts a print job.
</td>
157 <td>Pause-Printer
</td>
160 <td>Pause printing on a printer.
</td>
163 <td>Resume-Printer
</td>
166 <td>Resume printing on a printer.
</td>
169 <td><a href='#PURGE_JOBS'
>Purge-Jobs
</a></td>
172 <td>Purge all jobs.
</td>
175 <td><a href='#SET_JOB_ATTRIBUTES'
>Set-Job-Attributes
</a></td>
178 <td>Set attributes for a pending or held job.
</td>
181 <td><a href='#CREATE_PRINTER_SUBSCRIPTION'
>Create-Printer-Subscription
</a></td>
184 <td>Creates a subscription associated with a printer or the server.
</td>
187 <td>Create-Job-Subscription
</td>
190 <td>Creates a subscription associated with a job.
</td>
193 <td>Get-Subscription-Attributes
</td>
196 <td>Gets the attributes for a subscription.
</td>
199 <td>Get-Subscriptions
</td>
202 <td>Gets the attributes for zero or more subscriptions.
</td>
205 <td>Renew-Subscription
</td>
208 <td>Renews a subscription.
</td>
211 <td>Cancel-Subscription
</td>
214 <td>Cancels a subscription.
</td>
217 <td>Get-Notifications
</td>
220 <td>Get notification events for
<tt>ippget
</tt> subscriptions.
</td>
223 <td>Enable-Printer
</td>
226 <td>Accepts jobs on a printer.
</td>
229 <td>Disable-Printer
</td>
232 <td>Rejects jobs on a printer.
</td>
235 <td><a href='#CUPS_GET_DEFAULT'
>CUPS-Get-Default
</a></td>
238 <td>Get the default destination.
</td>
241 <td><a href='#CUPS_GET_PRINTERS'
>CUPS-Get-Printers
</a></td>
244 <td>Get all of the available printers.
</td>
247 <td><a href='#CUPS_ADD_MODIFY_PRINTER'
>CUPS-Add-Modify-Printer
</a></td>
250 <td>Add or modify a printer.
</td>
253 <td><a href='#CUPS_DELETE_PRINTER'
>CUPS-Delete-Printer
</a></td>
256 <td>Delete a printer.
</td>
259 <td><a href='#CUPS_GET_CLASSES'
>CUPS-Get-Classes
</a></td>
262 <td>Get all of the available printer classes.
</td>
265 <td><a href='#CUPS_ADD_MODIFY_CLASS'
>CUPS-Add-Modify-Class
</a></td>
268 <td>Add or modify a printer class.
</td>
271 <td><a href='#CUPS_DELETE_CLASS'
>CUPS-Delete-Class
</a></td>
274 <td>Delete a printer class.
</td>
277 <td><a href='#CUPS_ACCEPT_JOBS'
>CUPS-Accept-Jobs
</a></td>
280 <td>Accept jobs on a printer or printer class.
</td>
283 <td><a href='#CUPS_REJECT_JOBS'
>CUPS-Reject-Jobs
</a></td>
286 <td>Reject jobs on a printer or printer class.
</td>
289 <td><a href='#CUPS_SET_DEFAULT'
>CUPS-Set-Default
</a></td>
292 <td>Set the default destination.
</td>
295 <td><a href='#CUPS_GET_DEVICES'
>CUPS-Get-Devices
</a></td>
298 <td>Get all of the available devices.
</td>
301 <td><a href='#CUPS_GET_PPDS'
>CUPS-Get-PPDs
</a></td>
304 <td>Get all of the available PPDs.
</td>
307 <td><a href='#CUPS_MOVE_JOB'
>CUPS-Move-Job
</a></td>
310 <td>Move a job to a different printer.
</td>
313 <td><a href='#CUPS_AUTHENTICATE_JOB'
>CUPS-Authenticate-Job
</a></td>
316 <td>Authenticate a job for printing.
</td>
319 <td><a href='#CUPS_GET_PPD'
>CUPS-Get-PPD
</a></td>
322 <td>Get a PPD file.
</td>
325 <td><a href='#CUPS_GET_DOCUMENT'
>CUPS-Get-Document
</a></td>
328 <td>Get a document file from a job.
</td>
333 <h2 class='title'
><a name='OPERATIONS'
>Operations
</a></h2>
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.
339 <h3 class='title'
><a name='PRINT_JOB'
>Print-Job Operation
</a></h3>
341 <p>The Print-Job operation (
0x0002) prints a file.
343 <h4>Print-Job Request
</h4>
345 <p>The following groups of attributes are supplied as part of the
348 <p>Group
1: Operation Attributes
352 <dt>Natural Language and Character Set:
354 <dd>The
"attributes-charset" and
"attributes-natural-language"
355 attributes as described in section
3.1.4.1 of the IPP Model and
358 <dt>"printer-uri" (uri):
360 <dd>The client MUST supply a URI for the specified printer.
364 <p>Group
2: Job Template Attributes
368 <dt>"auth-info" (
1setOf text(MAX)):
<span class='info'
>CUPS
1.3/OS X
10.5</span>
370 <dd>The client OPTIONALLY supplies one or more authentication values as specified by the
"auth-info-required" attribute.
372 <dt>"job-billing" (text(MAX))
<span class='info'
>CUPS
1.1</span> or
373 "job-account-id (text(MAX))"<span class='info'
>CUPS
1.7</span>:
375 <dd>The client OPTIONALLY supplies a billing string that is logged
376 with the page accounting information.
378 <dt>"job-sheets" (
1setof type3 keyword | name(MAX)):
<span class='info'
>CUPS
1.1</span>
380 <dd>The client OPTIONALLY supplies one or two banner pages that
381 are printed before and after any files in the print job. The
382 name of
"none" is reserved to indicate that no banner page
383 should be printed. If the client does not specify this
384 attribute then the value of the
"job-sheets-default" printer
385 object attribute is used.
387 <blockquote><b>Note:
</b> Standard IPP only allows
388 specification of a single job-sheets attribute
391 <dt>"media" (
1setof type3 keyword | name(MAX)):
393 <dd>The client OPTIONALLY supplies one or more media attributes
394 specifying the size, type, source, and color of the output
395 media. If the client does not specify this attribute then the
396 value of the
"media-default" printer object attribute is used.
398 <blockquote><b>Note:
</b> Standard IPP only allows
399 specification of a single media attribute
402 <dt>Other Job Template Attributes
406 <p>The Print-Job request is followed by a file to be printed.
408 <h4>Print-Job Response
</h4>
410 <p>The following groups of attributes are send as part of the Print-Job
413 <p>Group
1: Operation Attributes
419 <dd>The standard response status message.
421 <dt>Natural Language and Character Set:
423 <dd>The
"attributes-charset" and
"attributes-natural-language"
424 attributes as described in section
3.1.4.2 of the IPP Model and
429 <p>Group
2: Job Attributes
433 <dt>Standard Job Attributes
437 <p>Group
3: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
441 <dt>auth-info-required (
1setOf Type2 keyword)
443 <dd>The required authentication information.
447 <h3 class='title'
><span class='info'
>CUPS
1.1</span><a name='CREATE_JOB'
>Create-Job Operation
</a></h3>
449 <p>The Create-Job operation (
0x0005) creates a new, empty print job.
451 <h4>Create-Job Request
</h4>
453 <p>The following groups of attributes are supplied as part of the
456 <p>Group
1: Operation Attributes
460 <dt>Natural Language and Character Set:
462 <dd>The
"attributes-charset" and
"attributes-natural-language"
463 attributes as described in section
3.1.4.1 of the IPP Model and
466 <dt>"printer-uri" (uri):
468 <dd>The client MUST supply a URI for the specified printer.
472 <p>Group
2: Job Template Attributes
476 <dt>"auth-info" (
1setOf text(MAX)):
<span class='info'
>CUPS
1.3/OS X
10.5</span>
478 <dd>The client OPTIONALLY supplies one or more authentication values as specified by the
"auth-info-required" attribute.
480 <dt>"job-billing" (text(MAX))
<span class='info'
>CUPS
1.1</span> or
481 "job-account-id (text(MAX))<span class='info'>CUPS 1.7</span>:
483 <dd>The client OPTIONALLY supplies a billing string that is logged
484 with the page accounting information.
486 <dt>"job-sheets
" (1setof type3 keyword | name(MAX)):<span class='info'>CUPS 1.1</span>
488 <dd>The client OPTIONALLY supplies one or two banner pages that
489 are printed before and after any files in the print job. The
490 name of "none
" is reserved to indicate that no banner page
491 should be printed. If the client does not specify this
492 attribute then the value of the "job-sheets-default
" printer
493 object attribute is used.
495 <blockquote><b>Note:</b> Standard IPP only allows
496 specification of a single job-sheets attribute
499 <dt>"media
" (1setof type3 keyword | name(MAX)):
501 <dd>The client OPTIONALLY supplies one or more media attributes
502 specifying the size, type, source, and color of the output
503 media. If the client does not specify this attribute then the
504 value of the "media-default
" printer object attribute is used.
506 <blockquote><b>Note:</b> Standard IPP only allows
507 specification of a single media attribute
510 <dt>Standard Job Template Attributes
514 <h4>Create-Job Response</h4>
516 <p>The following groups of attributes are send as part of the
519 <p>Group 1: Operation Attributes
525 <dd>The standard response status message.
527 <dt>Natural Language and Character Set:
529 <dd>The "attributes-charset
" and "attributes-natural-language
"
530 attributes as described in section 3.1.4.2 of the IPP Model and
535 <p>Group 2: Job Attributes
539 <dt>Standard Job Attributes
543 <p>Group 3: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
547 <dt>auth-info-required (1setOf Type2 keyword)
549 <dd>The required authentication information.
553 <h3 class='title'><a name='CANCEL_JOB'>Cancel Job Operation</a></h3>
555 <p>The Cancel-Job operation (0x0008) cancels the specified job. CUPS 1.4 adds
556 a new <tt>purge-job (boolean)</tt> attribute that allows you to purge both
557 active and completed jobs, removing all history and document files for the
560 <h4>Cancel-Job Request</h4>
562 <p>The following groups of attributes are supplied as part of the
565 <p>Group 1: Operation Attributes
569 <dt>Natural Language and Character Set:
571 <dd>The "attributes-charset
" and "attributes-natural-language
"
572 attributes as described in section 3.1.4.1 of the IPP Model and
575 <dt>"printer-uri
" (uri) and "job-id
" (integer)
579 <dd>The client MUST supply a URI for the specified printer and
580 a job ID number, or the job URI.
582 <dt><span class="info
">CUPS 1.4/OS X 10.6</span>"purge-job
" (boolean):
584 <dd>The client OPTIONALLY supplies this attribute. When true,
585 all job files (history and document) are purged. The default
586 is false, leading to the standard IPP behavior.
590 <h4>Cancel-Job Response</h4>
592 <p>The following groups of attributes are send as part of the Cancel-Job
595 <p>Group 1: Operation Attributes
601 <dd>The standard response status message.
603 <dt>Natural Language and Character Set:
605 <dd>The "attributes-charset
" and "attributes-natural-language
"
606 attributes as described in section 3.1.4.2 of the IPP Model and
611 <h3 class='title'><a name='PURGE_JOBS'>Purge-Jobs Operation</a></h3>
613 <p>The Purge-Jobs operation (0x0012) cancels all of the jobs on a
614 given destination and optionally removes all history and document
615 files for the jobs as well.
617 <h4>Purge-Jobs Request</h4>
619 <p>The following groups of attributes are supplied as part of the
622 <p>Group 1: Operation Attributes
626 <dt>Natural Language and Character Set:
628 <dd>The "attributes-charset
" and "attributes-natural-language
"
629 attributes as described in section 3.1.4.1 of the IPP Model and
632 <dt>"printer-uri
" (uri):
634 <dd>The client MUST supply a URI for the specified printer or
635 "ipp://.../printers
" for all printers and classes.
637 <dt><span class="info
">CUPS 1.2/OS X 10.5</span>"requesting-user-name
" (name(MAX)):
639 <dd>The client OPTIONALLY supplies this attribute to specify whose jobs
640 jobs are purged or canceled.
642 <dt><span class="info
">CUPS 1.2/OS X 10.5</span>"my-jobs
" (boolean):
644 <dd>The client OPTIONALLY supplies this attribute to specify that only
645 the jobs owned by the requesting user are purged or canceled. The
648 <dt><span class="info
">CUPS 1.2/OS X 10.5</span>"purge-jobs
" (boolean):
650 <dd>The client OPTIONALLY supplies this attribute to specify
651 whether the jobs are purged (true) or just canceled (false).
656 <h4>Purge-Jobs Response</h4>
658 <p>The following groups of attributes are send as part of the Purge-Jobs
661 <p>Group 1: Operation Attributes
667 <dd>The standard response status message.
669 <dt>Natural Language and Character Set:
671 <dd>The "attributes-charset
" and "attributes-natural-language
"
672 attributes as described in section 3.1.4.2 of the IPP Model and
677 <h3 class='title'><span class='info'>CUPS 1.1</span><a name='SET_JOB_ATTRIBUTES'>Set-Job-Attributes Operation</a></h3>
679 <p>The Set-Job-Attributes operation (0x0014) changes the attributes of
680 an active (not completed) job.
682 <h4>Set-Job-Attributes Request</h4>
684 <p>The following groups of attributes are supplied as part of the
685 Set-Job-Attributes request:
687 <p>Group 1: Operation Attributes
691 <dt>Natural Language and Character Set:
693 <dd>The "attributes-charset
" and "attributes-natural-language
"
694 attributes as described in section 3.1.4.1 of the IPP Model and
697 <dt>"printer-uri
" (uri) and "job-id
" (integer)
701 <dd>The client MUST supply a URI for the specified printer and
702 a job ID number, or the job URI.
706 <p>Group 2: Job Template Attributes
710 <dt>"job-sheets
" (1setof type3 keyword | name(MAX)):<span class='info'>CUPS 1.1</span>
712 <dd>The client OPTIONALLY supplies one or two banner pages that
713 are printed before and after any files in the print job. The
714 name of "none
" is reserved to indicate that no banner page
715 should be printed. If the client does not specify this
716 attribute then the value of the "job-sheets-default
" printer
717 object attribute is used.
719 <blockquote><b>Note:</b> Standard IPP only allows
720 specification of a single job-sheets attribute
723 <dt>"media
" (1setof type3 keyword | name(MAX)):
725 <dd>The client OPTIONALLY supplies one or more media attributes
726 specifying the size, type, source, and color of the output
727 media. If the client does not specify this attribute then the
728 value of the "media-default
" printer object attribute is used.
730 <blockquote><b>Note:</b> Standard IPP only allows
731 specification of a single media attribute
734 <dt>Other Job Template Attributes
738 <h4>Set-Job-Attributes Response</h4>
740 <p>The following groups of attributes are send as part of the Set-Job-Attributes
743 <p>Group 1: Operation Attributes
749 <dd>The standard response status message.
751 <dt>Natural Language and Character Set:
753 <dd>The "attributes-charset
" and "attributes-natural-language
"
754 attributes as described in section 3.1.4.2 of the IPP Model and
759 <h3 class='title'><span class='info'>CUPS 1.2/OS X 10.5</span><a
760 name='CREATE_PRINTER_SUBSCRIPTION'>Create-Printer-Subscription</a></h3>
762 <p>The Create-Printer-Subscription operation (0x0016) creates a
763 subscription for printer or server event notifications. CUPS
764 provides several additional events in addition to the standard
765 events in the IPP notifications specification.</p>
767 <h4>Create-Printer-Subscription Request</h4>
769 <p>The following groups of attributes are supplied as part of the
772 <p>Group 1: Operation Attributes</p>
776 <dt>Natural Language and Character Set:
778 <dd>The "attributes-charset
" and "attributes-natural-language
"
779 attributes as described in section 3.1.4.1 of the IPP Model and
782 <dt>"printer-uri
" (uri):
785 (<tt>ipp://server/printers/printername</tt>), class
786 (<tt>ipp://server/classes/classname</tt>), or server
787 (<tt>ipp://server/</tt>) URI for event notifications.
789 <dt>"notify-events
" (1setOf keyword):
791 <dd>The events to monitor. In addition to the standard
792 events, CUPS adds the following keywords:
795 <li><tt>printer-added</tt> - Get notified
796 whenever a printer or class is added</li>
798 <li><tt>printer-deleted</tt> - Get notified
799 whenever a printer or class is deleted</li>
801 <li><tt>printer-modified</tt> - Get notified
802 whenever a printer or class is modified</li>
804 <li><tt>server-audit</tt> - Get notified when a
805 security condition occurs</li>
807 <li><tt>server-restarted</tt> - Get notified when
808 the server is restarted</li>
810 <li><tt>server-started</tt> - Get notified when
811 the server is started</li>
813 <li><tt>server-stopped</tt> - Get notified when
814 the server is stopped</li>
820 <h4>Create-Printer-Subscription Response</h4>
822 <p>The following groups of attributes are send as part of the
825 <p>Group 1: Operation Attributes</p>
831 <dd>The standard response status message.
833 <dt>Natural Language and Character Set:
835 <dd>The "attributes-charset
" and "attributes-natural-language
"
836 attributes as described in section 3.1.4.2 of the IPP Model and
841 <p>Group 2: Subscription Object Attributes</p>
845 <dt>"subscription-id
" (integer):
847 <dd>The subscription number.
851 <h3 class='title'><a name='CUPS_GET_DEFAULT'>CUPS-Get-Default Operation</a></h3>
853 <p>The CUPS-Get-Default operation (0x4001) returns the default printer
856 <h4>CUPS-Get-Default Request</h4>
858 <p>The following groups of attributes are supplied as part of the
859 CUPS-Get-Default request:
861 <p>Group 1: Operation Attributes
865 <dt>Natural Language and Character Set:
867 <dd>The "attributes-charset
" and "attributes-natural-language
"
868 attributes as described in section 3.1.4.1 of the IPP Model and
871 <dt>"requested-attributes
" (1setOf keyword) :
873 <dd>The client OPTIONALLY supplies a set of attribute names
874 and/or attribute group names in whose values the requester is
875 interested. If the client omits this attribute, the server
876 responds as if this attribute had been supplied with a value of
881 <h4>CUPS-Get-Default Response</h4>
883 <p>The following groups of attributes are send as part of the
884 CUPS-Get-Default Response:
886 <p>Group 1: Operation Attributes
892 <dd>The standard response status message.
894 <dt>Natural Language and Character Set:
896 <dd>The "attributes-charset
" and "attributes-natural-language
"
897 attributes as described in section 3.1.4.2 of the IPP Model and
902 <p>Group 2: Printer Object Attributes
906 <dt>The set of requested attributes and their current values.
910 <h3 class='title'><a name='CUPS_GET_PRINTERS'>CUPS-Get-Printers Operation</a></h3>
912 <p>The CUPS-Get-Printers operation (0x4002) returns the printer
913 attributes for every printer known to the system. This may include
914 printers that are not served directly by the server.
916 <h4>CUPS-Get-Printers Request</h4>
918 <p>The following groups of attributes are supplied as part of the
919 CUPS-Get-Printers request:
921 <p>Group 1: Operation Attributes
925 <dt>Natural Language and Character Set:
927 <dd>The "attributes-charset
" and "attributes-natural-language
"
928 attributes as described in section 3.1.4.1 of the IPP Model and
931 <dt>"first-printer-name
" (name(127)):<span class='info'>CUPS 1.2/OS X 10.5</span>
933 <dd>The client OPTIONALLY supplies this attribute to
934 select the first printer that is returned.
936 <dt>"limit
" (integer (1:MAX)):
938 <dd>The client OPTIONALLY supplies this attribute limiting the
939 number of printers that are returned.
941 <dt>"printer-location
" (text(127)): <span class='info'>CUPS 1.1.7</span>
943 <dd>The client OPTIONALLY supplies this attribute to
944 select which printers are returned.
946 <dt>"printer-type
" (type2 enum): <span class='info'>CUPS 1.1.7</span>
948 <dd>The client OPTIONALLY supplies a printer type enumeration to
949 select which printers are returned.
951 <dt>"printer-type-mask
" (type2 enum): <span class='info'>CUPS 1.1.7</span>
953 <dd>The client OPTIONALLY supplies a printer type mask
954 enumeration to select which bits are used in the "printer-type
"
957 <dt>"requested-attributes
" (1setOf keyword) :
959 <dd>The client OPTIONALLY supplies a set of attribute names
960 and/or attribute group names in whose values the requester is
961 interested. If the client omits this attribute, the server
962 responds as if this attribute had been supplied with a value of
965 <dt>"requested-user-name
" (name(127)) : <span class='info'>CUPS 1.2/OS X 10.5</span>
967 <dd>The client OPTIONALLY supplies a user name that is used to filter
968 the returned printers.
972 <h4>CUPS-Get-Printers Response</h4>
974 <p>The following groups of attributes are send as part of the
975 CUPS-Get-Printers Response:
977 <p>Group 1: Operation Attributes
983 <dd>The standard response status message.
985 <dt>Natural Language and Character Set:
987 <dd>The "attributes-charset
" and "attributes-natural-language
"
988 attributes as described in section 3.1.4.2 of the IPP Model and
993 <p>Group 2: Printer Object Attributes
997 <dt>The set of requested attributes and their current values for
1002 <h3 class='title'><a name='CUPS_ADD_MODIFY_PRINTER'>CUPS-Add-Modify-Printer Operation</a></h3>
1004 <p>The CUPS-Add-Modify-Printer operation (0x4003) adds a new printer or
1005 modifies an existing printer on the system.
1007 <h4>CUPS-Add-Modify-Printer Request</h4>
1009 <p>The following groups of attributes are supplied as part of the
1010 CUPS-Add-Modify-Printer request:
1012 <p>Group 1: Operation Attributes
1016 <dt>Natural Language and Character Set:
1018 <dd>The "attributes-charset
" and "attributes-natural-language
"
1019 attributes as described in section 3.1.4.1 of the IPP Model and
1022 <dt>"printer-uri
" (uri):
1024 <dd>The client MUST supply a URI for the specified printer.
1028 <p>Group 2: Printer Object Attributes
1032 <dt>"auth-info-required
" (1setOf type2 keyword):<span class='info'>CUPS 1.3/OS X 10.5</span>
1034 <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
1036 <dt>"job-sheets-default
" (1setOf name(127)): <span
1037 class='info'>CUPS 1.1.7</span>
1039 <dd>The client OPTIONALLY supplies one or two banner page
1040 names that are printed before and after files in a job.
1041 The reserved name "none
" is used to specify that no
1042 banner page should be printed.
1044 <dt>"device-uri
" (uri):
1046 <dd>The client OPTIONALLY supplies a device URI for the
1049 <dt>"port-monitor
" (name(127)):
1051 <dd>The client OPTIONALLY supplies a port monitor name for the
1054 <dt>"ppd-name
" (name(127)):
1056 <dd>The client OPTIONALLY supplies a PPD name for the specified
1059 <dt>"printer-is-accepting-jobs
" (boolean):
1061 <dd>The client OPTIONALLY supplies this boolean attribute
1062 indicating whether or not the printer object should accept new jobs.
1064 <dt>"printer-info
" (text(127)):
1066 <dd>The client OPTIONALLY supplies this attribute indicating the
1067 printer information string.
1069 <dt>"printer-location
" (text(127)):
1071 <dd>The client OPTIONALLY supplies this attribute indicating a
1072 textual location of the printer.
1074 <dt>"printer-more-info
" (uri):
1076 <dd>The client OPTIONALLY supplies this attribute indicating a
1077 URI for additional printer information.
1079 <dt>"printer-state
" (type2 enum):
1081 <dd>The client OPTIONALLY supplies this attribute indicating the
1082 initial/current state of the printer. Only the "idle
" and "stopped
"
1083 enumerations are recognized.
1085 <dt>"printer-state-message
" (text(MAX)):
1087 <dd>The client OPTIONALLY supplies this attribute indicating a
1088 textual reason for the current printer state.
1090 <dt>"requesting-user-name-allowed
" (1setof name(127) | delete)
1092 <br>"requesting-user-name-denied
" (1setof name(127) | delete):
1094 <dd>The client OPTIONALLY supplies one of these attributes to
1095 specify an access control list for incoming print jobs. To allow
1096 all users access to a printer, use the delete tag for the
1101 <p>The CUPS-Add-Modify-Printer request can optionally be followed by a PPD
1102 file or System V interface script to be used for the printer. The
1103 "ppd-name
" attribute overrides any file that is attached to the end of
1104 the request with a local CUPS PPD file.
1106 <h4>CUPS-Add-Modify-Printer Response</h4>
1108 <p>The following groups of attributes are send as part of the
1109 CUPS-Add-Modify-Printer Response:
1111 <p>Group 1: Operation Attributes
1117 <dd>The standard response status message.
1119 <dt>Natural Language and Character Set:
1121 <dd>The "attributes-charset
" and "attributes-natural-language
"
1122 attributes as described in section 3.1.4.2 of the IPP Model and
1127 <h3 class='title'><a name='CUPS_DELETE_PRINTER'>CUPS-Delete-Printer Operation</a></h3>
1129 <p>The CUPS-Delete-Printer operation (0x4004) removes an existing
1130 printer from the system.
1132 <h4>CUPS-Delete-Printer Request</h4>
1134 <p>The following groups of attributes are supplied as part of the
1135 CUPS-Delete-Printer request:
1137 <p>Group 1: Operation Attributes
1141 <dt>Natural Language and Character Set:
1143 <dd>The "attributes-charset
" and "attributes-natural-language
"
1144 attributes as described in section 3.1.4.1 of the IPP Model and
1147 <dt>"printer-uri
" (uri):
1149 <dd>The client MUST supply a URI for the specified printer.
1153 <h4>CUPS-Delete-Printer Response</h4>
1155 <p>The following groups of attributes are send as part of the
1156 CUPS-Delete-Printer Response:
1158 <p>Group 1: Operation Attributes
1164 <dd>The standard response status message.
1166 <dt>Natural Language and Character Set:
1168 <dd>The "attributes-charset
" and "attributes-natural-language
"
1169 attributes as described in section 3.1.4.2 of the IPP Model and
1174 <h3 class='title'><a name='CUPS_GET_CLASSES'>CUPS-Get-Classes Operation</a></h3>
1176 <p>The CUPS-Get-Classes operation (0x4005) returns the printer
1177 attributes for every printer class known to the system. This may
1178 include printer classes that are not served directly by the server.
1180 <h4>CUPS-Get-Classes Request</h4>
1182 <p>The following groups of attributes are supplied as part of the
1183 CUPS-Get-Classes request:
1185 <p>Group 1: Operation Attributes
1189 <dt>Natural Language and Character Set:
1191 <dd>The "attributes-charset
" and "attributes-natural-language
"
1192 attributes as described in section 3.1.4.1 of the IPP Model and
1195 <dt>"first-printer-name
" (name(127)):<span class='info'>CUPS 1.2/OS X 10.5</span>
1197 <dd>The client OPTIONALLY supplies this attribute to
1198 select the first printer that is returned.
1200 <dt>"limit
" (integer (1:MAX)):
1202 <dd>The client OPTIONALLY supplies this attribute limiting the
1203 number of printer classes that are returned.
1205 <dt>"printer-location
" (text(127)): <span class='info'>CUPS 1.1.7</span>
1206 <dd>The client OPTIONALLY supplies this attribute to
1207 select which printer classes are returned.
1209 <dt>"printer-type
" (type2 enum): <span class='info'>CUPS 1.1.7</span>
1210 <dd>The client OPTIONALLY supplies a printer type enumeration to
1211 select which printer classes are returned.
1213 <dt>"printer-type-mask
" (type2 enum): <span class='info'>CUPS 1.1.7</span>
1214 <dd>The client OPTIONALLY supplies a printer type mask
1215 enumeration to select which bits are used in the "printer-type
"
1218 <dt>"requested-attributes
" (1setOf keyword) :
1220 <dd>The client OPTIONALLY supplies a set of attribute names
1221 and/or attribute group names in whose values the requester is
1222 interested. If the client omits this attribute, the server responds as
1223 if this attribute had been supplied with a value of 'all'.
1225 <dt>"requested-user-name
" (name(127)) : <span class='info'>CUPS 1.2/OS X 10.5</span>
1227 <dd>The client OPTIONALLY supplies a user name that is used to filter
1228 the returned printers.
1232 <h4>CUPS-Get-Classes Response</h4>
1234 <p>The following groups of attributes are send as part of the
1235 CUPS-Get-Classes Response:
1237 <p>Group 1: Operation Attributes
1243 <dd>The standard response status message.
1245 <dt>Natural Language and Character Set:
1247 <dd>The "attributes-charset
" and "attributes-natural-language
"
1248 attributes as described in section 3.1.4.2 of the IPP Model and
1253 <p>Group 2: Printer Class Object Attributes
1257 <dt>The set of requested attributes and their current values for
1262 <h3 class='title'><a name='CUPS_ADD_MODIFY_CLASS'>CUPS-Add-Modify-Class Operation</a></h3>
1264 <p>The CUPS-Add-Modify-Class operation (0x4006) adds a new printer class or
1265 modifies and existing printer class on the system.
1267 <h4>CUPS-Add-Modify-Class Request</h4>
1269 <p>The following groups of attributes are supplied as part of the
1270 CUPS-Add-Modify-Class request:
1272 <p>Group 1: Operation Attributes
1276 <dt>Natural Language and Character Set:
1278 <dd>The "attributes-charset
" and "attributes-natural-language
"
1279 attributes as described in section 3.1.4.1 of the IPP Model and
1282 <dt>"printer-uri
" (uri):
1284 <dd>The client MUST supply a URI for the specified printer class.
1288 <p>Group 2: Printer Object Attributes
1292 <dt>"auth-info-required
" (1setOf type2 keyword):<span class='info'>CUPS 1.3/OS X 10.5</span>
1294 <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
1296 <dt>"member-uris
" (1setof uri):
1298 <dd>The client OPTIONALLY supplies the "member-uris
" set
1299 specifying the printers and printer classes that are part of the class.
1301 <dt>"printer-is-accepting-jobs
" (boolean):
1303 <dd>The client OPTIONALLY supplies this boolean attribute
1304 indicating whether or not the class object should accept new jobs.
1306 <dt>"printer-info
" (text(127)):
1308 <dd>The client OPTIONALLY supplies this attribute indicating the
1309 printer information string.
1311 <dt>"printer-location
" (text(127)):
1313 <dd>The client OPTIONALLY supplies this attribute indicating a
1314 textual location of the class.
1316 <dt>"printer-more-info
" (uri):
1318 <dd>The client OPTIONALLY supplies this attribute indicating a
1319 URI for additional class information.
1321 <dt>"printer-state
" (type2 enum):
1323 <dd>The client OPTIONALLY supplies this attribute indicating the
1324 initial/current state of the class. Only the "idle
" and "stopped
"
1325 enumerations are recognized.
1327 <dt>"printer-state-message
" (text(MAX)):
1329 <dd>The client OPTIONALLY supplies this attribute indicating a
1330 textual reason for the current class state.
1332 <dt>"requesting-user-name-allowed
" (1setof name(127))
1334 <br>"requesting-user-name-denied
" (1setof name(127)):
1336 <dd>The client OPTIONALLY supplies one of these attributes to
1337 specify an access control list for incoming print jobs. To allow
1338 all users access to a class, use the delete tag for the
1343 <h4>CUPS-Add-Modify-Class Response</h4>
1345 <p>The following groups of attributes are send as part of the CUPS-Add-Modify-Class Response:
1347 <p>Group 1: Operation Attributes
1353 <dd>The standard response status message.
1355 <dt>Natural Language and Character Set:
1357 <dd>The "attributes-charset
" and "attributes-natural-language
"
1358 attributes as described in section 3.1.4.2 of the IPP Model and
1363 <h3 class='title'><a name='CUPS_DELETE_CLASS'>CUPS-Delete-Class Operation</a></h3>
1365 <p>The CUPS-Delete-Class operation (0x4007) removes an existing printer
1366 class from the system.
1368 <h4>CUPS-Delete-Class Request</h4>
1370 <p>The following groups of attributes are supplied as part of the
1371 CUPS-Delete-Class request:
1373 <p>Group 1: Operation Attributes
1377 <dt>Natural Language and Character Set:
1379 <dd>The "attributes-charset
" and "attributes-natural-language
"
1380 attributes as described in section 3.1.4.1 of the IPP Model and
1383 <dt>"printer-uri
" (uri):
1385 <dd>The client MUST supply a URI for the specified printer class.
1389 <h4>CUPS-Delete-Class Response</h4>
1391 <p>The following groups of attributes are send as part of the
1392 CUPS-Delete-Class Response:
1394 <p>Group 1: Operation Attributes
1400 <dd>The standard response status message.
1402 <dt>Natural Language and Character Set:
1404 <dd>The "attributes-charset
" and "attributes-natural-language
"
1405 attributes as described in section 3.1.4.2 of the IPP Model and
1410 <h3 class='title'><a name='CUPS_ACCEPT_JOBS'>CUPS-Accept-Jobs Operation</a></h3>
1412 <p>The CUPS-Accept-Jobs operation (0x4008) sets the
1413 "printer-is-accepting-jobs
" attribute to true for the specified printer
1416 <h4>CUPS-Accept-Jobs Request</h4>
1418 <p>The following groups of attributes are supplied as part of the
1419 CUPS-Accept-Jobs request:
1421 <p>Group 1: Operation Attributes
1425 <dt>Natural Language and Character Set:
1427 <dd>The "attributes-charset
" and "attributes-natural-language
"
1428 attributes as described in section 3.1.4.1 of the IPP Model and
1431 <dt>"printer-uri
" (uri):
1433 <dd>The client MUST supply a URI for the specified printer or printer class.
1437 <h4>CUPS-Accept-Jobs Response</h4>
1439 <p>The following groups of attributes are send as part of the
1440 CUPS-Accept-Jobs Response:
1442 <p>Group 1: Operation Attributes
1448 <dd>The standard response status message.
1450 <dt>Natural Language and Character Set:
1452 <dd>The "attributes-charset
" and "attributes-natural-language
"
1453 attributes as described in section 3.1.4.2 of the IPP Model and
1458 <h3 class='title'><a name='CUPS_REJECT_JOBS'>CUPS-Reject-Jobs Operation</a></h3>
1460 <p>The CUPS-Reject-Jobs operation (0x4009) sets
1461 the"printer-is-accepting-jobs
" attribute to false for the specified
1462 printer or printer class.
1464 <h4>CUPS-Reject-Jobs Request</h4>
1466 <p>The following groups of attributes are supplied as part of the
1467 CUPS-Reject-Jobs request:
1469 <p>Group 1: Operation Attributes
1473 <dt>Natural Language and Character Set:
1475 <dd>The "attributes-charset
" and "attributes-natural-language
"
1476 attributes as described in section 3.1.4.1 of the IPP Model and
1479 <dt>"printer-uri
" (uri):
1481 <dd>The client MUST supply a URI for the specified printer or printer class.
1485 <p>Group 2: Printer Object Attributes
1489 <dt>"printer-state-message
" (text(MAX)):
1491 <dd>The client OPTIONALLY supplies this attribute indicating a
1492 textual reason for the current printer state.
1496 <h4>CUPS-Reject-Jobs Response</h4>
1498 <p>The following groups of attributes are send as part of the
1499 CUPS-Reject-Jobs Response:
1501 <p>Group 1: Operation Attributes
1507 <dd>The standard response status message.
1509 <dt>Natural Language and Character Set:
1511 <dd>The "attributes-charset
" and "attributes-natural-language
"
1512 attributes as described in section 3.1.4.2 of the IPP Model and
1517 <h3 class='title'><a name='CUPS_SET_DEFAULT'>CUPS-Set-Default Operation</a></h3>
1519 <p>The CUPS-Set-Default operation (0x400A) sets the default printer
1520 destination for all clients when a resource name of "/printers
" is
1523 <h4>CUPS-Set-Default Request</h4>
1525 <p>The following groups of attributes are supplied as part of the
1526 CUPS-Set-Default request:
1528 <p>Group 1: Operation Attributes
1532 <dt>Natural Language and Character Set:
1534 <dd>The "attributes-charset
" and "attributes-natural-language
"
1535 attributes as described in section 3.1.4.1 of the IPP Model and
1538 <dt>"printer-uri
" (uri):
1540 <dd>The client MUST supply a URI for the specified printer or
1545 <h4>CUPS-Set-Default Response</h4>
1547 <p>The following groups of attributes are send as part of the
1548 CUPS-Set-Default Response:
1550 <p>Group 1: Operation Attributes
1556 <dd>The standard response status message.
1558 <dt>Natural Language and Character Set:
1560 <dd>The "attributes-charset
" and "attributes-natural-language
"
1561 attributes as described in section 3.1.4.2 of the IPP Model and
1566 <h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_GET_DEVICES'>CUPS-Get-Devices Operation</a></h3>
1568 <p>The CUPS-Get-Devices operation (0x400B) returns all of the
1569 supported device-uri's for the server.</p>
1571 <h4>CUPS-Get-Devices Request</h4>
1573 <p>The following groups of attributes are supplied as part of the
1574 CUPS-Get-Devices request:
1576 <p>Group 1: Operation Attributes
1580 <dt>Natural Language and Character Set:
1582 <dd>The "attributes-charset
" and "attributes-natural-language
"
1583 attributes as described in section 3.1.4.1 of the IPP Model and
1586 <dt>"device-class
" (type1 keyword):
1588 <dd>The client OPTIONALLY supplies a device class keyword to select
1589 which devices are returned.
1591 <dt>"exclude-schemes
" (1setOf name) :<span class='info'>CUPS 1.4/OS X 10.6</span>
1593 <dd>The client OPTIONALLY supplies a set of scheme names that the
1594 requestor does not want to discover. If the client omits this attribute,
1595 the server responds with devices of all schemes specified by
1596 the "include-schemes
" attribute.
1598 <dt>"include-schemes
" (1setOf name) :<span class='info'>CUPS 1.4/OS X 10.6</span>
1600 <dd>The client OPTIONALLY supplies a set of scheme names that the
1601 requestor wants to discover. If the client omits this attribute,
1602 the server responds with devices of all schemes except those specified
1603 by the "exclude-schemes
" attribute.
1605 <dt>"limit
" (integer (1:MAX)):
1607 <dd>The client OPTIONALLY supplies this attribute limiting the number of
1608 devices that are returned.
1610 <dt>"requested-attributes
" (1setOf keyword) :
1612 <dd>The client OPTIONALLY supplies a set of attribute names and/or
1613 attribute group names in whose values the requester is interested. If
1614 the client omits this attribute, the server responds as if this
1615 attribute had been supplied with a value of 'all'.
1617 <dt>"timeout
" (integer (1:MAX)) :<span class='info'>CUPS 1.4/OS X 10.6</span>
1619 <dd>The client OPTIONALLY supplies this attribute to limit the duration
1620 of the lookup. The default timeout is 15 seconds.
1624 <h4>CUPS-Get-Devices Response</h4>
1626 <p>The following groups of attributes are send as part of the
1627 CUPS-Get-Devices Response:
1629 <p>Group 1: Operation Attributes
1635 <dd>The standard response status message.
1637 <dt>Natural Language and Character Set:
1639 <dd>The "attributes-charset
" and "attributes-natural-language
"
1640 attributes as described in section 3.1.4.2 of the IPP Model and
1645 <p>Group 2: Device Object Attributes
1649 <dt>The set of requested attributes and their current values for
1654 <h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_GET_PPDS'>CUPS-Get-PPDs Operation</a></h3>
1656 <p>The CUPS-Get-PPDs operation (0x400C) returns all of the
1657 locally available PPD files on the system.</p>
1659 <h4>CUPS-Get-PPDs Request</h4>
1661 <p>The following groups of attributes are supplied as part of the
1662 CUPS-Get-PPDs request:
1664 <p>Group 1: Operation Attributes
1668 <dt>Natural Language and Character Set:
1670 <dd>The "attributes-charset
" and "attributes-natural-language
"
1671 attributes as described in section 3.1.4.1 of the IPP Model and
1674 <dt>"exclude-schemes
" (1setOf name) :<span class='info'>CUPS 1.4/OS X 10.6</span>
1676 <dd>The client OPTIONALLY supplies a set of scheme names that the
1677 requestor does not want to list. If the client omits this attribute,
1678 the server responds with PPDs of all schemes specified by the
1679 "include-schemes
" attribute.
1681 <dt>"include-schemes
" (1setOf name) :<span class='info'>CUPS 1.4/OS X 10.6</span>
1683 <dd>The client OPTIONALLY supplies a set of scheme names that the
1684 requestor wants to list. If the client omits this attribute, the server
1685 responds with PPDs of all schemes except those specified by the
1686 "exclude-schemes
" attribute.
1688 <dt>"limit
" (integer (1:MAX)):
1690 <dd>The client OPTIONALLY supplies this attribute limiting the number of PPDs that are returned.
1692 <dt>"ppd-make
" (text(127)):
1694 <dd>The client OPTIONALLY supplies a printer manufacturer to select which PPDs are returned.
1696 <dt>"ppd-make-and-model
" (text(127)):<span class='info'>CUPS 1.3/OS X 10.5</span>
1698 <dd>The client OPTIONALLY supplies a make and model to select which PPDs are returned.
1700 <dt>"ppd-model-number
" (integer):<span class='info'>CUPS 1.3/OS X 10.5</span>
1702 <dd>The client OPTIONALLY supplies a model number to select which PPDs are returned.
1704 <dt>"ppd-natural-language
" (naturalLanguage):<span class='info'>CUPS 1.3/OS X 10.5</span>
1706 <dd>The client OPTIONALLY supplies a language to select which PPDs are returned.
1708 <dt>"ppd-product
" (text(127)):<span class='info'>CUPS 1.3/OS X 10.5</span>
1710 <dd>The client OPTIONALLY supplies a PostScript product string to select which PPDs are returned.
1712 <dt>"ppd-psversion
" (text(127)):<span class='info'>CUPS 1.3/OS X 10.5</span>
1714 <dd>The client OPTIONALLY supplies a PostScript version string to select which PPDs are returned.
1716 <dt>"ppd-type
" (type1 keyword):<span class='info'>CUPS 1.3/OS X 10.5</span>
1718 <dd>The client OPTIONALLY supplies a driver type to select which PPDs are returned.
1720 <dt>"requested-attributes
" (1setOf keyword) :
1722 <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.
1726 <h4>CUPS-Get-PPDs Response</h4>
1728 <p>The following groups of attributes are send as part of the
1729 CUPS-Get-PPDs Response:
1731 <p>Group 1: Operation Attributes
1737 <dd>The standard response status message.
1739 <dt>Natural Language and Character Set:
1741 <dd>The "attributes-charset
" and "attributes-natural-language
"
1742 attributes as described in section 3.1.4.2 of the IPP Model and
1747 <p>Group 2: PPD Attributes
1751 <dt>The set of requested attributes and their current values for each
1756 <h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_MOVE_JOB'>CUPS-Move-Job Operation</a></h3>
1758 <p>The CUPS-Move-Job operation (0x400D) moves an active print job or all print
1759 jobs for a printer to a different printer.</p>
1761 <h4>CUPS-Move-Job Request</h4>
1763 <p>The following groups of attributes are supplied as part of the
1764 CUPS-Move-Job request:
1766 <p>Group 1: Operation Attributes
1770 <dt>Natural Language and Character Set:
1772 <dd>The "attributes-charset
" and "attributes-natural-language
"
1773 attributes as described in section 3.1.4.1 of the IPP Model and
1776 <dt>"printer-uri
" (uri)
1778 <dt>"printer-uri
" (uri) and "job-id
" (integer)
1782 <dd>The client MUST supply a URI for the specified printer, the URI for
1783 the specified printer and a job ID number, or the job URI.
1787 <p>Group 2: Job Template Attributes
1791 <dt>"job-printer-uri
" (uri)
1793 <dd>The client MUST supply a URI for a printer on the same server.
1797 <h4>CUPS-Move-Job Response</h4>
1799 <p>The following groups of attributes are send as part of the
1800 CUPS-Move-Job Response:
1802 <p>Group 1: Operation Attributes
1808 <dd>The standard response status message.
1810 <dt>Natural Language and Character Set:
1812 <dd>The "attributes-charset
" and "attributes-natural-language
"
1813 attributes as described in section 3.1.4.2 of the IPP Model and
1818 <h3 class='title'><span class='info'>CUPS 1.2/OS X 10.5</span><a name='CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job Operation</a></h3>
1820 <p>The CUPS-Authenticate-Job operation (0x400E) authenticates a print job for
1821 printing, releasing the job if it is held. Typically this is used when printing
1822 to a remote server. The authentication information is passed in the HTTP
1823 request; the HTTP connection is normally encrypted for this type of request.</p>
1825 <h4>CUPS-Authenticate-Job Request</h4>
1827 <p>The following groups of attributes are supplied as part of the
1828 CUPS-Authenticate-Job request:
1830 <p>Group 1: Operation Attributes
1834 <dt>Natural Language and Character Set:
1836 <dd>The "attributes-charset
" and "attributes-natural-language
"
1837 attributes as described in section 3.1.4.1 of the IPP Model and
1840 <dt>"printer-uri
" (uri) and "job-id
" (integer)
1844 <dd>The client MUST supply a URI for the specified printer and
1845 a job ID number, or the job URI.
1849 <p>Group 2: Job Attributes
1853 <dt>"auth-info
" (1setOf text(MAX)):<span class='info'>CUPS 1.3/OS X 10.5</span>
1855 <dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required
" attribute.
1857 <dt>"job-hold-until
" (keyword | name(MAX)):<span class='info'>CUPS 1.3/OS X 10.5</span>
1859 <dd>The client OPTIONALLY supplies a new job-hold-until value for the
1860 job. If specified and not the "no-hold
" value, the job is held instead
1861 of released for printing.
1865 <h4>CUPS-Authenticate-Job Response</h4>
1867 <p>The following groups of attributes are send as part of the
1868 CUPS-Authenticate-Job Response:
1870 <p>Group 1: Operation Attributes
1876 <dd>The standard response status message.
1878 <dt>Natural Language and Character Set:
1880 <dd>The "attributes-charset
" and "attributes-natural-language
"
1881 attributes as described in section 3.1.4.2 of the IPP Model and
1886 <p>Group 2: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
1890 <dt>auth-info-required (1setOf Type2 keyword)
1892 <dd>The required authentication information.
1896 <h3 class='title'><span class='info'>CUPS 1.3/OS X 10.5</span><a name='CUPS_GET_PPD'>CUPS-Get-PPD Operation</a></h3>
1898 <p>The CUPS-Get-PPD operation (0x400F) gets a PPD file from the
1899 server. The PPD file can be specified using a <tt>ppd-name</tt>
1900 returned by <a href='#CUPS_GET_PPDS'><tt>CUPS-Get-PPDs</tt></a>
1901 or using the <tt>printer-uri</tt> for a queue.</p>
1903 <p>If the PPD file is found, <tt>successful-ok</tt> is returned with
1904 the PPD file following the response data.</p>
1906 <p>If the PPD file cannot be served by the local server because
1907 the <tt>printer-uri</tt> attribute points to an external printer,
1908 a <tt>cups-see-other</tt> status is returned with the correct
1911 <p>If the PPD file does not exist, <tt>client-error-not-found</tt> is
1914 <h4>CUPS-Get-PPD Request</h4>
1916 <p>The following group of attributes is supplied as part of the
1917 CUPS-Get-PPD request:
1919 <p>Group 1: Operation Attributes
1923 <dt>Natural Language and Character Set:
1925 <dd>The "attributes-charset
" and "attributes-natural-language
"
1926 attributes as described in section 3.1.4.1 of the IPP Model and
1929 <dt>"printer-uri
" (uri)
1931 <br>"ppd-name
" (name(255)):
1933 <dd>The client MUST supply a printer URI or PPD name.
1937 <h4>CUPS-Get-PPD Response</h4>
1939 <p>The following group of attributes is sent as part of the
1940 CUPS-Get-PPD Response:
1942 <p>Group 1: Operation Attributes
1948 <dd>The standard response status message.
1950 <dt>Natural Language and Character Set:
1952 <dd>The "attributes-charset
" and "attributes-natural-language
"
1953 attributes as described in section 3.1.4.2 of the IPP Model and
1956 <dt>"printer-uri
" (uri):
1958 <dd>The printer that provides the actual PPD file when
1959 the status code is cups-see-other (0x280)
1963 <p>If the status code is <tt>successful-ok</tt>, the PPD file follows
1964 the end of the IPP response.</p>
1966 <h3 class='title'><span class='info'>CUPS 1.4/OS X 10.6</span><a name='CUPS_GET_DOCUMENT'>CUPS-Get-Document Operation</a></h3>
1968 <p>The CUPS-Get-Document operation (0x4027) gets a document file from a
1969 job on the server. The document file is specified using the
1970 <tt>document-number</tt> and either the <tt>job-uri</tt> or <tt>printer-uri</tt>
1971 and <tt>job-id</tt> identifying the job.</p>
1973 <p>If the document file is found, <tt>successful-ok</tt> is returned with
1974 the document file following the response data.</p>
1976 <p>If the document file does not exist, <tt>client-error-not-found</tt> is
1979 <p>If the requesting user does not have access to the document file,
1980 <tt>client-error-not-authorized</tt> is returned.
1982 <h4>CUPS-Get-Document Request</h4>
1984 <p>The following group of attributes is supplied as part of the
1985 CUPS-Get-Document request:
1987 <p>Group 1: Operation Attributes
1991 <dt>Natural Language and Character Set:
1993 <dd>The "attributes-charset
" and "attributes-natural-language
"
1994 attributes as described in section 3.1.4.1 of the IPP Model and
1997 <dt>"printer-uri
" (uri) and "job-id
" (integer)
1999 <br>"job-uri
" (uri):
2001 <dd>The client MUST supply a printer URI and job ID or job URI.
2003 <dt>"document-number
" (integer(1:MAX)):
2005 <dd>The client MUST supply a document number to retrieve. The
2006 <tt>document-count</tt> attribute for the job defines the maximum
2007 document number that can be specified. In the case of jobs with
2008 banners (<tt>job-sheets</tt> is not "none
"), document number 1
2009 will typically contain the start banner and document number N
2010 will typically contain the end banner.
2014 <h4>CUPS-Get-Document Response</h4>
2016 <p>The following group of attributes is sent as part of the
2017 CUPS-Get-Document Response:
2019 <p>Group 1: Operation Attributes
2025 <dd>The standard response status message.
2027 <dt>Natural Language and Character Set:
2029 <dd>The "attributes-charset
" and "attributes-natural-language
"
2030 attributes as described in section 3.1.4.2 of the IPP Model and
2033 <dt>"document-format
" (mimeType):
2035 <dd>The format of the document file.
2037 <dt>"document-number
" (integer(1:MAX)):
2039 <dd>The requested document number.
2041 <dt>"document-name
" (name(MAX)):
2043 <dd>The name that was supplied with the document, if any.
2047 <p>If the status code is <tt>successful-ok</tt>, the document file follows
2048 the end of the IPP response.</p>
2051 <h2 class='title'><a name='ATTRIBUTES'>Attributes</a></h2>
2053 <p>CUPS provides many extension attributes to support multiple
2054 devices, PPD files, standard job filters, printers, and printer
2057 <h3 class='title'><a name='DEVICE_ATTRIBUTES'>Device Attributes</a></h3>
2059 <p>Device attributes are returned by the CUPS-Get-Devices
2060 operation and enumerate all of the available hardware devices and
2061 network protocols that are supported by the server.</p>
2063 <h4><a name="device-class
">device-class (type2 keyword)</a></h4>
2065 <p>The device-class attribute specifies the class of device and can be
2066 one of the following:
2070 <li>"file
" - a disk file.
2072 <li>"direct
" - a parallel or fixed-rate serial data port,
2073 currently used for Centronics, IEEE-1284, and USB printer
2076 <li>"serial
" - a variable-rate serial port.
2078 <li>"network
" - a network connection, typically via AppSocket,
2079 HTTP, IPP, LPD, or SMB/CIFS protocols.
2083 <h4><a name="device-id
">device-id (text(127))</a><span class="info
">CUPS 1.2/OS X 10.5</span></h4>
2085 <p>The device-id attribute specifies the IEEE-1284 device ID
2086 string for the device.</p>
2088 <h4><a name="device-info
">device-info (text(127))</a></h4>
2090 <p>The device-info attribute specifies a human-readable string describing
2091 the device, e.g. "Parallel Port #
1".
2093 <h4><a name="device-location
">device-location (text(127))</a><span class="info
">CUPS 1.4/OS X 10.6</span></h4>
2095 <p>The device-location attribute specifies the physical location of the
2098 <h4><a name="device-make-and-model
">device-make-and-model (text(127))</a></h4>
2100 <p>The device-make-and-model attribute specifies a device
2101 identification string provided by the printer connected to the device.
2102 If the device or printer does not support identification then this
2103 attribute contains the string "unknown
".
2105 <h4><a name="device-uri
">device-uri (uri)</a></h4>
2107 <p>The device-uri attribute specifies a unique identifier for the
2108 device. The actual format of the device-uri string depends on the value
2109 of the device-class attribute:
2113 <li>"file
" - The device-uri will be of the form
2114 "file:///path/to/filename
".
2116 <li>"direct
" - The device-uri will be of the form
2117 "scheme:/dev/filename
" or "scheme://vendor/identifier
",
2118 where scheme may be "parallel
" or "usb
" in the current
2121 <li>"serial
" - The device-uri will be of the form
2122 "serial:/dev/filename?baud=value+parity=value+flow=value
".
2123 The baud value is the data rate in bits per second; the
2124 supported values depend on the underlying hardware.
2125 The parity value can be one of "none
", "even
", or "odd
".
2126 The flow value can be one of "none
", "soft
" (XON/XOFF
2127 handshaking), "hard
" or "rts/cts
" (RTS/CTS handshaking),
2128 or "dtrdsr
" (DTR/DSR handshaking).
2130 <p>The URI returned by CUPS-Get-Devices will contain the
2131 maximum baud rate supported by the device and the best
2132 type of flow control available ("soft
" or "hard
").
2134 <li>"network
" - The device-uri will be of the form
2135 "scheme://[username:password@]hostname[:port]/[resource]
",
2136 where scheme may be "http
", "https
", "ipp
", "lpd
", "smb
", or
2137 "socket
" in the current implementation.
2139 <p>The URI returned by CUPS-Get-Devices will only contain
2140 the scheme name ("scheme
"). It is up to the client
2141 application to add the appropriate host and other
2142 information when adding a new printer.
2144 <p>The URI returned by Get-Printer-Attributes and
2145 CUPS-Get-Printers has any username and password information
2146 stripped; the information is still stored and used by the
2147 server internally to perform any needed authentication.
2151 <h3 class='title'><a name='JOB_TEMPLATE_ATTRIBUTES'>Job Template Attributes</a></h3>
2153 <h4><a name="auth-info
">auth-info (1setOf text(MAX))</a><span class="info
">CUPS 1.3/OS X 10.5</span></h4>
2155 <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.
2157 <h4><a name="cpi
">cpi (type2 enum)</a></h4>
2159 <p>The cpi attribute specifies the number of characters per inch when
2160 printing text files. Only the values 10, 12, and 17 are currently
2161 supported. The default value is 10.
2163 <h4><a name="fit-to-page
">fit-to-page (boolean)</a><span class="info
">CUPS 1.4/OS X 10.6</span></h4>
2165 <p>The fit-to-page attribute specifies whether to scale documents to fit on the
2166 selected media (fit-to-page=true) or use the physical size specified in the
2167 document (fit-to-page=false). The default value is false.
2169 <h4><a name="job-billing
">job-billing (text(MAX))</a><span class='info'>CUPS 1.1</span></h4>
2171 <p>The job-billing attribute provides a text value to associate with a job
2172 for billing purposes.
2174 <blockquote><b>Note:</b> This attribute has been superceded by the "job-account-id
" attribute defined in PWG 5100.11: Job and Printer Extensions - Set 2.</blockquote>
2176 <h4><a name="job-cancel-after
">job-cancel-after (integer(1:MAX))</a><span class='info'>CUPS 2.0</span></h4>
2178 <p>The job-cancel-after attribute provides the maximum number of seconds that are allowed for processing a job.</p>
2180 <h4><a name="job-hold-until
">job-hold-until (keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4>
2182 <p>The job-hold-until attribute specifies a hold time. In addition to the
2183 standard IPP/1.1 keyword names, CUPS supports name values of the form
2184 "HH:MM
" and "HH:MM:SS
" that specify a hold time. The hold time is in
2185 Universal Coordinated Time (UTC) and <i>not</i> in the local time zone. If the
2186 specified time is less than the current time, the job is held until the
2189 <h4><a name="job-media-progress
">job-media-progress (integer(0:100))</a><span class='info'>CUPS 1.4/OS X 10.6</span></h4>
2191 <p>The job-media-progress attribute specifies the percentage of completion of
2192 the current page. It is only valid when the job-state attribute has the
2193 "processing
" value (5).</p>
2195 <h4><a name="job-printer-state-message
">job-printer-state-message (text(MAX))</a><span class='info'>CUPS 1.3/OS X 10.5</span></h4>
2197 <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>
2199 <h4><a name="job-printer-state-reasons
">job-printer-state-reasons (1setOf type2 keyword)</a><span class='info'>CUPS 1.3/OS X 10.5</span></h4>
2201 <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>
2203 <h4><a name="job-sheets
">job-sheets (1setof type3 keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4>
2205 <p>The job-sheets attribute specifies one or two banner files that are printed
2206 before and after a job. The reserved value of "none
" disables banner printing.
2207 The default value is stored in the job-sheets-default attribute.
2209 <p>If only one value is supplied, the banner file is printed before the job.
2210 If two values are supplied, the first value is used as the starting banner
2211 file and the second as the ending banner file.
2213 <h4><a name="job-originating-host-name
">job-originating-host-name (name(MAX))</a></h4>
2215 <p><i>(CUPS 1.1.5 and higher)</i>
2217 <p>The job-originating-host-name attribute specifies the host
2218 from which the job was queued. The value will be the hostname or
2219 IP address of the client depending on whether hostname
2220 resolution is enabled. The localhost address (127.0.0.1) is
2221 <b>always</b> resolved to the name "localhost
".
2223 <p>This attribute is read-only.
2225 <h4><a name="lpi
">lpi (type2 enum)</a></h4>
2227 <p>The lpi attribute specifies the number of lines per inch when
2228 printing text files. Only the values 6 and 8 are currently supported.
2229 The default value is 6.
2231 <h4><a name="mirror
">mirror (boolean)</a></h4>
2233 <p>The mirror attribute specifies whether pages are mirrored on
2234 their X axis, which is useful for printing transfer images on
2235 special media. The default value is false.
2237 <h4><a name="number-up-layout
">number-up-layout (type2 keyword)</a><span class='info'>Deprecated/Introduced in CUPS 1.1.15</span></h4>
2239 <p>The number-up-layout attribute specifies the order each input
2240 page is placed on each output page. The following keywords are
2245 <li><CODE>btlr</CODE> - Bottom to top, left to right</li>
2247 <li><CODE>btrl</CODE> - Bottom to top, right to left</li>
2249 <li><CODE>lrbt</CODE> - Left to right, bottom to top</li>
2251 <li><CODE>lrtb</CODE> - Left to right, top to bottom (default)</li>
2253 <li><CODE>rlbt</CODE> - Right to left, bottom to top</li>
2255 <li><CODE>rltb</CODE> - Right to left, top to bottom</li>
2257 <li><CODE>tblr</CODE> - Top to bottom, left to right</li>
2259 <li><CODE>tbrl</CODE> - Top to bottom, right to left</li>
2263 <blockquote><b>Note:</b>
2265 <p>This attribute is deprecated in favor of the PWG presentation-direction-number-up attribute and will be removed in a future release.</p>
2269 <h4><a name="page-border
">page-border (type2 keyword)</a><span class='info'>CUPS 1.1.15</span></h4>
2270 <p>The page-border attribute specifies whether a border is
2271 draw around each page. The following keywords are presently
2276 <li><CODE>double</CODE> - Two hairline borders are drawn</li>
2278 <li><CODE>double-thick</CODE> - Two 1pt borders are drawn</li>
2280 <li><CODE>none</CODE> - No border is drawn (default)</li>
2282 <li><CODE>single</CODE> - A single hairline border is drawn</li>
2284 <li><CODE>single-thick</CODE> - A single 1pt border is drawn</li>
2288 <h4><a name="page-bottom
">page-bottom (integer(0:MAX))</a><span class="info
">Deprecated</span></h4>
2290 <p>The page-bottom attribute specifies the bottom margin in points (72 points
2291 equals 1 inch). The default value is the device physical margin.
2293 <h4><a name="page-label
">page-label (text(MAX))</a><span class='info'>Deprecated</span></h4>
2294 <p>The page-label attribute provides a text value to place in
2295 the header and footer on each page. If a classification level is
2296 set on the server, then this classification is printed before
2299 <h4><a name="page-left
">page-left (integer(0:MAX))</a><span class="info
">Deprecated</span></h4>
2301 <p>The page-left attribute specifies the left margin in points (72 points
2302 equals 1 inch). The default value is the device physical margin.
2304 <h4><a name="page-right
">page-right (integer(0:MAX))</a><span class="info
">Deprecated</span></h4>
2306 <p>The page-right attribute specifies the right margin in points (72 points
2307 equals 1 inch). The default value is the device physical margin.
2309 <h4><a name="page-set
">page-set (type2 keyword)</a></h4>
2311 <p>The page-set attribute specifies which pages to print in a file. The
2312 supported keywords are "all
", "even
", and "odd
". The default value is
2315 <h4><a name="page-top
">page-top (integer(0:MAX))</a><span class="info
">Deprecated</span></h4>
2317 <p>The page-top attribute specifies the top margin in points (72 points
2318 equals 1 inch). The default value is the device physical margin.
2320 <h4><a name="prettyprint
">prettyprint (boolean)</a><span class="info
">Deprecated</span></h4>
2322 <p>The prettyprint attribute specifies whether text files should be printed
2323 with a shaded header and keyword highlighting (prettyprint=true) or without
2324 additional formatting (prettyprint=false). The default value is false.
2326 <h4><a name="wrap
">wrap (boolean)</a><span class="info
">Deprecated</span></h4>
2328 <p>The wrap attribute specifies whether long lines should be wrapped
2329 (wrap=true) or not (wrap=false) when printing text files. The default
2332 <h3 class='title'><a name='PPD_ATTRIBUTES'>PPD Attributes</a></h3>
2334 <h4><a name="ppd-device-id
">ppd-device-id (text(127))</a></h4>
2336 <p>The ppd-device-id attribute specifies the IEEE-1284 device ID
2337 string for the device described by the PPD file.</p>
2339 <h4><a name="ppd-make
">ppd-make (text(127))</a></h4>
2341 <p>The ppd-make attribute specifies the manufacturer of the printer
2342 (the Manufacturer attribute in the PPD file). If the manufacturer
2343 is not specified in the PPD file then an educated guess is made using
2344 the NickName attribute in the PPD file.
2346 <h4><a name="ppd-make-and-model
">ppd-make-and-model (text(127))</a></h4>
2348 <p>The ppd-make-and-model attribute specifies the manufacturer and model
2349 name of the PPD file (the NickName attribute in the PPD file). If the
2350 make and model is not specified in the PPD file then the ModelName or
2351 ShortNickName attributes are used instead.
2353 <h4><a name="ppd-model-number
">ppd-model-number (integer)</a><span class="info
">CUPS 1.3/OS X 10.5</span></h4>
2355 <p>The ppd-model-number attribute provides the <tt>cupsModelNumber</tt> value from the PPD file.
2357 <h4><a name="ppd-name
">ppd-name (name(255))</a></h4>
2359 <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.
2361 <h4><a name="ppd-natural-language
">ppd-natural-language (1setOf naturalLanguage)</a></h4>
2363 <p>The ppd-natural-language attribute specifies the language encoding
2364 of the PPD file (the LanguageVersion attribute in the PPD file). If the
2365 language is unknown or undefined then "en
" (English) is assumed.
2367 <h4><a name="ppd-product
">ppd-product (1setOf text(127))</a></h4>
2369 <p>The ppd-product attribute specifies the Product attribute values in the PPD file.
2371 <h4><a name="ppd-psversion
">ppd-psversion (1setOf text(127))</a><span class="info
">CUPS 1.3/OS X 10.5</span></h4>
2373 <p>The ppd-product attribute specifies the PSVersion attribute values in the PPD file.
2375 <h4><a name="ppd-type
">ppd-type (type1 keyword)</a><span class="info
">CUPS 1.3/OS X 10.5</span></h4>
2377 <p>The ppd-type attribute specifies the type of driver described by the PPD file:</p>
2381 <li><tt>fax</tt> - A facsimile or multi-function device</li>
2383 <li><tt>pdf</tt> - A PDF printer</li>
2385 <li><tt>postscript</tt> - A PostScript printer (no filters)</li>
2387 <li><tt>raster</tt> - A CUPS raster driver</li>
2389 <li><tt>unknown</tt> - An unknown or hybrid driver</li>
2394 <h3 class='title'><a name='PRINTER_ATTRIBUTES'>Printer Attributes</a></h3>
2396 <h4><a name="auth-info-required
">auth-info-required (1setOf type2 keyword)</a><span class="info
">CUPS 1.3/OS X 10.5</span></h4>
2398 <p>The auth-info-required attribute specifies the authentication information that is required for printing a job. The following keywords are recognized:</p>
2402 <li><tt>domain</tt> - A domain name is required.</li>
2404 <li><tt>none</tt> - No authentication is required - this keyword can only appear by itself.</li>
2406 <li><tt>password</tt> - A password is required.</li>
2408 <li><tt>username</tt> - A username is required.</li>
2412 <h4><a name="job-k-limit
">job-k-limit (integer)</a><span class='info'>CUPS 1.1</span></h4>
2414 <p>The job-k-limit attribute specifies the maximum number of kilobytes that
2415 may be printed by a user, including banner files. The default value of 0
2416 specifies that there is no limit.
2418 <h4><a name="job-page-limit
">job-page-limit (integer)</a><span class='info'>CUPS 1.1</span></h4>
2420 <p>The job-page-limit attribute specifies the maximum number of pages that
2421 may be printed by a user, including banner files. The default value of 0
2422 specifies that there is no limit.
2424 <h4><a name="job-quota-period
">job-quota-period (integer)</a><span class='info'>CUPS 1.1</span></h4>
2426 <p>The job-quota-period attribute specifies the time period used for quota
2427 calculations, in seconds. The default value of 0 specifies that the limits
2428 apply to all jobs that have been printed by a user that are still known to
2431 <h4><a name="job-sheets-supported
">job-sheets-supported (1setof type3 keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4>
2433 <p>The job-sheets-supported attribute specifies the available banner files.
2434 There will always be at least one banner file available called "none
".
2436 <h4><a name="marker-change-time
">marker-change-time (integer)</a><span class='info'>CUPS 1.3/OS X 10.5</span></h4>
2438 <p>The marker-change-time attribute specifies the printer-up-time value when
2439 the last change to the marker-colors, marker-levels, marker-message,
2440 marker-names, or marker-types attributes was made.</p>
2442 <h4><a name="marker-colors
">marker-colors (1setof name(MAX))</a><span class='info'>CUPS 1.3/OS X 10.5</span></h4>
2444 <p>The marker-colors attribute specifies the color(s) for each supply in the
2445 printer. It is only available when the driver provides supply levels. The
2446 color is either "none
" or one or more hex-encoded sRGB colors of the form
2449 <h4><a name="marker-high-levels
">marker-high-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4/OS X 10.6</span></h4>
2451 <p>The marker-high-levels attribute specifies the supply levels that indicate
2452 a near-full condition. A value of 100 should be used for supplies that are
2453 consumed/emptied, e.g. ink cartridges.</p>
2455 <h4><a name="marker-levels
">marker-levels (1setof integer(-3:100))</a><span class='info'>CUPS 1.3/OS X 10.5</span></h4>
2457 <p>The marker-levels attribute specifies the current supply levels for the
2458 printer. It is only available when the driver provides supply levels. A
2459 value of -1 indicates the level is unavailable, -2 indicates unknown, and -3
2460 indicates the level is unknown but has not yet reached capacity. Values from 0
2461 to 100 indicate the corresponding percentage.</p>
2463 <h4><a name="marker-low-levels
">marker-low-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4/OS X 10.6</span></h4>
2465 <p>The marker-low-levels attribute specifies the supply levels that indicate
2466 a near-empty condition. A value of 0 should be used for supplies that are
2467 filled, e.g. waste ink tanks.</p>
2469 <h4><a name="marker-message
">marker-message (text(MAX))</a><span class='info'>CUPS 1.4/OS X 10.6</span></h4>
2471 <p>The marker-message attribute provides a human-readable status message
2472 for the current supply levels, e.g. "12 pages of ink remaining.
" It is only
2473 available when the driver provides supply levels.</p>
2475 <h4><a name="marker-names
">marker-names (1setof name(MAX))</a><span class='info'>CUPS 1.3/OS X 10.5</span></h4>
2477 <p>The marker-names attribute specifies the name(s) for each supply in the
2478 printer. It is only available when the driver provides supply levels.</p>
2480 <h4><a name="marker-types
">marker-types (1setof type3 keyword)</a><span class='info'>CUPS 1.3/OS X 10.5</span></h4>
2482 <p>The marker-types attribute specifies the type(s) of each supply in the
2483 printer. It is only available when the driver provides supply levels. The
2484 following (RFC 3805) types are currently supported:</p>
2488 <li><tt>toner</tt></li>
2490 <li><tt>wasteToner</tt></li>
2492 <li><tt>ink</tt></li>
2494 <li><tt>inkCartridge</tt></li>
2496 <li><tt>inkRibbon</tt></li>
2498 <li><tt>wasteInk</tt></li>
2500 <li><tt>opc</tt></li>
2502 <li><tt>developer</tt></li>
2504 <li><tt>fuserOil</tt></li>
2506 <li><tt>solidWax</tt></li>
2508 <li><tt>ribbonWax</tt></li>
2510 <li><tt>wasteWax</tt></li>
2512 <li><tt>fuser</tt></li>
2514 <li><tt>coronaWire</tt></li>
2516 <li><tt>fuserOilWick</tt></li>
2518 <li><tt>cleanerUnit</tt></li>
2520 <li><tt>fuserCleaningPad</tt></li>
2522 <li><tt>transferUnit</tt></li>
2524 <li><tt>tonerCartridge</tt></li>
2526 <li><tt>fuserOiler</tt></li>
2528 <li><tt>water</tt></li>
2530 <li><tt>wasteWater</tt></li>
2532 <li><tt>bindingSupply</tt></li>
2534 <li><tt>bandingSupply</tt></li>
2536 <li><tt>stichingWire</tt></li>
2538 <li><tt>shrinkWrap</tt></li>
2540 <li><tt>paperWrap</tt></li>
2542 <li><tt>staples</tt></li>
2544 <li><tt>inserts</tt></li>
2546 <li><tt>covers</tt></li>
2550 <h4><a name="port-monitor
">port-monitor" (name(
127))
</a></h4>
2552 <p>The port-monitor attribute specifies the port monitor to use when printing
2553 to this printer. The default port monitor is
"none".
2555 <h4><a name=
"port-monitor-supported">port-monitor-supported
" (1setOf name(127))</a></h4>
2557 <p>The port-monitor-supported attribute specifies the available port monitors.
2559 <h4><a name="printer-commands
">printer-commands (1setOf Type3 keyword)</a><span class='info'>CUPS 1.4/OS X 10.6</span></h4>
2561 <p>The printer-commands attribute specifies the commands that are supported
2562 by the CUPS command file filter. The keyword "none
" indicates that no commands
2565 <h4><a name="printer-dns-sd-name
">printer-dns-sd-name (name(MAX) | noValue)</a><span class='info'>CUPS 1.4/OS X 10.6</span></h4>
2567 <p>The printer-dns-sd-name attribute specifies the registered DNS-SD service
2568 name for the printer. If the printer is not being shared using this protocol,
2569 printer-dns-sd-name will have the noValue value.</p>
2571 <h4><a name="printer-state-reasons
">printer-state-reasons (1setOf type2 keyword)</a></h4>
2573 <p>The printer-state-reasons attribute provides additional persistent state
2574 information for a printer. In addition to the keywords defined in RFC 2911,
2575 CUPS supports vendor-specific keywords with a domain prefix ("com.vendor.foo
")
2576 and the following CUPS-specific keywords:</p>
2580 <li><tt>cups-insecure-filter-warning</tt> - a filter or backend (or the
2581 directory containing the filter or backend) has insecure file
2582 permissions. CUPS will not execute programs with world write permissions
2583 or setuid programs. When run as root (the default), CUPS also does not
2584 execute programs that are not owned by root.
2585 <span class='info'>CUPS 1.4/OS X 10.6</span></li>
2587 <li><tt>cups-missing-filter-warning</tt> - a filter or backend is not
2588 installed. <span class='info'>CUPS 1.4/OS X 10.6</span></li>
2592 <h4><a name="printer-type
">printer-type (type2 enum)</a></h4>
2594 <p>The printer-type attribute specifies printer type and
2595 capability bits for the printer or class. The default value is
2596 computed from internal state information and the PPD file for the
2597 printer. The following bits are defined:</p>
2599 <div class='table'><table align='center' border='1' width='80%'
2600 summary='Printer Type Bits'>
2604 <th>Description</th>
2610 <td>Is a printer class.</td>
2614 <td>Is a remote destination.</td>
2618 <td>Can print in black.</td>
2622 <td>Can print in color.</td>
2626 <td>Can print on both sides of the page in hardware.</td>
2630 <td>Can staple output.</td>
2634 <td>Can do fast copies in hardware.</td>
2638 <td>Can do fast copy collation in hardware.</td>
2642 <td>Can punch output.</td>
2646 <td>Can cover output.</td>
2650 <td>Can bind output.</td>
2654 <td>Can sort output.</td>
2658 <td>Can handle media up to US-Legal/A4.</td>
2662 <td>Can handle media from US-Legal/A4 to ISO-C/A2.</td>
2666 <td>Can handle media larger than ISO-C/A2.</td>
2670 <td>Can handle user-defined media sizes.</td>
2674 <td>Is an implicit (server-generated) class.</td>
2678 <td>Is the a default printer on the network.</td>
2682 <td>Is a facsimile device.</td>
2686 <td>Is rejecting jobs.</td>
2690 <td>Delete this queue.</td>
2694 <td>Queue is not shared.</td>
2698 <td>Queue requires authentication.</td>
2702 <td>Queue supports CUPS command files.</td>
2706 <td>Queue was automatically discovered and added.</td>
2710 <td>Queue is a scanner with no printing capabilities.</td>
2714 <td>Queue is a printer with scanning capabilities.</td>
2719 <h4>printer-type-mask (type2 enum)<span class='info'>CUPS 1.1</span></h4>
2721 <p>The printer-type-mask attribute is used to choose printers or classes with
2722 the CUPS-Get-Printers and CUPS-Get-Classes operations. The bits are defined
2723 identically to the printer-type attribute and default to all 1's.
2725 <h4>requesting-user-name-allowed (1setof name(127))<span class='info'>CUPS 1.1</span></h4>
2727 <p>The requesting-user-name-allowed attribute lists all of the users that are
2728 allowed to access a printer or class. Either this attribute or the
2729 requesting-user-name-denied attribute will be defined, but not both.
2731 <h4>requesting-user-name-denied (1setof name(127))<span class='info'>CUPS 1.1</span></h4>
2733 <p>The requesting-user-name-denied attribute lists all of the users that are
2734 not allowed to access a printer or class. Either this attribute or the
2735 requesting-user-name-allowed attribute will be defined, but not both.
2737 <h3 class='title'><a name='CLASS_ATTRIBUTES'>Printer Class Attributes</a></h3>
2739 <h4>member-names (1setof name(127))</h4>
2741 <p>The member-names attribute specifies each of the printer-name attributes of
2742 the member printers and classes. Each name corresponds to the same element of
2743 the member-uris attribute.
2745 <h4>member-uris (1setof uri)</h4>
2747 <p>The member-uris attribute specifies each of the printer-uri attributes of
2748 the member printers and classes. Each URI corresponds to the same element of
2749 the member-names attribute.