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

   1 <HTML>
   2 <!-- SECTION: References -->
   3 <HEAD>
   4         <TITLE>cupsd.conf</TITLE>
   5         <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
   6 </HEAD>
   7 <BODY>
   8
   9 <H1 CLASS="title">cupsd.conf</H1>
  10
  11 <P>The <VAR>/etc/cups/cupsd.conf</VAR> file contains
  12 configuration <I>directives</I> that control how the server
  13 functions. Each directive is listed on a line by itself followed
  14 by its value. Comments are introduced using the number sign ("#")
  15 character at the beginning of a line.</P>
  16
  17 <P>Since the server configuration file consists of plain text,
  18 you can use your favorite text editor to make changes to it.
  19 After making any changes, restart the <CODE>cupsd(8)</CODE>
  20 process using the startup script for your operating system:</P>
  21
  22 <UL>
  23
  24         <LI>Linux, Solaris:
  25         <PRE CLASS="command">
  26 /etc/init.d/cups restart
  27         </PRE></LI>
  28
  29         <LI>OS X:
  30         <PRE CLASS="command">
  31 sudo launchctl unload /System/Library/LaunchDaemons/org.cups.cupsd.plist
  32 sudo launchctl load /System/Library/LaunchDaemons/org.cups.cupsd.plist
  33         </PRE></LI>
  34
  35 </UL>
  36
  37 <P>You can also edit this file from the CUPS web interface, which
  38 automatically handles restarting the scheduler.</P>
  39
  40 <BLOCKQUOTE><B>Note:</B>
  41
  42 <P>The specification of time units ("w" for weeks, "h" for hours, etc.) in the various time interval directives is new in CUPS 1.6/OS X 10.8. Prior releases of CUPS only supported time intervals in seconds.</P>
  43
  44 </BLOCKQUOTE>
  45
  46
  47 <H2 CLASS="title"><A NAME="AccessLogLevel">AccessLogLevel</A></H2>
  48
  49 <H3>Examples</H3>
  50
  51 <PRE CLASS="command">
  52 AccessLogLevel config
  53 AccessLogLevel actions
  54 AccessLogLevel all
  55 AccessLogLevel none
  56 </PRE>
  57
  58 <H3>Description</H3>
  59
  60 <P>The <CODE>AccessLogLevel</CODE> directive controls which requests are logged
  61 to the access log file. The following levels are defined:</P>
  62
  63 <UL>
  64
  65         <LI><CODE>config</CODE>; Log when printers and classes are added,
  66         deleted, or modified and when configuration files are accessed or
  67         updated.</LI>
  68
  69         <LI><CODE>actions</CODE>; Log when print jobs are submitted,
  70         held, released, modified, or canceled, and any of the conditions
  71         for <CODE>config</CODE>.</LI>
  72
  73         <LI><CODE>all</CODE>; Log all requests.</LI>
  74
  75         <LI><CODE>none</CODE>; Log no requests.</LI>
  76
  77 </UL>
  78
  79 <P>The default access log level is <CODE>@CUPS_ACCESS_LOG_LEVEL@</CODE>.</P>
  80
  81
  82 <H2 CLASS="title"><A NAME="Allow">Allow</A></H2>
  83
  84 <H3>Examples</H3>
  85
  86 <PRE CLASS="command">
  87 &lt;Location /path&gt;
  88   ...
  89   Allow from All
  90   Allow from None
  91   Allow from *.example.com
  92   Allow from .example.com
  93   Allow from host.example.com
  94   Allow from nnn.*
  95   Allow from nnn.nnn.*
  96   Allow from nnn.nnn.nnn.*
  97   Allow from nnn.nnn.nnn.nnn
  98   Allow from nnn.nnn.nnn.nnn/mm
  99   Allow from nnn.nnn.nnn.nnn/mmm.mmm.mmm.mmm
 100   Allow from [xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]
 101   Allow from [xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]/mmm
 102   Allow from @LOCAL
 103   Allow from @IF(name)
 104 &lt;/Location&gt;
 105 </PRE>
 106
 107 <H3>Description</H3>
 108
 109 <P>The <CODE>Allow</CODE> directive specifies a hostname, IP
 110 address, or network that is allowed access to the server.
 111 <CODE>Allow</CODE> directives are cumulative, so multiple
 112 <CODE>Allow</CODE> directives can be used to allow access for
 113 multiple hosts or networks.</P>
 114
 115 <P>Host and domain name matching require that you enable the <A
 116 HREF="#HostNameLookups"><CODE>HostNameLookups</CODE></A>
 117 directive.</P>
 118
 119 <P>The <CODE>/mm</CODE> notation specifies a CIDR netmask, as shown in
 120 <A HREF="#TABLE1">Table 1</A>.</P>
 121
 122 <DIV CLASS="table"><TABLE SUMMARY="CIDR Netmasks">
 123 <CAPTION>Table 1: <A NAME="TABLE1">CIDR Netmasks</A></CAPTION>
 124 <TR>
 125         <TH WIDTH="10%">mm</TH>
 126         <TH WIDTH="20%">netmask</TH>
 127         <TH WIDTH="10%">mm</TH>
 128         <TH WIDTH="20%">netmask</TH>
 129 </TR>
 130 <TR>
 131         <TD ALIGN="CENTER">0</TD>
 132         <TD ALIGN="CENTER">0.0.0.0</TD>
 133         <TD ALIGN="CENTER">8</TD>
 134         <TD ALIGN="CENTER">255.0.0.0</TD>
 135 </TR>
 136 <TR>
 137         <TD ALIGN="CENTER">1</TD>
 138         <TD ALIGN="CENTER">128.0.0.0</TD>
 139         <TD ALIGN="CENTER">16</TD>
 140         <TD ALIGN="CENTER">255.255.0.0</TD>
 141 </TR>
 142 <TR>
 143         <TD ALIGN="CENTER">2</TD>
 144         <TD ALIGN="CENTER">192.0.0.0</TD>
 145         <TD ALIGN="CENTER">24</TD>
 146         <TD ALIGN="CENTER">255.255.255.0</TD>
 147 </TR>
 148 <TR>
 149         <TD ALIGN="CENTER">...</TD>
 150         <TD ALIGN="CENTER">...</TD>
 151         <TD ALIGN="CENTER">32</TD>
 152         <TD ALIGN="CENTER">255.255.255.255</TD>
 153 </TR>
 154 </TABLE></DIV>
 155
 156 <P>The <CODE>@LOCAL</CODE> name will allow access from all local
 157 interfaces. The <CODE>@IF(name)</CODE> name will allow access
 158 from the named interface. In both cases, CUPS only allows access
 159 from the network that the interface(s) are configured for -
 160 requests  arriving on the interface from a foreign network will
 161 <em>not</em> be accepted.</P>
 162
 163 <P>The <CODE>Allow</CODE> directive must appear inside a <A
 164 HREF="#Location"><CODE>Location</CODE></A> or <A
 165 HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
 166
 167
 168 <H2 CLASS="title"><A NAME="AuthType">AuthType</A></H2>
 169
 170 <H3>Examples</H3>
 171
 172 <PRE CLASS="command">
 173 &lt;Location /path&gt;
 174   ...
 175   AuthType None
 176   AuthType Basic
 177   AuthType Digest
 178   AuthType BasicDigest
 179   AuthType Negotiate
 180 &lt;/Location&gt;
 181 </PRE>
 182
 183 <H3>Description</H3>
 184
 185 <P>The <CODE>AuthType</CODE> directive defines the type of
 186 authentication to perform:</P>
 187
 188 <UL>
 189
 190         <LI><CODE>None</CODE> - No authentication should be
 191         performed (default)</LI>
 192
 193         <LI><CODE>Basic</CODE> - Basic authentication should be
 194         performed using the UNIX password and group files</LI>
 195
 196         <LI><CODE>Digest</CODE> - Digest authentication should be
 197         performed using the <VAR>/etc/cups/passwd.md5</VAR>
 198         file</LI>
 199
 200         <LI><CODE>BasicDigest</CODE> - Basic authentication
 201         should be performed using the
 202         <VAR>/etc/cups/passwd.md5</VAR> file</LI>
 203
 204         <LI><CODE>Negotiate</CODE> - Kerberos authentication
 205         should be performed</LI>
 206
 207 </UL>
 208
 209 <P>When using <CODE>Basic</CODE>, <CODE>Digest</CODE>,
 210 <CODE>BasicDigest</CODE>, or <CODE>Negotiate</CODE> authentication,
 211 clients connecting through the <CODE>localhost</CODE> interface can
 212 also authenticate using certificates.</P>
 213
 214 <P>The <CODE>AuthType</CODE> directive must appear inside a <A
 215 HREF="#Location"><CODE>Location</CODE></A> or <A
 216 HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
 217
 218
 219 <H2 CLASS="title"><A NAME="AutoPurgeJobs">AutoPurgeJobs</A></H2>
 220
 221 <H3>Examples</H3>
 222
 223 <PRE CLASS="command">
 224 AutoPurgeJobs Yes
 225 AutoPurgeJobs No
 226 </PRE>
 227
 228 <H3>Description</H3>
 229
 230 <P>The <CODE>AutoPurgeJobs</CODE> directive specifies whether or
 231 not to purge completed jobs once they are no longer required for
 232 quotas. This option has no effect if quotas are not enabled. The
 233 default setting is <CODE>No</CODE>.</P>
 234
 235
 236 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="BrowseLocalProtocols">BrowseLocalProtocols</A></H2>
 237
 238 <H3>Examples</H3>
 239
 240 <PRE CLASS="command">
 241 BrowseLocalProtocols all
 242 BrowseLocalProtocols none
 243 BrowseLocalProtocols dnssd
 244 </PRE>
 245
 246 <H3>Description</H3>
 247
 248 <P>The <CODE>BrowseLocalProtocols</CODE> directive specifies the protocols to use when advertising local shared printers on the network. Multiple protocols can be specified by separating them with spaces. The default is "<CODE>dnssd</CODE>" on systems that support Bonjour and "<CODE>none</CODE>" on all others.</P>
 249
 250
 251 <H2 CLASS="title"><A NAME="BrowseWebIF">BrowseWebIF</A></H2>
 252
 253 <H3>Examples</H3>
 254
 255 <PRE CLASS="command">
 256 BrowseWebIF On
 257 BrowseWebIF Off
 258 </PRE>
 259
 260 <H3>Description</H3>
 261
 262 <P>The <CODE>BrowseWebIF</CODE> directive controls whether the CUPS web
 263 interface is advertised via DNS-SD. The default setting is
 264 <CODE>Off</CODE>.</P>
 265
 266
 267 <H2 CLASS="title"><A NAME="Browsing">Browsing</A></H2>
 268
 269 <H3>Examples</H3>
 270
 271 <PRE CLASS="command">
 272 Browsing On
 273 Browsing Off
 274 </PRE>
 275
 276 <H3>Description</H3>
 277
 278 <P>The <CODE>Browsing</CODE> directive controls whether or not printer sharing is enabled. The default setting is <CODE>On</CODE>.</P>
 279
 280
 281 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Classification">Classification</A></H2>
 282
 283 <H3>Examples</H3>
 284
 285 <PRE CLASS="command">
 286 Classification
 287 Classification classified
 288 Classification confidential
 289 Classification secret
 290 Classification topsecret
 291 Classification unclassified
 292 </PRE>
 293
 294 <H3>Description</H3>
 295
 296 <P>The <CODE>Classification</CODE> directive sets the
 297 classification level on the server. When this option is set, at
 298 least one of the banner pages is forced to the classification
 299 level, and the classification is placed on each page of output.
 300 The default is no classification level.</P>
 301
 302
 303 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.10</SPAN><A NAME="ClassifyOverride">ClassifyOverride</A></H2>
 304
 305 <H3>Examples</H3>
 306
 307 <PRE CLASS="command">
 308 ClassifyOverride Yes
 309 ClassifyOverride No
 310 </PRE>
 311
 312 <H3>Description</H3>
 313
 314 <P>The <CODE>ClassifyOverride</CODE> directive specifies whether
 315 users can override the default classification level on the
 316 server. When the server classification is set, users can change
 317 the classification using the <CODE>job-sheets</CODE> option and
 318 can choose to only print one security banner before or after the
 319 job. If the <CODE>job-sheets</CODE> option is set to
 320 <CODE>none</CODE> then the server default classification is
 321 used.</P>
 322
 323 <P>The default is to not allow classification overrides.</P>
 324
 325
 326 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="DefaultAuthType">DefaultAuthType</A></H2>
 327
 328 <H3>Examples</H3>
 329
 330 <PRE CLASS="command">
 331 DefaultAuthType Basic
 332 DefaultAuthType BasicDigest
 333 DefaultAuthType Digest
 334 DefaultAuthType Negotiate
 335 </PRE>
 336
 337 <H3>Description</H3>
 338
 339 <P>The <CODE>DefaultAuthType</CODE> directive specifies the type
 340 of authentication to use for IPP operations that require a
 341 username. The default is <CODE>Basic</CODE>.</P>
 342
 343
 344 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="DefaultEncryption">DefaultEncryption</A></H2>
 345
 346 <H3>Examples</H3>
 347
 348 <PRE CLASS="command">
 349 DefaultEncryption Never
 350 DefaultEncryption IfRequested
 351 DefaultEncryption Required
 352 </PRE>
 353
 354 <H3>Description</H3>
 355
 356 <P>The <CODE>DefaultEncryption</CODE> directive specifies the
 357 type of encryption to use when performing authentication. The
 358 default is <CODE>Required</CODE>.</P>
 359
 360
 361 <H2 CLASS="title"><A NAME="DefaultLanguage">DefaultLanguage</A></H2>
 362
 363 <H3>Examples</H3>
 364
 365 <PRE CLASS="command">
 366 DefaultLanguage de
 367 DefaultLanguage en
 368 DefaultLanguage es
 369 DefaultLanguage fr
 370 DefaultLanguage it
 371 </PRE>
 372
 373 <H3>Description</H3>
 374
 375 <P>The <CODE>DefaultLanguage</CODE> directive specifies the
 376 default language to use for client connections. Setting the
 377 default language also sets the default character set if a
 378 language localization file exists for it. The default language
 379 is "en" for English.</P>
 380
 381
 382 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/OS X 10.6</SPAN><A NAME="DefaultPaperSize">DefaultPaperSize</A></H2>
 383
 384 <H3>Examples</H3>
 385
 386 <PRE CLASS="command">
 387 DefaultPaperSize Letter
 388 DefaultPaperSize A4
 389 DefaultPaperSize Auto
 390 DefaultPaperSize None
 391 </PRE>
 392
 393 <H3>Description</H3>
 394
 395 <P>The <CODE>DefaultPaperSize</CODE> directive specifies the default paper
 396 size to use when creating new printers. The default is <CODE>Auto</CODE>
 397 which uses a paper size appropriate for the system default locale. A value
 398 of <CODE>None</CODE> tells the scheduler to not set the default paper
 399 size.</P>
 400
 401
 402 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="DefaultPolicy">DefaultPolicy</A></H2>
 403
 404 <H3>Examples</H3>
 405
 406 <PRE CLASS="command">
 407 DefaultPolicy default
 408 DefaultPolicy authenticated
 409 DefaultPolicy foo
 410 </PRE>
 411
 412 <H3>Description</H3>
 413
 414 <P>The <CODE>DefaultPolicy</CODE> directive specifies the default
 415 policy to use for IPP operation. The default is
 416 <CODE>default</CODE>. CUPS also includes a policy called
 417 <CODE>authenticated</CODE> that requires a username and password for printing
 418 and other job operations.</P>
 419
 420
 421 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="DefaultShared">DefaultShared</A></H2>
 422
 423 <H3>Examples</H3>
 424
 425 <PRE CLASS="command">
 426 DefaultShared Yes
 427 DefaultShared No
 428 </PRE>
 429
 430 <H3>Description</H3>
 431
 432 <P>The <CODE>DefaultShared</CODE> directive specifies whether printers are shared (published) by default. The default is <CODE>Yes</CODE>.</P>
 433
 434
 435 <H2 CLASS="title"><A NAME="Deny">Deny</A></H2>
 436
 437 <H3>Examples</H3>
 438
 439 <PRE CLASS="command">
 440 &lt;Location /path&gt;
 441   ..
 442   Deny from All
 443   Deny from None
 444   Deny from *.example.com
 445   Deny from .example.com
 446   Deny from host.example.com
 447   Deny from nnn.*
 448   Deny from nnn.nnn.*
 449   Deny from nnn.nnn.nnn.*
 450   Deny from nnn.nnn.nnn.nnn
 451   Deny from nnn.nnn.nnn.nnn/mm
 452   Deny from nnn.nnn.nnn.nnn/mmm.mmm.mmm.mmm
 453   Deny from [xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]
 454   Deny from [xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]/mmm
 455   Deny from @LOCAL
 456   Deny from @IF(name)
 457 &lt;/Location&gt;
 458 </PRE>
 459
 460 <H3>Description</H3>
 461
 462 <P>The <CODE>Deny</CODE> directive specifies a hostname, IP
 463 address, or network that is denied access to the server.
 464 <CODE>Deny</CODE> directives are cumulative, so multiple
 465 <CODE>Deny</CODE> directives can be used to deny access for
 466 multiple hosts or networks.</P>
 467
 468 <P>Host and domain name matching require that you enable the <A
 469 HREF="#HostNameLookups"><CODE>HostNameLookups</CODE></A>
 470 directive.</P>
 471
 472 <P>The <CODE>/mm</CODE> notation specifies a CIDR netmask, a shown in
 473 <A HREF="TABLE1">Table 1</A>.</P>
 474
 475 <P>The <CODE>@LOCAL</CODE> name will deny access from all local
 476 interfaces. The <CODE>@IF(name)</CODE> name will deny access from
 477 the named interface. In both cases, CUPS only denies access from
 478 the network that the interface(s) are configured for - requests
 479 arriving on the interface from a foreign network will
 480 <em>not</em> be denied.</P>
 481
 482 <P>The <CODE>Deny</CODE> directive must appear inside a <A
 483 HREF="#Location"><CODE>Location</CODE></A> or <A
 484 HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
 485
 486
 487 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/OS X 10.6</SPAN><A NAME="DirtyCleanInterval">DirtyCleanInterval</A></H2>
 488
 489 <H3>Examples</H3>
 490
 491 <PRE CLASS="command">
 492 DirtyCleanInterval 1w
 493 DirtyCleanInterval 1d
 494 DirtyCleanInterval 1h
 495 DirtyCleanInterval 1m
 496 DirtyCleanInterval 30
 497 DirtyCleanInterval 0
 498 </PRE>
 499
 500 <H3>Description</H3>
 501
 502 <P>The <CODE>DirtyCleanInterval</CODE> directive specifies the amount of time to wait before updating configuration and state files for printers, classes, subscriptions, and jobs in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix). A value of <CODE>0</CODE> causes the update to occur as soon as possible, typically within a few milliseconds.</P>
 503
 504 <P>The default value is <CODE>30</CODE> (30 seconds).</P>
 505
 506
 507 <H2 CLASS="title"><A NAME="Encryption">Encryption</A></H2>
 508
 509 <H3>Examples</H3>
 510
 511 <PRE CLASS="command">
 512 &lt;Location /path&gt;
 513   ...
 514   Encryption Never
 515   Encryption IfRequested
 516   Encryption Required
 517 &lt;/Location&gt;
 518 </PRE>
 519
 520 <H3>Description</H3>
 521
 522 <P>The <CODE>Encryption</CODE> directive must appear instead a <A
 523 HREF="#Location"><CODE>Location</CODE></A> or <A
 524 HREF="#Limit"><CODE>Limit</CODE></A> section and specifies the
 525 encryption settings for that location. The default setting is
 526 <CODE>IfRequested</CODE> for all locations.</P>
 527
 528
 529 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.3/OS X 10.5</SPAN><A NAME="ErrorPolicy">ErrorPolicy</A></H2>
 530
 531 <H3>Examples</H3>
 532
 533 <PRE CLASS="command">
 534 ErrorPolicy abort-job
 535 ErrorPolicy retry-job
 536 ErrorPolicy stop-printer
 537 </PRE>
 538
 539 <H3>Description</H3>
 540
 541 <P>The <CODE>ErrorPolicy</CODE> directive defines the default policy that
 542 is used when a backend is unable to send a print job to the
 543 printer.</P>
 544
 545 <P>The following values are supported:</P>
 546
 547 <UL>
 548
 549         <LI><CODE>abort-job</CODE> - Abort the job and proceed
 550         with the next job in the queue</LI>
 551
 552         <LI><CODE>retry-job</CODE> - Retry the job after waiting
 553         for N seconds; the <VAR>cupsd.conf</VAR> <A
 554         HREF="#JobRetryInterval"><CODE>JobRetryInterval</CODE></A>
 555         directive controls the value of N</LI>
 556
 557         <LI><CODE>retry-this-job</CODE> - Retry the current job immediately
 558         and indefinitely.</LI>
 559
 560         <LI><CODE>stop-printer</CODE> - Stop the printer and keep
 561         the job for future printing; this is the default
 562         value</LI>
 563
 564 </UL>
 565
 566
 567 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.3</SPAN><A NAME="FilterLimit">FilterLimit</A></H2>
 568
 569 <H3>Examples</H3>
 570
 571 <PRE CLASS="command">
 572 FilterLimit 0
 573 FilterLimit 200
 574 FilterLimit 1000
 575 </PRE>
 576
 577 <H3>Description</H3>
 578
 579 <P>The <CODE>FilterLimit</CODE> directive sets the maximum cost
 580 of all running job filters. It can be used to limit the number of
 581 filter programs that are run on a server to minimize disk,
 582 memory, and CPU resource problems. A limit of 0 disables filter
 583 limiting.</P>
 584
 585 <P>An average print to a non-PostScript printer needs a filter
 586 limit of about 200. A PostScript printer needs about half that
 587 (100). Setting the limit below these thresholds will effectively
 588 limit the scheduler to printing a single job at any time.</P>
 589
 590 <P>The default limit is 0.</P>
 591
 592
 593 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.16</SPAN><A NAME="FilterNice">FilterNice</A></H2>
 594
 595 <H3>Examples</H3>
 596
 597 <PRE CLASS="command">
 598 FilterNice 0
 599 FilterNice 10
 600 FilterNice 19
 601 </PRE>
 602
 603 <H3>Description</H3>
 604
 605 <P>The <CODE>FilterNice</CODE> directive sets the <B>nice(1)</B>
 606 value to assign to filter processes. The nice value ranges from
 607 0, the highest priority, to 19, the lowest priority. The default
 608 is 0.</P>
 609
 610
 611 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.6/OS X 10.8</SPAN><A NAME="GSSServiceName">GSSServiceName</A></H2>
 612
 613 <H3>Examples</H3>
 614
 615 <PRE CLASS="command">
 616 GSSServiceName http
 617 GSSServiceName ipp
 618 </PRE>
 619
 620 <H3>Description</H3>
 621
 622 <P>The <CODE>GSSServiceName</CODE> directive sets the Kerberos service name to use. The default is <CODE>http</CODE> for compatibility with Microsoft Windows.</P>
 623
 624
 625 <H2 CLASS="title"><A NAME="HostNameLookups">HostNameLookups</A></H2>
 626
 627 <H3>Examples</H3>
 628
 629 <PRE CLASS="command">
 630 HostNameLookups On
 631 HostNameLookups Off
 632 HostNameLookups Double
 633 </PRE>
 634
 635 <H3>Description</H3>
 636
 637 <P>The <CODE>HostNameLookups</CODE> directive controls whether or
 638 not CUPS looks up the hostname for connecting clients. The
 639 <CODE>Double</CODE> setting causes CUPS to verify that the
 640 hostname resolved from the address matches one of the addresses
 641 returned for that hostname. <CODE>Double</CODE> lookups also
 642 prevent clients with unregistered addresses from connecting to
 643 your server.</P>
 644
 645 <P>The default is <CODE>Off</CODE> to avoid the potential server
 646 performance problems with hostname lookups. Set this option to
 647 <CODE>On</CODE> or <CODE>Double</CODE> only if absolutely
 648 required.</P>
 649
 650
 651 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.9</SPAN><A NAME="Include">Include</A></H2>
 652
 653 <H3>Examples</H3>
 654
 655 <PRE CLASS="command">
 656 Include filename
 657 Include /foo/bar/filename
 658 </PRE>
 659
 660 <H3>Description</H3>
 661
 662 <P>The <CODE>Include</CODE> directive includes the named file in
 663 the <CODE>cupsd.conf</CODE> file. If no leading path is provided,
 664 the file is assumed to be relative to the <A
 665 HREF="ref-cups-files-conf.html#ServerRoot"><CODE>ServerRoot</CODE></A> directory.</P>
 666
 667
 668 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.5</SPAN><A NAME="JobPrivateAccess">JobPrivateAccess</A></H2>
 669
 670 <H3>Examples</H3>
 671
 672 <PRE CLASS="command">
 673 JobPrivateAccess all
 674 JobPrivateAccess default
 675 JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
 676 </PRE>
 677
 678 <H3>Description</H3>
 679
 680 <P>The <CODE>JobPrivateAccess</CODE> directive specifies the access list for a
 681 job's private values. The "default" access list is "@OWNER @SYSTEM". "@ACL" maps
 682 to the printer's requesting-user-name-allowed or requesting-user-name-denied
 683 values.</P>
 684
 685 <P>The <CODE>JobPrivateAccess</CODE> directive must appear inside a <A
 686 HREF="#Policy"><CODE>Policy</CODE></A> section.</P>
 687
 688
 689 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.5</SPAN><A NAME="JobPrivateValues">JobPrivateValues</A></H2>
 690
 691 <H3>Examples</H3>
 692
 693 <PRE CLASS="command">
 694 JobPrivateValues all
 695 JobPrivateValues default
 696 JobPrivateValues none
 697 JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
 698 </PRE>
 699
 700 <H3>Description</H3>
 701
 702 <P>The <CODE>JobPrivateValues</CODE> directive specifies the list of job values
 703 to make private. The "default" values are "job-name",
 704 "job-originating-host-name", "job-originating-user-name", and "phone".</P>
 705
 706 <P>The <CODE>JobPrivateValues</CODE> directive must appear inside a <A
 707 HREF="#Policy"><CODE>Policy</CODE></A> section.</P>
 708
 709
 710 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="JobRetryInterval">JobRetryInterval</A></H2>
 711
 712 <H3>Examples</H3>
 713
 714 <PRE CLASS="command">
 715 JobRetryInterval 1w
 716 JobRetryInterval 1d
 717 JobRetryInterval 1h
 718 JobRetryInterval 1m
 719 JobRetryInterval 30
 720 </PRE>
 721
 722 <H3>Description</H3>
 723
 724 <P>The <CODE>JobRetryInterval</CODE> directive specifies the amount of time to wait before retrying a job in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix). This is typically used for fax queues but can also be used with normal print queues whose error policy is <CODE>retry-job</CODE> or <CODE>retry-current-job</CODE>.</P>
 725
 726 <P>The default is <CODE>30</CODE> (30 seconds).</P>
 727
 728
 729 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/OS X 10.6</SPAN><A NAME="JobKillDelay">JobKillDelay</A></H2>
 730
 731 <H3>Examples</H3>
 732
 733 <PRE CLASS="command">
 734 JobKillDelay 1w
 735 JobKillDelay 1d
 736 JobKillDelay 1h
 737 JobKillDelay 1m
 738 JobKillDelay 30
 739 </PRE>
 740
 741 <H3>Description</H3>
 742
 743 <P>The <CODE>JobKillDelay</CODE> directive specifies the amount of time to wait before killing the filters and backend associated with a canceled or held job in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
 744
 745 <P>The default is <CODE>30</CODE> (30 seconds).</P>
 746
 747
 748 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="JobRetryLimit">JobRetryLimit</A></H2>
 749
 750 <H3>Examples</H3>
 751
 752 <PRE CLASS="command">
 753 JobRetryLimit 5
 754 JobRetryLimit 50
 755 </PRE>
 756
 757 <H3>Description</H3>
 758
 759 <P>The <CODE>JobRetryLimit</CODE> directive specifies the maximum
 760 number of times the scheduler will try to print a job. This is
 761 typically used for fax queues but can also be used with normal
 762 print queues whose error policy is <CODE>retry-job</CODE>. The
 763 default is 5 times.</P>
 764
 765
 766 <H2 CLASS="title"><A NAME="KeepAlive">KeepAlive</A></H2>
 767
 768 <H3>Examples</H3>
 769
 770 <PRE CLASS="command">
 771 KeepAlive On
 772 KeepAlive Off
 773 </PRE>
 774
 775 <H3>Description</H3>
 776
 777 <P>The <CODE>KeepAlive</CODE> directive controls whether or not
 778 to support persistent HTTP connections. The default is
 779 <CODE>On</CODE>.</P>
 780
 781 <P>HTTP/1.1 clients automatically support persistent connections,
 782 while HTTP/1.0 clients must specifically request them using the
 783 <CODE>Keep-Alive</CODE> attribute in the <CODE>Connection:</CODE>
 784 field of each request.</P>
 785
 786
 787 <H2 CLASS="title"><A NAME="KeepAliveTimeout">KeepAliveTimeout</A></H2>
 788
 789 <H3>Examples</H3>
 790
 791 <PRE CLASS="command">
 792 KeepAliveTimeout 1w
 793 KeepAliveTimeout 1d
 794 KeepAliveTimeout 1h
 795 KeepAliveTimeout 1m
 796 KeepAliveTimeout 30
 797 </PRE>
 798
 799 <H3>Description</H3>
 800
 801 <P>The <CODE>KeepAliveTimeout</CODE> directive controls how long a persistent HTTP connection will remain open after the last request in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
 802
 803 <P>The default is <CODE>30</CODE> (30 seconds).</P>
 804
 805
 806 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Limit">Limit (Location)</A></H2>
 807
 808 <H3>Examples</H3>
 809
 810 <PRE CLASS="command">
 811 &lt;Location /path&gt;
 812   &lt;Limit GET POST&gt;
 813   ...
 814   &lt;/Limit&gt;
 815
 816   &lt;Limit ALL&gt;
 817   ...
 818   &lt;/Limit&gt;
 819 &lt;/Location&gt;
 820 </PRE>
 821
 822 <H3>Description</H3>
 823
 824 <P>The <CODE>Limit</CODE> directive groups access control
 825 directives for specific types of HTTP requests and must appear
 826 inside a <A HREF="#Location"><CODE>Location</CODE></A> section.
 827 Access can be limited for individual request types
 828 (<CODE>DELETE</CODE>, <CODE>GET</CODE>, <CODE>HEAD</CODE>,
 829 <CODE>OPTIONS</CODE>, <CODE>POST</CODE>, <CODE>PUT</CODE>, and
 830 <CODE>TRACE</CODE>) or for all request types (<CODE>ALL</CODE>).
 831 The request type names are case-sensitive for compatibility with
 832 Apache.</P>
 833
 834
 835 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="LimitIPP">Limit (Policy)</A></H2>
 836
 837 <H3>Examples</H3>
 838
 839 <PRE CLASS="command">
 840 &lt;Policy name&gt;
 841   &lt;Limit CUPS-Add-Modify-Printer CUPS-Delete-Printer&gt;
 842   ...
 843   &lt;/Limit&gt;
 844
 845   &lt;Limit All&gt;
 846   ...
 847   &lt;/Limit&gt;
 848 &lt;/Policy&gt;
 849 </PRE>
 850
 851 <H3>Description</H3>
 852
 853 <P>When included in <A HREF="#Policy"><CODE>Policy</CODE></A>
 854 sections, the <CODE>Limit</CODE> directive groups access control
 855 directives for specific IPP operations. Multiple operations can
 856 be listed, separated by spaces. Table 2 lists the supported
 857 operations.</P>
 858
 859 <DIV CLASS="table"><TABLE SUMMARY="Supported IPP Operations">
 860 <CAPTION>Table 2: <A NAME="TABLE2">Supported IPP Operations</A></CAPTION>
 861 <THEAD>
 862 <TR>
 863         <TH>Operation Name</TH>
 864         <TH>Description</TH>
 865 </TR>
 866 </THEAD>
 867 <TBODY>
 868 <TR>
 869         <TD>All</TD>
 870         <TD>All operations - used as the default limit for
 871         operations that are not listed</TD>
 872 </TR>
 873 <TR>
 874         <TD>Cancel-Job</TD>
 875         <TD>Cancel a job</TD>
 876 </TR>
 877 <TR>
 878         <TD>Cancel-Subscription</TD>
 879         <TD>Cancel a subscription</TD>
 880 </TR>
 881 <TR>
 882         <TD>Create-Job</TD>
 883         <TD>Create a new, empty job</TD>
 884 </TR>
 885 <TR>
 886         <TD>Create-Job-Subscription</TD>
 887         <TD>Creates a notification subscription on a job</TD>
 888 </TR>
 889 <TR>
 890         <TD>Create-Printer-Subscription</TD>
 891         <TD>Creates a notification subscription on a printer</TD>
 892 </TR>
 893 <TR>
 894         <TD>CUPS-Accept-Jobs</TD>
 895         <TD>Sets the printer-is-accepting-jobs value for a printer to true</TD>
 896 </TR>
 897 <TR>
 898         <TD>CUPS-Add-Modify-Class</TD>
 899         <TD>Adds or modifies a class</TD>
 900 </TR>
 901 <TR>
 902         <TD>CUPS-Add-Modify-Printer</TD>
 903         <TD>Adds or modifies a printer</TD>
 904 </TR>
 905 <TR>
 906         <TD>CUPS-Authenticate-Job</TD>
 907         <TD>Authenticates a job for printing</TD>
 908 </TR>
 909 <TR>
 910         <TD>CUPS-Delete-Class</TD>
 911         <TD>Deletes a class</TD>
 912 </TR>
 913 <TR>
 914         <TD>CUPS-Delete-Printer</TD>
 915         <TD>Deletes a printer</TD>
 916 </TR>
 917 <TR>
 918         <TD>CUPS-Get-Classes</TD>
 919         <TD>Gets a list of classes</TD>
 920 </TR>
 921 <TR>
 922         <TD>CUPS-Get-Default</TD>
 923         <TD>Gets the (network/server) default printer or class</TD>
 924 </TR>
 925 <TR>
 926         <TD>CUPS-Get-Devices</TD>
 927         <TD>Gets a list of available devices</TD>
 928 </TR>
 929 <TR>
 930         <TD>CUPS-Get-PPDs</TD>
 931         <TD>Gets a list of available manufacturers or drivers</TD>
 932 </TR>
 933 <TR>
 934         <TD>CUPS-Get-Printers</TD>
 935         <TD>Gets a list of printers and/or classes</TD>
 936 </TR>
 937 <TR>
 938         <TD>CUPS-Move-Job</TD>
 939         <TD>Moves a job to a new destination</TD>
 940 </TR>
 941 <TR>
 942         <TD>CUPS-Reject-Jobs</TD>
 943         <TD>Sets the printer-is-accepting-jobs value for a printer to false</TD>
 944 </TR>
 945 <TR>
 946         <TD>CUPS-Set-Default</TD>
 947         <TD>Sets the network/server default printer or class</TD>
 948 </TR>
 949 <TR>
 950         <TD>Disable-Printer</TD>
 951         <TD>Sets the printer-state value for a printer to stopped</TD>
 952 </TR>
 953 <TR>
 954         <TD>Enable-Printer</TD>
 955         <TD>Sets the printer-state value for a printer to idle/processing</TD>
 956 </TR>
 957 <TR>
 958         <TD>Get-Job-Attributes</TD>
 959         <TD>Gets information about a job</TD>
 960 </TR>
 961 <TR>
 962         <TD>Get-Jobs</TD>
 963         <TD>Gets a list of jobs</TD>
 964 </TR>
 965 <TR>
 966         <TD>Get-Notifications</TD>
 967         <TD>Gets a list of events</TD>
 968 </TR>
 969 <TR>
 970         <TD>Get-Printer-Attributes</TD>
 971         <TD>Gets information about a printer or class</TD>
 972 </TR>
 973 <TR>
 974         <TD>Get-Subscription-Attributes</TD>
 975         <TD>Gets information about a notification subscription</TD>
 976 </TR>
 977 <TR>
 978         <TD>Get-Subscriptions</TD>
 979         <TD>Gets a list of notification subscriptions</TD>
 980 </TR>
 981 <TR>
 982         <TD>Hold-Job</TD>
 983         <TD>Holds a job for printing</TD>
 984 </TR>
 985 <TR>
 986         <TD>Pause-Printer</TD>
 987         <TD>Sets the printer-state value for a printer to stopped</TD>
 988 </TR>
 989 <TR>
 990         <TD>Print-Job</TD>
 991         <TD>Creates a job with a single file for printing</TD>
 992 </TR>
 993 <TR>
 994         <TD>Purge-Jobs</TD>
 995         <TD>Removes all jobs from a printer</TD>
 996 </TR>
 997 <TR>
 998         <TD>Release-Job</TD>
 999         <TD>Releases a previously held job for printing</TD>
