man/cupsd.conf.man.in

   1 .\"
   2 .\" "$Id$"
   3 .\"
   4 .\"   cupsd.conf man page for CUPS.
   5 .\"
   6 .\"   Copyright 2007-2013 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" "19 November 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. \fBNote:\fR
  21 File, directory, and user configuration directives that used to be allowed in
  22 the \fIcupsd.conf\fR file are now stored in the \fIcups-files.conf(5)\fR instead
  23 in order to prevent certain types of privilege escalation attacks.
  24 .LP
  25 Each line in the file can be a configuration directive, a blank line,
  26 or a comment. Comment lines start with the # character. The
  27 configuration directives are intentionally similar to those used by the
  28 popular Apache web server software and are described below.
  29 .SH DIRECTIVES
  30 The following directives are understood by \fIcupsd(8)\fR. Consult the
  31 on-line help for detailed descriptions:
  32 .TP 5
  33 AccessLogLevel config
  34 .TP 5
  35 AccessLogLevel actions
  36 .TP 5
  37 AccessLogLevel all
  38 .br
  39 Specifies the logging level for the AccessLog file.
  40 .TP 5
  41 Allow all
  42 .TP 5
  43 Allow none
  44 .TP 5
  45 Allow host.domain.com
  46 .TP 5
  47 Allow *.domain.com
  48 .TP 5
  49 Allow ip-address
  50 .TP 5
  51 Allow ip-address/netmask
  52 .TP 5
  53 Allow ip-address/mm
  54 .TP 5
  55 Allow @IF(name)
  56 .TP 5
  57 Allow @LOCAL
  58 .br
  59 Allows access from the named hosts or addresses.
  60 .TP 5
  61 AuthType None
  62 .TP 5
  63 AuthType Basic
  64 .TP 5
  65 AuthType BasicDigest
  66 .TP 5
  67 AuthType Digest
  68 .TP 5
  69 AuthType Negotiate
  70 .br
  71 Specifies the authentication type (None, Basic, BasicDigest, Digest, Negotiate)
  72 .TP 5
  73 AutoPurgeJobs Yes
  74 .TP 5
  75 AutoPurgeJobs No
  76 .br
  77 Specifies whether to purge job history data automatically when
  78 it is no longer required for quotas.
  79 .TP 5
  80 BrowseLocalProtocols [All] [DNSSD]
  81 .br
  82 Specifies the protocols to use for local printer sharing.
  83 .TP 5
  84 BrowseWebIF Yes
  85 .TP 5
  86 BrowseWebIF No
  87 .br
  88 Specifies whether the CUPS web interface is advertised via DNS-SD.
  89 .TP 5
  90 Browsing Yes
  91 .TP 5
  92 Browsing No
  93 .br
  94 Specifies whether or not shared printers should be advertised.
  95 .TP 5
  96 Classification banner
  97 .br
  98 Specifies the security classification of the server.
  99 .TP 5
 100 ClassifyOverride Yes
 101 .TP 5
 102 ClassifyOverride No
 103 .br
 104 Specifies whether to allow users to override the classification
 105 of individual print jobs.
 106 .TP 5
 107 DefaultAuthType Basic
 108 .TP 5
 109 DefaultAuthType BasicDigest
 110 .TP 5
 111 DefaultAuthType Digest
 112 .TP 5
 113 DefaultAuthType Negotiate
 114 .br
 115 Specifies the default type of authentication to use.
 116 .TP 5
 117 DefaultEncryption Never
 118 .TP 5
 119 DefaultEncryption IfRequested
 120 .TP 5
 121 DefaultEncryption Required
 122 .br
 123 Specifies the type of encryption to use for authenticated requests.
 124 .TP 5
 125 DefaultLanguage locale
 126 .br
 127 Specifies the default language to use for text and web content.
 128 .TP 5
 129 DefaultPaperSize Auto
 130 .TP 5
 131 DefaultPaperSize None
 132 .TP 5
 133 DefaultPaperSize sizename
 134 .br
 135 Specifies the default paper size for new print queues. "Auto" uses a locale-
 136 specific default, while "None" specifies there is no default paper size.
 137 .TP 5
 138 DefaultPolicy policy-name
 139 .br
 140 Specifies the default access policy to use.
 141 .TP 5
 142 DefaultShared Yes
 143 .TP 5
 144 DefaultShared No
 145 .br
 146 Specifies whether local printers are shared by default.
 147 .TP 5
 148 Deny all
 149 .TP 5
 150 Deny none
 151 .TP 5
 152 Deny host.domain.com
 153 .TP 5
 154 Deny *.domain.com
 155 .TP 5
 156 Deny ip-address
 157 .TP 5
 158 Deny ip-address/netmask
 159 .TP 5
 160 Deny ip-address/mm
 161 .TP 5
 162 Deny @IF(name)
 163 .TP 5
 164 Deny @LOCAL
 165 .br
 166 Denies access to the named host or address.
 167 .TP 5
 168 DirtyCleanInterval seconds
 169 .br
 170 Specifies the delay for updating of configuration and state files. A value of 0
 171 causes the update to happen as soon as possible, typically within a few
 172 milliseconds.
 173 .TP 5
 174 Encryption IfRequested
 175 .TP 5
 176 Encryption Never
 177 .TP 5
 178 Encryption Required
 179 .br
 180 Specifies the level of encryption that is required for a particular
 181 location.
 182 .TP 5
 183 FilterLimit limit
 184 .br
 185 Specifies the maximum cost of filters that are run concurrently.
 186 .TP 5
 187 FilterNice nice-value
 188 .br
 189 Specifies the scheduling priority ("nice" value) of filters that
 190 are run to print a job.
 191 .TP 5
 192 GSSServiceName name
 193 .br
 194 Specifies the service name when using Kerberos authentication. The default
 195 service name is "@CUPS_DEFAULT_GSSSERVICENAME@".
 196 .TP 5
 197 HostNameLookups On
 198 .TP 5
 199 HostNameLookups Off
 200 .TP 5
 201 HostNameLookups Double
 202 .br
 203 Specifies whether or not to do reverse lookups on client addresses.
 204 .TP 5
 205 Include filename
 206 .br
 207 Includes the named file.
 208 .TP 5
 209 JobKillDelay seconds
 210 .br
 211 Specifies the number of seconds to wait before killing the filters and backend
 212 associated with a canceled or held job.
 213 .TP 5
 214 JobPrivateAccess all
 215 .TP 5
 216 JobPrivateAccess default
 217 .TP 5
 218 JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
 219 .br
 220 Specifies an access list for a job's private values. The "default" access list
 221 is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed
 222 or requesting-user-name-denied values.
 223 .TP 5
 224 JobPrivateValues all
 225 .TP 5
 226 JobPrivateValues default
 227 .TP 5
 228 JobPrivateValues none
 229 .TP 5
 230 JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
 231 Specifies the list of job values to make private. The "default" values are
 232 "job-name", "job-originating-host-name", and "job-originating-user-name".
 233 .TP 5
 234 JobRetryInterval seconds
 235 .br
 236 Specifies the interval between retries of jobs in seconds.
 237 .TP 5
 238 JobRetryLimit count
 239 .br
 240 Specifies the number of retries that are done for jobs.
 241 .TP 5
 242 KeepAlive Yes
 243 .TP 5
 244 KeepAlive No
 245 .br
 246 Specifies whether to support HTTP keep-alive connections.
 247 .TP 5
 248 KeepAliveTimeout seconds
 249 .br
 250 Specifies the amount of time that connections are kept alive.
 251 .TP 5
 252 <Limit operations> ... </Limit>
 253 .br
 254 Specifies the IPP operations that are being limited inside a policy.
 255 .TP 5
 256 <Limit methods> ... </Limit>
 257 .TP 5
 258 <LimitExcept methods> ... </LimitExcept>
 259 .br
 260 Specifies the HTTP methods that are being limited inside a location.
 261 .TP 5
 262 LimitRequestBody
 263 .br
 264 Specifies the maximum size of any print job request.
 265 .TP 5
 266 Listen ip-address:port
 267 .TP 5
 268 Listen *:port
 269 .TP 5
 270 Listen /path/to/domain/socket
 271 .br
 272 Listens to the specified address and port or domain socket path.
 273 .TP 5
 274 <Location /path> ... </Location>
 275 .br
 276 Specifies access control for the named location.
 277 .TP 5
 278 LogDebugHistory #-messages
 279 .br
 280 Specifies the number of debugging messages that are logged when an error
 281 occurs in a print job.
 282 .TP 5
 283 LogLevel alert
 284 .TP 5
 285 LogLevel crit
 286 .TP 5
 287 LogLevel debug2
 288 .TP 5
 289 LogLevel debug
 290 .TP 5
 291 LogLevel emerg
 292 .TP 5
 293 LogLevel error
 294 .TP 5
 295 LogLevel info
 296 .TP 5
 297 LogLevel none
 298 .TP 5
 299 LogLevel notice
 300 .TP 5
 301 LogLevel warn
 302 .br
 303 Specifies the logging level for the ErrorLog file.
 304 .TP 5
 305 LogTimeFormat standard
 306 .TP 5
 307 LogTimeFormat usecs
 308 .br
 309 Specifies the format of the date and time in the log files.
 310 .TP 5
 311 MaxClients number
 312 .br
 313 Specifies the maximum number of simultaneous clients to support.
 314 .TP 5
 315 MaxClientsPerHost number
 316 .br
 317 Specifies the maximum number of simultaneous clients to support from a
 318 single address.
 319 .TP 5
 320 MaxCopies number
 321 .br
 322 Specifies the maximum number of copies that a user can print of each job.
 323 .TP 5
 324 MaxHoldTime seconds
 325 .br
 326 Specifies the maximum time a job may remain in the "indefinite" hold state
 327 before it is canceled. Set to 0 to disable cancellation of held jobs.
 328 .TP 5
 329 MaxJobs number
 330 .br
 331 Specifies the maximum number of simultaneous jobs to support.
 332 .TP 5
 333 MaxJobsPerPrinter number
 334 .br
 335 Specifies the maximum number of simultaneous jobs per printer to support.
 336 .TP 5
 337 MaxJobsPerUser number
 338 .br
 339 Specifies the maximum number of simultaneous jobs per user to support.
 340 .TP 5
 341 MaxJobTime seconds
 342 .br
 343 Specifies the maximum time a job may take to print before it is canceled. The
 344 default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck"
 345 jobs.
 346 .TP 5
 347 MaxLogSize number-bytes
 348 .br
 349 Specifies the maximum size of the log files before they are
 350 rotated (0 to disable rotation)
 351 .TP 5
 352 MaxRequestSize number-bytes
 353 .br
 354 Specifies the maximum request/file size in bytes (0 for no limit)
 355 .TP 5
 356 MultipleOperationTimeout seconds
 357 .br
 358 Specifies the maximum amount of time to allow between files in a multiple file
 359 print job.
 360 .TP 5
 361 Order allow,deny
 362 .TP 5
 363 Order deny,allow
 364 .br
 365 Specifies the order of HTTP access control (allow,deny or deny,allow)
 366 .TP 5
 367 PageLogFormat format string
 368 .br
 369 Specifies the format of page log lines.
 370 .TP 5
 371 PassEnv variable [... variable]
 372 .br
 373 Passes the specified environment variable(s) to child processes.
 374 .TP 5
 375 <Policy name> ... </Policy>
 376 .br
 377 Specifies access control for the named policy.
 378 .TP 5
 379 Port number
 380 .br
 381 Specifies a port number to listen to for HTTP requests.
 382 .TP 5
 383 PreserveJobFiles Yes
 384 .TP 5
 385 PreserveJobFiles No
 386 .br
 387 Specifies whether or not to preserve job files after they are printed.
 388 .TP 5
 389 PreserveJobHistory Yes
 390 .TP 5
 391 PreserveJobHistory No
 392 .br
 393 Specifies whether or not to preserve the job history after they are
 394 printed.
 395 .TP 5
 396 PrintcapFormat bsd
 397 .TP 5
 398 PrintcapFormat plist
 399 .TP 5
 400 PrintcapFormat solaris
 401 .br
 402 Specifies the format of the printcap file.
 403 .TP 5
 404 ReloadTimeout seconds
 405 .br
 406 Specifies the amount of time to wait for job completion before
 407 restarting the scheduler.
 408 .TP 5
 409 Require group group-name-list
 410 .TP 5
 411 Require user user-name-list
 412 .TP 5
 413 Require valid-user
 414 .br
 415 Specifies that user or group authentication is required.
 416 .TP 5
 417 RIPCache bytes
 418 .br
 419 Specifies the maximum amount of memory to use when converting images
 420 and PostScript files to bitmaps for a printer.
 421 .TP 5
 422 Satisfy all
 423 .TP 5
 424 Satisfy any
 425 .br
 426 Specifies whether all or any limits set for a Location must be
 427 satisfied to allow access.
 428 .TP 5
 429 ServerAdmin user@domain.com
 430 .br
 431 Specifies the email address of the server administrator.
 432 .TP 5
 433 ServerAlias hostname [... hostname]
 434 .TP 5
 435 ServerAlias *
 436 .br
 437 Specifies an alternate name that the server is known by. The special name "*"
 438 allows any name to be used.
 439 .TP 5
 440 ServerName hostname-or-ip-address
 441 .br
 442 Specifies the fully-qualified hostname of the server.
 443 .TP 5
 444 ServerTokens Full
 445 .TP 5
 446 ServerTokens Major
 447 .TP 5
 448 ServerTokens Minimal
 449 .TP 5
 450 ServerTokens Minor
 451 .TP 5
 452 ServerTokens None
 453 .TP 5
 454 ServerTokens OS
 455 .TP 5
 456 ServerTokens ProductOnly
 457 .br
 458 Specifies what information is included in the Server header of HTTP
 459 responses.
 460 .TP 5
 461 SetEnv variable value
 462 .br
 463 Set the specified environment variable to be passed to child processes.
 464 .TP 5
 465 SSLListen
 466 .br
 467 Listens on the specified address and port for encrypted connections.
 468 .TP 5
 469 SSLOptions None
 470 .TP 5
 471 SSLOptions NoEmptyFragments
 472 .br
 473 Sets SSL/TLS protocol options for encrypted connections.
 474 .TP 5
 475 SSLPort
 476 .br
 477 Listens on the specified port for encrypted connections.
 478 .TP 5
 479 StrictConformance Yes
 480 .TP 5
 481 StrictConformance No
 482 .br
 483 Specifies whether the scheduler requires clients to strictly adhere to the IPP
 484 specifications. The default is No.
 485 .TP 5
 486 SubscriptionPrivateAccess all
 487 .TP 5
 488 SubscriptionPrivateAccess default
 489 .TP 5
 490 SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
 491 .br
 492 Specifies an access list for a subscription's private values. The "default"
 493 access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
 494 requesting-user-name-allowed or requesting-user-name-denied values.
 495 .TP 5
 496 SubscriptionPrivateValues all
 497 .TP 5
 498 SubscriptionPrivateValues default
 499 .TP 5
 500 SubscriptionPrivateValues none
 501 .TP 5
 502 SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
 503 Specifies the list of job values to make private. The "default" values are
 504 "notify-events", "notify-pull-method", "notify-recipient-uri",
 505 "notify-subscriber-user-name", and "notify-user-data".
 506 .TP 5
 507 Timeout seconds
 508 .br
 509 Specifies the HTTP request timeout in seconds.
 510 .TP 5
 511 WebInterface yes
 512 .TP 5
 513 WebInterface no
 514 Specifies whether the web interface is enabled.
 515 .SH SEE ALSO
 516 \fIclasses.conf(5)\fR, \fIcups-files.conf(5)\fR, \fIcupsd(8)\fR,
 517 \fImime.convs(5)\fR, \fImime.types(5)\fR, \fIprinters.conf(5)\fR,
 518 \fIsubscriptions.conf(5)\fR,
 519 .br
 520 http://localhost:631/help
 521 .SH COPYRIGHT
 522 Copyright 2007-2013 by Apple Inc.
 523 .\"
 524 .\" End of "$Id$".
 525 .\"