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