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