]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - doc/help/man-cupsd.conf.html
Update ipp documentation to reflect the behavior of configuring WiFi on IPP USB printers.
[thirdparty/cups.git] / doc / help / man-cupsd.conf.html
index b1b0ac0b5dbe1aaac592e11aecaf4a20641b3b11..70e00b5be1612ab0550da954f5cc73f27ef4111f 100644 (file)
@@ -13,7 +13,7 @@ cupsd.conf - server configuration file for cups
 The
 <i>cupsd.conf</i>
 file configures the CUPS scheduler,
-<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a>
+<b>cupsd</b>(8).
 It is normally located in the
 <i>/etc/cups</i>
 directory.
@@ -23,7 +23,7 @@ The configuration directive name and values are case-insensitive.
 Comment lines start with the # character.
 <h3><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h3>
 The following top-level directives are understood by
-<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
+<b>cupsd</b>(8):
 <dl class="man">
 <dt><a name="AccessLogLevel"></a><b>AccessLogLevel config</b>
 <dd style="margin-left: 5.0em"><dt><b>AccessLogLevel actions</b>
@@ -119,7 +119,7 @@ The default service name is "http."
 <dd style="margin-left: 5.0em"><dt><b>HostNameLookups Double</b>
 <dd style="margin-left: 5.0em">Specifies whether to do reverse lookups on connecting clients.
 The "Double" setting causes
-<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a>
+<b>cupsd</b>(8)
 to verify that the hostname resolved from the address matches one of the addresses returned for that hostname.
 Double lookups also prevent clients with unregistered addresses from connecting to your server.
 The default is "Off" to avoid the potential server performance problems with hostname lookups.
@@ -128,7 +128,7 @@ Only set this option to "On" or "Double" if absolutely required.
 <dd style="margin-left: 5.0em">Specifies the length of time to wait before shutting down due to inactivity.
 The default is "60" seconds.
 Note: Only applicable when
-<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a>
+<b>cupsd</b>(8)
 is run on-demand (e.g., with <b>-l</b>).
 <dt><a name="JobKillDelay"></a><b>JobKillDelay </b><i>seconds</i>
 <dd style="margin-left: 5.0em">Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.
@@ -145,9 +145,6 @@ The default is "5".
 <dd style="margin-left: 5.0em"><dt><b>KeepAlive No</b>
 <dd style="margin-left: 5.0em">Specifies whether to support HTTP keep-alive connections.
 The default is "Yes".
-<dt><a name="KeepAliveTimeout"></a><b>KeepAliveTimeout </b><i>seconds</i>
-<dd style="margin-left: 5.0em">Specifies how long an idle client connection remains open.
-The default is "30".
 <dt><a name="LimitIPP"></a><b>&lt;Limit </b><i>operation </i>...<b>> </b>... <b>&lt;/Limit></b>
 <dd style="margin-left: 5.0em">Specifies the IPP operations that are being limited inside a Policy section. IPP operation names are listed below in the section "IPP OPERATION NAMES".
 <dt><a name="Limit"></a><b>&lt;Limit </b><i>method </i>...<b>> </b>... <b>&lt;/Limit></b>
@@ -163,11 +160,6 @@ The default is "0" which disables the limit check.
 <dd style="margin-left: 5.0em">Listens to the specified address and port or domain socket path for connections.
 Multiple Listen directives can be provided to listen on multiple addresses.
 The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks.
-<dt><a name="ListenBackLog"></a><b>ListenBackLog </b><i>number</i>
-<dd style="margin-left: 5.0em">Specifies the number of pending connections that will be allowed.
-This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections.
-When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones.
-The default is the OS-defined default limit, typically either "5" for older operating systems or "128" for newer operating systems.
 <dt><a name="Location"></a><b>&lt;Location </b><i>/path</i><b>> </b>... <b>&lt;/Location></b>
 <dd style="margin-left: 5.0em">Specifies access control for the named location.
 Paths are documented below in the section "LOCATION PATHS".
@@ -223,7 +215,7 @@ The value "0" disables log rotation.
 The default is "1048576" (1MB).
 <dt><a name="MultipleOperationTimeout"></a><b>MultipleOperationTimeout </b><i>seconds</i>
 <dd style="margin-left: 5.0em">Specifies the maximum amount of time to allow between files in a multiple file print job.
