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