]> 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
Save work on man pages.
[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">
25d0c3fe
MS		 24<dt><b>AccessLog</b>
25<dd style="margin-left: 5.0em"><dt><b>AccessLog </b><i>filename</i>
651e0a22
MS		 26<dd style="margin-left: 5.0em"><dt><b>AccessLog syslog</b>
27<dd style="margin-left: 5.0em">Defines the access log filename.
651e0a22 28Specifying a blank filename disables access log generation.
25d0c3fe 29The value "syslog" causes log entries to be sent to the system log daemon.
651e0a22
MS		 30The server name may be included in filenames using the string "%s", for example:
31<pre class="man">
32
33 AccessLog /var/log/cups/%s-access_log
34
35</pre>
25d0c3fe 36The default is "/var/log/cups/access_log".
651e0a22
MS		 37<dt><b>ConfigFilePerm </b><i>mode</i>
38<dd style="margin-left: 5.0em">Specifies the permissions for all configuration files that the scheduler writes.
25d0c3fe
MS		 39The default is "0644" on OS X and "0640" on all other operating systems.
40<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		 41This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system.
42There is no way to disable this security feature.
43<dt><b>DataDir </b><i>path</i>
25d0c3fe
MS		 44<dd style="margin-left: 5.0em">Specifies the directory where data files can be found.
45The default is usually "/usr/share/cups".
651e0a22 46<dt><b>DocumentRoot </b><i>directory</i>
25d0c3fe
MS		 47<dd style="margin-left: 5.0em">Specifies the root directory for the CUPS web interface content.
48The default is usually "/usr/share/doc/cups".
49<dt><b>ErrorLog</b>
50<dd style="margin-left: 5.0em"><dt><b>ErrorLog </b><i>filename</i>
651e0a22
MS		 51<dd style="margin-left: 5.0em"><dt><b>ErrorLog syslog</b>
52<dd style="margin-left: 5.0em">Defines the error log filename.
651e0a22 53Specifying a blank filename disables error log generation.
25d0c3fe 54The value "syslog" causes log entries to be sent to the system log daemon.
651e0a22
MS		 55The server name may be included in filenames using the string "%s", for example:
56<pre class="man">
57
58 ErrorLog /var/log/cups/%s-error_log
59
60</pre>
25d0c3fe 61The default is "/var/log/cups/error_log".
651e0a22 62<dt><b>FatalErrors none</b>
25d0c3fe
MS		 63<dd style="margin-left: 5.0em"><dt><b>FatalErrors all </b><i>-kind </i>[ ... <i>-kind </i>]
64<dd style="margin-left: 5.0em"><dt><b>FatalErrors </b><i>kind </i>[ ... <i>kind </i>]
651e0a22 65<dd style="margin-left: 5.0em">Specifies which errors are fatal, causing the scheduler to exit.
25d0c3fe 66The default is "config".
651e0a22
MS		 67The <i>kind</i> strings are:
68<div style="margin-left: 0.0em;">
69<dl class="man">
70<dt><b>none</b>
71<dd style="margin-left: 5.0em">No errors are fatal.
72<dt><b>all</b>
73<dd style="margin-left: 5.0em">All of the errors below are fatal.
74<dt><b>browse</b>
75<dd style="margin-left: 5.0em">Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon.
76<dt><b>config</b>
77<dd style="margin-left: 5.0em">Configuration file syntax errors are fatal.
78<dt><b>listen</b>
79<dd style="margin-left: 5.0em">Listen or Port errors are fatal, except for IPv6 failures on the loopback or "any" addresses.
80<dt><b>log</b>
81<dd style="margin-left: 5.0em">Log file creation or write errors are fatal.
82<dt><b>permissions</b>
83<dd style="margin-left: 5.0em">Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions.
84</div>
85<dt><b>FileDevice Yes</b>
86<dd style="margin-left: 5.0em"><dt><b>FileDevice No</b>
87<dd style="margin-left: 5.0em">Specifies whether the file pseudo-device can be used for new printer queues.
88The URI "file:///dev/null" is always allowed.
651e0a22
MS		 89<dt><b>Group </b><i>group-name-or-number</i>
90<dd style="margin-left: 5.0em">Specifies the group name or ID that will be used when executing external programs.
25d0c3fe 91The default group is operating system specific but is usually "lp" or "nobody".
651e0a22 92<dt><b>LogFilePerm </b><i>mode</i>
25d0c3fe
MS		 93<dd style="margin-left: 5.0em">Specifies the permissions of all log files that the scheduler writes.
94The default is "0644".
651e0a22
MS		 95<dt><b>PageLog </b>[ <i>filename</i> ]
96<dd style="margin-left: 5.0em"><dt><b>PageLog syslog</b>
97<dd style="margin-left: 5.0em">Defines the page log filename.
98The value "syslog" causes log entries to be sent to the system log daemon.
99Specifying a blank filename disables page log generation.
100The server name may be included in filenames using the string "%s", for example:
101<pre class="man">
102
103 PageLog /var/log/cups/%s-page_log
104
105</pre>
25d0c3fe 106The default is "/var/log/cups/page_log".
651e0a22
MS		 107<dt><b>RemoteRoot </b><i>username</i>
108<dd style="margin-left: 5.0em">Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user.
25d0c3fe 109The default is "remroot".
651e0a22
MS		 110<dt><b>RequestRoot </b><i>directory</i>
111<dd style="margin-left: 5.0em">Specifies the directory that contains print jobs and other HTTP request data.
25d0c3fe 112The default is "/var/spool/cups".
651e0a22
MS		 113<dt><b>Sandboxing off</b>
114<dd style="margin-left: 5.0em"><dt><b>Sandboxing relaxed</b>
115<dd style="margin-left: 5.0em"><dt><b>Sandboxing strict</b>
116<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.
117The default is "strict".
25d0c3fe 118This directive is currently only used/supported on OS X.
651e0a22
MS		 119<dt><b>ServerBin </b><i>directory</i>
120<dd style="margin-left: 5.0em">Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors.
25d0c3fe 121The default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the platform.
651e0a22
MS		 122<dt><b>ServerKeychain </b><i>path</i>
123<dd style="margin-left: 5.0em">Specifies the location of TLS certificates and private keys.
25d0c3fe 124The default is "/Library/Keychains/System.keychain" on OS X and "/etc/cups/ssl" on all other operating systems.
651e0a22
MS		 125<dt><b>ServerRoot </b><i>directory</i>
126<dd style="margin-left: 5.0em">Specifies the directory containing the server configuration files.
25d0c3fe 127The default is "/etc/cups".
651e0a22
MS		 128<dt><b>SyncOnClose Yes</b>
129<dd style="margin-left: 5.0em"><dt><b>SyncOnClose No</b>
130<dd style="margin-left: 5.0em">Specifies whether the scheduler calls
131<b>fsync</b>(2)
25d0c3fe
MS		 132after writing configuration or state files.
133The default is "No".
134<dt><b>SystemGroup </b><i>group-name </i>[ ... <i>group-name</i> ]
651e0a22 135<dd style="margin-left: 5.0em">Specifies the group(s) to use for <i>@SYSTEM</i> group authentication.
25d0c3fe 136The default contains "admin", "lpadmin", "root", "sys", and/or "system".
651e0a22
MS		 137<dt><b>TempDir </b><i>directory</i>
138<dd style="margin-left: 5.0em">Specifies the directory where temporary files are stored.
25d0c3fe 139The default is "/var/spool/cups/tmp".
651e0a22
MS		 140<dt><b>User </b><i>username</i>
141<dd style="margin-left: 5.0em">Specifies the user name or ID that is used when running external programs.
25d0c3fe 142The default is "lp".
2909c66c 143</dl>
94436c5a 144<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
651e0a22
MS		 145<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a>
146<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
147<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
148<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
149<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
150<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
151<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a>
152<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
153CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
94436c5a 154<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
651e0a22 155Copyright &copy; 2007-2014 by Apple Inc.
94436c5a
MS		 156
157</body>
158</html>
Unnamed repository; edit this file 'description' to name the repository.