]> git.ipfire.org Git - thirdparty/cups.git/commitdiff
Update PPD documentation to include cupsPageSizeCategory (added in CUPS 1.4)
authormike <mike@7a7537e8-13f0-0310-91df-b6672ffda945>
Mon, 30 Apr 2012 20:59:09 +0000 (20:59 +0000)
committermike <mike@7a7537e8-13f0-0310-91df-b6672ffda945>
Mon, 30 Apr 2012 20:59:09 +0000 (20:59 +0000)
git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@10441 7a7537e8-13f0-0310-91df-b6672ffda945

doc/help/api-ppd.html
doc/help/spec-ppd.html
filter/spec-ppd.shtml

index d0162618232600a04ef8912c509d9c07ece1fe75..33b4077a8299387eb70d9931dd720a77faae6a0a 100644 (file)
@@ -434,7 +434,7 @@ conflicts.">ppdMarkOption</a></li>
        <li><a href="#ppdOpenFd" title="Read a PPD file into memory.">ppdOpenFd</a></li>
        <li><a href="#ppdOpenFile" title="Read a PPD file into memory.">ppdOpenFile</a></li>
        <li><a href="#ppdPageLength" title="Get the page length for the given size.">ppdPageLength</a></li>
-       <li><a href="#ppdPageSize" title="Get the page size record for the given size.">ppdPageSize</a></li>
+       <li><a href="#ppdPageSize" title="Get the page size record for the named size.">ppdPageSize</a></li>
        <li><a href="#ppdPageSizeLimits" title="Return the custom page size limits.">ppdPageSizeLimits</a></li>
        <li><a href="#ppdPageWidth" title="Get the page width for the given size.">ppdPageWidth</a></li>
        <li><a href="#ppdSetConformance" title="Set the conformance level for PPD files.">ppdSetConformance</a></li>
@@ -1486,7 +1486,7 @@ float ppdPageLength (<br>
 <h4 class="returnvalue">Return Value</h4>
 <p class="description">Length of page in points or 0.0</p>
 <h3 class="function"><a name="ppdPageSize">ppdPageSize</a></h3>
-<p class="description">Get the page size record for the given size.</p>
+<p class="description">Get the page size record for the named size.</p>
 <p class="code">
 <a href="#ppd_size_t">ppd_size_t</a> *ppdPageSize (<br>
 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
index 0688e47ae6c7b40effc2cf066e801f0a240d6702..0eb63ae89d903d876920623d31633bf1d7d24d32 100644 (file)
@@ -397,6 +397,7 @@ div.contents ul.subcontents li {
        <li><a href="#cupsMediaQualifier3">cupsMediaQualifier3</a></li>
        <li><a href="#cupsMinSize">cupsMinSize</a></li>
        <li><a href="#cupsMaxSize">cupsMaxSize</a></li>
+       <li><a href="#cupsPageSizeCategory">cupsPageSizeCategory</a></li>
 </ul></li>
 <li><a href="#ATTRIBUTES">General Attributes</a><ul class="subcontents">
        <li><a href="#cupsBackSide">cupsBackSide</a></li>
@@ -1398,6 +1399,21 @@ are used to identify options to use for matching.</p>
 </pre>
 
 
+<h3><span class='info'>CUPS 1.4/OS X 10.6</span><a name='cupsPageSizeCategory'>cupsPageSizeCategory</a></h3>
+
+<p class="summary">*cupsPageSizeCategory name/text: "name name2 ... nameN"</p>
+
+<p>This keyword lists related paper size names that should be grouped together in the Print or Page Setup dialogs. The "name" portion of the keyword specifies the root/default size for the grouping. On OS X the grouped paper sizes are shown in a submenu of the main paper size. When omitted, sizes with the same dimensions are automatically grouped together, for example "Letter" and "Letter.Borderless".</p>
+
+<p>Example:</p>
+
+<pre class="command">
+<em>*% Specify grouping of borderless/non-borderless sizes</em>
+*cupsPageSizeCategory Letter/US Letter: "Letter Letter.Borderless"
+*cupsPageSizeCategory A4/A4: "A4 A4.Borderless"
+</pre>
+
+
 <h2 class='title'><a name='ATTRIBUTES'>General Attributes</a></h2>
 
 <h3><span class='info'>CUPS 1.3/OS X 10.5</span><a name='cupsBackSide'>cupsBackSide</a></h3>
@@ -1776,6 +1792,7 @@ the output for a specific model of printer.</p>
 *cupsModelNumber: 1234
 </pre>
 
+
 <h3><span class='info'>CUPS 1.3/OS X 10.5</span><a name='cupsPJLCharset'>cupsPJLCharset</a></h3>
 
 <p class='summary'>*cupsPJLCharset: "ISO character set name"</p>
@@ -2236,6 +2253,8 @@ the device.</p>
 
 <ul>
 
+    <li>Added <a href="#cupsPageSizeCategory"><tt>cupsPageSizeCategory</tt></a> keyword (originally defined in CUPS 1.4).</li>
+
        <li>Added <a href="#cupsMaxCopies"><tt>cupsMaxCopies</tt></a> keyword.</li>
 
        <li>Documented <a href="#JCLToPDFInterpreter"><tt>JCLToPDFInterpreter</tt></a> keyword.</li>
index 1776027908cc180c2641ce312d87c99b24bbe11f..0f54d3785e4d54627679203e600376f340892993 100644 (file)
@@ -957,6 +957,21 @@ are used to identify options to use for matching.</p>
 </pre>
 
 
+<h3><span class='info'>CUPS 1.4/OS X 10.6</span><a name='cupsPageSizeCategory'>cupsPageSizeCategory</a></h3>
+
+<p class="summary">*cupsPageSizeCategory name/text: "name name2 ... nameN"</p>
+
+<p>This keyword lists related paper size names that should be grouped together in the Print or Page Setup dialogs. The "name" portion of the keyword specifies the root/default size for the grouping. On OS X the grouped paper sizes are shown in a submenu of the main paper size. When omitted, sizes with the same dimensions are automatically grouped together, for example "Letter" and "Letter.Borderless".</p>
+
+<p>Example:</p>
+
+<pre class="command">
+<em>*% Specify grouping of borderless/non-borderless sizes</em>
+*cupsPageSizeCategory Letter/US Letter: "Letter Letter.Borderless"
+*cupsPageSizeCategory A4/A4: "A4 A4.Borderless"
+</pre>
+
+
 <h2 class='title'><a name='ATTRIBUTES'>General Attributes</a></h2>
 
 <h3><span class='info'>CUPS 1.3/OS X 10.5</span><a name='cupsBackSide'>cupsBackSide</a></h3>
@@ -1335,6 +1350,7 @@ the output for a specific model of printer.</p>
 *cupsModelNumber: 1234
 </pre>
 
+
 <h3><span class='info'>CUPS 1.3/OS X 10.5</span><a name='cupsPJLCharset'>cupsPJLCharset</a></h3>
 
 <p class='summary'>*cupsPJLCharset: "ISO character set name"</p>
@@ -1795,6 +1811,8 @@ the device.</p>
 
 <ul>
 
+    <li>Added <a href="#cupsPageSizeCategory"><tt>cupsPageSizeCategory</tt></a> keyword (originally defined in CUPS 1.4).</li>
+
        <li>Added <a href="#cupsMaxCopies"><tt>cupsMaxCopies</tt></a> keyword.</li>
 
        <li>Documented <a href="#JCLToPDFInterpreter"><tt>JCLToPDFInterpreter</tt></a> keyword.</li>