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