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