-The default is "300" (5 minutes).
+The default is "900" (15 minutes).
 <dt><a name="Policy"></a><b>&lt;Policy </b><i>name</i><b>> </b>... <b>&lt;/Policy></b>
 <dd style="margin-left: 5.0em">Specifies access control for the named policy.
 <dt><a name="Port"></a><b>Port </b><i>number</i>
@@ -267,13 +259,11 @@ command.
 <dd style="margin-left: 5.0em">Specifies what information is included in the Server header of HTTP responses.
 "None" disables the Server header.
 "ProductOnly" reports "CUPS".
-"Major" reports "CUPS 2".
-"Minor" reports "CUPS 2.0".
-"Minimal" reports "CUPS 2.0.0".
-"OS" reports "CUPS 2.0.0 (UNAME)" where UNAME is the output of the
-<b>uname</b>(1)
-command.
-"Full" reports "CUPS 2.0.0 (UNAME) IPP/2.0".
+"Major" reports "CUPS/major IPP/2".
+"Minor" reports "CUPS/major.minor IPP/2.1".
+"Minimal" reports "CUPS/major.minor.patch IPP/2.1".
+"OS" reports "CUPS/major.minor.path (osname osversion) IPP/2.1".
+"Full" reports "CUPS/major.minor.path (osname osversion; architecture) IPP/2.1".
 The default is "Minimal".
 <dt><a name="SSLListen"></a><b>SSLListen </b><i>ipv4-address</i><b>:</b><i>port</i>
 <dd style="margin-left: 5.0em"><dt><b>SSLListen [</b><i>ipv6-address</i><b>]:</b><i>port</i>
@@ -301,7 +291,7 @@ Not all operating systems support TLS 1.3 at this time.
 The default is "No".
 <dt><a name="Timeout"></a><b>Timeout </b><i>seconds</i>
 <dd style="margin-left: 5.0em">Specifies the HTTP request timeout.
-The default is "300" (5 minutes).
+The default is "900" (15 minutes).
 <dt><a name="WebInterface"></a><b>WebInterface yes</b>
 <dd style="margin-left: 5.0em"><dt><b>WebInterface no</b>
 <dd style="margin-left: 5.0em">Specifies whether the web interface is enabled.
@@ -309,7 +299,7 @@ The default is "No".
 </dl>
 <h3><a name="HTTP_METHOD_NAMES">Http Method Names</a></h3>
 The following HTTP methods are supported by
-<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
+<b>cupsd</b>(8):
 <dl class="man">
 <dt>GET
 <dd style="margin-left: 5.0em">Used by a client to download icons and other printer resources and to access the CUPS web interface.
@@ -324,7 +314,7 @@ The following HTTP methods are supported by
 </dl>
 <h3><a name="IPP_OPERATION_NAMES">Ipp Operation Names</a></h3>
 The following IPP operations are supported by
-<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
+<b>cupsd</b>(8):
 <dl class="man">
 <dt>CUPS-Accept-Jobs
 <dd style="margin-left: 5.0em">Allows a printer to accept new jobs.
@@ -417,7 +407,7 @@ The following IPP operations are supported by
 </dl>
 <h3><a name="LOCATION_PATHS">Location Paths</a></h3>
 The following paths are commonly used when configuring
-<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
+<b>cupsd</b>(8):
 <dl class="man">
 <dt>/
 <dd style="margin-left: 5.0em">The path for all get operations (get-printers, get-jobs, etc.)
@@ -459,6 +449,8 @@ The following directives may be placed inside Location and Limit sections in the
 <dd style="margin-left: 5.0em"><dt><b>Allow @IF(</b><i>name</i><b>)</b>
 <dd style="margin-left: 5.0em"><dt><b>Allow @LOCAL</b>
 <dd style="margin-left: 5.0em">Allows access from the named hosts, domains, addresses, or interfaces.
+The @IF(name) form uses the current subnets configured for the named interface.
+The @LOCAL form uses the current subnets configured for all interfaces that are not point-to-point, for example Ethernet and Wi-Fi interfaces are used but DSL and VPN interfaces are not.
 The Order directive controls whether Allow lines are evaluated before or after Deny lines.
 <dt><b>AuthType None</b>
 <dd style="margin-left: 5.0em"><dt><b>AuthType Basic</b>
@@ -478,6 +470,8 @@ The value "Default" corresponds to the DefaultAuthType value.
 <dd style="margin-left: 5.0em"><dt><b>Deny @IF(</b><i>name</i><b>)</b>
 <dd style="margin-left: 5.0em"><dt><b>Deny @LOCAL</b>
 <dd style="margin-left: 5.0em">Denies access from the named hosts, domains, addresses, or interfaces.
