[prev in list] [next in list] [prev in thread] [next in thread]
List: cups-commit
Subject: [cups.commit] [CUPS] r9121 - branches/branch-1.4/doc/help
From: cups-dev () easysw ! com
Date: 2010-04-23 18:57:02
Message-ID: 9891-cups.commit () news ! easysw ! com
[Download RAW message or body]
Author: mike
Date: 2010-04-23 11:57:00 -0700 (Fri, 23 Apr 2010)
New Revision: 9121
Log:
Update API help.
Modified:
branches/branch-1.4/doc/help/api-cgi.html
branches/branch-1.4/doc/help/api-cups.html
branches/branch-1.4/doc/help/api-filter.html
branches/branch-1.4/doc/help/api-httpipp.html
branches/branch-1.4/doc/help/api-ppd.html
Modified: branches/branch-1.4/doc/help/api-cgi.html
===================================================================
--- branches/branch-1.4/doc/help/api-cgi.html 2010-04-23 18:56:34 UTC (rev 9120)
+++ branches/branch-1.4/doc/help/api-cgi.html 2010-04-23 18:57:00 UTC (rev 9121)
@@ -377,6 +377,7 @@
<li><a href="#OVERVIEW">Overview</a></li>
<li><a href="#FUNCTIONS">Functions</a><ul class="code">
<li><a href="#cgiCheckVariables" title="Check for the presence of \
"required" variables.">cgiCheckVariables</a></li> +<li><a \
href="#cgiClearVariables" title="Clear all form \
variables.">cgiClearVariables</a></li> <li><a href="#cgiCompileSearch" \
title="Compile a search string.">cgiCompileSearch</a></li> <li><a \
href="#cgiCopyTemplateFile" title="Copy a template file and replace all the \
'{variable}' strings with the variable value.">cgiCopyTemplateFile</a></li> @@ \
-386,26 +387,28 @@ <li><a href="#cgiEndMultipart" title="End the delivery of a \
multipart web page.">cgiEndMultipart</a></li> <li><a href="#cgiFormEncode" \
title="Encode a string as a form variable.">cgiFormEncode</a></li> <li><a \
href="#cgiFreeSearch" title="Free a compiled search \
context.">cgiFreeSearch</a></li>
-<li><a href="#cgiGetArray" title="Get an element from a form \
array...">cgiGetArray</a></li> +<li><a href="#cgiGetArray" title="Get an element from \
a form array.">cgiGetArray</a></li> <li><a href="#cgiGetAttributes" title="Get the \
list of attributes that are needed by the template file.">cgiGetAttributes</a></li>
+<li><a href="#cgiGetCookie" title="Get a cookie value.">cgiGetCookie</a></li>
<li><a href="#cgiGetFile" title="Get the file (if any) that was submitted in the \
form.">cgiGetFile</a></li> <li><a href="#cgiGetIPPObjects" title="Get the objects in \
an IPP response.">cgiGetIPPObjects</a></li> <li><a href="#cgiGetSize" title="Get the \
size of a form array value.">cgiGetSize</a></li> <li><a href="#cgiGetTemplateDir" \
title="Get the templates directory...">cgiGetTemplateDir</a></li>
-<li><a href="#cgiGetVariable" title="Get a CGI variable from the \
database...">cgiGetVariable</a></li>
-<li><a href="#cgiInitialize" title="Initialize the CGI variable \
"database"...">cgiInitialize</a></li> +<li><a href="#cgiGetVariable" \
title="Get a CGI variable from the database.">cgiGetVariable</a></li> +<li><a \
href="#cgiInitialize" title="Initialize the CGI variable \
"database".">cgiInitialize</a></li> <li><a href="#cgiIsPOST" \
title="Determine whether this page was POSTed.">cgiIsPOST</a></li> <li><a \
href="#cgiMoveJobs" title="Move one or more jobs.">cgiMoveJobs</a></li> <li><a \
href="#cgiPrintCommand" title="Print a CUPS command job.">cgiPrintCommand</a></li> \
<li><a href="#cgiPrintTestPage" title="Print a test page.">cgiPrintTestPage</a></li> \
<li><a href="#cgiRewriteURL" title="Rewrite a printer URI into a web browser \
URL...">cgiRewriteURL</a></li> <li><a href="#cgiSetArray" title="Set array element N \
to the specified string.">cgiSetArray</a></li> +<li><a href="#cgiSetCookie" \
title="Set a cookie value.">cgiSetCookie</a></li> <li><a href="#cgiSetIPPObjectVars" \
title="Set CGI variables from an IPP object.">cgiSetIPPObjectVars</a></li> <li><a \
href="#cgiSetIPPVars" title="Set CGI variables from an IPP \
response.">cgiSetIPPVars</a></li> <li><a href="#cgiSetServerVersion" title="Set the \
server name and CUPS version...">cgiSetServerVersion</a></li> <li><a \
href="#cgiSetSize" title="Set the array size.">cgiSetSize</a></li>
-<li><a href="#cgiSetVariable" title="Set a CGI variable in the \
database...">cgiSetVariable</a></li> +<li><a href="#cgiSetVariable" title="Set a CGI \
variable in the database.">cgiSetVariable</a></li> <li><a href="#cgiShowIPPError" \
title="Show the last IPP error message.">cgiShowIPPError</a></li> <li><a \
href="#cgiShowJobs" title="Show print jobs.">cgiShowJobs</a></li> <li><a \
href="#cgiStartHTML" title="Start a HTML page.">cgiStartHTML</a></li> @@ -463,6 \
+466,10 @@ <p class="description">1 if all variables present, 0 otherwise</p>
<h4 class="discussion">Discussion</h4>
<p class="discussion">Names may be separated by spaces and/or commas.</p>
+<h3 class="function"><a name="cgiClearVariables">cgiClearVariables</a></h3>
+<p class="description">Clear all form variables.</p>
+<p class="code">
+void cgiClearVariables (void);</p>
<h3 class="function"><a name="cgiCompileSearch">cgiCompileSearch</a></h3>
<p class="description">Compile a search string.</p>
<p class="code">
@@ -557,7 +564,7 @@
<dd class="description">Search context</dd>
</dl>
<h3 class="function"><a name="cgiGetArray">cgiGetArray</a></h3>
-<p class="description">Get an element from a form array...</p>
+<p class="description">Get an element from a form array.</p>
<p class="code">
const char *cgiGetArray (<br>
const char *name,<br>
@@ -587,6 +594,19 @@
<dt>tmpl</dt>
<dd class="description">Base filename</dd>
</dl>
+<h3 class="function"><a name="cgiGetCookie">cgiGetCookie</a></h3>
+<p class="description">Get a cookie value.</p>
+<p class="code">
+const char *cgiGetCookie (<br>
+ const char *name<br>
+);</p>
+<h4 class="parameters">Parameters</h4>
+<dl>
+<dt>name</dt>
+<dd class="description">Name of cookie</dd>
+</dl>
+<h4 class="returnvalue">Return Value</h4>
+<p class="description">Value or NULL</p>
<h3 class="function"><a name="cgiGetFile">cgiGetFile</a></h3>
<p class="description">Get the file (if any) that was submitted in the form.</p>
<p class="code">
@@ -629,7 +649,7 @@
<h4 class="returnvalue">Return Value</h4>
<p class="description">Template directory</p>
<h3 class="function"><a name="cgiGetVariable">cgiGetVariable</a></h3>
-<p class="description">Get a CGI variable from the database...</p>
+<p class="description">Get a CGI variable from the database.</p>
<p class="code">
const char *cgiGetVariable (<br>
const char *name<br>
@@ -643,9 +663,9 @@
<p class="description">Value of variable</p>
<h4 class="discussion">Discussion</h4>
<p class="discussion">Returns NULL if the variable doesn't exist. If the variable \
is an
-array of values, returns the last element...</p>
+array of values, returns the last element.</p>
<h3 class="function"><a name="cgiInitialize">cgiInitialize</a></h3>
-<p class="description">Initialize the CGI variable "database"...</p>
+<p class="description">Initialize the CGI variable "database".</p>
<p class="code">
int cgiInitialize (void);</p>
<h4 class="returnvalue">Return Value</h4>
@@ -751,6 +771,32 @@
<h4 class="discussion">Discussion</h4>
<p class="discussion">If the variable array is smaller than (element + 1), the \
intervening elements are set to NULL.</p>
+<h3 class="function"><a name="cgiSetCookie">cgiSetCookie</a></h3>
+<p class="description">Set a cookie value.</p>
+<p class="code">
+void cgiSetCookie (<br>
+ const char *name,<br>
+ const char *value,<br>
+ const char *path,<br>
+ const char *domain,<br>
+ time_t expires,<br>
+ int secure<br>
+);</p>
+<h4 class="parameters">Parameters</h4>
+<dl>
+<dt>name</dt>
+<dd class="description">Name</dd>
+<dt>value</dt>
+<dd class="description">Value</dd>
+<dt>path</dt>
+<dd class="description">Path (typically "/")</dd>
+<dt>domain</dt>
+<dd class="description">Domain name</dd>
+<dt>expires</dt>
+<dd class="description">Expiration date (0 for session)</dd>
+<dt>secure</dt>
+<dd class="description">Require SSL</dd>
+</dl>
<h3 class="function"><a name="cgiSetIPPObjectVars">cgiSetIPPObjectVars</a></h3>
<p class="description">Set CGI variables from an IPP object.</p>
<p class="code">
@@ -814,7 +860,7 @@
<dd class="description">Number of elements (0 to N)</dd>
</dl>
<h3 class="function"><a name="cgiSetVariable">cgiSetVariable</a></h3>
-<p class="description">Set a CGI variable in the database...</p>
+<p class="description">Set a CGI variable in the database.</p>
<p class="code">
void cgiSetVariable (<br>
const char *name,<br>
Modified: branches/branch-1.4/doc/help/api-cups.html
===================================================================
--- branches/branch-1.4/doc/help/api-cups.html 2010-04-23 18:56:34 UTC (rev 9120)
+++ branches/branch-1.4/doc/help/api-cups.html 2010-04-23 18:57:00 UTC (rev 9121)
@@ -398,7 +398,7 @@
<li><a href="#cupsCancelJob" title="Cancel a print job on the default \
server.">cupsCancelJob</a></li> <li><a href="#cupsCancelJob2" title="Cancel or purge \
a print job.">cupsCancelJob2</a></li> <li><a href="#cupsCreateJob" title="Create an \
empty job for streaming.">cupsCreateJob</a></li>
-<li><a href="#cupsEncryption" title="Get the default encryption \
settings.">cupsEncryption</a></li> +<li><a href="#cupsEncryption" title="Get the \
current encryption settings.">cupsEncryption</a></li> <li><a \
href="#cupsFinishDocument" title="Finish sending a \
document.">cupsFinishDocument</a></li> <li><a href="#cupsFreeDests" title="Free the \
memory used by the list of destinations.">cupsFreeDests</a></li> <li><a \
href="#cupsFreeJobs" title="Free memory used by job data.">cupsFreeJobs</a></li> @@ \
-419,7 +419,7 @@ server if it has changed.">cupsGetPPD3</a></li>
<li><a href="#cupsGetPassword" title="Get a password from the \
user.">cupsGetPassword</a></li> <li><a href="#cupsGetPassword2" title="Get a \
password from the user using the advanced
-callback.">cupsGetPassword2</a></li>
+password callback.">cupsGetPassword2</a></li>
<li><a href="#cupsGetPrinters" title="Get a list of printers from the default \
server.">cupsGetPrinters</a></li> <li><a href="#cupsGetServerPPD" title="Get an \
available PPD file from the server.">cupsGetServerPPD</a></li> <li><a \
href="#cupsLangDefault" title="Return the default language.">cupsLangDefault</a></li> \
@@ -442,14 +442,14 @@ 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 default \
server.">cupsServer</a></li> +<li><a href="#cupsServer" title="Return the \
hostname/address of the current server.">cupsServer</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> <li><a href="#cupsSetEncryption" title="Set the \
encryption preference.">cupsSetEncryption</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.">cupsSetServer</a></li> +<li><a href="#cupsSetServer" title="Set the default \
server name and port.">cupsSetServer</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> @@ -479,7 +479,7 @@
CUPS API introduction for the Common UNIX Printing System (CUPS).
- Copyright 2007-2008 by Apple Inc.
+ Copyright 2007-2010 by Apple Inc.
Copyright 1997-2006 by Easy Software Products, all rights reserved.
These coded instructions, statements, and computer programs are the
@@ -558,12 +558,13 @@
</tr>
<tr>
<td>"printer-is-accepting-jobs"</td>
- <td>"1" if the destination is accepting new jobs, "0" if not.</td>
+ <td>"true" if the destination is accepting new jobs, "false" if
+ not.</td>
</tr>
<tr>
<td>"printer-is-shared"</td>
- <td>"1" if the destination is being shared with other computers, "0" if
- not.</td>
+ <td>"true" if the destination is being shared with other computers,
+ "false" if not.</td>
</tr>
<tr>
<td>"printer-location"</td>
@@ -1157,7 +1158,7 @@
</p>
<h3 class="function"><a name="cupsEncryption">cupsEncryption</a></h3>
-<p class="description">Get the default encryption settings.</p>
+<p class="description">Get the current encryption settings.</p>
<p class="code">
http_encryption_t cupsEncryption (void);</p>
<h4 class="returnvalue">Return Value</h4>
@@ -1166,7 +1167,12 @@
<p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION
environment variable, then the ~/.cups/client.conf file, and finally the
/etc/cups/client.conf file. If not set, the default is
-<code>HTTP_ENCRYPT_IF_REQUESTED</code>.</p>
+<code>HTTP_ENCRYPT_IF_REQUESTED</code>.<br>
+<br>
+Note: The current encryption setting is tracked separately for each thread
+in a program. Multi-threaded programs that override the setting via the
+<a href="#cupsSetEncryption"><code>cupsSetEncryption</code></a> function need to do \
so in each thread for the same +setting to be used.</p>
<h3 class="function"><span class="info"> CUPS 1.4/Mac OS X 10.6 </span><a \
name="cupsFinishDocument">cupsFinishDocument</a></h3> <p class="description">Finish \
sending a document.</p> <p class="code">
@@ -1577,10 +1583,15 @@
<p class="description">Password</p>
<h4 class="discussion">Discussion</h4>
<p class="discussion">Uses the current password callback function. Returns \
<code>NULL</code> if the
-user does not provide a password.</p>
+user does not provide a password.<br>
+<br>
+Note: The current password callback function is tracked separately for each
+thread in a program. Multi-threaded programs that override the setting via
+the <a href="#cupsSetPasswordCB"><code>cupsSetPasswordCB</code></a> or <a \
href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a> functions need to +do \
so in each thread for the same function to be used.</p> <h3 class="function"><span \
class="info"> CUPS 1.4/Mac OS X 10.6 </span><a \
name="cupsGetPassword2">cupsGetPassword2</a></h3> <p class="description">Get a \
password from the user using the advanced
-callback.</p>
+password callback.</p>
<p class="code">
const char *cupsGetPassword2 (<br>
const char *prompt,<br>
@@ -1603,7 +1614,12 @@
<p class="description">Password</p>
<h4 class="discussion">Discussion</h4>
<p class="discussion">Uses the current password callback function. Returns \
<code>NULL</code> if the
-user does not provide a password.
+user does not provide a password.<br>
+<br>
+Note: The current password callback function is tracked separately for each
+thread in a program. Multi-threaded programs that override the setting via
+the <a href="#cupsSetPasswordCB"><code>cupsSetPasswordCB</code></a> or <a \
href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a> functions need to +do \
so in each thread for the same function to be used.
</p>
<h3 class="function"><span class="info"> DEPRECATED </span><a \
name="cupsGetPrinters">cupsGetPrinters</a></h3> @@ -1941,14 +1957,24 @@
<h4 class="returnvalue">Return Value</h4>
<p class="description">New number of options</p>
<h3 class="function"><a name="cupsServer">cupsServer</a></h3>
-<p class="description">Return the hostname/address of the default server.</p>
+<p class="description">Return the hostname/address of the current server.</p>
<p class="code">
const char *cupsServer (void);</p>
<h4 class="returnvalue">Return Value</h4>
<p class="description">Server name</p>
<h4 class="discussion">Discussion</h4>
-<p class="discussion">The returned value can be a fully-qualified hostname, a \
numeric
-IPv4 or IPv6 address, or a domain socket pathname.</p>
+<p class="discussion">The default server comes from the CUPS_SERVER environment \
variable, then the +~/.cups/client.conf file, and finally the /etc/cups/client.conf \
file. If not +set, the default is the local system - either "localhost" or \
a domain socket +path.<br>
+<br>
+The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6
+address, or a domain socket pathname.<br>
+<br>
+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.3/Mac OS X 10.5 </span><a \
name="cupsSetDefaultDest">cupsSetDefaultDest</a></h3> <p class="description">Set the \
default destination.</p> <p class="code">
@@ -2021,6 +2047,15 @@
<dt>e</dt>
<dd class="description">New encryption preference</dd>
</dl>
+<h4 class="discussion">Discussion</h4>
+<p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION
+environment variable, then the ~/.cups/client.conf file, and finally the
+/etc/cups/client.conf file. If not set, the default is
+<code>HTTP_ENCRYPT_IF_REQUESTED</code>.<br>
+<br>
+Note: The current encryption setting is 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"><a name="cupsSetPasswordCB">cupsSetPasswordCB</a></h3>
<p class="description">Set the password callback for CUPS.</p>
<p class="code">
@@ -2033,7 +2068,14 @@
<dd class="description">Callback function</dd>
</dl>
<h4 class="discussion">Discussion</h4>
-<p class="discussion">Pass <code>NULL</code> to restore the default (console) \
password callback.</p> +<p class="discussion">Pass <code>NULL</code> to restore the \
default (console) password callback, which +reads the password from the console. \
Programs should call either this +function or <a \
href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a>, as only one callback \
can be registered +by a program per thread.<br>
+<br>
+Note: The current password 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.4/Mac OS X 10.6 </span><a \
name="cupsSetPasswordCB2">cupsSetPasswordCB2</a></h3> <p class="description">Set the \
advanced password callback for CUPS.</p> <p class="code">
@@ -2049,11 +2091,18 @@
<dd class="description">User data pointer</dd>
</dl>
<h4 class="discussion">Discussion</h4>
-<p class="discussion">Pass <code>NULL</code> to restore the default (console) \
password callback. +<p class="discussion">Pass <code>NULL</code> to restore the \
default (console) password callback, which +reads the password from the console. \
Programs should call either this +function or <a \
href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a>, as only one callback \
can be registered +by a program per thread.<br>
+<br>
+Note: The current password 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="cupsSetServer">cupsSetServer</a></h3>
-<p class="description">Set the default server name.</p>
+<p class="description">Set the default server name and port.</p>
<p class="code">
void cupsSetServer (<br>
const char *server<br>
@@ -2065,8 +2114,14 @@
</dl>
<h4 class="discussion">Discussion</h4>
<p class="discussion">The "server" string can be a fully-qualified \
hostname, a numeric
-IPv4 or IPv6 address, or a domain socket pathname. Pass <code>NULL</code> to
-restore the default server name.</p>
+IPv4 or IPv6 address, or a domain socket pathname. Hostnames and numeric IP
+addresses can be optionally followed by a colon and port number to override
+the default port 631, e.g. "hostname:8631". Pass <code>NULL</code> to \
restore the +default server name and port.<br>
+<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"><a name="cupsSetUser">cupsSetUser</a></h3>
<p class="description">Set the default user name.</p>
<p class="code">
@@ -2079,7 +2134,11 @@
<dd class="description">User name</dd>
</dl>
<h4 class="discussion">Discussion</h4>
-<p class="discussion">Pass <code>NULL</code> to restore the default user name.</p>
+<p class="discussion">Pass <code>NULL</code> to restore the default user name.<br>
+<br>
+Note: The current user name is tracked separately for each thread in a
+program. Multi-threaded programs that override the user name need to do so
+in each thread for the same user name to be used.</p>
<h3 class="function"><span class="info"> CUPS 1.4/Mac OS X 10.6 </span><a \
name="cupsStartDocument">cupsStartDocument</a></h3> <p class="description">Add a \
document to a job created with cupsCreateJob().</p> <p class="code">
@@ -2186,6 +2245,11 @@
const char *cupsUser (void);</p>
<h4 class="returnvalue">Return Value</h4>
<p class="description">User name</p>
+<h4 class="discussion">Discussion</h4>
+<p class="discussion">Note: The current user name is tracked separately for each \
thread in a +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"><a name="cups_dest_t">cups_dest_t</a></h3>
<p class="description">Destination</p>
Modified: branches/branch-1.4/doc/help/api-filter.html
===================================================================
--- branches/branch-1.4/doc/help/api-filter.html 2010-04-23 18:56:34 UTC (rev 9120)
+++ branches/branch-1.4/doc/help/api-filter.html 2010-04-23 18:57:00 UTC (rev 9121)
@@ -489,7 +489,7 @@
used by the filter since that can lead to an unauthorized disclosure of
information. <em>Always</em> treat input as suspect and validate it!</p>
-<p>If you are developing a backend that runs as root , make sure to check for
+<p>If you are developing a backend that runs as root, make sure to check for
potential buffer overflows, integer under/overflow conditions, and file
accesses since these can lead to privilege escalations. When writing files,
always validate the file path and <em>never</em> allow a user to determine
@@ -510,15 +510,15 @@
<h3><a name="PERMISSIONS">File Permissions</a></h3>
<p>For security reasons, CUPS will only run filters and backends that are owned
-by root and do not have world write permissions. The recommended permissions for
-filters and backends are 0555 - read and execute but no write. Backends that
-must run as root should use permissions of 0500 - read and execute by root, no
-access for other users. Write permissions can be enabled for the root user
-only.</p>
+by root and do not have world or group write permissions. The recommended
+permissions for filters and backends are 0555 - read and execute but no write.
+Backends that must run as root should use permissions of 0500 - read and execute
+by root, no access for other users. Write permissions can be enabled for the
+root user only.</p>
<p>To avoid a warning message, the directory containing your filter(s) must also
-be owned by root and have world write disabled - permissions of 0755 or 0555 are
-strongly encouraged.</p>
+be owned by root and have world and group write disabled - permissions of 0755
+or 0555 are strongly encouraged.</p>
<h3><a name="TEMPFILES">Temporary Files</a></h3>
Modified: branches/branch-1.4/doc/help/api-httpipp.html
===================================================================
--- branches/branch-1.4/doc/help/api-httpipp.html 2010-04-23 18:56:34 UTC (rev 9120)
+++ branches/branch-1.4/doc/help/api-httpipp.html 2010-04-23 18:57:00 UTC (rev 9121)
@@ -412,7 +412,7 @@
<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="#httpDecode64" \
title="Base64-decode a string.">httpDecode64</a></li> @@ -465,7 +465,7 @@
<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="#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> @@ -537,19 +537,19 @@
<li><a href="#http_uri_status_t" title="URI separation status \
">http_uri_status_t</a></li> <li><a href="#http_version_t" title="HTTP version \
numbers">http_version_t</a></li> <li><a href="#ipp_attribute_t" \
title="Attribute">ipp_attribute_t</a></li>
- <li><a href="#ipp_finish_t" title="Finishings...">ipp_finish_t</a></li>
+ <li><a href="#ipp_finish_t" title="Finishings">ipp_finish_t</a></li>
<li><a href="#ipp_iocb_t" title="IPP IO Callback Function ">ipp_iocb_t</a></li>
- <li><a href="#ipp_jstate_t" title="Job States....">ipp_jstate_t</a></li>
- <li><a href="#ipp_op_t" title="IPP operations...">ipp_op_t</a></li>
- <li><a href="#ipp_orient_t" title="Orientation...">ipp_orient_t</a></li>
- <li><a href="#ipp_pstate_t" title="Printer States....">ipp_pstate_t</a></li>
- <li><a href="#ipp_quality_t" title="Qualities...">ipp_quality_t</a></li>
+ <li><a href="#ipp_jstate_t" title="Job states">ipp_jstate_t</a></li>
+ <li><a href="#ipp_op_t" title="IPP operations">ipp_op_t</a></li>
+ <li><a href="#ipp_orient_t" title="Orientation values">ipp_orient_t</a></li>
+ <li><a href="#ipp_pstate_t" title="Printer states">ipp_pstate_t</a></li>
+ <li><a href="#ipp_quality_t" title="Qualities">ipp_quality_t</a></li>
<li><a href="#ipp_request_t" title="Request Header">ipp_request_t</a></li>
- <li><a href="#ipp_res_t" title="Resolution units...">ipp_res_t</a></li>
- <li><a href="#ipp_state_t" title="IPP states...">ipp_state_t</a></li>
+ <li><a href="#ipp_res_t" title="Resolution units">ipp_res_t</a></li>
+ <li><a href="#ipp_state_t" title="IPP states">ipp_state_t</a></li>
<li><a href="#ipp_t" title="Attribute Value">ipp_t</a></li>
- <li><a href="#ipp_uchar_t" title="IPP status codes...">ipp_uchar_t</a></li>
- <li><a href="#ipp_tag_t" title="Format tags for attributes...">ipp_tag_t</a></li>
+ <li><a href="#ipp_uchar_t" title="IPP status codes">ipp_uchar_t</a></li>
+ <li><a href="#ipp_tag_t" title="Format tags for attributes">ipp_tag_t</a></li>
<li><a href="#ipp_value_t" title="Attribute Value">ipp_value_t</a></li>
</ul></li>
<li><a href="#STRUCTURES">Structures</a><ul class="code">
@@ -576,16 +576,16 @@
<li><a href="#http_uri_coding_e" title="URI en/decode \
flags">http_uri_coding_e</a></li> <li><a href="#http_uri_status_e" title="URI \
separation status ">http_uri_status_e</a></li> <li><a href="#http_version_e" \
title="HTTP version numbers">http_version_e</a></li>
- <li><a href="#ipp_finish_e" title="Finishings...">ipp_finish_e</a></li>
- <li><a href="#ipp_jstate_e" title="Job States....">ipp_jstate_e</a></li>
- <li><a href="#ipp_op_e" title="IPP operations...">ipp_op_e</a></li>
- <li><a href="#ipp_orient_e" title="Orientation...">ipp_orient_e</a></li>
- <li><a href="#ipp_pstate_e" title="Printer States....">ipp_pstate_e</a></li>
- <li><a href="#ipp_quality_e" title="Qualities...">ipp_quality_e</a></li>
- <li><a href="#ipp_res_e" title="Resolution units...">ipp_res_e</a></li>
- <li><a href="#ipp_state_e" title="IPP states...">ipp_state_e</a></li>
- <li><a href="#ipp_status_e" title="IPP status codes...">ipp_status_e</a></li>
- <li><a href="#ipp_tag_e" title="Format tags for attributes...">ipp_tag_e</a></li>
+ <li><a href="#ipp_finish_e" title="Finishings">ipp_finish_e</a></li>
+ <li><a href="#ipp_jstate_e" title="Job states">ipp_jstate_e</a></li>
+ <li><a href="#ipp_op_e" title="IPP operations">ipp_op_e</a></li>
+ <li><a href="#ipp_orient_e" title="Orientation values">ipp_orient_e</a></li>
+ <li><a href="#ipp_pstate_e" title="Printer states">ipp_pstate_e</a></li>
+ <li><a href="#ipp_quality_e" title="Qualities">ipp_quality_e</a></li>
+ <li><a href="#ipp_res_e" title="Resolution units">ipp_res_e</a></li>
+ <li><a href="#ipp_state_e" title="IPP states">ipp_state_e</a></li>
+ <li><a href="#ipp_status_e" title="IPP status codes">ipp_status_e</a></li>
+ <li><a href="#ipp_tag_e" title="Format tags for attributes">ipp_tag_e</a></li>
</ul></li>
<!--
"$Id$"
@@ -1531,7 +1531,7 @@
<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>
@@ -2356,7 +2356,7 @@
</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>
@@ -3324,7 +3324,7 @@
typedef struct <a href="#ipp_attribute_s">ipp_attribute_s</a> ipp_attribute_t;
</p>
<h3 class="typedef"><a name="ipp_finish_t">ipp_finish_t</a></h3>
-<p class="description">Finishings...</p>
+<p class="description">Finishings</p>
<p class="code">
typedef enum <a href="#ipp_finish_e">ipp_finish_e</a> ipp_finish_t;
</p>
@@ -3334,27 +3334,27 @@
typedef ssize_t (*ipp_iocb_t)(void *, <a href="#ipp_uchar_t">ipp_uchar_t</a> *, \
size_t); </p>
<h3 class="typedef"><a name="ipp_jstate_t">ipp_jstate_t</a></h3>
-<p class="description">Job States....</p>
+<p class="description">Job states</p>
<p class="code">
typedef enum <a href="#ipp_jstate_e">ipp_jstate_e</a> ipp_jstate_t;
</p>
<h3 class="typedef"><a name="ipp_op_t">ipp_op_t</a></h3>
-<p class="description">IPP operations...</p>
+<p class="description">IPP operations</p>
<p class="code">
typedef enum <a href="#ipp_op_e">ipp_op_e</a> ipp_op_t;
</p>
<h3 class="typedef"><a name="ipp_orient_t">ipp_orient_t</a></h3>
-<p class="description">Orientation...</p>
+<p class="description">Orientation values</p>
<p class="code">
typedef enum <a href="#ipp_orient_e">ipp_orient_e</a> ipp_orient_t;
</p>
<h3 class="typedef"><a name="ipp_pstate_t">ipp_pstate_t</a></h3>
-<p class="description">Printer States....</p>
+<p class="description">Printer states</p>
<p class="code">
typedef enum <a href="#ipp_pstate_e">ipp_pstate_e</a> ipp_pstate_t;
</p>
<h3 class="typedef"><a name="ipp_quality_t">ipp_quality_t</a></h3>
-<p class="description">Qualities...</p>
+<p class="description">Qualities</p>
<p class="code">
typedef enum <a href="#ipp_quality_e">ipp_quality_e</a> ipp_quality_t;
</p>
@@ -3364,12 +3364,12 @@
typedef union <a href="#ipp_request_u">ipp_request_u</a> ipp_request_t;
</p>
<h3 class="typedef"><a name="ipp_res_t">ipp_res_t</a></h3>
-<p class="description">Resolution units...</p>
+<p class="description">Resolution units</p>
<p class="code">
typedef enum <a href="#ipp_res_e">ipp_res_e</a> ipp_res_t;
</p>
<h3 class="typedef"><a name="ipp_state_t">ipp_state_t</a></h3>
-<p class="description">IPP states...</p>
+<p class="description">IPP states</p>
<p class="code">
typedef enum <a href="#ipp_state_e">ipp_state_e</a> ipp_state_t;
</p>
@@ -3379,12 +3379,12 @@
typedef struct <a href="#ipp_s">ipp_s</a> ipp_t;
</p>
<h3 class="typedef"><a name="ipp_uchar_t">ipp_uchar_t</a></h3>
-<p class="description">IPP status codes...</p>
+<p class="description">IPP status codes</p>
<p class="code">
typedef typedef unsigned char ipp_uchar_t;
</p>
<h3 class="typedef"><a name="ipp_tag_t">ipp_tag_t</a></h3>
-<p class="description">Format tags for attributes...</p>
+<p class="description">Format tags for attributes</p>
<p class="code">
typedef enum <a href="#ipp_tag_e">ipp_tag_e</a> ipp_tag_t;
</p>
@@ -3442,6 +3442,7 @@
<a href="#ipp_attribute_t">ipp_attribute_t</a> *prev;<br>
<a href="#ipp_request_t">ipp_request_t</a> request;<br>
<a href="#ipp_state_t">ipp_state_t</a> state;<br>
+ int use;<br>
};</p>
<h4 class="members">Members</h4>
<dl>
@@ -3459,6 +3460,8 @@
<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>
</dl>
<h2 class="title"><a name="UNIONS">Unions</a></h2>
<h3 class="union"><a name="ipp_request_u">ipp_request_u</a></h3>
@@ -3786,7 +3789,7 @@
<dd class="description">HTTP/1.1</dd>
</dl>
<h3 class="enumeration"><a name="ipp_finish_e">ipp_finish_e</a></h3>
-<p class="description">Finishings...</p>
+<p class="description">Finishings</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_FINISHINGS_BALE </dt>
@@ -3847,7 +3850,7 @@
<dd class="description">Trim (any type)</dd>
</dl>
<h3 class="enumeration"><a name="ipp_jstate_e">ipp_jstate_e</a></h3>
-<p class="description">Job States....</p>
+<p class="description">Job states</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_JOB_ABORTED </dt>
@@ -3866,7 +3869,7 @@
<dd class="description">Job has been stopped</dd>
</dl>
<h3 class="enumeration"><a name="ipp_op_e">ipp_op_e</a></h3>
-<p class="description">IPP operations...</p>
+<p class="description">IPP operations</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>CUPS_ACCEPT_JOBS </dt>
@@ -3953,7 +3956,7 @@
<dd class="description">Validate job options</dd>
</dl>
<h3 class="enumeration"><a name="ipp_orient_e">ipp_orient_e</a></h3>
-<p class="description">Orientation...</p>
+<p class="description">Orientation values</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_LANDSCAPE </dt>
@@ -3966,7 +3969,7 @@
<dd class="description">180 degrees</dd>
</dl>
<h3 class="enumeration"><a name="ipp_pstate_e">ipp_pstate_e</a></h3>
-<p class="description">Printer States....</p>
+<p class="description">Printer states</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_PRINTER_IDLE </dt>
@@ -3977,7 +3980,7 @@
<dd class="description">Printer is stopped</dd>
</dl>
<h3 class="enumeration"><a name="ipp_quality_e">ipp_quality_e</a></h3>
-<p class="description">Qualities...</p>
+<p class="description">Qualities</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_QUALITY_DRAFT </dt>
@@ -3988,7 +3991,7 @@
<dd class="description">Normal quality</dd>
</dl>
<h3 class="enumeration"><a name="ipp_res_e">ipp_res_e</a></h3>
-<p class="description">Resolution units...</p>
+<p class="description">Resolution units</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_RES_PER_CM </dt>
@@ -3997,7 +4000,7 @@
<dd class="description">Pixels per inch</dd>
</dl>
<h3 class="enumeration"><a name="ipp_state_e">ipp_state_e</a></h3>
-<p class="description">IPP states...</p>
+<p class="description">IPP states</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_ATTRIBUTE </dt>
@@ -4012,7 +4015,7 @@
<dd class="description">Nothing is happening/request completed</dd>
</dl>
<h3 class="enumeration"><a name="ipp_status_e">ipp_status_e</a></h3>
-<p class="description">IPP status codes...</p>
+<p class="description">IPP status codes</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>CUPS_SEE_OTHER </dt>
@@ -4105,7 +4108,7 @@
<dd class="description">server-error-version-not-supported</dd>
</dl>
<h3 class="enumeration"><a name="ipp_tag_e">ipp_tag_e</a></h3>
-<p class="description">Format tags for attributes...</p>
+<p class="description">Format tags for attributes</p>
<h4 class="constants">Constants</h4>
<dl>
<dt>IPP_TAG_ADMINDEFINE </dt>
Modified: branches/branch-1.4/doc/help/api-ppd.html
===================================================================
--- branches/branch-1.4/doc/help/api-ppd.html 2010-04-23 18:56:34 UTC (rev 9120)
+++ branches/branch-1.4/doc/help/api-ppd.html 2010-04-23 18:57:00 UTC (rev 9121)
@@ -1805,6 +1805,7 @@
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>
@@ -1887,6 +1888,8 @@
<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>
@@ -2154,6 +2157,8 @@
<dd class="description">Bad OrderDependency</dd>
<dt>PPD_BAD_UI_CONSTRAINTS </dt>
<dd class="description">Bad UIConstraints</dd>
+<dt>PPD_BAD_VALUE </dt>
+<dd class="description">Bad value string</dd>
<dt>PPD_FILE_OPEN_ERROR </dt>
<dd class="description">Unable to open PPD file</dd>
<dt>PPD_ILLEGAL_CHARACTER </dt>
@@ -2172,6 +2177,8 @@
<dd class="description">Line longer than 255 chars</dd>
<dt>PPD_MISSING_ASTERISK </dt>
<dd class="description">Missing asterisk in column 0</dd>
+<dt>PPD_MISSING_OPTION_KEYWORD </dt>
+<dd class="description">Missing option keyword</dd>
<dt>PPD_MISSING_PPDADOBE4 </dt>
<dd class="description">Missing PPD-Adobe-4.x header</dd>
<dt>PPD_MISSING_VALUE </dt>
_______________________________________________
cups-commit mailing list
cups-commit@easysw.com
http://lists.easysw.com/mailman/listinfo/cups-commit
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic