.\"
-.\" "$Id$"
-.\"
.\" cupsd.conf man page for CUPS.
.\"
-.\" Copyright 2007-2014 by Apple Inc.
-.\" Copyright 1997-2006 by Easy Software Products.
+.\" Copyright © 2007-2018 by Apple Inc.
+.\" Copyright © 1997-2006 by Easy Software Products.
.\"
.\" These coded instructions, statements, and computer programs are the
.\" property of Apple Inc. and are protected by Federal copyright
.\" which should have been included with this file. If this file is
.\" file is missing or damaged, see the license at "http://www.cups.org/".
.\"
-.TH cupsd.conf 5 "CUPS" "11 June 2014" "Apple Inc."
+.TH cupsd.conf 5 "CUPS" "24 April 2018" "Apple Inc."
.SH NAME
cupsd.conf \- server configuration file for cups
.SH DESCRIPTION
.SS TOP-LEVEL DIRECTIVES
The following top-level directives are understood by
.BR cupsd (8):
+.\"#AccessLogLevel
.TP 5
\fBAccessLogLevel config\fR
.TP 5
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".
+.\"#AutoPurgeJobs
.TP 5
\fBAutoPurgeJobs Yes\fR
.TP 5
.br
Specifies whether to purge job history data automatically when it is no longer required for quotas.
The default is "No".
+.\"#BrowseLocalProtocols
.TP 5
\fBBrowseLocalProtocols all\fR
.TP 5
\fBBrowseLocalProtocols none\fR
Specifies which protocols to use for local printer sharing.
The default is "dnssd" on systems that support Bonjour and "none" otherwise.
+.\"#BrowseWebIF
.TP 5
\fBBrowseWebIF Yes\fR
.TP 5
.br
Specifies whether the CUPS web interface is advertised.
The default is "No".
+.\"#Browsing
.TP 5
\fBBrowsing Yes\fR
.TP 5
.br
Specifies whether shared printers are advertised.
The default is "No".
-.TP 5
-\fBClassification \fIbanner\fR
-.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.
-.TP 5
-\fBClassifyOverride Yes\fR
-.TP 5
-\fBClassifyOverride No\fR
-.br
-Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option.
-The default is "No".
+.\"#DefaultAuthType
.TP 5
\fBDefaultAuthType Basic\fR
.TP 5
.br
Specifies the default type of authentication to use.
The default is "Basic".
+.\"#DefaultEncryption
.TP 5
\fBDefaultEncryption Never\fR
.TP 5
\fBDefaultEncryption Required\fR
Specifies whether encryption will be used for authenticated requests.
The default is "Required".
+.\"#DefaultLanguage
.TP 5
\fBDefaultLanguage \fIlocale\fR
Specifies the default language to use for text and web content.
The default is "en".
+.\"#DefaultPaperSize
.TP 5
\fBDefaultPaperSize Auto\fR
.TP 5
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".
+.\"#DefaultPolicy
.TP 5
\fBDefaultPolicy \fIpolicy-name\fR
Specifies the default access policy to use.
The default access policy is "default".
+.\"#DefaultShared
.TP 5
\fBDefaultShared Yes\fR
.TP 5
\fBDefaultShared No\fR
Specifies whether local printers are shared by default.
The default is "Yes".
+.\"#DirtyCleanInterval
.TP 5
\fBDirtyCleanInterval \fIseconds\fR
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".
+.\"#ErrorPolicy
+.TP 5
+\fBErrorPolicy abort-job\fR
+Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer.
+.TP 5
+\fBErrorPolicy retry-current-job\fR
+Specifies that a failed print job should be retried immediately unless otherwise specified for the printer.
+.TP 5
+\fBErrorPolicy retry-job\fR
+Specifies that a failed print job should be retried at a later time unless otherwise specified for the printer.
+.TP 5
+\fBErrorPolicy stop-printer\fR
+Specifies that a failed print job should stop the printer unless otherwise specified for the printer. The 'stop-printer' error policy is the default.
+.\"#FilterLimit
.TP 5
\fBFilterLimit \fIlimit\fR
Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems.
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".
+.\"#FilterNice
.TP 5
\fBFilterNice \fInice-value\fR
Specifies the scheduling priority (
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.
+.\"#GSSServiceName
.TP 5
\fBGSSServiceName \fIname\fR
Specifies the service name when using Kerberos authentication.
The default service name is "http."
.TP 5
+.\"#HostNameLookups
\fBHostNameLookups On\fR
.TP 5
\fBHostNameLookups Off\fR
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.
+.\"#IdleExitTimeout
+.TP 5
+\fBIdleExitTimeout \fIseconds\fR
+Specifies the length of time to wait before shutting down due to inactivity.
+The default is "60" seconds.
+Note: Only applicable when
+.BR cupsd (8)
+is run on-demand (e.g., with \fB-l\fR).
+.\"#JobKillDelay
.TP 5
\fBJobKillDelay \fIseconds\fR
Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.
The default is "30".
+.\"#JobRetryInterval
.TP 5
\fBJobRetryInterval \fIseconds\fR
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".
+.\"#JobRetryLimit
.TP 5
\fBJobRetryLimit \fIcount\fR
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".
+.\"#KeepAlive
.TP 5
\fBKeepAlive Yes\fR
.TP 5
\fBKeepAlive No\fR
Specifies whether to support HTTP keep-alive connections.
The default is "Yes".
+.\"#KeepAliveTimeout
.TP 5
\fBKeepAliveTimeout \fIseconds\fR
Specifies how long an idle client connection remains open.
The default is "30".
+.\"#LimitIPP
.TP 5
\fB<Limit \fIoperation \fR...\fB> \fR... \fB</Limit>\fR
-Specifies the IPP operations that are being limited inside a Policy section. IPP operation names are listed below in the section "IPP OPERATIONS".
+Specifies the IPP operations that are being limited inside a Policy section. IPP operation names are listed below in the section "IPP OPERATION NAMES".
+.\"#Limit
.TP 5
\fB<Limit \fImethod \fR...\fB> \fR... \fB</Limit>\fR
+.\"#LimitExcept
.TP 5
\fB<LimitExcept \fImethod \fR...\fB> \fR... \fB</LimitExcept>\fR
-Specifies the HTTP methods that are being limited inside a Location section. HTTP method names are listed below in the section "HTTP METHODS".
+Specifies the HTTP methods that are being limited inside a Location section. HTTP method names are listed below in the section "HTTP METHOD NAMES".
+.\"#LimitRequestBody
.TP 5
\fBLimitRequestBody \fIsize\fR
Specifies the maximum size of print files, IPP requests, and HTML form data.
The default is "0" which disables the limit check.
+.\"#Listen
.TP 5
\fBListen \fIipv4-address\fB:\fIport\fR
.TP 5
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.
+.\"#ListenBackLog
.TP 5
\fBListenBackLog \fInumber\fR
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.
+.\"#Location
.TP 5
\fB<Location \fI/path\fB> \fR... \fB</Location>\fR
Specifies access control for the named location.
Paths are documented below in the section "LOCATION PATHS".
+.\"#LogDebugHistory
.TP 5
\fBLogDebugHistory \fInumber\fR
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.
+.\"#LogLevel
.TP 5
\fBLogLevel \fRnone
.TP 5
Specifies the level of logging for the ErrorLog file.
The value "none" stops all logging while "debug2" logs everything.
The default is "warn".
+.\"#LogTimeFormat
.TP 5
\fBLogTimeFormat \fRstandard
.TP 5
\fBLogTimeFormat \fRusecs
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.
+.\"#MaxClients
.TP 5
\fBMaxClients \fInumber\fR
Specifies the maximum number of simultaneous clients that are allowed by the scheduler.
The default is "100".
+.\"#MaxClientPerHost
.TP 5
\fBMaxClientsPerHost \fInumber\fR
Specifies the maximum number of simultaneous clients that are allowed from a
single address.
The default is the MaxClients value.
+.\"#MaxCopies
.TP 5
\fBMaxCopies \fInumber\fR
Specifies the maximum number of copies that a user can print of each job.
The default is "9999".
+.\"#MaxHoldTime
.TP 5
\fBMaxHoldTime \fIseconds\fR
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.
+.\"#MaxJobs
.TP 5
\fBMaxJobs \fInumber\fR
Specifies the maximum number of simultaneous jobs that are allowed.
Set to "0" to allow an unlimited number of jobs.
The default is "500".
+.\"#MaxJobsPerPrinter
.TP 5
\fBMaxJobsPerPrinter \fInumber\fR
Specifies the maximum number of simultaneous jobs that are allowed per printer.
The default is "0" which allows up to MaxJobs jobs per printer.
+.\"#MaxJobsPerUser
.TP 5
\fBMaxJobsPerUser \fInumber\fR
Specifies the maximum number of simultaneous jobs that are allowed per user.
The default is "0" which allows up to MaxJobs jobs per user.
+.\"#MaxJobTime
.TP 5
\fBMaxJobTime \fIseconds\fR
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).
+.\"#MaxLogSize
.TP 5
\fBMaxLogSize \fIsize\fR
Specifies the maximum size of the log files before they are rotated.
The value "0" disables log rotation.
The default is "1048576" (1MB).
+.\"#MultipleOperationTimeout
.TP 5
\fBMultipleOperationTimeout \fIseconds\fR
Specifies the maximum amount of time to allow between files in a multiple file print job.
The default is "300" (5 minutes).
-.TP 5
-\fBPageLogFormat \fIformat-string\fR
-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:
-.nf
-
- "%%" 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.
-
-.fi
-The default is "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}".
+.\"#PassEnv
.TP 5
\fBPassEnv \fIvariable \fR[ ... \fIvariable \fR]
Passes the specified environment variable(s) to child processes.
+.\"#Policy
.TP 5
\fB<Policy \fIname\fB> \fR... \fB</Policy>\fR
Specifies access control for the named policy.
+.\"#Port
.TP 5
\fBPort \fInumber\fR
Listens to the specified port number for connections.
+.\"#PreserveJobFiles
.TP 5
\fBPreserveJobFiles Yes\fR
.TP 5
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).
+.\"#PreserveJobHistory
.TP 5
\fBPreserveJobHistory Yes\fR
.TP 5
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".
+.\"#ReloadTimeout
.TP 5
\fBReloadTimeout \fIseconds\fR
Specifies the amount of time to wait for job completion before restarting the scheduler.
The default is "30".
-.TP 5
-\fBRIPCache \fIsize\fR
-Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.
-The default is "128m".
+.\"#ServerAdmin
.TP 5
\fBServerAdmin \fIemail-address\fR
Specifies the email address of the server administrator.
The default value is "root@ServerName".
+.\"#ServerAlias
.TP 5
\fBServerAlias \fIhostname \fR[ ... \fIhostname \fR]
.TP 5
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 "*".
+.\"#ServerName
.TP 5
\fBServerName \fIhostname\fR
Specifies the fully-qualified hostname of the server.
The default is the value reported by the
.BR hostname (1)
command.
+.\"#ServerTokens
.TP 5
\fBServerTokens None\fR
.TP 5
"Major" reports "CUPS 2".
"Minor" reports "CUPS 2.0".
"Minimal" reports "CUPS 2.0.0".
-"OS" reports "CUPS 2.0.0 (UNAME)" where UNAME is the output of the
+"OS" reports "CUPS 2.0.0 (UNAME)" where UNAME is the output of the
.BR uname (1)
command.
"Full" reports "CUPS 2.0.0 (UNAME) IPP/2.0".
The default is "Minimal".
+.\"#SetEnv
.TP 5
\fBSetEnv \fIvariable value\fR
Set the specified environment variable to be passed to child processes.
-.TP 5
+.\"#SSLListen
.TP 5
\fBSSLListen \fIipv4-address\fB:\fIport\fR
.TP 5
.TP 5
\fBSSLListen *:\fIport\fR
Listens on the specified address and port for encrypted connections.
+.\"#SSLOptions
+.TP 5
+\fBSSLOptions \fR[\fIAllowDH\fR] [\fIAllowRC4\fR] [\fIAllowSSL3\fR] [\fIDenyCBC\fR] [\fIDenyTLS1.0\fR]
+.TP 5
+\fBSSLOptions None\fR
+Sets encryption options.
+By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
+Security is reduced when \fIAllow\fR options are used.
+Security is enhanced when \fIDeny\fR options are used.
+The \fIAllowDH\fR option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS).
+The \fIAllowRC4\fR option enables the 128-bit RC4 cipher suites, which are required for some older clients.
+The \fIAllowSSL3\fR option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
+The \fIDenyCBC\fR option disables all CBC cipher suites.
+The \fIDenyTLS1.0\fR option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
+.\"#SSLPort
.TP 5
\fBSSLPort \fIport\fR
Listens on the specified port for encrypted connections.
+.\"#StrictConformance
.TP 5
\fBStrictConformance Yes\fR
.TP 5
\fBStrictConformance No\fR
Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications.
The default is "No".
+.\"#Timeout
.TP 5
\fBTimeout \fIseconds\fR
Specifies the HTTP request timeout.
The default is "300" (5 minutes).
+.\"#WebInterface
.TP 5
\fBWebInterface yes\fR
.TP 5
The path for all jobs (hold-job, release-job, etc.)
.TP 5
/jobs/id
-The path for the specified job.
+The path for the specified job
.TP 5
/printers
The path for all printers
.BR cups-files.conf (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.
.TP 5
\fBRequire valid-user\fR
Specifies that any authenticated user is acceptable.
\fBSubscriptionPrivateValues \fIattribute-name \fR[ ... \fIattribute-name \fR]
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".
+.SS DEPRECATED DIRECTIVES
+The following directives are deprecated and will be removed in a future release of CUPS:
+.\"#Classification
+.TP 5
+\fBClassification \fIbanner\fR
+.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.
+.\"#ClassifyOverride
+.TP 5
+\fBClassifyOverride Yes\fR
+.TP 5
+\fBClassifyOverride No\fR
+.br
+Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option.
+The default is "No".
+.\"#PageLogFormat
+.TP 5
+\fBPageLogFormat \fIformat-string\fR
+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:
+.nf
+
+ "%%" 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.
+
+.fi
+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.
+.\"#RIPCache
+.TP 5
+\fBRIPCache \fIsize\fR
+Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.
+The default is "128m".
.SH CONFORMING TO
The \fBcupsd.conf\fR file format is based on the Apache HTTP Server configuration file format.
.SH EXAMPLES
.BR subscriptions.conf (5),
CUPS Online Help (http://localhost:631/help)
.SH COPYRIGHT
-Copyright \[co] 2007-2014 by Apple Inc.
-.\"
-.\" End of "$Id$".
-.\"
+Copyright \[co] 2007-2018 by Apple Inc.
projects / thirdparty / cups.git / blobdiff