diff options
Diffstat (limited to 'doc/help/ref-cupsd-conf.html.in')
| -rw-r--r-- | doc/help/ref-cupsd-conf.html.in | 528 |
1 files changed, 1 insertions, 527 deletions
diff --git a/doc/help/ref-cupsd-conf.html.in b/doc/help/ref-cupsd-conf.html.in index 6002729cf..36f694a32 100644 --- a/doc/help/ref-cupsd-conf.html.in +++ b/doc/help/ref-cupsd-conf.html.in @@ -335,229 +335,6 @@ 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> <H3>Examples</H3> @@ -565,13 +342,7 @@ printers. The default is to not include any options.</P> <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 +353,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 +381,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> @@ -1382,25 +914,6 @@ 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> - -<H3>Examples</H3> - -<PRE CLASS="command"> -HideImplicitMembers Yes -HideImplicitMembers No -</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> - - <H2 CLASS="title"><A NAME="HostNameLookups">HostNameLookups</A></H2> <H3>Examples</H3> @@ -1427,45 +940,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> |