doc/help/ref-cupsd-conf.html.in

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