Scroll to navigation

cupsd.conf(5) Apple Inc. cupsd.conf(5)

NAME

cupsd.conf - server configuration file for cups

DESCRIPTION

The cupsd.conf file configures the CUPS scheduler, cupsd(8). It is normally located in the /etc/cups directory.

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.

DIRECTIVES

The following directives are understood by cupsd(8). Consult the on-line help for detailed descriptions:


Defines the access log filename.

Specifies the logging level for the AccessLog file.

Allows access from the named hosts or addresses.

Specifies the authentication class (User, Group, System) - this directive is deprecated.

Specifies the authentication group - this directive is deprecated.

Specifies the authentication type (None, Basic, BasicDigest, Digest, Negotiate)

Specifies whether to purge job history data automatically when it is no longer required for quotas.

Specifies a broadcast address for outgoing printer information packets.

Allows incoming printer information packets from the named host or address.

Denies incoming printer information packets from the named host or address.

Specifies the maximum interval between printer information broadcasts.

Specifies the LDAP domain name to use when registering printers.

Specifies the SSL certificate authority file to use.

Specifies the LDAP domain name to use when discovering printers.

Specifies the password to use when accessing the LDAP server.

Specifies the LDAP server to use.

Specifies the order of printer information access control (allow,deny or deny,allow)

Specifies a server to poll for printer information.

Specifies the port to listen to for printer information packets.

Specifies the protocols to use for printer browsing.

Specifies the protocols to use for local printer browsing.

Specifies the protocols to use for remote printer browsing.

Specifies that printer information packets should be relayed from one host or network to another.

Specifies whether remote printers will use short names ("printer") or not ("printer@server"). This option is ignored if more than one remote printer exists with the same name.

Specifies the maximum interval between printer information updates before remote printers will be removed from the list of available printers.

Specifies whether the CUPS web interface is advertised via DNS-SD.

Specifies whether or not remote printer browsing should be enabled.

Specifies the security classification of the server.

Specifies whether to allow users to override the classification of individual print jobs.

Specifies the permissions for all configuration files that the scheduler writes.

Specifies the degree of restriction for changes to cupsd.conf. Keywords dealing with filenames, paths, and users are security-sensitive. Changes to them via HTTP are forbidden by default ("all"). The value "none" removes any restriction altogether (note that this is unsafe). The value "root-only" allows only users authorised as user "root" to adjust security-sensitive configuration settings, but note that users adjusting settings using polkit (via cups-pk-helper) are authenticated as user "root".

Specified the directory where data files can be found.

Specifies the default type of authentication to use.

Specifies the default character set to use for text.

Specifies the type of encryption to use for authenticated requests.

Specifies the default language to use for text and web content.

Specifies the default paper size for new print queues. "Auto" uses a locale- specific default, while "None" specifies there is no default paper size.

Specifies the default access policy to use.

Specifies whether local printers are shared by default.

Denies access to the named host or address.

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.

Specifies the root directory for the internal web server documents.

Specifies the level of encryption that is required for a particular location.

Specifies the error log filename.

Specifies which errors are fatal, causing the scheduler to exit. "Kind" is "browse", "config", "listen", "log", or "permissions".

Specifies whether the file pseudo-device can be used for new printer queues.
Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer.
Specifies that a failed print job should be retried at a later time unless otherwise specified for the printer.
Specifies that a failed print job should be retried immediately unless otherwise specified for the printer.
Specifies that a failed print job should stop the printer unless otherwise specified for the printer. The 'stop-printer' error policy is the default.

Specifies the maximum cost of filters that are run concurrently.

Specifies the scheduling priority ("nice" value) of filters that are run to print a job.

Specifies the search path for fonts.

Specifies the group name or ID that will be used when executing external programs.

Specifies whether to hide members of implicit classes.

Specifies whether or not to do reverse lookups on client addresses.

Specifies whether or not to create implicit classes for local and remote printers, e.g. "AnyPrinter" from "Printer", "Printer@server1", and "Printer@server2".

