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