diff options
| author | Michael Sweet <michael.r.sweet@gmail.com> | 2017-06-07 16:16:05 -0400 |
|---|---|---|
| committer | Michael Sweet <michael.r.sweet@gmail.com> | 2017-06-07 16:16:05 -0400 |
| commit | 718ee2fff3cfeedf69dedf4ca68b14e2f49ff8c6 (patch) | |
| tree | 389e6ccb33c5700f9b58804cdebb750e4d90bf41 /doc | |
| parent | 500fca270aaff7cf513662ae4ddb3c71bf32abe5 (diff) | |
Save work on CUPS Programming Manual.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/help/api-raster.html | 5 | ||||
| -rw-r--r-- | doc/help/cupspm.epub | bin | 221280 -> 218052 bytes | |||
| -rw-r--r-- | doc/help/cupspm.html | 716 |
3 files changed, 66 insertions, 655 deletions
diff --git a/doc/help/api-raster.html b/doc/help/api-raster.html index 54b88d1dc..f3d7253f0 100644 --- a/doc/help/api-raster.html +++ b/doc/help/api-raster.html @@ -605,7 +605,7 @@ the memory used to read the raster file:</p> </ul> <h2 class="title"><a id="FUNCTIONS">Functions</a></h2> <h3 class="function"><a id="cupsRasterClose">cupsRasterClose</a></h3> - <p class="description">Close a raster stream.</p> + <p class="description"></p> <p class="code"> void cupsRasterClose (<br>     <a href="#cups_raster_t">cups_raster_t</a> *r<br> @@ -615,7 +615,8 @@ void cupsRasterClose (<br> <dt>r</dt> <dd class="description">Stream to close</dd> </dl> -<h4 class="discussion">Discussion</h4> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Close a raster stream.</p> <p class="discussion">The file descriptor associated with the raster stream must be closed separately as needed.</p> <h3 class="function"><span class="info"> CUPS 2.2/macOS 10.12 </span><a id="cupsRasterInitPWGHeader">cupsRasterInitPWGHeader</a></h3> diff --git a/doc/help/cupspm.epub b/doc/help/cupspm.epub Binary files differindex 48ec695cb..51f7600fc 100644 --- a/doc/help/cupspm.epub +++ b/doc/help/cupspm.epub diff --git a/doc/help/cupspm.html b/doc/help/cupspm.html index 531713057..17aeb9ad4 100644 --- a/doc/help/cupspm.html +++ b/doc/help/cupspm.html @@ -438,19 +438,12 @@ h3.title { <li><a href="#ippWrite">ippWrite</a></li> <li><a href="#ippWriteFile">ippWriteFile</a></li> <li><a href="#ippWriteIO">ippWriteIO</a></li> - <li><a href="#pwgFormatSizeName">pwgFormatSizeName</a></li> - <li><a href="#pwgInitSize">pwgInitSize</a></li> - <li><a href="#pwgMediaForLegacy">pwgMediaForLegacy</a></li> - <li><a href="#pwgMediaForPPD">pwgMediaForPPD</a></li> - <li><a href="#pwgMediaForPWG">pwgMediaForPWG</a></li> - <li><a href="#pwgMediaForSize">pwgMediaForSize</a></li> </ul></li> <li><a href="#TYPES">Data Types</a><ul class="subcontents"> <li><a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a></li> <li><a href="#cups_dest_cb_t">cups_dest_cb_t</a></li> <li><a href="#cups_dest_t">cups_dest_t</a></li> <li><a href="#cups_dinfo_t">cups_dinfo_t</a></li> - <li><a href="#cups_encoding_t">cups_encoding_t</a></li> <li><a href="#cups_job_t">cups_job_t</a></li> <li><a href="#cups_lang_t">cups_lang_t</a></li> <li><a href="#cups_option_t">cups_option_t</a></li> @@ -459,9 +452,6 @@ h3.title { <li><a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a></li> <li><a href="#cups_size_t">cups_size_t</a></li> <li><a href="#http_addr_t">http_addr_t</a></li> - <li><a href="#http_addrlist_t">http_addrlist_t</a></li> - <li><a href="#http_auth_t">http_auth_t</a></li> - <li><a href="#http_credential_t">http_credential_t</a></li> <li><a href="#http_encoding_t">http_encoding_t</a></li> <li><a href="#http_encryption_t">http_encryption_t</a></li> <li><a href="#http_field_t">http_field_t</a></li> @@ -472,13 +462,9 @@ h3.title { <li><a href="#http_trust_t">http_trust_t</a></li> <li><a href="#http_uri_coding_t">http_uri_coding_t</a></li> <li><a href="#http_uri_status_t">http_uri_status_t</a></li> - <li><a href="#http_version_t">http_version_t</a></li> <li><a href="#ipp_attribute_t">ipp_attribute_t</a></li> <li><a href="#ipp_copycb_t">ipp_copycb_t</a></li> - <li><a href="#ipp_dstate_t">ipp_dstate_t</a></li> - <li><a href="#ipp_finish_t">ipp_finish_t</a></li> <li><a href="#ipp_iocb_t">ipp_iocb_t</a></li> - <li><a href="#ipp_jcollate_t">ipp_jcollate_t</a></li> <li><a href="#ipp_orient_t">ipp_orient_t</a></li> <li><a href="#ipp_pstate_t">ipp_pstate_t</a></li> <li><a href="#ipp_quality_t">ipp_quality_t</a></li> @@ -486,9 +472,6 @@ h3.title { <li><a href="#ipp_state_t">ipp_state_t</a></li> <li><a href="#ipp_t">ipp_t</a></li> <li><a href="#ipp_uchar_t">ipp_uchar_t</a></li> - <li><a href="#pwg_map_t">pwg_map_t</a></li> - <li><a href="#pwg_media_t">pwg_media_t</a></li> - <li><a href="#pwg_size_t">pwg_size_t</a></li> </ul></li> <li><a href="#STRUCTURES">Structures</a><ul class="subcontents"> <li><a href="#cups_dest_s">cups_dest_s</a></li> @@ -496,16 +479,9 @@ h3.title { <li><a href="#cups_lang_s">cups_lang_s</a></li> <li><a href="#cups_option_s">cups_option_s</a></li> <li><a href="#cups_size_s">cups_size_s</a></li> - <li><a href="#http_addrlist_s">http_addrlist_s</a></li> - <li><a href="#http_credential_s">http_credential_s</a></li> - <li><a href="#pwg_map_s">pwg_map_s</a></li> - <li><a href="#pwg_media_s">pwg_media_s</a></li> - <li><a href="#pwg_size_s">pwg_size_s</a></li> </ul></li> <li><a href="#ENUMERATIONS">Enumerations</a><ul class="subcontents"> - <li><a href="#cups_encoding_e">cups_encoding_e</a></li> <li><a href="#cups_ptype_e">cups_ptype_e</a></li> - <li><a href="#http_auth_e">http_auth_e</a></li> <li><a href="#http_encoding_e">http_encoding_e</a></li> <li><a href="#http_encryption_e">http_encryption_e</a></li> <li><a href="#http_field_e">http_field_e</a></li> @@ -515,10 +491,7 @@ h3.title { <li><a href="#http_trust_e">http_trust_e</a></li> <li><a href="#http_uri_coding_e">http_uri_coding_e</a></li> <li><a href="#http_uri_status_e">http_uri_status_e</a></li> - <li><a href="#http_version_e">http_version_e</a></li> - <li><a href="#ipp_dstate_e">ipp_dstate_e</a></li> <li><a href="#ipp_finishings_e">ipp_finishings_e</a></li> - <li><a href="#ipp_jcollate_e">ipp_jcollate_e</a></li> <li><a href="#ipp_jstate_e">ipp_jstate_e</a></li> <li><a href="#ipp_op_e">ipp_op_e</a></li> <li><a href="#ipp_orient_e">ipp_orient_e</a></li> @@ -629,6 +602,9 @@ int main(void) <li><code>CUPS_DEST_FLAGS_ERROR</code>: An error occurred. The reason for the error can be found by calling the <code>cupsLastError</code> and/or <code>cupsLastErrorString</code> functions.</li> </ul> <p>The callback function returns 0 to stop enumeration or 1 to continue.</p> + <blockquote> + <p>Note that the callback function will likely be called multiple times for the same destination, so it is up to the caller to suppress any duplicate destinations.</p> +</blockquote> <p>The following example shows how to use <code>cupsEnumDests</code> to get a filtered array of destinations:</p> <pre><code>typedef struct { @@ -1507,7 +1483,10 @@ printers. The constant <code>CUPS_PRINTER_DISCOVERED</code> is used to filter o destinations that are available but have not yet been added locally.<br> <br> Enumeration happens on the current thread and does not return until all -destinations have been enumerated or the callback function returns 0. +destinations have been enumerated or the callback function returns 0.<br> +<br> +Note: The callback function will likely receive multiple updates for the same +destinations - it is up to the caller to suppress any duplicate destinations. </p> <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsFindDestDefault">cupsFindDestDefault</a></h3> @@ -6799,173 +6778,6 @@ to a human-readable message on failure. </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Current state</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="pwgFormatSizeName">pwgFormatSizeName</a></h3> - <p class="description">Generate a PWG self-describing media size name.</p> -<p class="code"> -int pwgFormatSizeName (<br> -    char *keyword,<br> -    size_t keysize,<br> -    const char *prefix,<br> -    const char *name,<br> -    int width,<br> -    int length,<br> -    const char *units<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>keyword</dt> - <dd class="description">Keyword buffer</dd> -<dt>keysize</dt> - <dd class="description">Size of keyword buffer</dd> -<dt>prefix</dt> - <dd class="description">Prefix for PWG size or <code>NULL</code> for automatic</dd> -<dt>name</dt> - <dd class="description">Size name or <code>NULL</code></dd> -<dt>width</dt> - <dd class="description">Width of page in 2540ths</dd> -<dt>length</dt> - <dd class="description">Length of page in 2540ths</dd> -<dt>units</dt> - <dd class="description">Units - "in", "mm", or <code>NULL</code> for automatic</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> - <p class="description">1 on success, 0 on failure</p> -<h4 class="discussion">Discussion</h4> - <p class="discussion">This function generates a PWG self-describing media size name of the form -"prefix_name_WIDTHxLENGTHunits". The prefix is typically "custom" or "roll" -for user-supplied sizes but can also be "disc", "iso", "jis", "jpn", "na", -"oe", "om", "prc", or "roc". A value of <code>NULL</code> automatically chooses -"oe" or "om" depending on the units.<br> -<br> -The size name may only contain lowercase letters, numbers, "-", and ".". If -<code>NULL</code> is passed, the size name will contain the formatted dimensions.<br> -<br> -The width and length are specified in hundredths of millimeters, equivalent -to 1/100000th of a meter or 1/2540th of an inch. The width, length, and -units used for the generated size name are calculated automatically if the -units string is <code>NULL</code>, otherwise inches ("in") or millimeters ("mm") -are used. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="pwgInitSize">pwgInitSize</a></h3> - <p class="description">Initialize a pwg_size_t structure using IPP Job Template -attributes.</p> -<p class="code"> -int pwgInitSize (<br> -    <a href="#pwg_size_t">pwg_size_t</a> *size,<br> -    <a href="#ipp_t">ipp_t</a> *job,<br> -    int *margins_set<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>size</dt> - <dd class="description">Size to initialize</dd> -<dt>job</dt> - <dd class="description">Job template attributes</dd> -<dt>margins_set</dt> - <dd class="description">1 if margins were set, 0 otherwise</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> - <p class="description">1 if size was initialized, 0 otherwise</p> -<h4 class="discussion">Discussion</h4> - <p class="discussion">This function initializes a pwg_size_t structure from an IPP "media" or -"media-col" attribute in the specified IPP message. 0 is returned if neither -attribute is found in the message or the values are not valid.<br> -<br> -The "margins_set" variable is initialized to 1 if any "media-xxx-margin" -member attribute was specified in the "media-col" Job Template attribute, -otherwise it is initialized to 0. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="pwgMediaForLegacy">pwgMediaForLegacy</a></h3> - <p class="description">Find a PWG media size by ISO/IPP legacy name.</p> -<p class="code"> -<a href="#pwg_media_t">pwg_media_t</a> *pwgMediaForLegacy (<br> -    const char *legacy<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>legacy</dt> - <dd class="description">Legacy size name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> - <p class="description">Matching size or NULL</p> -<h4 class="discussion">Discussion</h4> - <p class="discussion">The "name" argument specifies the legacy ISO media size name, for example -"iso-a4" or "na-letter". - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="pwgMediaForPPD">pwgMediaForPPD</a></h3> - <p class="description">Find a PWG media size by Adobe PPD name.</p> -<p class="code"> -<a href="#pwg_media_t">pwg_media_t</a> *pwgMediaForPPD (<br> -    const char *ppd<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ppd</dt> - <dd class="description">PPD size name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> - <p class="description">Matching size or NULL</p> -<h4 class="discussion">Discussion</h4> - <p class="discussion">The "ppd" argument specifies an Adobe page size name as defined in Table B.1 -of the Adobe PostScript Printer Description File Format Specification Version -4.3.<br> -<br> -If the name is non-standard, the returned PWG media size is stored in -thread-local storage and is overwritten by each call to the function in the -thread. Custom names can be of the form "Custom.WIDTHxLENGTH[units]" or -"WIDTHxLENGTH[units]". - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="pwgMediaForPWG">pwgMediaForPWG</a></h3> - <p class="description">Find a PWG media size by 5101.1 self-describing name.</p> -<p class="code"> -<a href="#pwg_media_t">pwg_media_t</a> *pwgMediaForPWG (<br> -    const char *pwg<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>pwg</dt> - <dd class="description">PWG size name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> - <p class="description">Matching size or NULL</p> -<h4 class="discussion">Discussion</h4> - <p class="discussion">The "pwg" argument specifies a self-describing media size name of the form -"prefix_name_WIDTHxLENGTHunits" as defined in PWG 5101.1.<br> -<br> -If the name is non-standard, the returned PWG media size is stored in -thread-local storage and is overwritten by each call to the function in the -thread. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="pwgMediaForSize">pwgMediaForSize</a></h3> - <p class="description">Get the PWG media size for the given dimensions.</p> -<p class="code"> -<a href="#pwg_media_t">pwg_media_t</a> *pwgMediaForSize (<br> -    int width,<br> -    int length<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>width</dt> - <dd class="description">Width in hundredths of millimeters</dd> -<dt>length</dt> - <dd class="description">Length in hundredths of millimeters</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> - <p class="description">PWG media name</p> -<h4 class="discussion">Discussion</h4> - <p class="discussion">The "width" and "length" are in hundredths of millimeters, equivalent to -1/100000th of a meter or 1/2540th of an inch.<br> -<br> -If the dimensions are non-standard, the returned PWG media size is stored in -thread-local storage and is overwritten by each call to the function in the -thread. - -</p> <h2 class="title"><a id="TYPES">Data Types</a></h2> <h3 class="typedef"><a id="cups_client_cert_cb_t"><span class="info"> CUPS 1.5/macOS 10.7 </span>cups_client_cert_cb_t</a></h3> <p class="description">Client credentials callback @@ -6990,11 +6802,6 @@ information </p> <p class="code"> typedef struct _cups_dinfo_s cups_dinfo_t; </p> - <h3 class="typedef"><a id="cups_encoding_t">cups_encoding_t</a></h3> - <p class="description">Language Encodings</p> - <p class="code"> -typedef enum <a href="#cups_encoding_e">cups_encoding_e</a> cups_encoding_t; -</p> <h3 class="typedef"><a id="cups_job_t">cups_job_t</a></h3> <p class="description">Job</p> <p class="code"> @@ -7040,24 +6847,6 @@ more portable. </p> <p class="code"> typedef union _http_addr_u / http_addr_t; </p> - <h3 class="typedef"><a id="http_addrlist_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>http_addrlist_t</a></h3> - <p class="description">Socket address list, which is -used to enumerate all of the -addresses that are associated -with a hostname. </p> - <p class="code"> -typedef struct <a href="#http_addrlist_s">http_addrlist_s</a> / http_addrlist_t; -</p> - <h3 class="typedef"><a id="http_auth_t">http_auth_t</a></h3> - <p class="description">HTTP authentication types</p> - <p class="code"> -typedef enum <a href="#http_auth_e">http_auth_e</a> http_auth_t; -</p> - <h3 class="typedef"><a id="http_credential_t"><span class="info"> CUPS 1.5/macOS 10.7 </span>http_credential_t</a></h3> - <p class="description">HTTP credential data </p> - <p class="code"> -typedef struct <a href="#http_credential_s">http_credential_s</a> http_credential_t; -</p> <h3 class="typedef"><a id="http_encoding_t">http_encoding_t</a></h3> <p class="description">HTTP transfer encoding values</p> <p class="code"> @@ -7109,11 +6898,6 @@ typedef enum <a href="#http_uri_coding_e">http_uri_coding_e</a> http_uri_coding_ <p class="code"> typedef enum <a href="#http_uri_status_e">http_uri_status_e</a> http_uri_status_t; </p> - <h3 class="typedef"><a id="http_version_t">http_version_t</a></h3> - <p class="description">HTTP version numbers</p> - <p class="code"> -typedef enum <a href="#http_version_e">http_version_e</a> http_version_t; -</p> <h3 class="typedef"><a id="ipp_attribute_t">ipp_attribute_t</a></h3> <p class="description">IPP attribute</p> <p class="code"> @@ -7126,26 +6910,11 @@ these definitions will be moved to a private header file in a future release.</p <p class="code"> typedef int(*)(void *context, <a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr)ipp_copycb_t; </p> - <h3 class="typedef"><a id="ipp_dstate_t">ipp_dstate_t</a></h3> - <p class="description">Document states</p> - <p class="code"> -typedef enum <a href="#ipp_dstate_e">ipp_dstate_e</a> ipp_dstate_t; -</p> - <h3 class="typedef"><a id="ipp_finish_t">ipp_finish_t</a></h3> - <p class="description">Job collation types</p> - <p class="code"> -typedef enum <a href="#ipp_finishings_e">ipp_finishings_e</a> ipp_finish_t; -</p> <h3 class="typedef"><a id="ipp_iocb_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>ipp_iocb_t</a></h3> <p class="description">IPP IO Callback Function </p> <p class="code"> typedef ssize_t(*)(void *context, <a href="#ipp_uchar_t">ipp_uchar_t</a> *buffer, size_t bytes) ipp_iocb_t; </p> - <h3 class="typedef"><a id="ipp_jcollate_t">ipp_jcollate_t</a></h3> - <p class="description">Job collation types</p> - <p class="code"> -typedef enum <a href="#ipp_jcollate_e">ipp_jcollate_e</a> ipp_jcollate_t; -</p> <h3 class="typedef"><a id="ipp_orient_t">ipp_orient_t</a></h3> <p class="description">Orientation values</p> <p class="code"> @@ -7181,21 +6950,6 @@ typedef struct _ipp_s ipp_t; <p class="code"> typedef unsigned char ipp_uchar_t; </p> - <h3 class="typedef"><a id="pwg_map_t">pwg_map_t</a></h3> - <p class="description">Map element - PPD to/from PWG</p> - <p class="code"> -typedef struct <a href="#pwg_map_s">pwg_map_s</a> pwg_map_t; -</p> - <h3 class="typedef"><a id="pwg_media_t">pwg_media_t</a></h3> - <p class="description">Common media size data</p> - <p class="code"> -typedef struct <a href="#pwg_media_s">pwg_media_s</a> pwg_media_t; -</p> - <h3 class="typedef"><a id="pwg_size_t">pwg_size_t</a></h3> - <p class="description">Size element - PPD to/from PWG</p> - <p class="code"> -typedef struct <a href="#pwg_size_s">pwg_size_s</a> pwg_size_t; -</p> <h2 class="title"><a id="STRUCTURES">Structures</a></h2> <h3 class="struct"><a id="cups_dest_s">cups_dest_s</a></h3> <p class="description">Destination</p> @@ -7302,164 +7056,12 @@ typedef struct <a href="#pwg_size_s">pwg_size_s</a> pwg_size_t; <dd class="description">Top margin in hundredths of millimeters</dd> </dl> -<h3 class="struct"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="http_addrlist_s">http_addrlist_s</a></h3> - <p class="description">Socket address list, which is -used to enumerate all of the -addresses that are associated -with a hostname. </p> -<p class="code">struct http_addrlist_s {<br> -    <a href="#http_addr_t">http_addr_t</a> addr;<br> -    struct <a href="#http_addrlist_s">http_addrlist_s</a> *next;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>addr </dt> - <dd class="description">Address</dd> -<dt>next </dt> - <dd class="description">Pointer to next address in list</dd> -</dl> -<h3 class="struct"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="http_credential_s">http_credential_s</a></h3> - <p class="description">HTTP credential data </p> -<p class="code">struct http_credential_s {<br> -    void *data;<br> -    size_t datalen;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>data </dt> - <dd class="description">Pointer to credential data</dd> -<dt>datalen </dt> - <dd class="description">Credential length</dd> -</dl> -<h3 class="struct"><a id="pwg_map_s">pwg_map_s</a></h3> - <p class="description">Map element - PPD to/from PWG</p> -<p class="code">struct pwg_map_s {<br> -    char *pwg, *ppd;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>ppd </dt> - <dd class="description">PPD option keyword</dd> -</dl> -<h3 class="struct"><a id="pwg_media_s">pwg_media_s</a></h3> - <p class="description">Common media size data</p> -<p class="code">struct pwg_media_s {<br> -    int width, length;<br> -    const char *pwg, *legacy, *ppd;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>length </dt> - <dd class="description">Length in 2540ths</dd> -<dt>ppd </dt> - <dd class="description">Standard Adobe PPD name</dd> -</dl> -<h3 class="struct"><a id="pwg_size_s">pwg_size_s</a></h3> - <p class="description">Size element - PPD to/from PWG</p> -<p class="code">struct pwg_size_s {<br> -    <a href="#pwg_map_t">pwg_map_t</a> map;<br> -    int width, length, left, bottom, right, top;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>map </dt> - <dd class="description">Map element</dd> -<dt>top </dt> - <dd class="description">Top margin in 2540ths</dd> -</dl> <h2 class="title"><a id="ENUMERATIONS">Constants</a></h2> - <h3 class="enumeration"><a id="cups_encoding_e">cups_encoding_e</a></h3> - <p class="description">Language Encodings</p> - <h4 class="constants">Constants</h4> - <dl> - <dt>CUPS_EUC_CN </dt> - <dd class="description">EUC Simplified Chinese</dd> - <dt>CUPS_EUC_JP </dt> - <dd class="description">EUC Japanese</dd> - <dt>CUPS_EUC_KR </dt> - <dd class="description">EUC Korean</dd> - <dt>CUPS_EUC_TW </dt> - <dd class="description">EUC Traditional Chinese</dd> - <dt>CUPS_ISO8859_1 </dt> - <dd class="description">ISO-8859-1</dd> - <dt>CUPS_ISO8859_10 </dt> - <dd class="description">ISO-8859-10</dd> - <dt>CUPS_ISO8859_11 </dt> - <dd class="description">ISO-8859-11</dd> - <dt>CUPS_ISO8859_13 </dt> - <dd class="description">ISO-8859-13</dd> - <dt>CUPS_ISO8859_14 </dt> - <dd class="description">ISO-8859-14</dd> - <dt>CUPS_ISO8859_15 </dt> - <dd class="description">ISO-8859-15</dd> - <dt>CUPS_ISO8859_16 </dt> - <dd class="description">ISO-8859-16</dd> - <dt>CUPS_ISO8859_2 </dt> - <dd class="description">ISO-8859-2</dd> - <dt>CUPS_ISO8859_3 </dt> - <dd class="description">ISO-8859-3</dd> - <dt>CUPS_ISO8859_4 </dt> - <dd class="description">ISO-8859-4</dd> - <dt>CUPS_ISO8859_5 </dt> - <dd class="description">ISO-8859-5</dd> - <dt>CUPS_ISO8859_6 </dt> - <dd class="description">ISO-8859-6</dd> - <dt>CUPS_ISO8859_7 </dt> - <dd class="description">ISO-8859-7</dd> - <dt>CUPS_ISO8859_8 </dt> - <dd class="description">ISO-8859-8</dd> - <dt>CUPS_ISO8859_9 </dt> - <dd class="description">ISO-8859-9</dd> - <dt>CUPS_JIS_X0213 </dt> - <dd class="description">JIS X0213 aka Shift JIS</dd> - <dt>CUPS_KOI8_R </dt> - <dd class="description">KOI-8-R</dd> - <dt>CUPS_KOI8_U </dt> - <dd class="description">KOI-8-U</dd> - <dt>CUPS_MAC_ROMAN </dt> - <dd class="description">MacRoman</dd> - <dt>CUPS_US_ASCII </dt> - <dd class="description">US ASCII</dd> - <dt>CUPS_UTF8 </dt> - <dd class="description">UTF-8</dd> - <dt>CUPS_WINDOWS_1250 </dt> - <dd class="description">CP-1250</dd> - <dt>CUPS_WINDOWS_1251 </dt> - <dd class="description">CP-1251</dd> - <dt>CUPS_WINDOWS_1252 </dt> - <dd class="description">CP-1252</dd> - <dt>CUPS_WINDOWS_1253 </dt> - <dd class="description">CP-1253</dd> - <dt>CUPS_WINDOWS_1254 </dt> - <dd class="description">CP-1254</dd> - <dt>CUPS_WINDOWS_1255 </dt> - <dd class="description">CP-1255</dd> - <dt>CUPS_WINDOWS_1256 </dt> - <dd class="description">CP-1256</dd> - <dt>CUPS_WINDOWS_1257 </dt> - <dd class="description">CP-1257</dd> - <dt>CUPS_WINDOWS_1258 </dt> - <dd class="description">CP-1258</dd> - <dt>CUPS_WINDOWS_1361 </dt> - <dd class="description">Korean Johab</dd> - <dt>CUPS_WINDOWS_874 </dt> - <dd class="description">CP-874</dd> - <dt>CUPS_WINDOWS_932 </dt> - <dd class="description">Japanese JIS X0208-1990</dd> - <dt>CUPS_WINDOWS_936 </dt> - <dd class="description">Simplified Chinese GB 2312-80</dd> - <dt>CUPS_WINDOWS_949 </dt> - <dd class="description">Korean KS C5601-1992</dd> - <dt>CUPS_WINDOWS_950 </dt> - <dd class="description">Traditional Chinese Big Five</dd> -</dl> <h3 class="enumeration"><a id="cups_ptype_e">cups_ptype_e</a></h3> <p class="description">Printer type/capability bit constants</p> <h4 class="constants">Constants</h4> <dl> - <dt>CUPS_PRINTER_3D <span class="info"> DEPRECATED </span></dt> - <dd class="description">Printer with 3D capabilities </dd> <dt>CUPS_PRINTER_AUTHENTICATED <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> <dd class="description">Printer requires authentication </dd> @@ -7482,9 +7084,6 @@ constants</p> <dd class="description">Can cover output</dd> <dt>CUPS_PRINTER_DEFAULT </dt> <dd class="description">Default printer on network</dd> - <dt>CUPS_PRINTER_DELETE <span class="info"> DEPRECATED </span></dt> - <dd class="description">Delete printer - </dd> <dt>CUPS_PRINTER_DISCOVERED <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> <dd class="description">Printer was discovered </dd> <dt>CUPS_PRINTER_DUPLEX </dt> @@ -7497,9 +7096,6 @@ constants</p> <dd class="description">Local printer or class</dd> <dt>CUPS_PRINTER_MEDIUM </dt> <dd class="description">Can print on Tabloid/B/C/A3/A2-size media</dd> - <dt>CUPS_PRINTER_MFP <span class="info"> CUPS 1.4/macOS 10.6 </span></dt> - <dd class="description">Printer with scanning capabilities -</dd> <dt>CUPS_PRINTER_NOT_SHARED <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> <dd class="description">Printer is not shared </dd> @@ -7509,9 +7105,6 @@ constants</p> <dd class="description">Printer is rejecting jobs</dd> <dt>CUPS_PRINTER_REMOTE </dt> <dd class="description">Remote printer or class</dd> - <dt>CUPS_PRINTER_SCANNER <span class="info"> CUPS 1.4/macOS 10.6 </span></dt> - <dd class="description">Scanner-only device -</dd> <dt>CUPS_PRINTER_SMALL </dt> <dd class="description">Can print on Letter/Legal/A4-size media</dd> <dt>CUPS_PRINTER_SORT </dt> @@ -7521,25 +7114,6 @@ constants</p> <dt>CUPS_PRINTER_VARIABLE </dt> <dd class="description">Can print on rolls and custom-size media</dd> </dl> - <h3 class="enumeration"><a id="http_auth_e">http_auth_e</a></h3> - <p class="description">HTTP authentication types</p> - <h4 class="constants">Constants</h4> - <dl> - <dt>HTTP_AUTH_BASIC </dt> - <dd class="description">Basic authentication in use</dd> - <dt>HTTP_AUTH_MD5 </dt> - <dd class="description">Digest authentication in use</dd> - <dt>HTTP_AUTH_MD5_INT </dt> - <dd class="description">Digest authentication in use for body</dd> - <dt>HTTP_AUTH_MD5_SESS </dt> - <dd class="description">MD5-session authentication in use</dd> - <dt>HTTP_AUTH_MD5_SESS_INT </dt> - <dd class="description">MD5-session authentication in use for body</dd> - <dt>HTTP_AUTH_NEGOTIATE <span class="info"> CUPS 1.3/macOS 10.5 </span></dt> - <dd class="description">GSSAPI authentication in use </dd> - <dt>HTTP_AUTH_NONE </dt> - <dd class="description">No authentication in use</dd> -</dl> <h3 class="enumeration"><a id="http_encoding_e">http_encoding_e</a></h3> <p class="description">HTTP transfer encoding values</p> <h4 class="constants">Constants</h4> @@ -7842,34 +7416,8 @@ are server-oriented...</p> <dt>HTTP_URI_STATUS_UNKNOWN_SCHEME </dt> <dd class="description">Unknown scheme in URI (warning)</dd> </dl> - <h3 class="enumeration"><a id="http_version_e">http_version_e</a></h3> - <p class="description">HTTP version numbers</p> - <h4 class="constants">Constants</h4> - <dl> - <dt>HTTP_VERSION_0_9 </dt> - <dd class="description">HTTP/0.9</dd> - <dt>HTTP_VERSION_1_0 </dt> - <dd class="description">HTTP/1.0</dd> - <dt>HTTP_VERSION_1_1 </dt> - <dd class="description">HTTP/1.1</dd> -</dl> - <h3 class="enumeration"><a id="ipp_dstate_e">ipp_dstate_e</a></h3> - <p class="description">Document states</p> - <h4 class="constants">Constants</h4> - <dl> - <dt>IPP_DOCUMENT_ABORTED </dt> - <dd class="description">Document is aborted</dd> - <dt>IPP_DOCUMENT_CANCELED </dt> - <dd class="description">Document is canceled</dd> - <dt>IPP_DOCUMENT_COMPLETED </dt> - <dd class="description">Document is completed</dd> - <dt>IPP_DOCUMENT_PENDING </dt> - <dd class="description">Document is pending</dd> - <dt>IPP_DOCUMENT_PROCESSING </dt> - <dd class="description">Document is processing</dd> -</dl> <h3 class="enumeration"><a id="ipp_finishings_e">ipp_finishings_e</a></h3> - <p class="description">Finishings</p> + <p class="description">Finishings values</p> <h4 class="constants">Constants</h4> <dl> <dt>IPP_FINISHINGS_BALE </dt> @@ -7890,60 +7438,6 @@ are server-oriented...</p> <dd class="description">Apply protective liquid or powder coating</dd> <dt>IPP_FINISHINGS_COVER </dt> <dd class="description">Add cover</dd> - <dt>IPP_FINISHINGS_CUPS_FOLD_ACCORDIAN </dt> - <dd class="description">Accordian-fold the paper vertically into four sections</dd> - <dt>IPP_FINISHINGS_CUPS_FOLD_DOUBLE_GATE </dt> - <dd class="description">Fold the top and bottom quarters of the paper towards the midline, then fold in half vertically</dd> - <dt>IPP_FINISHINGS_CUPS_FOLD_GATE </dt> - <dd class="description">Fold the top and bottom quarters of the paper towards the midline</dd> - <dt>IPP_FINISHINGS_CUPS_FOLD_HALF </dt> - <dd class="description">Fold the paper in half vertically</dd> - <dt>IPP_FINISHINGS_CUPS_FOLD_HALF_Z </dt> - <dd class="description">Fold the paper in half horizontally, then Z-fold the paper vertically</dd> - <dt>IPP_FINISHINGS_CUPS_FOLD_LEFT_GATE </dt> - <dd class="description">Fold the top quarter of the paper towards the midline</dd> - <dt>IPP_FINISHINGS_CUPS_FOLD_LETTER </dt> - <dd class="description">Fold the paper into three sections vertically; sometimes also known as a C fold</dd> - <dt>IPP_FINISHINGS_CUPS_FOLD_PARALLEL </dt> - <dd class="description">Fold the paper in half vertically two times, yielding four sections</dd> - <dt>IPP_FINISHINGS_CUPS_FOLD_POSTER </dt> - <dd class="description">Fold the paper in half horizontally and vertically; sometimes also called a cross fold</dd> - <dt>IPP_FINISHINGS_CUPS_FOLD_RIGHT_GATE </dt> - <dd class="description">Fold the bottom quarter of the paper towards the midline</dd> - <dt>IPP_FINISHINGS_CUPS_FOLD_Z </dt> - <dd class="description">Fold the paper vertically into three sections, forming a Z</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_LEFT </dt> - <dd class="description">Punch 1 hole bottom left</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_RIGHT </dt> - <dd class="description">Punch 1 hole bottom right</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_DUAL_BOTTOM </dt> - <dd class="description">Punch 2 holes bottom edge</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_DUAL_LEFT </dt> - <dd class="description">Punch 2 holes left side</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_DUAL_RIGHT </dt> - <dd class="description">Punch 2 holes right side</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_DUAL_TOP </dt> - <dd class="description">Punch 2 holes top edge</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_QUAD_BOTTOM </dt> - <dd class="description">Punch 4 holes bottom edge</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_QUAD_LEFT </dt> - <dd class="description">Punch 4 holes left side</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_QUAD_RIGHT </dt> - <dd class="description">Punch 4 holes right side</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_QUAD_TOP </dt> - <dd class="description">Punch 4 holes top edge</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_TOP_LEFT </dt> - <dd class="description">Punch 1 hole top left</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_TOP_RIGHT </dt> - <dd class="description">Punch 1 hole top right</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_BOTTOM </dt> - <dd class="description">Punch 3 holes bottom edge</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_LEFT </dt> - <dd class="description">Punch 3 holes left side</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_RIGHT </dt> - <dd class="description">Punch 3 holes right side</dd> - <dt>IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_TOP </dt> - <dd class="description">Punch 3 holes top edge</dd> <dt>IPP_FINISHINGS_EDGE_STITCH </dt> <dd class="description">Stitch along any side</dd> <dt>IPP_FINISHINGS_EDGE_STITCH_BOTTOM </dt> @@ -8031,7 +7525,7 @@ are server-oriented...</p> <dt>IPP_FINISHINGS_SADDLE_STITCH </dt> <dd class="description">Staple interior</dd> <dt>IPP_FINISHINGS_STAPLE </dt> - <dd class="description">Staple (any location)</dd> + <dd class="description">Staple (any location/method)</dd> <dt>IPP_FINISHINGS_STAPLE_BOTTOM_LEFT </dt> <dd class="description">Staple bottom left corner</dd> <dt>IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT </dt> @@ -8067,14 +7561,6 @@ are server-oriented...</p> <dt>IPP_FINISHINGS_TRIM_AFTER_PAGES </dt> <dd class="description">Trim output after each page</dd> </dl> - <h3 class="enumeration"><a id="ipp_jcollate_e">ipp_jcollate_e</a></h3> - <p class="description">Job collation types</p> - <h4 class="constants">Constants</h4> - <dl> - <dt>IPP_JCOLLATE_COLLATED_DOCUMENTS </dt> - <dt>IPP_JCOLLATE_UNCOLLATED_DOCUMENTS </dt> - <dt>IPP_JCOLLATE_UNCOLLATED_SHEETS </dt> -</dl> <h3 class="enumeration"><a id="ipp_jstate_e">ipp_jstate_e</a></h3> <p class="description">Job states</p> <h4 class="constants">Constants</h4> @@ -8098,174 +7584,110 @@ are server-oriented...</p> <p class="description">IPP operations</p> <h4 class="constants">Constants</h4> <dl> - <dt>IPP_OP_ACKNOWLEDGE_DOCUMENT </dt> - <dd class="description">Acknowledge-Document</dd> - <dt>IPP_OP_ACKNOWLEDGE_IDENTIFY_PRINTER </dt> - <dd class="description">Acknowledge-Identify-Printer</dd> - <dt>IPP_OP_ACKNOWLEDGE_JOB </dt> - <dd class="description">Acknowledge-Job</dd> - <dt>IPP_OP_ACTIVATE_PRINTER </dt> - <dd class="description">Start a printer</dd> - <dt>IPP_OP_ADD_DOCUMENT_IMAGES </dt> - <dd class="description">Add-Document-Images</dd> <dt>IPP_OP_CANCEL_CURRENT_JOB </dt> - <dd class="description">Cancel the current job</dd> - <dt>IPP_OP_CANCEL_DOCUMENT </dt> - <dd class="description">Cancel-Document</dd> + <dd class="description">Cancel-Current-Job: Cancel the current job</dd> <dt>IPP_OP_CANCEL_JOB </dt> - <dd class="description">Cancel a job</dd> + <dd class="description">Cancel-Job: Cancel a job</dd> <dt>IPP_OP_CANCEL_JOBS </dt> - <dd class="description">Cancel-Jobs</dd> + <dd class="description">Cancel-Jobs: Cancel all jobs (administrative)</dd> <dt>IPP_OP_CANCEL_MY_JOBS </dt> - <dd class="description">Cancel-My-Jobs</dd> + <dd class="description">Cancel-My-Jobs: Cancel a user's jobs</dd> <dt>IPP_OP_CANCEL_SUBSCRIPTION <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> - <dd class="description">Cancel a subscription </dd> + <dd class="description">Cancel-Subscription: Cancel a subscription </dd> <dt>IPP_OP_CLOSE_JOB </dt> - <dd class="description">Close-Job</dd> + <dd class="description">Close-Job: Close a job and start printing</dd> <dt>IPP_OP_CREATE_JOB </dt> - <dd class="description">Create an empty print job</dd> + <dd class="description">Create-Job: Create an empty print job</dd> <dt>IPP_OP_CREATE_JOB_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> - <dd class="description">Create one of more job subscriptions </dd> + <dd class="description">Create-Job-Subscriptions: Create one of more job subscriptions </dd> <dt>IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> - <dd class="description">Create one or more printer subscriptions </dd> - <dt>IPP_OP_CUPS_ACCEPT_JOBS </dt> - <dd class="description">Accept new jobs on a printer</dd> + <dd class="description">Create-Printer-Subscriptions: Create one or more printer subscriptions </dd> <dt>IPP_OP_CUPS_ADD_MODIFY_CLASS </dt> - <dd class="description">Add or modify a class</dd> + <dd class="description">CUPS-Add-Modify-Class: Add or modify a class</dd> <dt>IPP_OP_CUPS_ADD_MODIFY_PRINTER </dt> - <dd class="description">Add or modify a printer</dd> + <dd class="description">CUPS-Add-Modify-Printer: Add or modify a printer</dd> <dt>IPP_OP_CUPS_AUTHENTICATE_JOB <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> - <dd class="description">Authenticate a job </dd> + <dd class="description">CUPS-Authenticate-Job: Authenticate a job </dd> <dt>IPP_OP_CUPS_CREATE_LOCAL_PRINTER <span class="info"> CUPS 2.2 </span></dt> - <dd class="description">Create a local (temporary) printer </dd> + <dd class="description">CUPS-Create-Local-Printer: Create a local (temporary) printer </dd> <dt>IPP_OP_CUPS_DELETE_CLASS </dt> - <dd class="description">Delete a class</dd> + <dd class="description">CUPS-Delete-Class: Delete a class</dd> <dt>IPP_OP_CUPS_DELETE_PRINTER </dt> - <dd class="description">Delete a printer</dd> - <dt>IPP_OP_CUPS_GET_CLASSES <span class="info"> DEPRECATED </span></dt> - <dd class="description">Get a list of classes </dd> + <dd class="description">CUPS-Delete-Printer: Delete a printer</dd> <dt>IPP_OP_CUPS_GET_DEFAULT </dt> - <dd class="description">Get the default printer</dd> + <dd class="description">CUPS-Get-Default: Get the default printer</dd> <dt>IPP_OP_CUPS_GET_DEVICES <span class="info"> DEPRECATED </span></dt> - <dd class="description">Get a list of supported devices </dd> + <dd class="description">CUPS-Get-Devices: Get a list of supported devices </dd> <dt>IPP_OP_CUPS_GET_DOCUMENT <span class="info"> CUPS 1.4/macOS 10.6 </span></dt> - <dd class="description">Get a document file </dd> + <dd class="description">CUPS-Get-Document: Get a document file </dd> <dt>IPP_OP_CUPS_GET_PPD <span class="info"> DEPRECATED </span></dt> - <dd class="description">Get a PPD file </dd> + <dd class="description">CUPS-Get-PPD: Get a PPD file </dd> <dt>IPP_OP_CUPS_GET_PPDS <span class="info"> DEPRECATED </span></dt> - <dd class="description">Get a list of supported drivers </dd> + <dd class="description">CUPS-Get-PPDs: Get a list of supported drivers </dd> <dt>IPP_OP_CUPS_GET_PRINTERS </dt> - <dd class="description">Get a list of printers and/or classes</dd> + <dd class="description">CUPS-Get-Printers: Get a list of printers and/or classes</dd> <dt>IPP_OP_CUPS_INVALID </dt> <dd class="description">Invalid operation name for <a href="#ippOpValue"><code>ippOpValue</code></a></dd> <dt>IPP_OP_CUPS_MOVE_JOB </dt> - <dd class="description">Move a job to a different printer</dd> - <dt>IPP_OP_CUPS_REJECT_JOBS </dt> - <dd class="description">Reject new jobs on a printer</dd> + <dd class="description">CUPS-Move-Job: Move a job to a different printer</dd> <dt>IPP_OP_CUPS_SET_DEFAULT </dt> - <dd class="description">Set the default printer</dd> - <dt>IPP_OP_DEACTIVATE_PRINTER </dt> - <dd class="description">Stop a printer</dd> - <dt>IPP_OP_DELETE_DOCUMENT </dt> - <dd class="description">Delete-Document</dd> - <dt>IPP_OP_DEREGISTER_OUTPUT_DEVICE </dt> - <dd class="description">Deregister-Output-Device</dd> + <dd class="description">CUPS-Set-Default: Set the default printer</dd> <dt>IPP_OP_DISABLE_PRINTER </dt> - <dd class="description">Stop a printer</dd> + <dd class="description">Disable-Printer: Reject new jobs for a printer</dd> <dt>IPP_OP_ENABLE_PRINTER </dt> - <dd class="description">Start a printer</dd> - <dt>IPP_OP_FETCH_DOCUMENT </dt> - <dd class="description">Fetch-Document</dd> - <dt>IPP_OP_FETCH_JOB </dt> - <dd class="description">Fetch-Job</dd> - <dt>IPP_OP_GET_DOCUMENTS </dt> - <dd class="description">Get-Documents</dd> - <dt>IPP_OP_GET_DOCUMENT_ATTRIBUTES </dt> - <dd class="description">Get-Document-Attributes</dd> + <dd class="description">Enable-Printer: Accept new jobs for a printer</dd> <dt>IPP_OP_GET_JOBS </dt> - <dd class="description">Get a list of jobs</dd> + <dd class="description">Get-Jobs: Get a list of jobs</dd> <dt>IPP_OP_GET_JOB_ATTRIBUTES </dt> - <dd class="description">Get job attributes</dd> - <dt>IPP_OP_GET_NEXT_DOCUMENT_DATA </dt> - <dd class="description">Get-Next-Document-Data</dd> + <dd class="description">Get-Job-Attribute: Get information about a job</dd> <dt>IPP_OP_GET_NOTIFICATIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> - <dd class="description">Get notification events </dd> - <dt>IPP_OP_GET_OUTPUT_DEVICE_ATTRIBUTES </dt> - <dd class="description">Get-Output-Device-Attributes</dd> + <dd class="description">Get-Notifications: Get notification events </dd> <dt>IPP_OP_GET_PRINTER_ATTRIBUTES </dt> - <dd class="description">Get printer attributes</dd> + <dd class="description">Get-Printer-Attributes: Get information about a printer</dd> <dt>IPP_OP_GET_PRINTER_SUPPORTED_VALUES </dt> - <dd class="description">Get supported attribute values</dd> + <dd class="description">Get-Printer-Supported-Values: Get supported values</dd> <dt>IPP_OP_GET_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> - <dd class="description">Get list of subscriptions </dd> + <dd class="description">Get-Subscriptions: Get list of subscriptions </dd> <dt>IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> - <dd class="description">Get subscription attributes </dd> + <dd class="description">Get-Subscription-Attributes: Get subscription information </dd> <dt>IPP_OP_HOLD_JOB </dt> - <dd class="description">Hold a job for printing</dd> + <dd class="description">Hold-Job: Hold a job for printing</dd> <dt>IPP_OP_HOLD_NEW_JOBS </dt> - <dd class="description">Hold new jobs</dd> + <dd class="description">Hold-New-Jobs: Hold new jobs</dd> <dt>IPP_OP_IDENTIFY_PRINTER </dt> - <dd class="description">Identify-Printer</dd> + <dd class="description">Identify-Printer: Make the printer beep, flash, or display a message for identification</dd> <dt>IPP_OP_PAUSE_PRINTER </dt> - <dd class="description">Stop a printer</dd> + <dd class="description">Pause-Printer: Stop a printer</dd> <dt>IPP_OP_PAUSE_PRINTER_AFTER_CURRENT_JOB </dt> - <dd class="description">Stop printer after the current job</dd> + <dd class="description">Pause-Printer-After-Current-Job: Stop printer after the current job</dd> <dt>IPP_OP_PRINT_JOB </dt> - <dd class="description">Print a single file</dd> - <dt>IPP_OP_PRINT_URI </dt> - <dd class="description">Print a single URL</dd> + <dd class="description">Print-Job: Print a single file</dd> <dt>IPP_OP_PROMOTE_JOB </dt> - <dd class="description">Promote a job to print sooner</dd> - <dt>IPP_OP_PURGE_JOBS </dt> - <dd class="description">Cancel all jobs</dd> + <dd class="description">Promote-Job: Promote a job to print sooner</dd> <dt>IPP_OP_RELEASE_HELD_NEW_JOBS </dt> - <dd class="description">Release new jobs</dd> + <dd class="description">Release-Held-New-Jobs: Release new jobs that were previously held</dd> <dt>IPP_OP_RELEASE_JOB </dt> - <dd class="description">Release a job for printing</dd> + <dd class="description">Release-Job: Release a job for printing</dd> <dt>IPP_OP_RENEW_SUBSCRIPTION <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> - <dd class="description">Renew a printer subscription </dd> - <dt>IPP_OP_REPROCESS_JOB </dt> - <dd class="description">Reprint a job</dd> - <dt>IPP_OP_RESTART_JOB </dt> - <dd class="description">Reprint a job</dd> - <dt>IPP_OP_RESTART_PRINTER </dt> - <dd class="description">Restart a printer</dd> - <dt>IPP_OP_RESUBMIT_JOB </dt> - <dd class="description">Resubmit-Job</dd> + <dd class="description">Renew-Subscription: Renew a printer subscription </dd> + <dt>IPP_OP_RESTART_JOB <span class="info"> DEPRECATED </span></dt> + <dd class="description">Restart-Job: Reprint a job </dd> <dt>IPP_OP_RESUME_JOB </dt> - <dd class="description">Resume the current job</dd> + <dd class="description">Resume-Job: Resume the current job</dd> <dt>IPP_OP_RESUME_PRINTER </dt> - <dd class="description">Start a printer</dd> + <dd class="description">Resume-Printer: Start a printer</dd> <dt>IPP_OP_SCHEDULE_JOB_AFTER </dt> - <dd class="description">Schedule a job to print after another</dd> + <dd class="description">Schedule-Job-After: Schedule a job to print after another</dd> <dt>IPP_OP_SEND_DOCUMENT </dt> - <dd class="description">Add a file to a job</dd> - <dt>IPP_OP_SEND_URI </dt> - <dd class="description">Add a URL to a job</dd> - <dt>IPP_OP_SET_DOCUMENT_ATTRIBUTES </dt> - <dd class="description">Set-Document-Attributes</dd> + <dd class="description">Send-Document: Add a file to a job</dd> <dt>IPP_OP_SET_JOB_ATTRIBUTES </dt> - <dd class="description">Set job attributes</dd> + <dd class="description">Set-Job-Attributes: Set job values</dd> <dt>IPP_OP_SET_PRINTER_ATTRIBUTES </dt> - <dd class="description">Set printer attributes</dd> - <dt>IPP_OP_SHUTDOWN_PRINTER </dt> - <dd class="description">Turn a printer off</dd> - <dt>IPP_OP_STARTUP_PRINTER </dt> - <dd class="description">Turn a printer on</dd> + <dd class="description">Set-Printer-Attributes: Set printer values</dd> <dt>IPP_OP_SUSPEND_CURRENT_JOB </dt> - <dd class="description">Suspend the current job</dd> - <dt>IPP_OP_UPDATE_ACTIVE_JOBS </dt> - <dd class="description">Update-Active-Jobs</dd> - <dt>IPP_OP_UPDATE_DOCUMENT_STATUS </dt> - <dd class="description">Update-Document-Status</dd> - <dt>IPP_OP_UPDATE_JOB_STATUS </dt> - <dd class="description">Update-Job-Status</dd> - <dt>IPP_OP_UPDATE_OUTPUT_DEVICE_ATTRIBUTES </dt> - <dd class="description">Update-Output-Device-Attributes</dd> - <dt>IPP_OP_VALIDATE_DOCUMENT </dt> - <dd class="description">Validate-Document</dd> + <dd class="description">Suspend-Current-Job: Suspend the current job</dd> <dt>IPP_OP_VALIDATE_JOB </dt> - <dd class="description">Validate job options</dd> + <dd class="description">Validate-Job: Validate job values prior to submission</dd> </dl> <h3 class="enumeration"><a id="ipp_orient_e">ipp_orient_e</a></h3> <p class="description">Orientation values</p> @@ -8334,8 +7756,6 @@ are server-oriented...</p> <dl> <dt>IPP_STATUS_CUPS_INVALID </dt> <dd class="description">Invalid status name for <a href="#ippErrorValue"><code>ippErrorValue</code></a></dd> - <dt>IPP_STATUS_CUPS_SEE_OTHER </dt> - <dd class="description">cups-see-other</dd> <dt>IPP_STATUS_ERROR_ACCOUNT_AUTHORIZATION_FAILED </dt> <dd class="description">client-error-account-authorization-failed</dd> <dt>IPP_STATUS_ERROR_ACCOUNT_CLOSED </dt> @@ -8372,8 +7792,8 @@ are server-oriented...</p> <dd class="description">cups-authentication-canceled - Authentication canceled by user </dd> <dt>IPP_STATUS_ERROR_CUPS_PKI <span class="info"> CUPS 1.5/macOS 10.7 </span></dt> <dd class="description">cups-pki-error - Error negotiating a secure connection </dd> - <dt>IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED </dt> - <dd class="description">cups-upgrade-required - TLS upgrade required</dd> + <dt>IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED <span class="info"> CUPS 1.5/macOS 10.7 </span></dt> + <dd class="description">cups-upgrade-required - TLS upgrade required </dd> <dt>IPP_STATUS_ERROR_DEVICE </dt> <dd class="description">server-error-device-error</dd> <dt>IPP_STATUS_ERROR_DOCUMENT_ACCESS </dt> @@ -8457,8 +7877,6 @@ are server-oriented...</p> <dl> <dt>IPP_TAG_ADMINDEFINE </dt> <dd class="description">Admin-defined value</dd> - <dt>IPP_TAG_BEGIN_COLLECTION </dt> - <dd class="description">Beginning of collection value</dd> <dt>IPP_TAG_BOOLEAN </dt> <dd class="description">Boolean value</dd> <dt>IPP_TAG_CHARSET </dt> @@ -8471,18 +7889,12 @@ are server-oriented...</p> <dd class="description">Default value</dd> <dt>IPP_TAG_DELETEATTR </dt> <dd class="description">Delete-attribute value</dd> - <dt>IPP_TAG_DOCUMENT </dt> - <dd class="description">Document group</dd> <dt>IPP_TAG_END </dt> <dd class="description">End-of-attributes</dd> - <dt>IPP_TAG_END_COLLECTION </dt> - <dd class="description">End of collection value</dd> <dt>IPP_TAG_ENUM </dt> <dd class="description">Enumeration value</dd> <dt>IPP_TAG_EVENT_NOTIFICATION </dt> <dd class="description">Event group</dd> - <dt>IPP_TAG_EXTENSION </dt> - <dd class="description">Extension point for 32-bit tags</dd> <dt>IPP_TAG_INTEGER </dt> <dd class="description">Integer value</dd> <dt>IPP_TAG_JOB </dt> @@ -8491,8 +7903,6 @@ are server-oriented...</p> <dd class="description">Keyword value</dd> <dt>IPP_TAG_LANGUAGE </dt> <dd class="description">Language value</dd> - <dt>IPP_TAG_MEMBERNAME </dt> - <dd class="description">Collection member name value</dd> <dt>IPP_TAG_MIMETYPE </dt> <dd class="description">MIME media type value</dd> <dt>IPP_TAG_NAME </dt> |