.\"
.\" "$Id$"
.\"
.\" cupsd.conf man page for CUPS.
.\"
.\" Copyright 2007-2014 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
.\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
.\" 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" "28 March 2014" "Apple Inc."
.SH NAME
cupsd.conf \- server configuration file for cups
.SH DESCRIPTION
The
.I cupsd.conf
file configures the CUPS scheduler,
.BR cupsd (8).
It is normally located in the \fI/etc/cups\fR directory. \fBNote:\fR File, directory, and user configuration directives that used to be allowed in the \fIcupsd.conf\fR file are now stored in the \fIcups-files.conf(5)\fR instead in order to prevent certain types of privilege escalation attacks.
.LP
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.
.SH TOP-LEVEL DIRECTIVES
The following directives are understood by
.B cupsd (8).
Consult the online help (http://localhost:631/help) for detailed descriptions:
.TP 5
AccessLogLevel config
.TP 5
AccessLogLevel actions
.TP 5
AccessLogLevel all
Specifies the logging level for the AccessLog file.
.TP 5
AutoPurgeJobs Yes
.TP 5
AutoPurgeJobs No
.br
Specifies whether to purge job history data automatically when
it is no longer required for quotas.
.TP 5
BrowseLocalProtocols [
.I All
] [
.I DNSSD
]
Specifies the protocols to use for local printer sharing.
.TP 5
BrowseWebIF Yes
.TP 5
BrowseWebIF No
.br
Specifies whether the CUPS web interface is advertised via DNS-SD.
.TP 5
Browsing Yes
.TP 5
Browsing No
.br
Specifies whether or not shared printers should be advertised.
.TP 5
Classification banner
.br
Specifies the security classification of the server.
.TP 5
ClassifyOverride Yes
.TP 5
ClassifyOverride No
.br
Specifies whether to allow users to override the classification
of individual print jobs.
.TP 5
DefaultAuthType Basic
.TP 5
DefaultAuthType Negotiate
.br
Specifies the default type of authentication to use.
.TP 5
DefaultEncryption Never
.TP 5
DefaultEncryption IfRequested
.TP 5
DefaultEncryption Required
Specifies the type of encryption to use for authenticated requests.
.TP 5
DefaultLanguage locale
Specifies the default language to use for text and web content.
.TP 5
DefaultPaperSize Auto
.TP 5
DefaultPaperSize None
.TP 5
DefaultPaperSize sizename
Specifies the default paper size for new print queues. "Auto" uses a locale-
specific default, while "None" specifies there is no default paper size.
.TP 5
DefaultPolicy policy-name
Specifies the default access policy to use.
.TP 5
DefaultShared Yes
.TP 5
DefaultShared No
Specifies whether local printers are shared by default.
.TP 5
DirtyCleanInterval seconds
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.
.TP 5
FilterLimit limit
Specifies the maximum cost of filters that are run concurrently.
.TP 5
FilterNice nice-value
Specifies the scheduling priority ("nice" value) of filters that
are run to print a job.
.TP 5
GSSServiceName name
Specifies the service name when using Kerberos authentication. The default
service name is "http".
.TP 5
HostNameLookups On
.TP 5
HostNameLookups Off
.TP 5
HostNameLookups Double
Specifies whether or not to do reverse lookups on client addresses.
.TP 5
Include filename
Includes the named file.
.TP 5
JobKillDelay seconds
Specifies the number of seconds to wait before killing the filters and backend
associated with a canceled or held job.
.TP 5
JobRetryInterval seconds
Specifies the interval between retries of jobs in seconds.
.TP 5
JobRetryLimit count
Specifies the number of retries that are done for jobs.
.TP 5
KeepAlive Yes
.TP 5
KeepAlive No
Specifies whether to support HTTP keep-alive connections.
.TP 5
KeepAliveTimeout seconds
Specifies the amount of time that connections are kept alive.
.TP 5
...
Specifies the IPP operations that are being limited inside a policy.
.TP 5
...
.TP 5
...
Specifies the HTTP methods that are being limited inside a location.
.TP 5
LimitRequestBody
Specifies the maximum size of any print job request.
.TP 5
Listen ip-address:port
.TP 5
Listen *:port
.TP 5
Listen /path/to/domain/socket
Listens to the specified address and port or domain socket path.
.TP 5
...
Specifies access control for the named location.
.TP 5
LogDebugHistory #-messages
Specifies the number of debugging messages that are logged when an error
occurs in a print job.
.TP 5
LogLevel alert
.TP 5
LogLevel crit
.TP 5
LogLevel debug2
.TP 5
LogLevel debug
.TP 5
LogLevel emerg
.TP 5
LogLevel error
.TP 5
LogLevel info
.TP 5
LogLevel none
.TP 5
LogLevel notice
.TP 5
LogLevel warn
Specifies the logging level for the ErrorLog file.
.TP 5
LogTimeFormat standard
.TP 5
LogTimeFormat usecs
Specifies the format of the date and time in the log files.
.TP 5
MaxClients number
Specifies the maximum number of simultaneous clients to support.
.TP 5
MaxClientsPerHost number
Specifies the maximum number of simultaneous clients to support from a
single address.
.TP 5
MaxCopies number
Specifies the maximum number of copies that a user can print of each job.
.TP 5
MaxHoldTime seconds
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.
.TP 5
MaxJobs number
Specifies the maximum number of simultaneous jobs to support.
.TP 5
MaxJobsPerPrinter number
Specifies the maximum number of simultaneous jobs per printer to support.
.TP 5
MaxJobsPerUser number
Specifies the maximum number of simultaneous jobs per user to support.
.TP 5
MaxJobTime seconds
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.
.TP 5
MaxLogSize number-bytes
Specifies the maximum size of the log files before they are
rotated (0 to disable rotation)
.TP 5
MaxRequestSize number-bytes
Specifies the maximum request/file size in bytes (0 for no limit)
.TP 5
MultipleOperationTimeout seconds
Specifies the maximum amount of time to allow between files in a multiple file
print job.
.TP 5
PageLogFormat format string
Specifies the format of page log lines.
.TP 5
PassEnv variable [... variable]
Passes the specified environment variable(s) to child processes.
.TP 5
...
Specifies access control for the named policy.
.TP 5
Port number
Specifies a port number to listen to for HTTP requests.
.TP 5
PreserveJobFiles Yes
.TP 5
PreserveJobFiles No
Specifies whether or not to preserve job files after they are printed.
.TP 5
PreserveJobHistory Yes
.TP 5
PreserveJobHistory No
Specifies whether or not to preserve the job history after they are
printed.
.TP 5
PrintcapFormat bsd
.TP 5
PrintcapFormat plist
.TP 5
PrintcapFormat solaris
Specifies the format of the printcap file.
.TP 5
ReloadTimeout seconds
Specifies the amount of time to wait for job completion before
restarting the scheduler.
.TP 5
RIPCache bytes
Specifies the maximum amount of memory to use when converting images
and PostScript files to bitmaps for a printer.
.TP 5
Satisfy all
.TP 5
Satisfy any
Specifies whether all or any limits set for a Location must be
satisfied to allow access.
.TP 5
ServerAdmin user@domain.com
Specifies the email address of the server administrator.
.TP 5
ServerAlias hostname [... hostname]
.TP 5
ServerAlias *
Specifies an alternate name that the server is known by. The special name "*"
allows any name to be used.
.TP 5
ServerName hostname-or-ip-address
Specifies the fully-qualified hostname of the server.
.TP 5
ServerTokens Full
.TP 5
ServerTokens Major
.TP 5
ServerTokens Minimal
.TP 5
ServerTokens Minor
.TP 5
ServerTokens None
.TP 5
ServerTokens OS
.TP 5
ServerTokens ProductOnly
Specifies what information is included in the Server header of HTTP
responses.
.TP 5
SetEnv variable value
Set the specified environment variable to be passed to child processes.
.TP 5
SSLListen
Listens on the specified address and port for encrypted connections.
.TP 5
SSLPort
Listens on the specified port for encrypted connections.
.TP 5
StrictConformance Yes
.TP 5
StrictConformance No
Specifies whether the scheduler requires clients to strictly adhere to the IPP
specifications. The default is No.
.TP 5
Timeout seconds
Specifies the HTTP request timeout in seconds.
.TP 5
WebInterface yes
.TP 5
WebInterface no
Specifies whether the web interface is enabled.
.SH DIRECTIVES VALID WITHIN LOCATION AND LIMIT SECTIONS
The following directives may be placed inside Location and Limit sections in the \fIcupsd.conf\fR file:
.TP 5
Allow all
.TP 5
Allow none
.TP 5
Allow host.domain.com
.TP 5
Allow *.domain.com
.TP 5
Allow ip-address
.TP 5
Allow ip-address/netmask
.TP 5
Allow ip-address/mm
.TP 5
Allow @IF(name)
.TP 5
Allow @LOCAL
Allows access from the named hosts or addresses.
.TP 5
AuthType None
.TP 5
AuthType Basic
.TP 5
AuthType Negotiate
Specifies the authentication type (None, Basic, or Negotiate)
.TP 5
Deny all
.TP 5
Deny none
.TP 5
Deny host.domain.com
.TP 5
Deny *.domain.com
.TP 5
Deny ip-address
.TP 5
Deny ip-address/netmask
.TP 5
Deny ip-address/mm
.TP 5
Deny @IF(name)
.TP 5
Deny @LOCAL
Denies access to the named host or address.
.TP 5
Encryption IfRequested
.TP 5
Encryption Never
.TP 5
Encryption Required
Specifies the level of encryption that is required for a particular
location.
.TP 5
Order allow,deny
.TP 5
Order deny,allow
Specifies the order of HTTP access control (allow,deny or deny,allow)
.TP 5
Require group group-name-list
.TP 5
Require user user-name-list
.TP 5
Require valid-user
Specifies that user or group authentication is required.
.SH DIRECTIVES VALID WITHIN POLICY SECTIONS
The following directives may be placed inside Policy sections in the \fIcupsd.conf\fR file:
.TP 5
JobPrivateAccess all
.TP 5
JobPrivateAccess default
.TP 5
JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
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.
.TP 5
JobPrivateValues all
.TP 5
JobPrivateValues default
.TP 5
JobPrivateValues none
.TP 5
JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
Specifies the list of job values to make private. The "default" values are "job-name", "job-originating-host-name", and "job-originating-user-name".
.TP 5
SubscriptionPrivateAccess all
.TP 5
SubscriptionPrivateAccess default
.TP 5
SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
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.
.TP 5
SubscriptionPrivateValues all
.TP 5
SubscriptionPrivateValues default
.TP 5
SubscriptionPrivateValues none
.TP 5
SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
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".
.SH SEE ALSO
.BR classes.conf (5), cups-files.conf (5), cupsd (8), mime.convs (5), mime.types (5), printers.conf (5), subscriptions.conf (5),
http://localhost:631/help
.SH COPYRIGHT
Copyright \[co] 2007-2014 by Apple Inc.
.\"
.\" End of "$Id$".
.\"