man/cupsd.conf.5

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