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