doc/help/ref-cupsd-conf.html

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