[thirdparty/cups.git] / doc / help / man-cupsd.conf.html

<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>cupsd.conf(5)</title>
</head>
<body>
<h1 class="title">cupsd.conf(5)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
cupsd.conf - server configuration file for cups
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The <i>cupsd.conf</i> file configures the CUPS scheduler, <i>cupsd(8)</i>.  It
is normally located in the <i>/etc/cups</i> directory. <b>Note:</b>
File, directory, and user configuration directives that used to be allowed in
the <i>cupsd.conf</i> file are now stored in the <i>cups-files.conf(5)</i> instead
in order to prevent certain types of privilege escalation attacks.
<p>Each line in the file can be a configuration directive, a blank line,
or a comment. Comment lines start with the # character. The
configuration directives are intentionally similar to those used by the
popular Apache web server software and are described below.
<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
The following directives are understood by <i>cupsd(8)</i>. Consult the
on-line help for detailed descriptions:
<p style="margin-left: 5.0em; text-indent: -5.0em">AccessLogLevel config
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">AccessLogLevel actions
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">AccessLogLevel all
<br>
<br>
Specifies the logging level for the AccessLog file.
<p style="margin-left: 5.0em; text-indent: -5.0em">Allow all
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Allow none
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Allow host.domain.com
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Allow *.domain.com
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Allow ip-address
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Allow ip-address/netmask
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Allow ip-address/mm
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Allow @IF(name)
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Allow @LOCAL
<br>
<br>
Allows access from the named hosts or addresses.
<p style="margin-left: 5.0em; text-indent: -5.0em">AuthType None
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">AuthType Basic
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">AuthType BasicDigest
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">AuthType Digest
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">AuthType Negotiate
<br>
<br>
Specifies the authentication type (None, Basic, BasicDigest, Digest, Negotiate)
<p style="margin-left: 5.0em; text-indent: -5.0em">AutoPurgeJobs Yes
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">AutoPurgeJobs No
<br>
<br>
Specifies whether to purge job history data automatically when
it is no longer required for quotas.
<p style="margin-left: 5.0em; text-indent: -5.0em">BrowseLocalProtocols [All] [DNSSD]
<br>
<br>
Specifies the protocols to use for local printer sharing.
<p style="margin-left: 5.0em; text-indent: -5.0em">BrowseWebIF Yes
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">BrowseWebIF No
<br>
<br>
Specifies whether the CUPS web interface is advertised via DNS-SD.
<p style="margin-left: 5.0em; text-indent: -5.0em">Browsing Yes
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Browsing No
<br>
<br>
Specifies whether or not shared printers should be advertised.
<p style="margin-left: 5.0em; text-indent: -5.0em">Classification banner
<br>
<br>
Specifies the security classification of the server.
<p style="margin-left: 5.0em; text-indent: -5.0em">ClassifyOverride Yes
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">ClassifyOverride No
<br>
<br>
Specifies whether to allow users to override the classification
of individual print jobs.
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultAuthType Basic
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultAuthType BasicDigest
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultAuthType Digest
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultAuthType Negotiate
<br>
<br>
Specifies the default type of authentication to use.
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultEncryption Never
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultEncryption IfRequested
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultEncryption Required
<br>
<br>
Specifies the type of encryption to use for authenticated requests.
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultLanguage locale
<br>
<br>
Specifies the default language to use for text and web content.
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultPaperSize Auto
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultPaperSize None
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultPaperSize sizename
<br>
<br>
Specifies the default paper size for new print queues. "Auto" uses a locale-
specific default, while "None" specifies there is no default paper size.
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultPolicy policy-name
<br>
<br>
Specifies the default access policy to use.
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultShared Yes
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultShared No
<br>
<br>
Specifies whether local printers are shared by default.
<p style="margin-left: 5.0em; text-indent: -5.0em">Deny all
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Deny none
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Deny host.domain.com
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Deny *.domain.com
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Deny ip-address
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Deny ip-address/netmask
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Deny ip-address/mm
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Deny @IF(name)
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Deny @LOCAL
<br>
<br>
Denies access to the named host or address.
<p style="margin-left: 5.0em; text-indent: -5.0em">DirtyCleanInterval seconds
<br>
<br>
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.
<p style="margin-left: 5.0em; text-indent: -5.0em">Encryption IfRequested
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Encryption Never
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Encryption Required
<br>
<br>
Specifies the level of encryption that is required for a particular
location.
<p style="margin-left: 5.0em; text-indent: -5.0em">FilterLimit limit
<br>
<br>
Specifies the maximum cost of filters that are run concurrently.
<p style="margin-left: 5.0em; text-indent: -5.0em">FilterNice nice-value
<br>
<br>
Specifies the scheduling priority ("nice" value) of filters that
are run to print a job.
<p style="margin-left: 5.0em; text-indent: -5.0em">GSSServiceName name
<br>
<br>
Specifies the service name when using Kerberos authentication. The default
service name is "http".
<p style="margin-left: 5.0em; text-indent: -5.0em">HostNameLookups On
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">HostNameLookups Off
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">HostNameLookups Double
<br>
<br>
Specifies whether or not to do reverse lookups on client addresses.
<p style="margin-left: 5.0em; text-indent: -5.0em">Include filename
<br>
<br>
Includes the named file.
<p style="margin-left: 5.0em; text-indent: -5.0em">JobKillDelay seconds
<br>
<br>
Specifies the number of seconds to wait before killing the filters and backend
associated with a canceled or held job.
<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateAccess all
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateAccess default
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
<br>
<br>
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.
<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateValues all
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateValues default
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateValues none
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
<br>
Specifies the list of job values to make private. The "default" values are
"job-name", "job-originating-host-name", and "job-originating-user-name".
<p style="margin-left: 5.0em; text-indent: -5.0em">JobRetryInterval seconds
<br>
<br>
Specifies the interval between retries of jobs in seconds.
<p style="margin-left: 5.0em; text-indent: -5.0em">JobRetryLimit count
<br>
<br>
Specifies the number of retries that are done for jobs.
<p style="margin-left: 5.0em; text-indent: -5.0em">KeepAlive Yes
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">KeepAlive No
<br>
<br>
Specifies whether to support HTTP keep-alive connections.
<p style="margin-left: 5.0em; text-indent: -5.0em">KeepAliveTimeout seconds
<br>
<br>
Specifies the amount of time that connections are kept alive.
<p style="margin-left: 5.0em; text-indent: -5.0em">&lt;Limit operations> ... &lt;/Limit>
<br>
<br>
Specifies the IPP operations that are being limited inside a policy.
<p style="margin-left: 5.0em; text-indent: -5.0em">&lt;Limit methods> ... &lt;/Limit>
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">&lt;LimitExcept methods> ... &lt;/LimitExcept>
<br>
<br>
Specifies the HTTP methods that are being limited inside a location.
<p style="margin-left: 5.0em; text-indent: -5.0em">LimitRequestBody
<br>
<br>
Specifies the maximum size of any print job request.
<p style="margin-left: 5.0em; text-indent: -5.0em">Listen ip-address:port
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Listen *:port
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Listen /path/to/domain/socket
<br>
<br>
Listens to the specified address and port or domain socket path.
<p style="margin-left: 5.0em; text-indent: -5.0em">&lt;Location /path> ... &lt;/Location>
<br>
<br>
Specifies access control for the named location.
<p style="margin-left: 5.0em; text-indent: -5.0em">LogDebugHistory #-messages
<br>
<br>
Specifies the number of debugging messages that are logged when an error
occurs in a print job.
<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel alert
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel crit
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel debug2
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel debug
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel emerg
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel error
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel info
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel none
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel notice
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel warn
<br>
<br>
Specifies the logging level for the ErrorLog file.
<p style="margin-left: 5.0em; text-indent: -5.0em">LogTimeFormat standard
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">LogTimeFormat usecs
<br>
<br>
Specifies the format of the date and time in the log files.
<p style="margin-left: 5.0em; text-indent: -5.0em">MaxClients number
<br>
<br>
Specifies the maximum number of simultaneous clients to support.
<p style="margin-left: 5.0em; text-indent: -5.0em">MaxClientsPerHost number
<br>
<br>
Specifies the maximum number of simultaneous clients to support from a
single address.
<p style="margin-left: 5.0em; text-indent: -5.0em">MaxCopies number
<br>
<br>
Specifies the maximum number of copies that a user can print of each job.
<p style="margin-left: 5.0em; text-indent: -5.0em">MaxHoldTime seconds
<br>
<br>
Specifies the maximum time a job may remain in the "indefinite" hold state
before it is canceled. Set to 0 to disable cancellation of held jobs.
<p style="margin-left: 5.0em; text-indent: -5.0em">MaxJobs number
<br>
<br>
Specifies the maximum number of simultaneous jobs to support.
<p style="margin-left: 5.0em; text-indent: -5.0em">MaxJobsPerPrinter number
<br>
<br>
Specifies the maximum number of simultaneous jobs per printer to support.
<p style="margin-left: 5.0em; text-indent: -5.0em">MaxJobsPerUser number
<br>
<br>
Specifies the maximum number of simultaneous jobs per user to support.
<p style="margin-left: 5.0em; text-indent: -5.0em">MaxJobTime seconds
<br>
<br>
Specifies the maximum time a job may take to print before it is canceled. The
default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck"
jobs.
<p style="margin-left: 5.0em; text-indent: -5.0em">MaxLogSize number-bytes
<br>
<br>
Specifies the maximum size of the log files before they are
rotated (0 to disable rotation)
<p style="margin-left: 5.0em; text-indent: -5.0em">MaxRequestSize number-bytes
<br>
<br>
Specifies the maximum request/file size in bytes (0 for no limit)
<p style="margin-left: 5.0em; text-indent: -5.0em">MultipleOperationTimeout seconds
<br>
<br>
Specifies the maximum amount of time to allow between files in a multiple file
print job.
<p style="margin-left: 5.0em; text-indent: -5.0em">Order allow,deny
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Order deny,allow
<br>
<br>
Specifies the order of HTTP access control (allow,deny or deny,allow)
<p style="margin-left: 5.0em; text-indent: -5.0em">PageLogFormat format string
<br>
<br>
Specifies the format of page log lines.
<p style="margin-left: 5.0em; text-indent: -5.0em">PassEnv variable [... variable]
<br>
<br>
Passes the specified environment variable(s) to child processes.
<p style="margin-left: 5.0em; text-indent: -5.0em">&lt;Policy name> ... &lt;/Policy>
<br>
<br>
Specifies access control for the named policy.
<p style="margin-left: 5.0em; text-indent: -5.0em">Port number
<br>
<br>
Specifies a port number to listen to for HTTP requests.
<p style="margin-left: 5.0em; text-indent: -5.0em">PreserveJobFiles Yes
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">PreserveJobFiles No
<br>
<br>
Specifies whether or not to preserve job files after they are printed.
<p style="margin-left: 5.0em; text-indent: -5.0em">PreserveJobHistory Yes
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">PreserveJobHistory No
<br>
<br>
Specifies whether or not to preserve the job history after they are
printed.
<p style="margin-left: 5.0em; text-indent: -5.0em">PrintcapFormat bsd
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">PrintcapFormat plist
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">PrintcapFormat solaris
<br>
<br>
Specifies the format of the printcap file.
<p style="margin-left: 5.0em; text-indent: -5.0em">ReloadTimeout seconds
<br>
<br>
Specifies the amount of time to wait for job completion before
restarting the scheduler.
<p style="margin-left: 5.0em; text-indent: -5.0em">Require group group-name-list
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Require user user-name-list
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Require valid-user
<br>
<br>
Specifies that user or group authentication is required.
<p style="margin-left: 5.0em; text-indent: -5.0em">RIPCache bytes
<br>
<br>
Specifies the maximum amount of memory to use when converting images
and PostScript files to bitmaps for a printer.
<p style="margin-left: 5.0em; text-indent: -5.0em">Satisfy all
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Satisfy any
<br>
<br>
Specifies whether all or any limits set for a Location must be
satisfied to allow access.
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerAdmin user@domain.com
<br>
<br>
Specifies the email address of the server administrator.
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerAlias hostname [... hostname]
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerAlias *
<br>
<br>
Specifies an alternate name that the server is known by. The special name "*"
allows any name to be used.
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerName hostname-or-ip-address
<br>
<br>
Specifies the fully-qualified hostname of the server.
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens Full
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens Major
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens Minimal
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens Minor
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens None
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens OS
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens ProductOnly
<br>
<br>
Specifies what information is included in the Server header of HTTP
responses.
<p style="margin-left: 5.0em; text-indent: -5.0em">SetEnv variable value
<br>
<br>
Set the specified environment variable to be passed to child processes.
<p style="margin-left: 5.0em; text-indent: -5.0em">SSLListen
<br>
<br>
Listens on the specified address and port for encrypted connections.
<p style="margin-left: 5.0em; text-indent: -5.0em">SSLPort
<br>
<br>
Listens on the specified port for encrypted connections.
<p style="margin-left: 5.0em; text-indent: -5.0em">StrictConformance Yes
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">StrictConformance No
<br>
<br>
Specifies whether the scheduler requires clients to strictly adhere to the IPP
specifications. The default is No.
<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateAccess all
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateAccess default
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
<br>
<br>
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.
<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateValues all
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateValues default
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateValues none
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
<br>
Specifies the list of job values to make private. The "default" values are
"notify-events", "notify-pull-method", "notify-recipient-uri",
"notify-subscriber-user-name", and "notify-user-data".
<p style="margin-left: 5.0em; text-indent: -5.0em">Timeout seconds
<br>
<br>
Specifies the HTTP request timeout in seconds.
<p style="margin-left: 5.0em; text-indent: -5.0em">WebInterface yes
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">WebInterface no
<br>
Specifies whether the web interface is enabled.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>classes.conf(5)</i>, <i>cups-files.conf(5)</i>, <i>cupsd(8)</i>,
<i>mime.convs(5)</i>, <i>mime.types(5)</i>, <i>printers.conf(5)</i>,
<i>subscriptions.conf(5)</i>,
<br>
<a href="http://localhost:631/help">http://localhost:631/help</a>
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright 2007-2013 by Apple Inc.

</body>
</html>