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