man/cupsd.conf.man.in

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