man/cupsd.conf.man.in

   1 .\"
   2 .\" "$Id: cupsd.conf.man.in 7935 2008-09-11 01:54:11Z mike $"
   3 .\"
   4 .\"   cupsd.conf man page for CUPS.
   5 .\"
   6 .\"   Copyright 2007-2012 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 "CUPS" "6 January 2012" "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 BrowseLocalProtocols [All] [DNSSD]
  98 .br
  99 Specifies the protocols to use for local printer sharing.
 100 .TP 5
 101 BrowseWebIF Yes
 102 .TP 5
 103 BrowseWebIF No
 104 .br
 105 Specifies whether the CUPS web interface is advertised via DNS-SD.
 106 .TP 5
 107 Browsing Yes
 108 .TP 5
 109 Browsing No
 110 .br
 111 Specifies whether or not remote printer browsing should be enabled.
 112 .TP 5
 113 Classification banner
 114 .br
 115 Specifies the security classification of the server.
 116 .TP 5
 117 ClassifyOverride Yes
 118 .TP 5
 119 ClassifyOverride No
 120 .br
 121 Specifies whether to allow users to override the classification
 122 of individual print jobs.
 123 .TP 5
 124 ConfigFilePerm mode
 125 .br
 126 Specifies the permissions for all configuration files that the scheduler
 127 writes.
 128 .TP 5
 129 DataDir path
 130 .br
 131 Specified the directory where data files can be found.
 132 .TP 5
 133 DefaultAuthType Basic
 134 .TP 5
 135 DefaultAuthType BasicDigest
 136 .TP 5
 137 DefaultAuthType Digest
 138 .TP 5
 139 DefaultAuthType Negotiate
 140 .br
 141 Specifies the default type of authentication to use.
 142 .TP 5
 143 DefaultEncryption Never
 144 .TP 5
 145 DefaultEncryption IfRequested
 146 .TP 5
 147 DefaultEncryption Required
 148 .br
 149 Specifies the type of encryption to use for authenticated requests.
 150 .TP 5
 151 DefaultLanguage locale
 152 .br
 153 Specifies the default language to use for text and web content.
 154 .TP 5
 155 DefaultPaperSize Auto
 156 .TP 5
 157 DefaultPaperSize None
 158 .TP 5
 159 DefaultPaperSize sizename
 160 .br
 161 Specifies the default paper size for new print queues. "Auto" uses a locale-
 162 specific default, while "None" specifies there is no default paper size.
 163 .TP 5
 164 DefaultPolicy policy-name
 165 .br
 166 Specifies the default access policy to use.
 167 .TP 5
 168 DefaultShared Yes
 169 .TP 5
 170 DefaultShared No
 171 .br
 172 Specifies whether local printers are shared by default.
 173 .TP 5
 174 Deny all
 175 .TP 5
 176 Deny none
 177 .TP 5
 178 Deny host.domain.com
 179 .TP 5
 180 Deny *.domain.com
 181 .TP 5
 182 Deny ip-address
 183 .TP 5
 184 Deny ip-address/netmask
 185 .TP 5
 186 Deny ip-address/mm
 187 .TP 5
 188 Deny @IF(name)
 189 .TP 5
 190 Deny @LOCAL
 191 .br
 192 Denies access to the named host or address.
 193 .TP 5
 194 DirtyCleanInterval seconds
 195 .br
 196 Specifies the delay for updating of configuration and state files. A value of 0
 197 causes the update to happen as soon as possible, typically within a few
 198 milliseconds.
 199 .TP 5
 200 DocumentRoot directory
 201 .br
 202 Specifies the root directory for the internal web server documents.
 203 .TP 5
 204 Encryption IfRequested
 205 .TP 5
 206 Encryption Never
 207 .TP 5
 208 Encryption Required
 209 .br
 210 Specifies the level of encryption that is required for a particular
 211 location.
 212 .TP 5
 213 ErrorLog filename
 214 .TP 5
 215 ErrorLog syslog
 216 .br
 217 Specifies the error log filename.
 218 .TP 5
 219 FatalErrors none
 220 .TP 5
 221 FatalErrors all -kind [... -kind]
 222 .TP 5
 223 FatalErrors kind [... kind]
 224 .br
 225 Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
 226 "browse", "config", "listen", "log", or "permissions".
 227 .TP 5
 228 FileDevice Yes
 229 .TP 5
 230 FileDevice No
 231 .br
 232 Specifies whether the file pseudo-device can be used for new
 233 printer queues.
 234 .TP 5
 235 FilterLimit limit
 236 .br
 237 Specifies the maximum cost of filters that are run concurrently.
 238 .TP 5
 239 FilterNice nice-value
 240 .br
 241 Specifies the scheduling priority ("nice" value) of filters that
 242 are run to print a job.
 243 .TP 5
 244 FontPath directory[:directory:...]
 245 .br
 246 Specifies the search path for fonts.
 247 .TP 5
 248 Group group-name-or-number
 249 .br
 250 Specifies the group name or ID that will be used when executing
 251 external programs.
 252 .TP 5
 253 GSSServiceName name
 254 .br
 255 Specifies the service name when using Kerberos authentication. The default
 256 service name is "@CUPS_DEFAULT_GSSSERVICENAME@".
 257 .TP 5
 258 HostNameLookups On
 259 .TP 5
 260 HostNameLookups Off
 261 .TP 5
 262 HostNameLookups Double
 263 .br
 264 Specifies whether or not to do reverse lookups on client addresses.
 265 .TP 5
 266 Include filename
 267 .br
 268 Includes the named file.
 269 .TP 5
 270 JobKillDelay seconds
 271 .br
 272 Specifies the number of seconds to wait before killing the filters and backend
 273 associated with a canceled or held job.
 274 .TP 5
 275 JobPrivateAccess all
 276 .TP 5
 277 JobPrivateAccess default
 278 .TP 5
 279 JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
 280 .br
 281 Specifies an access list for a job's private values. The "default" access list
 282 is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed
 283 or requesting-user-name-denied values.
 284 .TP 5
 285 JobPrivateValues all
 286 .TP 5
 287 JobPrivateValues default
 288 .TP 5
 289 JobPrivateValues none
 290 .TP 5
 291 JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
 292 Specifies the list of job values to make private. The "default" values are
 293 "job-name", "job-originating-host-name", and "job-originating-user-name".
 294 .TP 5
 295 JobRetryInterval seconds
 296 .br
 297 Specifies the interval between retries of jobs in seconds.
 298 .TP 5
 299 JobRetryLimit count
 300 .br
 301 Specifies the number of retries that are done for jobs.
 302 .TP 5
 303 KeepAlive Yes
 304 .TP 5
 305 KeepAlive No
 306 .br
 307 Specifies whether to support HTTP keep-alive connections.
 308 .TP 5
 309 KeepAliveTimeout seconds
 310 .br
 311 Specifies the amount of time that connections are kept alive.
 312 .TP 5
 313 <Limit operations> ... </Limit>
 314 .br
 315 Specifies the IPP operations that are being limited inside a policy.
 316 .TP 5
 317 <Limit methods> ... </Limit>
 318 .TP 5
 319 <LimitExcept methods> ... </LimitExcept>
 320 .br
 321 Specifies the HTTP methods that are being limited inside a location.
 322 .TP 5
 323 LimitRequestBody
 324 .br
 325 Specifies the maximum size of any print job request.
 326 .TP 5
 327 Listen ip-address:port
 328 .TP 5
 329 Listen *:port
 330 .TP 5
 331 Listen /path/to/domain/socket
 332 .br
 333 Listens to the specified address and port or domain socket path.
 334 .TP 5
 335 <Location /path> ... </Location>
 336 .br
 337 Specifies access control for the named location.
 338 .TP 5
 339 LogDebugHistory #-messages
 340 .br
 341 Specifies the number of debugging messages that are logged when an error
 342 occurs in a print job.
 343 .TP 5
 344 LogFilePerm mode
 345 .br
 346 Specifies the permissions for all log files that the scheduler writes.
 347 .TP 5
 348 LogLevel alert
 349 .TP 5
 350 LogLevel crit
 351 .TP 5
 352 LogLevel debug2
 353 .TP 5
 354 LogLevel debug
 355 .TP 5
 356 LogLevel emerg
 357 .TP 5
 358 LogLevel error
 359 .TP 5
 360 LogLevel info
 361 .TP 5
 362 LogLevel none
 363 .TP 5
 364 LogLevel notice
 365 .TP 5
 366 LogLevel warn
 367 .br
 368 Specifies the logging level for the ErrorLog file.
 369 .TP 5
 370 LogTimeFormat standard
 371 .TP 5
 372 LogTimeFormat usecs
 373 .br
 374 Specifies the format of the date and time in the log files.
 375 .TP 5
 376 MaxClients number
 377 .br
 378 Specifies the maximum number of simultaneous clients to support.
 379 .TP 5
 380 MaxClientsPerHost number
 381 .br
 382 Specifies the maximum number of simultaneous clients to support from a
 383 single address.
 384 .TP 5
 385 MaxCopies number
 386 .br
 387 Specifies the maximum number of copies that a user can print of each job.
 388 .TP 5
 389 MaxJobs number
 390 .br
 391 Specifies the maximum number of simultaneous jobs to support.
 392 .TP 5
 393 MaxJobsPerPrinter number
 394 .br
 395 Specifies the maximum number of simultaneous jobs per printer to support.
 396 .TP 5
 397 MaxJobsPerUser number
 398 .br
 399 Specifies the maximum number of simultaneous jobs per user to support.
 400 .TP 5
 401 MaxJobTime seconds
 402 .br
 403 Specifies the maximum time a job may take to print before it is canceled. The
 404 default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck"
 405 jobs.
 406 .TP 5
 407 MaxLogSize number-bytes
 408 .br
 409 Specifies the maximum size of the log files before they are
 410 rotated (0 to disable rotation)
 411 .TP 5
 412 MaxRequestSize number-bytes
 413 .br
 414 Specifies the maximum request/file size in bytes (0 for no limit)
 415 .TP 5
 416 MultipleOperationTimeout seconds
 417 .br
 418 Specifies the maximum amount of time to allow between files in a multiple file
 419 print job.
 420 .TP 5
 421 Order allow,deny
 422 .TP 5
 423 Order deny,allow
 424 .br
 425 Specifies the order of HTTP access control (allow,deny or deny,allow)
 426 .TP 5
 427 PageLog filename
 428 .TP 5
 429 PageLog syslog
 430 .br
 431 Specifies the page log filename.
 432 .TP 5
 433 PageLogFormat format string
 434 .br
 435 Specifies the format of page log lines.
 436 .TP 5
 437 PassEnv variable [... variable]
 438 .br
 439 Passes the specified environment variable(s) to child processes.
 440 .TP 5
 441 <Policy name> ... </Policy>
 442 .br
 443 Specifies access control for the named policy.
 444 .TP 5
 445 Port number
 446 .br
 447 Specifies a port number to listen to for HTTP requests.
 448 .TP 5
 449 PreserveJobFiles Yes
 450 .TP 5
 451 PreserveJobFiles No
 452 .br
 453 Specifies whether or not to preserve job files after they are printed.
 454 .TP 5
 455 PreserveJobHistory Yes
 456 .TP 5
 457 PreserveJobHistory No
 458 .br
 459 Specifies whether or not to preserve the job history after they are
 460 printed.
 461 .TP 5
 462 Printcap
 463 .TP 5
 464 Printcap filename
 465 .br
 466 Specifies the filename for a printcap file that is updated
 467 automatically with a list of available printers (needed for
 468 legacy applications); specifying Printcap with no filename
 469 disables printcap generation.
 470 .TP 5
 471 PrintcapFormat bsd
 472 .TP 5
 473 PrintcapFormat plist
 474 .TP 5
 475 PrintcapFormat solaris
 476 .br
 477 Specifies the format of the printcap file.
 478 .TP 5
 479 PrintcapGUI
 480 .TP 5
 481 PrintcapGUI gui-program-filename
 482 .br
 483 Specifies whether to generate option panel definition files on
 484 some operating systems. When provided with no program filename,
 485 disables option panel definition files.
 486 .TP 5
 487 ReloadTimeout seconds
 488 .br
 489 Specifies the amount of time to wait for job completion before
 490 restarting the scheduler.
 491 .TP 5
 492 RemoteRoot user-name
 493 .br
 494 Specifies the username that is associated with unauthenticated root
 495 accesses.
 496 .TP 5
 497 RequestRoot directory
 498 .br
 499 Specifies the directory to store print jobs and other HTTP request
 500 data.
 501 .TP 5
 502 Require group group-name-list
 503 .TP 5
 504 Require user user-name-list
 505 .TP 5
 506 Require valid-user
 507 .br
 508 Specifies that user or group authentication is required.
 509 .TP 5
 510 RIPCache bytes
 511 .br
 512 Specifies the maximum amount of memory to use when converting images
 513 and PostScript files to bitmaps for a printer.
 514 .TP 5
 515 Satisfy all
 516 .TP 5
 517 Satisfy any
 518 .br
 519 Specifies whether all or any limits set for a Location must be
 520 satisfied to allow access.
 521 .TP 5
 522 ServerAdmin user@domain.com
 523 .br
 524 Specifies the email address of the server administrator.
 525 .TP 5
 526 ServerAlias hostname [... hostname]
 527 .TP 5
 528 ServerAlias *
 529 .br
 530 Specifies an alternate name that the server is known by. The special name "*"
 531 allows any name to be used.
 532 .TP 5
 533 ServerBin directory
 534 .br
 535 Specifies the directory where backends, CGIs, daemons, and filters may
 536 be found.
 537 .TP 5
 538 ServerCertificate filename
 539 .br
 540 Specifies the encryption certificate to use.
 541 .TP 5
 542 ServerKey filename
 543 .br
 544 Specifies the encryption key to use.
 545 .TP 5
 546 ServerName hostname-or-ip-address
 547 .br
 548 Specifies the fully-qualified hostname of the server.
 549 .TP 5
 550 ServerRoot directory
 551 .br
 552 Specifies the directory where the server configuration files can be found.
 553 .TP 5
 554 ServerTokens Full
 555 .TP 5
 556 ServerTokens Major
 557 .TP 5
 558 ServerTokens Minimal
 559 .TP 5
 560 ServerTokens Minor
 561 .TP 5
 562 ServerTokens None
 563 .TP 5
 564 ServerTokens OS
 565 .TP 5
 566 ServerTokens ProductOnly
 567 .br
 568 Specifies what information is included in the Server header of HTTP
 569 responses.
 570 .TP 5
 571 SetEnv variable value
 572 .br
 573 Set the specified environment variable to be passed to child processes.
 574 .TP 5
 575 SSLListen
 576 .br
 577 Listens on the specified address and port for encrypted connections.
 578 .TP 5
 579 SSLOptions None
 580 .TP 5
 581 SSLOptions NoEmptyFragments
 582 .br
 583 Sets SSL/TLS protocol options for encrypted connections.
 584 .TP 5
 585 SSLPort
 586 .br
 587 Listens on the specified port for encrypted connections.
 588 .TP 5
 589 SubscriptionPrivateAccess all
 590 .TP 5
 591 SubscriptionPrivateAccess default
 592 .TP 5
 593 SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
 594 .br
 595 Specifies an access list for a subscription's private values. The "default"
 596 access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
 597 requesting-user-name-allowed or requesting-user-name-denied values.
 598 .TP 5
 599 SubscriptionPrivateValues all
 600 .TP 5
 601 SubscriptionPrivateValues default
 602 .TP 5
 603 SubscriptionPrivateValues none
 604 .TP 5
 605 SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
 606 Specifies the list of job values to make private. The "default" values are
 607 "notify-events", "notify-pull-method", "notify-recipient-uri",
 608 "notify-subscriber-user-name", and "notify-user-data".
 609 .TP 5
 610 SystemGroup group-name [group-name ...]
 611 .br
 612 Specifies the group(s) to use for System class authentication.
 613 .TP 5
 614 TempDir directory
 615 .br
 616 Specifies the directory where temporary files are stored.
 617 .TP 5
 618 Timeout seconds
 619 .br
 620 Specifies the HTTP request timeout in seconds.
 621 .TP 5
 622 User user-name
 623 .br
 624 Specifies the user name or ID that is used when running external programs.
 625 .TP 5
 626 WebInterface yes
 627 .TP 5
 628 WebInterface no
 629 Specifies whether the web interface is enabled.
 630 .SH SEE ALSO
 631 \fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fImime.convs(5)\fR,
 632 \fImime.types(5)\fR, \fIprinters.conf(5)\fR,
 633 \fIsubscriptions.conf(5)\fR,
 634 .br
 635 http://localhost:631/help
 636 .SH COPYRIGHT
 637 Copyright 2007-2011 by Apple Inc.
 638 .\"
 639 .\" End of "$Id: cupsd.conf.man.in 7935 2008-09-11 01:54:11Z mike $".
 640 .\"