]>
Commit | Line | Data |
---|---|---|
c41769ff MS |
1 | .\" |
2 | .\" "$Id$" | |
3 | .\" | |
c390f212 | 4 | .\" cups-files.conf man page for CUPS. |
c41769ff | 5 | .\" |
8fe0183a MS |
6 | .\" Copyright 2007-2014 by Apple Inc. |
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 | .\" |
25d0c3fe | 15 | .TH cups-files.conf 5 "CUPS" "11 June 2014" "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): | |
c41769ff | 30 | .TP 5 |
25d0c3fe | 31 | \fBAccessLog\fR |
c41769ff | 32 | .TP 5 |
25d0c3fe | 33 | \fBAccessLog \fIfilename\fR |
c390f212 MS |
34 | .TP 5 |
35 | \fBAccessLog syslog\fR | |
c41769ff | 36 | Defines the access log filename. |
c390f212 | 37 | Specifying a blank filename disables access log generation. |
25d0c3fe | 38 | The value "syslog" causes log entries to be sent to the system log daemon. |
c390f212 MS |
39 | The server name may be included in filenames using the string "%s", for example: |
40 | .nf | |
41 | ||
42 | AccessLog /var/log/cups/%s-access_log | |
43 | ||
44 | .fi | |
25d0c3fe | 45 | The default is "/var/log/cups/access_log". |
c41769ff | 46 | .TP 5 |
c390f212 MS |
47 | \fBConfigFilePerm \fImode\fR |
48 | Specifies the permissions for all configuration files that the scheduler writes. | |
25d0c3fe | 49 | The default is "0644" on OS X and "0640" on all other operating systems. |
b4a8492a | 50 | .LP |
25d0c3fe | 51 | \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 |
52 | This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system. |
53 | There is no way to disable this security feature. | |
c41769ff | 54 | .TP 5 |
c390f212 | 55 | \fBDataDir \fIpath\fR |
25d0c3fe MS |
56 | Specifies the directory where data files can be found. |
57 | The default is usually "/usr/share/cups". | |
c41769ff | 58 | .TP 5 |
c390f212 | 59 | \fBDocumentRoot \fIdirectory\fR |
25d0c3fe MS |
60 | Specifies the root directory for the CUPS web interface content. |
61 | The default is usually "/usr/share/doc/cups". | |
62 | .TP 5 | |
63 | \fBErrorLog\fR | |
c41769ff | 64 | .TP 5 |
25d0c3fe | 65 | \fBErrorLog \fIfilename\fR |
c41769ff | 66 | .TP 5 |
c390f212 MS |
67 | \fBErrorLog syslog\fR |
68 | Defines the error log filename. | |
c390f212 | 69 | Specifying a blank filename disables error log generation. |
25d0c3fe | 70 | The value "syslog" causes log entries to be sent to the system log daemon. |
c390f212 MS |
71 | The server name may be included in filenames using the string "%s", for example: |
72 | .nf | |
73 | ||
74 | ErrorLog /var/log/cups/%s-error_log | |
75 | ||
76 | .fi | |
25d0c3fe | 77 | The default is "/var/log/cups/error_log". |
c41769ff | 78 | .TP 5 |
c390f212 | 79 | \fBFatalErrors none\fR |
c41769ff | 80 | .TP 5 |
25d0c3fe | 81 | \fBFatalErrors all \fI\-kind \fR[ ... \fI\-kind \fR] |
c41769ff | 82 | .TP 5 |
25d0c3fe | 83 | \fBFatalErrors \fIkind \fR[ ... \fIkind \fR] |
c390f212 | 84 | Specifies which errors are fatal, causing the scheduler to exit. |
25d0c3fe | 85 | The default is "config". |
c390f212 MS |
86 | The \fIkind\fR strings are: |
87 | .RS 5 | |
c41769ff | 88 | .TP 5 |
c390f212 MS |
89 | .B none |
90 | No errors are fatal. | |
c41769ff | 91 | .TP 5 |
c390f212 MS |
92 | .B all |
93 | All of the errors below are fatal. | |
c41769ff | 94 | .TP 5 |
c390f212 MS |
95 | .B browse |
96 | Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon. | |
97 | .TP 5 | |
98 | .B config | |
99 | Configuration file syntax errors are fatal. | |
100 | .TP 5 | |
101 | .B listen | |
102 | Listen or Port errors are fatal, except for IPv6 failures on the loopback or "any" addresses. | |
103 | .TP 5 | |
104 | .B log | |
105 | Log file creation or write errors are fatal. | |
c41769ff | 106 | .TP 5 |
c390f212 MS |
107 | .B permissions |
108 | Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions. | |
109 | .RE | |
110 | .TP 5 | |
111 | \fBFileDevice Yes\fR | |
112 | .TP 5 | |
113 | \fBFileDevice No\fR | |
114 | Specifies whether the file pseudo-device can be used for new printer queues. | |
115 | The URI "file:///dev/null" is always allowed. | |
116 | .TP 5 | |
c390f212 MS |
117 | \fBGroup \fIgroup-name-or-number\fR |
118 | Specifies the group name or ID that will be used when executing external programs. | |
25d0c3fe | 119 | The default group is operating system specific but is usually "lp" or "nobody". |
c41769ff | 120 | .TP 5 |
c390f212 | 121 | \fBLogFilePerm \fImode\fR |
25d0c3fe MS |
122 | Specifies the permissions of all log files that the scheduler writes. |
123 | The default is "0644". | |
c41769ff | 124 | .TP 5 |
c390f212 | 125 | \fBPageLog \fR[ \fIfilename\fR ] |
c41769ff | 126 | .TP 5 |
c390f212 MS |
127 | \fBPageLog syslog\fR |
128 | Defines the page log filename. | |
129 | The value "syslog" causes log entries to be sent to the system log daemon. | |
130 | Specifying a blank filename disables page log generation. | |
131 | The server name may be included in filenames using the string "%s", for example: | |
132 | .nf | |
133 | ||
134 | PageLog /var/log/cups/%s-page_log | |
135 | ||
136 | .fi | |
25d0c3fe | 137 | The default is "/var/log/cups/page_log". |
c41769ff | 138 | .TP 5 |
c390f212 MS |
139 | \fBRemoteRoot \fIusername\fR |
140 | Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user. | |
25d0c3fe | 141 | The default is "remroot". |
c41769ff | 142 | .TP 5 |
c390f212 MS |
143 | \fBRequestRoot \fIdirectory\fR |
144 | Specifies the directory that contains print jobs and other HTTP request data. | |
25d0c3fe | 145 | The default is "/var/spool/cups". |
c41769ff | 146 | .TP 5 |
c390f212 | 147 | \fBSandboxing off\fR |
8fe0183a | 148 | .TP 5 |
c390f212 | 149 | \fBSandboxing relaxed\fR |
8fe0183a | 150 | .TP 5 |
c390f212 MS |
151 | \fBSandboxing strict\fR |
152 | Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler. | |
153 | The default is "strict". | |
25d0c3fe | 154 | This directive is currently only used/supported on OS X. |
8fe0183a | 155 | .TP 5 |
c390f212 MS |
156 | \fBServerBin \fIdirectory\fR |
157 | Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors. | |
25d0c3fe | 158 | The default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the platform. |
c41769ff | 159 | .TP 5 |
c390f212 | 160 | \fBServerKeychain \fIpath\fR |
8fe0183a | 161 | Specifies the location of TLS certificates and private keys. |
25d0c3fe | 162 | The default is "/Library/Keychains/System.keychain" on OS X and "/etc/cups/ssl" on all other operating systems. |
c41769ff | 163 | .TP 5 |
c390f212 MS |
164 | \fBServerRoot \fIdirectory\fR |
165 | Specifies the directory containing the server configuration files. | |
25d0c3fe | 166 | The default is "/etc/cups". |
c41769ff | 167 | .TP 5 |
c390f212 | 168 | \fBSyncOnClose Yes\fR |
8a259669 | 169 | .TP 5 |
c390f212 MS |
170 | \fBSyncOnClose No\fR |
171 | Specifies whether the scheduler calls | |
172 | .BR fsync (2) | |
25d0c3fe MS |
173 | after writing configuration or state files. |
174 | The default is "No". | |
8a259669 | 175 | .TP 5 |
25d0c3fe | 176 | \fBSystemGroup \fIgroup-name \fR[ ... \fIgroup-name\fR ] |
c390f212 | 177 | Specifies the group(s) to use for \fI@SYSTEM\fR group authentication. |
25d0c3fe | 178 | The default contains "admin", "lpadmin", "root", "sys", and/or "system". |
c41769ff | 179 | .TP 5 |
c390f212 | 180 | \fBTempDir \fIdirectory\fR |
c41769ff | 181 | Specifies the directory where temporary files are stored. |
25d0c3fe | 182 | The default is "/var/spool/cups/tmp". |
c41769ff | 183 | .TP 5 |
c390f212 | 184 | \fBUser \fIusername\fR |
c41769ff | 185 | Specifies the user name or ID that is used when running external programs. |
25d0c3fe | 186 | The default is "lp". |
c41769ff | 187 | .SH SEE ALSO |
c390f212 MS |
188 | .BR classes.conf (5), |
189 | .BR cups (1), | |
190 | .BR cupsd (8), | |
191 | .BR cupsd.conf (5), | |
192 | .BR mime.convs (5), | |
193 | .BR mime.types (5), | |
194 | .BR printers.conf (5), | |
195 | .BR subscriptions.conf (5), | |
196 | CUPS Online Help (http://localhost:631/help) | |
c41769ff | 197 | .SH COPYRIGHT |
c390f212 | 198 | Copyright \[co] 2007-2014 by Apple Inc. |
c41769ff MS |
199 | .\" |
200 | .\" End of "$Id$". | |
201 | .\" |