]> git.ipfire.org Git - thirdparty/cups.git/blame - man/cupsd.conf.man.in
Import CUPS v1.7.1
[thirdparty/cups.git] / man / cupsd.conf.man.in
CommitLineData
ef416fc2 1.\"
61515785 2.\" "$Id: cupsd.conf.man.in 11109 2013-07-08 21:15:13Z 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.\"
ffa2ca90 15.TH cupsd.conf 5 "CUPS" "8 July 2013" "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
bd7854cb 183FilterLimit limit
ef416fc2 184.br
185Specifies the maximum cost of filters that are run concurrently.
186.TP 5
bd7854cb 187FilterNice nice-value
ef416fc2 188.br
189Specifies the scheduling priority ("nice" value) of filters that
190are run to print a job.
191.TP 5
dcb445bc
MS
192GSSServiceName name
193.br
194Specifies the service name when using Kerberos authentication. The default
ffa2ca90 195service name is "http".
dcb445bc 196.TP 5
dd1abb6b 197HostNameLookups On
bd7854cb 198.TP 5
dd1abb6b 199HostNameLookups Off
bd7854cb 200.TP 5
201HostNameLookups Double
ef416fc2 202.br
203Specifies whether or not to do reverse lookups on client addresses.
204.TP 5
bd7854cb 205Include filename
ef416fc2 206.br
207Includes the named file.
208.TP 5
238c3832
MS
209JobKillDelay seconds
210.br
211Specifies the number of seconds to wait before killing the filters and backend
212associated with a canceled or held job.
213.TP 5
10d09e33
MS
214JobPrivateAccess all
215.TP 5
216JobPrivateAccess default
217.TP 5
218JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
219.br
220Specifies an access list for a job's private values. The "default" access list
221is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed
222or requesting-user-name-denied values.
223.TP 5
224JobPrivateValues all
225.TP 5
226JobPrivateValues default
227.TP 5
228JobPrivateValues none
229.TP 5
230JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
231Specifies the list of job values to make private. The "default" values are
232"job-name", "job-originating-host-name", and "job-originating-user-name".
233.TP 5
bd7854cb 234JobRetryInterval seconds
ef416fc2 235.br
236Specifies the interval between retries of jobs in seconds.
237.TP 5
bd7854cb 238JobRetryLimit count
ef416fc2 239.br
240Specifies the number of retries that are done for jobs.
241.TP 5
80ca4592 242KeepAlive Yes
243.TP 5
244KeepAlive No
ef416fc2 245.br
80ca4592 246Specifies whether to support HTTP keep-alive connections.
ef416fc2 247.TP 5
80ca4592 248KeepAliveTimeout seconds
ef416fc2 249.br
80ca4592 250Specifies the amount of time that connections are kept alive.
ef416fc2 251.TP 5
252<Limit operations> ... </Limit>
253.br
254Specifies the IPP operations that are being limited inside a policy.
255.TP 5
256<Limit methods> ... </Limit>
257.TP 5
258<LimitExcept methods> ... </LimitExcept>
259.br
260Specifies the HTTP methods that are being limited inside a location.
261.TP 5
262LimitRequestBody
263.br
264Specifies the maximum size of any print job request.
265.TP 5
bd7854cb 266Listen ip-address:port
267.TP 5
268Listen *:port
ed486911 269.TP 5
270Listen /path/to/domain/socket
ef416fc2 271.br
ed486911 272Listens to the specified address and port or domain socket path.
ef416fc2 273.TP 5
274<Location /path> ... </Location>
275.br
276Specifies access control for the named location.
277.TP 5
178cb736
MS
278LogDebugHistory #-messages
279.br
280Specifies the number of debugging messages that are logged when an error
281occurs in a print job.
282.TP 5
bd7854cb 283LogLevel alert
284.TP 5
285LogLevel crit
286.TP 5
287LogLevel debug2
288.TP 5
289LogLevel debug
290.TP 5
291LogLevel emerg
292.TP 5
293LogLevel error
294.TP 5
295LogLevel info
296.TP 5
297LogLevel none
298.TP 5
299LogLevel notice
300.TP 5
301LogLevel warn
ef416fc2 302.br
bd7854cb 303Specifies the logging level for the ErrorLog file.
ef416fc2 304.TP 5
dfd5680b
MS
305LogTimeFormat standard
306.TP 5
307LogTimeFormat usecs
308.br
309Specifies the format of the date and time in the log files.
310.TP 5
bd7854cb 311MaxClients number
ef416fc2 312.br
313Specifies the maximum number of simultaneous clients to support.
314.TP 5
bd7854cb 315MaxClientsPerHost number
ef416fc2 316.br
317Specifies the maximum number of simultaneous clients to support from a
318single address.
319.TP 5
bd7854cb 320MaxCopies number
ef416fc2 321.br
322Specifies the maximum number of copies that a user can print of each job.
323.TP 5
3e7fe0ca
MS
324MaxHoldTime seconds
325.br
326Specifies the maximum time a job may remain in the "indefinite" hold state
327before it is canceled. Set to 0 to disable cancellation of held jobs.
328.TP 5
bd7854cb 329MaxJobs number
ef416fc2 330.br
331Specifies the maximum number of simultaneous jobs to support.
332.TP 5
bd7854cb 333MaxJobsPerPrinter number
ef416fc2 334.br
335Specifies the maximum number of simultaneous jobs per printer to support.
336.TP 5
bd7854cb 337MaxJobsPerUser number
ef416fc2 338.br
339Specifies the maximum number of simultaneous jobs per user to support.
340.TP 5
dcb445bc
MS
341MaxJobTime seconds
342.br
343Specifies the maximum time a job may take to print before it is canceled. The
344default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck"
345jobs.
346.TP 5
bd7854cb 347MaxLogSize number-bytes
ef416fc2 348.br
349Specifies the maximum size of the log files before they are
350rotated (0 to disable rotation)
351.TP 5
bd7854cb 352MaxRequestSize number-bytes
ef416fc2 353.br
354Specifies the maximum request/file size in bytes (0 for no limit)
355.TP 5
dfd5680b
MS
356MultipleOperationTimeout seconds
357.br
358Specifies the maximum amount of time to allow between files in a multiple file
359print job.
360.TP 5
bd7854cb 361Order allow,deny
362.TP 5
363Order deny,allow
ef416fc2 364.br
365Specifies the order of HTTP access control (allow,deny or deny,allow)
366.TP 5
01ce6322
MS
367PageLogFormat format string
368.br
369Specifies the format of page log lines.
370.TP 5
ef416fc2 371PassEnv variable [... variable]
372.br
373Passes the specified environment variable(s) to child processes.
374.TP 5
375<Policy name> ... </Policy>
376.br
377Specifies access control for the named policy.
378.TP 5
bd7854cb 379Port number
ef416fc2 380.br
381Specifies a port number to listen to for HTTP requests.
382.TP 5
bd7854cb 383PreserveJobFiles Yes
384.TP 5
385PreserveJobFiles No
ef416fc2 386.br
387Specifies whether or not to preserve job files after they are printed.
388.TP 5
bd7854cb 389PreserveJobHistory Yes
390.TP 5
391PreserveJobHistory No
ef416fc2 392.br
393Specifies whether or not to preserve the job history after they are
394printed.
395.TP 5
bd7854cb 396PrintcapFormat bsd
ef416fc2 397.TP 5
0af14961
MS
398PrintcapFormat plist
399.TP 5
bd7854cb 400PrintcapFormat solaris
ef416fc2 401.br
402Specifies the format of the printcap file.
403.TP 5
bd7854cb 404ReloadTimeout seconds
ef416fc2 405.br
406Specifies the amount of time to wait for job completion before
407restarting the scheduler.
408.TP 5
bd7854cb 409Require group group-name-list
410.TP 5
411Require user user-name-list
412.TP 5
413Require valid-user
ef416fc2 414.br
415Specifies that user or group authentication is required.
416.TP 5
bd7854cb 417RIPCache bytes
ef416fc2 418.br
419Specifies the maximum amount of memory to use when converting images
420and PostScript files to bitmaps for a printer.
421.TP 5
bd7854cb 422Satisfy all
ef416fc2 423.TP 5
bd7854cb 424Satisfy any
ef416fc2 425.br
426Specifies whether all or any limits set for a Location must be
427satisfied to allow access.
428.TP 5
bd7854cb 429ServerAdmin user@domain.com
ef416fc2 430.br
431Specifies the email address of the server administrator.
432.TP 5
88f9aafc
MS
433ServerAlias hostname [... hostname]
434.TP 5
435ServerAlias *
e07d4801
MS
436.br
437Specifies an alternate name that the server is known by. The special name "*"
438allows any name to be used.
439.TP 5
bd7854cb 440ServerName hostname-or-ip-address
ef416fc2 441.br
442Specifies the fully-qualified hostname of the server.
443.TP 5
bd7854cb 444ServerTokens Full
445.TP 5
446ServerTokens Major
447.TP 5
448ServerTokens Minimal
449.TP 5
450ServerTokens Minor
451.TP 5
452ServerTokens None
453.TP 5
454ServerTokens OS
455.TP 5
456ServerTokens ProductOnly
ef416fc2 457.br
458Specifies what information is included in the Server header of HTTP
459responses.
460.TP 5
461SetEnv variable value
462.br
463Set the specified environment variable to be passed to child processes.
464.TP 5
465SSLListen
466.br
467Listens on the specified address and port for encrypted connections.
468.TP 5
b19ccc9e
MS
469SSLOptions None
470.TP 5
471SSLOptions NoEmptyFragments
472.br
473Sets SSL/TLS protocol options for encrypted connections.
474.TP 5
ef416fc2 475SSLPort
476.br
477Listens on the specified port for encrypted connections.
478.TP 5
a29fd7dd
MS
479StrictConformance Yes
480.TP 5
481StrictConformance No
482.br
483Specifies whether the scheduler requires clients to strictly adhere to the IPP
484specifications. The default is No.
485.TP 5
10d09e33
MS
486SubscriptionPrivateAccess all
487.TP 5
488SubscriptionPrivateAccess default
489.TP 5
490SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
491.br
492Specifies an access list for a subscription's private values. The "default"
493access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
494requesting-user-name-allowed or requesting-user-name-denied values.
495.TP 5
496SubscriptionPrivateValues all
497.TP 5
498SubscriptionPrivateValues default
499.TP 5
500SubscriptionPrivateValues none
501.TP 5
502SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
503Specifies the list of job values to make private. The "default" values are
504"notify-events", "notify-pull-method", "notify-recipient-uri",
505"notify-subscriber-user-name", and "notify-user-data".
506.TP 5
bd7854cb 507Timeout seconds
ef416fc2 508.br
509Specifies the HTTP request timeout in seconds.
510.TP 5
229681c1
MS
511WebInterface yes
512.TP 5
513WebInterface no
514Specifies whether the web interface is enabled.
ef416fc2 515.SH SEE ALSO
c41769ff
MS
516\fIclasses.conf(5)\fR, \fIcups-files.conf(5)\fR, \fIcupsd(8)\fR,
517\fImime.convs(5)\fR, \fImime.types(5)\fR, \fIprinters.conf(5)\fR,
bd7854cb 518\fIsubscriptions.conf(5)\fR,
519.br
520http://localhost:631/help
ef416fc2 521.SH COPYRIGHT
0fa6c7fa 522Copyright 2007-2013 by Apple Inc.
ef416fc2 523.\"
61515785 524.\" End of "$Id: cupsd.conf.man.in 11109 2013-07-08 21:15:13Z msweet $".
ef416fc2 525.\"