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" "18 August 2004" "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 BrowseRelay
  97 .br
  98 Specifies that printer information packets should be relayed from one host or
  99 network to another.
 100 .TP 5
 101 BrowseShortNames
 102 .br
 103 Specifies whether remote printers will use short names ("printer") or not
 104 ("printer@server"). This option is ignored if more than one remote printer
 105 exists with the same name.
 106 .TP 5
 107 BrowseTimeout
 108 .br
 109 Specifies the maximum interval between printer information updates before
 110 remote printers will be removed from the list of available printers.
 111 .TP 5
 112 Browsing
 113 .br
 114 Specifies whether or not remote printer browsing should be enabled.
 115 .TP 5
 116 Classification
 117 .br
 118 Specifies the security classification of the server.
 119 .TP 5
 120 ClassifyOverride
 121 .br
 122 Specifies whether to allow users to override the classification
 123 of individual print jobs.
 124 .TP 5
 125 ConfigFilePerm
 126 .br
 127 Specifies the permissions for all configuration files that the scheduler
 128 writes.
 129 .TP 5
 130 DataDir
 131 .br
 132 Specified the directory where data files can be found.
 133 .TP 5
 134 DefaultCharset
 135 .br
 136 Specifies the default character set to use for text.
 137 .TP 5
 138 DefaultLanguage
 139 .br
 140 Specifies the default language to use for text and web content.
 141 .TP 5
 142 Deny
 143 .br
 144 Denies access to the named host or address.
 145 .TP 5
 146 DocumentRoot
 147 .br
 148 Specifies the root directory for the internal web server documents.
 149 .TP 5
 150 Encryption
 151 .br
 152 Specifies the level of encryption that is required for a particular
 153 location.
 154 .TP 5
 155 ErrorLog
 156 .br
 157 Specifies the error log filename.
 158 .TP 5
 159 FaxRetryInterval
 160 .br
 161 Specifies the interval between retries of fax jobs in seconds.
 162 .TP 5
 163 FaxRetryLimit
 164 .br
 165 Specifies the number of retries that are done for fax jobs.
 166 .TP 5
 167 FileDevice
 168 .br
 169 Specifies whether the file pseudo-device can be used for new
 170 printer queues.
 171 .TP 5
 172 FilterLimit
 173 .br
 174 Specifies the maximum cost of filters that are run concurrently.
 175 .TP 5
 176 FilterNice
 177 .br
 178 Specifies the scheduling priority ("nice" value) of filters that
 179 are run to print a job.
 180 .TP 5
 181 FontPath
 182 .br
 183 Specifies the search path for fonts.
 184 .TP 5
 185 Group
 186 .br
 187 Specifies the group name or ID that will be used when executing
 188 external programs.
 189 .TP 5
 190 HideImplicitMembers
 191 .br
 192 Specifies whether to hide members of implicit classes.
 193 .TP 5
 194 HostNameLookups
 195 .br
 196 Specifies whether or not to do reverse lookups on client addresses.
 197 .TP 5
 198 ImplicitAnyClasses
 199 .br
 200 Specifies whether or not to create implicit classes for local and
 201 remote printers, e.g. "AnyPrinter" from "Printer", "Printer@server1",
 202 and "Printer@server2".
 203 .TP 5
 204 ImplicitClasses
 205 .br
 206 Specifies whether or not to create implicit classes from identical
 207 remote printers.
 208 .TP 5
 209 Include
 210 .br
 211 Includes the named file.
 212 .TP 5
 213 KeepAlive
 214 .br
 215 Specifies whether or not to support HTTP Keep-Alive.
 216 .TP 5
 217 KeepAliveTimeout
 218 .br
 219 Specifies the connection timeout for HTTP Keep-Alive.
 220 .TP 5
 221 <Limit methods> ... </Limit>
 222 .TP 5
 223 <LimitExcept methods> ... </LimitExcept>
 224 .br
 225 Specifies the HTTP methods that are being limited inside a location.
 226 .TP 5
 227 LimitRequestBody
 228 .br
 229 Specifies the maximum size of any print job request.
 230 .TP 5
 231 Listen
 232 .br
 233 Listens to the specified address and port.
 234 .TP 5
 235 <Location /path> ... </Location>
 236 .br
 237 Specifies access control for the named location.
 238 .TP 5
 239 LogFilePerm
 240 .br
 241 Specifies the permissions for all log files that the scheduler writes.
 242 .TP 5
 243 LogLevel
 244 .br
 245 Specifies the logging level (none, warn, error, info, debug, or debug2)
 246 .TP 5
 247 MaxClients
 248 .br
 249 Specifies the maximum number of simultaneous clients to support.
 250 .TP 5
 251 MaxClientsPerHost
 252 .br
 253 Specifies the maximum number of simultaneous clients to support from a
 254 single address.
 255 .TP 5
 256 MaxCopies
 257 .br
 258 Specifies the maximum number of copies that a user can print of each job.
 259 .TP 5
 260 MaxJobs
 261 .br
 262 Specifies the maximum number of simultaneous jobs to support.
 263 .TP 5
 264 MaxJobsPerPrinter
 265 .br
 266 Specifies the maximum number of simultaneous jobs per printer to support.
 267 .TP 5
 268 MaxJobsPerUser
 269 .br
 270 Specifies the maximum number of simultaneous jobs per user to support.
 271 .TP 5
 272 MaxLogSize
 273 .br
 274 Specifies the maximum size of the log files before they are
 275 rotated (0 to disable rotation)
 276 .TP 5
 277 MaxRequestSize
 278 .br
 279 Specifies the maximum request/file size in bytes (0 for no limit)
 280 .TP 5
 281 Order
 282 .br
 283 Specifies the order of HTTP access control (allow,deny or deny,allow)
 284 .TP 5
 285 PageLog
 286 .br
 287 Specifies the page log filename.
 288 .TP 5
 289 Port
 290 .br
 291 Specifies a port number to listen to for HTTP requests.
 292 .TP 5
 293 PreserveJobFiles
 294 .br
 295 Specifies whether or not to preserve job files after they are printed.
 296 .TP 5
 297 PreserveJobHistory
 298 .br
 299 Specifies whether or not to preserve the job history after they are
 300 printed.
 301 .TP 5
 302 Printcap
 303 .br
 304 Specifies the filename for a printcap file that is updated automatically
 305 with a list of available printers (needed for legacy applications)
 306 .TP 5
 307 PrintcapFormat
 308 .br
 309 Specifies the format of the printcap file.
 310 .TP 5
 311 PrintcapGUI
 312 .br
 313 Specifies whether to generate option panel definition files on some
 314 operating systems.
 315 .TP 5
 316 ReloadTimeout
 317 .br
 318 Specifies the amount of time to wait for job completion before
 319 restarting the scheduler.
 320 .TP 5
 321 RemoteRoot
 322 .br
 323 Specifies the username that is associated with unauthenticated root
 324 accesses.
 325 .TP 5
 326 RequestRoot
 327 .br
 328 Specifies the directory to store print jobs and other HTTP request
 329 data.
 330 .TP 5
 331 Require
 332 .br
 333 Specifies that user or group authentication is required.
 334 .TP 5
 335 RIPCache
 336 .br
 337 Specifies the maximum amount of memory to use when converting images
 338 and PostScript files to bitmaps for a printer.
 339 .TP 5
 340 RunAsUser
 341 .br
 342 Specifies that the scheduler should run as the unpriviledged user
 343 set with the User directive.
 344 .TP 5
 345 Satisfy
 346 .br
 347 Specifies whether all or any limits set for a Location must be
 348 satisfied to allow access.
 349 .TP 5
 350 ServerAdmin
 351 .br
 352 Specifies the email address of the server administrator.
 353 .TP 5
 354 ServerBin
 355 .br
 356 Specifies the directory where backends, CGIs, daemons, and filters may
 357 be found.
 358 .TP 5
 359 ServerCertificate
 360 .br
 361 Specifies the encryption certificate to use.
 362 .TP 5
 363 ServerKey
 364 .br
 365 Specifies the encryption key to use.
 366 .TP 5
 367 ServerName
 368 .br
 369 Specifies the fully-qualified hostname of the server.
 370 .TP 5
 371 ServerRoot
 372 .br
 373 Specifies the directory where the server configuration files can be found.
 374 .TP 5
 375 ServerTokens
 376 .br
 377 Specifies what information is included in the Server header of HTTP
 378 responses.
 379 .TP 5
 380 SSLListen
 381 .br
 382 Listens on the specified address and port for encrypted connections.
 383 .TP 5
 384 SSLPort
 385 .br
 386 Listens on the specified port for encrypted connections.
 387 .TP 5
 388 SystemGroup
 389 .br
 390 Specifies the group to use for System class authentication.
 391 .TP 5
 392 TempDir
 393 .br
 394 Specifies the directory where temporary files are stored.
 395 .TP 5
 396 Timeout
 397 .br
 398 Specifies the HTTP request timeout in seconds.
 399 .TP 5
 400 User
 401 .br
 402 Specifies the user name or ID that is used when running external programs.
 403 .SH SEE ALSO
 404 classes.conf(5), cupsd(8), mime.convs(5), mime.types(5), printers.conf(5),
 405 CUPS Software Administrators Manual,
 406 http://localhost:631/documentation.html
 407 .SH COPYRIGHT
 408 Copyright 1993-2005 by Easy Software Products, All Rights Reserved.
 409 .\"
 410 .\" End of "$Id$".
 411 .\"