-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<!-- SECTION: Programming -->
+<!-- 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>
<!--
CUPS IPP specification for the Common UNIX Printing System (CUPS).
- Copyright 1997-2006 by Easy Software Products.
+ Copyright 2007-2008 by Apple Inc.
+ Copyright 1997-2007 by Easy Software Products.
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:
-
- Attn: CUPS Licensing Information
- Easy Software Products
- 44141 Airport View Drive, Suite 204
- Hollywood, Maryland 20636 USA
-
- Voice: (301) 373-9600
- EMail: cups-info@cups.org
- WWW: http://www.cups.org
+ property of Apple Inc. 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
+ file is missing or damaged, see the license at "http://www.cups.org/".
-->
+<H1 CLASS="title">CUPS Implementation of IPP</H1>
+
<h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2>
-<p>CUPS 1.1 implements IPP/1.1 and the operations and attributes
+<p>CUPS 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>
-<p>CUPS also provides 13 new operations and many new attributes
+<p>CUPS also provides 16 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_OPERATIONS'>CUPS IPP Operations</a></h3>
-<p>CUPS provides 14 extension operations in addition to most of the
+<p>CUPS provides 16 extension operations in addition to most of the
standard IPP and registered extension operations:
<div class='table'><table align='center' border='1' width='80%'
<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>
<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>
</tbody>
</table></div>
<dl>
+ <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3</span>
+
+ <dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute.
+
<dt>"job-billing" (text(MAX)):<span class='info'>CUPS 1.1</span>
<dd>The client OPTIONALLY supplies a billing string that is logged
</dl>
+<p>Group 3: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
+
+<dl>
+
+ <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='CREATE_JOB'>Create-Job Operation</a></h3>
<p>The Create-Job operation (0x0005) creates a new, empty print job.
<dl>
+ <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3</span>
+
+ <dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute.
+
<dt>"job-billing" (text(MAX)):<span class='info'>CUPS 1.1</span>
<dd>The client OPTIONALLY supplies a billing string that is logged
</dl>
+<p>Group 3: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
+
+<dl>
+
+ <dt>auth-info-required (1setOf Type2 keyword)
+
+ <dd>The required authentication information.
+
+</dl>
+
+<h3 class='title'><a name='CANCEL_JOB'>Cancel Job Operation</a></h3>
+
+<p>The Cancel-Job operation (0x0008) cancels the specified job. CUPS 1.4 adds
+a new <tt>purge-job (boolean)</tt> attribute that allows you to purge both
+active and completed jobs, removing all history and document files for the
+job as well.
+
+<h4>Cancel-Job Request</h4>
+
+<p>The following groups of attributes are supplied as part of the
+Set-Job-Attributes request:
+
+<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.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.
+
+ <dt><span class="info">CUPS 1.4</span>"purge-job" (boolean):
+
+ <dd>The client OPTIONALLY supplies this attribute. When true,
+ all job files (history and document) are purged. The default
+ is false, leading to the standard IPP behavior.
+
+</dl>
+
+<h4>Cancel-Job Response</h4>
+
+<p>The following groups of attributes are send as part of the Cancel-Job
+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>
+
+<h3 class='title'><a name='PURGE_JOBS'>Purge-Jobs Operation</a></h3>
+
+<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.
+
+<h4>Purge-Jobs Request</h4>
+
+<p>The following groups of attributes are supplied as part of the
+Purge-Jobs request:
+
+<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.1 of the IPP Model and
+ Semantics document.
+
+ <dt>"printer-uri" (uri):
+
+ <dd>The client MUST supply a URI for the specified printer or
+ "ipp://.../printers" for all printers and classes.
+
+ <dt><span class="info">CUPS 1.2</span>"purge-jobs" (boolean):
+
+ <dd>The client OPTIONALLY supplies this attribute to specify
+ whether the jobs are purged (true) or just canceled (false).
+ The default is true.
+
+</dl>
+
+<h4>Purge-Jobs Response</h4>
+
+<p>The following groups of attributes are send as part of the Purge-Jobs
+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>
+
<h3 class='title'><span class='info'>CUPS 1.1</span><a name='SET_JOB_ATTRIBUTES'>Set-Job-Attributes Operation</a></h3>
<p>The Set-Job-Attributes operation (0x0014) changes the attributes of
provides several additional events in addition to the standard
events in the IPP notifications specification.</p>
-<h4> Request</h4>
+<h4>Create-Printer-Subscription Request</h4>
<p>The following groups of attributes are supplied as part of the
request:</p>
</dl>
-<h4> Response</h4>
+<h4>Create-Printer-Subscription Response</h4>
<p>The following groups of attributes are send as part of the
response:</p>
attributes as described in section 3.1.4.1 of the IPP Model and
Semantics document.
+ <dt>"first-printer-name" (name(127)):<span class='info'>CUPS 1.2</span>
+
+ <dd>The client OPTIONALLY supplies this attribute to
+ select the first printer that is returned.
+
<dt>"limit" (integer (1:MAX)):
<dd>The client OPTIONALLY supplies this attribute limiting the
number of printers that are returned.
- <dt>"printer-info" (text(127)):<span class='info'>CUPS 1.1</span>
-
- <dd>The client OPTIONALLY supplies this attribute to
- select which printers are returned.
-
<dt>"printer-location" (text(127)): <span class='info'>CUPS 1.1.7</span>
<dd>The client OPTIONALLY supplies this attribute to
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</span>
+
+ <dd>The client OPTIONALLY supplies a user name that is used to filter
+ the returned printers.
+
</dl>
<h4>CUPS-Get-Printers Response</h4>
<dl>
+ <dt>"auth-info-required" (1setOf type2 keyword):<span class='info'>CUPS 1.3</span>
+
+ <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
+
<dt>"job-sheets-default" (1setOf name(127)): <span
class='info'>CUPS 1.1.7</span>
<dd>The client OPTIONALLY supplies a device URI for the
specified printer.
+ <dt>"port-monitor" (name(127)):
+
+ <dd>The client OPTIONALLY supplies a port monitor name for the
+ specified printer.
+
<dt>"ppd-name" (name(127)):
<dd>The client OPTIONALLY supplies a PPD name for the specified
attributes as described in section 3.1.4.1 of the IPP Model and
Semantics document.
+ <dt>"first-printer-name" (name(127)):<span class='info'>CUPS 1.2</span>
+
+ <dd>The client OPTIONALLY supplies this attribute to
+ select the first printer that is returned.
+
<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.
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</span>
+
+ <dd>The client OPTIONALLY supplies a user name that is used to filter
+ the returned printers.
+
</dl>
<h4>CUPS-Get-Classes Response</h4>
<dl>
+ <dt>"auth-info-required" (1setOf type2 keyword):<span class='info'>CUPS 1.3</span>
+
+ <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
+
<dt>"member-uris" (1setof uri):
<dd>The client OPTIONALLY supplies the "member-uris" set
<dd>The client OPTIONALLY supplies a device class keyword to select
which devices are returned.
+ <dt>"exclude-schemes" (1setOf name) :<span class='info'>CUPS 1.4</span>
+
+ <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.
+
+ <dt>"include-schemes" (1setOf name) :<span class='info'>CUPS 1.4</span>
+
+ <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.
+
<dt>"limit" (integer (1:MAX)):
<dd>The client OPTIONALLY supplies this attribute limiting the number of
the client omits this attribute, the server responds as if this
attribute had been supplied with a value of 'all'.
+ <dt>"timeout" (integer (1:MAX)) :<span class='info'>CUPS 1.4</span>
+
+ <dd>The client OPTIONALLY supplies this attribute limiting the number of
+ devices that are returned.
+
</dl>
<h4>CUPS-Get-Devices Response</h4>
attributes as described in section 3.1.4.1 of the IPP Model and
Semantics document.
+ <dt>"exclude-schemes" (1setOf name) :<span class='info'>CUPS 1.4</span>
+
+ <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.
+
+ <dt>"include-schemes" (1setOf name) :<span class='info'>CUPS 1.4</span>
+
+ <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.
+
<dt>"limit" (integer (1:MAX)):
- <dd>The client OPTIONALLY supplies this attribute limiting the number of
- PPDs that are returned.
+ <dd>The client OPTIONALLY supplies this attribute limiting the number of PPDs that are returned.
<dt>"ppd-make" (text(127)):
- <dd>The client OPTIONALLY supplies a printer manufacturer to select
- which PPDs are returned.
+ <dd>The client OPTIONALLY supplies a printer manufacturer to select which PPDs are returned.
+
+ <dt>"ppd-make-and-model" (text(127)):<span class='info'>CUPS 1.3</span>
+
+ <dd>The client OPTIONALLY supplies a make and model to select which PPDs are returned.
+
+ <dt>"ppd-model-number" (integer):<span class='info'>CUPS 1.3</span>
+
+ <dd>The client OPTIONALLY supplies a model number to select which PPDs are returned.
+
+ <dt>"ppd-natural-language" (naturalLanguage):<span class='info'>CUPS 1.3</span>
+
+ <dd>The client OPTIONALLY supplies a language to select which PPDs are returned.
+
+ <dt>"ppd-product" (text(127)):<span class='info'>CUPS 1.3</span>
+
+ <dd>The client OPTIONALLY supplies a PostScript product string to select which PPDs are returned.
+
+ <dt>"ppd-psversion" (text(127)):<span class='info'>CUPS 1.3</span>
+
+ <dd>The client OPTIONALLY supplies a PostScript version string to select which PPDs are returned.
+
+ <dt>"ppd-type" (type1 keyword):<span class='info'>CUPS 1.3</span>
+
+ <dd>The client OPTIONALLY supplies a driver type to select which PPDs are returned.
<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'. Specify "ppd-make" to get a list of manufacturers.
</dl>
<h3 class='title'><span class='info'>CUPS 1.2</span><a name='CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job Operation</a></h3>
-<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>
+<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-Authenticate-Job Request</h4>
</dl>
+<p>Group 2: Job Attributes
+
+<dl>
+
+ <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3</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</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
</dl>
+<p>Group 2: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
+
+<dl>
+
+ <dt>auth-info-required (1setOf Type2 keyword)
+
+ <dd>The required authentication information.
+
+</dl>
+
+<h3 class='title'><span class='info'>CUPS 1.3</span><a name='CUPS_GET_PPD'>CUPS-Get-PPD Operation</a></h3>
+
+<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>If the PPD file is found, <tt>successful-ok</tt> is returned with
+the PPD file following the response data.</p>
+
+<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>
+
+<p>If the PPD file does not exist, <tt>client-error-not-found</tt> is
+returned.</p>
+
+<h4>CUPS-Get-PPD Request</h4>
+
+<p>The following group of attributes is supplied as part of the
+CUPS-Get-PPD request:
+
+<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.1 of the IPP Model and
+ Semantics document.
+
+ <dt>"printer-uri" (uri)
+ <br><i>OR</i>
+ <br>"ppd-name" (name(255)):
+
+ <dd>The client MUST supply a printer URI or PPD name.
+
+</dl>
+
+<h4>CUPS-Get-PPD Response</h4>
+
+<p>The following group of attributes is sent as part of the
+CUPS-Get-PPD 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.
+
+ <dt>"printer-uri" (uri):
+
+ <dd>The printer that provides the actual PPD file when
+ the status code is cups-see-other (0x280)
+
+</dl>
+
+<p>If the status code is <tt>successful-ok</tt>, the PPD file follows
+the end of the IPP response.</p>
+
+<h3 class='title'><span class='info'>CUPS 1.4</span><a name='CUPS_GET_DOCUMENT'>CUPS-Get-Document Operation</a></h3>
+
+<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>
+
+<p>If the document file is found, <tt>successful-ok</tt> is returned with
+the document file following the response data.</p>
+
+<p>If the document file does not exist, <tt>client-error-not-found</tt> is
+returned.</p>
+
+<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 group of attributes is supplied as part of the
+CUPS-Get-Document request:
+
+<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.1 of the IPP Model and
+ Semantics document.
+
+ <dt>"printer-uri" (uri) and "job-id" (integer)
+ <br><i>OR</i>
+ <br>"job-uri" (uri):
+
+ <dd>The client MUST supply a printer URI and job ID or job URI.
+
+ <dt>"document-number" (integer(1:MAX)):
+
+ <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-Document Response</h4>
+
+<p>The following group of attributes is sent as part of the
+CUPS-Get-Document 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.
+
+ <dt>"document-format" (mimeType):
+
+ <dd>The format of the document file.
+
+ <dt>"document-number" (integer(1:MAX)):
+
+ <dd>The requested document number.
+
+ <dt>"document-name" (name(MAX)):
+
+ <dd>The name that was supplied with the document, if any.
+
+</dl>
+
+<p>If the status code is <tt>successful-ok</tt>, the document file follows
+the end of the IPP response.</p>
+
+
<h2 class='title'><a name='ATTRIBUTES'>Attributes</a></h2>
<p>CUPS provides many extension attributes to support multiple
operation and enumerate all of the available hardware devices and
network protocols that are supported by the server.</p>
-<h4>device-class (type2 keyword)</h4>
+<h4><a name="device-class">device-class (type2 keyword)</a></h4>
<p>The device-class attribute specifies the class of device and can be
one of the following:
</ul>
-<h4>device-id (text(127))</h4>
+<h4><a name="device-id">device-id (text(127))</a><span class="info">CUPS 1.2</span></h4>
<p>The device-id attribute specifies the IEEE-1284 device ID
string for the device.</p>
-<h4>device-info (text(127))</h4>
+<h4><a name="device-info">device-info (text(127))</a></h4>
<p>The device-info attribute specifies a human-readable string describing
the device, e.g. "Parallel Port #1".
-<h4>device-make-and-model (text(127))</h4>
+<h4><a name="device-location">device-location (text(127))</a><span class="info">CUPS 1.4</span></h4>
-<p>The device-makr-and-model attribute specifies a device
+<p>The device-location attribute specifies the physical location of the
+printer.
+
+<h4><a name="device-make-and-model">device-make-and-model (text(127))</a></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".
-<h4>device-uri (uri)</h4>
+<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
<h3 class='title'><a name='JOB_TEMPLATE_ATTRIBUTES'>Job Template Attributes</a></h3>
-<h4>blackplot (boolean)</h4>
+<h4><a name="auth-info">auth-info (1setOf text(MAX))</a><span class="info">CUPS 1.3</span></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.
+
+<h4><a name="blackplot">blackplot (boolean)</a></h4>
<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>brightness (integer(0:200))</h4>
+<h4><a name="brightness">brightness (integer(0:200))</a><span class="info">Deprecated</span></h4>
<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
<p>Brightness is applied to the Cyan, Magenta, Yellow, and Black values using
the function "f(x) = brightness / 100 * x".
-<h4>columns (integer(1:4))</h4>
+<blockquote><b>Note:</b>
+
+<p>This attribute is deprecated and will be removed from a future CUPS
+release.</p>
+
+</blockquote>
+
+<h4><a name="columns">columns (integer(1:4))</a> <span class='info'>Deprecated</span></h4>
<p>The columns attribute specifies the number of columns to generate when
printing text files. The default value is 1.
-<h4>cpi (type2 enum)</h4>
+<h4><a name="cpi">cpi (type2 enum)</a></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.
-<h4>fitplot (boolean)</h4>
+<h4><a name="document-count">document-count (integer(1:MAX))</a></h4>
+
+<p>The document-count attribute specifies the number of documents that
+are present in the job.
+
+<h4><a name="fit-to-page">fit-to-page (boolean)</a><span class="info">CUPS 1.4</span></h4>
+
+<p>The fit-to-page attribute specifies whether to scale documents to fit on the
+selected media (fit-to-page=true) or use the physical size specified in the
+document (fit-to-page=false). The default value is false.
+
+<h4><a name="fitplot">fitplot (boolean)</a><span class="info">Deprecated</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.
-<h4>gamma (integer(1:10000))</h4>
+<h4><a name="gamma">gamma (integer(1:10000))</a><span class="info">Deprecated</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
1000.
<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>".
+grayscale output) using the function "f(x) = x<sup>(1000/gamma)</sup>".
+
+<blockquote><b>Note:</b>
+
+<p>This attribute is deprecated and will be removed from a future CUPS
+release.</p>
-<h4>hue (integer(-180:180))</h4>
+</blockquote>
+
+<h4><a name="hue">hue (integer(-180:180))</a><span class="info">Deprecated</span></h4>
<p>The hue attribute specifies a color hue rotation when printing image
files. The default value is 0.
-<h4>job-billing (text(MAX))<span class='info'>CUPS 1.1</span></h4>
+<blockquote><b>Note:</b>
+
+<p>This attribute is deprecated and will be removed from a future CUPS
+release.</p>
+
+</blockquote>
+
+<h4><a name="job-billing">job-billing (text(MAX))</a><span class='info'>CUPS 1.1</span></h4>
<p>The job-billing attribute provides a text value to associate with a job
for billing purposes.
-<h4>job-hold-until (keyword | name(MAX))<span class='info'>CUPS 1.1</span></h4>
+<h4><a name="job-hold-until">job-hold-until (keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></h4>
<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
+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>job-sheets (1setof type3 keyword | name(MAX))<span class='info'>CUPS 1.1</span></h4>
+<h4><a name="job-media-progress">job-media-progress (integer(0:100))</a><span class='info'>CUPS 1.4</span></h4>
+
+<p>The job-media-progress attribute specifies the percentage of completion of
+the current page. It is only valid when the job-state attribute has the
+"processing" value (5).</p>
+
+<h4><a name="job-printer-state-message">job-printer-state-message (text(MAX))</a><span class='info'>CUPS 1.3</span></h4>
+
+<p>The job-printer-state-message attribute provides the last known value of the printer-state-message attribute for the printer that processed (or is processing) the job.</p>
+
+<h4><a name="job-printer-state-reasons">job-printer-state-reasons (1setOf type2 keyword)</a><span class='info'>CUPS 1.3</span></h4>
+
+<p>The job-printer-state-reasons attribute provides the last known value of the printer-state-reasons attribute for the printer that processed (or is processing) the job.</p>
+
+<h4><a name="job-sheets">job-sheets (1setof type3 keyword | name(MAX))</a><span class='info'>CUPS 1.1</span></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.
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-originating-host-name (name(MAX))</h4>
+<h4><a name="job-originating-host-name">job-originating-host-name (name(MAX))</a></h4>
<p><i>(CUPS 1.1.5 and higher)</i>
<p>This attribute is read-only.
-<h4>lpi (type2 enum)</h4>
+<h4><a name="lpi">lpi (type2 enum)</a></h4>
<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>mirror (boolean)</h4>
+<h4><a name="mirror">mirror (boolean)</a></h4>
<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.
-<h4>natural-scaling (integer(1:1000))<span class='info'>CUPS 1.1.9</span></h4>
+<h4><a name="natural-scaling">natural-scaling (integer(1:1000))</a><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
<p>The ppi option can be used to override the natural resolution of the
image, which controls the natural size.
-<h4>number-up-layout (type2 keyword)<span class='info'>CUPS 1.1.15</span></h4>
+<h4><a name="number-up-layout">number-up-layout (type2 keyword)</a><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:
</ul>
-<h4>page-border (type2 keyword)<span class='info'>CUPS 1.1.15</span></h4>
+<h4><a name="page-border">page-border (type2 keyword)</a><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:
</ul>
-<h4>page-bottom (integer(0:MAX))</h4>
+<h4><a name="page-bottom">page-bottom (integer(0:MAX))</a></h4>
<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>page-label (text(MAX))<span class='info'>CUPS 1.1.7</span></h4>
+<h4><a name="page-label">page-label (text(MAX))</a><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.
-<h4>page-left (integer(0:MAX))</h4>
+<h4><a name="page-left">page-left (integer(0:MAX))</a></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.
-<h4>page-right (integer(0:MAX))</h4>
+<h4><a name="page-right">page-right (integer(0:MAX))</a></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.
-<h4>page-set (type2 keyword)</h4>
+<h4><a name="page-set">page-set (type2 keyword)</a></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".
-<h4>page-top (integer(0:MAX))</h4>
+<h4><a name="page-top">page-top (integer(0:MAX))</a></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.
-<h4>penwidth (integer(0:MAX))</h4>
+<h4><a name="penwidth">penwidth (integer(0:MAX))</a></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).
-<h4>position (type2 keyword)</h4>
+<h4><a name="position">position (type2 keyword)</a></h4>
<p>The position attribute specifies the location of image files on the
media. The following keyword values are recognized:
</ul>
-<h4>ppi (integer(1:MAX))</h4>
+<h4><a name="ppi">ppi (integer(1:MAX))</a></h4>
<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.
-<h4>prettyprint (boolean)</h4>
+<h4><a name="prettyprint">prettyprint (boolean)</a></h4>
<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.
-<h4>saturation (integer(0:200))</h4>
+<h4><a name="saturation">saturation (integer(0:200))</a><span class="info">Deprecated</span></h4>
<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.
-<h4>scaling (integer(1:1000))</h4>
+<blockquote><b>Note:</b>
+
+<p>This attribute is deprecated and will be removed from a future CUPS
+release.</p>
+
+</blockquote>
+
+<h4><a name="scaling">scaling (integer(1:1000))</a></h4>
<p>The scaling attribute specifies the scaling of image files with
respect to the selected media. A value of 100 specifies that the image
<p>The scaling attribute overrides the ppi attribute if specified.
-<h4>wrap (boolean)</h4>
+<h4><a name="wrap">wrap (boolean)</a></h4>
<p>The wrap attribute specifies whether long lines should be wrapped
(wrap=true) or not (wrap=false) when printing text files. The default
<h3 class='title'><a name='PPD_ATTRIBUTES'>PPD Attributes</a></h3>
-<h4>ppd-device-id (text(127))</h4>
+<h4><a name="ppd-device-id">ppd-device-id (text(127))</a></h4>
<p>The ppd-device-id attribute specifies the IEEE-1284 device ID
string for the device described by the PPD file.</p>
-<h4>ppd-natural-language (naturalLanguage)</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>ppd-make (text(127))</h4>
+<h4><a name="ppd-make">ppd-make (text(127))</a></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>ppd-make-and-model (text(127))</h4>
+<h4><a name="ppd-make-and-model">ppd-make-and-model (text(127))</a></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>ppd-name (name(255))</h4>
+<h4><a name="ppd-model-number">ppd-model-number (integer)</a><span class="info">CUPS 1.3</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></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></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></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">CUPS 1.3</span></h4>
+
+<p>The ppd-product attribute specifies the PSVersion attribute values in the PPD file.
+
+<h4><a name="ppd-type">ppd-type (type1 keyword)</a><span class="info">CUPS 1.3</span></h4>
+
+<p>The ppd-type attribute specifies the type of driver described by the PPD file:</p>
+
+<ul>
+
+ <li><tt>fax</tt> - A facsimile or multi-function device</li>
+
+ <li><tt>pdf</tt> - A PDF printer</li>
+
+ <li><tt>postscript</tt> - A PostScript printer (no filters)</li>
+
+ <li><tt>raster</tt> - A CUPS raster driver</li>
+
+ <li><tt>unknown</tt> - An unknown or hybrid driver</li>
+
+</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.
<h3 class='title'><a name='PRINTER_ATTRIBUTES'>Printer Attributes</a></h3>
-<h4>job-k-limit (integer)<span class='info'>CUPS 1.1</span></h4>
+<h4><a name="auth-info-required">auth-info-required (1setOf type2 keyword)</a><span class="info">CUPS 1.3</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><tt>domain</tt> - A domain name is required.</li>
+
+ <li><tt>none</tt> - No authentication is required - this keyword can only appear by itself.</li>
+
+ <li><tt>password</tt> - A password is required.</li>
+
+ <li><tt>username</tt> - A username is required.</li>
+
+</ul>
+
+<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>job-page-limit (integer)<span class='info'>CUPS 1.1</span></h4>
+<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.
-<h4>job-quota-period (integer)<span class='info'>CUPS 1.1</span></h4>
+<h4><a name="job-quota-period">job-quota-period (integer)</a><span class='info'>CUPS 1.1</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.
-<h4>job-sheets-supported (1setof type3 keyword | name(MAX))<span class='info'>CUPS 1.1</span></h4>
+<h4><a name="job-sheets-supported">job-sheets-supported (1setof type3 keyword | name(MAX))</a><span class='info'>CUPS 1.1</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".
-<h4>printer-type (type2 enum)</h4>
+<h4><a name="marker-change-time">marker-change-time (integer)</a><span class='info'>CUPS 1.3</span></h4>
+
+<p>The marker-change-time 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><a name="marker-colors">marker-colors (1setof name(MAX))</a><span class='info'>CUPS 1.3</span></h4>
+
+<p>The marker-colors 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><a name="marker-high-levels">marker-high-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4</span></h4>
+
+<p>The marker-high-levels 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><a name="marker-levels">marker-levels (1setof integer(-1:100))</a><span class='info'>CUPS 1.3</span></h4>
+
+<p>The marker-levels 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 unknown, while values from 0 to 100
+indicate the corresponding percentage.</p>
+
+<h4><a name="marker-low-levels">marker-low-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4</span></h4>
+
+<p>The marker-low-levels 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><a name="marker-message">marker-message (text(MAX))</a><span class='info'>CUPS 1.4</span></h4>
+
+<p>The marker-message 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</span></h4>
+
+<p>The marker-names 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</span></h4>
+
+<p>The marker-types 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><tt>toner</tt></li>
+
+ <li><tt>wasteToner</tt></li>
+
+ <li><tt>ink</tt></li>
+
+ <li><tt>inkCartridge</tt></li>
+
+ <li><tt>inkRibbon</tt></li>
+
+ <li><tt>wasteInk</tt></li>
+
+ <li><tt>opc</tt></li>
+
+ <li><tt>developer</tt></li>
+
+ <li><tt>fuserOil</tt></li>
+
+ <li><tt>solidWax</tt></li>
+
+ <li><tt>ribbonWax</tt></li>
+
+ <li><tt>wasteWax</tt></li>
+
+ <li><tt>fuser</tt></li>
+
+ <li><tt>coronaWire</tt></li>
+
+ <li><tt>fuserOilWick</tt></li>
+
+ <li><tt>cleanerUnit</tt></li>
+
+ <li><tt>fuserCleaningPad</tt></li>
+
+ <li><tt>transferUnit</tt></li>
+
+ <li><tt>tonerCartridge</tt></li>
+
+ <li><tt>fuserOiler</tt></li>
+
+ <li><tt>water</tt></li>
+
+ <li><tt>wasteWater</tt></li>
+
+ <li><tt>bindingSupply</tt></li>
+
+ <li><tt>bandingSupply</tt></li>
+
+ <li><tt>stichingWire</tt></li>
+
+ <li><tt>shrinkWrap</tt></li>
+
+ <li><tt>paperWrap</tt></li>
+
+ <li><tt>staples</tt></li>
+
+ <li><tt>inserts</tt></li>
+
+ <li><tt>covers</tt></li>
+
+</ul>
+
+<h4><a name="port-monitor">port-monitor" (name(127))</a></h4>
+
+<p>The port-monitor attribute specifies the port monitor to use when printing
+to this printer. The default port monitor is "none".
+
+<h4><a name="port-monitor-supported">port-monitor-supported" (1setOf name(127))</a></h4>
+
+<p>The port-monitor-supported attribute specifies the available port monitors.
+
+<h4><a name="printer-commands">printer-commands (1setOf Type3 keyword)</a><span class='info'>CUPS 1.4</span></h4>
+
+<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><a name="printer-dns-sd-name">printer-dns-sd-name (name(MAX) | noValue)</a><span class='info'>CUPS 1.4</span></h4>
+
+<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 noValue value.</p>
+
+<h4><a name="printer-state-reasons">printer-state-reasons (1setOf type2 keyword)</a></h4>
+
+<p>The printer-state-reasons attribute provides additional persistent state
+information for a printer. In addition to the keywords defined in RFC 2911,
+CUPS supports vendor-specific keywords with a domain prefix ("com.vendor.foo")
+and the following CUPS-specific keywords:</p>
+
+<ul>
+
+ <li><tt>cups-insecure-filter-warning</tt> - a filter or backend (or the
+ directory containing the filter or backend) has insecure file
+ permissions. CUPS will not execute programs with world write permissions
+ or setuid programs. When run as root (the default), CUPS also does not
+ execute programs that are not owned by root.
+ <span class='info'>CUPS 1.4</span></li>
+
+ <li><tt>cups-missing-filter-warning</tt> - a filter or backend is not
+ installed. <span class='info'>CUPS 1.4</span></li>
+
+</ul>
+
+<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
<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>
</tbody>
</table></div>
projects / thirdparty / cups.git / blobdiff