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