1cups-files.conf(5) Apple Inc. cups-files.conf(5)
2
6 cups-files.conf - file and directory configuration file for cups
7
9 The cups-files.conf file configures the files and directories used by
10 the CUPS scheduler, cupsd(8). It is normally located in the /etc/cups
11 directory.
12 Each line in the file can be a configuration directive, a blank line,
14 or a comment. Configuration directives typically consist of a name and
15 zero or more values separated by whitespace. The configuration direc‐
16 tive name and values are case-insensitive. Comment lines start with
17 the # character.
18 DIRECTIVES
20 The following directives are understood by cupsd(8):
21 AccessLog
23 AccessLog filename
25 AccessLog stderr
27 AccessLog syslog
29 Defines the access log filename. Specifying a blank filename dis‐
30 ables access log generation. The value "stderr" causes log
31 entries to be sent to the standard error file when the scheduler
32 is running in the foreground, or to the system log daemon when run
33 in the background. The value "syslog" causes log entries to be
34 sent to the system log daemon. The server name may be included in
35 filenames using the string "%s", for example:
36 AccessLog /var/log/cups/%s-access_log
38 The default is "/var/log/cups/access_log".
40 CacheDir directory
42 Specifies the directory to use for long-lived temporary (cache)
43 files. The default is "/var/spool/cups/cache" or
44 "/var/cache/cups" depending on the platform.
45 ConfigFilePerm mode
47 Specifies the permissions for all configuration files that the
48 scheduler writes. The default is "0644" on macOS and "0640" on
49 all other operating systems.
50 Note: The permissions for the printers.conf file are currently masked
52 to only allow access from the scheduler user (typically root). This is
53 done because printer device URIs sometimes contain sensitive authenti‐
54 cation information that should not be generally known on the system.
55 There is no way to disable this security feature.
56 CreateSelfSignedCerts yes
58 CreateSelfSignedCerts no
60 Specifies whether the scheduler automatically creates self-signed
61 certificates for client connections using TLS. The default is
62 yes.
63 DataDir path
65 Specifies the directory where data files can be found. The
66 default is usually "/usr/share/cups".
67 DocumentRoot directory
69 Specifies the root directory for the CUPS web interface content.
70 The default is usually "/usr/share/doc/cups".
71 ErrorLog
73 ErrorLog filename
75 ErrorLog stderr
77 ErrorLog syslog
79 Defines the error log filename. Specifying a blank filename dis‐
80 ables error log generation. The value "stderr" causes log entries
81 to be sent to the standard error file when the scheduler is run‐
82 ning in the foreground, or to the system log daemon when run in
83 the background. The value "syslog" causes log entries to be sent
84 to the system log daemon. The server name may be included in
85 filenames using the string "%s", for example:
86 ErrorLog /var/log/cups/%s-error_log
88 The default is "/var/log/cups/error_log".
90 FatalErrors none
92 FatalErrors all -kind [ ... -kind ]
94 FatalErrors kind [ ... kind ]
96 Specifies which errors are fatal, causing the scheduler to exit.
97 The default is "config". The kind strings are:
98 none No errors are fatal.
100 all All of the errors below are fatal.
102 browse
104 Browsing initialization errors are fatal, for example failed
105 connections to the DNS-SD daemon.
106 config
108 Configuration file syntax errors are fatal.
109 listen
111 Listen or Port errors are fatal, except for IPv6 failures on
112 the loopback or "any" addresses.
113 log Log file creation or write errors are fatal.
115 permissions
117 Bad startup file permissions are fatal, for example shared
118 TLS certificate and key files with world-read permissions.
119 Group group-name-or-number
121 Specifies the group name or ID that will be used when executing
122 external programs. The default group is operating system specific
123 but is usually "lp" or "nobody".
124 LogFilePerm mode
126 Specifies the permissions of all log files that the scheduler
127 writes. The default is "0644".
128 PageLog [ filename ]
130 PageLog stderr
132 PageLog syslog
134 Defines the page log filename. The value "stderr" causes log
135 entries to be sent to the standard error file when the scheduler
136 is running in the foreground, or to the system log daemon when run
137 in the background. The value "syslog" causes log entries to be
138 sent to the system log daemon. Specifying a blank filename dis‐
139 ables page log generation. The server name may be included in
140 filenames using the string "%s", for example:
141 PageLog /var/log/cups/%s-page_log
143 The default is "/var/log/cups/page_log".
145 PassEnv variable [ ... variable ]
147 Passes the specified environment variable(s) to child processes.
148 Note: the standard CUPS filter and backend environment variables
149 cannot be overridden using this directive.
150 RemoteRoot username
152 Specifies the username that is associated with unauthenticated
153 accesses by clients claiming to be the root user. The default is
154 "remroot".
155 RequestRoot directory
157 Specifies the directory that contains print jobs and other HTTP
158 request data. The default is "/var/spool/cups".
159 Sandboxing relaxed
161 Sandboxing strict
163 Specifies the level of security sandboxing that is applied to
164 print filters, backends, and other child processes of the sched‐
165 uler. The default is "strict". This directive is currently only
166 used/supported on macOS.
167 ServerBin directory
169 Specifies the directory containing the backends, CGI programs,
170 filters, helper programs, notifiers, and port monitors. The
171 default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the
172 platform.
173 ServerKeychain path
175 Specifies the location of TLS certificates and private keys. The
176 default is "/Library/Keychains/System.keychain" on macOS and
177 "/etc/cups/ssl" on all other operating systems. macOS uses its
178 keychain database to store certificates and keys while other plat‐
179 forms use separate files in the specified directory, *.crt for
180 PEM-encoded certificates and *.key for PEM-encoded private keys.
181 ServerRoot directory
183 Specifies the directory containing the server configuration files.
184 The default is "/etc/cups".
185 SetEnv variable value
187 Set the specified environment variable to be passed to child pro‐
188 cesses. Note: the standard CUPS filter and backend environment
189 variables cannot be overridden using this directive.
190 StateDir directory
192 Specifies the directory to use for PID and local certificate
193 files. The default is "/var/run/cups" or "/etc/cups" depending on
194 the platform.
195 SyncOnClose Yes
197 SyncOnClose No
199 Specifies whether the scheduler calls fsync(2) after writing con‐
200 figuration or state files. The default is "Yes".
201 SystemGroup group-name [ ... group-name ]
203 Specifies the group(s) to use for @SYSTEM group authentication.
204 The default contains "admin", "lpadmin", "root", "sys", and/or
205 "system".
206 TempDir directory
208 Specifies the directory where short-term temporary files are
209 stored. The default is "/var/spool/cups/tmp".
210 User username
212 Specifies the user name or ID that is used when running external
213 programs. The default is "lp".
214 DEPRECATED DIRECTIVES
216 The following directives are deprecated and will be removed from a
217 future version of CUPS:
218 FileDevice Yes
220 FileDevice No
222 Specifies whether the file pseudo-device can be used for new
223 printer queues. The URI "file:///dev/null" is always allowed.
224 File devices cannot be used with "raw" print queues - a PPD file
225 is required. The specified file is overwritten for every print
226 job. Writing to directories is not supported.
227 FontPath directory[:...:directoryN]
229 Specifies a colon separated list of directories where fonts can be
230 found. On Linux the font-config(1) mechanism is used instead. On
231 macOS the Font Book application manages system-installed fonts.
232 LPDConfigFile filename
234 Specifies the LPD service configuration file to update.
235 Printcap filename
237 Specifies a file that is filled with a list of local print queues.
238 PrintcapFormat bsd
240 PrintcapFormat plist
242 PrintcapFormat solaris
244 Specifies the format to use for the Printcap file. "bsd" is the
245 historical LPD printcap file format. "plist" is the Apple plist
246 file format. "solaris" is the historical Solaris LPD printcap
247 file format.
248 SMBConfigFile filename
250 Specifies the SMB service configuration file to update.
251
253 classes.conf(5), cups(1), cupsd(8), cupsd.conf(5), mime.convs(5),
254 mime.types(5), printers.conf(5), subscriptions.conf(5), CUPS Online
255 Help (http://localhost:631/help)
256
258 Copyright © 2007-2018 by Apple Inc.
25925 February 2018 CUPS cups-files.conf(5)