doc/help/man-cupsd.conf.html

   1 <!DOCTYPE HTML>
   2 <html>
   3 <!-- SECTION: Man Pages -->
   4 <head>
   5         <link rel="stylesheet" type="text/css" href="../cups-printable.css">
   6         <title>cupsd.conf(5)</title>
   7 </head>
   8 <body>
   9 <h1 class="title">cupsd.conf(5)</h1>
  10 <h2 class="title"><a name="NAME">Name</a></h2>
  11 cupsd.conf - server configuration file for cups
  12 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
  13 The
  14 <i>cupsd.conf</i>
  15 file configures the CUPS scheduler,
  16 <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a>
  17 It is normally located in the
  18 <i>/etc/cups</i>
  19 directory.
  20 <b>Note:</b> File, directory, and user configuration directives that used to be allowed in the <b>cupsd.conf</b> file are now stored in the
  21 <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
  22 file instead in order to prevent certain types of privilege escalation attacks.
  23 <p>Each line in the file can be a configuration directive, a blank line, or a comment.
  24 Configuration directives typically consist of a name and zero or more values separated by whitespace.
  25 The configuration directive name and values are case-insensitive.
  26 Comment lines start with the # character.
  27 <h3><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h3>
  28 The following top-level directives are understood by
  29 <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
  30 <dl class="man">
  31 <dt><b>AccessLogLevel config</b>
  32 <dd style="margin-left: 5.0em"><dt><b>AccessLogLevel actions</b>
  33 <dd style="margin-left: 5.0em"><dt><b>AccessLogLevel all</b>
  34 <dd style="margin-left: 5.0em">Specifies the logging level for the AccessLog file.
  35 The "config" level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated.
  36 The "actions" level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for "config".
  37 The "all" level logs all requests.
  38 The default access log level is "actions".
  39 <dt><b>AutoPurgeJobs Yes</b>
  40 <dd style="margin-left: 5.0em"><dt><b>AutoPurgeJobs No</b>
  41 <dd style="margin-left: 5.0em"><br>
  42 Specifies whether to purge job history data automatically when it is no longer required for quotas.
  43 The default is "No".
  44 <dt><b>BrowseLocalProtocols all</b>
  45 <dd style="margin-left: 5.0em"><dt><b>BrowseLocalProtocols dnssd</b>
  46 <dd style="margin-left: 5.0em"><dt><b>BrowseLocalProtocols none</b>
  47 <dd style="margin-left: 5.0em">Specifies which protocols to use for local printer sharing.
  48 The default is "dnssd" on systems that support Bonjour and "none" otherwise.
  49 <dt><b>BrowseWebIF Yes</b>
  50 <dd style="margin-left: 5.0em"><dt><b>BrowseWebIF No</b>
  51 <dd style="margin-left: 5.0em"><br>
  52 Specifies whether the CUPS web interface is advertised.
  53 The default is "No".
  54 <dt><b>Browsing Yes</b>
  55 <dd style="margin-left: 5.0em"><dt><b>Browsing No</b>
  56 <dd style="margin-left: 5.0em"><br>
  57 Specifies whether shared printers are advertised.
  58 The default is "No".
  59 <dt><b>Classification </b><i>banner</i>
  60 <dd style="margin-left: 5.0em"><br>
  61 Specifies the security classification of the server.
  62 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.
  63 The default is no classification banner.
  64 <dt><b>ClassifyOverride Yes</b>
  65 <dd style="margin-left: 5.0em"><dt><b>ClassifyOverride No</b>
  66 <dd style="margin-left: 5.0em"><br>
  67 Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option.
  68 The default is "No".
  69 <dt><b>DefaultAuthType Basic</b>
  70 <dd style="margin-left: 5.0em"><dt><b>DefaultAuthType Negotiate</b>
  71 <dd style="margin-left: 5.0em"><br>
  72 Specifies the default type of authentication to use.
  73 The default is "Basic".
  74 <dt><b>DefaultEncryption Never</b>
  75 <dd style="margin-left: 5.0em"><dt><b>DefaultEncryption IfRequested</b>
  76 <dd style="margin-left: 5.0em"><dt><b>DefaultEncryption Required</b>
  77 <dd style="margin-left: 5.0em">Specifies whether encryption will be used for authenticated requests.
  78 The default is "Required".
  79 <dt><b>DefaultLanguage </b><i>locale</i>
  80 <dd style="margin-left: 5.0em">Specifies the default language to use for text and web content.
  81 The default is "en".
  82 <dt><b>DefaultPaperSize Auto</b>
  83 <dd style="margin-left: 5.0em"><dt><b>DefaultPaperSize None</b>
  84 <dd style="margin-left: 5.0em"><dt><b>DefaultPaperSize </b><i>sizename</i>
  85 <dd style="margin-left: 5.0em">Specifies the default paper size for new print queues. "Auto" uses a locale-specific default, while "None" specifies there is no default paper size.
  86 Specific size names are typically "Letter" or "A4".
  87 The default is "Auto".
  88 <dt><b>DefaultPolicy </b><i>policy-name</i>
  89 <dd style="margin-left: 5.0em">Specifies the default access policy to use.
  90 The default access policy is "default".
  91 <dt><b>DefaultShared Yes</b>
  92 <dd style="margin-left: 5.0em"><dt><b>DefaultShared No</b>
  93 <dd style="margin-left: 5.0em">Specifies whether local printers are shared by default.
  94 The default is "Yes".
  95 <dt><b>DirtyCleanInterval </b><i>seconds</i>
  96 <dd style="margin-left: 5.0em">Specifies the delay for updating of configuration and state files.
  97 A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds.
  98 The default value is "30".
  99 <dt><b>FilterLimit </b><i>limit</i>
 100 <dd style="margin-left: 5.0em">Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems.
 101 A limit of 0 disables filter limiting.
 102 An average print to a non-PostScript printer needs a filter limit of about 200.
 103 A PostScript printer needs about half that (100).
 104 Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time.
 105 The default limit is "0".
 106 <dt><b>FilterNice </b><i>nice-value</i>
 107 <dd style="margin-left: 5.0em">Specifies the scheduling priority (
 108 <b>nice</b>(8)
 109 value) of filters that are run to print a job.
 110 The nice value ranges from 0, the highest priority, to 19, the lowest priority.
 111 The default is 0.
 112 <dt><b>GSSServiceName </b><i>name</i>
 113 <dd style="margin-left: 5.0em">Specifies the service name when using Kerberos authentication.
 114 The default service name is "http."
 115 <dt><b>HostNameLookups On</b>
 116 <dd style="margin-left: 5.0em"><dt><b>HostNameLookups Off</b>
 117 <dd style="margin-left: 5.0em"><dt><b>HostNameLookups Double</b>
 118 <dd style="margin-left: 5.0em">Specifies whether to do reverse lookups on connecting clients.
 119 The "Double" setting causes
 120 <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a>
 121 to verify that the hostname resolved from the address matches one of the addresses returned for that hostname.
 122 Double lookups also prevent clients with unregistered addresses from connecting to your server.
 123 The default is "Off" to avoid the potential server performance problems with hostname lookups.
 124 Only set this option to "On" or "Double" if absolutely required.
 125 <dt><b>JobKillDelay </b><i>seconds</i>
 126 <dd style="margin-left: 5.0em">Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.
 127 The default is "30".
 128 <dt><b>JobRetryInterval </b><i>seconds</i>
 129 <dd style="margin-left: 5.0em">Specifies the interval between retries of jobs in seconds.
 130 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".
 131 The default is "30".
 132 <dt><b>JobRetryLimit </b><i>count</i>
 133 <dd style="margin-left: 5.0em">Specifies the number of retries that are done for jobs.
 134 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".
 135 The default is "5".
 136 <dt><b>KeepAlive Yes</b>
 137 <dd style="margin-left: 5.0em"><dt><b>KeepAlive No</b>
 138 <dd style="margin-left: 5.0em">Specifies whether to support HTTP keep-alive connections.
 139 The default is "Yes".
 140 <dt><b>KeepAliveTimeout </b><i>seconds</i>
 141 <dd style="margin-left: 5.0em">Specifies how long an idle client connection remains open.
 142 The default is "30".
 143 <dt><b>&lt;Limit </b><i>operation </i>...<b>> </b>... <b>&lt;/Limit></b>
 144 <dd style="margin-left: 5.0em">Specifies the IPP operations that are being limited inside a Policy section. IPP operation names are listed below in the section "IPP OPERATIONS".
 145 <dt><b>&lt;Limit </b><i>method </i>...<b>> </b>... <b>&lt;/Limit></b>
 146 <dd style="margin-left: 5.0em"><dt><b>&lt;LimitExcept </b><i>method </i>...<b>> </b>... <b>&lt;/LimitExcept></b>
 147 <dd style="margin-left: 5.0em">Specifies the HTTP methods that are being limited inside a Location section. HTTP method names are listed below in the section "HTTP METHODS".
 148 <dt><b>LimitRequestBody </b><i>size</i>
 149 <dd style="margin-left: 5.0em">Specifies the maximum size of print files, IPP requests, and HTML form data.
 150 The default is "0" which disables the limit check.
 151 <dt><b>Listen </b><i>ipv4-address</i><b>:</b><i>port</i>
 152 <dd style="margin-left: 5.0em"><dt><b>Listen [</b><i>ipv6-address</i><b>]:</b><i>port</i>
 153 <dd style="margin-left: 5.0em"><dt><b>Listen *:</b><i>port</i>
 154 <dd style="margin-left: 5.0em"><dt><b>Listen </b><i>/path/to/domain/socket</i>
 155 <dd style="margin-left: 5.0em">Listens to the specified address and port or domain socket path for connections.
 156 Multiple Listen directives can be provided to listen on multiple addresses.
 157 The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks.
 158 <dt><b>ListenBackLog </b><i>number</i>
 159 <dd style="margin-left: 5.0em">Specifies the number of pending connections that will be allowed.
 160 This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections.
 161 When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones.
 162 The default is the OS-defined default limit, typically either "5" for older operating systems or "128" for newer operating systems.
 163 <dt><b>&lt;Location </b><i>/path</i><b>> </b>... <b>&lt;/Location></b>
 164 <dd style="margin-left: 5.0em">Specifies access control for the named location.
 165 Paths are documented below in the section "LOCATION PATHS".
 166 <dt><b>LogDebugHistory </b><i>number</i>
 167 <dd style="margin-left: 5.0em">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.
 168 <dt><b>LogLevel </b>none
 169 <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>emerg
 170 <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>alert
 171 <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>crit
 172 <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>error
 173 <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>warn
 174 <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>notice
 175 <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>info
 176 <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>debug
 177 <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>debug2
 178 <dd style="margin-left: 5.0em">Specifies the level of logging for the ErrorLog file.
 179 The value "none" stops all logging while "debug2" logs everything.
 180 The default is "warn".
 181 <dt><b>LogTimeFormat </b>standard
 182 <dd style="margin-left: 5.0em"><dt><b>LogTimeFormat </b>usecs
 183 <dd style="margin-left: 5.0em">Specifies the format of the date and time in the log files.
 184 The value "standard" is the default and logs whole seconds while "usecs" logs microseconds.
 185 <dt><b>MaxClients </b><i>number</i>
 186 <dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients that are allowed by the scheduler.
 187 The default is "100".
 188 <dt><b>MaxClientsPerHost </b><i>number</i>
 189 <dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients that are allowed from a
 190 single address.
 191 The default is the MaxClients value.
 192 <dt><b>MaxCopies </b><i>number</i>
 193 <dd style="margin-left: 5.0em">Specifies the maximum number of copies that a user can print of each job.
 194 The default is "9999".
 195 <dt><b>MaxHoldTime </b><i>seconds</i>
 196 <dd style="margin-left: 5.0em">Specifies the maximum time a job may remain in the "indefinite" hold state before it is canceled.
 197 The default is "0" which disables cancellation of held jobs.
 198 <dt><b>MaxJobs </b><i>number</i>
 199 <dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs that are allowed.
 200 Set to "0" to allow an unlimited number of jobs.
 201 The default is "500".
 202 <dt><b>MaxJobsPerPrinter </b><i>number</i>
 203 <dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs that are allowed per printer.
 204 The default is "0" which allows up to MaxJobs jobs per printer.
 205 <dt><b>MaxJobsPerUser </b><i>number</i>
 206 <dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs that are allowed per user.
 207 The default is "0" which allows up to MaxJobs jobs per user.
 208 <dt><b>MaxJobTime </b><i>seconds</i>
 209 <dd style="margin-left: 5.0em">Specifies the maximum time a job may take to print before it is canceled.
 210 Set to "0" to disable cancellation of "stuck" jobs.
 211 The default is "10800" (3 hours).
 212 <dt><b>MaxLogSize </b><i>size</i>
 213 <dd style="margin-left: 5.0em">Specifies the maximum size of the log files before they are rotated.
 214 The value "0" disables log rotation.
 215 The default is "1048576" (1MB).
 216 <dt><b>MultipleOperationTimeout </b><i>seconds</i>
 217 <dd style="margin-left: 5.0em">Specifies the maximum amount of time to allow between files in a multiple file print job.
 218 The default is "300" (5 minutes).
 219 <dt><b>PageLogFormat </b><i>format-string</i>
 220 <dd style="margin-left: 5.0em">Specifies the format of PageLog lines.
 221 Sequences beginning with percent (%) characters are replaced with the corresponding information, while all other characters are copied literally.
 222 The following percent sequences are recognized:
 223 <pre class="man">
 224
 225     "%%" inserts a single percent character.
 226     "%{name}" inserts the value of the specified IPP attribute.
 227     "%C" inserts the number of copies for the current page.
 228     "%P" inserts the current page number.
 229     "%T" inserts the current date and time in common log format.
 230     "%j" inserts the job ID.
 231     "%p" inserts the printer name.
 232     "%u" inserts the username.
 233
 234 </pre>
 235 The default is "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}".
 236 <dt><b>PassEnv </b><i>variable </i>[ ... <i>variable </i>]
 237 <dd style="margin-left: 5.0em">Passes the specified environment variable(s) to child processes.
 238 <dt><b>&lt;Policy </b><i>name</i><b>> </b>... <b>&lt;/Policy></b>
 239 <dd style="margin-left: 5.0em">Specifies access control for the named policy.
 240 <dt><b>Port </b><i>number</i>
 241 <dd style="margin-left: 5.0em">Listens to the specified port number for connections.
 242 <dt><b>PreserveJobFiles Yes</b>
 243 <dd style="margin-left: 5.0em"><dt><b>PreserveJobFiles No</b>
 244 <dd style="margin-left: 5.0em"><dt><b>PreserveJobFiles </b><i>seconds</i>
 245 <dd style="margin-left: 5.0em">Specifies whether job files (documents) are preserved after a job is printed.
 246 If a numeric value is specified, job files are preserved for the indicated number of seconds after printing.
 247 The default is "86400" (preserve 1 day).
 248 <dt><b>PreserveJobHistory Yes</b>
 249 <dd style="margin-left: 5.0em"><dt><b>PreserveJobHistory No</b>
 250 <dd style="margin-left: 5.0em"><dt><b>PreserveJobHistory </b><i>seconds</i>
 251 <dd style="margin-left: 5.0em">Specifies whether the job history is preserved after a job is printed.
 252 If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing.
 253 If "Yes", the job history is preserved until the MaxJobs limit is reached.
 254 The default is "Yes".
 255 <dt><b>ReloadTimeout </b><i>seconds</i>
 256 <dd style="margin-left: 5.0em">Specifies the amount of time to wait for job completion before restarting the scheduler.
 257 The default is "30".
 258 <dt><b>RIPCache </b><i>size</i>
 259 <dd style="margin-left: 5.0em">Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.
 260 The default is "128m".
 261 <dt><b>ServerAdmin </b><i>email-address</i>
 262 <dd style="margin-left: 5.0em">Specifies the email address of the server administrator.
 263 The default value is "root@ServerName".
 264 <dt><b>ServerAlias </b><i>hostname </i>[ ... <i>hostname </i>]
 265 <dd style="margin-left: 5.0em"><dt><b>ServerAlias *</b>
 266 <dd style="margin-left: 5.0em">The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces.
 267 Using the special name "*" can expose your system to known browser-based DNS rebinding attacks, even when accessing sites through a firewall.
 268 If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using "*".
 269 <dt><b>ServerName </b><i>hostname</i>
 270 <dd style="margin-left: 5.0em">Specifies the fully-qualified hostname of the server.
 271 The default is the value reported by the
 272 <b>hostname</b>(1)
 273 command.
 274 <dt><b>ServerTokens None</b>
 275 <dd style="margin-left: 5.0em"><dt><b>ServerTokens ProductOnly</b>
 276 <dd style="margin-left: 5.0em"><dt><b>ServerTokens Major</b>
 277 <dd style="margin-left: 5.0em"><dt><b>ServerTokens Minor</b>
 278 <dd style="margin-left: 5.0em"><dt><b>ServerTokens Minimal</b>
 279 <dd style="margin-left: 5.0em"><dt><b>ServerTokens OS</b>
 280 <dd style="margin-left: 5.0em"><dt><b>ServerTokens Full</b>
 281 <dd style="margin-left: 5.0em">Specifies what information is included in the Server header of HTTP responses.
 282 "None" disables the Server header.
 283 "ProductOnly" reports "CUPS".
 284 "Major" reports "CUPS 2".
 285 "Minor" reports "CUPS 2.0".
 286 "Minimal" reports "CUPS 2.0.0".
 287 "OS" reports "CUPS 2.0.0 (UNAME)" where UNAME is the output of the
 288 <b>uname</b>(1)
 289 command.
 290 "Full" reports "CUPS 2.0.0 (UNAME) IPP/2.0".
 291 The default is "Minimal".
 292 <dt><b>SetEnv </b><i>variable value</i>
 293 <dd style="margin-left: 5.0em">Set the specified environment variable to be passed to child processes.
 294 <dt><dt><b>SSLListen </b><i>ipv4-address</i><b>:</b><i>port</i>
 295 <dd style="margin-left: 5.0em"><dt><b>SSLListen [</b><i>ipv6-address</i><b>]:</b><i>port</i>
 296 <dd style="margin-left: 5.0em"><dt><b>SSLListen *:</b><i>port</i>
 297 <dd style="margin-left: 5.0em">Listens on the specified address and port for encrypted connections.
 298 <dt><b>SSLPort </b><i>port</i>
 299 <dd style="margin-left: 5.0em">Listens on the specified port for encrypted connections.
 300 <dt><b>StrictConformance Yes</b>
 301 <dd style="margin-left: 5.0em"><dt><b>StrictConformance No</b>
 302 <dd style="margin-left: 5.0em">Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications.
 303 The default is "No".
 304 <dt><b>Timeout </b><i>seconds</i>
 305 <dd style="margin-left: 5.0em">Specifies the HTTP request timeout.
 306 The default is "300" (5 minutes).
 307 <dt><b>WebInterface yes</b>
 308 <dd style="margin-left: 5.0em"><dt><b>WebInterface no</b>
 309 <dd style="margin-left: 5.0em">Specifies whether the web interface is enabled.
 310 The default is "No".
 311 </dl>
 312 <h3><a name="HTTP_METHOD_NAMES">Http Method Names</a></h3>
 313 The following HTTP methods are supported by
 314 <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
 315 <dl class="man">
 316 <dt>GET
 317 <dd style="margin-left: 5.0em">Used by a client to download icons and other printer resources and to access the CUPS web interface.
 318 <dt>HEAD
 319 <dd style="margin-left: 5.0em">Used by a client to get the type, size, and modification date of resources.
 320 <dt>OPTIONS
 321 <dd style="margin-left: 5.0em">Used by a client to establish a secure (SSL/TLS) connection.
 322 <dt>POST
 323 <dd style="margin-left: 5.0em">Used by a client to submit IPP requests and HTML forms from the CUPS web interface.
 324 <dt>PUT
 325 <dd style="margin-left: 5.0em">Used by a client to upload configuration files.
 326 </dl>
 327 <h3><a name="IPP_OPERATION_NAMES">Ipp Operation Names</a></h3>
 328 The following IPP operations are supported by
 329 <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
 330 <dl class="man">
 331 <dt>CUPS-Accept-Jobs
 332 <dd style="margin-left: 5.0em">Allows a printer to accept new jobs.
 333 <dt>CUPS-Add-Modify-Class
 334 <dd style="margin-left: 5.0em">Adds or modifies a printer class.
 335 <dt>CUPS-Add-Modify-Printer
 336 <dd style="margin-left: 5.0em">Adds or modifies a printer.
 337 <dt>CUPS-Authenticate-Job
 338 <dd style="margin-left: 5.0em">Releases a job that is held for authentication.
 339 <dt>CUPS-Delete-Class
 340 <dd style="margin-left: 5.0em">Deletes a printer class.
 341 <dt>CUPS-Delete-Printer
 342 <dd style="margin-left: 5.0em">Deletes a printer.
 343 <dt>CUPS-Get-Classes
 344 <dd style="margin-left: 5.0em">Gets a list of printer classes.
 345 <dt>CUPS-Get-Default
 346 <dd style="margin-left: 5.0em">Gets the server default printer or printer class.
 347 <dt>CUPS-Get-Devices
 348 <dd style="margin-left: 5.0em">Gets a list of devices that are currently available.
 349 <dt>CUPS-Get-Document
 350 <dd style="margin-left: 5.0em">Gets a document file for a job.
 351 <dt>CUPS-Get-PPD
 352 <dd style="margin-left: 5.0em">Gets a PPD file.
 353 <dt>CUPS-Get-PPDs
 354 <dd style="margin-left: 5.0em">Gets a list of installed PPD files.
 355 <dt>CUPS-Get-Printers
 356 <dd style="margin-left: 5.0em">Gets a list of printers.
 357 <dt>CUPS-Move-Job
 358 <dd style="margin-left: 5.0em">Moves a job.
 359 <dt>CUPS-Reject-Jobs
 360 <dd style="margin-left: 5.0em">Prevents a printer from accepting new jobs.
 361 <dt>CUPS-Set-Default
 362 <dd style="margin-left: 5.0em">Sets the server default printer or printer class.
 363 <dt>Cancel-Job
 364 <dd style="margin-left: 5.0em">Cancels a job.
 365 <dt>Cancel-Jobs
 366 <dd style="margin-left: 5.0em">Cancels one or more jobs.
 367 <dt>Cancel-My-Jobs
 368 <dd style="margin-left: 5.0em">Cancels one or more jobs creates by a user.
 369 <dt>Cancel-Subscription
 370 <dd style="margin-left: 5.0em">Cancels a subscription.
 371 <dt>Close-Job
 372 <dd style="margin-left: 5.0em">Closes a job that is waiting for more documents.
 373 <dt>Create-Job
 374 <dd style="margin-left: 5.0em">Creates a new job with no documents.
 375 <dt>Create-Job-Subscriptions
 376 <dd style="margin-left: 5.0em">Creates a subscription for job events.
 377 <dt>Create-Printer-Subscriptions
 378 <dd style="margin-left: 5.0em">Creates a subscription for printer events.
 379 <dt>Get-Job-Attributes
 380 <dd style="margin-left: 5.0em">Gets information about a job.
 381 <dt>Get-Jobs
 382 <dd style="margin-left: 5.0em">Gets a list of jobs.
 383 <dt>Get-Notifications
 384 <dd style="margin-left: 5.0em">Gets a list of event notifications for a subscription.
 385 <dt>Get-Printer-Attributes
 386 <dd style="margin-left: 5.0em">Gets information about a printer or printer class.
 387 <dt>Get-Subscription-Attributes
 388 <dd style="margin-left: 5.0em">Gets information about a subscription.
 389 <dt>Get-Subscriptions
 390 <dd style="margin-left: 5.0em">Gets a list of subscriptions.
 391 <dt>Hold-Job
 392 <dd style="margin-left: 5.0em">Holds a job from printing.
 393 <dt>Hold-New-Jobs
 394 <dd style="margin-left: 5.0em">Holds all new jobs from printing.
 395 <dt>Pause-Printer
 396 <dd style="margin-left: 5.0em">Stops processing of jobs by a printer or printer class.
 397 <dt>Pause-Printer-After-Current-Job
 398 <dd style="margin-left: 5.0em">Stops processing of jobs by a printer or printer class after the current job is finished.
 399 <dt>Print-Job
 400 <dd style="margin-left: 5.0em">Creates a new job with a single document.
 401 <dt>Purge-Jobs
 402 <dd style="margin-left: 5.0em">Cancels one or more jobs and deletes the job history.
 403 <dt>Release-Held-New-Jobs
 404 <dd style="margin-left: 5.0em">Allows previously held jobs to print.
 405 <dt>Release-Job
 406 <dd style="margin-left: 5.0em">Allows a job to print.
 407 <dt>Renew-Subscription
 408 <dd style="margin-left: 5.0em">Renews a subscription.
 409 <dt>Restart-Job
 410 <dd style="margin-left: 5.0em">Reprints a job, if possible.
 411 <dt>Send-Document
 412 <dd style="margin-left: 5.0em">Adds a document to a job.
 413 <dt>Set-Job-Attributes
 414 <dd style="margin-left: 5.0em">Changes job information.
 415 <dt>Set-Printer-Attributes
 416 <dd style="margin-left: 5.0em">Changes printer or printer class information.
 417 <dt>Validate-Job
 418 <dd style="margin-left: 5.0em">Validates options for a new job.
 419 </dl>
 420 <h3><a name="LOCATION_PATHS">Location Paths</a></h3>
 421 The following paths are commonly used when configuring
 422 <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
 423 <dl class="man">
 424 <dt>/
 425 <dd style="margin-left: 5.0em">The path for all get operations (get-printers, get-jobs, etc.)
 426 <dt>/admin
 427 <dd style="margin-left: 5.0em">The path for all administration operations (add-printer, delete-printer, start-printer, etc.)
 428 <dt>/admin/conf
 429 <dd style="margin-left: 5.0em">The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.)
 430 <dt>/admin/log
 431 <dd style="margin-left: 5.0em">The path for access to the CUPS log files (access_log, error_log, page_log)
 432 <dt>/classes
 433 <dd style="margin-left: 5.0em">The path for all printer classes
 434 <dt>/classes/name
 435 <dd style="margin-left: 5.0em">The resource for the named printer class
 436 <dt>/jobs
 437 <dd style="margin-left: 5.0em">The path for all jobs (hold-job, release-job, etc.)
 438 <dt>/jobs/id
 439 <dd style="margin-left: 5.0em">The path for the specified job.
 440 <dt>/printers
 441 <dd style="margin-left: 5.0em">The path for all printers
 442 <dt>/printers/name
 443 <dd style="margin-left: 5.0em">The path for the named printer
 444 <dt>/printers/name.png
 445 <dd style="margin-left: 5.0em">The icon file path for the named printer
 446 <dt>/printers/name.ppd
 447 <dd style="margin-left: 5.0em">The PPD file path for the named printer
 448 </dl>
 449 <h3><a name="DIRECTIVES_VALID_WITHIN_LOCATION_AND_LIMIT_SECTIONS">Directives Valid Within Location And Limit Sections</a></h3>
 450 The following directives may be placed inside Location and Limit sections in the <b>cupsd.conf</b> file:
 451 <dl class="man">
 452 <dt><b>Allow all</b>
 453 <dd style="margin-left: 5.0em"><dt><b>Allow none</b>
 454 <dd style="margin-left: 5.0em"><dt><b>Allow </b><i>host.domain.com</i>
 455 <dd style="margin-left: 5.0em"><dt><b>Allow *.</b><i>domain.com</i>
 456 <dd style="margin-left: 5.0em"><dt><b>Allow </b><i>ipv4-address</i>
 457 <dd style="margin-left: 5.0em"><dt><b>Allow </b><i>ipv4-address</i><b>/</b><i>netmask</i>
 458 <dd style="margin-left: 5.0em"><dt><b>Allow </b><i>ipv4-address</i><b>/</b><i>mm</i>
 459 <dd style="margin-left: 5.0em"><dt><b>Allow [</b><i>ipv6-address</i><b>]</b>
 460 <dd style="margin-left: 5.0em"><dt><b>Allow [</b><i>ipv6-address</i><b>]/</b><i>mm</i>
 461 <dd style="margin-left: 5.0em"><dt><b>Allow @IF(</b><i>name</i><b>)</b>
 462 <dd style="margin-left: 5.0em"><dt><b>Allow @LOCAL</b>
 463 <dd style="margin-left: 5.0em">Allows access from the named hosts, domains, addresses, or interfaces.
 464 The Order directive controls whether Allow lines are evaluated before or after Deny lines.
 465 <dt><b>AuthType None</b>
 466 <dd style="margin-left: 5.0em"><dt><b>AuthType Basic</b>
 467 <dd style="margin-left: 5.0em"><dt><b>AuthType Default</b>
 468 <dd style="margin-left: 5.0em"><dt><b>AuthType Negotiate</b>
 469 <dd style="margin-left: 5.0em">Specifies the type of authentication required.
 470 The value "Default" corresponds to the DefaultAuthType value.
 471 <dt><b>Deny all</b>
 472 <dd style="margin-left: 5.0em"><dt><b>Deny none</b>
 473 <dd style="margin-left: 5.0em"><dt><b>Deny </b><i>host.domain.com</i>
 474 <dd style="margin-left: 5.0em"><dt><b>Deny *.</b><i>domain.com</i>
 475 <dd style="margin-left: 5.0em"><dt><b>Deny </b><i>ipv4-address</i>
 476 <dd style="margin-left: 5.0em"><dt><b>Deny </b><i>ipv4-address</i><b>/</b><i>netmask</i>
 477 <dd style="margin-left: 5.0em"><dt><b>Deny </b><i>ipv4-address</i><b>/</b><i>mm</i>
 478 <dd style="margin-left: 5.0em"><dt><b>Deny [</b><i>ipv6-address</i><b>]</b>
 479 <dd style="margin-left: 5.0em"><dt><b>Deny [</b><i>ipv6-address</i><b>]/</b><i>mm</i>
 480 <dd style="margin-left: 5.0em"><dt><b>Deny @IF(</b><i>name</i><b>)</b>
 481 <dd style="margin-left: 5.0em"><dt><b>Deny @LOCAL</b>
 482 <dd style="margin-left: 5.0em">Denies access from the named hosts, domains, addresses, or interfaces.
 483 The Order directive controls whether Deny lines are evaluated before or after Allow lines.
 484 <dt><b>Encryption IfRequested</b>
 485 <dd style="margin-left: 5.0em"><dt><b>Encryption Never</b>
 486 <dd style="margin-left: 5.0em"><dt><b>Encryption Required</b>
 487 <dd style="margin-left: 5.0em">Specifies the level of encryption that is required for a particular location.
 488 The default value is "IfRequested".
 489 <dt><b>Order allow,deny</b>
 490 <dd style="margin-left: 5.0em">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.
 491 <dt><b>Order deny,allow</b>
 492 <dd style="margin-left: 5.0em">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.
 493 <dt><b>Require group </b><i>group-name </i>[ <i>group-name </i>... ]
 494 <dd style="margin-left: 5.0em">Specifies that an authenticated user must be a member of one of the named groups.
 495 <dt><b>Require user {</b><i>user-name</i>|<b>@</b><i>group-name</i>} ...
 496 <dd style="margin-left: 5.0em">Specifies that an authenticated user must match one of the named users or be a member of one of the named groups.
 497 The group name "@SYSTEM" corresponds to the list of groups defined by the SystemGroup directive in the
 498 <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
 499 file.
 500 The group name "@OWNER" corresponds to the owner of the resource, for example the person that submitted a print job.
 501 <dt><b>Require valid-user</b>
 502 <dd style="margin-left: 5.0em">Specifies that any authenticated user is acceptable.
 503 <dt><b>Satisfy all</b>
 504 <dd style="margin-left: 5.0em">Specifies that all Allow, AuthType, Deny, Order, and Require conditions must be satisfied to allow access.
 505 <dt><b>Satisfy any</b>
 506 <dd style="margin-left: 5.0em">Specifies that any a client may access a resource if either the authentication (AuthType/Require) or address (Allow/Deny/Order) conditions are satisfied.
 507 For example, this can be used to require authentication only for remote accesses.
 508 </dl>
 509 <h3><a name="DIRECTIVES_VALID_WITHIN_POLICY_SECTIONS">Directives Valid Within Policy Sections</a></h3>
 510 The following directives may be placed inside Policy sections in the <b>cupsd.conf</b> file:
 511 <dl class="man">
 512 <dt><b>JobPrivateAccess all</b>
 513 <dd style="margin-left: 5.0em"><dt><b>JobPrivateAccess default</b>
 514 <dd style="margin-left: 5.0em"><dt><b>JobPrivateAccess </b>{<i>user</i>|<b>@</b><i>group</i>|<b>@ACL</b>|<b>@OWNER</b>|<b>@SYSTEM</b>} ...
 515 <dd style="margin-left: 5.0em">Specifies an access list for a job's private values.
 516 The "default" access list is "@OWNER @SYSTEM".
 517 "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
 518 "@OWNER" maps to the job's owner.
 519 "@SYSTEM" maps to the groups listed for the SystemGroup directive in the
 520 <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
 521 file.
 522 <dt><b>JobPrivateValues all</b>
 523 <dd style="margin-left: 5.0em"><dt><b>JobPrivateValues default</b>
 524 <dd style="margin-left: 5.0em"><dt><b>JobPrivateValues none</b>
 525 <dd style="margin-left: 5.0em"><dt><b>JobPrivateValues </b><i>attribute-name </i>[ ... <i>attribute-name </i>]
 526 <dd style="margin-left: 5.0em">Specifies the list of job values to make private.
 527 The "default" values are "job-name", "job-originating-host-name", "job-originating-user-name", and "phone".
 528 <dt><b>SubscriptionPrivateAccess all</b>
 529 <dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateAccess default</b>
 530 <dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateAccess </b>{<i>user</i>|<b>@</b><i>group</i>|<b>@ACL</b>|<b>@OWNER</b>|<b>@SYSTEM</b>} ...
 531 <dd style="margin-left: 5.0em">Specifies an access list for a subscription's private values.
 532 The "default" access list is "@OWNER @SYSTEM".
 533 "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
 534 "@OWNER" maps to the job's owner.
 535 "@SYSTEM" maps to the groups listed for the SystemGroup directive in the
 536 <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
 537 file.
 538 <dt><b>SubscriptionPrivateValues all</b>
 539 <dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateValues default</b>
 540 <dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateValues none</b>
 541 <dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateValues </b><i>attribute-name </i>[ ... <i>attribute-name </i>]
 542 <dd style="margin-left: 5.0em">Specifies the list of subscription values to make private.
 543 The "default" values are "notify-events", "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and "notify-user-data".
 544 </dl>
 545 <h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
 546 The <b>cupsd.conf</b> file format is based on the Apache HTTP Server configuration file format.
 547 <h2 class="title"><a name="EXAMPLES">Examples</a></h2>
 548 Log everything with a maximum log file size of 32 megabytes:
 549 <pre class="man">
 550
 551     AccessLogLevel all
 552     LogLevel debug2
 553     MaxLogSize 32m
 554
 555 </pre>
 556 Require authentication for accesses from outside the 10. network:
 557 <pre class="man">
 558
 559     &lt;Location />
 560     Order allow,deny
 561     Allow from 10./8
 562     AuthType Basic
 563     Require valid-user
 564     Satisfy any
 565     &lt;/Location>
 566 </pre>
 567 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
 568 <a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a>
 569 <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a>
 570 <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
 571 <a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
 572 <a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
 573 <a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a>
 574 <a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
 575 CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
 576 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 577 Copyright &copy; 2007-2014 by Apple Inc.
 578
 579 </body>
 580 </html>