1cupsd.conf(5) Easy Software Products 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 Allow all
27 Allow none
29 Allow host.domain.com
31 Allow *.domain.com
33 Allow ip-address
35 Allow ip-address/netmask
37 Allow ip-address/mm
39 Allow @IF(name)
41 Allow @LOCAL
43 Allows access from the named hosts or addresses.
44 AuthClass User
46 AuthClass Group
48 AuthClass System
50 Specifies the authentication class (User, Group, System) - this
51 directive is deprecated.
52 AuthGroupName group-name
54 Specifies the authentication group - this directive is deprecated.
55 AuthType None
57 AuthType Basic
59 AuthType BasicDigest
61 AuthType Digest
63 Specifies the authentication type (None, Basic, BasicDigest,
64 Digest)
65 AutoPurgeJobs Yes
67 AutoPurgeJobs No
69 Specifies whether to purge job history data automatically when it
70 is no longer required for quotas.
71 BrowseAddress ip-address
73 BrowseAddress @IF(name)
75 BrowseAddress @LOCAL
77 Specifies a broadcast address for outgoing printer information
78 packets.
79 BrowseAllow all
81 BrowseAllow none
83 BrowseAllow host.domain.com
85 BrowseAllow *.domain.com
87 BrowseAllow ip-address
89 BrowseAllow ip-address/netmask
91 BrowseAllow ip-address/mm
93 BrowseAllow @IF(name)
95 BrowseAllow @LOCAL
97 Allows incoming printer information packets from the named host or
98 address.
99 BrowseDeny all
101 BrowseDeny none
103 BrowseDeny host.domain.com
105 BrowseDeny *.domain.com
107 BrowseDeny ip-address
109 BrowseDeny ip-address/netmask
111 BrowseDeny ip-address/mm
113 BrowseDeny @IF(name)
115 BrowseDeny @LOCAL
117 Denies incoming printer information packets from the named host or
118 address.
119 BrowseInterval seconds
121 Specifies the maximum interval between printer information broad‐
122 casts.
123 BrowseOrder allow,deny
125 BrowseOrder deny,allow
127 Specifies the order of printer information access control
128 (allow,deny or deny,allow)
129 BrowsePoll host-or-ip-address
131 Specifies a server to poll for printer information.
132 BrowsePort port
134 Specifies the port to listen to for printer information packets.
135 BrowseProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
137 Specifies the protocols to use for printer browsing.
138 BrowseLocalProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
140 Specifies the protocols to use for local printer browsing.
141 BrowseRemoteProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
143 Specifies the protocols to use for remote printer browsing.
144 BrowseRelay from-address to-address
146 Specifies that printer information packets should be relayed from
147 one host or network to another.
148 BrowseShortNames Yes
150 BrowseShortNames No
152 Specifies whether remote printers will use short names ("printer")
153 or not ("printer@server"). This option is ignored if more than one
154 remote printer exists with the same name.
155 BrowseTimeout seconds
157 Specifies the maximum interval between printer information updates
158 before remote printers will be removed from the list of available
159 printers.
160 Browsing Yes
162 Browsing No
164 Specifies whether or not remote printer browsing should be
165 enabled.
166 Classification banner
168 Specifies the security classification of the server.
169 ClassifyOverride Yes
171 ClassifyOverride No
173 Specifies whether to allow users to override the classification of
174 individual print jobs.
175 ConfigFilePerm mode
177 Specifies the permissions for all configuration files that the
178 scheduler writes.
179 DataDir path
181 Specified the directory where data files can be found.
182 DefaultAuthType Basic
184 DefaultAuthType BasicDigest
186 DefaultAuthType Digest
188 Specifies the default type of authentication to use.
189 DefaultCharset charset
191 Specifies the default character set to use for text.
192 DefaultLanguage locale
194 Specifies the default language to use for text and web content.
195 DefaultPolicy policy-name
197 Specifies the default access policy to use.
198 Deny all
200 Deny none
202 Deny host.domain.com
204 Deny *.domain.com
206 Deny ip-address
208 Deny ip-address/netmask
210 Deny ip-address/mm
212 Deny @IF(name)
214 Deny @LOCAL
216 Denies access to the named host or address.
217 DocumentRoot directory
219 Specifies the root directory for the internal web server docu‐
220 ments.
221 Encryption IfRequested
223 Encryption Never
225 Encryption Required
227 Specifies the level of encryption that is required for a particu‐
228 lar location.
229 ErrorLog filename
231 ErrorLog syslog
233 Specifies the error log filename.
234 FileDevice Yes
236 FileDevice No
238 Specifies whether the file pseudo-device can be used for new
239 printer queues.
240 FilterLimit limit
242 Specifies the maximum cost of filters that are run concurrently.
243 FilterNice nice-value
245 Specifies the scheduling priority ("nice" value) of filters that
246 are run to print a job.
247 FontPath directory[:directory:...]
249 Specifies the search path for fonts.
250 Group group-name-or-number
252 Specifies the group name or ID that will be used when executing
253 external programs.
254 HideImplicitMembers Yes
256 HideImplicitMembers No
258 Specifies whether to hide members of implicit classes.
259 HostNameLookups Yes
261 HostNameLookups No
263 HostNameLookups Double
265 Specifies whether or not to do reverse lookups on client
266 addresses.
267 ImplicitAnyClasses Yes
269 ImplicitAnyClasses No
271 Specifies whether or not to create implicit classes for local and
272 remote printers, e.g. "AnyPrinter" from "Printer",
273 "Printer@server1", and "Printer@server2".
274 ImplicitClasses Yes
276 ImplicitClasses No
278 Specifies whether or not to create implicit classes from identical
279 remote printers.
280 Include filename
282 Includes the named file.
283 JobRetryInterval seconds
285 Specifies the interval between retries of jobs in seconds.
286 JobRetryLimit count
288 Specifies the number of retries that are done for jobs.
289 KeepAlive Yes
291 KeepAlive No
293 Specifies whether to support HTTP keep-alive connections.
294 KeepAliveTimeout seconds
296 Specifies the amount of time that connections are kept alive.
297 <Limit operations> ... </Limit>
299 Specifies the IPP operations that are being limited inside a pol‐
300 icy.
301 <Limit methods> ... </Limit>
303 <LimitExcept methods> ... </LimitExcept>
305 Specifies the HTTP methods that are being limited inside a loca‐
306 tion.
307 LimitRequestBody
309 Specifies the maximum size of any print job request.
310 Listen ip-address:port
312 Listen *:port
314 Listen /path/to/domain/socket
316 Listens to the specified address and port or domain socket path.
317 <Location /path> ... </Location>
319 Specifies access control for the named location.
320 LogFilePerm mode
322 Specifies the permissions for all log files that the scheduler
323 writes.
324 LogLevel alert
326 LogLevel crit
328 LogLevel debug2
330 LogLevel debug
332 LogLevel emerg
334 LogLevel error
336 LogLevel info
338 LogLevel none
340 LogLevel notice
342 LogLevel warn
344 Specifies the logging level for the ErrorLog file.
345 MaxClients number
347 Specifies the maximum number of simultaneous clients to support.
348 MaxClientsPerHost number
350 Specifies the maximum number of simultaneous clients to support
351 from a single address.
352 MaxCopies number
354 Specifies the maximum number of copies that a user can print of
355 each job.
356 MaxJobs number
358 Specifies the maximum number of simultaneous jobs to support.
359 MaxJobsPerPrinter number
361 Specifies the maximum number of simultaneous jobs per printer to
362 support.
363 MaxJobsPerUser number
365 Specifies the maximum number of simultaneous jobs per user to sup‐
366 port.
367 MaxLogSize number-bytes
369 Specifies the maximum size of the log files before they are
370 rotated (0 to disable rotation)
371 MaxRequestSize number-bytes
373 Specifies the maximum request/file size in bytes (0 for no limit)
374 Order allow,deny
376 Order deny,allow
378 Specifies the order of HTTP access control (allow,deny or
379 deny,allow)
380 PageLog filename
382 PageLog syslog
384 Specifies the page log filename.
385 PassEnv variable [... variable]
387 Passes the specified environment variable(s) to child processes.
388 <Policy name> ... </Policy>
390 Specifies access control for the named policy.
391 Port number
393 Specifies a port number to listen to for HTTP requests.
394 PreserveJobFiles Yes
396 PreserveJobFiles No
398 Specifies whether or not to preserve job files after they are
399 printed.
400 PreserveJobHistory Yes
402 PreserveJobHistory No
404 Specifies whether or not to preserve the job history after they
405 are printed.
406 Printcap
408 Printcap filename
410 Specifies the filename for a printcap file that is updated auto‐
411 matically with a list of available printers (needed for legacy
412 applications); specifying Printcap with no filename disables
413 printcap generation.
414 PrintcapFormat bsd
416 PrintcapFormat solaris
418 Specifies the format of the printcap file.
419 PrintcapGUI
421 PrintcapGUI gui-program-filename
423 Specifies whether to generate option panel definition files on
424 some operating systems. When provided with no program filename,
425 disables option panel definition files.
426 ReloadTimeout seconds
428 Specifies the amount of time to wait for job completion before
429 restarting the scheduler.
430 RemoteRoot user-name
432 Specifies the username that is associated with unauthenticated
433 root accesses.
434 RequestRoot directory
436 Specifies the directory to store print jobs and other HTTP request
437 data.
438 Require group group-name-list
440 Require user user-name-list
442 Require valid-user
444 Specifies that user or group authentication is required.
445 RIPCache bytes
447 Specifies the maximum amount of memory to use when converting
448 images and PostScript files to bitmaps for a printer.
449 Satisfy all
451 Satisfy any
453 Specifies whether all or any limits set for a Location must be
454 satisfied to allow access.
455 ServerAdmin user@domain.com
457 Specifies the email address of the server administrator.
458 ServerBin directory
460 Specifies the directory where backends, CGIs, daemons, and filters
461 may be found.
462 ServerCertificate filename
464 Specifies the encryption certificate to use.
465 ServerKey filename
467 Specifies the encryption key to use.
468 ServerName hostname-or-ip-address
470 Specifies the fully-qualified hostname of the server.
471 ServerRoot directory
473 Specifies the directory where the server configuration files can
474 be found.
475 ServerTokens Full
477 ServerTokens Major
479 ServerTokens Minimal
481 ServerTokens Minor
483 ServerTokens None
485 ServerTokens OS
487 ServerTokens ProductOnly
489 Specifies what information is included in the Server header of
490 HTTP responses.
491 SetEnv variable value
493 Set the specified environment variable to be passed to child pro‐
494 cesses.
495 SSLListen
497 Listens on the specified address and port for encrypted connec‐
498 tions.
499 SSLPort
501 Listens on the specified port for encrypted connections.
502 SystemGroup group-name [group-name ...]
504 Specifies the group(s) to use for System class authentication.
505 TempDir directory
507 Specifies the directory where temporary files are stored.
508 Timeout seconds
510 Specifies the HTTP request timeout in seconds.
511 User user-name
513 Specifies the user name or ID that is used when running external
514 programs.
515
517 classes.conf(5), cupsd(8), mime.convs(5), mime.types(5), print‐
518 ers.conf(5), subscriptions.conf(5),
519 http://localhost:631/help
520
522 Copyright 1997-2006 by Easy Software Products, All Rights Reserved.
5236 June 2006 Common UNIX Printing System cupsd.conf(5)