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>/var/log/cups/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 dns-sd
514 BrowseLocalProtocols ldap
515 BrowseLocalProtocols slp
516 BrowseLocalProtocols cups dns-sd
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
</CODE>, which is a
525 broadcast-based protocol.
</P>
528 <H2 CLASS=
"title"><A NAME=
"BrowseOrder">BrowseOrder
</A></H2>
532 <PRE CLASS=
"command">
533 BrowseOrder allow,deny
534 BrowseOrder deny,allow
539 <P>The
<CODE>BrowseOrder
</CODE> directive specifies the order of
540 allow/deny processing. The default order is
541 <CODE>deny,allow
</CODE>:
</P>
545 <LI><CODE>allow,deny
</CODE> - Deny browse packets by
546 default, then check
<CODE>BrowseAllow
</CODE> lines
547 followed by
<CODE>BrowseDeny
</CODE> lines.
</LI>
549 <LI><CODE>deny,allow
</CODE> - Allow browse packets by
550 default, then check
<CODE>BrowseDeny
</CODE> lines
551 followed by
<CODE>BrowseAllow
</CODE> lines.
</LI>
556 <H2 CLASS=
"title"><A NAME=
"BrowsePoll">BrowsePoll
</A></H2>
560 <PRE CLASS=
"command">
561 BrowsePoll
192.0.2.2:
631
562 BrowsePoll host.domain.com:
631
567 <P>The
<CODE>BrowsePoll
</CODE> directive polls a server for
568 available printers once every
<A
569 HREF=
"#BrowseInterval"><CODE>BrowseInterval
</CODE></A> seconds.
570 Multiple
<CODE>BrowsePoll
</CODE> directives can be specified to
571 poll multiple servers.
</P>
573 <P>If
<CODE>BrowseInterval
</CODE> is set to
0 then the server is
574 polled once every
30 seconds.
</P>
577 <H2 CLASS=
"title"><A NAME=
"BrowsePort">BrowsePort
</A></H2>
581 <PRE CLASS=
"command">
588 <P>The
<CODE>BrowsePort
</CODE> directive specifies the UDP port number
589 used for browse packets. The default port number is
631.
</P>
591 <BLOCKQUOTE><B>Note:
</B>
593 <P>You must set the
<CODE>BrowsePort
</CODE> to the same value
594 on all of the systems that you want to see.
599 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.10</SPAN><A NAME=
"BrowseProtocols">BrowseProtocols
</A></H2>
603 <PRE CLASS=
"command">
607 BrowseProtocols dns-sd
610 BrowseProtocols cups dns-sd
615 <P>The
<CODE>BrowseProtocols
</CODE> directive specifies the
616 protocols to use when showing and advertising shared printers on
617 the local network. Multiple protocols can be specified by
618 separating them with spaces. The default protocol is
619 <CODE>cups
</CODE>, which is a broadcast-based protocol.
</P>
621 <BLOCKQUOTE><B>Note:
</B>
623 <P>When using the
<CODE>SLP
</CODE> protocol, you must have at least
624 one Directory Agent (DA) server on your network. Otherwise the
625 CUPS scheduler (
<CODE>cupsd
</CODE>) will not respond to client
626 requests for several seconds while polling the network.
</P>
631 <H2 CLASS=
"title"><A NAME=
"BrowseRelay">BrowseRelay
</A></H2>
635 <PRE CLASS=
"command">
636 BrowseRelay
193.0.2.1 192.0.2.255
637 BrowseRelay
193.0.2.0/
255.255.255.0 192.0.2.255
638 BrowseRelay
193.0.2.0/
24 192.0.2.255
639 BrowseRelay *.domain.com
192.0.2.255
640 BrowseRelay host.domain.com
192.0.2.255
645 <P>The
<CODE>BrowseRelay
</CODE> directive specifies source and
646 destination addresses for relaying browsing information from one
647 host or network to another. Multiple
<CODE>BrowseRelay
</CODE>
648 directives can be specified as needed.
</P>
650 <P><CODE>BrowseRelay
</CODE> is typically used on systems that
651 bridge multiple subnets using one or more network interfaces. It
652 can also be used to relay printer information from polled servers
655 <PRE CLASS=
"command">
656 BrowseRelay
127.0.0.1 @LOCAL
659 <P>This effectively provides access to printers on a WAN for all
660 clients on the LAN(s).
</P>
663 <H2 CLASS=
"title"><A NAME=
"BrowseRemoteOptions">BrowseRemoteOptions
</A></H2>
667 <PRE CLASS=
"command">
668 BrowseRemoteOptions compression=yes
669 BrowseRemoteOptions encryption=required
670 BrowseRemoteOptions ?compression=yes
&encryption=required
675 <P>The
<CODE>BrowseRemoteOptions
</CODE> directive specifies
676 additional IPP backend options to include with remote shared
677 printers. If the options string begins with a question mark (?),
678 the options replace any options specified by the remote server.
679 The default is to not include any options.
</P>
682 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"BrowseRemoteProtocols">BrowseRemoteProtocols
</A></H2>
686 <PRE CLASS=
"command">
687 BrowseRemoteProtocols all
688 BrowseRemoteProtocols none
689 BrowseRemoteProtocols cups
690 BrowseRemoteProtocols dns-sd
691 BrowseRemoteProtocols ldap
692 BrowseRemoteProtocols slp
693 BrowseRemoteProtocols cups dns-sd
698 <P>The
<CODE>BrowseRemoteProtocols
</CODE> directive specifies the
699 protocols to use when finding remote shared printers on the
700 network. Multiple protocols can be specified by separating them
701 with spaces. The default is
<CODE>cups
</CODE>, which is a
702 broadcast-based protocol.
</P>
705 <H2 CLASS=
"title"><A NAME=
"BrowseShortNames">BrowseShortNames
</A></H2>
709 <PRE CLASS=
"command">
716 <P>The
<CODE>BrowseShortNames
</CODE> directive specifies whether
717 or not short names are used for remote printers when possible.
718 Short names are just the remote printer name, without the server
719 (
"printer"). If more than one remote printer is detected with the
720 same name, the printers will have long names (
"printer@server1",
721 "printer@server2".)
</P>
723 <P>The default value for this option is
<CODE>Yes
</CODE>.
</P>
726 <H2 CLASS=
"title"><A NAME=
"BrowseTimeout">BrowseTimeout
</A></H2>
730 <PRE CLASS=
"command">
737 <P>The
<CODE>BrowseTimeout
</CODE> directive sets the timeout for
738 printer or class information that is received in browse packets.
739 Once a printer or class times out it is removed from the list of
740 available destinations.
</P>
742 <P>The
<CODE>BrowseTimeout
</CODE> value should always be greater
744 HREF=
"#BrowseInterval"><CODE>BrowseInterval
</CODE></A> value.
745 Otherwise printers and classes will disappear from client systems
749 <H2 CLASS=
"title"><A NAME=
"Browsing">Browsing
</A></H2>
753 <PRE CLASS=
"command">
760 <P>The
<CODE>Browsing
</CODE> directive controls whether or not
761 network printer browsing is enabled. The default setting is
764 <P>This directive does not enable sharing of local printers by
765 itself; you must also use the
<A
766 HREF=
"#BrowseAddress"><CODE>BrowseAddress
</CODE></A> or
<A
767 HREF=
"#BrowseProtocols"><CODE>BrowseProtocols
</CODE></A>
768 directives to advertise local printers to other systems.
</P>
770 <BLOCKQUOTE><B>Note:
</B>
772 <P>If you are using HP-UX
10.20 and a subnet that is not
24,
773 16, or
8 bits, printer browsing (and in fact all broadcast
774 reception) will not work. This problem appears to be fixed in
780 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"Classification">Classification
</A></H2>
784 <PRE CLASS=
"command">
786 Classification classified
787 Classification confidential
788 Classification secret
789 Classification topsecret
790 Classification unclassified
795 <P>The
<CODE>Classification
</CODE> directive sets the
796 classification level on the server. When this option is set, at
797 least one of the banner pages is forced to the classification
798 level, and the classification is placed on each page of output.
799 The default is no classification level.
</P>
802 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.10</SPAN><A NAME=
"ClassifyOverride">ClassifyOverride
</A></H2>
806 <PRE CLASS=
"command">
813 <P>The
<CODE>ClassifyOverride
</CODE> directive specifies whether
814 users can override the default classification level on the
815 server. When the server classification is set, users can change
816 the classification using the
<CODE>job-sheets
</CODE> option and
817 can choose to only print one security banner before or after the
818 job. If the
<CODE>job-sheets
</CODE> option is set to
819 <CODE>none
</CODE> then the server default classification is
822 <P>The default is to not allow classification overrides.
</P>
825 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.15</SPAN><A NAME=
"ConfigFilePerm">ConfigFilePerm
</A></H2>
829 <PRE CLASS=
"command">
836 <P>The
<CODE>ConfigFilePerm
</CODE> directive specifies the
837 permissions to use when writing configuration files. The default
841 <H2 CLASS=
"title"><A NAME=
"DataDir">DataDir
</A></H2>
845 <PRE CLASS=
"command">
846 DataDir /usr/share/cups
851 <P>The
<CODE>DataDir
</CODE> directive sets the directory to use
855 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"DefaultAuthType">DefaultAuthType
</A></H2>
859 <PRE CLASS=
"command">
860 DefaultAuthType Basic
861 DefaultAuthType BasicDigest
862 DefaultAuthType Digest
863 DefaultAuthType Negotiate
868 <P>The
<CODE>DefaultAuthType
</CODE> directive specifies the type
869 of authentication to use for IPP operations that require a
870 username. The default is
<CODE>Basic
</CODE>.
</P>
873 <H2 CLASS=
"title"><A NAME=
"DefaultCharset">DefaultCharset
</A></H2>
877 <PRE CLASS=
"command">
879 DefaultCharset iso-
8859-
1
880 DefaultCharset windows-
1251
885 <P>The
<CODE>DefaultCharset
</CODE> directive sets the default
886 character set to use for client connections. The default
887 character set is
<CODE>utf-
8</CODE> but is overridden by the
888 character set for the language specified by the client or the
889 <CODE>DefaultLanguage
</CODE> directive.
</P>
892 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"DefaultEncryption">DefaultEncryption
</A></H2>
896 <PRE CLASS=
"command">
897 DefaultEncryption Never
898 DefaultEncryption IfRequested
899 DefaultEncryption Required
904 <P>The
<CODE>DefaultEncryption
</CODE> directive specifies the
905 type of encryption to use when performing authentication. The
906 default is
<CODE>Required
</CODE>.
</P>
909 <H2 CLASS=
"title"><A NAME=
"DefaultLanguage">DefaultLanguage
</A></H2>
913 <PRE CLASS=
"command">
923 <P>The
<CODE>DefaultLanguage
</CODE> directive specifies the
924 default language to use for client connections. Setting the
925 default language also sets the default character set if a
926 language localization file exists for it. The default language
927 is
"en" for English.
</P>
930 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"DefaultPolicy">DefaultPolicy
</A></H2>
934 <PRE CLASS=
"command">
935 DefaultPolicy default
941 <P>The
<CODE>DefaultPolicy
</CODE> directive specifies the default
942 policy to use for IPP operation. The default is
943 <CODE>default
</CODE>.
</P>
946 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"DefaultShared">DefaultShared
</A></H2>
950 <PRE CLASS=
"command">
957 <P>The
<CODE>DefaultShared
</CODE> directive specifies whether
958 printers are shared (published) by default. The default is
959 <CODE>yes
</CODE>.
</P>
962 <H2 CLASS=
"title"><A NAME=
"Deny">Deny
</A></H2>
966 <PRE CLASS=
"command">
967 <Location /path
>
971 Deny from *.domain.com
972 Deny from .domain.com
973 Deny from host.domain.com
976 Deny from nnn.nnn.nnn.*
977 Deny from nnn.nnn.nnn.nnn
978 Deny from nnn.nnn.nnn.nnn/mm
979 Deny from nnn.nnn.nnn.nnn/mmm.mmm.mmm.mmm
980 Deny from xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx
988 <P>The
<CODE>Deny
</CODE> directive specifies a hostname, IP
989 address, or network that is allowed access to the server.
990 <CODE>Deny
</CODE> directives are cummulative, so multiple
991 <CODE>Deny
</CODE> directives can be used to allow access for
992 multiple hosts or networks. The
<CODE>/mm
</CODE> notation
993 specifies a CIDR netmask, a shown in
<A HREF=
"TABLE1">Table
996 <P>The
<CODE>@LOCAL
</CODE> name will deny access from all local
997 interfaces. The
<CODE>@IF(name)
</CODE> name will deny access from
998 the named interface. In both cases, CUPS only denies access from
999 the network that the interface(s) are configured for - requests
1000 arriving on the interface from a foreign network will
1001 <em>not
</em> be denied.
</P>
1003 <P>The
<CODE>Deny
</CODE> directive must appear inside a
<A
1004 HREF=
"#Location"><CODE>Location
</CODE></A> or
<A
1005 HREF=
"#Limit"><CODE>Limit
</CODE></A> section.
</P>
1008 <H2 CLASS=
"title"><A NAME=
"DocumentRoot">DocumentRoot
</A></H2>
1012 <PRE CLASS=
"command">
1013 DocumentRoot /usr/share/doc/cups
1014 DocumentRoot /foo/bar/doc/cups
1017 <H3>Description
</H3>
1019 <P>The
<CODE>DocumentRoot
</CODE> directive specifies the location
1020 of web content for the HTTP server in CUPS. If an absolute path
1021 is not specified then it is assumed to be relative to the
<A
1022 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory. The
1023 default directory is
<VAR>/usr/share/doc/cups
</VAR>.
</P>
1025 <P>Documents are first looked up in a sub-directory for the
1026 primary language requested by the client (e.g.
1027 <VAR>/usr/share/doc/cups/fr/...
</VAR>) and then directly under
1028 the
<CODE>DocumentRoot
</CODE> directory (e.g.
1029 <VAR>/usr/share/doc/cups/...
</VAR>), so it is possible to
1030 localize the web content by providing subdirectories for each
1031 language needed.
</P>
1034 <H2 CLASS=
"title"><A NAME=
"Encryption">Encryption
</A></H2>
1038 <PRE CLASS=
"command">
1039 <Location /path
>
1042 Encryption IfRequested
1047 <H3>Description
</H3>
1049 <P>The
<CODE>Encryption
</CODE> directive must appear instead a
<A
1050 HREF=
"#Location"><CODE>Location
</CODE></A> or
<A
1051 HREF=
"#Limit"><CODE>Limit
</CODE></A> section and specifies the
1052 encryption settings for that location. The default setting is
1053 <CODE>IfRequested
</CODE> for all locations.
</P>
1056 <H2 CLASS=
"title"><A NAME=
"ErrorLog">ErrorLog
</A></H2>
1060 <PRE CLASS=
"command">
1061 ErrorLog /var/log/cups/error_log
1062 ErrorLog /var/log/cups/error_log-%s
1066 <H3>Description
</H3>
1068 <P>The
<CODE>ErrorLog
</CODE> directive sets the name of the error
1069 log file. If the filename is not absolute then it is assumed to
1070 be relative to the
<A
1071 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory. The
1072 default error log file is
<VAR>/var/log/cups/error_log
</VAR>.
</P>
1074 <P>The server name can be included in the filename by using
1075 <CODE>%s
</CODE> in the name.
</P>
1077 <P>The special name
"syslog" can be used to send the error
1078 information to the system log instead of a plain file.
</P>
1081 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.18</SPAN><A NAME=
"FileDevice">FileDevice
</A></H2>
1085 <PRE CLASS=
"command">
1090 <H3>Description
</H3>
1092 <P>The
<CODE>FileDevice
</CODE> directive determines whether the
1093 scheduler allows new printers to be added using device URIs of
1094 the form
<CODE>file:/filename
</CODE>. File devices are most often
1095 used to test new printer drivers and do not support raw file
1098 <P>The default setting is
<CODE>No
</CODE>.
</P>
1100 <BLOCKQUOTE><B>Note:
</B>
1102 <P>File devices are managed by the scheduler. Since the
1103 scheduler normally runs as the root user, file devices
1104 can be used to overwrite system files and potentially
1105 gain unauthorized access to the system. If you must
1106 create printers using file devices, we recommend that
1107 you set the
<CODE>FileDevice
</CODE> directive to
1108 <CODE>Yes
</CODE> for only as long as you need to add the
1109 printers to the system, and then reset the directive to
1110 <CODE>No
</CODE>.
</P>
1115 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.3</SPAN><A NAME=
"FilterLimit">FilterLimit
</A></H2>
1119 <PRE CLASS=
"command">
1125 <H3>Description
</H3>
1127 <P>The
<CODE>FilterLimit
</CODE> directive sets the maximum cost
1128 of all running job filters. It can be used to limit the number of
1129 filter programs that are run on a server to minimize disk,
1130 memory, and CPU resource problems. A limit of
0 disables filter
1133 <P>An average print to a non-PostScript printer needs a filter
1134 limit of about
200. A PostScript printer needs about half that
1135 (
100). Setting the limit below these thresholds will effectively
1136 limit the scheduler to printing a single job at any time.
</P>
1138 <P>The default limit is
0.
</P>
1141 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.16</SPAN><A NAME=
"FilterNice">FilterNice
</A></H2>
1145 <PRE CLASS=
"command">
1151 <H3>Description
</H3>
1153 <P>The
<CODE>FilterNice
</CODE> directive sets the
<B>nice(
1)
</B>
1154 value to assign to filter processes. The nice value ranges from
1155 0, the highest priority, to
19, the lowest priority. The default
1159 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.3</SPAN><A NAME=
"FontPath">FontPath
</A></H2>
1163 <PRE CLASS=
"command">
1164 FontPath /foo/bar/fonts
1165 FontPath /usr/share/cups/fonts:/foo/bar/fonts
1168 <H3>Description
</H3>
1170 <P>The
<CODE>FontPath
</CODE> directive specifies the font path to
1171 use when searching for fonts. The default font path is
1172 <CODE>/usr/share/cups/fonts
</CODE>.
</P>
1175 <H2 CLASS=
"title"><A NAME=
"Group">Group
</A></H2>
1179 <PRE CLASS=
"command">
1184 <H3>Description
</H3>
1186 <P>The
<CODE>Group
</CODE> directive specifies the UNIX group that
1187 filter and CGI programs run as. The default group is
1188 system-specific but is usually
<CODE>lp
</CODE> or
1189 <CODE>nobody
</CODE>.
</P>
1192 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.3</SPAN><A NAME=
"GSSServiceName">GSSServiceName
</A></H2>
1196 <PRE CLASS=
"command">
1201 <H3>Description
</H3>
1203 <P>The
<CODE>GSSServiceName
</CODE> directive specifies the Kerberos service name that is used when passing authorization tickets. The default name is
<CODE>IPP
</CODE>.
</P>
1206 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.10</SPAN><A NAME=
"HideImplicitMembers">HideImplicitMembers
</A></H2>
1210 <PRE CLASS=
"command">
1211 HideImplicitMembers Yes
1212 HideImplicitMembers No
1215 <H3>Description
</H3>
1217 <P>The
<CODE>HideImplicitMembers
</CODE> directive controls
1218 whether the individual printers in an implicit class are hidden
1219 from the user. The default is
<CODE>Yes
</CODE>.
</P>
1221 <P><A HREF=
"#ImplicitClasses"><CODE>ImplicitClasses
</CODE></A>
1222 must be enabled for this directive to have any effect.
</P>
1225 <H2 CLASS=
"title"><A NAME=
"HostNameLookups">HostNameLookups
</A></H2>
1229 <PRE CLASS=
"command">
1232 HostNameLookups Double
1235 <H3>Description
</H3>
1237 <P>The
<CODE>HostNameLookups
</CODE> directive controls whether or
1238 not CUPS looks up the hostname for connecting clients. The
1239 <CODE>Double
</CODE> setting causes CUPS to verify that the
1240 hostname resolved from the address matches one of the addresses
1241 returned for that hostname.
<CODE>Double
</CODE> lookups also
1242 prevent clients with unregistered addresses from connecting to
1245 <P>The default is
<CODE>Off
</CODE> to avoid the potential server
1246 performance problems with hostname lookups. Set this option to
1247 <CODE>On
</CODE> or
<CODE>Double
</CODE> only if absolutely
1251 <H2 CLASS=
"title"><A NAME=
"ImplicitClasses">ImplicitClasses
</A></H2>
1255 <PRE CLASS=
"command">
1260 <H3>Description
</H3>
1262 <P>The
<CODE>ImplicitClasses
</CODE> directive controls whether
1263 implicit classes are created based upon the available network
1264 printers and classes. The default setting is
<CODE>On
</CODE> but
1265 is automatically turned
<CODE>Off
</CODE> if
<A
1266 HREF=
"#Browsing"><CODE>Browsing
</CODE></A> is turned
1267 <CODE>Off
</CODE>.
</P>
1270 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.10</SPAN><A NAME=
"ImplicitAnyClasses">ImplicitAnyClasses
</A></H2>
1274 <PRE CLASS=
"command">
1275 ImplicitAnyClasses On
1276 ImplicitAnyClasses Off
1279 <H3>Description
</H3>
1281 <P>The
<CODE>ImplicitAnyClasses
</CODE> directive controls
1282 whether implicit classes for local and remote printers are
1283 created with the name
<CODE>AnyPrinter
</CODE>. The default
1284 setting is
<CODE>Off
</CODE>.
</P>
1286 <P><A HREF=
"#ImplicitClasses"><CODE>ImplicitClasses
</CODE></A>
1287 must be enabled for this directive to have any effect.
</P>
1290 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.9</SPAN><A NAME=
"Include">Include
</A></H2>
1294 <PRE CLASS=
"command">
1296 Include /foo/bar/filename
1299 <H3>Description
</H3>
1301 <P>The
<CODE>Include
</CODE> directive includes the named file in
1302 the
<CODE>cupsd.conf
</CODE> file. If no leading path is provided,
1303 the file is assumed to be relative to the
<A
1304 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory.
</P>
1307 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"JobRetryInterval">JobRetryInterval
</A></H2>
1311 <PRE CLASS=
"command">
1313 JobRetryInterval
120
1316 <H3>Description
</H3>
1318 <P>The
<CODE>JobRetryInterval
</CODE> directive specifies the
1319 number of seconds to wait before retrying a job. This is
1320 typically used for fax queues but can also be used with normal
1321 print queues whose error policy is
<CODE>retry-job
</CODE>. The
1322 default is
30 seconds.
</P>
1325 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"JobRetryLimit">JobRetryLimit
</A></H2>
1329 <PRE CLASS=
"command">
1334 <H3>Description
</H3>
1336 <P>The
<CODE>JobRetryLimit
</CODE> directive specifies the maximum
1337 number of times the scheduler will try to print a job. This is
1338 typically used for fax queues but can also be used with normal
1339 print queues whose error policy is
<CODE>retry-job
</CODE>. The
1340 default is
5 times.
</P>
1343 <H2 CLASS=
"title"><A NAME=
"KeepAlive">KeepAlive
</A></H2>
1347 <PRE CLASS=
"command">
1352 <H3>Description
</H3>
1354 <P>The
<CODE>KeepAlive
</CODE> directive controls whether or not
1355 to support persistent HTTP connections. The default is
1356 <CODE>On
</CODE>.
</P>
1358 <P>HTTP/
1.1 clients automatically support persistent connections,
1359 while HTTP/
1.0 clients must specifically request them using the
1360 <CODE>Keep-Alive
</CODE> attribute in the
<CODE>Connection:
</CODE>
1361 field of each request.
</P>
1364 <H2 CLASS=
"title"><A NAME=
"KeepAliveTimeout">KeepAliveTimeout
</A></H2>
1368 <PRE CLASS=
"command">
1373 <H3>Description
</H3>
1375 <P>The
<CODE>KeepAliveTimeout
</CODE> directive controls how long
1376 a persistent HTTP connection will remain open after the last
1377 request. The default is
60 seconds.
</P>
1380 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"Limit">Limit (Location)
</A></H2>
1384 <PRE CLASS=
"command">
1385 <Location /path
>
1386 <Limit GET POST
>
1396 <H3>Description
</H3>
1398 <P>The
<CODE>Limit
</CODE> directive groups access control
1399 directives for specific types of HTTP requests and must appear
1400 inside a
<A HREF=
"#Location"><CODE>Location
</CODE></A> section.
1401 Access can be limited for individual request types
1402 (
<CODE>DELETE
</CODE>,
<CODE>GET
</CODE>,
<CODE>HEAD
</CODE>,
1403 <CODE>OPTIONS
</CODE>,
<CODE>POST
</CODE>,
<CODE>PUT
</CODE>, and
1404 <CODE>TRACE
</CODE>) or for all request types (
<CODE>ALL
</CODE>).
1405 The request type names are case-sensitive for compatibility with
1409 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"LimitIPP">Limit (Policy)
</A></H2>
1413 <PRE CLASS=
"command">
1415 <Limit CUPS-Add-Modify-Printer CUPS-Delete-Printer
>
1425 <H3>Description
</H3>
1427 <P>When included in
<A HREF=
"#Policy"><CODE>Policy
</CODE></A>
1428 sections, the
<CODE>Limit
</CODE> directive groups access control
1429 directives for specific IPP operations. Multiple operations can
1430 be listed, separated by spaces. Table
2 lists the supported
1433 <DIV CLASS=
"table"><TABLE SUMMARY=
"Supported IPP Operations">
1434 <CAPTION>Table
2:
<A NAME=
"TABLE2">Supported IPP Operations
</A></CAPTION>
1437 <TH>Operation Name
</TH>
1438 <TH>Description
</TH>
1444 <TD>All operations - used as the default limit for
1445 operations that are not listed
</TD>
1449 <TD>Cancel a job
</TD>
1452 <TD>Cancel-Subscription
</TD>
1453 <TD>Cancel a subscription
</TD>
1457 <TD>Create a new, empty job
</TD>
1460 <TD>Create-Job-Subscription
</TD>
1461 <TD>Creates a notification subscription on a job
</TD>
1464 <TD>Create-Printer-Subscription
</TD>
1465 <TD>Creates a notification subscription on a printer
</TD>
1468 <TD>CUPS-Accept-Jobs
</TD>
1469 <TD>Sets the printer-is-accepting-jobs value for a printer to true
</TD>
1472 <TD>CUPS-Add-Modify-Class
</TD>
1473 <TD>Adds or modifies a class
</TD>
1476 <TD>CUPS-Add-Modify-Printer
</TD>
1477 <TD>Adds or modifies a printer
</TD>
1480 <TD>CUPS-Authenticate-Job
</TD>
1481 <TD>Authenticates a job for printing
</TD>
1484 <TD>CUPS-Delete-Class
</TD>
1485 <TD>Deletes a class
</TD>
1488 <TD>CUPS-Delete-Printer
</TD>
1489 <TD>Deletes a printer
</TD>
1492 <TD>CUPS-Get-Classes
</TD>
1493 <TD>Gets a list of classes
</TD>
1496 <TD>CUPS-Get-Default
</TD>
1497 <TD>Gets the (network/server) default printer or class
</TD>
1500 <TD>CUPS-Get-Devices
</TD>
1501 <TD>Gets a list of available devices
</TD>
1504 <TD>CUPS-Get-PPDs
</TD>
1505 <TD>Gets a list of available manufacturers or drivers
</TD>
1508 <TD>CUPS-Get-Printers
</TD>
1509 <TD>Gets a list of printers and/or classes
</TD>
1512 <TD>CUPS-Move-Job
</TD>
1513 <TD>Moves a job to a new destination
</TD>
1516 <TD>CUPS-Reject-Jobs
</TD>
1517 <TD>Sets the printer-is-accepting-jobs value for a printer to false
</TD>
1520 <TD>CUPS-Set-Default
</TD>
1521 <TD>Sets the network/server default printer or class
</TD>
1524 <TD>Disable-Printer
</TD>
1525 <TD>Sets the printer-state value for a printer to stopped
</TD>
1528 <TD>Enable-Printer
</TD>
1529 <TD>Sets the printer-state value for a printer to idle/processing
</TD>
1532 <TD>Get-Job-Attributes
</TD>
1533 <TD>Gets information about a job
</TD>
1537 <TD>Gets a list of jobs
</TD>
1540 <TD>Get-Notifications
</TD>
1541 <TD>Gets a list of events
</TD>
1544 <TD>Get-Printer-Attributes
</TD>
1545 <TD>Gets informaion about a printer or class
</TD>
1548 <TD>Get-Subscription-Attributes
</TD>
1549 <TD>Gets informaion about a notification subscription
</TD>
1552 <TD>Get-Subscriptions
</TD>
1553 <TD>Gets a list of notification subscriptions
</TD>
1557 <TD>Holds a job for printing
</TD>
1560 <TD>Pause-Printer
</TD>
1561 <TD>Sets the printer-state value for a printer to stopped
</TD>
1565 <TD>Creates a job with a single file for printing
</TD>
1569 <TD>Removes all jobs from a printer
</TD>
1572 <TD>Release-Job
</TD>
1573 <TD>Releases a previously held job for printing
</TD>
1576 <TD>Renew-Subscription
</TD>
1577 <TD>Renews a notification subscription
</TD>
1580 <TD>Restart-Job
</TD>
1581 <TD>Reprints a job
</TD>
1584 <TD>Resume-Printer
</TD>
1585 <TD>Sets the printer-stae value for a printer to idle/processing
</TD>
1588 <TD>Send-Document
</TD>
1589 <TD>Adds a file to an job created with Create-Job
</TD>
1592 <TD>Set-Job-Attributes
</TD>
1593 <TD>Changes job options
</TD>
1596 <TD>Validate-Job
</TD>
1597 <TD>Validates job options prior to printing
</TD>
1603 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"LimitExcept">LimitExcept
</A></H2>
1607 <PRE CLASS=
"command">
1608 <Location /path
>
1609 <LimitExcept GET POST
>
1611 </LimitExcept
>
1615 <H3>Description
</H3>
1617 <P>The
<CODE>LimitExcept
</CODE> directive groups access control
1618 directives for specific types of HTTP requests and must appear
1619 inside a
<A HREF=
"#Location"><CODE>Location
</CODE></A> section.
1620 Unlike the
<A HREF=
"#Limit"><CODE>Limit
</CODE></A> directive,
1621 <CODE>LimitExcept
</CODE> restricts access for all requests
1622 <I>except
</I> those listed on the
<CODE>LimitExcept
</CODE>
1626 <H2 CLASS=
"title"><A NAME=
"LimitRequestBody">LimitRequestBody
</A></H2>
1630 <PRE CLASS=
"command">
1631 LimitRequestBody
10485760
1632 LimitRequestBody
10m
1636 <H3>Description
</H3>
1638 <P>The
<CODE>LimitRequestBody
</CODE> directive controls the
1639 maximum size of print files, IPP requests, and HTML form data in
1640 HTTP POST requests. The default limit is
0 which disables the
1644 <H2 CLASS=
"title"><A NAME=
"Listen">Listen
</A></H2>
1648 <PRE CLASS=
"command">
1649 Listen
127.0.0.1:
631
1650 Listen
192.0.2.1:
631
1655 <H3>Description
</H3>
1657 <P>The
<CODE>Listen
</CODE> directive specifies a network address
1658 and port to listen for connections. Multiple
<CODE>Listen
</CODE>
1659 directives can be provided to listen on multiple addresses.
</P>
1661 <P>The
<CODE>Listen
</CODE> directive is similar to the
<A
1662 HREF=
"#Port"><CODE>Port
</CODE></A> directive but allows you to
1663 restrict access to specific interfaces or networks.
</P>
1666 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"ListenBackLog">ListenBackLog
</A></H2>
1670 <PRE CLASS=
"command">
1675 <H3>Description
</H3>
1677 <P>The
<CODE>ListenBackLog
</CODE> directive sets the maximum
1678 number of pending connections the scheduler will allow. This
1679 normally only affects very busy servers that have reached the
<A
1680 HREF=
"#MaxClients"><CODE>MaxClients
</CODE></A> limit, but can
1681 also be triggered by large numbers of simultaneous connections.
1682 When the limit is reached, the operating system will refuse
1683 additional connections until the scheduler can accept the pending
1684 ones. The default is the OS-defined default limit, typically
1685 either
5 for older operating systems or
128 for newer operating
1689 <H2 CLASS=
"title"><A NAME=
"Location">Location
</A></H2>
1693 <PRE CLASS=
"command">
1698 <Location /admin
>
1702 <Location /admin/conf
>
1706 <Location /admin/log
>
1710 <Location /classes
>
1714 <Location /classes/name
>
1718 <Location /jobs
>
1722 <Location /printers
>
1726 <Location /printers/name
>
1732 <H3>Description
</H3>
1734 <P>The
<CODE>Location
</CODE> directive specifies access control
1735 and authentication options for the specified HTTP resource or
1736 path. The
<A HREF=
"#Allow"><CODE>Allow
</CODE></A>,
<A
1737 HREF=
"#AuthType"><CODE>AuthType
</CODE></A>,
<A
1738 HREF=
"#Deny"><CODE>Deny
</CODE></A>,
<A
1739 HREF=
"#Encryption"><CODE>Encryption
</CODE></A>,
<A
1740 HREF=
"#Limit"><CODE>Limit
</CODE></A>,
<A
1741 HREF=
"#LimitExcept"><CODE>LimitExcept
</CODE></A>,
<A
1742 HREF=
"#Order"><CODE>Order
</CODE></A>,
<A
1743 HREF=
"#Require"><CODE>Require
</CODE></A>, and
<A
1744 HREF=
"#Satisfy"><CODE>Satisfy
</CODE></A> directives may all
1745 appear inside a location.
</P>
1747 <P>Note that more specific resources override the less specific
1748 ones. So the directives inside the
<CODE>/printers/name
</CODE>
1749 location will override ones from
<CODE>/printers
</CODE>.
1750 Directives inside
<CODE>/printers
</CODE> will override ones from
1751 <CODE>/
</CODE>. None of the directives are inherited.
</P>
1753 <DIV CLASS=
"table"><TABLE SUMMARY=
"Common Locaions on the Server">
1754 <CAPTION>Table
3:
<A NAME=
"TABLE3">Common Locations on the Server
</A></CAPTION>
1756 <TR><TH>Location
</TH><TH>Description
</TH></TR>
1759 <TR><TD><CODE>/
</CODE></TD><TD>The path for all get operations (get-printers, get-jobs, etc.)
</TD></TR>
1760 <TR><TD><CODE>/admin
</CODE></TD><TD>The path for all administration operations (add-printer, delete-printer, start-printer, etc.)
</TD></TR>
1761 <TR><TD><CODE>/admin/conf
</CODE></TD><TD>The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.)
</TD></TR>
1762 <TR><TD><CODE>/admin/log
</CODE></TD><TD>The path for access to the CUPS log files (access_log, error_log, page_log)
</TD></TR>
1763 <TR><TD><CODE>/classes
</CODE></TD><TD>The path for all classes
</TD></TR>
1764 <TR><TD><CODE>/classes/name
</CODE></TD><TD>The resource for class
<CODE>name
</CODE></TD></TR>
1765 <TR><TD><CODE>/jobs
</CODE></TD><TD>The path for all jobs (hold-job, release-job, etc.)
</TD></TR>
1766 <TR><TD><CODE>/jobs/id
</CODE></TD><TD>The resource for job
<CODE>id
</CODE></TD></TR>
1767 <TR><TD><CODE>/printers
</CODE></TD><TD>The path for all printers
</TD></TR>
1768 <TR><TD><CODE>/printers/name
</CODE></TD><TD>The path for printer
<CODE>name
</CODE></TD></TR>
1769 <TR><TD><CODE>/printers/name.ppd
</CODE></TD><TD>The PPD file path for printer
<CODE>name
</CODE></TD></TR>
1774 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.15</SPAN><A NAME=
"LogFilePerm">LogFilePerm
</A></H2>
1778 <PRE CLASS=
"command">
1783 <H3>Description
</H3>
1785 <P>The
<CODE>LogFilePerm
</CODE> directive specifies the
1786 permissions to use when writing configuration files. The default
1790 <H2 CLASS=
"title"><A NAME=
"LogLevel">LogLevel
</A></H2>
1794 <PRE CLASS=
"command">
1807 <H3>Description
</H3>
1809 <P>The
<CODE>LogLevel
</CODE> directive specifies the level of
1810 logging for the
<A HREF=
"#ErrorLog"><CODE>ErrorLog
</CODE></A>
1811 file. The following values are recognized (each level logs
1812 everything under the preceding levels):
</P>
1816 <LI><CODE>none
</CODE> - Log nothing
</LI>
1818 <LI><CODE>emerg
</CODE> - Log emergency conditions that
1819 prevent the server from running
</LI>
1821 <LI><CODE>alert
</CODE> - Log alerts that must be handled
1824 <LI><CODE>crit
</CODE> - Log critical errors that don't
1825 prevent the server from running
</LI>
1827 <LI><CODE>error
</CODE> - Log general errors
</LI>
1829 <LI><CODE>warn
</CODE> - Log errors and warnings
</LI>
1831 <LI><CODE>notice
</CODE> - Log temporary error conditions
</LI>
1833 <LI><CODE>info
</CODE> - Log all requests and state
1834 changes (default)
</LI>
1836 <LI><CODE>debug
</CODE> - Log basic debugging
1839 <LI><CODE>debug2
</CODE> - Log all debugging
1845 <H2 CLASS=
"title"><A NAME=
"MaxClients">MaxClients
</A></H2>
1849 <PRE CLASS=
"command">
1854 <H3>Description
</H3>
1856 <P>The
<CODE>MaxClients
</CODE> directive controls the maximum
1857 number of simultaneous clients that will be allowed by the
1858 server. The default is
100 clients.
</P>
1860 <BLOCKQUOTE><B>Note:
</B>
1862 <P>Since each print job requires a file descriptor for the status
1863 pipe, the scheduler internally limits the
<CODE>MaxClients
</CODE>
1864 value to
1/
3 of the available file descriptors to avoid possible
1865 problems when printing large numbers of jobs.
</P>
1870 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.18</SPAN><A NAME=
"MaxClientsPerHost">MaxClientsPerHost
</A></H2>
1874 <PRE CLASS=
"command">
1875 MaxClientsPerHost
10
1878 <H3>Description
</H3>
1880 <P>The
<CODE>MaxClientsPerHost
</CODE> directive controls the
1881 maximum number of simultaneous clients that will be allowed from
1882 a single host by the server. The default is the
1883 <CODE>MaxClients
</CODE> value.
</P>
1885 <P>This directive provides a small measure of protection against
1886 Denial of Service attacks from a single host.
</P>
1889 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.16</SPAN><A NAME=
"MaxCopies">MaxCopies
</A></H2>
1893 <PRE CLASS=
"command">
1898 <H3>Description
</H3>
1900 <P>The
<CODE>MaxCopies
</CODE> directive controls the maximum
1901 number of copies that a user can print of a job. The default is
1904 <BLOCKQUOTE><B>Note:
</B>
1906 <P>Most HP PCL laser printers internally limit the number of
1913 <H2 CLASS=
"title"><A NAME=
"MaxJobs">MaxJobs
</A></H2>
1917 <PRE CLASS=
"command">
1923 <H3>Description
</H3>
1925 <P>The
<CODE>MaxJobs
</CODE> directive controls the maximum number
1926 of jobs that are kept in memory. Once the number of jobs reaches
1927 the limit, the oldest completed job is automatically purged from
1928 the system to make room for the new one. If all of the known jobs
1929 are still pending or active then the new job will be
1932 <P>Setting the maximum size to
0 disables this functionality. The
1933 default setting is
500.
</P>
1936 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"MaxJobsPerPrinter">MaxJobsPerPrinter
</A></H2>
1940 <PRE CLASS=
"command">
1941 MaxJobsPerPrinter
100
1942 MaxJobsPerPrinter
9999
1946 <H3>Description
</H3>
1948 <P>The
<CODE>MaxJobsPerPrinter
</CODE> directive controls the
1949 maximum number of active jobs that are allowed for each printer
1950 or class. Once a printer or class reaches the limit, new jobs
1951 will be rejected until one of the active jobs is completed,
1952 stopped, aborted, or canceled.
</P>
1954 <P>Setting the maximum to
0 disables this functionality. The
1955 default setting is
0.
</P>
1958 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"MaxJobsPerUser">MaxJobsPerUser
</A></H2>
1962 <PRE CLASS=
"command">
1968 <H3>Description
</H3>
1970 <P>The
<CODE>MaxJobsPerUser
</CODE> directive controls the maximum
1971 number of active jobs that are allowed for each user. Once a user
1972 reaches the limit, new jobs will be rejected until one of the
1973 active jobs is completed, stopped, aborted, or canceled.
</P>
1975 <P>Setting the maximum to
0 disables this functionality. The
1976 default setting is
0.
</P>
1979 <H2 CLASS=
"title"><A NAME=
"MaxLogSize">MaxLogSize
</A></H2>
1983 <PRE CLASS=
"command">
1989 <H3>Description
</H3>
1991 <P>The
<CODE>MaxLogSize
</CODE> directive controls the maximum
1992 size of each log file. Once a log file reaches or exceeds the
1993 maximum size it is closed and renamed to
<VAR>filename.O
</VAR>.
1994 This allows you to rotate the logs automatically. The default
1995 size is
1048576 bytes (
1MB).
</P>
1997 <P>Setting the maximum size to
0 disables log rotation.
</P>
2000 <H2 CLASS=
"title"><SPAN CLASS=
"info">Deprecated
</SPAN><A NAME=
"MaxRequestSize">MaxRequestSize
</A></H2>
2004 <PRE CLASS=
"command">
2005 MaxRequestSize
10485760
2010 <H3>Description
</H3>
2012 <P>The
<CODE>MaxRequestSize
</CODE> directive controls the maximum
2013 size of print files, IPP requests, and HTML form data in HTTP
2014 POST requests. The default limit is
0 which disables the limit
2017 <P><B>This directive is deprecated and will be removed in a
2018 future CUPS release.
</B> Use the
<A
2019 HREF=
"#LimitRequestBody"><CODE>LimitRequestBody
</CODE></A>
2020 directive instead.
</P>
2023 <H2 CLASS=
"title"><A NAME=
"Order">Order
</A></H2>
2027 <PRE CLASS=
"command">
2028 <Location /path
>
2035 <H3>Description
</H3>
2037 <P>The
<CODE>Order
</CODE> directive defines the default access
2038 control. The following values are supported:
</P>
2042 <LI><CODE>allow,deny
</CODE> - Deny requests by default,
2043 then check the
<A HREF=
"#Allow"><CODE>Allow
</CODE></A>
2044 lines followed by the
<A
2045 HREF=
"#Deny"><CODE>Deny
</CODE></A> lines
</LI>
2047 <LI><CODE>deny,allow
</CODE> - Allow requests by default,
2048 then check the
<A HREF=
"#Deny"><CODE>Deny
</CODE></A>
2049 lines followed by the
<A
2050 HREF=
"#Allow"><CODE>Allow
</CODE></A> lines
</LI>
2054 <P>The
<CODE>Order
</CODE> directive must appear inside a
<A
2055 HREF=
"#Location"><CODE>Location
</CODE></A> or
<A
2056 HREF=
"#Limit"><CODE>Limit
</CODE></A> section.
</P>
2059 <H2 CLASS=
"title"><A NAME=
"PageLog">PageLog
</A></H2>
2063 <PRE CLASS=
"command">
2064 PageLog /var/log/cups/page_log
2065 PageLog /var/log/cups/page_log-%s
2069 <H3>Description
</H3>
2071 <P>The
<CODE>PageLog
</CODE> directive sets the name of the page
2072 log file. If the filename is not absolute then it is assumed to
2073 be relative to the
<A
2074 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory. The
2075 default page log file is
<VAR>/var/log/cups/page_log
</VAR>.
</P>
2077 <P>The server name can be included in the filename by using
2078 <CODE>%s
</CODE> in the name.
</P>
2080 <P>The special name
"syslog" can be used to send the page
2081 information to the system log instead of a plain file.
</P>
2084 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"PassEnv">PassEnv
</A></H2>
2088 <PRE CLASS=
"command">
2089 PassEnv MY_ENV_VARIABLE
2092 <H3>Description
</H3>
2094 <P>The
<CODE>PassEnv
</CODE> directive specifies an environment
2095 variable that should be passed to child processes. Normally, the
2096 scheduler only passes the
<CODE>DYLD_LIBRARY_PATH
</CODE>,
2097 <CODE>LD_ASSUME_KERNEL
</CODE>,
<CODE>LD_LIBRARY_PATH
</CODE>,
2098 <CODE>LD_PRELOAD
</CODE>,
<CODE>NLSPATH
</CODE>,
2099 <CODE>SHLIB_PATH
</CODE>,
<CODE>TZ
</CODE>, and
<CODE>VGARGS
</CODE>
2100 environment variables to child processes.
</P>
2103 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"Policy">Policy
</A></H2>
2107 <PRE CLASS=
"command">
2109 <Limit operation ... operation
>
2112 <Limit operation ... operation
>
2121 <H3>Description
</H3>
2123 <P>The
<CODE>Policy
</CODE> directive specifies IPP operation
2124 access control limits. Each policy contains
1 or more
<A
2125 HREF=
"#LimitIPP"><CODE>Limit
</CODE></A> sections to set the
2126 access control limits for specific operations - user limits,
2127 authentication, encryption, and allowed/denied addresses,
2128 domains, or hosts. The
<CODE><Limit All
></CODE> section
2129 specifies the default access control limits for operations that
2132 <P>Policies are named and associated with printers via the
2133 printer's operation policy setting
2134 (
<CODE>printer-op-policy
</CODE>). The default policy for the
2135 scheduler is specified using the
<A
2136 HREF=
"#DefaultPolicy"><CODE>DefaultPolicy
</CODE></A>
2140 <H2 CLASS=
"title"><A NAME=
"Port">Port
</A></H2>
2144 <PRE CLASS=
"command">
2149 <H3>Description
</H3>
2151 <P>The
<CODE>Port
</CODE> directive specifies a port to listen on.
2152 Multiple
<CODE>Port
</CODE> lines can be specified to listen on
2153 multiple ports. The
<CODE>Port
</CODE> directive is equivalent to
2154 "<CODE>Listen *:nnn</CODE>". The default port is
631.
</P>
2156 <BLOCKQUOTE><B>Note:
</B>
2158 <P>On systems that support IPv6, this directive will bind to both
2159 the IPv4 and IPv6 wildcard address.
</P>
2164 <H2 CLASS=
"title"><A NAME=
"PreserveJobHistory">PreserveJobHistory
</A></H2>
2168 <PRE CLASS=
"command">
2169 PreserveJobHistory On
2170 PreserveJobHistory Off
2173 <H3>Description
</H3>
2175 <P>The
<CODE>PreserveJobHistory
</CODE> directive controls whether
2176 the history of completed, canceled, or aborted print jobs is
2179 <P>A value of
<CODE>On
</CODE> (the default) preserves job
2180 information until the administrator purges it with the
2181 <CODE>cancel
</CODE> command.
</P>
2183 <P>A value of
<CODE>Off
</CODE> removes the job information as
2184 soon as each job is completed, canceled, or aborted.
</P>
2187 <H2 CLASS=
"title"><A NAME=
"PreserveJobFiles">PreserveJobFiles
</A></H2>
2191 <PRE CLASS=
"command">
2193 PreserveJobFiles Off
2196 <H3>Description
</H3>
2198 <P>The
<CODE>PreserveJobFiles
</CODE> directive controls whether
2199 the document files of completed, canceled, or aborted print jobs
2200 are stored on disk.
</P>
2202 <P>A value of
<CODE>On
</CODE> preserves job files until the
2203 administrator purges them with the
<CODE>cancel
</CODE> command.
2204 Jobs can be restarted (and reprinted) as desired until they are
2207 <P>A value of
<CODE>Off
</CODE> (the default) removes the job
2208 files as soon as each job is completed, canceled, or aborted.
</P>
2211 <H2 CLASS=
"title"><A NAME=
"Printcap">Printcap
</A></H2>
2215 <PRE CLASS=
"command">
2217 Printcap /etc/printcap
2218 Printcap /etc/printers.conf
2221 <H3>Description
</H3>
2223 <P>The
<CODE>Printcap
</CODE> directive controls whether or not a
2224 printcap file is automatically generated and updated with a list
2225 of available printers. If specified with no value, then no
2226 printcap file will be generated. The default is to generate a
2227 file named
<VAR>/etc/printcap
</VAR>.
</P>
2229 <P>When a filename is specified (e.g.
<VAR>/etc/printcap
</VAR>),
2230 the printcap file is written whenever a printer is added or
2231 removed. The printcap file can then be used by applications that
2232 are hardcoded to look at the printcap file for the available
2236 <H2 CLASS=
"title"><A NAME=
"PrintcapFormat">PrintcapFormat
</A></H2>
2240 <PRE CLASS=
"command">
2242 PrintcapFormat Solaris
2245 <H3>Description
</H3>
2247 <P>The
<CODE>PrintcapFormat
</CODE> directive controls the output
2248 format of the printcap file. The default is to generate a BSD
2252 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.13</SPAN><A NAME=
"PrintcapGUI">PrintcapGUI
</A></H2>
2256 <PRE CLASS=
"command">
2257 PrintGUI /usr/bin/glpoptions
2260 <H3>Description
</H3>
2262 <P>The
<CODE>PrintcapGUI
</CODE> directive sets the program to
2263 associate with the IRIX printer GUI interface script which is
2264 used by IRIX applications to display printer-specific options.
2265 There is no default program.
</P>
2268 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.21</SPAN><A NAME=
"ReloadTimeout">ReloadTimeout
</A></H2>
2272 <PRE CLASS=
"command">
2277 <H3>Description
</H3>
2279 <P>The
<CODE>ReloadTimeout
</CODE> directive specifies the number
2280 of seconds the scheduler will wait for active jobs to complete
2281 before doing a restart. The default is
60 seconds.
</P>
2284 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.3</SPAN><A NAME=
"RemoteRoot">RemoteRoot
</A></H2>
2288 <PRE CLASS=
"command">
2293 <H3>Description
</H3>
2295 <P>The
<CODE>RemoteRoot
</CODE> directive sets the username for
2296 unauthenticated root requests from remote hosts. The default
2297 username is
<VAR>remroot
</VAR>. Setting
<CODE>RemoteRoot
</CODE>
2298 to
<VAR>root
</VAR> effectively disables this security
2302 <H2 CLASS=
"title"><A NAME=
"RequestRoot">RequestRoot
</A></H2>
2306 <PRE CLASS=
"command">
2307 RequestRoot /var/spool/cups
2308 RequestRoot /foo/bar/spool/cups
2311 <H3>Description
</H3>
2313 <P>The
<CODE>RequestRoot
</CODE> directive sets the directory for
2314 incoming IPP requests and HTML forms. If an absolute path is not
2315 provided then it is assumed to be relative to the
<A
2316 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory. The
2317 default request directory is
<VAR>/var/spool/cups
</VAR>.
</P>
2320 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"Require">Require
</A></H2>
2324 <PRE CLASS=
"command">
2325 <Location /path
>
2327 Require group foo bar
2328 Require user john mary
2330 Require user @groupname
2331 Require user @SYSTEM
2336 <H3>Description
</H3>
2338 <P>The
<CODE>Require
</CODE> directive specifies that
2339 authentication is required for the resource. The
2340 <CODE>group
</CODE> keyword specifies that the authenticated user
2341 must be a member of one or more of the named groups that
2344 <P>The
<CODE>user
</CODE> keyboard specifies that the
2345 authenticated user must be one of the named users or groups that
2346 follow. Group names are specified using the
"@" prefix.
</P>
2348 <P>The
<CODE>valid-user
</CODE> keyword specifies that any
2349 authenticated user may access the resource.
</P>
2351 <P>The default is to do no authentication. This directive must
2352 appear inside a
<A HREF=
"#Location"><CODE>Location
</CODE></A> or
2353 <A HREF=
"#Limit"><CODE>Limit
</CODE></A> section.
</P>
2356 <H2 CLASS=
"title"><A NAME=
"RIPCache">RIPCache
</A></H2>
2360 <PRE CLASS=
"command">
2366 <H3>Description
</H3>
2368 <P>The
<CODE>RIPCache
</CODE> directive sets the size of the
2369 memory cache used by Raster Image Processor (
"RIP") filters such
2370 as
<CODE>imagetoraster
</CODE> and
<CODE>pstoraster
</CODE>. The
2371 size can be suffixed with a
"k" for kilobytes,
"m" for megabytes,
2372 or
"g" for gigabytes. The default cache size is
"8m", or
8
2376 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.16</SPAN><A NAME=
"RootCertDuration">RootCertDuration
</A></H2>
2380 <PRE CLASS=
"command">
2382 RootCertDuration
300
2385 <H3>Description
</H3>
2387 <P>The
<CODE>RootCertDuration
</CODE> directive specifies the
2388 number of seconds the
<EM>root certificate
</EM> remains valid.
2389 The scheduler will generate a new certificate as needed when the
2390 number of seconds has expired. If set to
0, the root certificate
2391 is generated only once on startup or on a restart. The default is
2395 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.7</SPAN><A NAME=
"Satisfy">Satisfy
</A></H2>
2399 <PRE CLASS=
"command">
2400 <Location /path
>
2407 <H3>Description
</H3>
2409 <P>The
<CODE>Satisfy
</CODE> directive specifies whether all
2410 conditions must be satisfied to allow access to the resource. If
2411 set to
<CODE>all
</CODE>, then all authentication and access
2412 control conditions must be satified to allow access.
</P>
2414 <P>Setting
<CODE>Satisfy
</CODE> to
<CODE>any
</CODE> allows a user
2415 to gain access if the authentication or access control
2416 requirements are satisfied. For example, you might require
2417 authentication for remote access, but allow local access without
2420 <P>The default is
<CODE>all
</CODE>. This directive must appear
2421 inside a
<A HREF=
"#Location"><CODE>Location
</CODE></A> or
<A
2422 HREF=
"#Limit"><CODE>Limit
</CODE></A> section.
</P>
2425 <H2 CLASS=
"title"><A NAME=
"ServerAdmin">ServerAdmin
</A></H2>
2429 <PRE CLASS=
"command">
2430 ServerAdmin user@host
2431 ServerAdmin root@foo.bar.com
2434 <H3>Description
</H3>
2436 <P>The
<CODE>ServerAdmin
</CODE> directive identifies the email
2437 address for the administrator on the system. By default the
2438 administrator email address is
<CODE>root@server
</CODE>, where
2439 <CODE>server
</CODE> is the
<A
2440 HREF=
"#ServerName"><CODE>ServerName
</CODE></A>.
</P>
2443 <H2 CLASS=
"title"><A NAME=
"ServerBin">ServerBin
</A></H2>
2447 <PRE CLASS=
"command">
2448 ServerBin /usr/lib/cups
2449 ServerBin /foo/bar/lib/cups
2452 <H3>Description
</H3>
2454 <P>The
<CODE>ServerBin
</CODE> directive sets the directory for
2455 server-run executables. If an absolute path is not provided then
2456 it is assumed to be relative to the
<A
2457 HREF=
"#ServerRoot"><CODE>ServerRoot
</CODE></A> directory. The
2458 default executable directory is
<VAR>/usr/lib/cups
</VAR>,
2459 <VAR>/usr/lib32/cups
</VAR>, or
<VAR>/usr/libexec/cups
</VAR>
2460 depending on the operating system.
</P>
2463 <H2 CLASS=
"title"><A NAME=
"ServerCertificate">ServerCertificate
</A></H2>
2467 <PRE CLASS=
"command">
2468 ServerCertificate /etc/cups/ssl/server.crt
2471 <H3>Description
</H3>
2473 <P>The
<CODE>ServerCertificate
</CODE> directive specifies the
2474 location of the SSL certificate file used by the server when
2475 negotiating encrypted connections. The certificate must not be
2476 encrypted (password protected) since the scheduler normally runs
2477 in the background and will be unable to ask for a password.
</P>
2479 <P>The default certificate file is
2480 <VAR>/etc/cups/ssl/server.crt
</VAR>.
</P>
2483 <H2 CLASS=
"title"><A NAME=
"ServerKey">ServerKey
</A></H2>
2487 <PRE CLASS=
"command">
2488 ServerKey /etc/cups/ssl/server.key
2491 <H3>Description
</H3>
2493 <P>The
<CODE>ServerKey
</CODE> directive specifies the location of
2494 the SSL private key file used by the server when negotiating
2495 encrypted connections.
</P>
2497 <P>The default key file is
2498 <VAR>/etc/cups/ssl/server.crt
</VAR>.
</P>
2501 <H2 CLASS=
"title"><A NAME=
"ServerName">ServerName
</A></H2>
2505 <PRE CLASS=
"command">
2506 ServerName foo.domain.com
2507 ServerName myserver.domain.com
2510 <H3>Description
</H3>
2512 <P>The
<CODE>ServerName
</CODE> directive specifies the hostname
2513 that is reported to clients. By default the server name is the
2517 <H2 CLASS=
"title"><A NAME=
"ServerRoot">ServerRoot
</A></H2>
2521 <PRE CLASS=
"command">
2522 ServerRoot /etc/cups
2523 ServerRoot /foo/bar/cups
2526 <H3>Description
</H3>
2528 <P>The
<CODE>ServerRoot
</CODE> directive specifies the absolute
2529 path to the server configuration and state files. It is also used
2530 to resolve relative paths in the
<VAR>cupsd.conf
</VAR> file. The
2531 default server directory is
<VAR>/etc/cups
</VAR>.
</P>
2534 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.1.21</SPAN><A NAME=
"ServerTokens">ServerTokens
</A></H2>
2538 <PRE CLASS=
"command">
2540 ServerTokens ProductOnly
2543 ServerTokens Minimal
2548 <H3>Description
</H3>
2550 <P>The
<CODE>ServerTokens
</CODE> directive specifies the
2551 information that is included in the
<CODE>Server:
</CODE> header
2552 of all HTTP responses. Table
4 lists the token name along with
2553 the text that is returned. The default is
2554 <CODE>Minimal
</CODE>.
</P>
2556 <DIV CLASS=
"table"><TABLE SUMMARY=
"ServerToken Names and Values">
2557 <CAPTION>Table
4:
<A NAME=
"TABLE4">ServerToken Names and Values
</A></CAPTION>
2567 <TD>No
<CODE>Server:
</CODE> header is returned
</TD>
2570 <TD>ProductOnly
</TD>
2583 <TD>"CUPS 1.2.N" where N is the patch release
</TD>
2587 <TD>"CUPS 1.2.N (UNAME)" where N is the patch release and
2588 UNAME is the output of the
<B>uname(
1)
</B> command
</TD>
2592 <TD>"CUPS 1.2.N (UNAME) IPP/1.1" where N is the patch
2593 release and UNAME is the output of the
<B>uname(
1)
</B>
2600 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"SetEnv">SetEnv
</A></H2>
2604 <PRE CLASS=
"command">
2605 SetEnv PATH /usr/lib/cups/filter:/bin:/usr/bin:/usr/local/bin
2606 SetEnv MY_ENV_VAR foo
2609 <H3>Description
</H3>
2611 <P>The
<CODE>SetEnv
</CODE> directive specifies an environment
2612 variable that should be passed to child processes.
</P>
2615 <H2 CLASS=
"title"><A NAME=
"SSLListen">SSLListen
</A></H2>
2619 <PRE CLASS=
"command">
2620 SSLListen
127.0.0.1:
443
2621 SSLListen
192.0.2.1:
443
2624 <H3>Description
</H3>
2626 <P>The
<CODE>SSLListen
</CODE> directive specifies a network
2627 address and port to listen for secure connections. Multiple
2628 <CODE>SSLListen
</CODE> directives can be provided to listen on
2629 multiple addresses.
</P>
2631 <P>The
<CODE>SSLListen
</CODE> directive is similar to the
<A
2632 HREF=
"#SSLPort"><CODE>SSLPort
</CODE></A> directive but allows you
2633 to restrict access to specific interfaces or networks.
</P>
2636 <H2 CLASS=
"title"><A NAME=
"SSLPort">SSLPort
</A></H2>
2640 <PRE CLASS=
"command">
2644 <H3>Description
</H3>
2646 <P>The
<CODE>SSLPort
</CODE> directive specifies a port to listen
2647 on for secure connections. Multiple
<CODE>SSLPort
</CODE> lines
2648 can be specified to listen on multiple ports.
</P>
2651 <H2 CLASS=
"title"><A NAME=
"SystemGroup">SystemGroup
</A></H2>
2655 <PRE CLASS=
"command">
2660 SystemGroup root lpadmin
2663 <H3>Description
</H3>
2665 <P>The
<CODE>SystemGroup
</CODE> directive specifies the system
2666 administration group for
<CODE>System
</CODE> authentication.
2667 Multiple groups can be listed, separated with spaces. The default
2668 is system-dependent and generally consists of all of the
2669 following groups, if present:
<CODE>lpadmin
</CODE>,
2670 <CODE>root
</CODE>,
<CODE>sys
</CODE>, and/or
2671 <CODE>system
</CODE>.
</P>
2674 <H2 CLASS=
"title"><A NAME=
"TempDir">TempDir
</A></H2>
2678 <PRE CLASS=
"command">
2680 TempDir /foo/bar/tmp
2683 <H3>Description
</H3>
2685 <P>The
<CODE>TempDir
</CODE> directive specifies an absolute path
2686 for the directory to use for temporary files. The default
2687 directory is
<VAR>/var/spool/cups/tmp
</VAR>.
</P>
2689 <P>Temporary directories must be world-writable and should have
2690 the
"sticky" permission bit enabled so that other users cannot
2691 delete filter temporary files. The following commands will create
2692 an appropriate temporary directory called
2693 <VAR>/foo/bar/tmp
</VAR>:
</P>
2695 <PRE CLASS=
"command">
2696 <KBD>mkdir /foo/bar/tmp
</KBD>
2697 <KBD>chmod a+rwxt /foo/bar/tmp
</KBD>
2701 <H2 CLASS=
"title"><A NAME=
"Timeout">Timeout
</A></H2>
2705 <PRE CLASS=
"command">
2710 <H3>Description
</H3>
2712 <P>The
<CODE>Timeout
</CODE> directive controls the amount of time
2713 to wait before an active HTTP or IPP request times out. The
2714 default timeout is
300 seconds.
</P>
2717 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"UseNetworkDefault">UseNetworkDefault
</A></H2>
2721 <PRE CLASS=
"command">
2722 UseNetworkDefault yes
2723 UseNetworkDefault no
2726 <H3>Description
</H3>
2728 <P>The
<CODE>UseNetworkDefault
</CODE> directive controls whether
2729 the client will use a network/remote printer as a default
2730 printer. If enabled, the default printer of a server is used as
2731 the default printer on a client. When multiple servers are
2732 advertising a default printer, the client's default printer is
2733 set to the first discovered printer, or to the implicit class for
2734 the same printer available from multiple servers.
</P>
2736 <P>The default is
<CODE>yes
</CODE>.
</P>
2739 <H2 CLASS=
"title"><A NAME=
"User">User
</A></H2>
2743 <PRE CLASS=
"command">
2748 <H3>Description
</H3>
2750 <P>The
<CODE>User
</CODE> directive specifies the UNIX user that
2751 filter and CGI programs run as. The default user is
2752 <CODE>lp
</CODE>.
</P>
2754 <BLOCKQUOTE><B>Note:
</B>
2756 <P>You may not use user
<CODE>root
</CODE>, as that would expose
2757 the system to unacceptable security risks. The scheduler will
2758 automatically choose user
<CODE>nobody
</CODE> if you specify a
2759 user whose ID is
0.
</P>