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