man/cupsd.conf.man.in

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