-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
+<!DOCTYPE HTML>
<html>
<!-- SECTION: Specifications -->
<head>
<title>CUPS Implementation of IPP</title>
<meta name='keywords' content='Programming, Internet Printing Protocol'>
+ <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
</head>
<body>
<!--
- "$Id: spec-ipp.html 177 2006-06-21 00:20:03Z jlovell $"
+ IPP specification for CUPS.
- CUPS IPP specification for the Common UNIX Printing System (CUPS).
+ Copyright © 2007-2023 by Apple Inc.
+ Copyright © 1997-2007 by Easy Software Products.
- Copyright 1997-2006 by Easy Software Products.
+ Licensed under Apache License v2.0. See the file "LICENSE" for more
+ information.
+-->
- These coded instructions, statements, and computer programs are the
- property of Easy Software Products and are protected by Federal
- copyright law. Distribution and use rights are outlined in the file
- "LICENSE.txt" which should have been included with this file. If this
- file is missing or damaged please contact Easy Software Products
- at:
+<H1 CLASS="title">CUPS Implementation of IPP</H1>
- Attn: CUPS Licensing Information
- Easy Software Products
- 44141 Airport View Drive, Suite 204
- Hollywood, Maryland 20636 USA
+<h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2>
- Voice: (301) 373-9600
- EMail: cups-info@cups.org
- WWW: http://www.cups.org
--->
+<p>CUPS implements <a href="http://ftp.pwg.org/pub/pwg/standards/std-ipp20-20151030-5100.12.pdf">IPP/2.1</a> and the operations and attributes defined in the following specifications:</p>
-<h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2>
+<ul>
+
+ <li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext10-20101030-5100.11.pdf">PWG 5100.11: IPP Job and Printer Extensions - Set 2 (JPS2)</a> (all operations plus the "job-creation-attributes-supported", "job-ids", "job-password", "job-password-encryption", "media-col-database", and "which-jobs" attributes)</li>
+
+ <li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext3v10-20120727-5100.13.pdf">PWG 5100.13: IPP Job and Printer Extensions - Set 3 (JPS3)</a> (all operations/attributes required for IPP Everywhere except "printer-geo-location" and "printer-icc-profiles")</li>
+
+ <li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ippeve10-20130128-5100.14.pdf">PWG 5100.14: IPP Everywhere</a> (conforming to the Client and most of the Printer requirements)</li>
-<p>CUPS 1.1 implements IPP/1.1 and the operations and attributes
-defined in the "IPP: Job and Printer Set Operations", "IPP/1.1:
-Output-bin Attribute Extension", and "IPP/1.1: finishings
-'fold',' trim', and 'bale' attribute values extension"
-specifications.</p>
+ <li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ippfaxout10-20140618-5100.15.pdf">PWG 5100.15: IPP FaxOut Service</a> (for facsimile queues)</li>
-<p>CUPS also provides 13 new operations and many new attributes
-to support multiple IPP printers and printer classes on a single
-host.</p>
+ <li><a href="http://ftp.pwg.org/pub/pwg/candidates/cs-ipptrans10-20131108-5100.16.pdf">PWG 5100.16: IPP Transaction-Based Printing Extensions</a></li>
+
+ <li><a href="http://tools.ietf.org/html/rfc3995">RFC 3995: IPP: Event Notifications and Subscriptions</a></li>
+
+ <li><a href="http://tools.ietf.org/html/rfc3996">RFC 3996: IPP: The 'ippget' Delivery Method for Event Notifications</li>
+
+ <li><a href="http://tools.ietf.org/html/rfc3998">RFC 3998: IPP: Job and Printer Administrative Operations</a> (Disable-Printer, Enable-Printer, Hold-New-Jobs, and Release-Held-New-Jobs operations)</li>
+
+ <li><a href="http://tools.ietf.org/html/rfc7472">RFC 7472: IPP over HTTPS Transport Binding and 'ipps' URI Scheme</a></li>
+
+</ul>
+
+<p>CUPS also provides 17 new operations and many new attributes to support multiple IPP printers and printer classes on a single host.</p>
<h3 class='title'><a name='IPP_URIS'>IPP URIs</a></h3>
-<p>CUPS supports the "http", "https", and "ipp" schemes. The
-following resource names are used:</p>
+<p>CUPS supports the "http", "https", "ipp", and "ipps" schemes. The following resource names are used:</p>
<dl>
<dt><tt>scheme://hostname:port/</tt></dt>
- <dd>Can be used for all "get" operations and for server
- subscriptions.</dd>
+ <dd>Can be used for all "get" operations and for server subscriptions.</dd>
<dt><tt>scheme://hostname:port/admin/</tt></dt>
</dl>
-<p>So a typical printer URI would be
-"ipp://foo.bar.com/printers/LaserJet". In addition, the CUPS
-server also supports normal browser access via
-"http://hostname:port/" and "https://hostname:port/".</p>
+<p>So a typical printer URI would be "ipp://foo.example.com/printers/LaserJet". In addition, the CUPS scheduler also supports (when enabled) normal browser access via "http://foo.example.com:port/" and "https://foo.example.com:port/".</p>
<h3 class='title'><a name='IPP_OPERATIONS'>CUPS IPP Operations</a></h3>
-<p>CUPS provides 14 extension operations in addition to most of the
-standard IPP and registered extension operations:
+<p>CUPS provides 17 vendor extension operations in addition to most of the standard IPP and registered extension operations:</p>
<div class='table'><table align='center' border='1' width='80%'
summary='Supported Operations'>
</thead>
<tbody>
<tr>
- <td><a href='#PRINT_JOB'>Print-Job</a></td>
+ <td>Print-Job</td>
<td>1.0</td>
<td>0x0002</td>
<td>Print a file.</td>
<td>Validate job attributes.</td>
</tr>
<tr>
- <td><a href='#CREATE_JOB'>Create-Job</a></td>
+ <td>Create-Job</td>
<td>1.1</td>
<td>0x0005</td>
<td>Create a print job.</td>
<td>Send a file for a print job.</td>
</tr>
<tr>
- <td>Cancel-Job</td>
+ <td><a href='#CANCEL_JOB'>Cancel-Job</a></td>
<td>1.0</td>
<td>0x0008</td>
<td>Cancel a print job.</td>
<td>Resume printing on a printer.</td>
</tr>
<tr>
- <td>Purge-Jobs</td>
+ <td><a href='#PURGE_JOBS'>Purge-Jobs</a></td>
<td>1.0</td>
<td>0x0012</td>
<td>Purge all jobs.</td>
</tr>
<tr>
- <td><a href='#SET_JOB_ATTRIBUTES'>Set-Job-Attributes</a></td>
+ <td>Set-Printer-Attributes</td>
+ <td>1.4</td>
+ <td>0x0013</td>
+ <td>Set attributes for a printer.</td>
+</tr>
+<tr>
+ <td>Set-Job-Attributes</td>
<td>1.1</td>
<td>0x0014</td>
<td>Set attributes for a pending or held job.</td>
<td>0x0023</td>
<td>Rejects jobs on a printer.</td>
</tr>
+<tr>
+ <td>Hold-New-Jobs</td>
+ <td>1.4</td>
+ <td>0x0025</td>
+ <td>Hold new jobs by default.</td>
+</tr>
+<tr>
+ <td>Release-Held-New-Jobs</td>
+ <td>1.4</td>
+ <td>0x0026</td>
+ <td>Releases all jobs that were previously held.</td>
+</tr>
+<tr>
+ <td>Cancel-Jobs</td>
+ <td>1.5</td>
+ <td>0x0038</td>
+ <td>Cancel all jobs (administrator).</td>
+</tr>
+<tr>
+ <td>Cancel-My-Jobs</td>
+ <td>1.5</td>
+ <td>0x0039</td>
+ <td>Cancel all jobs (user).</td>
+</tr>
+<tr>
+ <td>Close-Job</td>
+ <td>1.5</td>
+ <td>0x003b</td>
+ <td>Close a created job.</td>
+</tr>
<tr>
<td><a href='#CUPS_GET_DEFAULT'>CUPS-Get-Default</a></td>
<td>1.0</td>
<td>Delete a printer class.</td>
</tr>
<tr>
- <td><a href='#CUPS_ACCEPT_JOBS'>CUPS-Accept-Jobs</a></td>
+ <td>CUPS-Accept-Jobs</td>
<td>1.0</td>
<td>0x4008</td>
- <td>Accept jobs on a printer or printer class.</td>
+ <td>Accept jobs on a printer or printer class. This operation is deprecated - use the Enable-Printer operation instead.</td>
</tr>
<tr>
- <td><a href='#CUPS_REJECT_JOBS'>CUPS-Reject-Jobs</a></td>
+ <td>CUPS-Reject-Jobs</td>
<td>1.0</td>
<td>0x4009</td>
- <td>Reject jobs on a printer or printer class.</td>
+ <td>Reject jobs on a printer or printer class. This operation is deprecated - use the Disable-Printer operation instead.</td>
</tr>
<tr>
<td><a href='#CUPS_SET_DEFAULT'>CUPS-Set-Default</a></td>
<td>0x400E</td>
<td>Authenticate a job for printing.</td>
</tr>
+<tr>
+ <td><a href='#CUPS_GET_PPD'>CUPS-Get-PPD</a></td>
+ <td>1.3</td>
+ <td>0x400F</td>
+ <td>Get a PPD file.</td>
+</tr>
+<tr>
+ <td><a href='#CUPS_GET_DOCUMENT'>CUPS-Get-Document</a></td>
+ <td>1.4</td>
+ <td>0x4027</td>
+ <td>Get a document file from a job.</td>
+</tr>
+<tr>
+ <td><a href='#CUPS_CREATE_LOCAL_PRINTER'>CUPS-Create-Local-Printer</a></td>
+ <td>2.2</td>
+ <td>0x4028</td>
+ <td>Creates a local (temporary) print queue pointing to a remote IPP Everywhere printer.</td>
+</tr>
</tbody>
</table></div>
<h2 class='title'><a name='OPERATIONS'>Operations</a></h2>
-<p>The following sections describe the operations supported by CUPS.
-In the interest of brevity, operations which use only the standard
-IPP attributes are not described.
-
-<h3 class='title'><a name='PRINT_JOB'>Print-Job Operation</a></h3>
+<p>The following sections describe the operations supported by CUPS. In the interest of brevity, operations which use only the standard IPP attributes are not described.
-<p>The Print-Job operation (0x0002) prints a file.
-<h4>Print-Job Request</h4>
+<h3 class='title'><a name='CANCEL_JOB'>Cancel Job Operation (Extension)</a></h3>
-<p>The following groups of attributes are supplied as part of the
-Print-Job request:
+<p>The Cancel-Job operation (0x0008) cancels the specified job. CUPS 1.4 added support for the <tt>purge-job (boolean)</tt> operation attribute that (if 'true') removes all history and document files for the job as well.</p>
-<p>Group 1: Operation Attributes
-<dl>
+<h3 class='title'><a name='PURGE_JOBS'>Purge-Jobs Operation</a></h3>
- <dt>Natural Language and Character Set:
+<p>The Purge-Jobs operation (0x0012) cancels all of the jobs on a given destination and optionally removes all history and document files for the jobs as well. CUPS 1.2 added support for the <tt>purge-job (boolean)</tt> operation attribute that (if 'false') retains all history and document files for the canceled jobs.</p>
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+<blockquote><b>Note:</b>
+ <p>The Cancel-Jobs and Cancel-My-Jobs operations should be used instead of Purge-Jobs.</p>
+</blockquote>
- <dt>"printer-uri" (uri):
- <dd>The client MUST supply a URI for the specified printer.
-</dl>
+<h3 class='title'><span class='info'>CUPS 1.2/macOS 10.5</span><a
+name='CREATE_PRINTER_SUBSCRIPTION'>Create-Printer-Subscription</a></h3>
-<p>Group 2: Job Template Attributes
+<p>The Create-Printer-Subscription operation (0x0016) creates a subscription for printer or server event notifications. CUPS provides several additional events in addition to the standard events in the IPP notifications specification. CUPS adds the following <tt>notify-events (1setOf type2 keyword)</tt> values:<p>
-<dl>
+<ul>
- <dt>"job-billing" (text(MAX)):<span class='info'>CUPS 1.1</span>
+ <li><tt>printer-added</tt> - Get notified whenever a printer or class is added</li>
- <dd>The client OPTIONALLY supplies a billing string that is logged
- with the page accounting information.
+ <li><tt>printer-deleted</tt> - Get notified whenever a printer or class is deleted</li>
- <dt>"job-sheets" (1setof type3 keyword | name(MAX)):<span class='info'>CUPS 1.1</span>
+ <li><tt>printer-modified</tt> - Get notified whenever a printer or class is modified</li>
- <dd>The client OPTIONALLY supplies one or two banner pages that
- are printed before and after any files in the print job. The
- name of "none" is reserved to indicate that no banner page
- should be printed. If the client does not specify this
- attribute then the value of the "job-sheets-default" printer
- object attribute is used.
+ <li><tt>server-audit</tt> - Get notified when a security condition occurs</li>
- <blockquote><b>Note:</b> Standard IPP only allows
- specification of a single job-sheets attribute
- value.</blockquote>
+ <li><tt>server-restarted</tt> - Get notified when the server is restarted</li>
- <dt>"media" (1setof type3 keyword | name(MAX)):
+ <li><tt>server-started</tt> - Get notified when the server is started</li>
- <dd>The client OPTIONALLY supplies one or more media attributes
- specifying the size, type, source, and color of the output
- media. If the client does not specify this attribute then the
- value of the "media-default" printer object attribute is used.
+ <li><tt>server-stopped</tt> - Get notified when the server is stopped</li>
- <blockquote><b>Note:</b> Standard IPP only allows
- specification of a single media attribute
- value.</blockquote>
+</ul>
- <dt>Other Job Template Attributes
-</dl>
+<h3 class='title'><a name='CUPS_GET_DEFAULT'>CUPS-Get-Default Operation</a></h3>
-<p>The Print-Job request is followed by a file to be printed.
+<p>The CUPS-Get-Default operation (0x4001) returns the default printer URI and attributes.
-<h4>Print-Job Response</h4>
+<h4>CUPS-Get-Default Request</h4>
-<p>The following groups of attributes are send as part of the Print-Job
-Response:
+<p>The following groups of attributes are supplied as part of the CUPS-Get-Default request:
<p>Group 1: Operation Attributes
<dl>
- <dt>Status Message:
-
- <dd>The standard response status message.
-
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
-
-</dl>
-
-<p>Group 2: Job Attributes
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
-<dl>
+ <dt>"requested-attributes" (1setOf keyword):
- <dt>Standard Job Attributes
+ <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'.
</dl>
-<h3 class='title'><span class='info'>CUPS 1.1</span><a name='CREATE_JOB'>Create-Job Operation</a></h3>
-
-<p>The Create-Job operation (0x0005) creates a new, empty print job.
-
-<h4>Create-Job Request</h4>
+<h4>CUPS-Get-Default Response</h4>
-<p>The following groups of attributes are supplied as part of the
-Create-Job request:
+<p>The following groups of attributes are send as part of the CUPS-Get-Default Response:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
- <dt>"printer-uri" (uri):
+ <dt>Status Message:
- <dd>The client MUST supply a URI for the specified printer.
+ <dd>The standard response status message.
</dl>
-<p>Group 2: Job Template Attributes
+<p>Group 2: Printer Object Attributes
<dl>
- <dt>"job-billing" (text(MAX)):<span class='info'>CUPS 1.1</span>
+ <dt>The set of requested attributes and their current values.
- <dd>The client OPTIONALLY supplies a billing string that is logged
- with the page accounting information.
+</dl>
- <dt>"job-sheets" (1setof type3 keyword | name(MAX)):<span class='info'>CUPS 1.1</span>
+<h3 class='title'><a name='CUPS_GET_PRINTERS'>CUPS-Get-Printers Operation</a></h3>
- <dd>The client OPTIONALLY supplies one or two banner pages that
- are printed before and after any files in the print job. The
- name of "none" is reserved to indicate that no banner page
- should be printed. If the client does not specify this
- attribute then the value of the "job-sheets-default" printer
- object attribute is used.
+<p>The CUPS-Get-Printers operation (0x4002) returns the printer attributes for every printer known to the system. This may include printers that are not served directly by the server.
- <blockquote><b>Note:</b> Standard IPP only allows
- specification of a single job-sheets attribute
- value.</blockquote>
+<h4>CUPS-Get-Printers Request</h4>
- <dt>"media" (1setof type3 keyword | name(MAX)):
+<p>The following groups of attributes are supplied as part of the CUPS-Get-Printers request:
- <dd>The client OPTIONALLY supplies one or more media attributes
- specifying the size, type, source, and color of the output
- media. If the client does not specify this attribute then the
- value of the "media-default" printer object attribute is used.
+<p>Group 1: Operation Attributes
- <blockquote><b>Note:</b> Standard IPP only allows
- specification of a single media attribute
- value.</blockquote>
+<dl>
- <dt>Standard Job Template Attributes
+ <dt>Natural Language and Character Set:
-</dl>
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
-<h4>Create-Job Response</h4>
+ <dt>"first-printer-name" (name(127)): <span class='info'>CUPS 1.2/macOS 10.5</span>
-<p>The following groups of attributes are send as part of the
-Create-Job Response:
+ <dd>The client OPTIONALLY supplies this attribute to select the first printer that is returned.
-<p>Group 1: Operation Attributes
+ <dt>"limit" (integer (1:MAX)):
-<dl>
+ <dd>The client OPTIONALLY supplies this attribute limiting the number of printers that are returned.
- <dt>Status Message:
+ <dt>"printer-id" (integer(0:65535)): <span class='info'>CUPS 2.2</span>
- <dd>The standard response status message.
+ <dd>The client OPTIONALLY supplies this attribute to select which printer is returned.
- <dt>Natural Language and Character Set:
+ <dt>"printer-location" (text(127)): <span class='info'>CUPS 1.1.7</span>
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dd>The client OPTIONALLY supplies this attribute to select which printers are returned.
-</dl>
+ <dt>"printer-type" (type2 enum): <span class='info'>CUPS 1.1.7</span>
-<p>Group 2: Job Attributes
+ <dd>The client OPTIONALLY supplies a printer type enumeration to select which printers are returned.
-<dl>
+ <dt>"printer-type-mask" (type2 enum): <span class='info'>CUPS 1.1.7</span>
- <dt>Standard Job Attributes
+ <dd>The client OPTIONALLY supplies a printer type mask enumeration to select which bits are used in the "printer-type" attribute.
-</dl>
+ <dt>"requested-attributes" (1setOf keyword):
-<h3 class='title'><span class='info'>CUPS 1.1</span><a name='SET_JOB_ATTRIBUTES'>Set-Job-Attributes Operation</a></h3>
+ <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'.
-<p>The Set-Job-Attributes operation (0x0014) changes the attributes of
-an active (not completed) job.
+ <dt>"requested-user-name" (name(127)): <span class='info'>CUPS 1.2/macOS 10.5</span>
-<h4>Set-Job-Attributes Request</h4>
+ <dd>The client OPTIONALLY supplies a user name that is used to filter the returned printers.
-<p>The following groups of attributes are supplied as part of the
-Set-Job-Attributes request:
+</dl>
+
+<h4>CUPS-Get-Printers Response</h4>
+
+<p>The following groups of attributes are send as part of the CUPS-Get-Printers Response:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
- <dt>"printer-uri" (uri) and "job-id" (integer)
- <br><i>OR</i>
- <br>"job-uri":
+ <dt>Status Message:
- <dd>The client MUST supply a URI for the specified printer and
- a job ID number, or the job URI.
+ <dd>The standard response status message.
</dl>
-<p>Group 2: Job Template Attributes
+<p>Group 2: Printer Object Attributes
<dl>
- <dt>"job-sheets" (1setof type3 keyword | name(MAX)):<span class='info'>CUPS 1.1</span>
-
- <dd>The client OPTIONALLY supplies one or two banner pages that
- are printed before and after any files in the print job. The
- name of "none" is reserved to indicate that no banner page
- should be printed. If the client does not specify this
- attribute then the value of the "job-sheets-default" printer
- object attribute is used.
-
- <blockquote><b>Note:</b> Standard IPP only allows
- specification of a single job-sheets attribute
- value.</blockquote>
+ <dt>The set of requested attributes and their current values for each printer.
- <dt>"media" (1setof type3 keyword | name(MAX)):
-
- <dd>The client OPTIONALLY supplies one or more media attributes
- specifying the size, type, source, and color of the output
- media. If the client does not specify this attribute then the
- value of the "media-default" printer object attribute is used.
+</dl>
- <blockquote><b>Note:</b> Standard IPP only allows
- specification of a single media attribute
- value.</blockquote>
- <dt>Other Job Template Attributes
+<h3 class='title'><a name='CUPS_ADD_MODIFY_PRINTER'>CUPS-Add-Modify-Printer Operation</a></h3>
-</dl>
+<p>The CUPS-Add-Modify-Printer operation (0x4003) adds a new printer or modifies an existing printer on the system.
-<h4>Set-Job-Attributes Response</h4>
+<h4>CUPS-Add-Modify-Printer Request</h4>
-<p>The following groups of attributes are send as part of the Set-Job-Attributes
-Response:
+<p>The following groups of attributes are supplied as part of the CUPS-Add-Modify-Printer request:
<p>Group 1: Operation Attributes
<dl>
- <dt>Status Message:
+ <dt>Natural Language and Character Set:
- <dd>The standard response status message.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
- <dt>Natural Language and Character Set:
+ <dt>"printer-uri" (uri):
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dd>The client MUST supply a URI for the specified printer.
</dl>
-<h3 class='title'><span class='info'>CUPS 1.2</span><a
-name='CREATE_PRINTER_SUBSCRIPTION'>Create-Printer-Subscription</a></h3>
+<p>Group 2: Printer Object Attributes
-<p>The Create-Printer-Subscription operation (0x0016) creates a
-subscription for printer or server event notifications. CUPS
-provides several additional events in addition to the standard
-events in the IPP notifications specification.</p>
+<dl>
-<h4> Request</h4>
+ <dt>"auth-info-required" (1setOf type2 keyword): <span class='info'>CUPS 1.3/macOS 10.5</span>
-<p>The following groups of attributes are supplied as part of the
-request:</p>
+ <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
-<p>Group 1: Operation Attributes</p>
+ <dt>"job-sheets-default" (1setOf name(127)): <span class='info'>CUPS 1.1.7</span>
-<dl>
+ <dd>The client OPTIONALLY supplies one or two banner page names that are printed before and after files in a job. The reserved name "none" is used to specify that no banner page should be printed.
- <dt>Natural Language and Character Set:
+ <dt>"device-uri" (uri):
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The client OPTIONALLY supplies a device URI for the specified printer.
- <dt>"printer-uri" (uri):
+ <dt>"port-monitor" (name(127)):
- <dd>The printer
- (<tt>ipp://server/printers/printername</tt>), class
- (<tt>ipp://server/classes/classname</tt>), or server
- (<tt>ipp://server/</tt>) URI for event notifications.
+ <dd>The client OPTIONALLY supplies a port monitor name for the specified printer.
- <dt>"notify-events" (1setOf keyword):
+ <dt>"ppd-name" (name(255)):
- <dd>The events to monitor. In addition to the standard
- events, CUPS adds the following keywords:
- <ul>
+ <dd>The client OPTIONALLY supplies a PPD name for the specified printer.
- <li><tt>printer-added</tt> - Get notified
- whenever a printer or class is added</li>
+ <dt>"printer-is-accepting-jobs" (boolean):
- <li><tt>printer-deleted</tt> - Get notified
- whenever a printer or class is deleted</li>
+ <dd>The client OPTIONALLY supplies this boolean attribute indicating whether the printer object should accept new jobs.
- <li><tt>printer-modified</tt> - Get notified
- whenever a printer or class is modified</li>
+ <dt>"printer-info" (text(127)):
- <li><tt>server-audit</tt> - Get notified when a
- security condition occurs</li>
+ <dd>The client OPTIONALLY supplies this attribute indicating the printer information string.
- <li><tt>server-restarted</tt> - Get notified when
- the server is restarted</li>
+ <dt>"printer-location" (text(127)):
- <li><tt>server-started</tt> - Get notified when
- the server is started</li>
+ <dd>The client OPTIONALLY supplies this attribute indicating a textual location of the printer.
- <li><tt>server-stopped</tt> - Get notified when
- the server is stopped</li>
+ <dt>"printer-more-info" (uri):
- </ul>
+ <dd>The client OPTIONALLY supplies this attribute indicating a URI for additional printer information.
-</dl>
+ <dt>"printer-state" (type2 enum):
-<h4> Response</h4>
+ <dd>The client OPTIONALLY supplies this attribute indicating the initial/current state of the printer. Only the 'idle(3)' and 'stopped(5)' enumerations are recognized.
-<p>The following groups of attributes are send as part of the
-response:</p>
+ <dt>"printer-state-message" (text(MAX)):
-<p>Group 1: Operation Attributes</p>
+ <dd>The client OPTIONALLY supplies this attribute indicating a textual reason for the current printer state.
-<dl>
+ <dt>"requesting-user-name-allowed" (1setof name(127) | delete)
+ <br><i>OR</i>
+ <br>"requesting-user-name-denied" (1setof name(127) | delete):
- <dt>Status Message:
+ <dd>The client OPTIONALLY supplies one of these attributes to specify an access control list for incoming print jobs. To allow all users access to a printer, use the delete tag for the attribute value.
- <dd>The standard response status message.
+</dl>
- <dt>Natural Language and Character Set:
+<p>The CUPS-Add-Modify-Printer request can optionally be followed by a PPD file to be used for the printer. The "ppd-name" attribute overrides any file that is attached to the end of the request with a local CUPS PPD file.
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+<h4>CUPS-Add-Modify-Printer Response</h4>
-</dl>
+<p>The following groups of attributes are send as part of the
+CUPS-Add-Modify-Printer Response:
-<p>Group 2: Subscription Object Attributes</p>
+<p>Group 1: Operation Attributes
<dl>
- <dt>"subscription-id" (integer):
+ <dt>Natural Language and Character Set:
+
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
+
+ <dt>Status Message:
- <dd>The subscription number.
+ <dd>The standard response status message.
</dl>
-<h3 class='title'><a name='CUPS_GET_DEFAULT'>CUPS-Get-Default Operation</a></h3>
-<p>The CUPS-Get-Default operation (0x4001) returns the default printer
-URI and attributes.
+<h3 class='title'><a name='CUPS_DELETE_PRINTER'>CUPS-Delete-Printer Operation</a></h3>
+
+<p>The CUPS-Delete-Printer operation (0x4004) removes an existing printer from the system.
-<h4>CUPS-Get-Default Request</h4>
+<h4>CUPS-Delete-Printer Request</h4>
-<p>The following groups of attributes are supplied as part of the
-CUPS-Get-Default request:
+<p>The following groups of attributes are supplied as part of the CUPS-Delete-Printer request:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
- <dt>"requested-attributes" (1setOf keyword) :
+ <dt>"printer-uri" (uri):
- <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'.
+ <dd>The client MUST supply a URI for the specified printer.
</dl>
-<h4>CUPS-Get-Default Response</h4>
+<h4>CUPS-Delete-Printer Response</h4>
-<p>The following groups of attributes are send as part of the
-CUPS-Get-Default Response:
+<p>The following groups of attributes are send as part of the CUPS-Delete-Printer Response:
<p>Group 1: Operation Attributes
<dl>
- <dt>Status Message:
-
- <dd>The standard response status message.
-
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
-
-</dl>
-
-<p>Group 2: Printer Object Attributes
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
-<dl>
+ <dt>Status Message:
- <dt>The set of requested attributes and their current values.
+ <dd>The standard response status message.
</dl>
-<h3 class='title'><a name='CUPS_GET_PRINTERS'>CUPS-Get-Printers Operation</a></h3>
-<p>The CUPS-Get-Printers operation (0x4002) returns the printer
-attributes for every printer known to the system. This may include
-printers that are not served directly by the server.
+<h3 class='title'><a name='CUPS_GET_CLASSES'>CUPS-Get-Classes Operation</a></h3>
+
+<p>The CUPS-Get-Classes operation (0x4005) returns the printer attributes for every printer class known to the system. This may include printer classes that are not served directly by the server.
-<h4>CUPS-Get-Printers Request</h4>
+<h4>CUPS-Get-Classes Request</h4>
-<p>The following groups of attributes are supplied as part of the
-CUPS-Get-Printers request:
+<p>The following groups of attributes are supplied as part of the CUPS-Get-Classes request:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
- <dt>"limit" (integer (1:MAX)):
+ <dt>"first-printer-name" (name(127)): <span class='info'>CUPS 1.2/macOS 10.5</span>
- <dd>The client OPTIONALLY supplies this attribute limiting the
- number of printers that are returned.
+ <dd>The client OPTIONALLY supplies this attribute to select the first printer that is returned.
- <dt>"printer-info" (text(127)):<span class='info'>CUPS 1.1</span>
+ <dt>"limit" (integer (1:MAX)):
- <dd>The client OPTIONALLY supplies this attribute to
- select which printers are returned.
+ <dd>The client OPTIONALLY supplies this attribute limiting the number of printer classes that are returned.
<dt>"printer-location" (text(127)): <span class='info'>CUPS 1.1.7</span>
- <dd>The client OPTIONALLY supplies this attribute to
- select which printers are returned.
+ <dd>The client OPTIONALLY supplies this attribute to select which printer classes are returned.
<dt>"printer-type" (type2 enum): <span class='info'>CUPS 1.1.7</span>
- <dd>The client OPTIONALLY supplies a printer type enumeration to
- select which printers are returned.
+ <dd>The client OPTIONALLY supplies a printer type enumeration to select which printer classes are returned.
<dt>"printer-type-mask" (type2 enum): <span class='info'>CUPS 1.1.7</span>
- <dd>The client OPTIONALLY supplies a printer type mask
- enumeration to select which bits are used in the "printer-type"
- attribute.
+ <dd>The client OPTIONALLY supplies a printer type mask enumeration to select which bits are used in the "printer-type" attribute.
+
+ <dt>"requested-attributes" (1setOf keyword):
- <dt>"requested-attributes" (1setOf keyword) :
+ <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'.
- <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'.
+ <dt>"requested-user-name" (name(127)): <span class='info'>CUPS 1.2/macOS 10.5</span>
+
+ <dd>The client OPTIONALLY supplies a user name that is used to filter the returned printers.
</dl>
-<h4>CUPS-Get-Printers Response</h4>
+<h4>CUPS-Get-Classes Response</h4>
-<p>The following groups of attributes are send as part of the
-CUPS-Get-Printers Response:
+<p>The following groups of attributes are send as part of the CUPS-Get-Classes Response:
<p>Group 1: Operation Attributes
<dl>
- <dt>Status Message:
+ <dt>Natural Language and Character Set:
- <dd>The standard response status message.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
- <dt>Natural Language and Character Set:
+ <dt>Status Message:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dd>The standard response status message.
</dl>
-<p>Group 2: Printer Object Attributes
+<p>Group 2: Printer Class Object Attributes
<dl>
- <dt>The set of requested attributes and their current values for
- each printer.
+ <dt>The set of requested attributes and their current values for each printer class.
</dl>
-<h3 class='title'><a name='CUPS_ADD_MODIFY_PRINTER'>CUPS-Add-Modify-Printer Operation</a></h3>
+<h3 class='title'><a name='CUPS_ADD_MODIFY_CLASS'>CUPS-Add-Modify-Class Operation</a></h3>
-<p>The CUPS-Add-Modify-Printer operation (0x4003) adds a new printer or
-modifies an existing printer on the system.
+<p>The CUPS-Add-Modify-Class operation (0x4006) adds a new printer class or modifies and existing printer class on the system.
-<h4>CUPS-Add-Modify-Printer Request</h4>
+<h4>CUPS-Add-Modify-Class Request</h4>
-<p>The following groups of attributes are supplied as part of the
-CUPS-Add-Modify-Printer request:
+<p>The following groups of attributes are supplied as part of the CUPS-Add-Modify-Class request:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
<dt>"printer-uri" (uri):
- <dd>The client MUST supply a URI for the specified printer.
+ <dd>The client MUST supply a URI for the specified printer class.
</dl>
<dl>
- <dt>"job-sheets-default" (1setOf name(127)): <span
- class='info'>CUPS 1.1.7</span>
-
- <dd>The client OPTIONALLY supplies one or two banner page
- names that are printed before and after files in a job.
- The reserved name "none" is used to specify that no
- banner page should be printed.
-
- <dt>"device-uri" (uri):
+ <dt>"auth-info-required" (1setOf type2 keyword): <span class='info'>CUPS 1.3/macOS 10.5</span>
- <dd>The client OPTIONALLY supplies a device URI for the
- specified printer.
+ <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
- <dt>"ppd-name" (name(127)):
+ <dt>"member-uris" (1setof uri):
- <dd>The client OPTIONALLY supplies a PPD name for the specified
- printer.
+ <dd>The client OPTIONALLY supplies the "member-uris" set specifying the printers and printer classes that are part of the class.
<dt>"printer-is-accepting-jobs" (boolean):
- <dd>The client OPTIONALLY supplies this boolean attribute
- indicating whether or not the printer object should accept new jobs.
+ <dd>The client OPTIONALLY supplies this boolean attribute indicating whether the class object should accept new jobs.
<dt>"printer-info" (text(127)):
- <dd>The client OPTIONALLY supplies this attribute indicating the
- printer information string.
+ <dd>The client OPTIONALLY supplies this attribute indicating the printer information string.
<dt>"printer-location" (text(127)):
- <dd>The client OPTIONALLY supplies this attribute indicating a
- textual location of the printer.
+ <dd>The client OPTIONALLY supplies this attribute indicating a textual location of the class.
<dt>"printer-more-info" (uri):
- <dd>The client OPTIONALLY supplies this attribute indicating a
- URI for additional printer information.
+ <dd>The client OPTIONALLY supplies this attribute indicating a URI for additional class information.
<dt>"printer-state" (type2 enum):
- <dd>The client OPTIONALLY supplies this attribute indicating the
- initial/current state of the printer. Only the "idle" and "stopped"
- enumerations are recognized.
+ <dd>The client OPTIONALLY supplies this attribute indicating the initial/current state of the class. Only the 'idle(3)' and 'stopped(5)' enumerations are recognized.
<dt>"printer-state-message" (text(MAX)):
- <dd>The client OPTIONALLY supplies this attribute indicating a
- textual reason for the current printer state.
+ <dd>The client OPTIONALLY supplies this attribute indicating a textual reason for the current class state.
- <dt>"requesting-user-name-allowed" (1setof name(127) | delete)
+ <dt>"requesting-user-name-allowed" (1setof name(127))
<br><i>OR</i>
- <br>"requesting-user-name-denied" (1setof name(127) | delete):
+ <br>"requesting-user-name-denied" (1setof name(127)):
- <dd>The client OPTIONALLY supplies one of these attributes to
- specify an access control list for incoming print jobs. To allow
- all users access to a printer, use the delete tag for the
- attribute value.
+ <dd>The client OPTIONALLY supplies one of these attributes to specify an access control list for incoming print jobs. To allow all users access to a class, use the delete tag for the attribute value.
</dl>
-<p>The CUPS-Add-Modify-Printer request can optionally be followed by a PPD
-file or System V interface script to be used for the printer. The
-"ppd-name" attribute overrides any file that is attached to the end of
-the request with a local CUPS PPD file.
-
-<h4>CUPS-Add-Modify-Printer Response</h4>
+<h4>CUPS-Add-Modify-Class Response</h4>
-<p>The following groups of attributes are send as part of the
-CUPS-Add-Modify-Printer Response:
+<p>The following groups of attributes are send as part of the CUPS-Add-Modify-Class Response:
<p>Group 1: Operation Attributes
<dl>
- <dt>Status Message:
+ <dt>Natural Language and Character Set:
- <dd>The standard response status message.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
- <dt>Natural Language and Character Set:
+ <dt>Status Message:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dd>The standard response status message.
</dl>
-<h3 class='title'><a name='CUPS_DELETE_PRINTER'>CUPS-Delete-Printer Operation</a></h3>
-<p>The CUPS-Delete-Printer operation (0x4004) removes an existing
-printer from the system.
+<h3 class='title'><a name='CUPS_DELETE_CLASS'>CUPS-Delete-Class Operation</a></h3>
-<h4>CUPS-Delete-Printer Request</h4>
+<p>The CUPS-Delete-Class operation (0x4007) removes an existing printer class from the system.
-<p>The following groups of attributes are supplied as part of the
-CUPS-Delete-Printer request:
+<h4>CUPS-Delete-Class Request</h4>
+
+<p>The following groups of attributes are supplied as part of the CUPS-Delete-Class request:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
<dt>"printer-uri" (uri):
- <dd>The client MUST supply a URI for the specified printer.
+ <dd>The client MUST supply a URI for the specified printer class.
</dl>
-<h4>CUPS-Delete-Printer Response</h4>
+<h4>CUPS-Delete-Class Response</h4>
-<p>The following groups of attributes are send as part of the
-CUPS-Delete-Printer Response:
+<p>The following groups of attributes are send as part of the CUPS-Delete-Class Response:
<p>Group 1: Operation Attributes
<dl>
- <dt>Status Message:
+ <dt>Natural Language and Character Set:
- <dd>The standard response status message.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
- <dt>Natural Language and Character Set:
+ <dt>Status Message:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dd>The standard response status message.
</dl>
-<h3 class='title'><a name='CUPS_GET_CLASSES'>CUPS-Get-Classes Operation</a></h3>
-<p>The CUPS-Get-Classes operation (0x4005) returns the printer
-attributes for every printer class known to the system. This may
-include printer classes that are not served directly by the server.
+<h3 class='title'><a name='CUPS_SET_DEFAULT'>CUPS-Set-Default Operation</a></h3>
-<h4>CUPS-Get-Classes Request</h4>
+<p>The CUPS-Set-Default operation (0x400A) sets the default printer destination for all clients when a resource name of "/printers" is specified.
-<p>The following groups of attributes are supplied as part of the
-CUPS-Get-Classes request:
+<h4>CUPS-Set-Default Request</h4>
+
+<p>The following groups of attributes are supplied as part of the CUPS-Set-Default request:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
-
- <dt>"limit" (integer (1:MAX)):
-
- <dd>The client OPTIONALLY supplies this attribute limiting the
- number of printer classes that are returned.
-
- <dt>"printer-info" (text(127)): <span class='info'>CUPS 1.1.7</span>
- <dd>The client OPTIONALLY supplies this attribute to
- select which printer classes are returned.
-
- <dt>"printer-location" (text(127)): <span class='info'>CUPS 1.1.7</span>
- <dd>The client OPTIONALLY supplies this attribute to
- select which printer classes are returned.
-
- <dt>"printer-type" (type2 enum): <span class='info'>CUPS 1.1.7</span>
- <dd>The client OPTIONALLY supplies a printer type enumeration to
- select which printer classes are returned.
-
- <dt>"printer-type-mask" (type2 enum): <span class='info'>CUPS 1.1.7</span>
- <dd>The client OPTIONALLY supplies a printer type mask
- enumeration to select which bits are used in the "printer-type"
- attribute.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
- <dt>"requested-attributes" (1setOf keyword) :
+ <dt>"printer-uri" (uri):
- <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'.
+ <dd>The client MUST supply a URI for the specified printer or printer class.
</dl>
-<h4>CUPS-Get-Classes Response</h4>
+<h4>CUPS-Set-Default Response</h4>
-<p>The following groups of attributes are send as part of the
-CUPS-Get-Classes Response:
+<p>The following groups of attributes are send as part of the CUPS-Set-Default Response:
<p>Group 1: Operation Attributes
<dl>
+ <dt>Natural Language and Character Set:
+
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
+
<dt>Status Message:
<dd>The standard response status message.
- <dt>Natural Language and Character Set:
+</dl>
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
-</dl>
+<h3 class='title'><span class='info'>Deprecated</span><a name='CUPS_GET_DEVICES'>CUPS-Get-Devices Operation</a></h3>
-<p>Group 2: Printer Class Object Attributes
+<p>The CUPS-Get-Devices operation (0x400B) returns all of the supported device-uri's for the server.</p>
-<dl>
-
- <dt>The set of requested attributes and their current values for
- each printer class.
-
-</dl>
-
-<h3 class='title'><a name='CUPS_ADD_MODIFY_CLASS'>CUPS-Add-Modify-Class Operation</a></h3>
-
-<p>The CUPS-Add-Modify-Class operation (0x4006) adds a new printer class or
-modifies and existing printer class on the system.
-
-<h4>CUPS-Add-Modify-Class Request</h4>
+<h4>CUPS-Get-Devices Request</h4>
-<p>The following groups of attributes are supplied as part of the
-CUPS-Add-Modify-Class request:
+<p>The following groups of attributes are supplied as part of the CUPS-Get-Devices request:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
- <dt>"printer-uri" (uri):
+ <dt>"device-class" (type1 keyword):
- <dd>The client MUST supply a URI for the specified printer class.
+ <dd>The client OPTIONALLY supplies a device class keyword to select which devices are returned.
-</dl>
+ <dt>"exclude-schemes" (1setOf name): <span class='info'>CUPS 1.4/macOS 10.6</span>
-<p>Group 2: Printer Object Attributes
+ <dd>The client OPTIONALLY supplies a set of scheme names that the requestor does not want to discover. If the client omits this attribute, the server responds with devices of all schemes specified by the "include-schemes" attribute.
-<dl>
+ <dt>"include-schemes" (1setOf name): <span class='info'>CUPS 1.4/macOS 10.6</span>
- <dt>"member-uris" (1setof uri):
+ <dd>The client OPTIONALLY supplies a set of scheme names that the requestor wants to discover. If the client omits this attribute, the server responds with devices of all schemes except those specified by the "exclude-schemes" attribute.
- <dd>The client OPTIONALLY supplies the "member-uris" set
- specifying the printers and printer classes that are part of the class.
+ <dt>"limit" (integer (1:MAX)):
- <dt>"printer-is-accepting-jobs" (boolean):
+ <dd>The client OPTIONALLY supplies this attribute limiting the number of devices that are returned.
- <dd>The client OPTIONALLY supplies this boolean attribute
- indicating whether or not the class object should accept new jobs.
+ <dt>"requested-attributes" (1setOf keyword):
- <dt>"printer-info" (text(127)):
+ <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'.
- <dd>The client OPTIONALLY supplies this attribute indicating the
- printer information string.
+ <dt>"timeout" (integer (1:MAX)): <span class='info'>CUPS 1.4/macOS 10.6</span>
- <dt>"printer-location" (text(127)):
+ <dd>The client OPTIONALLY supplies this attribute to limit the duration of the lookup. The default timeout is 15 seconds.
- <dd>The client OPTIONALLY supplies this attribute indicating a
- textual location of the class.
+</dl>
- <dt>"printer-more-info" (uri):
+<h4>CUPS-Get-Devices Response</h4>
- <dd>The client OPTIONALLY supplies this attribute indicating a
- URI for additional class information.
+<p>The following groups of attributes are send as part of the CUPS-Get-Devices Response:
- <dt>"printer-state" (type2 enum):
+<p>Group 1: Operation Attributes
- <dd>The client OPTIONALLY supplies this attribute indicating the
- initial/current state of the class. Only the "idle" and "stopped"
- enumerations are recognized.
+<dl>
- <dt>"printer-state-message" (text(MAX)):
+ <dt>Natural Language and Character Set:
- <dd>The client OPTIONALLY supplies this attribute indicating a
- textual reason for the current class state.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
- <dt>"requesting-user-name-allowed" (1setof name(127))
- <br><i>OR</i>
- <br>"requesting-user-name-denied" (1setof name(127)):
+ <dt>Status Message:
- <dd>The client OPTIONALLY supplies one of these attributes to
- specify an access control list for incoming print jobs. To allow
- all users access to a class, use the delete tag for the
- attribute value.
+ <dd>The standard response status message.
</dl>
-<h4>CUPS-Add-Modify-Class Response</h4>
-
-<p>The following groups of attributes are send as part of the CUPS-Add-Modify-Class Response:
-
-<p>Group 1: Operation Attributes
+<p>Groups 2-N: Device Object Attributes (using printer-attributes-tag group)
<dl>
- <dt>Status Message:
-
- <dd>The standard response status message.
-
- <dt>Natural Language and Character Set:
-
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dt>The set of requested attributes and their current values for
+ each device.
</dl>
-<h3 class='title'><a name='CUPS_DELETE_CLASS'>CUPS-Delete-Class Operation</a></h3>
-<p>The CUPS-Delete-Class operation (0x4007) removes an existing printer
-class from the system.
+<h3 class='title'><span class='info'>Deprecated</span><a name='CUPS_GET_PPDS'>CUPS-Get-PPDs Operation</a></h3>
-<h4>CUPS-Delete-Class Request</h4>
+<p>The CUPS-Get-PPDs operation (0x400C) returns all of the locally available PPD files on the system.</p>
-<p>The following groups of attributes are supplied as part of the
-CUPS-Delete-Class request:
+<h4>CUPS-Get-PPDs Request</h4>
+
+<p>The following groups of attributes are supplied as part of the CUPS-Get-PPDs request:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
- <dt>"printer-uri" (uri):
+ <dt>"exclude-schemes" (1setOf name): <span class='info'>CUPS 1.4/macOS 10.6</span>
- <dd>The client MUST supply a URI for the specified printer class.
+ <dd>The client OPTIONALLY supplies a set of scheme names that the requestor does not want to list. If the client omits this attribute, the server responds with PPDs of all schemes specified by the "include-schemes" attribute.
-</dl>
+ <dt>"include-schemes" (1setOf name): <span class='info'>CUPS 1.4/macOS 10.6</span>
-<h4>CUPS-Delete-Class Response</h4>
+ <dd>The client OPTIONALLY supplies a set of scheme names that the requestor wants to list. If the client omits this attribute, the server responds with PPDs of all schemes except those specified by the "exclude-schemes" attribute.
-<p>The following groups of attributes are send as part of the
-CUPS-Delete-Class Response:
+ <dt>"limit" (integer (1:MAX)):
-<p>Group 1: Operation Attributes
+ <dd>The client OPTIONALLY supplies this attribute limiting the number of PPDs that are returned.
-<dl>
+ <dt>"ppd-make" (text(127)):
- <dt>Status Message:
+ <dd>The client OPTIONALLY supplies a printer manufacturer to select which PPDs are returned.
- <dd>The standard response status message.
+ <dt>"ppd-make-and-model" (text(127)): <span class='info'>CUPS 1.3/macOS 10.5</span>
- <dt>Natural Language and Character Set:
+ <dd>The client OPTIONALLY supplies a make and model to select which PPDs are returned.
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dt>"ppd-model-number" (integer): <span class='info'>CUPS 1.3/macOS 10.5</span>
-</dl>
+ <dd>The client OPTIONALLY supplies a model number to select which PPDs are returned.
-<h3 class='title'><a name='CUPS_ACCEPT_JOBS'>CUPS-Accept-Jobs Operation</a></h3>
+ <dt>"ppd-natural-language" (naturalLanguage): <span class='info'>CUPS 1.3/macOS 10.5</span>
-<p>The CUPS-Accept-Jobs operation (0x4008) sets the
-"printer-is-accepting-jobs" attribute to true for the specified printer
-or printer class.
+ <dd>The client OPTIONALLY supplies a language to select which PPDs are returned.
-<h4>CUPS-Accept-Jobs Request</h4>
+ <dt>"ppd-product" (text(127)): <span class='info'>CUPS 1.3/macOS 10.5</span>
-<p>The following groups of attributes are supplied as part of the
-CUPS-Accept-Jobs request:
+ <dd>The client OPTIONALLY supplies a PostScript product string to select which PPDs are returned.
-<p>Group 1: Operation Attributes
+ <dt>"ppd-psversion" (text(127)): <span class='info'>CUPS 1.3/macOS 10.5</span>
-<dl>
+ <dd>The client OPTIONALLY supplies a PostScript version string to select which PPDs are returned.
- <dt>Natural Language and Character Set:
+ <dt>"ppd-type" (type1 keyword): <span class='info'>CUPS 1.3/macOS 10.5</span>
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The client OPTIONALLY supplies a driver type to select which PPDs are returned.
- <dt>"printer-uri" (uri):
+ <dt>"requested-attributes" (1setOf keyword):
- <dd>The client MUST supply a URI for the specified printer or printer class.
+ <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.
</dl>
-<h4>CUPS-Accept-Jobs Response</h4>
+<h4>CUPS-Get-PPDs Response</h4>
<p>The following groups of attributes are send as part of the
-CUPS-Accept-Jobs Response:
+CUPS-Get-PPDs Response:
<p>Group 1: Operation Attributes
<dl>
+ <dt>Natural Language and Character Set:
+
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
+
<dt>Status Message:
<dd>The standard response status message.
- <dt>Natural Language and Character Set:
+</dl>
+
+<p>Groups 2-N: PPD Attributes (using printer-attributes-tag group)
+
+<dl>
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dt>The set of requested attributes and their current values for each PPD file.
</dl>
-<h3 class='title'><a name='CUPS_REJECT_JOBS'>CUPS-Reject-Jobs Operation</a></h3>
-<p>The CUPS-Reject-Jobs operation (0x4009) sets
-the"printer-is-accepting-jobs" attribute to false for the specified
-printer or printer class.
+<h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_MOVE_JOB'>CUPS-Move-Job Operation</a></h3>
+
+<p>The CUPS-Move-Job operation (0x400D) moves an active print job or all print jobs for a printer to a different printer.</p>
-<h4>CUPS-Reject-Jobs Request</h4>
+<h4>CUPS-Move-Job Request</h4>
-<p>The following groups of attributes are supplied as part of the
-CUPS-Reject-Jobs request:
+<p>The following groups of attributes are supplied as part of the CUPS-Move-Job request:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
- <dt>"printer-uri" (uri):
+ <dt>"printer-uri" (uri)
+ <br><i>OR</i>
+ <dt>"printer-uri" (uri) and "job-id" (integer)
+ <br><i>OR</i>
+ <br>"job-uri" (uri):
- <dd>The client MUST supply a URI for the specified printer or printer class.
+ <dd>The client MUST supply a URI for the specified printer, the URI for the specified printer and a job ID number, or the job URI.
</dl>
-<p>Group 2: Printer Object Attributes
+<p>Group 2: Job Template Attributes
<dl>
- <dt>"printer-state-message" (text(MAX)):
+ <dt>"job-printer-uri" (uri):
- <dd>The client OPTIONALLY supplies this attribute indicating a
- textual reason for the current printer state.
+ <dd>The client MUST supply a URI for a printer on the same server.
</dl>
-<h4>CUPS-Reject-Jobs Response</h4>
+<h4>CUPS-Move-Job Response</h4>
-<p>The following groups of attributes are send as part of the
-CUPS-Reject-Jobs Response:
+<p>The following groups of attributes are send as part of the CUPS-Move-Job Response:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
</dl>
-<h3 class='title'><a name='CUPS_SET_DEFAULT'>CUPS-Set-Default Operation</a></h3>
+<h3 class='title'><span class='info'>CUPS 1.2/macOS 10.5</span><a name='CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job Operation</a></h3>
-<p>The CUPS-Set-Default operation (0x400A) sets the default printer
-destination for all clients when a resource name of "/printers" is
-specified.
+<p>The CUPS-Authenticate-Job operation (0x400E) authenticates a print job for printing, releasing the job if it is held. Typically this is used when printing to a remote server. The authentication information is passed in the HTTP request; the HTTP connection is normally encrypted for this type of request.</p>
-<h4>CUPS-Set-Default Request</h4>
+<h4>CUPS-Authenticate-Job Request</h4>
-<p>The following groups of attributes are supplied as part of the
-CUPS-Set-Default request:
+<p>The following groups of attributes are supplied as part of the CUPS-Authenticate-Job request:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
- <dt>"printer-uri" (uri):
+ <dt>"printer-uri" (uri) and "job-id" (integer)
+ <br><i>OR</i>
+ <br>"job-uri" (uri):
- <dd>The client MUST supply a URI for the specified printer or
- printer class.
+ <dd>The client MUST supply a URI for the specified printer and a job ID number, or the job URI.
</dl>
-<h4>CUPS-Set-Default Response</h4>
+<p>Group 2: Job Attributes
-<p>The following groups of attributes are send as part of the
-CUPS-Set-Default Response:
+<dl>
+
+ <dt>"auth-info" (1setOf text(MAX)): <span class='info'>CUPS 1.3/macOS 10.5</span>
+
+ <dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute.
+
+ <dt>"job-hold-until" (keyword | name(MAX)): <span class='info'>CUPS 1.3/macOS 10.5</span>
+
+ <dd>The client OPTIONALLY supplies a new job-hold-until value for the job. If specified and not the "no-hold" value, the job is held instead of released for printing.
+
+</dl>
+
+<h4>CUPS-Authenticate-Job Response</h4>
+
+<p>The following groups of attributes are send as part of the CUPS-Authenticate-Job Response:
<p>Group 1: Operation Attributes
<dl>
+ <dt>Natural Language and Character Set:
+
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
+
<dt>Status Message:
<dd>The standard response status message.
- <dt>Natural Language and Character Set:
+</dl>
+
+<p>Group 2: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
+
+<dl>
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dt>auth-info-required (1setOf Type2 keyword)
+
+ <dd>The required authentication information.
</dl>
-<h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_GET_DEVICES'>CUPS-Get-Devices Operation</a></h3>
-<p>The CUPS-Get-Devices operation (0x400B) returns all of the
-supported device-uri's for the server.</p>
+<h3 class='title'><span class='info'>Deprecated</span><a name='CUPS_GET_PPD'>CUPS-Get-PPD Operation</a></h3>
-<h4>CUPS-Get-Devices Request</h4>
+<p>The CUPS-Get-PPD operation (0x400F) gets a PPD file from the server. The PPD file can be specified using a <tt>ppd-name</tt> returned by <a href='#CUPS_GET_PPDS'><tt>CUPS-Get-PPDs</tt></a> or using the <tt>printer-uri</tt> for a queue.</p>
-<p>The following groups of attributes are supplied as part of the
-CUPS-Get-Devices request:
+<p>If the PPD file is found, <tt>successful-ok</tt> is returned with the PPD file following the response data.</p>
-<p>Group 1: Operation Attributes
+<p>If the PPD file cannot be served by the local server because the <tt>printer-uri</tt> attribute points to an external printer, a <tt>cups-see-other</tt> status is returned with the correct URI to use.</p>
-<dl>
+<p>If the PPD file does not exist, <tt>client-error-not-found</tt> is returned.</p>
- <dt>Natural Language and Character Set:
+<h4>CUPS-Get-PPD Request</h4>
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+<p>The following group of attributes is supplied as part of the CUPS-Get-PPD request:
- <dt>"device-class" (type1 keyword):
+<p>Group 1: Operation Attributes
- <dd>The client OPTIONALLY supplies a device class keyword to select
- which devices are returned.
+<dl>
- <dt>"limit" (integer (1:MAX)):
+ <dt>Natural Language and Character Set:
- <dd>The client OPTIONALLY supplies this attribute limiting the number of
- devices that are returned.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
- <dt>"requested-attributes" (1setOf keyword) :
+ <dt>"printer-uri" (uri)
+ <br><i>OR</i>
+ <br>"ppd-name" (name(255)):
- <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'.
+ <dd>The client MUST supply a printer URI or PPD name.
</dl>
-<h4>CUPS-Get-Devices Response</h4>
+<h4>CUPS-Get-PPD Response</h4>
-<p>The following groups of attributes are send as part of the
-CUPS-Get-Devices Response:
+<p>The following group of attributes is sent as part of the CUPS-Get-PPD Response:
<p>Group 1: Operation Attributes
<dl>
+ <dt>Natural Language and Character Set:
+
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
+
<dt>Status Message:
<dd>The standard response status message.
- <dt>Natural Language and Character Set:
+ <dt>"printer-uri" (uri):
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dd>The printer that provides the actual PPD file when the status code is cups-see-other (0x280).
</dl>
-<p>Group 2: Device Object Attributes
+<p>If the status code is <tt>successful-ok</tt>, the PPD file follows the end of the IPP response.</p>
-<dl>
- <dt>The set of requested attributes and their current values for
- each device.
+<h3 class='title'><span class='info'>CUPS 1.4/macOS 10.6</span><a name='CUPS_GET_DOCUMENT'>CUPS-Get-Document Operation</a></h3>
-</dl>
+<p>The CUPS-Get-Document operation (0x4027) gets a document file from a job on the server. The document file is specified using the <tt>document-number</tt> and either the <tt>job-uri</tt> or <tt>printer-uri</tt> and <tt>job-id</tt> identifying the job.</p>
-<h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_GET_PPDS'>CUPS-Get-PPDs Operation</a></h3>
+<p>If the document file is found, <tt>successful-ok</tt> is returned with the document file following the response data.</p>
-<p>The CUPS-Get-PPDs operation (0x400C) returns all of the
-locally available PPD files on the system.</p>
+<p>If the document file does not exist, <tt>client-error-not-found</tt> is returned.</p>
-<h4>CUPS-Get-PPDs Request</h4>
+<p>If the requesting user does not have access to the document file, <tt>client-error-not-authorized</tt> is returned.
+
+<h4>CUPS-Get-Document Request</h4>
-<p>The following groups of attributes are supplied as part of the
-CUPS-Get-PPDs request:
+<p>The following group of attributes is supplied as part of the CUPS-Get-Document request:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
-
- <dt>"limit" (integer (1:MAX)):
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
- <dd>The client OPTIONALLY supplies this attribute limiting the number of
- PPDs that are returned.
-
- <dt>"ppd-make" (text(127)):
+ <dt>"printer-uri" (uri) and "job-id" (integer)
+ <br><i>OR</i>
+ <br>"job-uri" (uri):
- <dd>The client OPTIONALLY supplies a printer manufacturer to select
- which PPDs are returned.
+ <dd>The client MUST supply a printer URI and job ID or job URI.
- <dt>"requested-attributes" (1setOf keyword) :
+ <dt>"document-number" (integer(1:MAX)):
- <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'.
+ <dd>The client MUST supply a document number to retrieve. The <tt>document-count</tt> attribute for the job defines the maximum document number that can be specified. In the case of jobs with banners (<tt>job-sheets</tt> is not "none"), document number 1 will typically contain the start banner and document number N will typically contain the end banner.
</dl>
-<h4>CUPS-Get-PPDs Response</h4>
+<h4>CUPS-Get-Document Response</h4>
-<p>The following groups of attributes are send as part of the
-CUPS-Get-PPDs Response:
+<p>The following group of attributes is sent as part of the CUPS-Get-Document Response:
<p>Group 1: Operation Attributes
<dl>
+ <dt>Natural Language and Character Set:
+
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
+
<dt>Status Message:
<dd>The standard response status message.
- <dt>Natural Language and Character Set:
+ <dt>"document-format" (mimeType):
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dd>The format of the document file.
-</dl>
+ <dt>"document-number" (integer(1:MAX)):
-<p>Group 2: PPD Attributes
+ <dd>The requested document number.
-<dl>
+ <dt>"document-name" (name(MAX)):
- <dt>The set of requested attributes and their current values for each
- PPD file.
+ <dd>The name that was supplied with the document, if any.
</dl>
-<h3 class='title'><span class='info'>CUPS 1.1</span><a name='CUPS_MOVE_JOB'>CUPS-Move-Job Operation</a></h3>
+<p>If the status code is <tt>successful-ok</tt>, the document file follows the end of the IPP response.</p>
-<p>The CUPS-Move-Job operation (0x400D) moves an active print job
-to a different printer.</p>
-<h4>CUPS-Move-Job Request</h4>
+<h3 class='title'><a name='CUPS_CREATE_LOCAL_PRINTER'>CUPS-Create-Local-Printer</a></h3>
+
+<p>The CUPS-Create-Local-Printer operation (0x4028) creates a local (temporary) print queue pointing to a remote IPP Everywhere Printer. The queue will remain until the scheduler idle exits, is restarted, or the system is restarted or shutdown. Temporary print queues can be made permanent by an administrator by setting the "printer-is-shared" attribute to 'true'.</p>
+
+<p>At a minimum, the scheduler requires a name and URI for the Printer to add. When successful, the local "printer-uri" values are returned and may be used by the Client to submit Job Creation Requests, monitor for state changes, and so forth.</p>
+
+<p>If the named printer already exists, the scheduler will reject the request with the 'client-error-not-possible' status code.</p>
-<p>The following groups of attributes are supplied as part of the
-CUPS-Move-Job request:
+<p>Access Rights: The authenticated user performing this operation MUST be a Local User of the system, and the request MUST be made over a local (domain socket or loopback interface) address. Otherwise, the request will be rejected with the 'client-error-forbidden' status code.</p>
+
+<h4>CUPS-Create-Local-Printer Request</h4>
+
+<p>The following group of attributes is supplied as part of the CUPS-Create-Local-Printer request:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
-
- <dt>"printer-uri" (uri) and "job-id" (integer)
- <br><i>OR</i>
- <br>"job-uri":
-
- <dd>The client MUST supply a URI for the specified printer and
- a job ID number, or the job URI.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
</dl>
-<p>Group 2: Job Template Attributes
+<p>Group 2: Printer Attributes
<dl>
- <dt>"job-printer-uri" (uri)
+ <dt>"printer-name" (name(127)):
- <dd>The client MUST supply a URI for a printer on the same server.
+ <dd>The Client MUST supply this attribute which provides the name for the new Printer.
-</dl>
+ <dt>"device-uri" (uri):
-<h4>CUPS-Move-Job Response</h4>
+ <dd>The Client MUST supply this attribute which provides an "ipp" or "ipps" URI pointing to an IPP Everywhere Printer.
-<p>The following groups of attributes are send as part of the
-CUPS-Move-Job Response:
+ <dt>"printer-device-id" (text(1023)):
-<p>Group 1: Operation Attributes
+ <dd>The Client OPTIONALLY supplies this attribute which provides the IEEE 1284 device ID for the new Printer.
-<dl>
+ <dt>"printer-geo-location" (uri):
- <dt>Status Message:
+ <dd>The Client OPTIONALLY supplies this attribute which provides the geo-location of the new Printer as a "geo" URI.
- <dd>The standard response status message.
-
- <dt>Natural Language and Character Set:
+ <dt>"printer-info" (text(127)):
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dd>The Client OPTIONALLY supplies this attribute which provides the description for the new Printer.
-</dl>
+ <dt>"printer-location" (text(127)):
-<h3 class='title'><span class='info'>CUPS 1.2</span><a name='CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job Operation</a></h3>
+ <dd>The Client OPTIONALLY supplies this attribute which provides the location of the new Printer.
-<p>The CUPS-Authenticate-Job operation (0x400E) authenticate a
-print job for printing. Typically this is used when printing to a
-remote server. The authentication information is passed in the
-HTTP request.</p>
+</dl>
-<h4>CUPS-Authenticate-Job Request</h4>
+<h4>CUPS-Create-Local-Printer Response</h4>
-<p>The following groups of attributes are supplied as part of the
-CUPS-Authenticate-Job request:
+<p>The following group of attributes is sent as part of the CUPS-Create-Local-Printer Response:
<p>Group 1: Operation Attributes
<dt>Natural Language and Character Set:
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.1 of the IPP Model and
- Semantics document.
+ <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
- <dt>"printer-uri" (uri) and "job-id" (integer)
- <br><i>OR</i>
- <br>"job-uri":
+ <dt>Status Message:
- <dd>The client MUST supply a URI for the specified printer and
- a job ID number, or the job URI.
+ <dd>The standard response status message.
</dl>
-<h4>CUPS-Authenticate-Job Response</h4>
+<p>Group 2: Printer Attributes
-<p>The following groups of attributes are send as part of the
-CUPS-Authenticate-Job Response:
+<dl>
-<p>Group 1: Operation Attributes
+ <dt>"printer-id" (integer(0:65535)):
-<dl>
+ <dd>The numeric identifier for the created Printer.
- <dt>Status Message:
+ <dt>"printer-is-accepting-jobs" (boolean):
- <dd>The standard response status message.
+ <dd>Whether the created Printer is accepting jobs at the time of the response.
- <dt>Natural Language and Character Set:
+ <dt>"printer-state" (type1 enum):
+
+ <dd>The state of the created Printer at the time of the response.
+
+ <dt>"printer-state-reasons" (1setOf type2 keyword):
+
+ <dd>The state keywords for the created Printer at the time of the response.
+
+ <dt>"printer-uri-supported" (1setOf uri):
- <dd>The "attributes-charset" and "attributes-natural-language"
- attributes as described in section 3.1.4.2 of the IPP Model and
- Semantics document.
+ <dd>The URIs for the created Printer.
</dl>
+
<h2 class='title'><a name='ATTRIBUTES'>Attributes</a></h2>
-<p>CUPS provides many extension attributes to support multiple
-devices, PPD files, standard job filters, printers, and printer
-classes.</p>
+<p>CUPS provides many extension attributes to support multiple devices, PPD files, standard job filters, printers, and printer classes.</p>
-<h3 class='title'><a name='DEVICE_ATTRIBUTES'>Device Attributes</a></h3>
+<h3 class='title'><a name='DEVICE_ATTRIBUTES'>Device Attributes</a><span class="info">Deprecated</span></h3>
-<p>Device attributes are returned by the CUPS-Get-Devices
-operation and enumerate all of the available hardware devices and
-network protocols that are supported by the server.</p>
+<p>Device attributes are returned by the CUPS-Get-Devices operation and enumerate all of the available hardware devices and network protocols that are supported by the server. Device attributes are reported in the printer-attributes-tag group.</p>
-<h4>device-class (type2 keyword)</h4>
+<h4><a name="device-class">device-class (type2 keyword)</a><span class="info">Deprecated</span></h4>
-<p>The device-class attribute specifies the class of device and can be
-one of the following:
+<p>The "device-class" attribute provides the class of device and can be one of the following:
<ul>
- <li>"file" - a disk file.
+ <li>'file': A disk file.
- <li>"direct" - a parallel or fixed-rate serial data port,
+ <li>'direct': A parallel or fixed-rate serial data port,
currently used for Centronics, IEEE-1284, and USB printer
ports.
- <li>"serial" - a variable-rate serial port.
+ <li>'serial': A variable-rate serial port.
- <li>"network" - a network connection, typically via AppSocket,
- HTTP, IPP, LPD, or SMB/CIFS protocols.
+ <li>'network': A network connection, typically via AppSocket, HTTP, IPP, LPD, or SMB/CIFS protocols.
</ul>
-<h4>device-id (text(127))</h4>
+<h4><a name="device-id">device-id (text(1023))</a><span class="info">Deprecated</span></h4>
+
+<p>The "device-id" attribute provides the IEEE-1284 device ID string for the device.</p>
-<p>The device-id attribute specifies the IEEE-1284 device ID
-string for the device.</p>
+<h4><a name="device-info">device-info (text(127))</a><span class="info">Deprecated</span></h4>
-<h4>device-info (text(127))</h4>
+<p>The "device-info" attribute specifies a human-readable string describing the device, e.g., 'Parallel Port #1'.
-<p>The device-info attribute specifies a human-readable string describing
-the device, e.g. "Parallel Port #1".
+<h4><a name="device-location">device-location (text(127))</a><span class="info">Deprecated</span></h4>
-<h4>device-make-and-model (text(127))</h4>
+<p>The "device-location" attribute specifies the physical location of the printer, e.g., '2nd Floor Computer Lab'.
-<p>The device-makr-and-model attribute specifies a device
-identification string provided by the printer connected to the device.
-If the device or printer does not support identification then this
-attribute contains the string "unknown".
+<h4><a name="device-make-and-model">device-make-and-model (text(127))</a><span class="info">Deprecated</span></h4>
-<h4>device-uri (uri)</h4>
+<p>The "device-make-and-model" attribute specifies a device identification string provided by the printer connected to the device. If the device or printer does not support identification then this attribute contains the string 'unknown'.
-<p>The device-uri attribute specifies a unique identifier for the
-device. The actual format of the device-uri string depends on the value
-of the device-class attribute:
+<h4><a name="device-uri">device-uri (uri)</a></h4>
+
+<p>The "device-uri" attribute specifies a unique identifier for the device. The actual format of the "device-uri" string depends on the value of the "device-class" attribute:
<ul>
- <li>"file" - The device-uri will be of the form
- "file:///path/to/filename".
-
- <li>"direct" - The device-uri will be of the form
- "scheme:/dev/filename" or "scheme://vendor/identifier",
- where scheme may be "parallel" or "usb" in the current
- implementation.
-
- <li>"serial" - The device-uri will be of the form
- "serial:/dev/filename?baud=value+parity=value+flow=value".
- The baud value is the data rate in bits per second; the
- supported values depend on the underlying hardware.
- The parity value can be one of "none", "even", or "odd".
- The flow value can be one of "none", "soft" (XON/XOFF
- handshaking), "hard" or "rts/cts" (RTS/CTS handshaking),
- or "dtrdsr" (DTR/DSR handshaking).
-
- <p>The URI returned by CUPS-Get-Devices will contain the
- maximum baud rate supported by the device and the best
- type of flow control available ("soft" or "hard").
-
- <li>"network" - The device-uri will be of the form
- "scheme://[username:password@]hostname[:port]/[resource]",
- where scheme may be "http", "https", "ipp", "lpd", "smb", or
- "socket" in the current implementation.
-
- <p>The URI returned by CUPS-Get-Devices will only contain
- the scheme name ("scheme"). It is up to the client
- application to add the appropriate host and other
- information when adding a new printer.
-
- <p>The URI returned by Get-Printer-Attributes and
- CUPS-Get-Printers has any username and password information
- stripped; the information is still stored and used by the
- server internally to perform any needed authentication.
+ <li>'file': The "device-uri" will be of the form 'file:///path/to/filename'.
+
+ <li>'direct': The "device-uri" will be of the form 'scheme:/dev/filename' or 'scheme://vendor/identifier', where scheme may be 'parallel' or 'usb' in the current implementation.
+
+ <li>'serial': The "device-uri" will be of the form 'serial:/dev/filename?baud=value+parity=value+flow=value'. The baud value is the data rate in bits per second; the supported values depend on the underlying hardware. The parity value can be one of "none", "even", or "odd". The flow value can be one of "none", "soft" (XON/XOFF handshaking), "hard" or "rts/cts" (RTS/CTS handshaking), or "dtrdsr" (DTR/DSR handshaking).
+
+ <p>The URI returned by CUPS-Get-Devices will contain the maximum baud rate supported by the device and the best type of flow control available ("soft" or "hard").
+
+ <li>'network': The "device-uri" will be of the form 'scheme://[username:password@]hostname[:port]/[resource]', where scheme may be "http", "https", "ipp", "lpd", "smb", or "socket" in the current implementation.
+
+ <p>The URI returned by CUPS-Get-Devices MAY only contain the scheme name ('scheme'). It is up to the client application to add the appropriate host and other information when adding a new printer.
+
+ <p>The URI returned by Get-Printer-Attributes and CUPS-Get-Printers has any username and password information stripped; the information is still stored and used by the server internally to perform any needed authentication.
</ul>
-<h3 class='title'><a name='JOB_TEMPLATE_ATTRIBUTES'>Job Template Attributes</a></h3>
-<h4>blackplot (boolean)</h4>
+<h3 class='title'><a name='JOB_ATTRIBUTES'>Job Attributes</a></h3>
-<p>The blackplot attribute specifies whether HP-GL/2 plot files should be
-rendered entirely in black ink (blackplot=true) or using the colors and shades
-specified in the file (blackplot=false). The default value is false.
+<h4><a name="auth-info">auth-info (1setOf text(MAX))</a><span class="info">CUPS 1.3/macOS 10.5</span></h4>
-<h4>brightness (integer(0:200))</h4>
+<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.
-<p>The brightness attribute specifies the overall brightness of the printed
-output in percent. A brightness of 100 is normal, while 200 is twice as
-bright and 50 is half as bright. The default value is 100.
+<h4><a name="job-cancel-after">job-cancel-after (integer(1:MAX))</a><span class='info'>CUPS 2.0</span></h4>
-<p>Brightness is applied to the Cyan, Magenta, Yellow, and Black values using
-the function "f(x) = brightness / 100 * x".
+<p>The "job-cancel-after" attribute provides the maximum number of seconds that are allowed for processing a job.</p>
-<h4>columns (integer(1:4))</h4>
+<h4><a name="job-hold-until">job-hold-until (keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4>
-<p>The columns attribute specifies the number of columns to generate when
-printing text files. The default value is 1.
+<p>The "job-hold-until" attribute specifies a hold time. In addition to the standard IPP/1.1 keyword names, CUPS supports name values of the form "HH:MM" and "HH:MM:SS" that specify a hold time. The hold time is in Universal Coordinated Time (UTC) and <i>not</i> in the local time zone. If the specified time is less than the current time, the job is held until the next day.
-<h4>cpi (type2 enum)</h4>
+<h4><a name="job-media-progress">job-media-progress (integer(0:100))</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
-<p>The cpi attribute specifies the number of characters per inch when
-printing text files. Only the values 10, 12, and 17 are currently
-supported. The default value is 10.
+<p>The "job-media-progress" status attribute specifies the percentage of completion of the current page. It is only valid when the "job-state" attribute has the 'processing(5)' value.</p>
-<h4>fitplot (boolean)</h4>
+<h4><a name="job-printer-state-message">job-printer-state-message (text(MAX))</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
-<p>The fitplot attribute specifies whether to scale HP-GL/2 plot files to
-fit on the selected media (fitplot=true) or use the physical scale specified
-in the plot file (fitplot=false). The default value is false.
+<p>The "job-printer-state-message" status attribute provides the last known value of the "printer-state-message" attribute for the printer that processed (or is processing) the job.</p>
-<h4>gamma (integer(1:10000))</h4>
+<h4><a name="job-printer-state-reasons">job-printer-state-reasons (1setOf type2 keyword)</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
-<p>The gamma attribute specifies the luminance correction for the output.
-A value of 1000 specifies no correction, while values of 2000 and 500 will
-generate lighter and darker output, respectively. The default value is
-1000.
+<p>The "job-printer-state-reasons" status attribute provides the last known value of the "printer-state-reasons" attribute for the printer that processed (or is processing) the job.</p>
-<p>Gamma is applied to the Red, Green, and Blue values (or luminance for
-grayscale output) using the function "f(x) = x<SUp>(1000/gamma)</SUp>".
+<h4><a name="job-sheets">job-sheets (1setof type3 keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4>
-<h4>hue (integer(-180:180))</h4>
+<p>The "job-sheets" attribute specifies one or two banner files that are printed before and after a job. The reserved value of "none" disables banner printing. The default value is stored in the "job-sheets-default" attribute.
-<p>The hue attribute specifies a color hue rotation when printing image
-files. The default value is 0.
+<p>If only one value is supplied, the banner file is printed before the job. If two values are supplied, the first value is used as the starting banner file and the second as the ending banner file.
-<h4>job-billing (text(MAX))<span class='info'>CUPS 1.1</span></h4>
+<h4><a name="job-originating-host-name">job-originating-host-name (name(MAX))</a><span class='info'>CUPS 1.1.5/macOS 10.2</span></h4>
-<p>The job-billing attribute provides a text value to associate with a job
-for billing purposes.
+<p>The "job-originating-host-name" status attribute specifies the host from which the job was queued. The value will be the hostname or IP address of the client depending on whether hostname resolution is enabled. The localhost address (127.0.0.1) is <b>always</b> resolved to the name "localhost".
-<h4>job-hold-until (keyword | name(MAX))<span class='info'>CUPS 1.1</span></h4>
+<p>This attribute is read-only.
-<p>The job-hold-until attribute specifies a hold time. In addition to the
-standard IPP/1.1 keyword names, CUPS supports name values of the form
-"HH:MM" and "HH:MM:SS" that specify a hold time. The hold time is in
-Greenwich Mean Time (GMT) and <i>not</i> in the local time zone. If the
-specified time is less than the current time, the job is held until the
-next day.
+<h4><a name="page-border">page-border (type2 keyword)</a><span class='info'>CUPS 1.1.15</span></h4>
-<h4>job-sheets (1setof type3 keyword | name(MAX))<span class='info'>CUPS 1.1</span></h4>
+<p>The "page-border" attribute specifies whether a border is draw around each page. The following keywords are presently defined:
-<p>The job-sheets attribute specifies one or two banner files that are printed
-before and after a job. The reserved value of "none" disables banner printing.
-The default value is stored in the job-sheets-default attribute.
+<ul>
-<p>If only one value is supplied, the banner file is printed before the job.
-If two values are supplied, the first value is used as the starting banner
-file and the second as the ending banner file.
+ <li>'double': Two hairline borders are drawn</li>
-<h4>job-originating-host-name (name(MAX))</h4>
+ <li>'double-thick': Two 1pt borders are drawn</li>
-<p><i>(CUPS 1.1.5 and higher)</i>
+ <li>'none': No border is drawn (default)</li>
-<p>The job-originating-host-name attribute specifies the host
-from which the job was queued. The value will be the hostname or
-IP address of the client depending on whether hostname
-resolution is enabled. The localhost address (127.0.0.1) is
-<b>always</b> resolved to the name "localhost".
+ <li>'single': A single hairline border is drawn</li>
-<p>This attribute is read-only.
+ <li>'single-thick': A single 1pt border is drawn</li>
-<h4>lpi (type2 enum)</h4>
+</ul>
-<p>The lpi attribute specifies the number of lines per inch when
-printing text files. Only the values 6 and 8 are currently supported.
-The default value is 6.
+<h4><a name="page-set">page-set (type2 keyword)</a><span class="info">Deprecated</span></h4>
-<h4>mirror (boolean)</h4>
+<p>The "page-set" attribute specifies which pages to print in a file. The supported keywords are 'all', 'even', and 'odd'. The default value is 'all'.
-<p>The mirror attribute specifies whether pages are mirrored on
-their X axis, which is useful for printing transfer images on
-special media. The default value is false.
+<h3 class='title'><a name='PPD_ATTRIBUTES'>PPD Attributes</a><span class="info">Deprecated</span></h3>
-<h4>natural-scaling (integer(1:1000))<span class='info'>CUPS 1.1.9</span></h4>
-<p>The natural-scaling attribute specifies the scaling of image files with
-respect to the natural image size. A value of 100 specifies that the image
-file should exactly the natural size, while 50 is half the natural size
-and 200 is twice the natural size. The default value is 100.
+<p>PPD attributes are returned in the printer-attributes-tag group.
-<p>The ppi option can be used to override the natural resolution of the
-image, which controls the natural size.
+<h4><a name="ppd-device-id">ppd-device-id (text(127))</a><span class="info">Deprecated</span></h4>
-<h4>number-up-layout (type2 keyword)<span class='info'>CUPS 1.1.15</span></h4>
-<p>The number-up-layout attribute specifies the order each input
-page is placed on each output page. The following keywords are
-presently defined:
+<p>The "ppd-device-id" attribute specifies the IEEE-1284 device ID string for the device described by the PPD file.</p>
-<ul>
+<h4><a name="ppd-make">ppd-make (text(127))</a><span class="info">Deprecated</span></h4>
+
+<p>The "ppd-make" attribute specifies the manufacturer of the printer (the Manufacturer attribute in the PPD file). If the manufacturer is not specified in the PPD file then an educated guess is made using the NickName attribute in the PPD file.
+
+<h4><a name="ppd-make-and-model">ppd-make-and-model (text(127))</a><span class="info">Deprecated</span></h4>
+
+<p>The "ppd-make-and-model" attribute specifies the manufacturer and model name of the PPD file (the NickName attribute in the PPD file). If the make and model is not specified in the PPD file then the ModelName or ShortNickName attributes are used instead.
+
+<h4><a name="ppd-model-number">ppd-model-number (integer)</a><span class="info">Deprecated</span></h4>
+
+<p>The "ppd-model-number" attribute provides the <tt>cupsModelNumber</tt> value from the PPD file.
+
+<h4><a name="ppd-name">ppd-name (name(255))</a><span class="info">Deprecated</span></h4>
+
+<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.
+
+<h4><a name="ppd-natural-language">ppd-natural-language (1setOf naturalLanguage)</a><span class="info">Deprecated</span></h4>
+
+<p>The "ppd-natural-language" attribute specifies the language encoding of the PPD file (the LanguageVersion attribute in the PPD file). If the language is unknown or undefined then "en" (English) is assumed.
+
+<h4><a name="ppd-product">ppd-product (1setOf text(127))</a><span class="info">Deprecated</span></h4>
+
+<p>The "ppd-product" attribute specifies the Product attribute values in the PPD file.
+
+<h4><a name="ppd-psversion">ppd-psversion (1setOf text(127))</a><span class="info">Deprecated</span></h4>
- <li><CODE>btlr</CODE> - Bottom to top, left to right</li>
+<p>The "ppd-product" attribute specifies the PSVersion attribute values in the PPD file.
- <li><CODE>btrl</CODE> - Bottom to top, right to left</li>
+<h4><a name="ppd-type">ppd-type (type1 keyword)</a><span class="info">Deprecated</span></h4>
- <li><CODE>lrbt</CODE> - Left to right, bottom to top</li>
+<p>The "ppd-type" attribute specifies the type of driver described by the PPD file:</p>
- <li><CODE>lrtb</CODE> - Left to right, top to bottom (default)</li>
+<ul>
+
+ <li>'fax': A facsimile or multi-function device</li>
- <li><CODE>rlbt</CODE> - Right to left, bottom to top</li>
+ <li>'pdf': A PDF printer</li>
- <li><CODE>rltb</CODE> - Right to left, top to bottom</li>
+ <li>'postscript': A PostScript printer (no filters)</li>
- <li><CODE>tblr</CODE> - Top to bottom, left to right</li>
+ <li>'raster': A CUPS raster driver</li>
- <li><CODE>tbrl</CODE> - Top to bottom, right to left</li>
+ <li>'unknown': An unknown or hybrid driver</li>
</ul>
-<h4>page-border (type2 keyword)<span class='info'>CUPS 1.1.15</span></h4>
-<p>The page-border attribute specifies whether a border is
-draw around each page. The following keywords are presently
-defined:
+
+<h3 class='title'><a name='PRINTER_ATTRIBUTES'>Printer Attributes</a></h3>
+
+<h4><a name="auth-info-required">auth-info-required (1setOf type2 keyword)</a><span class="info">CUPS 1.3/macOS 10.5</span></h4>
+
+<p>The "auth-info-required" attribute specifies the authentication information that is required for printing a job. The following keywords are recognized:</p>
<ul>
- <li><CODE>double</CODE> - Two hairline borders are drawn</li>
+ <li>'domain': A domain name is required.</li>
- <li><CODE>double-thick</CODE> - Two 1pt borders are drawn</li>
+ <li>'negotiate': Kerberos is required - this keyword can only appear by itself and causes cupsd to collect the UID of the printing user.</li>
- <li><CODE>none</CODE> - No border is drawn (default)</li>
+ <li>'none': No authentication is required - this keyword can only appear by itself.</li>
- <li><CODE>single</CODE> - A single hairline border is drawn</li>
+ <li>'password': A password is required.</li>
- <li><CODE>single-thick</CODE> - A single 1pt border is drawn</li>
+ <li>'username': A username is required. Some protocols (like SMB) prefix the username with the domain, for example "DOMAIN\user".</li>
</ul>
-<h4>page-bottom (integer(0:MAX))</h4>
+<h4><a name="job-k-limit">job-k-limit (integer)</a><span class='info'>CUPS 1.1</span></h4>
+
+<p>The "job-k-limit" attribute specifies the maximum number of kilobytes that may be printed by a user, including banner files. The default value of 0 specifies that there is no limit.
+
+<h4><a name="job-page-limit">job-page-limit (integer)</a><span class='info'>CUPS 1.1</span></h4>
+
+<p>The "job-page-limit" attribute specifies the maximum number of pages that may be printed by a user, including banner files. The default value of 0 specifies that there is no limit.
-<p>The page-bottom attribute specifies the bottom margin in points (72 points
-equals 1 inch). The default value is the device physical margin.
+<h4><a name="job-quota-period">job-quota-period (integer)</a><span class='info'>CUPS 1.1</span></h4>
-<h4>page-label (text(MAX))<span class='info'>CUPS 1.1.7</span></h4>
-<p>The page-label attribute provides a text value to place in
-the header and footer on each page. If a classification level is
-set on the server, then this classification is printed before
-the page label.
+<p>The "job-quota-period" attribute specifies the time period used for quota calculations, in seconds. The default value of 0 specifies that the limits apply to all jobs that have been printed by a user that are still known to the system.
-<h4>page-left (integer(0:MAX))</h4>
+<h4><a name="marker-change-time">marker-change-time (integer)</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
-<p>The page-left attribute specifies the left margin in points (72 points
-equals 1 inch). The default value is the device physical margin.
+<p>The "marker-change-time" status attribute specifies the "printer-up-time" value when the last change to the marker-colors, marker-levels, marker-message, marker-names, or marker-types attributes was made.</p>
-<h4>page-right (integer(0:MAX))</h4>
+<h4><a name="marker-colors">marker-colors (1setof name(MAX))</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
-<p>The page-right attribute specifies the right margin in points (72 points
-equals 1 inch). The default value is the device physical margin.
+<p>The "marker-colors" status attribute specifies the color(s) for each supply in the printer. It is only available when the driver provides supply levels. The color is either 'none' or one or more hex-encoded sRGB colors of the form '#RRGGBB'.</p>
-<h4>page-set (type2 keyword)</h4>
+<h4><a name="marker-high-levels">marker-high-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
-<p>The page-set attribute specifies which pages to print in a file. The
-supported keywords are "all", "even", and "odd". The default value is
-"all".
+<p>The "marker-high-levels" status attribute specifies the supply levels that indicate a near-full condition. A value of 100 should be used for supplies that are consumed/emptied, e.g. ink cartridges.</p>
-<h4>page-top (integer(0:MAX))</h4>
+<h4><a name="marker-levels">marker-levels (1setof integer(-3:100))</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
-<p>The page-top attribute specifies the top margin in points (72 points
-equals 1 inch). The default value is the device physical margin.
+<p>The "marker-levels" status attribute specifies the current supply levels for the printer. It is only available when the driver provides supply levels. A value of -1 indicates the level is unavailable, -2 indicates unknown, and -3 indicates the level is unknown but has not yet reached capacity. Values from 0 to 100 indicate the corresponding percentage.</p>
-<h4>penwidth (integer(0:MAX))</h4>
+<h4><a name="marker-low-levels">marker-low-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
-<p>The penwidth attribute specifies the default pen width in micrometers
-when printing HP-GL/2 plot files. The default value is 1000 (1 millimeter).
+<p>The "marker-low-levels" status attribute specifies the supply levels that indicate a near-empty condition. A value of 0 should be used for supplies that are filled, e.g. waste ink tanks.</p>
-<h4>position (type2 keyword)</h4>
+<h4><a name="marker-message">marker-message (text(MAX))</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
-<p>The position attribute specifies the location of image files on the
-media. The following keyword values are recognized:
+<p>The "marker-message" status attribute provides a human-readable status message for the current supply levels, e.g. "12 pages of ink remaining." It is only available when the driver provides supply levels.</p>
+
+<h4><a name="marker-names">marker-names (1setof name(MAX))</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
+
+<p>The "marker-names" status attribute specifies the name(s) for each supply in the printer. It is only available when the driver provides supply levels.</p>
+
+<h4><a name="marker-types">marker-types (1setof type3 keyword)</a><span class='info'>CUPS 1.3/macOS 10.5</span></h4>
+
+<p>The "marker-types" status attribute specifies the type(s) of each supply in the printer. It is only available when the driver provides supply levels. The following (RFC 3805) types are currently supported:</p>
<ul>
- <li><CODE>center</CODE> - Center the image on the page (default)
+ <li>'toner'</li>
- <li><CODE>top</CODE> - Print the image centered at the top of the page
+ <li>'waste-toner'</li>
- <li><CODE>left</CODE> - Print the image centered on the left of page
+ <li>'ink'</li>
- <li><CODE>right</CODE> - Print the image centered on the right of the page
+ <li>'ink-cartridge'</li>
- <li><CODE>top-left</CODE> - Print the image at the top left corner of
- the page
+ <li>'ink-ribbon'</li>
- <li><CODE>top-right</CODE> - Print the image at the top right corner of
- the page
+ <li>'waste-ink'</li>
- <li><CODE>bottom</CODE> - Print the image centered at the bottom of
- the page
+ <li>'opc'</li>
- <li><CODE>bottom-left</CODE> - Print the image at the bottom left
- corner of the page
+ <li>'developer'</li>
- <li><CODE>bottom-right</CODE> - Print the image at the bottom right
- corner of the page
+ <li>'fuser-oil'</li>
-</ul>
+ <li>'solid-wax'</li>
-<h4>ppi (integer(1:MAX))</h4>
+ <li>'ribbon-wax'</li>
-<p>The ppi attribute specifies the resolution of an image file in pixels
-per inch. The default value is the resolution included with the file or
-128 if no resolution information is available.
+ <li>'waste-wax'</li>
-<h4>prettyprint (boolean)</h4>
+ <li>'fuser'</li>
-<p>The prettyprint attribute specifies whether text files should be printed
-with a shaded header and keyword highlighting (prettyprint=true) or without
-additional formatting (prettyprint=false). The default value is false.
+ <li>'corona-wire'</li>
-<h4>saturation (integer(0:200))</h4>
+ <li>'fuser-oil-wick'</li>
-<p>The saturation attribute specifies the color saturation when
-printing image files. A saturation of 100 is normal, while values of 50
-and 200 will be half and twice as colorful, respectively. The default
-value is 100.
+ <li>'cleaner-unit'</li>
-<h4>scaling (integer(1:1000))</h4>
+ <li>'fuser-cleaning-pad'</li>
-<p>The scaling attribute specifies the scaling of image files with
-respect to the selected media. A value of 100 specifies that the image
-file should fit 100% of the page, or as much as possible given the
-image dimensions. The default value is unspecified.
+ <li>'transfer-unit'</li>
-<p>The scaling attribute overrides the ppi attribute if specified.
+ <li>'toner-cartridge'</li>
-<h4>wrap (boolean)</h4>
+ <li>'fuser-oiler'</li>
-<p>The wrap attribute specifies whether long lines should be wrapped
-(wrap=true) or not (wrap=false) when printing text files. The default
-value is true.
+ <li>'water'</li>
-<h3 class='title'><a name='PPD_ATTRIBUTES'>PPD Attributes</a></h3>
+ <li>'waste-water'</li>
-<h4>ppd-device-id (text(127))</h4>
+ <li>'binding-supply'</li>
-<p>The ppd-device-id attribute specifies the IEEE-1284 device ID
-string for the device described by the PPD file.</p>
+ <li>'banding-supply'</li>
-<h4>ppd-natural-language (naturalLanguage)</h4>
+ <li>'stiching-wire'</li>
-<p>The ppd-natural-language attribute specifies the language encoding
-of the PPD file (the LanguageVersion attribute in the PPD file). If the
-language is unknown or undefined then "en" (English) is assumed.
+ <li>'shrink-wrap'</li>
-<h4>ppd-make (text(127))</h4>
+ <li>'paper-wrap'</li>
-<p>The ppd-make attribute specifies the manufacturer of the printer
-(the Manufacturer attribute in the PPD file). If the manufacturer
-is not specified in the PPD file then an educated guess is made using
-the NickName attribute in the PPD file.
+ <li>'staples'</li>
-<h4>ppd-make-and-model (text(127))</h4>
+ <li>'inserts'</li>
-<p>The ppd-make-and-model attribute specifies the manufacturer and model
-name of the PPD file (the NickName attribute in the PPD file). If the
-make and model is not specified in the PPD file then the ModelName or
-ShortNickName attributes are used instead.
+ <li>'covers'</li>
-<h4>ppd-name (name(255))</h4>
+</ul>
-<p>The ppd-name attribute specifies the PPD filename on the server
-relative to the model directory. The forward slash (/) is used to
-delineate directories.
+<h4><a name="port-monitor">port-monitor" (name(127))</a><span class="info">Deprecated</span></h4>
-<h3 class='title'><a name='PRINTER_ATTRIBUTES'>Printer Attributes</a></h3>
+<p>The "port-monitor" attribute specifies the port monitor to use when printing to this printer. The default port monitor is 'none'.
-<h4>job-k-limit (integer)<span class='info'>CUPS 1.1</span></h4>
+<h4><a name="port-monitor-supported">port-monitor-supported" (1setOf name(127))</a><span class="info">Deprecated</span></h4>
-<p>The job-k-limit attribute specifies the maximum number of kilobytes that
-may be printed by a user, including banner files. The default value of 0
-specifies that there is no limit.
+<p>The "port-monitor-supported" attribute specifies the available port monitors.
-<h4>job-page-limit (integer)<span class='info'>CUPS 1.1</span></h4>
+<h4><a name="printer-commands">printer-commands (1setOf Type3 keyword)</a><span class='info'>Deprecated</span></h4>
-<p>The job-page-limit attribute specifies the maximum number of pages that
-may be printed by a user, including banner files. The default value of 0
-specifies that there is no limit.
+<p>The "printer-commands" attribute specifies the commands that are supported by the CUPS command file filter. The keyword 'none' indicates that no commands are supported.</p>
-<h4>job-quota-period (integer)<span class='info'>CUPS 1.1</span></h4>
+<h4><a name="printer-dns-sd-name">printer-dns-sd-name (name(MAX) | noValue)</a><span class='info'>CUPS 1.4/macOS 10.6</span></h4>
-<p>The job-quota-period attribute specifies the time period used for quota
-calculations, in seconds. The default value of 0 specifies that the limits
-apply to all jobs that have been printed by a user that are still known to
-the system.
+<p>The "printer-dns-sd-name" attribute specifies the registered DNS-SD service name for the printer. If the printer is not being shared using this protocol, "printer-dns-sd-name" will have the no-value value.</p>
-<h4>job-sheets-supported (1setof type3 keyword | name(MAX))<span class='info'>CUPS 1.1</span></h4>
+<h4><a name="printer-id">printer-id (integer(0:65535)</a><span class="info">CUPS 2.2</span></h4>
-<p>The job-sheets-supported attribute specifies the available banner files.
-There will always be at least one banner file available called "none".
+<p>The "printer-id" status attribute provides a unique integer identifying the printer. It is used when only an IP address and integer are provided for identifying a print queue.</p>
-<h4>printer-type (type2 enum)</h4>
+<h4><a name="printer-type">printer-type (type2 enum)</a></h4>
-<p>The printer-type attribute specifies printer type and
-capability bits for the printer or class. The default value is
-computed from internal state information and the PPD file for the
-printer. The following bits are defined:</p>
+<p>The "printer-type" status attribute specifies printer type and capability bits for the printer or class. The default value is computed from internal state information and the PPD file for the printer. The following bits are defined:</p>
-<div class='table'><table align='center' border='1' width='80%'
-summary='Printer Type Bits'>
+<div class='table'><table align='center' border='1' width='80%' summary='Printer Type Bits'>
<thead>
<tr>
<th>Bit</th>
<td>Is the a default printer on the network.</td>
</tr>
<tr>
- <td>0x00040000<td>
+ <td>0x00040000</td>
<td>Is a facsimile device.</td>
</tr>
<tr>
<td>0x00400000</td>
<td>Queue requires authentication.</td>
</tr>
+<tr>
+ <td>0x00800000</td>
+ <td>Queue supports CUPS command files.</td>
+</tr>
+<tr>
+ <td>0x01000000</td>
+ <td>Queue was automatically discovered and added.</td>
+</tr>
+<tr>
+ <td>0x02000000</td>
+ <td>Queue is a scanner with no printing capabilities.</td>
+</tr>
+<tr>
+ <td>0x04000000</td>
+ <td>Queue is a printer with scanning capabilities.</td>
+</tr>
+<tr>
+ <td>0x08000000</td>
+ <td>Queue is a printer with 3D capabilities.</td>
+</tr>
</tbody>
</table></div>
<h4>printer-type-mask (type2 enum)<span class='info'>CUPS 1.1</span></h4>
-<p>The printer-type-mask attribute is used to choose printers or classes with
-the CUPS-Get-Printers and CUPS-Get-Classes operations. The bits are defined
-identically to the printer-type attribute and default to all 1's.
+<p>The "printer-type-mask" attribute is used to choose printers or classes with the CUPS-Get-Printers and CUPS-Get-Classes operations. The bits are defined identically to the printer-type attribute and default to all 1's.
+</p>
+
+<h4>printer-wifi-password (octetString(MAX))</h4>
+
+<p>The optional "printer-wifi-password" description attribute provides the wireless network password for a printer.
+Printers must not return this attribute in the response to a Get-Printer-Attributes request.
+This attribute can only be set via an authenticated Set-Printer-Attributes request over a secure channel,
+or via an unauthenticated IPP USB connection when the printer is in its initial setup state.
+When a value for this attribute is not set, the 'wifi-not-configured-report' keyword must be present in the
+"printer-state-reasons" printer attribute values. If a printer supports this attribute, it must also support
+the "printer-wifi-ssid" and "printer-wifi-state" attributes.</p>
+
+<h4>printer-wifi-ssid (name(MAX))</h4>
+
+<p>The optional "printer-wifi-ssid" description attribute specifies the wireless network name for the printer.
+When set to the empty string, the printer must not join infrastructure or ad-hoc networks.
+This attribute can only be set via an authenticated Set-Printer-Attributes request over a secure channel,
+or via an unauthenticated IPP USB connection when the printer is in its initial setup state.
+This attribute also must reflect any configuration done by the user through the printer's web interface,
+control panel, or other interface. When a value for this attribute is not set, the 'wifi-not-configured-report'
+keyword must be present in the "printer-state-reasons" printer attribute values.
+If a printer supports this attribute, it must also support the "printer-wifi-password" and
+"printer-wifi-state" attributes.</p>
+
+<p>Printers that support the Set-Printer-Attribtes operation and "printer-wifi-password" and "printer-wifi-ssid"
+printer description attributes must also support unauthenticated Set-Printer-Attributes requests over USB when Wi-Fi
+networking has not yet been configured. This allows a client to configure the Wi-Fi networking of a printer over USB.</p>
+
+<p>When configuring a wireless network, clients must send both the "printer-wifi-ssid" and "printer-wifi-password"
+printer description attributes. If only one attribute is supplied, the printer must reject the request with the
+client-error-bad-request status code. If either attribute is supplied with an invalid value,
+the printer must reject the request with the client-error-attributes-or-values-not-supported status code.</p>
+
+In addition to other defined printer-state-reasons, the 'wifi-not-configured-report' reason is returned when the
+"printer-wifi-password" and "printer-wifi-ssid" printer description attributes are not set,
+regardless of the value of the "printer-wifi-state" printer status attribute.
+
+<h4>printer-wifi-state (type2 enum)</h4>
+
+<p>The optional "printer-wifi-state" status attribute specifies a printer's current wireless network state as
+an enumerated value. The following values are currently defined:</p>
+
+<div class='table'><table align='center' border='1' width='80%' summary='Wireless Networking State'>
+<tbody>
+<tr>
+ <td>3</td>
+ <td>(off) wireless networking is turned off</td>
+</tr>
+<tr>
+ <td>4</td>
+ <td>(not-configured) wireless networking is not yet configured</td>
+</tr>
+<tr>
+ <td>5</td>
+ <td>(not-visible) the configured wireless network is not visible</td>
+</tr>
+<tr>
+ <td>6</td>
+ <td>(cannot-join) unable to join the configured wireless network</td>
+</tr>
+<tr>
+ <td>7</td>
+ <td>(joining) joining the configured wireless network</td>
+</tr>
+<tr>
+ <td>8</td>
+ <td>(on) joined to the configured wireless network</td>
+</tr>
+</tbody>
+</table></div>
<h4>requesting-user-name-allowed (1setof name(127))<span class='info'>CUPS 1.1</span></h4>
-<p>The requesting-user-name-allowed attribute lists all of the users that are
-allowed to access a printer or class. Either this attribute or the
-requesting-user-name-denied attribute will be defined, but not both.
+<p>The "requesting-user-name-allowed" attribute lists all of the users that are allowed to access a printer or class. Either this attribute or the "requesting-user-name-denied" attribute will be defined, but not both.
<h4>requesting-user-name-denied (1setof name(127))<span class='info'>CUPS 1.1</span></h4>
-<p>The requesting-user-name-denied attribute lists all of the users that are
-not allowed to access a printer or class. Either this attribute or the
-requesting-user-name-allowed attribute will be defined, but not both.
+<p>The "requesting-user-name-denied" attribute lists all of the users that are not allowed to access a printer or class. Either this attribute or the "requesting-user-name-allowed" attribute will be defined, but not both.
<h3 class='title'><a name='CLASS_ATTRIBUTES'>Printer Class Attributes</a></h3>
+<p>Printer class attributes are placed in the printer-attributes-tag group.</p>
+
<h4>member-names (1setof name(127))</h4>
-<p>The member-names attribute specifies each of the printer-name attributes of
-the member printers and classes. Each name corresponds to the same element of
-the member-uris attribute.
+<p>The "member-names" attribute specifies the "printer-name" attributes for each the member printer and class. Each name corresponds to the same element of the "member-uris" attribute.
<h4>member-uris (1setof uri)</h4>
-<p>The member-uris attribute specifies each of the printer-uri attributes of
-the member printers and classes. Each URI corresponds to the same element of
-the member-names attribute.
+<p>The "member-uris" attribute specifies the "printer-uri-supported" values for each member printer and class. Each URI corresponds to the same element of the "member-names" attribute.
</body>
</html>
projects / thirdparty / cups.git / blobdiff