2 .\" "$Id: cupsd.conf.man.in 7935 2008-09-11 01:54:11Z mike $"
4 .\" cupsd.conf man page for the Common UNIX Printing System (CUPS).
6 .\" Copyright 2007-2010 by Apple Inc.
7 .\" Copyright 1997-2006 by Easy Software Products.
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/".
15 .TH cupsd.conf 5 "CUPS" "5 November 2010" "Apple Inc."
17 cupsd.conf \- server configuration file for cups
19 The \fIcupsd.conf\fR file configures the CUPS scheduler, \fIcupsd(8)\fR. It
20 is normally located in the \fI@CUPS_SERVERROOT@\fR directory.
22 Each line in the file can be a configuration directive, a blank line,
23 or a comment. Comment lines start with the # character. The
24 configuration directives are intentionally similar to those used by the
25 popular Apache web server software and are described below.
27 The following directives are understood by \fIcupsd(8)\fR. Consult the
28 on-line help for detailed descriptions:
34 Defines the access log filename.
38 AccessLogLevel actions
42 Specifies the logging level for the AccessLog file.
54 Allow ip-address/netmask
62 Allows access from the named hosts or addresses.
70 Specifies the authentication class (User, Group, System) -
71 \fBthis directive is deprecated\fR.
73 AuthGroupName group-name
75 Specifies the authentication group - \fBthis directive is
88 Specifies the authentication type (None, Basic, BasicDigest, Digest, Negotiate)
94 Specifies whether to purge job history data automatically when
95 it is no longer required for quotas.
97 BrowseAddress ip-address
99 BrowseAddress @IF(name)
103 Specifies a broadcast address for outgoing printer information packets.
109 BrowseAllow host.domain.com
111 BrowseAllow *.domain.com
113 BrowseAllow ip-address
115 BrowseAllow ip-address/netmask
117 BrowseAllow ip-address/mm
119 BrowseAllow @IF(name)
123 Allows incoming printer information packets from the named host or address.
129 BrowseDeny host.domain.com
131 BrowseDeny *.domain.com
133 BrowseDeny ip-address
135 BrowseDeny ip-address/netmask
137 BrowseDeny ip-address/mm
143 Denies incoming printer information packets from the named host or address.
145 BrowseInterval seconds
147 Specifies the maximum interval between printer information broadcasts.
151 Specifies the LDAP domain name to use when registering printers.
155 Specifies the SSL certificate authority file to use.
159 Specifies the LDAP domain name to use when discovering printers.
163 Specifies the password to use when accessing the LDAP server.
167 Specifies the LDAP server to use.
169 BrowseOrder allow,deny
171 BrowseOrder deny,allow
173 Specifies the order of printer information access control (allow,deny or deny,allow)
175 BrowsePoll host-or-ip-address
177 Specifies a server to poll for printer information.
181 Specifies the port to listen to for printer information packets.
183 BrowseProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
185 Specifies the protocols to use for printer browsing.
187 BrowseLocalProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
189 Specifies the protocols to use for local printer browsing.
191 BrowseRemoteProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
193 Specifies the protocols to use for remote printer browsing.
195 BrowseRelay from-address to-address
197 Specifies that printer information packets should be relayed from one host or
204 Specifies whether remote printers will use short names ("printer") or not
205 ("printer@server"). This option is ignored if more than one remote printer
206 exists with the same name.
208 BrowseTimeout seconds
210 Specifies the maximum interval between printer information updates before
211 remote printers will be removed from the list of available printers.
217 Specifies whether the CUPS web interface is advertised via DNS-SD.
223 Specifies whether or not remote printer browsing should be enabled.
225 Classification banner
227 Specifies the security classification of the server.
233 Specifies whether to allow users to override the classification
234 of individual print jobs.
238 Specifies the permissions for all configuration files that the scheduler
243 Specified the directory where data files can be found.
245 DefaultAuthType Basic
247 DefaultAuthType BasicDigest
249 DefaultAuthType Digest
251 DefaultAuthType Negotiate
253 Specifies the default type of authentication to use.
255 DefaultEncryption Never
257 DefaultEncryption IfRequested
259 DefaultEncryption Required
261 Specifies the type of encryption to use for authenticated requests.
263 DefaultLanguage locale
265 Specifies the default language to use for text and web content.
267 DefaultPaperSize Auto
269 DefaultPaperSize None
271 DefaultPaperSize sizename
273 Specifies the default paper size for new print queues. "Auto" uses a locale-
274 specific default, while "None" specifies there is no default paper size.
276 DefaultPolicy policy-name
278 Specifies the default access policy to use.
284 Specifies whether local printers are shared by default.
296 Deny ip-address/netmask
304 Denies access to the named host or address.
306 DirtyCleanInterval seconds
308 Specifies the delay for updating of configuration and state files. A value of 0
309 causes the update to happen as soon as possible, typically within a few
312 DocumentRoot directory
314 Specifies the root directory for the internal web server documents.
316 Encryption IfRequested
322 Specifies the level of encryption that is required for a particular
329 Specifies the error log filename.
333 FatalErrors all -kind [... -kind]
335 FatalErrors kind [... kind]
337 Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
338 "browse", "config", "listen", "log", or "permissions".
344 Specifies whether the file pseudo-device can be used for new
349 Specifies the maximum cost of filters that are run concurrently.
351 FilterNice nice-value
353 Specifies the scheduling priority ("nice" value) of filters that
354 are run to print a job.
356 FontPath directory[:directory:...]
358 Specifies the search path for fonts.
360 Group group-name-or-number
362 Specifies the group name or ID that will be used when executing
365 HideImplicitMembers Yes
367 HideImplicitMembers No
369 Specifies whether to hide members of implicit classes.
375 HostNameLookups Double
377 Specifies whether or not to do reverse lookups on client addresses.
379 ImplicitAnyClasses Yes
381 ImplicitAnyClasses No
383 Specifies whether or not to create implicit classes for local and
384 remote printers, e.g. "AnyPrinter" from "Printer", "Printer@server1",
385 and "Printer@server2".
391 Specifies whether or not to create implicit classes from identical
396 Includes the named file.
400 Specifies the number of seconds to wait before killing the filters and backend
401 associated with a canceled or held job.
405 JobPrivateAccess default
407 JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
409 Specifies an access list for a job's private values. The "default" access list
410 is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed
411 or requesting-user-name-denied values.
415 JobPrivateValues default
417 JobPrivateValues none
419 JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
420 Specifies the list of job values to make private. The "default" values are
421 "job-name", "job-originating-host-name", and "job-originating-user-name".
423 JobRetryInterval seconds
425 Specifies the interval between retries of jobs in seconds.
429 Specifies the number of retries that are done for jobs.
435 Specifies whether to support HTTP keep-alive connections.
437 KeepAliveTimeout seconds
439 Specifies the amount of time that connections are kept alive.
441 <Limit operations> ... </Limit>
443 Specifies the IPP operations that are being limited inside a policy.
445 <Limit methods> ... </Limit>
447 <LimitExcept methods> ... </LimitExcept>
449 Specifies the HTTP methods that are being limited inside a location.
453 Specifies the maximum size of any print job request.
455 Listen ip-address:port
459 Listen /path/to/domain/socket
461 Listens to the specified address and port or domain socket path.
463 <Location /path> ... </Location>
465 Specifies access control for the named location.
467 LogDebugHistory #-messages
469 Specifies the number of debugging messages that are logged when an error
470 occurs in a print job.
474 Specifies the permissions for all log files that the scheduler writes.
496 Specifies the logging level for the ErrorLog file.
498 LogTimeFormat standard
502 Specifies the format of the date and time in the log files.
506 Specifies the maximum number of simultaneous clients to support.
508 MaxClientsPerHost number
510 Specifies the maximum number of simultaneous clients to support from a
515 Specifies the maximum number of copies that a user can print of each job.
519 Specifies the maximum number of simultaneous jobs to support.
521 MaxJobsPerPrinter number
523 Specifies the maximum number of simultaneous jobs per printer to support.
525 MaxJobsPerUser number
527 Specifies the maximum number of simultaneous jobs per user to support.
529 MaxLogSize number-bytes
531 Specifies the maximum size of the log files before they are
532 rotated (0 to disable rotation)
534 MaxRequestSize number-bytes
536 Specifies the maximum request/file size in bytes (0 for no limit)
538 MultipleOperationTimeout seconds
540 Specifies the maximum amount of time to allow between files in a multiple file
547 Specifies the order of HTTP access control (allow,deny or deny,allow)
553 Specifies the page log filename.
555 PageLogFormat format string
557 Specifies the format of page log lines.
559 PassEnv variable [... variable]
561 Passes the specified environment variable(s) to child processes.
563 <Policy name> ... </Policy>
565 Specifies access control for the named policy.
569 Specifies a port number to listen to for HTTP requests.
575 Specifies whether or not to preserve job files after they are printed.
577 PreserveJobHistory Yes
579 PreserveJobHistory No
581 Specifies whether or not to preserve the job history after they are
588 Specifies the filename for a printcap file that is updated
589 automatically with a list of available printers (needed for
590 legacy applications); specifying Printcap with no filename
591 disables printcap generation.
597 PrintcapFormat solaris
599 Specifies the format of the printcap file.
603 PrintcapGUI gui-program-filename
605 Specifies whether to generate option panel definition files on
606 some operating systems. When provided with no program filename,
607 disables option panel definition files.
609 ReloadTimeout seconds
611 Specifies the amount of time to wait for job completion before
612 restarting the scheduler.
616 Specifies the username that is associated with unauthenticated root
619 RequestRoot directory
621 Specifies the directory to store print jobs and other HTTP request
624 Require group group-name-list
626 Require user user-name-list
630 Specifies that user or group authentication is required.
634 Specifies the maximum amount of memory to use when converting images
635 and PostScript files to bitmaps for a printer.
641 Specifies whether all or any limits set for a Location must be
642 satisfied to allow access.
644 ServerAdmin user@domain.com
646 Specifies the email address of the server administrator.
650 Specifies an alternate name that the server is known by. The special name "*"
651 allows any name to be used.
655 Specifies the directory where backends, CGIs, daemons, and filters may
658 ServerCertificate filename
660 Specifies the encryption certificate to use.
664 Specifies the encryption key to use.
666 ServerName hostname-or-ip-address
668 Specifies the fully-qualified hostname of the server.
672 Specifies the directory where the server configuration files can be found.
686 ServerTokens ProductOnly
688 Specifies what information is included in the Server header of HTTP
691 SetEnv variable value
693 Set the specified environment variable to be passed to child processes.
697 Listens on the specified address and port for encrypted connections.
701 SSLOptions NoEmptyFragments
703 Sets SSL/TLS protocol options for encrypted connections.
707 Listens on the specified port for encrypted connections.
709 SubscriptionPrivateAccess all
711 SubscriptionPrivateAccess default
713 SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
715 Specifies an access list for a subscription's private values. The "default"
716 access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
717 requesting-user-name-allowed or requesting-user-name-denied values.
719 SubscriptionPrivateValues all
721 SubscriptionPrivateValues default
723 SubscriptionPrivateValues none
725 SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
726 Specifies the list of job values to make private. The "default" values are
727 "notify-events", "notify-pull-method", "notify-recipient-uri",
728 "notify-subscriber-user-name", and "notify-user-data".
730 SystemGroup group-name [group-name ...]
732 Specifies the group(s) to use for System class authentication.
736 Specifies the directory where temporary files are stored.
740 Specifies the HTTP request timeout in seconds.
744 Specifies the user name or ID that is used when running external programs.
749 Specifies whether the web interface is enabled.
751 \fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fImime.convs(5)\fR,
752 \fImime.types(5)\fR, \fIprinters.conf(5)\fR,
753 \fIsubscriptions.conf(5)\fR,
755 http://localhost:631/help
757 Copyright 2007-2010 by Apple Inc.
759 .\" End of "$Id: cupsd.conf.man.in 7935 2008-09-11 01:54:11Z mike $".