diff options
Diffstat (limited to 'doc/help')
| -rw-r--r-- | doc/help/api-array.html | 88 | ||||
| -rw-r--r-- | doc/help/api-cgi.html | 2 | ||||
| -rw-r--r-- | doc/help/api-cups.html | 96 | ||||
| -rw-r--r-- | doc/help/api-driver.html | 2 | ||||
| -rw-r--r-- | doc/help/api-filedir.html | 2 | ||||
| -rw-r--r-- | doc/help/api-filter.html | 4 | ||||
| -rw-r--r-- | doc/help/api-httpipp.html | 140 | ||||
| -rw-r--r-- | doc/help/api-mime.html | 2 | ||||
| -rw-r--r-- | doc/help/api-overview.html | 2 | ||||
| -rw-r--r-- | doc/help/api-ppd.html | 5 | ||||
| -rw-r--r-- | doc/help/api-ppdc.html | 2 | ||||
| -rw-r--r-- | doc/help/api-raster.html | 93 | ||||
| -rw-r--r-- | doc/help/postscript-driver.html | 17 | ||||
| -rw-r--r-- | doc/help/ppd-compiler.html | 17 | ||||
| -rw-r--r-- | doc/help/raster-driver.html | 17 | ||||
| -rw-r--r-- | doc/help/ref-cupsd-conf.html.in | 85 | ||||
| -rw-r--r-- | doc/help/spec-ppd.html | 869 |
17 files changed, 1073 insertions, 370 deletions
diff --git a/doc/help/api-array.html b/doc/help/api-array.html index fec426de9..2b47b3e13 100644 --- a/doc/help/api-array.html +++ b/doc/help/api-array.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { @@ -394,6 +396,7 @@ div.contents ul.subcontents li { <li><a href="#cupsArrayLast" title="Get the last element in the array.">cupsArrayLast</a></li> <li><a href="#cupsArrayNew" title="Create a new array.">cupsArrayNew</a></li> <li><a href="#cupsArrayNew2" title="Create a new array with hash.">cupsArrayNew2</a></li> +<li><a href="#cupsArrayNew3" title="Create a new array with hash and/or free function.">cupsArrayNew3</a></li> <li><a href="#cupsArrayNext" title="Get the next element in the array.">cupsArrayNext</a></li> <li><a href="#cupsArrayPrev" title="Get the previous element in the array.">cupsArrayPrev</a></li> <li><a href="#cupsArrayRemove" title="Remove an element from the array.">cupsArrayRemove</a></li> @@ -402,6 +405,8 @@ div.contents ul.subcontents li { <li><a href="#cupsArrayUserData" title="Return the user data for an array.">cupsArrayUserData</a></li> </ul></li> <li><a href="#TYPES">Data Types</a><ul class="code"> + <li><a href="#cups_acopy_func_t" title="Array element copy function">cups_acopy_func_t</a></li> + <li><a href="#cups_afree_func_t" title="Array element free function">cups_afree_func_t</a></li> <li><a href="#cups_ahash_func_t" title="Array hash function">cups_ahash_func_t</a></li> <li><a href="#cups_array_func_t" title="Array comparison function">cups_array_func_t</a></li> <li><a href="#cups_array_t" title="CUPS array type">cups_array_t</a></li> @@ -439,8 +444,9 @@ data.</p> <h3><a name='MANAGING_ARRAYS'>Managing Arrays</a></h3> <p>Arrays are created using either the -<a href='#cupsArrayNew'><code>cupsArrayNew</code></a> or -<a href='#cupsArrayNew2'><code>cupsArrayNew2</code></a> functions. The +<a href='#cupsArrayNew'><code>cupsArrayNew</code></a>, +<a href='#cupsArrayNew2'><code>cupsArrayNew2</code></a>, or +<a href='#cupsArrayNew2'><code>cupsArrayNew3</code></a> functions. The first function creates a new array with the specified callback function and user data pointer:</p> @@ -477,7 +483,7 @@ static int compare_func(void *first, void *second, void *user_data); static int hash_func(void *element, void *user_data); void *user_data; -<a href='#cups_array_t'>cups_array_t</a> *array = <a href='#cupsArrayNew2'>cupsArrayNew2</a>(compare_func, user_data, hash_func, HASH_SIZE); +<a href='#cups_array_t'>cups_array_t</a> *hash_array = <a href='#cupsArrayNew2'>cupsArrayNew2</a>(compare_func, user_data, hash_func, HASH_SIZE); </pre> <p>The hash function (type @@ -488,6 +494,25 @@ element and is called whenever you look up an element in the array with only limited by available memory, but generally should not be larger than 16384 to realize any performance improvement.</p> +<p>The <a href='#cupsArrayNew3'><code>cupsArrayNew3</code></a> function adds +copy and free callbacks to support basic memory management of elements:</p> + +<pre class='example'> +#include <cups/array.h> + +#define HASH_SIZE 512 /* Size of hash table */ + +static int compare_func(void *first, void *second, void *user_data); +static void *copy_func(void *element, void *user_data); +static void free_func(void *element, void *user_data); +static int hash_func(void *element, void *user_data); + +void *user_data; +<a href='#cups_array_t'>cups_array_t</a> *array = <a href='#cupsArrayNew3'>cupsArrayNew3</a>(compare_func, user_data, NULL, 0, copy_func, free_func); + +<a href='#cups_array_t'>cups_array_t</a> *hash_array = <a href='#cupsArrayNew3'>cupsArrayNew3</a>(compare_func, user_data, hash_func, HASH_SIZE, copy_func, free_func); +</pre> + <p>Once you have created the array, you add elements using the <a href='#cupsArrayAdd'><code>cupsArrayAdd</code></a> <a href='#cupsArrayInsert'><code>cupsArrayInsert</code></a> functions. @@ -536,8 +561,7 @@ example:</p> <p>Finally, you free the memory used by the array using the <a href='#cupsArrayDelete'><code>cupsArrayDelete</code></a> function. All of the memory for the array and hash table (if any) is freed, however <em>CUPS -does not free the elements</em> - if necessary, you must allocate and free the -elements yourself.</p> +does not free the elements unless you provide copy and free functions</em>.</p> <h3><a name='FINDING_AND_ENUMERATING'>Finding and Enumerating Elements</a></h3> @@ -849,6 +873,50 @@ The hash function ("h") is used to implement cached lookups with the specified hash size ("hsize"). </p> +<h3 class="function"><span class="info"> CUPS 1.5 </span><a name="cupsArrayNew3">cupsArrayNew3</a></h3> +<p class="description">Create a new array with hash and/or free function.</p> +<p class="code"> +<a href="#cups_array_t">cups_array_t</a> *cupsArrayNew3 (<br> + <a href="#cups_array_func_t">cups_array_func_t</a> f,<br> + void *d,<br> + <a href="#cups_ahash_func_t">cups_ahash_func_t</a> h,<br> + int hsize,<br> + <a href="#cups_acopy_func_t">cups_acopy_func_t</a> cf,<br> + <a href="#cups_afree_func_t">cups_afree_func_t</a> ff<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>f</dt> +<dd class="description">Comparison function or <code>NULL</code> for an unsorted array</dd> +<dt>d</dt> +<dd class="description">User data or <code>NULL</code></dd> +<dt>h</dt> +<dd class="description">Hash function or <code>NULL</code> for unhashed lookups</dd> +<dt>hsize</dt> +<dd class="description">Hash size (>= 0)</dd> +<dt>cf</dt> +<dd class="description">Copy function</dd> +<dt>ff</dt> +<dd class="description">Free function</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">Array</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">The comparison function ("f") is used to create a sorted array. The function +receives pointers to two elements and the user data pointer ("d") - the user +data pointer argument can safely be omitted when not required so functions +like <code>strcmp</code> can be used for sorted string arrays.<br> +<br> +The hash function ("h") is used to implement cached lookups with the +specified hash size ("hsize").<br> +<br> +The copy function ("cf") is used to automatically copy/retain elements when +added or the array is copied.<br> +<br> +The free function ("cf") is used to automatically free/release elements when +removed or the array is deleted. + +</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="cupsArrayNext">cupsArrayNext</a></h3> <p class="description">Get the next element in the array.</p> <p class="code"> @@ -963,6 +1031,16 @@ void *cupsArrayUserData (<br> <h4 class="returnvalue">Return Value</h4> <p class="description">User data</p> <h2 class="title"><a name="TYPES">Data Types</a></h2> +<h3 class="typedef"><a name="cups_acopy_func_t">cups_acopy_func_t</a></h3> +<p class="description">Array element copy function</p> +<p class="code"> +typedef void *(*cups_acopy_func_t)(void *element, void *data); +</p> +<h3 class="typedef"><a name="cups_afree_func_t">cups_afree_func_t</a></h3> +<p class="description">Array element free function</p> +<p class="code"> +typedef void (*cups_afree_func_t)(void *element, void *data); +</p> <h3 class="typedef"><a name="cups_ahash_func_t">cups_ahash_func_t</a></h3> <p class="description">Array hash function</p> <p class="code"> diff --git a/doc/help/api-cgi.html b/doc/help/api-cgi.html index bdcd5c21f..a1b75197f 100644 --- a/doc/help/api-cgi.html +++ b/doc/help/api-cgi.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { diff --git a/doc/help/api-cups.html b/doc/help/api-cups.html index d53d09f0f..796248bba 100644 --- a/doc/help/api-cups.html +++ b/doc/help/api-cups.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { @@ -428,8 +430,6 @@ for the given language.">cupsLangEncoding</a></li> <li><a href="#cupsLangFlush" title="Flush all language data out of the cache.">cupsLangFlush</a></li> <li><a href="#cupsLangFree" title="Free language data.">cupsLangFree</a></li> <li><a href="#cupsLangGet" title="Get a language.">cupsLangGet</a></li> -<li><a href="#cupsLastError" title="Return the last IPP status code.">cupsLastError</a></li> -<li><a href="#cupsLastErrorString" title="Return the last IPP status-message.">cupsLastErrorString</a></li> <li><a href="#cupsNotifySubject" title="Return the subject for the given notification message.">cupsNotifySubject</a></li> <li><a href="#cupsNotifyText" title="Return the text for the given notification message.">cupsNotifyText</a></li> <li><a href="#cupsParseOptions" title="Parse options from a command-line argument.">cupsParseOptions</a></li> @@ -443,6 +443,9 @@ specified server.">cupsPrintFiles2</a></li> <li><a href="#cupsRemoveDest" title="Remove a destination from the destination list.">cupsRemoveDest</a></li> <li><a href="#cupsRemoveOption" title="Remove an option from an option array.">cupsRemoveOption</a></li> <li><a href="#cupsServer" title="Return the hostname/address of the current server.">cupsServer</a></li> +<li><a href="#cupsSetClientCertCB" title="Set the client certificate callback.">cupsSetClientCertCB</a></li> +<li><a href="#cupsSetCredentials" title="Set the default credentials to be used for SSL/TLS +connections.">cupsSetCredentials</a></li> <li><a href="#cupsSetDefaultDest" title="Set the default destination.">cupsSetDefaultDest</a></li> <li><a href="#cupsSetDests" title="Save the list of destinations for the default server.">cupsSetDests</a></li> <li><a href="#cupsSetDests2" title="Save the list of destinations for the specified server.">cupsSetDests2</a></li> @@ -450,6 +453,7 @@ specified server.">cupsPrintFiles2</a></li> <li><a href="#cupsSetPasswordCB" title="Set the password callback for CUPS.">cupsSetPasswordCB</a></li> <li><a href="#cupsSetPasswordCB2" title="Set the advanced password callback for CUPS.">cupsSetPasswordCB2</a></li> <li><a href="#cupsSetServer" title="Set the default server name and port.">cupsSetServer</a></li> +<li><a href="#cupsSetServerCertCB" title="Set the server certificate callback.">cupsSetServerCertCB</a></li> <li><a href="#cupsSetUser" title="Set the default user name.">cupsSetUser</a></li> <li><a href="#cupsStartDocument" title="Add a document to a job created with cupsCreateJob().">cupsStartDocument</a></li> <li><a href="#cupsTempFd" title="Creates a temporary file.">cupsTempFd</a></li> @@ -458,6 +462,7 @@ specified server.">cupsPrintFiles2</a></li> <li><a href="#cupsUser" title="Return the current user's name.">cupsUser</a></li> </ul></li> <li><a href="#TYPES">Data Types</a><ul class="code"> + <li><a href="#cups_client_cert_cb_t" title="Client credentials callback ">cups_client_cert_cb_t</a></li> <li><a href="#cups_dest_t" title="Destination">cups_dest_t</a></li> <li><a href="#cups_device_cb_t" title="Device callback ">cups_device_cb_t</a></li> <li><a href="#cups_job_t" title="Job">cups_job_t</a></li> @@ -465,6 +470,7 @@ specified server.">cupsPrintFiles2</a></li> <li><a href="#cups_password_cb2_t" title="New password callback ">cups_password_cb2_t</a></li> <li><a href="#cups_password_cb_t" title="Password callback">cups_password_cb_t</a></li> <li><a href="#cups_ptype_t" title="Printer type/capability bits">cups_ptype_t</a></li> + <li><a href="#cups_server_cert_cb_t" title="Server credentials callback ">cups_server_cert_cb_t</a></li> </ul></li> <li><a href="#STRUCTURES">Structures</a><ul class="code"> <li><a href="#cups_dest_s" title="Destination">cups_dest_s</a></li> @@ -1716,18 +1722,6 @@ cups_lang_t *cupsLangGet (<br> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Language data</p> -<h3 class="function"><a name="cupsLastError">cupsLastError</a></h3> -<p class="description">Return the last IPP status code.</p> -<p class="code"> -ipp_status_t cupsLastError (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">IPP status code from last request</p> -<h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="cupsLastErrorString">cupsLastErrorString</a></h3> -<p class="description">Return the last IPP status-message.</p> -<p class="code"> -const char *cupsLastErrorString (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">status-message text from last request</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="cupsNotifySubject">cupsNotifySubject</a></h3> <p class="description">Return the subject for the given notification message.</p> <p class="code"> @@ -1975,6 +1969,48 @@ Note: The current server is tracked separately for each thread in a program. Multi-threaded programs that override the server via the <a href="#cupsSetServer"><code>cupsSetServer</code></a> function need to do so in each thread for the same server to be used.</p> +<h3 class="function"><span class="info"> CUPS 1.5 </span><a name="cupsSetClientCertCB">cupsSetClientCertCB</a></h3> +<p class="description">Set the client certificate callback.</p> +<p class="code"> +void cupsSetClientCertCB (<br> + <a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a> cb,<br> + void *user_data<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>cb</dt> +<dd class="description">Callback function</dd> +<dt>user_data</dt> +<dd class="description">User data pointer</dd> +</dl> +<h4 class="discussion">Discussion</h4> +<p class="discussion">Pass <code>NULL</code> to restore the default callback.<br> +<br> +Note: The current certificate callback is tracked separately for each thread +in a program. Multi-threaded programs that override the callback need to do +so in each thread for the same callback to be used. + +</p> +<h3 class="function"><span class="info"> CUPS 1.5 </span><a name="cupsSetCredentials">cupsSetCredentials</a></h3> +<p class="description">Set the default credentials to be used for SSL/TLS +connections.</p> +<p class="code"> +int cupsSetCredentials (<br> + cups_array_t *credentials<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>credentials</dt> +<dd class="description">Array of credentials</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">Status of call (0 = success)</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">Note: The default credentials are tracked separately for each thread in a +program. Multi-threaded programs that override the setting need to do so in +each thread for the same setting to be used. + +</p> <h3 class="function"><span class="info"> CUPS 1.3/Mac OS X 10.5 </span><a name="cupsSetDefaultDest">cupsSetDefaultDest</a></h3> <p class="description">Set the default destination.</p> <p class="code"> @@ -2122,6 +2158,28 @@ default server name and port.<br> Note: The current server is tracked separately for each thread in a program. Multi-threaded programs that override the server need to do so in each thread for the same server to be used.</p> +<h3 class="function"><span class="info"> CUPS 1.5 </span><a name="cupsSetServerCertCB">cupsSetServerCertCB</a></h3> +<p class="description">Set the server certificate callback.</p> +<p class="code"> +void cupsSetServerCertCB (<br> + <a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a> cb,<br> + void *user_data<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>cb</dt> +<dd class="description">Callback function</dd> +<dt>user_data</dt> +<dd class="description">User data pointer</dd> +</dl> +<h4 class="discussion">Discussion</h4> +<p class="discussion">Pass <code>NULL</code> to restore the default callback.<br> +<br> +Note: The current credentials callback is tracked separately for each thread +in a program. Multi-threaded programs that override the callback need to do +so in each thread for the same callback to be used. + +</p> <h3 class="function"><a name="cupsSetUser">cupsSetUser</a></h3> <p class="description">Set the default user name.</p> <p class="code"> @@ -2251,6 +2309,11 @@ program. Multi-threaded programs that override the user name with the <a href="#cupsSetUser"><code>cupsSetUser</code></a> function need to do so in each thread for the same user name to be used.</p> <h2 class="title"><a name="TYPES">Data Types</a></h2> +<h3 class="typedef"><span class="info"> CUPS 1.5 </span><a name="cups_client_cert_cb_t">cups_client_cert_cb_t</a></h3> +<p class="description">Client credentials callback </p> +<p class="code"> +typedef int (*cups_client_cert_cb_t)(http_t *http, void *tls, cups_array_t *distinguished_names, void *user_data); +</p> <h3 class="typedef"><a name="cups_dest_t">cups_dest_t</a></h3> <p class="description">Destination</p> <p class="code"> @@ -2286,6 +2349,11 @@ typedef const char *(*cups_password_cb_t)(const char *prompt); <p class="code"> typedef unsigned cups_ptype_t; </p> +<h3 class="typedef"><span class="info"> CUPS 1.5 </span><a name="cups_server_cert_cb_t">cups_server_cert_cb_t</a></h3> +<p class="description">Server credentials callback </p> +<p class="code"> +typedef int (*cups_server_cert_cb_t)(http_t *http, void *tls, cups_array_t *certs, void *user_data); +</p> <h2 class="title"><a name="STRUCTURES">Structures</a></h2> <h3 class="struct"><a name="cups_dest_s">cups_dest_s</a></h3> <p class="description">Destination</p> diff --git a/doc/help/api-driver.html b/doc/help/api-driver.html index 4f221310b..2f456ea0c 100644 --- a/doc/help/api-driver.html +++ b/doc/help/api-driver.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { diff --git a/doc/help/api-filedir.html b/doc/help/api-filedir.html index 7f4dd9473..d79857834 100644 --- a/doc/help/api-filedir.html +++ b/doc/help/api-filedir.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { diff --git a/doc/help/api-filter.html b/doc/help/api-filter.html index 568aa07b8..48ed8dcb4 100644 --- a/doc/help/api-filter.html +++ b/doc/help/api-filter.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { @@ -375,7 +377,7 @@ div.contents ul.subcontents li { Programming: <a href='api-raster.html' target='_top'>Raster API</a><br> Programming: <a href='postscript-driver.html' target='_top'>Developing PostScript Printer Drivers</a><br> Programming: <a href='raster-driver.html' target='_top'>Developing Raster Printer Drivers</a><br> - Specifications: <a href='spec-design' target='_top'>CUPS Design Description</a></td> + Specifications: <a href='spec-design.html' target='_top'>CUPS Design Description</a></td> </tr> </tbody> </table></div> diff --git a/doc/help/api-httpipp.html b/doc/help/api-httpipp.html index 6753a8d92..98878ddab 100644 --- a/doc/help/api-httpipp.html +++ b/doc/help/api-httpipp.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { @@ -393,11 +395,14 @@ div.contents ul.subcontents li { <li><a href="#cupsGetFd" title="Get a file from the server.">cupsGetFd</a></li> <li><a href="#cupsGetFile" title="Get a file from the server.">cupsGetFile</a></li> <li><a href="#cupsGetResponse" title="Get a response to an IPP request.">cupsGetResponse</a></li> +<li><a href="#cupsLastError" title="Return the last IPP status code.">cupsLastError</a></li> +<li><a href="#cupsLastErrorString" title="Return the last IPP status-message.">cupsLastErrorString</a></li> <li><a href="#cupsPutFd" title="Put a file on the server.">cupsPutFd</a></li> <li><a href="#cupsPutFile" title="Put a file on the server.">cupsPutFile</a></li> <li><a href="#cupsReadResponseData" title="Read additional data after the IPP response.">cupsReadResponseData</a></li> <li><a href="#cupsSendRequest" title="Send an IPP request.">cupsSendRequest</a></li> <li><a href="#cupsWriteRequestData" title="Write additional data after an IPP request.">cupsWriteRequestData</a></li> +<li><a href="#httpAddCredential" title="Allocates and adds a single credential to an array.">httpAddCredential</a></li> <li><a href="#httpAddrAny" title="Check for the "any" address.">httpAddrAny</a></li> <li><a href="#httpAddrEqual" title="Compare two addresses.">httpAddrEqual</a></li> <li><a href="#httpAddrLength" title="Return the length of the address in bytes.">httpAddrLength</a></li> @@ -412,9 +417,11 @@ components with a formatted resource.">httpAssembleURIf</a></li> <li><a href="#httpCheck" title="Check to see if there is a pending response from the server.">httpCheck</a></li> <li><a href="#httpClearCookie" title="Clear the cookie value(s).">httpClearCookie</a></li> <li><a href="#httpClearFields" title="Clear HTTP request fields.">httpClearFields</a></li> -<li><a href="#httpClose" title="Close an HTTP connection...">httpClose</a></li> +<li><a href="#httpClose" title="Close an HTTP connection.">httpClose</a></li> <li><a href="#httpConnect" title="Connect to a HTTP server.">httpConnect</a></li> <li><a href="#httpConnectEncrypt" title="Connect to a HTTP server using encryption.">httpConnectEncrypt</a></li> +<li><a href="#httpCopyCredentials" title="Copy the credentials associated with an encrypted +connection.">httpCopyCredentials</a></li> <li><a href="#httpDecode64" title="Base64-decode a string.">httpDecode64</a></li> <li><a href="#httpDecode64_2" title="Base64-decode a string.">httpDecode64_2</a></li> <li><a href="#httpDelete" title="Send a DELETE request to the server.">httpDelete</a></li> @@ -424,6 +431,7 @@ components with a formatted resource.">httpAssembleURIf</a></li> <li><a href="#httpError" title="Get the last error on a connection.">httpError</a></li> <li><a href="#httpFlush" title="Flush data from a HTTP connection.">httpFlush</a></li> <li><a href="#httpFlushWrite" title="Flush data in write buffer.">httpFlushWrite</a></li> +<li><a href="#httpFreeCredentials" title="Free an array of credentials.">httpFreeCredentials</a></li> <li><a href="#httpGet" title="Send a GET request to the server.">httpGet</a></li> <li><a href="#httpGetAuthString" title="Get the current authorization string.">httpGetAuthString</a></li> <li><a href="#httpGetBlocking" title="Get the blocking/non-block state of a connection.">httpGetBlocking</a></li> @@ -465,7 +473,9 @@ components.">httpSeparate2</a></li> <li><a href="#httpSeparateURI" title="Separate a Universal Resource Identifier into its components.">httpSeparateURI</a></li> <li><a href="#httpSetAuthString" title="Set the current authorization string.">httpSetAuthString</a></li> -<li><a href="#httpSetCookie" title="Set the cookie value(s)...">httpSetCookie</a></li> +<li><a href="#httpSetCookie" title="Set the cookie value(s).">httpSetCookie</a></li> +<li><a href="#httpSetCredentials" title="Set the credentials associated with an encrypted +connection.">httpSetCredentials</a></li> <li><a href="#httpSetExpect" title="Set the Expect: header in a request.">httpSetExpect</a></li> <li><a href="#httpSetField" title="Set the value of an HTTP header.">httpSetField</a></li> <li><a href="#httpSetLength" title="Set the content-length and content-encoding.">httpSetLength</a></li> @@ -525,6 +535,7 @@ used to enumerate all of the addresses that are associated with a hostname. ">http_addrlist_t</a></li> <li><a href="#http_auth_t" title="HTTP authentication types">http_auth_t</a></li> + <li><a href="#http_credential_t" title="Credential data ">http_credential_t</a></li> <li><a href="#http_encoding_t" title="HTTP transfer encoding values">http_encoding_t</a></li> <li><a href="#http_encryption_t" title="HTTP encryption values">http_encryption_t</a></li> <li><a href="#http_field_t" title="HTTP field names">http_field_t</a></li> @@ -557,6 +568,7 @@ are server-oriented...">http_state_t</a></li> used to enumerate all of the addresses that are associated with a hostname. ">http_addrlist_s</a></li> + <li><a href="#http_credential_s" title="Credential data ">http_credential_s</a></li> <li><a href="#ipp_attribute_s" title="Attribute">ipp_attribute_s</a></li> <li><a href="#ipp_s" title="IPP Request/Response/Notification">ipp_s</a></li> </ul></li> @@ -1172,6 +1184,18 @@ cupsSendDocument() or cupsSendRequest(). For requests that return additional data, use httpRead() after getting a successful response. </p> +<h3 class="function"><a name="cupsLastError">cupsLastError</a></h3> +<p class="description">Return the last IPP status code.</p> +<p class="code"> +ipp_status_t cupsLastError (void);</p> +<h4 class="returnvalue">Return Value</h4> +<p class="description">IPP status code from last request</p> +<h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="cupsLastErrorString">cupsLastErrorString</a></h3> +<p class="description">Return the last IPP status-message.</p> +<p class="code"> +const char *cupsLastErrorString (void);</p> +<h4 class="returnvalue">Return Value</h4> +<p class="description">status-message text from last request</p> <h3 class="function"><span class="info"> CUPS 1.1.20/Mac OS X 10.4 </span><a name="cupsPutFd">cupsPutFd</a></h3> <p class="description">Put a file on the server.</p> <p class="code"> @@ -1269,7 +1293,7 @@ files for CUPS_GET_PPD and CUPS_GET_DOCUMENT requests, respectively. <h4 class="discussion">Discussion</h4> <p class="discussion">Use httpWrite() to write any additional data (document, PPD file, etc.) for the request, cupsGetResponse() to get the IPP response, and httpRead() -to read any additional data following the response. Only one request can be +to read any additional data following the response. Only one request can be sent/queued at a time.<br> <br> Unlike cupsDoFileRequest(), cupsDoIORequest(), and cupsDoRequest(), the @@ -1300,6 +1324,29 @@ request is not freed. after <a href="#cupsStartDocument"><code>cupsStartDocument</code></a> to provide a document file. </p> +<h3 class="function"><span class="info"> CUPS 1.5 </span><a name="httpAddCredential">httpAddCredential</a></h3> +<p class="description">Allocates and adds a single credential to an array.</p> +<p class="code"> +int httpAddCredential (<br> + cups_array_t *credentials,<br> + const void *data,<br> + size_t datalen<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>credentials</dt> +<dd class="description">Credentials array</dd> +<dt>data</dt> +<dd class="description">PEM-encoded X.509 data</dd> +<dt>datalen</dt> +<dd class="description">Length of data</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">0 on success, -1 on error</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">Use <code>cupsArrayNew(NULL, NULL)</code> to create a credentials array. + +</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="httpAddrAny">httpAddrAny</a></h3> <p class="description">Check for the "any" address.</p> <p class="code"> @@ -1531,7 +1578,7 @@ void httpClearFields (<br> <dd class="description">Connection to server</dd> </dl> <h3 class="function"><a name="httpClose">httpClose</a></h3> -<p class="description">Close an HTTP connection...</p> +<p class="description">Close an HTTP connection.</p> <p class="code"> void httpClose (<br> <a href="#http_t">http_t</a> *http<br> @@ -1580,6 +1627,23 @@ void httpClose (<br> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">New HTTP connection</p> +<h3 class="function"><span class="info"> CUPS 1.5 </span><a name="httpCopyCredentials">httpCopyCredentials</a></h3> +<p class="description">Copy the credentials associated with an encrypted +connection.</p> +<p class="code"> +int httpCopyCredentials (<br> + <a href="#http_t">http_t</a> *http,<br> + cups_array_t **credentials<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to server</dd> +<dt>credentials</dt> +<dd class="description">Array of credentials</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">Status of call (0 = success)</p> <h3 class="function"><span class="info"> DEPRECATED </span><a name="httpDecode64">httpDecode64</a></h3> <p class="description">Base64-decode a string.</p> <p class="code"> @@ -1732,6 +1796,17 @@ int httpFlushWrite (<br> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Bytes written or -1 on error</p> +<h3 class="function"><a name="httpFreeCredentials">httpFreeCredentials</a></h3> +<p class="description">Free an array of credentials.</p> +<p class="code"> +void httpFreeCredentials (<br> + cups_array_t *credentials<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>credentials</dt> +<dd class="description">Array of credentials</dd> +</dl> <h3 class="function"><a name="httpGet">httpGet</a></h3> <p class="description">Send a GET request to the server.</p> <p class="code"> @@ -2356,7 +2431,7 @@ httpHead(), httpOptions(), httpPost, or httpPut(). </p> <h3 class="function"><span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span><a name="httpSetCookie">httpSetCookie</a></h3> -<p class="description">Set the cookie value(s)...</p> +<p class="description">Set the cookie value(s).</p> <p class="code"> void httpSetCookie (<br> <a href="#http_t">http_t</a> *http,<br> @@ -2369,6 +2444,23 @@ void httpSetCookie (<br> <dt>cookie</dt> <dd class="description">Cookie string</dd> </dl> +<h3 class="function"><span class="info"> CUPS 1.5 </span><a name="httpSetCredentials">httpSetCredentials</a></h3> +<p class="description">Set the credentials associated with an encrypted +connection.</p> +<p class="code"> +int httpSetCredentials (<br> + <a href="#http_t">http_t</a> *http,<br> + cups_array_t *credentials<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to server</dd> +<dt>credentials</dt> +<dd class="description">Array of credentials</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">Status of call (0 = success)</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="httpSetExpect">httpSetExpect</a></h3> <p class="description">Set the Expect: header in a request.</p> <p class="code"> @@ -3267,6 +3359,11 @@ typedef struct <a href="#http_addrlist_s">http_addrlist_s</a> / http_addrlist_t; <p class="code"> typedef enum <a href="#http_auth_e">http_auth_e</a> http_auth_t; </p> +<h3 class="typedef"><span class="info"> CUPS 1.5 </span><a name="http_credential_t">http_credential_t</a></h3> +<p class="description">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 name="http_encoding_t">http_encoding_t</a></h3> <p class="description">HTTP transfer encoding values</p> <p class="code"> @@ -3308,7 +3405,7 @@ typedef struct _http_s http_t; <p class="code"> typedef enum <a href="#http_uri_coding_e">http_uri_coding_e</a> http_uri_coding_t; </p> -<h3 class="typedef"><span class="info"> CUPS1.2 </span><a name="http_uri_status_t">http_uri_status_t</a></h3> +<h3 class="typedef"><span class="info"> CUPS 1.2 </span><a name="http_uri_status_t">http_uri_status_t</a></h3> <p class="description">URI separation status </p> <p class="code"> typedef enum <a href="#http_uri_status_e">http_uri_status_e</a> http_uri_status_t; @@ -3410,6 +3507,19 @@ with a hostname. </p> <dt>next </dt> <dd class="description">Pointer to next address in list</dd> </dl> +<h3 class="struct"><span class="info"> CUPS 1.5 </span><a name="http_credential_s">http_credential_s</a></h3> +<p class="description">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 name="ipp_attribute_s">ipp_attribute_s</a></h3> <p class="description">Attribute</p> <p class="code">struct ipp_attribute_s {<br> @@ -3460,8 +3570,8 @@ with a hostname. </p> <dd class="description">Request header</dd> <dt>state </dt> <dd class="description">State of request</dd> -<dt>use </dt> -<dd class="description">Use count</dd> +<dt>use <span class="info"> CUPS 1.4.4/Mac OS X 10.6.? </span></dt> +<dd class="description">Use count </dd> </dl> <h2 class="title"><a name="UNIONS">Unions</a></h2> <h3 class="union"><a name="ipp_request_u">ipp_request_u</a></h3> @@ -3646,8 +3756,8 @@ are server-oriented...</p> <dl> <dt>HTTP_ACCEPTED </dt> <dd class="description">DELETE command was successful</dd> -<dt>HTTP_AUTHORIZATION_CANCELED </dt> -<dd class="description">User cancelled authorization</dd> +<dt>HTTP_AUTHORIZATION_CANCELED <span class="info"> CUPS 1.4 </span></dt> +<dd class="description">User canceled authorization </dd> <dt>HTTP_BAD_GATEWAY </dt> <dd class="description">Bad gateway</dd> <dt>HTTP_BAD_REQUEST </dt> @@ -3698,6 +3808,8 @@ are server-oriented...</p> <dd class="description">Only a partial file was recieved/sent</dd> <dt>HTTP_PAYMENT_REQUIRED </dt> <dd class="description">Payment required</dd> +<dt>HTTP_PKI_ERROR <span class="info"> CUPS 1.5 </span></dt> +<dd class="description">Error negotiating a secure connection </dd> <dt>HTTP_PRECONDITION </dt> <dd class="description">Precondition failed</dd> <dt>HTTP_PROXY_AUTHENTICATION </dt> @@ -3748,7 +3860,7 @@ are server-oriented...</p> <dt>HTTP_URI_CODING_USERNAME </dt> <dd class="description">En/decode the username portion</dd> </dl> -<h3 class="enumeration"><span class="info"> CUPS1.2 </span><a name="http_uri_status_e">http_uri_status_e</a></h3> +<h3 class="enumeration"><span class="info"> CUPS 1.2 </span><a name="http_uri_status_e">http_uri_status_e</a></h3> <p class="description">URI separation status </p> <h4 class="constants">Constants</h4> <dl> @@ -4032,6 +4144,8 @@ are server-oriented...</p> <dd class="description">client-error-attributes-or-values-not-supported</dd> <dt>IPP_ATTRIBUTES_NOT_SETTABLE </dt> <dd class="description">client-error-attributes-not-settable</dd> +<dt>IPP_AUTHENTICATION_CANCELED <span class="info"> CUPS 1.5 </span></dt> +<dd class="description">Authentication canceled by user </dd> <dt>IPP_BAD_REQUEST </dt> <dd class="description">client-error-bad-request</dd> <dt>IPP_CHARSET </dt> @@ -4092,6 +4206,8 @@ are server-oriented...</p> <dd class="description">successful-ok-too-many-events</dd> <dt>IPP_OPERATION_NOT_SUPPORTED </dt> <dd class="description">server-error-operation-not-supported</dd> +<dt>IPP_PKI_ERROR <span class="info"> CUPS 1.5 </span></dt> +<dd class="description">Error negotiating a secure connection </dd> <dt>IPP_PRINTER_BUSY </dt> <dd class="description">server-error-busy</dd> <dt>IPP_PRINTER_IS_DEACTIVATED </dt> @@ -4110,6 +4226,8 @@ are server-oriented...</p> <dd class="description">client-error-timeout</dd> <dt>IPP_TOO_MANY_SUBSCRIPTIONS </dt> <dd class="description">client-error-too-many-subscriptions</dd> +<dt>IPP_UPGRADE_REQUIRED </dt> +<dd class="description">TLS upgrade required</dd> <dt>IPP_URI_SCHEME </dt> <dd class="description">client-error-uri-scheme-not-supported</dd> <dt>IPP_VERSION_NOT_SUPPORTED </dt> diff --git a/doc/help/api-mime.html b/doc/help/api-mime.html index 7b428490e..e904ddbd5 100644 --- a/doc/help/api-mime.html +++ b/doc/help/api-mime.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { diff --git a/doc/help/api-overview.html b/doc/help/api-overview.html index a5eb498a2..bdd3f612b 100644 --- a/doc/help/api-overview.html +++ b/doc/help/api-overview.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { diff --git a/doc/help/api-ppd.html b/doc/help/api-ppd.html index 6ac61beec..c6d6077ca 100644 --- a/doc/help/api-ppd.html +++ b/doc/help/api-ppd.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { @@ -1805,7 +1807,6 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; char *product;<br> <a href="#ppd_profile_t">ppd_profile_t</a> *profiles;<br> char *protocols;<br> - void *pwg;<br> char *shortnickname;<br> <a href="#ppd_size_t">ppd_size_t</a> *sizes;<br> int throughput;<br> @@ -1888,8 +1889,6 @@ typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; <dd class="description">sRGB color profiles </dd> <dt>protocols <span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span></dt> <dd class="description">Protocols (BCP, TBCP) string </dd> -<dt>pwg </dt> -<dd class="description">PWG to/from PPD mappings</dd> <dt>shortnickname </dt> <dd class="description">Short version of nickname</dd> <dt>sizes </dt> diff --git a/doc/help/api-ppdc.html b/doc/help/api-ppdc.html index d8bef72bb..e02f71d05 100644 --- a/doc/help/api-ppdc.html +++ b/doc/help/api-ppdc.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { diff --git a/doc/help/api-raster.html b/doc/help/api-raster.html index 93c816b88..3d7875cdc 100644 --- a/doc/help/api-raster.html +++ b/doc/help/api-raster.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { @@ -340,9 +342,9 @@ div.contents ul.subcontents li { <!-- "$Id$" - Raster API header for the Common UNIX Printing System (CUPS). + Raster API documentation for CUPS. - Copyright 2008-2009 by Apple Inc. + Copyright 2008-2010 by Apple Inc. These coded instructions, statements, and computer programs are the property of Apple Inc. and are protected by Federal copyright @@ -1186,20 +1188,52 @@ factor not applied) </dd> <p class="description">cupsColorSpace attribute values</p> <h4 class="constants">Constants</h4> <dl> +<dt>CUPS_CSPACE_ADOBERGB <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">Red, green, blue (Adobe RGB) </dd> <dt>CUPS_CSPACE_CIELab <span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span></dt> <dd class="description">CIE Lab </dd> <dt>CUPS_CSPACE_CIEXYZ <span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span></dt> <dd class="description">CIE XYZ </dd> <dt>CUPS_CSPACE_CMY </dt> -<dd class="description">Cyan, magenta, yellow</dd> +<dd class="description">Cyan, magenta, yellow (DeviceCMY)</dd> <dt>CUPS_CSPACE_CMYK </dt> -<dd class="description">Cyan, magenta, yellow, black</dd> -<dt>CUPS_CSPACE_GMCK </dt> -<dd class="description">Gold, magenta, yellow, black</dd> -<dt>CUPS_CSPACE_GMCS </dt> -<dd class="description">Gold, magenta, yellow, silver</dd> -<dt>CUPS_CSPACE_GOLD </dt> -<dd class="description">Gold foil</dd> +<dd class="description">Cyan, magenta, yellow, black (DeviceCMYK)</dd> +<dt>CUPS_CSPACE_DEVICE1 <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 1 color </dd> +<dt>CUPS_CSPACE_DEVICE2 <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 2 colors </dd> +<dt>CUPS_CSPACE_DEVICE3 <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 3 colors </dd> +<dt>CUPS_CSPACE_DEVICE4 <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 4 colors </dd> +<dt>CUPS_CSPACE_DEVICE5 <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 5 colors </dd> +<dt>CUPS_CSPACE_DEVICE6 <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 6 colors </dd> +<dt>CUPS_CSPACE_DEVICE7 <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 7 colors </dd> +<dt>CUPS_CSPACE_DEVICE8 <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 8 colors </dd> +<dt>CUPS_CSPACE_DEVICE9 <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 9 colors </dd> +<dt>CUPS_CSPACE_DEVICEA <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 10 colors </dd> +<dt>CUPS_CSPACE_DEVICEB <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 11 colors </dd> +<dt>CUPS_CSPACE_DEVICEC <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 12 colors </dd> +<dt>CUPS_CSPACE_DEVICED <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 13 colors </dd> +<dt>CUPS_CSPACE_DEVICEE <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 14 colors </dd> +<dt>CUPS_CSPACE_DEVICEF <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">DeviceN, 15 colors </dd> +<dt>CUPS_CSPACE_GMCK <span class="info"> DEPRECATED </span></dt> +<dd class="description">Gold, magenta, yellow, black </dd> +<dt>CUPS_CSPACE_GMCS <span class="info"> DEPRECATED </span></dt> +<dd class="description">Gold, magenta, yellow, silver </dd> +<dt>CUPS_CSPACE_GOLD <span class="info"> DEPRECATED </span></dt> +<dd class="description">Gold foil </dd> <dt>CUPS_CSPACE_ICC1 <span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span></dt> <dd class="description">ICC-based, 1 color </dd> <dt>CUPS_CSPACE_ICC2 <span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span></dt> @@ -1231,28 +1265,31 @@ factor not applied) </dd> <dt>CUPS_CSPACE_ICCF <span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span></dt> <dd class="description">ICC-based, 15 colors </dd> <dt>CUPS_CSPACE_K </dt> -<dd class="description">Black</dd> -<dt>CUPS_CSPACE_KCMY </dt> -<dd class="description">Black, cyan, magenta, yellow</dd> -<dt>CUPS_CSPACE_KCMYcm </dt> -<dd class="description">Black, cyan, magenta, yellow, * -light-cyan, light-magenta</dd> +<dd class="description">Black (DeviceK)</dd> +<dt>CUPS_CSPACE_KCMY <span class="info"> DEPRECATED </span></dt> +<dd class="description">Black, cyan, magenta, yellow </dd> +<dt>CUPS_CSPACE_KCMYcm <span class="info"> DEPRECATED </span></dt> +<dd class="description">Black, cyan, magenta, yellow, light-cyan, light-magenta </dd> <dt>CUPS_CSPACE_RGB </dt> -<dd class="description">Red, green, blue</dd> +<dd class="description">Red, green, blue (DeviceRGB, sRGB by default)</dd> <dt>CUPS_CSPACE_RGBA </dt> -<dd class="description">Red, green, blue, alpha</dd> +<dd class="description">Red, green, blue, alpha (DeviceRGB, sRGB by default)</dd> <dt>CUPS_CSPACE_RGBW <span class="info"> CUPS 1.2/Mac OS X 10.5 </span></dt> -<dd class="description">Red, green, blue, white </dd> -<dt>CUPS_CSPACE_SILVER </dt> -<dd class="description">Silver foil</dd> +<dd class="description">Red, green, blue, white (DeviceRGB, sRGB by default) </dd> +<dt>CUPS_CSPACE_SILVER <span class="info"> DEPRECATED </span></dt> +<dd class="description">Silver foil </dd> +<dt>CUPS_CSPACE_SRGB <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">Red, green, blue (sRGB) </dd> +<dt>CUPS_CSPACE_SW <span class="info"> CUPS 1.4.5 </span></dt> +<dd class="description">Luminance (gamma 2.2) </dd> <dt>CUPS_CSPACE_W </dt> -<dd class="description">Luminance</dd> -<dt>CUPS_CSPACE_WHITE </dt> -<dd class="description">White ink (as black)</dd> -<dt>CUPS_CSPACE_YMC </dt> -<dd class="description">Yellow, magenta, cyan</dd> -<dt>CUPS_CSPACE_YMCK </dt> -<dd class="description">Yellow, magenta, cyan, black</dd> +<dd class="description">Luminance (DeviceGray, gamma 2.2 by default)</dd> +<dt>CUPS_CSPACE_WHITE <span class="info"> DEPRECATED </span></dt> +<dd class="description">White ink (as black) </dd> +<dt>CUPS_CSPACE_YMC <span class="info"> DEPRECATED </span></dt> +<dd class="description">Yellow, magenta, cyan </dd> +<dt>CUPS_CSPACE_YMCK <span class="info"> DEPRECATED </span></dt> +<dd class="description">Yellow, magenta, cyan, black </dd> </dl> <h3 class="enumeration"><a name="cups_cut_e">cups_cut_e</a></h3> <p class="description">CutMedia attribute values</p> diff --git a/doc/help/postscript-driver.html b/doc/help/postscript-driver.html index 40a7db7aa..b74dc0364 100644 --- a/doc/help/postscript-driver.html +++ b/doc/help/postscript-driver.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { @@ -337,6 +339,21 @@ div.contents ul.subcontents li { </head> <body> <div class='body'> +<!-- + "$Id$" + + PostScript printer driver documentation for CUPS. + + Copyright 2007-2010 by Apple Inc. + Copyright 1997-2007 by Easy Software Products. + + These coded instructions, statements, and computer programs are the + 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/". +--> + <h1 class='title'>Developing PostScript Printer Drivers</h1> <p>This document describes how to develop printer drivers for PostScript printers. Topics include: <a href='#BASICS'>printer driver basics</a>, <a href='#CREATE'>creating new PPD files</a>, <a href='#IMPORT'>importing existing PPD files</a>, <a href='#FILTERS'>using custom filters</a>, <a href='#COLOR'>implementing color management</a>, and <a href='#MACOSX'>adding Mac OS X features</a>.</p> diff --git a/doc/help/ppd-compiler.html b/doc/help/ppd-compiler.html index c00d4dbdd..9a40ca88e 100644 --- a/doc/help/ppd-compiler.html +++ b/doc/help/ppd-compiler.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { @@ -337,6 +339,21 @@ div.contents ul.subcontents li { </head> <body> <div class='body'> +<!-- + "$Id$" + + PPD compiler documentation for CUPS. + + Copyright 2007-2010 by Apple Inc. + Copyright 1997-2007 by Easy Software Products. + + These coded instructions, statements, and computer programs are the + 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/". +--> + <h1 class='title'>Introduction to the PPD Compiler</h1> <P>This document describes how to use the CUPS PostScript Printer Description diff --git a/doc/help/raster-driver.html b/doc/help/raster-driver.html index fc85337c4..40346a66a 100644 --- a/doc/help/raster-driver.html +++ b/doc/help/raster-driver.html @@ -24,7 +24,9 @@ PRE { } PRE.command { + border: dotted thin #7f7f7f; margin-left: 36pt; + padding: 10px; } P.compact { @@ -337,6 +339,21 @@ div.contents ul.subcontents li { </head> <body> <div class='body'> +<!-- + "$Id$" + + Raster printer driver documentation for CUPS. + + Copyright 2007-2010 by Apple Inc. + Copyright 1997-2007 by Easy Software Products. + + These coded instructions, statements, and computer programs are the + 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/". +--> + <h1 class='title'>Developing Raster Printer Drivers</h1> <p>This document describes how to develop printer drivers for raster printers. Topics include: <a href='#BASICS'>printer driver basics</a>, <a href='#CREATE'>creating new PPD files</a>, <a href='#FILTERS'>using filters</a>, <a href='#COLOR'>implementing color management</a>, and <a href='#MACOSX'>adding Mac OS X features</a>.</p> diff --git a/doc/help/ref-cupsd-conf.html.in b/doc/help/ref-cupsd-conf.html.in index a35ca4af6..d3610cb84 100644 --- a/doc/help/ref-cupsd-conf.html.in +++ b/doc/help/ref-cupsd-conf.html.in @@ -1479,6 +1479,48 @@ the file is assumed to be relative to the <A HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory.</P> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.5</SPAN><A NAME="JobPrivateAccess">JobPrivateAccess</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +JobPrivateAccess all +JobPrivateAccess default +JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+ +</PRE> + +<H3>Description</H3> + +<P>The <CODE>JobPrivateAccess</CODE> directive specifies the access list for a +job's private values. The "default" access list is "@OWNER @SYSTEM". "@ACL" maps +to the printer's requesting-user-name-allowed or requesting-user-name-denied +values.</P> + +<P>The <CODE>JobPrivateAccess</CODE> directive must appear inside a <A +HREF="#Policy"><CODE>Policy</CODE></A> section.</P> + + +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.5</SPAN><A NAME="JobPrivateValues">JobPrivateValues</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +JobPrivateValues all +JobPrivateValues default +JobPrivateValues none +JobPrivateValues attribute-name-1 [ ... attribute-name-N ] +</PRE> + +<H3>Description</H3> + +<P>The <CODE>JobPrivateValues</CODE> directive specifies the list of job values +to make private. The "default" values are "job-name", +"job-originating-host-name", and "job-originating-user-name".</P> + +<P>The <CODE>JobPrivateValues</CODE> directive must appear inside a <A +HREF="#Policy"><CODE>Policy</CODE></A> section.</P> + + <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="JobRetryInterval">JobRetryInterval</A></H2> <H3>Examples</H3> @@ -2985,6 +3027,49 @@ on for secure connections. Multiple <CODE>SSLPort</CODE> lines can be specified to listen on multiple ports.</P> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.5</SPAN><A NAME="SubscriptionPrivateAccess">SubscriptionPrivateAccess</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +SubscriptionPrivateAccess all +SubscriptionPrivateAccess default +SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+ +</PRE> + +<H3>Description</H3> + +<P>The <CODE>SubscriptionPrivateAccess</CODE> directive specifies the access list for a +subscription's private values. The "default" access list is "@OWNER @SYSTEM". +"@ACL" maps to the printer's requesting-user-name-allowed or +requesting-user-name-denied values.</P> + +<P>The <CODE>SubscriptionPrivateAccess</CODE> directive must appear inside a <A +HREF="#Policy"><CODE>Policy</CODE></A> section.</P> + + +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.5</SPAN><A NAME="SubscriptionPrivateValues">SubscriptionPrivateValues</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +SubscriptionPrivateValues all +SubscriptionPrivateValues default +SubscriptionPrivateValues none +SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ] +</PRE> + +<H3>Description</H3> + +<P>The <CODE>SubscriptionPrivateValues</CODE> directive specifies the list of +subscription values to make private. The "default" values are "notify-events", +"notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and +"notify-user-data".</P> + +<P>The <CODE>SubscriptionPrivateValues</CODE> directive must appear inside a <A +HREF="#Policy"><CODE>Policy</CODE></A> section.</P> + + <H2 CLASS="title"><A NAME="SystemGroup">SystemGroup</A></H2> <H3>Examples</H3> diff --git a/doc/help/spec-ppd.html b/doc/help/spec-ppd.html index 3c81a763c..1343d71f2 100644 --- a/doc/help/spec-ppd.html +++ b/doc/help/spec-ppd.html @@ -2,15 +2,347 @@ <html> <!-- SECTION: Specifications --> <head> - <title>CUPS PPD Extensions</title> - <meta name='keywords' content='Programming, PostScript Printer Description'> - <link rel='stylesheet' type='text/css' href='../cups-printable.css'> +<title>CUPS PPD Extensions</title> +<meta name="keywords" content="Specifications"> +<meta name="creator" content="Mini-XML v2.6"> +<style type="text/css"><!-- +BODY { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +H1, H2, H3, H4, H5, H6, P, TD, TH { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +KBD { + font-family: monaco, courier, monospace; + font-weight: bold; +} + +PRE { + font-family: monaco, courier, monospace; +} + +PRE.command { + border: dotted thin #7f7f7f; + margin-left: 36pt; + padding: 10px; +} + +P.compact { + margin: 0; +} + +P.example { + font-style: italic; + margin-left: 36pt; +} + +PRE.example { + background: #eeeeee; + border: dotted thin #999999; + margin-left: 36pt; + padding: 10pt; +} + +PRE.command EM, PRE.example EM { + font-family: lucida grande, geneva, helvetica, arial, sans-serif; +} + +P.command { + font-family: monaco, courier, monospace; + margin-left: 36pt; +} + +P.formula { + font-style: italic; + margin-left: 36pt; +} + +BLOCKQUOTE { + background: #eeeeee; + border: solid thin #999999; + padding: 10pt; +} + +A IMG { + border: none; +} + +A:link:hover IMG { + background: #f0f0f0; + border-radius: 10px; + -moz-border-radius: 10px; +} + +A:link, A:visited { + font-weight: normal; + text-decoration: none; +} + +A:link:hover, A:visited:hover, A:active { + text-decoration: underline; +} + +SUB, SUP { + font-size: 50%; +} + +TR.data, TD.data, TR.data TD { + margin-top: 10pt; + padding: 5pt; + border-bottom: solid 1pt #999999; +} + +TR.data TH { + border-bottom: solid 1pt #999999; + padding-top: 10pt; + padding-left: 5pt; + text-align: left; +} + +DIV.table TABLE { + border: solid thin #999999; + border-collapse: collapse; + border-spacing: 0; + margin-left: auto; + margin-right: auto; +} + +DIV.table CAPTION { + caption-side: top; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +DIV.table TABLE TD { + border: solid thin #cccccc; + padding-top: 5pt; +} + +DIV.table TABLE TH { + background: #cccccc; + border: none; + border-bottom: solid thin #999999; +} + +DIV.figure TABLE { + margin-left: auto; + margin-right: auto; +} + +DIV.figure CAPTION { + caption-side: bottom; + font-size: 120%; + font-style: italic; + font-weight: bold; + margin-left: auto; + margin-right: auto; +} + +TH.label { + text-align: right; + vertical-align: top; +} + +TH.sublabel { + text-align: right; + font-weight: normal; +} + +HR { + border: solid thin; +} + +SPAN.info { + background: black; + border: thin solid black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} + +H2 SPAN.info, H3 SPAN.info, H4 SPAN.info { + float: right; + font-size: 100%; +} + +H1.title { +} + +H2.title, H3.title { + border-bottom: solid 2pt #000000; +} + +DIV.indent, TABLE.indent { + margin-top: 2em; + margin-left: auto; + margin-right: auto; + width: 90%; +} + +TABLE.indent { + border-collapse: collapse; +} + +TABLE.indent TD, TABLE.indent TH { + padding: 0; +} + +TABLE.list { + border-collapse: collapse; + margin-left: auto; + margin-right: auto; + width: 90%; +} + +TABLE.list TH { + background: white; + border-bottom: solid thin #cccccc; + color: #444444; + padding-top: 10pt; + padding-left: 5pt; + text-align: left; + vertical-align: bottom; + white-space: nowrap; +} + +TABLE.list TH A { + color: #4444cc; +} + +TABLE.list TD { + border-bottom: solid thin #eeeeee; + padding-top: 5pt; + padding-left: 5pt; +} + +TABLE.list TR:nth-child(even) { + background: #f8f8f8; +} + +TABLE.list TR:nth-child(odd) { + background: #f4f4f4; +} + +DT { + margin-left: 36pt; + margin-top: 12pt; +} + +DD { + margin-left: 54pt; +} + +DL.category DT { + font-weight: bold; +} + +P.summary { + margin-left: 36pt; + font-family: monaco, courier, monospace; +} + +DIV.summary TABLE { + border: solid thin #999999; + border-collapse: collapse; + border-spacing: 0; + margin: 10px; +} + +DIV.summary TABLE TD, DIV.summary TABLE TH { + border: solid thin #999999; + padding: 5px; + text-align: left; + vertical-align: top; +} + +DIV.summary TABLE THEAD TH { + background: #eeeeee; +} + +/* API documentation styles... */ +div.body h1 { + margin: 0; +} +div.body h2 { + margin-top: 1.5em; +} +div.body h3, div.body h4, div.body h5 { + margin-bottom: 0.5em; + margin-top: 1.5em; +} +.class, .enumeration, .function, .struct, .typedef, .union { + border-bottom: solid thin #999999; + margin-bottom: 0; + margin-top: 2em; +} +.description { + margin-top: 0.5em; +} +code, p.code, pre, ul.code li { + font-family: monaco, courier, monospace; + font-size: 90%; +} +ul.code, ul.contents, ul.subcontents { + list-style-type: none; + margin: 0; + padding-left: 0; +} +ul.code li { + margin: 0; +} +ul.contents > li { + margin-top: 1em; +} +ul.contents li ul.code, ul.contents li ul.subcontents { + padding-left: 2em; +} +div.body dl { + margin-left: 0; + margin-top: 0; +} +div.body dt { + font-style: italic; + margin-left: 0; + margin-top: 0; +} +div.body dd { + margin-bottom: 0.5em; +} + +/* This is just for the HTML files generated with the framedhelp target */ +div.contents { + background: #e8e8e8; + border: solid thin black; + padding: 10px; +} +div.contents h1 { + font-size: 110%; +} +div.contents h2 { + font-size: 100%; +} +div.contents ul.contents { + font-size: 80%; +} +div.contents ul.subcontents li { + margin-left: 1em; + text-indent: -1em; +} +--></style> </head> <body> +<div class='body'> <!-- - "$Id: spec-ppd.html 7937 2008-09-11 16:16:41Z mike $" + "$Id: spec-ppd.html 9345 2010-10-26 23:46:51Z mike $" - CUPS PPD extensions specification for CUPS. + PPD extension documentation for CUPS. Copyright 2007-2010 by Apple Inc. Copyright 1997-2007 by Easy Software Products. @@ -24,24 +356,86 @@ <H1 CLASS="title">CUPS PPD Extensions</H1> -<h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2> - -<p>This specification describes the attributes and extensions -that CUPS adds to <a -href="http://partners.adobe.com/public/developer/en/ps/5003.PPD_Spec_v4.3.pdf"> -Adobe TechNote #5003: PostScript Printer Description File Format -Specification Version 4.3</a>. PostScript Printer Description -("PPD") files describe the capabilities of each printer and are -used by CUPS to support printer-specific features and intelligent -filtering.</p> +<p>This specification describes the attributes and extensions that CUPS adds to <a href="http://partners.adobe.com/public/developer/en/ps/5003.PPD_Spec_v4.3.pdf" target="_blank">Adobe TechNote #5003: PostScript Printer Description File Format Specification Version 4.3</a>. PostScript Printer Description ("PPD") files describe the capabilities of each printer and are used by CUPS to support printer-specific features and intelligent filtering.</p> +<div class='summary'><table summary='General Information'> +<tbody> +<tr> + <th>See Also</th> + <td>Programming: <a href='postscript-driver.html'>Developing PostScript Printer Drivers</a><br> + Programming: <a href='raster-driver.html'>Developing Raster Printer Drivers</a><br> + Programming: <a href='api-filter.html'>Filter and Backend Programming</a><br> + Programming: <a href='ppd-compiler.html'>Introduction to the PPD Compiler</a><br> + Programming: <a href='api-raster.html'>Raster API</a><br> + References: <a href='ref-ppdcfile.html'>PPD Compiler Driver Information File Reference</a></td> +</tr> +</tbody> +</table></div> +<h2 class="title">Contents</h2> +<ul class="contents"> +<ul class="subcontents"> +<li><a href="#SYNTAX">PPD File Syntax</a></li> +<li><a href="#AUTOCONFIG">Auto-Configuration</a><ul class="subcontents"> +<li><a href="#APAutoSetupTool">APAutoSetupTool</a></li> +<li><a href="#QUERYKEYWORD">?MainKeyword</a></li> +<li><a href="#OID">OIDMainKeyword</a></li> +</ul></li> +<li><a href="#PROFILES">Color Profiles</a><ul class="subcontents"> +<li><a href="#cupsColorProfile">cupsColorProfile</a></li> +<li><a href="#cupsICCProfile">cupsICCProfile</a></li> +<li><a href="#APCustom">Custom Color Matching Support</a></li> +</ul></li> +<li><a href="#CONSTRAINTS">Constraints</a><ul class="subcontents"> +<li><a href="#cupsUIConstraints">cupsUIConstraints</a></li> +<li><a href="#cupsUIResolver">cupsUIResolver</a></li> +</ul></li> +<li><a href="#I18N">Globalized PPD Support</a></li> +<li><a href="#OPTIONS">CUPS 1.3/Mac OS X 10.6Custom Options</a></li> +<li><a href="#RASTERPS">Writing PostScript Option Commands for Raster Drivers</a></li> +<li><a href="#MEDIA">Media Keywords</a><ul class="subcontents"> +<li><a href="#cupsMediaQualifier2">cupsMediaQualifier2</a></li> +<li><a href="#cupsMediaQualifier3">cupsMediaQualifier3</a></li> +<li><a href="#cupsMinSize">cupsMinSize</a></li> +<li><a href="#cupsMaxSize">cupsMaxSize</a></li> +</ul></li> +<li><a href="#ATTRIBUTES">General Attributes</a><ul class="subcontents"> +<li><a href="#cupsBackSide">cupsBackSide</a></li> +<li><a href="#cupsCommands">cupsCommands</a></li> +<li><a href="#cupsEvenDuplex">cupsEvenDuplex</a></li> +<li><a href="#cupsFax">cupsFax</a></li> +<li><a href="#cupsFilter">cupsFilter</a></li> +<li><a href="#cupsFlipDuplex">cupsFlipDuplex</a></li> +<li><a href="#cupsIPPFinishings">cupsIPPFinishings</a></li> +<li><a href="#cupsIPPReason">cupsIPPReason</a></li> +<li><a href="#cupsLanguages">cupsLanguages</a></li> +<li><a href="#cupsManualCopies">cupsManualCopies</a></li> +<li><a href="#cupsMarkerName">cupsMarkerName</a></li> +<li><a href="#cupsMarkerNotice">cupsMarkerNotice</a></li> +<li><a href="#cupsModelNumber">cupsModelNumber</a></li> +<li><a href="#cupsPJLCharset">cupsPJLCharset</a></li> +<li><a href="#cupsPJLDisplay">cupsPJLDisplay</a></li> +<li><a href="#cupsPortMonitor">cupsPortMonitor</a></li> +<li><a href="#cupsPreFilter">cupsPreFilter</a></li> +<li><a href="#cupsPrintQuality">cupsPrintQuality</a></li> +<li><a href="#cupsSNMPSupplies">cupsSNMPSupplies</a></li> +<li><a href="#cupsVersion">cupsVersion</a></li> +</ul></li> +<li><a href="#MACOSX">Mac OS X Attributes</a><ul class="subcontents"> +<li><a href="#APDialogExtension">APDialogExtension</a></li> +<li><a href="#APDuplexRequiresFlippedMargin">APDuplexRequiresFlippedMargin</a></li> +<li><a href="#APHelpBook">APHelpBook</a></li> +<li><a href="#APICADriver">APICADriver</a></li> +<li><a href="#APPrinterIconPath">APPrinterIconPath</a></li> +<li><a href="#APPrinterLowInkTool">APPrinterLowInkTool</a></li> +<li><a href="#APPrinterPreset">APPrinterPreset</a></li> +<li><a href="#APPrinterUtilityPath">APPrinterUtilityPath</a></li> +<li><a href="#APScannerOnly">APScannerOnly</a></li> +<li><a href="#APScanAppBundleID">APScanAppBundleID</a></li> +</ul></li> +<li><a href="#HISTORY">Change History</a></li> <h2 class='title'><a name='SYNTAX'>PPD File Syntax</a></h2> -<p>The PPD format is text-based and uses lines of up to 255 -characters terminated by a carriage return, linefeed, or -combination of carriage return and line feed. The following ABNF -definition [RFC4234] defines the general format of lines in a PPD -file:</p> +<p>The PPD format is text-based and uses lines of up to 255 characters terminated by a carriage return, linefeed, or combination of carriage return and line feed. The following ABNF definition [<a href="http://tools.ietf.org/html/rfc5234" target="_blank">RFC5234</a>] defines the general format of lines in a PPD file:</p> <pre class='command'> PPD-FILE = HEADER +(DATA / COMMENT / LINE-END) @@ -69,21 +463,21 @@ LINE-END = CR / LF / CR LF <h2 class='title'><a name='AUTOCONFIG'>Auto-Configuration</a></h2> -<p>CUPS supports several methods of auto-configuration via PPD attributes. -<em>Currently these methods are only implemented on Mac OS X.</em></p> +<p>CUPS supports several methods of auto-configuration via PPD keywords.</p> -<h3><span class='info'>Mac OS X 10.5</span><a name='APAutoSetupTool'>APAutoSetupTool</a></h3> +<h3><span class='info'>Deprecated</span><a name='APAutoSetupTool'>APAutoSetupTool</a></h3> <p class='summary'>*APAutoSetupTool: "/LibraryPrinters/vendor/filename"</p> -<p>This attribute defines a program that sets the default option choices. It -is run when a printer is added from the printer browser instead of the -normal PostScript query and SNMP OID attribute lookups.</p> +<p>This deprecated keyword defines a program that sets the default option choices. It is run when a printer is added from the <var>Add Printer</var> window or the <var>Nearby Printers</var> list in the <var>Print</var> dialog.</p> -<p>The program is provided with two arguments: the printer's device URI and -the PPD file to be used for the printer. The program must write an updated -PPD file to stdout.</p> +<p>The program is provided with two arguments: the printer's device URI and the PPD file to be used for the printer. The program must write an updated PPD file to stdout.</p> + +<blockquote><b>Note:</b> +<p>This keyword is deprecated. New printer drivers SHOULD provide a CUPS command filter and support the "AutoConfigure" command. Alternately, drivers MAY use the <a href="#OID">SNMP OID</a> keywords to configure network printers or <a href="#QUERYKEYWORD">PostScript query keywords</a> to configure PostScript printers.</p> + +</blockquote> <p>Examples:</p> <pre class='command'> @@ -91,20 +485,16 @@ PPD file to stdout.</p> *APAutoSetupTool: "/Library/Printers/vendor/Tools/autosetuptool" </pre> -<h3><span class='info'>Mac OS X 10.2</span><a name='QUERYKEYWORD'>?MainKeyword</a></h3> +<h3><span class='info'>Mac OS X 10.2/CUPS 1.4</span><a name='QUERYKEYWORD'>?MainKeyword</a></h3> <p class='summary'>*?<i>MainKeyword</i>: "<br> PostScript query code that writes a message using the = operator...<br> "<br> *End</p> -<p>The <tt>?<i>MainKeyword</i></tt> attribute defines PostScript code that -determines the currently selected/enabled option keyword (choice) for the -main keyword (option). It is typically used when communicating with USB, -serial, Appletalk, and AppSocket (port 9100) printers.</p> +<p>The <tt>?<i>MainKeyword</i></tt> keyword defines PostScript code that determines the currently selected/enabled option keyword (choice) for the main keyword (option). It is typically used when communicating with USB, serial, Appletalk, and AppSocket (port 9100) printers.</p> -<p>The PostScript code typically sends its response back using the <tt>=</tt> -operator.</p> +<p>The PostScript code typically sends its response back using the <tt>=</tt> operator.</p> <p>Example:</p> @@ -124,20 +514,14 @@ operator.</p> *CloseUI: OptionDuplex </pre> -<h3><span class='info'>Mac OS X 10.4</span><a name='OID'>OIDMainKeyword</a></h3> +<h3><span class='info'>Mac OS X 10.4/CUPS 1.5</span><a name='OID'>OIDMainKeyword</a></h3> <p class='summary'>*?OID<i>MainKeyword</i>: ".n.n.n..."<br> *OID<i>MainKeyword</i> <i>OptionKeyword1</i>: "value"<br> ...<br> *OID<i>MainKeyword</i> <i>OptionKeywordN</i>: "value"</p> -<p>The <tt>OID<i>MainKeyword</i></tt> attribute is used to define -SNMP OIDs that map to installable options. The first (query) line -defines the OID to lookup on the network device. The second and -subsequent attributes define a mapping from OID value to option -keyword. Since SNMP is an IP-based network protocol, this method -is typically only used to configure AppSocket, IPP, and LPD network -printers.</p> +<p>The <tt>OID<i>MainKeyword</i></tt> keyword is used to define SNMP OIDs that map to installable options. The first (query) line defines the OID to lookup on the network device. The second and subsequent keywords define a mapping from OID value to option keyword. Since SNMP is an IP-based network protocol, this method is typically only used to configure AppSocket, IPP, and LPD network printers.</p> <p>Examples:</p> @@ -153,32 +537,21 @@ printers.</p> <h2 class='title'><a name='PROFILES'>Color Profiles</a></h2> -<p>CUPS supports three types of color profiles. The first type is -based on sRGB and is used by the standard CUPS raster filters and -GPL Ghostscript. The second type is based on ICC profiles and is -used by the Quartz-based filters on MacOS X. The final type is -based on well-known colorspaces such as sRGB and Adobe RGB.</p> +<p>CUPS supports three types of color profiles. The first type is based on sRGB and is used by the standard CUPS raster filters and GPL Ghostscript. The second type is based on ICC profiles and is used by the Quartz-based filters on MacOS X. The final type is based on well-known colorspaces such as sRGB and Adobe RGB.</p> <blockquote><b>Note:</b> -<p>At this time, none of the CUPS raster filters support ICC profiles. This -will be addressed as time and resources permit.</p> +<p>At this time, none of the CUPS raster filters support ICC profiles. This will be addressed as time and resources permit.</p> </blockquote> <h3><span class='info'>Deprecated</span><a name='cupsColorProfile'>cupsColorProfile</a></h3> -<p class='summary'>*cupsColorProfile Resolution/MediaType: "density -gamma m00 m01 m02 m10 m11 m12 m20 m21 m22"</p> +<p class='summary'>*cupsColorProfile Resolution/MediaType: "density gamma m00 m01 m02 m10 m11 m12 m20 m21 m22"</p> -<p>This string attribute specifies an sRGB-based color profile -consisting of gamma and density controls and a 3x3 CMY color -transform matrix. <em>This attribute is not supported on Mac OS X.</em></p> +<p>This string keyword specifies an sRGB-based color profile consisting of gamma and density controls and a 3x3 CMY color transform matrix. <em>This keyword is not supported on Mac OS X.</em></p> -<p>The <i>Resolution</i> and <i>MediaType</i> values may be "-" -to act as a wildcard. Otherwise they must match one of the -<tt>Resolution</tt> or <tt>MediaType</tt> attributes defined in -the PPD file.</p> +<p>The <i>Resolution</i> and <i>MediaType</i> values may be "-" to act as a wildcard. Otherwise they must match one of the <tt>Resolution</tt> or <tt>MediaType</tt> option keywords defined in the PPD file.</p> <p>The <i>density</i> and <i>gamma</i> values define gamma and density adjustment function such that:</p> @@ -187,9 +560,7 @@ density adjustment function such that:</p> f(x) = density * x <sup style='font-size: 100%'>gamma</sup> </pre> -<p>The <i>m00</i> through <i>m22</i> values define a 3x3 -transformation matrix for the CMY color values. The density -function is applied <i>after</i> the CMY transformation:</p> +<p>The <i>m00</i> through <i>m22</i> values define a 3x3 transformation matrix for the CMY color values. The density function is applied <i>after</i> the CMY transformation:</p> <pre class='command'> | m00 m01 m02 | @@ -211,23 +582,13 @@ function is applied <i>after</i> the CMY transformation:</p> </pre> -<h3><span class='info'>Mac OS X 10.3/CUPS 1.2/Mac OS X 10.5</span><a name='cupsICCProfile'>cupsICCProfile</a></h3> +<h3><span class='info'>Mac OS X 10.3/CUPS 1.2</span><a name='cupsICCProfile'>cupsICCProfile</a></h3> -<p class='summary'>*cupsICCProfile -ColorModel.MediaType.Resolution/Description: "filename"</p> +<p class='summary'>*cupsICCProfile ColorModel.MediaType.Resolution/Description: "filename"</p> -<p>This attribute specifies an ICC color profile that is -used to convert the document colors to the device -colorspace. The <tt>ColorModel</tt>, <tt>MediaType</tt>, and -<tt>Resolution</tt> keywords specify a selector for color -profiles. If omitted, the color profile will match any option -keyword for the corresponding main keyword.</p> +<p>This keyword specifies an ICC color profile that is used to convert the document colors to the device colorspace. The <tt>ColorModel</tt>, <tt>MediaType</tt>, and <tt>Resolution</tt> option keywords specify a selector for color profiles. If omitted, the color profile will match any option keyword for the corresponding main keyword.</p> -<p>The <tt>Description</tt> specifies human-readable text that -is associated with the color profile. The <tt>filename</tt> -portion specifies the ICC color profile to use; if the filename -is not absolute, it is loaded relative to the -<var>/usr/share/cups/profiles</var> directory.</p> +<p>The <tt>Description</tt> specifies human-readable text that is associated with the color profile. The <tt>filename</tt> portion specifies the ICC color profile to use; if the filename is not absolute, it is loaded relative to the <var>/usr/share/cups/profiles</var> directory.</p> <p>Examples:</p> @@ -244,11 +605,7 @@ is not absolute, it is loaded relative to the <h4>Customizing the Profile Selection Keywords</h4> -<p>The <tt>MediaType</tt> and <tt>Resolution</tt> keywords can be -reassigned to different main keywords, allowing drivers to do -color profile selection based on different parameters. The -<tt>cupsICCQualifier2</tt> and <tt>cupsICCQualifier3</tt> -attributes define the mapping from selector to main keyword:</p> +<p>The <tt>MediaType</tt> and <tt>Resolution</tt> main keywords can be reassigned to different main keywords, allowing drivers to do color profile selection based on different parameters. The <tt>cupsICCQualifier2</tt> and <tt>cupsICCQualifier3</tt> keywords define the mapping from selector to main keyword:</p> <pre class='command'> *cupsICCQualifier2: MainKeyword2 @@ -269,19 +626,11 @@ attributes define the mapping from selector to main keyword:</p> *<a href='#APCustomColorMatchingProfile'>APCustomColorMatchingProfile</a>: profile<br> *<a href='#APDefaultCustomColorMatchingProfile'>APDefaultCustomColorMatchingProfile</a>: profile</p> -<p>These attributes tell the Mac OS X raster filters that the printer -driver provides its own custom color matching and that generic color -profiles should be used when generating 1-, 3-, and 4-component raster -data as requested by the driver. The <tt>APCustomColorMatchingProfile</tt> -and <tt>APDefaultColorMatchingProfile</tt> attributes specify alternate -color profiles (sRGB or AdobeRGB) to use for 3-color (RGB) raster data.</p> +<p>These keywords tell the Mac OS X raster filters that the printer driver provides its own custom color matching and that generic color profiles should be used when generating 1-, 3-, and 4-component raster data as requested by the driver. The <tt>APCustomColorMatchingProfile</tt> and <tt>APDefaultColorMatchingProfile</tt> keywords specify alternate color profiles (sRGB or AdobeRGB) to use for 3-color (RGB) raster data.</p> <blockquote><b>Note:</b> -<p>Prior to Mac OS X 10.6, the default RGB color space was Apple's "GenericRGB". -The new default in Mac OS X 10.6 and later is "sRGB". For more information, see -<a href="http://support.apple.com/kb/HT3712">"Mac OS X v10.6: About gamma -2.2"</a> on Apple's support site.</p> +<p>Prior to Mac OS X 10.6, the default RGB color space was Apple's "GenericRGB". The new default in Mac OS X 10.6 and later is "sRGB". For more information, see <a href="http://support.apple.com/kb/HT3712">"Mac OS X v10.6: About gamma 2.2"</a> on Apple's support site.</p> </blockquote> @@ -289,10 +638,7 @@ The new default in Mac OS X 10.6 and later is "sRGB". For more information, see <p class='summary'>*APCustomColorMatchingName name/text: ""</p> -<p>This attribute defines an alternate name for the color matching -provided by a driver in the <var>Color Matching</var> print panel. -The default is to use the name "Vendor Matching" or its localized -equivalent.</p> +<p>This keyword defines an alternate name for the color matching provided by a driver in the <var>Color Matching</var> print panel. The default is to use the name "Vendor Matching" or its localized equivalent.</p> <p>Examples:</p> @@ -306,18 +652,11 @@ equivalent.</p> <p class='summary'>*APCustomColorMatchingProfile: name</p> -<p>This attribute defines a supported RGB color profile that can be used -when doing custom color matching. Currently only <tt>sRGB</tt>, -<tt>AdobeRGB</tt>, and <tt>GenericRGB</tt> are supported. If not specified, RGB -data will use the GenericRGB colorspace.</p> +<p>This keyword defines a supported RGB color profile that can be used when doing custom color matching. Currently only <tt>sRGB</tt>, <tt>AdobeRGB</tt>, and <tt>GenericRGB</tt> are supported. If not specified, RGB data will use the GenericRGB colorspace.</p> <blockquote><b>Note:</b> -<p>If you provide multiple <tt>APCustomColorMatchingProfile</tt> attributes, -you are responsible for providing the necessary user interface controls to -select the profile in a <a href='#APDialogExtension'>print dialog pane</a>. -Add the named profile to the print settings using the key -<tt>kPMCustomColorMatchingProfileKey</tt>.</p> +<p>If you provide multiple <tt>APCustomColorMatchingProfile</tt> keywords, you are responsible for providing the necessary user interface controls to select the profile in a <a href='#APDialogExtension'>print dialog pane</a>. Add the named profile to the print settings using the key <tt>kPMCustomColorMatchingProfileKey</tt>.</p> </blockquote> @@ -335,9 +674,7 @@ Add the named profile to the print settings using the key <p class='summary'>*APDefaultCustomColorMatchingProfile: name</p> -<p>This attribute defines the default RGB color profile that will be used -when doing custom color matching. Currently only <tt>sRGB</tt>, -<tt>AdobeRGB</tt>, and <tt>GenericRGB</tt> are supported.</p> +<p>This keyword defines the default RGB color profile that will be used when doing custom color matching. Currently only <tt>sRGB</tt>, <tt>AdobeRGB</tt>, and <tt>GenericRGB</tt> are supported.</p> <p>Examples:</p> @@ -351,12 +688,7 @@ when doing custom color matching. Currently only <tt>sRGB</tt>, <p class='summary'>*APSupportsCustomColorMatching: boolean</p> -<p>This attribute specifies that the driver provides its own custom color -matching. When <tt>true</tt>, the default hand-off colorspace will be -GenericGray, GenericRGB, or GenericCMYK depending on the number of -components the driver requests. The <a -href='#APDefaultCustomColorMatchingProfile'><tt>APDefaultCustomColorMatchingProfile</tt></a> -attribute can be used to override the default 3-component (RGB) colorspace.</p> +<p>This keyword specifies that the driver provides its own custom color matching. When <tt>true</tt>, the default hand-off colorspace will be GenericGray, GenericRGB, or GenericCMYK depending on the number of components the driver requests. The <a href='#APDefaultCustomColorMatchingProfile'><tt>APDefaultCustomColorMatchingProfile</tt></a> keyword can be used to override the default 3-component (RGB) colorspace.</p> <p>The default for <tt>APSupportsCustomColorMatching</tt> is <tt>false</tt>.</p> @@ -370,11 +702,7 @@ attribute can be used to override the default 3-component (RGB) colorspace.</p> <h2 class='title'><a name='CONSTRAINTS'>Constraints</a></h2> -<p>Constraints are option choices that are not allowed by the driver or -device, for example printing 2-sided transparencies. All versions of CUPS -support constraints defined by the legacy Adobe <tt>UIConstraints</tt> and -<tt>NonUIConstraints</tt> attributes which support conflicts between any two -option choices, for example:</p> +<p>Constraints are option choices that are not allowed by the driver or device, for example printing 2-sided transparencies. All versions of CUPS support constraints defined by the legacy Adobe <tt>UIConstraints</tt> and <tt>NonUIConstraints</tt> keywords which support conflicts between any two option choices, for example:</p> <pre class='command'> *% Do not allow 2-sided printing on transparency media @@ -382,24 +710,13 @@ option choices, for example:</p> *UIConstraints: "*MediaType Transparency *Duplex" </pre> -<p>While nearly all constraints can be expressed using these attributes, there -are valid scenarios requiring constraints between more than two option choices. -In addition, resolution of constraints is problematic since users and software -have to guess how a particular constraint is best resolved.</p> +<p>While nearly all constraints can be expressed using these keywords, there are valid scenarios requiring constraints between more than two option choices. In addition, resolution of constraints is problematic since users and software have to guess how a particular constraint is best resolved.</p> -<p>CUPS 1.4 and higher define two new attributes for constraints, -<tt>cupsUIConstraints</tt> and <tt>cupsUIResolver</tt>. Each -<tt>cupsUIConstraints</tt> attribute points to a <tt>cupsUIResolver</tt> -attribute which specifies alternate options that resolve the conflict condition. -The same <tt>cupsUIResolver</tt> can be used by multiple -<tt>cupsUIConstraints</tt>.</p> +<p>CUPS 1.4 and higher define two new keywords for constraints, <tt>cupsUIConstraints</tt> and <tt>cupsUIResolver</tt>. Each <tt>cupsUIConstraints</tt> keyword points to a <tt>cupsUIResolver</tt> keyword which specifies alternate options that resolve the conflict condition. The same <tt>cupsUIResolver</tt> can be used by multiple <tt>cupsUIConstraints</tt>.</p> <blockquote><b>Note:</b> - <p>When developing PPD files that contain constraints, it is very important - to use the <a href="man-cupstestppd.html">cupstestppd(1)</a> program to - verify that your constraints are accurate and cannot result in unresolvable - option selections.</p> +<p>When developing PPD files that contain constraints, it is very important to use the <a href="man-cupstestppd.html">cupstestppd(1)</a> program to verify that your constraints are accurate and cannot result in unresolvable option selections.</p> </blockquote> @@ -411,10 +728,7 @@ The same <tt>cupsUIResolver</tt> can be used by multiple *cupsUIConstraints resolver: "*Keyword1 OptionKeyword1 *Keyword2 OptionKeyword2 ..."<br> *cupsUIConstraints: "*InstallableKeyword1 OptionKeyword1 *Keyword2 OptionKeyword2 ..."</p> -<p>Lists two or more options which conflict. The "resolver" string is a -(possibly unique) keyword which specifies which options to change when the -constraint exists. When no resolver is provided, CUPS first tries the default -choice followed by testing each option choice to resolve the conflict.</p> +<p>Lists two or more options which conflict. The "resolver" string is a (possibly unique) keyword which specifies which options to change when the constraint exists. When no resolver is provided, CUPS first tries the default choice followed by testing each option choice to resolve the conflict.</p> <p>Examples:</p> @@ -440,16 +754,7 @@ choice followed by testing each option choice to resolve the conflict.</p> <p class='summary'>*cupsUIResolution resolver: "*Keyword1 OptionKeyword1 *Keyword2 OptionKeyword2 ..."</p> -<p>Specifies two or more options to mark/select to resolve a constraint. The -"resolver" string identifies a particular action to take for one or more -<a href='#cupsUIConstraints'><tt>cupsUIConstraints</tt></a>. The same action -can be used for multiple constraints. The option keyword pairs are treated as -an ordered list of option selections to try - only the first N selections will -be used, where N is the minimum number of selections required. Because -<a href="api-ppd.html#cupsResolveConflicts"><code>cupsResolveConflicts()</code></a> -will not change the most recent option selection passed to it, at least two -options from the constraints must be listed to avoid situations where conflicts -cannot be resolved.</p> +<p>Specifies two or more options to mark/select to resolve a constraint. The "resolver" string identifies a particular action to take for one or more <a href='#cupsUIConstraints'><tt>cupsUIConstraints</tt></a>. The same action can be used for multiple constraints. The option keyword pairs are treated as an ordered list of option selections to try - only the first N selections will be used, where N is the minimum number of selections required. Because <a href="api-ppd.html#cupsResolveConflicts"><code>cupsResolveConflicts()</code></a> will not change the most recent option selection passed to it, at least two options from the constraints must be listed to avoid situations where conflicts cannot be resolved.</p> <p>Examples:</p> @@ -469,8 +774,7 @@ cannot be resolved.</p> <h2 class='title'><a name='I18N'>Globalized PPD Support</a></h2> -<p>CUPS 1.2 and higher adds support for PPD files containing multiple -languages by following the following additional rules:</p> +<p>CUPS 1.2 and higher adds support for PPD files containing multiple languages by following the following additional rules:</p> <ol> @@ -478,59 +782,36 @@ languages by following the following additional rules:</p> <li>The <tt>LanguageEncoding</tt> MUST be <tt>ISOLatin1</tt></li> - <li>The <tt>cupsLanguages</tt> attribute MUST be provided and - list each of the supported locales in the PPD file</li> + <li>The <tt>cupsLanguages</tt> keyword MUST be provided and list each of the supported locales in the PPD file</li> - <li>Main and option keywords MUST NOT exceed 34 (instead of 40) - characters to allow room for the locale prefixes in translation - attributes</li> + <li>Main and option keywords MUST NOT exceed 34 (instead of 40) characters to allow room for the locale prefixes in translation keywords</li> <li>The main keyword "Translation" MUST NOT be used</li> - <li>Translation strings included with the main and option - keywords MUST NOT contain characters outside the ASCII - subset of ISOLatin1 and UTF-8; developers wishing to use - characters outside ASCII MUST provide a separate set of - English localization attributes for the affected keywords.</li> + <li>Translation strings included with the main and option keywords MUST NOT contain characters outside the ASCII subset of ISOLatin1 and UTF-8; developers wishing to use characters outside ASCII MUST provide a separate set of English localization keywords for the affected keywords.</li> - <li>Localizations are specified using a locale prefix of - the form "ll" or "ll_CC." where "ll" is the 2-letter ISO - language code and "CC" is the 2-letter ISO country - code<ul> + <li>Localizations are specified using a locale prefix of the form "ll" or "ll_CC." where "ll" is the 2-letter ISO language code and "CC" is the 2-letter ISO country code<ul> <li>A generic language translation ("ll") SHOULD be provided with country-specific differences ("ll_CC") provided only as needed</li> <li>For historical reasons, the "zh" and "zh_CN" locales map to Simplified Chinese while the "zh_TW" locale maps to Traditional Chinese</li> </ul></li> - <li>Locale-specific translation strings MUST be encoded - using UTF-8.</li> + <li>Locale-specific translation strings MUST be encoded using UTF-8.</li> - <li>Main keywords MUST be localized using one of the - following forms: - <p><tt>*ll.Translation MainKeyword/translation - text: ""</tt><br /> - <tt>*ll_CC.Translation MainKeyword/translation - text: ""</tt></p></li> + <li>Main keywords MUST be localized using one of the following forms: + <p><tt>*ll.Translation MainKeyword/translation text: ""</tt><br /> + <tt>*ll_CC.Translation MainKeyword/translation text: ""</tt></p></li> - <li>Option keywords MUST be localized using one of the - following forms: - <p><tt>*ll.MainKeyword OptionKeyword/translation - text: ""</tt><br /> - <tt>*ll_CC.MainKeyword OptionKeyword/translation - text: ""</tt></p></li> + <li>Option keywords MUST be localized using one of the following forms: + <p><tt>*ll.MainKeyword OptionKeyword/translation text: ""</tt><br> + <tt>*ll_CC.MainKeyword OptionKeyword/translation text: ""</tt></p></li> - <li>Localization attributes MAY appear anywhere after the - first line of the PPD file</li> + <li>Localization keywords MAY appear anywhere after the first line of the PPD file</li> </ol> <blockquote><b>Note:</b> -<p>We use a <tt>LanguageEncoding</tt> value of <tt>ISOLatin1</tt> -and limit the allowed base translation strings to ASCII to avoid -character coding issues that would otherwise occur. In addition, -requiring the base translation strings to be in English allows -for easier fallback translation when no localization is provided -in the PPD file for a given locale.</p> +<p>We use a <tt>LanguageEncoding</tt> value of <tt>ISOLatin1</tt> and limit the allowed base translation strings to ASCII to avoid character coding issues that would otherwise occur. In addition, requiring the base translation strings to be in English allows for easier fallback translation when no localization is provided in the PPD file for a given locale.</p> </blockquote> @@ -571,11 +852,9 @@ in the PPD file for a given locale.</p> </pre> -<h2 class='title'><a name='OPTIONS'>Custom Options</a></h2> +<h2 class='title'><a name='OPTIONS'><span class="info">CUPS 1.3/Mac OS X 10.6</span>Custom Options</a></h2> -<p>CUPS supports custom options using an extension of the -<tt>CustomPageSize</tt> and <tt>ParamCustomPageSize</tt> -syntax:</p> +<p>CUPS supports custom options using an extension of the <tt>CustomPageSize</tt> and <tt>ParamCustomPageSize</tt> syntax:</p> <pre class='command'> *CustomFoo True: "command" @@ -585,68 +864,33 @@ syntax:</p> *ParamCustomFoo NameN/Text N: order type minimum maximum </pre> -<p>When the base option is part of the <tt>JCLSetup</tt> section, -the "command" string contains JCL commands with "\order" -placeholders for each numbered parameter. The CUPS API handles -any necessary value quoting for HP-PJL commands. For example, if -the JCL command string is "@PJL SET PASSCODE=\1" and the first -option value is "1234" then CUPS will output the string -"@PJL SET PASSCODE=1234".</p> - -<p>For non-<tt>JCLSetup</tt> options, the "order" value is a -number from 1 to N and specifies the order of values as they are -placed on the stack before the command. For example, if the -PostScript command string is -"<</cupsReal1 2 1 roll>>setpagedevice" and the -option value is "2.0" then CUPS will output the string -"2.0 <</cupsReal1 2 1 roll>>setpagedevice".</p> +<p>When the base option is part of the <tt>JCLSetup</tt> section, the "command" string contains JCL commands with "\order" placeholders for each numbered parameter. The CUPS API handles any necessary value quoting for HP-PJL commands. For example, if the JCL command string is "@PJL SET PASSCODE=\1" and the first +option value is "1234" then CUPS will output the string "@PJL SET PASSCODE=1234".</p> + +<p>For non-<tt>JCLSetup</tt> options, the "order" value is a number from 1 to N and specifies the order of values as they are placed on the stack before the command. For example, if the PostScript command string is "<</cupsReal1 2 1 roll>>setpagedevice" and the option value is "2.0" then CUPS will output the string "2.0 <</cupsReal1 2 1 roll>>setpagedevice".</p> <p>The "type" is one of the following keywords:</p> <ul> - <li><tt>curve</tt> - a real value from "minimum" to - "maximum" representing a gamma correction curve using the - function: f(x) = x <sup>value</sup></li> + <li><tt>curve</tt> - a real value from "minimum" to "maximum" representing a gamma correction curve using the function: f(x) = x <sup>value</sup></li> - <li><tt>int</tt> - an integer value from "minimum" to - "maximum"</li> + <li><tt>int</tt> - an integer value from "minimum" to "maximum"</li> - <li><tt>invcurve</tt> - a real value from "minimum" to - "maximum" representing a gamma correction curve using the - function: f(x) = x <sup>1 / value</sup></li> + <li><tt>invcurve</tt> - a real value from "minimum" to "maximum" representing a gamma correction curve using the function: f(x) = x <sup>1 / value</sup></li> - <li><tt>passcode</tt> - a string of numbers value with a - minimum of "minimum" numbers and a maximum of "maximum" - numbers ("minimum" and "maximum" are numbers and passcode - strings are not displayed in the user interface)</li> + <li><tt>passcode</tt> - a string of numbers value with a minimum of "minimum" numbers and a maximum of "maximum" numbers ("minimum" and "maximum" are numbers and passcode strings are not displayed in the user interface)</li> - <li><tt>password</tt> - a string value with a minimum of - "minimum" characters and a maximum of "maximum" - characters ("minimum" and "maximum" are numbers and password - strings are not displayed in the user interface)</li> + <li><tt>password</tt> - a string value with a minimum of "minimum" characters and a maximum of "maximum" characters ("minimum" and "maximum" are numbers and password strings are not displayed in the user interface)</li> - <li><tt>points</tt> - a measurement value in points from - "minimum" to "maximum"</li> + <li><tt>points</tt> - a measurement value in points from "minimum" to "maximum"</li> - <li><tt>real</tt> - a real value from "minimum" to - "maximum"</li> + <li><tt>real</tt> - a real value from "minimum" to "maximum"</li> - <li><tt>string</tt> - a string value with a minimum of - "minimum" characters and a maximum of "maximum" - characters ("minimum" and "maximum" are numbers)</li> + <li><tt>string</tt> - a string value with a minimum of "minimum" characters and a maximum of "maximum" characters ("minimum" and "maximum" are numbers)</li> </ul> -<blockquote><b>Note:</b> - -<p>Custom options are not directly supported by the Mac OS X Print Dialog -nor by the CUPS web interface at this time. Vendors that use custom -options on Mac OS X must provide their own user interface via the -<a href='#APDialogExtension'><tt>APDialogExtension</tt></a> attribute.</p> - -</blockquote> - <p>Examples:</p> <pre class='command'> @@ -696,7 +940,7 @@ options on Mac OS X must provide their own user interface via the <h2 class='title'><a name='RASTERPS'>Writing PostScript Option Commands for Raster Drivers</a></h2> -<p>PPD files are used for both PostScript and non-PostScript printers. For CUPS raster drivers, you use a subset of the PostScript language to set page device attributes such as page size, resolution, and so forth. For example, the following code sets the page size to A4 size:</p> +<p>PPD files are used for both PostScript and non-PostScript printers. For CUPS raster drivers, you use a subset of the PostScript language to set page device keywords such as page size, resolution, and so forth. For example, the following code sets the page size to A4 size:</p> <pre class='command'> *PageSize A4: "<</PageSize[595 842]>>setpagedevice" @@ -1061,16 +1305,16 @@ PRE B { </table></div> -<h2 class='title'><a name='MEDIA'>Media Attributes</a></h2> +<h2 class='title'><a name='MEDIA'>Media Keywords</a></h2> -<p>The CUPS media attributes allow drivers to specify alternate custom page +<p>The CUPS media keywords allow drivers to specify alternate custom page size limits based on up to two options.</p> <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMediaQualifier2'>cupsMediaQualifier2</a></h3> <p class='summary'>*cupsMediaQualifier2: MainKeyword</p> -<p>This attribute specifies the second option to use for overriding the +<p>This keyword specifies the second option to use for overriding the custom page size limits.</p> <p>Example:</p> @@ -1089,7 +1333,7 @@ custom page size limits.</p> <p class='summary'>*cupsMediaQualifier3: MainKeyword</p> -<p>This attribute specifies the third option to use for overriding the +<p>This keyword specifies the third option to use for overriding the custom page size limits.</p> <p>Example:</p> @@ -1110,9 +1354,9 @@ custom page size limits.</p> *cupsMinSize .Qualifier2.: "width length"<br> *cupsMinSize ..Qualifier3: "width length"</p> -<p>This attribute specifies alternate minimum custom page sizes in points. +<p>This keyword specifies alternate minimum custom page sizes in points. The <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a> and -<a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a> attributes +<a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a> keywords are used to identify options to use for matching.</p> <p>Example:</p> @@ -1133,9 +1377,9 @@ are used to identify options to use for matching.</p> *cupsMaxSize .Qualifier2.: "width length"<br> *cupsMaxSize ..Qualifier3: "width length"</p> -<p>This attribute specifies alternate maximum custom page sizes in points. +<p>This keyword specifies alternate maximum custom page sizes in points. The <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a> and -<a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a> attributes +<a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a> keywords are used to identify options to use for matching.</p> <p>Example:</p> @@ -1157,9 +1401,9 @@ are used to identify options to use for matching.</p> <p class='summary'>*cupsBackSide: keyword</p> -<p>This attribute requests special handling of the back side of pages +<p>This keyword requests special handling of the back side of pages when doing duplexed (2-sided) output. <a href='#TABLE_1'>Table 1</a> -shows the supported keyword values for this attribute and their effect +shows the supported keyword values for this keyword and their effect on the raster data sent to your driver. For example, when <tt>cupsBackSide</tt> is <code>Rotated</code> and <tt>Tumble</tt> is <tt>false</tt>, your driver will receive print data starting at the bottom right corner of the page, with @@ -1169,7 +1413,7 @@ each line going right-to-left instead of left-to-right. The default value is <blockquote><b>Note:</b> <p><tt>cupsBackSide</tt> replaces the older <tt>cupsFlipDuplex</tt> -attribute - if <tt>cupsBackSide</tt> is specified, <tt>cupsFlipDuplex</tt> +keyword - if <tt>cupsBackSide</tt> is specified, <tt>cupsFlipDuplex</tt> will be ignored.</p> </blockquote> @@ -1247,13 +1491,13 @@ will be ignored.</p> </pre> <p>Also see the related <a href='#APDuplexRequiresFlippedMargin'><tt>APDuplexRequiresFlippedMargin</tt></a> -attribute.</p> +keyword.</p> <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsCommands'>cupsCommands</a></h3> <p class='summary'>*cupsCommands: "name name2 ... nameN"</p> -<p>This string attribute specifies the commands that are supported by the +<p>This string keyword specifies the commands that are supported by the CUPS command file filter for this device. The command names are separated by whitespace.</p> @@ -1269,7 +1513,7 @@ by whitespace.</p> <p class='summary'>*cupsEvenDuplex: boolean</p> -<p>This boolean attribute notifies the RIP filters that the +<p>This boolean keyword notifies the RIP filters that the destination printer requires an even number of pages when 2-sided printing is selected. The default value is <code>false</code>.</p> @@ -1284,7 +1528,7 @@ printing is selected. The default value is <code>false</code>.</p> <p class='summary'>*cupsFax: boolean</p> -<p>This boolean attribute specifies whether the PPD defines a facsimile device. The default is <tt>false</tt>.</p> +<p>This boolean keyword specifies whether the PPD defines a facsimile device. The default is <tt>false</tt>.</p> <p>Examples:</p> @@ -1296,7 +1540,7 @@ printing is selected. The default value is <code>false</code>.</p> <p class='summary'>*cupsFilter: "source/type cost program"</p> -<p>This string attribute provides a conversion rule from the +<p>This string keyword provides a conversion rule from the given source type to the printer's native format using the filter "program". If a printer supports the source type directly, the special filter program "-" may be specified.</p> @@ -1319,8 +1563,8 @@ the special filter program "-" may be specified.</p> <p class='summary'>*cupsFlipDuplex: boolean</p> <p>Due to implementation differences between Mac OS X and Ghostscript, -the <tt>cupsFlipDuplex</tt> attribute is deprecated. Instead, use -the <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> attribute to specify +the <tt>cupsFlipDuplex</tt> keyword is deprecated. Instead, use +the <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> keyword to specify the coordinate system (pixel layout) of the page data on the back side of duplex pages.</p> @@ -1334,7 +1578,7 @@ Ghostscript.</p> <p>Mac OS X drivers that previously used <tt>cupsFlipDuplex</tt> may wish to provide both the old and -new attributes for maximum compatibility, for example:</p> +new keywords for maximum compatibility, for example:</p> <pre class='command'> *cupsBackSide: Rotated @@ -1353,7 +1597,7 @@ Ghostscript can use:</p> <p class='summary'>*cupsIPPFinishings number/text: "*Option Choice ..."</p> -<p>This attribute defines a mapping from IPP <code>finishings</code> +<p>This keyword defines a mapping from IPP <code>finishings</code> values to PPD options and choices.</p> <p>Examples:</p> @@ -1369,7 +1613,7 @@ values to PPD options and choices.</p> <p class='summary'>*cupsIPPReason reason/Reason Text: "optional URIs"</p> -<p>This optional attribute maps custom +<p>This optional keyword maps custom <code>printer-state-reasons</code> keywords that are generated by the driver to human readable text. The optional URIs string contains zero or more URIs separated by a newline. Each URI can @@ -1413,7 +1657,7 @@ http://www.vendor.com/help" <p class='summary'>*cupsLanguages: "locale list"</p> -<p>This attribute describes which language localizations are +<p>This keyword describes which language localizations are included in the PPD. The "locale list" string is a space-delimited list of locale names ("en", "en_US", "fr_CA", etc.)</p> @@ -1428,7 +1672,7 @@ list of locale names ("en", "en_US", "fr_CA", etc.)</p> <p class='summary'>*cupsManualCopies: boolean</p> -<p>This boolean attribute notifies the RIP filters that the +<p>This boolean keyword notifies the RIP filters that the destination printer does not support copy generation in hardware. The default value is <code>false</code>.</p> @@ -1443,7 +1687,7 @@ hardware. The default value is <code>false</code>.</p> <p class='summary'>*cupsMarkerName/Name Text: ""</p> -<p>This optional attribute maps <code>marker-names</code> strings that are +<p>This optional keyword maps <code>marker-names</code> strings that are generated by the driver to human readable text.</p> <p>Examples:</p> @@ -1457,7 +1701,7 @@ generated by the driver to human readable text.</p> <p class='summary'>*cupsMarkerNotice: "disclaimer text"</p> -<p>This optional attribute provides disclaimer text for the supply level +<p>This optional keyword provides disclaimer text for the supply level information provided by the driver, typically something like "supply levels are approximate".</p> @@ -1471,7 +1715,7 @@ are approximate".</p> <p class='summary'>*cupsModelNumber: number</p> -<p>This integer attribute specifies a printer-specific model +<p>This integer keyword specifies a printer-specific model number. This number can be used by a filter program to adjust the output for a specific model of printer.</p> @@ -1486,7 +1730,7 @@ the output for a specific model of printer.</p> <p class='summary'>*cupsPJLCharset: "ISO character set name"</p> -<p>This string attribute specifies the character set that is used +<p>This string keyword specifies the character set that is used for strings in PJL commands. If not specified, US-ASCII is assumed.</p> @@ -1501,7 +1745,7 @@ assumed.</p> <p class='summary'>*cupsPJLDisplay: "what"</p> -<p>This optional attribute specifies which command is used to display the +<p>This optional keyword specifies which command is used to display the job ID, name, and user on the printer's control panel. "What" is either "none" to disable this functionality, "job" to use "@PJL JOB DISPLAY", or "rdymsg" to use "@PJL RDYMSG DISPLAY". The default is "job".</p> @@ -1520,15 +1764,15 @@ to use "@PJL RDYMSG DISPLAY". The default is "job".</p> <p class='summary'>*cupsPortMonitor urischeme/Descriptive Text: "port monitor"</p> -<p>This string attribute specifies printer-specific "port +<p>This string keyword specifies printer-specific "port monitor" filters that may be used with the printer. The CUPS -scheduler also looks for the <tt>Protocols</tt> attribute to see +scheduler also looks for the <tt>Protocols</tt> keyword to see if the <tt>BCP</tt> or <tt>TBCP</tt> protocols are supported. If so, the corresponding port monitor ("bcp" and "tbcp", respectively) is listed in the printer's -<tt>port-monitor-supported</tt> attribute.</p> +<tt>port-monitor-supported</tt> keyword.</p> -<p>The "urischeme" portion of the attribute specifies the URI scheme +<p>The "urischeme" portion of the keyword specifies the URI scheme that this port monitor should be used for. Typically this is used to pre-select a particular port monitor for each type of connection that is supported by the printer. The "port monitor" string can be "none" @@ -1552,7 +1796,7 @@ to disable the port monitor for the given URI scheme.</p> <p class='summary'>*cupsPreFilter: "source/type cost program"</p> -<p>This string attribute provides a pre-filter rule. The pre-filter +<p>This string keyword provides a pre-filter rule. The pre-filter program will be inserted in the conversion chain immediately before the filter that accepts the given MIME type.</p> @@ -1571,7 +1815,7 @@ before the filter that accepts the given MIME type.</p> <p class='summary'>*cupsPrintQuality keyword/text: "code"</p> -<p>This UI keyword defines standard print qualities that directly map from the IPP "print-quality" job template attribute. Standard keyword values are "Draft", "Normal", and "High" which are mapped from the IPP "print-quality" values 3, 4, and 5 respectively. Each <code>cupsPrintQuality</code> option typically sets output mode and resolution parameters in the page device dictionary, eliminating the need for separate (and sometimes confusing) output mode and resolution options.</p> +<p>This UI keyword defines standard print qualities that directly map from the IPP "print-quality" job template keyword. Standard keyword values are "Draft", "Normal", and "High" which are mapped from the IPP "print-quality" values 3, 4, and 5 respectively. Each <code>cupsPrintQuality</code> option typically sets output mode and resolution parameters in the page device dictionary, eliminating the need for separate (and sometimes confusing) output mode and resolution options.</p> <blockquote><b>Note:</b> @@ -1595,7 +1839,7 @@ before the filter that accepts the given MIME type.</p> <p class='summary'>*cupsSNMPSupplies: boolean</p> -<p>This attribute tells the standard network backends whether they should query +<p>This keyword tells the standard network backends whether they should query the standard SNMP Printer MIB OIDs for supply levels. The default value is <code>True</code>. @@ -1610,7 +1854,7 @@ the standard SNMP Printer MIB OIDs for supply levels. The default value is <p class='summary'>*cupsVersion: major.minor</p> -<p>This required attribute describes which version of the CUPS +<p>This required keyword describes which version of the CUPS PPD file extensions was used. Currently it must be the string "1.0", "1.1", "1.2", or "1.3".</p> @@ -1628,8 +1872,8 @@ PPD file extensions was used. Currently it must be the string <p class='summary'>*APDialogExtension: "/Library/Printers/vendor/filename.plugin"</p> -<p>This attribute defines additional option panes that are displayed in the -print dialog. Each attribute adds one or more option panes. See the "OutputBinsPDE" +<p>This keyword defines additional option panes that are displayed in the +print dialog. Each keyword adds one or more option panes. See the "OutputBinsPDE" example and <a href='http://developer.apple.com/qa/qa2004/qa1352.html'>Apple Technical Q&A QA1352</a> for information on writing your own print dialog plug-ins.</p> @@ -1654,7 +1898,7 @@ in order to be usable with all applications.</p> <p class='summary'>*APDuplexRequiresFlippedMargin: boolean</p> -<p>This boolean attribute notifies the RIP filters that the +<p>This boolean keyword notifies the RIP filters that the destination printer requires the top and bottom margins of the <tt>ImageableArea</tt> to be swapped for the back page. The default is <tt>true</tt> when <tt>cupsBackSide</tt> is <tt>Flipped</tt> @@ -1730,15 +1974,15 @@ and the <tt>Tumble</tt> page attribute.</p> </pre> <p>Also see the related <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> -attribute.</p> +keyword.</p> <h3><a name='APHelpBook'>APHelpBook</a></h3> <p class='summary'>*APHelpBook: "bundle URL"</p> -<p>This string attribute specifies the Apple help book bundle to use when +<p>This string keyword specifies the Apple help book bundle to use when looking up IPP reason codes for this printer driver. The -<a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> attribute maps +<a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> keyword maps "help" URIs to this file.</p> <p>Example:</p> @@ -1751,7 +1995,7 @@ looking up IPP reason codes for this printer driver. The <p class='summary'>*APICADriver: boolean</p> -<p>This attribute specifies whether the device has a matching Image Capture +<p>This keyword specifies whether the device has a matching Image Capture Architecture (ICA) driver for scanning. The default is <tt>False</tt>.</p> <p>Examples:</p> @@ -1765,7 +2009,7 @@ Architecture (ICA) driver for scanning. The default is <tt>False</tt>.</p> <p class='summary'>*APPrinterIconPath: "/Library/Printers/vendor/filename.icns"</p> -<p>This attribute defines the location of a printer icon file to use when +<p>This keyword defines the location of a printer icon file to use when displaying the printer. The file must be in the Apple icon format.</p> <p>Examples:</p> @@ -1779,7 +2023,7 @@ displaying the printer. The file must be in the Apple icon format.</p> <p class='summary'>*APPrinterLowInkTool: "/Library/Printers/vendor/program"</p> -<p>This attribute defines an program that checks the ink/toner/marker levels +<p>This keyword defines an program that checks the ink/toner/marker levels on a printer, returning an XML document with those levels. See the "InkTool" example and <a href='http://developer.apple.com/technotes/tn2005/tn2144.html'>Apple @@ -1796,7 +2040,7 @@ Technical Note TN2144</a> for more information.</p> <p class='summary'>*APPrinterPreset name/text: "*Option Choice ..."</p> -<p>This attribute defines presets for multiple options that show up +<p>This keyword defines presets for multiple options that show up in the print dialog of applications (such as iPhoto) that set the job style hint to <tt>NSPrintPhotoJobStyleHint</tt>. Each preset maps to one or more pairs of PPD options and choices as well as providing key/value data for @@ -1866,7 +2110,7 @@ choice (*MainKeyword OptionKeyword) or a preset identifier and value <p class='summary'>*APPrinterPrinterUtilityPath: "/Library/Printers/vendor/filename.app"</p> -<p>This attribute defines a GUI application that can be used to do printer +<p>This keyword defines a GUI application that can be used to do printer maintenance functions such as cleaning the print head(s). See ... for more information.</p> @@ -1881,7 +2125,7 @@ information.</p> <p class='summary'>*APScannerOnly: boolean</p> -<p>This attribute specifies whether the device has scanning but no printing +<p>This keyword specifies whether the device has scanning but no printing capabilities. The default is <tt>False</tt>.</p> <p>Examples:</p> @@ -1895,7 +2139,7 @@ capabilities. The default is <tt>False</tt>.</p> <p class='summary'>*APScanAppBundleID: "bundle ID"</p> -<p>This attribute defines the application to use when scanning pages from +<p>This keyword defines the application to use when scanning pages from the device.</p> <p>Examples:</p> @@ -1908,6 +2152,15 @@ the device.</p> <h2 class='title'><a name='HISTORY'>Change History</a></h2> +<h3>Changes in CUPS 1.5</h3> + +<ul> + + <li>Changes all instances of PPD attributes to PPD keywords, to be consistent with the parent specification from Adobe.</li> + +</ul> + + <h3>Changes in CUPS 1.4.5</h3> <ul> @@ -1924,32 +2177,32 @@ the device.</p> <ul> <li>Added <a href='#APICADriver'><tt>APICADriver</tt></a> - attribute.</li> + keyword.</li> <li>Added <a href='#cupsCommands'><tt>cupsCommands</tt></a> - attribute.</li> + keyword.</li> <li>Added <a href='#cupsMarkerName'><tt>cupsMarkerName</tt></a> - attribute.</li> + keyword.</li> <li>Added <a href='#cupsMarkerNotice'><tt>cupsMarkerNotice</tt></a> - attribute.</li> + keyword.</li> <li>Added <a href='#cupsPJLDisplay'><tt>cupsPJLDisplay</tt></a> - attribute.</li> + keyword.</li> <li>Added <a href='#cupsSNMPSupplies'><tt>cupsSNMPSupplies</tt></a> - attribute.</li> + keyword.</li> <li>Added <a href='#cupsUIResolver'><tt>cupsUIResolver</tt></a> and <a href='#cupsUIConstraints'><tt>cupsUIConstraints</tt></a> - attributes.</li> + keywords.</li> <li>Added <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a>, <a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a>, <a href='#cupsMinSize'><tt>cupsMinSize</tt></a>, and - <a href='#cupsMaxSize'><tt>cupsMaxSize</tt></a> attributes.</li> + <a href='#cupsMaxSize'><tt>cupsMaxSize</tt></a> keywords.</li> </ul> @@ -1958,11 +2211,11 @@ the device.</p> <ul> - <li>Added missing Mac OS X <tt>AP</tt> attributes.</li> + <li>Added missing Mac OS X <tt>AP</tt> keywords.</li> <li>Added section on auto-configuration including the <tt>OID<i>MainKeyword</i></tt> and <tt>?<i>MainKeyword</i></tt> - attributes.</li> + keywords.</li> <li>Minor reorganization.</li> @@ -1981,7 +2234,7 @@ the device.</p> <li>Added <a href='#APPrinterPreset'><tt>APPrinterPreset</tt></a>, <a href='#cupsIPPFinishings'><tt>cupsIPPFinishings</tt></a>, and - <a href='#cupsPreFilter'><tt>cupsPreFilter</tt></a> attributes.</li> + <a href='#cupsPreFilter'><tt>cupsPreFilter</tt></a> keywords.</li> <li>Added discussion of custom option code, sample <tt>CustomPageSize</tt> code, and "do not use dict and put" note.</li> @@ -2001,24 +2254,24 @@ the device.</p> <ul> - <li>Added globalization support attributes</li> + <li>Added globalization support keywords</li> <li>Added custom option values support</li> - <li>Added <a href='#APHelpBook'><tt>APHelpBook</tt></a> attribute</li> + <li>Added <a href='#APHelpBook'><tt>APHelpBook</tt></a> keyword</li> <li>Added <a href='#APDuplexRequiresFlippedMargin'><tt>APDuplexRequiresFlippedMargin</tt></a> - attribute</li> + keyword</li> - <li>Added <a href='#cupsICCProfile'><tt>cupsICCProfile</tt></a> attribute</li> + <li>Added <a href='#cupsICCProfile'><tt>cupsICCProfile</tt></a> keyword</li> - <li>Added <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> attribute</li> + <li>Added <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> keyword</li> - <li>Added <a href='#cupsLanguages'><tt>cupsLanguages</tt></a> attribute</li> + <li>Added <a href='#cupsLanguages'><tt>cupsLanguages</tt></a> keyword</li> - <li>Added <a href='#cupsPortMonitor'><tt>cupsPortMonitor</tt></a> attribute</li> + <li>Added <a href='#cupsPortMonitor'><tt>cupsPortMonitor</tt></a> keyword</li> - <li>Removed <tt>cupsProtocol</tt> attribute</li> + <li>Removed <tt>cupsProtocol</tt> keyword</li> </ul> @@ -2026,11 +2279,11 @@ the device.</p> <ul> - <li>Added <a href='#cupsFlipDuplex'><tt>cupsFlipDuplex</tt></a> attribute</li> + <li>Added <a href='#cupsFlipDuplex'><tt>cupsFlipDuplex</tt></a> keyword</li> - <li>Added <tt>cupsProtocol</tt> attribute</li> + <li>Added <tt>cupsProtocol</tt> keyword</li> </ul> - +</div> </body> </html> |