doc/help/ref-cupsd-conf.html

   1 <HTML>
   2 <!-- SECTION: References -->
   3 <HEAD>
   4         <TITLE>cupsd.conf</TITLE>
   5 </HEAD>
   6 <BODY>
   7
   8
   9 <P>The <VAR>/etc/cups/cupsd.conf</VAR> file contains
  10 configuration <I>directives</I> that control how the server
  11 functions. Each directive is listed on a line by itself followed
  12 by its value. Comments are introduced using the number sign ("#")
  13 character at the beginning of a line.</P>
  14
  15 <P>Since the server configuration file consists of plain text,
  16 you can use your favorite text editor to make changes to it.
  17 After making any changes, restart the <CODE>cupsd(8)</CODE>
  18 process using the startup script for your operating system:</P>
  19
  20 <UL>
  21
  22         <LI>AIX, IRIX, Linux, Solaris:
  23         <PRE CLASS="command">
  24 /etc/init.d/cups restart
  25         </PRE></LI>
  26
  27         <LI>HP-UX:
  28         <PRE CLASS="command">
  29 /sbin/init.d/cups restart
  30         </PRE></LI>
  31
  32         <LI>MacOS X:
  33         <PRE CLASS="command">
  34 /System/Library/StartupItems/PrintingServices/PrintingServices restart
  35         </PRE></LI>
  36
  37 </UL>
  38
  39 <P>You can also edit this file from the CUPS web interface, which
  40 automatically handles restarting the scheduler.</P>
  41
  42
  43 <H2 CLASS="title"><A NAME="AccessLog">AccessLog</A></H2>
  44
  45 <H3>Examples</H3>
  46
  47 <PRE CLASS="command">
  48 AccessLog /var/log/cups/access_log
  49 AccessLog /var/log/cups/access_log-%s
  50 AccessLog syslog
  51 </PRE>
  52
  53 <H3>Description</H3>
  54
  55 <P>The <CODE>AccessLog</CODE> directive sets the name of the
  56 access log file. If the filename is not absolute then it is
  57 assumed to be relative to the <A
  58 HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The
  59 access log file is stored in "common log format" and can be used
  60 by any web access reporting tool to generate a report on CUPS
  61 server activity.</P>
  62
  63 <P>The server name can be included in the filename by using
  64 <CODE>%s</CODE> in the name.</P>
  65
  66 <P>The special name "syslog" can be used to send the access
  67 information to the system log instead of a plain file.</P>
  68
  69 <P>The default access log file is
  70 <VAR>/var/log/cups/access_log</VAR>.</P>
  71
  72
  73 <H2 CLASS="title"><A NAME="Allow">Allow</A></H2>
  74
  75 <H3>Examples</H3>
  76
  77 <PRE CLASS="command">
  78 &lt;Location /path&gt;
  79   ...
  80   Allow from All
  81   Allow from None
  82   Allow from *.domain.com
  83   Allow from .domain.com
  84   Allow from host.domain.com
  85   Allow from nnn.*
  86   Allow from nnn.nnn.*
  87   Allow from nnn.nnn.nnn.*
  88   Allow from nnn.nnn.nnn.nnn
  89   Allow from nnn.nnn.nnn.nnn/mm
  90   Allow from nnn.nnn.nnn.nnn/mmm.mmm.mmm.mmm
  91   Allow from xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx
  92   Allow from @LOCAL
  93   Allow from @IF(name)
  94 &lt;/Location&gt;
  95 </PRE>
  96
  97 <H3>Description</H3>
  98
  99 <P>The <CODE>Allow</CODE> directive specifies a hostname, IP
 100 address, or network that is allowed access to the server.
 101 <CODE>Allow</CODE> directives are cummulative, so multiple
 102 <CODE>Allow</CODE> directives can be used to allow access for
 103 multiple hosts or networks.  The <CODE>/mm</CODE> notation
 104 specifies a CIDR netmask, as shown in Table 1.</P>
 105
 106 <DIV CLASS="table"><TABLE SUMMARY="CIDR Netmasks">
 107 <CAPTION>Table 1: <A NAME="TABLE1">CIDR Netmasks</A></CAPTION>
 108 <TR>
 109         <TH WIDTH="10%">mm</TH>
 110         <TH WIDTH="20%">netmask</TH>
 111         <TH WIDTH="10%">mm</TH>
 112         <TH WIDTH="20%">netmask</TH>
 113 </TR>
 114 <TR>
 115         <TD ALIGN="CENTER">0</TD>
 116         <TD ALIGN="CENTER">0.0.0.0</TD>
 117         <TD ALIGN="CENTER">8</TD>
 118         <TD ALIGN="CENTER">255.0.0.0</TD>
 119 </TR>
 120 <TR>
 121         <TD ALIGN="CENTER">1</TD>
 122         <TD ALIGN="CENTER">128.0.0.0</TD>
 123         <TD ALIGN="CENTER">16</TD>
 124         <TD ALIGN="CENTER">255.255.0.0</TD>
 125 </TR>
 126 <TR>
 127         <TD ALIGN="CENTER">2</TD>
 128         <TD ALIGN="CENTER">192.0.0.0</TD>
 129         <TD ALIGN="CENTER">24</TD>
 130         <TD ALIGN="CENTER">255.255.255.0</TD>
 131 </TR>
 132 <TR>
 133         <TD ALIGN="CENTER">...</TD>
 134         <TD ALIGN="CENTER">...</TD>
 135         <TD ALIGN="CENTER">32</TD>
 136         <TD ALIGN="CENTER">255.255.255.255</TD>
 137 </TR>
 138 </TABLE></DIV>
 139
 140 <P>The <CODE>@LOCAL</CODE> name will allow access from all local
 141 interfaces. The <CODE>@IF(name)</CODE> name will allow access
 142 from the named interface. In both cases, CUPS only allows access
 143 from the network that the interface(s) are configured for -
 144 requests  arriving on the interface from a foreign network will
 145 <em>not</em> be accepted.</P>
 146
 147 <P>The <CODE>Allow</CODE> directive must appear inside a <A
 148 HREF="#Location"><CODE>Location</CODE></A> or <A
 149 HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
 150
 151
 152 <H2 CLASS="title"><SPAN CLASS="info">Deprecated</SPAN><A NAME="AuthClass">AuthClass</A></H2>
 153
 154 <H3>Examples</H3>
 155
 156 <PRE CLASS="command">
 157 &lt;Location /path&gt;
 158   ...
 159   AuthClass Anonymous
 160   AuthClass User
 161   AuthClass System
 162   AuthClass Group
 163 &lt;/Location&gt;
 164 </PRE>
 165
 166 <H3>Description</H3>
 167
 168 <P>The <CODE>AuthClass</CODE> directive defines what level of
 169 authentication is required:</P>
 170
 171 <UL>
 172
 173         <LI><CODE>Anonymous</CODE> - No authentication should be
 174         performed (default)</LI>
 175
 176         <LI><CODE>User</CODE> - A valid username and password is
 177         required</LI>
 178
 179         <LI><CODE>System</CODE> - A valid username and password
 180         is required, and the username must belong to the "sys"
 181         group; this can be changed using the <A
 182         HREF="#SystemGroup"><CODE>SystemGroup</CODE></A>
 183         directive</LI>
 184
 185         <LI><CODE>Group</CODE> - A valid username and password is
 186         required, and the username must belong to the group named
 187         by the <A
 188         HREF="#AuthGroupName"><CODE>AuthGroupName</CODE></A>
 189         directive</LI>
 190
 191 </UL>
 192
 193 <P>The <CODE>AuthClass</CODE> directive must appear inside a <A
 194 HREF="#Location"><CODE>Location</CODE></A> or <A
 195 HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
 196
 197 <P><B>This directive is deprecated and will be removed from a
 198 future release of CUPS.</B> Consider using the more flexible <A
 199 HREF="#Require"><CODE>Require</CODE></A> directive instead.</P>
 200
 201
 202 <H2 CLASS="title"><SPAN CLASS="info">Deprecated</SPAN><A NAME="AuthGroupName">AuthGroupName</A></H2>
 203
 204 <H3>Examples</H3>
 205
 206 <PRE CLASS="command">
 207 &lt;Location /path&gt;
 208   ...
 209   AuthGroupName mygroup
 210   AuthGroupName lp
 211 &lt;/Location&gt;
 212 </PRE>
 213
 214 <H3>Description</H3>
 215
 216 <P>The <CODE>AuthGroupName</CODE> directive sets the group to use
 217 for <CODE>Group</CODE> authentication.</P>
 218
 219 <P>The <CODE>AuthGroupName</CODE> directive must appear inside a
 220 <A HREF="#Location"><CODE>Location</CODE></A> or <A
 221 HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
 222
 223 <P><B>This directive is deprecated and will be removed from a
 224 future release of CUPS.</B> Consider using the more flexible <A
 225 HREF="#Require"><CODE>Require</CODE></A> directive instead.</P>
 226
 227
 228 <H2 CLASS="title"><A NAME="AuthType">AuthType</A></H2>
 229
 230 <H3>Examples</H3>
 231
 232 <PRE CLASS="command">
 233 &lt;Location /path&gt;
 234   ...
 235   AuthType None
 236   AuthType Basic
 237   AuthType Digest
 238   AuthType BasicDigest
 239 &lt;/Location&gt;
 240 </PRE>
 241
 242 <H3>Description</H3>
 243
 244 <P>The <CODE>AuthType</CODE> directive defines the type of
 245 authentication to perform:</P>
 246
 247 <UL>
 248
 249         <LI><CODE>None</CODE> - No authentication should be
 250         performed (default)</LI>
 251
 252         <LI><CODE>Basic</CODE> - Basic authentication should be
 253         performed using the UNIX password and group files</LI>
 254
 255         <LI><CODE>Digest</CODE> - Digest authentication should be
 256         performed using the <VAR>/etc/cups/passwd.md5</VAR>
 257         file</LI>
 258
 259         <LI><CODE>BasicDigest</CODE> - Basic authentication
 260         should be performed using the
 261         <VAR>/etc/cups/passwd.md5</VAR> file</LI>
 262
 263 </UL>
 264
 265 <P>When using <CODE>Basic</CODE>, <CODE>Digest</CODE>, or
 266 <CODE>BasicDigest</CODE> authentication, clients connecting
 267 through the <CODE>localhost</CODE> interface can also
 268 authenticate using certificates.</P>
 269
 270 <P>The <CODE>AuthType</CODE> directive must appear inside a <A
 271 HREF="#Location"><CODE>Location</CODE></A> or <A
 272 HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
 273
 274
 275 <H2 CLASS="title"><A NAME="AutoPurgeJobs">AutoPurgeJobs</A></H2>
 276
 277 <H3>Examples</H3>
 278
 279 <PRE CLASS="command">
 280 AutoPurgeJobs Yes
 281 AutoPurgeJobs No
 282 </PRE>
 283
 284 <H3>Description</H3>
 285
 286 <P>The <CODE>AutoPurgeJobs</CODE> directive specifies whether or
 287 not to purge completed jobs once they are no longer required for
 288 quotas. This option has no effect if quotas are not enabled. The
 289 default setting is <CODE>No</CODE>.</P>
 290
 291
 292 <H2 CLASS="title"><A NAME="BrowseAddress">BrowseAddress</A></H2>
 293
 294 <H3>Examples</H3>
 295
 296 <PRE CLASS="command">
 297 BrowseAddress 255.255.255.255:631
 298 BrowseAddress 192.0.2.255:631
 299 BrowseAddress host.domain.com:631
 300 BrowseAddress @LOCAL
 301 BrowseAddress @IF(name)
 302 </PRE>
 303
 304 <H3>Description</H3>
 305
 306 <P>The <CODE>BrowseAddress</CODE> directive specifies an address
 307 to send browsing information to. Multiple
 308 <CODE>BrowseAddress</CODE> directives can be specified to send
 309 browsing information to different networks or systems.</P>
 310
 311 <P>The <CODE>@LOCAL</CODE> name will broadcast printer
 312 information to all local interfaces. The <CODE>@IF(name)</CODE>
 313 name will broadcast to the named interface.</P>
 314
 315 <P>There is no default browse address.</P>
 316
 317 <BLOCKQUOTE><B>Note:</B>
 318
 319 <P>If you are using HP-UX 10.20 and a subnet that is not 24,
 320 16, or 8 bits, printer browsing (and in fact all broadcast
 321 reception) will not work. This problem appears to be fixed in
 322 HP-UX 11.0.</P>
 323
 324 </BLOCKQUOTE>
 325
 326
 327 <H2 CLASS="title"><A NAME="BrowseAllow">BrowseAllow</A></H2>
 328
 329 <H3>Examples</H3>
 330
 331 <PRE CLASS="command">
 332 BrowseAllow from all
 333 BrowseAllow from none
 334 BrowseAllow from 192.0.2
 335 BrowseAllow from 192.0.2.0/24
 336 BrowseAllow from 192.0.2.0/255.255.255.0
 337 BrowseAllow from *.domain.com
 338 BrowseAllow from @LOCAL
 339 BrowseAllow from @IF(name)
 340 </PRE>
 341
 342 <H3>Description</H3>
 343
 344 <P>The <CODE>BrowseAllow</CODE> directive specifies a system or
 345 network to accept browse packets from. The default is to accept
 346 browse packets from all hosts.</P>
 347
 348 <P>Host and domain name matching require that you enable the <A
 349 HREF="#HostNameLookups"><CODE>HostNameLookups</CODE></A>
 350 directive.</P>
 351
 352 <P>IP address matching supports exact matches, partial addresses
 353 that match networks using netmasks of 255.0.0.0, 255.255.0.0, and
 354 255.255.255.0, or network addresses using the specified netmask
 355 or bit count.</P>
 356
 357 <P>The <CODE>@LOCAL</CODE> name will allow browse data from all
 358 local interfaces. The <CODE>@IF(name)</CODE> name will allow
 359 browse data from the named interface. In both cases, CUPS only
 360 allows data from the network that the interface(s) are configured
 361 for - data arriving on the interface from a foreign network will
 362 <em>not</em> be allowed.</P>
 363
 364
 365 <H2 CLASS="title"><A NAME="BrowseDeny">BrowseDeny</A></H2>
 366
 367 <H3>Examples</H3>
 368
 369 <PRE CLASS="command">
 370 BrowseDeny from all
 371 BrowseDeny from none
 372 BrowseDeny from 192.0.2
 373 BrowseDeny from 192.0.2.0/24
 374 BrowseDeny from 192.0.2.0/255.255.255.0
 375 BrowseDeny from *.domain.com
 376 BrowseDeny from @LOCAL
 377 BrowseDeny from @IF(name)
 378 </PRE>
 379
 380 <H3>Description</H3>
 381
 382 <P>The <CODE>BrowseDeny</CODE> directive specifies a system or
 383 network to reject browse packets from. The default is to not deny
 384 browse packets from any hosts.</P>
 385
 386 <P>Host and domain name matching require that you enable the <A
 387 HREF="#HostNameLookups"><CODE>HostNameLookups</CODE></A>
 388 directive.</P>
 389
 390 <P>IP address matching supports exact matches, partial addresses
 391 that match networks using netmasks of 255.0.0.0, 255.255.0.0, and
 392 255.255.255.0, or network addresses using the specified netmask
 393 or bit count.</P>
 394
 395 <P>The <CODE>@LOCAL</CODE> name will block browse data from all
 396 local interfaces. The <CODE>@IF(name)</CODE> name will block
 397 browse data from the named interface. In both cases, CUPS only
 398 blocks data from the network that the interface(s) are configured
 399 for - data arriving on the interface from a foreign network will
 400 <em>not</em> be blocked.</P>
 401
 402
 403 <H2 CLASS="title"><A NAME="BrowseInterval">BrowseInterval</A></H2>
 404
 405 <H3>Examples</H3>
 406
 407 <PRE CLASS="command">
 408 BrowseInterval 0
 409 BrowseInterval 30
 410 </PRE>
 411
 412 <H3>Description</H3>
 413
 414 <P>The <CODE>BrowseInterval</CODE> directive specifies the
 415 maximum amount of time between browsing updates. Specifying a
 416 value of 0 seconds disables outgoing browse updates but allows a
 417 server to receive printer information from other hosts.</P>
 418
 419 <P>The <CODE>BrowseInterval</CODE> value should always be less
 420 than the <A HREF="#BrowseTimeout"><CODE>BrowseTimeout</CODE></A>
 421 value. Otherwise printers and classes will disappear from client
 422 systems between updates.</P>
 423
 424
 425 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="BrowseLDAPBindDN">BrowseLDAPBindDN</A></H2>
 426
 427 <H3>Examples</H3>
 428
 429 <PRE CLASS="command">
 430 BrowseLDAPBindDN foo
 431 </PRE>
 432
 433 <H3>Description</H3>
 434
 435 <P>The <CODE>BrowseLDAPBindDN</CODE> directive specifies the LDAP
 436 domain name to use when listening for printer registrations. The
 437 default is undefined.</P>
 438
 439
 440 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="BrowseLDAPDN">BrowseLDAPDN</A></H2>
 441
 442 <H3>Examples</H3>
 443
 444 <PRE CLASS="command">
 445 BrowseLDAPDN bar
 446 </PRE>
 447
 448 <H3>Description</H3>
 449
 450 <P>The <CODE>BrowseLDAPDN</CODE> directive specifies the LDAP
 451 domain name to use when registering local shared printers. The
 452 default is undefined.</P>
 453
 454
 455 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="BrowseLDAPPassword">BrowseLDAPPassword</A></H2>
 456
 457 <H3>Examples</H3>
 458
 459 <PRE CLASS="command">
 460 BrowseLDAPPassword foo123
 461 </PRE>
 462
 463 <H3>Description</H3>
 464
 465 <P>The <CODE>BrowseLDAPPassword</CODE> directive specifies the
 466 access password to use when connecting to the LDAP server. The
 467 default is undefined.</P>
 468
 469
 470 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="BrowseLDAPServer">BrowseLDAPServer</A></H2>
 471
 472 <H3>Examples</H3>
 473
 474 <PRE CLASS="command">
 475 BrowseLDAPServer localhost
 476 </PRE>
 477
 478 <H3>Description</H3>
 479
 480 <P>The <CODE>BrowseLDAPServer</CODE> directive specifies the name
 481 of the LDAP server to connect to. The default is undefined.</P>
 482
 483
 484 <H2 CLASS="title"><A NAME="BrowseLocalOptions">BrowseLocalOptions</A></H2>
 485
 486 <H3>Examples</H3>
 487
 488 <PRE CLASS="command">
 489 BrowseLocalOptions compression=yes
 490 BrowseLocalOptions encryption=required
 491 BrowseLocalOptions compression=yes&amp;encryption=required
 492 </PRE>
 493
 494 <H3>Description</H3>
 495
 496 <P>The <CODE>BrowseLocalOptions</CODE> directive specifies
 497 additional IPP backend options to advertise with local shared
 498 printers. The default is to not include any options.</P>
 499
 500
 501 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="BrowseLocalProtocols">BrowseLocalProtocols</A></H2>
 502
 503 <H3>Examples</H3>
 504
 505 <PRE CLASS="command">
 506 BrowseLocalProtocols all
 507 BrowseLocalProtocols none
 508 BrowseLocalProtocols cups
 509 BrowseLocalProtocols dns-sd
 510 BrowseLocalProtocols ldap
 511 BrowseLocalProtocols slp
 512 BrowseLocalProtocols cups dns-sd
 513 </PRE>
 514
 515 <H3>Description</H3>
 516
 517 <P>The <CODE>BrowseLocalProtocols</CODE> directive specifies the
 518 protocols to use when advertising local shared printers on the
 519 network. Multiple protocols can be specified by separating them
 520 with spaces. The default is <CODE>cups</CODE>, which is a
 521 broadcast-based protocol.</P>
 522
 523
 524 <H2 CLASS="title"><A NAME="BrowseOrder">BrowseOrder</A></H2>
 525
 526 <H3>Examples</H3>
 527
 528 <PRE CLASS="command">
 529 BrowseOrder allow,deny
 530 BrowseOrder deny,allow
 531 </PRE>
 532
 533 <H3>Description</H3>
 534
 535 <P>The <CODE>BrowseOrder</CODE> directive specifies the order of
 536 allow/deny processing. The default order is
 537 <CODE>deny,allow</CODE>:</P>
 538
 539 <UL>
 540
 541         <LI><CODE>allow,deny</CODE> - Deny browse packets by
 542         default, then check <CODE>BrowseAllow</CODE> lines
 543         followed by <CODE>BrowseDeny</CODE> lines.</LI>
 544
 545         <LI><CODE>deny,allow</CODE> - Allow browse packets by
 546         default, then check <CODE>BrowseDeny</CODE> lines
 547         followed by <CODE>BrowseAllow</CODE> lines.</LI>
 548
 549 </UL>
 550
 551
 552 <H2 CLASS="title"><A NAME="BrowsePoll">BrowsePoll</A></H2>
 553
 554 <H3>Examples</H3>
 555
 556 <PRE CLASS="command">
 557 BrowsePoll 192.0.2.2:631
 558 BrowsePoll host.domain.com:631
 559 </PRE>
 560
 561 <H3>Description</H3>
 562
 563 <P>The <CODE>BrowsePoll</CODE> directive polls a server for
 564 available printers once every <A
 565 HREF="#BrowseInterval"><CODE>BrowseInterval</CODE></A> seconds.
 566 Multiple <CODE>BrowsePoll</CODE> directives can be specified to
 567 poll multiple servers.</P>
 568
 569 <P>If <CODE>BrowseInterval</CODE> is set to 0 then the server is
 570 polled once every 30 seconds.</P>
 571
 572
 573 <H2 CLASS="title"><A NAME="BrowsePort">BrowsePort</A></H2>
 574
 575 <H3>Examples</H3>
 576
 577 <PRE CLASS="command">
 578 BrowsePort 631
 579 BrowsePort 9999
 580 </PRE>
 581
 582 <H3>Description</H3>
 583
 584 <P>The <CODE>BrowsePort</CODE> directive specifies the UDP port number
 585 used for browse packets. The default port number is 631.</P>
 586
 587 <BLOCKQUOTE><B>Note:</B>
 588
 589 <P>You must set the <CODE>BrowsePort</CODE> to the same value
 590 on all of the systems that you want to see.
 591
 592 </BLOCKQUOTE>
 593
 594
 595 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.10</SPAN><A NAME="BrowseProtocols">BrowseProtocols</A></H2>
 596
 597 <H3>Examples</H3>
 598
 599 <PRE CLASS="command">
 600 BrowseProtocols all
 601 BrowseProtocols none
 602 BrowseProtocols cups
 603 BrowseProtocols dns-sd
 604 BrowseProtocols ldap
 605 BrowseProtocols slp
 606 BrowseProtocols cups dns-sd
 607 </PRE>
 608
 609 <H3>Description</H3>
 610
 611 <P>The <CODE>BrowseProtocols</CODE> directive specifies the
 612 protocols to use when showing and advertising shared printers on
 613 the local network. Multiple protocols can be specified by
 614 separating them with spaces. The default protocol is
 615 <CODE>cups</CODE>, which is a broadcast-based protocol.</P>
 616
 617 <BLOCKQUOTE><B>Note:</B>
 618
 619 <P>When using the <CODE>SLP</CODE> protocol, you must have at least
 620 one Directory Agent (DA) server on your network. Otherwise the
 621 CUPS scheduler (<CODE>cupsd</CODE>) will not respond to client
 622 requests for several seconds while polling the network.</P>
 623
 624 </BLOCKQUOTE>
 625
 626
 627 <H2 CLASS="title"><A NAME="BrowseRelay">BrowseRelay</A></H2>
 628
 629 <H3>Examples</H3>
 630
 631 <PRE CLASS="command">
 632 BrowseRelay 193.0.2.1 192.0.2.255
 633 BrowseRelay 193.0.2.0/255.255.255.0 192.0.2.255
 634 BrowseRelay 193.0.2.0/24 192.0.2.255
 635 BrowseRelay *.domain.com 192.0.2.255
 636 BrowseRelay host.domain.com 192.0.2.255
 637 </PRE>
 638
 639 <H3>Description</H3>
 640
 641 <P>The <CODE>BrowseRelay</CODE> directive specifies source and
 642 destination addresses for relaying browsing information from one
 643 host or network to another. Multiple <CODE>BrowseRelay</CODE>
 644 directives can be specified as needed.</P>
 645
 646 <P><CODE>BrowseRelay</CODE> is typically used on systems that
 647 bridge multiple subnets using one or more network interfaces. It
 648 can also be used to relay printer information from polled servers
 649 with the line:</P>
 650
 651 <PRE CLASS="command">
 652 BrowseRelay 127.0.0.1 @LOCAL
 653 </PRE>
 654
 655 <P>This effectively provides access to printers on a WAN for all
 656 clients on the LAN(s).</P>
 657
 658
 659 <H2 CLASS="title"><A NAME="BrowseRemoteOptions">BrowseRemoteOptions</A></H2>
 660
 661 <H3>Examples</H3>
 662
 663 <PRE CLASS="command">
 664 BrowseRemoteOptions compression=yes
 665 BrowseRemoteOptions encryption=required
 666 BrowseRemoteOptions ?compression=yes&amp;encryption=required
 667 </PRE>
 668
 669 <H3>Description</H3>
 670
 671 <P>The <CODE>BrowseRemoteOptions</CODE> directive specifies
 672 additional IPP backend options to include with remote shared
 673 printers. If the options string begins with a question mark (?),
 674 the options replace any options specified by the remote server.
 675 The default is to not include any options.</P>
 676
 677
 678 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="BrowseRemoteProtocols">BrowseRemoteProtocols</A></H2>
 679
 680 <H3>Examples</H3>
 681
 682 <PRE CLASS="command">
 683 BrowseRemoteProtocols all
 684 BrowseRemoteProtocols none
 685 BrowseRemoteProtocols cups
 686 BrowseRemoteProtocols dns-sd
 687 BrowseRemoteProtocols ldap
 688 BrowseRemoteProtocols slp
 689 BrowseRemoteProtocols cups dns-sd
 690 </PRE>
 691
 692 <H3>Description</H3>
 693
 694 <P>The <CODE>BrowseRemoteProtocols</CODE> directive specifies the
 695 protocols to use when finding remote shared printers on the
 696 network. Multiple protocols can be specified by separating them
 697 with spaces. The default is <CODE>cups</CODE>, which is a
 698 broadcast-based protocol.</P>
 699
 700
 701 <H2 CLASS="title"><A NAME="BrowseShortNames">BrowseShortNames</A></H2>
 702
 703 <H3>Examples</H3>
 704
 705 <PRE CLASS="command">
 706 BrowseShortNames Yes
 707 BrowseShortNames No
 708 </PRE>
 709
 710 <H3>Description</H3>
 711
 712 <P>The <CODE>BrowseShortNames</CODE> directive specifies whether
 713 or not short names are used for remote printers when possible.
 714 Short names are just the remote printer name, without the server
 715 ("printer"). If more than one remote printer is detected with the
 716 same name, the printers will have long names ("printer@server1",
 717 "printer@server2".)</P>
 718
 719 <P>The default value for this option is <CODE>Yes</CODE>.</P>
 720
 721
 722 <H2 CLASS="title"><A NAME="BrowseTimeout">BrowseTimeout</A></H2>
 723
 724 <H3>Examples</H3>
 725
 726 <PRE CLASS="command">
 727 BrowseTimeout 300
 728 BrowseTimeout 60
 729 </PRE>
 730
 731 <H3>Description</H3>
 732
 733 <P>The <CODE>BrowseTimeout</CODE> directive sets the timeout for
 734 printer or class information that is received in browse packets.
 735 Once a printer or class times out it is removed from the list of
 736 available destinations.</P>
 737
 738 <P>The <CODE>BrowseTimeout</CODE> value should always be greater
 739 than the <A
 740 HREF="#BrowseInterval"><CODE>BrowseInterval</CODE></A> value.
 741 Otherwise printers and classes will disappear from client systems
 742 between updates.</P>
 743
 744
 745 <H2 CLASS="title"><A NAME="Browsing">Browsing</A></H2>
 746
 747 <H3>Examples</H3>
 748
 749 <PRE CLASS="command">
 750 Browsing On
 751 Browsing Off
 752 </PRE>
 753
 754 <H3>Description</H3>
 755
 756 <P>The <CODE>Browsing</CODE> directive controls whether or not
 757 network printer browsing is enabled. The default setting is
 758 <CODE>On</CODE>.</P>
 759
 760 <P>This directive does not enable sharing of local printers by
 761 itself; you must also use the <A
 762 HREF="#BrowseAddress"><CODE>BrowseAddress</CODE></A> or <A
 763 HREF="#BrowseProtocols"><CODE>BrowseProtocols</CODE></A>
 764 directives to advertise local printers to other systems.</P>
 765
 766 <BLOCKQUOTE><B>Note:</B>
 767
 768 <P>If you are using HP-UX 10.20 and a subnet that is not 24,
 769 16, or 8 bits, printer browsing (and in fact all broadcast
 770 reception) will not work. This problem appears to be fixed in
 771 HP-UX 11.0.</P>
 772
 773 </BLOCKQUOTE>
 774
 775
 776 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Classification">Classification</A></H2>
 777
 778 <H3>Examples</H3>
 779
 780 <PRE CLASS="command">
 781 Classification
 782 Classification classified
 783 Classification confidential
 784 Classification secret
 785 Classification topsecret
 786 Classification unclassified
 787 </PRE>
 788
 789 <H3>Description</H3>
 790
 791 <P>The <CODE>Classification</CODE> directive sets the
 792 classification level on the server. When this option is set, at
 793 least one of the banner pages is forced to the classification
 794 level, and the classification is placed on each page of output.
 795 The default is no classification level.</P>
 796
 797
 798 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.10</SPAN><A NAME="ClassifyOverride">ClassifyOverride</A></H2>
 799
 800 <H3>Examples</H3>
 801
 802 <PRE CLASS="command">
 803 ClassifyOverride Yes
 804 ClassifyOverride No
 805 </PRE>
 806
 807 <H3>Description</H3>
 808
 809 <P>The <CODE>ClassifyOverride</CODE> directive specifies whether
 810 users can override the default classification level on the
 811 server. When the server classification is set, users can change
 812 the classification using the <CODE>job-sheets</CODE> option and
 813 can choose to only print one security banner before or after the
 814 job. If the <CODE>job-sheets</CODE> option is set to
 815 <CODE>none</CODE> then the server default classification is
 816 used.</P>
 817
 818 <P>The default is to not allow classification overrides.</P>
 819
 820
 821 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.15</SPAN><A NAME="ConfigFilePerm">ConfigFilePerm</A></H2>
 822
 823 <H3>Examples</H3>
 824
 825 <PRE CLASS="command">
 826 ConfigFilePerm 0644
 827 ConfigFilePerm 0640
 828 </PRE>
 829
 830 <H3>Description</H3>
 831
 832 <P>The <CODE>ConfigFilePerm</CODE> directive specifies the
 833 permissions to use when writing configuration files. The default
 834 is 0640.</P>
 835
 836
 837 <H2 CLASS="title"><A NAME="DataDir">DataDir</A></H2>
 838
 839 <H3>Examples</H3>
 840
 841 <PRE CLASS="command">
 842 DataDir /usr/share/cups
 843 </PRE>
 844
 845 <H3>Description</H3>
 846
 847 <P>The <CODE>DataDir</CODE> directive sets the directory to use
 848 for data files.</P>
 849
 850
 851 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="DefaultAuthType">DefaultAuthType</A></H2>
 852
 853 <H3>Examples</H3>
 854
 855 <PRE CLASS="command">
 856 DefaultAuthType Basic
 857 DefaultAuthType BasicDigest
 858 DefaultAuthType Digest
 859 </PRE>
 860
 861 <H3>Description</H3>
 862
 863 <P>The <CODE>DefaultAuthType</CODE> directive specifies the type
 864 of authentication to use for IPP operations that require a
 865 username. The default is <CODE>Basic</CODE>.</P>
 866
 867
 868 <H2 CLASS="title"><A NAME="DefaultCharset">DefaultCharset</A></H2>
 869
 870 <H3>Examples</H3>
 871
 872 <PRE CLASS="command">
 873 DefaultCharset utf-8
 874 DefaultCharset iso-8859-1
 875 DefaultCharset windows-1251
 876 </PRE>
 877
 878 <H3>Description</H3>
 879
 880 <P>The <CODE>DefaultCharset</CODE> directive sets the default
 881 character set to use for client connections. The default
 882 character set is <CODE>utf-8</CODE> but is overridden by the
 883 character set for the language specified by the client or the
 884 <CODE>DefaultLanguage</CODE> directive.</P>
 885
 886
 887 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="DefaultEncryption">DefaultEncryption</A></H2>
 888
 889 <H3>Examples</H3>
 890
 891 <PRE CLASS="command">
 892 DefaultEncryption Never
 893 DefaultEncryption IfRequested
 894 DefaultEncryption Required
 895 </PRE>
 896
 897 <H3>Description</H3>
 898
 899 <P>The <CODE>DefaultEncryption</CODE> directive specifies the
 900 type of encryption to use when performing authentication. The
 901 default is <CODE>Required</CODE>.</P>
 902
 903
 904 <H2 CLASS="title"><A NAME="DefaultLanguage">DefaultLanguage</A></H2>
 905
 906 <H3>Examples</H3>
 907
 908 <PRE CLASS="command">
 909 DefaultLanguage de
 910 DefaultLanguage en
 911 DefaultLanguage es
 912 DefaultLanguage fr
 913 DefaultLanguage it
 914 </PRE>
 915
 916 <H3>Description</H3>
 917
 918 <P>The <CODE>DefaultLanguage</CODE> directive specifies the
 919 default language to use for client connections. Setting the
 920 default language also sets the default character set if a
 921 language localization file exists for it. The default language
 922 is "en" for English.</P>
 923
 924
 925 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="DefaultPolicy">DefaultPolicy</A></H2>
 926
 927 <H3>Examples</H3>
 928
 929 <PRE CLASS="command">
 930 DefaultPolicy default
 931 DefaultPolicy foo
 932 </PRE>
 933
 934 <H3>Description</H3>
 935
 936 <P>The <CODE>DefaultPolicy</CODE> directive specifies the default
 937 policy to use for IPP operation. The default is
 938 <CODE>default</CODE>.</P>
 939
 940
 941 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="DefaultShared">DefaultShared</A></H2>
 942
 943 <H3>Examples</H3>
 944
 945 <PRE CLASS="command">
 946 DefaultShared yes
 947 DefaultShared no
 948 </PRE>
 949
 950 <H3>Description</H3>
 951
 952 <P>The <CODE>DefaultShared</CODE> directive specifies whether
 953 printers are shared (published) by default. The default is
 954 <CODE>yes</CODE>.</P>
 955
 956
 957 <H2 CLASS="title"><A NAME="Deny">Deny</A></H2>
 958
 959 <H3>Examples</H3>
 960
 961 <PRE CLASS="command">
 962 &lt;Location /path&gt;
 963   ..
 964   Deny from All
 965   Deny from None
 966   Deny from *.domain.com
 967   Deny from .domain.com
 968   Deny from host.domain.com
 969   Deny from nnn.*
 970   Deny from nnn.nnn.*
 971   Deny from nnn.nnn.nnn.*
 972   Deny from nnn.nnn.nnn.nnn
 973   Deny from nnn.nnn.nnn.nnn/mm
 974   Deny from nnn.nnn.nnn.nnn/mmm.mmm.mmm.mmm
 975   Deny from xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx
 976   Deny from @LOCAL
 977   Deny from @IF(name)
 978 &lt;/Location&gt;
 979 </PRE>
 980
 981 <H3>Description</H3>
 982
 983 <P>The <CODE>Deny</CODE> directive specifies a hostname, IP
 984 address, or network that is allowed access to the server.
 985 <CODE>Deny</CODE> directives are cummulative, so multiple
 986 <CODE>Deny</CODE> directives can be used to allow access for
 987 multiple hosts or networks. The <CODE>/mm</CODE> notation
 988 specifies a CIDR netmask, a shown in <A HREF="TABLE1">Table
 989 1</A>.</P>
 990
 991 <P>The <CODE>@LOCAL</CODE> name will deny access from all local
 992 interfaces. The <CODE>@IF(name)</CODE> name will deny access from
 993 the named interface. In both cases, CUPS only denies access from
 994 the network that the interface(s) are configured for - requests
 995 arriving on the interface from a foreign network will
 996 <em>not</em> be denied.</P>
 997
 998 <P>The <CODE>Deny</CODE> directive must appear inside a <A
 999 HREF="#Location"><CODE>Location</CODE></A> or <A
