man/cupsd.conf.man

   1 .\"
   2 .\" "$Id$"
   3 .\"
   4 .\"   cupsd.conf man page for the Common UNIX Printing System (CUPS).
   5 .\"
   6 .\"   Copyright 1997-2005 by Easy Software Products.
   7 .\"
   8 .\"   These coded instructions, statements, and computer programs are the
   9 .\"   property of Easy Software Products and are protected by Federal
  10 .\"   copyright law.  Distribution and use rights are outlined in the file
  11 .\"   "LICENSE.txt" which should have been included with this file.  If this
  12 .\"   file is missing or damaged please contact Easy Software Products
  13 .\"   at:
  14 .\"
  15 .\"       Attn: CUPS Licensing Information
  16 .\"       Easy Software Products
  17 .\"       44141 Airport View Drive, Suite 204
  18 .\"       Hollywood, Maryland 20636 USA
  19 .\"
  20 .\"       Voice: (301) 373-9600
  21 .\"       EMail: cups-info@cups.org
  22 .\"         WWW: http://www.cups.org
  23 .\"
  24 .TH cupsd.conf 5 "Common UNIX Printing System" "30 September 2005" "Easy Software Products"
  25 .SH NAME
  26 cupsd.conf \- server configuration file for cups
  27 .SH DESCRIPTION
  28 The \fIcupsd.conf\fR file configures the CUPS scheduler, \fIcupsd(8)\fR.  It
  29 is normally located in the \fI/etc/cups\fR directory.
  30 .LP
  31 Each line in the file can be a configuration directive, a blank line,
  32 or a comment. Comment lines start with the # character. The
  33 configuration directives are intentionally similar to those used by the
  34 popular Apache web server software and are described below.
  35 .SH DIRECTIVES
  36 The following directives are understood by \fIcupsd\fR. Consult the CUPS
  37 Software Administrators Manual for a detailed description:
  38 .TP 5
  39 AccessLog
  40 .br
  41 Defines the access log filename.
  42 .TP 5
  43 Allow
  44 .br
  45 Allows access from the named hosts or addresses.
  46 .TP 5
  47 AuthClass
  48 .br
  49 Specifies the authentication class (User, Group, System)
  50 .TP 5
  51 AuthGroupName
  52 .br
  53 Specifies the authentication group.
  54 .TP 5
  55 AuthType
  56 .br
  57 Specifies the authentication type (None, Basic, Digest)
  58 .TP 5
  59 AutoPurgeJobs
  60 .br
  61 Specifies whether to purge job history data automatically when
  62 it is no longer required for quotas.
  63 .TP 5
  64 BrowseAddress
  65 .br
  66 Specifies a broadcast address for outgoing printer information packets.
  67 .TP 5
  68 BrowseAllow
  69 .br
  70 Allows incoming printer information packets from the named host or address.
  71 .TP 5
  72 BrowseDeny
  73 .br
  74 Denies incoming printer information packets from the named host or address.
  75 .TP 5
  76 BrowseInterval
  77 .br
  78 Specifies the maximum interval between printer information broadcasts.
  79 .TP 5
  80 BrowseOrder
  81 .br
  82 Specifies the order of printer information access control (allow,deny or deny,allow)
  83 .TP 5
  84 BrowsePoll
  85 .br
  86 Specifies a server to poll for printer information.
  87 .TP 5
  88 BrowsePort
  89 .br
  90 Specifies the port to listen to for printer information packets.
  91 .TP 5
  92 BrowseProtocols
  93 .br
  94 Specifies the protocols to use for printer browsing.
  95 .TP 5
  96 BrowseLocalProtocols
  97 .br
  98 Specifies the protocols to use for local printer browsing.
  99 .TP 5
 100 BrowseRemoteProtocols
 101 .br
 102 Specifies the protocols to use for remote printer browsing.
 103 .TP 5
 104 BrowseRelay
 105 .br
 106 Specifies that printer information packets should be relayed from one host or
 107 network to another.
 108 .TP 5
 109 BrowseShortNames
 110 .br
 111 Specifies whether remote printers will use short names ("printer") or not
 112 ("printer@server"). This option is ignored if more than one remote printer
 113 exists with the same name.
 114 .TP 5
 115 BrowseTimeout
 116 .br
 117 Specifies the maximum interval between printer information updates before
 118 remote printers will be removed from the list of available printers.
 119 .TP 5
 120 Browsing
 121 .br
 122 Specifies whether or not remote printer browsing should be enabled.
 123 .TP 5
 124 Classification
 125 .br
 126 Specifies the security classification of the server.
 127 .TP 5
 128 ClassifyOverride
 129 .br
 130 Specifies whether to allow users to override the classification
 131 of individual print jobs.
 132 .TP 5
 133 ConfigFilePerm
 134 .br
 135 Specifies the permissions for all configuration files that the scheduler
 136 writes.
 137 .TP 5
 138 DataDir
 139 .br
 140 Specified the directory where data files can be found.
 141 .TP 5
 142 DefaultAuthType
 143 .br
 144 Specifies the default type of authentication to use.
 145 .TP 5
 146 DefaultCharset
 147 .br
 148 Specifies the default character set to use for text.
 149 .TP 5
 150 DefaultLanguage
 151 .br
 152 Specifies the default language to use for text and web content.
 153 .TP 5
 154 DefaultPolicy
 155 .br
 156 Specifies the default access policy to use.
 157 .TP 5
 158 Deny
 159 .br
 160 Denies access to the named host or address.
 161 .TP 5
 162 DocumentRoot
 163 .br
 164 Specifies the root directory for the internal web server documents.
 165 .TP 5
 166 Encryption
 167 .br
 168 Specifies the level of encryption that is required for a particular
 169 location.
 170 .TP 5
 171 ErrorLog
 172 .br
 173 Specifies the error log filename.
 174 .TP 5
 175 FaxRetryInterval
 176 .br
 177 Specifies the interval between retries of fax jobs in seconds.
 178 .TP 5
 179 FaxRetryLimit
 180 .br
 181 Specifies the number of retries that are done for fax jobs.
 182 .TP 5
 183 FileDevice
 184 .br
 185 Specifies whether the file pseudo-device can be used for new
 186 printer queues.
 187 .TP 5
 188 FilterLimit
 189 .br
 190 Specifies the maximum cost of filters that are run concurrently.
 191 .TP 5
 192 FilterNice
 193 .br
 194 Specifies the scheduling priority ("nice" value) of filters that
 195 are run to print a job.
 196 .TP 5
 197 FontPath
 198 .br
 199 Specifies the search path for fonts.
 200 .TP 5
 201 Group
 202 .br
 203 Specifies the group name or ID that will be used when executing
 204 external programs.
 205 .TP 5
 206 HideImplicitMembers
 207 .br
 208 Specifies whether to hide members of implicit classes.
 209 .TP 5
 210 HostNameLookups
 211 .br
 212 Specifies whether or not to do reverse lookups on client addresses.
 213 .TP 5
 214 ImplicitAnyClasses
 215 .br
 216 Specifies whether or not to create implicit classes for local and
 217 remote printers, e.g. "AnyPrinter" from "Printer", "Printer@server1",
 218 and "Printer@server2".
 219 .TP 5
 220 ImplicitClasses
 221 .br
 222 Specifies whether or not to create implicit classes from identical
 223 remote printers.
 224 .TP 5
 225 Include
 226 .br
 227 Includes the named file.
 228 .TP 5
 229 KeepAlive
 230 .br
 231 Specifies whether or not to support HTTP Keep-Alive.
 232 .TP 5
 233 KeepAliveTimeout
 234 .br
 235 Specifies the connection timeout for HTTP Keep-Alive.
 236 .TP 5
 237 <Limit operations> ... </Limit>
 238 .br
 239 Specifies the IPP operations that are being limited inside a policy.
 240 .TP 5
 241 <Limit methods> ... </Limit>
 242 .TP 5
 243 <LimitExcept methods> ... </LimitExcept>
 244 .br
 245 Specifies the HTTP methods that are being limited inside a location.
 246 .TP 5
 247 LimitRequestBody
 248 .br
 249 Specifies the maximum size of any print job request.
 250 .TP 5
 251 Listen
 252 .br
 253 Listens to the specified address and port.
 254 .TP 5
 255 <Location /path> ... </Location>
 256 .br
 257 Specifies access control for the named location.
 258 .TP 5
 259 LogFilePerm
 260 .br
 261 Specifies the permissions for all log files that the scheduler writes.
 262 .TP 5
 263 LogLevel
 264 .br
 265 Specifies the logging level (none, warn, error, info, debug, or debug2)
 266 .TP 5
 267 MaxClients
 268 .br
 269 Specifies the maximum number of simultaneous clients to support.
 270 .TP 5
 271 MaxClientsPerHost
 272 .br
 273 Specifies the maximum number of simultaneous clients to support from a
 274 single address.
 275 .TP 5
 276 MaxCopies
 277 .br
 278 Specifies the maximum number of copies that a user can print of each job.
 279 .TP 5
 280 MaxJobs
 281 .br
 282 Specifies the maximum number of simultaneous jobs to support.
 283 .TP 5
 284 MaxJobsPerPrinter
 285 .br
 286 Specifies the maximum number of simultaneous jobs per printer to support.
 287 .TP 5
 288 MaxJobsPerUser
 289 .br
 290 Specifies the maximum number of simultaneous jobs per user to support.
 291 .TP 5
 292 MaxLogSize
 293 .br
 294 Specifies the maximum size of the log files before they are
 295 rotated (0 to disable rotation)
 296 .TP 5
 297 MaxRequestSize
 298 .br
 299 Specifies the maximum request/file size in bytes (0 for no limit)
 300 .TP 5
 301 Order
 302 .br
 303 Specifies the order of HTTP access control (allow,deny or deny,allow)
 304 .TP 5
 305 PageLog
 306 .br
 307 Specifies the page log filename.
 308 .TP 5
 309 PassEnv variable [... variable]
 310 .br
 311 Passes the specified environment variable(s) to child processes.
 312 .TP 5
 313 <Policy name> ... </Policy>
 314 .br
 315 Specifies access control for the named policy.
 316 .TP 5
 317 Port
 318 .br
 319 Specifies a port number to listen to for HTTP requests.
 320 .TP 5
 321 PreserveJobFiles
 322 .br
 323 Specifies whether or not to preserve job files after they are printed.
 324 .TP 5
 325 PreserveJobHistory
 326 .br
 327 Specifies whether or not to preserve the job history after they are
 328 printed.
 329 .TP 5
 330 Printcap
 331 .br
 332 Specifies the filename for a printcap file that is updated automatically
 333 with a list of available printers (needed for legacy applications)
 334 .TP 5
 335 PrintcapFormat
 336 .br
 337 Specifies the format of the printcap file.
 338 .TP 5
 339 PrintcapGUI
 340 .br
 341 Specifies whether to generate option panel definition files on some
 342 operating systems.
 343 .TP 5
 344 ReloadTimeout
 345 .br
 346 Specifies the amount of time to wait for job completion before
 347 restarting the scheduler.
 348 .TP 5
 349 RemoteRoot
 350 .br
 351 Specifies the username that is associated with unauthenticated root
 352 accesses.
 353 .TP 5
 354 RequestRoot
 355 .br
 356 Specifies the directory to store print jobs and other HTTP request
 357 data.
 358 .TP 5
 359 Require
 360 .br
 361 Specifies that user or group authentication is required.
 362 .TP 5
 363 RIPCache
 364 .br
 365 Specifies the maximum amount of memory to use when converting images
 366 and PostScript files to bitmaps for a printer.
 367 .TP 5
 368 RunAsUser
 369 .br
 370 Specifies that the scheduler should run as the unpriviledged user
 371 set with the User directive.
 372 .TP 5
 373 Satisfy
 374 .br
 375 Specifies whether all or any limits set for a Location must be
 376 satisfied to allow access.
 377 .TP 5
 378 ServerAdmin
 379 .br
 380 Specifies the email address of the server administrator.
 381 .TP 5
 382 ServerBin
 383 .br
 384 Specifies the directory where backends, CGIs, daemons, and filters may
 385 be found.
 386 .TP 5
 387 ServerCertificate
 388 .br
 389 Specifies the encryption certificate to use.
 390 .TP 5
 391 ServerKey
 392 .br
 393 Specifies the encryption key to use.
 394 .TP 5
 395 ServerName
 396 .br
 397 Specifies the fully-qualified hostname of the server.
 398 .TP 5
 399 ServerRoot
 400 .br
 401 Specifies the directory where the server configuration files can be found.
 402 .TP 5
 403 ServerTokens
 404 .br
 405 Specifies what information is included in the Server header of HTTP
 406 responses.
 407 .TP 5
 408 SetEnv variable value
 409 .br
 410 Set the specified environment variable to be passed to child processes.
 411 .TP 5
 412 SSLListen
 413 .br
 414 Listens on the specified address and port for encrypted connections.
 415 .TP 5
 416 SSLPort
 417 .br
 418 Listens on the specified port for encrypted connections.
 419 .TP 5
 420 SystemGroup
 421 .br
 422 Specifies the group to use for System class authentication.
 423 .TP 5
 424 TempDir
 425 .br
 426 Specifies the directory where temporary files are stored.
 427 .TP 5
 428 Timeout
 429 .br
 430 Specifies the HTTP request timeout in seconds.
 431 .TP 5
 432 User
 433 .br
 434 Specifies the user name or ID that is used when running external programs.
 435 .SH SEE ALSO
 436 classes.conf(5), cupsd(8), mime.convs(5), mime.types(5), printers.conf(5),
 437 CUPS Software Administrators Manual,
 438 http://localhost:631/documentation.html
 439 .SH COPYRIGHT
 440 Copyright 1993-2005 by Easy Software Products, All Rights Reserved.
 441 .\"
 442 .\" End of "$Id$".
 443 .\"