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