1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
3 <!-- SECTION: Specifications -->
5 <title>CUPS Implementation of IPP
</title>
6 <meta name='keywords' content='Programming, Internet Printing Protocol'
>
12 CUPS IPP specification for the Common UNIX Printing System (CUPS).
14 Copyright 1997-2007 by Easy Software Products.
16 These coded instructions, statements, and computer programs are the
17 property of Easy Software Products and are protected by Federal
18 copyright law. Distribution and use rights are outlined in the file
19 "LICENSE.txt" which should have been included with this file. If this
20 file is missing or damaged please contact Easy Software Products
23 Attn: CUPS Licensing Information
24 Easy Software Products
25 44141 Airport View Drive, Suite 204
26 Hollywood, Maryland 20636 USA
29 EMail: cups-info@cups.org
30 WWW: http://www.cups.org
33 <h2 class='title'
><a name='INTRODUCTION'
>Introduction
</a></h2>
35 <p>CUPS
1.1 implements IPP/
1.1 and the operations and attributes
36 defined in the
"IPP: Job and Printer Set Operations",
"IPP/1.1:
37 Output-bin Attribute Extension", and
"IPP/1.1: finishings
38 'fold',' trim', and 'bale' attribute values extension"
41 <p>CUPS also provides
15 new operations and many new attributes
42 to support multiple IPP printers and printer classes on a single
45 <h3 class='title'
><a name='IPP_URIS'
>IPP URIs
</a></h3>
47 <p>CUPS supports the
"http",
"https", and
"ipp" schemes. The
48 following resource names are used:
</p>
52 <dt><tt>scheme://hostname:port/
</tt></dt>
54 <dd>Can be used for all
"get" operations and for server
57 <dt><tt>scheme://hostname:port/admin/
</tt></dt>
59 <dd>Used for all administrative operations.
</dd>
61 <dt><tt>scheme://hostname:port/classes/name
</tt></dt>
63 <dd>Specifies a printer class.
</dd>
65 <dt><tt>scheme://hostname:port/jobs/id
</tt></dt>
67 <dd>Specifies a job.
</dd>
69 <dt><tt>scheme://hostname:port/printers/name
</tt></dt>
71 <dd>Specifies a printer.
</dd>
75 <p>So a typical printer URI would be
76 "ipp://foo.bar.com/printers/LaserJet". In addition, the CUPS
77 server also supports normal browser access via
78 "http://hostname:port/" and
"https://hostname:port/".
</p>
80 <h3 class='title'
><a name='IPP_OPERATIONS'
>CUPS IPP Operations
</a></h3>
82 <p>CUPS provides
14 extension operations in addition to most of the
83 standard IPP and registered extension operations:
85 <div class='table'
><table align='center' border='
1' width='
80%'
86 summary='Supported Operations'
>
89 <TH VALIGN=
"TOP">Operation Name
</th>
90 <TH VALIGN=
"TOP">CUPS
</th>
91 <TH VALIGN=
"TOP">Code
</th>
92 <TH VALIGN=
"TOP">Brief Description
</th>
97 <td><a href='#PRINT_JOB'
>Print-Job
</a></td>
100 <td>Print a file.
</td>
103 <td>Validate-Job
</td>
106 <td>Validate job attributes.
</td>
109 <td><a href='#CREATE_JOB'
>Create-Job
</a></td>
112 <td>Create a print job.
</td>
115 <td>Send-Document
</td>
118 <td>Send a file for a print job.
</td>
124 <td>Cancel a print job.
</td>
127 <td>Get-Job-Attributes
</td>
130 <td>Get job attributes.
</td>
136 <td>Get all jobs.
</td>
139 <td>Get-Printer-Attributes
</td>
142 <td>Get printer attributes.
</td>
148 <td>Hold a job for printing.
</td>
154 <td>Release a job for printing.
</td>
160 <td>Restarts a print job.
</td>
163 <td>Pause-Printer
</td>
166 <td>Pause printing on a printer.
</td>
169 <td>Resume-Printer
</td>
172 <td>Resume printing on a printer.
</td>
178 <td>Purge all jobs.
</td>
181 <td><a href='#SET_JOB_ATTRIBUTES'
>Set-Job-Attributes
</a></td>
184 <td>Set attributes for a pending or held job.
</td>
187 <td><a href='#CREATE_PRINTER_SUBSCRIPTION'
>Create-Printer-Subscription
</a></td>
190 <td>Creates a subscription associated with a printer or the server.
</td>
193 <td>Create-Job-Subscription
</td>
196 <td>Creates a subscription associated with a job.
</td>
199 <td>Get-Subscription-Attributes
</td>
202 <td>Gets the attributes for a subscription.
</td>
205 <td>Get-Subscriptions
</td>
208 <td>Gets the attributes for zero or more subscriptions.
</td>
211 <td>Renew-Subscription
</td>
214 <td>Renews a subscription.
</td>
217 <td>Cancel-Subscription
</td>
220 <td>Cancels a subscription.
</td>
223 <td>Get-Notifications
</td>
226 <td>Get notification events for
<tt>ippget
</tt> subscriptions.
</td>
229 <td>Enable-Printer
</td>
232 <td>Accepts jobs on a printer.
</td>
235 <td>Disable-Printer
</td>
238 <td>Rejects jobs on a printer.
</td>
241 <td><a href='#CUPS_GET_DEFAULT'
>CUPS-Get-Default
</a></td>
244 <td>Get the default destination.
</td>
247 <td><a href='#CUPS_GET_PRINTERS'
>CUPS-Get-Printers
</a></td>
250 <td>Get all of the available printers.
</td>
253 <td><a href='#CUPS_ADD_MODIFY_PRINTER'
>CUPS-Add-Modify-Printer
</a></td>
256 <td>Add or modify a printer.
</td>
259 <td><a href='#CUPS_DELETE_PRINTER'
>CUPS-Delete-Printer
</a></td>
262 <td>Delete a printer.
</td>
265 <td><a href='#CUPS_GET_CLASSES'
>CUPS-Get-Classes
</a></td>
268 <td>Get all of the available printer classes.
</td>
271 <td><a href='#CUPS_ADD_MODIFY_CLASS'
>CUPS-Add-Modify-Class
</a></td>
274 <td>Add or modify a printer class.
</td>
277 <td><a href='#CUPS_DELETE_CLASS'
>CUPS-Delete-Class
</a></td>
280 <td>Delete a printer class.
</td>
283 <td><a href='#CUPS_ACCEPT_JOBS'
>CUPS-Accept-Jobs
</a></td>
286 <td>Accept jobs on a printer or printer class.
</td>
289 <td><a href='#CUPS_REJECT_JOBS'
>CUPS-Reject-Jobs
</a></td>
292 <td>Reject jobs on a printer or printer class.
</td>
295 <td><a href='#CUPS_SET_DEFAULT'
>CUPS-Set-Default
</a></td>
298 <td>Set the default destination.
</td>
301 <td><a href='#CUPS_GET_DEVICES'
>CUPS-Get-Devices
</a></td>
304 <td>Get all of the available devices.
</td>
307 <td><a href='#CUPS_GET_PPDS'
>CUPS-Get-PPDs
</a></td>
310 <td>Get all of the available PPDs.
</td>
313 <td><a href='#CUPS_MOVE_JOB'
>CUPS-Move-Job
</a></td>
316 <td>Move a job to a different printer.
</td>
319 <td><a href='#CUPS_AUTHENTICATE_JOB'
>CUPS-Authenticate-Job
</a></td>
322 <td>Authenticate a job for printing.
</td>
325 <td><a href='#CUPS_GET_PPD'
>CUPS-Get-PPD
</a></td>
328 <td>Get a PPD file.
</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</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>
374 <dd>The client OPTIONALLY supplies a billing string that is logged
375 with the page accounting information.
377 <dt>"job-sheets" (
1setof type3 keyword | name(MAX)):
<span class='info'
>CUPS
1.1</span>
379 <dd>The client OPTIONALLY supplies one or two banner pages that
380 are printed before and after any files in the print job. The
381 name of
"none" is reserved to indicate that no banner page
382 should be printed. If the client does not specify this
383 attribute then the value of the
"job-sheets-default" printer
384 object attribute is used.
386 <blockquote><b>Note:
</b> Standard IPP only allows
387 specification of a single job-sheets attribute
390 <dt>"media" (
1setof type3 keyword | name(MAX)):
392 <dd>The client OPTIONALLY supplies one or more media attributes
393 specifying the size, type, source, and color of the output
394 media. If the client does not specify this attribute then the
395 value of the
"media-default" printer object attribute is used.
397 <blockquote><b>Note:
</b> Standard IPP only allows
398 specification of a single media attribute
401 <dt>Other Job Template Attributes
405 <p>The Print-Job request is followed by a file to be printed.
407 <h4>Print-Job Response
</h4>
409 <p>The following groups of attributes are send as part of the Print-Job
412 <p>Group
1: Operation Attributes
418 <dd>The standard response status message.
420 <dt>Natural Language and Character Set:
422 <dd>The
"attributes-charset" and
"attributes-natural-language"
423 attributes as described in section
3.1.4.2 of the IPP Model and
428 <p>Group
2: Job Attributes
432 <dt>Standard Job Attributes
436 <p>Group
3: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
440 <dt>auth-info-required (
1setOf Type2 keyword)
442 <dd>The required authentication information.
446 <h3 class='title'
><span class='info'
>CUPS
1.1</span><a name='CREATE_JOB'
>Create-Job Operation
</a></h3>
448 <p>The Create-Job operation (
0x0005) creates a new, empty print job.
450 <h4>Create-Job Request
</h4>
452 <p>The following groups of attributes are supplied as part of the
455 <p>Group
1: Operation Attributes
459 <dt>Natural Language and Character Set:
461 <dd>The
"attributes-charset" and
"attributes-natural-language"
462 attributes as described in section
3.1.4.1 of the IPP Model and
465 <dt>"printer-uri" (uri):
467 <dd>The client MUST supply a URI for the specified printer.
471 <p>Group
2: Job Template Attributes
475 <dt>"auth-info" (
1setOf text(MAX)):
<span class='info'
>CUPS
1.3</span>
477 <dd>The client OPTIONALLY supplies one or more authentication values as specified by the
"auth-info-required" attribute.
479 <dt>"job-billing" (text(MAX)):
<span class='info'
>CUPS
1.1</span>
481 <dd>The client OPTIONALLY supplies a billing string that is logged
482 with the page accounting information.
484 <dt>"job-sheets" (
1setof type3 keyword | name(MAX)):
<span class='info'
>CUPS
1.1</span>
486 <dd>The client OPTIONALLY supplies one or two banner pages that
487 are printed before and after any files in the print job. The
488 name of
"none" is reserved to indicate that no banner page
489 should be printed. If the client does not specify this
490 attribute then the value of the
"job-sheets-default" printer
491 object attribute is used.
493 <blockquote><b>Note:
</b> Standard IPP only allows
494 specification of a single job-sheets attribute
497 <dt>"media" (
1setof type3 keyword | name(MAX)):
499 <dd>The client OPTIONALLY supplies one or more media attributes
500 specifying the size, type, source, and color of the output
501 media. If the client does not specify this attribute then the
502 value of the
"media-default" printer object attribute is used.
504 <blockquote><b>Note:
</b> Standard IPP only allows
505 specification of a single media attribute
508 <dt>Standard Job Template Attributes
512 <h4>Create-Job Response
</h4>
514 <p>The following groups of attributes are send as part of the
517 <p>Group
1: Operation Attributes
523 <dd>The standard response status message.
525 <dt>Natural Language and Character Set:
527 <dd>The
"attributes-charset" and
"attributes-natural-language"
528 attributes as described in section
3.1.4.2 of the IPP Model and
533 <p>Group
2: Job Attributes
537 <dt>Standard Job Attributes
541 <p>Group
3: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
545 <dt>auth-info-required (
1setOf Type2 keyword)
547 <dd>The required authentication information.
551 <h3 class='title'
><span class='info'
>CUPS
1.1</span><a name='SET_JOB_ATTRIBUTES'
>Set-Job-Attributes Operation
</a></h3>
553 <p>The Set-Job-Attributes operation (
0x0014) changes the attributes of
554 an active (not completed) job.
556 <h4>Set-Job-Attributes Request
</h4>
558 <p>The following groups of attributes are supplied as part of the
559 Set-Job-Attributes request:
561 <p>Group
1: Operation Attributes
565 <dt>Natural Language and Character Set:
567 <dd>The
"attributes-charset" and
"attributes-natural-language"
568 attributes as described in section
3.1.4.1 of the IPP Model and
571 <dt>"printer-uri" (uri) and
"job-id" (integer)
575 <dd>The client MUST supply a URI for the specified printer and
576 a job ID number, or the job URI.
580 <p>Group
2: Job Template Attributes
584 <dt>"job-sheets" (
1setof type3 keyword | name(MAX)):
<span class='info'
>CUPS
1.1</span>
586 <dd>The client OPTIONALLY supplies one or two banner pages that
587 are printed before and after any files in the print job. The
588 name of
"none" is reserved to indicate that no banner page
589 should be printed. If the client does not specify this
590 attribute then the value of the
"job-sheets-default" printer
591 object attribute is used.
593 <blockquote><b>Note:
</b> Standard IPP only allows
594 specification of a single job-sheets attribute
597 <dt>"media" (
1setof type3 keyword | name(MAX)):
599 <dd>The client OPTIONALLY supplies one or more media attributes
600 specifying the size, type, source, and color of the output
601 media. If the client does not specify this attribute then the
602 value of the
"media-default" printer object attribute is used.
604 <blockquote><b>Note:
</b> Standard IPP only allows
605 specification of a single media attribute
608 <dt>Other Job Template Attributes
612 <h4>Set-Job-Attributes Response
</h4>
614 <p>The following groups of attributes are send as part of the Set-Job-Attributes
617 <p>Group
1: Operation Attributes
623 <dd>The standard response status message.
625 <dt>Natural Language and Character Set:
627 <dd>The
"attributes-charset" and
"attributes-natural-language"
628 attributes as described in section
3.1.4.2 of the IPP Model and
633 <h3 class='title'
><span class='info'
>CUPS
1.2</span><a
634 name='CREATE_PRINTER_SUBSCRIPTION'
>Create-Printer-Subscription
</a></h3>
636 <p>The Create-Printer-Subscription operation (
0x0016) creates a
637 subscription for printer or server event notifications. CUPS
638 provides several additional events in addition to the standard
639 events in the IPP notifications specification.
</p>
641 <h4>Create-Printer-Subscription Request
</h4>
643 <p>The following groups of attributes are supplied as part of the
646 <p>Group
1: Operation Attributes
</p>
650 <dt>Natural Language and Character Set:
652 <dd>The
"attributes-charset" and
"attributes-natural-language"
653 attributes as described in section
3.1.4.1 of the IPP Model and
656 <dt>"printer-uri" (uri):
659 (
<tt>ipp://server/printers/printername
</tt>), class
660 (
<tt>ipp://server/classes/classname
</tt>), or server
661 (
<tt>ipp://server/
</tt>) URI for event notifications.
663 <dt>"notify-events" (
1setOf keyword):
665 <dd>The events to monitor. In addition to the standard
666 events, CUPS adds the following keywords:
669 <li><tt>printer-added
</tt> - Get notified
670 whenever a printer or class is added
</li>
672 <li><tt>printer-deleted
</tt> - Get notified
673 whenever a printer or class is deleted
</li>
675 <li><tt>printer-modified
</tt> - Get notified
676 whenever a printer or class is modified
</li>
678 <li><tt>server-audit
</tt> - Get notified when a
679 security condition occurs
</li>
681 <li><tt>server-restarted
</tt> - Get notified when
682 the server is restarted
</li>
684 <li><tt>server-started
</tt> - Get notified when
685 the server is started
</li>
687 <li><tt>server-stopped
</tt> - Get notified when
688 the server is stopped
</li>
694 <h4>Create-Printer-Subscription Response
</h4>
696 <p>The following groups of attributes are send as part of the
699 <p>Group
1: Operation Attributes
</p>
705 <dd>The standard response status message.
707 <dt>Natural Language and Character Set:
709 <dd>The
"attributes-charset" and
"attributes-natural-language"
710 attributes as described in section
3.1.4.2 of the IPP Model and
715 <p>Group
2: Subscription Object Attributes
</p>
719 <dt>"subscription-id" (integer):
721 <dd>The subscription number.
725 <h3 class='title'
><a name='CUPS_GET_DEFAULT'
>CUPS-Get-Default Operation
</a></h3>
727 <p>The CUPS-Get-Default operation (
0x4001) returns the default printer
730 <h4>CUPS-Get-Default Request
</h4>
732 <p>The following groups of attributes are supplied as part of the
733 CUPS-Get-Default request:
735 <p>Group
1: Operation Attributes
739 <dt>Natural Language and Character Set:
741 <dd>The
"attributes-charset" and
"attributes-natural-language"
742 attributes as described in section
3.1.4.1 of the IPP Model and
745 <dt>"requested-attributes" (
1setOf keyword) :
747 <dd>The client OPTIONALLY supplies a set of attribute names
748 and/or attribute group names in whose values the requester is
749 interested. If the client omits this attribute, the server
750 responds as if this attribute had been supplied with a value of
755 <h4>CUPS-Get-Default Response
</h4>
757 <p>The following groups of attributes are send as part of the
758 CUPS-Get-Default Response:
760 <p>Group
1: Operation Attributes
766 <dd>The standard response status message.
768 <dt>Natural Language and Character Set:
770 <dd>The
"attributes-charset" and
"attributes-natural-language"
771 attributes as described in section
3.1.4.2 of the IPP Model and
776 <p>Group
2: Printer Object Attributes
780 <dt>The set of requested attributes and their current values.
784 <h3 class='title'
><a name='CUPS_GET_PRINTERS'
>CUPS-Get-Printers Operation
</a></h3>
786 <p>The CUPS-Get-Printers operation (
0x4002) returns the printer
787 attributes for every printer known to the system. This may include
788 printers that are not served directly by the server.
790 <h4>CUPS-Get-Printers Request
</h4>
792 <p>The following groups of attributes are supplied as part of the
793 CUPS-Get-Printers request:
795 <p>Group
1: Operation Attributes
799 <dt>Natural Language and Character Set:
801 <dd>The
"attributes-charset" and
"attributes-natural-language"
802 attributes as described in section
3.1.4.1 of the IPP Model and
805 <dt>"limit" (integer (
1:MAX)):
807 <dd>The client OPTIONALLY supplies this attribute limiting the
808 number of printers that are returned.
810 <dt>"printer-info" (text(
127)):
<span class='info'
>CUPS
1.1</span>
812 <dd>The client OPTIONALLY supplies this attribute to
813 select which printers are returned.
815 <dt>"printer-location" (text(
127)):
<span class='info'
>CUPS
1.1.7</span>
817 <dd>The client OPTIONALLY supplies this attribute to
818 select which printers are returned.
820 <dt>"printer-type" (type2 enum):
<span class='info'
>CUPS
1.1.7</span>
822 <dd>The client OPTIONALLY supplies a printer type enumeration to
823 select which printers are returned.
825 <dt>"printer-type-mask" (type2 enum):
<span class='info'
>CUPS
1.1.7</span>
827 <dd>The client OPTIONALLY supplies a printer type mask
828 enumeration to select which bits are used in the
"printer-type"
831 <dt>"requested-attributes" (
1setOf keyword) :
833 <dd>The client OPTIONALLY supplies a set of attribute names
834 and/or attribute group names in whose values the requester is
835 interested. If the client omits this attribute, the server
836 responds as if this attribute had been supplied with a value of
841 <h4>CUPS-Get-Printers Response
</h4>
843 <p>The following groups of attributes are send as part of the
844 CUPS-Get-Printers Response:
846 <p>Group
1: Operation Attributes
852 <dd>The standard response status message.
854 <dt>Natural Language and Character Set:
856 <dd>The
"attributes-charset" and
"attributes-natural-language"
857 attributes as described in section
3.1.4.2 of the IPP Model and
862 <p>Group
2: Printer Object Attributes
866 <dt>The set of requested attributes and their current values for
871 <h3 class='title'
><a name='CUPS_ADD_MODIFY_PRINTER'
>CUPS-Add-Modify-Printer Operation
</a></h3>
873 <p>The CUPS-Add-Modify-Printer operation (
0x4003) adds a new printer or
874 modifies an existing printer on the system.
876 <h4>CUPS-Add-Modify-Printer Request
</h4>
878 <p>The following groups of attributes are supplied as part of the
879 CUPS-Add-Modify-Printer request:
881 <p>Group
1: Operation Attributes
885 <dt>Natural Language and Character Set:
887 <dd>The
"attributes-charset" and
"attributes-natural-language"
888 attributes as described in section
3.1.4.1 of the IPP Model and
891 <dt>"printer-uri" (uri):
893 <dd>The client MUST supply a URI for the specified printer.
897 <p>Group
2: Printer Object Attributes
901 <dt>"auth-info-required" (
1setOf type2 keyword):
<span class='info'
>CUPS
1.3</span>
903 <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
905 <dt>"job-sheets-default" (
1setOf name(
127)):
<span
906 class='info'
>CUPS
1.1.7</span>
908 <dd>The client OPTIONALLY supplies one or two banner page
909 names that are printed before and after files in a job.
910 The reserved name
"none" is used to specify that no
911 banner page should be printed.
913 <dt>"device-uri" (uri):
915 <dd>The client OPTIONALLY supplies a device URI for the
918 <dt>"ppd-name" (name(
127)):
920 <dd>The client OPTIONALLY supplies a PPD name for the specified
923 <dt>"printer-is-accepting-jobs" (boolean):
925 <dd>The client OPTIONALLY supplies this boolean attribute
926 indicating whether or not the printer object should accept new jobs.
928 <dt>"printer-info" (text(
127)):
930 <dd>The client OPTIONALLY supplies this attribute indicating the
931 printer information string.
933 <dt>"printer-location" (text(
127)):
935 <dd>The client OPTIONALLY supplies this attribute indicating a
936 textual location of the printer.
938 <dt>"printer-more-info" (uri):
940 <dd>The client OPTIONALLY supplies this attribute indicating a
941 URI for additional printer information.
943 <dt>"printer-state" (type2 enum):
945 <dd>The client OPTIONALLY supplies this attribute indicating the
946 initial/current state of the printer. Only the
"idle" and
"stopped"
947 enumerations are recognized.
949 <dt>"printer-state-message" (text(MAX)):
951 <dd>The client OPTIONALLY supplies this attribute indicating a
952 textual reason for the current printer state.
954 <dt>"requesting-user-name-allowed" (
1setof name(
127) | delete)
956 <br>"requesting-user-name-denied" (
1setof name(
127) | delete):
958 <dd>The client OPTIONALLY supplies one of these attributes to
959 specify an access control list for incoming print jobs. To allow
960 all users access to a printer, use the delete tag for the
965 <p>The CUPS-Add-Modify-Printer request can optionally be followed by a PPD
966 file or System V interface script to be used for the printer. The
967 "ppd-name" attribute overrides any file that is attached to the end of
968 the request with a local CUPS PPD file.
970 <h4>CUPS-Add-Modify-Printer Response
</h4>
972 <p>The following groups of attributes are send as part of the
973 CUPS-Add-Modify-Printer Response:
975 <p>Group
1: Operation Attributes
981 <dd>The standard response status message.
983 <dt>Natural Language and Character Set:
985 <dd>The
"attributes-charset" and
"attributes-natural-language"
986 attributes as described in section
3.1.4.2 of the IPP Model and
991 <h3 class='title'
><a name='CUPS_DELETE_PRINTER'
>CUPS-Delete-Printer Operation
</a></h3>
993 <p>The CUPS-Delete-Printer operation (
0x4004) removes an existing
994 printer from the system.
996 <h4>CUPS-Delete-Printer Request
</h4>
998 <p>The following groups of attributes are supplied as part of the
999 CUPS-Delete-Printer request:
1001 <p>Group
1: Operation Attributes
1005 <dt>Natural Language and Character Set:
1007 <dd>The
"attributes-charset" and
"attributes-natural-language"
1008 attributes as described in section
3.1.4.1 of the IPP Model and
1011 <dt>"printer-uri" (uri):
1013 <dd>The client MUST supply a URI for the specified printer.
1017 <h4>CUPS-Delete-Printer Response
</h4>
1019 <p>The following groups of attributes are send as part of the
1020 CUPS-Delete-Printer Response:
1022 <p>Group
1: Operation Attributes
1028 <dd>The standard response status message.
1030 <dt>Natural Language and Character Set:
1032 <dd>The
"attributes-charset" and
"attributes-natural-language"
1033 attributes as described in section
3.1.4.2 of the IPP Model and
1038 <h3 class='title'
><a name='CUPS_GET_CLASSES'
>CUPS-Get-Classes Operation
</a></h3>
1040 <p>The CUPS-Get-Classes operation (
0x4005) returns the printer
1041 attributes for every printer class known to the system. This may
1042 include printer classes that are not served directly by the server.
1044 <h4>CUPS-Get-Classes Request
</h4>
1046 <p>The following groups of attributes are supplied as part of the
1047 CUPS-Get-Classes request:
1049 <p>Group
1: Operation Attributes
1053 <dt>Natural Language and Character Set:
1055 <dd>The
"attributes-charset" and
"attributes-natural-language"
1056 attributes as described in section
3.1.4.1 of the IPP Model and
1059 <dt>"limit" (integer (
1:MAX)):
1061 <dd>The client OPTIONALLY supplies this attribute limiting the
1062 number of printer classes that are returned.
1064 <dt>"printer-info" (text(
127)):
<span class='info'
>CUPS
1.1.7</span>
1065 <dd>The client OPTIONALLY supplies this attribute to
1066 select which printer classes are returned.
1068 <dt>"printer-location" (text(
127)):
<span class='info'
>CUPS
1.1.7</span>
1069 <dd>The client OPTIONALLY supplies this attribute to
1070 select which printer classes are returned.
1072 <dt>"printer-type" (type2 enum):
<span class='info'
>CUPS
1.1.7</span>
1073 <dd>The client OPTIONALLY supplies a printer type enumeration to
1074 select which printer classes are returned.
1076 <dt>"printer-type-mask" (type2 enum):
<span class='info'
>CUPS
1.1.7</span>
1077 <dd>The client OPTIONALLY supplies a printer type mask
1078 enumeration to select which bits are used in the
"printer-type"
1081 <dt>"requested-attributes" (
1setOf keyword) :
1083 <dd>The client OPTIONALLY supplies a set of attribute names
1084 and/or attribute group names in whose values the requester is
1085 interested. If the client omits this attribute, the server responds as
1086 if this attribute had been supplied with a value of 'all'.
1090 <h4>CUPS-Get-Classes Response
</h4>
1092 <p>The following groups of attributes are send as part of the
1093 CUPS-Get-Classes Response:
1095 <p>Group
1: Operation Attributes
1101 <dd>The standard response status message.
1103 <dt>Natural Language and Character Set:
1105 <dd>The
"attributes-charset" and
"attributes-natural-language"
1106 attributes as described in section
3.1.4.2 of the IPP Model and
1111 <p>Group
2: Printer Class Object Attributes
1115 <dt>The set of requested attributes and their current values for
1120 <h3 class='title'
><a name='CUPS_ADD_MODIFY_CLASS'
>CUPS-Add-Modify-Class Operation
</a></h3>
1122 <p>The CUPS-Add-Modify-Class operation (
0x4006) adds a new printer class or
1123 modifies and existing printer class on the system.
1125 <h4>CUPS-Add-Modify-Class Request
</h4>
1127 <p>The following groups of attributes are supplied as part of the
1128 CUPS-Add-Modify-Class request:
1130 <p>Group
1: Operation Attributes
1134 <dt>Natural Language and Character Set:
1136 <dd>The
"attributes-charset" and
"attributes-natural-language"
1137 attributes as described in section
3.1.4.1 of the IPP Model and
1140 <dt>"printer-uri" (uri):
1142 <dd>The client MUST supply a URI for the specified printer class.
1146 <p>Group
2: Printer Object Attributes
1150 <dt>"auth-info-required" (
1setOf type2 keyword):
<span class='info'
>CUPS
1.3</span>
1152 <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
1154 <dt>"member-uris" (
1setof uri):
1156 <dd>The client OPTIONALLY supplies the
"member-uris" set
1157 specifying the printers and printer classes that are part of the class.
1159 <dt>"printer-is-accepting-jobs" (boolean):
1161 <dd>The client OPTIONALLY supplies this boolean attribute
1162 indicating whether or not the class object should accept new jobs.
1164 <dt>"printer-info" (text(
127)):
1166 <dd>The client OPTIONALLY supplies this attribute indicating the
1167 printer information string.
1169 <dt>"printer-location" (text(
127)):
1171 <dd>The client OPTIONALLY supplies this attribute indicating a
1172 textual location of the class.
1174 <dt>"printer-more-info" (uri):
1176 <dd>The client OPTIONALLY supplies this attribute indicating a
1177 URI for additional class information.
1179 <dt>"printer-state" (type2 enum):
1181 <dd>The client OPTIONALLY supplies this attribute indicating the
1182 initial/current state of the class. Only the
"idle" and
"stopped"
1183 enumerations are recognized.
1185 <dt>"printer-state-message" (text(MAX)):
1187 <dd>The client OPTIONALLY supplies this attribute indicating a
1188 textual reason for the current class state.
1190 <dt>"requesting-user-name-allowed" (
1setof name(
127))
1192 <br>"requesting-user-name-denied" (
1setof name(
127)):
1194 <dd>The client OPTIONALLY supplies one of these attributes to
1195 specify an access control list for incoming print jobs. To allow
1196 all users access to a class, use the delete tag for the
1201 <h4>CUPS-Add-Modify-Class Response
</h4>
1203 <p>The following groups of attributes are send as part of the CUPS-Add-Modify-Class Response:
1205 <p>Group
1: Operation Attributes
1211 <dd>The standard response status message.
1213 <dt>Natural Language and Character Set:
1215 <dd>The
"attributes-charset" and
"attributes-natural-language"
1216 attributes as described in section
3.1.4.2 of the IPP Model and
1221 <h3 class='title'
><a name='CUPS_DELETE_CLASS'
>CUPS-Delete-Class Operation
</a></h3>
1223 <p>The CUPS-Delete-Class operation (
0x4007) removes an existing printer
1224 class from the system.
1226 <h4>CUPS-Delete-Class Request
</h4>
1228 <p>The following groups of attributes are supplied as part of the
1229 CUPS-Delete-Class request:
1231 <p>Group
1: Operation Attributes
1235 <dt>Natural Language and Character Set:
1237 <dd>The
"attributes-charset" and
"attributes-natural-language"
1238 attributes as described in section
3.1.4.1 of the IPP Model and
1241 <dt>"printer-uri" (uri):
1243 <dd>The client MUST supply a URI for the specified printer class.
1247 <h4>CUPS-Delete-Class Response
</h4>
1249 <p>The following groups of attributes are send as part of the
1250 CUPS-Delete-Class Response:
1252 <p>Group
1: Operation Attributes
1258 <dd>The standard response status message.
1260 <dt>Natural Language and Character Set:
1262 <dd>The
"attributes-charset" and
"attributes-natural-language"
1263 attributes as described in section
3.1.4.2 of the IPP Model and
1268 <h3 class='title'
><a name='CUPS_ACCEPT_JOBS'
>CUPS-Accept-Jobs Operation
</a></h3>
1270 <p>The CUPS-Accept-Jobs operation (
0x4008) sets the
1271 "printer-is-accepting-jobs" attribute to true for the specified printer
1274 <h4>CUPS-Accept-Jobs Request
</h4>
1276 <p>The following groups of attributes are supplied as part of the
1277 CUPS-Accept-Jobs request:
1279 <p>Group
1: Operation Attributes
1283 <dt>Natural Language and Character Set:
1285 <dd>The
"attributes-charset" and
"attributes-natural-language"
1286 attributes as described in section
3.1.4.1 of the IPP Model and
1289 <dt>"printer-uri" (uri):
1291 <dd>The client MUST supply a URI for the specified printer or printer class.
1295 <h4>CUPS-Accept-Jobs Response
</h4>
1297 <p>The following groups of attributes are send as part of the
1298 CUPS-Accept-Jobs Response:
1300 <p>Group
1: Operation Attributes
1306 <dd>The standard response status message.
1308 <dt>Natural Language and Character Set:
1310 <dd>The
"attributes-charset" and
"attributes-natural-language"
1311 attributes as described in section
3.1.4.2 of the IPP Model and
1316 <h3 class='title'
><a name='CUPS_REJECT_JOBS'
>CUPS-Reject-Jobs Operation
</a></h3>
1318 <p>The CUPS-Reject-Jobs operation (
0x4009) sets
1319 the
"printer-is-accepting-jobs" attribute to false for the specified
1320 printer or printer class.
1322 <h4>CUPS-Reject-Jobs Request
</h4>
1324 <p>The following groups of attributes are supplied as part of the
1325 CUPS-Reject-Jobs request:
1327 <p>Group
1: Operation Attributes
1331 <dt>Natural Language and Character Set:
1333 <dd>The
"attributes-charset" and
"attributes-natural-language"
1334 attributes as described in section
3.1.4.1 of the IPP Model and
1337 <dt>"printer-uri" (uri):
1339 <dd>The client MUST supply a URI for the specified printer or printer class.
1343 <p>Group
2: Printer Object Attributes
1347 <dt>"printer-state-message" (text(MAX)):
1349 <dd>The client OPTIONALLY supplies this attribute indicating a
1350 textual reason for the current printer state.
1354 <h4>CUPS-Reject-Jobs Response
</h4>
1356 <p>The following groups of attributes are send as part of the
1357 CUPS-Reject-Jobs Response:
1359 <p>Group
1: Operation Attributes
1365 <dd>The standard response status message.
1367 <dt>Natural Language and Character Set:
1369 <dd>The
"attributes-charset" and
"attributes-natural-language"
1370 attributes as described in section
3.1.4.2 of the IPP Model and
1375 <h3 class='title'
><a name='CUPS_SET_DEFAULT'
>CUPS-Set-Default Operation
</a></h3>
1377 <p>The CUPS-Set-Default operation (
0x400A) sets the default printer
1378 destination for all clients when a resource name of
"/printers" is
1381 <h4>CUPS-Set-Default Request
</h4>
1383 <p>The following groups of attributes are supplied as part of the
1384 CUPS-Set-Default request:
1386 <p>Group
1: Operation Attributes
1390 <dt>Natural Language and Character Set:
1392 <dd>The
"attributes-charset" and
"attributes-natural-language"
1393 attributes as described in section
3.1.4.1 of the IPP Model and
1396 <dt>"printer-uri" (uri):
1398 <dd>The client MUST supply a URI for the specified printer or
1403 <h4>CUPS-Set-Default Response
</h4>
1405 <p>The following groups of attributes are send as part of the
1406 CUPS-Set-Default Response:
1408 <p>Group
1: Operation Attributes
1414 <dd>The standard response status message.
1416 <dt>Natural Language and Character Set:
1418 <dd>The
"attributes-charset" and
"attributes-natural-language"
1419 attributes as described in section
3.1.4.2 of the IPP Model and
1424 <h3 class='title'
><span class='info'
>CUPS
1.1</span><a name='CUPS_GET_DEVICES'
>CUPS-Get-Devices Operation
</a></h3>
1426 <p>The CUPS-Get-Devices operation (
0x400B) returns all of the
1427 supported device-uri's for the server.
</p>
1429 <h4>CUPS-Get-Devices Request
</h4>
1431 <p>The following groups of attributes are supplied as part of the
1432 CUPS-Get-Devices request:
1434 <p>Group
1: Operation Attributes
1438 <dt>Natural Language and Character Set:
1440 <dd>The
"attributes-charset" and
"attributes-natural-language"
1441 attributes as described in section
3.1.4.1 of the IPP Model and
1444 <dt>"device-class" (type1 keyword):
1446 <dd>The client OPTIONALLY supplies a device class keyword to select
1447 which devices are returned.
1449 <dt>"limit" (integer (
1:MAX)):
1451 <dd>The client OPTIONALLY supplies this attribute limiting the number of
1452 devices that are returned.
1454 <dt>"requested-attributes" (
1setOf keyword) :
1456 <dd>The client OPTIONALLY supplies a set of attribute names and/or
1457 attribute group names in whose values the requester is interested. If
1458 the client omits this attribute, the server responds as if this
1459 attribute had been supplied with a value of 'all'.
1463 <h4>CUPS-Get-Devices Response
</h4>
1465 <p>The following groups of attributes are send as part of the
1466 CUPS-Get-Devices Response:
1468 <p>Group
1: Operation Attributes
1474 <dd>The standard response status message.
1476 <dt>Natural Language and Character Set:
1478 <dd>The
"attributes-charset" and
"attributes-natural-language"
1479 attributes as described in section
3.1.4.2 of the IPP Model and
1484 <p>Group
2: Device Object Attributes
1488 <dt>The set of requested attributes and their current values for
1493 <h3 class='title'
><span class='info'
>CUPS
1.1</span><a name='CUPS_GET_PPDS'
>CUPS-Get-PPDs Operation
</a></h3>
1495 <p>The CUPS-Get-PPDs operation (
0x400C) returns all of the
1496 locally available PPD files on the system.
</p>
1498 <h4>CUPS-Get-PPDs Request
</h4>
1500 <p>The following groups of attributes are supplied as part of the
1501 CUPS-Get-PPDs request:
1503 <p>Group
1: Operation Attributes
1507 <dt>Natural Language and Character Set:
1509 <dd>The
"attributes-charset" and
"attributes-natural-language"
1510 attributes as described in section
3.1.4.1 of the IPP Model and
1513 <dt>"limit" (integer (
1:MAX)):
1515 <dd>The client OPTIONALLY supplies this attribute limiting the number of
1516 PPDs that are returned.
1518 <dt>"ppd-make" (text(
127)):
1520 <dd>The client OPTIONALLY supplies a printer manufacturer to select
1521 which PPDs are returned.
1523 <dt>"requested-attributes" (
1setOf keyword) :
1525 <dd>The client OPTIONALLY supplies a set of attribute names and/or
1526 attribute group names in whose values the requester is interested. If
1527 the client omits this attribute, the server responds as if this
1528 attribute had been supplied with a value of 'all'.
1532 <h4>CUPS-Get-PPDs Response
</h4>
1534 <p>The following groups of attributes are send as part of the
1535 CUPS-Get-PPDs Response:
1537 <p>Group
1: Operation Attributes
1543 <dd>The standard response status message.
1545 <dt>Natural Language and Character Set:
1547 <dd>The
"attributes-charset" and
"attributes-natural-language"
1548 attributes as described in section
3.1.4.2 of the IPP Model and
1553 <p>Group
2: PPD Attributes
1557 <dt>The set of requested attributes and their current values for each
1562 <h3 class='title'
><span class='info'
>CUPS
1.1</span><a name='CUPS_MOVE_JOB'
>CUPS-Move-Job Operation
</a></h3>
1564 <p>The CUPS-Move-Job operation (
0x400D) moves an active print job
1565 to a different printer.
</p>
1567 <h4>CUPS-Move-Job Request
</h4>
1569 <p>The following groups of attributes are supplied as part of the
1570 CUPS-Move-Job request:
1572 <p>Group
1: Operation Attributes
1576 <dt>Natural Language and Character Set:
1578 <dd>The
"attributes-charset" and
"attributes-natural-language"
1579 attributes as described in section
3.1.4.1 of the IPP Model and
1582 <dt>"printer-uri" (uri) and
"job-id" (integer)
1586 <dd>The client MUST supply a URI for the specified printer and
1587 a job ID number, or the job URI.
1591 <p>Group
2: Job Template Attributes
1595 <dt>"job-printer-uri" (uri)
1597 <dd>The client MUST supply a URI for a printer on the same server.
1601 <h4>CUPS-Move-Job Response
</h4>
1603 <p>The following groups of attributes are send as part of the
1604 CUPS-Move-Job Response:
1606 <p>Group
1: Operation Attributes
1612 <dd>The standard response status message.
1614 <dt>Natural Language and Character Set:
1616 <dd>The
"attributes-charset" and
"attributes-natural-language"
1617 attributes as described in section
3.1.4.2 of the IPP Model and
1622 <h3 class='title'
><span class='info'
>CUPS
1.2</span><a name='CUPS_AUTHENTICATE_JOB'
>CUPS-Authenticate-Job Operation
</a></h3>
1624 <p>The CUPS-Authenticate-Job operation (
0x400E) authenticate a
1625 print job for printing. Typically this is used when printing to a
1626 remote server. The authentication information is passed in the
1629 <h4>CUPS-Authenticate-Job Request
</h4>
1631 <p>The following groups of attributes are supplied as part of the
1632 CUPS-Authenticate-Job request:
1634 <p>Group
1: Operation Attributes
1638 <dt>Natural Language and Character Set:
1640 <dd>The
"attributes-charset" and
"attributes-natural-language"
1641 attributes as described in section
3.1.4.1 of the IPP Model and
1644 <dt>"printer-uri" (uri) and
"job-id" (integer)
1648 <dd>The client MUST supply a URI for the specified printer and
1649 a job ID number, or the job URI.
1653 <p>Group
2: Job Attributes
1657 <dt>"auth-info" (
1setOf text(MAX)):
<span class='info'
>CUPS
1.3</span>
1659 <dd>The client OPTIONALLY supplies one or more authentication values as specified by the
"auth-info-required" attribute.
1663 <h4>CUPS-Authenticate-Job Response
</h4>
1665 <p>The following groups of attributes are send as part of the
1666 CUPS-Authenticate-Job Response:
1668 <p>Group
1: Operation Attributes
1674 <dd>The standard response status message.
1676 <dt>Natural Language and Character Set:
1678 <dd>The
"attributes-charset" and
"attributes-natural-language"
1679 attributes as described in section
3.1.4.2 of the IPP Model and
1684 <p>Group
2: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
1688 <dt>auth-info-required (
1setOf Type2 keyword)
1690 <dd>The required authentication information.
1694 <h3 class='title'
><span class='info'
>CUPS
1.3</span><a name='CUPS_GET_PPD'
>CUPS-Get-PPD Operation
</a></h3>
1696 <p>The CUPS-Get-PPD operation (
0x400F) gets a PPD file from the
1697 server. The PPD file can be specified using a
<tt>ppd-name
</tt>
1698 returned by
<a href='#CUPS_GET_PPDS'
><tt>CUPS-Get-PPDs
</tt></a>
1699 or using the
<tt>printer-uri
</tt> for a queue.
</p>
1701 <p>If the PPD file is found,
<tt>successful-ok
</tt> is returned with
1702 the PPD file following the response data.
</p>
1704 <p>If the PPD file cannot be served by the local server because
1705 the
<tt>printer-uri
</tt> attribute points to an external printer,
1706 a
<tt>cups-see-other
</tt> status is returned with the correct
1709 <p>If the PPD file does not exist,
<tt>client-error-not-found
</tt> is
1712 <h4>CUPS-Get-PPD Request
</h4>
1714 <p>The following group of attributes is supplied as part of the
1715 CUPS-Get-PPD request:
1717 <p>Group
1: Operation Attributes
1721 <dt>Natural Language and Character Set:
1723 <dd>The
"attributes-charset" and
"attributes-natural-language"
1724 attributes as described in section
3.1.4.1 of the IPP Model and
1727 <dt>"printer-uri" (uri)
1729 <br>"ppd-name" (name(
255)):
1731 <dd>The client MUST supply a printer URI or PPD name.
1735 <h4>CUPS-Get-PPD Response
</h4>
1737 <p>The following group of attributes is sent as part of the
1738 CUPS-Get-PPD Response:
1740 <p>Group
1: Operation Attributes
1746 <dd>The standard response status message.
1748 <dt>Natural Language and Character Set:
1750 <dd>The
"attributes-charset" and
"attributes-natural-language"
1751 attributes as described in section
3.1.4.2 of the IPP Model and
1754 <dt>"printer-uri" (uri):
1756 <dd>The printer that provides the actual PPD file when
1757 the status code is cups-see-other (
0x280)
1761 <p>If the status code is
<tt>successful-ok
</tt>, the PPD file follows
1762 the end of the IPP response.
</p>
1765 <h2 class='title'
><a name='ATTRIBUTES'
>Attributes
</a></h2>
1767 <p>CUPS provides many extension attributes to support multiple
1768 devices, PPD files, standard job filters, printers, and printer
1771 <h3 class='title'
><a name='DEVICE_ATTRIBUTES'
>Device Attributes
</a></h3>
1773 <p>Device attributes are returned by the CUPS-Get-Devices
1774 operation and enumerate all of the available hardware devices and
1775 network protocols that are supported by the server.
</p>
1777 <h4><a name=
"device-class">device-class (type2 keyword)
</a></h4>
1779 <p>The device-class attribute specifies the class of device and can be
1780 one of the following:
1784 <li>"file" - a disk file.
1786 <li>"direct" - a parallel or fixed-rate serial data port,
1787 currently used for Centronics, IEEE-
1284, and USB printer
1790 <li>"serial" - a variable-rate serial port.
1792 <li>"network" - a network connection, typically via AppSocket,
1793 HTTP, IPP, LPD, or SMB/CIFS protocols.
1797 <h4><a name=
"device-id">device-id (text(
127))
</a><span class=
"info">CUPS
1.2</span></h4>
1799 <p>The device-id attribute specifies the IEEE-
1284 device ID
1800 string for the device.
</p>
1802 <h4><a name=
"device-info">device-info (text(
127))
</a></h4>
1804 <p>The device-info attribute specifies a human-readable string describing
1805 the device, e.g.
"Parallel Port #1".
1807 <h4><a name=
"device-make-and-model">device-make-and-model (text(
127))
</a></h4>
1809 <p>The device-makr-and-model attribute specifies a device
1810 identification string provided by the printer connected to the device.
1811 If the device or printer does not support identification then this
1812 attribute contains the string
"unknown".
1814 <h4><a name=
"device-uri">device-uri (uri)
</a></h4>
1816 <p>The device-uri attribute specifies a unique identifier for the
1817 device. The actual format of the device-uri string depends on the value
1818 of the device-class attribute:
1822 <li>"file" - The device-uri will be of the form
1823 "file:///path/to/filename".
1825 <li>"direct" - The device-uri will be of the form
1826 "scheme:/dev/filename" or
"scheme://vendor/identifier",
1827 where scheme may be
"parallel" or
"usb" in the current
1830 <li>"serial" - The device-uri will be of the form
1831 "serial:/dev/filename?baud=value+parity=value+flow=value".
1832 The baud value is the data rate in bits per second; the
1833 supported values depend on the underlying hardware.
1834 The parity value can be one of
"none",
"even", or
"odd".
1835 The flow value can be one of
"none",
"soft" (XON/XOFF
1836 handshaking),
"hard" or
"rts/cts" (RTS/CTS handshaking),
1837 or
"dtrdsr" (DTR/DSR handshaking).
1839 <p>The URI returned by CUPS-Get-Devices will contain the
1840 maximum baud rate supported by the device and the best
1841 type of flow control available (
"soft" or
"hard").
1843 <li>"network" - The device-uri will be of the form
1844 "scheme://[username:password@]hostname[:port]/[resource]",
1845 where scheme may be
"http",
"https",
"ipp",
"lpd",
"smb", or
1846 "socket" in the current implementation.
1848 <p>The URI returned by CUPS-Get-Devices will only contain
1849 the scheme name (
"scheme"). It is up to the client
1850 application to add the appropriate host and other
1851 information when adding a new printer.
1853 <p>The URI returned by Get-Printer-Attributes and
1854 CUPS-Get-Printers has any username and password information
1855 stripped; the information is still stored and used by the
1856 server internally to perform any needed authentication.
1860 <h3 class='title'
><a name='JOB_TEMPLATE_ATTRIBUTES'
>Job Template Attributes
</a></h3>
1862 <h4><a name=
"auth-info">auth-info (
1setOf text(MAX))
</a><span class=
"info">CUPS
1.3</span></h4>
1864 <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.
1866 <h4><a name=
"blackplot">blackplot (boolean)
</a></h4>
1868 <p>The blackplot attribute specifies whether HP-GL/
2 plot files should be
1869 rendered entirely in black ink (blackplot=true) or using the colors and shades
1870 specified in the file (blackplot=false). The default value is false.
1872 <h4><a name=
"brightness">brightness (integer(
0:
200))
</a></h4>
1874 <p>The brightness attribute specifies the overall brightness of the printed
1875 output in percent. A brightness of
100 is normal, while
200 is twice as
1876 bright and
50 is half as bright. The default value is
100.
1878 <p>Brightness is applied to the Cyan, Magenta, Yellow, and Black values using
1879 the function
"f(x) = brightness / 100 * x".
1881 <h4><a name=
"columns">columns (integer(
1:
4))
</a></h4>
1883 <p>The columns attribute specifies the number of columns to generate when
1884 printing text files. The default value is
1.
1886 <h4><a name=
"cpi">cpi (type2 enum)
</a></h4>
1888 <p>The cpi attribute specifies the number of characters per inch when
1889 printing text files. Only the values
10,
12, and
17 are currently
1890 supported. The default value is
10.
1892 <h4><a name=
"fitplot">fitplot (boolean)
</a></h4>
1894 <p>The fitplot attribute specifies whether to scale HP-GL/
2 plot files to
1895 fit on the selected media (fitplot=true) or use the physical scale specified
1896 in the plot file (fitplot=false). The default value is false.
1898 <h4><a name=
"gamma">gamma (integer(
1:
10000))
</a></h4>
1900 <p>The gamma attribute specifies the luminance correction for the output.
1901 A value of
1000 specifies no correction, while values of
2000 and
500 will
1902 generate lighter and darker output, respectively. The default value is
1905 <p>Gamma is applied to the Red, Green, and Blue values (or luminance for
1906 grayscale output) using the function
"f(x) = x<SUp>(1000/gamma)</SUp>".
1908 <h4><a name=
"hue">hue (integer(-
180:
180))
</a></h4>
1910 <p>The hue attribute specifies a color hue rotation when printing image
1911 files. The default value is
0.
1913 <h4><a name=
"job-billing">job-billing (text(MAX))
</a><span class='info'
>CUPS
1.1</span></h4>
1915 <p>The job-billing attribute provides a text value to associate with a job
1916 for billing purposes.
1918 <h4><a name=
"job-hold-until">job-hold-until (keyword | name(MAX))
</a><span class='info'
>CUPS
1.1</span></h4>
1920 <p>The job-hold-until attribute specifies a hold time. In addition to the
1921 standard IPP/
1.1 keyword names, CUPS supports name values of the form
1922 "HH:MM" and
"HH:MM:SS" that specify a hold time. The hold time is in
1923 Universal Coordinated Time (UTC) and
<i>not
</i> in the local time zone. If the
1924 specified time is less than the current time, the job is held until the
1927 <h4><a name=
"job-sheets">job-sheets (
1setof type3 keyword | name(MAX))
</a><span class='info'
>CUPS
1.1</span></h4>
1929 <p>The job-sheets attribute specifies one or two banner files that are printed
1930 before and after a job. The reserved value of
"none" disables banner printing.
1931 The default value is stored in the job-sheets-default attribute.
1933 <p>If only one value is supplied, the banner file is printed before the job.
1934 If two values are supplied, the first value is used as the starting banner
1935 file and the second as the ending banner file.
1937 <h4><a name=
"job-originating-host-name">job-originating-host-name (name(MAX))
</a></h4>
1939 <p><i>(CUPS
1.1.5 and higher)
</i>
1941 <p>The job-originating-host-name attribute specifies the host
1942 from which the job was queued. The value will be the hostname or
1943 IP address of the client depending on whether hostname
1944 resolution is enabled. The localhost address (
127.0.0.1) is
1945 <b>always
</b> resolved to the name
"localhost".
1947 <p>This attribute is read-only.
1949 <h4><a name=
"lpi">lpi (type2 enum)
</a></h4>
1951 <p>The lpi attribute specifies the number of lines per inch when
1952 printing text files. Only the values
6 and
8 are currently supported.
1953 The default value is
6.
1955 <h4><a name=
"mirror">mirror (boolean)
</a></h4>
1957 <p>The mirror attribute specifies whether pages are mirrored on
1958 their X axis, which is useful for printing transfer images on
1959 special media. The default value is false.
1961 <h4><a name=
"natural-scaling">natural-scaling (integer(
1:
1000))
</a><span class='info'
>CUPS
1.1.9</span></h4>
1962 <p>The natural-scaling attribute specifies the scaling of image files with
1963 respect to the natural image size. A value of
100 specifies that the image
1964 file should exactly the natural size, while
50 is half the natural size
1965 and
200 is twice the natural size. The default value is
100.
1967 <p>The ppi option can be used to override the natural resolution of the
1968 image, which controls the natural size.
1970 <h4><a name=
"number-up-layout">number-up-layout (type2 keyword)
</a><span class='info'
>CUPS
1.1.15</span></h4>
1971 <p>The number-up-layout attribute specifies the order each input
1972 page is placed on each output page. The following keywords are
1977 <li><CODE>btlr
</CODE> - Bottom to top, left to right
</li>
1979 <li><CODE>btrl
</CODE> - Bottom to top, right to left
</li>
1981 <li><CODE>lrbt
</CODE> - Left to right, bottom to top
</li>
1983 <li><CODE>lrtb
</CODE> - Left to right, top to bottom (default)
</li>
1985 <li><CODE>rlbt
</CODE> - Right to left, bottom to top
</li>
1987 <li><CODE>rltb
</CODE> - Right to left, top to bottom
</li>
1989 <li><CODE>tblr
</CODE> - Top to bottom, left to right
</li>
1991 <li><CODE>tbrl
</CODE> - Top to bottom, right to left
</li>
1995 <h4><a name=
"page-border">page-border (type2 keyword)
</a><span class='info'
>CUPS
1.1.15</span></h4>
1996 <p>The page-border attribute specifies whether a border is
1997 draw around each page. The following keywords are presently
2002 <li><CODE>double
</CODE> - Two hairline borders are drawn
</li>
2004 <li><CODE>double-thick
</CODE> - Two
1pt borders are drawn
</li>
2006 <li><CODE>none
</CODE> - No border is drawn (default)
</li>
2008 <li><CODE>single
</CODE> - A single hairline border is drawn
</li>
2010 <li><CODE>single-thick
</CODE> - A single
1pt border is drawn
</li>
2014 <h4><a name=
"page-bottom">page-bottom (integer(
0:MAX))
</a></h4>
2016 <p>The page-bottom attribute specifies the bottom margin in points (
72 points
2017 equals
1 inch). The default value is the device physical margin.
2019 <h4><a name=
"page-label">page-label (text(MAX))
</a><span class='info'
>CUPS
1.1.7</span></h4>
2020 <p>The page-label attribute provides a text value to place in
2021 the header and footer on each page. If a classification level is
2022 set on the server, then this classification is printed before
2025 <h4><a name=
"page-left">page-left (integer(
0:MAX))
</a></h4>
2027 <p>The page-left attribute specifies the left margin in points (
72 points
2028 equals
1 inch). The default value is the device physical margin.
2030 <h4><a name=
"page-right">page-right (integer(
0:MAX))
</a></h4>
2032 <p>The page-right attribute specifies the right margin in points (
72 points
2033 equals
1 inch). The default value is the device physical margin.
2035 <h4><a name=
"page-set">page-set (type2 keyword)
</a></h4>
2037 <p>The page-set attribute specifies which pages to print in a file. The
2038 supported keywords are
"all",
"even", and
"odd". The default value is
2041 <h4><a name=
"page-top">page-top (integer(
0:MAX))
</a></h4>
2043 <p>The page-top attribute specifies the top margin in points (
72 points
2044 equals
1 inch). The default value is the device physical margin.
2046 <h4><a name=
"penwidth">penwidth (integer(
0:MAX))
</a></h4>
2048 <p>The penwidth attribute specifies the default pen width in micrometers
2049 when printing HP-GL/
2 plot files. The default value is
1000 (
1 millimeter).
2051 <h4><a name=
"position">position (type2 keyword)
</a></h4>
2053 <p>The position attribute specifies the location of image files on the
2054 media. The following keyword values are recognized:
2058 <li><CODE>center
</CODE> - Center the image on the page (default)
2060 <li><CODE>top
</CODE> - Print the image centered at the top of the page
2062 <li><CODE>left
</CODE> - Print the image centered on the left of page
2064 <li><CODE>right
</CODE> - Print the image centered on the right of the page
2066 <li><CODE>top-left
</CODE> - Print the image at the top left corner of
2069 <li><CODE>top-right
</CODE> - Print the image at the top right corner of
2072 <li><CODE>bottom
</CODE> - Print the image centered at the bottom of
2075 <li><CODE>bottom-left
</CODE> - Print the image at the bottom left
2078 <li><CODE>bottom-right
</CODE> - Print the image at the bottom right
2083 <h4><a name=
"ppi">ppi (integer(
1:MAX))
</a></h4>
2085 <p>The ppi attribute specifies the resolution of an image file in pixels
2086 per inch. The default value is the resolution included with the file or
2087 128 if no resolution information is available.
2089 <h4><a name=
"prettyprint">prettyprint (boolean)
</a></h4>
2091 <p>The prettyprint attribute specifies whether text files should be printed
2092 with a shaded header and keyword highlighting (prettyprint=true) or without
2093 additional formatting (prettyprint=false). The default value is false.
2095 <h4><a name=
"saturation">saturation (integer(
0:
200))
</a></h4>
2097 <p>The saturation attribute specifies the color saturation when
2098 printing image files. A saturation of
100 is normal, while values of
50
2099 and
200 will be half and twice as colorful, respectively. The default
2102 <h4><a name=
"scaling">scaling (integer(
1:
1000))
</a></h4>
2104 <p>The scaling attribute specifies the scaling of image files with
2105 respect to the selected media. A value of
100 specifies that the image
2106 file should fit
100% of the page, or as much as possible given the
2107 image dimensions. The default value is unspecified.
2109 <p>The scaling attribute overrides the ppi attribute if specified.
2111 <h4><a name=
"wrap">wrap (boolean)
</a></h4>
2113 <p>The wrap attribute specifies whether long lines should be wrapped
2114 (wrap=true) or not (wrap=false) when printing text files. The default
2117 <h3 class='title'
><a name='PPD_ATTRIBUTES'
>PPD Attributes
</a></h3>
2119 <h4><a name=
"ppd-device-id">ppd-device-id (text(
127))
</a></h4>
2121 <p>The ppd-device-id attribute specifies the IEEE-
1284 device ID
2122 string for the device described by the PPD file.
</p>
2124 <h4><a name=
"ppd-make">ppd-make (text(
127))
</a></h4>
2126 <p>The ppd-make attribute specifies the manufacturer of the printer
2127 (the Manufacturer attribute in the PPD file). If the manufacturer
2128 is not specified in the PPD file then an educated guess is made using
2129 the NickName attribute in the PPD file.
2131 <h4><a name=
"ppd-make-and-model">ppd-make-and-model (text(
127))
</a></h4>
2133 <p>The ppd-make-and-model attribute specifies the manufacturer and model
2134 name of the PPD file (the NickName attribute in the PPD file). If the
2135 make and model is not specified in the PPD file then the ModelName or
2136 ShortNickName attributes are used instead.
2138 <h4><a name=
"ppd-name">ppd-name (name(
255))
</a></h4>
2140 <p>The ppd-name attribute specifies the PPD filename on the server
2141 relative to the model directory. The forward slash (/) is used to
2142 delineate directories.
2144 <h4><a name=
"ppd-natural-language">ppd-natural-language (
1setOf naturalLanguage)
</a></h4>
2146 <p>The ppd-natural-language attribute specifies the language encoding
2147 of the PPD file (the LanguageVersion attribute in the PPD file). If the
2148 language is unknown or undefined then
"en" (English) is assumed.
2150 <h4><a name=
"ppd-product">ppd-product (
1setOf text(
127))
</a></h4>
2152 <p>The ppd-product attribute specifies the Product attribute values in the PPD file.
2154 <h4><a name=
"ppd-psversion">ppd-psversion (
1setOf text(
127))
</a><span class=
"info">CUPS
1.3</span></h4>
2156 <p>The ppd-product attribute specifies the PSVersion attribute values in the PPD file.
2159 <h3 class='title'
><a name='PRINTER_ATTRIBUTES'
>Printer Attributes
</a></h3>
2161 <h4><a name=
"auth-info-required">auth-info-required (
1setOf type2 keyword)
</a><span class=
"info">CUPS
1.3</span></h4>
2163 <p>The auth-info-required attribute specifies the authentication information that is required for printing a job. The following keywords are recognized:
</p>
2167 <li><tt>domain
</tt> - A domain name is required.
</li>
2169 <li><tt>none
</tt> - No authentication is required - this keyword can only appear by itself.
</li>
2171 <li><tt>password
</tt> - A password is required.
</li>
2173 <li><tt>username
</tt> - A username is required.
</li>
2177 <h4><a name=
"job-k-limit">job-k-limit (integer)
</a><span class='info'
>CUPS
1.1</span></h4>
2179 <p>The job-k-limit attribute specifies the maximum number of kilobytes that
2180 may be printed by a user, including banner files. The default value of
0
2181 specifies that there is no limit.
2183 <h4><a name=
"job-page-limit">job-page-limit (integer)
</a><span class='info'
>CUPS
1.1</span></h4>
2185 <p>The job-page-limit attribute specifies the maximum number of pages that
2186 may be printed by a user, including banner files. The default value of
0
2187 specifies that there is no limit.
2189 <h4><a name=
"job-quota-period">job-quota-period (integer)
</a><span class='info'
>CUPS
1.1</span></h4>
2191 <p>The job-quota-period attribute specifies the time period used for quota
2192 calculations, in seconds. The default value of
0 specifies that the limits
2193 apply to all jobs that have been printed by a user that are still known to
2196 <h4><a name=
"job-sheets-completed">job-sheets-supported (
1setof type3 keyword | name(MAX))
</a><span class='info'
>CUPS
1.1</span></h4>
2198 <p>The job-sheets-supported attribute specifies the available banner files.
2199 There will always be at least one banner file available called
"none".
2201 <h4><a name=
"printer-type">printer-type (type2 enum)
</a></h4>
2203 <p>The printer-type attribute specifies printer type and
2204 capability bits for the printer or class. The default value is
2205 computed from internal state information and the PPD file for the
2206 printer. The following bits are defined:
</p>
2208 <div class='table'
><table align='center' border='
1' width='
80%'
2209 summary='Printer Type Bits'
>
2213 <th>Description
</th>
2219 <td>Is a printer class.
</td>
2223 <td>Is a remote destination.
</td>
2227 <td>Can print in black.
</td>
2231 <td>Can print in color.
</td>
2235 <td>Can print on both sides of the page in hardware.
</td>
2239 <td>Can staple output.
</td>
2243 <td>Can do fast copies in hardware.
</td>
2247 <td>Can do fast copy collation in hardware.
</td>
2251 <td>Can punch output.
</td>
2255 <td>Can cover output.
</td>
2259 <td>Can bind output.
</td>
2263 <td>Can sort output.
</td>
2267 <td>Can handle media up to US-Legal/A4.
</td>
2271 <td>Can handle media from US-Legal/A4 to ISO-C/A2.
</td>
2275 <td>Can handle media larger than ISO-C/A2.
</td>
2279 <td>Can handle user-defined media sizes.
</td>
2283 <td>Is an implicit (server-generated) class.
</td>
2287 <td>Is the a default printer on the network.
</td>
2291 <td>Is a facsimile device.
</td>
2295 <td>Is rejecting jobs.
</td>
2299 <td>Delete this queue.
</td>
2303 <td>Queue is not shared.
</td>
2307 <td>Queue requires authentication.
</td>
2312 <h4>printer-type-mask (type2 enum)
<span class='info'
>CUPS
1.1</span></h4>
2314 <p>The printer-type-mask attribute is used to choose printers or classes with
2315 the CUPS-Get-Printers and CUPS-Get-Classes operations. The bits are defined
2316 identically to the printer-type attribute and default to all
1's.
2318 <h4>requesting-user-name-allowed (
1setof name(
127))
<span class='info'
>CUPS
1.1</span></h4>
2320 <p>The requesting-user-name-allowed attribute lists all of the users that are
2321 allowed to access a printer or class. Either this attribute or the
2322 requesting-user-name-denied attribute will be defined, but not both.
2324 <h4>requesting-user-name-denied (
1setof name(
127))
<span class='info'
>CUPS
1.1</span></h4>
2326 <p>The requesting-user-name-denied attribute lists all of the users that are
2327 not allowed to access a printer or class. Either this attribute or the
2328 requesting-user-name-allowed attribute will be defined, but not both.
2330 <h3 class='title'
><a name='CLASS_ATTRIBUTES'
>Printer Class Attributes
</a></h3>
2332 <h4>member-names (
1setof name(
127))
</h4>
2334 <p>The member-names attribute specifies each of the printer-name attributes of
2335 the member printers and classes. Each name corresponds to the same element of
2336 the member-uris attribute.
2338 <h4>member-uris (
1setof uri)
</h4>
2340 <p>The member-uris attribute specifies each of the printer-uri attributes of
2341 the member printers and classes. Each URI corresponds to the same element of
2342 the member-names attribute.