diff options
Diffstat (limited to 'doc/help/ref-cupsd-conf.html.in')
| -rw-r--r-- | doc/help/ref-cupsd-conf.html.in | 746 |
1 files changed, 160 insertions, 586 deletions
diff --git a/doc/help/ref-cupsd-conf.html.in b/doc/help/ref-cupsd-conf.html.in index ce0ec8f6..8454cf78 100644 --- a/doc/help/ref-cupsd-conf.html.in +++ b/doc/help/ref-cupsd-conf.html.in @@ -42,6 +42,12 @@ sudo launchctl load /System/Library/LaunchDaemons/org.cups.cupsd.plist <P>You can also edit this file from the CUPS web interface, which automatically handles restarting the scheduler.</P> +<BLOCKQUOTE><B>Note:</B> + +<P>The specification of time units ("w" for weeks, "h" for hours, etc.) in the various time interval directives is new in CUPS 1.6/OS X 10.8. Prior releases of CUPS only supported time intervals in seconds.</P> + +</BLOCKQUOTE> + <H2 CLASS="title"><A NAME="AccessLog">AccessLog</A></H2> @@ -335,243 +341,14 @@ quotas. This option has no effect if quotas are not enabled. The default setting is <CODE>No</CODE>.</P> -<H2 CLASS="title"><A NAME="BrowseAddress">BrowseAddress</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseAddress 255.255.255.255:631 -BrowseAddress 192.0.2.255:631 -BrowseAddress host.example.com:631 -BrowseAddress @LOCAL -BrowseAddress @IF(name) -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseAddress</CODE> directive specifies an address -to send browsing information to. Multiple -<CODE>BrowseAddress</CODE> directives can be specified to send -browsing information to different networks or systems.</P> - -<P>The <CODE>@LOCAL</CODE> name will broadcast printer -information to all local interfaces. The <CODE>@IF(name)</CODE> -name will broadcast to the named interface.</P> - -<P>There is no default browse address.</P> - -<BLOCKQUOTE><B>Note:</B> - -<P>If you are using HP-UX 10.20 and a subnet that is not 24, -16, or 8 bits, printer browsing (and in fact all broadcast -reception) will not work. This problem appears to be fixed in -HP-UX 11.0.</P> - -</BLOCKQUOTE> - - -<H2 CLASS="title"><A NAME="BrowseAllow">BrowseAllow</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseAllow from all -BrowseAllow from none -BrowseAllow from 192.0.2 -BrowseAllow from 192.0.2.0/24 -BrowseAllow from 192.0.2.0/255.255.255.0 -BrowseAllow from *.example.com -BrowseAllow from @LOCAL -BrowseAllow from @IF(name) -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseAllow</CODE> directive specifies a system or -network to accept browse packets from. The default is to accept -browse packets from all hosts.</P> - -<P>Host and domain name matching require that you enable the <A -HREF="#HostNameLookups"><CODE>HostNameLookups</CODE></A> -directive.</P> - -<P>IP address matching supports exact matches, partial addresses that match -networks using netmasks of 255.0.0.0, 255.255.0.0, and 255.255.255.0, or network -addresses using the specified netmask or bit count. The <CODE>/mm</CODE> -notation specifies a CIDR netmask, a shown in <A HREF="TABLE1">Table 1</A>.</P> - -<P>The <CODE>@LOCAL</CODE> name will allow browse data from all -local interfaces. The <CODE>@IF(name)</CODE> name will allow -browse data from the named interface. In both cases, CUPS only -allows data from the network that the interface(s) are configured -for - data arriving on the interface from a foreign network will -<em>not</em> be allowed.</P> - - -<H2 CLASS="title"><A NAME="BrowseDeny">BrowseDeny</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseDeny from all -BrowseDeny from none -BrowseDeny from 192.0.2 -BrowseDeny from 192.0.2.0/24 -BrowseDeny from 192.0.2.0/255.255.255.0 -BrowseDeny from *.example.com -BrowseDeny from @LOCAL -BrowseDeny from @IF(name) -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseDeny</CODE> directive specifies a system or -network to reject browse packets from. The default is to not deny -browse packets from any hosts.</P> - -<P>Host and domain name matching require that you enable the <A -HREF="#HostNameLookups"><CODE>HostNameLookups</CODE></A> -directive.</P> - -<P>IP address matching supports exact matches, partial addresses that match -networks using netmasks of 255.0.0.0, 255.255.0.0, and 255.255.255.0, or network -addresses using the specified netmask or bit count. The <CODE>/mm</CODE> -notation specifies a CIDR netmask, a shown in <A HREF="TABLE1">Table 1</A>.</P> - -<P>The <CODE>@LOCAL</CODE> name will block browse data from all -local interfaces. The <CODE>@IF(name)</CODE> name will block -browse data from the named interface. In both cases, CUPS only -blocks data from the network that the interface(s) are configured -for - data arriving on the interface from a foreign network will -<em>not</em> be blocked.</P> - - -<H2 CLASS="title"><A NAME="BrowseInterval">BrowseInterval</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseInterval 0 -BrowseInterval 30 -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseInterval</CODE> directive specifies the -maximum amount of time between browsing updates. Specifying a -value of 0 seconds disables outgoing browse updates but allows a -server to receive printer information from other hosts.</P> - -<P>The <CODE>BrowseInterval</CODE> value should always be less -than the <A HREF="#BrowseTimeout"><CODE>BrowseTimeout</CODE></A> -value. Otherwise printers and classes will disappear from client -systems between updates.</P> - - -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="BrowseLDAPBindDN">BrowseLDAPBindDN</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseLDAPBindDN foo -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseLDAPBindDN</CODE> directive specifies the LDAP -domain name to use when listening for printer registrations. The -default is undefined.</P> - - -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/Mac OS X 10.6</SPAN><A NAME="BrowseLDAPCACertFile">BrowseLDAPCACertFile</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseLDAPCACertFile /etc/cups/ssl/certs -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseLDAPCACertFile</CODE> directive specifies the SSL certificate -authority file to use for LDAP + SSL. The default is undefined.</P> - - -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="BrowseLDAPDN">BrowseLDAPDN</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseLDAPDN bar -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseLDAPDN</CODE> directive specifies the LDAP -domain name to use when registering local shared printers. The -default is undefined.</P> - - -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="BrowseLDAPPassword">BrowseLDAPPassword</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseLDAPPassword foo123 -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseLDAPPassword</CODE> directive specifies the -access password to use when connecting to the LDAP server. The -default is undefined.</P> - - -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="BrowseLDAPServer">BrowseLDAPServer</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseLDAPServer localhost -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseLDAPServer</CODE> directive specifies the name -of the LDAP server to connect to. The default is undefined.</P> - - -<H2 CLASS="title"><A NAME="BrowseLocalOptions">BrowseLocalOptions</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseLocalOptions compression=yes -BrowseLocalOptions encryption=required -BrowseLocalOptions compression=yes&encryption=required -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseLocalOptions</CODE> directive specifies -additional IPP backend options to advertise with local shared -printers. The default is to not include any options.</P> - - -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="BrowseLocalProtocols">BrowseLocalProtocols</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="BrowseLocalProtocols">BrowseLocalProtocols</A></H2> <H3>Examples</H3> <PRE CLASS="command"> BrowseLocalProtocols all BrowseLocalProtocols none -BrowseLocalProtocols cups BrowseLocalProtocols dnssd -BrowseLocalProtocols ldap -BrowseLocalProtocols lpd -BrowseLocalProtocols slp -BrowseLocalProtocols smb -BrowseLocalProtocols cups dnssd </PRE> <H3>Description</H3> @@ -582,230 +359,6 @@ network. Multiple protocols can be specified by separating them with spaces. The default is "<CODE>@CUPS_BROWSE_LOCAL_PROTOCOLS@</CODE>".</P> -<H2 CLASS="title"><A NAME="BrowseOrder">BrowseOrder</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseOrder allow,deny -BrowseOrder deny,allow -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseOrder</CODE> directive specifies the order of -allow/deny processing. The default order is -<CODE>deny,allow</CODE>:</P> - -<UL> - - <LI><CODE>allow,deny</CODE> - Deny browse packets by - default, then check <CODE>BrowseAllow</CODE> lines - followed by <CODE>BrowseDeny</CODE> lines.</LI> - - <LI><CODE>deny,allow</CODE> - Allow browse packets by - default, then check <CODE>BrowseDeny</CODE> lines - followed by <CODE>BrowseAllow</CODE> lines.</LI> - -</UL> - - -<H2 CLASS="title"><A NAME="BrowsePoll">BrowsePoll</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowsePoll 192.0.2.2:631 -BrowsePoll host.example.com:631 -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowsePoll</CODE> directive polls a server for -available printers once every <A -HREF="#BrowseInterval"><CODE>BrowseInterval</CODE></A> seconds. -Multiple <CODE>BrowsePoll</CODE> directives can be specified to -poll multiple servers.</P> - -<P>If <CODE>BrowseInterval</CODE> is set to 0 then the server is -polled once every 30 seconds.</P> - - -<H2 CLASS="title"><A NAME="BrowsePort">BrowsePort</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowsePort 631 -BrowsePort 9999 -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowsePort</CODE> directive specifies the UDP port number -used for browse packets. The default port number is 631.</P> - -<BLOCKQUOTE><B>Note:</B> - -<P>You must set the <CODE>BrowsePort</CODE> to the same value -on all of the systems that you want to see. - -</BLOCKQUOTE> - - -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.10</SPAN><A NAME="BrowseProtocols">BrowseProtocols</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseProtocols all -BrowseProtocols none -BrowseProtocols cups -BrowseProtocols dnssd -BrowseProtocols ldap -BrowseProtocols lpd -BrowseProtocols slp -BrowseProtocols smb -BrowseProtocols cups dnssd -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseProtocols</CODE> directive specifies the -protocols to use when showing and advertising shared printers on -the local network. Multiple protocols can be specified by -separating them with spaces. The default protocol is -"<CODE>@CUPS_BROWSE_LOCAL_PROTOCOLS@</CODE>" for -<A HREF="#BrowseLocalProtocols"><CODE>BrowseLocalProtocols</CODE></A> and -"<CODE>@CUPS_BROWSE_REMOTE_PROTOCOLS@</CODE>" for -<A HREF="#BrowseRemoteProtocols"><CODE>BrowseRemoteProtocols</CODE></A>.</P> - -<BLOCKQUOTE><B>Note:</B> - -<P>When using the <CODE>SLP</CODE> protocol, you must have at least -one Directory Agent (DA) server on your network. Otherwise the -CUPS scheduler (<CODE>cupsd</CODE>) will not respond to client -requests for several seconds while polling the network.</P> - -</BLOCKQUOTE> - - -<H2 CLASS="title"><A NAME="BrowseRelay">BrowseRelay</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseRelay 193.0.2.1 192.0.2.255 -BrowseRelay 193.0.2.0/255.255.255.0 192.0.2.255 -BrowseRelay 193.0.2.0/24 192.0.2.255 -BrowseRelay *.example.com 192.0.2.255 -BrowseRelay host.example.com 192.0.2.255 -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseRelay</CODE> directive specifies source and -destination addresses for relaying browsing information from one -host or network to another. Multiple <CODE>BrowseRelay</CODE> -directives can be specified as needed.</P> - -<P><CODE>BrowseRelay</CODE> is typically used on systems that -bridge multiple subnets using one or more network interfaces. It -can also be used to relay printer information from polled servers -with the line:</P> - -<PRE CLASS="command"> -BrowseRelay 127.0.0.1 192.0.2.255 -</PRE> - -<P>This effectively provides access to printers on a WAN for all -clients on the LAN. Use multiple <CODE>BrowseRelay</CODE> lines to -relay information to multiple subnets.</P> - - -<H2 CLASS="title"><A NAME="BrowseRemoteOptions">BrowseRemoteOptions</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseRemoteOptions compression=yes -BrowseRemoteOptions encryption=required -BrowseRemoteOptions ?compression=yes&encryption=required -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseRemoteOptions</CODE> directive specifies -additional IPP backend options to include with remote shared -printers. If the options string begins with a question mark (?), -the options replace any options specified by the remote server. -The default is to not include any options.</P> - - -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="BrowseRemoteProtocols">BrowseRemoteProtocols</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseRemoteProtocols all -BrowseRemoteProtocols none -BrowseRemoteProtocols cups -BrowseRemoteProtocols ldap -BrowseRemoteProtocols slp -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseRemoteProtocols</CODE> directive specifies the -protocols to use when finding remote shared printers on the -network. Multiple protocols can be specified by separating them -with spaces. The default is "<CODE>@CUPS_BROWSE_REMOTE_PROTOCOLS@</CODE>".</P> - - -<H2 CLASS="title"><A NAME="BrowseShortNames">BrowseShortNames</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseShortNames Yes -BrowseShortNames No -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseShortNames</CODE> directive specifies whether -or not short names are used for remote printers when possible. -Short names are just the remote printer name, without the server -("printer"). If more than one remote printer is detected with the -same name, the printers will have long names ("printer@server1", -"printer@server2".)</P> - -<P>The default value for this option is <CODE>@CUPS_BROWSE_SHORT_NAMES@</CODE>.</P> - - -<H2 CLASS="title"><A NAME="BrowseTimeout">BrowseTimeout</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -BrowseTimeout 300 -BrowseTimeout 60 -</PRE> - -<H3>Description</H3> - -<P>The <CODE>BrowseTimeout</CODE> directive sets the timeout for -printer or class information that is received in browse packets. -Once a printer or class times out it is removed from the list of -available destinations.</P> - -<P>The <CODE>BrowseTimeout</CODE> value should always be greater -than the <A -HREF="#BrowseInterval"><CODE>BrowseInterval</CODE></A> value. -Otherwise printers and classes will disappear from client systems -between updates.</P> - - <H2 CLASS="title"><A NAME="BrowseWebIF">BrowseWebIF</A></H2> <H3>Examples</H3> @@ -834,24 +387,9 @@ Browsing Off <H3>Description</H3> <P>The <CODE>Browsing</CODE> directive controls whether or not -network printer browsing is enabled. The default setting is +printer sharing is enabled. The default setting is <CODE>@CUPS_BROWSING@</CODE>.</P> -<P>This directive does not enable sharing of local printers by -itself; you must also use the <A -HREF="#BrowseAddress"><CODE>BrowseAddress</CODE></A> or <A -HREF="#BrowseProtocols"><CODE>BrowseProtocols</CODE></A> -directives to advertise local printers to other systems.</P> - -<BLOCKQUOTE><B>Note:</B> - -<P>If you are using HP-UX 10.20 and a subnet that is not 24, -16, or 8 bits, printer browsing (and in fact all broadcast -reception) will not work. This problem appears to be fixed in -HP-UX 11.0.</P> - -</BLOCKQUOTE> - <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Classification">Classification</A></H2> @@ -932,7 +470,7 @@ DataDir /usr/share/cups for data files.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="DefaultAuthType">DefaultAuthType</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="DefaultAuthType">DefaultAuthType</A></H2> <H3>Examples</H3> @@ -950,7 +488,7 @@ of authentication to use for IPP operations that require a username. The default is <CODE>Basic</CODE>.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="DefaultEncryption">DefaultEncryption</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="DefaultEncryption">DefaultEncryption</A></H2> <H3>Examples</H3> @@ -988,7 +526,7 @@ language localization file exists for it. The default language is "en" for English.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/Mac OS X 10.6</SPAN><A NAME="DefaultPaperSize">DefaultPaperSize</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/OS X 10.6</SPAN><A NAME="DefaultPaperSize">DefaultPaperSize</A></H2> <H3>Examples</H3> @@ -1008,7 +546,7 @@ of <CODE>None</CODE> tells the scheduler to not set the default paper size.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="DefaultPolicy">DefaultPolicy</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="DefaultPolicy">DefaultPolicy</A></H2> <H3>Examples</H3> @@ -1027,7 +565,7 @@ policy to use for IPP operation. The default is and other job operations.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="DefaultShared">DefaultShared</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="DefaultShared">DefaultShared</A></H2> <H3>Examples</H3> @@ -1095,22 +633,24 @@ HREF="#Location"><CODE>Location</CODE></A> or <A HREF="#Limit"><CODE>Limit</CODE></A> section.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/Mac OS X 10.6</SPAN><A NAME="DirtyCleanInterval">DirtyCleanInterval</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/OS X 10.6</SPAN><A NAME="DirtyCleanInterval">DirtyCleanInterval</A></H2> <H3>Examples</H3> <PRE CLASS="command"> +DirtyCleanInterval 1w +DirtyCleanInterval 1d +DirtyCleanInterval 1h +DirtyCleanInterval 1m DirtyCleanInterval 30 DirtyCleanInterval 0 </PRE> <H3>Description</H3> -<P>The <CODE>DirtyCleanInterval</CODE> directive specifies the number of -seconds to wait before updating configuration and state files for printers, -classes, subscriptions, and jobs. The default is 30 seconds. A value of 0 -causes the update to occur as soon as possible, typically within a few -milliseconds.</P> +<P>The <CODE>DirtyCleanInterval</CODE> directive specifies the amount of time to wait before updating configuration and state files for printers, classes, subscriptions, and jobs in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix). A value of <CODE>0</CODE> causes the update to occur as soon as possible, typically within a few milliseconds.</P> + +<P>The default value is <CODE>30</CODE> (30 seconds).</P> <H2 CLASS="title"><A NAME="DocumentRoot">DocumentRoot</A></H2> @@ -1186,7 +726,7 @@ default error log file is <VAR>@CUPS_LOGDIR@/error_log</VAR>.</P> information to the system log instead of a plain file.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.3/Mac OS X 10.5</SPAN><A NAME="ErrorPolicy">ErrorPolicy</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.3/OS X 10.5</SPAN><A NAME="ErrorPolicy">ErrorPolicy</A></H2> <H3>Examples</H3> @@ -1225,7 +765,7 @@ printer.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/Mac OS X 10.6</SPAN><A NAME="FatalErrors">FatalErrors</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/OS X 10.6</SPAN><A NAME="FatalErrors">FatalErrors</A></H2> <H3>Examples</H3> @@ -1386,23 +926,18 @@ system-specific but is usually <CODE>lp</CODE> or <CODE>nobody</CODE>.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.10</SPAN><A NAME="HideImplicitMembers">HideImplicitMembers</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.6/OS X 10.8</SPAN><A NAME="GSSServiceName">GSSServiceName</A></H2> <H3>Examples</H3> <PRE CLASS="command"> -HideImplicitMembers Yes -HideImplicitMembers No +GSSServiceName http +GSSServiceName ipp </PRE> <H3>Description</H3> -<P>The <CODE>HideImplicitMembers</CODE> directive controls -whether the individual printers in an implicit class are hidden -from the user. The default is <CODE>Yes</CODE>.</P> - -<P><A HREF="#ImplicitClasses"><CODE>ImplicitClasses</CODE></A> -must be enabled for this directive to have any effect.</P> +<P>The <CODE>GSSServiceName</CODE> directive sets the Kerberos service name to use. The default is <CODE>@CUPS_DEFAULT_GSSSERVICE_NAME@</CODE> for compatibility with Microsoft Windows.</P> <H2 CLASS="title"><A NAME="HostNameLookups">HostNameLookups</A></H2> @@ -1431,45 +966,6 @@ performance problems with hostname lookups. Set this option to required.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.10</SPAN><A NAME="ImplicitAnyClasses">ImplicitAnyClasses</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -ImplicitAnyClasses On -ImplicitAnyClasses Off -</PRE> - -<H3>Description</H3> - -<P>The <CODE>ImplicitAnyClasses</CODE> directive controls -whether implicit classes for local and remote printers are -created with the name <CODE>AnyPrinter</CODE>. The default -setting is <CODE>Off</CODE>.</P> - -<P><A HREF="#ImplicitClasses"><CODE>ImplicitClasses</CODE></A> -must be enabled for this directive to have any effect.</P> - - -<H2 CLASS="title"><A NAME="ImplicitClasses">ImplicitClasses</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -ImplicitClasses On -ImplicitClasses Off -</PRE> - -<H3>Description</H3> - -<P>The <CODE>ImplicitClasses</CODE> directive controls whether -implicit classes are created based upon the available network -printers and classes. The default setting is -<CODE>@CUPS_IMPLICIT_CLASSES@</CODE> but is automatically turned -<CODE>Off</CODE> if <A HREF="#Browsing"><CODE>Browsing</CODE></A> is turned -<CODE>Off</CODE>.</P> - - <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.9</SPAN><A NAME="Include">Include</A></H2> <H3>Examples</H3> @@ -1523,47 +1019,51 @@ JobPrivateValues attribute-name-1 [ ... attribute-name-N ] <P>The <CODE>JobPrivateValues</CODE> directive specifies the list of job values to make private. The "default" values are "job-name", -"job-originating-host-name", and "job-originating-user-name".</P> +"job-originating-host-name", "job-originating-user-name", and "phone".</P> <P>The <CODE>JobPrivateValues</CODE> directive must appear inside a <A HREF="#Policy"><CODE>Policy</CODE></A> section.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="JobRetryInterval">JobRetryInterval</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="JobRetryInterval">JobRetryInterval</A></H2> <H3>Examples</H3> <PRE CLASS="command"> +JobRetryInterval 1w +JobRetryInterval 1d +JobRetryInterval 1h +JobRetryInterval 1m JobRetryInterval 30 -JobRetryInterval 120 </PRE> <H3>Description</H3> -<P>The <CODE>JobRetryInterval</CODE> directive specifies the -number of seconds to wait before retrying a job. This is -typically used for fax queues but can also be used with normal -print queues whose error policy is <CODE>retry-job</CODE>. The -default is 30 seconds.</P> +<P>The <CODE>JobRetryInterval</CODE> directive specifies the amount of time to wait before retrying a job in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix). This is typically used for fax queues but can also be used with normal print queues whose error policy is <CODE>retry-job</CODE> or <CODE>retry-current-job</CODE>.</P> +<P>The default is <CODE>30</CODE> (30 seconds).</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/Mac OS X 10.6</SPAN><A NAME="JobKillDelay">JobKillDelay</A></H2> + +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/OS X 10.6</SPAN><A NAME="JobKillDelay">JobKillDelay</A></H2> <H3>Examples</H3> <PRE CLASS="command"> +JobKillDelay 1w +JobKillDelay 1d +JobKillDelay 1h +JobKillDelay 1m JobKillDelay 30 -JobKillDelay 120 </PRE> <H3>Description</H3> -<P>The <CODE>JobKillDelay</CODE> directive specifies the number of seconds to -wait before killing the filters and backend associated with a canceled or held -job. The default is 30 seconds.</P> +<P>The <CODE>JobKillDelay</CODE> directive specifies the amount of time to wait before killing the filters and backend associated with a canceled or held job in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P> + +<P>The default is <CODE>30</CODE> (30 seconds).</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="JobRetryLimit">JobRetryLimit</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="JobRetryLimit">JobRetryLimit</A></H2> <H3>Examples</H3> @@ -1607,15 +1107,18 @@ field of each request.</P> <H3>Examples</H3> <PRE CLASS="command"> -KeepAliveTimeout 60 +KeepAliveTimeout 1w +KeepAliveTimeout 1d +KeepAliveTimeout 1h +KeepAliveTimeout 1m KeepAliveTimeout 30 </PRE> <H3>Description</H3> -<P>The <CODE>KeepAliveTimeout</CODE> directive controls how long -a persistent HTTP connection will remain open after the last -request. The default is 30 seconds.</P> +<P>The <CODE>KeepAliveTimeout</CODE> directive controls how long a persistent HTTP connection will remain open after the last request in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P> + +<P>The default is <CODE>30</CODE> (30 seconds).</P> <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Limit">Limit (Location)</A></H2> @@ -1647,7 +1150,7 @@ The request type names are case-sensitive for compatibility with Apache.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="LimitIPP">Limit (Policy)</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="LimitIPP">Limit (Policy)</A></H2> <H3>Examples</H3> @@ -2187,6 +1690,23 @@ copies to 100.</P> </BLOCKQUOTE> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.6/OS X 10.8</SPAN><A NAME="MaxHoldTime">MaxHoldTime</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +MaxHoldTime 10800 +MaxHoldTime 3h +MaxHoldTime 180m +MaxHoldTime 0 +</PRE> + +<H3>Description</H3> + +<P>The <CODE>MaxHoldTime</CODE> directive controls the maximum number of seconds allowed for a job to remain in the "indefinite" hold state. The job is canceled automatically if it remains held indefinitely longer than the specified time interval in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P> + +<p>The default setting is <CODE>0</CODE> which disables this functionality.</P> + <H2 CLASS="title"><A NAME="MaxJobs">MaxJobs</A></H2> @@ -2254,6 +1774,26 @@ active jobs is completed, stopped, aborted, or canceled.</P> default setting is 0.</P> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.6/OS X 10.8</SPAN><A NAME="MaxJobTime">MaxJobTime</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +MaxJobTime 10800 +MaxJobTime 3h +MaxJobTime 180m +MaxJobTime 0 +</PRE> + +<H3>Description</H3> + +<P>The <CODE>MaxJobTime</CODE> directive controls the maximum number of +seconds allowed for a job to complete printing before it is considered "stuck". +The job is canceled automatically if it takes longer than the specified time to complete in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P> + +<p>Setting the maximum time to <CODE>0</CODE> disables this functionality. The default setting is <CODE>3h</CODE> (3 hours).</P> + + <H2 CLASS="title"><A NAME="MaxLogSize">MaxLogSize</A></H2> <H3>Examples</H3> @@ -2298,20 +1838,23 @@ HREF="#LimitRequestBody"><CODE>LimitRequestBody</CODE></A> directive instead.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/Mac OS X 10.6</SPAN><A NAME="MultipleOperationTimeout">MultipleOperationTimeout</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/OS X 10.6</SPAN><A NAME="MultipleOperationTimeout">MultipleOperationTimeout</A></H2> <H3>Examples</H3> <PRE CLASS="command"> -MultipleOperationTimeout 60 +MultipleOperationTimeout 1w +MultipleOperationTimeout 1d +MultipleOperationTimeout 1h +MultipleOperationTimeout 5m MultipleOperationTimeout 300 -MultipleOperationTimeout 86400 </PRE> <H3>Description</H3> -<P>The <CODE>MultipleOperationTimeout</CODE> directive sets the maximum amount -of time between files in a multi-file print job. The default is 300 seconds.</P> +<P>The <CODE>MultipleOperationTimeout</CODE> directive sets the maximum amount of time between files in a multi-file print job in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P> + +<P>The default is <CODE>5m</CODE> (five minutes).</P> <H2 CLASS="title"><A NAME="Order">Order</A></H2> @@ -2417,7 +1960,7 @@ recognized:</P> <P>The default is "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}".</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="PassEnv">PassEnv</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="PassEnv">PassEnv</A></H2> <H3>Examples</H3> @@ -2436,7 +1979,7 @@ scheduler only passes the <CODE>DYLD_LIBRARY_PATH</CODE>, environment variables to child processes.</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="Policy">Policy</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="Policy">Policy</A></H2> <H3>Examples</H3> @@ -2504,20 +2047,24 @@ the IPv4 and IPv6 wildcard address.</P> <PRE CLASS="command"> PreserveJobHistory On PreserveJobHistory Off +PreserveJobHistory 1w +PreserveJobHistory 7d +PreserveJobHistory 168h +PreserveJobHistory 10080m +PreserveJobHistory 604800 </PRE> <H3>Description</H3> -<P>The <CODE>PreserveJobHistory</CODE> directive controls whether -the history of completed, canceled, or aborted print jobs is -stored on disk.</P> +<P>The <CODE>PreserveJobHistory</CODE> directive controls whether the history of completed, canceled, or aborted print jobs is retained by the scheduler. A value of <CODE>On</CODE> preserves job information until the administrator purges it with the <CODE>cancel</CODE> command. A value of <CODE>Off</CODE> removes the job information as soon as each job is completed, canceled, or aborted. Numeric values preserve job information for the specified number of seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P> -<P>A value of <CODE>On</CODE> (the default) preserves job -information until the administrator purges it with the -<CODE>cancel</CODE> command.</P> +<P>The default value is <CODE>On</CODE>.</P> -<P>A value of <CODE>Off</CODE> removes the job information as -soon as each job is completed, canceled, or aborted.</P> +<BLOCKQUOTE><B>Note:</B> + +<P>The <A HREF="#MaxJobs"><CODE>MaxJobs</CODE></A>, <A HREF="#MaxJobsPerPrinter"><CODE>MaxJobsPerPrinter</CODE></A>, and <A HREF="#MaxJobsPerUser"><CODE>MaxJobsPerUser</CODE></A> directives can cause job history to be discarded to make room for new jobs.</P> + +</BLOCKQUOTE> <H2 CLASS="title"><A NAME="PreserveJobFiles">PreserveJobFiles</A></H2> @@ -2527,21 +2074,26 @@ soon as each job is completed, canceled, or aborted.</P> <PRE CLASS="command"> PreserveJobFiles On PreserveJobFiles Off +PreserveJobFiles 1w +PreserveJobFiles 7d +PreserveJobFiles 168h +PreserveJobFiles 10080m +PreserveJobFiles 604800 </PRE> <H3>Description</H3> -<P>The <CODE>PreserveJobFiles</CODE> directive controls whether -the document files of completed, canceled, or aborted print jobs -are stored on disk.</P> +<P>The <CODE>PreserveJobFiles</CODE> directive controls whether the document files of completed, canceled, or aborted print jobs are retained. Jobs can be restarted (and reprinted) as desired until they are purged.</P> + +<P>A value of <CODE>On</CODE> preserves job files until the administrator purges them with the <CODE>cancel</CODE> command. A value of <CODE>Off</CODE> removes the job files as soon as each job is completed, canceled, or aborted. Numeric values preserve job files for the specified number of seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P> + +<P>The default value is <CODE>1d</CODE> (one day).</P> + +<BLOCKQUOTE><B>Note:</B> -<P>A value of <CODE>On</CODE> preserves job files until the -administrator purges them with the <CODE>cancel</CODE> command. -Jobs can be restarted (and reprinted) as desired until they are -purged.</P> +<P>The <A HREF="#MaxJobs"><CODE>MaxJobs</CODE></A>, <A HREF="#MaxJobsPerPrinter"><CODE>MaxJobsPerPrinter</CODE></A>, <A HREF="#MaxJobsPerUser"><CODE>MaxJobsPerUser</CODE></A>, and <A HREF="#PreserveJobHistory"><CODE>PreserveJobHistory</CODE></A> directives can cause job files to be discarded sooner than specified.</P> -<P>A value of <CODE>Off</CODE> (the default) removes the job -files as soon as each job is completed, canceled, or aborted.</P> +</BLOCKQUOTE> <H2 CLASS="title"><A NAME="Printcap">Printcap</A></H2> @@ -2583,7 +2135,7 @@ PrintcapFormat plist <H3>Description</H3> <P>The <CODE>PrintcapFormat</CODE> directive controls the output format of the -printcap file. The default is to generate the plist format on Mac OS X, the +printcap file. The default is to generate the plist format on OS X, the Solaris format on Solaris, and the BSD format on other operating systems.</P> @@ -2717,17 +2269,18 @@ megabytes.</P> <PRE CLASS="command"> RootCertDuration 0 +RootCertDuration 1w +RootCertDuration 1d +RootCertDuration 1h +RootCertDuration 5m RootCertDuration 300 </PRE> <H3>Description</H3> -<P>The <CODE>RootCertDuration</CODE> directive specifies the -number of seconds the <EM>root certificate</EM> remains valid. -The scheduler will generate a new certificate as needed when the -number of seconds has expired. If set to 0, the root certificate -is generated only once on startup or on a restart. The default is -300 seconds.</P> +<P>The <CODE>RootCertDuration</CODE> directive specifies the amount of time the <EM>root certificate</EM> remains valid in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix). The scheduler will generate a new certificate as needed when the given time interval has expired. If set to 0, the root certificate is generated only once on startup or on a restart.</P> + +<P>The default is <CODE>5m</CODE> (five minutes).</P> <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Satisfy">Satisfy</A></H2> @@ -2963,7 +2516,7 @@ the text that is returned. The default is </TABLE></DIV> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="SetEnv">SetEnv</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="SetEnv">SetEnv</A></H2> <H3>Examples</H3> @@ -3032,6 +2585,23 @@ on for secure connections. Multiple <CODE>SSLPort</CODE> lines can be specified to listen on multiple ports.</P> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.6</SPAN><A NAME="StrictConformance">StrictConformance</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +StrictConformance No +StrictConformance Yes +</PRE> + +<H3>Description</H3> + +<P>The <CODE>StrictConformance</CODE> directive specifies whether the scheduler +requires strict IPP conformance for client requests, for example to not allow +document attributes in a Create-Job request. The default is +<code>No</code>.</P> + + <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.5</SPAN><A NAME="SubscriptionPrivateAccess">SubscriptionPrivateAccess</A></H2> <H3>Examples</H3> @@ -3127,18 +2697,22 @@ an appropriate temporary directory called <H3>Examples</H3> <PRE CLASS="command"> +Timeout 1w +Timeout 1d +Timeout 1h +Timeout 5m Timeout 300 -Timeout 90 </PRE> <H3>Description</H3> <P>The <CODE>Timeout</CODE> directive controls the amount of time -to wait before an active HTTP or IPP request times out. The -default timeout is 300 seconds.</P> +to wait before an active HTTP or IPP request times out in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P> + +<P>The default timeout is <CODE>5m</CODE> (five minutes).</P> -<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="UseNetworkDefault">UseNetworkDefault</A></H2> +<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/OS X 10.5</SPAN><A NAME="UseNetworkDefault">UseNetworkDefault</A></H2> <H3>Examples</H3> |