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

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