Specifies whether or not to create implicit classes from identical remote printers.

Includes the named file.

Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.

Specifies the interval between retries of jobs in seconds.

Specifies the number of retries that are done for jobs.

Specifies whether to support HTTP keep-alive connections.

Specifies the amount of time that connections are kept alive.
<Limit operations> ... </Limit>

Specifies the IPP operations that are being limited inside a policy.
<Limit methods> ... </Limit>
<LimitExcept methods> ... </LimitExcept>

Specifies the HTTP methods that are being limited inside a location.

Specifies the maximum size of any print job request.

Listens to the specified address and port or domain socket path.
<Location /path> ... </Location>

Specifies access control for the named location.

Specifies the number of debugging messages that are logged when an error occurs in a print job.

Specifies the permissions for all log files that the scheduler writes.

Specifies the logging level for the ErrorLog file.

Specifies the format of the date and time in the log files.

Specifies the maximum number of simultaneous clients to support.

Specifies the maximum number of simultaneous clients to support from a single address.

Specifies the maximum number of copies that a user can print of each job.

Specifies the maximum number of simultaneous jobs to support.

Specifies the maximum number of simultaneous jobs per printer to support.

Specifies the maximum number of simultaneous jobs per user to support.

Specifies the maximum size of the log files before they are rotated (0 to disable rotation)

Specifies the maximum request/file size in bytes (0 for no limit)

Specifies the maximum amount of time to allow between files in a multiple file print job.

Specifies the order of HTTP access control (allow,deny or deny,allow)

Specifies the page log filename.

Specifies the format of page log lines.

Passes the specified environment variable(s) to child processes.
<Policy name> ... </Policy>

Specifies access control for the named policy.

Specifies a port number to listen to for HTTP requests.

Specifies whether or not to preserve job files after they are printed.

Specifies whether or not to preserve the job history after they are printed.
Printcap filename

Specifies the filename for a printcap file that is updated automatically with a list of available printers (needed for legacy applications); specifying Printcap with no filename disables printcap generation.

Specifies the format of the printcap file.
PrintcapGUI gui-program-filename

Specifies whether to generate option panel definition files on some operating systems. When provided with no program filename, disables option panel definition files.

Specifies the amount of time to wait for job completion before restarting the scheduler.

Specifies the username that is associated with unauthenticated root accesses.

Specifies the directory to store print jobs and other HTTP request data.

Specifies that user or group authentication is required.

Specifies the maximum amount of memory to use when converting images and PostScript files to bitmaps for a printer.

Specifies whether all or any limits set for a Location must be satisfied to allow access.

Specifies the email address of the server administrator.

Specifies an alternate name that the server is known by. The special name "*" allows any name to be used.

Specifies the directory where backends, CGIs, daemons, and filters may be found.

Specifies the encryption certificate to use.

Specifies the encryption key to use.

Specifies the fully-qualified hostname of the server.

Specifies the directory where the server configuration files can be found.

Specifies what information is included in the Server header of HTTP responses.

Set the specified environment variable to be passed to child processes.

Listens on the specified address and port for encrypted connections.

Sets SSL/TLS protocol options for encrypted connections. By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites. The NoEmptyFragments option allows CUPS to work with Microsoft Windows with the FIPS conformance mode enabled. The AllowRC4 option enables the 128-bit RC4 cipher suites, which are required for some older clients that do not implement newer ones. The AllowSSL3 option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.

Listens on the specified port for encrypted connections.
Specifies whether the scheduler calls fsync(2) after writing configuration state files. The default is Yes.

Specifies the group(s) to use for System class authentication.

Specifies the directory where temporary files are stored.

Specifies the HTTP request timeout in seconds.

Specifies the user name or ID that is used when running external programs.

SEE ALSO

classes.conf(5), cupsd(8), mime.convs(5), mime.types(5), printers.conf(5), subscriptions.conf(5),
http://localhost:631/help

COPYRIGHT

Copyright 2007-2009 by Apple Inc.

CUPS 14 July 2009