2 .\" "$Id: cupsd.conf.man.in 181 2006-06-22 20:01:18Z jlovell $"
4 .\" cupsd.conf man page for the Common UNIX Printing System (CUPS).
6 .\" Copyright 1997-2006 by Easy Software Products.
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
15 .\" Attn: CUPS Licensing Information
16 .\" Easy Software Products
17 .\" 44141 Airport View Drive, Suite 204
18 .\" Hollywood, Maryland 20636 USA
20 .\" Voice: (301) 373-9600
21 .\" EMail: cups-info@cups.org
22 .\" WWW: http://www.cups.org
24 .TH cupsd.conf 5 "Common UNIX Printing System" "6 June 2006" "Easy Software Products"
26 cupsd.conf \- server configuration file for cups
28 The \fIcupsd.conf\fR file configures the CUPS scheduler, \fIcupsd(8)\fR. It
29 is normally located in the \fI@CUPS_SERVERROOT@\fR directory.
31 Each line in the file can be a configuration directive, a blank line,
32 or a comment. Comment lines start with the # character. The
33 configuration directives are intentionally similar to those used by the
34 popular Apache web server software and are described below.
36 The following directives are understood by \fIcupsd(8)\fR. Consult the
37 on-line help for detailed descriptions:
43 Defines the access log filename.
55 Allow ip-address/netmask
63 Allows access from the named hosts or addresses.
71 Specifies the authentication class (User, Group, System) -
72 \fBthis directive is deprecated\fR.
74 AuthGroupName group-name
76 Specifies the authentication group - \fBthis directive is
87 Specifies the authentication type (None, Basic, BasicDigest, Digest)
93 Specifies whether to purge job history data automatically when
94 it is no longer required for quotas.
96 BrowseAddress ip-address
98 BrowseAddress @IF(name)
102 Specifies a broadcast address for outgoing printer information packets.
108 BrowseAllow host.domain.com
110 BrowseAllow *.domain.com
112 BrowseAllow ip-address
114 BrowseAllow ip-address/netmask
116 BrowseAllow ip-address/mm
118 BrowseAllow @IF(name)
122 Allows incoming printer information packets from the named host or address.
128 BrowseDeny host.domain.com
130 BrowseDeny *.domain.com
132 BrowseDeny ip-address
134 BrowseDeny ip-address/netmask
136 BrowseDeny ip-address/mm
142 Denies incoming printer information packets from the named host or address.
144 BrowseInterval seconds
146 Specifies the maximum interval between printer information broadcasts.
148 BrowseOrder allow,deny
150 BrowseOrder deny,allow
152 Specifies the order of printer information access control (allow,deny or deny,allow)
154 BrowsePoll host-or-ip-address
156 Specifies a server to poll for printer information.
160 Specifies the port to listen to for printer information packets.
162 BrowseProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
164 Specifies the protocols to use for printer browsing.
166 BrowseLocalProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
168 Specifies the protocols to use for local printer browsing.
170 BrowseRemoteProtocols [All] [CUPS] [DNSSD] [LDAP] [SLP]
172 Specifies the protocols to use for remote printer browsing.
174 BrowseRelay from-address to-address
176 Specifies that printer information packets should be relayed from one host or
183 Specifies whether remote printers will use short names ("printer") or not
184 ("printer@server"). This option is ignored if more than one remote printer
185 exists with the same name.
187 BrowseTimeout seconds
189 Specifies the maximum interval between printer information updates before
190 remote printers will be removed from the list of available printers.
196 Specifies whether or not remote printer browsing should be enabled.
198 Classification banner
200 Specifies the security classification of the server.
206 Specifies whether to allow users to override the classification
207 of individual print jobs.
211 Specifies the permissions for all configuration files that the scheduler
216 Specified the directory where data files can be found.
218 DefaultAuthType Basic
220 DefaultAuthType BasicDigest
222 DefaultAuthType Digest
224 Specifies the default type of authentication to use.
226 DefaultCharset charset
228 Specifies the default character set to use for text.
230 DefaultLanguage locale
232 Specifies the default language to use for text and web content.
234 DefaultPolicy policy-name
236 Specifies the default access policy to use.
248 Deny ip-address/netmask
256 Denies access to the named host or address.
258 DocumentRoot directory
260 Specifies the root directory for the internal web server documents.
262 Encryption IfRequested
268 Specifies the level of encryption that is required for a particular
275 Specifies the error log filename.
281 Specifies whether the file pseudo-device can be used for new
286 Specifies the maximum cost of filters that are run concurrently.
288 FilterNice nice-value
290 Specifies the scheduling priority ("nice" value) of filters that
291 are run to print a job.
293 FontPath directory[:directory:...]
295 Specifies the search path for fonts.
297 Group group-name-or-number
299 Specifies the group name or ID that will be used when executing
302 HideImplicitMembers Yes
304 HideImplicitMembers No
306 Specifies whether to hide members of implicit classes.
312 HostNameLookups Double
314 Specifies whether or not to do reverse lookups on client addresses.
316 ImplicitAnyClasses Yes
318 ImplicitAnyClasses No
320 Specifies whether or not to create implicit classes for local and
321 remote printers, e.g. "AnyPrinter" from "Printer", "Printer@server1",
322 and "Printer@server2".
328 Specifies whether or not to create implicit classes from identical
333 Includes the named file.
335 JobRetryInterval seconds
337 Specifies the interval between retries of jobs in seconds.
341 Specifies the number of retries that are done for jobs.
347 Specifies whether to support HTTP keep-alive connections.
349 KeepAliveTimeout seconds
351 Specifies the amount of time that connections are kept alive.
353 <Limit operations> ... </Limit>
355 Specifies the IPP operations that are being limited inside a policy.
357 <Limit methods> ... </Limit>
359 <LimitExcept methods> ... </LimitExcept>
361 Specifies the HTTP methods that are being limited inside a location.
365 Specifies the maximum size of any print job request.
367 Listen ip-address:port
371 Listen /path/to/domain/socket
373 Listens to the specified address and port or domain socket path.
375 <Location /path> ... </Location>
377 Specifies access control for the named location.
381 Specifies the permissions for all log files that the scheduler writes.
403 Specifies the logging level for the ErrorLog file.
407 Specifies the maximum number of simultaneous clients to support.
409 MaxClientsPerHost number
411 Specifies the maximum number of simultaneous clients to support from a
416 Specifies the maximum number of copies that a user can print of each job.
420 Specifies the maximum number of simultaneous jobs to support.
422 MaxJobsPerPrinter number
424 Specifies the maximum number of simultaneous jobs per printer to support.
426 MaxJobsPerUser number
428 Specifies the maximum number of simultaneous jobs per user to support.
430 MaxLogSize number-bytes
432 Specifies the maximum size of the log files before they are
433 rotated (0 to disable rotation)
435 MaxRequestSize number-bytes
437 Specifies the maximum request/file size in bytes (0 for no limit)
443 Specifies the order of HTTP access control (allow,deny or deny,allow)
449 Specifies the page log filename.
451 PassEnv variable [... variable]
453 Passes the specified environment variable(s) to child processes.
455 <Policy name> ... </Policy>
457 Specifies access control for the named policy.
461 Specifies a port number to listen to for HTTP requests.
467 Specifies whether or not to preserve job files after they are printed.
469 PreserveJobHistory Yes
471 PreserveJobHistory No
473 Specifies whether or not to preserve the job history after they are
480 Specifies the filename for a printcap file that is updated
481 automatically with a list of available printers (needed for
482 legacy applications); specifying Printcap with no filename
483 disables printcap generation.
487 PrintcapFormat solaris
489 Specifies the format of the printcap file.
493 PrintcapGUI gui-program-filename
495 Specifies whether to generate option panel definition files on
496 some operating systems. When provided with no program filename,
497 disables option panel definition files.
499 ReloadTimeout seconds
501 Specifies the amount of time to wait for job completion before
502 restarting the scheduler.
506 Specifies the username that is associated with unauthenticated root
509 RequestRoot directory
511 Specifies the directory to store print jobs and other HTTP request
514 Require group group-name-list
516 Require user user-name-list
520 Specifies that user or group authentication is required.
524 Specifies the maximum amount of memory to use when converting images
525 and PostScript files to bitmaps for a printer.
531 Specifies whether all or any limits set for a Location must be
532 satisfied to allow access.
534 ServerAdmin user@domain.com
536 Specifies the email address of the server administrator.
540 Specifies the directory where backends, CGIs, daemons, and filters may
543 ServerCertificate filename
545 Specifies the encryption certificate to use.
549 Specifies the encryption key to use.
551 ServerName hostname-or-ip-address
553 Specifies the fully-qualified hostname of the server.
557 Specifies the directory where the server configuration files can be found.
571 ServerTokens ProductOnly
573 Specifies what information is included in the Server header of HTTP
576 SetEnv variable value
578 Set the specified environment variable to be passed to child processes.
582 Listens on the specified address and port for encrypted connections.
586 Listens on the specified port for encrypted connections.
588 SystemGroup group-name [group-name ...]
590 Specifies the group(s) to use for System class authentication.
594 Specifies the directory where temporary files are stored.
598 Specifies the HTTP request timeout in seconds.
602 Specifies the user name or ID that is used when running external programs.
604 \fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fImime.convs(5)\fR,
605 \fImime.types(5)\fR, \fIprinters.conf(5)\fR,
606 \fIsubscriptions.conf(5)\fR,
608 http://localhost:631/help
610 Copyright 1997-2006 by Easy Software Products, All Rights Reserved.
612 .\" End of "$Id: cupsd.conf.man.in 181 2006-06-22 20:01:18Z jlovell $".