man/cupsd.conf.man.in

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