]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | .\" |
1a18c85c | 2 | .\" "$Id: cupsd.conf.man.in 12059 2014-07-28 14:04:32Z msweet $" |
ef416fc2 | 3 | .\" |
1a18c85c | 4 | .\" cupsd.conf man page for CUPS. |
ef416fc2 | 5 | .\" |
1a18c85c MS |
6 | .\" Copyright 2007-2014 by Apple Inc. |
7 | .\" Copyright 1997-2006 by Easy Software Products. | |
ef416fc2 | 8 | .\" |
1a18c85c 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/". | |
ef416fc2 | 14 | .\" |
b60086f8 | 15 | .TH cupsd.conf 5 "CUPS" "28 July 2014" "Apple Inc." |
ef416fc2 | 16 | .SH NAME |
17 | cupsd.conf \- server configuration file for cups | |
18 | .SH DESCRIPTION | |
1a18c85c MS |
19 | The |
20 | .I cupsd.conf | |
21 | file configures the CUPS scheduler, | |
22 | .BR cupsd (8). | |
23 | It is normally located in the | |
24 | .I /etc/cups | |
25 | directory. | |
26 | \fBNote:\fR File, directory, and user configuration directives that used to be allowed in the \fBcupsd.conf\fR file are now stored in the | |
27 | .BR cups-files.conf (5) | |
28 | file instead in order to prevent certain types of privilege escalation attacks. | |
ef416fc2 | 29 | .LP |
1a18c85c MS |
30 | Each line in the file can be a configuration directive, a blank line, or a comment. |
31 | Configuration directives typically consist of a name and zero or more values separated by whitespace. | |
32 | The configuration directive name and values are case-insensitive. | |
33 | Comment lines start with the # character. | |
34 | .SS TOP-LEVEL DIRECTIVES | |
35 | The following top-level directives are understood by | |
36 | .BR cupsd (8): | |
ef416fc2 | 37 | .TP 5 |
1a18c85c | 38 | \fBAccessLogLevel config\fR |
1f0275e3 | 39 | .TP 5 |
1a18c85c | 40 | \fBAccessLogLevel actions\fR |
1f0275e3 | 41 | .TP 5 |
1a18c85c | 42 | \fBAccessLogLevel all\fR |
1f0275e3 | 43 | Specifies the logging level for the AccessLog file. |
1a18c85c MS |
44 | The "config" level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated. |
45 | The "actions" level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for "config". | |
46 | The "all" level logs all requests. | |
47 | The default access log level is "actions". | |
1f0275e3 | 48 | .TP 5 |
1a18c85c | 49 | \fBAutoPurgeJobs Yes\fR |
bd7854cb | 50 | .TP 5 |
1a18c85c MS |
51 | \fBAutoPurgeJobs No\fR |
52 | .br | |
53 | Specifies whether to purge job history data automatically when it is no longer required for quotas. | |
54 | The default is "No". | |
bd7854cb | 55 | .TP 5 |
1a18c85c | 56 | \fBBrowseLocalProtocols all\fR |
bd7854cb | 57 | .TP 5 |
1a18c85c | 58 | \fBBrowseLocalProtocols dnssd\fR |
bd7854cb | 59 | .TP 5 |
1a18c85c MS |
60 | \fBBrowseLocalProtocols none\fR |
61 | Specifies which protocols to use for local printer sharing. | |
62 | The default is "dnssd" on systems that support Bonjour and "none" otherwise. | |
bd7854cb | 63 | .TP 5 |
1a18c85c | 64 | \fBBrowseWebIF Yes\fR |
bd7854cb | 65 | .TP 5 |
1a18c85c MS |
66 | \fBBrowseWebIF No\fR |
67 | .br | |
68 | Specifies whether the CUPS web interface is advertised. | |
69 | The default is "No". | |
bd7854cb | 70 | .TP 5 |
1a18c85c | 71 | \fBBrowsing Yes\fR |
bd7854cb | 72 | .TP 5 |
1a18c85c | 73 | \fBBrowsing No\fR |
ef416fc2 | 74 | .br |
1a18c85c MS |
75 | Specifies whether shared printers are advertised. |
76 | The default is "No". | |
ef416fc2 | 77 | .TP 5 |
1a18c85c MS |
78 | \fBClassification \fIbanner\fR |
79 | .br | |
80 | Specifies the security classification of the server. | |
81 | Any valid banner name can be used, including "classified", "confidential", "secret", "topsecret", and "unclassified", or the banner can be omitted to disable secure printing functions. | |
82 | The default is no classification banner. | |
bd7854cb | 83 | .TP 5 |
1a18c85c | 84 | \fBClassifyOverride Yes\fR |
bd7854cb | 85 | .TP 5 |
1a18c85c MS |
86 | \fBClassifyOverride No\fR |
87 | .br | |
88 | Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option. | |
89 | The default is "No". | |
bd7854cb | 90 | .TP 5 |
1a18c85c | 91 | \fBDefaultAuthType Basic\fR |
f7deaa1a | 92 | .TP 5 |
1a18c85c | 93 | \fBDefaultAuthType Negotiate\fR |
ef416fc2 | 94 | .br |
1a18c85c MS |
95 | Specifies the default type of authentication to use. |
96 | The default is "Basic". | |
ef416fc2 | 97 | .TP 5 |
1a18c85c | 98 | \fBDefaultEncryption Never\fR |
bd7854cb | 99 | .TP 5 |
1a18c85c | 100 | \fBDefaultEncryption IfRequested\fR |
ef416fc2 | 101 | .TP 5 |
1a18c85c MS |
102 | \fBDefaultEncryption Required\fR |
103 | Specifies whether encryption will be used for authenticated requests. | |
104 | The default is "Required". | |
ef416fc2 | 105 | .TP 5 |
1a18c85c MS |
106 | \fBDefaultLanguage \fIlocale\fR |
107 | Specifies the default language to use for text and web content. | |
108 | The default is "en". | |
b19ccc9e | 109 | .TP 5 |
1a18c85c | 110 | \fBDefaultPaperSize Auto\fR |
b19ccc9e | 111 | .TP 5 |
1a18c85c | 112 | \fBDefaultPaperSize None\fR |
bd7854cb | 113 | .TP 5 |
1a18c85c MS |
114 | \fBDefaultPaperSize \fIsizename\fR |
115 | Specifies the default paper size for new print queues. "Auto" uses a locale-specific default, while "None" specifies there is no default paper size. | |
116 | Specific size names are typically "Letter" or "A4". | |
117 | The default is "Auto". | |
ef416fc2 | 118 | .TP 5 |
1a18c85c MS |
119 | \fBDefaultPolicy \fIpolicy-name\fR |
120 | Specifies the default access policy to use. | |
121 | The default access policy is "default". | |
ef416fc2 | 122 | .TP 5 |
1a18c85c | 123 | \fBDefaultShared Yes\fR |
bd7854cb | 124 | .TP 5 |
1a18c85c MS |
125 | \fBDefaultShared No\fR |
126 | Specifies whether local printers are shared by default. | |
127 | The default is "Yes". | |
ef416fc2 | 128 | .TP 5 |
1a18c85c MS |
129 | \fBDirtyCleanInterval \fIseconds\fR |
130 | Specifies the delay for updating of configuration and state files. | |
131 | A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds. | |
132 | The default value is "30". | |
bd7854cb | 133 | .TP 5 |
1a18c85c MS |
134 | \fBErrorPolicy abort-job\fR |
135 | Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer. | |
bd7854cb | 136 | .TP 5 |
1a18c85c MS |
137 | \fBErrorPolicy retry-job\fR |
138 | Specifies that a failed print job should be retried at a later time unless otherwise specified for the printer. | |
f7deaa1a | 139 | .TP 5 |
1a18c85c MS |
140 | \fBErrorPolicy retry-this-job\fR |
141 | Specifies that a failed print job should be retried immediately unless otherwise specified for the printer. | |
ef416fc2 | 142 | .TP 5 |
1a18c85c MS |
143 | \fBErrorPolicy stop-printer\fR |
144 | Specifies that a failed print job should stop the printer unless otherwise specified for the printer. The 'stop-printer' error policy is the default. | |
8b450588 | 145 | .TP 5 |
1a18c85c MS |
146 | \fBFilterLimit \fIlimit\fR |
147 | Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems. | |
148 | A limit of 0 disables filter limiting. | |
149 | An average print to a non-PostScript printer needs a filter limit of about 200. | |
150 | A PostScript printer needs about half that (100). | |
151 | Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time. | |
152 | The default limit is "0". | |
153 | .TP 5 | |
154 | \fBFilterNice \fInice-value\fR | |
155 | Specifies the scheduling priority ( | |
156 | .BR nice (8) | |
157 | value) of filters that are run to print a job. | |
158 | The nice value ranges from 0, the highest priority, to 19, the lowest priority. | |
159 | The default is 0. | |
160 | .TP 5 | |
161 | \fBGSSServiceName \fIname\fR | |
162 | Specifies the service name when using Kerberos authentication. | |
163 | The default service name is "http." | |
164 | .TP 5 | |
165 | \fBHostNameLookups On\fR | |
166 | .TP 5 | |
167 | \fBHostNameLookups Off\fR | |
168 | .TP 5 | |
169 | \fBHostNameLookups Double\fR | |
170 | Specifies whether to do reverse lookups on connecting clients. | |
171 | The "Double" setting causes | |
172 | .BR cupsd (8) | |
173 | to verify that the hostname resolved from the address matches one of the addresses returned for that hostname. | |
174 | Double lookups also prevent clients with unregistered addresses from connecting to your server. | |
175 | The default is "Off" to avoid the potential server performance problems with hostname lookups. | |
176 | Only set this option to "On" or "Double" if absolutely required. | |
177 | .TP 5 | |
178 | \fBJobKillDelay \fIseconds\fR | |
179 | Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job. | |
180 | The default is "30". | |
181 | .TP 5 | |
182 | \fBJobRetryInterval \fIseconds\fR | |
183 | Specifies the interval between retries of jobs in seconds. | |
184 | This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job" or "retry-current-job". | |
185 | The default is "30". | |
8b450588 | 186 | .TP 5 |
1a18c85c MS |
187 | \fBJobRetryLimit \fIcount\fR |
188 | Specifies the number of retries that are done for jobs. | |
189 | This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job" or "retry-current-job". | |
190 | The default is "5". | |
8b450588 | 191 | .TP 5 |
1a18c85c | 192 | \fBKeepAlive Yes\fR |
ef416fc2 | 193 | .TP 5 |
1a18c85c MS |
194 | \fBKeepAlive No\fR |
195 | Specifies whether to support HTTP keep-alive connections. | |
196 | The default is "Yes". | |
49d87452 | 197 | .TP 5 |
1a18c85c MS |
198 | \fBKeepAliveTimeout \fIseconds\fR |
199 | Specifies how long an idle client connection remains open. | |
200 | The default is "30". | |
49d87452 | 201 | .TP 5 |
1a18c85c MS |
202 | \fB<Limit \fIoperation \fR...\fB> \fR... \fB</Limit>\fR |
203 | Specifies the IPP operations that are being limited inside a Policy section. IPP operation names are listed below in the section "IPP OPERATIONS". | |
49d87452 | 204 | .TP 5 |
1a18c85c | 205 | \fB<Limit \fImethod \fR...\fB> \fR... \fB</Limit>\fR |
ef416fc2 | 206 | .TP 5 |
1a18c85c MS |
207 | \fB<LimitExcept \fImethod \fR...\fB> \fR... \fB</LimitExcept>\fR |
208 | Specifies the HTTP methods that are being limited inside a Location section. HTTP method names are listed below in the section "HTTP METHODS". | |
3d052e43 | 209 | .TP 5 |
1a18c85c MS |
210 | \fBLimitRequestBody \fIsize\fR |
211 | Specifies the maximum size of print files, IPP requests, and HTML form data. | |
212 | The default is "0" which disables the limit check. | |
3d052e43 | 213 | .TP 5 |
1a18c85c | 214 | \fBListen \fIipv4-address\fB:\fIport\fR |
bd7854cb | 215 | .TP 5 |
1a18c85c | 216 | \fBListen [\fIipv6-address\fB]:\fIport\fR |
bd7854cb | 217 | .TP 5 |
1a18c85c | 218 | \fBListen *:\fIport\fR |
bd7854cb | 219 | .TP 5 |
1a18c85c MS |
220 | \fBListen \fI/path/to/domain/socket\fR |
221 | Listens to the specified address and port or domain socket path for connections. | |
222 | Multiple Listen directives can be provided to listen on multiple addresses. | |
223 | The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks. | |
bd7854cb | 224 | .TP 5 |
1a18c85c MS |
225 | \fBListenBackLog \fInumber\fR |
226 | Specifies the number of pending connections that will be allowed. | |
227 | This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections. | |
228 | When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones. | |
229 | The default is the OS-defined default limit, typically either "5" for older operating systems or "128" for newer operating systems. | |
bd7854cb | 230 | .TP 5 |
1a18c85c MS |
231 | \fB<Location \fI/path\fB> \fR... \fB</Location>\fR |
232 | Specifies access control for the named location. | |
233 | Paths are documented below in the section "LOCATION PATHS". | |
bd7854cb | 234 | .TP 5 |
1a18c85c MS |
235 | \fBLogDebugHistory \fInumber\fR |
236 | Specifies the number of debugging messages that are retained for logging if an error occurs in a print job. Debug messages are logged regardless of the LogLevel setting. | |
bd7854cb | 237 | .TP 5 |
1a18c85c | 238 | \fBLogLevel \fRnone |
bd7854cb | 239 | .TP 5 |
1a18c85c | 240 | \fBLogLevel \fRemerg |
ef416fc2 | 241 | .TP 5 |
1a18c85c | 242 | \fBLogLevel \fRalert |
4a4b4f99 | 243 | .TP 5 |
1a18c85c | 244 | \fBLogLevel \fRcrit |
bd7854cb | 245 | .TP 5 |
1a18c85c | 246 | \fBLogLevel \fRerror |
bd7854cb | 247 | .TP 5 |
1a18c85c | 248 | \fBLogLevel \fRwarn |
ef416fc2 | 249 | .TP 5 |
1a18c85c | 250 | \fBLogLevel \fRnotice |
b60086f8 | 251 | .TP 5 |
1a18c85c | 252 | \fBLogLevel \fRinfo |
b60086f8 | 253 | .TP 5 |
1a18c85c | 254 | \fBLogLevel \fRdebug |
b60086f8 | 255 | .TP 5 |
1a18c85c MS |
256 | \fBLogLevel \fRdebug2 |
257 | Specifies the level of logging for the ErrorLog file. | |
258 | The value "none" stops all logging while "debug2" logs everything. | |
259 | The default is "warn". | |
b60086f8 | 260 | .TP 5 |
1a18c85c | 261 | \fBLogTimeFormat \fRstandard |
ef416fc2 | 262 | .TP 5 |
1a18c85c MS |
263 | \fBLogTimeFormat \fRusecs |
264 | Specifies the format of the date and time in the log files. | |
265 | The value "standard" is the default and logs whole seconds while "usecs" logs microseconds. | |
ef416fc2 | 266 | .TP 5 |
1a18c85c MS |
267 | \fBMaxClients \fInumber\fR |
268 | Specifies the maximum number of simultaneous clients that are allowed by the scheduler. | |
269 | The default is "100". | |
dcb445bc | 270 | .TP 5 |
1a18c85c MS |
271 | \fBMaxClientsPerHost \fInumber\fR |
272 | Specifies the maximum number of simultaneous clients that are allowed from a | |
273 | single address. | |
274 | The default is the MaxClients value. | |
bd7854cb | 275 | .TP 5 |
1a18c85c MS |
276 | \fBMaxCopies \fInumber\fR |
277 | Specifies the maximum number of copies that a user can print of each job. | |
278 | The default is "9999". | |
279 | .TP 5 | |
280 | \fBMaxHoldTime \fIseconds\fR | |
281 | Specifies the maximum time a job may remain in the "indefinite" hold state before it is canceled. | |
282 | The default is "0" which disables cancellation of held jobs. | |
283 | .TP 5 | |
284 | \fBMaxJobs \fInumber\fR | |
285 | Specifies the maximum number of simultaneous jobs that are allowed. | |
286 | Set to "0" to allow an unlimited number of jobs. | |
287 | The default is "500". | |
288 | .TP 5 | |
289 | \fBMaxJobsPerPrinter \fInumber\fR | |
290 | Specifies the maximum number of simultaneous jobs that are allowed per printer. | |
291 | The default is "0" which allows up to MaxJobs jobs per printer. | |
292 | .TP 5 | |
293 | \fBMaxJobsPerUser \fInumber\fR | |
294 | Specifies the maximum number of simultaneous jobs that are allowed per user. | |
295 | The default is "0" which allows up to MaxJobs jobs per user. | |
296 | .TP 5 | |
297 | \fBMaxJobTime \fIseconds\fR | |
298 | Specifies the maximum time a job may take to print before it is canceled. | |
299 | Set to "0" to disable cancellation of "stuck" jobs. | |
300 | The default is "10800" (3 hours). | |
301 | .TP 5 | |
302 | \fBMaxLogSize \fIsize\fR | |
303 | Specifies the maximum size of the log files before they are rotated. | |
304 | The value "0" disables log rotation. | |
305 | The default is "1048576" (1MB). | |
306 | .TP 5 | |
307 | \fBMultipleOperationTimeout \fIseconds\fR | |
308 | Specifies the maximum amount of time to allow between files in a multiple file print job. | |
309 | The default is "300" (5 minutes). | |
310 | .TP 5 | |
311 | \fBPageLogFormat \fIformat-string\fR | |
312 | Specifies the format of PageLog lines. | |
313 | Sequences beginning with percent (%) characters are replaced with the corresponding information, while all other characters are copied literally. | |
314 | The following percent sequences are recognized: | |
315 | .nf | |
316 | ||
317 | "%%" inserts a single percent character. | |
318 | "%{name}" inserts the value of the specified IPP attribute. | |
319 | "%C" inserts the number of copies for the current page. | |
320 | "%P" inserts the current page number. | |
321 | "%T" inserts the current date and time in common log format. | |
322 | "%j" inserts the job ID. | |
323 | "%p" inserts the printer name. | |
324 | "%u" inserts the username. | |
325 | ||
326 | .fi | |
327 | The default is "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}". | |
328 | .TP 5 | |
329 | \fBPassEnv \fIvariable \fR[ ... \fIvariable \fR] | |
330 | Passes the specified environment variable(s) to child processes. | |
bd7854cb | 331 | .TP 5 |
1a18c85c MS |
332 | \fB<Policy \fIname\fB> \fR... \fB</Policy>\fR |
333 | Specifies access control for the named policy. | |
ef416fc2 | 334 | .TP 5 |
1a18c85c MS |
335 | \fBPort \fInumber\fR |
336 | Listens to the specified port number for connections. | |
ef416fc2 | 337 | .TP 5 |
1a18c85c | 338 | \fBPreserveJobFiles Yes\fR |
238c3832 | 339 | .TP 5 |
1a18c85c | 340 | \fBPreserveJobFiles No\fR |
10d09e33 | 341 | .TP 5 |
1a18c85c MS |
342 | \fBPreserveJobFiles \fIseconds\fR |
343 | Specifies whether job files (documents) are preserved after a job is printed. | |
344 | If a numeric value is specified, job files are preserved for the indicated number of seconds after printing. | |
345 | The default is "86400" (preserve 1 day). | |
10d09e33 | 346 | .TP 5 |
1a18c85c | 347 | \fBPreserveJobHistory Yes\fR |
10d09e33 | 348 | .TP 5 |
1a18c85c | 349 | \fBPreserveJobHistory No\fR |
10d09e33 | 350 | .TP 5 |
1a18c85c MS |
351 | \fBPreserveJobHistory \fIseconds\fR |
352 | Specifies whether the job history is preserved after a job is printed. | |
353 | If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing. | |
354 | If "Yes", the job history is preserved until the MaxJobs limit is reached. | |
355 | The default is "Yes". | |
10d09e33 | 356 | .TP 5 |
1a18c85c MS |
357 | \fBReloadTimeout \fIseconds\fR |
358 | Specifies the amount of time to wait for job completion before restarting the scheduler. | |
359 | The default is "30". | |
10d09e33 | 360 | .TP 5 |
1a18c85c MS |
361 | \fBRIPCache \fIsize\fR |
362 | Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer. | |
363 | The default is "128m". | |
10d09e33 | 364 | .TP 5 |
1a18c85c MS |
365 | \fBServerAdmin \fIemail-address\fR |
366 | Specifies the email address of the server administrator. | |
367 | The default value is "root@ServerName". | |
ef416fc2 | 368 | .TP 5 |
1a18c85c | 369 | \fBServerAlias \fIhostname \fR[ ... \fIhostname \fR] |
ef416fc2 | 370 | .TP 5 |
1a18c85c MS |
371 | \fBServerAlias *\fR |
372 | The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces. | |
373 | Using the special name "*" can expose your system to known browser-based DNS rebinding attacks, even when accessing sites through a firewall. | |
374 | If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using "*". | |
80ca4592 | 375 | .TP 5 |
1a18c85c MS |
376 | \fBServerName \fIhostname\fR |
377 | Specifies the fully-qualified hostname of the server. | |
378 | The default is the value reported by the | |
379 | .BR hostname (1) | |
380 | command. | |
ef416fc2 | 381 | .TP 5 |
1a18c85c | 382 | \fBServerTokens None\fR |
ef416fc2 | 383 | .TP 5 |
1a18c85c | 384 | \fBServerTokens ProductOnly\fR |
ef416fc2 | 385 | .TP 5 |
1a18c85c | 386 | \fBServerTokens Major\fR |
ef416fc2 | 387 | .TP 5 |
1a18c85c | 388 | \fBServerTokens Minor\fR |
ef416fc2 | 389 | .TP 5 |
1a18c85c | 390 | \fBServerTokens Minimal\fR |
ef416fc2 | 391 | .TP 5 |
1a18c85c | 392 | \fBServerTokens OS\fR |
bd7854cb | 393 | .TP 5 |
1a18c85c MS |
394 | \fBServerTokens Full\fR |
395 | Specifies what information is included in the Server header of HTTP responses. | |
396 | "None" disables the Server header. | |
397 | "ProductOnly" reports "CUPS". | |
398 | "Major" reports "CUPS 2". | |
399 | "Minor" reports "CUPS 2.0". | |
400 | "Minimal" reports "CUPS 2.0.0". | |
401 | "OS" reports "CUPS 2.0.0 (UNAME)" where UNAME is the output of the | |
402 | .BR uname (1) | |
403 | command. | |
404 | "Full" reports "CUPS 2.0.0 (UNAME) IPP/2.0". | |
405 | The default is "Minimal". | |
ed486911 | 406 | .TP 5 |
1a18c85c MS |
407 | \fBSetEnv \fIvariable value\fR |
408 | Set the specified environment variable to be passed to child processes. | |
ef416fc2 | 409 | .TP 5 |
ef416fc2 | 410 | .TP 5 |
1a18c85c | 411 | \fBSSLListen \fIipv4-address\fB:\fIport\fR |
178cb736 | 412 | .TP 5 |
1a18c85c | 413 | \fBSSLListen [\fIipv6-address\fB]:\fIport\fR |
bd7854cb | 414 | .TP 5 |
1a18c85c MS |
415 | \fBSSLListen *:\fIport\fR |
416 | Listens on the specified address and port for encrypted connections. | |
bd7854cb | 417 | .TP 5 |
1a18c85c MS |
418 | \fBSSLPort \fIport\fR |
419 | Listens on the specified port for encrypted connections. | |
bd7854cb | 420 | .TP 5 |
1a18c85c | 421 | \fBStrictConformance Yes\fR |
bd7854cb | 422 | .TP 5 |
1a18c85c MS |
423 | \fBStrictConformance No\fR |
424 | Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications. | |
425 | The default is "No". | |
bd7854cb | 426 | .TP 5 |
1a18c85c MS |
427 | \fBTimeout \fIseconds\fR |
428 | Specifies the HTTP request timeout. | |
429 | The default is "300" (5 minutes). | |
bd7854cb | 430 | .TP 5 |
1a18c85c | 431 | \fBWebInterface yes\fR |
bd7854cb | 432 | .TP 5 |
1a18c85c MS |
433 | \fBWebInterface no\fR |
434 | Specifies whether the web interface is enabled. | |
435 | The default is "No". | |
436 | .SS HTTP METHOD NAMES | |
437 | The following HTTP methods are supported by | |
438 | .BR cupsd (8): | |
bd7854cb | 439 | .TP 5 |
1a18c85c MS |
440 | GET |
441 | Used by a client to download icons and other printer resources and to access the CUPS web interface. | |
bd7854cb | 442 | .TP 5 |
1a18c85c MS |
443 | HEAD |
444 | Used by a client to get the type, size, and modification date of resources. | |
ef416fc2 | 445 | .TP 5 |
1a18c85c MS |
446 | OPTIONS |
447 | Used by a client to establish a secure (SSL/TLS) connection. | |
dfd5680b | 448 | .TP 5 |
1a18c85c MS |
449 | POST |
450 | Used by a client to submit IPP requests and HTML forms from the CUPS web interface. | |
dfd5680b | 451 | .TP 5 |
1a18c85c MS |
452 | PUT |
453 | Used by a client to upload configuration files. | |
454 | .SS IPP OPERATION NAMES | |
455 | The following IPP operations are supported by | |
456 | .BR cupsd (8): | |
ef416fc2 | 457 | .TP 5 |
1a18c85c MS |
458 | CUPS\-Accept\-Jobs |
459 | Allows a printer to accept new jobs. | |
ef416fc2 | 460 | .TP 5 |
1a18c85c MS |
461 | CUPS\-Add\-Modify\-Class |
462 | Adds or modifies a printer class. | |
ef416fc2 | 463 | .TP 5 |
1a18c85c MS |
464 | CUPS\-Add\-Modify\-Printer |
465 | Adds or modifies a printer. | |
3e7fe0ca | 466 | .TP 5 |
1a18c85c MS |
467 | CUPS\-Authenticate\-Job |
468 | Releases a job that is held for authentication. | |
ef416fc2 | 469 | .TP 5 |
1a18c85c MS |
470 | CUPS\-Delete\-Class |
471 | Deletes a printer class. | |
ef416fc2 | 472 | .TP 5 |
1a18c85c MS |
473 | CUPS\-Delete\-Printer |
474 | Deletes a printer. | |
ef416fc2 | 475 | .TP 5 |
1a18c85c MS |
476 | CUPS\-Get\-Classes |
477 | Gets a list of printer classes. | |
dcb445bc | 478 | .TP 5 |
1a18c85c MS |
479 | CUPS\-Get\-Default |
480 | Gets the server default printer or printer class. | |
ef416fc2 | 481 | .TP 5 |
1a18c85c MS |
482 | CUPS\-Get\-Devices |
483 | Gets a list of devices that are currently available. | |
ef416fc2 | 484 | .TP 5 |
1a18c85c MS |
485 | CUPS\-Get\-Document |
486 | Gets a document file for a job. | |
dfd5680b | 487 | .TP 5 |
1a18c85c MS |
488 | CUPS\-Get\-PPD |
489 | Gets a PPD file. | |
bd7854cb | 490 | .TP 5 |
1a18c85c MS |
491 | CUPS\-Get\-PPDs |
492 | Gets a list of installed PPD files. | |
ef416fc2 | 493 | .TP 5 |
1a18c85c MS |
494 | CUPS\-Get\-Printers |
495 | Gets a list of printers. | |
01ce6322 | 496 | .TP 5 |
1a18c85c MS |
497 | CUPS\-Move\-Job |
498 | Moves a job. | |
ef416fc2 | 499 | .TP 5 |
1a18c85c MS |
500 | CUPS\-Reject\-Jobs |
501 | Prevents a printer from accepting new jobs. | |
ef416fc2 | 502 | .TP 5 |
1a18c85c MS |
503 | CUPS\-Set\-Default |
504 | Sets the server default printer or printer class. | |
ef416fc2 | 505 | .TP 5 |
1a18c85c MS |
506 | Cancel\-Job |
507 | Cancels a job. | |
bd7854cb | 508 | .TP 5 |
1a18c85c MS |
509 | Cancel\-Jobs |
510 | Cancels one or more jobs. | |
ef416fc2 | 511 | .TP 5 |
1a18c85c MS |
512 | Cancel\-My\-Jobs |
513 | Cancels one or more jobs creates by a user. | |
bd7854cb | 514 | .TP 5 |
1a18c85c MS |
515 | Cancel\-Subscription |
516 | Cancels a subscription. | |
ef416fc2 | 517 | .TP 5 |
1a18c85c MS |
518 | Close\-Job |
519 | Closes a job that is waiting for more documents. | |
ef416fc2 | 520 | .TP 5 |
1a18c85c MS |
521 | Create\-Job |
522 | Creates a new job with no documents. | |
0af14961 | 523 | .TP 5 |
1a18c85c MS |
524 | Create\-Job\-Subscriptions |
525 | Creates a subscription for job events. | |
ef416fc2 | 526 | .TP 5 |
1a18c85c MS |
527 | Create\-Printer\-Subscriptions |
528 | Creates a subscription for printer events. | |
ef416fc2 | 529 | .TP 5 |
1a18c85c MS |
530 | Get\-Job\-Attributes |
531 | Gets information about a job. | |
bd7854cb | 532 | .TP 5 |
1a18c85c MS |
533 | Get\-Jobs |
534 | Gets a list of jobs. | |
bd7854cb | 535 | .TP 5 |
1a18c85c MS |
536 | Get\-Notifications |
537 | Gets a list of event notifications for a subscription. | |
ef416fc2 | 538 | .TP 5 |
1a18c85c MS |
539 | Get\-Printer\-Attributes |
540 | Gets information about a printer or printer class. | |
ef416fc2 | 541 | .TP 5 |
1a18c85c MS |
542 | Get\-Subscription\-Attributes |
543 | Gets information about a subscription. | |
ef416fc2 | 544 | .TP 5 |
1a18c85c MS |
545 | Get\-Subscriptions |
546 | Gets a list of subscriptions. | |
ef416fc2 | 547 | .TP 5 |
1a18c85c MS |
548 | Hold\-Job |
549 | Holds a job from printing. | |
ef416fc2 | 550 | .TP 5 |
1a18c85c MS |
551 | Hold\-New\-Jobs |
552 | Holds all new jobs from printing. | |
88f9aafc | 553 | .TP 5 |
1a18c85c MS |
554 | Pause\-Printer |
555 | Stops processing of jobs by a printer or printer class. | |
e07d4801 | 556 | .TP 5 |
1a18c85c MS |
557 | Pause\-Printer\-After\-Current\-Job |
558 | Stops processing of jobs by a printer or printer class after the current job is finished. | |
ef416fc2 | 559 | .TP 5 |
1a18c85c MS |
560 | Print\-Job |
561 | Creates a new job with a single document. | |
bd7854cb | 562 | .TP 5 |
1a18c85c MS |
563 | Purge\-Jobs |
564 | Cancels one or more jobs and deletes the job history. | |
bd7854cb | 565 | .TP 5 |
1a18c85c MS |
566 | Release\-Held\-New\-Jobs |
567 | Allows previously held jobs to print. | |
bd7854cb | 568 | .TP 5 |
1a18c85c MS |
569 | Release\-Job |
570 | Allows a job to print. | |
bd7854cb | 571 | .TP 5 |
1a18c85c MS |
572 | Renew\-Subscription |
573 | Renews a subscription. | |
bd7854cb | 574 | .TP 5 |
1a18c85c MS |
575 | Restart\-Job |
576 | Reprints a job, if possible. | |
bd7854cb | 577 | .TP 5 |
1a18c85c MS |
578 | Send\-Document |
579 | Adds a document to a job. | |
ef416fc2 | 580 | .TP 5 |
1a18c85c MS |
581 | Set\-Job\-Attributes |
582 | Changes job information. | |
ef416fc2 | 583 | .TP 5 |
1a18c85c MS |
584 | Set\-Printer\-Attributes |
585 | Changes printer or printer class information. | |
ef416fc2 | 586 | .TP 5 |
1a18c85c MS |
587 | Validate\-Job |
588 | Validates options for a new job. | |
589 | .SS LOCATION PATHS | |
590 | The following paths are commonly used when configuring | |
591 | .BR cupsd (8): | |
b19ccc9e | 592 | .TP 5 |
1a18c85c MS |
593 | / |
594 | The path for all get operations (get-printers, get-jobs, etc.) | |
b19ccc9e | 595 | .TP 5 |
1a18c85c MS |
596 | /admin |
597 | The path for all administration operations (add-printer, delete-printer, start-printer, etc.) | |
ef416fc2 | 598 | .TP 5 |
1a18c85c MS |
599 | /admin/conf |
600 | The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.) | |
a29fd7dd | 601 | .TP 5 |
1a18c85c MS |
602 | /admin/log |
603 | The path for access to the CUPS log files (access_log, error_log, page_log) | |
a29fd7dd | 604 | .TP 5 |
1a18c85c MS |
605 | /classes |
606 | The path for all printer classes | |
10d09e33 | 607 | .TP 5 |
1a18c85c MS |
608 | /classes/name |
609 | The resource for the named printer class | |
10d09e33 | 610 | .TP 5 |
1a18c85c MS |
611 | /jobs |
612 | The path for all jobs (hold-job, release-job, etc.) | |
10d09e33 | 613 | .TP 5 |
1a18c85c MS |
614 | /jobs/id |
615 | The path for the specified job. | |
10d09e33 | 616 | .TP 5 |
1a18c85c MS |
617 | /printers |
618 | The path for all printers | |
10d09e33 | 619 | .TP 5 |
1a18c85c MS |
620 | /printers/name |
621 | The path for the named printer | |
10d09e33 | 622 | .TP 5 |
1a18c85c MS |
623 | /printers/name.png |
624 | The icon file path for the named printer | |
10d09e33 | 625 | .TP 5 |
1a18c85c MS |
626 | /printers/name.ppd |
627 | The PPD file path for the named printer | |
628 | .SS DIRECTIVES VALID WITHIN LOCATION AND LIMIT SECTIONS | |
629 | The following directives may be placed inside Location and Limit sections in the \fBcupsd.conf\fR file: | |
ef416fc2 | 630 | .TP 5 |
1a18c85c | 631 | \fBAllow all\fR |
229681c1 | 632 | .TP 5 |
1a18c85c MS |
633 | \fBAllow none\fR |
634 | .TP 5 | |
635 | \fBAllow \fIhost.domain.com\fR | |
636 | .TP 5 | |
637 | \fBAllow *.\fIdomain.com\fR | |
638 | .TP 5 | |
639 | \fBAllow \fIipv4-address\fR | |
640 | .TP 5 | |
641 | \fBAllow \fIipv4-address\fB/\fInetmask\fR | |
642 | .TP 5 | |
643 | \fBAllow \fIipv4-address\fB/\fImm\fR | |
644 | .TP 5 | |
645 | \fBAllow [\fIipv6-address\fB]\fR | |
646 | .TP 5 | |
647 | \fBAllow [\fIipv6-address\fB]/\fImm\fR | |
648 | .TP 5 | |
649 | \fBAllow @IF(\fIname\fB)\fR | |
650 | .TP 5 | |
651 | \fBAllow @LOCAL\fR | |
652 | Allows access from the named hosts, domains, addresses, or interfaces. | |
653 | The Order directive controls whether Allow lines are evaluated before or after Deny lines. | |
654 | .TP 5 | |
655 | \fBAuthType None\fR | |
656 | .TP 5 | |
657 | \fBAuthType Basic\fR | |
658 | .TP 5 | |
659 | \fBAuthType Default\fR | |
660 | .TP 5 | |
661 | \fBAuthType Negotiate\fR | |
662 | Specifies the type of authentication required. | |
663 | The value "Default" corresponds to the DefaultAuthType value. | |
664 | .TP 5 | |
665 | \fBDeny all\fR | |
666 | .TP 5 | |
667 | \fBDeny none\fR | |
668 | .TP 5 | |
669 | \fBDeny \fIhost.domain.com\fR | |
670 | .TP 5 | |
671 | \fBDeny *.\fIdomain.com\fR | |
672 | .TP 5 | |
673 | \fBDeny \fIipv4-address\fR | |
674 | .TP 5 | |
675 | \fBDeny \fIipv4-address\fB/\fInetmask\fR | |
676 | .TP 5 | |
677 | \fBDeny \fIipv4-address\fB/\fImm\fR | |
678 | .TP 5 | |
679 | \fBDeny [\fIipv6-address\fB]\fR | |
680 | .TP 5 | |
681 | \fBDeny [\fIipv6-address\fB]/\fImm\fR | |
682 | .TP 5 | |
683 | \fBDeny @IF(\fIname\fB)\fR | |
684 | .TP 5 | |
685 | \fBDeny @LOCAL\fR | |
686 | Denies access from the named hosts, domains, addresses, or interfaces. | |
687 | The Order directive controls whether Deny lines are evaluated before or after Allow lines. | |
688 | .TP 5 | |
689 | \fBEncryption IfRequested\fR | |
690 | .TP 5 | |
691 | \fBEncryption Never\fR | |
692 | .TP 5 | |
693 | \fBEncryption Required\fR | |
694 | Specifies the level of encryption that is required for a particular location. | |
695 | The default value is "IfRequested". | |
696 | .TP 5 | |
697 | \fBOrder allow,deny\fR | |
698 | Specifies that access is denied by default. Allow lines are then processed followed by Deny lines to determine whether a client may access a particular resource. | |
699 | .TP 5 | |
700 | \fBOrder deny,allow\fR | |
701 | Specifies that access is allowed by default. Deny lines are then processed followed by Allow lines to determine whether a client may access a particular resource. | |
702 | .TP 5 | |
703 | \fBRequire group \fIgroup-name \fR[ \fIgroup-name \fR... ] | |
704 | Specifies that an authenticated user must be a member of one of the named groups. | |
705 | .TP 5 | |
706 | \fBRequire user {\fIuser-name\fR|\fB@\fIgroup-name\fR} ... | |
707 | Specifies that an authenticated user must match one of the named users or be a member of one of the named groups. | |
708 | The group name "@SYSTEM" corresponds to the list of groups defined by the SystemGroup directive in the | |
709 | .BR cups-files.conf (5) | |
710 | file. | |
711 | The group name "@OWNER" corresponds to the owner of the resource, for example the person that submitted a print job. | |
712 | .TP 5 | |
713 | \fBRequire valid-user\fR | |
714 | Specifies that any authenticated user is acceptable. | |
715 | .TP 5 | |
716 | \fBSatisfy all\fR | |
717 | Specifies that all Allow, AuthType, Deny, Order, and Require conditions must be satisfied to allow access. | |
718 | .TP 5 | |
719 | \fBSatisfy any\fR | |
720 | Specifies that any a client may access a resource if either the authentication (AuthType/Require) or address (Allow/Deny/Order) conditions are satisfied. | |
721 | For example, this can be used to require authentication only for remote accesses. | |
722 | .SS DIRECTIVES VALID WITHIN POLICY SECTIONS | |
723 | The following directives may be placed inside Policy sections in the \fBcupsd.conf\fR file: | |
724 | .TP 5 | |
725 | \fBJobPrivateAccess all\fR | |
726 | .TP 5 | |
727 | \fBJobPrivateAccess default\fR | |
728 | .TP 5 | |
729 | \fBJobPrivateAccess \fR{\fIuser\fR|\fB@\fIgroup\fR|\fB@ACL\fR|\fB@OWNER\fR|\fB@SYSTEM\fR} ... | |
730 | Specifies an access list for a job's private values. | |
731 | The "default" access list is "@OWNER @SYSTEM". | |
732 | "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. | |
733 | "@OWNER" maps to the job's owner. | |
734 | "@SYSTEM" maps to the groups listed for the SystemGroup directive in the | |
735 | .BR cups-files.conf (5) | |
736 | file. | |
737 | .TP 5 | |
738 | \fBJobPrivateValues all\fR | |
739 | .TP 5 | |
740 | \fBJobPrivateValues default\fR | |
741 | .TP 5 | |
742 | \fBJobPrivateValues none\fR | |
743 | .TP 5 | |
744 | \fBJobPrivateValues \fIattribute-name \fR[ ... \fIattribute-name \fR] | |
745 | Specifies the list of job values to make private. | |
746 | The "default" values are "job-name", "job-originating-host-name", "job-originating-user-name", and "phone". | |
747 | .TP 5 | |
748 | \fBSubscriptionPrivateAccess all\fR | |
749 | .TP 5 | |
750 | \fBSubscriptionPrivateAccess default\fR | |
751 | .TP 5 | |
752 | \fBSubscriptionPrivateAccess \fR{\fIuser\fR|\fB@\fIgroup\fR|\fB@ACL\fR|\fB@OWNER\fR|\fB@SYSTEM\fR} ... | |
753 | Specifies an access list for a subscription's private values. | |
754 | The "default" access list is "@OWNER @SYSTEM". | |
755 | "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. | |
756 | "@OWNER" maps to the job's owner. | |
757 | "@SYSTEM" maps to the groups listed for the SystemGroup directive in the | |
758 | .BR cups-files.conf (5) | |
759 | file. | |
760 | .TP 5 | |
761 | \fBSubscriptionPrivateValues all\fR | |
762 | .TP 5 | |
763 | \fBSubscriptionPrivateValues default\fR | |
764 | .TP 5 | |
765 | \fBSubscriptionPrivateValues none\fR | |
766 | .TP 5 | |
767 | \fBSubscriptionPrivateValues \fIattribute-name \fR[ ... \fIattribute-name \fR] | |
768 | Specifies the list of subscription values to make private. | |
769 | The "default" values are "notify-events", "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and "notify-user-data". | |
770 | .SH CONFORMING TO | |
771 | The \fBcupsd.conf\fR file format is based on the Apache HTTP Server configuration file format. | |
772 | .SH EXAMPLES | |
773 | Log everything with a maximum log file size of 32 megabytes: | |
774 | .nf | |
775 | ||
776 | AccessLogLevel all | |
777 | LogLevel debug2 | |
778 | MaxLogSize 32m | |
779 | ||
780 | .fi | |
781 | Require authentication for accesses from outside the 10. network: | |
782 | .nf | |
783 | ||
784 | <Location /> | |
785 | Order allow,deny | |
786 | Allow from 10./8 | |
787 | AuthType Basic | |
788 | Require valid-user | |
789 | Satisfy any | |
790 | </Location> | |
791 | .fi | |
ef416fc2 | 792 | .SH SEE ALSO |
1a18c85c MS |
793 | .BR classes.conf (5), |
794 | .BR cups-files.conf (5), | |
795 | .BR cupsd (8), | |
796 | .BR mime.convs (5), | |
797 | .BR mime.types (5), | |
798 | .BR printers.conf (5), | |
799 | .BR subscriptions.conf (5), | |
800 | CUPS Online Help (http://localhost:631/help) | |
ef416fc2 | 801 | .SH COPYRIGHT |
1a18c85c | 802 | Copyright \[co] 2007-2014 by Apple Inc. |
ef416fc2 | 803 | .\" |
1a18c85c | 804 | .\" End of "$Id: cupsd.conf.man.in 12059 2014-07-28 14:04:32Z msweet $". |
ef416fc2 | 805 | .\" |