man/cupsd.conf.man.in

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