<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$"
- CUPS IPP specification for the Common UNIX Printing System (CUPS).
+ CUPS IPP specification for CUPS.
- Copyright 2007-2008 by Apple Inc.
+ Copyright 2007-2013 by Apple Inc.
Copyright 1997-2007 by Easy Software Products.
These coded instructions, statements, and computer programs are the
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 implements IPP/1.1 and the operations and attributes
+<p>CUPS implements IPP/2.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"
<dl>
- <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3</span>
+ <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3/OS X 10.5</span>
<dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute.
<dl>
- <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3</span>
+ <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3/OS X 10.5</span>
<dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute.
<h4>Cancel-Job Request</h4>
<p>The following groups of attributes are supplied as part of the
-Set-Job-Attributes request:
+Cancel-Job request:
<p>Group 1: Operation Attributes
<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):
+ <dt><span class="info">CUPS 1.4/OS X 10.6</span>"purge-job" (boolean):
<dd>The client OPTIONALLY supplies this attribute. When true,
all job files (history and document) are purged. The default
<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):
+ <dt><span class="info">CUPS 1.2/OS X 10.5</span>"requesting-user-name" (name(MAX)):
+
+ <dd>The client OPTIONALLY supplies this attribute to specify whose jobs
+ jobs are purged or canceled.
+
+ <dt><span class="info">CUPS 1.2/OS X 10.5</span>"my-jobs" (boolean):
+
+ <dd>The client OPTIONALLY supplies this attribute to specify that only
+ the jobs owned by the requesting user are purged or canceled. The
+ default is false.
+
+ <dt><span class="info">CUPS 1.2/OS X 10.5</span>"purge-jobs" (boolean):
<dd>The client OPTIONALLY supplies this attribute to specify
whether the jobs are purged (true) or just canceled (false).
</dl>
-<h3 class='title'><span class='info'>CUPS 1.2</span><a
+<h3 class='title'><span class='info'>CUPS 1.2
/OS X 10.5</span><a
name='CREATE_PRINTER_SUBSCRIPTION'>Create-Printer-Subscription</a></h3>
<p>The Create-Printer-Subscription operation (0x0016) creates a
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>
+ <dt>"first-printer-name" (name(127)):<span class='info'>CUPS 1.2/OS X 10.5</span>
<dd>The client OPTIONALLY supplies this attribute to
select the first printer that is returned.
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>
+ <dt>"requested-user-name" (name(127)) : <span class='info'>CUPS 1.2/OS X 10.5</span>
<dd>The client OPTIONALLY supplies a user name that is used to filter
the returned printers.
<dl>
- <dt>"auth-info-required" (1setOf type2 keyword):<span class='info'>CUPS 1.3</span>
+ <dt>"auth-info-required" (1setOf type2 keyword):<span class='info'>CUPS 1.3/OS X 10.5</span>
<dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
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>
+ <dt>"first-printer-name" (name(127)):<span class='info'>CUPS 1.2/OS X 10.5</span>
<dd>The client OPTIONALLY supplies this attribute to
select the first printer that is 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>
+ <dt>"requested-user-name" (name(127)) : <span class='info'>CUPS 1.2/OS X 10.5</span>
<dd>The client OPTIONALLY supplies a user name that is used to filter
the returned printers.
<dl>
- <dt>"auth-info-required" (1setOf type2 keyword):<span class='info'>CUPS 1.3</span>
+ <dt>"auth-info-required" (1setOf type2 keyword):<span class='info'>CUPS 1.3/OS X 10.5</span>
<dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
<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>
+ <dt>"exclude-schemes" (1setOf name) :<span class='info'>CUPS 1.4/OS X 10.6</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>
+ <dt>"include-schemes" (1setOf name) :<span class='info'>CUPS 1.4/OS X 10.6</span>
<dd>The client OPTIONALLY supplies a set of scheme names that the
requestor wants to discover. If the client omits this attribute,
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>
+ <dt>"timeout" (integer (1:MAX)) :<span class='info'>CUPS 1.4/OS X 10.6</span>
- <dd>The client OPTIONALLY supplies this attribute limiting the number of
- devices that are returned.
+ <dd>The client OPTIONALLY supplies this attribute to limit the duration
+ of the lookup. The default timeout is 15 seconds.
</dl>
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>
+ <dt>"exclude-schemes" (1setOf name) :<span class='info'>CUPS 1.4/OS X 10.6</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>
+ <dt>"include-schemes" (1setOf name) :<span class='info'>CUPS 1.4/OS X 10.6</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
<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>
+ <dt>"ppd-make-and-model" (text(127)):<span class='info'>CUPS 1.3/OS X 10.5</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>
+ <dt>"ppd-model-number" (integer):<span class='info'>CUPS 1.3/OS X 10.5</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>
+ <dt>"ppd-natural-language" (naturalLanguage):<span class='info'>CUPS 1.3/OS X 10.5</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>
+ <dt>"ppd-product" (text(127)):<span class='info'>CUPS 1.3/OS X 10.5</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>
+ <dt>"ppd-psversion" (text(127)):<span class='info'>CUPS 1.3/OS X 10.5</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>
+ <dt>"ppd-type" (type1 keyword):<span class='info'>CUPS 1.3/OS X 10.5</span>
<dd>The client OPTIONALLY supplies a driver type to select which PPDs are returned.
<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
-to a different printer.</p>
+<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-Move-Job Request</h4>
attributes as described in section 3.1.4.1 of the IPP Model and
Semantics document.
+ <dt>"printer-uri" (uri)
+ <br><i>OR</i>
<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 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>
</dl>
-<h3 class='title'><span class='info'>CUPS 1.2</span><a name='CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job Operation</a></h3>
+<h3 class='title'><span class='info'>CUPS 1.2
/OS X 10.5</span><a name='CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job Operation</a></h3>
-<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>
- <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3</span>
+ <dt>"auth-info" (1setOf text(MAX)):<span class='info'>CUPS 1.3/OS X 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/OS X 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>
</dl>
-<h3 class='title'><span class='info'>CUPS 1.3</span><a name='CUPS_GET_PPD'>CUPS-Get-PPD Operation</a></h3>
+<h3 class='title'><span class='info'>CUPS 1.3
/OS X 10.5</span><a name='CUPS_GET_PPD'>CUPS-Get-PPD Operation</a></h3>
<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>
<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>
+<h3 class='title'><span class='info'>CUPS 1.4
/OS X 10.6</span><a name='CUPS_GET_DOCUMENT'>CUPS-Get-Document Operation</a></h3>
<p>The CUPS-Get-Document operation (0x4027) gets a document file from a
job on the server. The document file is specified using the
</ul>
-<h4><a name="device-id">device-id (text(127))</a><span class="info">CUPS 1.2</span></h4>
+<h4><a name="device-id">device-id (text(127))</a><span class="info">CUPS 1.2/OS X 10.5</span></h4>
<p>The device-id attribute specifies the IEEE-1284 device ID
string for the device.</p>
<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>
+<h4><a name="device-location">device-location (text(127))</a><span class="info">CUPS 1.4/OS X 10.6</span></h4>
<p>The device-location attribute specifies the physical location of the
printer.
<h3 class='title'><a name='JOB_TEMPLATE_ATTRIBUTES'>Job Template Attributes</a></h3>
-<h4><a name="auth-info">auth-info (1setOf text(MAX))</a><span class="info">CUPS 1.3</span></h4>
+<h4><a name="auth-info">auth-info (1setOf text(MAX))</a><span class="info">CUPS 1.3/OS X 10.5</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><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
-bright and 50 is half as bright. The default value is 100.
-
-<p>Brightness is applied to the Cyan, Magenta, Yellow, and Black values using
-the function "f(x) = brightness / 100 * x".
-
-<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><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><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>
+<h4><a name="fit-to-page">fit-to-page (boolean)</a><span class="info">CUPS 1.4/OS X 10.6</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><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
-generate lighter and darker output, respectively. The default value is
-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>".
-
-<blockquote><b>Note:</b>
-
-<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
for billing purposes.
+<h4><a name="job-cancel-after">job-cancel-after (integer(1:MAX))</a><span class='info'>CUPS 2.0</span></h4>
+
+<p>The job-cancel-after attribute provides the maximum number of seconds that are allowed for processing a job.</p>
+
<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
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>
+<h4><a name="job-media-progress">job-media-progress (integer(0:100))</a><span class='info'>CUPS 1.4/OS X 10.6</span></h4>
<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>
+<h4><a name="job-printer-state-message">job-printer-state-message (text(MAX))</a><span class='info'>CUPS 1.3/OS X 10.5</span></h4>
<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>
+<h4><a name="job-printer-state-reasons">job-printer-state-reasons (1setOf type2 keyword)</a><span class='info'>CUPS 1.3/OS X 10.5</span></h4>
<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>
their X axis, which is useful for printing transfer images on
special media. The default value is false.
-<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
-and 200 is twice the natural size. The default value is 100.
+<h4><a name="number-up-layout">number-up-layout (type2 keyword)</a><span class='info'>Deprecated/Introduced in CUPS 1.1.15</span></h4>
-<p>The ppi option can be used to override the natural resolution of the
-image, which controls the natural size.
-
-<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>
+<blockquote><b>Note:</b>
+
+<p>This attribute is deprecated in favor of the PWG presentation-direction-number-up attribute and will be removed in a future release.</p>
+
+</blockquote>
+
<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
</ul>
-<h4><a name="page-bottom">page-bottom (integer(0:MAX))</a></h4>
+<h4><a name="page-bottom">page-bottom (integer(0:MAX))</a><span class="info">Deprecated</span></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><a name="page-label">page-label (text(MAX))</a><span class='info'>CUPS 1.1.7</span></h4>
+<h4><a name="page-label">page-label (text(MAX))</a><span class='info'>Deprecated</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><a name="page-left">page-left (integer(0:MAX))</a></h4>
+<h4><a name="page-left">page-left (integer(0:MAX))</a><span class="info">Deprecated</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.
-<h4><a name="page-right">page-right (integer(0:MAX))</a></h4>
+<h4><a name="page-right">page-right (integer(0:MAX))</a><span class="info">Deprecated</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.
supported keywords are "all", "even", and "odd". The default value is
"all".
-<h4><a name="page-top">page-top (integer(0:MAX))</a></h4>
+<h4><a name="page-top">page-top (integer(0:MAX))</a><span class="info">Deprecated</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.
-<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><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>
-
- <li><CODE>center</CODE> - Center the image on the page (default)
-
- <li><CODE>top</CODE> - Print the image centered at the top of the page
-
- <li><CODE>left</CODE> - Print the image centered on the left of page
-
- <li><CODE>right</CODE> - Print the image centered on the right of the page
-
- <li><CODE>top-left</CODE> - Print the image at the top left corner of
- the page
-
- <li><CODE>top-right</CODE> - Print the image at the top right corner of
- the page
-
- <li><CODE>bottom</CODE> - Print the image centered at the bottom of
- the page
-
- <li><CODE>bottom-left</CODE> - Print the image at the bottom left
- corner of the page
-
- <li><CODE>bottom-right</CODE> - Print the image at the bottom right
- corner of the page
-
-</ul>
-
-<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><a name="prettyprint">prettyprint (boolean)</a></h4>
+<h4><a name="prettyprint">prettyprint (boolean)</a><span class="info">Deprecated</span></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><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
-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.
-
-<p>The scaling attribute overrides the ppi attribute if specified.
-
-<h4><a name="wrap">wrap (boolean)</a></h4>
+<h4><a name="wrap">wrap (boolean)</a><span class="info">Deprecated</span></h4>
<p>The wrap attribute specifies whether long lines should be wrapped
(wrap=true) or not (wrap=false) when printing text files. The default
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">CUPS 1.3</span></h4>
+<h4><a name="ppd-model-number">ppd-model-number (integer)</a><span class="info">CUPS 1.3/OS X 10.5</span></h4>
<p>The ppd-model-number attribute provides the <tt>cupsModelNumber</tt> value from the PPD file.
<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>
+<h4><a name="ppd-psversion">ppd-psversion (1setOf text(127))</a><span class="info">CUPS 1.3/OS X 10.5</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>
+<h4><a name="ppd-type">ppd-type (type1 keyword)</a><span class="info">CUPS 1.3/OS X 10.5</span></h4>
<p>The ppd-type attribute specifies the type of driver described by the PPD file:</p>
<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</span></h4>
+<h4><a name="auth-info-required">auth-info-required (1setOf type2 keyword)</a><span class="info">CUPS 1.3/OS X 10.5</span></h4>
<p>The auth-info-required attribute specifies the authentication information that is required for printing a job. The following keywords are recognized:</p>
<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><span class='info'>CUPS 1.3</span></h4>
+<h4><a name="marker-change-time">marker-change-time (integer)</a><span class='info'>CUPS 1.3/OS X 10.5</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>
+<h4><a name="marker-colors">marker-colors (1setof name(MAX))</a><span class='info'>CUPS 1.3/OS X 10.5</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>
+<h4><a name="marker-high-levels">marker-high-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4/OS X 10.6</span></h4>
<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>
+<h4><a name="marker-levels">marker-levels (1setof integer(-3:100))</a><span class='info'>CUPS 1.3/OS X 10.5</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>
+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><a name="marker-low-levels">marker-low-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4</span></h4>
+<h4><a name="marker-low-levels">marker-low-levels (1setof integer(0:100))</a><span class='info'>CUPS 1.4/OS X 10.6</span></h4>
<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>
+<h4><a name="marker-message">marker-message (text(MAX))</a><span class='info'>CUPS 1.4/OS X 10.6</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>
+<h4><a name="marker-names">marker-names (1setof name(MAX))</a><span class='info'>CUPS 1.3/OS X 10.5</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>
+<h4><a name="marker-types">marker-types (1setof type3 keyword)</a><span class='info'>CUPS 1.3/OS X 10.5</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>
+<h4><a name="printer-commands">printer-commands (1setOf Type3 keyword)</a><span class='info'>CUPS 1.4/OS X 10.6</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>
+<h4><a name="printer-dns-sd-name">printer-dns-sd-name (name(MAX) | noValue)</a><span class='info'>CUPS 1.4/OS X 10.6</span></h4>
<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/OS X 10.6</span></li>
+
+ <li><tt>cups-missing-filter-warning</tt> - a filter or backend is not
+ installed. <span class='info'>CUPS 1.4/OS X 10.6</span></li>
+
+</ul>
+
<h4><a name="printer-type">printer-type (type2 enum)</a></h4>
<p>The printer-type attribute specifies printer type and
<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