]> 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.\"
bd7854cb 2.\" "$Id: cupsd.conf.man.in 5099 2006-02-13 02:46:10Z 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.\"
bd7854cb 24.TH cupsd.conf 5 "Common UNIX Printing System" "12 February 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 335KeepAlive Yes
336.TP 5
337KeepAlive No
338.br
339Specifies whether to support HTTP keep-alive connections.
340.TP 5
341KeepAliveTimeout seconds
342.br
343Specifies the amount of time that connections are kept alive.
344.TP 5
345JobRetryInterval seconds
ef416fc2 346.br
347Specifies the interval between retries of jobs in seconds.
348.TP 5
bd7854cb 349JobRetryLimit count
ef416fc2 350.br
351Specifies the number of retries that are done for jobs.
352.TP 5
353KeepAlive
354.br
355Specifies whether or not to support HTTP Keep-Alive.
356.TP 5
357KeepAliveTimeout
358.br
359Specifies the connection timeout for HTTP Keep-Alive.
360.TP 5
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
ef416fc2 378.br
379Listens to the specified address and port.
380.TP 5
381<Location /path> ... </Location>
382.br
383Specifies access control for the named location.
384.TP 5
bd7854cb 385LogFilePerm mode
ef416fc2 386.br
387Specifies the permissions for all log files that the scheduler writes.
388.TP 5
bd7854cb 389LogLevel alert
390.TP 5
391LogLevel crit
392.TP 5
393LogLevel debug2
394.TP 5
395LogLevel debug
396.TP 5
397LogLevel emerg
398.TP 5
399LogLevel error
400.TP 5
401LogLevel info
402.TP 5
403LogLevel none
404.TP 5
405LogLevel notice
406.TP 5
407LogLevel warn
ef416fc2 408.br
bd7854cb 409Specifies the logging level for the ErrorLog file.
ef416fc2 410.TP 5
bd7854cb 411MaxClients number
ef416fc2 412.br
413Specifies the maximum number of simultaneous clients to support.
414.TP 5
bd7854cb 415MaxClientsPerHost number
ef416fc2 416.br
417Specifies the maximum number of simultaneous clients to support from a
418single address.
419.TP 5
bd7854cb 420MaxCopies number
ef416fc2 421.br
422Specifies the maximum number of copies that a user can print of each job.
423.TP 5
bd7854cb 424MaxJobs number
ef416fc2 425.br
426Specifies the maximum number of simultaneous jobs to support.
427.TP 5
bd7854cb 428MaxJobsPerPrinter number
ef416fc2 429.br
430Specifies the maximum number of simultaneous jobs per printer to support.
431.TP 5
bd7854cb 432MaxJobsPerUser number
ef416fc2 433.br
434Specifies the maximum number of simultaneous jobs per user to support.
435.TP 5
bd7854cb 436MaxLogSize number-bytes
ef416fc2 437.br
438Specifies the maximum size of the log files before they are
439rotated (0 to disable rotation)
440.TP 5
bd7854cb 441MaxRequestSize number-bytes
ef416fc2 442.br
443Specifies the maximum request/file size in bytes (0 for no limit)
444.TP 5
bd7854cb 445Order allow,deny
446.TP 5
447Order deny,allow
ef416fc2 448.br
449Specifies the order of HTTP access control (allow,deny or deny,allow)
450.TP 5
bd7854cb 451PageLog filename
452.TP 5
453PageLog syslog
ef416fc2 454.br
455Specifies the page log filename.
456.TP 5
457PassEnv variable [... variable]
458.br
459Passes the specified environment variable(s) to child processes.
460.TP 5
461<Policy name> ... </Policy>
462.br
463Specifies access control for the named policy.
464.TP 5
bd7854cb 465Port number
ef416fc2 466.br
467Specifies a port number to listen to for HTTP requests.
468.TP 5
bd7854cb 469PreserveJobFiles Yes
470.TP 5
471PreserveJobFiles No
ef416fc2 472.br
473Specifies whether or not to preserve job files after they are printed.
474.TP 5
bd7854cb 475PreserveJobHistory Yes
476.TP 5
477PreserveJobHistory No
ef416fc2 478.br
479Specifies whether or not to preserve the job history after they are
480printed.
481.TP 5
482Printcap
bd7854cb 483.TP 5
484Printcap filename
ef416fc2 485.br
bd7854cb 486Specifies the filename for a printcap file that is updated
487automatically with a list of available printers (needed for
488legacy applications); specifying Printcap with no filename
489disables printcap generation.
490.TP 5
491PrintcapFormat bsd
ef416fc2 492.TP 5
bd7854cb 493PrintcapFormat solaris
ef416fc2 494.br
495Specifies the format of the printcap file.
496.TP 5
497PrintcapGUI
bd7854cb 498.TP 5
499PrintcapGUI gui-program-filename
ef416fc2 500.br
bd7854cb 501Specifies whether to generate option panel definition files on
502some operating systems. When provided with no program filename,
503disables option panel definition files.
ef416fc2 504.TP 5
bd7854cb 505ReloadTimeout seconds
ef416fc2 506.br
507Specifies the amount of time to wait for job completion before
508restarting the scheduler.
509.TP 5
bd7854cb 510RemoteRoot user-name
ef416fc2 511.br
512Specifies the username that is associated with unauthenticated root
513accesses.
514.TP 5
bd7854cb 515RequestRoot directory
ef416fc2 516.br
517Specifies the directory to store print jobs and other HTTP request
518data.
519.TP 5
bd7854cb 520Require group group-name-list
521.TP 5
522Require user user-name-list
523.TP 5
524Require valid-user
ef416fc2 525.br
526Specifies that user or group authentication is required.
527.TP 5
bd7854cb 528RIPCache bytes
ef416fc2 529.br
530Specifies the maximum amount of memory to use when converting images
531and PostScript files to bitmaps for a printer.
532.TP 5
bd7854cb 533Satisfy all
ef416fc2 534.TP 5
bd7854cb 535Satisfy any
ef416fc2 536.br
537Specifies whether all or any limits set for a Location must be
538satisfied to allow access.
539.TP 5
bd7854cb 540ServerAdmin user@domain.com
ef416fc2 541.br
542Specifies the email address of the server administrator.
543.TP 5
bd7854cb 544ServerBin directory
ef416fc2 545.br
546Specifies the directory where backends, CGIs, daemons, and filters may
547be found.
548.TP 5
bd7854cb 549ServerCertificate filename
ef416fc2 550.br
551Specifies the encryption certificate to use.
552.TP 5
bd7854cb 553ServerKey filename
ef416fc2 554.br
555Specifies the encryption key to use.
556.TP 5
bd7854cb 557ServerName hostname-or-ip-address
ef416fc2 558.br
559Specifies the fully-qualified hostname of the server.
560.TP 5
bd7854cb 561ServerRoot directory
ef416fc2 562.br
563Specifies the directory where the server configuration files can be found.
564.TP 5
bd7854cb 565ServerTokens Full
566.TP 5
567ServerTokens Major
568.TP 5
569ServerTokens Minimal
570.TP 5
571ServerTokens Minor
572.TP 5
573ServerTokens None
574.TP 5
575ServerTokens OS
576.TP 5
577ServerTokens ProductOnly
ef416fc2 578.br
579Specifies what information is included in the Server header of HTTP
580responses.
581.TP 5
582SetEnv variable value
583.br
584Set the specified environment variable to be passed to child processes.
585.TP 5
586SSLListen
587.br
588Listens on the specified address and port for encrypted connections.
589.TP 5
590SSLPort
591.br
592Listens on the specified port for encrypted connections.
593.TP 5
bd7854cb 594SystemGroup group-name [group-name ...]
ef416fc2 595.br
bd7854cb 596Specifies the group(s) to use for System class authentication.
ef416fc2 597.TP 5
bd7854cb 598TempDir directory
ef416fc2 599.br
600Specifies the directory where temporary files are stored.
601.TP 5
bd7854cb 602Timeout seconds
ef416fc2 603.br
604Specifies the HTTP request timeout in seconds.
605.TP 5
bd7854cb 606User user-name
ef416fc2 607.br
608Specifies the user name or ID that is used when running external programs.
609.SH SEE ALSO
bd7854cb 610\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fImime.convs(5)\fR,
611\fImime.types(5)\fR, \fIprinters.conf(5)\fR,
612\fIsubscriptions.conf(5)\fR,
613.br
614http://localhost:631/help
ef416fc2 615.SH COPYRIGHT
bd7854cb 616Copyright 1997-2006 by Easy Software Products, All Rights Reserved.
ef416fc2 617.\"
bd7854cb 618.\" End of "$Id: cupsd.conf.man.in 5099 2006-02-13 02:46:10Z mike $".
ef416fc2 619.\"
Unnamed repository; edit this file 'description' to name the repository.