diff options
| author | Didier Raboud <odyx@debian.org> | 2013-03-19 11:05:58 +0100 |
|---|---|---|
| committer | Didier Raboud <odyx@debian.org> | 2013-03-19 11:05:58 +0100 |
| commit | ea5667a811b20e235ce1975e763469edd1f7f0de (patch) | |
| tree | a02b8034aba8666f06fdbc971905ca760b1c3aa7 /doc | |
| parent | 6fd17d1b328ea9230585f7ad1e3c478343157220 (diff) | |
| download | cups-ea5667a811b20e235ce1975e763469edd1f7f0de.tar.gz | |
Imported Upstream version 1.6.2upstream/1.6.2
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 5 | ||||
| -rw-r--r-- | doc/ca/index.html.in | 2 | ||||
| -rw-r--r-- | doc/cs/index.html.in | 107 | ||||
| -rw-r--r-- | doc/es/index.html.in | 2 | ||||
| -rw-r--r-- | doc/fr/index.html.in | 107 | ||||
| -rw-r--r-- | doc/help/api-cups.html | 475 | ||||
| -rw-r--r-- | doc/help/api-httpipp.html | 62 | ||||
| -rw-r--r-- | doc/help/man-ipptool.html | 2 | ||||
| -rw-r--r-- | doc/help/man-ipptoolfile.html | 14 | ||||
| -rw-r--r-- | doc/help/network.html | 34 | ||||
| -rw-r--r-- | doc/help/ref-cups-files-conf.html.in | 513 | ||||
| -rw-r--r-- | doc/help/ref-cupsd-conf.html.in | 618 | ||||
| -rw-r--r-- | doc/help/spec-browsing.html | 38 | ||||
| -rw-r--r-- | doc/index.html.in | 2 | ||||
| -rw-r--r-- | doc/ja/index.html.in | 2 | ||||
| -rw-r--r-- | doc/ru/index.html.in | 206 |
16 files changed, 1491 insertions, 698 deletions
diff --git a/doc/Makefile b/doc/Makefile index bcd494cc..e599f759 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,9 +1,9 @@ # -# "$Id: Makefile 10429 2012-04-23 18:04:24Z mike $" +# "$Id: Makefile 10752 2012-12-12 18:03:02Z mike $" # # Documentation makefile for CUPS. # -# Copyright 2007-2011 by Apple Inc. +# Copyright 2007-2012 by Apple Inc. # Copyright 1997-2007 by Easy Software Products. # # These coded instructions, statements, and computer programs are the @@ -105,6 +105,7 @@ HELPFILES = \ help/ref-classes-conf.html \ help/ref-client-conf.html \ help/ref-cupsd-conf.html \ + help/ref-cups-files-conf.html \ help/ref-error_log.html \ help/ref-mailto-conf.html \ help/ref-page_log.html \ diff --git a/doc/ca/index.html.in b/doc/ca/index.html.in index 3cd2c33f..77542d3b 100644 --- a/doc/ca/index.html.in +++ b/doc/ca/index.html.in @@ -100,7 +100,7 @@ HEIGHT="128" ALT="CUPS"></A></TD> </TD></TR> <TR><TD> </TD></TR> <TR><TD CLASS="trailer">CUPS i el seu logotip són marques registrades de -<A HREF="http://www.apple.com">Apple Inc.</A> CUPS té copyright 2007-2012 d'Apple +<A HREF="http://www.apple.com">Apple Inc.</A> CUPS té copyright 2007-2013 d'Apple Inc. Tots els drets reservats.</TD></TR> </TABLE> </BODY> diff --git a/doc/cs/index.html.in b/doc/cs/index.html.in new file mode 100644 index 00000000..38f4a6f4 --- /dev/null +++ b/doc/cs/index.html.in @@ -0,0 +1,107 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> +<HEAD> + <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> + <TITLE>Hlavní strana - CUPS @CUPS_VERSION@@CUPS_REVISION@</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="/cups.css"> + <LINK REL="SHORTCUT ICON" HREF="/images/cups-icon.png" TYPE="image/png"> +</HEAD> +<BODY> +<TABLE CLASS="page" SUMMARY="{title}"> +<TR><TD CLASS="body"> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> +<TR HEIGHT="36"> +<TD><A HREF="http://www.cups.org/" TARGET="_blank"><IMG +SRC="/images/left.gif" WIDTH="64" HEIGHT="36" BORDER="0" ALT=""></A></TD> +<TD CLASS="sel"><A HREF="/"> Hlavní strana </A></TD> +<TD CLASS="unsel"><A HREF="/admin"> Administrace </A></TD> +<TD CLASS="unsel"><A HREF="/classes/"> Třídy tiskáren </A></TD> +<TD CLASS="unsel"><A HREF="/help/"> Nápověda </A></TD> +<TD CLASS="unsel"><A HREF="/jobs/"> Úlohy </A></TD> +<TD CLASS="unsel"><A HREF="/printers/"> Tiskárny </A></TD> +<TD CLASS="unsel" WIDTH="100%"><FORM ACTION="/help/" METHOD="GET"><INPUT +TYPE="SEARCH" NAME="QUERY" SIZE="20" PLACEHOLDER="Hledat" +AUTOSAVE="org.cups.help" RESULTS="20"></FORM></TD> +<TD><IMG SRC="/images/right.gif" WIDTH="4" HEIGHT="36" ALT=""></TD> +</TR> +</TABLE> + +<TABLE CLASS="indent" SUMMARY=""> +<TR><TD STYLE="padding-right: 20px;"> + +<H1>CUPS @CUPS_VERSION@</H1> + +<P>CUPS je na bázi standardů otevřený zdrojový kód tiskového systému vyvinutý +společností <A HREF="http://www.apple.com/">Apple Inc.</A> pro Mac OS<SUP>®</SUP> +X a jiné UNIX<SUP>®</SUP>ové operační systémy.</P> + +</TD> +<TD><A HREF="http://www.cups.org/"><IMG SRC="images/cups-icon.png" WIDTH="128" +HEIGHT="128" ALT="CUPS"></A></TD> +</TR> +</TABLE> + +<TABLE CLASS="indent" SUMMARY=""> +<TR><TD VALIGN="top" STYLE="border-right: dotted thin #cccccc; padding-right: 20px;"> + +<H2>CUPS pro uživatele</H2> + +<P><A HREF="help/overview.html">Popis CUPS</A></P> + +<P><A HREF="help/options.html">Příkazová řádka tisku a Možnosti</A></P> + +<P><A HREF="help/whatsnew.html">Co je nového v CUPS 1.6</A></P> + +<P><A HREF="http://www.cups.org/newsgroups.php?gcups.general">Uživatelské fórum</A></P> + +</TD><TD VALIGN="top" STYLE="border-right: dotted thin #cccccc; padding-left: 20px; padding-right: 20px;"> + +<H2>CUPS pro administrátory</H2> + +<P><A HREF="admin">Přidání tiskáren a tříd</A></P> + +<P><A HREF="help/policies.html">Správa politik</A></P> + +<P><A HREF="help/accounting.html">Základní účtování tiskáren</A></P> + +<P><A HREF="help/security.html">Zabezpečení serveru</A></P> + +<P><A HREF="help/kerberos.html">Použití ověřování pomocí protokolu Kerberos</A></P> + +<P><A HREF="help/network.html">Použití síťových tiskáren</A></P> + +<P><A HREF="help/ref-cupsd-conf.html">Konfigurační soubor cupsd.conf</A></P> + +<P><A HREF="http://www.cups.org/ppd.php">Hedat ovladače tiskárny</A></P> + +</TD><TD VALIGN="top" STYLE="padding-left: 20px;"> + +<H2>CUPS pro vývojáře</H2> + +<P><A HREF="help/api-overview.html">Úvod do CUPS programování</A></P> + +<P><A HREF="help/api-cups.html">CUPS API knihovny</A></P> + +<P><A HREF="help/api-filter.html">Programování filtrů a backendů</A></P> + +<P><A HREF="help/api-httpipp.html">HTTP a IPP API knihovny</A></P> + +<P><A HREF="help/api-ppd.html">PPD API knihovny</A></P> + +<P><A HREF="help/api-raster.html">Raster API knihovny</A></P> + +<P><A HREF="help/ref-ppdcfile.html">PPD kompilátor Driver Information File Reference</A></P> + +<P><A HREF="http://www.cups.org/newsgroups.php?gcups.development">Vývojářské fórum</A></P> + +</TD></TR> +</TABLE> + +</TD></TR> +<TR><TD> </TD></TR> +<TR><TD CLASS="trailer">CUPS a logo CUPS jsou ochranné známky společnosti +<A HREF="http://www.apple.com">Apple Inc.</A> CUPS je chráněn autorskými +právy 2007-2013 Apple Inc. Všechna práva vyhrazena.</TD></TR> +</TABLE> +</BODY> +</HTML> diff --git a/doc/es/index.html.in b/doc/es/index.html.in index 4c57ed5a..d4ef7975 100644 --- a/doc/es/index.html.in +++ b/doc/es/index.html.in @@ -101,7 +101,7 @@ HEIGHT="128" ALT="CUPS"></A></TD> <TR><TD> </TD></TR> <TR><TD CLASS="trailer">CUPS y el logo de CUPS son marcas registradas de <A HREF="http://www.apple.com">Apple Inc.</A> Los derechos -de copia de CUPS 2007-2012 son de Apple Inc. Todos los derechos reservados.</TD></TR> +de copia de CUPS 2007-2013 son de Apple Inc. Todos los derechos reservados.</TD></TR> </TABLE> </BODY> </HTML> diff --git a/doc/fr/index.html.in b/doc/fr/index.html.in new file mode 100644 index 00000000..3345a489 --- /dev/null +++ b/doc/fr/index.html.in @@ -0,0 +1,107 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> +<HEAD> + <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> + <TITLE>Accueil - CUPS @CUPS_VERSION@@CUPS_REVISION@</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="/cups.css"> + <LINK REL="SHORTCUT ICON" HREF="/images/cups-icon.png" TYPE="image/png"> +</HEAD> +<BODY> +<TABLE CLASS="page" SUMMARY="{title}"> +<TR><TD CLASS="body"> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> +<TR HEIGHT="36"> +<TD><A HREF="http://www.cups.org/" TARGET="_blank"><IMG +SRC="/images/left.gif" WIDTH="64" HEIGHT="36" BORDER="0" ALT=""></A></TD> +<TD CLASS="sel"><A HREF="/"> Accueil </A></TD> +<TD CLASS="unsel"><A HREF="/admin"> Administration </A></TD> +<TD CLASS="unsel"><A HREF="/classes/"> Classes </A></TD> +<TD CLASS="unsel"><A HREF="/help/"> Aide En Ligne </A></TD> +<TD CLASS="unsel"><A HREF="/jobs/"> Tâches </A></TD> +<TD CLASS="unsel"><A HREF="/printers/"> Imprimantes </A></TD> +<TD CLASS="unsel" WIDTH="100%"><FORM ACTION="/help/" METHOD="GET"><INPUT +TYPE="SEARCH" NAME="QUERY" SIZE="20" PLACEHOLDER="Search Help" +AUTOSAVE="org.cups.help" RESULTS="20"></FORM></TD> +<TD><IMG SRC="/images/right.gif" WIDTH="4" HEIGHT="36" ALT=""></TD> +</TR> +</TABLE> + +<TABLE CLASS="indent" SUMMARY=""> +<TR><TD STYLE="padding-right: 20px;"> + +<H1>CUPS @CUPS_VERSION@</H1> + +<P>CUPS est le système d'impression Open Source, basé sur des standards, développé par +<A HREF="http://www.apple.com/">Apple Inc.</A> pour Mac OS<SUP>®</SUP> X et +les autres OS UNIX<SUP>®</SUP>-like.</P> + +</TD> +<TD><A HREF="http://www.cups.org/"><IMG SRC="images/cups-icon.png" WIDTH="128" +HEIGHT="128" ALT="CUPS"></A></TD> +</TR> +</TABLE> + +<TABLE CLASS="indent" SUMMARY=""> +<TR><TD VALIGN="top" STYLE="border-right: dotted thin #cccccc; padding-right: 20px;"> + +<H2>CUPS pour les utilisateurs</H2> + +<P><A HREF="help/overview.html">Présentation de CUPS</A></P> + +<P><A HREF="help/options.html">Impression en ligne de commande et options</A></P> + +<P><A HREF="help/whatsnew.html">Quoi de neuf dans CUPS 1.6</A></P> + +<P><A HREF="http://www.cups.org/newsgroups.php?gcups.general">Forum utilisateur</A></P> + +</TD><TD VALIGN="top" STYLE="border-right: dotted thin #cccccc; padding-left: 20px; padding-right: 20px;"> + +<H2>CUPS pour les administrateurs</H2> + +<P><A HREF="admin">Ajout d'imprimantes et de classes</A></P> + +<P><A HREF="help/policies.html">Gérer les politiques</A></P> + +<P><A HREF="help/accounting.html">Printer Accounting Basics</A></P> + +<P><A HREF="help/security.html">Sécurité du serveur</A></P> + +<P><A HREF="help/kerberos.html">Utiliser l'authentification Kerberos</A></P> + +<P><A HREF="help/network.html">Utiliser des imprimantes réseaux</A></P> + +<P><A HREF="help/ref-cupsd-conf.html">Références sur cupsd.conf</A></P> + +<P><A HREF="http://www.cups.org/ppd.php">Trouver des pilotes d'imprimantes</A></P> + +</TD><TD VALIGN="top" STYLE="padding-left: 20px;"> + +<H2>CUPS pour les développeurs</H2> + +<P><A HREF="help/api-overview.html">Introduction à la programmation CUPS</A></P> + +<P><A HREF="help/api-cups.html">L'API CUPS</A></P> + +<P><A HREF="help/api-filter.html">Programmation de filtres et de backends</A></P> + +<P><A HREF="help/api-httpipp.html">Les API HTTP et IPP</A></P> + +<P><A HREF="help/api-ppd.html">L'API PPD</A></P> + +<P><A HREF="help/api-raster.html">L'API Raster</A></P> + +<P><A HREF="help/ref-ppdcfile.html">PPD Compiler Driver Information File Reference</A></P> + +<P><A HREF="http://www.cups.org/newsgroups.php?gcups.development">Forum développeurs</A></P> + +</TD></TR> +</TABLE> + +</TD></TR> +<TR><TD> </TD></TR> +<TR><TD CLASS="trailer">CUPS et le logo CUPS sont des marques déposées de +<A HREF="http://www.apple.com">Apple Inc.</A> CUPS est sous copyright 2007-2013 Apple +Inc. Tous droits réservés.</TD></TR> +</TABLE> +</BODY> +</HTML> diff --git a/doc/help/api-cups.html b/doc/help/api-cups.html index 2d6c7882..22e4f30f 100644 --- a/doc/help/api-cups.html +++ b/doc/help/api-cups.html @@ -341,7 +341,7 @@ div.contents ul.subcontents li { <body> <div class='body'> <!-- - "$Id: api-cups.html 10507 2012-05-23 22:39:50Z mike $" + "$Id: api-cups.html 10584 2012-08-29 19:52:16Z mike $" CUPS API header for CUPS. @@ -391,23 +391,34 @@ div.contents ul.subcontents li { <li><a href="#PASSWORDS_AND_AUTHENTICATION">Passwords and Authentication</a></li> </ul></li> <li><a href="#FUNCTIONS">Functions</a><ul class="code"> - <li><a href="#appleGetPaperSize" title="Get the default paper size.">appleGetPaperSize</a></li> <li><a href="#cupsAddDest" title="Add a destination to the list of destinations.">cupsAddDest</a></li> <li><a href="#cupsAddOption" title="Add an option to an option array.">cupsAddOption</a></li> <li><a href="#cupsAdminCreateWindowsPPD" title="Create the Windows PPD file for a printer.">cupsAdminCreateWindowsPPD</a></li> <li><a href="#cupsAdminExportSamba" title="Export a printer to Samba.">cupsAdminExportSamba</a></li> <li><a href="#cupsAdminGetServerSettings" title="Get settings from the server.">cupsAdminGetServerSettings</a></li> <li><a href="#cupsAdminSetServerSettings" title="Set settings on the server.">cupsAdminSetServerSettings</a></li> + <li><a href="#cupsCancelDestJob" title="Include necessary headers...">cupsCancelDestJob</a></li> <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="#cupsCheckDestSupported" title="Check that the option and value are supported +by the destination.">cupsCheckDestSupported</a></li> + <li><a href="#cupsCloseDestJob" title="Close a job and start printing.">cupsCloseDestJob</a></li> <li><a href="#cupsConnectDest" title="Connect to the server for a destination.">cupsConnectDest</a></li> <li><a href="#cupsConnectDestBlock" title="Connect to the server for a destination.">cupsConnectDestBlock</a></li> <li><a href="#cupsCopyDest" title="Callback block">cupsCopyDest</a></li> + <li><a href="#cupsCopyDestConflicts" title="Get conflicts and resolutions for a new +option/value pair.">cupsCopyDestConflicts</a></li> + <li><a href="#cupsCopyDestInfo" title="Get the supported values/capabilities for the +destination.">cupsCopyDestInfo</a></li> + <li><a href="#cupsCreateDestJob" title="Create a job on a destination.">cupsCreateDestJob</a></li> <li><a href="#cupsCreateJob" title="Create an empty job for streaming.">cupsCreateJob</a></li> <li><a href="#cupsEncryption" title="Get the current encryption settings.">cupsEncryption</a></li> <li><a href="#cupsEnumDests" title="Enumerate available destinations with a callback function.">cupsEnumDests</a></li> <li><a href="#cupsEnumDestsBlock" title="Enumerate available destinations with a block.">cupsEnumDestsBlock</a></li> + <li><a href="#cupsFinishDestDocument" title="Finish the current document.">cupsFinishDestDocument</a></li> <li><a href="#cupsFinishDocument" title="Finish sending a document.">cupsFinishDocument</a></li> + <li><a href="#cupsFreeDestInfo" title="Free destination information obtained using +cupsCopyDestInfo.">cupsFreeDestInfo</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> <li><a href="#cupsFreeOptions" title="Free all memory used by options.">cupsFreeOptions</a></li> @@ -415,6 +426,8 @@ div.contents ul.subcontents li { <li><a href="#cupsGetDefault" title="Get the default printer or class for the default server.">cupsGetDefault</a></li> <li><a href="#cupsGetDefault2" title="Get the default printer or class for the specified server.">cupsGetDefault2</a></li> <li><a href="#cupsGetDest" title="Get the named destination from the list.">cupsGetDest</a></li> + <li><a href="#cupsGetDestMediaByName" title="Get media names, dimensions, and margins.">cupsGetDestMediaByName</a></li> + <li><a href="#cupsGetDestMediaBySize" title="Get media names, dimensions, and margins.">cupsGetDestMediaBySize</a></li> <li><a href="#cupsGetDests" title="Get the list of destinations from the default server.">cupsGetDests</a></li> <li><a href="#cupsGetDests2" title="Get the list of destinations from the specified server.">cupsGetDests2</a></li> <li><a href="#cupsGetJobs" title="Get the jobs from the default server.">cupsGetJobs</a></li> @@ -436,6 +449,10 @@ 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="#cupsLocalizeDestOption" title="Get the localized string for a destination +option.">cupsLocalizeDestOption</a></li> + <li><a href="#cupsLocalizeDestValue" title="Get the localized string for a destination +option+value pair.">cupsLocalizeDestValue</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> @@ -461,6 +478,7 @@ connections.">cupsSetCredentials</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="#cupsStartDestDocument" title="Start a new document.">cupsStartDestDocument</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> <li><a href="#cupsTempFile" title="Generates a temporary filename.">cupsTempFile</a></li> @@ -506,7 +524,7 @@ constants">cups_ptype_e</a></li> </ul></li> </ul> <!-- - "$Id: api-cups.html 10507 2012-05-23 22:39:50Z mike $" + "$Id: api-cups.html 10584 2012-08-29 19:52:16Z mike $" API introduction for CUPS. @@ -949,22 +967,6 @@ fields for the username and password. The username should default to the string returned by the <a href="#cupsUser"><code>cupsUser</code></a> function.</p> <h2 class="title"><a name="FUNCTIONS">Functions</a></h2> -<h3 class="function"><a name="appleGetPaperSize">appleGetPaperSize</a></h3> -<p class="description">Get the default paper size.</p> -<p class="code"> -char *appleGetPaperSize (<br> - char *name,<br> - int namesize<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Paper size name buffer</dd> -<dt>namesize</dt> -<dd class="description">Size of buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Default paper size</p> <h3 class="function"><a name="cupsAddDest">cupsAddDest</a></h3> <p class="description">Add a destination to the list of destinations.</p> <p class="code"> @@ -1116,6 +1118,31 @@ int cupsAdminSetServerSettings (<br> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">1 on success, 0 on failure</p> +<h3 class="function"><a name="cupsCancelDestJob">cupsCancelDestJob</a></h3> +<p class="description">Include necessary headers...</p> +<p class="code"> +ipp_status_t cupsCancelDestJob (<br> + http_t *http,<br> + <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> + int job_id<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to destination</dd> +<dt>dest</dt> +<dd class="description">Destination</dd> +<dt>job_id</dt> +<dd class="description">Job ID</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">Cancel a job on a destination.</p> +<p class="discussion">The "job_id" is the number returned by cupsCreateDestJob.<br> +<br> +Returns IPP_OK on success and IPP_NOT_AUTHORIZED or IPP_FORBIDDEN on +failure. + +</p> <h3 class="function"><a name="cupsCancelJob">cupsCancelJob</a></h3> <p class="description">Cancel a print job on the default server.</p> <p class="code"> @@ -1171,6 +1198,64 @@ Use the <a href="#cupsLastError"><code>cupsLastError</code></a> and <a href="#cu the cause of any failure. </p> +<h3 class="function"><span class="info"> CUPS 1.6/OS X 10.8 </span><a name="cupsCheckDestSupported">cupsCheckDestSupported</a></h3> +<p class="description">Check that the option and value are supported +by the destination.</p> +<p class="code"> +int cupsCheckDestSupported (<br> + http_t *http,<br> + <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> + <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> + const char *option,<br> + const char *value<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to destination</dd> +<dt>dest</dt> +<dd class="description">Destination</dd> +<dt>dinfo</dt> +<dd class="description">Destination information</dd> +<dt>option</dt> +<dd class="description">Option</dd> +<dt>value</dt> +<dd class="description">Value</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">1 if supported, 0 otherwise</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">Returns 1 if supported, 0 otherwise. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/OS X 10.8 </span><a name="cupsCloseDestJob">cupsCloseDestJob</a></h3> +<p class="description">Close a job and start printing.</p> +<p class="code"> +ipp_status_t cupsCloseDestJob (<br> + http_t *http,<br> + <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> + <a href="#cups_dinfo_t">cups_dinfo_t</a> *info,<br> + int job_id<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to destination</dd> +<dt>dest</dt> +<dd class="description">Destination</dd> +<dt>info</dt> +<dd class="description">Destination information</dd> +<dt>job_id</dt> +<dd class="description">Job ID</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">IPP status code</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">Use when the last call to cupsStartDocument passed 0 for "last_document". +"job_id" is the job ID returned by cupsCreateDestJob. Returns <code>IPP_OK</code> +on success. + +</p> <h3 class="function"><span class="info"> CUPS 1.6/OS X 10.8 </span><a name="cupsConnectDest">cupsConnectDest</a></h3> <p class="description">Connect to the server for a destination.</p> <p class="code"> @@ -1273,6 +1358,125 @@ copy) - for use with the cupsEnumDests* functions. The caller is responsible for calling cupsFreeDests() on the returned object(s). </p> +<h3 class="function"><span class="info"> CUPS 1.6/OS X 10.8 </span><a name="cupsCopyDestConflicts">cupsCopyDestConflicts</a></h3> +<p class="description">Get conflicts and resolutions for a new +option/value pair.</p> +<p class="code"> +int cupsCopyDestConflicts (<br> + http_t *http,<br> + <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> + <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> + int num_options,<br> + <a href="#cups_option_t">cups_option_t</a> *options,<br> + const char *new_option,<br> + const char *new_value,<br> + int *num_conflicts,<br> + <a href="#cups_option_t">cups_option_t</a> **conflicts,<br> + int *num_resolved,<br> + <a href="#cups_option_t">cups_option_t</a> **resolved<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to destination</dd> +<dt>dest</dt> +<dd class="description">Destination</dd> +<dt>dinfo</dt> +<dd class="description">Destination information</dd> +<dt>num_options</dt> +<dd class="description">Number of current options</dd> +<dt>options</dt> +<dd class="description">Current options</dd> +<dt>new_option</dt> +<dd class="description">New option</dd> +<dt>new_value</dt> +<dd class="description">New value</dd> +<dt>num_conflicts</dt> +<dd class="description">Number of conflicting options</dd> +<dt>conflicts</dt> +<dd class="description">Conflicting options</dd> +<dt>num_resolved</dt> +<dd class="description">Number of options to resolve</dd> +<dt>resolved</dt> +<dd class="description">Resolved options</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">1 if there is a conflict, 0 if none, -1 on error</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">"num_options" and "options" represent the currently selected options by the +user. "new_option" and "new_value" are the setting the user has just +changed.<br> +<br> +Returns 1 if there is a conflict, 0 if there are no conflicts, and -1 if +there was an unrecoverable error such as a resolver loop.<br> +<br> +If "num_conflicts" and "conflicts" are not <code>NULL</code>, they are set to +contain the list of conflicting option/value pairs. Similarly, if +"num_resolved" and "resolved" are not <code>NULL</code> they will be set to the +list of changes needed to resolve the conflict.<br> +<br> +If cupsCopyDestConflicts returns 1 but "num_resolved" and "resolved" are set +to 0 and <code>NULL</code>, respectively, then the conflict cannot be resolved. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/OS X 10.8 </span><a name="cupsCopyDestInfo">cupsCopyDestInfo</a></h3> +<p class="description">Get the supported values/capabilities for the +destination.</p> +<p class="code"> +<a href="#cups_dinfo_t">cups_dinfo_t</a> *cupsCopyDestInfo (<br> + http_t *http,<br> + <a href="#cups_dest_t">cups_dest_t</a> *dest<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to destination</dd> +<dt>dest</dt> +<dd class="description">Destination</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">Destination information</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">The caller is responsible for calling <a href="#cupsFreeDestInfo"><code>cupsFreeDestInfo</code></a> on the return +value. <code>NULL</code> is returned on error. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/OS X 10.8 </span><a name="cupsCreateDestJob">cupsCreateDestJob</a></h3> +<p class="description">Create a job on a destination.</p> +<p class="code"> +ipp_status_t cupsCreateDestJob (<br> + http_t *http,<br> + <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> + <a href="#cups_dinfo_t">cups_dinfo_t</a> *info,<br> + int *job_id,<br> + const char *title,<br> + int num_options,<br> + <a href="#cups_option_t">cups_option_t</a> *options<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to destination</dd> +<dt>dest</dt> +<dd class="description">Destination</dd> +<dt>info</dt> +<dd class="description">Destination information</dd> +<dt>job_id</dt> +<dd class="description">Job ID or 0 on error</dd> +<dt>title</dt> +<dd class="description">Job name</dd> +<dt>num_options</dt> +<dd class="description">Number of job options</dd> +<dt>options</dt> +<dd class="description">Job options</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">IPP status code</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">Returns <code>IPP_OK</code> or <code>IPP_OK_SUBST</code> on success, saving the job ID +in the variable pointed to by "job_id". + +</p> <h3 class="function"><span class="info"> CUPS 1.4/OS X 10.6 </span><a name="cupsCreateJob">cupsCreateJob</a></h3> <p class="description">Create an empty job for streaming.</p> <p class="code"> @@ -1402,6 +1606,29 @@ Enumeration happens on the current thread and does not return until all destinations have been enumerated or the block returns 0. </p> +<h3 class="function"><span class="info"> CUPS 1.6/OS X 10.8 </span><a name="cupsFinishDestDocument">cupsFinishDestDocument</a></h3> +<p class="description">Finish the current document.</p> +<p class="code"> +ipp_status_t cupsFinishDestDocument (<br> + http_t *http,<br> + <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> + <a href="#cups_dinfo_t">cups_dinfo_t</a> *info<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to destination</dd> +<dt>dest</dt> +<dd class="description">Destination</dd> +<dt>info</dt> +<dd class="description">Destination information</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">Status of document submission</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">Returns <code>IPP_OK</code> or <code>IPP_OK_SUBST</code> on success. + +</p> <h3 class="function"><span class="info"> CUPS 1.4/OS X 10.6 </span><a name="cupsFinishDocument">cupsFinishDocument</a></h3> <p class="description">Finish sending a document.</p> <p class="code"> @@ -1422,6 +1649,18 @@ ipp_status_t cupsFinishDocument (<br> <p class="discussion">The document must have been started using <a href="#cupsStartDocument"><code>cupsStartDocument</code></a>. </p> +<h3 class="function"><a name="cupsFreeDestInfo">cupsFreeDestInfo</a></h3> +<p class="description">Free destination information obtained using +<a href="#cupsCopyDestInfo"><code>cupsCopyDestInfo</code></a>.</p> +<p class="code"> +void cupsFreeDestInfo (<br> + <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>dinfo</dt> +<dd class="description">Destination information</dd> +</dl> <h3 class="function"><a name="cupsFreeDests">cupsFreeDests</a></h3> <p class="description">Free the memory used by the list of destinations.</p> <p class="code"> @@ -1541,6 +1780,99 @@ not support the lpoptions-defined default printer. <h4 class="discussion">Discussion</h4> <p class="discussion">Use the <a href="#cupsGetDests"><code>cupsGetDests</code></a> or <a href="#cupsGetDests2"><code>cupsGetDests2</code></a> functions to get a list of supported destinations for the current user.</p> +<h3 class="function"><span class="info"> CUPS 1.6/OS X 10.8 </span><a name="cupsGetDestMediaByName">cupsGetDestMediaByName</a></h3> +<p class="description">Get media names, dimensions, and margins.</p> +<p class="code"> +int cupsGetDestMediaByName (<br> + http_t *http,<br> + <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> + <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> + const char *media,<br> + unsigned flags,<br> + <a href="#cups_size_t">cups_size_t</a> *size<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to destination</dd> +<dt>dest</dt> +<dd class="description">Destination</dd> +<dt>dinfo</dt> +<dd class="description">Destination information</dd> +<dt>media</dt> +<dd class="description">Media name</dd> +<dt>flags</dt> +<dd class="description">Media matching flags</dd> +<dt>size</dt> +<dd class="description">Media size information</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">1 on match, 0 on failure</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">The "media" string is a PWG media name. "Flags" provides some matching +guidance (multiple flags can be combined):<br> +<br> +CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, +CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, +CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, +CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and +CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the +size amongst the "ready" media.<br> +<br> +The matching result (if any) is returned in the "cups_size_t" structure.<br> +<br> +Returns 1 when there is a match and 0 if there is not a match. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/OS X 10.8 </span><a name="cupsGetDestMediaBySize">cupsGetDestMediaBySize</a></h3> +<p class="description">Get media names, dimensions, and margins.</p> +<p class="code"> +int cupsGetDestMediaBySize (<br> + http_t *http,<br> + <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> + <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> + int width,<br> + int length,<br> + unsigned flags,<br> + <a href="#cups_size_t">cups_size_t</a> *size<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to destination</dd> +<dt>dest</dt> +<dd class="description">Destination</dd> +<dt>dinfo</dt> +<dd class="description">Destination information</dd> +<dt>width</dt> +<dd class="description">Media width in hundredths of +of millimeters</dd> +<dt>length</dt> +<dd class="description">Media length in hundredths of +of millimeters</dd> +<dt>flags</dt> +<dd class="description">Media matching flags</dd> +<dt>size</dt> +<dd class="description">Media size information</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">1 on match, 0 on failure</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">"Width" and "length" are the dimensions in hundredths of millimeters. +"Flags" provides some matching guidance (multiple flags can be combined):<br> +<br> +CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, +CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, +CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, +CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and +CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the +size amongst the "ready" media.<br> +<br> +The matching result (if any) is returned in the "cups_size_t" structure.<br> +<br> +Returns 1 when there is a match and 0 if there is not a match. + +</p> <h3 class="function"><a name="cupsGetDests">cupsGetDests</a></h3> <p class="description">Get the list of destinations from the default server.</p> <p class="code"> @@ -1945,6 +2277,65 @@ cups_lang_t *cupsLangGet (<br> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Language data</p> +<h3 class="function"><span class="info"> CUPS 1.6/OS X 10.8 </span><a name="cupsLocalizeDestOption">cupsLocalizeDestOption</a></h3> +<p class="description">Get the localized string for a destination +option.</p> +<p class="code"> +const char *cupsLocalizeDestOption (<br> + http_t *http,<br> + <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> + <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> + const char *option<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to destination</dd> +<dt>dest</dt> +<dd class="description">Destination</dd> +<dt>dinfo</dt> +<dd class="description">Destination information</dd> +<dt>option</dt> +<dd class="description">Option to localize</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">Localized string</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">The returned string is stored in the destination information and will become +invalid if the destination information is deleted. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/OS X 10.8 </span><a name="cupsLocalizeDestValue">cupsLocalizeDestValue</a></h3> +<p class="description">Get the localized string for a destination +option+value pair.</p> +<p class="code"> +const char *cupsLocalizeDestValue (<br> + http_t *http,<br> + <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> + <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> + const char *option,<br> + const char *value<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to destination</dd> +<dt>dest</dt> +<dd class="description">Destination</dd> +<dt>dinfo</dt> +<dd class="description">Destination information</dd> +<dt>option</dt> +<dd class="description">Option to localize</dd> +<dt>value</dt> +<dd class="description">Value to localize</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">Localized string</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">The returned string is stored in the destination information and will become +invalid if the destination information is deleted. + +</p> <h3 class="function"><span class="info"> CUPS 1.2/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"> @@ -2420,6 +2811,52 @@ void cupsSetUser (<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.6/OS X 10.8 </span><a name="cupsStartDestDocument">cupsStartDestDocument</a></h3> +<p class="description">Start a new document.</p> +<p class="code"> +http_status_t cupsStartDestDocument (<br> + http_t *http,<br> + <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> + <a href="#cups_dinfo_t">cups_dinfo_t</a> *info,<br> + int job_id,<br> + const char *docname,<br> + const char *format,<br> + int num_options,<br> + <a href="#cups_option_t">cups_option_t</a> *options,<br> + int last_document<br> +);</p> +<h4 class="parameters">Parameters</h4> +<dl> +<dt>http</dt> +<dd class="description">Connection to destination</dd> +<dt>dest</dt> +<dd class="description">Destination</dd> +<dt>info</dt> +<dd class="description">Destination information</dd> +<dt>job_id</dt> +<dd class="description">Job ID</dd> +<dt>docname</dt> +<dd class="description">Document name</dd> +<dt>format</dt> +<dd class="description">Document format</dd> +<dt>num_options</dt> +<dd class="description">Number of document options</dd> +<dt>options</dt> +<dd class="description">Document options</dd> +<dt>last_document</dt> +<dd class="description">1 if this is the last document</dd> +</dl> +<h4 class="returnvalue">Return Value</h4> +<p class="description">Status of document creation</p> +<h4 class="discussion">Discussion</h4> +<p class="discussion">"job_id" is the job ID returned by cupsCreateDestJob. "docname" is the name +of the document/file being printed, "format" is the MIME media type for the +document (see CUPS_FORMAT_xxx constants), and "num_options" and "options" +are the options do be applied to the document. "last_document" should be 1 +if this is the last document to be submitted in the job. Returns +<code>HTTP_CONTINUE</code> on success. + +</p> <h3 class="function"><span class="info"> CUPS 1.4/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"> diff --git a/doc/help/api-httpipp.html b/doc/help/api-httpipp.html index a49f6d94..d1ea823f 100644 --- a/doc/help/api-httpipp.html +++ b/doc/help/api-httpipp.html @@ -341,7 +341,7 @@ div.contents ul.subcontents li { <body> <div class='body'> <!-- - "$Id: api-httpipp.html 10424 2012-04-23 17:26:57Z mike $" + "$Id: api-httpipp.html 10589 2012-08-30 23:01:44Z mike $" HTTP and IPP API header for CUPS. @@ -395,8 +395,10 @@ 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="#cupsLastError" title="Return the last IPP status code received on the current +thread.">cupsLastError</a></li> + <li><a href="#cupsLastErrorString" title="Return the last IPP status-message received on the +current thread.">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> @@ -646,7 +648,7 @@ are server-oriented...">http_state_e</a></li> </ul></li> </ul> <!-- - "$Id: api-httpipp.html 10424 2012-04-23 17:26:57Z mike $" + "$Id: api-httpipp.html 10589 2012-08-30 23:01:44Z mike $" HTTP and IPP API introduction for CUPS. @@ -1010,9 +1012,9 @@ status, prior to resubmitting your request. <h4 class="returnvalue">Return Value</h4> <p class="description">Response data</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function sends the IPP request to the specified server, retrying -and authenticating as necessary. The request is freed with <a href="#ippDelete"><code>ippDelete</code></a> -after receiving a valid IPP response.</p> +<p class="discussion">This function sends the IPP request and attached file to the specified +server, retrying and authenticating as necessary. The request is freed with +<a href="#ippDelete"><code>ippDelete</code></a>.</p> <h3 class="function"><span class="info"> CUPS 1.3/OS X 10.5 </span><a name="cupsDoIORequest">cupsDoIORequest</a></h3> <p class="description">Do an IPP request with file descriptors.</p> <p class="code"> @@ -1039,14 +1041,14 @@ after receiving a valid IPP response.</p> <h4 class="returnvalue">Return Value</h4> <p class="description">Response data</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function sends the IPP request to the specified server, retrying -and authenticating as necessary. The request is freed with ippDelete() -after receiving a valid IPP response.<br> +<p class="discussion">This function sends the IPP request with the optional input file "infile" to +the specified server, retrying and authenticating as necessary. The request +is freed with <a href="#ippDelete"><code>ippDelete</code></a>.<br> <br> -If "infile" is a valid file descriptor, cupsDoIORequest() copies +If "infile" is a valid file descriptor, <code>cupsDoIORequest</code> copies all of the data from the file after the IPP request message.<br> <br> -If "outfile" is a valid file descriptor, cupsDoIORequest() copies +If "outfile" is a valid file descriptor, <code>cupsDoIORequest</code> copies all of the data after the IPP response message to the file. </p> @@ -1071,8 +1073,7 @@ all of the data after the IPP response message to the file. <p class="description">Response data</p> <h4 class="discussion">Discussion</h4> <p class="discussion">This function sends the IPP request to the specified server, retrying -and authenticating as necessary. The request is freed with ippDelete() -after receiving a valid IPP response.</p> +and authenticating as necessary. The request is freed with <a href="#ippDelete"><code>ippDelete</code></a>.</p> <h3 class="function"><a name="cupsEncodeOptions">cupsEncodeOptions</a></h3> <p class="description">Encode printer options into IPP attributes.</p> <p class="code"> @@ -1220,19 +1221,21 @@ the request respectively. <p class="description">Response or <code>NULL</code> on HTTP error</p> <h4 class="discussion">Discussion</h4> <p class="discussion">Use this function to get the response for an IPP request sent using -cupsSendDocument() or cupsSendRequest(). For requests that return -additional data, use httpRead() after getting a successful response, -otherwise call httpFlush() to complete the response processing. +<a href="#cupsSendRequest"><code>cupsSendRequest</code></a>. For requests that return additional data, use +<a href="#cupsReadResponseData"><code>cupsReadResponseData</code></a> after getting a successful response, +otherwise call <a href="#httpFlush"><code>httpFlush</code></a> to complete the response processing. </p> <h3 class="function"><a name="cupsLastError">cupsLastError</a></h3> -<p class="description">Return the last IPP status code.</p> +<p class="description">Return the last IPP status code received on the current +thread.</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/OS X 10.5 </span><a name="cupsLastErrorString">cupsLastErrorString</a></h3> -<p class="description">Return the last IPP status-message.</p> +<p class="description">Return the last IPP status-message received on the +current thread.</p> <p class="code"> const char *cupsLastErrorString (void);</p> <h4 class="returnvalue">Return Value</h4> @@ -1305,8 +1308,9 @@ ssize_t cupsReadResponseData (<br> <h4 class="returnvalue">Return Value</h4> <p class="description">Bytes read, 0 on EOF, -1 on error</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function is used after cupsGetResponse() to read the PPD or document -files for CUPS_GET_PPD and CUPS_GET_DOCUMENT requests, respectively. +<p class="discussion">This function is used after <a href="#cupsGetResponse"><code>cupsGetResponse</code></a> to read the PPD or document +files from <code>CUPS_GET_PPD</code> and <code>CUPS_GET_DOCUMENT</code> requests, +respectively. </p> <h3 class="function"><span class="info"> CUPS 1.4/OS X 10.6 </span><a name="cupsSendRequest">cupsSendRequest</a></h3> @@ -1332,13 +1336,17 @@ files for CUPS_GET_PPD and CUPS_GET_DOCUMENT requests, respectively. <h4 class="returnvalue">Return Value</h4> <p class="description">Initial HTTP status</p> <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 -sent/queued at a time.<br> +<p class="discussion">Use <a href="#cupsWriteRequestData"><code>cupsWriteRequestData</code></a> to write any additional data (document, PPD +file, etc.) for the request, <a href="#cupsGetResponse"><code>cupsGetResponse</code></a> to get the IPP response, +and <a href="#cupsReadResponseData"><code>cupsReadResponseData</code></a> to read any additional data following the +response. Only one request can be sent/queued at a time per <code>http_t</code> +connection.<br> +<br> +Returns the initial HTTP status code, which will be <code>HTTP_CONTINUE</code> +on a successful send of the request.<br> <br> -Unlike cupsDoFileRequest(), cupsDoIORequest(), and cupsDoRequest(), the -request is not freed. +Note: Unlike <a href="#cupsDoFileRequest"><code>cupsDoFileRequest</code></a>, <a href="#cupsDoIORequest"><code>cupsDoIORequest</code></a>, and +<a href="#cupsDoRequest"><code>cupsDoRequest</code></a>, the request is NOT freed with <a href="#ippDelete"><code>ippDelete</code></a>. </p> <h3 class="function"><span class="info"> CUPS 1.4/OS X 10.6 </span><a name="cupsWriteRequestData">cupsWriteRequestData</a></h3> diff --git a/doc/help/man-ipptool.html b/doc/help/man-ipptool.html index 1b523c53..189613a9 100644 --- a/doc/help/man-ipptool.html +++ b/doc/help/man-ipptool.html @@ -151,7 +151,7 @@ The following standard files are available: <br> <a href='http://localhost:631/help'>http://localhost:631/help</a> <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright 2007-2012 by Apple Inc. +Copyright 2007-2013 by Apple Inc. </body> </html> diff --git a/doc/help/man-ipptoolfile.html b/doc/help/man-ipptoolfile.html index 645fd4a1..8c753896 100644 --- a/doc/help/man-ipptoolfile.html +++ b/doc/help/man-ipptoolfile.html @@ -11,7 +11,7 @@ ipptoolfile - ipptool file format <h2 class="title"><a name="DESCRIPTION">Description</a></h2> -The <a href='man-ipptool.html?TOPIC=Man+Pages'>ipptool(1)</a> program accepts free-form plain text files that describe one or more IPP requests. Comments start with the "#" character and continue to the end of the line. Each request is enclosed by curley braces, for example: +The <a href='man-ipptool.html?TOPIC=Man+Pages'>ipptool(1)</a> program accepts free-form plain text files that describe one or more IPP requests. Comments start with the "#" character and continue to the end of the line. Each request is enclosed by curly braces, for example: <pre> # This is a comment @@ -402,6 +402,14 @@ parallel attribute. <h2 class="title"><a name="STATUS_PREDICATES">Status Predicates</a></h2> The following predicates are understood following the STATUS test directive: <dl> +<dt>DEFINE-MATCH variable-name +</dt> +<dd>Defines the variable to "1" when the STATUS matches. A side-effect of this predicate is that this STATUS will never fail a test. +</dd> +<dt>DEFINE-NO-MATCH variable-name +</dt> +<dd>Defines the variable to "1" when the STATUS does not match. A side-effect of this predicate is that this STATUS will never fail a test. +</dd> <dt>IF-DEFINED variable-name </dt> <dd>Makes the STATUS apply only if the specified variable is defined. @@ -631,7 +639,7 @@ no job-uri has been seen. </dd> <dt>$notify-subscription-id </dt> -<dd>Inserts the last notify-subscription-id value returnd in a test response or 0 if +<dd>Inserts the last notify-subscription-id value returned in a test response or 0 if no notify-subscription-id has been seen. </dd> <dt>$port @@ -662,7 +670,7 @@ no notify-subscription-id has been seen. <a href='http://localhost:631/help'>http://localhost:631/help</a> <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> -Copyright 2007-2012 by Apple Inc. +Copyright 2007-2013 by Apple Inc. </body> </html> diff --git a/doc/help/network.html b/doc/help/network.html index 6743651f..ebe1b5f9 100644 --- a/doc/help/network.html +++ b/doc/help/network.html @@ -93,16 +93,22 @@ page on the device.</P> <PRE> socket://<i>ip-address-or-hostname</i> -socket://<i>ip-address-or-hostname</i>/?waiteof=false +socket://<i>ip-address-or-hostname</i>/?option=value +socket://<i>ip-address-or-hostname</i>/?option=value&option=value socket://<i>ip-address-or-hostname</i>:<i>port-number</i> -socket://<i>ip-address-or-hostname</i>:<i>port-number</i>/?waiteof=false +socket://<i>ip-address-or-hostname</i>:<i>port-number</i>/?option=value +socket://<i>ip-address-or-hostname</i>:<i>port-number</i>/?option=value&option=value </PRE> +<P>The "contimeout" option controls the number of seconds that the backend will wait to obtain a connection to the printer. The default is 1 week.</P> + +<P>The "snmp" option controls whether the <tt>socket</tt> backend queries for supply and page count information via SNMP.</P> + <P>The "waiteof" option controls whether the <tt>socket</tt> backend waits for the printer to complete the printing of the job. The default is to wait.</P> <H3><A NAME="IPP">Internet Printing Protocol (IPP)</A></H3> -<P>IPP is the only protocol that CUPS supports natively and is supported by some network printers and print servers. However, since many printers do not implement IPP properly, only use IPP when the vendor actually documents official support for it. IPP printing normally happens over port 631 and uses the <tt>http</tt> and <tt>ipp</tt> URI schemes:</P> +<P>IPP is the only protocol that CUPS supports natively and is supported by some network printers and print servers. However, since many printers do not implement IPP properly, only use IPP when the vendor actually documents official support for it. IPP printing normally happens over port 631 and uses the <tt>http</tt>, <tt>ipp</tt>, and <tt>ipps</tt> URI schemes:</P> <PRE> http://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i> @@ -114,6 +120,12 @@ ipp://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value&option=value ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i> ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value</i> ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&option=value</i> +ipps://<i>ip-address-or-hostname</i>/<i>resource</i> +ipps://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value</i> +ipps://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value&option=value</i> +ipps://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i> +ipps://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value</i> +ipps://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&option=value</i> </PRE> <P>The <tt>ipp</tt> backend supports many options, which are summarized in <A HREF="#TABLE2">Table 2</A>.</P> @@ -148,16 +160,20 @@ ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option <TD>Specifies that the connection to the IPP server should be encrypted using TLS.</TD> </TR> <TR> + <TD><TT>snmp=false</TT></TD> + <TD>Specifies that SNMP supply and page count queries should not be performed.</TD> +</TR> +<TR> <TD><TT>version=1.0</TT></TD> - <TD>Specifies that version 1.0 of the IPP protocol should be used instead of the default version 1.1.</TD> + <TD>Specifies that version 1.0 of the IPP protocol should be used instead of the default version 2.0.</TD> </TR> <TR> - <TD><TT>version=2.0</TT></TD> - <TD>Specifies that version 2.0 of the IPP protocol should be used instead of the default version 1.1.</TD> + <TD><TT>version=1.1</TT></TD> + <TD>Specifies that version 1.1 of the IPP protocol should be used instead of the default version 2.0.</TD> </TR> <TR> <TD><TT>version=2.1</TT></TD> - <TD>Specifies that version 2.1 of the IPP protocol should be used instead of the default version 1.1.</TD> + <TD>Specifies that version 2.1 of the IPP protocol should be used instead of the default version 2.0.</TD> </TR> <TR> <TD><TT>waitjob=false</TT></TD> @@ -267,6 +283,10 @@ lpd://<i>username@ip-address-or-hostname</i>/<i>queue</i>?<i>option=value&option <TD>Specifies that the job title string should be restricted to ASCII characters.</TD> </TR> <TR> + <TD><TT>snmp=false</TT></TD> + <TD>Specifies that SNMP supply and page count queries should not be performed.</TD> +</TR> +<TR> <TD><TT>timeout=<I>seconds</I></TT></TD> <TD>Specifies the number of seconds to wait for LPD commands to complete.</TD> </TR> diff --git a/doc/help/ref-cups-files-conf.html.in b/doc/help/ref-cups-files-conf.html.in new file mode 100644 index 00000000..fa922cb2 --- /dev/null +++ b/doc/help/ref-cups-files-conf.html.in @@ -0,0 +1,513 @@ +<HTML> +<!-- SECTION: References --> +<HEAD> + <TITLE>cups-files.conf</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> +</HEAD> +<BODY> + +<H1 CLASS="title">cups-files.conf</H1> + +<P>The <VAR>/etc/cups/cups-files.conf</VAR> file contains configuration <I>directives</I> that control the files, directories. users. and groups that are used by the CUPS scheduler, <CODE>cupsd(8)</CODE>. Each directive is listed on a line by itself followed by its value. Comments are introduced using the number sign ("#") character at the beginning of a line.</P> + +<H2 CLASS="title"><A NAME="AccessLog">AccessLog</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +AccessLog /var/log/cups/access_log +AccessLog /var/log/cups/access_log-%s +AccessLog syslog +</PRE> + +<H3>Description</H3> + +<P>The <CODE>AccessLog</CODE> directive sets the name of the +access log file. If the filename is not absolute then it is +assumed to be relative to the <A +HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The +access log file is stored in "common log format" and can be used +by any web access reporting tool to generate a report on CUPS +server activity.</P> + +<P>The server name can be included in the filename by using +<CODE>%s</CODE> in the name.</P> + +<P>The special name "syslog" can be used to send the access +information to the system log instead of a plain file.</P> + +<P>The default access log file is +<VAR>@CUPS_LOGDIR@/access_log</VAR>.</P> + + +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.15</SPAN><A NAME="ConfigFilePerm">ConfigFilePerm</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +ConfigFilePerm 0644 +ConfigFilePerm 0640 +</PRE> + +<H3>Description</H3> + +<P>The <CODE>ConfigFilePerm</CODE> directive specifies the permissions to use when the scheduler writes configuration and cache files, typically in response to IPP or HTTP requests. The default is @CUPS_CONFIG_FILE_PERM@.</P> + +<BLOCKQUOTE><B>Note:</B> + +<P>The permissions for the <VAR>printers.conf</VAR> file are always masked to only allow access from the scheduler user (typically root). This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system. There is no way to disable this security feature.</P> + +</BLOCKQUOTE> + + +<H2 CLASS="title"><A NAME="DataDir">DataDir</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +DataDir /usr/share/cups +</PRE> + +<H3>Description</H3> + +<P>The <CODE>DataDir</CODE> directive sets the directory to use +for data files.</P> + + +<H2 CLASS="title"><A NAME="DocumentRoot">DocumentRoot</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +DocumentRoot /usr/share/doc/cups +DocumentRoot /foo/bar/doc/cups +</PRE> + +<H3>Description</H3> + +<P>The <CODE>DocumentRoot</CODE> directive specifies the location +of web content for the HTTP server in CUPS. If an absolute path +is not specified then it is assumed to be relative to the <A +HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The +default directory is <VAR>@CUPS_DOCROOT@</VAR>.</P> + +<P>Documents are first looked up in a sub-directory for the +primary language requested by the client (e.g. +<VAR>@CUPS_DOCROOT@/fr/...</VAR>) and then directly under +the <CODE>DocumentRoot</CODE> directory (e.g. +<VAR>@CUPS_DOCROOT@/...</VAR>), so it is possible to +localize the web content by providing subdirectories for each +language needed.</P> + + +<H2 CLASS="title"><A NAME="ErrorLog">ErrorLog</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +ErrorLog /var/log/cups/error_log +ErrorLog /var/log/cups/error_log-%s +ErrorLog syslog +</PRE> + +<H3>Description</H3> + +<P>The <CODE>ErrorLog</CODE> directive sets the name of the error +log file. If the filename is not absolute then it is assumed to +be relative to the <A +HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The +default error log file is <VAR>@CUPS_LOGDIR@/error_log</VAR>.</P> + +<P>The server name can be included in the filename by using +<CODE>%s</CODE> in the name.</P> + +<P>The special name "syslog" can be used to send the error +information to the system log instead of a plain file.</P> + + +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/OS X 10.6</SPAN><A NAME="FatalErrors">FatalErrors</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +FatalErrors none +FatalErrors all +FatalErrors browse +FatalErrors config +FatalErrors listen +FatalErrors log +FatalErrors permissions +FatalErrors all -permissions +FatalErrors config permissions log +</PRE> + +<H3>Description</H3> + +<P>The <CODE>FatalErrors</CODE> directive determines whether certain kinds of +errors are fatal. The following kinds of errors are currently recognized:</P> + +<UL> + + <LI><CODE>none</CODE> - No errors are fatal</LI> + + <LI><CODE>all</CODE> - All of the errors below are fatal</LI> + + <LI><CODE>browse</CODE> - Browsing initialization errors are fatal, + for example failed binding to the CUPS browse port or failed connections + to LDAP servers</LI> + + <LI><CODE>config</CODE> - Configuration file syntax errors are + fatal</LI> + + <LI><CODE>listen</CODE> - Listen or Port errors are fatal, except for + IPv6 failures on the loopback or "any" addresses</LI> + + <LI><CODE>log</CODE> - Log file creation or write errors are fatal</LI> + + <LI><CODE>permissions</CODE> - Bad startup file permissions are + fatal, for example shared SSL certificate and key files with world- + read permissions</LI> + +</UL> + +<P>Multiple errors can be listed, and the form "-kind" can be used with +<CODE>all</CODE> to remove specific kinds of errors. The default setting is +<CODE>@CUPS_FATAL_ERRORS@</CODE>.</P> + + +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.18</SPAN><A NAME="FileDevice">FileDevice</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +FileDevice Yes +FileDevice No +</PRE> + +<H3>Description</H3> + +<P>The <CODE>FileDevice</CODE> directive determines whether the +scheduler allows new printers to be added using device URIs of +the form <CODE>file:/filename</CODE>. File devices are most often +used to test new printer drivers and do not support raw file +printing.</P> + +<P>The default setting is <CODE>No</CODE>.</P> + +<BLOCKQUOTE><B>Note:</B> + +<P>File devices are managed by the scheduler. Since the +scheduler normally runs as the root user, file devices +can be used to overwrite system files and potentially +gain unauthorized access to the system. If you must +create printers using file devices, we recommend that +you set the <CODE>FileDevice</CODE> directive to +<CODE>Yes</CODE> for only as long as you need to add the +printers to the system, and then reset the directive to +<CODE>No</CODE>.</P> + +</BLOCKQUOTE> + + +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.3</SPAN><A NAME="FontPath">FontPath</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +FontPath /foo/bar/fonts +FontPath /usr/share/cups/fonts:/foo/bar/fonts +</PRE> + +<H3>Description</H3> + +<P>The <CODE>FontPath</CODE> directive specifies the font path to +use when searching for fonts. The default font path is +<CODE>/usr/share/cups/fonts</CODE>.</P> + + +<H2 CLASS="title"><A NAME="Group">Group</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +Group lp +Group nobody +</PRE> + +<H3>Description</H3> + +<P>The <CODE>Group</CODE> directive specifies the UNIX group that +filter and CGI programs run as. The default group is +system-specific but is usually <CODE>lp</CODE> or +<CODE>nobody</CODE>.</P> + + +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.15</SPAN><A NAME="LogFilePerm">LogFilePerm</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +LogFilePerm 0644 +LogFilePerm 0600 +</PRE> + +<H3>Description</H3> + +<P>The <CODE>LogFilePerm</CODE> directive specifies the +permissions to use when writing log files. The default +is @CUPS_LOG_FILE_PERM@.</P> + + +<H2 CLASS="title"><A NAME="PageLog">PageLog</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +PageLog /var/log/cups/page_log +PageLog /var/log/cups/page_log-%s +PageLog syslog +</PRE> + +<H3>Description</H3> + +<P>The <CODE>PageLog</CODE> directive sets the name of the page +log file. If the filename is not absolute then it is assumed to +be relative to the <A +HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The +default page log file is <VAR>@CUPS_LOGDIR@/page_log</VAR>.</P> + +<P>The server name can be included in the filename by using +<CODE>%s</CODE> in the name.</P> + +<P>The special name "syslog" can be used to send the page +information to the system log instead of a plain file.</P> + + +<H2 CLASS="title"><A NAME="Printcap">Printcap</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +Printcap +Printcap /etc/printcap +Printcap /etc/printers.conf +Printcap /Library/Preferences/org.cups.printers.plist +</PRE> + +<H3>Description</H3> + +<P>The <CODE>Printcap</CODE> directive controls whether or not a +printcap file is automatically generated and updated with a list +of available printers. If specified with no value, then no +printcap file will be generated. The default is to generate a +file named <VAR>@CUPS_DEFAULT_PRINTCAP@</VAR>.</P> + +<P>When a filename is specified (e.g. <VAR>@CUPS_DEFAULT_PRINTCAP@</VAR>), +the printcap file is written whenever a printer is added or +removed. The printcap file can then be used by applications that +are hardcoded to look at the printcap file for the available +printers.</P> + + +<H2 CLASS="title"><A NAME="PrintcapFormat">PrintcapFormat</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +PrintcapFormat BSD +PrintcapFormat Solaris +PrintcapFormat plist +</PRE> + +<H3>Description</H3> + +<P>The <CODE>PrintcapFormat</CODE> directive controls the output format of the +printcap file. The default is to generate the plist format on OS X, the +Solaris format on Solaris, and the BSD format on other operating systems.</P> + + +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.3</SPAN><A NAME="RemoteRoot">RemoteRoot</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +RemoteRoot remroot +RemoteRoot root +</PRE> + +<H3>Description</H3> + +<P>The <CODE>RemoteRoot</CODE> directive sets the username for +unauthenticated root requests from remote hosts. The default +username is <VAR>remroot</VAR>. Setting <CODE>RemoteRoot</CODE> +to <VAR>root</VAR> effectively disables this security +mechanism.</P> + + +<H2 CLASS="title"><A NAME="RequestRoot">RequestRoot</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +RequestRoot /var/spool/cups +RequestRoot /foo/bar/spool/cups +</PRE> + +<H3>Description</H3> + +<P>The <CODE>RequestRoot</CODE> directive sets the directory for +incoming IPP requests and HTML forms. If an absolute path is not +provided then it is assumed to be relative to the <A +HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The +default request directory is <VAR>@CUPS_REQUESTS@</VAR>.</P> + + +<H2 CLASS="title"><A NAME="ServerBin">ServerBin</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +ServerBin /usr/lib/cups +ServerBin /foo/bar/lib/cups +</PRE> + +<H3>Description</H3> + +<P>The <CODE>ServerBin</CODE> directive sets the directory for +server-run executables. If an absolute path is not provided then +it is assumed to be relative to the <A +HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The +default executable directory is <VAR>/usr/lib/cups</VAR>, +<VAR>/usr/lib32/cups</VAR>, or <VAR>/usr/libexec/cups</VAR> +depending on the operating system.</P> + + +<H2 CLASS="title"><A NAME="ServerCertificate">ServerCertificate</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +ServerCertificate /etc/cups/ssl/server.crt +</PRE> + +<H3>Description</H3> + +<P>The <CODE>ServerCertificate</CODE> directive specifies the +location of the SSL certificate file used by the server when +negotiating encrypted connections. The certificate must not be +encrypted (password protected) since the scheduler normally runs +in the background and will be unable to ask for a password.</P> + +<P>The default certificate file is +<VAR>/etc/cups/ssl/server.crt</VAR>.</P> + + +<H2 CLASS="title"><A NAME="ServerKey">ServerKey</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +ServerKey /etc/cups/ssl/server.key +</PRE> + +<H3>Description</H3> + +<P>The <CODE>ServerKey</CODE> directive specifies the location of +the SSL private key file used by the server when negotiating +encrypted connections.</P> + +<P>The default key file is +<VAR>/etc/cups/ssl/server.crt</VAR>.</P> + + +<H2 CLASS="title"><A NAME="ServerRoot">ServerRoot</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +ServerRoot /etc/cups +ServerRoot /foo/bar/cups +</PRE> + +<H3>Description</H3> + +<P>The <CODE>ServerRoot</CODE> directive specifies the absolute +path to the server configuration and state files. It is also used +to resolve relative paths in the <VAR>cupsd.conf</VAR> file. The +default server directory is <VAR>/etc/cups</VAR>.</P> + + +<H2 CLASS="title"><A NAME="SystemGroup">SystemGroup</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +SystemGroup lpadmin +SystemGroup sys +SystemGroup system +SystemGroup root +SystemGroup root lpadmin +</PRE> + +<H3>Description</H3> + +<P>The <CODE>SystemGroup</CODE> directive specifies the system +administration group for <CODE>System</CODE> authentication. +Multiple groups can be listed, separated with spaces. The default +group list is <CODE>@CUPS_SYSTEM_GROUPS@</CODE>.</P> + + +<H2 CLASS="title"><A NAME="TempDir">TempDir</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +TempDir /var/tmp +TempDir /foo/bar/tmp +</PRE> + +<H3>Description</H3> + +<P>The <CODE>TempDir</CODE> directive specifies an absolute path +for the directory to use for temporary files. The default +directory is <VAR>@CUPS_REQUESTS@/tmp</VAR>.</P> + +<P>Temporary directories must be world-writable and should have +the "sticky" permission bit enabled so that other users cannot +delete filter temporary files. The following commands will create +an appropriate temporary directory called +<VAR>/foo/bar/tmp</VAR>:</P> + +<PRE CLASS="command"> +<KBD>mkdir /foo/bar/tmp</KBD> +<KBD>chmod a+rwxt /foo/bar/tmp</KBD> +</PRE> + + +<H2 CLASS="title"><A NAME="User">User</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +User lp +User guest +</PRE> + +<H3>Description</H3> + +<P>The <CODE>User</CODE> directive specifies the UNIX user that +filter and CGI programs run as. The default user is +<CODE>@CUPS_USER@</CODE>.</P> + +<BLOCKQUOTE><B>Note:</B> + +<P>You may not use user <CODE>root</CODE>, as that would expose +the system to unacceptable security risks. The scheduler will +automatically choose user <CODE>nobody</CODE> if you specify a +user whose ID is 0.</P> + +</BLOCKQUOTE> + + +</BODY> +</HTML> diff --git a/doc/help/ref-cupsd-conf.html.in b/doc/help/ref-cupsd-conf.html.in index 8454cf78..989765d0 100644 --- a/doc/help/ref-cupsd-conf.html.in +++ b/doc/help/ref-cupsd-conf.html.in @@ -49,36 +49,6 @@ automatically handles restarting the scheduler.</P> </BLOCKQUOTE> -<H2 CLASS="title"><A NAME="AccessLog">AccessLog</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -AccessLog /var/log/cups/access_log -AccessLog /var/log/cups/access_log-%s -AccessLog syslog -</PRE> - -<H3>Description</H3> - -<P>The <CODE>AccessLog</CODE> directive sets the name of the -access log file. If the filename is not absolute then it is -assumed to be relative to the <A -HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The -access log file is stored in "common log format" and can be used -by any web access reporting tool to generate a report on CUPS -server activity.</P> - -<P>The server name can be included in the filename by using -<CODE>%s</CODE> in the name.</P> - -<P>The special name "syslog" can be used to send the access -information to the system log instead of a plain file.</P> - -<P>The default access log file is -<VAR>@CUPS_LOGDIR@/access_log</VAR>.</P> - - <H2 CLASS="title"><A NAME="AccessLogLevel">AccessLogLevel</A></H2> <H3>Examples</H3> @@ -197,82 +167,6 @@ HREF="#Location"><CODE>Location</CODE></A> or <A HREF="#Limit"><CODE>Limit</CODE></A> section.</P> -<H2 CLASS="title"><SPAN CLASS="info">Deprecated</SPAN><A NAME="AuthClass">AuthClass</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -<Location /path> - ... - AuthClass Anonymous - AuthClass User - AuthClass System - AuthClass Group -</Location> -</PRE> - -<H3>Description</H3> - -<P>The <CODE>AuthClass</CODE> directive defines what level of -authentication is required:</P> - -<UL> - - <LI><CODE>Anonymous</CODE> - No authentication should be - performed (default)</LI> - - <LI><CODE>User</CODE> - A valid username and password is - required</LI> - - <LI><CODE>System</CODE> - A valid username and password - is required, and the username must belong to the "sys" - group; this can be changed using the <A - HREF="#SystemGroup"><CODE>SystemGroup</CODE></A> - directive</LI> - - <LI><CODE>Group</CODE> - A valid username and password is - required, and the username must belong to the group named - by the <A - HREF="#AuthGroupName"><CODE>AuthGroupName</CODE></A> - directive</LI> - -</UL> - -<P>The <CODE>AuthClass</CODE> directive must appear inside a <A -HREF="#Location"><CODE>Location</CODE></A> or <A -HREF="#Limit"><CODE>Limit</CODE></A> section.</P> - -<P><B>This directive is deprecated and will be removed from a -future release of CUPS.</B> Consider using the more flexible <A -HREF="#Require"><CODE>Require</CODE></A> directive instead.</P> - - -<H2 CLASS="title"><SPAN CLASS="info">Deprecated</SPAN><A NAME="AuthGroupName">AuthGroupName</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -<Location /path> - ... - AuthGroupName mygroup - AuthGroupName lp -</Location> -</PRE> - -<H3>Description</H3> - -<P>The <CODE>AuthGroupName</CODE> directive sets the group to use -for <CODE>Group</CODE> authentication.</P> - -<P>The <CODE>AuthGroupName</CODE> directive must appear inside a -<A HREF="#Location"><CODE>Location</CODE></A> or <A -HREF="#Limit"><CODE>Limit</CODE></A> section.</P> - -<P><B>This directive is deprecated and will be removed from a -future release of CUPS.</B> Consider using the more flexible <A -HREF="#Require"><CODE>Require</CODE></A> directive instead.</P> - - <H2 CLASS="title"><A NAME="AuthType">AuthType</A></H2> <H3>Examples</H3> @@ -436,40 +330,6 @@ used.</P> <P>The default is to not allow classification overrides.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.15</SPAN><A NAME="ConfigFilePerm">ConfigFilePerm</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -ConfigFilePerm 0644 -ConfigFilePerm 0640 -</PRE> - -<H3>Description</H3> - -<P>The <CODE>ConfigFilePerm</CODE> directive specifies the permissions to use when the scheduler writes configuration and cache files, typically in response to IPP or HTTP requests. The default is @CUPS_CONFIG_FILE_PERM@.</P> - -<BLOCKQUOTE><B>Note:</B> - -<P>The permissions for the <VAR>printers.conf</VAR> file are always masked to only allow access from the scheduler user (typically root). This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system. There is no way to disable this security feature.</P> - -</BLOCKQUOTE> - - -<H2 CLASS="title"><A NAME="DataDir">DataDir</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -DataDir /usr/share/cups -</PRE> - -<H3>Description</H3> - -<P>The <CODE>DataDir</CODE> directive sets the directory to use -for data files.</P> - - <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="DefaultAuthType">DefaultAuthType</A></H2> <H3>Examples</H3> @@ -653,32 +513,6 @@ DirtyCleanInterval 0 <P>The default value is <CODE>30</CODE> (30 seconds).</P> -<H2 CLASS="title"><A NAME="DocumentRoot">DocumentRoot</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -DocumentRoot /usr/share/doc/cups -DocumentRoot /foo/bar/doc/cups -</PRE> - -<H3>Description</H3> - -<P>The <CODE>DocumentRoot</CODE> directive specifies the location -of web content for the HTTP server in CUPS. If an absolute path -is not specified then it is assumed to be relative to the <A -HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The -default directory is <VAR>@CUPS_DOCROOT@</VAR>.</P> - -<P>Documents are first looked up in a sub-directory for the -primary language requested by the client (e.g. -<VAR>@CUPS_DOCROOT@/fr/...</VAR>) and then directly under -the <CODE>DocumentRoot</CODE> directory (e.g. -<VAR>@CUPS_DOCROOT@/...</VAR>), so it is possible to -localize the web content by providing subdirectories for each -language needed.</P> - - <H2 CLASS="title"><A NAME="Encryption">Encryption</A></H2> <H3>Examples</H3> @@ -701,31 +535,6 @@ encryption settings for that location. The default setting is <CODE>IfRequested</CODE> for all locations.</P> -<H2 CLASS="title"><A NAME="ErrorLog">ErrorLog</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -ErrorLog /var/log/cups/error_log -ErrorLog /var/log/cups/error_log-%s -ErrorLog syslog -</PRE> - -<H3>Description</H3> - -<P>The <CODE>ErrorLog</CODE> directive sets the name of the error -log file. If the filename is not absolute then it is assumed to -be relative to the <A -HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The -default error log file is <VAR>@CUPS_LOGDIR@/error_log</VAR>.</P> - -<P>The server name can be included in the filename by using -<CODE>%s</CODE> in the name.</P> - -<P>The special name "syslog" can be used to send the error -information to the system log instead of a plain file.</P> - - <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.3/OS X 10.5</SPAN><A NAME="ErrorPolicy">ErrorPolicy</A></H2> <H3>Examples</H3> @@ -764,91 +573,6 @@ printer.</P> </UL> - -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/OS X 10.6</SPAN><A NAME="FatalErrors">FatalErrors</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -FatalErrors none -FatalErrors all -FatalErrors browse -FatalErrors config -FatalErrors listen -FatalErrors log -FatalErrors permissions -FatalErrors all -permissions -FatalErrors config permissions log -</PRE> - -<H3>Description</H3> - -<P>The <CODE>FatalErrors</CODE> directive determines whether certain kinds of -errors are fatal. The following kinds of errors are currently recognized:</P> - -<UL> - - <LI><CODE>none</CODE> - No errors are fatal</LI> - - <LI><CODE>all</CODE> - All of the errors below are fatal</LI> - - <LI><CODE>browse</CODE> - Browsing initialization errors are fatal, - for example failed binding to the CUPS browse port or failed connections - to LDAP servers</LI> - - <LI><CODE>config</CODE> - Configuration file syntax errors are - fatal</LI> - - <LI><CODE>listen</CODE> - Listen or Port errors are fatal, except for - IPv6 failures on the loopback or "any" addresses</LI> - - <LI><CODE>log</CODE> - Log file creation or write errors are fatal</LI> - - <LI><CODE>permissions</CODE> - Bad startup file permissions are - fatal, for example shared SSL certificate and key files with world- - read permissions</LI> - -</UL> - -<P>Multiple errors can be listed, and the form "-kind" can be used with -<CODE>all</CODE> to remove specific kinds of errors. The default setting is -<CODE>@CUPS_FATAL_ERRORS@</CODE>.</P> - - -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.18</SPAN><A NAME="FileDevice">FileDevice</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -FileDevice Yes -FileDevice No -</PRE> - -<H3>Description</H3> - -<P>The <CODE>FileDevice</CODE> directive determines whether the -scheduler allows new printers to be added using device URIs of -the form <CODE>file:/filename</CODE>. File devices are most often -used to test new printer drivers and do not support raw file -printing.</P> - -<P>The default setting is <CODE>No</CODE>.</P> - -<BLOCKQUOTE><B>Note:</B> - -<P>File devices are managed by the scheduler. Since the -scheduler normally runs as the root user, file devices -can be used to overwrite system files and potentially -gain unauthorized access to the system. If you must -create printers using file devices, we recommend that -you set the <CODE>FileDevice</CODE> directive to -<CODE>Yes</CODE> for only as long as you need to add the -printers to the system, and then reset the directive to -<CODE>No</CODE>.</P> - -</BLOCKQUOTE> - - <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.3</SPAN><A NAME="FilterLimit">FilterLimit</A></H2> <H3>Examples</H3> @@ -893,39 +617,6 @@ value to assign to filter processes. The nice value ranges from is 0.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.3</SPAN><A NAME="FontPath">FontPath</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -FontPath /foo/bar/fonts -FontPath /usr/share/cups/fonts:/foo/bar/fonts -</PRE> - -<H3>Description</H3> - -<P>The <CODE>FontPath</CODE> directive specifies the font path to -use when searching for fonts. The default font path is -<CODE>/usr/share/cups/fonts</CODE>.</P> - - -<H2 CLASS="title"><A NAME="Group">Group</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -Group lp -Group nobody -</PRE> - -<H3>Description</H3> - -<P>The <CODE>Group</CODE> directive specifies the UNIX group that -filter and CGI programs run as. The default group is -system-specific but is usually <CODE>lp</CODE> or -<CODE>nobody</CODE>.</P> - - <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.6/OS X 10.8</SPAN><A NAME="GSSServiceName">GSSServiceName</A></H2> <H3>Examples</H3> @@ -980,7 +671,7 @@ Include /foo/bar/filename <P>The <CODE>Include</CODE> directive includes the named file in the <CODE>cupsd.conf</CODE> file. If no leading path is provided, the file is assumed to be relative to the <A -HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory.</P> +HREF="ref-cups-files-conf.html#ServerRoot"><CODE>ServerRoot</CODE></A> directory.</P> <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.5</SPAN><A NAME="JobPrivateAccess">JobPrivateAccess</A></H2> @@ -1533,22 +1224,6 @@ error occurs during printing. The default is 200 messages. A value of 0 disables debugging history entirely and is not recommended.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.15</SPAN><A NAME="LogFilePerm">LogFilePerm</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -LogFilePerm 0644 -LogFilePerm 0600 -</PRE> - -<H3>Description</H3> - -<P>The <CODE>LogFilePerm</CODE> directive specifies the -permissions to use when writing log files. The default -is @CUPS_LOG_FILE_PERM@.</P> - - <H2 CLASS="title"><A NAME="LogLevel">LogLevel</A></H2> <H3>Examples</H3> @@ -1569,7 +1244,7 @@ LogLevel debug2 <H3>Description</H3> <P>The <CODE>LogLevel</CODE> directive specifies the level of -logging for the <A HREF="#ErrorLog"><CODE>ErrorLog</CODE></A> +logging for the <A HREF="ref-cups-files-conf.html#ErrorLog"><CODE>ErrorLog</CODE></A> file. The following values are recognized (each level logs everything under the preceding levels):</P> @@ -1893,31 +1568,6 @@ HREF="#Location"><CODE>Location</CODE></A> or <A HREF="#Limit"><CODE>Limit</CODE></A> section.</P> -<H2 CLASS="title"><A NAME="PageLog">PageLog</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -PageLog /var/log/cups/page_log -PageLog /var/log/cups/page_log-%s -PageLog syslog -</PRE> - -<H3>Description</H3> - -<P>The <CODE>PageLog</CODE> directive sets the name of the page -log file. If the filename is not absolute then it is assumed to -be relative to the <A -HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The -default page log file is <VAR>@CUPS_LOGDIR@/page_log</VAR>.</P> - -<P>The server name can be included in the filename by using -<CODE>%s</CODE> in the name.</P> - -<P>The special name "syslog" can be used to send the page -information to the system log instead of a plain file.</P> - - <H2 CLASS="title"><A NAME="PageLogFormat">PageLogFormat</A></H2> <H3>Examples</H3> @@ -2096,65 +1746,6 @@ PreserveJobFiles 604800 </BLOCKQUOTE> -<H2 CLASS="title"><A NAME="Printcap">Printcap</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -Printcap -Printcap /etc/printcap -Printcap /etc/printers.conf -Printcap /Library/Preferences/org.cups.printers.plist -</PRE> - -<H3>Description</H3> - -<P>The <CODE>Printcap</CODE> directive controls whether or not a -printcap file is automatically generated and updated with a list -of available printers. If specified with no value, then no -printcap file will be generated. The default is to generate a -file named <VAR>@CUPS_DEFAUL_PRINTCAP@</VAR>.</P> - -<P>When a filename is specified (e.g. <VAR>@CUPS_DEFAULT_PRINTCAP@</VAR>), -the printcap file is written whenever a printer is added or -removed. The printcap file can then be used by applications that -are hardcoded to look at the printcap file for the available -printers.</P> - - -<H2 CLASS="title"><A NAME="PrintcapFormat">PrintcapFormat</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -PrintcapFormat BSD -PrintcapFormat Solaris -PrintcapFormat plist -</PRE> - -<H3>Description</H3> - -<P>The <CODE>PrintcapFormat</CODE> directive controls the output format of the -printcap file. The default is to generate the plist format on OS X, the -Solaris format on Solaris, and the BSD format on other operating systems.</P> - - -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.13</SPAN><A NAME="PrintcapGUI">PrintcapGUI</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -PrintGUI /usr/bin/glpoptions -</PRE> - -<H3>Description</H3> - -<P>The <CODE>PrintcapGUI</CODE> directive sets the program to -associate with the IRIX printer GUI interface script which is -used by IRIX applications to display printer-specific options. -There is no default program.</P> - - <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.21</SPAN><A NAME="ReloadTimeout">ReloadTimeout</A></H2> <H3>Examples</H3> @@ -2171,42 +1762,6 @@ of seconds the scheduler will wait for active jobs to complete before doing a restart. The default is 30 seconds.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.3</SPAN><A NAME="RemoteRoot">RemoteRoot</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -RemoteRoot remroot -RemoteRoot root -</PRE> - -<H3>Description</H3> - -<P>The <CODE>RemoteRoot</CODE> directive sets the username for -unauthenticated root requests from remote hosts. The default -username is <VAR>remroot</VAR>. Setting <CODE>RemoteRoot</CODE> -to <VAR>root</VAR> effectively disables this security -mechanism.</P> - - -<H2 CLASS="title"><A NAME="RequestRoot">RequestRoot</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -RequestRoot /var/spool/cups -RequestRoot /foo/bar/spool/cups -</PRE> - -<H3>Description</H3> - -<P>The <CODE>RequestRoot</CODE> directive sets the directory for -incoming IPP requests and HTML forms. If an absolute path is not -provided then it is assumed to be relative to the <A -HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The -default request directory is <VAR>@CUPS_REQUESTS@</VAR>.</P> - - <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Require">Require</A></H2> <H3>Examples</H3> @@ -2359,64 +1914,6 @@ alternate name with a ServerAlias directive instead of using "*".</P> </BLOCKQUOTE> -<H2 CLASS="title"><A NAME="ServerBin">ServerBin</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -ServerBin /usr/lib/cups -ServerBin /foo/bar/lib/cups -</PRE> - -<H3>Description</H3> - -<P>The <CODE>ServerBin</CODE> directive sets the directory for -server-run executables. If an absolute path is not provided then -it is assumed to be relative to the <A -HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The -default executable directory is <VAR>/usr/lib/cups</VAR>, -<VAR>/usr/lib32/cups</VAR>, or <VAR>/usr/libexec/cups</VAR> -depending on the operating system.</P> - - -<H2 CLASS="title"><A NAME="ServerCertificate">ServerCertificate</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -ServerCertificate /etc/cups/ssl/server.crt -</PRE> - -<H3>Description</H3> - -<P>The <CODE>ServerCertificate</CODE> directive specifies the -location of the SSL certificate file used by the server when -negotiating encrypted connections. The certificate must not be -encrypted (password protected) since the scheduler normally runs -in the background and will be unable to ask for a password.</P> - -<P>The default certificate file is -<VAR>/etc/cups/ssl/server.crt</VAR>.</P> - - -<H2 CLASS="title"><A NAME="ServerKey">ServerKey</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -ServerKey /etc/cups/ssl/server.key -</PRE> - -<H3>Description</H3> - -<P>The <CODE>ServerKey</CODE> directive specifies the location of -the SSL private key file used by the server when negotiating -encrypted connections.</P> - -<P>The default key file is -<VAR>/etc/cups/ssl/server.crt</VAR>.</P> - - <H2 CLASS="title"><A NAME="ServerName">ServerName</A></H2> <H3>Examples</H3> @@ -2433,23 +1930,6 @@ that is reported to clients. By default the server name is the hostname.</P> -<H2 CLASS="title"><A NAME="ServerRoot">ServerRoot</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -ServerRoot /etc/cups -ServerRoot /foo/bar/cups -</PRE> - -<H3>Description</H3> - -<P>The <CODE>ServerRoot</CODE> directive specifies the absolute -path to the server configuration and state files. It is also used -to resolve relative paths in the <VAR>cupsd.conf</VAR> file. The -default server directory is <VAR>/etc/cups</VAR>.</P> - - <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.21</SPAN><A NAME="ServerTokens">ServerTokens</A></H2> <H3>Examples</H3> @@ -2645,53 +2125,6 @@ subscription values to make private. The "default" values are "notify-events", HREF="#Policy"><CODE>Policy</CODE></A> section.</P> -<H2 CLASS="title"><A NAME="SystemGroup">SystemGroup</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -SystemGroup lpadmin -SystemGroup sys -SystemGroup system -SystemGroup root -SystemGroup root lpadmin -</PRE> - -<H3>Description</H3> - -<P>The <CODE>SystemGroup</CODE> directive specifies the system -administration group for <CODE>System</CODE> authentication. -Multiple groups can be listed, separated with spaces. The default -group list is <CODE>@CUPS_SYSTEM_GROUPS@</CODE>.</P> - - -<H2 CLASS="title"><A NAME="TempDir">TempDir</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -TempDir /var/tmp -TempDir /foo/bar/tmp -</PRE> - -<H3>Description</H3> - -<P>The <CODE>TempDir</CODE> directive specifies an absolute path -for the directory to use for temporary files. The default -directory is <VAR>@CUPS_REQUESTS@/tmp</VAR>.</P> - -<P>Temporary directories must be world-writable and should have -the "sticky" permission bit enabled so that other users cannot -delete filter temporary files. The following commands will create -an appropriate temporary directory called -<VAR>/foo/bar/tmp</VAR>:</P> - -<PRE CLASS="command"> -<KBD>mkdir /foo/bar/tmp</KBD> -<KBD>chmod a+rwxt /foo/bar/tmp</KBD> -</PRE> - - <H2 CLASS="title"><A NAME="Timeout">Timeout</A></H2> <H3>Examples</H3> @@ -2712,53 +2145,6 @@ to wait before an active HTTP or IPP request times out in seconds (no suffix), m <P>The default timeout is <CODE>5m</CODE> (five minutes).</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="UseNetworkDefault">UseNetworkDefault</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -UseNetworkDefault yes -UseNetworkDefault no -</PRE> - -<H3>Description</H3> - -<P>The <CODE>UseNetworkDefault</CODE> directive controls whether -the client will use a network/remote printer as a default -printer. If enabled, the default printer of a server is used as -the default printer on a client. When multiple servers are -advertising a default printer, the client's default printer is -set to the first discovered printer, or to the implicit class for -the same printer available from multiple servers.</P> - -<P>The default is <CODE>@CUPS_USE_NETWORK_DEFAULT@</CODE>.</P> - - -<H2 CLASS="title"><A NAME="User">User</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -User lp -User guest -</PRE> - -<H3>Description</H3> - -<P>The <CODE>User</CODE> directive specifies the UNIX user that -filter and CGI programs run as. The default user is -<CODE>@CUPS_USER@</CODE>.</P> - -<BLOCKQUOTE><B>Note:</B> - -<P>You may not use user <CODE>root</CODE>, as that would expose -the system to unacceptable security risks. The scheduler will -automatically choose user <CODE>nobody</CODE> if you specify a -user whose ID is 0.</P> - -</BLOCKQUOTE> - - <H2 CLASS="title"><SPAN CLASS="INFO">CUPS 1.5</SPAN><A NAME="WebInterface">WebInterface</A></H2> <H3>Examples</H3> diff --git a/doc/help/spec-browsing.html b/doc/help/spec-browsing.html index 4583731d..33f60b62 100644 --- a/doc/help/spec-browsing.html +++ b/doc/help/spec-browsing.html @@ -8,11 +8,11 @@ </head> <body> <!-- - "$Id: spec-browsing.html 9727 2011-04-28 21:20:12Z mike $" + "$Id: spec-browsing.html 10762 2012-12-13 20:28:30Z mike $" CUPS Browse Protocol specification for CUPS. - Copyright 2008-2011 by Apple Inc. + Copyright 2008-2012 by Apple Inc. Copyright 1997-2005 by Easy Software Products. These coded instructions, statements, and computer programs are the @@ -24,7 +24,7 @@ <BLOCKQUOTE><B>Note:</B> -<P>The CUPS Browse Protocol is deprecated and will no longer be used in a future release of CUPS.</P> +<P>The CUPS Browse Protocol was deprecated in CUPS 1.4 and is no longer supported.</P> </BLOCKQUOTE> @@ -32,37 +32,37 @@ <h2><a name='INTRO'>Introduction</a></h2> -<p>This specification describes the CUPS browsing protocol which is used for -printer sharing. The protocol is a UDP/IP-based broadcast service that -operates on IP service port 631 by default. Each broadcast packet describes +<p>This specification describes the CUPS browsing protocol which was used for +printer sharing. The protocol was a UDP/IP-based broadcast service that +operated on IP service port 631 by default. Each broadcast packet described a single printer or class being shared.</p> <p>For simple networks with a single subnet, a CUPS system sharing a printer -(the <em>server</em>) will periodically broadcast that printer's availability +(the <em>server</em>) would periodically broadcast that printer's availability and status information to the subnet. Every other CUPS system on the subnet -(the <em>clients</em>) will receive the broadcast and make that printer -available to local users. If a client stops receiving broadcasts from the -server, or if the server sends a special "deleted" broadcast message, the -client will remove its copy of the printer.</p> +(the <em>clients</em>) would receive the broadcast and make that printer +available to local users. If a client stopped receiving broadcasts from the +server, or if the server sent a special "deleted" broadcast message, the +client would remove its copy of the printer.</p> -<p>For larger networks with multiple subnets, a relay configuration can be used -where one or more client systems poll the server and then broadcast the +<p>For larger networks with multiple subnets, a relay configuration could be used +where one or more client systems polled the server and then broadcast the availability and status information for the server's shared printers to the clients' local subnets.</p> -<p>A key feature of CUPS printer sharing is support for <em>implicit +<p>A key feature of CUPS printer sharing was support for <em>implicit classes</em>, which are automatically-created classes for printers that are -shared by multiple servers. These implicit classes provide automatic load +shared by multiple servers. These implicit classes provided automatic load balancing and fail-safe printing functionality transparently to the user.</p> <h2><a name='SECURITY'>Security Considerations</a></h2> -<p>Like most discovery protocols, CUPS browse packets are not encrypted or -signed, so it is possible for malicious systems on a network to advertise +<p>Like most discovery protocols, CUPS browse packets were not encrypted or +signed, so it was possible for malicious systems on a network to advertise or remove printers on that network to cause denial of service or information -disclosure. In order to combat this, CUPS logs incoming browse packets and -provides access controls to limit browse packet reception to known hosts.</p> +disclosure. In order to combat this, CUPS logged incoming browse packets and +provided access controls to limit browse packet reception to known hosts.</p> <h2><a name='FORMAT'>Browse Packet Format</a></h2> diff --git a/doc/index.html.in b/doc/index.html.in index e79d52ef..58381441 100644 --- a/doc/index.html.in +++ b/doc/index.html.in @@ -100,7 +100,7 @@ HEIGHT="128" ALT="CUPS"></A></TD> </TD></TR> <TR><TD> </TD></TR> <TR><TD CLASS="trailer">CUPS and the CUPS logo are trademarks of -<A HREF="http://www.apple.com">Apple Inc.</A> CUPS is copyright 2007-2012 Apple +<A HREF="http://www.apple.com">Apple Inc.</A> Copyright 2007-2013 Apple Inc. All rights reserved.</TD></TR> </TABLE> </BODY> diff --git a/doc/ja/index.html.in b/doc/ja/index.html.in index d43a2ac7..e62d8f1e 100644 --- a/doc/ja/index.html.in +++ b/doc/ja/index.html.in @@ -100,7 +100,7 @@ HEIGHT="128" ALT="CUPS"></A></TD> </TD></TR> <TR><TD> </TD></TR> <TR><TD CLASS="trailer">CUPS and the CUPS logo are trademarks of -<A HREF="http://www.apple.com">Apple Inc.</A> CUPS is copyright 2007-2012 Apple +<A HREF="http://www.apple.com">Apple Inc.</A> CUPS is copyright 2007-2013 Apple Inc. All rights reserved.</TD></TR> </TABLE> </BODY> diff --git a/doc/ru/index.html.in b/doc/ru/index.html.in new file mode 100644 index 00000000..fda6cbcd --- /dev/null +++ b/doc/ru/index.html.in @@ -0,0 +1,206 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> +<HEAD> + <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> + <TITLE>Начало - CUPS @CUPS_VERSION@@CUPS_REVISION@</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="/cups.css"> + <LINK REL="SHORTCUT ICON" HREF="/images/cups-icon.png" TYPE="image/png"> +</HEAD> +<BODY> +<TABLE CLASS="page" SUMMARY="{title}"> +<TR><TD CLASS="body"> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> +<TR HEIGHT="36"> +<TD><A HREF="http://www.cups.org/" TARGET="_blank"><IMG +SRC="/images/left.gif" WIDTH="64" HEIGHT="36" BORDER="0" ALT=""></A></TD> +<TD CLASS="sel"><A HREF="/"> Начало </A></TD> +<TD CLASS="unsel"><A HREF="/admin"> Администрирование </A></TD> +<TD CLASS="unsel"><A HREF="/classes/"> Группы </A></TD> +<TD CLASS="unsel"><A HREF="/help/"> Справка </A></TD> +<TD CLASS="unsel"><A HREF="/jobs/"> Задания </A></TD> +<TD CLASS="unsel"><A HREF="/printers/"> Принтеры </A></TD> +<TD CLASS="unsel" WIDTH="100%"><FORM ACTION="/help/" METHOD="GET"><INPUT +TYPE="SEARCH" NAME="QUERY" SIZE="20" PLACEHOLDER="Search Help" +AUTOSAVE="org.cups.help" RESULTS="20"></FORM></TD> +<TD><IMG SRC="/images/right.gif" WIDTH="4" HEIGHT="36" ALT=""></TD> +</TR> +</TABLE> + +<TABLE CLASS="indent" SUMMARY=""> +<TR><TD STYLE="padding-right: 20px;"> + +<H1>CUPS @CUPS_VERSION@</H1> + +<P>CUPS — поддерживающая большинство стандартов, свободная подсистема печати, разрабатываемая компанией <A HREF="http://www.apple.com/">Apple Inc.</A> для операционной системы Mac OS<SUP>®</SUP> X и других UNIX<SUP>®</SUP>-подобных операционных систем.</P> + +</TD> +<TD><A HREF="http://www.cups.org/"><IMG SRC="images/cups-icon.png" WIDTH="128" +HEIGHT="128" ALT="CUPS"></A></TD> +</TR> +</TABLE> + +<TABLE CLASS="indent" SUMMARY=""> +<TR><TD VALIGN="top" STYLE="border-right: dotted thin #cccccc; padding-right: 20px;"> + +<H2>CUPS для пользователей</H2> + +<P><A HREF="help/overview.html">Введение в CUPS</A></P> + +<P><A HREF="help/options.html">Печать из командной строки</A></P> + +<P><A HREF="help/whatsnew.html">Что нового в CUPS 1.6</A></P> + +<P><A HREF="http://www.cups.org/newsgroups.php?gcups.general">Форум пользователей</A></P> + +</TD><TD VALIGN="top" STYLE="border-right: dotted thin #cccccc; padding-left: 20px; padding-right: 20px;"> + +<H2>CUPS для администраторов</H2> + +<P><A HREF="admin">Добавление принтеров и групп</A></P> + +<P><A HREF="help/policies.html">Управление доступом</A></P> + +<P><A HREF="help/accounting.html">Использование ресурсов</A></P> + +<P><A HREF="help/security.html">Безопасность системы</A></P> + +<P><A HREF="help/kerberos.html">Использование аутентификации Kerberos</A></P> + +<P><A HREF="help/network.html">Использование сетевых принтеров</A></P> + +<P><A HREF="help/ref-cupsd-conf.html">Справочник по cupsd.conf</A></P> + +<P><A HREF="http://www.cups.org/ppd.php">Поиск драйверов принтера</A></P> + +</TD><TD VALIGN="top" STYLE="padding-left: 20px;"> + +<H2>CUPS для разработчиков</H2> + +<P><A HREF="help/api-overview.html">Введение в разработку CUPS</A></P> + +<P><A HREF="help/api-cups.html">CUPS API</A></P> + +<P><A HREF="help/api-filter.html">Разработка фильтров и модулей</A></P> + +<P><A HREF="help/api-httpipp.html">API доступа по HTTP и IPP</A></P> + +<P><A HREF="help/api-ppd.html">PPD API</A></P> + +<P><A HREF="help/api-raster.html">Raster API</A></P> + +<P><A HREF="help/ref-ppdcfile.html">Справочник по компилятору PPD</A></P> + +<P><A HREF="http://www.cups.org/newsgroups.php?gcups.development">Форум разработчиков</A></P> + +</TD></TR> +</TABLE> + +</TD></TR> +<TR><TD> </TD></TR> +<TR><TD CLASS="trailer">CUPS а также логотип CUPS являются зарегистрированными торговыми марками <A HREF="http://www.apple.com">Apple Inc.</A> Авторские права на CUPS принадлежат (2007-2013) компании Apple Inc. Все права защищены.</TD></TR> +</TABLE> +</BODY> +</HTML> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> +<HEAD> + <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> + <TITLE>Начало - CUPS @CUPS_VERSION@@CUPS_REVISION@</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="/cups.css"> + <LINK REL="SHORTCUT ICON" HREF="/images/cups-icon.png" TYPE="image/png"> +</HEAD> +<BODY> +<TABLE CLASS="page" SUMMARY="{title}"> +<TR><TD CLASS="body"> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> +<TR HEIGHT="36"> +<TD><A HREF="http://www.cups.org/" TARGET="_blank"><IMG +SRC="/images/left.gif" WIDTH="64" HEIGHT="36" BORDER="0" ALT=""></A></TD> +<TD CLASS="sel"><A HREF="/"> Начало </A></TD> +<TD CLASS="unsel"><A HREF="/admin"> Администрирование </A></TD> +<TD CLASS="unsel"><A HREF="/classes/"> Группы </A></TD> +<TD CLASS="unsel"><A HREF="/help/"> Справка </A></TD> +<TD CLASS="unsel"><A HREF="/jobs/"> Задания </A></TD> +<TD CLASS="unsel"><A HREF="/printers/"> Принтеры </A></TD> +<TD CLASS="unsel" WIDTH="100%"><FORM ACTION="/help/" METHOD="GET"><INPUT +TYPE="SEARCH" NAME="QUERY" SIZE="20" PLACEHOLDER="Search Help" +AUTOSAVE="org.cups.help" RESULTS="20"></FORM></TD> +<TD><IMG SRC="/images/right.gif" WIDTH="4" HEIGHT="36" ALT=""></TD> +</TR> +</TABLE> + +<TABLE CLASS="indent" SUMMARY=""> +<TR><TD STYLE="padding-right: 20px;"> + +<H1>CUPS @CUPS_VERSION@</H1> + +<P>CUPS — поддерживающая большинство стандартов, свободная подсистема печати, разрабатываемая компанией <A HREF="http://www.apple.com/">Apple Inc.</A> для операционной системы Mac OS<SUP>®</SUP> X и других UNIX<SUP>®</SUP>-подобных операционных систем.</P> + +</TD> +<TD><A HREF="http://www.cups.org/"><IMG SRC="images/cups-icon.png" WIDTH="128" +HEIGHT="128" ALT="CUPS"></A></TD> +</TR> +</TABLE> + +<TABLE CLASS="indent" SUMMARY=""> +<TR><TD VALIGN="top" STYLE="border-right: dotted thin #cccccc; padding-right: 20px;"> + +<H2>CUPS для пользователей</H2> + +<P><A HREF="help/overview.html">Введение в CUPS</A></P> + +<P><A HREF="help/options.html">Печать из командной строки</A></P> + +<P><A HREF="help/whatsnew.html">Что нового в CUPS 1.6</A></P> + +<P><A HREF="http://www.cups.org/newsgroups.php?gcups.general">Форум пользователей</A></P> + +</TD><TD VALIGN="top" STYLE="border-right: dotted thin #cccccc; padding-left: 20px; padding-right: 20px;"> + +<H2>CUPS для администраторов</H2> + +<P><A HREF="admin">Добавление принтеров и групп</A></P> + +<P><A HREF="help/policies.html">Управление доступом</A></P> + +<P><A HREF="help/accounting.html">Использование ресурсов</A></P> + +<P><A HREF="help/security.html">Безопасность системы</A></P> + +<P><A HREF="help/kerberos.html">Использование аутентификации Kerberos</A></P> + +<P><A HREF="help/network.html">Использование сетевых принтеров</A></P> + +<P><A HREF="help/ref-cupsd-conf.html">Справочник по cupsd.conf</A></P> + +<P><A HREF="http://www.cups.org/ppd.php">Поиск драйверов принтера</A></P> + +</TD><TD VALIGN="top" STYLE="padding-left: 20px;"> + +<H2>CUPS для разработчиков</H2> + +<P><A HREF="help/api-overview.html">Введение в разработку CUPS</A></P> + +<P><A HREF="help/api-cups.html">CUPS API</A></P> + +<P><A HREF="help/api-filter.html">Разработка фильтров и модулей</A></P> + +<P><A HREF="help/api-httpipp.html">API доступа по HTTP и IPP</A></P> + +<P><A HREF="help/api-ppd.html">PPD API</A></P> + +<P><A HREF="help/api-raster.html">Raster API</A></P> + +<P><A HREF="help/ref-ppdcfile.html">Справочник по компилятору PPD</A></P> + +<P><A HREF="http://www.cups.org/newsgroups.php?gcups.development">Форум разработчиков</A></P> + +</TD></TR> +</TABLE> + +</TD></TR> +<TR><TD> </TD></TR> +<TR><TD CLASS="trailer">CUPS а также логотип CUPS являются зарегистрированными торговыми марками <A HREF="http://www.apple.com">Apple Inc.</A> Авторские права на CUPS принадлежат (2007-2013) компании Apple Inc. Все права защищены.</TD></TR> +</TABLE> +</BODY> +</HTML> |