man/cupsd.conf.man.in

   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-2009 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 "CUPS" "19 April 2009" "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 BrowseWebIF Yes
 214 .TP 5
 215 BrowseWebIF No
 216 .br
 217 Specifies whether the CUPS web interface is advertised via DNS-SD.
 218 .TP 5
 219 Browsing Yes
 220 .TP 5
 221 Browsing No
 222 .br
 223 Specifies whether or not remote printer browsing should be enabled.
 224 .TP 5
 225 Classification banner
 226 .br
 227 Specifies the security classification of the server.
 228 .TP 5
 229 ClassifyOverride Yes
 230 .TP 5
 231 ClassifyOverride No
 232 .br
 233 Specifies whether to allow users to override the classification
 234 of individual print jobs.
 235 .TP 5
 236 ConfigFilePerm mode
 237 .br
 238 Specifies the permissions for all configuration files that the scheduler
 239 writes.
 240 .TP 5
 241 DataDir path
 242 .br
 243 Specified the directory where data files can be found.
 244 .TP 5
 245 DefaultAuthType Basic
 246 .TP 5
 247 DefaultAuthType BasicDigest
 248 .TP 5
 249 DefaultAuthType Digest
 250 .TP 5
 251 DefaultAuthType Negotiate
 252 .br
 253 Specifies the default type of authentication to use.
 254 .TP 5
 255 DefaultCharset charset
 256 .br
 257 Specifies the default character set to use for text.
 258 .TP 5
 259 DefaultEncryption Never
 260 .TP 5
 261 DefaultEncryption IfRequested
 262 .TP 5
 263 DefaultEncryption Required
 264 .br
 265 Specifies the type of encryption to use for authenticated requests.
 266 .TP 5
 267 DefaultLanguage locale
 268 .br
 269 Specifies the default language to use for text and web content.
 270 .TP 5
 271 DefaultPaperSize Auto
 272 .TP 5
 273 DefaultPaperSize None
 274 .TP 5
 275 DefaultPaperSize sizename
 276 .br
 277 Specifies the default paper size for new print queues. "Auto" uses a locale-
 278 specific default, while "None" specifies there is no default paper size.
 279 .TP 5
 280 DefaultPolicy policy-name
 281 .br
 282 Specifies the default access policy to use.
 283 .TP 5
 284 DefaultShared Yes
 285 .TP 5
 286 DefaultShared No
 287 .br
 288 Specifies whether local printers are shared by default.
 289 .TP 5
 290 Deny all
 291 .TP 5
 292 Deny none
 293 .TP 5
 294 Deny host.domain.com
 295 .TP 5
 296 Deny *.domain.com
 297 .TP 5
 298 Deny ip-address
 299 .TP 5
 300 Deny ip-address/netmask
 301 .TP 5
 302 Deny ip-address/mm
 303 .TP 5
 304 Deny @IF(name)
 305 .TP 5
 306 Deny @LOCAL
 307 .br
 308 Denies access to the named host or address.
 309 .TP 5
 310 DocumentRoot directory
 311 .br
 312 Specifies the root directory for the internal web server documents.
 313 .TP 5
 314 Encryption IfRequested
 315 .TP 5
 316 Encryption Never
 317 .TP 5
 318 Encryption Required
 319 .br
 320 Specifies the level of encryption that is required for a particular
 321 location.
 322 .TP 5
 323 ErrorLog filename
 324 .TP 5
 325 ErrorLog syslog
 326 .br
 327 Specifies the error log filename.
 328 .TP 5
 329 FatalErrors none
 330 .TP 5
 331 FatalErrors all -kind [... -kind]
 332 .TP 5
 333 FatalErrors kind [... kind]
 334 .br
 335 Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
 336 "browse", "config", "listen", "log", or "permissions".
 337 .TP 5
 338 FileDevice Yes
 339 .TP 5
 340 FileDevice No
 341 .br
 342 Specifies whether the file pseudo-device can be used for new
 343 printer queues.
 344 .TP 5
 345 FilterLimit limit
 346 .br
 347 Specifies the maximum cost of filters that are run concurrently.
 348 .TP 5
 349 FilterNice nice-value
 350 .br
 351 Specifies the scheduling priority ("nice" value) of filters that
 352 are run to print a job.
 353 .TP 5
 354 FontPath directory[:directory:...]
 355 .br
 356 Specifies the search path for fonts.
 357 .TP 5
 358 Group group-name-or-number
 359 .br
 360 Specifies the group name or ID that will be used when executing
 361 external programs.
 362 .TP 5
 363 HideImplicitMembers Yes
 364 .TP 5
 365 HideImplicitMembers No
 366 .br
 367 Specifies whether to hide members of implicit classes.
 368 .TP 5
 369 HostNameLookups On
 370 .TP 5
 371 HostNameLookups Off
 372 .TP 5
 373 HostNameLookups Double
 374 .br
 375 Specifies whether or not to do reverse lookups on client addresses.
 376 .TP 5
 377 ImplicitAnyClasses Yes
 378 .TP 5
 379 ImplicitAnyClasses No
 380 .br
 381 Specifies whether or not to create implicit classes for local and
 382 remote printers, e.g. "AnyPrinter" from "Printer", "Printer@server1",
 383 and "Printer@server2".
 384 .TP 5
 385 ImplicitClasses Yes
 386 .TP 5
 387 ImplicitClasses No
 388 .br
 389 Specifies whether or not to create implicit classes from identical
 390 remote printers.
 391 .TP 5
 392 Include filename
 393 .br
 394 Includes the named file.
 395 .TP 5
 396 JobKillDelay seconds
 397 .br
 398 Specifies the number of seconds to wait before killing the filters and backend
 399 associated with a canceled or held job.
 400 .TP 5
 401 JobRetryInterval seconds
 402 .br
 403 Specifies the interval between retries of jobs in seconds.
 404 .TP 5
 405 JobRetryLimit count
 406 .br
 407 Specifies the number of retries that are done for jobs.
 408 .TP 5
 409 KeepAlive Yes
 410 .TP 5
 411 KeepAlive No
 412 .br
 413 Specifies whether to support HTTP keep-alive connections.
 414 .TP 5
 415 KeepAliveTimeout seconds
 416 .br
 417 Specifies the amount of time that connections are kept alive.
 418 .TP 5
 419 <Limit operations> ... </Limit>
 420 .br
 421 Specifies the IPP operations that are being limited inside a policy.
 422 .TP 5
 423 <Limit methods> ... </Limit>
 424 .TP 5
 425 <LimitExcept methods> ... </LimitExcept>
 426 .br
 427 Specifies the HTTP methods that are being limited inside a location.
 428 .TP 5
 429 LimitRequestBody
 430 .br
 431 Specifies the maximum size of any print job request.
 432 .TP 5
 433 Listen ip-address:port
 434 .TP 5
 435 Listen *:port
 436 .TP 5
 437 Listen /path/to/domain/socket
 438 .br
 439 Listens to the specified address and port or domain socket path.
 440 .TP 5
 441 <Location /path> ... </Location>
 442 .br
 443 Specifies access control for the named location.
 444 .TP 5
 445 LogDebugHistory #-messages
 446 .br
 447 Specifies the number of debugging messages that are logged when an error
 448 occurs in a print job.
 449 .TP 5
 450 LogFilePerm mode
 451 .br
 452 Specifies the permissions for all log files that the scheduler writes.
 453 .TP 5
 454 LogLevel alert
 455 .TP 5
 456 LogLevel crit
 457 .TP 5
 458 LogLevel debug2
 459 .TP 5
 460 LogLevel debug
 461 .TP 5
 462 LogLevel emerg
 463 .TP 5
 464 LogLevel error
 465 .TP 5
 466 LogLevel info
 467 .TP 5
 468 LogLevel none
 469 .TP 5
 470 LogLevel notice
 471 .TP 5
 472 LogLevel warn
 473 .br
 474 Specifies the logging level for the ErrorLog file.
 475 .TP 5
 476 LogTimeFormat standard
 477 .TP 5
 478 LogTimeFormat usecs
 479 .br
 480 Specifies the format of the date and time in the log files.
 481 .TP 5
 482 MaxClients number
 483 .br
 484 Specifies the maximum number of simultaneous clients to support.
 485 .TP 5
 486 MaxClientsPerHost number
 487 .br
 488 Specifies the maximum number of simultaneous clients to support from a
 489 single address.
 490 .TP 5
 491 MaxCopies number
 492 .br
 493 Specifies the maximum number of copies that a user can print of each job.
 494 .TP 5
 495 MaxJobs number
 496 .br
 497 Specifies the maximum number of simultaneous jobs to support.
 498 .TP 5
 499 MaxJobsPerPrinter number
 500 .br
 501 Specifies the maximum number of simultaneous jobs per printer to support.
 502 .TP 5
 503 MaxJobsPerUser number
 504 .br
 505 Specifies the maximum number of simultaneous jobs per user to support.
 506 .TP 5
 507 MaxLogSize number-bytes
 508 .br
 509 Specifies the maximum size of the log files before they are
 510 rotated (0 to disable rotation)
 511 .TP 5
 512 MaxRequestSize number-bytes
 513 .br
 514 Specifies the maximum request/file size in bytes (0 for no limit)
 515 .TP 5
 516 MultipleOperationTimeout seconds
 517 .br
 518 Specifies the maximum amount of time to allow between files in a multiple file
 519 print job.
 520 .TP 5
 521 Order allow,deny
 522 .TP 5
 523 Order deny,allow
 524 .br
 525 Specifies the order of HTTP access control (allow,deny or deny,allow)
 526 .TP 5
 527 PageLog filename
 528 .TP 5
 529 PageLog syslog
 530 .br
 531 Specifies the page log filename.
 532 .TP 5
 533 PageLogFormat format string
 534 .br
 535 Specifies the format of page log lines.
 536 .TP 5
 537 PassEnv variable [... variable]
 538 .br
 539 Passes the specified environment variable(s) to child processes.
 540 .TP 5
 541 <Policy name> ... </Policy>
 542 .br
 543 Specifies access control for the named policy.
 544 .TP 5
 545 Port number
 546 .br
 547 Specifies a port number to listen to for HTTP requests.
 548 .TP 5
 549 PreserveJobFiles Yes
 550 .TP 5
 551 PreserveJobFiles No
 552 .br
 553 Specifies whether or not to preserve job files after they are printed.
 554 .TP 5
 555 PreserveJobHistory Yes
 556 .TP 5
 557 PreserveJobHistory No
 558 .br
 559 Specifies whether or not to preserve the job history after they are
 560 printed.
 561 .TP 5
 562 Printcap
 563 .TP 5
 564 Printcap filename
 565 .br
 566 Specifies the filename for a printcap file that is updated
 567 automatically with a list of available printers (needed for
 568 legacy applications); specifying Printcap with no filename
 569 disables printcap generation.
 570 .TP 5
 571 PrintcapFormat bsd
 572 .TP 5
 573 PrintcapFormat plist
 574 .TP 5
 575 PrintcapFormat solaris
 576 .br
 577 Specifies the format of the printcap file.
 578 .TP 5
 579 PrintcapGUI
 580 .TP 5
 581 PrintcapGUI gui-program-filename
 582 .br
 583 Specifies whether to generate option panel definition files on
 584 some operating systems. When provided with no program filename,
 585 disables option panel definition files.
 586 .TP 5
 587 ReloadTimeout seconds
 588 .br
 589 Specifies the amount of time to wait for job completion before
 590 restarting the scheduler.
 591 .TP 5
 592 RemoteRoot user-name
 593 .br
 594 Specifies the username that is associated with unauthenticated root
 595 accesses.
 596 .TP 5
 597 RequestRoot directory
 598 .br
 599 Specifies the directory to store print jobs and other HTTP request
 600 data.
 601 .TP 5
 602 Require group group-name-list
 603 .TP 5
 604 Require user user-name-list
 605 .TP 5
 606 Require valid-user
 607 .br
 608 Specifies that user or group authentication is required.
 609 .TP 5
 610 RIPCache bytes
 611 .br
 612 Specifies the maximum amount of memory to use when converting images
 613 and PostScript files to bitmaps for a printer.
 614 .TP 5
 615 Satisfy all
 616 .TP 5
 617 Satisfy any
 618 .br
 619 Specifies whether all or any limits set for a Location must be
 620 satisfied to allow access.
 621 .TP 5
 622 ServerAdmin user@domain.com
 623 .br
 624 Specifies the email address of the server administrator.
 625 .TP 5
 626 ServerAlias hostname
 627 .br
 628 Specifies an alternate name that the server is known by. The special name "*"
 629 allows any name to be used.
 630 .TP 5
 631 ServerBin directory
 632 .br
 633 Specifies the directory where backends, CGIs, daemons, and filters may
 634 be found.
 635 .TP 5
 636 ServerCertificate filename
 637 .br
 638 Specifies the encryption certificate to use.
 639 .TP 5
 640 ServerKey filename
 641 .br
 642 Specifies the encryption key to use.
 643 .TP 5
 644 ServerName hostname-or-ip-address
 645 .br
 646 Specifies the fully-qualified hostname of the server.
 647 .TP 5
 648 ServerRoot directory
 649 .br
 650 Specifies the directory where the server configuration files can be found.
 651 .TP 5
 652 ServerTokens Full
 653 .TP 5
 654 ServerTokens Major
 655 .TP 5
 656 ServerTokens Minimal
 657 .TP 5
 658 ServerTokens Minor
 659 .TP 5
 660 ServerTokens None
 661 .TP 5
 662 ServerTokens OS
 663 .TP 5
 664 ServerTokens ProductOnly
 665 .br
 666 Specifies what information is included in the Server header of HTTP
 667 responses.
 668 .TP 5
 669 SetEnv variable value
 670 .br
 671 Set the specified environment variable to be passed to child processes.
 672 .TP 5
 673 SSLListen
 674 .br
 675 Listens on the specified address and port for encrypted connections.
 676 .TP 5
 677 SSLOptions None
 678 .TP 5
 679 SSLOptions NoEmptyFragments
 680 .br
 681 Sets SSL/TLS protocol options for encrypted connections.
 682 .TP 5
 683 SSLPort
 684 .br
 685 Listens on the specified port for encrypted connections.
 686 .TP 5
 687 SystemGroup group-name [group-name ...]
 688 .br
 689 Specifies the group(s) to use for System class authentication.
 690 .TP 5
 691 TempDir directory
 692 .br
 693 Specifies the directory where temporary files are stored.
 694 .TP 5
 695 Timeout seconds
 696 .br
 697 Specifies the HTTP request timeout in seconds.
 698 .TP 5
 699 User user-name
 700 .br
 701 Specifies the user name or ID that is used when running external programs.
 702 .SH SEE ALSO
 703 \fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fImime.convs(5)\fR,
 704 \fImime.types(5)\fR, \fIprinters.conf(5)\fR,
 705 \fIsubscriptions.conf(5)\fR,
 706 .br
 707 http://localhost:631/help
 708 .SH COPYRIGHT
 709 Copyright 2007-2009 by Apple Inc.
 710 .\"
 711 .\" End of "$Id: cupsd.conf.man.in 7935 2008-09-11 01:54:11Z mike $".
 712 .\"