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