3 <!-- SECTION: Man Pages -->
5 <link rel=
"stylesheet" type=
"text/css" href=
"../cups-printable.css">
6 <title>cupsd.conf(
5)
</title>
9 <h1 class=
"title">cupsd.conf(
5)
</h1>
10 <h2 class=
"title"><a name=
"NAME">Name
</a></h2>
11 cupsd.conf - server configuration file for cups
12 <h2 class=
"title"><a name=
"DESCRIPTION">Description
</a></h2>
13 The
<i>cupsd.conf
</i> file configures the CUPS scheduler,
<i>cupsd(
8)
</i>. It
14 is normally located in the
<i>/etc/cups
</i> directory.
<b>Note:
</b>
15 File, directory, and user configuration directives that used to be allowed in
16 the
<i>cupsd.conf
</i> file are now stored in the
<i>cups-files.conf(
5)
</i> instead
17 in order to prevent certain types of privilege escalation attacks.
18 <p>Each line in the file can be a configuration directive, a blank line,
19 or a comment. Comment lines start with the # character. The
20 configuration directives are intentionally similar to those used by the
21 popular Apache web server software and are described below.
22 <h2 class=
"title"><a name=
"DIRECTIVES">Directives
</a></h2>
23 The following directives are understood by
<i>cupsd(
8)
</i>. Consult the
24 on-line help for detailed descriptions:
25 <p style=
"margin-left: 5.0em; text-indent: -5.0em">AccessLogLevel config
27 <p style=
"margin-left: 5.0em; text-indent: -5.0em">AccessLogLevel actions
29 <p style=
"margin-left: 5.0em; text-indent: -5.0em">AccessLogLevel all
32 Specifies the logging level for the AccessLog file.
33 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Allow all
35 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Allow none
37 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Allow host.domain.com
39 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Allow *.domain.com
41 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Allow ip-address
43 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Allow ip-address/netmask
45 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Allow ip-address/mm
47 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Allow @IF(name)
49 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Allow @LOCAL
52 Allows access from the named hosts or addresses.
53 <p style=
"margin-left: 5.0em; text-indent: -5.0em">AuthType None
55 <p style=
"margin-left: 5.0em; text-indent: -5.0em">AuthType Basic
57 <p style=
"margin-left: 5.0em; text-indent: -5.0em">AuthType BasicDigest
59 <p style=
"margin-left: 5.0em; text-indent: -5.0em">AuthType Digest
61 <p style=
"margin-left: 5.0em; text-indent: -5.0em">AuthType Negotiate
64 Specifies the authentication type (None, Basic, BasicDigest, Digest, Negotiate)
65 <p style=
"margin-left: 5.0em; text-indent: -5.0em">AutoPurgeJobs Yes
67 <p style=
"margin-left: 5.0em; text-indent: -5.0em">AutoPurgeJobs No
70 Specifies whether to purge job history data automatically when
71 it is no longer required for quotas.
72 <p style=
"margin-left: 5.0em; text-indent: -5.0em">BrowseLocalProtocols [All] [DNSSD]
75 Specifies the protocols to use for local printer sharing.
76 <p style=
"margin-left: 5.0em; text-indent: -5.0em">BrowseWebIF Yes
78 <p style=
"margin-left: 5.0em; text-indent: -5.0em">BrowseWebIF No
81 Specifies whether the CUPS web interface is advertised via DNS-SD.
82 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Browsing Yes
84 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Browsing No
87 Specifies whether or not shared printers should be advertised.
88 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Classification banner
91 Specifies the security classification of the server.
92 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ClassifyOverride Yes
94 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ClassifyOverride No
97 Specifies whether to allow users to override the classification
98 of individual print jobs.
99 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultAuthType Basic
101 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultAuthType BasicDigest
103 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultAuthType Digest
105 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultAuthType Negotiate
108 Specifies the default type of authentication to use.
109 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultEncryption Never
111 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultEncryption IfRequested
113 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultEncryption Required
116 Specifies the type of encryption to use for authenticated requests.
117 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultLanguage locale
120 Specifies the default language to use for text and web content.
121 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultPaperSize Auto
123 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultPaperSize None
125 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultPaperSize sizename
128 Specifies the default paper size for new print queues.
"Auto" uses a locale-
129 specific default, while
"None" specifies there is no default paper size.
130 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultPolicy policy-name
133 Specifies the default access policy to use.
134 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultShared Yes
136 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DefaultShared No
139 Specifies whether local printers are shared by default.
140 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Deny all
142 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Deny none
144 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Deny host.domain.com
146 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Deny *.domain.com
148 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Deny ip-address
150 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Deny ip-address/netmask
152 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Deny ip-address/mm
154 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Deny @IF(name)
156 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Deny @LOCAL
159 Denies access to the named host or address.
160 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DirtyCleanInterval seconds
163 Specifies the delay for updating of configuration and state files. A value of
0
164 causes the update to happen as soon as possible, typically within a few
166 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Encryption IfRequested
168 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Encryption Never
170 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Encryption Required
173 Specifies the level of encryption that is required for a particular
175 <p style=
"margin-left: 5.0em; text-indent: -5.0em">FilterLimit limit
178 Specifies the maximum cost of filters that are run concurrently.
179 <p style=
"margin-left: 5.0em; text-indent: -5.0em">FilterNice nice-value
182 Specifies the scheduling priority (
"nice" value) of filters that
183 are run to print a job.
184 <p style=
"margin-left: 5.0em; text-indent: -5.0em">GSSServiceName name
187 Specifies the service name when using Kerberos authentication. The default
188 service name is
"http".
189 <p style=
"margin-left: 5.0em; text-indent: -5.0em">HostNameLookups On
191 <p style=
"margin-left: 5.0em; text-indent: -5.0em">HostNameLookups Off
193 <p style=
"margin-left: 5.0em; text-indent: -5.0em">HostNameLookups Double
196 Specifies whether or not to do reverse lookups on client addresses.
197 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Include filename
200 Includes the named file.
201 <p style=
"margin-left: 5.0em; text-indent: -5.0em">JobKillDelay seconds
204 Specifies the number of seconds to wait before killing the filters and backend
205 associated with a canceled or held job.
206 <p style=
"margin-left: 5.0em; text-indent: -5.0em">JobPrivateAccess all
208 <p style=
"margin-left: 5.0em; text-indent: -5.0em">JobPrivateAccess default
210 <p style=
"margin-left: 5.0em; text-indent: -5.0em">JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
213 Specifies an access list for a job's private values. The
"default" access list
214 is
"@OWNER @SYSTEM".
"@ACL" maps to the printer's requesting-user-name-allowed
215 or requesting-user-name-denied values.
216 <p style=
"margin-left: 5.0em; text-indent: -5.0em">JobPrivateValues all
218 <p style=
"margin-left: 5.0em; text-indent: -5.0em">JobPrivateValues default
220 <p style=
"margin-left: 5.0em; text-indent: -5.0em">JobPrivateValues none
222 <p style=
"margin-left: 5.0em; text-indent: -5.0em">JobPrivateValues attribute-name-
1 [ ... attribute-name-N ]
224 Specifies the list of job values to make private. The
"default" values are
225 "job-name",
"job-originating-host-name", and
"job-originating-user-name".
226 <p style=
"margin-left: 5.0em; text-indent: -5.0em">JobRetryInterval seconds
229 Specifies the interval between retries of jobs in seconds.
230 <p style=
"margin-left: 5.0em; text-indent: -5.0em">JobRetryLimit count
233 Specifies the number of retries that are done for jobs.
234 <p style=
"margin-left: 5.0em; text-indent: -5.0em">KeepAlive Yes
236 <p style=
"margin-left: 5.0em; text-indent: -5.0em">KeepAlive No
239 Specifies whether to support HTTP keep-alive connections.
240 <p style=
"margin-left: 5.0em; text-indent: -5.0em">KeepAliveTimeout seconds
243 Specifies the amount of time that connections are kept alive.
244 <p style=
"margin-left: 5.0em; text-indent: -5.0em"><Limit operations
> ...
</Limit
>
247 Specifies the IPP operations that are being limited inside a policy.
248 <p style=
"margin-left: 5.0em; text-indent: -5.0em"><Limit methods
> ...
</Limit
>
250 <p style=
"margin-left: 5.0em; text-indent: -5.0em"><LimitExcept methods
> ...
</LimitExcept
>
253 Specifies the HTTP methods that are being limited inside a location.
254 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LimitRequestBody
257 Specifies the maximum size of any print job request.
258 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Listen ip-address:port
260 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Listen *:port
262 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Listen /path/to/domain/socket
265 Listens to the specified address and port or domain socket path.
266 <p style=
"margin-left: 5.0em; text-indent: -5.0em"><Location /path
> ...
</Location
>
269 Specifies access control for the named location.
270 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogDebugHistory #-messages
273 Specifies the number of debugging messages that are logged when an error
274 occurs in a print job.
275 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogLevel alert
277 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogLevel crit
279 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogLevel debug2
281 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogLevel debug
283 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogLevel emerg
285 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogLevel error
287 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogLevel info
289 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogLevel none
291 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogLevel notice
293 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogLevel warn
296 Specifies the logging level for the ErrorLog file.
297 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogTimeFormat standard
299 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LogTimeFormat usecs
302 Specifies the format of the date and time in the log files.
303 <p style=
"margin-left: 5.0em; text-indent: -5.0em">MaxClients number
306 Specifies the maximum number of simultaneous clients to support.
307 <p style=
"margin-left: 5.0em; text-indent: -5.0em">MaxClientsPerHost number
310 Specifies the maximum number of simultaneous clients to support from a
312 <p style=
"margin-left: 5.0em; text-indent: -5.0em">MaxCopies number
315 Specifies the maximum number of copies that a user can print of each job.
316 <p style=
"margin-left: 5.0em; text-indent: -5.0em">MaxHoldTime seconds
319 Specifies the maximum time a job may remain in the
"indefinite" hold state
320 before it is canceled. Set to
0 to disable cancellation of held jobs.
321 <p style=
"margin-left: 5.0em; text-indent: -5.0em">MaxJobs number
324 Specifies the maximum number of simultaneous jobs to support.
325 <p style=
"margin-left: 5.0em; text-indent: -5.0em">MaxJobsPerPrinter number
328 Specifies the maximum number of simultaneous jobs per printer to support.
329 <p style=
"margin-left: 5.0em; text-indent: -5.0em">MaxJobsPerUser number
332 Specifies the maximum number of simultaneous jobs per user to support.
333 <p style=
"margin-left: 5.0em; text-indent: -5.0em">MaxJobTime seconds
336 Specifies the maximum time a job may take to print before it is canceled. The
337 default is
10800 seconds (
3 hours). Set to
0 to disable cancellation of
"stuck"
339 <p style=
"margin-left: 5.0em; text-indent: -5.0em">MaxLogSize number-bytes
342 Specifies the maximum size of the log files before they are
343 rotated (
0 to disable rotation)
344 <p style=
"margin-left: 5.0em; text-indent: -5.0em">MaxRequestSize number-bytes
347 Specifies the maximum request/file size in bytes (
0 for no limit)
348 <p style=
"margin-left: 5.0em; text-indent: -5.0em">MultipleOperationTimeout seconds
351 Specifies the maximum amount of time to allow between files in a multiple file
353 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Order allow,deny
355 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Order deny,allow
358 Specifies the order of HTTP access control (allow,deny or deny,allow)
359 <p style=
"margin-left: 5.0em; text-indent: -5.0em">PageLogFormat format string
362 Specifies the format of page log lines.
363 <p style=
"margin-left: 5.0em; text-indent: -5.0em">PassEnv variable [... variable]
366 Passes the specified environment variable(s) to child processes.
367 <p style=
"margin-left: 5.0em; text-indent: -5.0em"><Policy name
> ...
</Policy
>
370 Specifies access control for the named policy.
371 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Port number
374 Specifies a port number to listen to for HTTP requests.
375 <p style=
"margin-left: 5.0em; text-indent: -5.0em">PreserveJobFiles Yes
377 <p style=
"margin-left: 5.0em; text-indent: -5.0em">PreserveJobFiles No
380 Specifies whether or not to preserve job files after they are printed.
381 <p style=
"margin-left: 5.0em; text-indent: -5.0em">PreserveJobHistory Yes
383 <p style=
"margin-left: 5.0em; text-indent: -5.0em">PreserveJobHistory No
386 Specifies whether or not to preserve the job history after they are
388 <p style=
"margin-left: 5.0em; text-indent: -5.0em">PrintcapFormat bsd
390 <p style=
"margin-left: 5.0em; text-indent: -5.0em">PrintcapFormat plist
392 <p style=
"margin-left: 5.0em; text-indent: -5.0em">PrintcapFormat solaris
395 Specifies the format of the printcap file.
396 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ReloadTimeout seconds
399 Specifies the amount of time to wait for job completion before
400 restarting the scheduler.
401 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Require group group-name-list
403 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Require user user-name-list
405 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Require valid-user
408 Specifies that user or group authentication is required.
409 <p style=
"margin-left: 5.0em; text-indent: -5.0em">RIPCache bytes
412 Specifies the maximum amount of memory to use when converting images
413 and PostScript files to bitmaps for a printer.
414 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Satisfy all
416 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Satisfy any
419 Specifies whether all or any limits set for a Location must be
420 satisfied to allow access.
421 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ServerAdmin user@domain.com
424 Specifies the email address of the server administrator.
425 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ServerAlias hostname [... hostname]
427 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ServerAlias *
430 Specifies an alternate name that the server is known by. The special name
"*"
431 allows any name to be used.
432 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ServerName hostname-or-ip-address
435 Specifies the fully-qualified hostname of the server.
436 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ServerTokens Full
438 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ServerTokens Major
440 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ServerTokens Minimal
442 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ServerTokens Minor
444 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ServerTokens None
446 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ServerTokens OS
448 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ServerTokens ProductOnly
451 Specifies what information is included in the Server header of HTTP
453 <p style=
"margin-left: 5.0em; text-indent: -5.0em">SetEnv variable value
456 Set the specified environment variable to be passed to child processes.
457 <p style=
"margin-left: 5.0em; text-indent: -5.0em">SSLListen
460 Listens on the specified address and port for encrypted connections.
461 <p style=
"margin-left: 5.0em; text-indent: -5.0em">SSLPort
464 Listens on the specified port for encrypted connections.
465 <p style=
"margin-left: 5.0em; text-indent: -5.0em">StrictConformance Yes
467 <p style=
"margin-left: 5.0em; text-indent: -5.0em">StrictConformance No
470 Specifies whether the scheduler requires clients to strictly adhere to the IPP
471 specifications. The default is No.
472 <p style=
"margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateAccess all
474 <p style=
"margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateAccess default
476 <p style=
"margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
479 Specifies an access list for a subscription's private values. The
"default"
480 access list is
"@OWNER @SYSTEM".
"@ACL" maps to the printer's
481 requesting-user-name-allowed or requesting-user-name-denied values.
482 <p style=
"margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateValues all
484 <p style=
"margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateValues default
486 <p style=
"margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateValues none
488 <p style=
"margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateValues attribute-name-
1 [ ... attribute-name-N ]
490 Specifies the list of job values to make private. The
"default" values are
491 "notify-events",
"notify-pull-method",
"notify-recipient-uri",
492 "notify-subscriber-user-name", and
"notify-user-data".
493 <p style=
"margin-left: 5.0em; text-indent: -5.0em">Timeout seconds
496 Specifies the HTTP request timeout in seconds.
497 <p style=
"margin-left: 5.0em; text-indent: -5.0em">WebInterface yes
499 <p style=
"margin-left: 5.0em; text-indent: -5.0em">WebInterface no
501 Specifies whether the web interface is enabled.
502 <h2 class=
"title"><a name=
"SEE_ALSO">See Also
</a></h2>
503 <i>classes.conf(
5)
</i>,
<i>cups-files.conf(
5)
</i>,
<i>cupsd(
8)
</i>,
504 <i>mime.convs(
5)
</i>,
<i>mime.types(
5)
</i>,
<i>printers.conf(
5)
</i>,
505 <i>subscriptions.conf(
5)
</i>,
507 <a href=
"http://localhost:631/help">http://localhost:
631/help
</a>
508 <h2 class=
"title"><a name=
"COPYRIGHT">Copyright
</a></h2>
509 Copyright
2007-
2013 by Apple Inc.