]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - doc/help/spec-ipp.html
Merge changes from CUPS 1.4svn-r7874.
[thirdparty/cups.git] / doc / help / spec-ipp.html
index 704e967bab2e40631bffb762e9929f7551657aed..74df07290baa423979c3a7af030885f19acb0319 100644 (file)
 
   CUPS IPP specification for the Common UNIX Printing System (CUPS).
 
-  Copyright 2007 by Apple Inc.
+  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/".
 -->
 
 <h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2>
@@ -1571,6 +1561,12 @@ CUPS-Get-Devices request:
        <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.
+
        <dt>"limit" (integer (1:MAX)):
 
        <dd>The client OPTIONALLY supplies this attribute limiting the number of
@@ -1583,6 +1579,11 @@ CUPS-Get-Devices request:
        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>
@@ -2032,9 +2033,14 @@ 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>
+
+<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".
@@ -2097,7 +2103,7 @@ of the device-class attribute:
 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
@@ -2106,6 +2112,13 @@ 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></h4>
 
 <p>The columns attribute specifies the number of columns to generate when
@@ -2128,7 +2141,7 @@ are present in the job.
 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
@@ -2136,13 +2149,27 @@ 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>".
+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><a name="hue">hue (integer(-180:180))</a></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.
 
+<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
@@ -2333,13 +2360,20 @@ per inch. The default value is the resolution included with the file or
 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
@@ -2459,6 +2493,107 @@ the system.
 <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>
+
+<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></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>
+
+<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-message">marker-message (text(MAX))</a></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></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>
+
+<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
@@ -2468,6 +2603,12 @@ to this printer. The default port monitor is "none".
 
 <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