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