1000 </TR>
1001 <TR>
1002         <TD>Renew-Subscription</TD>
1003         <TD>Renews a notification subscription</TD>
1004 </TR>
1005 <TR>
1006         <TD>Restart-Job</TD>
1007         <TD>Reprints a job</TD>
1008 </TR>
1009 <TR>
1010         <TD>Resume-Printer</TD>
1011         <TD>Sets the printer-state value for a printer to idle/processing</TD>
1012 </TR>
1013 <TR>
1014         <TD>Send-Document</TD>
1015         <TD>Adds a file to an job created with Create-Job</TD>
1016 </TR>
1017 <TR>
1018         <TD>Set-Job-Attributes</TD>
1019         <TD>Changes job options</TD>
1020 </TR>
1021 <TR>
1022         <TD>Validate-Job</TD>
1023         <TD>Validates job options prior to printing</TD>
1024 </TR>
1025 </TBODY>
1026 </TABLE></DIV>
1027
1028
1029 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="LimitExcept">LimitExcept</A></H2>
1030
1031 <H3>Examples</H3>
1032
1033 <PRE CLASS="command">
1034 &lt;Location /path&gt;
1035   &lt;LimitExcept GET POST&gt;
1036   ...
1037   &lt;/LimitExcept&gt;
1038 &lt;/Location&gt;
1039 </PRE>
1040
1041 <H3>Description</H3>
1042
1043 <P>The <CODE>LimitExcept</CODE> directive groups access control
1044 directives for specific types of HTTP requests and must appear
1045 inside a <A HREF="#Location"><CODE>Location</CODE></A> section.
1046 Unlike the <A HREF="#Limit"><CODE>Limit</CODE></A> directive,
1047 <CODE>LimitExcept</CODE> restricts access for all requests
1048 <I>except</I> those listed on the <CODE>LimitExcept</CODE>
1049 line.</P>
1050
1051
1052 <H2 CLASS="title"><A NAME="LimitRequestBody">LimitRequestBody</A></H2>
1053
1054 <H3>Examples</H3>
1055
1056 <PRE CLASS="command">
1057 LimitRequestBody 10485760
1058 LimitRequestBody 10m
1059 LimitRequestBody 0
1060 </PRE>
1061
1062 <H3>Description</H3>
1063
1064 <P>The <CODE>LimitRequestBody</CODE> directive controls the
1065 maximum size of print files, IPP requests, and HTML form data in
1066 HTTP POST requests. The default limit is 0 which disables the
1067 limit check.</P>
1068
1069
1070 <H2 CLASS="title"><A NAME="Listen">Listen</A></H2>
1071
1072 <H3>Examples</H3>
1073
1074 <PRE CLASS="command">
1075 Listen 127.0.0.1:631
1076 Listen 192.0.2.1:631
1077 Listen [::1]:631
1078 Listen *:631
1079 </PRE>
1080
1081 <H3>Description</H3>
1082
1083 <P>The <CODE>Listen</CODE> directive specifies a network address
1084 and port to listen for connections. Multiple <CODE>Listen</CODE>
1085 directives can be provided to listen on multiple addresses.</P>
1086
1087 <P>The <CODE>Listen</CODE> directive is similar to the <A
1088 HREF="#Port"><CODE>Port</CODE></A> directive but allows you to
1089 restrict access to specific interfaces or networks.</P>
1090
1091
1092 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="ListenBackLog">ListenBackLog</A></H2>
1093
1094 <H3>Examples</H3>
1095
1096 <PRE CLASS="command">
1097 ListenBackLog 5
1098 ListenBackLog 10
1099 </PRE>
1100
1101 <H3>Description</H3>
1102
1103 <P>The <CODE>ListenBackLog</CODE> directive sets the maximum
1104 number of pending connections the scheduler will allow. This
1105 normally only affects very busy servers that have reached the <A
1106 HREF="#MaxClients"><CODE>MaxClients</CODE></A> limit, but can
1107 also be triggered by large numbers of simultaneous connections.
1108 When the limit is reached, the operating system will refuse
1109 additional connections until the scheduler can accept the pending
1110 ones. The default is the OS-defined default limit, typically
1111 either 5 for older operating systems or 128 for newer operating
1112 systems.</P>
1113
1114
1115 <H2 CLASS="title"><A NAME="Location">Location</A></H2>
1116
1117 <H3>Examples</H3>
1118
1119 <PRE CLASS="command">
1120 &lt;Location /&gt;
1121 ...
1122 &lt;/Location&gt;
1123
1124 &lt;Location /admin&gt;
1125 ...
1126 &lt;/Location&gt;
1127
1128 &lt;Location /admin/conf&gt;
1129 ...
1130 &lt;/Location&gt;
1131
1132 &lt;Location /admin/log&gt;
1133 ...
1134 &lt;/Location&gt;
1135
1136 &lt;Location /classes&gt;
1137 ...
1138 &lt;/Location&gt;
1139
1140 &lt;Location /classes/name&gt;
1141 ...
1142 &lt;/Location&gt;
1143
1144 &lt;Location /jobs&gt;
1145 ...
1146 &lt;/Location&gt;
1147
1148 &lt;Location /printers&gt;
1149 ...
1150 &lt;/Location&gt;
1151
1152 &lt;Location /printers/name&gt;
1153 ...
1154 &lt;/Location&gt;
1155
1156 </PRE>
1157
1158 <H3>Description</H3>
1159
1160 <P>The <CODE>Location</CODE> directive specifies access control
1161 and authentication options for the specified HTTP resource or
1162 path.  The  <A HREF="#Allow"><CODE>Allow</CODE></A>,  <A
1163 HREF="#AuthType"><CODE>AuthType</CODE></A>,  <A
1164 HREF="#Deny"><CODE>Deny</CODE></A>,  <A
1165 HREF="#Encryption"><CODE>Encryption</CODE></A>,  <A
1166 HREF="#Limit"><CODE>Limit</CODE></A>,  <A
1167 HREF="#LimitExcept"><CODE>LimitExcept</CODE></A>,  <A
1168 HREF="#Order"><CODE>Order</CODE></A>,  <A
1169 HREF="#Require"><CODE>Require</CODE></A>, and <A
1170 HREF="#Satisfy"><CODE>Satisfy</CODE></A> directives may all
1171 appear inside a location.</P>
1172
1173 <P>Note that more specific resources override the less specific
1174 ones. So the directives inside the <CODE>/printers/name</CODE>
1175 location will override ones from <CODE>/printers</CODE>.
1176 Directives inside <CODE>/printers</CODE> will override ones from
1177 <CODE>/</CODE>. None of the directives are inherited.</P>
1178
1179 <DIV CLASS="table"><TABLE SUMMARY="Common Locations on the Server">
1180 <CAPTION>Table 3: <A NAME="TABLE3">Common Locations on the Server</A></CAPTION>
1181 <THEAD>
1182 <TR><TH>Location</TH><TH>Description</TH></TR>
1183 </THEAD>
1184 <TBODY>
1185 <TR><TD><CODE>/</CODE></TD><TD>The path for all get operations (get-printers, get-jobs, etc.)</TD></TR>
1186 <TR><TD><CODE>/admin</CODE></TD><TD>The path for all administration operations (add-printer, delete-printer, start-printer, etc.)</TD></TR>
1187 <TR><TD><CODE>/admin/conf</CODE></TD><TD>The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.)</TD></TR>
1188 <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>
1189 <TR><TD><CODE>/classes</CODE></TD><TD>The path for all classes</TD></TR>
1190 <TR><TD><CODE>/classes/name</CODE></TD><TD>The resource for class <CODE>name</CODE></TD></TR>
1191 <TR><TD><CODE>/jobs</CODE></TD><TD>The path for all jobs (hold-job, release-job, etc.)</TD></TR>
1192 <TR><TD><CODE>/jobs/id</CODE></TD><TD>The resource for job <CODE>id</CODE></TD></TR>
1193 <TR><TD><CODE>/printers</CODE></TD><TD>The path for all printers</TD></TR>
1194 <TR><TD><CODE>/printers/name</CODE></TD><TD>The path for printer <CODE>name</CODE></TD></TR>
1195 <TR><TD><CODE>/printers/name.ppd</CODE></TD><TD>The PPD file path for printer <CODE>name</CODE></TD></TR>
1196 </TBODY>
1197 </TABLE></DIV>
1198
1199
1200 <H2 CLASS="title"><A NAME="LogDebugHistory">LogDebugHistory</A></H2>
1201
1202 <H3>Examples</H3>
1203
1204 <PRE CLASS="command">
1205 LogDebugHistory 0
1206 LogDebugHistory 200
1207 </PRE>
1208
1209 <H3>Description</H3>
1210
1211 <P>When <A HREF="#LogLevel"><CODE>LogLevel</CODE></A> is not set to
1212 <CODE>debug</CODE> or <CODE>debug2</CODE>, the <CODE>LogDebugHistory</CODE>
1213 directive specifies the number of debugging messages that are logged when an
1214 error occurs during printing. The default is 200 messages. A value of 0
1215 disables debugging history entirely and is not recommended.</P>
1216
1217
1218 <H2 CLASS="title"><A NAME="LogLevel">LogLevel</A></H2>
1219
1220 <H3>Examples</H3>
1221
1222 <PRE CLASS="command">
1223 LogLevel none
1224 LogLevel emerg
1225 LogLevel alert
1226 LogLevel crit
1227 LogLevel error
1228 LogLevel warn
1229 LogLevel notice
1230 LogLevel info
1231 LogLevel debug
1232 LogLevel debug2
1233 </PRE>
1234
1235 <H3>Description</H3>
1236
1237 <P>The <CODE>LogLevel</CODE> directive specifies the level of
1238 logging for the <A HREF="ref-cups-files-conf.html#ErrorLog"><CODE>ErrorLog</CODE></A>
1239 file. The following values are recognized (each level logs
1240 everything under the preceding levels):</P>
1241
1242 <UL>
1243
1244         <LI><CODE>none</CODE> - Log nothing</LI>
1245
1246         <LI><CODE>emerg</CODE> - Log emergency conditions that
1247         prevent the server from running</LI>
1248
1249         <LI><CODE>alert</CODE> - Log alerts that must be handled
1250         immediately</LI>
1251
1252         <LI><CODE>crit</CODE> - Log critical errors that don't
1253         prevent the server from running</LI>
1254
1255         <LI><CODE>error</CODE> - Log general errors</LI>
1256
1257         <LI><CODE>warn</CODE> - Log errors and warnings</LI>
1258
1259         <LI><CODE>notice</CODE> - Log temporary error conditions</LI>
1260
1261         <LI><CODE>info</CODE> - Log all requests and state
1262         changes</LI>
1263
1264         <LI><CODE>debug</CODE> - Log basic debugging
1265         information</LI>
1266
1267         <LI><CODE>debug2</CODE> - Log all debugging
1268         information</LI>
1269
1270 </UL>
1271
1272 <p>The default <code>LogLevel</code> is <code>@CUPS_LOG_LEVEL@</code>.</p>
1273
1274
1275 <H2 CLASS="title"><A NAME="LogTimeFormat">LogTimeFormat</A></H2>
1276
1277 <H3>Examples</H3>
1278
1279 <PRE CLASS="command">
1280 LogTimeFormat standard
1281 LogTimeFormat usecs
1282 </PRE>
1283
1284 <H3>Description</H3>
1285
1286 <P>The <CODE>LogTimeFormat</CODE> directive specifies the format used for the
1287 date and time in the log files. <CODE>Standard</CODE> uses the standard Apache
1288 Common Log Format date and time while <CODE>usecs</CODE> adds microseconds.
1289 The default is <CODE>standard</CODE>.</P>
1290
1291
1292 <H2 CLASS="title"><A NAME="MaxClients">MaxClients</A></H2>
1293
1294 <H3>Examples</H3>
1295
1296 <PRE CLASS="command">
1297 MaxClients 100
1298 MaxClients 1024
1299 </PRE>
1300
1301 <H3>Description</H3>
1302
1303 <P>The <CODE>MaxClients</CODE> directive controls the maximum
1304 number of simultaneous clients that will be allowed by the
1305 server. The default is 100 clients.</P>
1306
1307 <BLOCKQUOTE><B>Note:</B>
1308
1309 <P>Since each print job requires a file descriptor for the status
1310 pipe, the scheduler internally limits the <CODE>MaxClients</CODE>
1311 value to 1/3 of the available file descriptors to avoid possible
1312 problems when printing large numbers of jobs.</P>
1313
1314 </BLOCKQUOTE>
1315
1316
1317 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.18</SPAN><A NAME="MaxClientsPerHost">MaxClientsPerHost</A></H2>
1318
1319 <H3>Examples</H3>
1320
1321 <PRE CLASS="command">
1322 MaxClientsPerHost 10
1323 </PRE>
1324
1325 <H3>Description</H3>
1326
1327 <P>The <CODE>MaxClientsPerHost</CODE> directive controls the
1328 maximum number of simultaneous clients that will be allowed from
1329 a single host by the server. The default is the
1330 <CODE>MaxClients</CODE> value.</P>
1331
1332 <P>This directive provides a small measure of protection against
1333 Denial of Service attacks from a single host.</P>
1334
1335
1336 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.16</SPAN><A NAME="MaxCopies">MaxCopies</A></H2>
1337
1338 <H3>Examples</H3>
1339
1340 <PRE CLASS="command">
1341 MaxCopies 100
1342 MaxCopies 65535
1343 </PRE>
1344
1345 <H3>Description</H3>
1346
1347 <P>The <CODE>MaxCopies</CODE> directive controls the maximum
1348 number of copies that a user can print of a job. The default is
1349 @CUPS_MAX_COPIES@ copies.</P>
1350
1351 <BLOCKQUOTE><B>Note:</B>
1352
1353 <P>Most HP PCL laser printers internally limit the number of
1354 copies to 100.</P>
1355
1356 </BLOCKQUOTE>
1357
1358
1359 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.6/OS X 10.8</SPAN><A NAME="MaxHoldTime">MaxHoldTime</A></H2>
1360
1361 <H3>Examples</H3>
1362
1363 <PRE CLASS="command">
1364 MaxHoldTime 10800
1365 MaxHoldTime 3h
1366 MaxHoldTime 180m
1367 MaxHoldTime 0
1368 </PRE>
1369
1370 <H3>Description</H3>
1371
1372 <P>The <CODE>MaxHoldTime</CODE> directive controls the maximum number of seconds allowed for a job to remain in the "indefinite" hold state. The job is canceled automatically if it remains held indefinitely longer than the specified time interval in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
1373
1374 <p>The default setting is <CODE>0</CODE> which disables this functionality.</P>
1375
1376
1377 <H2 CLASS="title"><A NAME="MaxJobs">MaxJobs</A></H2>
1378
1379 <H3>Examples</H3>
1380
1381 <PRE CLASS="command">
1382 MaxJobs 100
1383 MaxJobs 9999
1384 MaxJobs 0
1385 </PRE>
1386
1387 <H3>Description</H3>
1388
1389 <P>The <CODE>MaxJobs</CODE> directive controls the maximum number
1390 of jobs that are kept in memory. Once the number of jobs reaches
1391 the limit, the oldest completed job is automatically purged from
1392 the system to make room for the new one. If all of the known jobs
1393 are still pending or active then the new job will be
1394 rejected.</P>
1395
1396 <P>Setting the maximum size to 0 disables this functionality. The
1397 default setting is 500.</P>
1398
1399
1400 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="MaxJobsPerPrinter">MaxJobsPerPrinter</A></H2>
1401
1402 <H3>Examples</H3>
1403
1404 <PRE CLASS="command">
1405 MaxJobsPerPrinter 100
1406 MaxJobsPerPrinter 9999
1407 MaxJobsPerPrinter 0
1408 </PRE>
1409
1410 <H3>Description</H3>
1411
1412 <P>The <CODE>MaxJobsPerPrinter</CODE> directive controls the
1413 maximum number of active jobs that are allowed for each printer
1414 or class. Once a printer or class reaches the limit, new jobs
1415 will be rejected until one of the active jobs is completed,
1416 stopped, aborted, or canceled.</P>
1417
1418 <P>Setting the maximum to 0 disables this functionality. The
1419 default setting is 0.</P>
1420
1421
1422 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="MaxJobsPerUser">MaxJobsPerUser</A></H2>
1423
1424 <H3>Examples</H3>
1425
1426 <PRE CLASS="command">
1427 MaxJobsPerUser 100
1428 MaxJobsPerUser 9999
1429 MaxJobsPerUser 0
1430 </PRE>
1431
1432 <H3>Description</H3>
1433
1434 <P>The <CODE>MaxJobsPerUser</CODE> directive controls the maximum
1435 number of active jobs that are allowed for each user. Once a user
1436 reaches the limit, new jobs will be rejected until one of the
1437 active jobs is completed, stopped, aborted, or canceled.</P>
1438
1439 <P>Setting the maximum to 0 disables this functionality. The
1440 default setting is 0.</P>
1441
1442
1443 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.6/OS X 10.8</SPAN><A NAME="MaxJobTime">MaxJobTime</A></H2>
1444
1445 <H3>Examples</H3>
1446
1447 <PRE CLASS="command">
1448 MaxJobTime 10800
1449 MaxJobTime 3h
1450 MaxJobTime 180m
1451 MaxJobTime 0
1452 </PRE>
1453
1454 <H3>Description</H3>
1455
1456 <P>The <CODE>MaxJobTime</CODE> directive controls the maximum number of
1457 seconds allowed for a job to complete printing before it is considered "stuck".
1458 The job is canceled automatically if it takes longer than the specified time to complete in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
1459
1460 <p>Setting the maximum time to <CODE>0</CODE> disables this functionality. The default setting is <CODE>3h</CODE> (3 hours).</P>
1461
1462
1463 <H2 CLASS="title"><A NAME="MaxLogSize">MaxLogSize</A></H2>
1464
1465 <H3>Examples</H3>
1466
1467 <PRE CLASS="command">
1468 MaxLogSize 1048576
1469 MaxLogSize 1m
1470 MaxLogSize 0
1471 </PRE>
1472
1473 <H3>Description</H3>
1474
1475 <P>The <CODE>MaxLogSize</CODE> directive controls the maximum
1476 size of each log file. Once a log file reaches or exceeds the
1477 maximum size it is closed and renamed to <VAR>filename.O</VAR>.
1478 This allows you to rotate the logs automatically. The default
1479 size is 1048576 bytes (1MB).</P>
1480
1481 <P>Setting the maximum size to 0 disables log rotation.</P>
1482
1483
1484 <H2 CLASS="title"><SPAN CLASS="info">Deprecated</SPAN><A NAME="MaxRequestSize">MaxRequestSize</A></H2>
1485
1486 <H3>Examples</H3>
1487
1488 <PRE CLASS="command">
1489 MaxRequestSize 10485760
1490 MaxRequestSize 10m
1491 MaxRequestSize 0
1492 </PRE>
1493
1494 <H3>Description</H3>
1495
1496 <P>The <CODE>MaxRequestSize</CODE> directive controls the maximum
1497 size of print files, IPP requests, and HTML form data in HTTP
1498 POST requests. The default limit is 0 which disables the limit
1499 check.</P>
1500
1501 <P><B>This directive is deprecated and will be removed in a
1502 future CUPS release.</B> Use the <A
1503 HREF="#LimitRequestBody"><CODE>LimitRequestBody</CODE></A>
1504 directive instead.</P>
1505
1506
1507 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/OS X 10.6</SPAN><A NAME="MultipleOperationTimeout">MultipleOperationTimeout</A></H2>
1508
1509 <H3>Examples</H3>
1510
1511 <PRE CLASS="command">
1512 MultipleOperationTimeout 1w
1513 MultipleOperationTimeout 1d
1514 MultipleOperationTimeout 1h
1515 MultipleOperationTimeout 5m
1516 MultipleOperationTimeout 300
1517 </PRE>
1518
1519 <H3>Description</H3>
1520
1521 <P>The <CODE>MultipleOperationTimeout</CODE> directive sets the maximum amount of time between files in a multi-file print job in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
1522
1523 <P>The default is <CODE>5m</CODE> (five minutes).</P>
1524
1525
1526 <H2 CLASS="title"><A NAME="Order">Order</A></H2>
1527
1528 <H3>Examples</H3>
1529
1530 <PRE CLASS="command">
1531 &lt;Location /path&gt;
1532   ...
1533   Order Allow,Deny
1534   Order Deny,Allow
1535 &lt;/Location&gt;
1536 </PRE>
1537
1538 <H3>Description</H3>
1539
1540 <P>The <CODE>Order</CODE> directive defines the default access
1541 control. The following values are supported:</P>
1542
1543 <UL>
1544
1545         <LI><CODE>allow,deny</CODE> - Deny requests by default,
1546         then check the <A HREF="#Allow"><CODE>Allow</CODE></A>
1547         lines followed by the <A
1548         HREF="#Deny"><CODE>Deny</CODE></A> lines</LI>
1549
1550         <LI><CODE>deny,allow</CODE> - Allow requests by default,
1551         then check the <A HREF="#Deny"><CODE>Deny</CODE></A>
1552         lines followed by the <A
1553         HREF="#Allow"><CODE>Allow</CODE></A> lines</LI>
1554
1555 </UL>
1556
1557 <P>The <CODE>Order</CODE> directive must appear inside a <A
1558 HREF="#Location"><CODE>Location</CODE></A> or <A
1559 HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
1560
1561
1562 <H2 CLASS="title"><A NAME="PageLogFormat">PageLogFormat</A></H2>
1563
1564 <H3>Examples</H3>
1565
1566 <PRE CLASS="command">
1567 PageLogFormat %p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}
1568 PageLogFormat PAGE %p %u %j %P %C %{job-billing} %{job-originating-host-name}
1569 </PRE>
1570
1571 <H3>Description</H3>
1572
1573 <P>The <CODE>PageLogFormat</CODE> directive sets the format of lines
1574 that are logged to the page log file. Sequences beginning with percent (%)
1575 characters are replaced with the corresponding information, while all other
1576 characters are copied literally. The following percent sequences are
1577 recognized:</P>
1578
1579 <UL>
1580
1581         <LI><CODE>%%</CODE>: Inserts a single percent character.</LI>
1582
1583         <LI><CODE>%{name}</CODE>: Inserts the value of the specified IPP
1584         attribute.</LI>
1585
1586         <LI><CODE>%C</CODE>: Inserts the number of copies for the current page.</LI>
1587
1588         <LI><CODE>%P</CODE>: Inserts the current page number.</LI>
1589
1590         <LI><CODE>%T</CODE>: Inserts the current date and time in common log
1591         format.</LI>
1592
1593         <LI><CODE>%j</CODE>: Inserts the job ID.</LI>
1594
1595         <LI><CODE>%p</CODE>: Inserts the printer name.</LI>
1596
1597         <LI><CODE>%u</CODE>: Inserts the username.</LI>
1598
1599 </UL>
1600
1601 <P>The default is "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}".</P>
1602
1603
1604 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="PassEnv">PassEnv</A></H2>
1605
1606 <H3>Examples</H3>
1607
1608 <PRE CLASS="command">
1609 PassEnv MY_ENV_VARIABLE
1610 </PRE>
1611
1612 <H3>Description</H3>
1613
1614 <P>The <CODE>PassEnv</CODE> directive specifies an environment
1615 variable that should be passed to child processes. Normally, the
1616 scheduler only passes the <CODE>DYLD_LIBRARY_PATH</CODE>,
1617 <CODE>LD_ASSUME_KERNEL</CODE>, <CODE>LD_LIBRARY_PATH</CODE>,
1618 <CODE>LD_PRELOAD</CODE>, <CODE>NLSPATH</CODE>,
1619 <CODE>SHLIB_PATH</CODE>, <CODE>TZ</CODE>, and <CODE>VGARGS</CODE>
1620 environment variables to child processes.</P>
1621
1622
1623 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="Policy">Policy</A></H2>
1624
1625 <H3>Examples</H3>
1626
1627 <PRE CLASS="command">
1628 &lt;Policy name&gt;
1629   &lt;Limit operation ... operation&gt;
1630   ...
1631   &lt;/Limit&gt;
1632   &lt;Limit operation ... operation&gt;
1633   ...
1634   &lt;/Limit&gt;
1635   &lt;Limit All&gt;
1636   ...
1637   &lt;/Limit&gt;
1638 &lt;/Policy&gt;
1639 </PRE>
1640
1641 <H3>Description</H3>
1642
1643 <P>The <CODE>Policy</CODE> directive specifies IPP operation
1644 access control limits. Each policy contains 1 or more <A
1645 HREF="#LimitIPP"><CODE>Limit</CODE></A> sections to set the
1646 access control limits for specific operations - user limits,
1647 authentication, encryption, and allowed/denied addresses,
1648 domains, or hosts. The <CODE>&lt;Limit All&gt;</CODE> section
1649 specifies the default access control limits for operations that
1650 are not listed.</P>
1651
1652 <P>Policies are named and associated with printers via the
1653 printer's operation policy setting
1654 (<CODE>printer-op-policy</CODE>). The default policy for the
1655 scheduler is specified using the <A
1656 HREF="#DefaultPolicy"><CODE>DefaultPolicy</CODE></A>
1657 directive.</P>
1658
1659
1660 <H2 CLASS="title"><A NAME="Port">Port</A></H2>
1661
1662 <H3>Examples</H3>
1663
1664 <PRE CLASS="command">
1665 Port 631
1666 Port 80
1667 </PRE>
1668
1669 <H3>Description</H3>
1670
1671 <P>The <CODE>Port</CODE> directive specifies a port to listen on.
1672 Multiple <CODE>Port</CODE> lines can be specified to listen on
1673 multiple ports. The <CODE>Port</CODE> directive is equivalent to
1674 "<CODE>Listen *:nnn</CODE>". The default port is 631.</P>
1675
1676 <BLOCKQUOTE><B>Note:</B>
1677
1678 <P>On systems that support IPv6, this directive will bind to both
1679 the IPv4 and IPv6 wildcard address.</P>
1680
1681 </BLOCKQUOTE>
1682
1683
1684 <H2 CLASS="title"><A NAME="PreserveJobHistory">PreserveJobHistory</A></H2>
1685
1686 <H3>Examples</H3>
1687
1688 <PRE CLASS="command">
1689 PreserveJobHistory On
1690 PreserveJobHistory Off
1691 PreserveJobHistory 1w
1692 PreserveJobHistory 7d
1693 PreserveJobHistory 168h
1694 PreserveJobHistory 10080m
1695 PreserveJobHistory 604800
1696 </PRE>
1697
1698 <H3>Description</H3>
1699
1700 <P>The <CODE>PreserveJobHistory</CODE> directive controls whether the history of completed, canceled, or aborted print jobs is retained by the scheduler. A value of <CODE>On</CODE> preserves job information until the administrator purges it with the <CODE>cancel</CODE> command. A value of <CODE>Off</CODE> removes the job information as soon as each job is completed, canceled, or aborted. Numeric values preserve job information for the specified number of seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
1701
1702 <P>The default value is <CODE>On</CODE>.</P>
1703
1704 <BLOCKQUOTE><B>Note:</B>
1705
1706 <P>The <A HREF="#MaxJobs"><CODE>MaxJobs</CODE></A>, <A HREF="#MaxJobsPerPrinter"><CODE>MaxJobsPerPrinter</CODE></A>, and <A HREF="#MaxJobsPerUser"><CODE>MaxJobsPerUser</CODE></A> directives can cause job history to be discarded to make room for new jobs.</P>
1707
1708 </BLOCKQUOTE>
1709
1710
1711 <H2 CLASS="title"><A NAME="PreserveJobFiles">PreserveJobFiles</A></H2>
1712
1713 <H3>Examples</H3>
1714
1715 <PRE CLASS="command">
1716 PreserveJobFiles On
1717 PreserveJobFiles Off
1718 PreserveJobFiles 1w
1719 PreserveJobFiles 7d
1720 PreserveJobFiles 168h
1721 PreserveJobFiles 10080m
1722 PreserveJobFiles 604800
1723 </PRE>
1724
1725 <H3>Description</H3>
1726
1727 <P>The <CODE>PreserveJobFiles</CODE> directive controls whether the document files of completed, canceled, or aborted print jobs are retained. Jobs can be restarted (and reprinted) as desired until they are purged.</P>
1728
1729 <P>A value of <CODE>On</CODE> preserves job files until the administrator purges them with the <CODE>cancel</CODE> command. A value of <CODE>Off</CODE> removes the job files as soon as each job is completed, canceled, or aborted. Numeric values preserve job files for the specified number of seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
1730
1731 <P>The default value is <CODE>1d</CODE> (one day).</P>
1732
1733 <BLOCKQUOTE><B>Note:</B>
1734
1735 <P>The <A HREF="#MaxJobs"><CODE>MaxJobs</CODE></A>, <A HREF="#MaxJobsPerPrinter"><CODE>MaxJobsPerPrinter</CODE></A>, <A HREF="#MaxJobsPerUser"><CODE>MaxJobsPerUser</CODE></A>, and <A HREF="#PreserveJobHistory"><CODE>PreserveJobHistory</CODE></A> directives can cause job files to be discarded sooner than specified.</P>
1736
1737 </BLOCKQUOTE>
1738
1739
1740 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.21</SPAN><A NAME="ReloadTimeout">ReloadTimeout</A></H2>
1741
1742 <H3>Examples</H3>
1743
1744 <PRE CLASS="command">
1745 ReloadTimeout 0
1746 ReloadTimeout 30
1747 </PRE>
1748
1749 <H3>Description</H3>
1750
1751 <P>The <CODE>ReloadTimeout</CODE> directive specifies the number
1752 of seconds the scheduler will wait for active jobs to complete
1753 before doing a restart. The default is 30 seconds.</P>
1754
1755
1756 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Require">Require</A></H2>
1757
1758 <H3>Examples</H3>
1759
1760 <PRE CLASS="command">
1761 &lt;Location /path&gt;
1762   ...
1763   Require group foo bar
1764   Require user john mary
1765   Require valid-user
1766   Require user @groupname
1767   Require user @SYSTEM
1768   Require user @OWNER
1769 &lt;/Location&gt;
1770 </PRE>
1771
1772 <H3>Description</H3>
1773
1774 <P>The <CODE>Require</CODE> directive specifies that
1775 authentication is required for the resource. The
1776 <CODE>group</CODE> keyword specifies that the authenticated user
1777 must be a member of one or more of the named groups that
1778 follow.</P>
1779
1780 <P>The <CODE>user</CODE> keyword specifies that the
1781 authenticated user must be one of the named users or groups that
1782 follow. Group names are specified using the "@" prefix.</P>
1783
1784 <P>The <CODE>valid-user</CODE> keyword specifies that any
1785 authenticated user may access the resource.</P>
1786
1787 <P>The default is to do no authentication. This directive must
1788 appear inside a <A HREF="#Location"><CODE>Location</CODE></A> or
1789 <A HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
1790
1791
1792 <H2 CLASS="title"><A NAME="RIPCache">RIPCache</A></H2>
1793
1794 <H3>Examples</H3>
1795
1796 <PRE CLASS="command">
1797 RIPCache 128m
1798 RIPCache 1g
1799 RIPCache 2048k
1800 </PRE>
1801
1802 <H3>Description</H3>
1803
1804 <P>The <CODE>RIPCache</CODE> directive sets the size of the
1805 memory cache used by Raster Image Processor ("RIP") filters such
1806 as <CODE>imagetoraster</CODE> and <CODE>pstoraster</CODE>. The
1807 size can be suffixed with a "k" for kilobytes, "m" for megabytes,
1808 or "g" for gigabytes. The default cache size is "128m", or 128
1809 megabytes.</P>
1810
1811
1812 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.16</SPAN><A NAME="RootCertDuration">RootCertDuration</A></H2>
1813
1814 <H3>Examples</H3>
1815
1816 <PRE CLASS="command">
1817 RootCertDuration 0
1818 RootCertDuration 1w
1819 RootCertDuration 1d
1820 RootCertDuration 1h
1821 RootCertDuration 5m
1822 RootCertDuration 300
1823 </PRE>
1824
1825 <H3>Description</H3>
1826
1827 <P>The <CODE>RootCertDuration</CODE> directive specifies the amount of time the <EM>root certificate</EM> remains valid in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix). The scheduler will generate a new certificate as needed when the given time interval has expired. If set to 0, the root certificate is generated only once on startup or on a restart.</P>
1828
1829 <P>The default is <CODE>5m</CODE> (five minutes).</P>
1830
1831
1832 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Satisfy">Satisfy</A></H2>
1833
1834 <H3>Examples</H3>
1835
1836 <PRE CLASS="command">
1837 &lt;Location /path&gt;
1838   ...
1839   Satisfy all
1840   Satisfy any
1841 &lt;/Location&gt;
1842 </PRE>
1843
1844 <H3>Description</H3>
1845
1846 <P>The <CODE>Satisfy</CODE> directive specifies whether all
1847 conditions must be satisfied to allow access to the resource. If
1848 set to <CODE>all</CODE>, then all authentication and access
1849 control conditions must be satisfied to allow access.</P>
1850
1851 <P>Setting <CODE>Satisfy</CODE> to <CODE>any</CODE> allows a user
1852 to gain access if the authentication or access control
1853 requirements are satisfied. For example, you might require
1854 authentication for remote access, but allow local access without
1855 authentication.</P>
1856
1857 <P>The default is <CODE>all</CODE>. This directive must appear
1858 inside a <A HREF="#Location"><CODE>Location</CODE></A> or <A
1859 HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
1860
1861
1862 <H2 CLASS="title"><A NAME="ServerAdmin">ServerAdmin</A></H2>
1863
1864 <H3>Examples</H3>
1865
1866 <PRE CLASS="command">
1867 ServerAdmin user@host
1868 ServerAdmin root@foo.bar.com
1869 </PRE>
1870
1871 <H3>Description</H3>
1872
1873 <P>The <CODE>ServerAdmin</CODE> directive identifies the email
1874 address for the administrator on the system. By default the
1875 administrator email address is <CODE>root@server</CODE>, where
1876 <CODE>server</CODE> is the <A
1877 HREF="#ServerName"><CODE>ServerName</CODE></A>.</P>
1878
1879
1880 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.3.10</SPAN><A NAME="ServerAlias">ServerAlias</A></H2>
1881
1882 <H3>Examples</H3>
1883
1884 <PRE CLASS="command">
1885 ServerAlias althost
1886 ServerAlias foo.example.com
1887 ServerAlias bar.example.com
1888 ServerAlias one.example.com two.example.com
1889 ServerAlias *
1890 </PRE>
1891
1892 <H3>Description</H3>
1893
1894 <P>The <CODE>ServerAlias</CODE> directive specifies alternate names that the server is known by. By default it contains a list of all aliases associated with the <A HREF="#ServerName"><CODE>ServerName</CODE></A>. The special name "*" can be used to allow any hostname when accessing CUPS via an external network interfaces.</P>
1895
1896 <BLOCKQUOTE><B>Note</B>
1897
1898 <P>The <CODE>ServerAlias</CODE> directive is used for HTTP Host header
1899 validation when clients connect to the scheduler from external interfaces.
1900 Using the special name "*" can expose your system to known browser-based
1901 DNS rebinding attacks, even when accessing sites through a firewall. If the
1902 auto-discovery of alternate names does not work, we recommend listing each
1903 alternate name with a ServerAlias directive instead of using "*".</P>
1904
1905 </BLOCKQUOTE>
1906
1907
1908 <H2 CLASS="title"><A NAME="ServerName">ServerName</A></H2>
1909
1910 <H3>Examples</H3>
1911
1912 <PRE CLASS="command">
1913 ServerName foo.example.com
1914 ServerName myserver.example.com
1915 </PRE>
1916
1917 <H3>Description</H3>
1918
1919 <P>The <CODE>ServerName</CODE> directive specifies the hostname
1920 that is reported to clients. By default the server name is the
1921 hostname.</P>
1922
1923
1924 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.21</SPAN><A NAME="ServerTokens">ServerTokens</A></H2>
1925
1926 <H3>Examples</H3>
1927
1928 <PRE CLASS="command">
1929 ServerTokens None
1930 ServerTokens ProductOnly
1931 ServerTokens Major
1932 ServerTokens Minor
1933 ServerTokens Minimal
1934 ServerTokens OS
1935 ServerTokens Full
1936 </PRE>
1937
1938 <H3>Description</H3>
1939
1940 <P>The <CODE>ServerTokens</CODE> directive specifies the
1941 information that is included in the <CODE>Server:</CODE> header
1942 of all HTTP responses. Table 4 lists the token name along with
1943 the text that is returned. The default is
1944 <CODE>Minimal</CODE>.</P>
1945
1946 <DIV CLASS="table"><TABLE SUMMARY="ServerToken Names and Values">
1947 <CAPTION>Table 4: <A NAME="TABLE4">ServerToken Names and Values</A></CAPTION>
1948 <THEAD>
1949 <TR>
1950         <TH>Name</TH>
1951         <TH>Value</TH>
1952 </TR>
1953 </THEAD>
1954 <TBODY>
1955 <TR>
1956         <TD>None</TD>
1957         <TD>No <CODE>Server:</CODE> header is returned</TD>
1958 </TR>
1959 <TR>
1960         <TD>ProductOnly</TD>
1961         <TD>"CUPS"</TD>
1962 </TR>
1963 <TR>
1964         <TD>Major</TD>
1965         <TD>"CUPS 1"</TD>
1966 </TR>
1967 <TR>
1968         <TD>Minor</TD>
1969         <TD>"CUPS 1.2"</TD>
1970 </TR>
1971 <TR>
1972         <TD>Minimal</TD>
1973         <TD>"CUPS 1.2.N" where N is the patch release</TD>
1974 </TR>
1975 <TR>
1976         <TD>OS</TD>
1977         <TD>"CUPS 1.2.N (UNAME)" where N is the patch release and
1978         UNAME is the output of the <B>uname(1)</B> command</TD>
1979 </TR>
1980 <TR>
1981         <TD>Full</TD>
1982         <TD>"CUPS 1.2.N (UNAME) IPP/1.1" where N is the patch
1983         release and UNAME is the output of the <B>uname(1)</B>
1984         command</TD>
1985 </TR>
1986 </TBODY>
1987 </TABLE></DIV>
1988
1989
1990 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="SetEnv">SetEnv</A></H2>
1991
1992 <H3>Examples</H3>
1993
1994 <PRE CLASS="command">
1995 SetEnv PATH /usr/lib/cups/filter:/bin:/usr/bin:/usr/local/bin
1996 SetEnv MY_ENV_VAR foo
1997 </PRE>
1998
1999 <H3>Description</H3>
2000
2001 <P>The <CODE>SetEnv</CODE> directive specifies an environment
2002 variable that should be passed to child processes.</P>
2003
2004
2005 <H2 CLASS="title"><A NAME="SSLListen">SSLListen</A></H2>
2006
2007 <H3>Examples</H3>
2008
2009 <PRE CLASS="command">
2010 SSLListen 127.0.0.1:443
2011 SSLListen 192.0.2.1:443
2012 </PRE>
2013
2014 <H3>Description</H3>
2015
2016 <P>The <CODE>SSLListen</CODE> directive specifies a network
2017 address and port to listen for secure connections. Multiple
2018 <CODE>SSLListen</CODE> directives can be provided to listen on
2019 multiple addresses.</P>
2020
2021 <P>The <CODE>SSLListen</CODE> directive is similar to the <A
2022 HREF="#SSLPort"><CODE>SSLPort</CODE></A> directive but allows you
2023 to restrict access to specific interfaces or networks.</P>
2024
2025
2026 <H2 CLASS="title"><A NAME="SSLPort">SSLPort</A></H2>
2027
2028 <H3>Examples</H3>
2029
2030 <PRE CLASS="command">
2031 SSLPort 443
2032 </PRE>
2033
2034 <H3>Description</H3>
2035
2036 <P>The <CODE>SSLPort</CODE> directive specifies a port to listen
2037 on for secure connections. Multiple <CODE>SSLPort</CODE> lines
2038 can be specified to listen on multiple ports.</P>
2039
2040
2041 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.6</SPAN><A NAME="StrictConformance">StrictConformance</A></H2>
2042
2043 <H3>Examples</H3>
2044
2045 <PRE CLASS="command">
2046 StrictConformance No
2047 StrictConformance Yes
2048 </PRE>
2049
2050 <H3>Description</H3>
2051
2052 <P>The <CODE>StrictConformance</CODE> directive specifies whether the scheduler
2053 requires strict IPP conformance for client requests, for example to not allow
2054 document attributes in a Create-Job request. The default is
2055 <code>No</code>.</P>
2056
2057
2058 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.5</SPAN><A NAME="SubscriptionPrivateAccess">SubscriptionPrivateAccess</A></H2>
2059
2060 <H3>Examples</H3>
2061
2062 <PRE CLASS="command">
2063 SubscriptionPrivateAccess all
2064 SubscriptionPrivateAccess default
2065 SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
2066 </PRE>
2067
2068 <H3>Description</H3>
2069
2070 <P>The <CODE>SubscriptionPrivateAccess</CODE> directive specifies the access list for a
2071 subscription's private values. The "default" access list is "@OWNER @SYSTEM".
2072 "@ACL" maps to the printer's requesting-user-name-allowed or
2073 requesting-user-name-denied values.</P>
2074
2075 <P>The <CODE>SubscriptionPrivateAccess</CODE> directive must appear inside a <A
2076 HREF="#Policy"><CODE>Policy</CODE></A> section.</P>
2077
2078
2079 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.5</SPAN><A NAME="SubscriptionPrivateValues">SubscriptionPrivateValues</A></H2>
2080
2081 <H3>Examples</H3>
2082
2083 <PRE CLASS="command">
2084 SubscriptionPrivateValues all
2085 SubscriptionPrivateValues default
2086 SubscriptionPrivateValues none
2087 SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
2088 </PRE>
2089
2090 <H3>Description</H3>
2091
2092 <P>The <CODE>SubscriptionPrivateValues</CODE> directive specifies the list of
2093 subscription values to make private. The "default" values are "notify-events",
2094 "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and
2095 "notify-user-data".</P>
2096
2097 <P>The <CODE>SubscriptionPrivateValues</CODE> directive must appear inside a <A
2098 HREF="#Policy"><CODE>Policy</CODE></A> section.</P>
2099
2100
2101 <H2 CLASS="title"><A NAME="Timeout">Timeout</A></H2>
2102
2103 <H3>Examples</H3>
2104
2105 <PRE CLASS="command">
2106 Timeout 1w
2107 Timeout 1d
2108 Timeout 1h
2109 Timeout 5m
2110 Timeout 300
2111 </PRE>
2112
2113 <H3>Description</H3>
2114
2115 <P>The <CODE>Timeout</CODE> directive controls the amount of time
2116 to wait before an active HTTP or IPP request times out in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
2117
2118 <P>The default timeout is <CODE>5m</CODE> (five minutes).</P>
2119
2120
2121 <H2 CLASS="title"><SPAN CLASS="INFO">CUPS 1.5</SPAN><A NAME="WebInterface">WebInterface</A></H2>
2122
2123 <H3>Examples</H3>
2124
2125 <PRE CLASS="command">
2126 WebInterface Yes
2127 WebInterface No
2128 </PRE>
2129
2130 <H3>Description</H3>
2131
2132 <P>The <CODE>WebInterface</CODE> directive specifies whether the web interface is enabled. The default value is <CODE>No</CODE> on OS X and <CODE>Yes</CODE> on all other operating systems.</P>
2133
2134 </BODY>
2135 </HTML>