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