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