]> git.ipfire.org Git - thirdparty/cups.git/blame - doc/help/man-cupsd.conf.html
projects / thirdparty / cups.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Kerberos credentials could get truncated when printing to a shared printer.
[thirdparty/cups.git] / doc / help / man-cupsd.conf.html
CommitLineData
62b97abe 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<!-- SECTION: Man Pages -->
4<head>
5 <link rel="stylesheet" type="text/css" href="../cups-printable.css">
6 <title>cupsd.conf(5)</title>
7</head>
8<body>
9<h1 class="title">cupsd.conf(5)</h1>
10<h2 class="title"><a name="NAME">Name</a></h2>
11cupsd.conf - server configuration file for cups
12<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
13The <i>cupsd.conf</i> file configures the CUPS scheduler, <a href='man-cupsd.html?TOPIC=Man+Pages'>cupsd(8)</a>. It
579b6de1 14is normally located in the <i>/private/etc/cups</i> directory. <b>Note:</b>
62b97abe 15File, directory, and user configuration directives that used to be allowed in
16the <i>cupsd.conf</i> file are now stored in the <a href='man-cups-files.conf.html?TOPIC=Man+Pages'>cups-files.conf(5)</a> instead
17in order to prevent certain types of privilege escalation attacks.
18<p>Each line in the file can be a configuration directive, a blank line,
19or a comment. Comment lines start with the # character. The
20configuration directives are intentionally similar to those used by the
21popular Apache web server software and are described below.
22<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
23The following directives are understood by <a href='man-cupsd.html?TOPIC=Man+Pages'>cupsd(8)</a>. Consult the
24on-line help for detailed descriptions:
25<dl>
26<dt>AccessLogLevel config
27</dt>
28<dd></dd>
29<dt>AccessLogLevel actions
30</dt>
31<dd></dd>
32<dt>AccessLogLevel all
33</dt>
34<dd></dd>
35<dd>Specifies the logging level for the AccessLog file.
36</dd>
37<dt>Allow all
38</dt>
39<dd></dd>
40<dt>Allow none
41</dt>
42<dd></dd>
43<dt>Allow host.domain.com
44</dt>
45<dd></dd>
46<dt>Allow *.domain.com
47</dt>
48<dd></dd>
49<dt>Allow ip-address
50</dt>
51<dd></dd>
52<dt>Allow ip-address/netmask
53</dt>
54<dd></dd>
55<dt>Allow ip-address/mm
56</dt>
57<dd></dd>
58<dt>Allow @IF(name)
59</dt>
60<dd></dd>
61<dt>Allow @LOCAL
62</dt>
63<dd></dd>
64<dd>Allows access from the named hosts or addresses.
65</dd>
66<dt>AuthType None
67</dt>
68<dd></dd>
69<dt>AuthType Basic
70</dt>
71<dd></dd>
72<dt>AuthType BasicDigest
73</dt>
74<dd></dd>
75<dt>AuthType Digest
76</dt>
77<dd></dd>
78<dt>AuthType Negotiate
79</dt>
80<dd></dd>
81<dd>Specifies the authentication type (None, Basic, BasicDigest, Digest, Negotiate)
82</dd>
83<dt>AutoPurgeJobs Yes
84</dt>
85<dd></dd>
86<dt>AutoPurgeJobs No
87</dt>
88<dd></dd>
89<dd>Specifies whether to purge job history data automatically when
90it is no longer required for quotas.
91</dd>
92<dt>BrowseLocalProtocols [All] [DNSSD]
93</dt>
94<dd></dd>
95<dd>Specifies the protocols to use for local printer sharing.
96</dd>
97<dt>BrowseWebIF Yes
98</dt>
99<dd></dd>
100<dt>BrowseWebIF No
101</dt>
102<dd></dd>
103<dd>Specifies whether the CUPS web interface is advertised via DNS-SD.
104</dd>
105<dt>Browsing Yes
106</dt>
107<dd></dd>
108<dt>Browsing No
109</dt>
110<dd></dd>
111<dd>Specifies whether or not shared printers should be advertised.
112</dd>
113<dt>Classification banner
114</dt>
115<dd></dd>
116<dd>Specifies the security classification of the server.
117</dd>
118<dt>ClassifyOverride Yes
119</dt>
120<dd></dd>
121<dt>ClassifyOverride No
122</dt>
123<dd></dd>
124<dd>Specifies whether to allow users to override the classification
125of individual print jobs.
126</dd>
127<dt>DefaultAuthType Basic
128</dt>
129<dd></dd>
130<dt>DefaultAuthType BasicDigest
131</dt>
132<dd></dd>
133<dt>DefaultAuthType Digest
134</dt>
135<dd></dd>
136<dt>DefaultAuthType Negotiate
137</dt>
138<dd></dd>
139<dd>Specifies the default type of authentication to use.
140</dd>
141<dt>DefaultEncryption Never
142</dt>
143<dd></dd>
144<dt>DefaultEncryption IfRequested
145</dt>
146<dd></dd>
147<dt>DefaultEncryption Required
148</dt>
149<dd></dd>
150<dd>Specifies the type of encryption to use for authenticated requests.
151</dd>
152<dt>DefaultLanguage locale
153</dt>
154<dd></dd>
155<dd>Specifies the default language to use for text and web content.
156</dd>
157<dt>DefaultPaperSize Auto
158</dt>
159<dd></dd>
160<dt>DefaultPaperSize None
161</dt>
162<dd></dd>
163<dt>DefaultPaperSize sizename
164</dt>
165<dd></dd>
166<dd>Specifies the default paper size for new print queues. "Auto" uses a locale-
167specific default, while "None" specifies there is no default paper size.
168</dd>
169<dt>DefaultPolicy policy-name
170</dt>
171<dd></dd>
172<dd>Specifies the default access policy to use.
173</dd>
174<dt>DefaultShared Yes
175</dt>
176<dd></dd>
177<dt>DefaultShared No
178</dt>
179<dd></dd>
180<dd>Specifies whether local printers are shared by default.
181</dd>
182<dt>Deny all
183</dt>
184<dd></dd>
185<dt>Deny none
186</dt>
187<dd></dd>
188<dt>Deny host.domain.com
189</dt>
190<dd></dd>
191<dt>Deny *.domain.com
192</dt>
193<dd></dd>
194<dt>Deny ip-address
195</dt>
196<dd></dd>
197<dt>Deny ip-address/netmask
198</dt>
199<dd></dd>
200<dt>Deny ip-address/mm
201</dt>
202<dd></dd>
203<dt>Deny @IF(name)
204</dt>
205<dd></dd>
206<dt>Deny @LOCAL
207</dt>
208<dd></dd>
209<dd>Denies access to the named host or address.
210</dd>
211<dt>DirtyCleanInterval seconds
212</dt>
213<dd></dd>
214<dd>Specifies the delay for updating of configuration and state files. A value of 0
215causes the update to happen as soon as possible, typically within a few
216milliseconds.
217</dd>
218<dt>Encryption IfRequested
219</dt>
220<dd></dd>
221<dt>Encryption Never
222</dt>
223<dd></dd>
224<dt>Encryption Required
225</dt>
226<dd></dd>
227<dd>Specifies the level of encryption that is required for a particular
228location.
229</dd>
230<dt>FilterLimit limit
231</dt>
232<dd></dd>
233<dd>Specifies the maximum cost of filters that are run concurrently.
234</dd>
235<dt>FilterNice nice-value
236</dt>
237<dd></dd>
238<dd>Specifies the scheduling priority ("nice" value) of filters that
239are run to print a job.
240</dd>
241<dt>GSSServiceName name
242</dt>
243<dd></dd>
244<dd>Specifies the service name when using Kerberos authentication. The default
245service name is "host".
246</dd>
247<dt>HostNameLookups On
248</dt>
249<dd></dd>
250<dt>HostNameLookups Off
251</dt>
252<dd></dd>
253<dt>HostNameLookups Double
254</dt>
255<dd></dd>
256<dd>Specifies whether or not to do reverse lookups on client addresses.
257</dd>
258<dt>Include filename
259</dt>
260<dd></dd>
261<dd>Includes the named file.
262</dd>
263<dt>JobKillDelay seconds
264</dt>
265<dd></dd>
266<dd>Specifies the number of seconds to wait before killing the filters and backend
267associated with a canceled or held job.
268</dd>
269<dt>JobPrivateAccess all
270</dt>
271<dd></dd>
272<dt>JobPrivateAccess default
273</dt>
274<dd></dd>
275<dt>JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
276</dt>
277<dd></dd>
278<dd>Specifies an access list for a job's private values. The "default" access list
279is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed
280or requesting-user-name-denied values.
281</dd>
282<dt>JobPrivateValues all
283</dt>
284<dd></dd>
285<dt>JobPrivateValues default
286</dt>
287<dd></dd>
288<dt>JobPrivateValues none
289</dt>
290<dd></dd>
291<dt>JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
292</dt>
293<dd>Specifies the list of job values to make private. The "default" values are
294"job-name", "job-originating-host-name", and "job-originating-user-name".
295</dd>
296<dt>JobRetryInterval seconds
297</dt>
298<dd></dd>
299<dd>Specifies the interval between retries of jobs in seconds.
300</dd>
301<dt>JobRetryLimit count
302</dt>
303<dd></dd>
304<dd>Specifies the number of retries that are done for jobs.
305</dd>
306<dt>KeepAlive Yes
307</dt>
308<dd></dd>
309<dt>KeepAlive No
310</dt>
311<dd></dd>
312<dd>Specifies whether to support HTTP keep-alive connections.
313</dd>
314<dt>KeepAliveTimeout seconds
315</dt>
316<dd></dd>
317<dd>Specifies the amount of time that connections are kept alive.
318</dd>
319<dt>&lt;Limit operations> ... &lt;/Limit>
320</dt>
321<dd></dd>
322<dd>Specifies the IPP operations that are being limited inside a policy.
323</dd>
324<dt>&lt;Limit methods> ... &lt;/Limit>
325</dt>
326<dd></dd>
327<dt>&lt;LimitExcept methods> ... &lt;/LimitExcept>
328</dt>
329<dd></dd>
330<dd>Specifies the HTTP methods that are being limited inside a location.
331</dd>
332<dt>LimitRequestBody
333</dt>
334<dd></dd>
335<dd>Specifies the maximum size of any print job request.
336</dd>
337<dt>Listen ip-address:port
338</dt>
339<dd></dd>
340<dt>Listen *:port
341</dt>
342<dd></dd>
343<dt>Listen /path/to/domain/socket
344</dt>
345<dd></dd>
346<dd>Listens to the specified address and port or domain socket path.
347</dd>
348<dt>&lt;Location /path> ... &lt;/Location>
349</dt>
350<dd></dd>
351<dd>Specifies access control for the named location.
352</dd>
353<dt>LogDebugHistory #-messages
354</dt>
355<dd></dd>
356<dd>Specifies the number of debugging messages that are logged when an error
357occurs in a print job.
358</dd>
359<dt>LogLevel alert
360</dt>
361<dd></dd>
362<dt>LogLevel crit
363</dt>
364<dd></dd>
365<dt>LogLevel debug2
366</dt>
367<dd></dd>
368<dt>LogLevel debug
369</dt>
370<dd></dd>
371<dt>LogLevel emerg
372</dt>
373<dd></dd>
374<dt>LogLevel error
375</dt>
376<dd></dd>
377<dt>LogLevel info
378</dt>
379<dd></dd>
380<dt>LogLevel none
381</dt>
382<dd></dd>
383<dt>LogLevel notice
384</dt>
385<dd></dd>
386<dt>LogLevel warn
387</dt>
388<dd></dd>
389<dd>Specifies the logging level for the ErrorLog file.
390</dd>
391<dt>LogTimeFormat standard
392</dt>
393<dd></dd>
394<dt>LogTimeFormat usecs
395</dt>
396<dd></dd>
397<dd>Specifies the format of the date and time in the log files.
398</dd>
399<dt>MaxClients number
400</dt>
401<dd></dd>
402<dd>Specifies the maximum number of simultaneous clients to support.
403</dd>
404<dt>MaxClientsPerHost number
405</dt>
406<dd></dd>
407<dd>Specifies the maximum number of simultaneous clients to support from a
408single address.
409</dd>
410<dt>MaxCopies number
411</dt>
412<dd></dd>
413<dd>Specifies the maximum number of copies that a user can print of each job.
414</dd>
415<dt>MaxHoldTime seconds
416</dt>
417<dd></dd>
418<dd>Specifies the maximum time a job may remain in the "indefinite" hold state
419before it is canceled. Set to 0 to disable cancellation of held jobs.
420</dd>
421<dt>MaxJobs number
422</dt>
423<dd></dd>
424<dd>Specifies the maximum number of simultaneous jobs to support.
425</dd>
426<dt>MaxJobsPerPrinter number
427</dt>
428<dd></dd>
429<dd>Specifies the maximum number of simultaneous jobs per printer to support.
430</dd>
431<dt>MaxJobsPerUser number
432</dt>
433<dd></dd>
434<dd>Specifies the maximum number of simultaneous jobs per user to support.
435</dd>
436<dt>MaxJobTime seconds
437</dt>
438<dd></dd>
439<dd>Specifies the maximum time a job may take to print before it is canceled. The
440default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck"
441jobs.
442</dd>
443<dt>MaxLogSize number-bytes
444</dt>
445<dd></dd>
446<dd>Specifies the maximum size of the log files before they are
447rotated (0 to disable rotation)
448</dd>
449<dt>MaxRequestSize number-bytes
450</dt>
451<dd></dd>
452<dd>Specifies the maximum request/file size in bytes (0 for no limit)
453</dd>
454<dt>MultipleOperationTimeout seconds
455</dt>
456<dd></dd>
457<dd>Specifies the maximum amount of time to allow between files in a multiple file
458print job.
459</dd>
460<dt>Order allow,deny
461</dt>
462<dd></dd>
463<dt>Order deny,allow
464</dt>
465<dd></dd>
466<dd>Specifies the order of HTTP access control (allow,deny or deny,allow)
467</dd>
468<dt>PageLogFormat format string
469</dt>
470<dd></dd>
471<dd>Specifies the format of page log lines.
472</dd>
473<dt>PassEnv variable [... variable]
474</dt>
475<dd></dd>
476<dd>Passes the specified environment variable(s) to child processes.
477</dd>
478<dt>&lt;Policy name> ... &lt;/Policy>
479</dt>
480<dd></dd>
481<dd>Specifies access control for the named policy.
482</dd>
483<dt>Port number
484</dt>
485<dd></dd>
486<dd>Specifies a port number to listen to for HTTP requests.
487</dd>
488<dt>PreserveJobFiles Yes
489</dt>
490<dd></dd>
491<dt>PreserveJobFiles No
492</dt>
493<dd></dd>
494<dd>Specifies whether or not to preserve job files after they are printed.
495</dd>
496<dt>PreserveJobHistory Yes
497</dt>
498<dd></dd>
499<dt>PreserveJobHistory No
500</dt>
501<dd></dd>
502<dd>Specifies whether or not to preserve the job history after they are
503printed.
504</dd>
505<dt>PrintcapFormat bsd
506</dt>
507<dd></dd>
508<dt>PrintcapFormat plist
509</dt>
510<dd></dd>
511<dt>PrintcapFormat solaris
512</dt>
513<dd></dd>
514<dd>Specifies the format of the printcap file.
515</dd>
516<dt>ReloadTimeout seconds
517</dt>
518<dd></dd>
519<dd>Specifies the amount of time to wait for job completion before
520restarting the scheduler.
521</dd>
522<dt>Require group group-name-list
523</dt>
524<dd></dd>
525<dt>Require user user-name-list
526</dt>
527<dd></dd>
528<dt>Require valid-user
529</dt>
530<dd></dd>
531<dd>Specifies that user or group authentication is required.
532</dd>
533<dt>RIPCache bytes
534</dt>
535<dd></dd>
536<dd>Specifies the maximum amount of memory to use when converting images
537and PostScript files to bitmaps for a printer.
538</dd>
539<dt>Satisfy all
540</dt>
541<dd></dd>
542<dt>Satisfy any
543</dt>
544<dd></dd>
545<dd>Specifies whether all or any limits set for a Location must be
546satisfied to allow access.
547</dd>
548<dt>ServerAdmin user@domain.com
549</dt>
550<dd></dd>
551<dd>Specifies the email address of the server administrator.
552</dd>
553<dt>ServerAlias hostname [... hostname]
554</dt>
555<dd></dd>
556<dt>ServerAlias *
557</dt>
558<dd></dd>
559<dd>Specifies an alternate name that the server is known by. The special name "*"
560allows any name to be used.
561</dd>
562<dt>ServerName hostname-or-ip-address
563</dt>
564<dd></dd>
565<dd>Specifies the fully-qualified hostname of the server.
566</dd>
567<dt>ServerTokens Full
568</dt>
569<dd></dd>
570<dt>ServerTokens Major
571</dt>
572<dd></dd>
573<dt>ServerTokens Minimal
574</dt>
575<dd></dd>
576<dt>ServerTokens Minor
577</dt>
578<dd></dd>
579<dt>ServerTokens None
580</dt>
581<dd></dd>
582<dt>ServerTokens OS
583</dt>
584<dd></dd>
585<dt>ServerTokens ProductOnly
586</dt>
587<dd></dd>
588<dd>Specifies what information is included in the Server header of HTTP
589responses.
590</dd>
591<dt>SetEnv variable value
592</dt>
593<dd></dd>
594<dd>Set the specified environment variable to be passed to child processes.
595</dd>
596<dt>SSLListen
597</dt>
598<dd></dd>
599<dd>Listens on the specified address and port for encrypted connections.
600</dd>
601<dt>SSLOptions None
602</dt>
603<dd></dd>
604<dt>SSLOptions NoEmptyFragments
605</dt>
606<dd></dd>
607<dd>Sets SSL/TLS protocol options for encrypted connections.
608</dd>
609<dt>SSLPort
610</dt>
611<dd></dd>
612<dd>Listens on the specified port for encrypted connections.
613</dd>
614<dt>StrictConformance Yes
615</dt>
616<dd></dd>
617<dt>StrictConformance No
618</dt>
619<dd></dd>
620<dd>Specifies whether the scheduler requires clients to strictly adhere to the IPP
621specifications. The default is No.
622</dd>
623<dt>SubscriptionPrivateAccess all
624</dt>
625<dd></dd>
626<dt>SubscriptionPrivateAccess default
627</dt>
628<dd></dd>
629<dt>SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
630</dt>
631<dd></dd>
632<dd>Specifies an access list for a subscription's private values. The "default"
633access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
634requesting-user-name-allowed or requesting-user-name-denied values.
635</dd>
636<dt>SubscriptionPrivateValues all
637</dt>
638<dd></dd>
639<dt>SubscriptionPrivateValues default
640</dt>
641<dd></dd>
642<dt>SubscriptionPrivateValues none
643</dt>
644<dd></dd>
645<dt>SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
646</dt>
647<dd>Specifies the list of job values to make private. The "default" values are
648"notify-events", "notify-pull-method", "notify-recipient-uri",
649"notify-subscriber-user-name", and "notify-user-data".
650</dd>
651<dt>Timeout seconds
652</dt>
653<dd></dd>
654<dd>Specifies the HTTP request timeout in seconds.
655</dd>
656<dt>WebInterface yes
657</dt>
658<dd></dd>
659<dt>WebInterface no
660</dt>
661<dd>Specifies whether the web interface is enabled.
662</dd>
663</dl>
664<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
665<a href='man-classes.conf.html?TOPIC=Man+Pages'>classes.conf(5)</a>, <a href='man-cups-files.conf.html?TOPIC=Man+Pages'>cups-files.conf(5)</a>, <a href='man-cupsd.html?TOPIC=Man+Pages'>cupsd(8)</a>,
666<a href='man-mime.convs.html?TOPIC=Man+Pages'>mime.convs(5)</a>, <a href='man-mime.types.html?TOPIC=Man+Pages'>mime.types(5)</a>, <a href='man-printers.conf.html?TOPIC=Man+Pages'>printers.conf(5)</a>,
667<a href='man-subscriptions.conf.html?TOPIC=Man+Pages'>subscriptions.conf(5)</a>,
668<br>
669<a href='http://localhost:631/help'>http://localhost:631/help</a>
670<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
671Copyright 2007-2013 by Apple Inc.
672
673</body>
674</html>
Unnamed repository; edit this file 'description' to name the repository.