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