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