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