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