man/cupsd.conf.man.in

   1 .\"
   2 .\" "$Id$"
   3 .\"
   4 .\" cupsd.conf man page for CUPS.
   5 .\"
   6 .\" Copyright 2007-2014 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" "20 October 2014" "Apple Inc."
  16 .SH NAME
  17 cupsd.conf \- server configuration file for cups
  18 .SH DESCRIPTION
  19 The
  20 .I cupsd.conf
  21 file configures the CUPS scheduler,
  22 .BR cupsd (8).
  23 It is normally located in the
  24 .I /etc/cups
  25 directory.
  26 \fBNote:\fR File, directory, and user configuration directives that used to be allowed in the \fBcupsd.conf\fR file are now stored in the
  27 .BR cups-files.conf (5)
  28 file instead in order to prevent certain types of privilege escalation attacks.
  29 .LP
  30 Each line in the file can be a configuration directive, a blank line, or a comment.
  31 Configuration directives typically consist of a name and zero or more values separated by whitespace.
  32 The configuration directive name and values are case-insensitive.
  33 Comment lines start with the # character.
  34 .SS TOP-LEVEL DIRECTIVES
  35 The following top-level directives are understood by
  36 .BR cupsd (8):
  37 .\"#AccessLogLevel
  38 .TP 5
  39 \fBAccessLogLevel config\fR
  40 .TP 5
  41 \fBAccessLogLevel actions\fR
  42 .TP 5
  43 \fBAccessLogLevel all\fR
  44 Specifies the logging level for the AccessLog file.
  45 The "config" level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated.
  46 The "actions" level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for "config".
  47 The "all" level logs all requests.
  48 The default access log level is "actions".
  49 .\"#AutoPurgeJobs
  50 .TP 5
  51 \fBAutoPurgeJobs Yes\fR
  52 .TP 5
  53 \fBAutoPurgeJobs No\fR
  54 .br
  55 Specifies whether to purge job history data automatically when it is no longer required for quotas.
  56 The default is "No".
  57 .\"#BrowseLocalProtocols
  58 .TP 5
  59 \fBBrowseLocalProtocols all\fR
  60 .TP 5
  61 \fBBrowseLocalProtocols dnssd\fR
  62 .TP 5
  63 \fBBrowseLocalProtocols none\fR
  64 Specifies which protocols to use for local printer sharing.
  65 The default is "dnssd" on systems that support Bonjour and "none" otherwise.
  66 .\"#BrowseWebIF
  67 .TP 5
  68 \fBBrowseWebIF Yes\fR
  69 .TP 5
  70 \fBBrowseWebIF No\fR
  71 .br
  72 Specifies whether the CUPS web interface is advertised.
  73 The default is "No".
  74 .\"#Browsing
  75 .TP 5
  76 \fBBrowsing Yes\fR
  77 .TP 5
  78 \fBBrowsing No\fR
  79 .br
  80 Specifies whether shared printers are advertised.
  81 The default is "No".
  82 .\"#Classification
  83 .TP 5
  84 \fBClassification \fIbanner\fR
  85 .br
  86 Specifies the security classification of the server.
  87 Any valid banner name can be used, including "classified", "confidential", "secret", "topsecret", and "unclassified", or the banner can be omitted to disable secure printing functions.
  88 The default is no classification banner.
  89 .\"#ClassifyOverride
  90 .TP 5
  91 \fBClassifyOverride Yes\fR
  92 .TP 5
  93 \fBClassifyOverride No\fR
  94 .br
  95 Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option.
  96 The default is "No".
  97 .\"#DefaultAuthType
  98 .TP 5
  99 \fBDefaultAuthType Basic\fR
 100 .TP 5
 101 \fBDefaultAuthType Negotiate\fR
 102 .br
 103 Specifies the default type of authentication to use.
 104 The default is "Basic".
 105 .\"#DefaultEncryption
 106 .TP 5
 107 \fBDefaultEncryption Never\fR
 108 .TP 5
 109 \fBDefaultEncryption IfRequested\fR
 110 .TP 5
 111 \fBDefaultEncryption Required\fR
 112 Specifies whether encryption will be used for authenticated requests.
 113 The default is "Required".
 114 .\"#DefaultLanguage
 115 .TP 5
 116 \fBDefaultLanguage \fIlocale\fR
 117 Specifies the default language to use for text and web content.
 118 The default is "en".
 119 .\"#DefaultPaperSize
 120 .TP 5
 121 \fBDefaultPaperSize Auto\fR
 122 .TP 5
 123 \fBDefaultPaperSize None\fR
 124 .TP 5
 125 \fBDefaultPaperSize \fIsizename\fR
 126 Specifies the default paper size for new print queues. "Auto" uses a locale-specific default, while "None" specifies there is no default paper size.
 127 Specific size names are typically "Letter" or "A4".
 128 The default is "Auto".
 129 .\"#DefaultPolicy
 130 .TP 5
 131 \fBDefaultPolicy \fIpolicy-name\fR
 132 Specifies the default access policy to use.
 133 The default access policy is "default".
 134 .\"#DefaultShared
 135 .TP 5
 136 \fBDefaultShared Yes\fR
 137 .TP 5
 138 \fBDefaultShared No\fR
 139 Specifies whether local printers are shared by default.
 140 The default is "Yes".
 141 .\"#DirtyCleanInterval
 142 .TP 5
 143 \fBDirtyCleanInterval \fIseconds\fR
 144 Specifies the delay for updating of configuration and state files.
 145 A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds.
 146 The default value is "30".
 147 .\"#ErrorPolicy
 148 .TP 5
 149 \fBErrorPolicy abort-job\fR
 150 Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer.
 151 .TP 5
 152 \fBErrorPolicy retry-job\fR
 153 Specifies that a failed print job should be retried at a later time unless otherwise specified for the printer.
 154 .TP 5
 155 \fBErrorPolicy retry-this-job\fR
 156 Specifies that a failed print job should be retried immediately unless otherwise specified for the printer.
 157 .TP 5
 158 \fBErrorPolicy stop-printer\fR
 159 Specifies that a failed print job should stop the printer unless otherwise specified for the printer. The 'stop-printer' error policy is the default.
 160 .\"#FilterLimit
 161 .TP 5
 162 \fBFilterLimit \fIlimit\fR
 163 Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems.
 164 A limit of 0 disables filter limiting.
 165 An average print to a non-PostScript printer needs a filter limit of about 200.
 166 A PostScript printer needs about half that (100).
 167 Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time.
 168 The default limit is "0".
 169 .\"#FilterNice
 170 .TP 5
 171 \fBFilterNice \fInice-value\fR
 172 Specifies the scheduling priority (
 173 .BR nice (8)
 174 value) of filters that are run to print a job.
 175 The nice value ranges from 0, the highest priority, to 19, the lowest priority.
 176 The default is 0.
 177 .\"#GSSServiceName
 178 .TP 5
 179 \fBGSSServiceName \fIname\fR
 180 Specifies the service name when using Kerberos authentication.
 181 The default service name is "http."
 182 .TP 5
 183 .\"#HostNameLookups
 184 \fBHostNameLookups On\fR
 185 .TP 5
 186 \fBHostNameLookups Off\fR
 187 .TP 5
 188 \fBHostNameLookups Double\fR
 189 Specifies whether to do reverse lookups on connecting clients.
 190 The "Double" setting causes
 191 .BR cupsd (8)
 192 to verify that the hostname resolved from the address matches one of the addresses returned for that hostname.
 193 Double lookups also prevent clients with unregistered addresses from connecting to your server.
 194 The default is "Off" to avoid the potential server performance problems with hostname lookups.
 195 Only set this option to "On" or "Double" if absolutely required.
 196 .\"#JobKillDelay
 197 .TP 5
 198 \fBJobKillDelay \fIseconds\fR
 199 Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.
 200 The default is "30".
 201 .\"#JobRetryInterval
 202 .TP 5
 203 \fBJobRetryInterval \fIseconds\fR
 204 Specifies the interval between retries of jobs in seconds.
 205 This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job" or "retry-current-job".
 206 The default is "30".
 207 .\"#JobRetryLimit
 208 .TP 5
 209 \fBJobRetryLimit \fIcount\fR
 210 Specifies the number of retries that are done for jobs.
 211 This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job" or "retry-current-job".
 212 The default is "5".
 213 .\"#KeepAlive
 214 .TP 5
 215 \fBKeepAlive Yes\fR
 216 .TP 5
 217 \fBKeepAlive No\fR
 218 Specifies whether to support HTTP keep-alive connections.
 219 The default is "Yes".
 220 .\"#KeepAliveTimeout
 221 .TP 5
 222 \fBKeepAliveTimeout \fIseconds\fR
 223 Specifies how long an idle client connection remains open.
 224 The default is "30".
 225 .\"#LimitIPP
 226 .TP 5
 227 \fB<Limit \fIoperation \fR...\fB> \fR... \fB</Limit>\fR
 228 Specifies the IPP operations that are being limited inside a Policy section. IPP operation names are listed below in the section "IPP OPERATIONS".
 229 .\"#Limit
 230 .TP 5
 231 \fB<Limit \fImethod \fR...\fB> \fR... \fB</Limit>\fR
 232 .\"#LimitExcept
 233 .TP 5
 234 \fB<LimitExcept \fImethod \fR...\fB> \fR... \fB</LimitExcept>\fR
 235 Specifies the HTTP methods that are being limited inside a Location section. HTTP method names are listed below in the section "HTTP METHODS".
 236 .\"#LimitRequestBody
 237 .TP 5
 238 \fBLimitRequestBody \fIsize\fR
 239 Specifies the maximum size of print files, IPP requests, and HTML form data.
 240 The default is "0" which disables the limit check.
 241 .\"#Listen
 242 .TP 5
 243 \fBListen \fIipv4-address\fB:\fIport\fR
 244 .TP 5
 245 \fBListen [\fIipv6-address\fB]:\fIport\fR
 246 .TP 5
 247 \fBListen *:\fIport\fR
 248 .TP 5
 249 \fBListen \fI/path/to/domain/socket\fR
 250 Listens to the specified address and port or domain socket path for connections.
 251 Multiple Listen directives can be provided to listen on multiple addresses.
 252 The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks.
 253 .\"#ListenBackLog
 254 .TP 5
 255 \fBListenBackLog \fInumber\fR
 256 Specifies the number of pending connections that will be allowed.
 257 This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections.
 258 When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones.
 259 The default is the OS-defined default limit, typically either "5" for older operating systems or "128" for newer operating systems.
 260 .\"#Location
 261 .TP 5
 262 \fB<Location \fI/path\fB> \fR... \fB</Location>\fR
 263 Specifies access control for the named location.
 264 Paths are documented below in the section "LOCATION PATHS".
 265 .\"#LogDebugHistory
 266 .TP 5
 267 \fBLogDebugHistory \fInumber\fR
 268 Specifies the number of debugging messages that are retained for logging if an error occurs in a print job. Debug messages are logged regardless of the LogLevel setting.
 269 .\"#LogLevel
 270 .TP 5
 271 \fBLogLevel \fRnone
 272 .TP 5
 273 \fBLogLevel \fRemerg
 274 .TP 5
 275 \fBLogLevel \fRalert
 276 .TP 5
 277 \fBLogLevel \fRcrit
 278 .TP 5
 279 \fBLogLevel \fRerror
 280 .TP 5
 281 \fBLogLevel \fRwarn
 282 .TP 5
 283 \fBLogLevel \fRnotice
 284 .TP 5
 285 \fBLogLevel \fRinfo
 286 .TP 5
 287 \fBLogLevel \fRdebug
 288 .TP 5
 289 \fBLogLevel \fRdebug2
 290 Specifies the level of logging for the ErrorLog file.
 291 The value "none" stops all logging while "debug2" logs everything.
 292 The default is "warn".
 293 .\"#LogTimeFormat
 294 .TP 5
 295 \fBLogTimeFormat \fRstandard
 296 .TP 5
 297 \fBLogTimeFormat \fRusecs
 298 Specifies the format of the date and time in the log files.
 299 The value "standard" is the default and logs whole seconds while "usecs" logs microseconds.
 300 .\"#MaxClients
 301 .TP 5
 302 \fBMaxClients \fInumber\fR
 303 Specifies the maximum number of simultaneous clients that are allowed by the scheduler.
 304 The default is "100".
 305 .\"#MaxClientPerHost
 306 .TP 5
 307 \fBMaxClientsPerHost \fInumber\fR
 308 Specifies the maximum number of simultaneous clients that are allowed from a
 309 single address.
 310 The default is the MaxClients value.
 311 .\"#MaxCopies
 312 .TP 5
 313 \fBMaxCopies \fInumber\fR
 314 Specifies the maximum number of copies that a user can print of each job.
 315 The default is "9999".
 316 .\"#MaxHoldTime
 317 .TP 5
 318 \fBMaxHoldTime \fIseconds\fR
 319 Specifies the maximum time a job may remain in the "indefinite" hold state before it is canceled.
 320 The default is "0" which disables cancellation of held jobs.
 321 .\"#MaxJobs
 322 .TP 5
 323 \fBMaxJobs \fInumber\fR
 324 Specifies the maximum number of simultaneous jobs that are allowed.
 325 Set to "0" to allow an unlimited number of jobs.
 326 The default is "500".
 327 .\"#MaxJobsPerPrinter
 328 .TP 5
 329 \fBMaxJobsPerPrinter \fInumber\fR
 330 Specifies the maximum number of simultaneous jobs that are allowed per printer.
 331 The default is "0" which allows up to MaxJobs jobs per printer.
 332 .\"#MaxJobsPerUser
 333 .TP 5
 334 \fBMaxJobsPerUser \fInumber\fR
 335 Specifies the maximum number of simultaneous jobs that are allowed per user.
 336 The default is "0" which allows up to MaxJobs jobs per user.
 337 .\"#MaxJobTime
 338 .TP 5
 339 \fBMaxJobTime \fIseconds\fR
 340 Specifies the maximum time a job may take to print before it is canceled.
 341 Set to "0" to disable cancellation of "stuck" jobs.
 342 The default is "10800" (3 hours).
 343 .\"#MaxLogSize
 344 .TP 5
 345 \fBMaxLogSize \fIsize\fR
 346 Specifies the maximum size of the log files before they are rotated.
 347 The value "0" disables log rotation.
 348 The default is "1048576" (1MB).
 349 .\"#MultipleOperationTimeout
 350 .TP 5
 351 \fBMultipleOperationTimeout \fIseconds\fR
 352 Specifies the maximum amount of time to allow between files in a multiple file print job.
 353 The default is "300" (5 minutes).
 354 .\"#PageLogFormat
 355 .TP 5
 356 \fBPageLogFormat \fIformat-string\fR
 357 Specifies the format of PageLog lines.
 358 Sequences beginning with percent (%) characters are replaced with the corresponding information, while all other characters are copied literally.
 359 The following percent sequences are recognized:
 360 .nf
 361
 362     "%%" inserts a single percent character.
 363     "%{name}" inserts the value of the specified IPP attribute.
 364     "%C" inserts the number of copies for the current page.
 365     "%P" inserts the current page number.
 366     "%T" inserts the current date and time in common log format.
 367     "%j" inserts the job ID.
 368     "%p" inserts the printer name.
 369     "%u" inserts the username.
 370
 371 .fi
 372 The default is "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}".
 373 .\"#PassEnv
 374 .TP 5
 375 \fBPassEnv \fIvariable \fR[ ... \fIvariable \fR]
 376 Passes the specified environment variable(s) to child processes.
 377 .\"#Policy
 378 .TP 5
 379 \fB<Policy \fIname\fB> \fR... \fB</Policy>\fR
 380 Specifies access control for the named policy.
 381 .\"#Port
 382 .TP 5
 383 \fBPort \fInumber\fR
 384 Listens to the specified port number for connections.
 385 .\"#PreserveJobFiles
 386 .TP 5
 387 \fBPreserveJobFiles Yes\fR
 388 .TP 5
 389 \fBPreserveJobFiles No\fR
 390 .TP 5
 391 \fBPreserveJobFiles \fIseconds\fR
 392 Specifies whether job files (documents) are preserved after a job is printed.
 393 If a numeric value is specified, job files are preserved for the indicated number of seconds after printing.
 394 The default is "86400" (preserve 1 day).
 395 .\"#PreserveJobHistory
 396 .TP 5
 397 \fBPreserveJobHistory Yes\fR
 398 .TP 5
 399 \fBPreserveJobHistory No\fR
 400 .TP 5
 401 \fBPreserveJobHistory \fIseconds\fR
 402 Specifies whether the job history is preserved after a job is printed.
 403 If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing.
 404 If "Yes", the job history is preserved until the MaxJobs limit is reached.
 405 The default is "Yes".
 406 .\"#ReloadTimeout
 407 .TP 5
 408 \fBReloadTimeout \fIseconds\fR
 409 Specifies the amount of time to wait for job completion before restarting the scheduler.
 410 The default is "30".
 411 .\"#RIPCache
 412 .TP 5
 413 \fBRIPCache \fIsize\fR
 414 Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.
 415 The default is "128m".
 416 .\"#ServerAdmin
 417 .TP 5
 418 \fBServerAdmin \fIemail-address\fR
 419 Specifies the email address of the server administrator.
 420 The default value is "root@ServerName".
 421 .\"#ServerAlias
 422 .TP 5
 423 \fBServerAlias \fIhostname \fR[ ... \fIhostname \fR]
 424 .TP 5
 425 \fBServerAlias *\fR
 426 The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces.
 427 Using the special name "*" can expose your system to known browser-based DNS rebinding attacks, even when accessing sites through a firewall.
 428 If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using "*".
 429 .\"#ServerName
 430 .TP 5
 431 \fBServerName \fIhostname\fR
 432 Specifies the fully-qualified hostname of the server.
 433 The default is the value reported by the
 434 .BR hostname (1)
 435 command.
 436 .\"#ServerTokens
 437 .TP 5
 438 \fBServerTokens None\fR
 439 .TP 5
 440 \fBServerTokens ProductOnly\fR
 441 .TP 5
 442 \fBServerTokens Major\fR
 443 .TP 5
 444 \fBServerTokens Minor\fR
 445 .TP 5
 446 \fBServerTokens Minimal\fR
 447 .TP 5
 448 \fBServerTokens OS\fR
 449 .TP 5
 450 \fBServerTokens Full\fR
 451 Specifies what information is included in the Server header of HTTP responses.
 452 "None" disables the Server header.
 453 "ProductOnly" reports "CUPS".
 454 "Major" reports "CUPS 2".
 455 "Minor" reports "CUPS 2.0".
 456 "Minimal" reports "CUPS 2.0.0".
 457 "OS" reports "CUPS 2.0.0 (UNAME)" where UNAME is the output of the
 458 .BR uname (1)
 459 command.
 460 "Full" reports "CUPS 2.0.0 (UNAME) IPP/2.0".
 461 The default is "Minimal".
 462 .\"#SetEnv
 463 .TP 5
 464 \fBSetEnv \fIvariable value\fR
 465 Set the specified environment variable to be passed to child processes.
 466 .\"#SSLListen
 467 .TP 5
 468 \fBSSLListen \fIipv4-address\fB:\fIport\fR
 469 .TP 5
 470 \fBSSLListen [\fIipv6-address\fB]:\fIport\fR
 471 .TP 5
 472 \fBSSLListen *:\fIport\fR
 473 Listens on the specified address and port for encrypted connections.
 474 .\"#SSLOptions
 475 .TP 5
 476 \fBSSLOptions \fR[\fIAllowRC4\fR] [\fIAllowSSL3\fR]
 477 .TP 5
 478 \fBSSLOptions None\fR
 479 Sets encryption options.
 480 By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
 481 The \fIAllowRC4\fR option enables the 128-bit RC4 cipher suites, which are required for some older clients that do not implement newer ones.
 482 The \fIAllowSSL3\fR option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
 483 .\"#SSLPort
 484 .TP 5
 485 \fBSSLPort \fIport\fR
 486 Listens on the specified port for encrypted connections.
 487 .\"#StrictConformance
 488 .TP 5
 489 \fBStrictConformance Yes\fR
 490 .TP 5
 491 \fBStrictConformance No\fR
 492 Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications.
 493 The default is "No".
 494 .\"#Timeout
 495 .TP 5
 496 \fBTimeout \fIseconds\fR
 497 Specifies the HTTP request timeout.
 498 The default is "300" (5 minutes).
 499 .\"#WebInterface
 500 .TP 5
 501 \fBWebInterface yes\fR
 502 .TP 5
 503 \fBWebInterface no\fR
 504 Specifies whether the web interface is enabled.
 505 The default is "No".
 506 .SS HTTP METHOD NAMES
 507 The following HTTP methods are supported by
 508 .BR cupsd (8):
 509 .TP 5
 510 GET
 511 Used by a client to download icons and other printer resources and to access the CUPS web interface.
 512 .TP 5
 513 HEAD
 514 Used by a client to get the type, size, and modification date of resources.
 515 .TP 5
 516 OPTIONS
 517 Used by a client to establish a secure (SSL/TLS) connection.
 518 .TP 5
 519 POST
 520 Used by a client to submit IPP requests and HTML forms from the CUPS web interface.
 521 .TP 5
 522 PUT
 523 Used by a client to upload configuration files.
 524 .SS IPP OPERATION NAMES
 525 The following IPP operations are supported by
 526 .BR cupsd (8):
 527 .TP 5
 528 CUPS\-Accept\-Jobs
 529 Allows a printer to accept new jobs.
 530 .TP 5
 531 CUPS\-Add\-Modify\-Class
 532 Adds or modifies a printer class.
 533 .TP 5
 534 CUPS\-Add\-Modify\-Printer
 535 Adds or modifies a printer.
 536 .TP 5
 537 CUPS\-Authenticate\-Job
 538 Releases a job that is held for authentication.
 539 .TP 5
 540 CUPS\-Delete\-Class
 541 Deletes a printer class.
 542 .TP 5
 543 CUPS\-Delete\-Printer
 544 Deletes a printer.
 545 .TP 5
 546 CUPS\-Get\-Classes
 547 Gets a list of printer classes.
 548 .TP 5
 549 CUPS\-Get\-Default
 550 Gets the server default printer or printer class.
 551 .TP 5
 552 CUPS\-Get\-Devices
 553 Gets a list of devices that are currently available.
 554 .TP 5
 555 CUPS\-Get\-Document
 556 Gets a document file for a job.
 557 .TP 5
 558 CUPS\-Get\-PPD
 559 Gets a PPD file.
 560 .TP 5
 561 CUPS\-Get\-PPDs
 562 Gets a list of installed PPD files.
 563 .TP 5
 564 CUPS\-Get\-Printers
 565 Gets a list of printers.
 566 .TP 5
 567 CUPS\-Move\-Job
 568 Moves a job.
 569 .TP 5
 570 CUPS\-Reject\-Jobs
 571 Prevents a printer from accepting new jobs.
 572 .TP 5
 573 CUPS\-Set\-Default
 574 Sets the server default printer or printer class.
 575 .TP 5
 576 Cancel\-Job
 577 Cancels a job.
 578 .TP 5
 579 Cancel\-Jobs
 580 Cancels one or more jobs.
 581 .TP 5
 582 Cancel\-My\-Jobs
 583 Cancels one or more jobs creates by a user.
 584 .TP 5
 585 Cancel\-Subscription
 586 Cancels a subscription.
 587 .TP 5
 588 Close\-Job
 589 Closes a job that is waiting for more documents.
 590 .TP 5
 591 Create\-Job
 592 Creates a new job with no documents.
 593 .TP 5
 594 Create\-Job\-Subscriptions
 595 Creates a subscription for job events.
 596 .TP 5
 597 Create\-Printer\-Subscriptions
 598 Creates a subscription for printer events.
 599 .TP 5
 600 Get\-Job\-Attributes
 601 Gets information about a job.
 602 .TP 5
 603 Get\-Jobs
 604 Gets a list of jobs.
 605 .TP 5
 606 Get\-Notifications
 607 Gets a list of event notifications for a subscription.
 608 .TP 5
 609 Get\-Printer\-Attributes
 610 Gets information about a printer or printer class.
 611 .TP 5
 612 Get\-Subscription\-Attributes
 613 Gets information about a subscription.
 614 .TP 5
 615 Get\-Subscriptions
 616 Gets a list of subscriptions.
 617 .TP 5
 618 Hold\-Job
 619 Holds a job from printing.
 620 .TP 5
 621 Hold\-New\-Jobs
 622 Holds all new jobs from printing.
 623 .TP 5
 624 Pause\-Printer
 625 Stops processing of jobs by a printer or printer class.
 626 .TP 5
 627 Pause\-Printer\-After\-Current\-Job
 628 Stops processing of jobs by a printer or printer class after the current job is finished.
 629 .TP 5
 630 Print\-Job
 631 Creates a new job with a single document.
 632 .TP 5
 633 Purge\-Jobs
 634 Cancels one or more jobs and deletes the job history.
 635 .TP 5
 636 Release\-Held\-New\-Jobs
 637 Allows previously held jobs to print.
 638 .TP 5
 639 Release\-Job
 640 Allows a job to print.
 641 .TP 5
 642 Renew\-Subscription
 643 Renews a subscription.
 644 .TP 5
 645 Restart\-Job
 646 Reprints a job, if possible.
 647 .TP 5
 648 Send\-Document
 649 Adds a document to a job.
 650 .TP 5
 651 Set\-Job\-Attributes
 652 Changes job information.
 653 .TP 5
 654 Set\-Printer\-Attributes
 655 Changes printer or printer class information.
 656 .TP 5
 657 Validate\-Job
 658 Validates options for a new job.
 659 .SS LOCATION PATHS
 660 The following paths are commonly used when configuring
 661 .BR cupsd (8):
 662 .TP 5
 663 /
 664 The path for all get operations (get-printers, get-jobs, etc.)
 665 .TP 5
 666 /admin
 667 The path for all administration operations (add-printer, delete-printer, start-printer, etc.)
 668 .TP 5
 669 /admin/conf
 670 The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.)
 671 .TP 5
 672 /admin/log
 673 The path for access to the CUPS log files (access_log, error_log, page_log)
 674 .TP 5
 675 /classes
 676 The path for all printer classes
 677 .TP 5
 678 /classes/name
 679 The resource for the named printer class
 680 .TP 5
 681 /jobs
 682 The path for all jobs (hold-job, release-job, etc.)
 683 .TP 5
 684 /jobs/id
 685 The path for the specified job.
 686 .TP 5
 687 /printers
 688 The path for all printers
 689 .TP 5
 690 /printers/name
 691 The path for the named printer
 692 .TP 5
 693 /printers/name.png
 694 The icon file path for the named printer
 695 .TP 5
 696 /printers/name.ppd
 697 The PPD file path for the named printer
 698 .SS DIRECTIVES VALID WITHIN LOCATION AND LIMIT SECTIONS
 699 The following directives may be placed inside Location and Limit sections in the \fBcupsd.conf\fR file:
 700 .TP 5
 701 \fBAllow all\fR
 702 .TP 5
 703 \fBAllow none\fR
 704 .TP 5
 705 \fBAllow \fIhost.domain.com\fR
 706 .TP 5
 707 \fBAllow *.\fIdomain.com\fR
 708 .TP 5
 709 \fBAllow \fIipv4-address\fR
 710 .TP 5
 711 \fBAllow \fIipv4-address\fB/\fInetmask\fR
 712 .TP 5
 713 \fBAllow \fIipv4-address\fB/\fImm\fR
 714 .TP 5
 715 \fBAllow [\fIipv6-address\fB]\fR
 716 .TP 5
 717 \fBAllow [\fIipv6-address\fB]/\fImm\fR
 718 .TP 5
 719 \fBAllow @IF(\fIname\fB)\fR
 720 .TP 5
 721 \fBAllow @LOCAL\fR
 722 Allows access from the named hosts, domains, addresses, or interfaces.
 723 The Order directive controls whether Allow lines are evaluated before or after Deny lines.
 724 .TP 5
 725 \fBAuthType None\fR
 726 .TP 5
 727 \fBAuthType Basic\fR
 728 .TP 5
 729 \fBAuthType Default\fR
 730 .TP 5
 731 \fBAuthType Negotiate\fR
 732 Specifies the type of authentication required.
 733 The value "Default" corresponds to the DefaultAuthType value.
 734 .TP 5
 735 \fBDeny all\fR
 736 .TP 5
 737 \fBDeny none\fR
 738 .TP 5
 739 \fBDeny \fIhost.domain.com\fR
 740 .TP 5
 741 \fBDeny *.\fIdomain.com\fR
 742 .TP 5
 743 \fBDeny \fIipv4-address\fR
 744 .TP 5
 745 \fBDeny \fIipv4-address\fB/\fInetmask\fR
 746 .TP 5
 747 \fBDeny \fIipv4-address\fB/\fImm\fR
 748 .TP 5
 749 \fBDeny [\fIipv6-address\fB]\fR
 750 .TP 5
 751 \fBDeny [\fIipv6-address\fB]/\fImm\fR
 752 .TP 5
 753 \fBDeny @IF(\fIname\fB)\fR
 754 .TP 5
 755 \fBDeny @LOCAL\fR
 756 Denies access from the named hosts, domains, addresses, or interfaces.
 757 The Order directive controls whether Deny lines are evaluated before or after Allow lines.
 758 .TP 5
 759 \fBEncryption IfRequested\fR
 760 .TP 5
 761 \fBEncryption Never\fR
 762 .TP 5
 763 \fBEncryption Required\fR
 764 Specifies the level of encryption that is required for a particular location.
 765 The default value is "IfRequested".
 766 .TP 5
 767 \fBOrder allow,deny\fR
 768 Specifies that access is denied by default. Allow lines are then processed followed by Deny lines to determine whether a client may access a particular resource.
 769 .TP 5
 770 \fBOrder deny,allow\fR
 771 Specifies that access is allowed by default. Deny lines are then processed followed by Allow lines to determine whether a client may access a particular resource.
 772 .TP 5
 773 \fBRequire group \fIgroup-name \fR[ \fIgroup-name \fR... ]
 774 Specifies that an authenticated user must be a member of one of the named groups.
 775 .TP 5
 776 \fBRequire user {\fIuser-name\fR|\fB@\fIgroup-name\fR} ...
 777 Specifies that an authenticated user must match one of the named users or be a member of one of the named groups.
 778 The group name "@SYSTEM" corresponds to the list of groups defined by the SystemGroup directive in the
 779 .BR cups-files.conf (5)
 780 file.
 781 The group name "@OWNER" corresponds to the owner of the resource, for example the person that submitted a print job.
 782 .TP 5
 783 \fBRequire valid-user\fR
 784 Specifies that any authenticated user is acceptable.
 785 .TP 5
 786 \fBSatisfy all\fR
 787 Specifies that all Allow, AuthType, Deny, Order, and Require conditions must be satisfied to allow access.
 788 .TP 5
 789 \fBSatisfy any\fR
 790 Specifies that any a client may access a resource if either the authentication (AuthType/Require) or address (Allow/Deny/Order) conditions are satisfied.
 791 For example, this can be used to require authentication only for remote accesses.
 792 .SS DIRECTIVES VALID WITHIN POLICY SECTIONS
 793 The following directives may be placed inside Policy sections in the \fBcupsd.conf\fR file:
 794 .TP 5
 795 \fBJobPrivateAccess all\fR
 796 .TP 5
 797 \fBJobPrivateAccess default\fR
 798 .TP 5
 799 \fBJobPrivateAccess \fR{\fIuser\fR|\fB@\fIgroup\fR|\fB@ACL\fR|\fB@OWNER\fR|\fB@SYSTEM\fR} ...
 800 Specifies an access list for a job's private values.
 801 The "default" access list is "@OWNER @SYSTEM".
 802 "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
 803 "@OWNER" maps to the job's owner.
 804 "@SYSTEM" maps to the groups listed for the SystemGroup directive in the
 805 .BR cups-files.conf (5)
 806 file.
 807 .TP 5
 808 \fBJobPrivateValues all\fR
 809 .TP 5
 810 \fBJobPrivateValues default\fR
 811 .TP 5
 812 \fBJobPrivateValues none\fR
 813 .TP 5
 814 \fBJobPrivateValues \fIattribute-name \fR[ ... \fIattribute-name \fR]
 815 Specifies the list of job values to make private.
 816 The "default" values are "job-name", "job-originating-host-name", "job-originating-user-name", and "phone".
 817 .TP 5
 818 \fBSubscriptionPrivateAccess all\fR
 819 .TP 5
 820 \fBSubscriptionPrivateAccess default\fR
 821 .TP 5
 822 \fBSubscriptionPrivateAccess \fR{\fIuser\fR|\fB@\fIgroup\fR|\fB@ACL\fR|\fB@OWNER\fR|\fB@SYSTEM\fR} ...
 823 Specifies an access list for a subscription's private values.
 824 The "default" access list is "@OWNER @SYSTEM".
 825 "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
 826 "@OWNER" maps to the job's owner.
 827 "@SYSTEM" maps to the groups listed for the SystemGroup directive in the
 828 .BR cups-files.conf (5)
 829 file.
 830 .TP 5
 831 \fBSubscriptionPrivateValues all\fR
 832 .TP 5
 833 \fBSubscriptionPrivateValues default\fR
 834 .TP 5
 835 \fBSubscriptionPrivateValues none\fR
 836 .TP 5
 837 \fBSubscriptionPrivateValues \fIattribute-name \fR[ ... \fIattribute-name \fR]
 838 Specifies the list of subscription values to make private.
 839 The "default" values are "notify-events", "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and "notify-user-data".
 840 .SH CONFORMING TO
 841 The \fBcupsd.conf\fR file format is based on the Apache HTTP Server configuration file format.
 842 .SH EXAMPLES
 843 Log everything with a maximum log file size of 32 megabytes:
 844 .nf
 845
 846     AccessLogLevel all
 847     LogLevel debug2
 848     MaxLogSize 32m
 849
 850 .fi
 851 Require authentication for accesses from outside the 10. network:
 852 .nf
 853
 854     <Location />
 855     Order allow,deny
 856     Allow from 10./8
 857     AuthType Basic
 858     Require valid-user
 859     Satisfy any
 860     </Location>
 861 .fi
 862 .SH SEE ALSO
 863 .BR classes.conf (5),
 864 .BR cups-files.conf (5),
 865 .BR cupsd (8),
 866 .BR mime.convs (5),
 867 .BR mime.types (5),
 868 .BR printers.conf (5),
 869 .BR subscriptions.conf (5),
 870 CUPS Online Help (http://localhost:631/help)
 871 .SH COPYRIGHT
 872 Copyright \[co] 2007-2014 by Apple Inc.
 873 .\"
 874 .\" End of "$Id$".
 875 .\"