]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - doc/help/man-cupsd.conf.html
Greatly simplify the man page handling.
[thirdparty/cups.git] / doc / help / man-cupsd.conf.html
index f4e744833f06b696f7aa0fb849445f9882e07c72..29e217c128a398c6228d35f97c3be2e2fe053f74 100644 (file)
@@ -13,20 +13,17 @@ 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.
-<b>Note:</b> 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>
-file instead in order to prevent certain types of privilege escalation attacks.
-<p>Each line in the file can be a configuration directive, a blank line, or a comment.
+Each line in the file can be a configuration directive, a blank line, or a comment.
 Configuration directives typically consist of a name and zero or more values separated by whitespace.
 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>
@@ -95,10 +92,10 @@ The default value is "30".
 The default is typically the server's ".local" hostname.
 <dt><a name="ErrorPolicy"></a><b>ErrorPolicy abort-job</b>
 <dd style="margin-left: 5.0em">Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer.
+<dt><b>ErrorPolicy retry-current-job</b>
+<dd style="margin-left: 5.0em">Specifies that a failed print job should be retried immediately unless otherwise specified for the printer.
 <dt><b>ErrorPolicy retry-job</b>
 <dd style="margin-left: 5.0em">Specifies that a failed print job should be retried at a later time unless otherwise specified for the printer.
-<dt><b>ErrorPolicy retry-this-job</b>
-<dd style="margin-left: 5.0em">Specifies that a failed print job should be retried immediately unless otherwise specified for the printer.
 <dt><b>ErrorPolicy stop-printer</b>
 <dd style="margin-left: 5.0em">Specifies that a failed print job should stop the printer unless otherwise specified for the printer. The 'stop-printer' error policy is the default.
 <dt><a name="FilterLimit"></a><b>FilterLimit </b><i>limit</i>
@@ -122,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.
@@ -131,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.
@@ -227,8 +224,6 @@ 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).
-<dt><a name="PassEnv"></a><b>PassEnv </b><i>variable </i>[ ... <i>variable </i>]
-<dd style="margin-left: 5.0em">Passes the specified environment variable(s) to child processes.
 <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>
@@ -272,16 +267,12 @@ 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="SetEnv"></a><b>SetEnv </b><i>variable value</i>
-<dd style="margin-left: 5.0em">Set the specified environment variable to be passed to child processes.
 <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>
 <dd style="margin-left: 5.0em"><dt><b>SSLListen *:</b><i>port</i>
@@ -316,7 +307,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.
@@ -331,7 +322,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.
@@ -424,7 +415,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.)
@@ -500,7 +491,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.
@@ -523,7 +514,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>
@@ -539,7 +530,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>
@@ -584,6 +575,16 @@ Use "%{job-impressions-completed}" to insert the number of pages (sides) that we
 <dd style="margin-left: 5.0em">Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.
 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
+<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
+<b>systemctl</b>(8)
+command, while on macOS the
+<b>launchctl</b>(8)
+command is used instead.
 <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>
@@ -607,16 +608,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-2017 by Apple Inc.
+Copyright &copy; 2007-2019 by Apple Inc.
 
 </body>
 </html>