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