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