]> git.ipfire.org Git - thirdparty/cups.git/blob - man/cups-files.conf.man.in
Merge pull request #5112 from paulmenzel/remove-libgcrypt-detection
[thirdparty/cups.git] / man / cups-files.conf.man.in
1 .\"
2 .\" cups-files.conf man page for CUPS.
3 .\"
4 .\" Copyright 2007-2017 by Apple Inc.
5 .\" Copyright 1997-2006 by Easy Software Products.
6 .\"
7 .\" These coded instructions, statements, and computer programs are the
8 .\" property of Apple Inc. and are protected by Federal copyright
9 .\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
10 .\" which should have been included with this file. If this file is
11 .\" file is missing or damaged, see the license at "http://www.cups.org/".
12 .\"
13 .TH cups-files.conf 5 "CUPS" "21 September 2017" "Apple Inc."
14 .SH NAME
15 cups\-files.conf \- file and directory configuration file for cups
16 .SH DESCRIPTION
17 The \fBcups\-files.conf\fR file configures the files and directories used by the CUPS scheduler,
18 .BR cupsd (8).
19 It is normally located in the \fI/etc/cups\fR directory.
20 .LP
21 Each line in the file can be a configuration directive, a blank line, or a comment.
22 Configuration directives typically consist of a name and zero or more values separated by whitespace.
23 The configuration directive name and values are case-insensitive.
24 Comment lines start with the # character.
25 .SS DIRECTIVES
26 The following directives are understood by
27 .BR cupsd (8):
28 .\"#AccessLog
29 .TP 5
30 \fBAccessLog\fR
31 .TP 5
32 \fBAccessLog \fIfilename\fR
33 .TP 5
34 \fBAccessLog stderr\fR
35 .TP 5
36 \fBAccessLog syslog\fR
37 Defines the access log filename.
38 Specifying a blank filename disables access log generation.
39 The value "stderr" causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.
40 The value "syslog" causes log entries to be sent to the system log daemon.
41 The server name may be included in filenames using the string "%s", for example:
42 .nf
43
44 AccessLog /var/log/cups/%s-access_log
45
46 .fi
47 The default is "/var/log/cups/access_log".
48 .\"#CacheDir
49 .TP 5
50 \fBCacheDir \fIdirectory\fR
51 Specifies the directory to use for long-lived temporary (cache) files.
52 The default is "/var/spool/cups/cache" or "/var/cache/cups" depending on the platform.
53 .\"#ConfigFilePerm
54 .TP 5
55 \fBConfigFilePerm \fImode\fR
56 Specifies the permissions for all configuration files that the scheduler writes.
57 The default is "0644" on macOS and "0640" on all other operating systems.
58 .LP
59 \fBNote:\fR The permissions for the \fIprinters.conf\fR file are currently masked to only allow access from the scheduler user (typically root).
60 This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system.
61 There is no way to disable this security feature.
62 .\"#CreateSelfSignedCerts
63 .TP 5
64 \fBCreateSelfSignedCerts yes\fR
65 .TP 5
66 \fBCreateSelfSignedCerts no\fR
67 Specifies whether the scheduler automatically creates self-signed certificates for client connections using TLS.
68 The default is yes.
69 .\"#DataDir
70 .TP 5
71 \fBDataDir \fIpath\fR
72 Specifies the directory where data files can be found.
73 The default is usually "/usr/share/cups".
74 .\"#DocumentRoot
75 .TP 5
76 \fBDocumentRoot \fIdirectory\fR
77 Specifies the root directory for the CUPS web interface content.
78 The default is usually "/usr/share/doc/cups".
79 .\"#ErrorLog
80 .TP 5
81 \fBErrorLog\fR
82 .TP 5
83 \fBErrorLog \fIfilename\fR
84 .TP 5
85 \fBErrorLog stderr\fR
86 .TP 5
87 \fBErrorLog syslog\fR
88 Defines the error log filename.
89 Specifying a blank filename disables error log generation.
90 The value "stderr" causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.
91 The value "syslog" causes log entries to be sent to the system log daemon.
92 The server name may be included in filenames using the string "%s", for example:
93 .nf
94
95 ErrorLog /var/log/cups/%s-error_log
96
97 .fi
98 The default is "/var/log/cups/error_log".
99 .\"#FatalErrors
100 .TP 5
101 \fBFatalErrors none\fR
102 .TP 5
103 \fBFatalErrors all \fI\-kind \fR[ ... \fI\-kind \fR]
104 .TP 5
105 \fBFatalErrors \fIkind \fR[ ... \fIkind \fR]
106 Specifies which errors are fatal, causing the scheduler to exit.
107 The default is "config".
108 The \fIkind\fR strings are:
109 .RS 5
110 .TP 5
111 .B none
112 No errors are fatal.
113 .TP 5
114 .B all
115 All of the errors below are fatal.
116 .TP 5
117 .B browse
118 Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon.
119 .TP 5
120 .B config
121 Configuration file syntax errors are fatal.
122 .TP 5
123 .B listen
124 Listen or Port errors are fatal, except for IPv6 failures on the loopback or "any" addresses.
125 .TP 5
126 .B log
127 Log file creation or write errors are fatal.
128 .TP 5
129 .B permissions
130 Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions.
131 .RE
132 .\"#Group
133 .TP 5
134 \fBGroup \fIgroup-name-or-number\fR
135 Specifies the group name or ID that will be used when executing external programs.
136 The default group is operating system specific but is usually "lp" or "nobody".
137 .\"#LogFilePerm
138 .TP 5
139 \fBLogFilePerm \fImode\fR
140 Specifies the permissions of all log files that the scheduler writes.
141 The default is "0644".
142 .\"#PageLog
143 .TP 5
144 \fBPageLog \fR[ \fIfilename\fR ]
145 .TP 5
146 \fBPageLog stderr\fR
147 .TP 5
148 \fBPageLog syslog\fR
149 Defines the page log filename.
150 The value "stderr" causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.
151 The value "syslog" causes log entries to be sent to the system log daemon.
152 Specifying a blank filename disables page log generation.
153 The server name may be included in filenames using the string "%s", for example:
154 .nf
155
156 PageLog /var/log/cups/%s-page_log
157
158 .fi
159 The default is "/var/log/cups/page_log".
160 .\"#RemoteRoot
161 .TP 5
162 \fBRemoteRoot \fIusername\fR
163 Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user.
164 The default is "remroot".
165 .\"#RequestRoot
166 .TP 5
167 \fBRequestRoot \fIdirectory\fR
168 Specifies the directory that contains print jobs and other HTTP request data.
169 The default is "/var/spool/cups".
170 .\"#Sandboxing
171 .TP 5
172 \fBSandboxing relaxed\fR
173 .TP 5
174 \fBSandboxing strict\fR
175 Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler.
176 The default is "strict".
177 This directive is currently only used/supported on macOS.
178 .\"#ServerBin
179 .TP 5
180 \fBServerBin \fIdirectory\fR
181 Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors.
182 The default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the platform.
183 .\"#ServerKeychain
184 .TP 5
185 \fBServerKeychain \fIpath\fR
186 Specifies the location of TLS certificates and private keys.
187 The default is "/Library/Keychains/System.keychain" on macOS and "/etc/cups/ssl" on all other operating systems.
188 macOS 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.
189 .\"#ServerRoot
190 .TP 5
191 \fBServerRoot \fIdirectory\fR
192 Specifies the directory containing the server configuration files.
193 The default is "/etc/cups".
194 .\"#StateDir
195 .TP 5
196 \fBStateDir \fIdirectory\fR
197 Specifies the directory to use for PID and local certificate files.
198 The default is "/var/run/cups" or "/etc/cups" depending on the platform.
199 .\"#SyncOnClose
200 .TP 5
201 \fBSyncOnClose Yes\fR
202 .TP 5
203 \fBSyncOnClose No\fR
204 Specifies whether the scheduler calls
205 .BR fsync (2)
206 after writing configuration or state files.
207 The default is "No".
208 .\"#SystemGroup
209 .TP 5
210 \fBSystemGroup \fIgroup-name \fR[ ... \fIgroup-name\fR ]
211 Specifies the group(s) to use for \fI@SYSTEM\fR group authentication.
212 The default contains "admin", "lpadmin", "root", "sys", and/or "system".
213 .\"#TempDir
214 .TP 5
215 \fBTempDir \fIdirectory\fR
216 Specifies the directory where short-term temporary files are stored.
217 The default is "/var/spool/cups/tmp".
218 .\"#User
219 .TP 5
220 \fBUser \fIusername\fR
221 Specifies the user name or ID that is used when running external programs.
222 The default is "lp".
223 .SS DEPRECATED DIRECTIVES
224 The following directives are deprecated and will be removed from a future version of CUPS:
225 .\"#FileDevice
226 .TP 5
227 \fBFileDevice Yes\fR
228 .TP 5
229 \fBFileDevice No\fR
230 Specifies whether the file pseudo-device can be used for new printer queues.
231 The URI "file:///dev/null" is always allowed.
232 File devices cannot be used with "raw" print queues - a PPD file is required.
233 The specified file is overwritten for every print job.
234 Writing to directories is not supported.
235 .\"#FontPath
236 .TP 5
237 \fBFontPath \fIdirectory[:...:directoryN]\fR
238 Specifies a colon separated list of directories where fonts can be found.
239 On Linux the
240 .BR font-config (1)
241 mechanism is used instead.
242 On macOS the Font Book application manages system-installed fonts.
243 .\"#LPDConfigFile
244 .TP 5
245 \fB LPDConfigFile \fIfilename\fR
246 Specifies the LPD service configuration file to update.
247 .\"#Printcap
248 .TP 5
249 \fBPrintcap \fIfilename\fR
250 Specifies a file that is filled with a list of local print queues.
251 .\"#PrintcapFormat
252 .TP 5
253 \fBPrintcapFormat bsd\fR
254 .TP 5
255 \fBPrintcapFormat plist\fR
256 .TP 5
257 \fBPrintcapFormat solaris\fR
258 Specifies the format to use for the Printcap file.
259 "bsd" is the historical LPD printcap file format.
260 "plist" is the Apple plist file format.
261 "solaris" is the historical Solaris LPD printcap file format.
262 .\"#SMBConfigFile
263 .TP 5
264 \fBSMBConfigFile \fIfilename\fR
265 Specifies the SMB service configuration file to update.
266 .SH SEE ALSO
267 .BR classes.conf (5),
268 .BR cups (1),
269 .BR cupsd (8),
270 .BR cupsd.conf (5),
271 .BR mime.convs (5),
272 .BR mime.types (5),
273 .BR printers.conf (5),
274 .BR subscriptions.conf (5),
275 CUPS Online Help (http://localhost:631/help)
276 .SH COPYRIGHT
277 Copyright \[co] 2007-2017 by Apple Inc.