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