]> git.ipfire.org Git - thirdparty/cups.git/blame - doc/help/man-cups-files.conf.html
projects / thirdparty / cups.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Update all references to OS X to macOS.
[thirdparty/cups.git] / doc / help / man-cups-files.conf.html
CommitLineData
c277f98c 1<!DOCTYPE HTML>
94436c5a
MS		 2<html>
3<!-- SECTION: Man Pages -->
4<head>
5 <link rel="stylesheet" type="text/css" href="../cups-printable.css">
6 <title>cups-files.conf(5)</title>
7</head>
8<body>
9<h1 class="title">cups-files.conf(5)</h1>
10<h2 class="title"><a name="NAME">Name</a></h2>
11cups-files.conf - file and directory configuration file for cups
12<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
651e0a22
MS		 13The <b>cups-files.conf</b> file configures the files and directories used by the CUPS scheduler,
14<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a>
15It is normally located in the <i>/etc/cups</i> directory.
16<p>Each line in the file can be a configuration directive, a blank line, or a comment.
25d0c3fe
MS		 17Configuration directives typically consist of a name and zero or more values separated by whitespace.
18The configuration directive name and values are case-insensitive.
651e0a22
MS		 19Comment lines start with the # character.
20<h3><a name="DIRECTIVES">Directives</a></h3>
21The following directives are understood by
22<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
2909c66c 23<dl class="man">
37d9646b 24<dt><a name="AccessLog"></a><b>AccessLog</b>
25d0c3fe 25<dd style="margin-left: 5.0em"><dt><b>AccessLog </b><i>filename</i>
c59e07c6 26<dd style="margin-left: 5.0em"><dt><b>AccessLog stderr</b>
651e0a22
MS		 27<dd style="margin-left: 5.0em"><dt><b>AccessLog syslog</b>
28<dd style="margin-left: 5.0em">Defines the access log filename.
651e0a22 29Specifying a blank filename disables access log generation.
c59e07c6 30The value "stderr" causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.
25d0c3fe 31The value "syslog" causes log entries to be sent to the system log daemon.
651e0a22
MS		 32The server name may be included in filenames using the string "%s", for example:
33<pre class="man">
34
35 AccessLog /var/log/cups/%s-access_log
36
37</pre>
25d0c3fe 38The default is "/var/log/cups/access_log".
37d9646b 39<dt><a name="ConfigFilePerm"></a><b>ConfigFilePerm </b><i>mode</i>
651e0a22 40<dd style="margin-left: 5.0em">Specifies the permissions for all configuration files that the scheduler writes.
8072030b 41The default is "0644" on macOS and "0640" on all other operating systems.
b4a8492a
MS		 42</dl>
43<p><b>Note:</b> The permissions for the <i>printers.conf</i> file are currently masked to only allow access from the scheduler user (typically root).
651e0a22
MS		 44This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system.
45There is no way to disable this security feature.
b4a8492a 46<dl class="man">
37d9646b 47<dt><a name="DataDir"></a><b>DataDir </b><i>path</i>
25d0c3fe
MS		 48<dd style="margin-left: 5.0em">Specifies the directory where data files can be found.
49The default is usually "/usr/share/cups".
37d9646b 50<dt><a name="DocumentRoot"></a><b>DocumentRoot </b><i>directory</i>
25d0c3fe
MS		 51<dd style="margin-left: 5.0em">Specifies the root directory for the CUPS web interface content.
52The default is usually "/usr/share/doc/cups".
37d9646b 53<dt><a name="ErrorLog"></a><b>ErrorLog</b>
25d0c3fe 54<dd style="margin-left: 5.0em"><dt><b>ErrorLog </b><i>filename</i>
c59e07c6 55<dd style="margin-left: 5.0em"><dt><b>ErrorLog stderr</b>
651e0a22
MS		 56<dd style="margin-left: 5.0em"><dt><b>ErrorLog syslog</b>
57<dd style="margin-left: 5.0em">Defines the error log filename.
651e0a22 58Specifying a blank filename disables error log generation.
c59e07c6 59The value "stderr" causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.
25d0c3fe 60The value "syslog" causes log entries to be sent to the system log daemon.
651e0a22
MS		 61The server name may be included in filenames using the string "%s", for example:
62<pre class="man">
63
64 ErrorLog /var/log/cups/%s-error_log
65
66</pre>
25d0c3fe 67The default is "/var/log/cups/error_log".
37d9646b 68<dt><a name="FatalErrors"></a><b>FatalErrors none</b>
25d0c3fe
MS		 69<dd style="margin-left: 5.0em"><dt><b>FatalErrors all </b><i>-kind </i>[ ... <i>-kind </i>]
70<dd style="margin-left: 5.0em"><dt><b>FatalErrors </b><i>kind </i>[ ... <i>kind </i>]
651e0a22 71<dd style="margin-left: 5.0em">Specifies which errors are fatal, causing the scheduler to exit.
25d0c3fe 72The default is "config".
651e0a22
MS		 73The <i>kind</i> strings are:
74<div style="margin-left: 0.0em;">
75<dl class="man">
76<dt><b>none</b>
77<dd style="margin-left: 5.0em">No errors are fatal.
78<dt><b>all</b>
79<dd style="margin-left: 5.0em">All of the errors below are fatal.
80<dt><b>browse</b>
81<dd style="margin-left: 5.0em">Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon.
82<dt><b>config</b>
83<dd style="margin-left: 5.0em">Configuration file syntax errors are fatal.
84<dt><b>listen</b>
85<dd style="margin-left: 5.0em">Listen or Port errors are fatal, except for IPv6 failures on the loopback or "any" addresses.
86<dt><b>log</b>
87<dd style="margin-left: 5.0em">Log file creation or write errors are fatal.
88<dt><b>permissions</b>
89<dd style="margin-left: 5.0em">Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions.
90</div>
37d9646b 91<dt><a name="FileDevice"></a><b>FileDevice Yes</b>
651e0a22
MS		 92<dd style="margin-left: 5.0em"><dt><b>FileDevice No</b>
93<dd style="margin-left: 5.0em">Specifies whether the file pseudo-device can be used for new printer queues.
94The URI "file:///dev/null" is always allowed.
37d9646b 95<dt><a name="Group"></a><b>Group </b><i>group-name-or-number</i>
651e0a22 96<dd style="margin-left: 5.0em">Specifies the group name or ID that will be used when executing external programs.
25d0c3fe 97The default group is operating system specific but is usually "lp" or "nobody".
37d9646b 98<dt><a name="LogFilePerm"></a><b>LogFilePerm </b><i>mode</i>
25d0c3fe
MS		 99<dd style="margin-left: 5.0em">Specifies the permissions of all log files that the scheduler writes.
100The default is "0644".
37d9646b 101<dt><a name="PageLog"></a><b>PageLog </b>[ <i>filename</i> ]
c59e07c6 102<dd style="margin-left: 5.0em"><dt><b>PageLog stderr</b>
651e0a22
MS		 103<dd style="margin-left: 5.0em"><dt><b>PageLog syslog</b>
104<dd style="margin-left: 5.0em">Defines the page log filename.
c59e07c6 105The value "stderr" causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.
651e0a22
MS		 106The value "syslog" causes log entries to be sent to the system log daemon.
107Specifying a blank filename disables page log generation.
108The server name may be included in filenames using the string "%s", for example:
109<pre class="man">
110
111 PageLog /var/log/cups/%s-page_log
112
113</pre>
25d0c3fe 114The default is "/var/log/cups/page_log".
37d9646b 115<dt><a name="RemoteRoot"></a><b>RemoteRoot </b><i>username</i>
651e0a22 116<dd style="margin-left: 5.0em">Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user.
25d0c3fe 117The default is "remroot".
37d9646b 118<dt><a name="RequestRoot"></a><b>RequestRoot </b><i>directory</i>
651e0a22 119<dd style="margin-left: 5.0em">Specifies the directory that contains print jobs and other HTTP request data.
25d0c3fe 120The default is "/var/spool/cups".
e9f9e650 121<dt><a name="Sandboxing"></a><b>Sandboxing relaxed</b>
651e0a22
MS		 122<dd style="margin-left: 5.0em"><dt><b>Sandboxing strict</b>
123<dd style="margin-left: 5.0em">Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler.
124The default is "strict".
8072030b 125This directive is currently only used/supported on macOS.
37d9646b 126<dt><a name="ServerBin"></a><b>ServerBin </b><i>directory</i>
651e0a22 127<dd style="margin-left: 5.0em">Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors.
25d0c3fe 128The default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the platform.
37d9646b 129<dt><a name="ServerKeychain"></a><b>ServerKeychain </b><i>path</i>
651e0a22 130<dd style="margin-left: 5.0em">Specifies the location of TLS certificates and private keys.
8072030b
MS		 131The default is "/Library/Keychains/System.keychain" on macOS and "/etc/cups/ssl" on all other operating systems.
132macOS uses its keychain database to store certificates and keys while other platforms use separate files in the specified directory, *.crt for PEM-encoded certificates and *.key for PEM-encoded private keys.
37d9646b 133<dt><a name="ServerRoot"></a><b>ServerRoot </b><i>directory</i>
651e0a22 134<dd style="margin-left: 5.0em">Specifies the directory containing the server configuration files.
25d0c3fe 135The default is "/etc/cups".
37d9646b 136<dt><a name="SyncOnClose"></a><b>SyncOnClose Yes</b>
651e0a22
MS		 137<dd style="margin-left: 5.0em"><dt><b>SyncOnClose No</b>
138<dd style="margin-left: 5.0em">Specifies whether the scheduler calls
139<b>fsync</b>(2)
25d0c3fe
MS		 140after writing configuration or state files.
141The default is "No".
37d9646b 142<dt><a name="SystemGroup"></a><b>SystemGroup </b><i>group-name </i>[ ... <i>group-name</i> ]
651e0a22 143<dd style="margin-left: 5.0em">Specifies the group(s) to use for <i>@SYSTEM</i> group authentication.
25d0c3fe 144The default contains "admin", "lpadmin", "root", "sys", and/or "system".
37d9646b 145<dt><a name="TempDir"></a><b>TempDir </b><i>directory</i>
651e0a22 146<dd style="margin-left: 5.0em">Specifies the directory where temporary files are stored.
25d0c3fe 147The default is "/var/spool/cups/tmp".
37d9646b 148<dt><a name="User"></a><b>User </b><i>username</i>
651e0a22 149<dd style="margin-left: 5.0em">Specifies the user name or ID that is used when running external programs.
25d0c3fe 150The default is "lp".
2909c66c 151</dl>
94436c5a 152<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
651e0a22
MS		 153<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a>
154<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
155<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
156<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
157<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
158<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
159<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a>
160<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
161CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
94436c5a 162<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
d58c2629 163Copyright &copy; 2007-2016 by Apple Inc.
94436c5a
MS		 164
165</body>
166</html>
Unnamed repository; edit this file 'description' to name the repository.