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