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 <i>cupsd.conf</i> file configures the CUPS scheduler, <i>cupsd(8)</i>.  It
  14 is normally located in the <i>/etc/cups</i> directory. <b>Note:</b>
  15 File, directory, and user configuration directives that used to be allowed in
  16 the <i>cupsd.conf</i> file are now stored in the <i>cups-files.conf(5)</i> instead
  17 in order to prevent certain types of privilege escalation attacks.
  18 <p>Each line in the file can be a configuration directive, a blank line,
  19 or a comment. Comment lines start with the # character. The
  20 configuration directives are intentionally similar to those used by the
  21 popular Apache web server software and are described below.
  22 <h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
  23 The following directives are understood by <i>cupsd(8)</i>. Consult the
  24 on-line help for detailed descriptions:
  25 <dl class="man">
  26 <dt>AccessLogLevel config
  27 <dd style="margin-left: 5.0em"><dt>AccessLogLevel actions
  28 <dd style="margin-left: 5.0em"><dt>AccessLogLevel all
  29 <dd style="margin-left: 5.0em"><br>
  30 Specifies the logging level for the AccessLog file.
  31 <dt>Allow all
  32 <dd style="margin-left: 5.0em"><dt>Allow none
  33 <dd style="margin-left: 5.0em"><dt>Allow host.domain.com
  34 <dd style="margin-left: 5.0em"><dt>Allow *.domain.com
  35 <dd style="margin-left: 5.0em"><dt>Allow ip-address
  36 <dd style="margin-left: 5.0em"><dt>Allow ip-address/netmask
  37 <dd style="margin-left: 5.0em"><dt>Allow ip-address/mm
  38 <dd style="margin-left: 5.0em"><dt>Allow @IF(name)
  39 <dd style="margin-left: 5.0em"><dt>Allow @LOCAL
  40 <dd style="margin-left: 5.0em"><br>
  41 Allows access from the named hosts or addresses.
  42 <dt>AuthType None
  43 <dd style="margin-left: 5.0em"><dt>AuthType Basic
  44 <dd style="margin-left: 5.0em"><dt>AuthType BasicDigest
  45 <dd style="margin-left: 5.0em"><dt>AuthType Digest
  46 <dd style="margin-left: 5.0em"><dt>AuthType Negotiate
  47 <dd style="margin-left: 5.0em"><br>
  48 Specifies the authentication type (None, Basic, BasicDigest, Digest, Negotiate)
  49 <dt>AutoPurgeJobs Yes
  50 <dd style="margin-left: 5.0em"><dt>AutoPurgeJobs No
  51 <dd style="margin-left: 5.0em"><br>
  52 Specifies whether to purge job history data automatically when
  53 it is no longer required for quotas.
  54 <dt>BrowseLocalProtocols [All] [DNSSD]
  55 <dd style="margin-left: 5.0em"><br>
  56 Specifies the protocols to use for local printer sharing.
  57 <dt>BrowseWebIF Yes
  58 <dd style="margin-left: 5.0em"><dt>BrowseWebIF No
  59 <dd style="margin-left: 5.0em"><br>
  60 Specifies whether the CUPS web interface is advertised via DNS-SD.
  61 <dt>Browsing Yes
  62 <dd style="margin-left: 5.0em"><dt>Browsing No
  63 <dd style="margin-left: 5.0em"><br>
  64 Specifies whether or not shared printers should be advertised.
  65 <dt>Classification banner
  66 <dd style="margin-left: 5.0em"><br>
  67 Specifies the security classification of the server.
  68 <dt>ClassifyOverride Yes
  69 <dd style="margin-left: 5.0em"><dt>ClassifyOverride No
  70 <dd style="margin-left: 5.0em"><br>
  71 Specifies whether to allow users to override the classification
  72 of individual print jobs.
  73 <dt>DefaultAuthType Basic
  74 <dd style="margin-left: 5.0em"><dt>DefaultAuthType BasicDigest
  75 <dd style="margin-left: 5.0em"><dt>DefaultAuthType Digest
  76 <dd style="margin-left: 5.0em"><dt>DefaultAuthType Negotiate
  77 <dd style="margin-left: 5.0em"><br>
  78 Specifies the default type of authentication to use.
  79 <dt>DefaultEncryption Never
  80 <dd style="margin-left: 5.0em"><dt>DefaultEncryption IfRequested
  81 <dd style="margin-left: 5.0em"><dt>DefaultEncryption Required
  82 <dd style="margin-left: 5.0em"><br>
  83 Specifies the type of encryption to use for authenticated requests.
  84 <dt>DefaultLanguage locale
  85 <dd style="margin-left: 5.0em"><br>
  86 Specifies the default language to use for text and web content.
  87 <dt>DefaultPaperSize Auto
  88 <dd style="margin-left: 5.0em"><dt>DefaultPaperSize None
  89 <dd style="margin-left: 5.0em"><dt>DefaultPaperSize sizename
  90 <dd style="margin-left: 5.0em"><br>
  91 Specifies the default paper size for new print queues. "Auto" uses a locale-
  92 specific default, while "None" specifies there is no default paper size.
  93 <dt>DefaultPolicy policy-name
  94 <dd style="margin-left: 5.0em"><br>
  95 Specifies the default access policy to use.
  96 <dt>DefaultShared Yes
  97 <dd style="margin-left: 5.0em"><dt>DefaultShared No
  98 <dd style="margin-left: 5.0em"><br>
  99 Specifies whether local printers are shared by default.
 100 <dt>Deny all
 101 <dd style="margin-left: 5.0em"><dt>Deny none
 102 <dd style="margin-left: 5.0em"><dt>Deny host.domain.com
 103 <dd style="margin-left: 5.0em"><dt>Deny *.domain.com
 104 <dd style="margin-left: 5.0em"><dt>Deny ip-address
 105 <dd style="margin-left: 5.0em"><dt>Deny ip-address/netmask
 106 <dd style="margin-left: 5.0em"><dt>Deny ip-address/mm
 107 <dd style="margin-left: 5.0em"><dt>Deny @IF(name)
 108 <dd style="margin-left: 5.0em"><dt>Deny @LOCAL
 109 <dd style="margin-left: 5.0em"><br>
 110 Denies access to the named host or address.
 111 <dt>DirtyCleanInterval seconds
 112 <dd style="margin-left: 5.0em"><br>
 113 Specifies the delay for updating of configuration and state files. A value of 0
 114 causes the update to happen as soon as possible, typically within a few
 115 milliseconds.
 116 <dt>Encryption IfRequested
 117 <dd style="margin-left: 5.0em"><dt>Encryption Never
 118 <dd style="margin-left: 5.0em"><dt>Encryption Required
 119 <dd style="margin-left: 5.0em"><br>
 120 Specifies the level of encryption that is required for a particular
 121 location.
 122 <dt>FilterLimit limit
 123 <dd style="margin-left: 5.0em"><br>
 124 Specifies the maximum cost of filters that are run concurrently.
 125 <dt>FilterNice nice-value
 126 <dd style="margin-left: 5.0em"><br>
 127 Specifies the scheduling priority ("nice" value) of filters that
 128 are run to print a job.
 129 <dt>GSSServiceName name
 130 <dd style="margin-left: 5.0em"><br>
 131 Specifies the service name when using Kerberos authentication. The default
 132 service name is "http".
 133 <dt>HostNameLookups On
 134 <dd style="margin-left: 5.0em"><dt>HostNameLookups Off
 135 <dd style="margin-left: 5.0em"><dt>HostNameLookups Double
 136 <dd style="margin-left: 5.0em"><br>
 137 Specifies whether or not to do reverse lookups on client addresses.
 138 <dt>Include filename
 139 <dd style="margin-left: 5.0em"><br>
 140 Includes the named file.
 141 <dt>JobKillDelay seconds
 142 <dd style="margin-left: 5.0em"><br>
 143 Specifies the number of seconds to wait before killing the filters and backend
 144 associated with a canceled or held job.
 145 <dt>JobPrivateAccess all
 146 <dd style="margin-left: 5.0em"><dt>JobPrivateAccess default
 147 <dd style="margin-left: 5.0em"><dt>JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
 148 <dd style="margin-left: 5.0em"><br>
 149 Specifies an access list for a job's private values. The "default" access list
 150 is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed
 151 or requesting-user-name-denied values.
 152 <dt>JobPrivateValues all
 153 <dd style="margin-left: 5.0em"><dt>JobPrivateValues default
 154 <dd style="margin-left: 5.0em"><dt>JobPrivateValues none
 155 <dd style="margin-left: 5.0em"><dt>JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
 156 <dd style="margin-left: 5.0em">Specifies the list of job values to make private. The "default" values are
 157 "job-name", "job-originating-host-name", and "job-originating-user-name".
 158 <dt>JobRetryInterval seconds
 159 <dd style="margin-left: 5.0em"><br>
 160 Specifies the interval between retries of jobs in seconds.
 161 <dt>JobRetryLimit count
 162 <dd style="margin-left: 5.0em"><br>
 163 Specifies the number of retries that are done for jobs.
 164 <dt>KeepAlive Yes
 165 <dd style="margin-left: 5.0em"><dt>KeepAlive No
 166 <dd style="margin-left: 5.0em"><br>
 167 Specifies whether to support HTTP keep-alive connections.
 168 <dt>KeepAliveTimeout seconds
 169 <dd style="margin-left: 5.0em"><br>
 170 Specifies the amount of time that connections are kept alive.
 171 <dt>&lt;Limit operations> ... &lt;/Limit>
 172 <dd style="margin-left: 5.0em"><br>
 173 Specifies the IPP operations that are being limited inside a policy.
 174 <dt>&lt;Limit methods> ... &lt;/Limit>
 175 <dd style="margin-left: 5.0em"><dt>&lt;LimitExcept methods> ... &lt;/LimitExcept>
 176 <dd style="margin-left: 5.0em"><br>
 177 Specifies the HTTP methods that are being limited inside a location.
 178 <dt>LimitRequestBody
 179 <dd style="margin-left: 5.0em"><br>
 180 Specifies the maximum size of any print job request.
 181 <dt>Listen ip-address:port
 182 <dd style="margin-left: 5.0em"><dt>Listen *:port
 183 <dd style="margin-left: 5.0em"><dt>Listen /path/to/domain/socket
 184 <dd style="margin-left: 5.0em"><br>
 185 Listens to the specified address and port or domain socket path.
 186 <dt>&lt;Location /path> ... &lt;/Location>
 187 <dd style="margin-left: 5.0em"><br>
 188 Specifies access control for the named location.
 189 <dt>LogDebugHistory #-messages
 190 <dd style="margin-left: 5.0em"><br>
 191 Specifies the number of debugging messages that are logged when an error
 192 occurs in a print job.
 193 <dt>LogLevel alert
 194 <dd style="margin-left: 5.0em"><dt>LogLevel crit
 195 <dd style="margin-left: 5.0em"><dt>LogLevel debug2
 196 <dd style="margin-left: 5.0em"><dt>LogLevel debug
 197 <dd style="margin-left: 5.0em"><dt>LogLevel emerg
 198 <dd style="margin-left: 5.0em"><dt>LogLevel error
 199 <dd style="margin-left: 5.0em"><dt>LogLevel info
 200 <dd style="margin-left: 5.0em"><dt>LogLevel none
 201 <dd style="margin-left: 5.0em"><dt>LogLevel notice
 202 <dd style="margin-left: 5.0em"><dt>LogLevel warn
 203 <dd style="margin-left: 5.0em"><br>
 204 Specifies the logging level for the ErrorLog file.
 205 <dt>LogTimeFormat standard
 206 <dd style="margin-left: 5.0em"><dt>LogTimeFormat usecs
 207 <dd style="margin-left: 5.0em"><br>
 208 Specifies the format of the date and time in the log files.
 209 <dt>MaxClients number
 210 <dd style="margin-left: 5.0em"><br>
 211 Specifies the maximum number of simultaneous clients to support.
 212 <dt>MaxClientsPerHost number
 213 <dd style="margin-left: 5.0em"><br>
 214 Specifies the maximum number of simultaneous clients to support from a
 215 single address.
 216 <dt>MaxCopies number
 217 <dd style="margin-left: 5.0em"><br>
 218 Specifies the maximum number of copies that a user can print of each job.
 219 <dt>MaxHoldTime seconds
 220 <dd style="margin-left: 5.0em"><br>
 221 Specifies the maximum time a job may remain in the "indefinite" hold state
 222 before it is canceled. Set to 0 to disable cancellation of held jobs.
 223 <dt>MaxJobs number
 224 <dd style="margin-left: 5.0em"><br>
 225 Specifies the maximum number of simultaneous jobs to support.
 226 <dt>MaxJobsPerPrinter number
 227 <dd style="margin-left: 5.0em"><br>
 228 Specifies the maximum number of simultaneous jobs per printer to support.
 229 <dt>MaxJobsPerUser number
 230 <dd style="margin-left: 5.0em"><br>
 231 Specifies the maximum number of simultaneous jobs per user to support.
 232 <dt>MaxJobTime seconds
 233 <dd style="margin-left: 5.0em"><br>
 234 Specifies the maximum time a job may take to print before it is canceled. The
 235 default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck"
 236 jobs.
 237 <dt>MaxLogSize number-bytes
 238 <dd style="margin-left: 5.0em"><br>
 239 Specifies the maximum size of the log files before they are
 240 rotated (0 to disable rotation)
 241 <dt>MaxRequestSize number-bytes
 242 <dd style="margin-left: 5.0em"><br>
 243 Specifies the maximum request/file size in bytes (0 for no limit)
 244 <dt>MultipleOperationTimeout seconds
 245 <dd style="margin-left: 5.0em"><br>
 246 Specifies the maximum amount of time to allow between files in a multiple file
 247 print job.
 248 <dt>Order allow,deny
 249 <dd style="margin-left: 5.0em"><dt>Order deny,allow
 250 <dd style="margin-left: 5.0em"><br>
 251 Specifies the order of HTTP access control (allow,deny or deny,allow)
 252 <dt>PageLogFormat format string
 253 <dd style="margin-left: 5.0em"><br>
 254 Specifies the format of page log lines.
 255 <dt>PassEnv variable [... variable]
 256 <dd style="margin-left: 5.0em"><br>
 257 Passes the specified environment variable(s) to child processes.
 258 <dt>&lt;Policy name> ... &lt;/Policy>
 259 <dd style="margin-left: 5.0em"><br>
 260 Specifies access control for the named policy.
 261 <dt>Port number
 262 <dd style="margin-left: 5.0em"><br>
 263 Specifies a port number to listen to for HTTP requests.
 264 <dt>PreserveJobFiles Yes
 265 <dd style="margin-left: 5.0em"><dt>PreserveJobFiles No
 266 <dd style="margin-left: 5.0em"><br>
 267 Specifies whether or not to preserve job files after they are printed.
 268 <dt>PreserveJobHistory Yes
 269 <dd style="margin-left: 5.0em"><dt>PreserveJobHistory No
 270 <dd style="margin-left: 5.0em"><br>
 271 Specifies whether or not to preserve the job history after they are
 272 printed.
 273 <dt>PrintcapFormat bsd
 274 <dd style="margin-left: 5.0em"><dt>PrintcapFormat plist
 275 <dd style="margin-left: 5.0em"><dt>PrintcapFormat solaris
 276 <dd style="margin-left: 5.0em"><br>
 277 Specifies the format of the printcap file.
 278 <dt>ReloadTimeout seconds
 279 <dd style="margin-left: 5.0em"><br>
 280 Specifies the amount of time to wait for job completion before
 281 restarting the scheduler.
 282 <dt>Require group group-name-list
 283 <dd style="margin-left: 5.0em"><dt>Require user user-name-list
 284 <dd style="margin-left: 5.0em"><dt>Require valid-user
 285 <dd style="margin-left: 5.0em"><br>
 286 Specifies that user or group authentication is required.
 287 <dt>RIPCache bytes
 288 <dd style="margin-left: 5.0em"><br>
 289 Specifies the maximum amount of memory to use when converting images
 290 and PostScript files to bitmaps for a printer.
 291 <dt>Satisfy all
 292 <dd style="margin-left: 5.0em"><dt>Satisfy any
 293 <dd style="margin-left: 5.0em"><br>
 294 Specifies whether all or any limits set for a Location must be
 295 satisfied to allow access.
 296 <dt>ServerAdmin user@domain.com
 297 <dd style="margin-left: 5.0em"><br>
 298 Specifies the email address of the server administrator.
 299 <dt>ServerAlias hostname [... hostname]
 300 <dd style="margin-left: 5.0em"><dt>ServerAlias *
 301 <dd style="margin-left: 5.0em"><br>
 302 Specifies an alternate name that the server is known by. The special name "*"
 303 allows any name to be used.
 304 <dt>ServerName hostname-or-ip-address
 305 <dd style="margin-left: 5.0em"><br>
 306 Specifies the fully-qualified hostname of the server.
 307 <dt>ServerTokens Full
 308 <dd style="margin-left: 5.0em"><dt>ServerTokens Major
 309 <dd style="margin-left: 5.0em"><dt>ServerTokens Minimal
 310 <dd style="margin-left: 5.0em"><dt>ServerTokens Minor
 311 <dd style="margin-left: 5.0em"><dt>ServerTokens None
 312 <dd style="margin-left: 5.0em"><dt>ServerTokens OS
 313 <dd style="margin-left: 5.0em"><dt>ServerTokens ProductOnly
 314 <dd style="margin-left: 5.0em"><br>
 315 Specifies what information is included in the Server header of HTTP
 316 responses.
 317 <dt>SetEnv variable value
 318 <dd style="margin-left: 5.0em"><br>
 319 Set the specified environment variable to be passed to child processes.
 320 <dt>SSLListen
 321 <dd style="margin-left: 5.0em"><br>
 322 Listens on the specified address and port for encrypted connections.
 323 <dt>SSLPort
 324 <dd style="margin-left: 5.0em"><br>
 325 Listens on the specified port for encrypted connections.
 326 <dt>StrictConformance Yes
 327 <dd style="margin-left: 5.0em"><dt>StrictConformance No
 328 <dd style="margin-left: 5.0em"><br>
 329 Specifies whether the scheduler requires clients to strictly adhere to the IPP
 330 specifications. The default is No.
 331 <dt>SubscriptionPrivateAccess all
 332 <dd style="margin-left: 5.0em"><dt>SubscriptionPrivateAccess default
 333 <dd style="margin-left: 5.0em"><dt>SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
 334 <dd style="margin-left: 5.0em"><br>
 335 Specifies an access list for a subscription's private values. The "default"
 336 access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
 337 requesting-user-name-allowed or requesting-user-name-denied values.
 338 <dt>SubscriptionPrivateValues all
 339 <dd style="margin-left: 5.0em"><dt>SubscriptionPrivateValues default
 340 <dd style="margin-left: 5.0em"><dt>SubscriptionPrivateValues none
 341 <dd style="margin-left: 5.0em"><dt>SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
 342 <dd style="margin-left: 5.0em">Specifies the list of job values to make private. The "default" values are
 343 "notify-events", "notify-pull-method", "notify-recipient-uri",
 344 "notify-subscriber-user-name", and "notify-user-data".
 345 <dt>Timeout seconds
 346 <dd style="margin-left: 5.0em"><br>
 347 Specifies the HTTP request timeout in seconds.
 348 <dt>WebInterface yes
 349 <dd style="margin-left: 5.0em"><dt>WebInterface no
 350 <dd style="margin-left: 5.0em">Specifies whether the web interface is enabled.
 351 </dl>
 352 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
 353 <i>classes.conf(5)</i>, <i>cups-files.conf(5)</i>, <i>cupsd(8)</i>,
 354 <i>mime.convs(5)</i>, <i>mime.types(5)</i>, <i>printers.conf(5)</i>,
 355 <i>subscriptions.conf(5)</i>,
 356 <br>
 357 <a href="http://localhost:631/help">http://localhost:631/help</a>
 358 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 359 Copyright 2007-2013 by Apple Inc.
 360
 361 </body>
 362 </html>