+The @IF(name) form uses the current subnets configured for the named interface.
+The @LOCAL form uses the current subnets configured for all interfaces that are not point-to-point, for example Ethernet and Wi-Fi interfaces are used but DSL and VPN interfaces are not.
 The Order directive controls whether Deny lines are evaluated before or after Allow lines.
 <dt><b>Encryption IfRequested</b>
 <dd style="margin-left: 5.0em"><dt><b>Encryption Never</b>
@@ -493,7 +487,7 @@ The default value is "IfRequested".
 <dt><b>Require user {</b><i>user-name</i>|<b>@</b><i>group-name</i>} ...
 <dd style="margin-left: 5.0em">Specifies that an authenticated user must match one of the named users or be a member of one of the named groups.
 The group name "@SYSTEM" corresponds to the list of groups defined by the SystemGroup directive in the
-<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
+<b>cups-files.conf</b>(5)
 file.
 The group name "@OWNER" corresponds to the owner of the resource, for example the person that submitted a print job.
 Note: The 'root' user is not special and must be granted privileges like any other user account.
@@ -516,7 +510,7 @@ The "default" access list is "@OWNER @SYSTEM".
 "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
 "@OWNER" maps to the job's owner.
 "@SYSTEM" maps to the groups listed for the SystemGroup directive in the
-<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
+<b>cups-files.conf</b>(5)
 file.
 <dt><b>JobPrivateValues all</b>
 <dd style="margin-left: 5.0em"><dt><b>JobPrivateValues default</b>
@@ -532,7 +526,7 @@ The "default" access list is "@OWNER @SYSTEM".
 "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
 "@OWNER" maps to the job's owner.
 "@SYSTEM" maps to the groups listed for the SystemGroup directive in the
-<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
+<b>cups-files.conf</b>(5)
 file.
 <dt><b>SubscriptionPrivateValues all</b>
 <dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateValues default</b>
@@ -554,6 +548,9 @@ The default is no classification banner.
 <dd style="margin-left: 5.0em"><br>
 Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option.
 The default is "No".
+<dt><a name="ListenBackLog"></a><b>ListenBackLog </b><i>number</i>
+<dd style="margin-left: 5.0em">Specified the number of pending connections that will be allowed.
+The scheduler now uses the value "128" on all platforms.
 <dt><a name="PageLogFormat"></a><b>PageLogFormat </b><i>format-string</i>
 <dd style="margin-left: 5.0em">Specifies the format of PageLog lines.
 Sequences beginning with percent (%) characters are replaced with the corresponding information, while all other characters are copied literally.
@@ -579,7 +576,7 @@ The default is "128m".
 </dl>
 <h2 class="title"><a name="NOTES">Notes</a></h2>
 File, directory, and user configuration directives that used to be allowed in the <b>cupsd.conf</b> file are now stored in the
-<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
+<b>cups-files.conf</b>(5)
 file instead in order to prevent certain types of privilege escalation attacks.
 <p>The scheduler MUST be restarted manually after making changes to the <b>cupsd.conf</b> file.
 On Linux this is typically done using the
@@ -587,6 +584,9 @@ On Linux this is typically done using the
 command, while on macOS the
 <b>launchctl</b>(8)
 command is used instead.
+<p>The @LOCAL macro name can be confusing since the system running
+<b>cupsd</b>
+often belongs to a different set of subnets from its clients.
 <h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
 The <b>cupsd.conf</b> file format is based on the Apache HTTP Server configuration file format.
 <h2 class="title"><a name="EXAMPLES">Examples</a></h2>
@@ -610,16 +610,16 @@ Require authentication for accesses from outside the 10. network:
     &lt;/Location>
 </pre>
 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a>
-<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a>
-<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
-<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
-<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
-<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a>
-<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
+<b>classes.conf</b>(5),
+<b>cups-files.conf</b>(5),
+<b>cupsd</b>(8),
+<b>mime.convs</b>(5),
+<b>mime.types</b>(5),
+<b>printers.conf</b>(5),
+<b>subscriptions.conf</b>(5),
 CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
-Copyright &copy; 2007-2018 by Apple Inc.
+Copyright &copy; 2007-2021 by Apple Inc.
 
 </body>
 </html>