man/cupsd.conf.man.in

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