]> 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-r7932.
[thirdparty/cups.git] / man / cupsd.conf.man.in
CommitLineData
ef416fc2 1.\"
75bd9771 2.\" "$Id: cupsd.conf.man.in 7645 2008-06-16 17:21:10Z mike $"
ef416fc2 3.\"
4.\" cupsd.conf man page for the Common UNIX Printing System (CUPS).
5.\"
3d052e43 6.\" Copyright 2007-2008 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.\"
49d87452 15.TH cupsd.conf 5 "Common UNIX Printing System" "8 September 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
bd7854cb 213Browsing Yes
214.TP 5
215Browsing No
ef416fc2 216.br
217Specifies whether or not remote printer browsing should be enabled.
218.TP 5
bd7854cb 219Classification banner
ef416fc2 220.br
221Specifies the security classification of the server.
222.TP 5
bd7854cb 223ClassifyOverride Yes
224.TP 5
225ClassifyOverride No
ef416fc2 226.br
227Specifies whether to allow users to override the classification
228of individual print jobs.
229.TP 5
bd7854cb 230ConfigFilePerm mode
ef416fc2 231.br
232Specifies the permissions for all configuration files that the scheduler
233writes.
234.TP 5
bd7854cb 235DataDir path
ef416fc2 236.br
237Specified the directory where data files can be found.
238.TP 5
bd7854cb 239DefaultAuthType Basic
240.TP 5
241DefaultAuthType BasicDigest
242.TP 5
243DefaultAuthType Digest
f7deaa1a 244.TP 5
2e4ff8af 245DefaultAuthType Negotiate
ef416fc2 246.br
247Specifies the default type of authentication to use.
248.TP 5
bd7854cb 249DefaultCharset charset
ef416fc2 250.br
251Specifies the default character set to use for text.
252.TP 5
bd7854cb 253DefaultLanguage locale
ef416fc2 254.br
255Specifies the default language to use for text and web content.
256.TP 5
49d87452
MS		 257DefaultPaperSize Auto
258.TP 5
259DefaultPaperSize None
260.TP 5
261DefaultPaperSize sizename
262.br
263Specifies the default paper size for new print queues. "Auto" uses a locale-
264specific default, while "None" specifies there is no default paper size.
265.TP 5
bd7854cb 266DefaultPolicy policy-name
ef416fc2 267.br
268Specifies the default access policy to use.
269.TP 5
3d052e43
MS		 270DefaultShared Yes
271.TP 5
272DefaultShared No
273.br
274Specifies whether local printers are shared by default.
275.TP 5
bd7854cb 276Deny all
277.TP 5
278Deny none
279.TP 5
280Deny host.domain.com
281.TP 5
282Deny *.domain.com
283.TP 5
284Deny ip-address
285.TP 5
286Deny ip-address/netmask
287.TP 5
288Deny ip-address/mm
289.TP 5
290Deny @IF(name)
291.TP 5
292Deny @LOCAL
ef416fc2 293.br
294Denies access to the named host or address.
295.TP 5
bd7854cb 296DocumentRoot directory
ef416fc2 297.br
298Specifies the root directory for the internal web server documents.
299.TP 5
bd7854cb 300Encryption IfRequested
301.TP 5
302Encryption Never
303.TP 5
304Encryption Required
ef416fc2 305.br
306Specifies the level of encryption that is required for a particular
307location.
308.TP 5
bd7854cb 309ErrorLog filename
310.TP 5
311ErrorLog syslog
ef416fc2 312.br
313Specifies the error log filename.
314.TP 5
49d87452
MS		 315FatalErrors none
316.TP 5
317FatalErrors all -kind [... -kind]
318.TP 5
319FatalErrors kind [... kind]
320.br
321Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
322"browse", "config", "listen", "log", or "permissions".
323.TP 5
bd7854cb 324FileDevice Yes
325.TP 5
326FileDevice No
ef416fc2 327.br
328Specifies whether the file pseudo-device can be used for new
329printer queues.
330.TP 5
bd7854cb 331FilterLimit limit
ef416fc2 332.br
333Specifies the maximum cost of filters that are run concurrently.
334.TP 5
bd7854cb 335FilterNice nice-value
ef416fc2 336.br
337Specifies the scheduling priority ("nice" value) of filters that
338are run to print a job.
339.TP 5
bd7854cb 340FontPath directory[:directory:...]
ef416fc2 341.br
342Specifies the search path for fonts.
343.TP 5
bd7854cb 344Group group-name-or-number
ef416fc2 345.br
346Specifies the group name or ID that will be used when executing
347external programs.
348.TP 5
bd7854cb 349HideImplicitMembers Yes
350.TP 5
351HideImplicitMembers No
ef416fc2 352.br
353Specifies whether to hide members of implicit classes.
354.TP 5
dd1abb6b 355HostNameLookups On
bd7854cb 356.TP 5
dd1abb6b 357HostNameLookups Off
bd7854cb 358.TP 5
359HostNameLookups Double
ef416fc2 360.br
361Specifies whether or not to do reverse lookups on client addresses.
362.TP 5
bd7854cb 363ImplicitAnyClasses Yes
364.TP 5
365ImplicitAnyClasses No
ef416fc2 366.br
367Specifies whether or not to create implicit classes for local and
368remote printers, e.g. "AnyPrinter" from "Printer", "Printer@server1",
369and "Printer@server2".
370.TP 5
bd7854cb 371ImplicitClasses Yes
372.TP 5
373ImplicitClasses No
ef416fc2 374.br
375Specifies whether or not to create implicit classes from identical
376remote printers.
377.TP 5
bd7854cb 378Include filename
ef416fc2 379.br
380Includes the named file.
381.TP 5
bd7854cb 382JobRetryInterval seconds
ef416fc2 383.br
384Specifies the interval between retries of jobs in seconds.
385.TP 5
bd7854cb 386JobRetryLimit count
ef416fc2 387.br
388Specifies the number of retries that are done for jobs.
389.TP 5
80ca4592 390KeepAlive Yes
391.TP 5
392KeepAlive No
ef416fc2 393.br
80ca4592 394Specifies whether to support HTTP keep-alive connections.
ef416fc2 395.TP 5
80ca4592 396KeepAliveTimeout seconds
ef416fc2 397.br
80ca4592 398Specifies the amount of time that connections are kept alive.
ef416fc2 399.TP 5
f7deaa1a 400Krb5Keytab filename
401.br
402Overrides the Kerberos key tab location.
403.TP 5
ef416fc2 404<Limit operations> ... </Limit>
405.br
406Specifies the IPP operations that are being limited inside a policy.
407.TP 5
408<Limit methods> ... </Limit>
409.TP 5
410<LimitExcept methods> ... </LimitExcept>
411.br
412Specifies the HTTP methods that are being limited inside a location.
413.TP 5
414LimitRequestBody
415.br
416Specifies the maximum size of any print job request.
417.TP 5
bd7854cb 418Listen ip-address:port
419.TP 5
420Listen *:port
ed486911 421.TP 5
422Listen /path/to/domain/socket
ef416fc2 423.br
ed486911 424Listens to the specified address and port or domain socket path.
ef416fc2 425.TP 5
426<Location /path> ... </Location>
427.br
428Specifies access control for the named location.
429.TP 5
bd7854cb 430LogFilePerm mode
ef416fc2 431.br
432Specifies the permissions for all log files that the scheduler writes.
433.TP 5
bd7854cb 434LogLevel alert
435.TP 5
436LogLevel crit
437.TP 5
438LogLevel debug2
439.TP 5
440LogLevel debug
441.TP 5
442LogLevel emerg
443.TP 5
444LogLevel error
445.TP 5
446LogLevel info
447.TP 5
448LogLevel none
449.TP 5
450LogLevel notice
451.TP 5
452LogLevel warn
ef416fc2 453.br
bd7854cb 454Specifies the logging level for the ErrorLog file.
ef416fc2 455.TP 5
bd7854cb 456MaxClients number
ef416fc2 457.br
458Specifies the maximum number of simultaneous clients to support.
459.TP 5
bd7854cb 460MaxClientsPerHost number
ef416fc2 461.br
462Specifies the maximum number of simultaneous clients to support from a
463single address.
464.TP 5
bd7854cb 465MaxCopies number
ef416fc2 466.br
467Specifies the maximum number of copies that a user can print of each job.
468.TP 5
bd7854cb 469MaxJobs number
ef416fc2 470.br
471Specifies the maximum number of simultaneous jobs to support.
472.TP 5
bd7854cb 473MaxJobsPerPrinter number
ef416fc2 474.br
475Specifies the maximum number of simultaneous jobs per printer to support.
476.TP 5
bd7854cb 477MaxJobsPerUser number
ef416fc2 478.br
479Specifies the maximum number of simultaneous jobs per user to support.
480.TP 5
bd7854cb 481MaxLogSize number-bytes
ef416fc2 482.br
483Specifies the maximum size of the log files before they are
484rotated (0 to disable rotation)
485.TP 5
bd7854cb 486MaxRequestSize number-bytes
ef416fc2 487.br
488Specifies the maximum request/file size in bytes (0 for no limit)
489.TP 5
bd7854cb 490Order allow,deny
491.TP 5
492Order deny,allow
ef416fc2 493.br
494Specifies the order of HTTP access control (allow,deny or deny,allow)
495.TP 5
bd7854cb 496PageLog filename
497.TP 5
498PageLog syslog
ef416fc2 499.br
500Specifies the page log filename.
501.TP 5
01ce6322
MS		 502PageLogFormat format string
503.br
504Specifies the format of page log lines.
505.TP 5
ef416fc2 506PassEnv variable [... variable]
507.br
508Passes the specified environment variable(s) to child processes.
509.TP 5
510<Policy name> ... </Policy>
511.br
512Specifies access control for the named policy.
513.TP 5
bd7854cb 514Port number
ef416fc2 515.br
516Specifies a port number to listen to for HTTP requests.
517.TP 5
bd7854cb 518PreserveJobFiles Yes
519.TP 5
520PreserveJobFiles No
ef416fc2 521.br
522Specifies whether or not to preserve job files after they are printed.
523.TP 5
bd7854cb 524PreserveJobHistory Yes
525.TP 5
526PreserveJobHistory No
ef416fc2 527.br
528Specifies whether or not to preserve the job history after they are
529printed.
530.TP 5
531Printcap
bd7854cb 532.TP 5
533Printcap filename
ef416fc2 534.br
bd7854cb 535Specifies the filename for a printcap file that is updated
536automatically with a list of available printers (needed for
537legacy applications); specifying Printcap with no filename
538disables printcap generation.
539.TP 5
540PrintcapFormat bsd
ef416fc2 541.TP 5
bd7854cb 542PrintcapFormat solaris
ef416fc2 543.br
544Specifies the format of the printcap file.
545.TP 5
546PrintcapGUI
bd7854cb 547.TP 5
548PrintcapGUI gui-program-filename
ef416fc2 549.br
bd7854cb 550Specifies whether to generate option panel definition files on
551some operating systems. When provided with no program filename,
552disables option panel definition files.
ef416fc2 553.TP 5
bd7854cb 554ReloadTimeout seconds
ef416fc2 555.br
556Specifies the amount of time to wait for job completion before
557restarting the scheduler.
558.TP 5
bd7854cb 559RemoteRoot user-name
ef416fc2 560.br
561Specifies the username that is associated with unauthenticated root
562accesses.
563.TP 5
bd7854cb 564RequestRoot directory
ef416fc2 565.br
566Specifies the directory to store print jobs and other HTTP request
567data.
568.TP 5
bd7854cb 569Require group group-name-list
570.TP 5
571Require user user-name-list
572.TP 5
573Require valid-user
ef416fc2 574.br
575Specifies that user or group authentication is required.
576.TP 5
bd7854cb 577RIPCache bytes
ef416fc2 578.br
579Specifies the maximum amount of memory to use when converting images
580and PostScript files to bitmaps for a printer.
581.TP 5
bd7854cb 582Satisfy all
ef416fc2 583.TP 5
bd7854cb 584Satisfy any
ef416fc2 585.br
586Specifies whether all or any limits set for a Location must be
587satisfied to allow access.
588.TP 5
bd7854cb 589ServerAdmin user@domain.com
ef416fc2 590.br
591Specifies the email address of the server administrator.
592.TP 5
bd7854cb 593ServerBin directory
ef416fc2 594.br
595Specifies the directory where backends, CGIs, daemons, and filters may
596be found.
597.TP 5
bd7854cb 598ServerCertificate filename
ef416fc2 599.br
600Specifies the encryption certificate to use.
601.TP 5
bd7854cb 602ServerKey filename
ef416fc2 603.br
604Specifies the encryption key to use.
605.TP 5
bd7854cb 606ServerName hostname-or-ip-address
ef416fc2 607.br
608Specifies the fully-qualified hostname of the server.
609.TP 5
bd7854cb 610ServerRoot directory
ef416fc2 611.br
612Specifies the directory where the server configuration files can be found.
613.TP 5
bd7854cb 614ServerTokens Full
615.TP 5
616ServerTokens Major
617.TP 5
618ServerTokens Minimal
619.TP 5
620ServerTokens Minor
621.TP 5
622ServerTokens None
623.TP 5
624ServerTokens OS
625.TP 5
626ServerTokens ProductOnly
ef416fc2 627.br
628Specifies what information is included in the Server header of HTTP
629responses.
630.TP 5
631SetEnv variable value
632.br
633Set the specified environment variable to be passed to child processes.
634.TP 5
635SSLListen
636.br
637Listens on the specified address and port for encrypted connections.
638.TP 5
639SSLPort
640.br
641Listens on the specified port for encrypted connections.
642.TP 5
bd7854cb 643SystemGroup group-name [group-name ...]
ef416fc2 644.br
bd7854cb 645Specifies the group(s) to use for System class authentication.
ef416fc2 646.TP 5
bd7854cb 647TempDir directory
ef416fc2 648.br
649Specifies the directory where temporary files are stored.
650.TP 5
bd7854cb 651Timeout seconds
ef416fc2 652.br
653Specifies the HTTP request timeout in seconds.
654.TP 5
bd7854cb 655User user-name
ef416fc2 656.br
657Specifies the user name or ID that is used when running external programs.
658.SH SEE ALSO
bd7854cb 659\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fImime.convs(5)\fR,
660\fImime.types(5)\fR, \fIprinters.conf(5)\fR,
661\fIsubscriptions.conf(5)\fR,
662.br
663http://localhost:631/help
ef416fc2 664.SH COPYRIGHT
3d052e43 665Copyright 2007-2008 by Apple Inc.
ef416fc2 666.\"
75bd9771 667.\" End of "$Id: cupsd.conf.man.in 7645 2008-06-16 17:21:10Z mike $".
ef416fc2 668.\"
Unnamed repository; edit this file 'description' to name the repository.