diff options
| author | Michael R Sweet <michael.r.sweet@gmail.com> | 2018-05-14 10:21:51 -0700 |
|---|---|---|
| committer | Michael R Sweet <michael.r.sweet@gmail.com> | 2018-05-14 10:21:51 -0700 |
| commit | 06a5a4d332debf82e76eb73e940b587ff6499f11 (patch) | |
| tree | 45a3fd34fa68c679c2f76703b3868fc1469387d2 /doc/help/api-ppd.html | |
| parent | 4cadd6202fbcfc6bcb18c7bada4c40af4e8d736b (diff) | |
Mark cupsGetDevices as deprecated.
Update CUPS Programming Manual.
Update CUPS Admin API documentation.
Update CUPS PPD documentation.
Diffstat (limited to 'doc/help/api-ppd.html')
| -rw-r--r-- | doc/help/api-ppd.html | 134 |
1 files changed, 74 insertions, 60 deletions
diff --git a/doc/help/api-ppd.html b/doc/help/api-ppd.html index c287479e5..a0918afd5 100644 --- a/doc/help/api-ppd.html +++ b/doc/help/api-ppd.html @@ -563,6 +563,7 @@ h3.title { </ul></li> <li><a href="#ENUMERATIONS">Enumerations</a><ul class="subcontents"> <li><a href="#ppd_conform_e">ppd_conform_e</a></li> + <li><a href="#ppd_cptype_e">ppd_cptype_e</a></li> <li><a href="#ppd_cs_e">ppd_cs_e</a></li> <li><a href="#ppd_section_e">ppd_section_e</a></li> <li><a href="#ppd_status_e">ppd_status_e</a></li> @@ -1513,103 +1514,103 @@ float ppdPageWidth(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *name); <h4 class="returnvalue">Return Value</h4> <p class="description">Width of page in points or 0.0</p> <h2 class="title"><a id="TYPES">Data Types</a></h2> - <h3 class="typedef"><a id="ppd_attr_t"><span class="info"> CUPS 1.1.19/macOS 10.3 </span>ppd_attr_t</a></h3> + <h3 class="typedef"><a id="ppd_attr_t"><span class="info"> DEPRECATED </span>ppd_attr_t</a></h3> <p class="description">PPD Attribute Structure </p> <p class="code"> typedef struct <a href="#ppd_attr_s">ppd_attr_s</a> ppd_attr_t; </p> - <h3 class="typedef"><a id="ppd_choice_t">ppd_choice_t</a></h3> - <p class="description">Option choices</p> + <h3 class="typedef"><a id="ppd_choice_t"><span class="info"> DEPRECATED </span>ppd_choice_t</a></h3> + <p class="description">Option choices </p> <p class="code"> typedef struct <a href="#ppd_choice_s">ppd_choice_s</a> ppd_choice_t; </p> - <h3 class="typedef"><a id="ppd_conform_t"><span class="info"> CUPS 1.1.19/macOS 10.3 </span>ppd_conform_t</a></h3> + <h3 class="typedef"><a id="ppd_conform_t"><span class="info"> DEPRECATED </span>ppd_conform_t</a></h3> <p class="description">Conformance Levels </p> <p class="code"> typedef enum <a href="#ppd_conform_e">ppd_conform_e</a> ppd_conform_t; </p> - <h3 class="typedef"><a id="ppd_const_t">ppd_const_t</a></h3> - <p class="description">Constraints</p> + <h3 class="typedef"><a id="ppd_const_t"><span class="info"> DEPRECATED </span>ppd_const_t</a></h3> + <p class="description">Constraints </p> <p class="code"> typedef struct <a href="#ppd_const_s">ppd_const_s</a> ppd_const_t; </p> - <h3 class="typedef"><a id="ppd_coption_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>ppd_coption_t</a></h3> + <h3 class="typedef"><a id="ppd_coption_t"><span class="info"> DEPRECATED </span>ppd_coption_t</a></h3> <p class="description">Custom Option </p> <p class="code"> typedef struct <a href="#ppd_coption_s">ppd_coption_s</a> ppd_coption_t; </p> - <h3 class="typedef"><a id="ppd_cparam_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>ppd_cparam_t</a></h3> + <h3 class="typedef"><a id="ppd_cparam_t"><span class="info"> DEPRECATED </span>ppd_cparam_t</a></h3> <p class="description">Custom Parameter </p> <p class="code"> typedef struct <a href="#ppd_cparam_s">ppd_cparam_s</a> ppd_cparam_t; </p> - <h3 class="typedef"><a id="ppd_cplimit_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>ppd_cplimit_t</a></h3> + <h3 class="typedef"><a id="ppd_cplimit_t"><span class="info"> DEPRECATED </span>ppd_cplimit_t</a></h3> <p class="description">Custom Parameter Limit </p> <p class="code"> typedef union <a href="#ppd_cplimit_u">ppd_cplimit_u</a> ppd_cplimit_t; </p> - <h3 class="typedef"><a id="ppd_cptype_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>ppd_cptype_t</a></h3> + <h3 class="typedef"><a id="ppd_cptype_t"><span class="info"> DEPRECATED </span>ppd_cptype_t</a></h3> <p class="description">Custom Parameter Type </p> <p class="code"> -typedef enum ppd_cptype_e ppd_cptype_t; +typedef enum <a href="#ppd_cptype_e">ppd_cptype_e</a> ppd_cptype_t; </p> - <h3 class="typedef"><a id="ppd_cpvalue_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>ppd_cpvalue_t</a></h3> + <h3 class="typedef"><a id="ppd_cpvalue_t"><span class="info"> DEPRECATED </span>ppd_cpvalue_t</a></h3> <p class="description">Custom Parameter Value </p> <p class="code"> typedef union <a href="#ppd_cpvalue_u">ppd_cpvalue_u</a> ppd_cpvalue_t; </p> - <h3 class="typedef"><a id="ppd_cs_t">ppd_cs_t</a></h3> - <p class="description">Colorspaces</p> + <h3 class="typedef"><a id="ppd_cs_t"><span class="info"> DEPRECATED </span>ppd_cs_t</a></h3> + <p class="description">Colorspaces </p> <p class="code"> typedef enum <a href="#ppd_cs_e">ppd_cs_e</a> ppd_cs_t; </p> - <h3 class="typedef"><a id="ppd_emul_t">ppd_emul_t</a></h3> - <p class="description">Emulators</p> + <h3 class="typedef"><a id="ppd_emul_t"><span class="info"> DEPRECATED </span>ppd_emul_t</a></h3> + <p class="description">Emulators </p> <p class="code"> typedef struct <a href="#ppd_emul_s">ppd_emul_s</a> ppd_emul_t; </p> - <h3 class="typedef"><a id="ppd_file_t">ppd_file_t</a></h3> - <p class="description">PPD File</p> + <h3 class="typedef"><a id="ppd_file_t"><span class="info"> DEPRECATED </span>ppd_file_t</a></h3> + <p class="description">PPD File </p> <p class="code"> typedef struct <a href="#ppd_file_s">ppd_file_s</a> ppd_file_t; </p> - <h3 class="typedef"><a id="ppd_group_t">ppd_group_t</a></h3> - <p class="description">Groups</p> + <h3 class="typedef"><a id="ppd_group_t"><span class="info"> DEPRECATED </span>ppd_group_t</a></h3> + <p class="description">Groups </p> <p class="code"> typedef struct <a href="#ppd_group_s">ppd_group_s</a> ppd_group_t; </p> - <h3 class="typedef"><a id="ppd_option_t">ppd_option_t</a></h3> - <p class="description">Options</p> + <h3 class="typedef"><a id="ppd_option_t"><span class="info"> DEPRECATED </span>ppd_option_t</a></h3> + <p class="description">Options </p> <p class="code"> typedef struct <a href="#ppd_option_s">ppd_option_s</a> ppd_option_t; </p> - <h3 class="typedef"><a id="ppd_profile_t">ppd_profile_t</a></h3> - <p class="description">sRGB Color Profiles</p> + <h3 class="typedef"><a id="ppd_profile_t"><span class="info"> DEPRECATED </span>ppd_profile_t</a></h3> + <p class="description">sRGB Color Profiles </p> <p class="code"> typedef struct <a href="#ppd_profile_s">ppd_profile_s</a> ppd_profile_t; </p> - <h3 class="typedef"><a id="ppd_section_t">ppd_section_t</a></h3> - <p class="description">Order dependency sections</p> + <h3 class="typedef"><a id="ppd_section_t"><span class="info"> DEPRECATED </span>ppd_section_t</a></h3> + <p class="description">Order dependency sections </p> <p class="code"> typedef enum <a href="#ppd_section_e">ppd_section_e</a> ppd_section_t; </p> - <h3 class="typedef"><a id="ppd_size_t">ppd_size_t</a></h3> - <p class="description">Page Sizes</p> + <h3 class="typedef"><a id="ppd_size_t"><span class="info"> DEPRECATED </span>ppd_size_t</a></h3> + <p class="description">Page Sizes </p> <p class="code"> typedef struct <a href="#ppd_size_s">ppd_size_s</a> ppd_size_t; </p> - <h3 class="typedef"><a id="ppd_status_t"><span class="info"> CUPS 1.1.19/macOS 10.3 </span>ppd_status_t</a></h3> + <h3 class="typedef"><a id="ppd_status_t"><span class="info"> DEPRECATED </span>ppd_status_t</a></h3> <p class="description">Status Codes </p> <p class="code"> typedef enum <a href="#ppd_status_e">ppd_status_e</a> ppd_status_t; </p> - <h3 class="typedef"><a id="ppd_ui_t">ppd_ui_t</a></h3> - <p class="description">UI Types</p> + <h3 class="typedef"><a id="ppd_ui_t"><span class="info"> DEPRECATED </span>ppd_ui_t</a></h3> + <p class="description">UI Types </p> <p class="code"> typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; </p> <h2 class="title"><a id="STRUCTURES">Structures</a></h2> -<h3 class="struct"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ppd_attr_s">ppd_attr_s</a></h3> +<h3 class="struct"><span class="info"> DEPRECATED </span><a id="ppd_attr_s">ppd_attr_s</a></h3> <p class="description">PPD Attribute Structure </p> <p class="code">struct ppd_attr_s {<br>     char name[PPD_MAX_NAME];<br> @@ -1628,8 +1629,8 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>value </th> <td class="description">Value string</td></tr> </tbody></table> -<h3 class="struct"><a id="ppd_choice_s">ppd_choice_s</a></h3> - <p class="description">Option choices</p> +<h3 class="struct"><span class="info"> DEPRECATED </span><a id="ppd_choice_s">ppd_choice_s</a></h3> + <p class="description">Option choices </p> <p class="code">struct ppd_choice_s {<br>     char choice[PPD_MAX_NAME];<br>     char *code;<br> @@ -1650,8 +1651,8 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>text[PPD_MAX_TEXT] </th> <td class="description">Human-readable option name</td></tr> </tbody></table> -<h3 class="struct"><a id="ppd_const_s">ppd_const_s</a></h3> - <p class="description">Constraints</p> +<h3 class="struct"><span class="info"> DEPRECATED </span><a id="ppd_const_s">ppd_const_s</a></h3> + <p class="description">Constraints </p> <p class="code">struct ppd_const_s {<br>     char choice1[PPD_MAX_NAME];<br>     char choice2[PPD_MAX_NAME];<br> @@ -1669,7 +1670,7 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>option2[PPD_MAX_NAME] </th> <td class="description">Second keyword</td></tr> </tbody></table> -<h3 class="struct"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ppd_coption_s">ppd_coption_s</a></h3> +<h3 class="struct"><span class="info"> DEPRECATED </span><a id="ppd_coption_s">ppd_coption_s</a></h3> <p class="description">Custom Option </p> <p class="code">struct ppd_coption_s {<br>     char keyword[PPD_MAX_NAME];<br> @@ -1688,7 +1689,7 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>params </th> <td class="description">Parameters</td></tr> </tbody></table> -<h3 class="struct"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ppd_cparam_s">ppd_cparam_s</a></h3> +<h3 class="struct"><span class="info"> DEPRECATED </span><a id="ppd_cparam_s">ppd_cparam_s</a></h3> <p class="description">Custom Parameter </p> <p class="code">struct ppd_cparam_s {<br>     <a href="#ppd_cpvalue_t">ppd_cpvalue_t</a> current;<br> @@ -1713,8 +1714,8 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>type </th> <td class="description">Parameter type</td></tr> </tbody></table> -<h3 class="struct"><a id="ppd_emul_s">ppd_emul_s</a></h3> - <p class="description">Emulators</p> +<h3 class="struct"><span class="info"> DEPRECATED </span><a id="ppd_emul_s">ppd_emul_s</a></h3> + <p class="description">Emulators </p> <p class="code">struct ppd_emul_s {<br>     char name[PPD_MAX_NAME];<br>     char *start;<br> @@ -1729,8 +1730,8 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>stop </th> <td class="description">Code to stop this emulation</td></tr> </tbody></table> -<h3 class="struct"><a id="ppd_file_s">ppd_file_s</a></h3> - <p class="description">PPD File</p> +<h3 class="struct"><span class="info"> DEPRECATED </span><a id="ppd_file_s">ppd_file_s</a></h3> + <p class="description">PPD File </p> <p class="code">struct ppd_file_s {<br>     int accurate_screens;<br>     int color_device;<br> @@ -1862,8 +1863,8 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>variable_sizes </th> <td class="description">1 = supports variable sizes, 0 = doesn't</td></tr> </tbody></table> -<h3 class="struct"><a id="ppd_group_s">ppd_group_s</a></h3> - <p class="description">Groups</p> +<h3 class="struct"><span class="info"> DEPRECATED </span><a id="ppd_group_s">ppd_group_s</a></h3> + <p class="description">Groups </p> <p class="code">struct ppd_group_s {<br>     char text[PPD_MAX_TEXT - PPD_MAX_NAME];<br>     char name[PPD_MAX_NAME];<br> @@ -1887,8 +1888,8 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>subgroups </th> <td class="description">Sub-groups (max depth = 1)</td></tr> </tbody></table> -<h3 class="struct"><a id="ppd_option_s">ppd_option_s</a></h3> - <p class="description">Options</p> +<h3 class="struct"><span class="info"> DEPRECATED </span><a id="ppd_option_s">ppd_option_s</a></h3> + <p class="description">Options </p> <p class="code">struct ppd_option_s {<br>     <a href="#ppd_choice_t">ppd_choice_t</a> *choices;<br>     char conflicted;<br> @@ -1921,8 +1922,8 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>ui </th> <td class="description">Type of UI option</td></tr> </tbody></table> -<h3 class="struct"><a id="ppd_profile_s">ppd_profile_s</a></h3> - <p class="description">sRGB Color Profiles</p> +<h3 class="struct"><span class="info"> DEPRECATED </span><a id="ppd_profile_s">ppd_profile_s</a></h3> + <p class="description">sRGB Color Profiles </p> <p class="code">struct ppd_profile_s {<br>     float density;<br>     float gamma;<br> @@ -1943,8 +1944,8 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>resolution[PPD_MAX_NAME] </th> <td class="description">Resolution or "-"</td></tr> </tbody></table> -<h3 class="struct"><a id="ppd_size_s">ppd_size_s</a></h3> - <p class="description">Page Sizes</p> +<h3 class="struct"><span class="info"> DEPRECATED </span><a id="ppd_size_s">ppd_size_s</a></h3> + <p class="description">Page Sizes </p> <p class="code">struct ppd_size_s {<br>     float bottom;<br>     float left;<br> @@ -1975,7 +1976,7 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <td class="description">Width of media in points</td></tr> </tbody></table> <h2 class="title"><a id="UNIONS">Unions</a></h2> -<h3 class="union"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ppd_cplimit_u">ppd_cplimit_u</a></h3> +<h3 class="union"><span class="info"> DEPRECATED </span><a id="ppd_cplimit_u">ppd_cplimit_u</a></h3> <p class="description">Custom Parameter Limit </p> <p class="code">union ppd_cplimit_u {<br>     float custom_curve;<br> @@ -2006,7 +2007,7 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>custom_string </th> <td class="description">String length</td></tr> </tbody></table> -<h3 class="union"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ppd_cpvalue_u">ppd_cpvalue_u</a></h3> +<h3 class="union"><span class="info"> DEPRECATED </span><a id="ppd_cpvalue_u">ppd_cpvalue_u</a></h3> <p class="description">Custom Parameter Value </p> <p class="code">union ppd_cpvalue_u {<br>     float custom_curve;<br> @@ -2038,15 +2039,28 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <td class="description">String value</td></tr> </tbody></table> <h2 class="title"><a id="ENUMERATIONS">Constants</a></h2> - <h3 class="enumeration"><a id="ppd_conform_e"><span class="info"> CUPS 1.1.19/macOS 10.3 </span>ppd_conform_e</a></h3> + <h3 class="enumeration"><a id="ppd_conform_e"><span class="info"> DEPRECATED </span>ppd_conform_e</a></h3> <p class="description">Conformance Levels </p> <h4 class="constants">Constants</h4> <table class="list"><tbody> <tr><th>PPD_CONFORM_RELAXED </th> <td class="description">Relax whitespace and control char</td></tr> <tr><th>PPD_CONFORM_STRICT </th> <td class="description">Require strict conformance</td></tr> </tbody></table> - <h3 class="enumeration"><a id="ppd_cs_e">ppd_cs_e</a></h3> - <p class="description">Colorspaces</p> + <h3 class="enumeration"><a id="ppd_cptype_e"><span class="info"> DEPRECATED </span>ppd_cptype_e</a></h3> + <p class="description">Custom Parameter Type </p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>PPD_CUSTOM_CURVE </th> <td class="description">Curve value for f(x) = x^value</td></tr> + <tr><th>PPD_CUSTOM_INT </th> <td class="description">Integer number value</td></tr> + <tr><th>PPD_CUSTOM_INVCURVE </th> <td class="description">Curve value for f(x) = x^(1/value)</td></tr> + <tr><th>PPD_CUSTOM_PASSCODE </th> <td class="description">String of (hidden) numbers</td></tr> + <tr><th>PPD_CUSTOM_PASSWORD </th> <td class="description">String of (hidden) characters</td></tr> + <tr><th>PPD_CUSTOM_POINTS </th> <td class="description">Measurement value in points</td></tr> + <tr><th>PPD_CUSTOM_REAL </th> <td class="description">Real number value</td></tr> + <tr><th>PPD_CUSTOM_STRING </th> <td class="description">String of characters</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ppd_cs_e"><span class="info"> DEPRECATED </span>ppd_cs_e</a></h3> + <p class="description">Colorspaces </p> <h4 class="constants">Constants</h4> <table class="list"><tbody> <tr><th>PPD_CS_CMY </th> <td class="description">CMY colorspace</td></tr> @@ -2056,8 +2070,8 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>PPD_CS_RGB </th> <td class="description">RGB colorspace</td></tr> <tr><th>PPD_CS_RGBK </th> <td class="description">RGBK (K = gray) colorspace</td></tr> </tbody></table> - <h3 class="enumeration"><a id="ppd_section_e">ppd_section_e</a></h3> - <p class="description">Order dependency sections</p> + <h3 class="enumeration"><a id="ppd_section_e"><span class="info"> DEPRECATED </span>ppd_section_e</a></h3> + <p class="description">Order dependency sections </p> <h4 class="constants">Constants</h4> <table class="list"><tbody> <tr><th>PPD_ORDER_ANY </th> <td class="description">Option code can be anywhere in the file</td></tr> @@ -2067,7 +2081,7 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>PPD_ORDER_PAGE </th> <td class="description">... must be in the PageSetup section</td></tr> <tr><th>PPD_ORDER_PROLOG </th> <td class="description">... must be in the Prolog section</td></tr> </tbody></table> - <h3 class="enumeration"><a id="ppd_status_e"><span class="info"> CUPS 1.1.19/macOS 10.3 </span>ppd_status_e</a></h3> + <h3 class="enumeration"><a id="ppd_status_e"><span class="info"> DEPRECATED </span>ppd_status_e</a></h3> <p class="description">Status Codes </p> <h4 class="constants">Constants</h4> <table class="list"><tbody> @@ -2096,8 +2110,8 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <tr><th>PPD_NULL_FILE </th> <td class="description">NULL PPD file pointer</td></tr> <tr><th>PPD_OK </th> <td class="description">OK</td></tr> </tbody></table> - <h3 class="enumeration"><a id="ppd_ui_e">ppd_ui_e</a></h3> - <p class="description">UI Types</p> + <h3 class="enumeration"><a id="ppd_ui_e"><span class="info"> DEPRECATED </span>ppd_ui_e</a></h3> + <p class="description">UI Types </p> <h4 class="constants">Constants</h4> <table class="list"><tbody> <tr><th>PPD_UI_BOOLEAN </th> <td class="description">True or False option</td></tr> |