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