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-2011 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" "3 November 2011" "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 HostNameLookups On
 254 .TP 5
 255 HostNameLookups Off
 256 .TP 5
 257 HostNameLookups Double
 258 .br
 259 Specifies whether or not to do reverse lookups on client addresses.
 260 .TP 5
 261 Include filename
 262 .br
 263 Includes the named file.
 264 .TP 5
 265 JobKillDelay seconds
 266 .br
 267 Specifies the number of seconds to wait before killing the filters and backend
 268 associated with a canceled or held job.
 269 .TP 5
 270 JobPrivateAccess all
 271 .TP 5
 272 JobPrivateAccess default
 273 .TP 5
 274 JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
 275 .br
 276 Specifies an access list for a job's private values. The "default" access list
 277 is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed
 278 or requesting-user-name-denied values.
 279 .TP 5
 280 JobPrivateValues all
 281 .TP 5
 282 JobPrivateValues default
 283 .TP 5
 284 JobPrivateValues none
 285 .TP 5
 286 JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
 287 Specifies the list of job values to make private. The "default" values are
 288 "job-name", "job-originating-host-name", and "job-originating-user-name".
 289 .TP 5
 290 JobRetryInterval seconds
 291 .br
 292 Specifies the interval between retries of jobs in seconds.
 293 .TP 5
 294 JobRetryLimit count
 295 .br
 296 Specifies the number of retries that are done for jobs.
 297 .TP 5
 298 KeepAlive Yes
 299 .TP 5
 300 KeepAlive No
 301 .br
 302 Specifies whether to support HTTP keep-alive connections.
 303 .TP 5
 304 KeepAliveTimeout seconds
 305 .br
 306 Specifies the amount of time that connections are kept alive.
 307 .TP 5
 308 <Limit operations> ... </Limit>
 309 .br
 310 Specifies the IPP operations that are being limited inside a policy.
 311 .TP 5
 312 <Limit methods> ... </Limit>
 313 .TP 5
 314 <LimitExcept methods> ... </LimitExcept>
 315 .br
 316 Specifies the HTTP methods that are being limited inside a location.
 317 .TP 5
 318 LimitRequestBody
 319 .br
 320 Specifies the maximum size of any print job request.
 321 .TP 5
 322 Listen ip-address:port
 323 .TP 5
 324 Listen *:port
 325 .TP 5
 326 Listen /path/to/domain/socket
 327 .br
 328 Listens to the specified address and port or domain socket path.
 329 .TP 5
 330 <Location /path> ... </Location>
 331 .br
 332 Specifies access control for the named location.
 333 .TP 5
 334 LogDebugHistory #-messages
 335 .br
 336 Specifies the number of debugging messages that are logged when an error
 337 occurs in a print job.
 338 .TP 5
 339 LogFilePerm mode
 340 .br
 341 Specifies the permissions for all log files that the scheduler writes.
 342 .TP 5
 343 LogLevel alert
 344 .TP 5
 345 LogLevel crit
 346 .TP 5
 347 LogLevel debug2
 348 .TP 5
 349 LogLevel debug
 350 .TP 5
 351 LogLevel emerg
 352 .TP 5
 353 LogLevel error
 354 .TP 5
 355 LogLevel info
 356 .TP 5
 357 LogLevel none
 358 .TP 5
 359 LogLevel notice
 360 .TP 5
 361 LogLevel warn
 362 .br
 363 Specifies the logging level for the ErrorLog file.
 364 .TP 5
 365 LogTimeFormat standard
 366 .TP 5
 367 LogTimeFormat usecs
 368 .br
 369 Specifies the format of the date and time in the log files.
 370 .TP 5
 371 MaxClients number
 372 .br
 373 Specifies the maximum number of simultaneous clients to support.
 374 .TP 5
 375 MaxClientsPerHost number
 376 .br
 377 Specifies the maximum number of simultaneous clients to support from a
 378 single address.
 379 .TP 5
 380 MaxCopies number
 381 .br
 382 Specifies the maximum number of copies that a user can print of each job.
 383 .TP 5
 384 MaxJobs number
 385 .br
 386 Specifies the maximum number of simultaneous jobs to support.
 387 .TP 5
 388 MaxJobsPerPrinter number
 389 .br
 390 Specifies the maximum number of simultaneous jobs per printer to support.
 391 .TP 5
 392 MaxJobsPerUser number
 393 .br
 394 Specifies the maximum number of simultaneous jobs per user to support.
 395 .TP 5
 396 MaxLogSize number-bytes
 397 .br
 398 Specifies the maximum size of the log files before they are
 399 rotated (0 to disable rotation)
 400 .TP 5
 401 MaxRequestSize number-bytes
 402 .br
 403 Specifies the maximum request/file size in bytes (0 for no limit)
 404 .TP 5
 405 MultipleOperationTimeout seconds
 406 .br
 407 Specifies the maximum amount of time to allow between files in a multiple file
 408 print job.
 409 .TP 5
 410 Order allow,deny
 411 .TP 5
 412 Order deny,allow
 413 .br
 414 Specifies the order of HTTP access control (allow,deny or deny,allow)
 415 .TP 5
 416 PageLog filename
 417 .TP 5
 418 PageLog syslog
 419 .br
 420 Specifies the page log filename.
 421 .TP 5
 422 PageLogFormat format string
 423 .br
 424 Specifies the format of page log lines.
 425 .TP 5
 426 PassEnv variable [... variable]
 427 .br
 428 Passes the specified environment variable(s) to child processes.
 429 .TP 5
 430 <Policy name> ... </Policy>
 431 .br
 432 Specifies access control for the named policy.
 433 .TP 5
 434 Port number
 435 .br
 436 Specifies a port number to listen to for HTTP requests.
 437 .TP 5
 438 PreserveJobFiles Yes
 439 .TP 5
 440 PreserveJobFiles No
 441 .br
 442 Specifies whether or not to preserve job files after they are printed.
 443 .TP 5
 444 PreserveJobHistory Yes
 445 .TP 5
 446 PreserveJobHistory No
 447 .br
 448 Specifies whether or not to preserve the job history after they are
 449 printed.
 450 .TP 5
 451 Printcap
 452 .TP 5
 453 Printcap filename
 454 .br
 455 Specifies the filename for a printcap file that is updated
 456 automatically with a list of available printers (needed for
 457 legacy applications); specifying Printcap with no filename
 458 disables printcap generation.
 459 .TP 5
 460 PrintcapFormat bsd
 461 .TP 5
 462 PrintcapFormat plist
 463 .TP 5
 464 PrintcapFormat solaris
 465 .br
 466 Specifies the format of the printcap file.
 467 .TP 5
 468 PrintcapGUI
 469 .TP 5
 470 PrintcapGUI gui-program-filename
 471 .br
 472 Specifies whether to generate option panel definition files on
 473 some operating systems. When provided with no program filename,
 474 disables option panel definition files.
 475 .TP 5
 476 ReloadTimeout seconds
 477 .br
 478 Specifies the amount of time to wait for job completion before
 479 restarting the scheduler.
 480 .TP 5
 481 RemoteRoot user-name
 482 .br
 483 Specifies the username that is associated with unauthenticated root
 484 accesses.
 485 .TP 5
 486 RequestRoot directory
 487 .br
 488 Specifies the directory to store print jobs and other HTTP request
 489 data.
 490 .TP 5
 491 Require group group-name-list
 492 .TP 5
 493 Require user user-name-list
 494 .TP 5
 495 Require valid-user
 496 .br
 497 Specifies that user or group authentication is required.
 498 .TP 5
 499 RIPCache bytes
 500 .br
 501 Specifies the maximum amount of memory to use when converting images
 502 and PostScript files to bitmaps for a printer.
 503 .TP 5
 504 Satisfy all
 505 .TP 5
 506 Satisfy any
 507 .br
 508 Specifies whether all or any limits set for a Location must be
 509 satisfied to allow access.
 510 .TP 5
 511 ServerAdmin user@domain.com
 512 .br
 513 Specifies the email address of the server administrator.
 514 .TP 5
 515 ServerAlias hostname [... hostname]
 516 .TP 5
 517 ServerAlias *
 518 .br
 519 Specifies an alternate name that the server is known by. The special name "*"
 520 allows any name to be used.
 521 .TP 5
 522 ServerBin directory
 523 .br
 524 Specifies the directory where backends, CGIs, daemons, and filters may
 525 be found.
 526 .TP 5
 527 ServerCertificate filename
 528 .br
 529 Specifies the encryption certificate to use.
 530 .TP 5
 531 ServerKey filename
 532 .br
 533 Specifies the encryption key to use.
 534 .TP 5
 535 ServerName hostname-or-ip-address
 536 .br
 537 Specifies the fully-qualified hostname of the server.
 538 .TP 5
 539 ServerRoot directory
 540 .br
 541 Specifies the directory where the server configuration files can be found.
 542 .TP 5
 543 ServerTokens Full
 544 .TP 5
 545 ServerTokens Major
 546 .TP 5
 547 ServerTokens Minimal
 548 .TP 5
 549 ServerTokens Minor
 550 .TP 5
 551 ServerTokens None
 552 .TP 5
 553 ServerTokens OS
 554 .TP 5
 555 ServerTokens ProductOnly
 556 .br
 557 Specifies what information is included in the Server header of HTTP
 558 responses.
 559 .TP 5
 560 SetEnv variable value
 561 .br
 562 Set the specified environment variable to be passed to child processes.
 563 .TP 5
 564 SSLListen
 565 .br
 566 Listens on the specified address and port for encrypted connections.
 567 .TP 5
 568 SSLOptions None
 569 .TP 5
 570 SSLOptions NoEmptyFragments
 571 .br
 572 Sets SSL/TLS protocol options for encrypted connections.
 573 .TP 5
 574 SSLPort
 575 .br
 576 Listens on the specified port for encrypted connections.
 577 .TP 5
 578 SubscriptionPrivateAccess all
 579 .TP 5
 580 SubscriptionPrivateAccess default
 581 .TP 5
 582 SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
 583 .br
 584 Specifies an access list for a subscription's private values. The "default"
 585 access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
 586 requesting-user-name-allowed or requesting-user-name-denied values.
 587 .TP 5
 588 SubscriptionPrivateValues all
 589 .TP 5
 590 SubscriptionPrivateValues default
 591 .TP 5
 592 SubscriptionPrivateValues none
 593 .TP 5
 594 SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
 595 Specifies the list of job values to make private. The "default" values are
 596 "notify-events", "notify-pull-method", "notify-recipient-uri",
 597 "notify-subscriber-user-name", and "notify-user-data".
 598 .TP 5
 599 SystemGroup group-name [group-name ...]
 600 .br
 601 Specifies the group(s) to use for System class authentication.
 602 .TP 5
 603 TempDir directory
 604 .br
 605 Specifies the directory where temporary files are stored.
 606 .TP 5
 607 Timeout seconds
 608 .br
 609 Specifies the HTTP request timeout in seconds.
 610 .TP 5
 611 User user-name
 612 .br
 613 Specifies the user name or ID that is used when running external programs.
 614 .TP 5
 615 WebInterface yes
 616 .TP 5
 617 WebInterface no
 618 Specifies whether the web interface is enabled.
 619 .SH SEE ALSO
 620 \fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fImime.convs(5)\fR,
 621 \fImime.types(5)\fR, \fIprinters.conf(5)\fR,
 622 \fIsubscriptions.conf(5)\fR,
 623 .br
 624 http://localhost:631/help
 625 .SH COPYRIGHT
 626 Copyright 2007-2011 by Apple Inc.
 627 .\"
 628 .\" End of "$Id: cupsd.conf.man.in 7935 2008-09-11 01:54:11Z mike $".
 629 .\"