-<!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: 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>
<!--
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"
<dd>The required authentication information.
-</dl
+</dl>
<h3 class='title'><span class='info'>CUPS 1.1</span><a name='CREATE_JOB'>Create-Job Operation</a></h3>
<dd>The required authentication information.
-</dl
+</dl>
-<h3 class='title'><a name='CANCEL_JOB'>Set-Job-Attributes Operation</a></h3>
+<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
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>
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>
<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.
+ 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)):
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.
<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>
<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>
<dd>The required authentication information.
-</dl
+</dl>
<h3 class='title'><span class='info'>CUPS 1.3</span><a name='CUPS_GET_PPD'>CUPS-Get-PPD Operation</a></h3>
<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">CUPS 1.4</span></h4>
+
+<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-makr-and-model attribute specifies a device
+<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".
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="brightness">brightness (integer(0:200))</a></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><a name="columns">columns (integer(1:4))</a></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.
<p>The document-count attribute specifies the number of documents that
are present in the job.
-<h4><a name="fitplot">fitplot (boolean)</a></h4>
+<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><a name="gamma">gamma (integer(1:10000))</a></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>
-<h4><a name="hue">hue (integer(-180:180))</a></h4>
+<p>This attribute is deprecated and will be removed from a future CUPS
+release.</p>
+
+</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.
+<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
specified time is less than the current time, the job is held until the
next day.
+<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>
with a shaded header and keyword highlighting (prettyprint=true) or without
additional formatting (prettyprint=false). The default value is false.
-<h4><a name="saturation">saturation (integer(0:200))</a></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.
+<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
<p>The job-sheets-supported attribute specifies the available banner files.
There will always be at least one banner file available called "none".
-<h4><a name="marker-change-time">marker-change-time (integer)</a></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-names, or
-marker-types attributes was made.</p>
+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></h4>
+<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-levels">marker-levels (1setof integer(-1:100))</a></h4>
+<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-names">marker-names (1setof name(MAX))</a></h4>
+<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></h4>
+<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
<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
<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>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