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