1000 HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
1001
1002
1003 <H2 CLASS="title"><A NAME="DocumentRoot">DocumentRoot</A></H2>
1004
1005 <H3>Examples</H3>
1006
1007 <PRE CLASS="command">
1008 DocumentRoot /usr/share/doc/cups
1009 DocumentRoot /foo/bar/doc/cups
1010 </PRE>
1011
1012 <H3>Description</H3>
1013
1014 <P>The <CODE>DocumentRoot</CODE> directive specifies the location
1015 of web content for the HTTP server in CUPS. If an absolute path
1016 is not specified then it is assumed to be relative to the <A
1017 HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The
1018 default directory is <VAR>/usr/share/doc/cups</VAR>.</P>
1019
1020 <P>Documents are first looked up in a sub-directory for the
1021 primary language requested by the client (e.g.
1022 <VAR>/usr/share/doc/cups/fr/...</VAR>) and then directly under
1023 the <CODE>DocumentRoot</CODE> directory (e.g.
1024 <VAR>/usr/share/doc/cups/...</VAR>), so it is possible to
1025 localize the web content by providing subdirectories for each
1026 language needed.</P>
1027
1028
1029 <H2 CLASS="title"><A NAME="Encryption">Encryption</A></H2>
1030
1031 <H3>Examples</H3>
1032
1033 <PRE CLASS="command">
1034 &lt;Location /path&gt;
1035   ...
1036   Encryption Never
1037   Encryption IfRequested
1038   Encryption Required
1039 &lt;/Location&gt;
1040 </PRE>
1041
1042 <H3>Description</H3>
1043
1044 <P>The <CODE>Encryption</CODE> directive must appear instead a <A
1045 HREF="#Location"><CODE>Location</CODE></A> or <A
1046 HREF="#Limit"><CODE>Limit</CODE></A> section and specifies the
1047 encryption settings for that location. The default setting is
1048 <CODE>IfRequested</CODE> for all locations.</P>
1049
1050
1051 <H2 CLASS="title"><A NAME="ErrorLog">ErrorLog</A></H2>
1052
1053 <H3>Examples</H3>
1054
1055 <PRE CLASS="command">
1056 ErrorLog /var/log/cups/error_log
1057 ErrorLog /var/log/cups/error_log-%s
1058 ErrorLog syslog
1059 </PRE>
1060
1061 <H3>Description</H3>
1062
1063 <P>The <CODE>ErrorLog</CODE> directive sets the name of the error
1064 log file. If the filename is not absolute then it is assumed to
1065 be relative to the <A
1066 HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The
1067 default error log file is <VAR>/var/log/cups/error_log</VAR>.</P>
1068
1069 <P>The server name can be included in the filename by using
1070 <CODE>%s</CODE> in the name.</P>
1071
1072 <P>The special name "syslog" can be used to send the error
1073 information to the system log instead of a plain file.</P>
1074
1075
1076 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.18</SPAN><A NAME="FileDevice">FileDevice</A></H2>
1077
1078 <H3>Examples</H3>
1079
1080 <PRE CLASS="command">
1081 FileDevice Yes
1082 FileDevice No
1083 </PRE>
1084
1085 <H3>Description</H3>
1086
1087 <P>The <CODE>FileDevice</CODE> directive determines whether the
1088 scheduler allows new printers to be added using device URIs of
1089 the form <CODE>file:/filename</CODE>. File devices are most often
1090 used to test new printer drivers and do not support raw file
1091 printing.</P>
1092
1093 <P>The default setting is <CODE>No</CODE>.</P>
1094
1095 <BLOCKQUOTE><B>Note:</B>
1096
1097 <P>File devices are managed by the scheduler. Since the
1098 scheduler normally runs as the root user, file devices
1099 can be used to overwrite system files and potentially
1100 gain unauthorized access to the system. If you must
1101 create printers using file devices, we recommend that
1102 you set the <CODE>FileDevice</CODE> directive to
1103 <CODE>Yes</CODE> for only as long as you need to add the
1104 printers to the system, and then reset the directive to
1105 <CODE>No</CODE>.</P>
1106
1107 </BLOCKQUOTE>
1108
1109
1110 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.3</SPAN><A NAME="FilterLimit">FilterLimit</A></H2>
1111
1112 <H3>Examples</H3>
1113
1114 <PRE CLASS="command">
1115 FilterLimit 0
1116 FilterLimit 200
1117 FilterLimit 1000
1118 </PRE>
1119
1120 <H3>Description</H3>
1121
1122 <P>The <CODE>FilterLimit</CODE> directive sets the maximum cost
1123 of all running job filters. It can be used to limit the number of
1124 filter programs that are run on a server to minimize disk,
1125 memory, and CPU resource problems. A limit of 0 disables filter
1126 limiting.</P>
1127
1128 <P>An average print to a non-PostScript printer needs a filter
1129 limit of about 200. A PostScript printer needs about half that
1130 (100). Setting the limit below these thresholds will effectively
1131 limit the scheduler to printing a single job at any time.</P>
1132
1133 <P>The default limit is 0.</P>
1134
1135
1136 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.16</SPAN><A NAME="FilterNice">FilterNice</A></H2>
1137
1138 <H3>Examples</H3>
1139
1140 <PRE CLASS="command">
1141 FilterNice 0
1142 FilterNice 10
1143 FilterNice 19
1144 </PRE>
1145
1146 <H3>Description</H3>
1147
1148 <P>The <CODE>FilterNice</CODE> directive sets the <B>nice(1)</B>
1149 value to assign to filter processes. The nice value ranges from
1150 0, the highest priority, to 19, the lowest priority. The default
1151 is 0.</P>
1152
1153
1154 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.3</SPAN><A NAME="FontPath">FontPath</A></H2>
1155
1156 <H3>Examples</H3>
1157
1158 <PRE CLASS="command">
1159 FontPath /foo/bar/fonts
1160 FontPath /usr/share/cups/fonts:/foo/bar/fonts
1161 </PRE>
1162
1163 <H3>Description</H3>
1164
1165 <P>The <CODE>FontPath</CODE> directive specifies the font path to
1166 use when searching for fonts. The default font path is
1167 <CODE>/usr/share/cups/fonts</CODE>.</P>
1168
1169
1170 <H2 CLASS="title"><A NAME="Group">Group</A></H2>
1171
1172 <H3>Examples</H3>
1173
1174 <PRE CLASS="command">
1175 Group lp
1176 Group nobody
1177 </PRE>
1178
1179 <H3>Description</H3>
1180
1181 <P>The <CODE>Group</CODE> directive specifies the UNIX group that
1182 filter and CGI programs run as. The default group is
1183 system-specific but is usually <CODE>lp</CODE> or
1184 <CODE>nobody</CODE>.</P>
1185
1186
1187 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.10</SPAN><A NAME="HideImplicitMembers">HideImplicitMembers</A></H2>
1188
1189 <H3>Examples</H3>
1190
1191 <PRE CLASS="command">
1192 HideImplicitMembers Yes
1193 HideImplicitMembers No
1194 </PRE>
1195
1196 <H3>Description</H3>
1197
1198 <P>The <CODE>HideImplicitMembers</CODE> directive controls
1199 whether the individual printers in an implicit class are hidden
1200 from the user. The default is <CODE>Yes</CODE>.</P>
1201
1202 <P><A HREF="#ImplicitClasses"><CODE>ImplicitClasses</CODE></A>
1203 must be enabled for this directive to have any effect.</P>
1204
1205
1206 <H2 CLASS="title"><A NAME="HostNameLookups">HostNameLookups</A></H2>
1207
1208 <H3>Examples</H3>
1209
1210 <PRE CLASS="command">
1211 HostNameLookups On
1212 HostNameLookups Off
1213 HostNameLookups Double
1214 </PRE>
1215
1216 <H3>Description</H3>
1217
1218 <P>The <CODE>HostNameLookups</CODE> directive controls whether or
1219 not CUPS looks up the hostname for connecting clients. The
1220 <CODE>Double</CODE> setting causes CUPS to verify that the
1221 hostname resolved from the address matches one of the addresses
1222 returned for that hostname. <CODE>Double</CODE> lookups also
1223 prevent clients with unregistered addresses from connecting to
1224 your server.</P>
1225
1226 <P>The default is <CODE>Off</CODE> to avoid the potential server
1227 performance problems with hostname lookups. Set this option to
1228 <CODE>On</CODE> or <CODE>Double</CODE> only if absolutely
1229 required.</P>
1230
1231
1232 <H2 CLASS="title"><A NAME="ImplicitClasses">ImplicitClasses</A></H2>
1233
1234 <H3>Examples</H3>
1235
1236 <PRE CLASS="command">
1237 ImplicitClasses On
1238 ImplicitClasses Off
1239 </PRE>
1240
1241 <H3>Description</H3>
1242
1243 <P>The <CODE>ImplicitClasses</CODE> directive controls whether
1244 implicit classes are created based upon the available network
1245 printers and classes. The default setting is <CODE>On</CODE> but
1246 is automatically turned <CODE>Off</CODE> if <A
1247 HREF="#Browsing"><CODE>Browsing</CODE></A> is turned
1248 <CODE>Off</CODE>.</P>
1249
1250
1251 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.10</SPAN><A NAME="ImplicitAnyClasses">ImplicitAnyClasses</A></H2>
1252
1253 <H3>Examples</H3>
1254
1255 <PRE CLASS="command">
1256 ImplicitAnyClasses On
1257 ImplicitAnyClasses Off
1258 </PRE>
1259
1260 <H3>Description</H3>
1261
1262 <P>The <CODE>ImplicitAnyClasses</CODE> directive controls
1263 whether implicit classes for local and remote printers are
1264 created with the name <CODE>AnyPrinter</CODE>. The default
1265 setting is <CODE>Off</CODE>.</P>
1266
1267 <P><A HREF="#ImplicitClasses"><CODE>ImplicitClasses</CODE></A>
1268 must be enabled for this directive to have any effect.</P>
1269
1270
1271 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.9</SPAN><A NAME="Include">Include</A></H2>
1272
1273 <H3>Examples</H3>
1274
1275 <PRE CLASS="command">
1276 Include filename
1277 Include /foo/bar/filename
1278 </PRE>
1279
1280 <H3>Description</H3>
1281
1282 <P>The <CODE>Include</CODE> directive includes the named file in
1283 the <CODE>cupsd.conf</CODE> file. If no leading path is provided,
1284 the file is assumed to be relative to the <A
1285 HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory.</P>
1286
1287
1288 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="JobRetryInterval">JobRetryInterval</A></H2>
1289
1290 <H3>Examples</H3>
1291
1292 <PRE CLASS="command">
1293 JobRetryInterval 30
1294 JobRetryInterval 120
1295 </PRE>
1296
1297 <H3>Description</H3>
1298
1299 <P>The <CODE>JobRetryInterval</CODE> directive specifies the
1300 number of seconds to wait before retrying a job. This is
1301 typically used for fax queues but can also be used with normal
1302 print queues whose error policy is <CODE>retry-job</CODE>. The
1303 default is 30 seconds.</P>
1304
1305
1306 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="JobRetryLimit">JobRetryLimit</A></H2>
1307
1308 <H3>Examples</H3>
1309
1310 <PRE CLASS="command">
1311 JobRetryLimit 5
1312 JobRetryLimit 50
1313 </PRE>
1314
1315 <H3>Description</H3>
1316
1317 <P>The <CODE>JobRetryLimit</CODE> directive specifies the maximum
1318 number of times the scheduler will try to print a job. This is
1319 typically used for fax queues but can also be used with normal
1320 print queues whose error policy is <CODE>retry-job</CODE>. The
1321 default is 5 times.</P>
1322
1323
1324 <H2 CLASS="title"><A NAME="KeepAlive">KeepAlive</A></H2>
1325
1326 <H3>Examples</H3>
1327
1328 <PRE CLASS="command">
1329 KeepAlive On
1330 KeepAlive Off
1331 </PRE>
1332
1333 <H3>Description</H3>
1334
1335 <P>The <CODE>KeepAlive</CODE> directive controls whether or not
1336 to support persistent HTTP connections. The default is
1337 <CODE>On</CODE>.</P>
1338
1339 <P>HTTP/1.1 clients automatically support persistent connections,
1340 while HTTP/1.0 clients must specifically request them using the
1341 <CODE>Keep-Alive</CODE> attribute in the <CODE>Connection:</CODE>
1342 field of each request.</P>
1343
1344
1345 <H2 CLASS="title"><A NAME="KeepAliveTimeout">KeepAliveTimeout</A></H2>
1346
1347 <H3>Examples</H3>
1348
1349 <PRE CLASS="command">
1350 KeepAliveTimeout 60
1351 KeepAliveTimeout 30
1352 </PRE>
1353
1354 <H3>Description</H3>
1355
1356 <P>The <CODE>KeepAliveTimeout</CODE> directive controls how long
1357 a persistent HTTP connection will remain open after the last
1358 request. The default is 60 seconds.</P>
1359
1360
1361 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Limit">Limit (Location)</A></H2>
1362
1363 <H3>Examples</H3>
1364
1365 <PRE CLASS="command">
1366 &lt;Location /path&gt;
1367   &lt;Limit GET POST&gt;
1368   ...
1369   &lt;/Limit&gt;
1370
1371   &lt;Limit ALL&gt;
1372   ...
1373   &lt;/Limit&gt;
1374 &lt;/Location&gt;
1375 </PRE>
1376
1377 <H3>Description</H3>
1378
1379 <P>The <CODE>Limit</CODE> directive groups access control
1380 directives for specific types of HTTP requests and must appear
1381 inside a <A HREF="#Location"><CODE>Location</CODE></A> section.
1382 Access can be limited for individual request types
1383 (<CODE>DELETE</CODE>, <CODE>GET</CODE>, <CODE>HEAD</CODE>,
1384 <CODE>OPTIONS</CODE>, <CODE>POST</CODE>, <CODE>PUT</CODE>, and
1385 <CODE>TRACE</CODE>) or for all request types (<CODE>ALL</CODE>).
1386 The request type names are case-sensitive for compatibility with
1387 Apache.</P>
1388
1389
1390 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="LimitIPP">Limit (Policy)</A></H2>
1391
1392 <H3>Examples</H3>
1393
1394 <PRE CLASS="command">
1395 &lt;Policy name&gt;
1396   &lt;Limit CUPS-Add-Modify-Printer CUPS-Delete-Printer&gt;
1397   ...
1398   &lt;/Limit&gt;
1399
1400   &lt;Limit All&gt;
1401   ...
1402   &lt;/Limit&gt;
1403 &lt;/Policy&gt;
1404 </PRE>
1405
1406 <H3>Description</H3>
1407
1408 <P>When included in <A HREF="#Policy"><CODE>Policy</CODE></A>
1409 sections, the <CODE>Limit</CODE> directive groups access control
1410 directives for specific IPP operations. Multiple operations can
1411 be listed, separated by spaces. Table 2 lists the supported
1412 operations.</P>
1413
1414 <DIV CLASS="table"><TABLE SUMMARY="Supported IPP Operations">
1415 <CAPTION>Table 2: <A NAME="TABLE2">Supported IPP Operations</A></CAPTION>
1416 <THEAD>
1417 <TR>
1418         <TH>Operation Name</TH>
1419         <TH>Description</TH>
1420 </TR>
1421 </THEAD>
1422 <TBODY>
1423 <TR>
1424         <TD>All</TD>
1425         <TD>All operations - used as the default limit for
1426         operations that are not listed</TD>
1427 </TR>
1428 <TR>
1429         <TD>Cancel-Job</TD>
1430         <TD>Cancel a job</TD>
1431 </TR>
1432 <TR>
1433         <TD>Cancel-Subscription</TD>
1434         <TD>Cancel a subscription</TD>
1435 </TR>
1436 <TR>
1437         <TD>Create-Job</TD>
1438         <TD>Create a new, empty job</TD>
1439 </TR>
1440 <TR>
1441         <TD>Create-Job-Subscription</TD>
1442         <TD>Creates a notification subscription on a job</TD>
1443 </TR>
1444 <TR>
1445         <TD>Create-Printer-Subscription</TD>
1446         <TD>Creates a notification subscription on a printer</TD>
1447 </TR>
1448 <TR>
1449         <TD>CUPS-Accept-Jobs</TD>
1450         <TD>Sets the printer-is-accepting-jobs value for a printer to true</TD>
1451 </TR>
1452 <TR>
1453         <TD>CUPS-Add-Modify-Class</TD>
1454         <TD>Adds or modifies a class</TD>
1455 </TR>
1456 <TR>
1457         <TD>CUPS-Add-Modify-Printer</TD>
1458         <TD>Adds or modifies a printer</TD>
1459 </TR>
1460 <TR>
1461         <TD>CUPS-Authenticate-Job</TD>
1462         <TD>Authenticates a job for printing</TD>
1463 </TR>
1464 <TR>
1465         <TD>CUPS-Delete-Class</TD>
1466         <TD>Deletes a class</TD>
1467 </TR>
1468 <TR>
1469         <TD>CUPS-Delete-Printer</TD>
1470         <TD>Deletes a printer</TD>
1471 </TR>
1472 <TR>
1473         <TD>CUPS-Get-Classes</TD>
1474         <TD>Gets a list of classes</TD>
1475 </TR>
1476 <TR>
1477         <TD>CUPS-Get-Default</TD>
1478         <TD>Gets the (network/server) default printer or class</TD>
1479 </TR>
1480 <TR>
1481         <TD>CUPS-Get-Devices</TD>
1482         <TD>Gets a list of available devices</TD>
1483 </TR>
1484 <TR>
1485         <TD>CUPS-Get-PPDs</TD>
1486         <TD>Gets a list of available manufacturers or drivers</TD>
1487 </TR>
1488 <TR>
1489         <TD>CUPS-Get-Printers</TD>
1490         <TD>Gets a list of printers and/or classes</TD>
1491 </TR>
1492 <TR>
1493         <TD>CUPS-Move-Job</TD>
1494         <TD>Moves a job to a new destination</TD>
1495 </TR>
1496 <TR>
1497         <TD>CUPS-Reject-Jobs</TD>
1498         <TD>Sets the printer-is-accepting-jobs value for a printer to false</TD>
1499 </TR>
1500 <TR>
1501         <TD>CUPS-Set-Default</TD>
1502         <TD>Sets the network/server default printer or class</TD>
1503 </TR>
1504 <TR>
1505         <TD>Disable-Printer</TD>
1506         <TD>Sets the printer-state value for a printer to stopped</TD>
1507 </TR>
1508 <TR>
1509         <TD>Enable-Printer</TD>
1510         <TD>Sets the printer-state value for a printer to idle/processing</TD>
1511 </TR>
1512 <TR>
1513         <TD>Get-Job-Attributes</TD>
1514         <TD>Gets information about a job</TD>
1515 </TR>
1516 <TR>
1517         <TD>Get-Jobs</TD>
1518         <TD>Gets a list of jobs</TD>
1519 </TR>
1520 <TR>
1521         <TD>Get-Notifications</TD>
1522         <TD>Gets a list of events</TD>
1523 </TR>
1524 <TR>
1525         <TD>Get-Printer-Attributes</TD>
1526         <TD>Gets informaion about a printer or class</TD>
1527 </TR>
1528 <TR>
1529         <TD>Get-Subscription-Attributes</TD>
1530         <TD>Gets informaion about a notification subscription</TD>
1531 </TR>
1532 <TR>
1533         <TD>Get-Subscriptions</TD>
1534         <TD>Gets a list of notification subscriptions</TD>
1535 </TR>
1536 <TR>
1537         <TD>Hold-Job</TD>
1538         <TD>Holds a job for printing</TD>
1539 </TR>
1540 <TR>
1541         <TD>Pause-Printer</TD>
1542         <TD>Sets the printer-state value for a printer to stopped</TD>
1543 </TR>
1544 <TR>
1545         <TD>Print-Job</TD>
1546         <TD>Creates a job with a single file for printing</TD>
1547 </TR>
1548 <TR>
1549         <TD>Purge-Jobs</TD>
1550         <TD>Removes all jobs from a printer</TD>
1551 </TR>
1552 <TR>
1553         <TD>Release-Job</TD>
1554         <TD>Releases a previously held job for printing</TD>
1555 </TR>
1556 <TR>
1557         <TD>Renew-Subscription</TD>
1558         <TD>Renews a notification subscription</TD>
1559 </TR>
1560 <TR>
1561         <TD>Restart-Job</TD>
1562         <TD>Reprints a job</TD>
1563 </TR>
1564 <TR>
1565         <TD>Resume-Printer</TD>
1566         <TD>Sets the printer-stae value for a printer to idle/processing</TD>
1567 </TR>
1568 <TR>
1569         <TD>Send-Document</TD>
1570         <TD>Adds a file to an job created with Create-Job</TD>
1571 </TR>
1572 <TR>
1573         <TD>Set-Job-Attributes</TD>
1574         <TD>Changes job options</TD>
1575 </TR>
1576 <TR>
1577         <TD>Validate-Job</TD>
1578         <TD>Validates job options prior to printing</TD>
1579 </TR>
1580 </TBODY>
1581 </TABLE></DIV>
1582
1583
1584 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="LimitExcept">LimitExcept</A></H2>
1585
1586 <H3>Examples</H3>
1587
1588 <PRE CLASS="command">
1589 &lt;Location /path&gt;
1590   &lt;LimitExcept GET POST&gt;
1591   ...
1592   &lt;/LimitExcept&gt;
1593 &lt;/Location&gt;
1594 </PRE>
1595
1596 <H3>Description</H3>
1597
1598 <P>The <CODE>LimitExcept</CODE> directive groups access control
1599 directives for specific types of HTTP requests and must appear
1600 inside a <A HREF="#Location"><CODE>Location</CODE></A> section.
1601 Unlike the <A HREF="#Limit"><CODE>Limit</CODE></A> directive,
1602 <CODE>LimitExcept</CODE> restricts access for all requests
1603 <I>except</I> those listed on the <CODE>LimitExcept</CODE>
1604 line.</P>
1605
1606
1607 <H2 CLASS="title"><A NAME="LimitRequestBody">LimitRequestBody</A></H2>
1608
1609 <H3>Examples</H3>
1610
1611 <PRE CLASS="command">
1612 LimitRequestBody 10485760
1613 LimitRequestBody 10m
1614 LimitRequestBody 0
1615 </PRE>
1616
1617 <H3>Description</H3>
1618
1619 <P>The <CODE>LimitRequestBody</CODE> directive controls the
1620 maximum size of print files, IPP requests, and HTML form data in
1621 HTTP POST requests. The default limit is 0 which disables the
1622 limit check.</P>
1623
1624
1625 <H2 CLASS="title"><A NAME="Listen">Listen</A></H2>
1626
1627 <H3>Examples</H3>
1628
1629 <PRE CLASS="command">
1630 Listen 127.0.0.1:631
1631 Listen 192.0.2.1:631
1632 Listen [::1]:631
1633 Listen *:631
1634 </PRE>
1635
1636 <H3>Description</H3>
1637
1638 <P>The <CODE>Listen</CODE> directive specifies a network address
1639 and port to listen for connections. Multiple <CODE>Listen</CODE>
1640 directives can be provided to listen on multiple addresses.</P>
1641
1642 <P>The <CODE>Listen</CODE> directive is similar to the <A
1643 HREF="#Port"><CODE>Port</CODE></A> directive but allows you to
1644 restrict access to specific interfaces or networks.</P>
1645
1646
1647 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="ListenBackLog">ListenBackLog</A></H2>
1648
1649 <H3>Examples</H3>
1650
1651 <PRE CLASS="command">
1652 ListenBackLog 5
1653 ListenBackLog 10
1654 </PRE>
1655
1656 <H3>Description</H3>
1657
1658 <P>The <CODE>ListenBackLog</CODE> directive sets the maximum
1659 number of pending connections the scheduler will allow. This
1660 normally only affects very busy servers that have reached the <A
1661 HREF="#MaxClients"><CODE>MaxClients</CODE></A> limit, but can
1662 also be triggered by large numbers of simultaneous connections.
1663 When the limit is reached, the operating system will refuse
1664 additional connections until the scheduler can accept the pending
1665 ones. The default is the OS-defined default limit, typically
1666 either 5 for older operating systems or 128 for newer operating
1667 systems.</P>
1668
1669
1670 <H2 CLASS="title"><A NAME="Location">Location</A></H2>
1671
1672 <H3>Examples</H3>
1673
1674 <PRE CLASS="command">
1675 &lt;Location /&gt;
1676 ...
1677 &lt;/Location&gt;
1678
1679 &lt;Location /admin&gt;
1680 ...
1681 &lt;/Location&gt;
1682
1683 &lt;Location /admin/conf&gt;
1684 ...
1685 &lt;/Location&gt;
1686
1687 &lt;Location /admin/log&gt;
1688 ...
1689 &lt;/Location&gt;
1690
1691 &lt;Location /classes&gt;
1692 ...
1693 &lt;/Location&gt;
1694
1695 &lt;Location /classes/name&gt;
1696 ...
1697 &lt;/Location&gt;
1698
1699 &lt;Location /jobs&gt;
1700 ...
1701 &lt;/Location&gt;
1702
1703 &lt;Location /printers&gt;
1704 ...
1705 &lt;/Location&gt;
1706
1707 &lt;Location /printers/name&gt;
1708 ...
1709 &lt;/Location&gt;
1710
1711 </PRE>
1712
1713 <H3>Description</H3>
1714
1715 <P>The <CODE>Location</CODE> directive specifies access control
1716 and authentication options for the specified HTTP resource or
1717 path.  The  <A HREF="#Allow"><CODE>Allow</CODE></A>,  <A
1718 HREF="#AuthType"><CODE>AuthType</CODE></A>,  <A
1719 HREF="#Deny"><CODE>Deny</CODE></A>,  <A
1720 HREF="#Encryption"><CODE>Encryption</CODE></A>,  <A
1721 HREF="#Limit"><CODE>Limit</CODE></A>,  <A
1722 HREF="#LimitExcept"><CODE>LimitExcept</CODE></A>,  <A
1723 HREF="#Order"><CODE>Order</CODE></A>,  <A
1724 HREF="#Require"><CODE>Require</CODE></A>, and <A
1725 HREF="#Satisfy"><CODE>Satisfy</CODE></A> directives may all
1726 appear inside a location.</P>
1727
1728 <P>Note that more specific resources override the less specific
1729 ones. So the directives inside the <CODE>/printers/name</CODE>
1730 location will override ones from <CODE>/printers</CODE>.
1731 Directives inside <CODE>/printers</CODE> will override ones from
1732 <CODE>/</CODE>. None of the directives are inherited.</P>
1733
1734 <DIV CLASS="table"><TABLE SUMMARY="Common Locaions on the Server">
1735 <CAPTION>Table 3: <A NAME="TABLE3">Common Locations on the Server</A></CAPTION>
1736 <THEAD>
1737 <TR><TH>Location</TH><TH>Description</TH></TR>
1738 </THEAD>
1739 <TBODY>
1740 <TR><TD><CODE>/</CODE></TD><TD>The path for all get operations (get-printers, get-jobs, etc.)</TD></TR>
1741 <TR><TD><CODE>/admin</CODE></TD><TD>The path for all administration operations (add-printer, delete-printer, start-printer, etc.)</TD></TR>
1742 <TR><TD><CODE>/admin/conf</CODE></TD><TD>The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.)</TD></TR>
1743 <TR><TD><CODE>/admin/log</CODE></TD><TD>The path for access to the CUPS log files (access_log, error_log, page_log)</TD></TR>
1744 <TR><TD><CODE>/classes</CODE></TD><TD>The path for all classes</TD></TR>
1745 <TR><TD><CODE>/classes/name</CODE></TD><TD>The resource for class <CODE>name</CODE></TD></TR>
1746 <TR><TD><CODE>/jobs</CODE></TD><TD>The path for all jobs (hold-job, release-job, etc.)</TD></TR>
1747 <TR><TD><CODE>/jobs/id</CODE></TD><TD>The resource for job <CODE>id</CODE></TD></TR>
1748 <TR><TD><CODE>/printers</CODE></TD><TD>The path for all printers</TD></TR>
1749 <TR><TD><CODE>/printers/name</CODE></TD><TD>The path for printer <CODE>name</CODE></TD></TR>
1750 <TR><TD><CODE>/printers/name.ppd</CODE></TD><TD>The PPD file path for printer <CODE>name</CODE></TD></TR>
1751 </TBODY>
1752 </TABLE></DIV>
1753
1754
1755 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.15</SPAN><A NAME="LogFilePerm">LogFilePerm</A></H2>
1756
1757 <H3>Examples</H3>
1758
1759 <PRE CLASS="command">
1760 LogFilePerm 0644
1761 LogFilePerm 0600
1762 </PRE>
1763
1764 <H3>Description</H3>
1765
1766 <P>The <CODE>LogFilePerm</CODE> directive specifies the
1767 permissions to use when writing configuration files. The default
1768 is 0644.</P>
1769
1770
1771 <H2 CLASS="title"><A NAME="LogLevel">LogLevel</A></H2>
1772
1773 <H3>Examples</H3>
1774
1775 <PRE CLASS="command">
1776 LogLevel none
1777 LogLevel emerg
1778 LogLevel alert
1779 LogLevel crit
1780 LogLevel error
1781 LogLevel warn
1782 LogLevel notice
1783 LogLevel info
1784 LogLevel debug
1785 LogLevel debug2
1786 </PRE>
1787
1788 <H3>Description</H3>
1789
1790 <P>The <CODE>LogLevel</CODE> directive specifies the level of
1791 logging for the <A HREF="#ErrorLog"><CODE>ErrorLog</CODE></A>
1792 file. The following values are recognized (each level logs
1793 everything under the preceding levels):</P>
1794
1795 <UL>
1796
1797         <LI><CODE>none</CODE> - Log nothing</LI>
1798
1799         <LI><CODE>emerg</CODE> - Log emergency conditions that
1800         prevent the server from running</LI>
1801
1802         <LI><CODE>alert</CODE> - Log alerts that must be handled
1803         immediately</LI>
1804
1805         <LI><CODE>crit</CODE> - Log critical errors that don't
1806         prevent the server from running</LI>
1807
1808         <LI><CODE>error</CODE> - Log general errors</LI>
1809
1810         <LI><CODE>warn</CODE> - Log errors and warnings</LI>
1811
1812         <LI><CODE>notice</CODE> - Log temporary error conditions</LI>
1813
1814         <LI><CODE>info</CODE> - Log all requests and state
1815         changes (default)</LI>
1816
1817         <LI><CODE>debug</CODE> - Log basic debugging
1818         information</LI>
1819
1820         <LI><CODE>debug2</CODE> - Log all debugging
1821         information</LI>
1822
1823 </UL>
1824
1825
1826 <H2 CLASS="title"><A NAME="MaxClients">MaxClients</A></H2>
1827
1828 <H3>Examples</H3>
1829
1830 <PRE CLASS="command">
1831 MaxClients 100
1832 MaxClients 1024
1833 </PRE>
1834
1835 <H3>Description</H3>
1836
1837 <P>The <CODE>MaxClients</CODE> directive controls the maximum
1838 number of simultaneous clients that will be allowed by the
1839 server. The default is 100 clients.</P>
1840
1841 <BLOCKQUOTE><B>Note:</B>
1842
1843 <P>Since each print job requires a file descriptor for the status
1844 pipe, the scheduler internally limits the <CODE>MaxClients</CODE>
1845 value to 1/3 of the available file descriptors to avoid possible
1846 problems when printing large numbers of jobs.</P>
1847
1848 </BLOCKQUOTE>
1849
1850
1851 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.18</SPAN><A NAME="MaxClientsPerHost">MaxClientsPerHost</A></H2>
1852
1853 <H3>Examples</H3>
1854
1855 <PRE CLASS="command">
1856 MaxClientsPerHost 10
1857 </PRE>
1858
1859 <H3>Description</H3>
1860
1861 <P>The <CODE>MaxClientsPerHost</CODE> directive controls the
1862 maximum number of simultaneous clients that will be allowed from
1863 a single host by the server. The default is the
1864 <CODE>MaxClients</CODE> value.</P>
1865
1866 <P>This directive provides a small measure of protection against
1867 Denial of Service attacks from a single host.</P>
1868
1869
1870 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.16</SPAN><A NAME="MaxCopies">MaxCopies</A></H2>
1871
1872 <H3>Examples</H3>
1873
1874 <PRE CLASS="command">
1875 MaxCopies 100
1876 MaxCopies 65535
1877 </PRE>
1878
1879 <H3>Description</H3>
1880
1881 <P>The <CODE>MaxCopies</CODE> directive controls the maximum
1882 number of copies that a user can print of a job. The default is
1883 100 copies.</P>
1884
1885 <BLOCKQUOTE><B>Note:</B>
1886
1887 <P>Most HP PCL laser printers internally limit the number of
1888 copies to 100.</P>
1889
1890 </BLOCKQUOTE>
1891
1892
1893
1894 <H2 CLASS="title"><A NAME="MaxJobs">MaxJobs</A></H2>
1895
1896 <H3>Examples</H3>
1897
1898 <PRE CLASS="command">
1899 MaxJobs 100
1900 MaxJobs 9999
1901 MaxJobs 0
1902 </PRE>
1903
1904 <H3>Description</H3>
1905
1906 <P>The <CODE>MaxJobs</CODE> directive controls the maximum number
1907 of jobs that are kept in memory. Once the number of jobs reaches
1908 the limit, the oldest completed job is automatically purged from
1909 the system to make room for the new one. If all of the known jobs
1910 are still pending or active then the new job will be
1911 rejected.</P>
1912
1913 <P>Setting the maximum size to 0 disables this functionality. The
1914 default setting is 500.</P>
1915
1916
1917 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="MaxJobsPerPrinter">MaxJobsPerPrinter</A></H2>
1918
1919 <H3>Examples</H3>
1920
1921 <PRE CLASS="command">
1922 MaxJobsPerPrinter 100
1923 MaxJobsPerPrinter 9999
1924 MaxJobsPerPrinter 0
1925 </PRE>
1926
1927 <H3>Description</H3>
1928
1929 <P>The <CODE>MaxJobsPerPrinter</CODE> directive controls the
1930 maximum number of active jobs that are allowed for each printer
1931 or class. Once a printer or class reaches the limit, new jobs
1932 will be rejected until one of the active jobs is completed,
1933 stopped, aborted, or canceled.</P>
1934
1935 <P>Setting the maximum to 0 disables this functionality. The
1936 default setting is 0.</P>
1937
1938
1939 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="MaxJobsPerUser">MaxJobsPerUser</A></H2>
1940
1941 <H3>Examples</H3>
1942
1943 <PRE CLASS="command">
1944 MaxJobsPerUser 100
1945 MaxJobsPerUser 9999
1946 MaxJobsPerUser 0
1947 </PRE>
1948
1949 <H3>Description</H3>
1950
1951 <P>The <CODE>MaxJobsPerUser</CODE> directive controls the maximum
1952 number of active jobs that are allowed for each user. Once a user
1953 reaches the limit, new jobs will be rejected until one of the
1954 active jobs is completed, stopped, aborted, or canceled.</P>
1955
1956 <P>Setting the maximum to 0 disables this functionality. The
1957 default setting is 0.</P>
1958
1959
1960 <H2 CLASS="title"><A NAME="MaxLogSize">MaxLogSize</A></H2>
1961
1962 <H3>Examples</H3>
1963
1964 <PRE CLASS="command">
1965 MaxLogSize 1048576
1966 MaxLogSize 1m
1967 MaxLogSize 0
1968 </PRE>
1969
1970 <H3>Description</H3>
1971
1972 <P>The <CODE>MaxLogSize</CODE> directive controls the maximum
1973 size of each log file. Once a log file reaches or exceeds the
1974 maximum size it is closed and renamed to <VAR>filename.O</VAR>.
1975 This allows you to rotate the logs automatically. The default
1976 size is 1048576 bytes (1MB).</P>
1977
1978 <P>Setting the maximum size to 0 disables log rotation.</P>
1979
1980
1981 <H2 CLASS="title"><SPAN CLASS="info">Deprecated</SPAN><A NAME="MaxRequestSize">MaxRequestSize</A></H2>
1982
1983 <H3>Examples</H3>
1984
1985 <PRE CLASS="command">
1986 MaxRequestSize 10485760
1987 MaxRequestSize 10m
1988 MaxRequestSize 0
1989 </PRE>
1990
1991 <H3>Description</H3>
1992
1993 <P>The <CODE>MaxRequestSize</CODE> directive controls the maximum
1994 size of print files, IPP requests, and HTML form data in HTTP
1995 POST requests. The default limit is 0 which disables the limit
1996 check.</P>
1997
1998 <P><B>This directive is deprecated and will be removed in a
1999 future CUPS release.</B> Use the <A
2000 HREF="#LimitRequestBody"><CODE>LimitRequestBody</CODE></A>
2001 directive instead.</P>
2002
2003
2004 <H2 CLASS="title"><A NAME="Order">Order</A></H2>
2005
2006 <H3>Examples</H3>
2007
2008 <PRE CLASS="command">
2009 &lt;Location /path&gt;
2010   ...
2011   Order Allow,Deny
2012   Order Deny,Allow
2013 &lt;/Location&gt;
2014 </PRE>
2015
2016 <H3>Description</H3>
2017
2018 <P>The <CODE>Order</CODE> directive defines the default access
2019 control. The following values are supported:</P>
2020
2021 <UL>
2022
2023         <LI><CODE>allow,deny</CODE> - Deny requests by default,
2024         then check the <A HREF="#Allow"><CODE>Allow</CODE></A>
2025         lines followed by the <A
2026         HREF="#Deny"><CODE>Deny</CODE></A> lines</LI>
2027
2028         <LI><CODE>deny,allow</CODE> - Allow requests by default,
2029         then check the <A HREF="#Deny"><CODE>Deny</CODE></A>
2030         lines followed by the <A
2031         HREF="#Allow"><CODE>Allow</CODE></A> lines</LI>
2032
2033 </UL>
2034
2035 <P>The <CODE>Order</CODE> directive must appear inside a <A
2036 HREF="#Location"><CODE>Location</CODE></A> or <A
2037 HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
2038
2039
2040 <H2 CLASS="title"><A NAME="PageLog">PageLog</A></H2>
2041
2042 <H3>Examples</H3>
2043
2044 <PRE CLASS="command">
2045 PageLog /var/log/cups/page_log
2046 PageLog /var/log/cups/page_log-%s
2047 PageLog syslog
2048 </PRE>
2049
2050 <H3>Description</H3>
2051
2052 <P>The <CODE>PageLog</CODE> directive sets the name of the page
2053 log file. If the filename is not absolute then it is assumed to
2054 be relative to the <A
2055 HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The
2056 default page log file is <VAR>/var/log/cups/page_log</VAR>.</P>
2057
2058 <P>The server name can be included in the filename by using
2059 <CODE>%s</CODE> in the name.</P>
2060
2061 <P>The special name "syslog" can be used to send the page
2062 information to the system log instead of a plain file.</P>
2063
2064
2065 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="PassEnv">PassEnv</A></H2>
2066
2067 <H3>Examples</H3>
2068
2069 <PRE CLASS="command">
2070 PassEnv MY_ENV_VARIABLE
2071 </PRE>
2072
2073 <H3>Description</H3>
2074
2075 <P>The <CODE>PassEnv</CODE> directive specifies an environment
2076 variable that should be passed to child processes. Normally, the
2077 scheduler only passes the <CODE>DYLD_LIBRARY_PATH</CODE>,
2078 <CODE>LD_ASSUME_KERNEL</CODE>, <CODE>LD_LIBRARY_PATH</CODE>,
2079 <CODE>LD_PRELOAD</CODE>, <CODE>NLSPATH</CODE>,
2080 <CODE>SHLIB_PATH</CODE>, <CODE>TZ</CODE>, and <CODE>VGARGS</CODE>
2081 environment variables to child processes.</P>
2082
2083
2084 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Policy">Policy</A></H2>
2085
2086 <H3>Examples</H3>
2087
2088 <PRE CLASS="command">
2089 &lt;Policy name&gt;
2090   &lt;Limit operation ... operation&gt;
2091   ...
2092   &lt;/Limit&gt;
2093   &lt;Limit operation ... operation&gt;
2094   ...
2095   &lt;/Limit&gt;
2096   &lt;Limit All&gt;
2097   ...
2098   &lt;/Limit&gt;
2099 &lt;/Policy&gt;
2100 </PRE>
2101
2102 <H3>Description</H3>
2103
2104 <P>The <CODE>Policy</CODE> directive specifies IPP operation
2105 access control limits. Each policy contains 1 or more <A
2106 HREF="#LimitIPP"><CODE>Limit</CODE></A> sections to set the
2107 access control limits for specific operations - user limits,
2108 authentication, encryption, and allowed/denied addresses,
2109 domains, or hosts. The <CODE>&lt;Limit All&gt;</CODE> section
2110 specifies the default access control limits for operations that
2111 are not listed.</P>
2112
2113 <P>Policies are named and associated with printers via the
2114 printer's operation policy setting
2115 (<CODE>printer-op-policy</CODE>). The default policy for the
2116 scheduler is specified using the <A
2117 HREF="#DefaultPolicy"><CODE>DefaultPolicy</CODE></A>
2118 directive.</P>
2119
2120
2121 <H2 CLASS="title"><A NAME="Port">Port</A></H2>
2122
2123 <H3>Examples</H3>
2124
2125 <PRE CLASS="command">
2126 Port 631
2127 Port 80
2128 </PRE>
2129
2130 <H3>Description</H3>
2131
2132 <P>The <CODE>Port</CODE> directive specifies a port to listen on.
2133 Multiple <CODE>Port</CODE> lines can be specified to listen on
2134 multiple ports. The <CODE>Port</CODE> directive is equivalent to
2135 "<CODE>Listen *:nnn</CODE>". The default port is 631.</P>
2136
2137 <BLOCKQUOTE><B>Note:</B>
2138
2139 <P>On systems that support IPv6, this directive will bind to both
2140 the IPv4 and IPv6 wildcard address.</P>
2141
2142 </BLOCKQUOTE>
2143
2144
2145 <H2 CLASS="title"><A NAME="PreserveJobHistory">PreserveJobHistory</A></H2>
2146
2147 <H3>Examples</H3>
2148
2149 <PRE CLASS="command">
2150 PreserveJobHistory On
2151 PreserveJobHistory Off
2152 </PRE>
2153
2154 <H3>Description</H3>
2155
2156 <P>The <CODE>PreserveJobHistory</CODE> directive controls whether
2157 the history of completed, canceled, or aborted print jobs is
2158 stored on disk.</P>
2159
2160 <P>A value of <CODE>On</CODE> (the default) preserves job
2161 information until the administrator purges it with the
2162 <CODE>cancel</CODE> command.</P>
2163
2164 <P>A value of <CODE>Off</CODE> removes the job information as
2165 soon as each job is completed, canceled, or aborted.</P>
2166
2167
2168 <H2 CLASS="title"><A NAME="PreserveJobFiles">PreserveJobFiles</A></H2>
2169
2170 <H3>Examples</H3>
2171
2172 <PRE CLASS="command">
2173 PreserveJobFiles On
2174 PreserveJobFiles Off
2175 </PRE>
2176
2177 <H3>Description</H3>
2178
2179 <P>The <CODE>PreserveJobFiles</CODE> directive controls whether
2180 the document files of completed, canceled, or aborted print jobs
2181 are stored on disk.</P>
2182
2183 <P>A value of <CODE>On</CODE> preserves job files until the
2184 administrator purges them with the <CODE>cancel</CODE> command.
2185 Jobs can be restarted (and reprinted) as desired until they are
2186 purged.</P>
2187
2188 <P>A value of <CODE>Off</CODE> (the default) removes the job
2189 files as soon as each job is completed, canceled, or aborted.</P>
2190
2191
2192 <H2 CLASS="title"><A NAME="Printcap">Printcap</A></H2>
2193
2194 <H3>Examples</H3>
2195
2196 <PRE CLASS="command">
2197 Printcap
2198 Printcap /etc/printcap
2199 Printcap /etc/printers.conf
2200 </PRE>
2201
2202 <H3>Description</H3>
2203
2204 <P>The <CODE>Printcap</CODE> directive controls whether or not a
2205 printcap file is automatically generated and updated with a list
2206 of available printers. If specified with no value, then no
2207 printcap file will be generated. The default is to generate a
2208 file named <VAR>/etc/printcap</VAR>.</P>
2209
2210 <P>When a filename is specified (e.g. <VAR>/etc/printcap</VAR>),
2211 the printcap file is written whenever a printer is added or
2212 removed. The printcap file can then be used by applications that
2213 are hardcoded to look at the printcap file for the available
2214 printers.</P>
2215
2216
2217 <H2 CLASS="title"><A NAME="PrintcapFormat">PrintcapFormat</A></H2>
2218
2219 <H3>Examples</H3>
2220
2221 <PRE CLASS="command">
2222 PrintcapFormat BSD
2223 PrintcapFormat Solaris
2224 </PRE>
2225
2226 <H3>Description</H3>
2227
2228 <P>The <CODE>PrintcapFormat</CODE> directive controls the output
2229 format of the printcap file. The default is to generate a BSD
2230 printcap file.</P>
2231
2232
2233 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.13</SPAN><A NAME="PrintcapGUI">PrintcapGUI</A></H2>
2234
2235 <H3>Examples</H3>
2236
2237 <PRE CLASS="command">
2238 PrintGUI /usr/bin/glpoptions
2239 </PRE>
2240
2241 <H3>Description</H3>
2242
2243 <P>The <CODE>PrintcapGUI</CODE> directive sets the program to
2244 associate with the IRIX printer GUI interface script which is
2245 used by IRIX applications to display printer-specific options.
2246 There is no default program.</P>
2247
2248
2249 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.21</SPAN><A NAME="ReloadTimeout">ReloadTimeout</A></H2>
2250
2251 <H3>Examples</H3>
2252
2253 <PRE CLASS="command">
2254 ReloadTimeout 0
2255 ReloadTimeout 60
2256 </PRE>
2257
2258 <H3>Description</H3>
2259
2260 <P>The <CODE>ReloadTimeout</CODE> directive specifies the number
2261 of seconds the scheduler will wait for active jobs to complete
2262 before doing a restart. The default is 60 seconds.</P>
2263
2264
2265 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.3</SPAN><A NAME="RemoteRoot">RemoteRoot</A></H2>
2266
2267 <H3>Examples</H3>
2268
2269 <PRE CLASS="command">
2270 RemoteRoot remroot
2271 RemoteRoot root
2272 </PRE>
2273
2274 <H3>Description</H3>
2275
2276 <P>The <CODE>RemoteRoot</CODE> directive sets the username for
2277 unauthenticated root requests from remote hosts. The default
2278 username is <VAR>remroot</VAR>. Setting <CODE>RemoteRoot</CODE>
2279 to <VAR>root</VAR> effectively disables this security
2280 mechanism.</P>
2281
2282
2283 <H2 CLASS="title"><A NAME="RequestRoot">RequestRoot</A></H2>
2284
2285 <H3>Examples</H3>
2286
2287 <PRE CLASS="command">
2288 RequestRoot /var/spool/cups
2289 RequestRoot /foo/bar/spool/cups
2290 </PRE>
2291
2292 <H3>Description</H3>
2293
2294 <P>The <CODE>RequestRoot</CODE> directive sets the directory for
2295 incoming IPP requests and HTML forms. If an absolute path is not
2296 provided then it is assumed to be relative to the <A
2297 HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The
2298 default request directory is <VAR>/var/spool/cups</VAR>.</P>
2299
2300
2301 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Require">Require</A></H2>
2302
2303 <H3>Examples</H3>
2304
2305 <PRE CLASS="command">
2306 &lt;Location /path&gt;
2307   ...
2308   Require group foo bar
2309   Require user john mary
2310   Require valid-user
2311   Require user @groupname
2312   Require user @SYSTEM
2313   Require user @OWNER
2314 &lt;/Location&gt;
2315 </PRE>
2316
2317 <H3>Description</H3>
2318
2319 <P>The <CODE>Require</CODE> directive specifies that
2320 authentication is required for the resource. The
2321 <CODE>group</CODE> keyword specifies that the authenticated user
2322 must be a member of one or more of the named groups that
2323 follow.</P>
2324
2325 <P>The <CODE>user</CODE> keyboard specifies that the
2326 authenticated user must be one of the named users or groups that
2327 follow. Group names are specified using the "@" prefix.</P>
2328
2329 <P>The <CODE>valid-user</CODE> keyword specifies that any
2330 authenticated user may access the resource.</P>
2331
2332 <P>The default is to do no authentication. This directive must
2333 appear inside a <A HREF="#Location"><CODE>Location</CODE></A> or
2334 <A HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
2335
2336
2337 <H2 CLASS="title"><A NAME="RIPCache">RIPCache</A></H2>
2338
2339 <H3>Examples</H3>
2340
2341 <PRE CLASS="command">
2342 RIPCache 8m
2343 RIPCache 1g
2344 RIPCache 2048k
2345 </PRE>
2346
2347 <H3>Description</H3>
2348
2349 <P>The <CODE>RIPCache</CODE> directive sets the size of the
2350 memory cache used by Raster Image Processor ("RIP") filters such
2351 as <CODE>imagetoraster</CODE> and <CODE>pstoraster</CODE>. The
2352 size can be suffixed with a "k" for kilobytes, "m" for megabytes,
2353 or "g" for gigabytes. The default cache size is "8m", or 8
2354 megabytes.</P>
2355
2356
2357 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.16</SPAN><A NAME="RootCertDuration">RootCertDuration</A></H2>
2358
2359 <H3>Examples</H3>
2360
2361 <PRE CLASS="command">
2362 RootCertDuration 0
2363 RootCertDuration 300
2364 </PRE>
2365
2366 <H3>Description</H3>
2367
2368 <P>The <CODE>RootCertDuration</CODE> directive specifies the
2369 number of seconds the <EM>root certificate</EM> remains valid.
2370 The scheduler will generate a new certificate as needed when the
2371 number of seconds has expired. If set to 0, the root certificate
2372 is generated only once on startup or on a restart. The default is
2373 300 seconds.</P>
2374
2375
2376 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Satisfy">Satisfy</A></H2>
2377
2378 <H3>Examples</H3>
2379
2380 <PRE CLASS="command">
2381 &lt;Location /path&gt;
2382   ...
2383   Satisfy all
2384   Satisfy any
2385 &lt;/Location&gt;
2386 </PRE>
2387
2388 <H3>Description</H3>
2389
2390 <P>The <CODE>Satisfy</CODE> directive specifies whether all
2391 conditions must be satisfied to allow access to the resource. If
2392 set to <CODE>all</CODE>, then all authentication and access
2393 control conditions must be satified to allow access.</P>
2394
2395 <P>Setting <CODE>Satisfy</CODE> to <CODE>any</CODE> allows a user
2396 to gain access if the authentication or access control
2397 requirements are satisfied. For example, you might require
2398 authentication for remote access, but allow local access without
2399 authentication.</P>
2400
2401 <P>The default is <CODE>all</CODE>. This directive must appear
2402 inside a <A HREF="#Location"><CODE>Location</CODE></A> or <A
2403 HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
2404
2405
2406 <H2 CLASS="title"><A NAME="ServerAdmin">ServerAdmin</A></H2>
2407
2408 <H3>Examples</H3>
2409
2410 <PRE CLASS="command">
2411 ServerAdmin user@host
2412 ServerAdmin root@foo.bar.com
2413 </PRE>
2414
2415 <H3>Description</H3>
2416
2417 <P>The <CODE>ServerAdmin</CODE> directive identifies the email
2418 address for the administrator on the system. By default the
2419 administrator email address is <CODE>root@server</CODE>, where
2420 <CODE>server</CODE> is the <A
2421 HREF="#ServerName"><CODE>ServerName</CODE></A>.</P>
2422
2423
2424 <H2 CLASS="title"><A NAME="ServerBin">ServerBin</A></H2>
2425
2426 <H3>Examples</H3>
2427
2428 <PRE CLASS="command">
2429 ServerBin /usr/lib/cups
2430 ServerBin /foo/bar/lib/cups
2431 </PRE>
2432
2433 <H3>Description</H3>
2434
2435 <P>The <CODE>ServerBin</CODE> directive sets the directory for
2436 server-run executables. If an absolute path is not provided then
2437 it is assumed to be relative to the <A
2438 HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The
2439 default executable directory is <VAR>/usr/lib/cups</VAR>,
2440 <VAR>/usr/lib32/cups</VAR>, or <VAR>/usr/libexec/cups</VAR>
2441 depending on the operating system.</P>
2442
2443
2444 <H2 CLASS="title"><A NAME="ServerCertificate">ServerCertificate</A></H2>
2445
2446 <H3>Examples</H3>
2447
2448 <PRE CLASS="command">
2449 ServerCertificate /etc/cups/ssl/server.crt
2450 </PRE>
2451
2452 <H3>Description</H3>
2453
2454 <P>The <CODE>ServerCertificate</CODE> directive specifies the
2455 location of the SSL certificate file used by the server when
2456 negotiating encrypted connections. The certificate must not be
2457 encrypted (password protected) since the scheduler normally runs
2458 in the background and will be unable to ask for a password.</P>
2459
2460 <P>The default certificate file is
2461 <VAR>/etc/cups/ssl/server.crt</VAR>.</P>
2462
2463
2464 <H2 CLASS="title"><A NAME="ServerKey">ServerKey</A></H2>
2465
2466 <H3>Examples</H3>
2467
2468 <PRE CLASS="command">
2469 ServerKey /etc/cups/ssl/server.key
2470 </PRE>
2471
2472 <H3>Description</H3>
2473
2474 <P>The <CODE>ServerKey</CODE> directive specifies the location of
2475 the SSL private key file used by the server when negotiating
2476 encrypted connections.</P>
2477
2478 <P>The default key file is
2479 <VAR>/etc/cups/ssl/server.crt</VAR>.</P>
2480
2481
2482 <H2 CLASS="title"><A NAME="ServerName"></A>ServerName</H2>
2483
2484 <H3>Examples</H3>
2485
2486 <PRE CLASS="command">
2487 ServerName foo.domain.com
2488 ServerName myserver.domain.com
2489 </PRE>
2490
2491 <H3>Description</H3>
2492
2493 <P>The <CODE>ServerName</CODE> directive specifies the hostname
2494 that is reported to clients. By default the server name is the
2495 hostname.</P>
2496
2497
2498 <H2 CLASS="title"><A NAME="ServerRoot">ServerRoot</A></H2>
2499
2500 <H3>Examples</H3>
2501
2502 <PRE CLASS="command">
2503 ServerRoot /etc/cups
2504 ServerRoot /foo/bar/cups
2505 </PRE>
2506
2507 <H3>Description</H3>
2508
2509 <P>The <CODE>ServerRoot</CODE> directive specifies the absolute
2510 path to the server configuration and state files. It is also used
2511 to resolve relative paths in the <VAR>cupsd.conf</VAR> file. The
2512 default server directory is <VAR>/etc/cups</VAR>.</P>
2513
2514
2515 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.21</SPAN><A NAME="ServerTokens">ServerTokens</A></H2>
2516
2517 <H3>Examples</H3>
2518
2519 <PRE CLASS="command">
2520 ServerTokens None
2521 ServerTokens ProductOnly
2522 ServerTokens Major
2523 ServerTokens Minor
2524 ServerTokens Minimal
2525 ServerTokens OS
2526 ServerTokens Full
2527 </PRE>
2528
2529 <H3>Description</H3>
2530
2531 <P>The <CODE>ServerTokens</CODE> directive specifies the
2532 information that is included in the <CODE>Server:</CODE> header
2533 of all HTTP responses. Table 4 lists the token name along with
2534 the text that is returned. The default is
2535 <CODE>Minimal</CODE>.</P>
2536
2537 <DIV CLASS="table"><TABLE SUMMARY="ServerToken Names and Values">
2538 <CAPTION>Table 4: <A NAME="TABLE4">ServerToken Names and Values</A></CAPTION>
2539 <THEAD>
2540 <TR>
2541         <TH>Name</TH>
2542         <TH>Value</TH>
2543 </TR>
2544 </THEAD>
2545 <TBODY>
2546 <TR>
2547         <TD>None</TD>
2548         <TD>No <CODE>Server:</CODE> header is returned</TD>
2549 </TR>
2550 <TR>
2551         <TD>ProductOnly</TD>
2552         <TD>"CUPS"</TD>
2553 </TR>
2554 <TR>
2555         <TD>Major</TD>
2556         <TD>"CUPS 1"</TD>
2557 </TR>
2558 <TR>
2559         <TD>Minor</TD>
2560         <TD>"CUPS 1.2"</TD>
2561 </TR>
2562 <TR>
2563         <TD>Minimal</TD>
2564         <TD>"CUPS 1.2.N" where N is the patch release</TD>
2565 </TR>
2566 <TR>
2567         <TD>OS</TD>
2568         <TD>"CUPS 1.2.N (UNAME)" where N is the patch release and
2569         UNAME is the output of the <B>uname(1)</B> command</TD>
2570 </TR>
2571 <TR>
2572         <TD>Full</TD>
2573         <TD>"CUPS 1.2.N (UNAME) IPP/1.1" where N is the patch
2574         release and UNAME is the output of the <B>uname(1)</B>
2575         command</TD>
2576 </TR>
2577 </TBODY>
2578 </TABLE></DIV>
2579
2580
2581 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="SetEnv">SetEnv</A></H2>
2582
2583 <H3>Examples</H3>
2584
2585 <PRE CLASS="command">
2586 SetEnv PATH /usr/lib/cups/filter:/bin:/usr/bin:/usr/local/bin
2587 SetEnv MY_ENV_VAR foo
2588 </PRE>
2589
2590 <H3>Description</H3>
2591
2592 <P>The <CODE>SetEnv</CODE> directive specifies an environment
2593 variable that should be passed to child processes.</P>
2594
2595
2596 <H2 CLASS="title"><A NAME="SSLListen">SSLListen</A></H2>
2597
2598 <H3>Examples</H3>
2599
2600 <PRE CLASS="command">
2601 SSLListen 127.0.0.1:443
2602 SSLListen 192.0.2.1:443
2603 </PRE>
2604
2605 <H3>Description</H3>
2606
2607 <P>The <CODE>SSLListen</CODE> directive specifies a network
2608 address and port to listen for secure connections. Multiple
2609 <CODE>SSLListen</CODE> directives can be provided to listen on
2610 multiple addresses.</P>
2611
2612 <P>The <CODE>SSLListen</CODE> directive is similar to the <A
2613 HREF="#SSLPort"><CODE>SSLPort</CODE></A> directive but allows you
2614 to restrict access to specific interfaces or networks.</P>
2615
2616
2617 <H2 CLASS="title"><A NAME="SSLPort">SSLPort</A></H2>
2618
2619 <H3>Examples</H3>
2620
2621 <PRE CLASS="command">
2622 SSLPort 443
2623 </PRE>
2624
2625 <H3>Description</H3>
2626
2627 <P>The <CODE>SSLPort</CODE> directive specifies a port to listen
2628 on for secure connections. Multiple <CODE>SSLPort</CODE> lines
2629 can be specified to listen on multiple ports.</P>
2630
2631
2632 <H2 CLASS="title"><A NAME="SystemGroup">SystemGroup</A></H2>
2633
2634 <H3>Examples</H3>
2635
2636 <PRE CLASS="command">
2637 SystemGroup lpadmin
2638 SystemGroup sys
2639 SystemGroup system
2640 SystemGroup root
2641 SystemGroup root lpadmin
2642 </PRE>
2643
2644 <H3>Description</H3>
2645
2646 <P>The <CODE>SystemGroup</CODE> directive specifies the system
2647 administration group for <CODE>System</CODE> authentication.
2648 Multiple groups can be listed, separated with spaces. The default
2649 is system-dependent and generally consists of all of the
2650 following groups, if present: <CODE>lpadmin</CODE>,
2651 <CODE>root</CODE>, <CODE>sys</CODE>, and/or
2652 <CODE>system</CODE>.</P>
2653
2654
2655 <H2 CLASS="title"><A NAME="TempDir">TempDir</A></H2>
2656
2657 <H3>Examples</H3>
2658
2659 <PRE CLASS="command">
2660 TempDir /var/tmp
2661 TempDir /foo/bar/tmp
2662 </PRE>
2663
2664 <H3>Description</H3>
2665
2666 <P>The <CODE>TempDir</CODE> directive specifies an absolute path
2667 for the directory to use for temporary files. The default
2668 directory is <VAR>/var/spool/cups/tmp</VAR>.</P>
2669
2670 <P>Temporary directories must be world-writable and should have
2671 the "sticky" permission bit enabled so that other users cannot
2672 delete filter temporary files. The following commands will create
2673 an appropriate temporary directory called
2674 <VAR>/foo/bar/tmp</VAR>:</P>
2675
2676 <PRE CLASS="command">
2677 <KBD>mkdir /foo/bar/tmp</KBD>
2678 <KBD>chmod a+rwxt /foo/bar/tmp</KBD>
2679 </PRE>
2680
2681
2682 <H2 CLASS="title"><A NAME="Timeout">Timeout</A></H2>
2683
2684 <H3>Examples</H3>
2685
2686 <PRE CLASS="command">
2687 Timeout 300
2688 Timeout 90
2689 </PRE>
2690
2691 <H3>Description</H3>
2692
2693 <P>The <CODE>Timeout</CODE> directive controls the amount of time
2694 to wait before an active HTTP or IPP request times out. The
2695 default timeout is 300 seconds.</P>
2696
2697
2698 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="UseNetworkDefault">UseNetworkDefault</A></H2>
2699
2700 <H3>Examples</H3>
2701
2702 <PRE CLASS="command">
2703 UseNetworkDefault yes
2704 UseNetworkDefault no
2705 </PRE>
2706
2707 <H3>Description</H3>
2708
2709 <P>The <CODE>UseNetworkDefault</CODE> directive controls whether
2710 the client will use a network/remote printer as a default
2711 printer. If enabled, the default printer of a server is used as
2712 the default printer on a client. When multiple servers are
2713 advertising a default printer, the client's default printer is
2714 set to the first discovered printer, or to the implicit class for
2715 the same printer available from multiple servers.</P>
2716
2717 <P>The default is <CODE>yes</CODE>.</P>
2718
2719
2720 <H2 CLASS="title"><A NAME="User">User</A></H2>
2721
2722 <H3>Examples</H3>
2723
2724 <PRE CLASS="command">
2725 User lp
2726 User guest
2727 </PRE>
2728
2729 <H3>Description</H3>
2730
2731 <P>The <CODE>User</CODE> directive specifies the UNIX user that
2732 filter and CGI programs run as. The default user is
2733 <CODE>lp</CODE>.</P>
2734
2735 <BLOCKQUOTE><B>Note:</B>
2736
2737 <P>You may not use user <CODE>root</CODE>, as that would expose
2738 the system to unacceptable security risks. The scheduler will
2739 automatically choose user <CODE>nobody</CODE> if you specify a
2740 user whose ID is 0.</P>
2741
2742 </BLOCKQUOTE>
2743
2744
2745 </BODY>
2746 </HTML>