]> git.ipfire.org Git - thirdparty/cups.git/blame - man/cupsd.conf.man.in
projects / thirdparty / cups.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge changes from CUPS 1.4svn-r8290.
[thirdparty/cups.git] / man / cupsd.conf.man.in
CommitLineData
ef416fc2 1.\"
b19ccc9e 2.\" "$Id: cupsd.conf.man.in 7935 2008-09-11 01:54:11Z mike $"
ef416fc2 3.\"
4.\" cupsd.conf man page for the Common UNIX Printing System (CUPS).
5.\"
c168a833 6.\" Copyright 2007-2009 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.\"
8b450588 15.TH cupsd.conf 5 "Common UNIX Printing System" "8 December 2008" "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
bd7854cb 20is normally located in the \fI@CUPS_SERVERROOT@\fR directory.
ef416fc2 21.LP
22Each line in the file can be a configuration directive, a blank line,
23or a comment. Comment lines start with the # character. The
24configuration directives are intentionally similar to those used by the
25popular Apache web server software and are described below.
26.SH DIRECTIVES
bd7854cb 27The following directives are understood by \fIcupsd(8)\fR. Consult the
28on-line help for detailed descriptions:
ef416fc2 29.TP 5
bd7854cb 30AccessLog filename
31.TP 5
32AccessLog syslog
ef416fc2 33.br
34Defines the access log filename.
35.TP 5
1f0275e3
MS		 36AccessLogLevel config
37.TP 5
38AccessLogLevel actions
39.TP 5
40AccessLogLevel all
41.br
42Specifies the logging level for the AccessLog file.
43.TP 5
bd7854cb 44Allow all
45.TP 5
46Allow none
47.TP 5
48Allow host.domain.com
49.TP 5
50Allow *.domain.com
51.TP 5
52Allow ip-address
53.TP 5
54Allow ip-address/netmask
55.TP 5
56Allow ip-address/mm
57.TP 5
58Allow @IF(name)
59.TP 5
60Allow @LOCAL
ef416fc2 61.br
62Allows access from the named hosts or addresses.
63.TP 5
bd7854cb 64AuthClass User
65.TP 5
66AuthClass Group
67.TP 5
68AuthClass System
ef416fc2 69.br
bd7854cb 70Specifies the authentication class (User, Group, System) -
71\fBthis directive is deprecated\fR.
ef416fc2 72.TP 5
bd7854cb 73AuthGroupName group-name
ef416fc2 74.br
bd7854cb 75Specifies the authentication group - \fBthis directive is
76deprecated\fR.
ef416fc2 77.TP 5
bd7854cb 78AuthType None
79.TP 5
80AuthType Basic
81.TP 5
82AuthType BasicDigest
83.TP 5
84AuthType Digest
f7deaa1a 85.TP 5
2e4ff8af 86AuthType Negotiate
ef416fc2 87.br
2e4ff8af 88Specifies the authentication type (None, Basic, BasicDigest, Digest, Negotiate)
ef416fc2 89.TP 5
bd7854cb 90AutoPurgeJobs Yes
91.TP 5
92AutoPurgeJobs No
ef416fc2 93.br
94Specifies whether to purge job history data automatically when
95it is no longer required for quotas.
96.TP 5
bd7854cb 97BrowseAddress ip-address
98.TP 5
99BrowseAddress @IF(name)
100.TP 5
101BrowseAddress @LOCAL
ef416fc2 102.br
103Specifies a broadcast address for outgoing printer information packets.
104.TP 5
bd7854cb 105BrowseAllow all
106.TP 5
107BrowseAllow none
108.TP 5
109BrowseAllow host.domain.com
110.TP 5
111BrowseAllow *.domain.com
112.TP 5
113BrowseAllow ip-address
114.TP 5
115BrowseAllow ip-address/netmask
116.TP 5
117BrowseAllow ip-address/mm
118.TP 5
119BrowseAllow @IF(name)
120.TP 5
121BrowseAllow @LOCAL
ef416fc2 122.br
123Allows incoming printer information packets from the named host or address.
124.TP 5
bd7854cb 125BrowseDeny all
126.TP 5
127BrowseDeny none
128.TP 5
129BrowseDeny host.domain.com
130.TP 5
131BrowseDeny *.domain.com
132.TP 5
133BrowseDeny ip-address
134.TP 5
135BrowseDeny ip-address/netmask
136.TP 5
137BrowseDeny ip-address/mm
138.TP 5
139BrowseDeny @IF(name)
140.TP 5
141BrowseDeny @LOCAL
ef416fc2 142.br
143Denies incoming printer information packets from the named host or address.
144.TP 5
bd7854cb 145BrowseInterval seconds
ef416fc2 146.br
147Specifies the maximum interval between printer information broadcasts.
148.TP 5
749b1e90
MS		 149BrowseLDAPBindDN
150.br
151Specifies the LDAP domain name to use when registering printers.
152.TP 5
153BrowseLDAPCACertFile
154.br
155Specifies the SSL certificate authority file to use.
156.TP 5
157BrowseLDAPDN
158.br
159Specifies the LDAP domain name to use when discovering printers.
160.TP 5
161BrowseLDAPPassword
162.br
163Specifies the password to use when accessing the LDAP server.
164.TP 5
165BrowseLDAPServer
166.br
167Specifies the LDAP server to use.
168.TP 5
bd7854cb 169BrowseOrder allow,deny
170.TP 5
171BrowseOrder deny,allow
ef416fc2 172.br
173Specifies the order of printer information access control (allow,deny or deny,allow)
174.TP 5
bd7854cb 175BrowsePoll host-or-ip-address
ef416fc2 176.br
177Specifies a server to poll for printer information.
178.TP 5
bd7854cb 179BrowsePort port
ef416fc2 180.br
181Specifies the port to listen to for printer information packets.
182.TP 5
bd7854cb 183BrowseProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
ef416fc2 184.br
185Specifies the protocols to use for printer browsing.
186.TP 5
bd7854cb 187BrowseLocalProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
ef416fc2 188.br
189Specifies the protocols to use for local printer browsing.
190.TP 5
bd7854cb 191BrowseRemoteProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
ef416fc2 192.br
193Specifies the protocols to use for remote printer browsing.
194.TP 5
bd7854cb 195BrowseRelay from-address to-address
ef416fc2 196.br
197Specifies that printer information packets should be relayed from one host or
198network to another.
199.TP 5
bd7854cb 200BrowseShortNames Yes
201.TP 5
202BrowseShortNames No
ef416fc2 203.br
204Specifies whether remote printers will use short names ("printer") or not
205("printer@server"). This option is ignored if more than one remote printer
206exists with the same name.
207.TP 5
bd7854cb 208BrowseTimeout seconds
ef416fc2 209.br
210Specifies the maximum interval between printer information updates before
211remote printers will be removed from the list of available printers.
212.TP 5
b19ccc9e
MS		 213BrowseWebIF Yes
214.TP 5
215BrowseWebIF No
216.br
217Specifies whether the CUPS web interface is advertised via DNS-SD.
218.TP 5
bd7854cb 219Browsing Yes
220.TP 5
221Browsing No
ef416fc2 222.br
223Specifies whether or not remote printer browsing should be enabled.
224.TP 5
bd7854cb 225Classification banner
ef416fc2 226.br
227Specifies the security classification of the server.
228.TP 5
bd7854cb 229ClassifyOverride Yes
230.TP 5
231ClassifyOverride No
ef416fc2 232.br
233Specifies whether to allow users to override the classification
234of individual print jobs.
235.TP 5
bd7854cb 236ConfigFilePerm mode
ef416fc2 237.br
238Specifies the permissions for all configuration files that the scheduler
239writes.
240.TP 5
bd7854cb 241DataDir path
ef416fc2 242.br
243Specified the directory where data files can be found.
244.TP 5
bd7854cb 245DefaultAuthType Basic
246.TP 5
247DefaultAuthType BasicDigest
248.TP 5
249DefaultAuthType Digest
f7deaa1a 250.TP 5
2e4ff8af 251DefaultAuthType Negotiate
ef416fc2 252.br
253Specifies the default type of authentication to use.
254.TP 5
bd7854cb 255DefaultCharset charset
ef416fc2 256.br
257Specifies the default character set to use for text.
258.TP 5
8b450588
MS		 259DefaultEncryption Never
260.TP 5
261DefaultEncryption IfRequested
262.TP 5
263DefaultEncryption Required
264.br
265Specifies the type of encryption to use for authenticated requests.
266.TP 5
bd7854cb 267DefaultLanguage locale
ef416fc2 268.br
269Specifies the default language to use for text and web content.
270.TP 5
49d87452
MS		 271DefaultPaperSize Auto
272.TP 5
273DefaultPaperSize None
274.TP 5
275DefaultPaperSize sizename
276.br
277Specifies the default paper size for new print queues. "Auto" uses a locale-
278specific default, while "None" specifies there is no default paper size.
279.TP 5
bd7854cb 280DefaultPolicy policy-name
ef416fc2 281.br
282Specifies the default access policy to use.
283.TP 5
3d052e43
MS		 284DefaultShared Yes
285.TP 5
286DefaultShared No
287.br
288Specifies whether local printers are shared by default.
289.TP 5
bd7854cb 290Deny all
291.TP 5
292Deny none
293.TP 5
294Deny host.domain.com
295.TP 5
296Deny *.domain.com
297.TP 5
298Deny ip-address
299.TP 5
300Deny ip-address/netmask
301.TP 5
302Deny ip-address/mm
303.TP 5
304Deny @IF(name)
305.TP 5
306Deny @LOCAL
ef416fc2 307.br
308Denies access to the named host or address.
309.TP 5
bd7854cb 310DocumentRoot directory
ef416fc2 311.br
312Specifies the root directory for the internal web server documents.
313.TP 5
bd7854cb 314Encryption IfRequested
315.TP 5
316Encryption Never
317.TP 5
318Encryption Required
ef416fc2 319.br
320Specifies the level of encryption that is required for a particular
321location.
322.TP 5
bd7854cb 323ErrorLog filename
324.TP 5
325ErrorLog syslog
ef416fc2 326.br
327Specifies the error log filename.
328.TP 5
49d87452
MS		 329FatalErrors none
330.TP 5
331FatalErrors all -kind [... -kind]
332.TP 5
333FatalErrors kind [... kind]
334.br
335Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
336"browse", "config", "listen", "log", or "permissions".
337.TP 5
bd7854cb 338FileDevice Yes
339.TP 5
340FileDevice No
ef416fc2 341.br
342Specifies whether the file pseudo-device can be used for new
343printer queues.
344.TP 5
bd7854cb 345FilterLimit limit
ef416fc2 346.br
347Specifies the maximum cost of filters that are run concurrently.
348.TP 5
bd7854cb 349FilterNice nice-value
ef416fc2 350.br
351Specifies the scheduling priority ("nice" value) of filters that
352are run to print a job.
353.TP 5
bd7854cb 354FontPath directory[:directory:...]
ef416fc2 355.br
356Specifies the search path for fonts.
357.TP 5
bd7854cb 358Group group-name-or-number
ef416fc2 359.br
360Specifies the group name or ID that will be used when executing
361external programs.
362.TP 5
bd7854cb 363HideImplicitMembers Yes
364.TP 5
365HideImplicitMembers No
ef416fc2 366.br
367Specifies whether to hide members of implicit classes.
368.TP 5
dd1abb6b 369HostNameLookups On
bd7854cb 370.TP 5
dd1abb6b 371HostNameLookups Off
bd7854cb 372.TP 5
373HostNameLookups Double
ef416fc2 374.br
375Specifies whether or not to do reverse lookups on client addresses.
376.TP 5
bd7854cb 377ImplicitAnyClasses Yes
378.TP 5
379ImplicitAnyClasses No
ef416fc2 380.br
381Specifies whether or not to create implicit classes for local and
382remote printers, e.g. "AnyPrinter" from "Printer", "Printer@server1",
383and "Printer@server2".
384.TP 5
bd7854cb 385ImplicitClasses Yes
386.TP 5
387ImplicitClasses No
ef416fc2 388.br
389Specifies whether or not to create implicit classes from identical
390remote printers.
391.TP 5
bd7854cb 392Include filename
ef416fc2 393.br
394Includes the named file.
395.TP 5
bd7854cb 396JobRetryInterval seconds
ef416fc2 397.br
398Specifies the interval between retries of jobs in seconds.
399.TP 5
bd7854cb 400JobRetryLimit count
ef416fc2 401.br
402Specifies the number of retries that are done for jobs.
403.TP 5
80ca4592 404KeepAlive Yes
405.TP 5
406KeepAlive No
ef416fc2 407.br
80ca4592 408Specifies whether to support HTTP keep-alive connections.
ef416fc2 409.TP 5
80ca4592 410KeepAliveTimeout seconds
ef416fc2 411.br
80ca4592 412Specifies the amount of time that connections are kept alive.
ef416fc2 413.TP 5
f7deaa1a 414Krb5Keytab filename
415.br
416Overrides the Kerberos key tab location.
417.TP 5
ef416fc2 418<Limit operations> ... </Limit>
419.br
420Specifies the IPP operations that are being limited inside a policy.
421.TP 5
422<Limit methods> ... </Limit>
423.TP 5
424<LimitExcept methods> ... </LimitExcept>
425.br
426Specifies the HTTP methods that are being limited inside a location.
427.TP 5
428LimitRequestBody
429.br
430Specifies the maximum size of any print job request.
431.TP 5
bd7854cb 432Listen ip-address:port
433.TP 5
434Listen *:port
ed486911 435.TP 5
436Listen /path/to/domain/socket
ef416fc2 437.br
ed486911 438Listens to the specified address and port or domain socket path.
ef416fc2 439.TP 5
440<Location /path> ... </Location>
441.br
442Specifies access control for the named location.
443.TP 5
bd7854cb 444LogFilePerm mode
ef416fc2 445.br
446Specifies the permissions for all log files that the scheduler writes.
447.TP 5
bd7854cb 448LogLevel alert
449.TP 5
450LogLevel crit
451.TP 5
452LogLevel debug2
453.TP 5
454LogLevel debug
455.TP 5
456LogLevel emerg
457.TP 5
458LogLevel error
459.TP 5
460LogLevel info
461.TP 5
462LogLevel none
463.TP 5
464LogLevel notice
465.TP 5
466LogLevel warn
ef416fc2 467.br
bd7854cb 468Specifies the logging level for the ErrorLog file.
ef416fc2 469.TP 5
bd7854cb 470MaxClients number
ef416fc2 471.br
472Specifies the maximum number of simultaneous clients to support.
473.TP 5
bd7854cb 474MaxClientsPerHost number
ef416fc2 475.br
476Specifies the maximum number of simultaneous clients to support from a
477single address.
478.TP 5
bd7854cb 479MaxCopies number
ef416fc2 480.br
481Specifies the maximum number of copies that a user can print of each job.
482.TP 5
bd7854cb 483MaxJobs number
ef416fc2 484.br
485Specifies the maximum number of simultaneous jobs to support.
486.TP 5
bd7854cb 487MaxJobsPerPrinter number
ef416fc2 488.br
489Specifies the maximum number of simultaneous jobs per printer to support.
490.TP 5
bd7854cb 491MaxJobsPerUser number
ef416fc2 492.br
493Specifies the maximum number of simultaneous jobs per user to support.
494.TP 5
bd7854cb 495MaxLogSize number-bytes
ef416fc2 496.br
497Specifies the maximum size of the log files before they are
498rotated (0 to disable rotation)
499.TP 5
bd7854cb 500MaxRequestSize number-bytes
ef416fc2 501.br
502Specifies the maximum request/file size in bytes (0 for no limit)
503.TP 5
bd7854cb 504Order allow,deny
505.TP 5
506Order deny,allow
ef416fc2 507.br
508Specifies the order of HTTP access control (allow,deny or deny,allow)
509.TP 5
bd7854cb 510PageLog filename
511.TP 5
512PageLog syslog
ef416fc2 513.br
514Specifies the page log filename.
515.TP 5
01ce6322
MS		 516PageLogFormat format string
517.br
518Specifies the format of page log lines.
519.TP 5
ef416fc2 520PassEnv variable [... variable]
521.br
522Passes the specified environment variable(s) to child processes.
523.TP 5
524<Policy name> ... </Policy>
525.br
526Specifies access control for the named policy.
527.TP 5
bd7854cb 528Port number
ef416fc2 529.br
530Specifies a port number to listen to for HTTP requests.
531.TP 5
bd7854cb 532PreserveJobFiles Yes
533.TP 5
534PreserveJobFiles No
ef416fc2 535.br
536Specifies whether or not to preserve job files after they are printed.
537.TP 5
bd7854cb 538PreserveJobHistory Yes
539.TP 5
540PreserveJobHistory No
ef416fc2 541.br
542Specifies whether or not to preserve the job history after they are
543printed.
544.TP 5
545Printcap
bd7854cb 546.TP 5
547Printcap filename
ef416fc2 548.br
bd7854cb 549Specifies the filename for a printcap file that is updated
550automatically with a list of available printers (needed for
551legacy applications); specifying Printcap with no filename
552disables printcap generation.
553.TP 5
554PrintcapFormat bsd
ef416fc2 555.TP 5
0af14961
MS		 556PrintcapFormat plist
557.TP 5
bd7854cb 558PrintcapFormat solaris
ef416fc2 559.br
560Specifies the format of the printcap file.
561.TP 5
562PrintcapGUI
bd7854cb 563.TP 5
564PrintcapGUI gui-program-filename
ef416fc2 565.br
bd7854cb 566Specifies whether to generate option panel definition files on
567some operating systems. When provided with no program filename,
568disables option panel definition files.
ef416fc2 569.TP 5
bd7854cb 570ReloadTimeout seconds
ef416fc2 571.br
572Specifies the amount of time to wait for job completion before
573restarting the scheduler.
574.TP 5
bd7854cb 575RemoteRoot user-name
ef416fc2 576.br
577Specifies the username that is associated with unauthenticated root
578accesses.
579.TP 5
bd7854cb 580RequestRoot directory
ef416fc2 581.br
582Specifies the directory to store print jobs and other HTTP request
583data.
584.TP 5
bd7854cb 585Require group group-name-list
586.TP 5
587Require user user-name-list
588.TP 5
589Require valid-user
ef416fc2 590.br
591Specifies that user or group authentication is required.
592.TP 5
bd7854cb 593RIPCache bytes
ef416fc2 594.br
595Specifies the maximum amount of memory to use when converting images
596and PostScript files to bitmaps for a printer.
597.TP 5
bd7854cb 598Satisfy all
ef416fc2 599.TP 5
bd7854cb 600Satisfy any
ef416fc2 601.br
602Specifies whether all or any limits set for a Location must be
603satisfied to allow access.
604.TP 5
bd7854cb 605ServerAdmin user@domain.com
ef416fc2 606.br
607Specifies the email address of the server administrator.
608.TP 5
bd7854cb 609ServerBin directory
ef416fc2 610.br
611Specifies the directory where backends, CGIs, daemons, and filters may
612be found.
613.TP 5
bd7854cb 614ServerCertificate filename
ef416fc2 615.br
616Specifies the encryption certificate to use.
617.TP 5
bd7854cb 618ServerKey filename
ef416fc2 619.br
620Specifies the encryption key to use.
621.TP 5
bd7854cb 622ServerName hostname-or-ip-address
ef416fc2 623.br
624Specifies the fully-qualified hostname of the server.
625.TP 5
bd7854cb 626ServerRoot directory
ef416fc2 627.br
628Specifies the directory where the server configuration files can be found.
629.TP 5
bd7854cb 630ServerTokens Full
631.TP 5
632ServerTokens Major
633.TP 5
634ServerTokens Minimal
635.TP 5
636ServerTokens Minor
637.TP 5
638ServerTokens None
639.TP 5
640ServerTokens OS
641.TP 5
642ServerTokens ProductOnly
ef416fc2 643.br
644Specifies what information is included in the Server header of HTTP
645responses.
646.TP 5
647SetEnv variable value
648.br
649Set the specified environment variable to be passed to child processes.
650.TP 5
651SSLListen
652.br
653Listens on the specified address and port for encrypted connections.
654.TP 5
b19ccc9e
MS		 655SSLOptions None
656.TP 5
657SSLOptions NoEmptyFragments
658.br
659Sets SSL/TLS protocol options for encrypted connections.
660.TP 5
ef416fc2 661SSLPort
662.br
663Listens on the specified port for encrypted connections.
664.TP 5
bd7854cb 665SystemGroup group-name [group-name ...]
ef416fc2 666.br
bd7854cb 667Specifies the group(s) to use for System class authentication.
ef416fc2 668.TP 5
bd7854cb 669TempDir directory
ef416fc2 670.br
671Specifies the directory where temporary files are stored.
672.TP 5
bd7854cb 673Timeout seconds
ef416fc2 674.br
675Specifies the HTTP request timeout in seconds.
676.TP 5
bd7854cb 677User user-name
ef416fc2 678.br
679Specifies the user name or ID that is used when running external programs.
680.SH SEE ALSO
bd7854cb 681\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fImime.convs(5)\fR,
682\fImime.types(5)\fR, \fIprinters.conf(5)\fR,
683\fIsubscriptions.conf(5)\fR,
684.br
685http://localhost:631/help
ef416fc2 686.SH COPYRIGHT
c168a833 687Copyright 2007-2009 by Apple Inc.
ef416fc2 688.\"
b19ccc9e 689.\" End of "$Id: cupsd.conf.man.in 7935 2008-09-11 01:54:11Z mike $".
ef416fc2 690.\"
Unnamed repository; edit this file 'description' to name the repository.