4 .\" cupsd.conf man page for CUPS.
6 .\" Copyright 2007-2013 by Apple Inc.
7 .\" Copyright 1997-2006 by Easy Software Products.
9 .\" These coded instructions, statements, and computer programs are the
10 .\" property of Apple Inc. and are protected by Federal copyright
11 .\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 .\" which should have been included with this file. If this file is
13 .\" file is missing or damaged, see the license at "http://www.cups.org/".
15 .TH cupsd.conf 5 "CUPS" "8 July 2013" "Apple Inc."
17 cupsd.conf \- server configuration file for cups
19 The \fIcupsd.conf\fR file configures the CUPS scheduler, \fIcupsd(8)\fR. It
20 is normally located in the \fI/etc/cups\fR directory. \fBNote:\fR
21 File, directory, and user configuration directives that used to be allowed in
22 the \fIcupsd.conf\fR file are now stored in the \fIcups-files.conf(5)\fR instead
23 in order to prevent certain types of privilege escalation attacks.
25 Each line in the file can be a configuration directive, a blank line,
26 or a comment. Comment lines start with the # character. The
27 configuration directives are intentionally similar to those used by the
28 popular Apache web server software and are described below.
30 The following directives are understood by \fIcupsd(8)\fR. Consult the
31 on-line help for detailed descriptions:
35 AccessLogLevel actions
39 Specifies the logging level for the AccessLog file.
51 Allow ip-address/netmask
59 Allows access from the named hosts or addresses.
71 Specifies the authentication type (None, Basic, BasicDigest, Digest, Negotiate)
77 Specifies whether to purge job history data automatically when
78 it is no longer required for quotas.
80 BrowseLocalProtocols [All] [DNSSD]
82 Specifies the protocols to use for local printer sharing.
88 Specifies whether the CUPS web interface is advertised via DNS-SD.
94 Specifies whether or not shared printers should be advertised.
98 Specifies the security classification of the server.
104 Specifies whether to allow users to override the classification
105 of individual print jobs.
107 DefaultAuthType Basic
109 DefaultAuthType BasicDigest
111 DefaultAuthType Digest
113 DefaultAuthType Negotiate
115 Specifies the default type of authentication to use.
117 DefaultEncryption Never
119 DefaultEncryption IfRequested
121 DefaultEncryption Required
123 Specifies the type of encryption to use for authenticated requests.
125 DefaultLanguage locale
127 Specifies the default language to use for text and web content.
129 DefaultPaperSize Auto
131 DefaultPaperSize None
133 DefaultPaperSize sizename
135 Specifies the default paper size for new print queues. "Auto" uses a locale-
136 specific default, while "None" specifies there is no default paper size.
138 DefaultPolicy policy-name
140 Specifies the default access policy to use.
146 Specifies whether local printers are shared by default.
158 Deny ip-address/netmask
166 Denies access to the named host or address.
168 DirtyCleanInterval seconds
170 Specifies the delay for updating of configuration and state files. A value of 0
171 causes the update to happen as soon as possible, typically within a few
174 Encryption IfRequested
180 Specifies the level of encryption that is required for a particular
185 Specifies the maximum cost of filters that are run concurrently.
187 FilterNice nice-value
189 Specifies the scheduling priority ("nice" value) of filters that
190 are run to print a job.
194 Specifies the service name when using Kerberos authentication. The default
195 service name is "http".
201 HostNameLookups Double
203 Specifies whether or not to do reverse lookups on client addresses.
207 Includes the named file.
211 Specifies the number of seconds to wait before killing the filters and backend
212 associated with a canceled or held job.
216 JobPrivateAccess default
218 JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
220 Specifies an access list for a job's private values. The "default" access list
221 is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed
222 or requesting-user-name-denied values.
226 JobPrivateValues default
228 JobPrivateValues none
230 JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
231 Specifies the list of job values to make private. The "default" values are
232 "job-name", "job-originating-host-name", and "job-originating-user-name".
234 JobRetryInterval seconds
236 Specifies the interval between retries of jobs in seconds.
240 Specifies the number of retries that are done for jobs.
246 Specifies whether to support HTTP keep-alive connections.
248 KeepAliveTimeout seconds
250 Specifies the amount of time that connections are kept alive.
252 <Limit operations> ... </Limit>
254 Specifies the IPP operations that are being limited inside a policy.
256 <Limit methods> ... </Limit>
258 <LimitExcept methods> ... </LimitExcept>
260 Specifies the HTTP methods that are being limited inside a location.
264 Specifies the maximum size of any print job request.
266 Listen ip-address:port
270 Listen /path/to/domain/socket
272 Listens to the specified address and port or domain socket path.
274 <Location /path> ... </Location>
276 Specifies access control for the named location.
278 LogDebugHistory #-messages
280 Specifies the number of debugging messages that are logged when an error
281 occurs in a print job.
303 Specifies the logging level for the ErrorLog file.
305 LogTimeFormat standard
309 Specifies the format of the date and time in the log files.
313 Specifies the maximum number of simultaneous clients to support.
315 MaxClientsPerHost number
317 Specifies the maximum number of simultaneous clients to support from a
322 Specifies the maximum number of copies that a user can print of each job.
326 Specifies the maximum time a job may remain in the "indefinite" hold state
327 before it is canceled. Set to 0 to disable cancellation of held jobs.
331 Specifies the maximum number of simultaneous jobs to support.
333 MaxJobsPerPrinter number
335 Specifies the maximum number of simultaneous jobs per printer to support.
337 MaxJobsPerUser number
339 Specifies the maximum number of simultaneous jobs per user to support.
343 Specifies the maximum time a job may take to print before it is canceled. The
344 default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck"
347 MaxLogSize number-bytes
349 Specifies the maximum size of the log files before they are
350 rotated (0 to disable rotation)
352 MaxRequestSize number-bytes
354 Specifies the maximum request/file size in bytes (0 for no limit)
356 MultipleOperationTimeout seconds
358 Specifies the maximum amount of time to allow between files in a multiple file
365 Specifies the order of HTTP access control (allow,deny or deny,allow)
367 PageLogFormat format string
369 Specifies the format of page log lines.
371 PassEnv variable [... variable]
373 Passes the specified environment variable(s) to child processes.
375 <Policy name> ... </Policy>
377 Specifies access control for the named policy.
381 Specifies a port number to listen to for HTTP requests.
387 Specifies whether or not to preserve job files after they are printed.
389 PreserveJobHistory Yes
391 PreserveJobHistory No
393 Specifies whether or not to preserve the job history after they are
400 PrintcapFormat solaris
402 Specifies the format of the printcap file.
404 ReloadTimeout seconds
406 Specifies the amount of time to wait for job completion before
407 restarting the scheduler.
409 Require group group-name-list
411 Require user user-name-list
415 Specifies that user or group authentication is required.
419 Specifies the maximum amount of memory to use when converting images
420 and PostScript files to bitmaps for a printer.
426 Specifies whether all or any limits set for a Location must be
427 satisfied to allow access.
429 ServerAdmin user@domain.com
431 Specifies the email address of the server administrator.
433 ServerAlias hostname [... hostname]
437 Specifies an alternate name that the server is known by. The special name "*"
438 allows any name to be used.
440 ServerName hostname-or-ip-address
442 Specifies the fully-qualified hostname of the server.
456 ServerTokens ProductOnly
458 Specifies what information is included in the Server header of HTTP
461 SetEnv variable value
463 Set the specified environment variable to be passed to child processes.
467 Listens on the specified address and port for encrypted connections.
471 SSLOptions NoEmptyFragments
473 Sets SSL/TLS protocol options for encrypted connections.
477 Listens on the specified port for encrypted connections.
479 StrictConformance Yes
483 Specifies whether the scheduler requires clients to strictly adhere to the IPP
484 specifications. The default is No.
486 SubscriptionPrivateAccess all
488 SubscriptionPrivateAccess default
490 SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
492 Specifies an access list for a subscription's private values. The "default"
493 access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
494 requesting-user-name-allowed or requesting-user-name-denied values.
496 SubscriptionPrivateValues all
498 SubscriptionPrivateValues default
500 SubscriptionPrivateValues none
502 SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
503 Specifies the list of job values to make private. The "default" values are
504 "notify-events", "notify-pull-method", "notify-recipient-uri",
505 "notify-subscriber-user-name", and "notify-user-data".
509 Specifies the HTTP request timeout in seconds.
514 Specifies whether the web interface is enabled.
516 \fIclasses.conf(5)\fR, \fIcups-files.conf(5)\fR, \fIcupsd(8)\fR,
517 \fImime.convs(5)\fR, \fImime.types(5)\fR, \fIprinters.conf(5)\fR,
518 \fIsubscriptions.conf(5)\fR,
520 http://localhost:631/help
522 Copyright 2007-2013 by Apple Inc.