792 lines
35 KiB
HTML
792 lines
35 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of cupsd.conf</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>cupsd.conf</H1>
|
|
Section: Apple Inc. (5)<BR>Updated: CUPS<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
cupsd.conf - server configuration file for cups
|
|
<A NAME="lbAC"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The
|
|
<I>cupsd.conf</I>
|
|
|
|
file configures the CUPS scheduler,
|
|
<B><A HREF="/cgi-bin/man/man2html?8+cupsd">cupsd</A></B>(8).
|
|
|
|
It is normally located in the
|
|
<I>/etc/cups</I>
|
|
|
|
directory.
|
|
Each line in the file can be a configuration directive, a blank line, or a comment.
|
|
Configuration directives typically consist of a name and zero or more values separated by whitespace.
|
|
The configuration directive name and values are case-insensitive.
|
|
Comment lines start with the # character.
|
|
<A NAME="lbAD"> </A>
|
|
<H3>TOP-LEVEL DIRECTIVES</H3>
|
|
|
|
The following top-level directives are understood by
|
|
<B><A HREF="/cgi-bin/man/man2html?8+cupsd">cupsd</A></B>(8):
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>AccessLogLevel config</B><DD>
|
|
<DT id="2"><B>AccessLogLevel actions</B><DD>
|
|
<DT id="3"><B>AccessLogLevel all</B><DD>
|
|
Specifies the logging level for the AccessLog file.
|
|
The "config" level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated.
|
|
The "actions" level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for "config".
|
|
The "all" level logs all requests.
|
|
The default access log level is "actions".
|
|
|
|
<DT id="4"><B>AutoPurgeJobs Yes</B><DD>
|
|
<DT id="5"><B>AutoPurgeJobs No</B><DD>
|
|
<BR>
|
|
|
|
Specifies whether to purge job history data automatically when it is no longer required for quotas.
|
|
The default is "No".
|
|
|
|
<DT id="6"><B>BrowseDNSSDSubTypes</B><I>_subtype[,...]</I>
|
|
|
|
<DD>
|
|
Specifies a list of Bonjour sub-types to advertise for each shared printer.
|
|
For example, "BrowseDNSSDSubTypes _cups,_print" will tell network clients that both CUPS sharing and IPP Everywhere are supported.
|
|
The default is "_cups" which is necessary for printer sharing to work between systems using CUPS.
|
|
|
|
<DT id="7"><B>BrowseLocalProtocols all</B><DD>
|
|
<DT id="8"><B>BrowseLocalProtocols dnssd</B><DD>
|
|
<DT id="9"><B>BrowseLocalProtocols none</B><DD>
|
|
Specifies which protocols to use for local printer sharing.
|
|
The default is "dnssd" on systems that support Bonjour and "none" otherwise.
|
|
|
|
<DT id="10"><B>BrowseWebIF Yes</B><DD>
|
|
<DT id="11"><B>BrowseWebIF No</B><DD>
|
|
<BR>
|
|
|
|
Specifies whether the CUPS web interface is advertised.
|
|
The default is "No".
|
|
|
|
<DT id="12"><B>Browsing Yes</B><DD>
|
|
<DT id="13"><B>Browsing No</B><DD>
|
|
<BR>
|
|
|
|
Specifies whether shared printers are advertised.
|
|
The default is "No".
|
|
|
|
<DT id="14"><B>DefaultAuthType Basic</B><DD>
|
|
<DT id="15"><B>DefaultAuthType Negotiate</B><DD>
|
|
<BR>
|
|
|
|
Specifies the default type of authentication to use.
|
|
The default is "Basic".
|
|
|
|
<DT id="16"><B>DefaultEncryption Never</B><DD>
|
|
<DT id="17"><B>DefaultEncryption IfRequested</B><DD>
|
|
<DT id="18"><B>DefaultEncryption Required</B><DD>
|
|
Specifies whether encryption will be used for authenticated requests.
|
|
The default is "Required".
|
|
|
|
<DT id="19"><B>DefaultLanguage </B><I>locale</I><DD>
|
|
Specifies the default language to use for text and web content.
|
|
The default is "en".
|
|
|
|
<DT id="20"><B>DefaultPaperSize Auto</B><DD>
|
|
<DT id="21"><B>DefaultPaperSize None</B><DD>
|
|
<DT id="22"><B>DefaultPaperSize </B><I>sizename</I><DD>
|
|
Specifies the default paper size for new print queues. "Auto" uses a locale-specific default, while "None" specifies there is no default paper size.
|
|
Specific size names are typically "Letter" or "A4".
|
|
The default is "Auto".
|
|
|
|
<DT id="23"><B>DefaultPolicy </B><I>policy-name</I><DD>
|
|
Specifies the default access policy to use.
|
|
The default access policy is "default".
|
|
|
|
<DT id="24"><B>DefaultShared Yes</B><DD>
|
|
<DT id="25"><B>DefaultShared No</B><DD>
|
|
Specifies whether local printers are shared by default.
|
|
The default is "Yes".
|
|
|
|
<DT id="26"><B>DirtyCleanInterval </B><I>seconds</I><DD>
|
|
Specifies the delay for updating of configuration and state files.
|
|
A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds.
|
|
The default value is "30".
|
|
|
|
<DT id="27"><B>DNSSDHostName</B><I>hostname.example.com</I>
|
|
|
|
<DD>
|
|
Specifies the fully-qualified domain name for the server that is used for Bonjour sharing.
|
|
The default is typically the server's ".local" hostname.
|
|
|
|
<DT id="28"><B>ErrorPolicy abort-job</B><DD>
|
|
Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer.
|
|
<DT id="29"><B>ErrorPolicy retry-current-job</B><DD>
|
|
Specifies that a failed print job should be retried immediately unless otherwise specified for the printer.
|
|
<DT id="30"><B>ErrorPolicy retry-job</B><DD>
|
|
Specifies that a failed print job should be retried at a later time unless otherwise specified for the printer. The 'retry-job' error policy is the default.
|
|
<DT id="31"><B>ErrorPolicy stop-printer</B><DD>
|
|
Specifies that a failed print job should stop the printer unless otherwise specified for the printer.
|
|
|
|
<DT id="32"><B>FilterLimit </B><I>limit</I><DD>
|
|
Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems.
|
|
A limit of 0 disables filter limiting.
|
|
An average print to a non-PostScript printer needs a filter limit of about 200.
|
|
A PostScript printer needs about half that (100).
|
|
Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time.
|
|
The default limit is "0".
|
|
|
|
<DT id="33"><B>FilterNice </B><I>nice-value</I><DD>
|
|
Specifies the scheduling priority (
|
|
<B><A HREF="/cgi-bin/man/man2html?8+nice">nice</A></B>(8)
|
|
|
|
value) of filters that are run to print a job.
|
|
The nice value ranges from 0, the highest priority, to 19, the lowest priority.
|
|
The default is 0.
|
|
|
|
<DT id="34"><B>GSSServiceName </B><I>name</I><DD>
|
|
Specifies the service name when using Kerberos authentication.
|
|
The default service name is "http."
|
|
<DT id="35">
|
|
<DD>
|
|
<B>HostNameLookups On</B>
|
|
<DT id="36"><B>HostNameLookups Off</B><DD>
|
|
<DT id="37"><B>HostNameLookups Double</B><DD>
|
|
Specifies whether to do reverse lookups on connecting clients.
|
|
The "Double" setting causes
|
|
<B><A HREF="/cgi-bin/man/man2html?8+cupsd">cupsd</A></B>(8)
|
|
|
|
to verify that the hostname resolved from the address matches one of the addresses returned for that hostname.
|
|
Double lookups also prevent clients with unregistered addresses from connecting to your server.
|
|
The default is "Off" to avoid the potential server performance problems with hostname lookups.
|
|
Only set this option to "On" or "Double" if absolutely required.
|
|
|
|
<DT id="38"><B>IdleExitTimeout </B><I>seconds</I><DD>
|
|
Specifies the length of time to wait before shutting down due to inactivity.
|
|
The default is "60" seconds.
|
|
Note: Only applicable when
|
|
<B><A HREF="/cgi-bin/man/man2html?8+cupsd">cupsd</A></B>(8)
|
|
|
|
is run on-demand (e.g., with <B>-l</B>).
|
|
|
|
<DT id="39"><B>JobKillDelay </B><I>seconds</I><DD>
|
|
Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.
|
|
The default is "30".
|
|
|
|
<DT id="40"><B>JobRetryInterval </B><I>seconds</I><DD>
|
|
Specifies the interval between retries of jobs in seconds.
|
|
This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job" or "retry-current-job".
|
|
The default is "30".
|
|
|
|
<DT id="41"><B>JobRetryLimit </B><I>count</I><DD>
|
|
Specifies the number of retries that are done for jobs.
|
|
This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job" or "retry-current-job".
|
|
The default is "5".
|
|
|
|
<DT id="42"><B>KeepAlive Yes</B><DD>
|
|
<DT id="43"><B>KeepAlive No</B><DD>
|
|
Specifies whether to support HTTP keep-alive connections.
|
|
The default is "Yes".
|
|
|
|
<DT id="44"><B>KeepAliveTimeout </B><I>seconds</I><DD>
|
|
Specifies how long an idle client connection remains open.
|
|
The default is "30".
|
|
|
|
<DT id="45"><B><Limit </B><I>operation </I>...<B>> </B>... <B></Limit></B><DD>
|
|
Specifies the IPP operations that are being limited inside a Policy section. IPP operation names are listed below in the section "IPP OPERATION NAMES".
|
|
|
|
<DT id="46"><B><Limit </B><I>method </I>...<B>> </B>... <B></Limit></B><DD>
|
|
|
|
<DT id="47"><B><LimitExcept </B><I>method </I>...<B>> </B>... <B></LimitExcept></B><DD>
|
|
Specifies the HTTP methods that are being limited inside a Location section. HTTP method names are listed below in the section "HTTP METHOD NAMES".
|
|
|
|
<DT id="48"><B>LimitRequestBody </B><I>size</I><DD>
|
|
Specifies the maximum size of print files, IPP requests, and HTML form data.
|
|
The default is "0" which disables the limit check.
|
|
|
|
<DT id="49"><B>Listen </B><I>ipv4-address</I><B>:</B><I>port</I><DD>
|
|
<DT id="50"><B>Listen [</B><I>ipv6-address</I><B>]:</B><I>port</I><DD>
|
|
<DT id="51"><B>Listen *:</B><I>port</I><DD>
|
|
<DT id="52"><B>Listen </B><I>/path/to/domain/socket</I><DD>
|
|
Listens to the specified address and port or domain socket path for connections.
|
|
Multiple Listen directives can be provided to listen on multiple addresses.
|
|
The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks.
|
|
|
|
<DT id="53"><B>ListenBackLog </B><I>number</I><DD>
|
|
Specifies the number of pending connections that will be allowed.
|
|
This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections.
|
|
When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones.
|
|
The default is the OS-defined default limit, typically either "5" for older operating systems or "128" for newer operating systems.
|
|
|
|
<DT id="54"><B><Location </B><I>/path</I><B>> </B>... <B></Location></B><DD>
|
|
Specifies access control for the named location.
|
|
Paths are documented below in the section "LOCATION PATHS".
|
|
|
|
<DT id="55"><B>LogDebugHistory </B><I>number</I><DD>
|
|
Specifies the number of debugging messages that are retained for logging if an error occurs in a print job. Debug messages are logged regardless of the LogLevel setting.
|
|
|
|
<DT id="56"><B>LogLevel </B>none<DD>
|
|
<DT id="57"><B>LogLevel </B>emerg<DD>
|
|
<DT id="58"><B>LogLevel </B>alert<DD>
|
|
<DT id="59"><B>LogLevel </B>crit<DD>
|
|
<DT id="60"><B>LogLevel </B>error<DD>
|
|
<DT id="61"><B>LogLevel </B>warn<DD>
|
|
<DT id="62"><B>LogLevel </B>notice<DD>
|
|
<DT id="63"><B>LogLevel </B>info<DD>
|
|
<DT id="64"><B>LogLevel </B>debug<DD>
|
|
<DT id="65"><B>LogLevel </B>debug2<DD>
|
|
Specifies the level of logging for the ErrorLog file.
|
|
The value "none" stops all logging while "debug2" logs everything.
|
|
The default is "warn".
|
|
|
|
<DT id="66"><B>LogTimeFormat </B>standard<DD>
|
|
<DT id="67"><B>LogTimeFormat </B>usecs<DD>
|
|
Specifies the format of the date and time in the log files.
|
|
The value "standard" is the default and logs whole seconds while "usecs" logs microseconds.
|
|
|
|
<DT id="68"><B>MaxClients </B><I>number</I><DD>
|
|
Specifies the maximum number of simultaneous clients that are allowed by the scheduler.
|
|
The default is "100".
|
|
|
|
<DT id="69"><B>MaxClientsPerHost </B><I>number</I><DD>
|
|
Specifies the maximum number of simultaneous clients that are allowed from a
|
|
single address.
|
|
The default is the MaxClients value.
|
|
|
|
<DT id="70"><B>MaxCopies </B><I>number</I><DD>
|
|
Specifies the maximum number of copies that a user can print of each job.
|
|
The default is "9999".
|
|
|
|
<DT id="71"><B>MaxHoldTime </B><I>seconds</I><DD>
|
|
Specifies the maximum time a job may remain in the "indefinite" hold state before it is canceled.
|
|
The default is "0" which disables cancellation of held jobs.
|
|
|
|
<DT id="72"><B>MaxJobs </B><I>number</I><DD>
|
|
Specifies the maximum number of simultaneous jobs that are allowed.
|
|
Set to "0" to allow an unlimited number of jobs.
|
|
The default is "500".
|
|
|
|
<DT id="73"><B>MaxJobsPerPrinter </B><I>number</I><DD>
|
|
Specifies the maximum number of simultaneous jobs that are allowed per printer.
|
|
The default is "0" which allows up to MaxJobs jobs per printer.
|
|
|
|
<DT id="74"><B>MaxJobsPerUser </B><I>number</I><DD>
|
|
Specifies the maximum number of simultaneous jobs that are allowed per user.
|
|
The default is "0" which allows up to MaxJobs jobs per user.
|
|
|
|
<DT id="75"><B>MaxJobTime </B><I>seconds</I><DD>
|
|
Specifies the maximum time a job may take to print before it is canceled.
|
|
Set to "0" to disable cancellation of "stuck" jobs.
|
|
The default is "10800" (3 hours).
|
|
|
|
<DT id="76"><B>MaxLogSize </B><I>size</I><DD>
|
|
Specifies the maximum size of the log files before they are rotated.
|
|
The value "0" disables log rotation.
|
|
The default is "1048576" (1MB).
|
|
|
|
<DT id="77"><B>MultipleOperationTimeout </B><I>seconds</I><DD>
|
|
Specifies the maximum amount of time to allow between files in a multiple file print job.
|
|
The default is "900" (15 minutes).
|
|
|
|
<DT id="78"><B><Policy </B><I>name</I><B>> </B>... <B></Policy></B><DD>
|
|
Specifies access control for the named policy.
|
|
|
|
<DT id="79"><B>Port </B><I>number</I><DD>
|
|
Listens to the specified port number for connections.
|
|
|
|
<DT id="80"><B>PreserveJobFiles Yes</B><DD>
|
|
<DT id="81"><B>PreserveJobFiles No</B><DD>
|
|
<DT id="82"><B>PreserveJobFiles </B><I>seconds</I><DD>
|
|
Specifies whether job files (documents) are preserved after a job is printed.
|
|
If a numeric value is specified, job files are preserved for the indicated number of seconds after printing.
|
|
The default is "86400" (preserve 1 day).
|
|
|
|
<DT id="83"><B>PreserveJobHistory Yes</B><DD>
|
|
<DT id="84"><B>PreserveJobHistory No</B><DD>
|
|
<DT id="85"><B>PreserveJobHistory </B><I>seconds</I><DD>
|
|
Specifies whether the job history is preserved after a job is printed.
|
|
If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing.
|
|
If "Yes", the job history is preserved until the MaxJobs limit is reached.
|
|
The default is "Yes".
|
|
|
|
<DT id="86"><B>ReloadTimeout </B><I>seconds</I><DD>
|
|
Specifies the amount of time to wait for job completion before restarting the scheduler.
|
|
The default is "30".
|
|
|
|
<DT id="87"><B>ServerAdmin </B><I>email-address</I><DD>
|
|
Specifies the email address of the server administrator.
|
|
The default value is "<A HREF="mailto:root@ServerName">root@ServerName</A>".
|
|
|
|
<DT id="88"><B>ServerAlias </B><I>hostname </I>[ ... <I>hostname </I>]<DD>
|
|
<DT id="89"><B>ServerAlias *</B><DD>
|
|
The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces.
|
|
Using the special name "*" can expose your system to known browser-based DNS rebinding attacks, even when accessing sites through a firewall.
|
|
If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using "*".
|
|
|
|
<DT id="90"><B>ServerName </B><I>hostname</I><DD>
|
|
Specifies the fully-qualified hostname of the server.
|
|
The default is the value reported by the
|
|
<B><A HREF="/cgi-bin/man/man2html?1+hostname">hostname</A></B>(1)
|
|
|
|
command.
|
|
|
|
<DT id="91"><B>ServerTokens None</B><DD>
|
|
<DT id="92"><B>ServerTokens ProductOnly</B><DD>
|
|
<DT id="93"><B>ServerTokens Major</B><DD>
|
|
<DT id="94"><B>ServerTokens Minor</B><DD>
|
|
<DT id="95"><B>ServerTokens Minimal</B><DD>
|
|
<DT id="96"><B>ServerTokens OS</B><DD>
|
|
<DT id="97"><B>ServerTokens Full</B><DD>
|
|
Specifies what information is included in the Server header of HTTP responses.
|
|
"None" disables the Server header.
|
|
"ProductOnly" reports "CUPS".
|
|
"Major" reports "CUPS/major IPP/2".
|
|
"Minor" reports "CUPS/major.minor IPP/2.1".
|
|
"Minimal" reports "CUPS/major.minor.patch IPP/2.1".
|
|
"OS" reports "CUPS/major.minor.path (osname osversion) IPP/2.1".
|
|
"Full" reports "CUPS/major.minor.path (osname osversion; architecture) IPP/2.1".
|
|
The default is "Minimal".
|
|
|
|
<DT id="98"><B>SSLListen </B><I>ipv4-address</I><B>:</B><I>port</I><DD>
|
|
<DT id="99"><B>SSLListen [</B><I>ipv6-address</I><B>]:</B><I>port</I><DD>
|
|
<DT id="100"><B>SSLListen *:</B><I>port</I><DD>
|
|
Listens on the specified address and port for encrypted connections.
|
|
|
|
<DT id="101"><DT><B>SSLOptions </B>[<I>AllowDH</I>] [<I>AllowRC4</I>] [<I>AllowSSL3</I>] [<I>DenyCBC</I>] [<I>DenyTLS1.0</I>] [<I>MaxTLS1.0</I>] [<I>MaxTLS1.1</I>] [<I>MaxTLS1.2</I>] [<I>MaxTLS1.3</I>] [<I>MinTLS1.0</I>] [<I>MinTLS1.1</I>] [<I>MinTLS1.2</I>] [<I>MinTLS1.3</I>]<DD>
|
|
<DD>
|
|
<DT id="102"><B>SSLOptions None</B><DD>
|
|
Sets encryption options (only in /etc/cups/client.conf).
|
|
By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
|
|
Security is reduced when <I>Allow</I> options are used.
|
|
Security is enhanced when <I>Deny</I> options are used.
|
|
The <I>AllowDH</I> option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS).
|
|
The <I>AllowRC4</I> option enables the 128-bit RC4 cipher suites, which are required for some older clients.
|
|
The <I>AllowSSL3</I> option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
|
|
The <I>DenyCBC</I> option disables all CBC cipher suites.
|
|
The <I>DenyTLS1.0</I> option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
|
|
The <I>MinTLS</I> options set the minimum TLS version to support.
|
|
The <I>MaxTLS</I> options set the maximum TLS version to support.
|
|
Not all operating systems support TLS 1.3 at this time.
|
|
|
|
<DT id="103"><B>SSLPort </B><I>port</I><DD>
|
|
Listens on the specified port for encrypted connections.
|
|
|
|
<DT id="104"><B>StrictConformance Yes</B><DD>
|
|
<DT id="105"><B>StrictConformance No</B><DD>
|
|
Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications.
|
|
The default is "No".
|
|
|
|
<DT id="106"><B>Timeout </B><I>seconds</I><DD>
|
|
Specifies the HTTP request timeout.
|
|
The default is "900" (15 minutes).
|
|
|
|
<DT id="107"><B>WebInterface yes</B><DD>
|
|
<DT id="108"><B>WebInterface no</B><DD>
|
|
Specifies whether the web interface is enabled.
|
|
The default is "No".
|
|
</DL>
|
|
<A NAME="lbAE"> </A>
|
|
<H3>HTTP METHOD NAMES</H3>
|
|
|
|
The following HTTP methods are supported by
|
|
<B><A HREF="/cgi-bin/man/man2html?8+cupsd">cupsd</A></B>(8):
|
|
|
|
<DL COMPACT>
|
|
<DT id="109">GET<DD>
|
|
Used by a client to download icons and other printer resources and to access the CUPS web interface.
|
|
<DT id="110">HEAD<DD>
|
|
Used by a client to get the type, size, and modification date of resources.
|
|
<DT id="111">OPTIONS<DD>
|
|
Used by a client to establish a secure (SSL/TLS) connection.
|
|
<DT id="112">POST<DD>
|
|
Used by a client to submit IPP requests and HTML forms from the CUPS web interface.
|
|
<DT id="113">PUT<DD>
|
|
Used by a client to upload configuration files.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H3>IPP OPERATION NAMES</H3>
|
|
|
|
The following IPP operations are supported by
|
|
<B><A HREF="/cgi-bin/man/man2html?8+cupsd">cupsd</A></B>(8):
|
|
|
|
<DL COMPACT>
|
|
<DT id="114">CUPS-Accept-Jobs<DD>
|
|
Allows a printer to accept new jobs.
|
|
<DT id="115">CUPS-Add-Modify-Class<DD>
|
|
Adds or modifies a printer class.
|
|
<DT id="116">CUPS-Add-Modify-Printer<DD>
|
|
Adds or modifies a printer.
|
|
<DT id="117">CUPS-Authenticate-Job<DD>
|
|
Releases a job that is held for authentication.
|
|
<DT id="118">CUPS-Delete-Class<DD>
|
|
Deletes a printer class.
|
|
<DT id="119">CUPS-Delete-Printer<DD>
|
|
Deletes a printer.
|
|
<DT id="120">CUPS-Get-Classes<DD>
|
|
Gets a list of printer classes.
|
|
<DT id="121">CUPS-Get-Default<DD>
|
|
Gets the server default printer or printer class.
|
|
<DT id="122">CUPS-Get-Devices<DD>
|
|
Gets a list of devices that are currently available.
|
|
<DT id="123">CUPS-Get-Document<DD>
|
|
Gets a document file for a job.
|
|
<DT id="124">CUPS-Get-PPD<DD>
|
|
Gets a PPD file.
|
|
<DT id="125">CUPS-Get-PPDs<DD>
|
|
Gets a list of installed PPD files.
|
|
<DT id="126">CUPS-Get-Printers<DD>
|
|
Gets a list of printers.
|
|
<DT id="127">CUPS-Move-Job<DD>
|
|
Moves a job.
|
|
<DT id="128">CUPS-Reject-Jobs<DD>
|
|
Prevents a printer from accepting new jobs.
|
|
<DT id="129">CUPS-Set-Default<DD>
|
|
Sets the server default printer or printer class.
|
|
<DT id="130">Cancel-Job<DD>
|
|
Cancels a job.
|
|
<DT id="131">Cancel-Jobs<DD>
|
|
Cancels one or more jobs.
|
|
<DT id="132">Cancel-My-Jobs<DD>
|
|
Cancels one or more jobs creates by a user.
|
|
<DT id="133">Cancel-Subscription<DD>
|
|
Cancels a subscription.
|
|
<DT id="134">Close-Job<DD>
|
|
Closes a job that is waiting for more documents.
|
|
<DT id="135">Create-Job<DD>
|
|
Creates a new job with no documents.
|
|
<DT id="136">Create-Job-Subscriptions<DD>
|
|
Creates a subscription for job events.
|
|
<DT id="137">Create-Printer-Subscriptions<DD>
|
|
Creates a subscription for printer events.
|
|
<DT id="138">Get-Job-Attributes<DD>
|
|
Gets information about a job.
|
|
<DT id="139">Get-Jobs<DD>
|
|
Gets a list of jobs.
|
|
<DT id="140">Get-Notifications<DD>
|
|
Gets a list of event notifications for a subscription.
|
|
<DT id="141">Get-Printer-Attributes<DD>
|
|
Gets information about a printer or printer class.
|
|
<DT id="142">Get-Subscription-Attributes<DD>
|
|
Gets information about a subscription.
|
|
<DT id="143">Get-Subscriptions<DD>
|
|
Gets a list of subscriptions.
|
|
<DT id="144">Hold-Job<DD>
|
|
Holds a job from printing.
|
|
<DT id="145">Hold-New-Jobs<DD>
|
|
Holds all new jobs from printing.
|
|
<DT id="146">Pause-Printer<DD>
|
|
Stops processing of jobs by a printer or printer class.
|
|
<DT id="147">Pause-Printer-After-Current-Job<DD>
|
|
Stops processing of jobs by a printer or printer class after the current job is finished.
|
|
<DT id="148">Print-Job<DD>
|
|
Creates a new job with a single document.
|
|
<DT id="149">Purge-Jobs<DD>
|
|
Cancels one or more jobs and deletes the job history.
|
|
<DT id="150">Release-Held-New-Jobs<DD>
|
|
Allows previously held jobs to print.
|
|
<DT id="151">Release-Job<DD>
|
|
Allows a job to print.
|
|
<DT id="152">Renew-Subscription<DD>
|
|
Renews a subscription.
|
|
<DT id="153">Restart-Job<DD>
|
|
Reprints a job, if possible.
|
|
<DT id="154">Send-Document<DD>
|
|
Adds a document to a job.
|
|
<DT id="155">Set-Job-Attributes<DD>
|
|
Changes job information.
|
|
<DT id="156">Set-Printer-Attributes<DD>
|
|
Changes printer or printer class information.
|
|
<DT id="157">Validate-Job<DD>
|
|
Validates options for a new job.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H3>LOCATION PATHS</H3>
|
|
|
|
The following paths are commonly used when configuring
|
|
<B><A HREF="/cgi-bin/man/man2html?8+cupsd">cupsd</A></B>(8):
|
|
|
|
<DL COMPACT>
|
|
<DT id="158">/<DD>
|
|
The path for all get operations (get-printers, get-jobs, etc.)
|
|
<DT id="159">/admin<DD>
|
|
The path for all administration operations (add-printer, delete-printer, start-printer, etc.)
|
|
<DT id="160">/admin/conf<DD>
|
|
The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.)
|
|
<DT id="161">/admin/log<DD>
|
|
The path for access to the CUPS log files (access_log, error_log, page_log)
|
|
<DT id="162">/classes<DD>
|
|
The path for all printer classes
|
|
<DT id="163">/classes/name<DD>
|
|
The resource for the named printer class
|
|
<DT id="164">/jobs<DD>
|
|
The path for all jobs (hold-job, release-job, etc.)
|
|
<DT id="165">/jobs/id<DD>
|
|
The path for the specified job
|
|
<DT id="166">/printers<DD>
|
|
The path for all printers
|
|
<DT id="167">/printers/name<DD>
|
|
The path for the named printer
|
|
<DT id="168">/printers/name.png<DD>
|
|
The icon file path for the named printer
|
|
<DT id="169">/printers/name.ppd<DD>
|
|
The PPD file path for the named printer
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H3>DIRECTIVES VALID WITHIN LOCATION AND LIMIT SECTIONS</H3>
|
|
|
|
The following directives may be placed inside Location and Limit sections in the <B>cupsd.conf</B> file:
|
|
<DL COMPACT>
|
|
<DT id="170"><B>Allow all</B><DD>
|
|
<DT id="171"><B>Allow none</B><DD>
|
|
<DT id="172"><B>Allow </B><I>host.domain.com</I><DD>
|
|
<DT id="173"><B>Allow *.</B><I>domain.com</I><DD>
|
|
<DT id="174"><B>Allow </B><I>ipv4-address</I><DD>
|
|
<DT id="175"><B>Allow </B><I>ipv4-address</I><B>/</B><I>netmask</I><DD>
|
|
<DT id="176"><B>Allow </B><I>ipv4-address</I><B>/</B><I>mm</I><DD>
|
|
<DT id="177"><B>Allow [</B><I>ipv6-address</I><B>]</B><DD>
|
|
<DT id="178"><B>Allow [</B><I>ipv6-address</I><B>]/</B><I>mm</I><DD>
|
|
<DT id="179"><B>Allow @IF(</B><I>name</I><B>)</B><DD>
|
|
<DT id="180"><B>Allow @LOCAL</B><DD>
|
|
Allows access from the named hosts, domains, addresses, or interfaces.
|
|
The @IF(name) form uses the current subnets configured for the named interface.
|
|
The @LOCAL form uses the current subnets configured for all interfaces that are not point-to-point, for example Ethernet and Wi-Fi interfaces are used but DSL and VPN interfaces are not.
|
|
The Order directive controls whether Allow lines are evaluated before or after Deny lines.
|
|
<DT id="181"><B>AuthType None</B><DD>
|
|
<DT id="182"><B>AuthType Basic</B><DD>
|
|
<DT id="183"><B>AuthType Default</B><DD>
|
|
<DT id="184"><B>AuthType Negotiate</B><DD>
|
|
Specifies the type of authentication required.
|
|
The value "Default" corresponds to the DefaultAuthType value.
|
|
<DT id="185"><B>Deny all</B><DD>
|
|
<DT id="186"><B>Deny none</B><DD>
|
|
<DT id="187"><B>Deny </B><I>host.domain.com</I><DD>
|
|
<DT id="188"><B>Deny *.</B><I>domain.com</I><DD>
|
|
<DT id="189"><B>Deny </B><I>ipv4-address</I><DD>
|
|
<DT id="190"><B>Deny </B><I>ipv4-address</I><B>/</B><I>netmask</I><DD>
|
|
<DT id="191"><B>Deny </B><I>ipv4-address</I><B>/</B><I>mm</I><DD>
|
|
<DT id="192"><B>Deny [</B><I>ipv6-address</I><B>]</B><DD>
|
|
<DT id="193"><B>Deny [</B><I>ipv6-address</I><B>]/</B><I>mm</I><DD>
|
|
<DT id="194"><B>Deny @IF(</B><I>name</I><B>)</B><DD>
|
|
<DT id="195"><B>Deny @LOCAL</B><DD>
|
|
Denies access from the named hosts, domains, addresses, or interfaces.
|
|
The @IF(name) form uses the current subnets configured for the named interface.
|
|
The @LOCAL form uses the current subnets configured for all interfaces that are not point-to-point, for example Ethernet and Wi-Fi interfaces are used but DSL and VPN interfaces are not.
|
|
The Order directive controls whether Deny lines are evaluated before or after Allow lines.
|
|
<DT id="196"><B>Encryption IfRequested</B><DD>
|
|
<DT id="197"><B>Encryption Never</B><DD>
|
|
<DT id="198"><B>Encryption Required</B><DD>
|
|
Specifies the level of encryption that is required for a particular location.
|
|
The default value is "IfRequested".
|
|
<DT id="199"><B>Order allow,deny</B><DD>
|
|
Specifies that access is denied by default. Allow lines are then processed followed by Deny lines to determine whether a client may access a particular resource.
|
|
<DT id="200"><B>Order deny,allow</B><DD>
|
|
Specifies that access is allowed by default. Deny lines are then processed followed by Allow lines to determine whether a client may access a particular resource.
|
|
<DT id="201"><B>Require group </B><I>group-name </I>[ <I>group-name </I>... ]<DD>
|
|
Specifies that an authenticated user must be a member of one of the named groups.
|
|
<DT id="202"><B>Require user {</B><I>user-name</I>|<B>@</B><I>group-name</I>} ...<DD>
|
|
Specifies that an authenticated user must match one of the named users or be a member of one of the named groups.
|
|
The group name "@SYSTEM" corresponds to the list of groups defined by the SystemGroup directive in the
|
|
<B><A HREF="/cgi-bin/man/man2html?5+cups-files.conf">cups-files.conf</A></B>(5)
|
|
|
|
file.
|
|
The group name "@OWNER" corresponds to the owner of the resource, for example the person that submitted a print job.
|
|
Note: The 'root' user is not special and must be granted privileges like any other user account.
|
|
<DT id="203"><B>Require valid-user</B><DD>
|
|
Specifies that any authenticated user is acceptable.
|
|
<DT id="204"><B>Satisfy all</B><DD>
|
|
Specifies that all Allow, AuthType, Deny, Order, and Require conditions must be satisfied to allow access.
|
|
<DT id="205"><B>Satisfy any</B><DD>
|
|
Specifies that any a client may access a resource if either the authentication (AuthType/Require) or address (Allow/Deny/Order) conditions are satisfied.
|
|
For example, this can be used to require authentication only for remote accesses.
|
|
</DL>
|
|
<A NAME="lbAI"> </A>
|
|
<H3>DIRECTIVES VALID WITHIN POLICY SECTIONS</H3>
|
|
|
|
The following directives may be placed inside Policy sections in the <B>cupsd.conf</B> file:
|
|
<DL COMPACT>
|
|
<DT id="206"><B>JobPrivateAccess all</B><DD>
|
|
<DT id="207"><B>JobPrivateAccess default</B><DD>
|
|
<DT id="208"><B>JobPrivateAccess </B>{<I>user</I>|<B>@</B><I>group</I>|<B>@ACL</B>|<B>@OWNER</B>|<B>@SYSTEM</B>} ...<DD>
|
|
Specifies an access list for a job's private values.
|
|
The "default" access list is "@OWNER @SYSTEM".
|
|
"@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
|
|
"@OWNER" maps to the job's owner.
|
|
"@SYSTEM" maps to the groups listed for the SystemGroup directive in the
|
|
<B><A HREF="/cgi-bin/man/man2html?5+cups-files.conf">cups-files.conf</A></B>(5)
|
|
|
|
file.
|
|
<DT id="209"><B>JobPrivateValues all</B><DD>
|
|
<DT id="210"><B>JobPrivateValues default</B><DD>
|
|
<DT id="211"><B>JobPrivateValues none</B><DD>
|
|
<DT id="212"><B>JobPrivateValues </B><I>attribute-name </I>[ ... <I>attribute-name </I>]<DD>
|
|
Specifies the list of job values to make private.
|
|
The "default" values are "job-name", "job-originating-host-name", "job-originating-user-name", and "phone".
|
|
<DT id="213"><B>SubscriptionPrivateAccess all</B><DD>
|
|
<DT id="214"><B>SubscriptionPrivateAccess default</B><DD>
|
|
<DT id="215"><B>SubscriptionPrivateAccess </B>{<I>user</I>|<B>@</B><I>group</I>|<B>@ACL</B>|<B>@OWNER</B>|<B>@SYSTEM</B>} ...<DD>
|
|
Specifies an access list for a subscription's private values.
|
|
The "default" access list is "@OWNER @SYSTEM".
|
|
"@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
|
|
"@OWNER" maps to the job's owner.
|
|
"@SYSTEM" maps to the groups listed for the SystemGroup directive in the
|
|
<B><A HREF="/cgi-bin/man/man2html?5+cups-files.conf">cups-files.conf</A></B>(5)
|
|
|
|
file.
|
|
<DT id="216"><B>SubscriptionPrivateValues all</B><DD>
|
|
<DT id="217"><B>SubscriptionPrivateValues default</B><DD>
|
|
<DT id="218"><B>SubscriptionPrivateValues none</B><DD>
|
|
<DT id="219"><B>SubscriptionPrivateValues </B><I>attribute-name </I>[ ... <I>attribute-name </I>]<DD>
|
|
Specifies the list of subscription values to make private.
|
|
The "default" values are "notify-events", "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and "notify-user-data".
|
|
</DL>
|
|
<A NAME="lbAJ"> </A>
|
|
<H3>DEPRECATED DIRECTIVES</H3>
|
|
|
|
The following directives are deprecated and will be removed in a future release of CUPS:
|
|
|
|
<DL COMPACT>
|
|
<DT id="220"><B>Classification </B><I>banner</I><DD>
|
|
<BR>
|
|
|
|
Specifies the security classification of the server.
|
|
Any valid banner name can be used, including "classified", "confidential", "secret", "topsecret", and "unclassified", or the banner can be omitted to disable secure printing functions.
|
|
The default is no classification banner.
|
|
|
|
<DT id="221"><B>ClassifyOverride Yes</B><DD>
|
|
<DT id="222"><B>ClassifyOverride No</B><DD>
|
|
<BR>
|
|
|
|
Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option.
|
|
The default is "No".
|
|
|
|
<DT id="223"><B>PageLogFormat </B><I>format-string</I><DD>
|
|
Specifies the format of PageLog lines.
|
|
Sequences beginning with percent (%) characters are replaced with the corresponding information, while all other characters are copied literally.
|
|
The following percent sequences are recognized:
|
|
<PRE>
|
|
|
|
"%%" inserts a single percent character.
|
|
"%{name}" inserts the value of the specified IPP attribute.
|
|
"%C" inserts the number of copies for the current page.
|
|
"%P" inserts the current page number.
|
|
"%T" inserts the current date and time in common log format.
|
|
"%j" inserts the job ID.
|
|
"%p" inserts the printer name.
|
|
"%u" inserts the username.
|
|
|
|
</PRE>
|
|
|
|
The default is the empty string, which disables page logging.
|
|
The string "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}" creates a page log with the standard items.
|
|
Use "%{job-impressions-completed}" to insert the number of pages (sides) that were printed, or "%{job-media-sheets-completed}" to insert the number of sheets that were printed.
|
|
|
|
<DT id="224"><B>RIPCache </B><I>size</I><DD>
|
|
Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.
|
|
The default is "128m".
|
|
</DL>
|
|
<A NAME="lbAK"> </A>
|
|
<H2>NOTES</H2>
|
|
|
|
File, directory, and user configuration directives that used to be allowed in the <B>cupsd.conf</B> file are now stored in the
|
|
<B><A HREF="/cgi-bin/man/man2html?5+cups-files.conf">cups-files.conf</A></B>(5)
|
|
|
|
file instead in order to prevent certain types of privilege escalation attacks.
|
|
<P>
|
|
|
|
The scheduler MUST be restarted manually after making changes to the <B>cupsd.conf</B> file.
|
|
On Linux this is typically done using the
|
|
<B><A HREF="/cgi-bin/man/man2html?8+systemctl">systemctl</A></B>(8)
|
|
|
|
command, while on macOS the
|
|
<B><A HREF="/cgi-bin/man/man2html?8+launchctl">launchctl</A></B>(8)
|
|
|
|
command is used instead.
|
|
<P>
|
|
|
|
The @LOCAL macro name can be confusing since the system running
|
|
<B>cupsd</B>
|
|
|
|
often belongs to a different set of subnets from its clients.
|
|
<A NAME="lbAL"> </A>
|
|
<H2>CONFORMING TO</H2>
|
|
|
|
The <B>cupsd.conf</B> file format is based on the Apache HTTP Server configuration file format.
|
|
<A NAME="lbAM"> </A>
|
|
<H2>EXAMPLES</H2>
|
|
|
|
Log everything with a maximum log file size of 32 megabytes:
|
|
<PRE>
|
|
|
|
AccessLogLevel all
|
|
LogLevel debug2
|
|
MaxLogSize 32m
|
|
|
|
</PRE>
|
|
|
|
Require authentication for accesses from outside the 10. network:
|
|
<PRE>
|
|
|
|
<Location />
|
|
Order allow,deny
|
|
Allow from 10./8
|
|
AuthType Basic
|
|
Require valid-user
|
|
Satisfy any
|
|
</Location>
|
|
</PRE>
|
|
|
|
<A NAME="lbAN"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+classes.conf">classes.conf</A></B>(5),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+cups-files.conf">cups-files.conf</A></B>(5),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+cupsd">cupsd</A></B>(8),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+mime.convs">mime.convs</A></B>(5),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+mime.types">mime.types</A></B>(5),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+printers.conf">printers.conf</A></B>(5),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+subscriptions.conf">subscriptions.conf</A></B>(5),
|
|
|
|
CUPS Online Help (<A HREF="http://localhost:631/help)">http://localhost:631/help)</A>
|
|
<A NAME="lbAO"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
Copyright © 2007-2019 by Apple Inc.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="225"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="226"><A HREF="#lbAC">DESCRIPTION</A><DD>
|
|
<DL>
|
|
<DT id="227"><A HREF="#lbAD">TOP-LEVEL DIRECTIVES</A><DD>
|
|
<DT id="228"><A HREF="#lbAE">HTTP METHOD NAMES</A><DD>
|
|
<DT id="229"><A HREF="#lbAF">IPP OPERATION NAMES</A><DD>
|
|
<DT id="230"><A HREF="#lbAG">LOCATION PATHS</A><DD>
|
|
<DT id="231"><A HREF="#lbAH">DIRECTIVES VALID WITHIN LOCATION AND LIMIT SECTIONS</A><DD>
|
|
<DT id="232"><A HREF="#lbAI">DIRECTIVES VALID WITHIN POLICY SECTIONS</A><DD>
|
|
<DT id="233"><A HREF="#lbAJ">DEPRECATED DIRECTIVES</A><DD>
|
|
</DL>
|
|
<DT id="234"><A HREF="#lbAK">NOTES</A><DD>
|
|
<DT id="235"><A HREF="#lbAL">CONFORMING TO</A><DD>
|
|
<DT id="236"><A HREF="#lbAM">EXAMPLES</A><DD>
|
|
<DT id="237"><A HREF="#lbAN">SEE ALSO</A><DD>
|
|
<DT id="238"><A HREF="#lbAO">COPYRIGHT</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:02 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|