Greatly simplify the man page handling.
[thirdparty/cups.git] / man / cupsd.conf.5
1 .\"
2 .\" cupsd.conf man page for CUPS.
3 .\"
4 .\" Copyright © 2007-2019 by Apple Inc.
5 .\" Copyright © 1997-2006 by Easy Software Products.
6 .\"
7 .\" Licensed under Apache License v2.0.  See the file "LICENSE" for more
8 .\" information.
9 .\"
10 .TH cupsd.conf 5 "CUPS" "26 April 2019" "Apple Inc."
11 .SH NAME
12 cupsd.conf \- server configuration file for cups
13 .SH DESCRIPTION
14 The
15 .I cupsd.conf
16 file configures the CUPS scheduler,
17 .BR cupsd (8).
18 It is normally located in the
19 .I /etc/cups
20 directory.
21 Each line in the file can be a configuration directive, a blank line, or a comment.
22 Configuration directives typically consist of a name and zero or more values separated by whitespace.
23 The configuration directive name and values are case-insensitive.
24 Comment lines start with the # character.
25 .SS TOP-LEVEL DIRECTIVES
26 The following top-level directives are understood by
27 .BR cupsd (8):
28 .\"#AccessLogLevel
29 .TP 5
30 \fBAccessLogLevel config\fR
31 .TP 5
32 \fBAccessLogLevel actions\fR
33 .TP 5
34 \fBAccessLogLevel all\fR
35 Specifies the logging level for the AccessLog file.
36 The "config" level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated.
37 The "actions" level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for "config".
38 The "all" level logs all requests.
39 The default access log level is "actions".
40 .\"#AutoPurgeJobs
41 .TP 5
42 \fBAutoPurgeJobs Yes\fR
43 .TP 5
44 \fBAutoPurgeJobs No\fR
45 .br
46 Specifies whether to purge job history data automatically when it is no longer required for quotas.
47 The default is "No".
48 .\"#BrowseDNSSDSubTypes
49 .TP 5
50 .BI BrowseDNSSDSubTypes _subtype[,...]
51 Specifies a list of Bonjour sub-types to advertise for each shared printer.
52 For example, "BrowseDNSSDSubTypes _cups,_print" will tell network clients that both CUPS sharing and IPP Everywhere are supported.
53 The default is "_cups" which is necessary for printer sharing to work between systems using CUPS.
54 .\"#BrowseLocalProtocols
55 .TP 5
56 \fBBrowseLocalProtocols all\fR
57 .TP 5
58 \fBBrowseLocalProtocols dnssd\fR
59 .TP 5
60 \fBBrowseLocalProtocols none\fR
61 Specifies which protocols to use for local printer sharing.
62 The default is "dnssd" on systems that support Bonjour and "none" otherwise.
63 .\"#BrowseWebIF
64 .TP 5
65 \fBBrowseWebIF Yes\fR
66 .TP 5
67 \fBBrowseWebIF No\fR
68 .br
69 Specifies whether the CUPS web interface is advertised.
70 The default is "No".
71 .\"#Browsing
72 .TP 5
73 \fBBrowsing Yes\fR
74 .TP 5
75 \fBBrowsing No\fR
76 .br
77 Specifies whether shared printers are advertised.
78 The default is "No".
79 .\"#DefaultAuthType
80 .TP 5
81 \fBDefaultAuthType Basic\fR
82 .TP 5
83 \fBDefaultAuthType Negotiate\fR
84 .br
85 Specifies the default type of authentication to use.
86 The default is "Basic".
87 .\"#DefaultEncryption
88 .TP 5
89 \fBDefaultEncryption Never\fR
90 .TP 5
91 \fBDefaultEncryption IfRequested\fR
92 .TP 5
93 \fBDefaultEncryption Required\fR
94 Specifies whether encryption will be used for authenticated requests.
95 The default is "Required".
96 .\"#DefaultLanguage
97 .TP 5
98 \fBDefaultLanguage \fIlocale\fR
99 Specifies the default language to use for text and web content.
100 The default is "en".
101 .\"#DefaultPaperSize
102 .TP 5
103 \fBDefaultPaperSize Auto\fR
104 .TP 5
105 \fBDefaultPaperSize None\fR
106 .TP 5
107 \fBDefaultPaperSize \fIsizename\fR
108 Specifies the default paper size for new print queues. "Auto" uses a locale-specific default, while "None" specifies there is no default paper size.
109 Specific size names are typically "Letter" or "A4".
110 The default is "Auto".
111 .\"#DefaultPolicy
112 .TP 5
113 \fBDefaultPolicy \fIpolicy-name\fR
114 Specifies the default access policy to use.
115 The default access policy is "default".
116 .\"#DefaultShared
117 .TP 5
118 \fBDefaultShared Yes\fR
119 .TP 5
120 \fBDefaultShared No\fR
121 Specifies whether local printers are shared by default.
122 The default is "Yes".
123 .\"#DirtyCleanInterval
124 .TP 5
125 \fBDirtyCleanInterval \fIseconds\fR
126 Specifies the delay for updating of configuration and state files.
127 A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds.
128 The default value is "30".
129 .\"#DNSSDHostName
130 .TP 5
131 .BI DNSSDHostName hostname.example.com
132 Specifies the fully-qualified domain name for the server that is used for Bonjour sharing.
133 The default is typically the server's ".local" hostname.
134 .\"#ErrorPolicy
135 .TP 5
136 \fBErrorPolicy abort-job\fR
137 Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer.
138 .TP 5
139 \fBErrorPolicy retry-current-job\fR
140 Specifies that a failed print job should be retried immediately unless otherwise specified for the printer.
141 .TP 5
142 \fBErrorPolicy retry-job\fR
143 Specifies that a failed print job should be retried at a later time unless otherwise specified for the printer.
144 .TP 5
145 \fBErrorPolicy stop-printer\fR
146 Specifies that a failed print job should stop the printer unless otherwise specified for the printer. The 'stop-printer' error policy is the default.
147 .\"#FilterLimit
148 .TP 5
149 \fBFilterLimit \fIlimit\fR
150 Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems.
151 A limit of 0 disables filter limiting.
152 An average print to a non-PostScript printer needs a filter limit of about 200.
153 A PostScript printer needs about half that (100).
154 Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time.
155 The default limit is "0".
156 .\"#FilterNice
157 .TP 5
158 \fBFilterNice \fInice-value\fR
159 Specifies the scheduling priority (
160 .BR nice (8)
161 value) of filters that are run to print a job.
162 The nice value ranges from 0, the highest priority, to 19, the lowest priority.
163 The default is 0.
164 .\"#GSSServiceName
165 .TP 5
166 \fBGSSServiceName \fIname\fR
167 Specifies the service name when using Kerberos authentication.
168 The default service name is "http."
169 .TP 5
170 .\"#HostNameLookups
171 \fBHostNameLookups On\fR
172 .TP 5
173 \fBHostNameLookups Off\fR
174 .TP 5
175 \fBHostNameLookups Double\fR
176 Specifies whether to do reverse lookups on connecting clients.
177 The "Double" setting causes
178 .BR cupsd (8)
179 to verify that the hostname resolved from the address matches one of the addresses returned for that hostname.
180 Double lookups also prevent clients with unregistered addresses from connecting to your server.
181 The default is "Off" to avoid the potential server performance problems with hostname lookups.
182 Only set this option to "On" or "Double" if absolutely required.
183 .\"#IdleExitTimeout
184 .TP 5
185 \fBIdleExitTimeout \fIseconds\fR
186 Specifies the length of time to wait before shutting down due to inactivity.
187 The default is "60" seconds.
188 Note: Only applicable when
189 .BR cupsd (8)
190 is run on-demand (e.g., with \fB-l\fR).
191 .\"#JobKillDelay
192 .TP 5
193 \fBJobKillDelay \fIseconds\fR
194 Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.
195 The default is "30".
196 .\"#JobRetryInterval
197 .TP 5
198 \fBJobRetryInterval \fIseconds\fR
199 Specifies the interval between retries of jobs in seconds.
200 This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job" or "retry-current-job".
201 The default is "30".
202 .\"#JobRetryLimit
203 .TP 5
204 \fBJobRetryLimit \fIcount\fR
205 Specifies the number of retries that are done for jobs.
206 This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job" or "retry-current-job".
207 The default is "5".
208 .\"#KeepAlive
209 .TP 5
210 \fBKeepAlive Yes\fR
211 .TP 5
212 \fBKeepAlive No\fR
213 Specifies whether to support HTTP keep-alive connections.
214 The default is "Yes".
215 .\"#KeepAliveTimeout
216 .TP 5
217 \fBKeepAliveTimeout \fIseconds\fR
218 Specifies how long an idle client connection remains open.
219 The default is "30".
220 .\"#LimitIPP
221 .TP 5
222 \fB<Limit \fIoperation \fR...\fB> \fR... \fB</Limit>\fR
223 Specifies the IPP operations that are being limited inside a Policy section. IPP operation names are listed below in the section "IPP OPERATION NAMES".
224 .\"#Limit
225 .TP 5
226 \fB<Limit \fImethod \fR...\fB> \fR... \fB</Limit>\fR
227 .\"#LimitExcept
228 .TP 5
229 \fB<LimitExcept \fImethod \fR...\fB> \fR... \fB</LimitExcept>\fR
230 Specifies the HTTP methods that are being limited inside a Location section. HTTP method names are listed below in the section "HTTP METHOD NAMES".
231 .\"#LimitRequestBody
232 .TP 5
233 \fBLimitRequestBody \fIsize\fR
234 Specifies the maximum size of print files, IPP requests, and HTML form data.
235 The default is "0" which disables the limit check.
236 .\"#Listen
237 .TP 5
238 \fBListen \fIipv4-address\fB:\fIport\fR
239 .TP 5
240 \fBListen [\fIipv6-address\fB]:\fIport\fR
241 .TP 5
242 \fBListen *:\fIport\fR
243 .TP 5
244 \fBListen \fI/path/to/domain/socket\fR
245 Listens to the specified address and port or domain socket path for connections.
246 Multiple Listen directives can be provided to listen on multiple addresses.
247 The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks.
248 .\"#ListenBackLog
249 .TP 5
250 \fBListenBackLog \fInumber\fR
251 Specifies the number of pending connections that will be allowed.
252 This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections.
253 When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones.
254 The default is the OS-defined default limit, typically either "5" for older operating systems or "128" for newer operating systems.
255 .\"#Location
256 .TP 5
257 \fB<Location \fI/path\fB> \fR... \fB</Location>\fR
258 Specifies access control for the named location.
259 Paths are documented below in the section "LOCATION PATHS".
260 .\"#LogDebugHistory
261 .TP 5
262 \fBLogDebugHistory \fInumber\fR
263 Specifies the number of debugging messages that are retained for logging if an error occurs in a print job. Debug messages are logged regardless of the LogLevel setting.
264 .\"#LogLevel
265 .TP 5
266 \fBLogLevel \fRnone
267 .TP 5
268 \fBLogLevel \fRemerg
269 .TP 5
270 \fBLogLevel \fRalert
271 .TP 5
272 \fBLogLevel \fRcrit
273 .TP 5
274 \fBLogLevel \fRerror
275 .TP 5
276 \fBLogLevel \fRwarn
277 .TP 5
278 \fBLogLevel \fRnotice
279 .TP 5
280 \fBLogLevel \fRinfo
281 .TP 5
282 \fBLogLevel \fRdebug
283 .TP 5
284 \fBLogLevel \fRdebug2
285 Specifies the level of logging for the ErrorLog file.
286 The value "none" stops all logging while "debug2" logs everything.
287 The default is "warn".
288 .\"#LogTimeFormat
289 .TP 5
290 \fBLogTimeFormat \fRstandard
291 .TP 5
292 \fBLogTimeFormat \fRusecs
293 Specifies the format of the date and time in the log files.
294 The value "standard" is the default and logs whole seconds while "usecs" logs microseconds.
295 .\"#MaxClients
296 .TP 5
297 \fBMaxClients \fInumber\fR
298 Specifies the maximum number of simultaneous clients that are allowed by the scheduler.
299 The default is "100".
300 .\"#MaxClientPerHost
301 .TP 5
302 \fBMaxClientsPerHost \fInumber\fR
303 Specifies the maximum number of simultaneous clients that are allowed from a
304 single address.
305 The default is the MaxClients value.
306 .\"#MaxCopies
307 .TP 5
308 \fBMaxCopies \fInumber\fR
309 Specifies the maximum number of copies that a user can print of each job.
310 The default is "9999".
311 .\"#MaxHoldTime
312 .TP 5
313 \fBMaxHoldTime \fIseconds\fR
314 Specifies the maximum time a job may remain in the "indefinite" hold state before it is canceled.
315 The default is "0" which disables cancellation of held jobs.
316 .\"#MaxJobs
317 .TP 5
318 \fBMaxJobs \fInumber\fR
319 Specifies the maximum number of simultaneous jobs that are allowed.
320 Set to "0" to allow an unlimited number of jobs.
321 The default is "500".
322 .\"#MaxJobsPerPrinter
323 .TP 5
324 \fBMaxJobsPerPrinter \fInumber\fR
325 Specifies the maximum number of simultaneous jobs that are allowed per printer.
326 The default is "0" which allows up to MaxJobs jobs per printer.
327 .\"#MaxJobsPerUser
328 .TP 5
329 \fBMaxJobsPerUser \fInumber\fR
330 Specifies the maximum number of simultaneous jobs that are allowed per user.
331 The default is "0" which allows up to MaxJobs jobs per user.
332 .\"#MaxJobTime
333 .TP 5
334 \fBMaxJobTime \fIseconds\fR
335 Specifies the maximum time a job may take to print before it is canceled.
336 Set to "0" to disable cancellation of "stuck" jobs.
337 The default is "10800" (3 hours).
338 .\"#MaxLogSize
339 .TP 5
340 \fBMaxLogSize \fIsize\fR
341 Specifies the maximum size of the log files before they are rotated.
342 The value "0" disables log rotation.
343 The default is "1048576" (1MB).
344 .\"#MultipleOperationTimeout
345 .TP 5
346 \fBMultipleOperationTimeout \fIseconds\fR
347 Specifies the maximum amount of time to allow between files in a multiple file print job.
348 The default is "300" (5 minutes).
349 .\"#Policy
350 .TP 5
351 \fB<Policy \fIname\fB> \fR... \fB</Policy>\fR
352 Specifies access control for the named policy.
353 .\"#Port
354 .TP 5
355 \fBPort \fInumber\fR
356 Listens to the specified port number for connections.
357 .\"#PreserveJobFiles
358 .TP 5
359 \fBPreserveJobFiles Yes\fR
360 .TP 5
361 \fBPreserveJobFiles No\fR
362 .TP 5
363 \fBPreserveJobFiles \fIseconds\fR
364 Specifies whether job files (documents) are preserved after a job is printed.
365 If a numeric value is specified, job files are preserved for the indicated number of seconds after printing.
366 The default is "86400" (preserve 1 day).
367 .\"#PreserveJobHistory
368 .TP 5
369 \fBPreserveJobHistory Yes\fR
370 .TP 5
371 \fBPreserveJobHistory No\fR
372 .TP 5
373 \fBPreserveJobHistory \fIseconds\fR
374 Specifies whether the job history is preserved after a job is printed.
375 If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing.
376 If "Yes", the job history is preserved until the MaxJobs limit is reached.
377 The default is "Yes".
378 .\"#ReloadTimeout
379 .TP 5
380 \fBReloadTimeout \fIseconds\fR
381 Specifies the amount of time to wait for job completion before restarting the scheduler.
382 The default is "30".
383 .\"#ServerAdmin
384 .TP 5
385 \fBServerAdmin \fIemail-address\fR
386 Specifies the email address of the server administrator.
387 The default value is "root@ServerName".
388 .\"#ServerAlias
389 .TP 5
390 \fBServerAlias \fIhostname \fR[ ... \fIhostname \fR]
391 .TP 5
392 \fBServerAlias *\fR
393 The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces.
394 Using the special name "*" can expose your system to known browser-based DNS rebinding attacks, even when accessing sites through a firewall.
395 If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using "*".
396 .\"#ServerName
397 .TP 5
398 \fBServerName \fIhostname\fR
399 Specifies the fully-qualified hostname of the server.
400 The default is the value reported by the
401 .BR hostname (1)
402 command.
403 .\"#ServerTokens
404 .TP 5
405 \fBServerTokens None\fR
406 .TP 5
407 \fBServerTokens ProductOnly\fR
408 .TP 5
409 \fBServerTokens Major\fR
410 .TP 5
411 \fBServerTokens Minor\fR
412 .TP 5
413 \fBServerTokens Minimal\fR
414 .TP 5
415 \fBServerTokens OS\fR
416 .TP 5
417 \fBServerTokens Full\fR
418 Specifies what information is included in the Server header of HTTP responses.
419 "None" disables the Server header.
420 "ProductOnly" reports "CUPS".
421 "Major" reports "CUPS/major IPP/2".
422 "Minor" reports "CUPS/major.minor IPP/2.1".
423 "Minimal" reports "CUPS/major.minor.patch IPP/2.1".
424 "OS" reports "CUPS/major.minor.path (osname osversion) IPP/2.1".
425 "Full" reports "CUPS/major.minor.path (osname osversion; architecture) IPP/2.1".
426 The default is "Minimal".
427 .\"#SSLListen
428 .TP 5
429 \fBSSLListen \fIipv4-address\fB:\fIport\fR
430 .TP 5
431 \fBSSLListen [\fIipv6-address\fB]:\fIport\fR
432 .TP 5
433 \fBSSLListen *:\fIport\fR
434 Listens on the specified address and port for encrypted connections.
435 .\"#SSLOptions
436 .TP 5
437 .TP 5
438 \fBSSLOptions \fR[\fIAllowDH\fR] [\fIAllowRC4\fR] [\fIAllowSSL3\fR] [\fIDenyCBC\fR] [\fIDenyTLS1.0\fR] [\fIMaxTLS1.0\fR] [\fIMaxTLS1.1\fR] [\fIMaxTLS1.2\fR] [\fIMaxTLS1.3\fR] [\fIMinTLS1.0\fR] [\fIMinTLS1.1\fR] [\fIMinTLS1.2\fR] [\fIMinTLS1.3\fR]
439 .TP 5
440 \fBSSLOptions None\fR
441 Sets encryption options (only in /etc/cups/client.conf).
442 By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
443 Security is reduced when \fIAllow\fR options are used.
444 Security is enhanced when \fIDeny\fR options are used.
445 The \fIAllowDH\fR option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS).
446 The \fIAllowRC4\fR option enables the 128-bit RC4 cipher suites, which are required for some older clients.
447 The \fIAllowSSL3\fR option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
448 The \fIDenyCBC\fR option disables all CBC cipher suites.
449 The \fIDenyTLS1.0\fR option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
450 The \fIMinTLS\fR options set the minimum TLS version to support.
451 The \fIMaxTLS\fR options set the maximum TLS version to support.
452 Not all operating systems support TLS 1.3 at this time.
453 .\"#SSLPort
454 .TP 5
455 \fBSSLPort \fIport\fR
456 Listens on the specified port for encrypted connections.
457 .\"#StrictConformance
458 .TP 5
459 \fBStrictConformance Yes\fR
460 .TP 5
461 \fBStrictConformance No\fR
462 Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications.
463 The default is "No".
464 .\"#Timeout
465 .TP 5
466 \fBTimeout \fIseconds\fR
467 Specifies the HTTP request timeout.
468 The default is "300" (5 minutes).
469 .\"#WebInterface
470 .TP 5
471 \fBWebInterface yes\fR
472 .TP 5
473 \fBWebInterface no\fR
474 Specifies whether the web interface is enabled.
475 The default is "No".
476 .SS HTTP METHOD NAMES
477 The following HTTP methods are supported by
478 .BR cupsd (8):
479 .TP 5
480 GET
481 Used by a client to download icons and other printer resources and to access the CUPS web interface.
482 .TP 5
483 HEAD
484 Used by a client to get the type, size, and modification date of resources.
485 .TP 5
486 OPTIONS
487 Used by a client to establish a secure (SSL/TLS) connection.
488 .TP 5
489 POST
490 Used by a client to submit IPP requests and HTML forms from the CUPS web interface.
491 .TP 5
492 PUT
493 Used by a client to upload configuration files.
494 .SS IPP OPERATION NAMES
495 The following IPP operations are supported by
496 .BR cupsd (8):
497 .TP 5
498 CUPS\-Accept\-Jobs
499 Allows a printer to accept new jobs.
500 .TP 5
501 CUPS\-Add\-Modify\-Class
502 Adds or modifies a printer class.
503 .TP 5
504 CUPS\-Add\-Modify\-Printer
505 Adds or modifies a printer.
506 .TP 5
507 CUPS\-Authenticate\-Job
508 Releases a job that is held for authentication.
509 .TP 5
510 CUPS\-Delete\-Class
511 Deletes a printer class.
512 .TP 5
513 CUPS\-Delete\-Printer
514 Deletes a printer.
515 .TP 5
516 CUPS\-Get\-Classes
517 Gets a list of printer classes.
518 .TP 5
519 CUPS\-Get\-Default
520 Gets the server default printer or printer class.
521 .TP 5
522 CUPS\-Get\-Devices
523 Gets a list of devices that are currently available.
524 .TP 5
525 CUPS\-Get\-Document
526 Gets a document file for a job.
527 .TP 5
528 CUPS\-Get\-PPD
529 Gets a PPD file.
530 .TP 5
531 CUPS\-Get\-PPDs
532 Gets a list of installed PPD files.
533 .TP 5
534 CUPS\-Get\-Printers
535 Gets a list of printers.
536 .TP 5
537 CUPS\-Move\-Job
538 Moves a job.
539 .TP 5
540 CUPS\-Reject\-Jobs
541 Prevents a printer from accepting new jobs.
542 .TP 5
543 CUPS\-Set\-Default
544 Sets the server default printer or printer class.
545 .TP 5
546 Cancel\-Job
547 Cancels a job.
548 .TP 5
549 Cancel\-Jobs
550 Cancels one or more jobs.
551 .TP 5
552 Cancel\-My\-Jobs
553 Cancels one or more jobs creates by a user.
554 .TP 5
555 Cancel\-Subscription
556 Cancels a subscription.
557 .TP 5
558 Close\-Job
559 Closes a job that is waiting for more documents.
560 .TP 5
561 Create\-Job
562 Creates a new job with no documents.
563 .TP 5
564 Create\-Job\-Subscriptions
565 Creates a subscription for job events.
566 .TP 5
567 Create\-Printer\-Subscriptions
568 Creates a subscription for printer events.
569 .TP 5
570 Get\-Job\-Attributes
571 Gets information about a job.
572 .TP 5
573 Get\-Jobs
574 Gets a list of jobs.
575 .TP 5
576 Get\-Notifications
577 Gets a list of event notifications for a subscription.
578 .TP 5
579 Get\-Printer\-Attributes
580 Gets information about a printer or printer class.
581 .TP 5
582 Get\-Subscription\-Attributes
583 Gets information about a subscription.
584 .TP 5
585 Get\-Subscriptions
586 Gets a list of subscriptions.
587 .TP 5
588 Hold\-Job
589 Holds a job from printing.
590 .TP 5
591 Hold\-New\-Jobs
592 Holds all new jobs from printing.
593 .TP 5
594 Pause\-Printer
595 Stops processing of jobs by a printer or printer class.
596 .TP 5
597 Pause\-Printer\-After\-Current\-Job
598 Stops processing of jobs by a printer or printer class after the current job is finished.
599 .TP 5
600 Print\-Job
601 Creates a new job with a single document.
602 .TP 5
603 Purge\-Jobs
604 Cancels one or more jobs and deletes the job history.
605 .TP 5
606 Release\-Held\-New\-Jobs
607 Allows previously held jobs to print.
608 .TP 5
609 Release\-Job
610 Allows a job to print.
611 .TP 5
612 Renew\-Subscription
613 Renews a subscription.
614 .TP 5
615 Restart\-Job
616 Reprints a job, if possible.
617 .TP 5
618 Send\-Document
619 Adds a document to a job.
620 .TP 5
621 Set\-Job\-Attributes
622 Changes job information.
623 .TP 5
624 Set\-Printer\-Attributes
625 Changes printer or printer class information.
626 .TP 5
627 Validate\-Job
628 Validates options for a new job.
629 .SS LOCATION PATHS
630 The following paths are commonly used when configuring
631 .BR cupsd (8):
632 .TP 5
633 /
634 The path for all get operations (get-printers, get-jobs, etc.)
635 .TP 5
636 /admin
637 The path for all administration operations (add-printer, delete-printer, start-printer, etc.)
638 .TP 5
639 /admin/conf
640 The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.)
641 .TP 5
642 /admin/log
643 The path for access to the CUPS log files (access_log, error_log, page_log)
644 .TP 5
645 /classes
646 The path for all printer classes
647 .TP 5
648 /classes/name
649 The resource for the named printer class
650 .TP 5
651 /jobs
652 The path for all jobs (hold-job, release-job, etc.)
653 .TP 5
654 /jobs/id
655 The path for the specified job
656 .TP 5
657 /printers
658 The path for all printers
659 .TP 5
660 /printers/name
661 The path for the named printer
662 .TP 5
663 /printers/name.png
664 The icon file path for the named printer
665 .TP 5
666 /printers/name.ppd
667 The PPD file path for the named printer
668 .SS DIRECTIVES VALID WITHIN LOCATION AND LIMIT SECTIONS
669 The following directives may be placed inside Location and Limit sections in the \fBcupsd.conf\fR file:
670 .TP 5
671 \fBAllow all\fR
672 .TP 5
673 \fBAllow none\fR
674 .TP 5
675 \fBAllow \fIhost.domain.com\fR
676 .TP 5
677 \fBAllow *.\fIdomain.com\fR
678 .TP 5
679 \fBAllow \fIipv4-address\fR
680 .TP 5
681 \fBAllow \fIipv4-address\fB/\fInetmask\fR
682 .TP 5
683 \fBAllow \fIipv4-address\fB/\fImm\fR
684 .TP 5
685 \fBAllow [\fIipv6-address\fB]\fR
686 .TP 5
687 \fBAllow [\fIipv6-address\fB]/\fImm\fR
688 .TP 5
689 \fBAllow @IF(\fIname\fB)\fR
690 .TP 5
691 \fBAllow @LOCAL\fR
692 Allows access from the named hosts, domains, addresses, or interfaces.
693 The Order directive controls whether Allow lines are evaluated before or after Deny lines.
694 .TP 5
695 \fBAuthType None\fR
696 .TP 5
697 \fBAuthType Basic\fR
698 .TP 5
699 \fBAuthType Default\fR
700 .TP 5
701 \fBAuthType Negotiate\fR
702 Specifies the type of authentication required.
703 The value "Default" corresponds to the DefaultAuthType value.
704 .TP 5
705 \fBDeny all\fR
706 .TP 5
707 \fBDeny none\fR
708 .TP 5
709 \fBDeny \fIhost.domain.com\fR
710 .TP 5
711 \fBDeny *.\fIdomain.com\fR
712 .TP 5
713 \fBDeny \fIipv4-address\fR
714 .TP 5
715 \fBDeny \fIipv4-address\fB/\fInetmask\fR
716 .TP 5
717 \fBDeny \fIipv4-address\fB/\fImm\fR
718 .TP 5
719 \fBDeny [\fIipv6-address\fB]\fR
720 .TP 5
721 \fBDeny [\fIipv6-address\fB]/\fImm\fR
722 .TP 5
723 \fBDeny @IF(\fIname\fB)\fR
724 .TP 5
725 \fBDeny @LOCAL\fR
726 Denies access from the named hosts, domains, addresses, or interfaces.
727 The Order directive controls whether Deny lines are evaluated before or after Allow lines.
728 .TP 5
729 \fBEncryption IfRequested\fR
730 .TP 5
731 \fBEncryption Never\fR
732 .TP 5
733 \fBEncryption Required\fR
734 Specifies the level of encryption that is required for a particular location.
735 The default value is "IfRequested".
736 .TP 5
737 \fBOrder allow,deny\fR
738 Specifies that access is denied by default. Allow lines are then processed followed by Deny lines to determine whether a client may access a particular resource.
739 .TP 5
740 \fBOrder deny,allow\fR
741 Specifies that access is allowed by default. Deny lines are then processed followed by Allow lines to determine whether a client may access a particular resource.
742 .TP 5
743 \fBRequire group \fIgroup-name \fR[ \fIgroup-name \fR... ]
744 Specifies that an authenticated user must be a member of one of the named groups.
745 .TP 5
746 \fBRequire user {\fIuser-name\fR|\fB@\fIgroup-name\fR} ...
747 Specifies that an authenticated user must match one of the named users or be a member of one of the named groups.
748 The group name "@SYSTEM" corresponds to the list of groups defined by the SystemGroup directive in the
749 .BR cups-files.conf (5)
750 file.
751 The group name "@OWNER" corresponds to the owner of the resource, for example the person that submitted a print job.
752 Note: The 'root' user is not special and must be granted privileges like any other user account.
753 .TP 5
754 \fBRequire valid-user\fR
755 Specifies that any authenticated user is acceptable.
756 .TP 5
757 \fBSatisfy all\fR
758 Specifies that all Allow, AuthType, Deny, Order, and Require conditions must be satisfied to allow access.
759 .TP 5
760 \fBSatisfy any\fR
761 Specifies that any a client may access a resource if either the authentication (AuthType/Require) or address (Allow/Deny/Order) conditions are satisfied.
762 For example, this can be used to require authentication only for remote accesses.
763 .SS DIRECTIVES VALID WITHIN POLICY SECTIONS
764 The following directives may be placed inside Policy sections in the \fBcupsd.conf\fR file:
765 .TP 5
766 \fBJobPrivateAccess all\fR
767 .TP 5
768 \fBJobPrivateAccess default\fR
769 .TP 5
770 \fBJobPrivateAccess \fR{\fIuser\fR|\fB@\fIgroup\fR|\fB@ACL\fR|\fB@OWNER\fR|\fB@SYSTEM\fR} ...
771 Specifies an access list for a job's private values.
772 The "default" access list is "@OWNER @SYSTEM".
773 "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
774 "@OWNER" maps to the job's owner.
775 "@SYSTEM" maps to the groups listed for the SystemGroup directive in the
776 .BR cups-files.conf (5)
777 file.
778 .TP 5
779 \fBJobPrivateValues all\fR
780 .TP 5
781 \fBJobPrivateValues default\fR
782 .TP 5
783 \fBJobPrivateValues none\fR
784 .TP 5
785 \fBJobPrivateValues \fIattribute-name \fR[ ... \fIattribute-name \fR]
786 Specifies the list of job values to make private.
787 The "default" values are "job-name", "job-originating-host-name", "job-originating-user-name", and "phone".
788 .TP 5
789 \fBSubscriptionPrivateAccess all\fR
790 .TP 5
791 \fBSubscriptionPrivateAccess default\fR
792 .TP 5
793 \fBSubscriptionPrivateAccess \fR{\fIuser\fR|\fB@\fIgroup\fR|\fB@ACL\fR|\fB@OWNER\fR|\fB@SYSTEM\fR} ...
794 Specifies an access list for a subscription's private values.
795 The "default" access list is "@OWNER @SYSTEM".
796 "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
797 "@OWNER" maps to the job's owner.
798 "@SYSTEM" maps to the groups listed for the SystemGroup directive in the
799 .BR cups-files.conf (5)
800 file.
801 .TP 5
802 \fBSubscriptionPrivateValues all\fR
803 .TP 5
804 \fBSubscriptionPrivateValues default\fR
805 .TP 5
806 \fBSubscriptionPrivateValues none\fR
807 .TP 5
808 \fBSubscriptionPrivateValues \fIattribute-name \fR[ ... \fIattribute-name \fR]
809 Specifies the list of subscription values to make private.
810 The "default" values are "notify-events", "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and "notify-user-data".
811 .SS DEPRECATED DIRECTIVES
812 The following directives are deprecated and will be removed in a future release of CUPS:
813 .\"#Classification
814 .TP 5
815 \fBClassification \fIbanner\fR
816 .br
817 Specifies the security classification of the server.
818 Any valid banner name can be used, including "classified", "confidential", "secret", "topsecret", and "unclassified", or the banner can be omitted to disable secure printing functions.
819 The default is no classification banner.
820 .\"#ClassifyOverride
821 .TP 5
822 \fBClassifyOverride Yes\fR
823 .TP 5
824 \fBClassifyOverride No\fR
825 .br
826 Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option.
827 The default is "No".
828 .\"#PageLogFormat
829 .TP 5
830 \fBPageLogFormat \fIformat-string\fR
831 Specifies the format of PageLog lines.
832 Sequences beginning with percent (%) characters are replaced with the corresponding information, while all other characters are copied literally.
833 The following percent sequences are recognized:
834 .nf
835
836     "%%" inserts a single percent character.
837     "%{name}" inserts the value of the specified IPP attribute.
838     "%C" inserts the number of copies for the current page.
839     "%P" inserts the current page number.
840     "%T" inserts the current date and time in common log format.
841     "%j" inserts the job ID.
842     "%p" inserts the printer name.
843     "%u" inserts the username.
844
845 .fi
846 The default is the empty string, which disables page logging.
847 The string "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}" creates a page log with the standard items.
848 Use "%{job-impressions-completed}" to insert the number of pages (sides) that were printed, or "%{job-media-sheets-completed}" to insert the number of sheets that were printed.
849 .\"#RIPCache
850 .TP 5
851 \fBRIPCache \fIsize\fR
852 Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.
853 The default is "128m".
854 .SH NOTES
855 File, directory, and user configuration directives that used to be allowed in the \fBcupsd.conf\fR file are now stored in the
856 .BR cups-files.conf (5)
857 file instead in order to prevent certain types of privilege escalation attacks.
858 .PP
859 The scheduler MUST be restarted manually after making changes to the \fBcupsd.conf\fR file.
860 On Linux this is typically done using the
861 .BR systemctl (8)
862 command, while on macOS the
863 .BR launchctl (8)
864 command is used instead.
865 .SH CONFORMING TO
866 The \fBcupsd.conf\fR file format is based on the Apache HTTP Server configuration file format.
867 .SH EXAMPLES
868 Log everything with a maximum log file size of 32 megabytes:
869 .nf
870
871     AccessLogLevel all
872     LogLevel debug2
873     MaxLogSize 32m
874
875 .fi
876 Require authentication for accesses from outside the 10. network:
877 .nf
878
879     <Location />
880     Order allow,deny
881     Allow from 10./8
882     AuthType Basic
883     Require valid-user
884     Satisfy any
885     </Location>
886 .fi
887 .SH SEE ALSO
888 .BR classes.conf (5),
889 .BR cups-files.conf (5),
890 .BR cupsd (8),
891 .BR mime.convs (5),
892 .BR mime.types (5),
893 .BR printers.conf (5),
894 .BR subscriptions.conf (5),
895 CUPS Online Help (http://localhost:631/help)
896 .SH COPYRIGHT
897 Copyright \[co] 2007-2019 by Apple Inc.