]>
Commit | Line | Data |
---|---|---|
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> | |
11 | cups-files.conf - file and directory configuration file for cups | |
12 | <h2 class="title"><a name="DESCRIPTION">Description</a></h2> | |
651e0a22 MS |
13 | The <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> | |
15 | It 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 |
17 | Configuration directives typically consist of a name and zero or more values separated by whitespace. |
18 | The configuration directive name and values are case-insensitive. | |
651e0a22 MS |
19 | Comment lines start with the # character. |
20 | <h3><a name="DIRECTIVES">Directives</a></h3> | |
21 | The 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> |
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 | 28 | Specifying a blank filename disables access log generation. |
25d0c3fe | 29 | The value "syslog" causes log entries to be sent to the system log daemon. |
651e0a22 MS |
30 | The 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 | 36 | The default is "/var/log/cups/access_log". |
37d9646b | 37 | <dt><a name="ConfigFilePerm"></a><b>ConfigFilePerm </b><i>mode</i> |
651e0a22 | 38 | <dd style="margin-left: 5.0em">Specifies the permissions for all configuration files that the scheduler writes. |
25d0c3fe | 39 | The default is "0644" on OS X and "0640" on all other operating systems. |
b4a8492a MS |
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). | |
651e0a22 MS |
42 | This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system. |
43 | There is no way to disable this security feature. | |
b4a8492a | 44 | <dl class="man"> |
37d9646b | 45 | <dt><a name="DataDir"></a><b>DataDir </b><i>path</i> |
25d0c3fe MS |
46 | <dd style="margin-left: 5.0em">Specifies the directory where data files can be found. |
47 | The default is usually "/usr/share/cups". | |
37d9646b | 48 | <dt><a name="DocumentRoot"></a><b>DocumentRoot </b><i>directory</i> |
25d0c3fe MS |
49 | <dd style="margin-left: 5.0em">Specifies the root directory for the CUPS web interface content. |
50 | The default is usually "/usr/share/doc/cups". | |
37d9646b | 51 | <dt><a name="ErrorLog"></a><b>ErrorLog</b> |
25d0c3fe | 52 | <dd style="margin-left: 5.0em"><dt><b>ErrorLog </b><i>filename</i> |
651e0a22 MS |
53 | <dd style="margin-left: 5.0em"><dt><b>ErrorLog syslog</b> |
54 | <dd style="margin-left: 5.0em">Defines the error log filename. | |
651e0a22 | 55 | Specifying a blank filename disables error log generation. |
25d0c3fe | 56 | The value "syslog" causes log entries to be sent to the system log daemon. |
651e0a22 MS |
57 | The 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> | |
25d0c3fe | 63 | The default is "/var/log/cups/error_log". |
37d9646b | 64 | <dt><a name="FatalErrors"></a><b>FatalErrors none</b> |
25d0c3fe MS |
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>] | |
651e0a22 | 67 | <dd style="margin-left: 5.0em">Specifies which errors are fatal, causing the scheduler to exit. |
25d0c3fe | 68 | The default is "config". |
651e0a22 MS |
69 | The <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> | |
37d9646b | 87 | <dt><a name="FileDevice"></a><b>FileDevice Yes</b> |
651e0a22 MS |
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. | |
90 | The URI "file:///dev/null" is always allowed. | |
37d9646b | 91 | <dt><a name="Group"></a><b>Group </b><i>group-name-or-number</i> |
651e0a22 | 92 | <dd style="margin-left: 5.0em">Specifies the group name or ID that will be used when executing external programs. |
25d0c3fe | 93 | The default group is operating system specific but is usually "lp" or "nobody". |
37d9646b | 94 | <dt><a name="LogFilePerm"></a><b>LogFilePerm </b><i>mode</i> |
25d0c3fe MS |
95 | <dd style="margin-left: 5.0em">Specifies the permissions of all log files that the scheduler writes. |
96 | The default is "0644". | |
37d9646b | 97 | <dt><a name="PageLog"></a><b>PageLog </b>[ <i>filename</i> ] |
651e0a22 MS |
98 | <dd style="margin-left: 5.0em"><dt><b>PageLog syslog</b> |
99 | <dd style="margin-left: 5.0em">Defines the page log filename. | |
100 | The value "syslog" causes log entries to be sent to the system log daemon. | |
101 | Specifying a blank filename disables page log generation. | |
102 | The 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> | |
25d0c3fe | 108 | The default is "/var/log/cups/page_log". |
37d9646b | 109 | <dt><a name="RemoteRoot"></a><b>RemoteRoot </b><i>username</i> |
651e0a22 | 110 | <dd style="margin-left: 5.0em">Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user. |
25d0c3fe | 111 | The default is "remroot". |
37d9646b | 112 | <dt><a name="RequestRoot"></a><b>RequestRoot </b><i>directory</i> |
651e0a22 | 113 | <dd style="margin-left: 5.0em">Specifies the directory that contains print jobs and other HTTP request data. |
25d0c3fe | 114 | The default is "/var/spool/cups". |
e9f9e650 | 115 | <dt><a name="Sandboxing"></a><b>Sandboxing relaxed</b> |
651e0a22 MS |
116 | <dd style="margin-left: 5.0em"><dt><b>Sandboxing strict</b> |
117 | <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. | |
118 | The default is "strict". | |
25d0c3fe | 119 | This directive is currently only used/supported on OS X. |
37d9646b | 120 | <dt><a name="ServerBin"></a><b>ServerBin </b><i>directory</i> |
651e0a22 | 121 | <dd style="margin-left: 5.0em">Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors. |
25d0c3fe | 122 | The default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the platform. |
37d9646b | 123 | <dt><a name="ServerKeychain"></a><b>ServerKeychain </b><i>path</i> |
651e0a22 | 124 | <dd style="margin-left: 5.0em">Specifies the location of TLS certificates and private keys. |
25d0c3fe | 125 | The default is "/Library/Keychains/System.keychain" on OS X and "/etc/cups/ssl" on all other operating systems. |
3abb875b | 126 | OS X 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 | 127 | <dt><a name="ServerRoot"></a><b>ServerRoot </b><i>directory</i> |
651e0a22 | 128 | <dd style="margin-left: 5.0em">Specifies the directory containing the server configuration files. |
25d0c3fe | 129 | The default is "/etc/cups". |
37d9646b | 130 | <dt><a name="SyncOnClose"></a><b>SyncOnClose Yes</b> |
651e0a22 MS |
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) | |
25d0c3fe MS |
134 | after writing configuration or state files. |
135 | The default is "No". | |
37d9646b | 136 | <dt><a name="SystemGroup"></a><b>SystemGroup </b><i>group-name </i>[ ... <i>group-name</i> ] |
651e0a22 | 137 | <dd style="margin-left: 5.0em">Specifies the group(s) to use for <i>@SYSTEM</i> group authentication. |
25d0c3fe | 138 | The default contains "admin", "lpadmin", "root", "sys", and/or "system". |
37d9646b | 139 | <dt><a name="TempDir"></a><b>TempDir </b><i>directory</i> |
651e0a22 | 140 | <dd style="margin-left: 5.0em">Specifies the directory where temporary files are stored. |
25d0c3fe | 141 | The default is "/var/spool/cups/tmp". |
37d9646b | 142 | <dt><a name="User"></a><b>User </b><i>username</i> |
651e0a22 | 143 | <dd style="margin-left: 5.0em">Specifies the user name or ID that is used when running external programs. |
25d0c3fe | 144 | The default is "lp". |
2909c66c | 145 | </dl> |
94436c5a | 146 | <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> |
651e0a22 MS |
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> | |
155 | CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) | |
94436c5a | 156 | <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> |
e9f9e650 | 157 | Copyright © 2007-2015 by Apple Inc. |
94436c5a MS |
158 | |
159 | </body> | |
160 | </html> |