2 <!-- SECTION: References -->
4 <TITLE>cupsd.conf
</TITLE>
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>
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>
22 <LI>AIX, IRIX, Linux, Solaris:
24 /etc/init.d/cups restart
29 /sbin/init.d/cups restart
34 /System/Library/StartupItems/PrintingServices/PrintingServices restart
39 <P>You can also edit this file from the CUPS web interface, which
40 automatically handles restarting the scheduler.
</P>
43 <H2 CLASS=
"title"><A NAME=
"AccessLog">AccessLog
</A></H2>
48 AccessLog /var/log/cups/access_log
49 AccessLog /var/log/cups/access_log-%s
55 <P>The
<CODE>AccessLog
</CODE> directive sets the name of the
56 access log file. If the filename is not absolute then it is
57 assumed to be relative to the
<A
58 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory. The
59 access log file is stored in
"common log format" and can be used
60 by any web access reporting tool to generate a report on CUPS
63 <P>The server name can be included in the filename by using
64 <CODE>%s
</CODE> in the name.
</P>
66 <P>The special name
"syslog" can be used to send the access
67 information to the system log instead of a plain file.
</P>
69 <P>The default access log file is
70 <VAR>@CUPS_LOGDIR@/access_log
</VAR>.
</P>
73 <H2 CLASS=
"title"><A NAME=
"Allow">Allow
</A></H2>
78 <Location /path
>
82 Allow from *.domain.com
83 Allow from .domain.com
84 Allow from host.domain.com
87 Allow from nnn.nnn.nnn.*
88 Allow from nnn.nnn.nnn.nnn
89 Allow from nnn.nnn.nnn.nnn/mm
90 Allow from nnn.nnn.nnn.nnn/mmm.mmm.mmm.mmm
91 Allow from xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx
99 <P>The
<CODE>Allow
</CODE> directive specifies a hostname, IP
100 address, or network that is allowed access to the server.
101 <CODE>Allow
</CODE> directives are cummulative, so multiple
102 <CODE>Allow
</CODE> directives can be used to allow access for
103 multiple hosts or networks. The
<CODE>/mm
</CODE> notation
104 specifies a CIDR netmask, as shown in Table
1.
</P>
106 <DIV CLASS=
"table"><TABLE SUMMARY=
"CIDR Netmasks">
107 <CAPTION>Table
1:
<A NAME=
"TABLE1">CIDR Netmasks
</A></CAPTION>
109 <TH WIDTH=
"10%">mm
</TH>
110 <TH WIDTH=
"20%">netmask
</TH>
111 <TH WIDTH=
"10%">mm
</TH>
112 <TH WIDTH=
"20%">netmask
</TH>
115 <TD ALIGN=
"CENTER">0</TD>
116 <TD ALIGN=
"CENTER">0.0.0.0</TD>
117 <TD ALIGN=
"CENTER">8</TD>
118 <TD ALIGN=
"CENTER">255.0.0.0</TD>
121 <TD ALIGN=
"CENTER">1</TD>
122 <TD ALIGN=
"CENTER">128.0.0.0</TD>
123 <TD ALIGN=
"CENTER">16</TD>
124 <TD ALIGN=
"CENTER">255.255.0.0</TD>
127 <TD ALIGN=
"CENTER">2</TD>
128 <TD ALIGN=
"CENTER">192.0.0.0</TD>
129 <TD ALIGN=
"CENTER">24</TD>
130 <TD ALIGN=
"CENTER">255.255.255.0</TD>
133 <TD ALIGN=
"CENTER">...
</TD>
134 <TD ALIGN=
"CENTER">...
</TD>
135 <TD ALIGN=
"CENTER">32</TD>
136 <TD ALIGN=
"CENTER">255.255.255.255</TD>
140 <P>The
<CODE>@LOCAL
</CODE> name will allow access from all local
141 interfaces. The
<CODE>@IF(name)
</CODE> name will allow access
142 from the named interface. In both cases, CUPS only allows access
143 from the network that the interface(s) are configured for -
144 requests arriving on the interface from a foreign network will
145 <em>not
</em> be accepted.
</P>
147 <P>The
<CODE>Allow
</CODE> directive must appear inside a
<A
148 HREF=
"#Location"><CODE>Location
</CODE></A> or
<A
149 HREF=
"#Limit"><CODE>Limit
</CODE></A> section.
</P>
152 <H2 CLASS=
"title"><SPAN CLASS=
"info">Deprecated
</SPAN><A NAME=
"AuthClass">AuthClass
</A></H2>
156 <PRE CLASS=
"command">
157 <Location /path
>
168 <P>The
<CODE>AuthClass
</CODE> directive defines what level of
169 authentication is required:
</P>
173 <LI><CODE>Anonymous
</CODE> - No authentication should be
174 performed (default)
</LI>
176 <LI><CODE>User
</CODE> - A valid username and password is
179 <LI><CODE>System
</CODE> - A valid username and password
180 is required, and the username must belong to the
"sys"
181 group; this can be changed using the
<A
182 HREF=
"#SystemGroup"><CODE>SystemGroup
</CODE></A>
185 <LI><CODE>Group
</CODE> - A valid username and password is
186 required, and the username must belong to the group named
188 HREF=
"#AuthGroupName"><CODE>AuthGroupName
</CODE></A>
193 <P>The
<CODE>AuthClass
</CODE> directive must appear inside a
<A
194 HREF=
"#Location"><CODE>Location
</CODE></A> or
<A
195 HREF=
"#Limit"><CODE>Limit
</CODE></A> section.
</P>
197 <P><B>This directive is deprecated and will be removed from a
198 future release of CUPS.
</B> Consider using the more flexible
<A
199 HREF=
"#Require"><CODE>Require
</CODE></A> directive instead.
</P>
202 <H2 CLASS=
"title"><SPAN CLASS=
"info">Deprecated
</SPAN><A NAME=
"AuthGroupName">AuthGroupName
</A></H2>
206 <PRE CLASS=
"command">
207 <Location /path
>
209 AuthGroupName mygroup
216 <P>The
<CODE>AuthGroupName
</CODE> directive sets the group to use
217 for
<CODE>Group
</CODE> authentication.
</P>
219 <P>The
<CODE>AuthGroupName
</CODE> directive must appear inside a
220 <A HREF=
"#Location"><CODE>Location
</CODE></A> or
<A
221 HREF=
"#Limit"><CODE>Limit
</CODE></A> section.
</P>
223 <P><B>This directive is deprecated and will be removed from a
224 future release of CUPS.
</B> Consider using the more flexible
<A
225 HREF=
"#Require"><CODE>Require
</CODE></A> directive instead.
</P>
228 <H2 CLASS=
"title"><A NAME=
"AuthType">AuthType
</A></H2>
232 <PRE CLASS=
"command">
233 <Location /path
>
245 <P>The
<CODE>AuthType
</CODE> directive defines the type of
246 authentication to perform:
</P>
250 <LI><CODE>None
</CODE> - No authentication should be
251 performed (default)
</LI>
253 <LI><CODE>Basic
</CODE> - Basic authentication should be
254 performed using the UNIX password and group files
</LI>
256 <LI><CODE>Digest
</CODE> - Digest authentication should be
257 performed using the
<VAR>/etc/cups/passwd.md5
</VAR>
260 <LI><CODE>BasicDigest
</CODE> - Basic authentication
261 should be performed using the
262 <VAR>/etc/cups/passwd.md5
</VAR> file
</LI>
264 <LI><CODE>Negotiate
</CODE> - Kerberos authentication
265 should be performed
</LI>
269 <P>When using
<CODE>Basic
</CODE>,
<CODE>Digest
</CODE>,
270 <CODE>BasicDigest
</CODE>, or
<CODE>Negotiate
</CODE> authentication,
271 clients connecting through the
<CODE>localhost
</CODE> interface can
272 also authenticate using certificates.
</P>
274 <P>The
<CODE>AuthType
</CODE> directive must appear inside a
<A
275 HREF=
"#Location"><CODE>Location
</CODE></A> or
<A
276 HREF=
"#Limit"><CODE>Limit
</CODE></A> section.
</P>
279 <H2 CLASS=
"title"><A NAME=
"AutoPurgeJobs">AutoPurgeJobs
</A></H2>
283 <PRE CLASS=
"command">
290 <P>The
<CODE>AutoPurgeJobs
</CODE> directive specifies whether or
291 not to purge completed jobs once they are no longer required for
292 quotas. This option has no effect if quotas are not enabled. The
293 default setting is
<CODE>No
</CODE>.
</P>
296 <H2 CLASS=
"title"><A NAME=
"BrowseAddress">BrowseAddress
</A></H2>
300 <PRE CLASS=
"command">
301 BrowseAddress
255.255.255.255:
631
302 BrowseAddress
192.0.2.255:
631
303 BrowseAddress host.domain.com:
631
305 BrowseAddress @IF(name)
310 <P>The
<CODE>BrowseAddress
</CODE> directive specifies an address
311 to send browsing information to. Multiple
312 <CODE>BrowseAddress
</CODE> directives can be specified to send
313 browsing information to different networks or systems.
</P>
315 <P>The
<CODE>@LOCAL
</CODE> name will broadcast printer
316 information to all local interfaces. The
<CODE>@IF(name)
</CODE>
317 name will broadcast to the named interface.
</P>
319 <P>There is no default browse address.
</P>
321 <BLOCKQUOTE><B>Note:
</B>
323 <P>If you are using HP-UX
10.20 and a subnet that is not
24,
324 16, or
8 bits, printer browsing (and in fact all broadcast
325 reception) will not work. This problem appears to be fixed in
331 <H2 CLASS=
"title"><A NAME=
"BrowseAllow">BrowseAllow
</A></H2>
335 <PRE CLASS=
"command">
337 BrowseAllow from none
338 BrowseAllow from
192.0.2
339 BrowseAllow from
192.0.2.0/
24
340 BrowseAllow from
192.0.2.0/
255.255.255.0
341 BrowseAllow from *.domain.com
342 BrowseAllow from @LOCAL
343 BrowseAllow from @IF(name)
348 <P>The
<CODE>BrowseAllow
</CODE> directive specifies a system or
349 network to accept browse packets from. The default is to accept
350 browse packets from all hosts.
</P>
352 <P>Host and domain name matching require that you enable the
<A
353 HREF=
"#HostNameLookups"><CODE>HostNameLookups
</CODE></A>
356 <P>IP address matching supports exact matches, partial addresses
357 that match networks using netmasks of
255.0.0.0,
255.255.0.0, and
358 255.255.255.0, or network addresses using the specified netmask
361 <P>The
<CODE>@LOCAL
</CODE> name will allow browse data from all
362 local interfaces. The
<CODE>@IF(name)
</CODE> name will allow
363 browse data from the named interface. In both cases, CUPS only
364 allows data from the network that the interface(s) are configured
365 for - data arriving on the interface from a foreign network will
366 <em>not
</em> be allowed.
</P>
369 <H2 CLASS=
"title"><A NAME=
"BrowseDeny">BrowseDeny
</A></H2>
373 <PRE CLASS=
"command">
376 BrowseDeny from
192.0.2
377 BrowseDeny from
192.0.2.0/
24
378 BrowseDeny from
192.0.2.0/
255.255.255.0
379 BrowseDeny from *.domain.com
380 BrowseDeny from @LOCAL
381 BrowseDeny from @IF(name)
386 <P>The
<CODE>BrowseDeny
</CODE> directive specifies a system or
387 network to reject browse packets from. The default is to not deny
388 browse packets from any hosts.
</P>
390 <P>Host and domain name matching require that you enable the
<A
391 HREF=
"#HostNameLookups"><CODE>HostNameLookups
</CODE></A>
394 <P>IP address matching supports exact matches, partial addresses
395 that match networks using netmasks of
255.0.0.0,
255.255.0.0, and
396 255.255.255.0, or network addresses using the specified netmask
399 <P>The
<CODE>@LOCAL
</CODE> name will block browse data from all
400 local interfaces. The
<CODE>@IF(name)
</CODE> name will block
401 browse data from the named interface. In both cases, CUPS only
402 blocks data from the network that the interface(s) are configured
403 for - data arriving on the interface from a foreign network will
404 <em>not
</em> be blocked.
</P>
407 <H2 CLASS=
"title"><A NAME=
"BrowseInterval">BrowseInterval
</A></H2>
411 <PRE CLASS=
"command">
418 <P>The
<CODE>BrowseInterval
</CODE> directive specifies the
419 maximum amount of time between browsing updates. Specifying a
420 value of
0 seconds disables outgoing browse updates but allows a
421 server to receive printer information from other hosts.
</P>
423 <P>The
<CODE>BrowseInterval
</CODE> value should always be less
424 than the
<A HREF=
"#BrowseTimeout"><CODE>BrowseTimeout
</CODE></A>
425 value. Otherwise printers and classes will disappear from client
426 systems between updates.
</P>
429 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"BrowseLDAPBindDN">BrowseLDAPBindDN
</A></H2>
433 <PRE CLASS=
"command">
439 <P>The
<CODE>BrowseLDAPBindDN
</CODE> directive specifies the LDAP
440 domain name to use when listening for printer registrations. The
441 default is undefined.
</P>
444 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"BrowseLDAPDN">BrowseLDAPDN
</A></H2>
448 <PRE CLASS=
"command">
454 <P>The
<CODE>BrowseLDAPDN
</CODE> directive specifies the LDAP
455 domain name to use when registering local shared printers. The
456 default is undefined.
</P>
459 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"BrowseLDAPPassword">BrowseLDAPPassword
</A></H2>
463 <PRE CLASS=
"command">
464 BrowseLDAPPassword foo123
469 <P>The
<CODE>BrowseLDAPPassword
</CODE> directive specifies the
470 access password to use when connecting to the LDAP server. The
471 default is undefined.
</P>
474 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"BrowseLDAPServer">BrowseLDAPServer
</A></H2>
478 <PRE CLASS=
"command">
479 BrowseLDAPServer localhost
484 <P>The
<CODE>BrowseLDAPServer
</CODE> directive specifies the name
485 of the LDAP server to connect to. The default is undefined.
</P>
488 <H2 CLASS=
"title"><A NAME=
"BrowseLocalOptions">BrowseLocalOptions
</A></H2>
492 <PRE CLASS=
"command">
493 BrowseLocalOptions compression=yes
494 BrowseLocalOptions encryption=required
495 BrowseLocalOptions compression=yes
&encryption=required
500 <P>The
<CODE>BrowseLocalOptions
</CODE> directive specifies
501 additional IPP backend options to advertise with local shared
502 printers. The default is to not include any options.
</P>
505 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"BrowseLocalProtocols">BrowseLocalProtocols
</A></H2>
509 <PRE CLASS=
"command">
510 BrowseLocalProtocols all
511 BrowseLocalProtocols none
512 BrowseLocalProtocols cups
513 BrowseLocalProtocols dnssd
514 BrowseLocalProtocols ldap
515 BrowseLocalProtocols slp
516 BrowseLocalProtocols cups dnssd
521 <P>The
<CODE>BrowseLocalProtocols
</CODE> directive specifies the
522 protocols to use when advertising local shared printers on the
523 network. Multiple protocols can be specified by separating them
524 with spaces. The default is
<CODE>@CUPS_BROWSE_REMOTE_PROTOCOLS@
</CODE>.
</P>
527 <H2 CLASS=
"title"><A NAME=
"BrowseOrder">BrowseOrder
</A></H2>
531 <PRE CLASS=
"command">
532 BrowseOrder allow,deny
533 BrowseOrder deny,allow
538 <P>The
<CODE>BrowseOrder
</CODE> directive specifies the order of
539 allow/deny processing. The default order is
540 <CODE>deny,allow
</CODE>:
</P>
544 <LI><CODE>allow,deny
</CODE> - Deny browse packets by
545 default, then check
<CODE>BrowseAllow
</CODE> lines
546 followed by
<CODE>BrowseDeny
</CODE> lines.
</LI>
548 <LI><CODE>deny,allow
</CODE> - Allow browse packets by
549 default, then check
<CODE>BrowseDeny
</CODE> lines
550 followed by
<CODE>BrowseAllow
</CODE> lines.
</LI>
555 <H2 CLASS=
"title"><A NAME=
"BrowsePoll">BrowsePoll
</A></H2>
559 <PRE CLASS=
"command">
560 BrowsePoll
192.0.2.2:
631
561 BrowsePoll host.domain.com:
631
566 <P>The
<CODE>BrowsePoll
</CODE> directive polls a server for
567 available printers once every
<A
568 HREF=
"#BrowseInterval"><CODE>BrowseInterval
</CODE></A> seconds.
569 Multiple
<CODE>BrowsePoll
</CODE> directives can be specified to
570 poll multiple servers.
</P>
572 <P>If
<CODE>BrowseInterval
</CODE> is set to
0 then the server is
573 polled once every
30 seconds.
</P>
576 <H2 CLASS=
"title"><A NAME=
"BrowsePort">BrowsePort
</A></H2>
580 <PRE CLASS=
"command">
587 <P>The
<CODE>BrowsePort
</CODE> directive specifies the UDP port number
588 used for browse packets. The default port number is
631.
</P>
590 <BLOCKQUOTE><B>Note:
</B>
592 <P>You must set the
<CODE>BrowsePort
</CODE> to the same value
593 on all of the systems that you want to see.
598 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.10</SPAN><A NAME=
"BrowseProtocols">BrowseProtocols
</A></H2>
602 <PRE CLASS=
"command">
606 BrowseProtocols dnssd
609 BrowseProtocols cups dnssd
614 <P>The
<CODE>BrowseProtocols
</CODE> directive specifies the
615 protocols to use when showing and advertising shared printers on
616 the local network. Multiple protocols can be specified by
617 separating them with spaces. The default protocol is
618 <CODE>@CUPS_BROWSE_LOCAL_PROTOCOLS@
</CODE> for
619 <A HREF=
"#BrowseLocalProtocols"><CODE>BrowseLocalProtocols
</CODE></A> and
620 <CODE>@CUPS_BROWSE_REMOTE_PROTOCOLS@
</CODE> for
621 <A HREF=
"#BrowseRemoteProtocols"><CODE>BrowseRemoteProtocols
</CODE></A>.
</P>
623 <BLOCKQUOTE><B>Note:
</B>
625 <P>When using the
<CODE>SLP
</CODE> protocol, you must have at least
626 one Directory Agent (DA) server on your network. Otherwise the
627 CUPS scheduler (
<CODE>cupsd
</CODE>) will not respond to client
628 requests for several seconds while polling the network.
</P>
633 <H2 CLASS=
"title"><A NAME=
"BrowseRelay">BrowseRelay
</A></H2>
637 <PRE CLASS=
"command">
638 BrowseRelay
193.0.2.1 192.0.2.255
639 BrowseRelay
193.0.2.0/
255.255.255.0 192.0.2.255
640 BrowseRelay
193.0.2.0/
24 192.0.2.255
641 BrowseRelay *.domain.com
192.0.2.255
642 BrowseRelay host.domain.com
192.0.2.255
647 <P>The
<CODE>BrowseRelay
</CODE> directive specifies source and
648 destination addresses for relaying browsing information from one
649 host or network to another. Multiple
<CODE>BrowseRelay
</CODE>
650 directives can be specified as needed.
</P>
652 <P><CODE>BrowseRelay
</CODE> is typically used on systems that
653 bridge multiple subnets using one or more network interfaces. It
654 can also be used to relay printer information from polled servers
657 <PRE CLASS=
"command">
658 BrowseRelay
127.0.0.1 @LOCAL
661 <P>This effectively provides access to printers on a WAN for all
662 clients on the LAN(s).
</P>
665 <H2 CLASS=
"title"><A NAME=
"BrowseRemoteOptions">BrowseRemoteOptions
</A></H2>
669 <PRE CLASS=
"command">
670 BrowseRemoteOptions compression=yes
671 BrowseRemoteOptions encryption=required
672 BrowseRemoteOptions ?compression=yes
&encryption=required
677 <P>The
<CODE>BrowseRemoteOptions
</CODE> directive specifies
678 additional IPP backend options to include with remote shared
679 printers. If the options string begins with a question mark (?),
680 the options replace any options specified by the remote server.
681 The default is to not include any options.
</P>
684 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"BrowseRemoteProtocols">BrowseRemoteProtocols
</A></H2>
688 <PRE CLASS=
"command">
689 BrowseRemoteProtocols all
690 BrowseRemoteProtocols none
691 BrowseRemoteProtocols cups
692 BrowseRemoteProtocols dnssd
693 BrowseRemoteProtocols ldap
694 BrowseRemoteProtocols slp
695 BrowseRemoteProtocols cups dnssd
700 <P>The
<CODE>BrowseRemoteProtocols
</CODE> directive specifies the
701 protocols to use when finding remote shared printers on the
702 network. Multiple protocols can be specified by separating them
703 with spaces. The default is
<CODE>@CUPS_BROWSE_REMOTE_PROTOCOLS@
</CODE>.
</P>
706 <H2 CLASS=
"title"><A NAME=
"BrowseShortNames">BrowseShortNames
</A></H2>
710 <PRE CLASS=
"command">
717 <P>The
<CODE>BrowseShortNames
</CODE> directive specifies whether
718 or not short names are used for remote printers when possible.
719 Short names are just the remote printer name, without the server
720 (
"printer"). If more than one remote printer is detected with the
721 same name, the printers will have long names (
"printer@server1",
722 "printer@server2".)
</P>
724 <P>The default value for this option is
<CODE>@CUPS_BROWSE_SHORT_NAMES@
</CODE>.
</P>
727 <H2 CLASS=
"title"><A NAME=
"BrowseTimeout">BrowseTimeout
</A></H2>
731 <PRE CLASS=
"command">
738 <P>The
<CODE>BrowseTimeout
</CODE> directive sets the timeout for
739 printer or class information that is received in browse packets.
740 Once a printer or class times out it is removed from the list of
741 available destinations.
</P>
743 <P>The
<CODE>BrowseTimeout
</CODE> value should always be greater
745 HREF=
"#BrowseInterval"><CODE>BrowseInterval
</CODE></A> value.
746 Otherwise printers and classes will disappear from client systems
750 <H2 CLASS=
"title"><A NAME=
"Browsing">Browsing
</A></H2>
754 <PRE CLASS=
"command">
761 <P>The
<CODE>Browsing
</CODE> directive controls whether or not
762 network printer browsing is enabled. The default setting is
763 <CODE>@CUPS_BROWSING@
</CODE>.
</P>
765 <P>This directive does not enable sharing of local printers by
766 itself; you must also use the
<A
767 HREF=
"#BrowseAddress"><CODE>BrowseAddress
</CODE></A> or
<A
768 HREF=
"#BrowseProtocols"><CODE>BrowseProtocols
</CODE></A>
769 directives to advertise local printers to other systems.
</P>
771 <BLOCKQUOTE><B>Note:
</B>
773 <P>If you are using HP-UX
10.20 and a subnet that is not
24,
774 16, or
8 bits, printer browsing (and in fact all broadcast
775 reception) will not work. This problem appears to be fixed in
781 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"Classification">Classification
</A></H2>
785 <PRE CLASS=
"command">
787 Classification classified
788 Classification confidential
789 Classification secret
790 Classification topsecret
791 Classification unclassified
796 <P>The
<CODE>Classification
</CODE> directive sets the
797 classification level on the server. When this option is set, at
798 least one of the banner pages is forced to the classification
799 level, and the classification is placed on each page of output.
800 The default is no classification level.
</P>
803 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.10</SPAN><A NAME=
"ClassifyOverride">ClassifyOverride
</A></H2>
807 <PRE CLASS=
"command">
814 <P>The
<CODE>ClassifyOverride
</CODE> directive specifies whether
815 users can override the default classification level on the
816 server. When the server classification is set, users can change
817 the classification using the
<CODE>job-sheets
</CODE> option and
818 can choose to only print one security banner before or after the
819 job. If the
<CODE>job-sheets
</CODE> option is set to
820 <CODE>none
</CODE> then the server default classification is
823 <P>The default is to not allow classification overrides.
</P>
826 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.15</SPAN><A NAME=
"ConfigFilePerm">ConfigFilePerm
</A></H2>
830 <PRE CLASS=
"command">
837 <P>The
<CODE>ConfigFilePerm
</CODE> directive specifies the
838 permissions to use when writing configuration files. The default
839 is @CUPS_CONFIG_FILE_PERM@.
</P>
842 <H2 CLASS=
"title"><A NAME=
"DataDir">DataDir
</A></H2>
846 <PRE CLASS=
"command">
847 DataDir /usr/share/cups
852 <P>The
<CODE>DataDir
</CODE> directive sets the directory to use
856 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"DefaultAuthType">DefaultAuthType
</A></H2>
860 <PRE CLASS=
"command">
861 DefaultAuthType Basic
862 DefaultAuthType BasicDigest
863 DefaultAuthType Digest
864 DefaultAuthType Negotiate
869 <P>The
<CODE>DefaultAuthType
</CODE> directive specifies the type
870 of authentication to use for IPP operations that require a
871 username. The default is
<CODE>Basic
</CODE>.
</P>
874 <H2 CLASS=
"title"><A NAME=
"DefaultCharset">DefaultCharset
</A></H2>
878 <PRE CLASS=
"command">
880 DefaultCharset iso-
8859-
1
881 DefaultCharset windows-
1251
886 <P>The
<CODE>DefaultCharset
</CODE> directive sets the default
887 character set to use for client connections. The default
888 character set is
<CODE>utf-
8</CODE> but is overridden by the
889 character set for the language specified by the client or the
890 <CODE>DefaultLanguage
</CODE> directive.
</P>
893 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"DefaultEncryption">DefaultEncryption
</A></H2>
897 <PRE CLASS=
"command">
898 DefaultEncryption Never
899 DefaultEncryption IfRequested
900 DefaultEncryption Required
905 <P>The
<CODE>DefaultEncryption
</CODE> directive specifies the
906 type of encryption to use when performing authentication. The
907 default is
<CODE>Required
</CODE>.
</P>
910 <H2 CLASS=
"title"><A NAME=
"DefaultLanguage">DefaultLanguage
</A></H2>
914 <PRE CLASS=
"command">
924 <P>The
<CODE>DefaultLanguage
</CODE> directive specifies the
925 default language to use for client connections. Setting the
926 default language also sets the default character set if a
927 language localization file exists for it. The default language
928 is
"en" for English.
</P>
931 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"DefaultPolicy">DefaultPolicy
</A></H2>
935 <PRE CLASS=
"command">
936 DefaultPolicy default
942 <P>The
<CODE>DefaultPolicy
</CODE> directive specifies the default
943 policy to use for IPP operation. The default is
944 <CODE>default
</CODE>.
</P>
947 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"DefaultShared">DefaultShared
</A></H2>
951 <PRE CLASS=
"command">
958 <P>The
<CODE>DefaultShared
</CODE> directive specifies whether
959 printers are shared (published) by default. The default is
960 <CODE>@CUPS_DEFAULT_SHARED@
</CODE>.
</P>
963 <H2 CLASS=
"title"><A NAME=
"Deny">Deny
</A></H2>
967 <PRE CLASS=
"command">
968 <Location /path
>
972 Deny from *.domain.com
973 Deny from .domain.com
974 Deny from host.domain.com
977 Deny from nnn.nnn.nnn.*
978 Deny from nnn.nnn.nnn.nnn
979 Deny from nnn.nnn.nnn.nnn/mm
980 Deny from nnn.nnn.nnn.nnn/mmm.mmm.mmm.mmm
981 Deny from xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx
989 <P>The
<CODE>Deny
</CODE> directive specifies a hostname, IP
990 address, or network that is allowed access to the server.
991 <CODE>Deny
</CODE> directives are cummulative, so multiple
992 <CODE>Deny
</CODE> directives can be used to allow access for
993 multiple hosts or networks. The
<CODE>/mm
</CODE> notation
994 specifies a CIDR netmask, a shown in
<A HREF=
"TABLE1">Table
997 <P>The
<CODE>@LOCAL
</CODE> name will deny access from all local
998 interfaces. The
<CODE>@IF(name)
</CODE> name will deny access from
999 the named interface. In both cases, CUPS only denies access from
1000 the network that the interface(s) are configured for - requests
1001 arriving on the interface from a foreign network will
1002 <em>not
</em> be denied.
</P>
1004 <P>The
<CODE>Deny
</CODE> directive must appear inside a
<A
1005 HREF=
"#Location"><CODE>Location
</CODE></A> or
<A
1006 HREF=
"#Limit"><CODE>Limit
</CODE></A> section.
</P>
1009 <H2 CLASS=
"title"><A NAME=
"DocumentRoot">DocumentRoot
</A></H2>
1013 <PRE CLASS=
"command">
1014 DocumentRoot /usr/share/doc/cups
1015 DocumentRoot /foo/bar/doc/cups
1018 <H3>Description
</H3>
1020 <P>The
<CODE>DocumentRoot
</CODE> directive specifies the location
1021 of web content for the HTTP server in CUPS. If an absolute path
1022 is not specified then it is assumed to be relative to the
<A
1023 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory. The
1024 default directory is
<VAR>@CUPS_DOCROOT@
</VAR>.
</P>
1026 <P>Documents are first looked up in a sub-directory for the
1027 primary language requested by the client (e.g.
1028 <VAR>@CUPS_DOCROOT@/fr/...
</VAR>) and then directly under
1029 the
<CODE>DocumentRoot
</CODE> directory (e.g.
1030 <VAR>@CUPS_DOCROOT@/...
</VAR>), so it is possible to
1031 localize the web content by providing subdirectories for each
1032 language needed.
</P>
1035 <H2 CLASS=
"title"><A NAME=
"Encryption">Encryption
</A></H2>
1039 <PRE CLASS=
"command">
1040 <Location /path
>
1043 Encryption IfRequested
1048 <H3>Description
</H3>
1050 <P>The
<CODE>Encryption
</CODE> directive must appear instead a
<A
1051 HREF=
"#Location"><CODE>Location
</CODE></A> or
<A
1052 HREF=
"#Limit"><CODE>Limit
</CODE></A> section and specifies the
1053 encryption settings for that location. The default setting is
1054 <CODE>IfRequested
</CODE> for all locations.
</P>
1057 <H2 CLASS=
"title"><A NAME=
"ErrorLog">ErrorLog
</A></H2>
1061 <PRE CLASS=
"command">
1062 ErrorLog /var/log/cups/error_log
1063 ErrorLog /var/log/cups/error_log-%s
1067 <H3>Description
</H3>
1069 <P>The
<CODE>ErrorLog
</CODE> directive sets the name of the error
1070 log file. If the filename is not absolute then it is assumed to
1071 be relative to the
<A
1072 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory. The
1073 default error log file is
<VAR>@CUPS_LOGDIR@/error_log
</VAR>.
</P>
1075 <P>The server name can be included in the filename by using
1076 <CODE>%s
</CODE> in the name.
</P>
1078 <P>The special name
"syslog" can be used to send the error
1079 information to the system log instead of a plain file.
</P>
1082 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.3</SPAN><A NAME=
"ErrorPolicy">ErrorPolicy
</A></H2>
1086 <PRE CLASS=
"command">
1087 ErrorPolicy abort-job
1088 ErrorPolicy retry-job
1089 ErrorPolicy stop-printer
1092 <H3>Description
</H3>
1094 <P>The
<CODE>ErrorPolicy
</CODE> directive defines the default policy that
1095 is used when a backend is unable to send a print job to the
1098 <P>The following values are supported:
</P>
1102 <LI><CODE>abort-job
</CODE> - Abort the job and proceed
1103 with the next job in the queue
</LI>
1105 <LI><CODE>retry-job
</CODE> - Retry the job after waiting
1106 for N seconds; the
<VAR>cupsd.conf
</VAR> <A
1107 HREF=
"#JobRetryInterval"><CODE>JobRetryInterval
</CODE></A>
1108 directive controls the value of N
</LI>
1110 <LI><CODE>stop-printer
</CODE> - Stop the printer and keep
1111 the job for future printing; this is the default
1117 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.18</SPAN><A NAME=
"FileDevice">FileDevice
</A></H2>
1121 <PRE CLASS=
"command">
1126 <H3>Description
</H3>
1128 <P>The
<CODE>FileDevice
</CODE> directive determines whether the
1129 scheduler allows new printers to be added using device URIs of
1130 the form
<CODE>file:/filename
</CODE>. File devices are most often
1131 used to test new printer drivers and do not support raw file
1134 <P>The default setting is
<CODE>No
</CODE>.
</P>
1136 <BLOCKQUOTE><B>Note:
</B>
1138 <P>File devices are managed by the scheduler. Since the
1139 scheduler normally runs as the root user, file devices
1140 can be used to overwrite system files and potentially
1141 gain unauthorized access to the system. If you must
1142 create printers using file devices, we recommend that
1143 you set the
<CODE>FileDevice
</CODE> directive to
1144 <CODE>Yes
</CODE> for only as long as you need to add the
1145 printers to the system, and then reset the directive to
1146 <CODE>No
</CODE>.
</P>
1151 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.3</SPAN><A NAME=
"FilterLimit">FilterLimit
</A></H2>
1155 <PRE CLASS=
"command">
1161 <H3>Description
</H3>
1163 <P>The
<CODE>FilterLimit
</CODE> directive sets the maximum cost
1164 of all running job filters. It can be used to limit the number of
1165 filter programs that are run on a server to minimize disk,
1166 memory, and CPU resource problems. A limit of
0 disables filter
1169 <P>An average print to a non-PostScript printer needs a filter
1170 limit of about
200. A PostScript printer needs about half that
1171 (
100). Setting the limit below these thresholds will effectively
1172 limit the scheduler to printing a single job at any time.
</P>
1174 <P>The default limit is
0.
</P>
1177 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.16</SPAN><A NAME=
"FilterNice">FilterNice
</A></H2>
1181 <PRE CLASS=
"command">
1187 <H3>Description
</H3>
1189 <P>The
<CODE>FilterNice
</CODE> directive sets the
<B>nice(
1)
</B>
1190 value to assign to filter processes. The nice value ranges from
1191 0, the highest priority, to
19, the lowest priority. The default
1195 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.3</SPAN><A NAME=
"FontPath">FontPath
</A></H2>
1199 <PRE CLASS=
"command">
1200 FontPath /foo/bar/fonts
1201 FontPath /usr/share/cups/fonts:/foo/bar/fonts
1204 <H3>Description
</H3>
1206 <P>The
<CODE>FontPath
</CODE> directive specifies the font path to
1207 use when searching for fonts. The default font path is
1208 <CODE>/usr/share/cups/fonts
</CODE>.
</P>
1211 <H2 CLASS=
"title"><A NAME=
"Group">Group
</A></H2>
1215 <PRE CLASS=
"command">
1220 <H3>Description
</H3>
1222 <P>The
<CODE>Group
</CODE> directive specifies the UNIX group that
1223 filter and CGI programs run as. The default group is
1224 system-specific but is usually
<CODE>lp
</CODE> or
1225 <CODE>nobody
</CODE>.
</P>
1228 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.3</SPAN><A NAME=
"GSSServiceName">GSSServiceName
</A></H2>
1232 <PRE CLASS=
"command">
1237 <H3>Description
</H3>
1239 <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>
1242 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.10</SPAN><A NAME=
"HideImplicitMembers">HideImplicitMembers
</A></H2>
1246 <PRE CLASS=
"command">
1247 HideImplicitMembers Yes
1248 HideImplicitMembers No
1251 <H3>Description
</H3>
1253 <P>The
<CODE>HideImplicitMembers
</CODE> directive controls
1254 whether the individual printers in an implicit class are hidden
1255 from the user. The default is
<CODE>Yes
</CODE>.
</P>
1257 <P><A HREF=
"#ImplicitClasses"><CODE>ImplicitClasses
</CODE></A>
1258 must be enabled for this directive to have any effect.
</P>
1261 <H2 CLASS=
"title"><A NAME=
"HostNameLookups">HostNameLookups
</A></H2>
1265 <PRE CLASS=
"command">
1268 HostNameLookups Double
1271 <H3>Description
</H3>
1273 <P>The
<CODE>HostNameLookups
</CODE> directive controls whether or
1274 not CUPS looks up the hostname for connecting clients. The
1275 <CODE>Double
</CODE> setting causes CUPS to verify that the
1276 hostname resolved from the address matches one of the addresses
1277 returned for that hostname.
<CODE>Double
</CODE> lookups also
1278 prevent clients with unregistered addresses from connecting to
1281 <P>The default is
<CODE>Off
</CODE> to avoid the potential server
1282 performance problems with hostname lookups. Set this option to
1283 <CODE>On
</CODE> or
<CODE>Double
</CODE> only if absolutely
1287 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.10</SPAN><A NAME=
"ImplicitAnyClasses">ImplicitAnyClasses
</A></H2>
1291 <PRE CLASS=
"command">
1292 ImplicitAnyClasses On
1293 ImplicitAnyClasses Off
1296 <H3>Description
</H3>
1298 <P>The
<CODE>ImplicitAnyClasses
</CODE> directive controls
1299 whether implicit classes for local and remote printers are
1300 created with the name
<CODE>AnyPrinter
</CODE>. The default
1301 setting is
<CODE>Off
</CODE>.
</P>
1303 <P><A HREF=
"#ImplicitClasses"><CODE>ImplicitClasses
</CODE></A>
1304 must be enabled for this directive to have any effect.
</P>
1307 <H2 CLASS=
"title"><A NAME=
"ImplicitClasses">ImplicitClasses
</A></H2>
1311 <PRE CLASS=
"command">
1316 <H3>Description
</H3>
1318 <P>The
<CODE>ImplicitClasses
</CODE> directive controls whether
1319 implicit classes are created based upon the available network
1320 printers and classes. The default setting is
1321 <CODE>@CUPS_IMPLICIT_CLASSES@
</CODE> but is automatically turned
1322 <CODE>Off
</CODE> if
<A HREF=
"#Browsing"><CODE>Browsing
</CODE></A> is turned
1323 <CODE>Off
</CODE>.
</P>
1326 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.9</SPAN><A NAME=
"Include">Include
</A></H2>
1330 <PRE CLASS=
"command">
1332 Include /foo/bar/filename
1335 <H3>Description
</H3>
1337 <P>The
<CODE>Include
</CODE> directive includes the named file in
1338 the
<CODE>cupsd.conf
</CODE> file. If no leading path is provided,
1339 the file is assumed to be relative to the
<A
1340 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory.
</P>
1343 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"JobRetryInterval">JobRetryInterval
</A></H2>
1347 <PRE CLASS=
"command">
1349 JobRetryInterval
120
1352 <H3>Description
</H3>
1354 <P>The
<CODE>JobRetryInterval
</CODE> directive specifies the
1355 number of seconds to wait before retrying a job. This is
1356 typically used for fax queues but can also be used with normal
1357 print queues whose error policy is
<CODE>retry-job
</CODE>. The
1358 default is
30 seconds.
</P>
1361 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"JobRetryLimit">JobRetryLimit
</A></H2>
1365 <PRE CLASS=
"command">
1370 <H3>Description
</H3>
1372 <P>The
<CODE>JobRetryLimit
</CODE> directive specifies the maximum
1373 number of times the scheduler will try to print a job. This is
1374 typically used for fax queues but can also be used with normal
1375 print queues whose error policy is
<CODE>retry-job
</CODE>. The
1376 default is
5 times.
</P>
1379 <H2 CLASS=
"title"><A NAME=
"KeepAlive">KeepAlive
</A></H2>
1383 <PRE CLASS=
"command">
1388 <H3>Description
</H3>
1390 <P>The
<CODE>KeepAlive
</CODE> directive controls whether or not
1391 to support persistent HTTP connections. The default is
1392 <CODE>On
</CODE>.
</P>
1394 <P>HTTP/
1.1 clients automatically support persistent connections,
1395 while HTTP/
1.0 clients must specifically request them using the
1396 <CODE>Keep-Alive
</CODE> attribute in the
<CODE>Connection:
</CODE>
1397 field of each request.
</P>
1400 <H2 CLASS=
"title"><A NAME=
"KeepAliveTimeout">KeepAliveTimeout
</A></H2>
1404 <PRE CLASS=
"command">
1409 <H3>Description
</H3>
1411 <P>The
<CODE>KeepAliveTimeout
</CODE> directive controls how long
1412 a persistent HTTP connection will remain open after the last
1413 request. The default is
60 seconds.
</P>
1416 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"Limit">Limit (Location)
</A></H2>
1420 <PRE CLASS=
"command">
1421 <Location /path
>
1422 <Limit GET POST
>
1432 <H3>Description
</H3>
1434 <P>The
<CODE>Limit
</CODE> directive groups access control
1435 directives for specific types of HTTP requests and must appear
1436 inside a
<A HREF=
"#Location"><CODE>Location
</CODE></A> section.
1437 Access can be limited for individual request types
1438 (
<CODE>DELETE
</CODE>,
<CODE>GET
</CODE>,
<CODE>HEAD
</CODE>,
1439 <CODE>OPTIONS
</CODE>,
<CODE>POST
</CODE>,
<CODE>PUT
</CODE>, and
1440 <CODE>TRACE
</CODE>) or for all request types (
<CODE>ALL
</CODE>).
1441 The request type names are case-sensitive for compatibility with
1445 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"LimitIPP">Limit (Policy)
</A></H2>
1449 <PRE CLASS=
"command">
1451 <Limit CUPS-Add-Modify-Printer CUPS-Delete-Printer
>
1461 <H3>Description
</H3>
1463 <P>When included in
<A HREF=
"#Policy"><CODE>Policy
</CODE></A>
1464 sections, the
<CODE>Limit
</CODE> directive groups access control
1465 directives for specific IPP operations. Multiple operations can
1466 be listed, separated by spaces. Table
2 lists the supported
1469 <DIV CLASS=
"table"><TABLE SUMMARY=
"Supported IPP Operations">
1470 <CAPTION>Table
2:
<A NAME=
"TABLE2">Supported IPP Operations
</A></CAPTION>
1473 <TH>Operation Name
</TH>
1474 <TH>Description
</TH>
1480 <TD>All operations - used as the default limit for
1481 operations that are not listed
</TD>
1485 <TD>Cancel a job
</TD>
1488 <TD>Cancel-Subscription
</TD>
1489 <TD>Cancel a subscription
</TD>
1493 <TD>Create a new, empty job
</TD>
1496 <TD>Create-Job-Subscription
</TD>
1497 <TD>Creates a notification subscription on a job
</TD>
1500 <TD>Create-Printer-Subscription
</TD>
1501 <TD>Creates a notification subscription on a printer
</TD>
1504 <TD>CUPS-Accept-Jobs
</TD>
1505 <TD>Sets the printer-is-accepting-jobs value for a printer to true
</TD>
1508 <TD>CUPS-Add-Modify-Class
</TD>
1509 <TD>Adds or modifies a class
</TD>
1512 <TD>CUPS-Add-Modify-Printer
</TD>
1513 <TD>Adds or modifies a printer
</TD>
1516 <TD>CUPS-Authenticate-Job
</TD>
1517 <TD>Authenticates a job for printing
</TD>
1520 <TD>CUPS-Delete-Class
</TD>
1521 <TD>Deletes a class
</TD>
1524 <TD>CUPS-Delete-Printer
</TD>
1525 <TD>Deletes a printer
</TD>
1528 <TD>CUPS-Get-Classes
</TD>
1529 <TD>Gets a list of classes
</TD>
1532 <TD>CUPS-Get-Default
</TD>
1533 <TD>Gets the (network/server) default printer or class
</TD>
1536 <TD>CUPS-Get-Devices
</TD>
1537 <TD>Gets a list of available devices
</TD>
1540 <TD>CUPS-Get-PPDs
</TD>
1541 <TD>Gets a list of available manufacturers or drivers
</TD>
1544 <TD>CUPS-Get-Printers
</TD>
1545 <TD>Gets a list of printers and/or classes
</TD>
1548 <TD>CUPS-Move-Job
</TD>
1549 <TD>Moves a job to a new destination
</TD>
1552 <TD>CUPS-Reject-Jobs
</TD>
1553 <TD>Sets the printer-is-accepting-jobs value for a printer to false
</TD>
1556 <TD>CUPS-Set-Default
</TD>
1557 <TD>Sets the network/server default printer or class
</TD>
1560 <TD>Disable-Printer
</TD>
1561 <TD>Sets the printer-state value for a printer to stopped
</TD>
1564 <TD>Enable-Printer
</TD>
1565 <TD>Sets the printer-state value for a printer to idle/processing
</TD>
1568 <TD>Get-Job-Attributes
</TD>
1569 <TD>Gets information about a job
</TD>
1573 <TD>Gets a list of jobs
</TD>
1576 <TD>Get-Notifications
</TD>
1577 <TD>Gets a list of events
</TD>
1580 <TD>Get-Printer-Attributes
</TD>
1581 <TD>Gets informaion about a printer or class
</TD>
1584 <TD>Get-Subscription-Attributes
</TD>
1585 <TD>Gets informaion about a notification subscription
</TD>
1588 <TD>Get-Subscriptions
</TD>
1589 <TD>Gets a list of notification subscriptions
</TD>
1593 <TD>Holds a job for printing
</TD>
1596 <TD>Pause-Printer
</TD>
1597 <TD>Sets the printer-state value for a printer to stopped
</TD>
1601 <TD>Creates a job with a single file for printing
</TD>
1605 <TD>Removes all jobs from a printer
</TD>
1608 <TD>Release-Job
</TD>
1609 <TD>Releases a previously held job for printing
</TD>
1612 <TD>Renew-Subscription
</TD>
1613 <TD>Renews a notification subscription
</TD>
1616 <TD>Restart-Job
</TD>
1617 <TD>Reprints a job
</TD>
1620 <TD>Resume-Printer
</TD>
1621 <TD>Sets the printer-stae value for a printer to idle/processing
</TD>
1624 <TD>Send-Document
</TD>
1625 <TD>Adds a file to an job created with Create-Job
</TD>
1628 <TD>Set-Job-Attributes
</TD>
1629 <TD>Changes job options
</TD>
1632 <TD>Validate-Job
</TD>
1633 <TD>Validates job options prior to printing
</TD>
1639 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"LimitExcept">LimitExcept
</A></H2>
1643 <PRE CLASS=
"command">
1644 <Location /path
>
1645 <LimitExcept GET POST
>
1647 </LimitExcept
>
1651 <H3>Description
</H3>
1653 <P>The
<CODE>LimitExcept
</CODE> directive groups access control
1654 directives for specific types of HTTP requests and must appear
1655 inside a
<A HREF=
"#Location"><CODE>Location
</CODE></A> section.
1656 Unlike the
<A HREF=
"#Limit"><CODE>Limit
</CODE></A> directive,
1657 <CODE>LimitExcept
</CODE> restricts access for all requests
1658 <I>except
</I> those listed on the
<CODE>LimitExcept
</CODE>
1662 <H2 CLASS=
"title"><A NAME=
"LimitRequestBody">LimitRequestBody
</A></H2>
1666 <PRE CLASS=
"command">
1667 LimitRequestBody
10485760
1668 LimitRequestBody
10m
1672 <H3>Description
</H3>
1674 <P>The
<CODE>LimitRequestBody
</CODE> directive controls the
1675 maximum size of print files, IPP requests, and HTML form data in
1676 HTTP POST requests. The default limit is
0 which disables the
1680 <H2 CLASS=
"title"><A NAME=
"Listen">Listen
</A></H2>
1684 <PRE CLASS=
"command">
1685 Listen
127.0.0.1:
631
1686 Listen
192.0.2.1:
631
1691 <H3>Description
</H3>
1693 <P>The
<CODE>Listen
</CODE> directive specifies a network address
1694 and port to listen for connections. Multiple
<CODE>Listen
</CODE>
1695 directives can be provided to listen on multiple addresses.
</P>
1697 <P>The
<CODE>Listen
</CODE> directive is similar to the
<A
1698 HREF=
"#Port"><CODE>Port
</CODE></A> directive but allows you to
1699 restrict access to specific interfaces or networks.
</P>
1702 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"ListenBackLog">ListenBackLog
</A></H2>
1706 <PRE CLASS=
"command">
1711 <H3>Description
</H3>
1713 <P>The
<CODE>ListenBackLog
</CODE> directive sets the maximum
1714 number of pending connections the scheduler will allow. This
1715 normally only affects very busy servers that have reached the
<A
1716 HREF=
"#MaxClients"><CODE>MaxClients
</CODE></A> limit, but can
1717 also be triggered by large numbers of simultaneous connections.
1718 When the limit is reached, the operating system will refuse
1719 additional connections until the scheduler can accept the pending
1720 ones. The default is the OS-defined default limit, typically
1721 either
5 for older operating systems or
128 for newer operating
1725 <H2 CLASS=
"title"><A NAME=
"Location">Location
</A></H2>
1729 <PRE CLASS=
"command">
1734 <Location /admin
>
1738 <Location /admin/conf
>
1742 <Location /admin/log
>
1746 <Location /classes
>
1750 <Location /classes/name
>
1754 <Location /jobs
>
1758 <Location /printers
>
1762 <Location /printers/name
>
1768 <H3>Description
</H3>
1770 <P>The
<CODE>Location
</CODE> directive specifies access control
1771 and authentication options for the specified HTTP resource or
1772 path. The
<A HREF=
"#Allow"><CODE>Allow
</CODE></A>,
<A
1773 HREF=
"#AuthType"><CODE>AuthType
</CODE></A>,
<A
1774 HREF=
"#Deny"><CODE>Deny
</CODE></A>,
<A
1775 HREF=
"#Encryption"><CODE>Encryption
</CODE></A>,
<A
1776 HREF=
"#Limit"><CODE>Limit
</CODE></A>,
<A
1777 HREF=
"#LimitExcept"><CODE>LimitExcept
</CODE></A>,
<A
1778 HREF=
"#Order"><CODE>Order
</CODE></A>,
<A
1779 HREF=
"#Require"><CODE>Require
</CODE></A>, and
<A
1780 HREF=
"#Satisfy"><CODE>Satisfy
</CODE></A> directives may all
1781 appear inside a location.
</P>
1783 <P>Note that more specific resources override the less specific
1784 ones. So the directives inside the
<CODE>/printers/name
</CODE>
1785 location will override ones from
<CODE>/printers
</CODE>.
1786 Directives inside
<CODE>/printers
</CODE> will override ones from
1787 <CODE>/
</CODE>. None of the directives are inherited.
</P>
1789 <DIV CLASS=
"table"><TABLE SUMMARY=
"Common Locaions on the Server">
1790 <CAPTION>Table
3:
<A NAME=
"TABLE3">Common Locations on the Server
</A></CAPTION>
1792 <TR><TH>Location
</TH><TH>Description
</TH></TR>
1795 <TR><TD><CODE>/
</CODE></TD><TD>The path for all get operations (get-printers, get-jobs, etc.)
</TD></TR>
1796 <TR><TD><CODE>/admin
</CODE></TD><TD>The path for all administration operations (add-printer, delete-printer, start-printer, etc.)
</TD></TR>
1797 <TR><TD><CODE>/admin/conf
</CODE></TD><TD>The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.)
</TD></TR>
1798 <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>
1799 <TR><TD><CODE>/classes
</CODE></TD><TD>The path for all classes
</TD></TR>
1800 <TR><TD><CODE>/classes/name
</CODE></TD><TD>The resource for class
<CODE>name
</CODE></TD></TR>
1801 <TR><TD><CODE>/jobs
</CODE></TD><TD>The path for all jobs (hold-job, release-job, etc.)
</TD></TR>
1802 <TR><TD><CODE>/jobs/id
</CODE></TD><TD>The resource for job
<CODE>id
</CODE></TD></TR>
1803 <TR><TD><CODE>/printers
</CODE></TD><TD>The path for all printers
</TD></TR>
1804 <TR><TD><CODE>/printers/name
</CODE></TD><TD>The path for printer
<CODE>name
</CODE></TD></TR>
1805 <TR><TD><CODE>/printers/name.ppd
</CODE></TD><TD>The PPD file path for printer
<CODE>name
</CODE></TD></TR>
1810 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.15</SPAN><A NAME=
"LogFilePerm">LogFilePerm
</A></H2>
1814 <PRE CLASS=
"command">
1819 <H3>Description
</H3>
1821 <P>The
<CODE>LogFilePerm
</CODE> directive specifies the
1822 permissions to use when writing configuration files. The default
1823 is @CUPS_LOG_FILE_PERM@.
</P>
1826 <H2 CLASS=
"title"><A NAME=
"LogLevel">LogLevel
</A></H2>
1830 <PRE CLASS=
"command">
1843 <H3>Description
</H3>
1845 <P>The
<CODE>LogLevel
</CODE> directive specifies the level of
1846 logging for the
<A HREF=
"#ErrorLog"><CODE>ErrorLog
</CODE></A>
1847 file. The following values are recognized (each level logs
1848 everything under the preceding levels):
</P>
1852 <LI><CODE>none
</CODE> - Log nothing
</LI>
1854 <LI><CODE>emerg
</CODE> - Log emergency conditions that
1855 prevent the server from running
</LI>
1857 <LI><CODE>alert
</CODE> - Log alerts that must be handled
1860 <LI><CODE>crit
</CODE> - Log critical errors that don't
1861 prevent the server from running
</LI>
1863 <LI><CODE>error
</CODE> - Log general errors
</LI>
1865 <LI><CODE>warn
</CODE> - Log errors and warnings
</LI>
1867 <LI><CODE>notice
</CODE> - Log temporary error conditions
</LI>
1869 <LI><CODE>info
</CODE> - Log all requests and state
1870 changes (default)
</LI>
1872 <LI><CODE>debug
</CODE> - Log basic debugging
1875 <LI><CODE>debug2
</CODE> - Log all debugging
1881 <H2 CLASS=
"title"><A NAME=
"MaxClients">MaxClients
</A></H2>
1885 <PRE CLASS=
"command">
1890 <H3>Description
</H3>
1892 <P>The
<CODE>MaxClients
</CODE> directive controls the maximum
1893 number of simultaneous clients that will be allowed by the
1894 server. The default is
100 clients.
</P>
1896 <BLOCKQUOTE><B>Note:
</B>
1898 <P>Since each print job requires a file descriptor for the status
1899 pipe, the scheduler internally limits the
<CODE>MaxClients
</CODE>
1900 value to
1/
3 of the available file descriptors to avoid possible
1901 problems when printing large numbers of jobs.
</P>
1906 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.18</SPAN><A NAME=
"MaxClientsPerHost">MaxClientsPerHost
</A></H2>
1910 <PRE CLASS=
"command">
1911 MaxClientsPerHost
10
1914 <H3>Description
</H3>
1916 <P>The
<CODE>MaxClientsPerHost
</CODE> directive controls the
1917 maximum number of simultaneous clients that will be allowed from
1918 a single host by the server. The default is the
1919 <CODE>MaxClients
</CODE> value.
</P>
1921 <P>This directive provides a small measure of protection against
1922 Denial of Service attacks from a single host.
</P>
1925 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.16</SPAN><A NAME=
"MaxCopies">MaxCopies
</A></H2>
1929 <PRE CLASS=
"command">
1934 <H3>Description
</H3>
1936 <P>The
<CODE>MaxCopies
</CODE> directive controls the maximum
1937 number of copies that a user can print of a job. The default is
1938 @CUPS_MAX_COPIES@ copies.
</P>
1940 <BLOCKQUOTE><B>Note:
</B>
1942 <P>Most HP PCL laser printers internally limit the number of
1949 <H2 CLASS=
"title"><A NAME=
"MaxJobs">MaxJobs
</A></H2>
1953 <PRE CLASS=
"command">
1959 <H3>Description
</H3>
1961 <P>The
<CODE>MaxJobs
</CODE> directive controls the maximum number
1962 of jobs that are kept in memory. Once the number of jobs reaches
1963 the limit, the oldest completed job is automatically purged from
1964 the system to make room for the new one. If all of the known jobs
1965 are still pending or active then the new job will be
1968 <P>Setting the maximum size to
0 disables this functionality. The
1969 default setting is
500.
</P>
1972 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"MaxJobsPerPrinter">MaxJobsPerPrinter
</A></H2>
1976 <PRE CLASS=
"command">
1977 MaxJobsPerPrinter
100
1978 MaxJobsPerPrinter
9999
1982 <H3>Description
</H3>
1984 <P>The
<CODE>MaxJobsPerPrinter
</CODE> directive controls the
1985 maximum number of active jobs that are allowed for each printer
1986 or class. Once a printer or class reaches the limit, new jobs
1987 will be rejected until one of the active jobs is completed,
1988 stopped, aborted, or canceled.
</P>
1990 <P>Setting the maximum to
0 disables this functionality. The
1991 default setting is
0.
</P>
1994 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"MaxJobsPerUser">MaxJobsPerUser
</A></H2>
1998 <PRE CLASS=
"command">
2004 <H3>Description
</H3>
2006 <P>The
<CODE>MaxJobsPerUser
</CODE> directive controls the maximum
2007 number of active jobs that are allowed for each user. Once a user
2008 reaches the limit, new jobs will be rejected until one of the
2009 active jobs is completed, stopped, aborted, or canceled.
</P>
2011 <P>Setting the maximum to
0 disables this functionality. The
2012 default setting is
0.
</P>
2015 <H2 CLASS=
"title"><A NAME=
"MaxLogSize">MaxLogSize
</A></H2>
2019 <PRE CLASS=
"command">
2025 <H3>Description
</H3>
2027 <P>The
<CODE>MaxLogSize
</CODE> directive controls the maximum
2028 size of each log file. Once a log file reaches or exceeds the
2029 maximum size it is closed and renamed to
<VAR>filename.O
</VAR>.
2030 This allows you to rotate the logs automatically. The default
2031 size is
1048576 bytes (
1MB).
</P>
2033 <P>Setting the maximum size to
0 disables log rotation.
</P>
2036 <H2 CLASS=
"title"><SPAN CLASS=
"info">Deprecated
</SPAN><A NAME=
"MaxRequestSize">MaxRequestSize
</A></H2>
2040 <PRE CLASS=
"command">
2041 MaxRequestSize
10485760
2046 <H3>Description
</H3>
2048 <P>The
<CODE>MaxRequestSize
</CODE> directive controls the maximum
2049 size of print files, IPP requests, and HTML form data in HTTP
2050 POST requests. The default limit is
0 which disables the limit
2053 <P><B>This directive is deprecated and will be removed in a
2054 future CUPS release.
</B> Use the
<A
2055 HREF=
"#LimitRequestBody"><CODE>LimitRequestBody
</CODE></A>
2056 directive instead.
</P>
2059 <H2 CLASS=
"title"><A NAME=
"Order">Order
</A></H2>
2063 <PRE CLASS=
"command">
2064 <Location /path
>
2071 <H3>Description
</H3>
2073 <P>The
<CODE>Order
</CODE> directive defines the default access
2074 control. The following values are supported:
</P>
2078 <LI><CODE>allow,deny
</CODE> - Deny requests by default,
2079 then check the
<A HREF=
"#Allow"><CODE>Allow
</CODE></A>
2080 lines followed by the
<A
2081 HREF=
"#Deny"><CODE>Deny
</CODE></A> lines
</LI>
2083 <LI><CODE>deny,allow
</CODE> - Allow requests by default,
2084 then check the
<A HREF=
"#Deny"><CODE>Deny
</CODE></A>
2085 lines followed by the
<A
2086 HREF=
"#Allow"><CODE>Allow
</CODE></A> lines
</LI>
2090 <P>The
<CODE>Order
</CODE> directive must appear inside a
<A
2091 HREF=
"#Location"><CODE>Location
</CODE></A> or
<A
2092 HREF=
"#Limit"><CODE>Limit
</CODE></A> section.
</P>
2095 <H2 CLASS=
"title"><A NAME=
"PageLog">PageLog
</A></H2>
2099 <PRE CLASS=
"command">
2100 PageLog /var/log/cups/page_log
2101 PageLog /var/log/cups/page_log-%s
2105 <H3>Description
</H3>
2107 <P>The
<CODE>PageLog
</CODE> directive sets the name of the page
2108 log file. If the filename is not absolute then it is assumed to
2109 be relative to the
<A
2110 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory. The
2111 default page log file is
<VAR>@CUPS_LOGDIR@/page_log
</VAR>.
</P>
2113 <P>The server name can be included in the filename by using
2114 <CODE>%s
</CODE> in the name.
</P>
2116 <P>The special name
"syslog" can be used to send the page
2117 information to the system log instead of a plain file.
</P>
2120 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"PassEnv">PassEnv
</A></H2>
2124 <PRE CLASS=
"command">
2125 PassEnv MY_ENV_VARIABLE
2128 <H3>Description
</H3>
2130 <P>The
<CODE>PassEnv
</CODE> directive specifies an environment
2131 variable that should be passed to child processes. Normally, the
2132 scheduler only passes the
<CODE>DYLD_LIBRARY_PATH
</CODE>,
2133 <CODE>LD_ASSUME_KERNEL
</CODE>,
<CODE>LD_LIBRARY_PATH
</CODE>,
2134 <CODE>LD_PRELOAD
</CODE>,
<CODE>NLSPATH
</CODE>,
2135 <CODE>SHLIB_PATH
</CODE>,
<CODE>TZ
</CODE>, and
<CODE>VGARGS
</CODE>
2136 environment variables to child processes.
</P>
2139 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"Policy">Policy
</A></H2>
2143 <PRE CLASS=
"command">
2145 <Limit operation ... operation
>
2148 <Limit operation ... operation
>
2157 <H3>Description
</H3>
2159 <P>The
<CODE>Policy
</CODE> directive specifies IPP operation
2160 access control limits. Each policy contains
1 or more
<A
2161 HREF=
"#LimitIPP"><CODE>Limit
</CODE></A> sections to set the
2162 access control limits for specific operations - user limits,
2163 authentication, encryption, and allowed/denied addresses,
2164 domains, or hosts. The
<CODE><Limit All
></CODE> section
2165 specifies the default access control limits for operations that
2168 <P>Policies are named and associated with printers via the
2169 printer's operation policy setting
2170 (
<CODE>printer-op-policy
</CODE>). The default policy for the
2171 scheduler is specified using the
<A
2172 HREF=
"#DefaultPolicy"><CODE>DefaultPolicy
</CODE></A>
2176 <H2 CLASS=
"title"><A NAME=
"Port">Port
</A></H2>
2180 <PRE CLASS=
"command">
2185 <H3>Description
</H3>
2187 <P>The
<CODE>Port
</CODE> directive specifies a port to listen on.
2188 Multiple
<CODE>Port
</CODE> lines can be specified to listen on
2189 multiple ports. The
<CODE>Port
</CODE> directive is equivalent to
2190 "<CODE>Listen *:nnn</CODE>". The default port is
631.
</P>
2192 <BLOCKQUOTE><B>Note:
</B>
2194 <P>On systems that support IPv6, this directive will bind to both
2195 the IPv4 and IPv6 wildcard address.
</P>
2200 <H2 CLASS=
"title"><A NAME=
"PreserveJobHistory">PreserveJobHistory
</A></H2>
2204 <PRE CLASS=
"command">
2205 PreserveJobHistory On
2206 PreserveJobHistory Off
2209 <H3>Description
</H3>
2211 <P>The
<CODE>PreserveJobHistory
</CODE> directive controls whether
2212 the history of completed, canceled, or aborted print jobs is
2215 <P>A value of
<CODE>On
</CODE> (the default) preserves job
2216 information until the administrator purges it with the
2217 <CODE>cancel
</CODE> command.
</P>
2219 <P>A value of
<CODE>Off
</CODE> removes the job information as
2220 soon as each job is completed, canceled, or aborted.
</P>
2223 <H2 CLASS=
"title"><A NAME=
"PreserveJobFiles">PreserveJobFiles
</A></H2>
2227 <PRE CLASS=
"command">
2229 PreserveJobFiles Off
2232 <H3>Description
</H3>
2234 <P>The
<CODE>PreserveJobFiles
</CODE> directive controls whether
2235 the document files of completed, canceled, or aborted print jobs
2236 are stored on disk.
</P>
2238 <P>A value of
<CODE>On
</CODE> preserves job files until the
2239 administrator purges them with the
<CODE>cancel
</CODE> command.
2240 Jobs can be restarted (and reprinted) as desired until they are
2243 <P>A value of
<CODE>Off
</CODE> (the default) removes the job
2244 files as soon as each job is completed, canceled, or aborted.
</P>
2247 <H2 CLASS=
"title"><A NAME=
"Printcap">Printcap
</A></H2>
2251 <PRE CLASS=
"command">
2253 Printcap /etc/printcap
2254 Printcap /etc/printers.conf
2257 <H3>Description
</H3>
2259 <P>The
<CODE>Printcap
</CODE> directive controls whether or not a
2260 printcap file is automatically generated and updated with a list
2261 of available printers. If specified with no value, then no
2262 printcap file will be generated. The default is to generate a
2263 file named
<VAR>/etc/printcap
</VAR>.
</P>
2265 <P>When a filename is specified (e.g.
<VAR>/etc/printcap
</VAR>),
2266 the printcap file is written whenever a printer is added or
2267 removed. The printcap file can then be used by applications that
2268 are hardcoded to look at the printcap file for the available
2272 <H2 CLASS=
"title"><A NAME=
"PrintcapFormat">PrintcapFormat
</A></H2>
2276 <PRE CLASS=
"command">
2278 PrintcapFormat Solaris
2281 <H3>Description
</H3>
2283 <P>The
<CODE>PrintcapFormat
</CODE> directive controls the output
2284 format of the printcap file. The default is to generate a BSD
2288 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.13</SPAN><A NAME=
"PrintcapGUI">PrintcapGUI
</A></H2>
2292 <PRE CLASS=
"command">
2293 PrintGUI /usr/bin/glpoptions
2296 <H3>Description
</H3>
2298 <P>The
<CODE>PrintcapGUI
</CODE> directive sets the program to
2299 associate with the IRIX printer GUI interface script which is
2300 used by IRIX applications to display printer-specific options.
2301 There is no default program.
</P>
2304 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.21</SPAN><A NAME=
"ReloadTimeout">ReloadTimeout
</A></H2>
2308 <PRE CLASS=
"command">
2313 <H3>Description
</H3>
2315 <P>The
<CODE>ReloadTimeout
</CODE> directive specifies the number
2316 of seconds the scheduler will wait for active jobs to complete
2317 before doing a restart. The default is
60 seconds.
</P>
2320 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.3</SPAN><A NAME=
"RemoteRoot">RemoteRoot
</A></H2>
2324 <PRE CLASS=
"command">
2329 <H3>Description
</H3>
2331 <P>The
<CODE>RemoteRoot
</CODE> directive sets the username for
2332 unauthenticated root requests from remote hosts. The default
2333 username is
<VAR>remroot
</VAR>. Setting
<CODE>RemoteRoot
</CODE>
2334 to
<VAR>root
</VAR> effectively disables this security
2338 <H2 CLASS=
"title"><A NAME=
"RequestRoot">RequestRoot
</A></H2>
2342 <PRE CLASS=
"command">
2343 RequestRoot /var/spool/cups
2344 RequestRoot /foo/bar/spool/cups
2347 <H3>Description
</H3>
2349 <P>The
<CODE>RequestRoot
</CODE> directive sets the directory for
2350 incoming IPP requests and HTML forms. If an absolute path is not
2351 provided then it is assumed to be relative to the
<A
2352 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory. The
2353 default request directory is
<VAR>@CUPS_REQUESTS@
</VAR>.
</P>
2356 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"Require">Require
</A></H2>
2360 <PRE CLASS=
"command">
2361 <Location /path
>
2363 Require group foo bar
2364 Require user john mary
2366 Require user @groupname
2367 Require user @SYSTEM
2372 <H3>Description
</H3>
2374 <P>The
<CODE>Require
</CODE> directive specifies that
2375 authentication is required for the resource. The
2376 <CODE>group
</CODE> keyword specifies that the authenticated user
2377 must be a member of one or more of the named groups that
2380 <P>The
<CODE>user
</CODE> keyboard specifies that the
2381 authenticated user must be one of the named users or groups that
2382 follow. Group names are specified using the
"@" prefix.
</P>
2384 <P>The
<CODE>valid-user
</CODE> keyword specifies that any
2385 authenticated user may access the resource.
</P>
2387 <P>The default is to do no authentication. This directive must
2388 appear inside a
<A HREF=
"#Location"><CODE>Location
</CODE></A> or
2389 <A HREF=
"#Limit"><CODE>Limit
</CODE></A> section.
</P>
2392 <H2 CLASS=
"title"><A NAME=
"RIPCache">RIPCache
</A></H2>
2396 <PRE CLASS=
"command">
2402 <H3>Description
</H3>
2404 <P>The
<CODE>RIPCache
</CODE> directive sets the size of the
2405 memory cache used by Raster Image Processor (
"RIP") filters such
2406 as
<CODE>imagetoraster
</CODE> and
<CODE>pstoraster
</CODE>. The
2407 size can be suffixed with a
"k" for kilobytes,
"m" for megabytes,
2408 or
"g" for gigabytes. The default cache size is
"8m", or
8
2412 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.16</SPAN><A NAME=
"RootCertDuration">RootCertDuration
</A></H2>
2416 <PRE CLASS=
"command">
2418 RootCertDuration
300
2421 <H3>Description
</H3>
2423 <P>The
<CODE>RootCertDuration
</CODE> directive specifies the
2424 number of seconds the
<EM>root certificate
</EM> remains valid.
2425 The scheduler will generate a new certificate as needed when the
2426 number of seconds has expired. If set to
0, the root certificate
2427 is generated only once on startup or on a restart. The default is
2431 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"Satisfy">Satisfy
</A></H2>
2435 <PRE CLASS=
"command">
2436 <Location /path
>
2443 <H3>Description
</H3>
2445 <P>The
<CODE>Satisfy
</CODE> directive specifies whether all
2446 conditions must be satisfied to allow access to the resource. If
2447 set to
<CODE>all
</CODE>, then all authentication and access
2448 control conditions must be satified to allow access.
</P>
2450 <P>Setting
<CODE>Satisfy
</CODE> to
<CODE>any
</CODE> allows a user
2451 to gain access if the authentication or access control
2452 requirements are satisfied. For example, you might require
2453 authentication for remote access, but allow local access without
2456 <P>The default is
<CODE>all
</CODE>. This directive must appear
2457 inside a
<A HREF=
"#Location"><CODE>Location
</CODE></A> or
<A
2458 HREF=
"#Limit"><CODE>Limit
</CODE></A> section.
</P>
2461 <H2 CLASS=
"title"><A NAME=
"ServerAdmin">ServerAdmin
</A></H2>
2465 <PRE CLASS=
"command">
2466 ServerAdmin user@host
2467 ServerAdmin root@foo.bar.com
2470 <H3>Description
</H3>
2472 <P>The
<CODE>ServerAdmin
</CODE> directive identifies the email
2473 address for the administrator on the system. By default the
2474 administrator email address is
<CODE>root@server
</CODE>, where
2475 <CODE>server
</CODE> is the
<A
2476 HREF=
"#ServerName"><CODE>ServerName
</CODE></A>.
</P>
2479 <H2 CLASS=
"title"><A NAME=
"ServerBin">ServerBin
</A></H2>
2483 <PRE CLASS=
"command">
2484 ServerBin /usr/lib/cups
2485 ServerBin /foo/bar/lib/cups
2488 <H3>Description
</H3>
2490 <P>The
<CODE>ServerBin
</CODE> directive sets the directory for
2491 server-run executables. If an absolute path is not provided then
2492 it is assumed to be relative to the
<A
2493 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory. The
2494 default executable directory is
<VAR>/usr/lib/cups
</VAR>,
2495 <VAR>/usr/lib32/cups
</VAR>, or
<VAR>/usr/libexec/cups
</VAR>
2496 depending on the operating system.
</P>
2499 <H2 CLASS=
"title"><A NAME=
"ServerCertificate">ServerCertificate
</A></H2>
2503 <PRE CLASS=
"command">
2504 ServerCertificate /etc/cups/ssl/server.crt
2507 <H3>Description
</H3>
2509 <P>The
<CODE>ServerCertificate
</CODE> directive specifies the
2510 location of the SSL certificate file used by the server when
2511 negotiating encrypted connections. The certificate must not be
2512 encrypted (password protected) since the scheduler normally runs
2513 in the background and will be unable to ask for a password.
</P>
2515 <P>The default certificate file is
2516 <VAR>/etc/cups/ssl/server.crt
</VAR>.
</P>
2519 <H2 CLASS=
"title"><A NAME=
"ServerKey">ServerKey
</A></H2>
2523 <PRE CLASS=
"command">
2524 ServerKey /etc/cups/ssl/server.key
2527 <H3>Description
</H3>
2529 <P>The
<CODE>ServerKey
</CODE> directive specifies the location of
2530 the SSL private key file used by the server when negotiating
2531 encrypted connections.
</P>
2533 <P>The default key file is
2534 <VAR>/etc/cups/ssl/server.crt
</VAR>.
</P>
2537 <H2 CLASS=
"title"><A NAME=
"ServerName">ServerName
</A></H2>
2541 <PRE CLASS=
"command">
2542 ServerName foo.domain.com
2543 ServerName myserver.domain.com
2546 <H3>Description
</H3>
2548 <P>The
<CODE>ServerName
</CODE> directive specifies the hostname
2549 that is reported to clients. By default the server name is the
2553 <H2 CLASS=
"title"><A NAME=
"ServerRoot">ServerRoot
</A></H2>
2557 <PRE CLASS=
"command">
2558 ServerRoot /etc/cups
2559 ServerRoot /foo/bar/cups
2562 <H3>Description
</H3>
2564 <P>The
<CODE>ServerRoot
</CODE> directive specifies the absolute
2565 path to the server configuration and state files. It is also used
2566 to resolve relative paths in the
<VAR>cupsd.conf
</VAR> file. The
2567 default server directory is
<VAR>/etc/cups
</VAR>.
</P>
2570 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.21</SPAN><A NAME=
"ServerTokens">ServerTokens
</A></H2>
2574 <PRE CLASS=
"command">
2576 ServerTokens ProductOnly
2579 ServerTokens Minimal
2584 <H3>Description
</H3>
2586 <P>The
<CODE>ServerTokens
</CODE> directive specifies the
2587 information that is included in the
<CODE>Server:
</CODE> header
2588 of all HTTP responses. Table
4 lists the token name along with
2589 the text that is returned. The default is
2590 <CODE>Minimal
</CODE>.
</P>
2592 <DIV CLASS=
"table"><TABLE SUMMARY=
"ServerToken Names and Values">
2593 <CAPTION>Table
4:
<A NAME=
"TABLE4">ServerToken Names and Values
</A></CAPTION>
2603 <TD>No
<CODE>Server:
</CODE> header is returned
</TD>
2606 <TD>ProductOnly
</TD>
2619 <TD>"CUPS 1.2.N" where N is the patch release
</TD>
2623 <TD>"CUPS 1.2.N (UNAME)" where N is the patch release and
2624 UNAME is the output of the
<B>uname(
1)
</B> command
</TD>
2628 <TD>"CUPS 1.2.N (UNAME) IPP/1.1" where N is the patch
2629 release and UNAME is the output of the
<B>uname(
1)
</B>
2636 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"SetEnv">SetEnv
</A></H2>
2640 <PRE CLASS=
"command">
2641 SetEnv PATH /usr/lib/cups/filter:/bin:/usr/bin:/usr/local/bin
2642 SetEnv MY_ENV_VAR foo
2645 <H3>Description
</H3>
2647 <P>The
<CODE>SetEnv
</CODE> directive specifies an environment
2648 variable that should be passed to child processes.
</P>
2651 <H2 CLASS=
"title"><A NAME=
"SSLListen">SSLListen
</A></H2>
2655 <PRE CLASS=
"command">
2656 SSLListen
127.0.0.1:
443
2657 SSLListen
192.0.2.1:
443
2660 <H3>Description
</H3>
2662 <P>The
<CODE>SSLListen
</CODE> directive specifies a network
2663 address and port to listen for secure connections. Multiple
2664 <CODE>SSLListen
</CODE> directives can be provided to listen on
2665 multiple addresses.
</P>
2667 <P>The
<CODE>SSLListen
</CODE> directive is similar to the
<A
2668 HREF=
"#SSLPort"><CODE>SSLPort
</CODE></A> directive but allows you
2669 to restrict access to specific interfaces or networks.
</P>
2672 <H2 CLASS=
"title"><A NAME=
"SSLPort">SSLPort
</A></H2>
2676 <PRE CLASS=
"command">
2680 <H3>Description
</H3>
2682 <P>The
<CODE>SSLPort
</CODE> directive specifies a port to listen
2683 on for secure connections. Multiple
<CODE>SSLPort
</CODE> lines
2684 can be specified to listen on multiple ports.
</P>
2687 <H2 CLASS=
"title"><A NAME=
"SystemGroup">SystemGroup
</A></H2>
2691 <PRE CLASS=
"command">
2696 SystemGroup root lpadmin
2699 <H3>Description
</H3>
2701 <P>The
<CODE>SystemGroup
</CODE> directive specifies the system
2702 administration group for
<CODE>System
</CODE> authentication.
2703 Multiple groups can be listed, separated with spaces. The default
2704 group list is
<CODE>@CUPS_SYSTEM_GROUPS@
</CODE>.
</P>
2707 <H2 CLASS=
"title"><A NAME=
"TempDir">TempDir
</A></H2>
2711 <PRE CLASS=
"command">
2713 TempDir /foo/bar/tmp
2716 <H3>Description
</H3>
2718 <P>The
<CODE>TempDir
</CODE> directive specifies an absolute path
2719 for the directory to use for temporary files. The default
2720 directory is
<VAR>@CUPS_REQUESTS@/tmp
</VAR>.
</P>
2722 <P>Temporary directories must be world-writable and should have
2723 the
"sticky" permission bit enabled so that other users cannot
2724 delete filter temporary files. The following commands will create
2725 an appropriate temporary directory called
2726 <VAR>/foo/bar/tmp
</VAR>:
</P>
2728 <PRE CLASS=
"command">
2729 <KBD>mkdir /foo/bar/tmp
</KBD>
2730 <KBD>chmod a+rwxt /foo/bar/tmp
</KBD>
2734 <H2 CLASS=
"title"><A NAME=
"Timeout">Timeout
</A></H2>
2738 <PRE CLASS=
"command">
2743 <H3>Description
</H3>
2745 <P>The
<CODE>Timeout
</CODE> directive controls the amount of time
2746 to wait before an active HTTP or IPP request times out. The
2747 default timeout is
300 seconds.
</P>
2750 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"UseNetworkDefault">UseNetworkDefault
</A></H2>
2754 <PRE CLASS=
"command">
2755 UseNetworkDefault yes
2756 UseNetworkDefault no
2759 <H3>Description
</H3>
2761 <P>The
<CODE>UseNetworkDefault
</CODE> directive controls whether
2762 the client will use a network/remote printer as a default
2763 printer. If enabled, the default printer of a server is used as
2764 the default printer on a client. When multiple servers are
2765 advertising a default printer, the client's default printer is
2766 set to the first discovered printer, or to the implicit class for
2767 the same printer available from multiple servers.
</P>
2769 <P>The default is
<CODE>@CUPS_USE_NETWORK_DEFAULT@
</CODE>.
</P>
2772 <H2 CLASS=
"title"><A NAME=
"User">User
</A></H2>
2776 <PRE CLASS=
"command">
2781 <H3>Description
</H3>
2783 <P>The
<CODE>User
</CODE> directive specifies the UNIX user that
2784 filter and CGI programs run as. The default user is
2785 <CODE>@CUPS_USER@
</CODE>.
</P>
2787 <BLOCKQUOTE><B>Note:
</B>
2789 <P>You may not use user
<CODE>root
</CODE>, as that would expose
2790 the system to unacceptable security risks. The scheduler will
2791 automatically choose user
<CODE>nobody
</CODE> if you specify a
2792 user whose ID is
0.
</P>