]>
Commit | Line | Data |
---|---|---|
c41769ff MS |
1 | .\" |
2 | .\" "$Id$" | |
3 | .\" | |
c390f212 | 4 | .\" cups-files.conf man page for CUPS. |
c41769ff | 5 | .\" |
08c7d544 | 6 | .\" Copyright 2007-2015 by Apple Inc. |
8fe0183a | 7 | .\" Copyright 1997-2006 by Easy Software Products. |
c41769ff | 8 | .\" |
8fe0183a MS |
9 | .\" These coded instructions, statements, and computer programs are the |
10 | .\" property of Apple Inc. and are protected by Federal copyright | |
11 | .\" law. Distribution and use rights are outlined in the file "LICENSE.txt" | |
12 | .\" which should have been included with this file. If this file is | |
13 | .\" file is missing or damaged, see the license at "http://www.cups.org/". | |
c41769ff | 14 | .\" |
08c7d544 | 15 | .TH cups-files.conf 5 "CUPS" "2 February 2015" "Apple Inc." |
c41769ff | 16 | .SH NAME |
c390f212 | 17 | cups\-files.conf \- file and directory configuration file for cups |
c41769ff | 18 | .SH DESCRIPTION |
c390f212 MS |
19 | The \fBcups\-files.conf\fR file configures the files and directories used by the CUPS scheduler, |
20 | .BR cupsd (8). | |
21 | It is normally located in the \fI/etc/cups\fR directory. | |
c41769ff | 22 | .LP |
c390f212 | 23 | Each line in the file can be a configuration directive, a blank line, or a comment. |
25d0c3fe MS |
24 | Configuration directives typically consist of a name and zero or more values separated by whitespace. |
25 | The configuration directive name and values are case-insensitive. | |
c390f212 MS |
26 | Comment lines start with the # character. |
27 | .SS DIRECTIVES | |
28 | The following directives are understood by | |
29 | .BR cupsd (8): | |
37d9646b | 30 | .\"#AccessLog |
c41769ff | 31 | .TP 5 |
25d0c3fe | 32 | \fBAccessLog\fR |
c41769ff | 33 | .TP 5 |
25d0c3fe | 34 | \fBAccessLog \fIfilename\fR |
c390f212 MS |
35 | .TP 5 |
36 | \fBAccessLog syslog\fR | |
c41769ff | 37 | Defines the access log filename. |
c390f212 | 38 | Specifying a blank filename disables access log generation. |
25d0c3fe | 39 | The value "syslog" causes log entries to be sent to the system log daemon. |
c390f212 MS |
40 | The server name may be included in filenames using the string "%s", for example: |
41 | .nf | |
42 | ||
43 | AccessLog /var/log/cups/%s-access_log | |
44 | ||
45 | .fi | |
25d0c3fe | 46 | The default is "/var/log/cups/access_log". |
37d9646b | 47 | .\"#ConfigFilePerm |
c41769ff | 48 | .TP 5 |
c390f212 MS |
49 | \fBConfigFilePerm \fImode\fR |
50 | Specifies the permissions for all configuration files that the scheduler writes. | |
25d0c3fe | 51 | The default is "0644" on OS X and "0640" on all other operating systems. |
b4a8492a | 52 | .LP |
25d0c3fe | 53 | \fBNote:\fR The permissions for the \fIprinters.conf\fR file are currently masked to only allow access from the scheduler user (typically root). |
c390f212 MS |
54 | This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system. |
55 | There is no way to disable this security feature. | |
37d9646b | 56 | .\"#DataDir |
c41769ff | 57 | .TP 5 |
c390f212 | 58 | \fBDataDir \fIpath\fR |
25d0c3fe MS |
59 | Specifies the directory where data files can be found. |
60 | The default is usually "/usr/share/cups". | |
37d9646b | 61 | .\"#DocumentRoot |
c41769ff | 62 | .TP 5 |
c390f212 | 63 | \fBDocumentRoot \fIdirectory\fR |
25d0c3fe MS |
64 | Specifies the root directory for the CUPS web interface content. |
65 | The default is usually "/usr/share/doc/cups". | |
37d9646b | 66 | .\"#ErrorLog |
25d0c3fe MS |
67 | .TP 5 |
68 | \fBErrorLog\fR | |
c41769ff | 69 | .TP 5 |
25d0c3fe | 70 | \fBErrorLog \fIfilename\fR |
c41769ff | 71 | .TP 5 |
c390f212 MS |
72 | \fBErrorLog syslog\fR |
73 | Defines the error log filename. | |
c390f212 | 74 | Specifying a blank filename disables error log generation. |
25d0c3fe | 75 | The value "syslog" causes log entries to be sent to the system log daemon. |
c390f212 MS |
76 | The server name may be included in filenames using the string "%s", for example: |
77 | .nf | |
78 | ||
79 | ErrorLog /var/log/cups/%s-error_log | |
80 | ||
81 | .fi | |
25d0c3fe | 82 | The default is "/var/log/cups/error_log". |
37d9646b | 83 | .\"#FatalErrors |
c41769ff | 84 | .TP 5 |
c390f212 | 85 | \fBFatalErrors none\fR |
c41769ff | 86 | .TP 5 |
25d0c3fe | 87 | \fBFatalErrors all \fI\-kind \fR[ ... \fI\-kind \fR] |
c41769ff | 88 | .TP 5 |
25d0c3fe | 89 | \fBFatalErrors \fIkind \fR[ ... \fIkind \fR] |
c390f212 | 90 | Specifies which errors are fatal, causing the scheduler to exit. |
25d0c3fe | 91 | The default is "config". |
c390f212 MS |
92 | The \fIkind\fR strings are: |
93 | .RS 5 | |
c41769ff | 94 | .TP 5 |
c390f212 MS |
95 | .B none |
96 | No errors are fatal. | |
c41769ff | 97 | .TP 5 |
c390f212 MS |
98 | .B all |
99 | All of the errors below are fatal. | |
c41769ff | 100 | .TP 5 |
c390f212 MS |
101 | .B browse |
102 | Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon. | |
103 | .TP 5 | |
104 | .B config | |
105 | Configuration file syntax errors are fatal. | |
106 | .TP 5 | |
107 | .B listen | |
108 | Listen or Port errors are fatal, except for IPv6 failures on the loopback or "any" addresses. | |
109 | .TP 5 | |
110 | .B log | |
111 | Log file creation or write errors are fatal. | |
c41769ff | 112 | .TP 5 |
c390f212 MS |
113 | .B permissions |
114 | Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions. | |
115 | .RE | |
37d9646b | 116 | .\"#FileDevice |
c390f212 MS |
117 | .TP 5 |
118 | \fBFileDevice Yes\fR | |
119 | .TP 5 | |
120 | \fBFileDevice No\fR | |
121 | Specifies whether the file pseudo-device can be used for new printer queues. | |
122 | The URI "file:///dev/null" is always allowed. | |
37d9646b | 123 | .\"#Group |
c390f212 | 124 | .TP 5 |
c390f212 MS |
125 | \fBGroup \fIgroup-name-or-number\fR |
126 | Specifies the group name or ID that will be used when executing external programs. | |
25d0c3fe | 127 | The default group is operating system specific but is usually "lp" or "nobody". |
37d9646b | 128 | .\"#LogFilePerm |
c41769ff | 129 | .TP 5 |
c390f212 | 130 | \fBLogFilePerm \fImode\fR |
25d0c3fe MS |
131 | Specifies the permissions of all log files that the scheduler writes. |
132 | The default is "0644". | |
37d9646b | 133 | .\"#PageLog |
c41769ff | 134 | .TP 5 |
c390f212 | 135 | \fBPageLog \fR[ \fIfilename\fR ] |
c41769ff | 136 | .TP 5 |
c390f212 MS |
137 | \fBPageLog syslog\fR |
138 | Defines the page log filename. | |
139 | The value "syslog" causes log entries to be sent to the system log daemon. | |
140 | Specifying a blank filename disables page log generation. | |
141 | The server name may be included in filenames using the string "%s", for example: | |
142 | .nf | |
143 | ||
144 | PageLog /var/log/cups/%s-page_log | |
145 | ||
146 | .fi | |
25d0c3fe | 147 | The default is "/var/log/cups/page_log". |
37d9646b | 148 | .\"#RemoteRoot |
c41769ff | 149 | .TP 5 |
c390f212 MS |
150 | \fBRemoteRoot \fIusername\fR |
151 | Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user. | |
25d0c3fe | 152 | The default is "remroot". |
37d9646b | 153 | .\"#RequestRoot |
c41769ff | 154 | .TP 5 |
c390f212 MS |
155 | \fBRequestRoot \fIdirectory\fR |
156 | Specifies the directory that contains print jobs and other HTTP request data. | |
25d0c3fe | 157 | The default is "/var/spool/cups". |
37d9646b | 158 | .\"#Sandboxing |
c41769ff | 159 | .TP 5 |
c390f212 | 160 | \fBSandboxing relaxed\fR |
8fe0183a | 161 | .TP 5 |
c390f212 MS |
162 | \fBSandboxing strict\fR |
163 | Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler. | |
164 | The default is "strict". | |
25d0c3fe | 165 | This directive is currently only used/supported on OS X. |
37d9646b | 166 | .\"#ServerBin |
8fe0183a | 167 | .TP 5 |
c390f212 MS |
168 | \fBServerBin \fIdirectory\fR |
169 | Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors. | |
25d0c3fe | 170 | The default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the platform. |
37d9646b | 171 | .\"#ServerKeychain |
c41769ff | 172 | .TP 5 |
c390f212 | 173 | \fBServerKeychain \fIpath\fR |
8fe0183a | 174 | Specifies the location of TLS certificates and private keys. |
25d0c3fe | 175 | The default is "/Library/Keychains/System.keychain" on OS X and "/etc/cups/ssl" on all other operating systems. |
08c7d544 | 176 | 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 | 177 | .\"#ServerRoot |
c41769ff | 178 | .TP 5 |
c390f212 MS |
179 | \fBServerRoot \fIdirectory\fR |
180 | Specifies the directory containing the server configuration files. | |
25d0c3fe | 181 | The default is "/etc/cups". |
37d9646b | 182 | .\"#SyncOnClose |
c41769ff | 183 | .TP 5 |
c390f212 | 184 | \fBSyncOnClose Yes\fR |
8a259669 | 185 | .TP 5 |
c390f212 MS |
186 | \fBSyncOnClose No\fR |
187 | Specifies whether the scheduler calls | |
188 | .BR fsync (2) | |
25d0c3fe MS |
189 | after writing configuration or state files. |
190 | The default is "No". | |
37d9646b | 191 | .\"#SystemGroup |
8a259669 | 192 | .TP 5 |
25d0c3fe | 193 | \fBSystemGroup \fIgroup-name \fR[ ... \fIgroup-name\fR ] |
c390f212 | 194 | Specifies the group(s) to use for \fI@SYSTEM\fR group authentication. |
25d0c3fe | 195 | The default contains "admin", "lpadmin", "root", "sys", and/or "system". |
37d9646b | 196 | .\"#TempDir |
c41769ff | 197 | .TP 5 |
c390f212 | 198 | \fBTempDir \fIdirectory\fR |
c41769ff | 199 | Specifies the directory where temporary files are stored. |
25d0c3fe | 200 | The default is "/var/spool/cups/tmp". |
37d9646b | 201 | .\"#User |
c41769ff | 202 | .TP 5 |
c390f212 | 203 | \fBUser \fIusername\fR |
c41769ff | 204 | Specifies the user name or ID that is used when running external programs. |
25d0c3fe | 205 | The default is "lp". |
c41769ff | 206 | .SH SEE ALSO |
c390f212 MS |
207 | .BR classes.conf (5), |
208 | .BR cups (1), | |
209 | .BR cupsd (8), | |
210 | .BR cupsd.conf (5), | |
211 | .BR mime.convs (5), | |
212 | .BR mime.types (5), | |
213 | .BR printers.conf (5), | |
214 | .BR subscriptions.conf (5), | |
215 | CUPS Online Help (http://localhost:631/help) | |
c41769ff | 216 | .SH COPYRIGHT |
0940626b | 217 | Copyright \[co] 2007-2015 by Apple Inc. |
c41769ff MS |
218 | .\" |
219 | .\" End of "$Id$". | |
220 | .\" |