1cupsd.conf(5) Apple Inc. cupsd.conf(5)
2
6 cupsd.conf - server configuration file for cups
7
9 The cupsd.conf file configures the CUPS scheduler, cupsd(8). It is
10 normally located in the /etc/cups directory.
11 Each line in the file can be a configuration directive, a blank line,
13 or a comment. Comment lines start with the # character. The configura‐
14 tion directives are intentionally similar to those used by the popular
15 Apache web server software and are described below.
16
18 The following directives are understood by cupsd(8). Consult the on-
19 line help for detailed descriptions:
20 AccessLog filename
22 AccessLog syslog
24 Defines the access log filename.
25 AccessLogLevel config
27 AccessLogLevel actions
29 AccessLogLevel all
31 Specifies the logging level for the AccessLog file.
32 Allow all
34 Allow none
36 Allow host.domain.com
38 Allow *.domain.com
40 Allow ip-address
42 Allow ip-address/netmask
44 Allow ip-address/mm
46 Allow @IF(name)
48 Allow @LOCAL
50 Allows access from the named hosts or addresses.
51 AuthClass User
53 AuthClass Group
55 AuthClass System
57 Specifies the authentication class (User, Group, System) - this
58 directive is deprecated.
59 AuthGroupName group-name
61 Specifies the authentication group - this directive is deprecated.
62 AuthType None
64 AuthType Basic
66 AuthType BasicDigest
68 AuthType Digest
70 AuthType Negotiate
72 Specifies the authentication type (None, Basic, BasicDigest,
73 Digest, Negotiate)
74 AutoPurgeJobs Yes
76 AutoPurgeJobs No
78 Specifies whether to purge job history data automatically when it
79 is no longer required for quotas.
80 BrowseAddress ip-address
82 BrowseAddress @IF(name)
84 BrowseAddress @LOCAL
86 Specifies a broadcast address for outgoing printer information
87 packets.
88 BrowseAllow all
90 BrowseAllow none
92 BrowseAllow host.domain.com
94 BrowseAllow *.domain.com
96 BrowseAllow ip-address
98 BrowseAllow ip-address/netmask
100 BrowseAllow ip-address/mm
102 BrowseAllow @IF(name)
104 BrowseAllow @LOCAL
106 Allows incoming printer information packets from the named host or
107 address.
108 BrowseDeny all
110 BrowseDeny none
112 BrowseDeny host.domain.com
114 BrowseDeny *.domain.com
116 BrowseDeny ip-address
118 BrowseDeny ip-address/netmask
120 BrowseDeny ip-address/mm
122 BrowseDeny @IF(name)
124 BrowseDeny @LOCAL
126 Denies incoming printer information packets from the named host or
127 address.
128 BrowseInterval seconds
130 Specifies the maximum interval between printer information broad‐
131 casts.
132 BrowseLDAPBindDN
134 Specifies the LDAP domain name to use when registering printers.
135 BrowseLDAPCACertFile
137 Specifies the SSL certificate authority file to use.
138 BrowseLDAPDN
140 Specifies the LDAP domain name to use when discovering printers.
141 BrowseLDAPPassword
143 Specifies the password to use when accessing the LDAP server.
144 BrowseLDAPServer
146 Specifies the LDAP server to use.
147 BrowseOrder allow,deny
149 BrowseOrder deny,allow
151 Specifies the order of printer information access control
152 (allow,deny or deny,allow)
153 BrowsePoll host-or-ip-address
155 Specifies a server to poll for printer information.
156 BrowsePort port
158 Specifies the port to listen to for printer information packets.
159 BrowseProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
161 Specifies the protocols to use for printer browsing.
162 BrowseLocalProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
164 Specifies the protocols to use for local printer browsing.
165 BrowseRemoteProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
167 Specifies the protocols to use for remote printer browsing.
168 BrowseRelay from-address to-address
170 Specifies that printer information packets should be relayed from
171 one host or network to another.
172 BrowseShortNames Yes
174 BrowseShortNames No
176 Specifies whether remote printers will use short names ("printer")
177 or not ("printer@server"). This option is ignored if more than one
178 remote printer exists with the same name.
179 BrowseTimeout seconds
181 Specifies the maximum interval between printer information updates
182 before remote printers will be removed from the list of available
183 printers.
184 BrowseWebIF Yes
186 BrowseWebIF No
188 Specifies whether the CUPS web interface is advertised via DNS-SD.
189 Browsing Yes
191 Browsing No
193 Specifies whether or not remote printer browsing should be
194 enabled.
195 Classification banner
197 Specifies the security classification of the server.
198 ClassifyOverride Yes
200 ClassifyOverride No
202 Specifies whether to allow users to override the classification of
203 individual print jobs.
204 ConfigFilePerm mode
206 Specifies the permissions for all configuration files that the
207 scheduler writes.
208 DataDir path
210 Specified the directory where data files can be found.
211 DefaultAuthType Basic
213 DefaultAuthType BasicDigest
215 DefaultAuthType Digest
217 DefaultAuthType Negotiate
219 Specifies the default type of authentication to use.
220 DefaultEncryption Never
222 DefaultEncryption IfRequested
224 DefaultEncryption Required
226 Specifies the type of encryption to use for authenticated
227 requests.
228 DefaultLanguage locale
230 Specifies the default language to use for text and web content.
231 DefaultPaperSize Auto
233 DefaultPaperSize None
235 DefaultPaperSize sizename
237 Specifies the default paper size for new print queues. "Auto" uses
238 a locale- specific default, while "None" specifies there is no
239 default paper size.
240 DefaultPolicy policy-name
242 Specifies the default access policy to use.
243 DefaultShared Yes
245 DefaultShared No
247 Specifies whether local printers are shared by default.
248 Deny all
250 Deny none
252 Deny host.domain.com
254 Deny *.domain.com
256 Deny ip-address
258 Deny ip-address/netmask
260 Deny ip-address/mm
262 Deny @IF(name)
264 Deny @LOCAL
266 Denies access to the named host or address.
267 DirtyCleanInterval seconds
269 Specifies the delay for updating of configuration and state files.
270 A value of 0 causes the update to happen as soon as possible, typ‐
271 ically within a few milliseconds.
272 DocumentRoot directory
274 Specifies the root directory for the internal web server docu‐
275 ments.
276 Encryption IfRequested
278 Encryption Never
280 Encryption Required
282 Specifies the level of encryption that is required for a particu‐
283 lar location.
284 ErrorLog filename
286 ErrorLog syslog
288 Specifies the error log filename.
289 FatalErrors none
291 FatalErrors all -kind [... -kind]
293 FatalErrors kind [... kind]
295 Specifies which errors are fatal, causing the scheduler to exit.
296 "Kind" is "browse", "config", "listen", "log", or "permissions".
297 FileDevice Yes
299 FileDevice No
301 Specifies whether the file pseudo-device can be used for new
302 printer queues.
303 FilterLimit limit
305 Specifies the maximum cost of filters that are run concurrently.
306 FilterNice nice-value
308 Specifies the scheduling priority ("nice" value) of filters that
309 are run to print a job.
310 FontPath directory[:directory:...]
312 Specifies the search path for fonts.
313 Group group-name-or-number
315 Specifies the group name or ID that will be used when executing
316 external programs.
317 HideImplicitMembers Yes
319 HideImplicitMembers No
321 Specifies whether to hide members of implicit classes.
322 HostNameLookups On
324 HostNameLookups Off
326 HostNameLookups Double
328 Specifies whether or not to do reverse lookups on client
329 addresses.
330 ImplicitAnyClasses Yes
332 ImplicitAnyClasses No
334 Specifies whether or not to create implicit classes for local and
335 remote printers, e.g. "AnyPrinter" from "Printer",
336 "Printer@server1", and "Printer@server2".
337 ImplicitClasses Yes
339 ImplicitClasses No
341 Specifies whether or not to create implicit classes from identical
342 remote printers.
343 Include filename
345 Includes the named file.
346 JobKillDelay seconds
348 Specifies the number of seconds to wait before killing the filters
349 and backend associated with a canceled or held job.
350 JobRetryInterval seconds
352 Specifies the interval between retries of jobs in seconds.
353 JobRetryLimit count
355 Specifies the number of retries that are done for jobs.
356 KeepAlive Yes
358 KeepAlive No
360 Specifies whether to support HTTP keep-alive connections.
361 KeepAliveTimeout seconds
363 Specifies the amount of time that connections are kept alive.
364 <Limit operations> ... </Limit>
366 Specifies the IPP operations that are being limited inside a pol‐
367 icy.
368 <Limit methods> ... </Limit>
370 <LimitExcept methods> ... </LimitExcept>
372 Specifies the HTTP methods that are being limited inside a loca‐
373 tion.
374 LimitRequestBody
376 Specifies the maximum size of any print job request.
377 Listen ip-address:port
379 Listen *:port
381 Listen /path/to/domain/socket
383 Listens to the specified address and port or domain socket path.
384 <Location /path> ... </Location>
386 Specifies access control for the named location.
387 LogDebugHistory #-messages
389 Specifies the number of debugging messages that are logged when an
390 error occurs in a print job.
391 LogFilePerm mode
393 Specifies the permissions for all log files that the scheduler
394 writes.
395 LogLevel alert
397 LogLevel crit
399 LogLevel debug2
401 LogLevel debug
403 LogLevel emerg
405 LogLevel error
407 LogLevel info
409 LogLevel none
411 LogLevel notice
413 LogLevel warn
415 Specifies the logging level for the ErrorLog file.
416 LogTimeFormat standard
418 LogTimeFormat usecs
420 Specifies the format of the date and time in the log files.
421 MaxClients number
423 Specifies the maximum number of simultaneous clients to support.
424 MaxClientsPerHost number
426 Specifies the maximum number of simultaneous clients to support
427 from a single address.
428 MaxCopies number
430 Specifies the maximum number of copies that a user can print of
431 each job.
432 MaxJobs number
434 Specifies the maximum number of simultaneous jobs to support.
435 MaxJobsPerPrinter number
437 Specifies the maximum number of simultaneous jobs per printer to
438 support.
439 MaxJobsPerUser number
441 Specifies the maximum number of simultaneous jobs per user to sup‐
442 port.
443 MaxLogSize number-bytes
445 Specifies the maximum size of the log files before they are
446 rotated (0 to disable rotation)
447 MaxRequestSize number-bytes
449 Specifies the maximum request/file size in bytes (0 for no limit)
450 MultipleOperationTimeout seconds
452 Specifies the maximum amount of time to allow between files in a
453 multiple file print job.
454 Order allow,deny
456 Order deny,allow
458 Specifies the order of HTTP access control (allow,deny or
459 deny,allow)
460 PageLog filename
462 PageLog syslog
464 Specifies the page log filename.
465 PageLogFormat format string
467 Specifies the format of page log lines.
468 PassEnv variable [... variable]
470 Passes the specified environment variable(s) to child processes.
471 <Policy name> ... </Policy>
473 Specifies access control for the named policy.
474 Port number
476 Specifies a port number to listen to for HTTP requests.
477 PreserveJobFiles Yes
479 PreserveJobFiles No
481 Specifies whether or not to preserve job files after they are
482 printed.
483 PreserveJobHistory Yes
485 PreserveJobHistory No
487 Specifies whether or not to preserve the job history after they
488 are printed.
489 Printcap
491 Printcap filename
493 Specifies the filename for a printcap file that is updated auto‐
494 matically with a list of available printers (needed for legacy
495 applications); specifying Printcap with no filename disables
496 printcap generation.
497 PrintcapFormat bsd
499 PrintcapFormat plist
501 PrintcapFormat solaris
503 Specifies the format of the printcap file.
504 PrintcapGUI
506 PrintcapGUI gui-program-filename
508 Specifies whether to generate option panel definition files on
509 some operating systems. When provided with no program filename,
510 disables option panel definition files.
511 ReloadTimeout seconds
513 Specifies the amount of time to wait for job completion before
514 restarting the scheduler.
515 RemoteRoot user-name
517 Specifies the username that is associated with unauthenticated
518 root accesses.
519 RequestRoot directory
521 Specifies the directory to store print jobs and other HTTP request
522 data.
523 Require group group-name-list
525 Require user user-name-list
527 Require valid-user
529 Specifies that user or group authentication is required.
530 RIPCache bytes
532 Specifies the maximum amount of memory to use when converting
533 images and PostScript files to bitmaps for a printer.
534 Satisfy all
536 Satisfy any
538 Specifies whether all or any limits set for a Location must be
539 satisfied to allow access.
540 ServerAdmin user@domain.com
542 Specifies the email address of the server administrator.
543 ServerAlias hostname
545 Specifies an alternate name that the server is known by. The spe‐
546 cial name "*" allows any name to be used.
547 ServerBin directory
549 Specifies the directory where backends, CGIs, daemons, and filters
550 may be found.
551 ServerCertificate filename
553 Specifies the encryption certificate to use.
554 ServerKey filename
556 Specifies the encryption key to use.
557 ServerName hostname-or-ip-address
559 Specifies the fully-qualified hostname of the server.
560 ServerRoot directory
562 Specifies the directory where the server configuration files can
563 be found.
564 ServerTokens Full
566 ServerTokens Major
568 ServerTokens Minimal
570 ServerTokens Minor
572 ServerTokens None
574 ServerTokens OS
576 ServerTokens ProductOnly
578 Specifies what information is included in the Server header of
579 HTTP responses.
580 SetEnv variable value
582 Set the specified environment variable to be passed to child pro‐
583 cesses.
584 SSLListen
586 Listens on the specified address and port for encrypted connec‐
587 tions.
588 SSLOptions None
590 SSLOptions NoEmptyFragments
592 Sets SSL/TLS protocol options for encrypted connections.
593 SSLPort
595 Listens on the specified port for encrypted connections.
596 SystemGroup group-name [group-name ...]
598 Specifies the group(s) to use for System class authentication.
599 TempDir directory
601 Specifies the directory where temporary files are stored.
602 Timeout seconds
604 Specifies the HTTP request timeout in seconds.
605 User user-name
607 Specifies the user name or ID that is used when running external
608 programs.
609
611 classes.conf(5), cupsd(8), mime.convs(5), mime.types(5), print‐
612 ers.conf(5), subscriptions.conf(5),
613 http://localhost:631/help
614
616 Copyright 2007-2009 by Apple Inc.
61728 January 2010 CUPS cupsd.conf(5)