]> git.ipfire.org Git - thirdparty/cups.git/blame - man/cupsd.conf.man.in
Import CUPS v1.7.5
[thirdparty/cups.git] / man / cupsd.conf.man.in
CommitLineData
ef416fc2 1.\"
b60086f8 2.\" "$Id: cupsd.conf.man.in 12060 2014-07-28 14:04:41Z msweet $"
ef416fc2 3.\"
321d8d57 4.\" cupsd.conf man page for CUPS.
ef416fc2 5.\"
0fa6c7fa 6.\" Copyright 2007-2013 by Apple Inc.
bd7854cb 7.\" Copyright 1997-2006 by Easy Software Products.
ef416fc2 8.\"
9.\" These coded instructions, statements, and computer programs are the
bc44d920 10.\" property of Apple Inc. and are protected by Federal copyright
11.\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
12.\" which should have been included with this file. If this file is
13.\" file is missing or damaged, see the license at "http://www.cups.org/".
ef416fc2 14.\"
b60086f8 15.TH cupsd.conf 5 "CUPS" "28 July 2014" "Apple Inc."
ef416fc2 16.SH NAME
17cupsd.conf \- server configuration file for cups
18.SH DESCRIPTION
19The \fIcupsd.conf\fR file configures the CUPS scheduler, \fIcupsd(8)\fR. It
ffa2ca90 20is normally located in the \fI/etc/cups\fR directory. \fBNote:\fR
c41769ff
MS
21File, directory, and user configuration directives that used to be allowed in
22the \fIcupsd.conf\fR file are now stored in the \fIcups-files.conf(5)\fR instead
23in order to prevent certain types of privilege escalation attacks.
ef416fc2 24.LP
25Each line in the file can be a configuration directive, a blank line,
26or a comment. Comment lines start with the # character. The
27configuration directives are intentionally similar to those used by the
28popular Apache web server software and are described below.
29.SH DIRECTIVES
bd7854cb 30The following directives are understood by \fIcupsd(8)\fR. Consult the
31on-line help for detailed descriptions:
ef416fc2 32.TP 5
1f0275e3
MS
33AccessLogLevel config
34.TP 5
35AccessLogLevel actions
36.TP 5
37AccessLogLevel all
38.br
39Specifies the logging level for the AccessLog file.
40.TP 5
bd7854cb 41Allow all
42.TP 5
43Allow none
44.TP 5
45Allow host.domain.com
46.TP 5
47Allow *.domain.com
48.TP 5
49Allow ip-address
50.TP 5
51Allow ip-address/netmask
52.TP 5
53Allow ip-address/mm
54.TP 5
55Allow @IF(name)
56.TP 5
57Allow @LOCAL
ef416fc2 58.br
59Allows access from the named hosts or addresses.
60.TP 5
bd7854cb 61AuthType None
62.TP 5
63AuthType Basic
64.TP 5
65AuthType BasicDigest
66.TP 5
67AuthType Digest
f7deaa1a 68.TP 5
2e4ff8af 69AuthType Negotiate
ef416fc2 70.br
2e4ff8af 71Specifies the authentication type (None, Basic, BasicDigest, Digest, Negotiate)
ef416fc2 72.TP 5
bd7854cb 73AutoPurgeJobs Yes
74.TP 5
75AutoPurgeJobs No
ef416fc2 76.br
77Specifies whether to purge job history data automatically when
78it is no longer required for quotas.
79.TP 5
a2326b5b 80BrowseLocalProtocols [All] [DNSSD]
749b1e90 81.br
a2326b5b 82Specifies the protocols to use for local printer sharing.
ef416fc2 83.TP 5
b19ccc9e
MS
84BrowseWebIF Yes
85.TP 5
86BrowseWebIF No
87.br
88Specifies whether the CUPS web interface is advertised via DNS-SD.
89.TP 5
bd7854cb 90Browsing Yes
91.TP 5
92Browsing No
ef416fc2 93.br
c41769ff 94Specifies whether or not shared printers should be advertised.
ef416fc2 95.TP 5
bd7854cb 96Classification banner
ef416fc2 97.br
98Specifies the security classification of the server.
99.TP 5
bd7854cb 100ClassifyOverride Yes
101.TP 5
102ClassifyOverride No
ef416fc2 103.br
104Specifies whether to allow users to override the classification
105of individual print jobs.
106.TP 5
bd7854cb 107DefaultAuthType Basic
108.TP 5
109DefaultAuthType BasicDigest
110.TP 5
111DefaultAuthType Digest
f7deaa1a 112.TP 5
2e4ff8af 113DefaultAuthType Negotiate
ef416fc2 114.br
115Specifies the default type of authentication to use.
116.TP 5
8b450588
MS
117DefaultEncryption Never
118.TP 5
119DefaultEncryption IfRequested
120.TP 5
121DefaultEncryption Required
122.br
123Specifies the type of encryption to use for authenticated requests.
124.TP 5
bd7854cb 125DefaultLanguage locale
ef416fc2 126.br
127Specifies the default language to use for text and web content.
128.TP 5
49d87452
MS
129DefaultPaperSize Auto
130.TP 5
131DefaultPaperSize None
132.TP 5
133DefaultPaperSize sizename
134.br
135Specifies the default paper size for new print queues. "Auto" uses a locale-
136specific default, while "None" specifies there is no default paper size.
137.TP 5
bd7854cb 138DefaultPolicy policy-name
ef416fc2 139.br
140Specifies the default access policy to use.
141.TP 5
3d052e43
MS
142DefaultShared Yes
143.TP 5
144DefaultShared No
145.br
146Specifies whether local printers are shared by default.
147.TP 5
bd7854cb 148Deny all
149.TP 5
150Deny none
151.TP 5
152Deny host.domain.com
153.TP 5
154Deny *.domain.com
155.TP 5
156Deny ip-address
157.TP 5
158Deny ip-address/netmask
159.TP 5
160Deny ip-address/mm
161.TP 5
162Deny @IF(name)
163.TP 5
164Deny @LOCAL
ef416fc2 165.br
166Denies access to the named host or address.
167.TP 5
4a4b4f99
MS
168DirtyCleanInterval seconds
169.br
170Specifies the delay for updating of configuration and state files. A value of 0
171causes the update to happen as soon as possible, typically within a few
172milliseconds.
173.TP 5
bd7854cb 174Encryption IfRequested
175.TP 5
176Encryption Never
177.TP 5
178Encryption Required
ef416fc2 179.br
180Specifies the level of encryption that is required for a particular
181location.
182.TP 5
b60086f8
MS
183ErrorPolicy abort-job
184Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer.
185.TP 5
186ErrorPolicy retry-job
187Specifies that a failed print job should be retried at a later time unless otherwise specified for the printer.
188.TP 5
189ErrorPolicy retry-this-job
190Specifies that a failed print job should be retried immediately unless otherwise specified for the printer.
191.TP 5
192ErrorPolicy stop-printer
193Specifies that a failed print job should stop the printer unless otherwise specified for the printer. The 'stop-printer' error policy is the default.
194.TP 5
bd7854cb 195FilterLimit limit
ef416fc2 196.br
197Specifies the maximum cost of filters that are run concurrently.
198.TP 5
bd7854cb 199FilterNice nice-value
ef416fc2 200.br
201Specifies the scheduling priority ("nice" value) of filters that
202are run to print a job.
203.TP 5
dcb445bc
MS
204GSSServiceName name
205.br
206Specifies the service name when using Kerberos authentication. The default
ffa2ca90 207service name is "http".
dcb445bc 208.TP 5
dd1abb6b 209HostNameLookups On
bd7854cb 210.TP 5
dd1abb6b 211HostNameLookups Off
bd7854cb 212.TP 5
213HostNameLookups Double
ef416fc2 214.br
215Specifies whether or not to do reverse lookups on client addresses.
216.TP 5
bd7854cb 217Include filename
ef416fc2 218.br
219Includes the named file.
220.TP 5
238c3832
MS
221JobKillDelay seconds
222.br
223Specifies the number of seconds to wait before killing the filters and backend
224associated with a canceled or held job.
225.TP 5
10d09e33
MS
226JobPrivateAccess all
227.TP 5
228JobPrivateAccess default
229.TP 5
230JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
231.br
232Specifies an access list for a job's private values. The "default" access list
233is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed
234or requesting-user-name-denied values.
235.TP 5
236JobPrivateValues all
237.TP 5
238JobPrivateValues default
239.TP 5
240JobPrivateValues none
241.TP 5
242JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
243Specifies the list of job values to make private. The "default" values are
244"job-name", "job-originating-host-name", and "job-originating-user-name".
245.TP 5
bd7854cb 246JobRetryInterval seconds
ef416fc2 247.br
248Specifies the interval between retries of jobs in seconds.
249.TP 5
bd7854cb 250JobRetryLimit count
ef416fc2 251.br
252Specifies the number of retries that are done for jobs.
253.TP 5
80ca4592 254KeepAlive Yes
255.TP 5
256KeepAlive No
ef416fc2 257.br
80ca4592 258Specifies whether to support HTTP keep-alive connections.
ef416fc2 259.TP 5
80ca4592 260KeepAliveTimeout seconds
ef416fc2 261.br
80ca4592 262Specifies the amount of time that connections are kept alive.
ef416fc2 263.TP 5
264<Limit operations> ... </Limit>
265.br
266Specifies the IPP operations that are being limited inside a policy.
267.TP 5
268<Limit methods> ... </Limit>
269.TP 5
270<LimitExcept methods> ... </LimitExcept>
271.br
272Specifies the HTTP methods that are being limited inside a location.
273.TP 5
274LimitRequestBody
275.br
276Specifies the maximum size of any print job request.
277.TP 5
bd7854cb 278Listen ip-address:port
279.TP 5
280Listen *:port
ed486911 281.TP 5
282Listen /path/to/domain/socket
ef416fc2 283.br
ed486911 284Listens to the specified address and port or domain socket path.
ef416fc2 285.TP 5
286<Location /path> ... </Location>
287.br
288Specifies access control for the named location.
289.TP 5
178cb736
MS
290LogDebugHistory #-messages
291.br
292Specifies the number of debugging messages that are logged when an error
293occurs in a print job.
294.TP 5
bd7854cb 295LogLevel alert
296.TP 5
297LogLevel crit
298.TP 5
299LogLevel debug2
300.TP 5
301LogLevel debug
302.TP 5
303LogLevel emerg
304.TP 5
305LogLevel error
306.TP 5
307LogLevel info
308.TP 5
309LogLevel none
310.TP 5
311LogLevel notice
312.TP 5
313LogLevel warn
ef416fc2 314.br
bd7854cb 315Specifies the logging level for the ErrorLog file.
ef416fc2 316.TP 5
dfd5680b
MS
317LogTimeFormat standard
318.TP 5
319LogTimeFormat usecs
320.br
321Specifies the format of the date and time in the log files.
322.TP 5
bd7854cb 323MaxClients number
ef416fc2 324.br
325Specifies the maximum number of simultaneous clients to support.
326.TP 5
bd7854cb 327MaxClientsPerHost number
ef416fc2 328.br
329Specifies the maximum number of simultaneous clients to support from a
330single address.
331.TP 5
bd7854cb 332MaxCopies number
ef416fc2 333.br
334Specifies the maximum number of copies that a user can print of each job.
335.TP 5
3e7fe0ca
MS
336MaxHoldTime seconds
337.br
338Specifies the maximum time a job may remain in the "indefinite" hold state
339before it is canceled. Set to 0 to disable cancellation of held jobs.
340.TP 5
bd7854cb 341MaxJobs number
ef416fc2 342.br
343Specifies the maximum number of simultaneous jobs to support.
344.TP 5
bd7854cb 345MaxJobsPerPrinter number
ef416fc2 346.br
347Specifies the maximum number of simultaneous jobs per printer to support.
348.TP 5
bd7854cb 349MaxJobsPerUser number
ef416fc2 350.br
351Specifies the maximum number of simultaneous jobs per user to support.
352.TP 5
dcb445bc
MS
353MaxJobTime seconds
354.br
355Specifies the maximum time a job may take to print before it is canceled. The
356default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck"
357jobs.
358.TP 5
bd7854cb 359MaxLogSize number-bytes
ef416fc2 360.br
361Specifies the maximum size of the log files before they are
362rotated (0 to disable rotation)
363.TP 5
bd7854cb 364MaxRequestSize number-bytes
ef416fc2 365.br
366Specifies the maximum request/file size in bytes (0 for no limit)
367.TP 5
dfd5680b
MS
368MultipleOperationTimeout seconds
369.br
370Specifies the maximum amount of time to allow between files in a multiple file
371print job.
372.TP 5
bd7854cb 373Order allow,deny
374.TP 5
375Order deny,allow
ef416fc2 376.br
377Specifies the order of HTTP access control (allow,deny or deny,allow)
378.TP 5
01ce6322
MS
379PageLogFormat format string
380.br
381Specifies the format of page log lines.
382.TP 5
ef416fc2 383PassEnv variable [... variable]
384.br
385Passes the specified environment variable(s) to child processes.
386.TP 5
387<Policy name> ... </Policy>
388.br
389Specifies access control for the named policy.
390.TP 5
bd7854cb 391Port number
ef416fc2 392.br
393Specifies a port number to listen to for HTTP requests.
394.TP 5
bd7854cb 395PreserveJobFiles Yes
396.TP 5
397PreserveJobFiles No
ef416fc2 398.br
399Specifies whether or not to preserve job files after they are printed.
400.TP 5
bd7854cb 401PreserveJobHistory Yes
402.TP 5
403PreserveJobHistory No
ef416fc2 404.br
405Specifies whether or not to preserve the job history after they are
406printed.
407.TP 5
bd7854cb 408PrintcapFormat bsd
ef416fc2 409.TP 5
0af14961
MS
410PrintcapFormat plist
411.TP 5
bd7854cb 412PrintcapFormat solaris
ef416fc2 413.br
414Specifies the format of the printcap file.
415.TP 5
bd7854cb 416ReloadTimeout seconds
ef416fc2 417.br
418Specifies the amount of time to wait for job completion before
419restarting the scheduler.
420.TP 5
bd7854cb 421Require group group-name-list
422.TP 5
423Require user user-name-list
424.TP 5
425Require valid-user
ef416fc2 426.br
427Specifies that user or group authentication is required.
428.TP 5
bd7854cb 429RIPCache bytes
ef416fc2 430.br
431Specifies the maximum amount of memory to use when converting images
432and PostScript files to bitmaps for a printer.
433.TP 5
bd7854cb 434Satisfy all
ef416fc2 435.TP 5
bd7854cb 436Satisfy any
ef416fc2 437.br
438Specifies whether all or any limits set for a Location must be
439satisfied to allow access.
440.TP 5
bd7854cb 441ServerAdmin user@domain.com
ef416fc2 442.br
443Specifies the email address of the server administrator.
444.TP 5
88f9aafc
MS
445ServerAlias hostname [... hostname]
446.TP 5
447ServerAlias *
e07d4801
MS
448.br
449Specifies an alternate name that the server is known by. The special name "*"
450allows any name to be used.
451.TP 5
bd7854cb 452ServerName hostname-or-ip-address
ef416fc2 453.br
454Specifies the fully-qualified hostname of the server.
455.TP 5
bd7854cb 456ServerTokens Full
457.TP 5
458ServerTokens Major
459.TP 5
460ServerTokens Minimal
461.TP 5
462ServerTokens Minor
463.TP 5
464ServerTokens None
465.TP 5
466ServerTokens OS
467.TP 5
468ServerTokens ProductOnly
ef416fc2 469.br
470Specifies what information is included in the Server header of HTTP
471responses.
472.TP 5
473SetEnv variable value
474.br
475Set the specified environment variable to be passed to child processes.
476.TP 5
477SSLListen
478.br
479Listens on the specified address and port for encrypted connections.
480.TP 5
b19ccc9e
MS
481SSLOptions None
482.TP 5
483SSLOptions NoEmptyFragments
484.br
485Sets SSL/TLS protocol options for encrypted connections.
486.TP 5
ef416fc2 487SSLPort
488.br
489Listens on the specified port for encrypted connections.
490.TP 5
a29fd7dd
MS
491StrictConformance Yes
492.TP 5
493StrictConformance No
494.br
495Specifies whether the scheduler requires clients to strictly adhere to the IPP
496specifications. The default is No.
497.TP 5
10d09e33
MS
498SubscriptionPrivateAccess all
499.TP 5
500SubscriptionPrivateAccess default
501.TP 5
502SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
503.br
504Specifies an access list for a subscription's private values. The "default"
505access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
506requesting-user-name-allowed or requesting-user-name-denied values.
507.TP 5
508SubscriptionPrivateValues all
509.TP 5
510SubscriptionPrivateValues default
511.TP 5
512SubscriptionPrivateValues none
513.TP 5
514SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
515Specifies the list of job values to make private. The "default" values are
516"notify-events", "notify-pull-method", "notify-recipient-uri",
517"notify-subscriber-user-name", and "notify-user-data".
518.TP 5
bd7854cb 519Timeout seconds
ef416fc2 520.br
521Specifies the HTTP request timeout in seconds.
522.TP 5
229681c1
MS
523WebInterface yes
524.TP 5
525WebInterface no
526Specifies whether the web interface is enabled.
ef416fc2 527.SH SEE ALSO
c41769ff
MS
528\fIclasses.conf(5)\fR, \fIcups-files.conf(5)\fR, \fIcupsd(8)\fR,
529\fImime.convs(5)\fR, \fImime.types(5)\fR, \fIprinters.conf(5)\fR,
bd7854cb 530\fIsubscriptions.conf(5)\fR,
531.br
532http://localhost:631/help
ef416fc2 533.SH COPYRIGHT
0fa6c7fa 534Copyright 2007-2013 by Apple Inc.
ef416fc2 535.\"
b60086f8 536.\" End of "$Id: cupsd.conf.man.in 12060 2014-07-28 14:04:41Z msweet $".
ef416fc2 537.\"