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