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