Load cups into easysw/current.

[thirdparty/cups.git] / doc / help / spec-ppd.html
diff --git a/doc/help/spec-ppd.html b/doc/help/spec-ppd.html

index 6dc27cb6b6513e1131f9f220e2f9e9d7770e58cb..51c35b925fa5654addf91358124875d0bdc93ac4 100644 (file)
--- a/doc/help/spec-ppd.html
+++ b/doc/help/spec-ppd.html
@@ -8,7 +8,7 @@
  </head>
  <body>
  <!--
-  "$Id: spec-ppd.html 5138 2006-02-21 10:49:06Z mike $"
+  "$Id: spec-ppd.html 5190 2006-02-27 02:42:07Z mike $"
  
    CUPS PPD extensions specification for the Common UNIX Printing System (CUPS).
  
@@ -224,6 +224,31 @@ PPD file extensions was used. Currently it must be the string
  *cupsVersion: "1.2"
  </pre>
  
+<h3>ippReason</h3>
+
+<p class='summary'>*ippReason reason/Reason Text: "optional URL"</p>
+
+<p>This optional attribute maps custom
+<code>printer-state-reasons</code> keywords that are generated by
+the driver to human readable text. The optional URL string is a
+CUPS server absolute path to a help file under the scheduler's
+<code>DocumentRoot</code> directory or a full URL
+("http://www.domain.com/path/to/help/page.html") which directs
+the user at additional information concerning the condition that
+is being reported.</p>
+
+<p>Examples:</p>
+
+<pre class='command'>
+<em>*% Map com.vendor-error to text but no page</em>
+*ippReason com.vendor-error/A serious error occurred: ""
+
+<em>*% Map com.vendor-error to text and a local page</em>
+*ippReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html"
+
+<em>*% Map com.vendor-error to text and a remote page</em>
+*ippReason com.vendor-error/A serious error occurred: "http://www.vendor.com/help"
+</pre>
  
  <h2 class='title'><a name='OPTIONS'>Custom Options</a></h2>
  
@@ -255,14 +280,6 @@ PostScript command string is
  option value is "2.0" then CUPS will output the string
  "2.0 &lt;&lt;/cupsReal1 2 1 roll&gt;&gt;setpagedevice".</p>
  
-<blockquote><b>Note:</b> Currently only CustomPageSize supports
-more than 1 parameter. This restriction is due to value encoding
-issues, since the "Custom.value" format does not allow for
-specification of named parameters. We anticipate supporting the
-collection value format "{Name1=foo Name2=bar}" for the final
-CUPS 1.2 release. In addition, the collection value format will
-allow string values to contain spaces.</blockquote>
-
  <p>The "type" is one of the following keywords:</p>
  
  <ul>
@@ -530,6 +547,11 @@ in the PPD file for a given locale.</blockquote>
  *fr_FR.Translation ModelName/La Foobar Laser 9999: ""
  *de_DE.Translation ModelName/Foobar LaserDrucken 9999: ""
  
+*ippReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html"
+<em>*% Localize printer-state-reason for French and German</em>
+*fr_FR.ippReason com.vendor-error/Une erreur s&egrave;rieuse s'est produite: "/help/com.vendor/error.html"
+*de_DE.ippReason com.vendor-error/Eine ernste St&ouml;rung trat: "/help/com.vendor/error.html"
+
  ...
  
  *OpenUI *InputSlot/Paper Source: PickOne
@@ -568,6 +590,8 @@ in the PPD file for a given locale.</blockquote>
  
         <li>Added <tt>cupsPortMonitor</tt> attribute</li>
  
+       <li>Added <tt>ippReason</tt> attribute</li>
+
         <li>Removed <tt>cupsProtocol</tt> attribute</li>
  
  </ul>