]> 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
Import CUPS v1.7.5
[thirdparty/cups.git] / doc / help / man-cupsd.conf.html
CommitLineData
94436c5a
MS		 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
ffa2ca90 14is normally located in the <i>/etc/cups</i> directory. <b>Note:</b>
94436c5a
MS		 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>
b60086f8
MS		 230<dt>ErrorPolicy abort-job
231</dt>
232<dd>Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer.
233</dd>
234<dt>ErrorPolicy retry-job
235</dt>
236<dd>Specifies that a failed print job should be retried at a later time unless otherwise specified for the printer.
237</dd>
238<dt>ErrorPolicy retry-this-job
239</dt>
240<dd>Specifies that a failed print job should be retried immediately unless otherwise specified for the printer.
241</dd>
242<dt>ErrorPolicy stop-printer
243</dt>
244<dd>Specifies that a failed print job should stop the printer unless otherwise specified for the printer. The 'stop-printer' error policy is the default.
245</dd>
94436c5a
MS		 246<dt>FilterLimit limit
247</dt>
248<dd></dd>
249<dd>Specifies the maximum cost of filters that are run concurrently.
250</dd>
251<dt>FilterNice nice-value
252</dt>
253<dd></dd>
254<dd>Specifies the scheduling priority ("nice" value) of filters that
255are run to print a job.
256</dd>
257<dt>GSSServiceName name
258</dt>
259<dd></dd>
260<dd>Specifies the service name when using Kerberos authentication. The default
ffa2ca90 261service name is "http".
94436c5a
MS		 262</dd>
263<dt>HostNameLookups On
264</dt>
265<dd></dd>
266<dt>HostNameLookups Off
267</dt>
268<dd></dd>
269<dt>HostNameLookups Double
270</dt>
271<dd></dd>
272<dd>Specifies whether or not to do reverse lookups on client addresses.
273</dd>
274<dt>Include filename
275</dt>
276<dd></dd>
277<dd>Includes the named file.
278</dd>
279<dt>JobKillDelay seconds
280</dt>
281<dd></dd>
282<dd>Specifies the number of seconds to wait before killing the filters and backend
283associated with a canceled or held job.
284</dd>
285<dt>JobPrivateAccess all
286</dt>
287<dd></dd>
288<dt>JobPrivateAccess default
289</dt>
290<dd></dd>
291<dt>JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
292</dt>
293<dd></dd>
294<dd>Specifies an access list for a job's private values. The "default" access list
295is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed
296or requesting-user-name-denied values.
297</dd>
298<dt>JobPrivateValues all
299</dt>
300<dd></dd>
301<dt>JobPrivateValues default
302</dt>
303<dd></dd>
304<dt>JobPrivateValues none
305</dt>
306<dd></dd>
307<dt>JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
308</dt>
309<dd>Specifies the list of job values to make private. The "default" values are
310"job-name", "job-originating-host-name", and "job-originating-user-name".
311</dd>
312<dt>JobRetryInterval seconds
313</dt>
314<dd></dd>
315<dd>Specifies the interval between retries of jobs in seconds.
316</dd>
317<dt>JobRetryLimit count
318</dt>
319<dd></dd>
320<dd>Specifies the number of retries that are done for jobs.
321</dd>
322<dt>KeepAlive Yes
323</dt>
324<dd></dd>
325<dt>KeepAlive No
326</dt>
327<dd></dd>
328<dd>Specifies whether to support HTTP keep-alive connections.
329</dd>
330<dt>KeepAliveTimeout seconds
331</dt>
332<dd></dd>
333<dd>Specifies the amount of time that connections are kept alive.
334</dd>
335<dt>&lt;Limit operations> ... &lt;/Limit>
336</dt>
337<dd></dd>
338<dd>Specifies the IPP operations that are being limited inside a policy.
339</dd>
340<dt>&lt;Limit methods> ... &lt;/Limit>
341</dt>
342<dd></dd>
343<dt>&lt;LimitExcept methods> ... &lt;/LimitExcept>
344</dt>
345<dd></dd>
346<dd>Specifies the HTTP methods that are being limited inside a location.
347</dd>
348<dt>LimitRequestBody
349</dt>
350<dd></dd>
351<dd>Specifies the maximum size of any print job request.
352</dd>
353<dt>Listen ip-address:port
354</dt>
355<dd></dd>
356<dt>Listen *:port
357</dt>
358<dd></dd>
359<dt>Listen /path/to/domain/socket
360</dt>
361<dd></dd>
362<dd>Listens to the specified address and port or domain socket path.
363</dd>
364<dt>&lt;Location /path> ... &lt;/Location>
365</dt>
366<dd></dd>
367<dd>Specifies access control for the named location.
368</dd>
369<dt>LogDebugHistory #-messages
370</dt>
371<dd></dd>
372<dd>Specifies the number of debugging messages that are logged when an error
373occurs in a print job.
374</dd>
375<dt>LogLevel alert
376</dt>
377<dd></dd>
378<dt>LogLevel crit
379</dt>
380<dd></dd>
381<dt>LogLevel debug2
382</dt>
383<dd></dd>
384<dt>LogLevel debug
385</dt>
386<dd></dd>
387<dt>LogLevel emerg
388</dt>
389<dd></dd>
390<dt>LogLevel error
391</dt>
392<dd></dd>
393<dt>LogLevel info
394</dt>
395<dd></dd>
396<dt>LogLevel none
397</dt>
398<dd></dd>
399<dt>LogLevel notice
400</dt>
401<dd></dd>
402<dt>LogLevel warn
403</dt>
404<dd></dd>
405<dd>Specifies the logging level for the ErrorLog file.
406</dd>
407<dt>LogTimeFormat standard
408</dt>
409<dd></dd>
410<dt>LogTimeFormat usecs
411</dt>
412<dd></dd>
413<dd>Specifies the format of the date and time in the log files.
414</dd>
415<dt>MaxClients number
416</dt>
417<dd></dd>
418<dd>Specifies the maximum number of simultaneous clients to support.
419</dd>
420<dt>MaxClientsPerHost number
421</dt>
422<dd></dd>
423<dd>Specifies the maximum number of simultaneous clients to support from a
424single address.
425</dd>
426<dt>MaxCopies number
427</dt>
428<dd></dd>
429<dd>Specifies the maximum number of copies that a user can print of each job.
430</dd>
431<dt>MaxHoldTime seconds
432</dt>
433<dd></dd>
434<dd>Specifies the maximum time a job may remain in the "indefinite" hold state
435before it is canceled. Set to 0 to disable cancellation of held jobs.
436</dd>
437<dt>MaxJobs number
438</dt>
439<dd></dd>
440<dd>Specifies the maximum number of simultaneous jobs to support.
441</dd>
442<dt>MaxJobsPerPrinter number
443</dt>
444<dd></dd>
445<dd>Specifies the maximum number of simultaneous jobs per printer to support.
446</dd>
447<dt>MaxJobsPerUser number
448</dt>
449<dd></dd>
450<dd>Specifies the maximum number of simultaneous jobs per user to support.
451</dd>
452<dt>MaxJobTime seconds
453</dt>
454<dd></dd>
455<dd>Specifies the maximum time a job may take to print before it is canceled. The
456default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck"
457jobs.
458</dd>
459<dt>MaxLogSize number-bytes
460</dt>
461<dd></dd>
462<dd>Specifies the maximum size of the log files before they are
463rotated (0 to disable rotation)
464</dd>
465<dt>MaxRequestSize number-bytes
466</dt>
467<dd></dd>
468<dd>Specifies the maximum request/file size in bytes (0 for no limit)
469</dd>
470<dt>MultipleOperationTimeout seconds
471</dt>
472<dd></dd>
473<dd>Specifies the maximum amount of time to allow between files in a multiple file
474print job.
475</dd>
476<dt>Order allow,deny
477</dt>
478<dd></dd>
479<dt>Order deny,allow
480</dt>
481<dd></dd>
482<dd>Specifies the order of HTTP access control (allow,deny or deny,allow)
483</dd>
484<dt>PageLogFormat format string
485</dt>
486<dd></dd>
487<dd>Specifies the format of page log lines.
488</dd>
489<dt>PassEnv variable [... variable]
490</dt>
491<dd></dd>
492<dd>Passes the specified environment variable(s) to child processes.
493</dd>
494<dt>&lt;Policy name> ... &lt;/Policy>
495</dt>
496<dd></dd>
497<dd>Specifies access control for the named policy.
498</dd>
499<dt>Port number
500</dt>
501<dd></dd>
502<dd>Specifies a port number to listen to for HTTP requests.
503</dd>
504<dt>PreserveJobFiles Yes
505</dt>
506<dd></dd>
507<dt>PreserveJobFiles No
508</dt>
509<dd></dd>
510<dd>Specifies whether or not to preserve job files after they are printed.
511</dd>
512<dt>PreserveJobHistory Yes
513</dt>
514<dd></dd>
515<dt>PreserveJobHistory No
516</dt>
517<dd></dd>
518<dd>Specifies whether or not to preserve the job history after they are
519printed.
520</dd>
521<dt>PrintcapFormat bsd
522</dt>
523<dd></dd>
524<dt>PrintcapFormat plist
525</dt>
526<dd></dd>
527<dt>PrintcapFormat solaris
528</dt>
529<dd></dd>
530<dd>Specifies the format of the printcap file.
531</dd>
532<dt>ReloadTimeout seconds
533</dt>
534<dd></dd>
535<dd>Specifies the amount of time to wait for job completion before
536restarting the scheduler.
537</dd>
538<dt>Require group group-name-list
539</dt>
540<dd></dd>
541<dt>Require user user-name-list
542</dt>
543<dd></dd>
544<dt>Require valid-user
545</dt>
546<dd></dd>
547<dd>Specifies that user or group authentication is required.
548</dd>
549<dt>RIPCache bytes
550</dt>
551<dd></dd>
552<dd>Specifies the maximum amount of memory to use when converting images
553and PostScript files to bitmaps for a printer.
554</dd>
555<dt>Satisfy all
556</dt>
557<dd></dd>
558<dt>Satisfy any
559</dt>
560<dd></dd>
561<dd>Specifies whether all or any limits set for a Location must be
562satisfied to allow access.
563</dd>
564<dt>ServerAdmin user@domain.com
565</dt>
566<dd></dd>
567<dd>Specifies the email address of the server administrator.
568</dd>
569<dt>ServerAlias hostname [... hostname]
570</dt>
571<dd></dd>
572<dt>ServerAlias *
573</dt>
574<dd></dd>
575<dd>Specifies an alternate name that the server is known by. The special name "*"
576allows any name to be used.
577</dd>
578<dt>ServerName hostname-or-ip-address
579</dt>
580<dd></dd>
581<dd>Specifies the fully-qualified hostname of the server.
582</dd>
583<dt>ServerTokens Full
584</dt>
585<dd></dd>
586<dt>ServerTokens Major
587</dt>
588<dd></dd>
589<dt>ServerTokens Minimal
590</dt>
591<dd></dd>
592<dt>ServerTokens Minor
593</dt>
594<dd></dd>
595<dt>ServerTokens None
596</dt>
597<dd></dd>
598<dt>ServerTokens OS
599</dt>
600<dd></dd>
601<dt>ServerTokens ProductOnly
602</dt>
603<dd></dd>
604<dd>Specifies what information is included in the Server header of HTTP
605responses.
606</dd>
607<dt>SetEnv variable value
608</dt>
609<dd></dd>
610<dd>Set the specified environment variable to be passed to child processes.
611</dd>
612<dt>SSLListen
613</dt>
614<dd></dd>
615<dd>Listens on the specified address and port for encrypted connections.
616</dd>
617<dt>SSLOptions None
618</dt>
619<dd></dd>
620<dt>SSLOptions NoEmptyFragments
621</dt>
622<dd></dd>
623<dd>Sets SSL/TLS protocol options for encrypted connections.
624</dd>
625<dt>SSLPort
626</dt>
627<dd></dd>
628<dd>Listens on the specified port for encrypted connections.
629</dd>
630<dt>StrictConformance Yes
631</dt>
632<dd></dd>
633<dt>StrictConformance No
634</dt>
635<dd></dd>
636<dd>Specifies whether the scheduler requires clients to strictly adhere to the IPP
637specifications. The default is No.
638</dd>
639<dt>SubscriptionPrivateAccess all
640</dt>
641<dd></dd>
642<dt>SubscriptionPrivateAccess default
643</dt>
644<dd></dd>
645<dt>SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
646</dt>
647<dd></dd>
648<dd>Specifies an access list for a subscription's private values. The "default"
649access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
650requesting-user-name-allowed or requesting-user-name-denied values.
651</dd>
652<dt>SubscriptionPrivateValues all
653</dt>
654<dd></dd>
655<dt>SubscriptionPrivateValues default
656</dt>
657<dd></dd>
658<dt>SubscriptionPrivateValues none
659</dt>
660<dd></dd>
661<dt>SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
662</dt>
663<dd>Specifies the list of job values to make private. The "default" values are
664"notify-events", "notify-pull-method", "notify-recipient-uri",
665"notify-subscriber-user-name", and "notify-user-data".
666</dd>
667<dt>Timeout seconds
668</dt>
669<dd></dd>
670<dd>Specifies the HTTP request timeout in seconds.
671</dd>
672<dt>WebInterface yes
673</dt>
674<dd></dd>
675<dt>WebInterface no
676</dt>
677<dd>Specifies whether the web interface is enabled.
678</dd>
679</dl>
680<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
681<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>,
682<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>,
683<a href='man-subscriptions.conf.html?TOPIC=Man+Pages'>subscriptions.conf(5)</a>,
684<br>
685<a href='http://localhost:631/help'>http://localhost:631/help</a>
686<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
687Copyright 2007-2013 by Apple Inc.
688
689</body>
690</html>
Unnamed repository; edit this file 'description' to name the repository.