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