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