man/cupsd.conf.man.in

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