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