doc/help/ref-cupsd-conf.html

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