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