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