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