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