]>
Commit | Line | Data |
---|---|---|
1a18c85c | 1 | <!DOCTYPE HTML> |
94436c5a MS |
2 | <html> |
3 | <!-- SECTION: Man Pages --> | |
4 | <head> | |
5 | <link rel="stylesheet" type="text/css" href="../cups-printable.css"> | |
6 | <title>cupsd.conf(5)</title> | |
7 | </head> | |
8 | <body> | |
9 | <h1 class="title">cupsd.conf(5)</h1> | |
10 | <h2 class="title"><a name="NAME">Name</a></h2> | |
11 | cupsd.conf - server configuration file for cups | |
12 | <h2 class="title"><a name="DESCRIPTION">Description</a></h2> | |
1a18c85c MS |
13 | The |
14 | <i>cupsd.conf</i> | |
15 | file configures the CUPS scheduler, | |
16 | <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a> | |
17 | It is normally located in the | |
18 | <i>/etc/cups</i> | |
19 | directory. | |
20 | <b>Note:</b> File, directory, and user configuration directives that used to be allowed in the <b>cupsd.conf</b> file are now stored in the | |
21 | <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a> | |
22 | file instead in order to prevent certain types of privilege escalation attacks. | |
23 | <p>Each line in the file can be a configuration directive, a blank line, or a comment. | |
24 | Configuration directives typically consist of a name and zero or more values separated by whitespace. | |
25 | The configuration directive name and values are case-insensitive. | |
26 | Comment lines start with the # character. | |
27 | <h3><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h3> | |
28 | The following top-level directives are understood by | |
29 | <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a> | |
30 | <dl class="man"> | |
31 | <dt><b>AccessLogLevel config</b> | |
32 | <dd style="margin-left: 5.0em"><dt><b>AccessLogLevel actions</b> | |
33 | <dd style="margin-left: 5.0em"><dt><b>AccessLogLevel all</b> | |
34 | <dd style="margin-left: 5.0em">Specifies the logging level for the AccessLog file. | |
35 | The "config" level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated. | |
36 | The "actions" level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for "config". | |
37 | The "all" level logs all requests. | |
38 | The default access log level is "actions". | |
39 | <dt><b>AutoPurgeJobs Yes</b> | |
40 | <dd style="margin-left: 5.0em"><dt><b>AutoPurgeJobs No</b> | |
41 | <dd style="margin-left: 5.0em"><br> | |
42 | Specifies whether to purge job history data automatically when it is no longer required for quotas. | |
43 | The default is "No". | |
44 | <dt><b>BrowseLocalProtocols all</b> | |
45 | <dd style="margin-left: 5.0em"><dt><b>BrowseLocalProtocols dnssd</b> | |
46 | <dd style="margin-left: 5.0em"><dt><b>BrowseLocalProtocols none</b> | |
47 | <dd style="margin-left: 5.0em">Specifies which protocols to use for local printer sharing. | |
48 | The default is "dnssd" on systems that support Bonjour and "none" otherwise. | |
49 | <dt><b>BrowseWebIF Yes</b> | |
50 | <dd style="margin-left: 5.0em"><dt><b>BrowseWebIF No</b> | |
51 | <dd style="margin-left: 5.0em"><br> | |
52 | Specifies whether the CUPS web interface is advertised. | |
53 | The default is "No". | |
54 | <dt><b>Browsing Yes</b> | |
55 | <dd style="margin-left: 5.0em"><dt><b>Browsing No</b> | |
56 | <dd style="margin-left: 5.0em"><br> | |
57 | Specifies whether shared printers are advertised. | |
58 | The default is "No". | |
59 | <dt><b>Classification </b><i>banner</i> | |
60 | <dd style="margin-left: 5.0em"><br> | |
61 | Specifies the security classification of the server. | |
62 | 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. | |
63 | The default is no classification banner. | |
64 | <dt><b>ClassifyOverride Yes</b> | |
65 | <dd style="margin-left: 5.0em"><dt><b>ClassifyOverride No</b> | |
66 | <dd style="margin-left: 5.0em"><br> | |
67 | Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option. | |
68 | The default is "No". | |
69 | <dt><b>DefaultAuthType Basic</b> | |
70 | <dd style="margin-left: 5.0em"><dt><b>DefaultAuthType Negotiate</b> | |
71 | <dd style="margin-left: 5.0em"><br> | |
72 | Specifies the default type of authentication to use. | |
73 | The default is "Basic". | |
74 | <dt><b>DefaultEncryption Never</b> | |
75 | <dd style="margin-left: 5.0em"><dt><b>DefaultEncryption IfRequested</b> | |
76 | <dd style="margin-left: 5.0em"><dt><b>DefaultEncryption Required</b> | |
77 | <dd style="margin-left: 5.0em">Specifies whether encryption will be used for authenticated requests. | |
78 | The default is "Required". | |
79 | <dt><b>DefaultLanguage </b><i>locale</i> | |
80 | <dd style="margin-left: 5.0em">Specifies the default language to use for text and web content. | |
81 | The default is "en". | |
82 | <dt><b>DefaultPaperSize Auto</b> | |
83 | <dd style="margin-left: 5.0em"><dt><b>DefaultPaperSize None</b> | |
84 | <dd style="margin-left: 5.0em"><dt><b>DefaultPaperSize </b><i>sizename</i> | |
85 | <dd style="margin-left: 5.0em">Specifies the default paper size for new print queues. "Auto" uses a locale-specific default, while "None" specifies there is no default paper size. | |
86 | Specific size names are typically "Letter" or "A4". | |
87 | The default is "Auto". | |
88 | <dt><b>DefaultPolicy </b><i>policy-name</i> | |
89 | <dd style="margin-left: 5.0em">Specifies the default access policy to use. | |
90 | The default access policy is "default". | |
91 | <dt><b>DefaultShared Yes</b> | |
92 | <dd style="margin-left: 5.0em"><dt><b>DefaultShared No</b> | |
93 | <dd style="margin-left: 5.0em">Specifies whether local printers are shared by default. | |
94 | The default is "Yes". | |
95 | <dt><b>DirtyCleanInterval </b><i>seconds</i> | |
96 | <dd style="margin-left: 5.0em">Specifies the delay for updating of configuration and state files. | |
97 | A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds. | |
98 | The default value is "30". | |
99 | <dt><b>ErrorPolicy abort-job</b> | |
100 | <dd style="margin-left: 5.0em">Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer. | |
101 | <dt><b>ErrorPolicy retry-job</b> | |
102 | <dd style="margin-left: 5.0em">Specifies that a failed print job should be retried at a later time unless otherwise specified for the printer. | |
103 | <dt><b>ErrorPolicy retry-this-job</b> | |
104 | <dd style="margin-left: 5.0em">Specifies that a failed print job should be retried immediately unless otherwise specified for the printer. | |
105 | <dt><b>ErrorPolicy stop-printer</b> | |
106 | <dd style="margin-left: 5.0em">Specifies that a failed print job should stop the printer unless otherwise specified for the printer. The 'stop-printer' error policy is the default. | |
107 | <dt><b>FilterLimit </b><i>limit</i> | |
108 | <dd style="margin-left: 5.0em">Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems. | |
109 | A limit of 0 disables filter limiting. | |
110 | An average print to a non-PostScript printer needs a filter limit of about 200. | |
111 | A PostScript printer needs about half that (100). | |
112 | Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time. | |
113 | The default limit is "0". | |
114 | <dt><b>FilterNice </b><i>nice-value</i> | |
115 | <dd style="margin-left: 5.0em">Specifies the scheduling priority ( | |
116 | <b>nice</b>(8) | |
117 | value) of filters that are run to print a job. | |
118 | The nice value ranges from 0, the highest priority, to 19, the lowest priority. | |
119 | The default is 0. | |
120 | <dt><b>GSSServiceName </b><i>name</i> | |
121 | <dd style="margin-left: 5.0em">Specifies the service name when using Kerberos authentication. | |
122 | The default service name is "http." | |
123 | <dt><b>HostNameLookups On</b> | |
124 | <dd style="margin-left: 5.0em"><dt><b>HostNameLookups Off</b> | |
125 | <dd style="margin-left: 5.0em"><dt><b>HostNameLookups Double</b> | |
126 | <dd style="margin-left: 5.0em">Specifies whether to do reverse lookups on connecting clients. | |
127 | The "Double" setting causes | |
128 | <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a> | |
129 | to verify that the hostname resolved from the address matches one of the addresses returned for that hostname. | |
130 | Double lookups also prevent clients with unregistered addresses from connecting to your server. | |
131 | The default is "Off" to avoid the potential server performance problems with hostname lookups. | |
132 | Only set this option to "On" or "Double" if absolutely required. | |
133 | <dt><b>JobKillDelay </b><i>seconds</i> | |
134 | <dd style="margin-left: 5.0em">Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job. | |
135 | The default is "30". | |
136 | <dt><b>JobRetryInterval </b><i>seconds</i> | |
137 | <dd style="margin-left: 5.0em">Specifies the interval between retries of jobs in seconds. | |
138 | 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". | |
139 | The default is "30". | |
140 | <dt><b>JobRetryLimit </b><i>count</i> | |
141 | <dd style="margin-left: 5.0em">Specifies the number of retries that are done for jobs. | |
142 | 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". | |
143 | The default is "5". | |
144 | <dt><b>KeepAlive Yes</b> | |
145 | <dd style="margin-left: 5.0em"><dt><b>KeepAlive No</b> | |
146 | <dd style="margin-left: 5.0em">Specifies whether to support HTTP keep-alive connections. | |
147 | The default is "Yes". | |
148 | <dt><b>KeepAliveTimeout </b><i>seconds</i> | |
149 | <dd style="margin-left: 5.0em">Specifies how long an idle client connection remains open. | |
150 | The default is "30". | |
151 | <dt><b><Limit </b><i>operation </i>...<b>> </b>... <b></Limit></b> | |
152 | <dd style="margin-left: 5.0em">Specifies the IPP operations that are being limited inside a Policy section. IPP operation names are listed below in the section "IPP OPERATIONS". | |
153 | <dt><b><Limit </b><i>method </i>...<b>> </b>... <b></Limit></b> | |
154 | <dd style="margin-left: 5.0em"><dt><b><LimitExcept </b><i>method </i>...<b>> </b>... <b></LimitExcept></b> | |
155 | <dd style="margin-left: 5.0em">Specifies the HTTP methods that are being limited inside a Location section. HTTP method names are listed below in the section "HTTP METHODS". | |
156 | <dt><b>LimitRequestBody </b><i>size</i> | |
157 | <dd style="margin-left: 5.0em">Specifies the maximum size of print files, IPP requests, and HTML form data. | |
158 | The default is "0" which disables the limit check. | |
159 | <dt><b>Listen </b><i>ipv4-address</i><b>:</b><i>port</i> | |
160 | <dd style="margin-left: 5.0em"><dt><b>Listen [</b><i>ipv6-address</i><b>]:</b><i>port</i> | |
161 | <dd style="margin-left: 5.0em"><dt><b>Listen *:</b><i>port</i> | |
162 | <dd style="margin-left: 5.0em"><dt><b>Listen </b><i>/path/to/domain/socket</i> | |
163 | <dd style="margin-left: 5.0em">Listens to the specified address and port or domain socket path for connections. | |
164 | Multiple Listen directives can be provided to listen on multiple addresses. | |
165 | The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks. | |
166 | <dt><b>ListenBackLog </b><i>number</i> | |
167 | <dd style="margin-left: 5.0em">Specifies the number of pending connections that will be allowed. | |
168 | This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections. | |
169 | When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones. | |
170 | The default is the OS-defined default limit, typically either "5" for older operating systems or "128" for newer operating systems. | |
171 | <dt><b><Location </b><i>/path</i><b>> </b>... <b></Location></b> | |
172 | <dd style="margin-left: 5.0em">Specifies access control for the named location. | |
173 | Paths are documented below in the section "LOCATION PATHS". | |
174 | <dt><b>LogDebugHistory </b><i>number</i> | |
175 | <dd style="margin-left: 5.0em">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. | |
176 | <dt><b>LogLevel </b>none | |
177 | <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>emerg | |
178 | <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>alert | |
179 | <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>crit | |
180 | <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>error | |
181 | <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>warn | |
182 | <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>notice | |
183 | <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>info | |
184 | <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>debug | |
185 | <dd style="margin-left: 5.0em"><dt><b>LogLevel </b>debug2 | |
186 | <dd style="margin-left: 5.0em">Specifies the level of logging for the ErrorLog file. | |
187 | The value "none" stops all logging while "debug2" logs everything. | |
188 | The default is "warn". | |
189 | <dt><b>LogTimeFormat </b>standard | |
190 | <dd style="margin-left: 5.0em"><dt><b>LogTimeFormat </b>usecs | |
191 | <dd style="margin-left: 5.0em">Specifies the format of the date and time in the log files. | |
192 | The value "standard" is the default and logs whole seconds while "usecs" logs microseconds. | |
193 | <dt><b>MaxClients </b><i>number</i> | |
194 | <dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients that are allowed by the scheduler. | |
195 | The default is "100". | |
196 | <dt><b>MaxClientsPerHost </b><i>number</i> | |
197 | <dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients that are allowed from a | |
94436c5a | 198 | single address. |
1a18c85c MS |
199 | The default is the MaxClients value. |
200 | <dt><b>MaxCopies </b><i>number</i> | |
201 | <dd style="margin-left: 5.0em">Specifies the maximum number of copies that a user can print of each job. | |
202 | The default is "9999". | |
203 | <dt><b>MaxHoldTime </b><i>seconds</i> | |
204 | <dd style="margin-left: 5.0em">Specifies the maximum time a job may remain in the "indefinite" hold state before it is canceled. | |
205 | The default is "0" which disables cancellation of held jobs. | |
206 | <dt><b>MaxJobs </b><i>number</i> | |
207 | <dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs that are allowed. | |
208 | Set to "0" to allow an unlimited number of jobs. | |
209 | The default is "500". | |
210 | <dt><b>MaxJobsPerPrinter </b><i>number</i> | |
211 | <dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs that are allowed per printer. | |
212 | The default is "0" which allows up to MaxJobs jobs per printer. | |
213 | <dt><b>MaxJobsPerUser </b><i>number</i> | |
214 | <dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs that are allowed per user. | |
215 | The default is "0" which allows up to MaxJobs jobs per user. | |
216 | <dt><b>MaxJobTime </b><i>seconds</i> | |
217 | <dd style="margin-left: 5.0em">Specifies the maximum time a job may take to print before it is canceled. | |
218 | Set to "0" to disable cancellation of "stuck" jobs. | |
219 | The default is "10800" (3 hours). | |
220 | <dt><b>MaxLogSize </b><i>size</i> | |
221 | <dd style="margin-left: 5.0em">Specifies the maximum size of the log files before they are rotated. | |
222 | The value "0" disables log rotation. | |
223 | The default is "1048576" (1MB). | |
224 | <dt><b>MultipleOperationTimeout </b><i>seconds</i> | |
225 | <dd style="margin-left: 5.0em">Specifies the maximum amount of time to allow between files in a multiple file print job. | |
226 | The default is "300" (5 minutes). | |
227 | <dt><b>PageLogFormat </b><i>format-string</i> | |
228 | <dd style="margin-left: 5.0em">Specifies the format of PageLog lines. | |
229 | Sequences beginning with percent (%) characters are replaced with the corresponding information, while all other characters are copied literally. | |
230 | The following percent sequences are recognized: | |
231 | <pre class="man"> | |
232 | ||
233 | "%%" inserts a single percent character. | |
234 | "%{name}" inserts the value of the specified IPP attribute. | |
235 | "%C" inserts the number of copies for the current page. | |
236 | "%P" inserts the current page number. | |
237 | "%T" inserts the current date and time in common log format. | |
238 | "%j" inserts the job ID. | |
239 | "%p" inserts the printer name. | |
240 | "%u" inserts the username. | |
241 | ||
242 | </pre> | |
243 | The default is "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}". | |
244 | <dt><b>PassEnv </b><i>variable </i>[ ... <i>variable </i>] | |
245 | <dd style="margin-left: 5.0em">Passes the specified environment variable(s) to child processes. | |
246 | <dt><b><Policy </b><i>name</i><b>> </b>... <b></Policy></b> | |
247 | <dd style="margin-left: 5.0em">Specifies access control for the named policy. | |
248 | <dt><b>Port </b><i>number</i> | |
249 | <dd style="margin-left: 5.0em">Listens to the specified port number for connections. | |
250 | <dt><b>PreserveJobFiles Yes</b> | |
251 | <dd style="margin-left: 5.0em"><dt><b>PreserveJobFiles No</b> | |
252 | <dd style="margin-left: 5.0em"><dt><b>PreserveJobFiles </b><i>seconds</i> | |
253 | <dd style="margin-left: 5.0em">Specifies whether job files (documents) are preserved after a job is printed. | |
254 | If a numeric value is specified, job files are preserved for the indicated number of seconds after printing. | |
255 | The default is "86400" (preserve 1 day). | |
256 | <dt><b>PreserveJobHistory Yes</b> | |
257 | <dd style="margin-left: 5.0em"><dt><b>PreserveJobHistory No</b> | |
258 | <dd style="margin-left: 5.0em"><dt><b>PreserveJobHistory </b><i>seconds</i> | |
259 | <dd style="margin-left: 5.0em">Specifies whether the job history is preserved after a job is printed. | |
260 | If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing. | |
261 | If "Yes", the job history is preserved until the MaxJobs limit is reached. | |
262 | The default is "Yes". | |
263 | <dt><b>ReloadTimeout </b><i>seconds</i> | |
264 | <dd style="margin-left: 5.0em">Specifies the amount of time to wait for job completion before restarting the scheduler. | |
265 | The default is "30". | |
266 | <dt><b>RIPCache </b><i>size</i> | |
267 | <dd style="margin-left: 5.0em">Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer. | |
268 | The default is "128m". | |
269 | <dt><b>ServerAdmin </b><i>email-address</i> | |
270 | <dd style="margin-left: 5.0em">Specifies the email address of the server administrator. | |
271 | The default value is "root@ServerName". | |
272 | <dt><b>ServerAlias </b><i>hostname </i>[ ... <i>hostname </i>] | |
273 | <dd style="margin-left: 5.0em"><dt><b>ServerAlias *</b> | |
274 | <dd style="margin-left: 5.0em">The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces. | |
275 | Using the special name "*" can expose your system to known browser-based DNS rebinding attacks, even when accessing sites through a firewall. | |
276 | If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using "*". | |
277 | <dt><b>ServerName </b><i>hostname</i> | |
278 | <dd style="margin-left: 5.0em">Specifies the fully-qualified hostname of the server. | |
279 | The default is the value reported by the | |
280 | <b>hostname</b>(1) | |
281 | command. | |
282 | <dt><b>ServerTokens None</b> | |
283 | <dd style="margin-left: 5.0em"><dt><b>ServerTokens ProductOnly</b> | |
284 | <dd style="margin-left: 5.0em"><dt><b>ServerTokens Major</b> | |
285 | <dd style="margin-left: 5.0em"><dt><b>ServerTokens Minor</b> | |
286 | <dd style="margin-left: 5.0em"><dt><b>ServerTokens Minimal</b> | |
287 | <dd style="margin-left: 5.0em"><dt><b>ServerTokens OS</b> | |
288 | <dd style="margin-left: 5.0em"><dt><b>ServerTokens Full</b> | |
289 | <dd style="margin-left: 5.0em">Specifies what information is included in the Server header of HTTP responses. | |
290 | "None" disables the Server header. | |
291 | "ProductOnly" reports "CUPS". | |
292 | "Major" reports "CUPS 2". | |
293 | "Minor" reports "CUPS 2.0". | |
294 | "Minimal" reports "CUPS 2.0.0". | |
295 | "OS" reports "CUPS 2.0.0 (UNAME)" where UNAME is the output of the | |
296 | <b>uname</b>(1) | |
297 | command. | |
298 | "Full" reports "CUPS 2.0.0 (UNAME) IPP/2.0". | |
299 | The default is "Minimal". | |
300 | <dt><b>SetEnv </b><i>variable value</i> | |
301 | <dd style="margin-left: 5.0em">Set the specified environment variable to be passed to child processes. | |
302 | <dt><dt><b>SSLListen </b><i>ipv4-address</i><b>:</b><i>port</i> | |
303 | <dd style="margin-left: 5.0em"><dt><b>SSLListen [</b><i>ipv6-address</i><b>]:</b><i>port</i> | |
304 | <dd style="margin-left: 5.0em"><dt><b>SSLListen *:</b><i>port</i> | |
305 | <dd style="margin-left: 5.0em">Listens on the specified address and port for encrypted connections. | |
86243a75 MS |
306 | <dt><b>SSLOptions </b>[<i>AllowRC4</i>] [<i>AllowSSL3</i>] |
307 | <dd style="margin-left: 5.0em"><dt><b>SSLOptions None</b> | |
308 | <dd style="margin-left: 5.0em">Sets encryption options. | |
309 | By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites. | |
310 | The <i>AllowRC4</i> option enables the 128-bit RC4 cipher suites, which are required for some older clients that do not implement newer ones. | |
311 | The <i>AllowSSL3</i> option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0. | |
1a18c85c MS |
312 | <dt><b>SSLPort </b><i>port</i> |
313 | <dd style="margin-left: 5.0em">Listens on the specified port for encrypted connections. | |
314 | <dt><b>StrictConformance Yes</b> | |
315 | <dd style="margin-left: 5.0em"><dt><b>StrictConformance No</b> | |
316 | <dd style="margin-left: 5.0em">Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications. | |
317 | The default is "No". | |
318 | <dt><b>Timeout </b><i>seconds</i> | |
319 | <dd style="margin-left: 5.0em">Specifies the HTTP request timeout. | |
320 | The default is "300" (5 minutes). | |
321 | <dt><b>WebInterface yes</b> | |
322 | <dd style="margin-left: 5.0em"><dt><b>WebInterface no</b> | |
323 | <dd style="margin-left: 5.0em">Specifies whether the web interface is enabled. | |
324 | The default is "No". | |
325 | </dl> | |
326 | <h3><a name="HTTP_METHOD_NAMES">Http Method Names</a></h3> | |
327 | The following HTTP methods are supported by | |
328 | <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a> | |
329 | <dl class="man"> | |
330 | <dt>GET | |
331 | <dd style="margin-left: 5.0em">Used by a client to download icons and other printer resources and to access the CUPS web interface. | |
332 | <dt>HEAD | |
333 | <dd style="margin-left: 5.0em">Used by a client to get the type, size, and modification date of resources. | |
334 | <dt>OPTIONS | |
335 | <dd style="margin-left: 5.0em">Used by a client to establish a secure (SSL/TLS) connection. | |
336 | <dt>POST | |
337 | <dd style="margin-left: 5.0em">Used by a client to submit IPP requests and HTML forms from the CUPS web interface. | |
338 | <dt>PUT | |
339 | <dd style="margin-left: 5.0em">Used by a client to upload configuration files. | |
340 | </dl> | |
341 | <h3><a name="IPP_OPERATION_NAMES">Ipp Operation Names</a></h3> | |
342 | The following IPP operations are supported by | |
343 | <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a> | |
344 | <dl class="man"> | |
345 | <dt>CUPS-Accept-Jobs | |
346 | <dd style="margin-left: 5.0em">Allows a printer to accept new jobs. | |
347 | <dt>CUPS-Add-Modify-Class | |
348 | <dd style="margin-left: 5.0em">Adds or modifies a printer class. | |
349 | <dt>CUPS-Add-Modify-Printer | |
350 | <dd style="margin-left: 5.0em">Adds or modifies a printer. | |
351 | <dt>CUPS-Authenticate-Job | |
352 | <dd style="margin-left: 5.0em">Releases a job that is held for authentication. | |
353 | <dt>CUPS-Delete-Class | |
354 | <dd style="margin-left: 5.0em">Deletes a printer class. | |
355 | <dt>CUPS-Delete-Printer | |
356 | <dd style="margin-left: 5.0em">Deletes a printer. | |
357 | <dt>CUPS-Get-Classes | |
358 | <dd style="margin-left: 5.0em">Gets a list of printer classes. | |
359 | <dt>CUPS-Get-Default | |
360 | <dd style="margin-left: 5.0em">Gets the server default printer or printer class. | |
361 | <dt>CUPS-Get-Devices | |
362 | <dd style="margin-left: 5.0em">Gets a list of devices that are currently available. | |
363 | <dt>CUPS-Get-Document | |
364 | <dd style="margin-left: 5.0em">Gets a document file for a job. | |
365 | <dt>CUPS-Get-PPD | |
366 | <dd style="margin-left: 5.0em">Gets a PPD file. | |
367 | <dt>CUPS-Get-PPDs | |
368 | <dd style="margin-left: 5.0em">Gets a list of installed PPD files. | |
369 | <dt>CUPS-Get-Printers | |
370 | <dd style="margin-left: 5.0em">Gets a list of printers. | |
371 | <dt>CUPS-Move-Job | |
372 | <dd style="margin-left: 5.0em">Moves a job. | |
373 | <dt>CUPS-Reject-Jobs | |
374 | <dd style="margin-left: 5.0em">Prevents a printer from accepting new jobs. | |
375 | <dt>CUPS-Set-Default | |
376 | <dd style="margin-left: 5.0em">Sets the server default printer or printer class. | |
377 | <dt>Cancel-Job | |
378 | <dd style="margin-left: 5.0em">Cancels a job. | |
379 | <dt>Cancel-Jobs | |
380 | <dd style="margin-left: 5.0em">Cancels one or more jobs. | |
381 | <dt>Cancel-My-Jobs | |
382 | <dd style="margin-left: 5.0em">Cancels one or more jobs creates by a user. | |
383 | <dt>Cancel-Subscription | |
384 | <dd style="margin-left: 5.0em">Cancels a subscription. | |
385 | <dt>Close-Job | |
386 | <dd style="margin-left: 5.0em">Closes a job that is waiting for more documents. | |
387 | <dt>Create-Job | |
388 | <dd style="margin-left: 5.0em">Creates a new job with no documents. | |
389 | <dt>Create-Job-Subscriptions | |
390 | <dd style="margin-left: 5.0em">Creates a subscription for job events. | |
391 | <dt>Create-Printer-Subscriptions | |
392 | <dd style="margin-left: 5.0em">Creates a subscription for printer events. | |
393 | <dt>Get-Job-Attributes | |
394 | <dd style="margin-left: 5.0em">Gets information about a job. | |
395 | <dt>Get-Jobs | |
396 | <dd style="margin-left: 5.0em">Gets a list of jobs. | |
397 | <dt>Get-Notifications | |
398 | <dd style="margin-left: 5.0em">Gets a list of event notifications for a subscription. | |
399 | <dt>Get-Printer-Attributes | |
400 | <dd style="margin-left: 5.0em">Gets information about a printer or printer class. | |
401 | <dt>Get-Subscription-Attributes | |
402 | <dd style="margin-left: 5.0em">Gets information about a subscription. | |
403 | <dt>Get-Subscriptions | |
404 | <dd style="margin-left: 5.0em">Gets a list of subscriptions. | |
405 | <dt>Hold-Job | |
406 | <dd style="margin-left: 5.0em">Holds a job from printing. | |
407 | <dt>Hold-New-Jobs | |
408 | <dd style="margin-left: 5.0em">Holds all new jobs from printing. | |
409 | <dt>Pause-Printer | |
410 | <dd style="margin-left: 5.0em">Stops processing of jobs by a printer or printer class. | |
411 | <dt>Pause-Printer-After-Current-Job | |
412 | <dd style="margin-left: 5.0em">Stops processing of jobs by a printer or printer class after the current job is finished. | |
413 | <dt>Print-Job | |
414 | <dd style="margin-left: 5.0em">Creates a new job with a single document. | |
415 | <dt>Purge-Jobs | |
416 | <dd style="margin-left: 5.0em">Cancels one or more jobs and deletes the job history. | |
417 | <dt>Release-Held-New-Jobs | |
418 | <dd style="margin-left: 5.0em">Allows previously held jobs to print. | |
419 | <dt>Release-Job | |
420 | <dd style="margin-left: 5.0em">Allows a job to print. | |
421 | <dt>Renew-Subscription | |
422 | <dd style="margin-left: 5.0em">Renews a subscription. | |
423 | <dt>Restart-Job | |
424 | <dd style="margin-left: 5.0em">Reprints a job, if possible. | |
425 | <dt>Send-Document | |
426 | <dd style="margin-left: 5.0em">Adds a document to a job. | |
427 | <dt>Set-Job-Attributes | |
428 | <dd style="margin-left: 5.0em">Changes job information. | |
429 | <dt>Set-Printer-Attributes | |
430 | <dd style="margin-left: 5.0em">Changes printer or printer class information. | |
431 | <dt>Validate-Job | |
432 | <dd style="margin-left: 5.0em">Validates options for a new job. | |
433 | </dl> | |
434 | <h3><a name="LOCATION_PATHS">Location Paths</a></h3> | |
435 | The following paths are commonly used when configuring | |
436 | <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a> | |
437 | <dl class="man"> | |
438 | <dt>/ | |
439 | <dd style="margin-left: 5.0em">The path for all get operations (get-printers, get-jobs, etc.) | |
440 | <dt>/admin | |
441 | <dd style="margin-left: 5.0em">The path for all administration operations (add-printer, delete-printer, start-printer, etc.) | |
442 | <dt>/admin/conf | |
443 | <dd style="margin-left: 5.0em">The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.) | |
444 | <dt>/admin/log | |
445 | <dd style="margin-left: 5.0em">The path for access to the CUPS log files (access_log, error_log, page_log) | |
446 | <dt>/classes | |
447 | <dd style="margin-left: 5.0em">The path for all printer classes | |
448 | <dt>/classes/name | |
449 | <dd style="margin-left: 5.0em">The resource for the named printer class | |
450 | <dt>/jobs | |
451 | <dd style="margin-left: 5.0em">The path for all jobs (hold-job, release-job, etc.) | |
452 | <dt>/jobs/id | |
453 | <dd style="margin-left: 5.0em">The path for the specified job. | |
454 | <dt>/printers | |
455 | <dd style="margin-left: 5.0em">The path for all printers | |
456 | <dt>/printers/name | |
457 | <dd style="margin-left: 5.0em">The path for the named printer | |
458 | <dt>/printers/name.png | |
459 | <dd style="margin-left: 5.0em">The icon file path for the named printer | |
460 | <dt>/printers/name.ppd | |
461 | <dd style="margin-left: 5.0em">The PPD file path for the named printer | |
94436c5a | 462 | </dl> |
1a18c85c MS |
463 | <h3><a name="DIRECTIVES_VALID_WITHIN_LOCATION_AND_LIMIT_SECTIONS">Directives Valid Within Location And Limit Sections</a></h3> |
464 | The following directives may be placed inside Location and Limit sections in the <b>cupsd.conf</b> file: | |
465 | <dl class="man"> | |
466 | <dt><b>Allow all</b> | |
467 | <dd style="margin-left: 5.0em"><dt><b>Allow none</b> | |
468 | <dd style="margin-left: 5.0em"><dt><b>Allow </b><i>host.domain.com</i> | |
469 | <dd style="margin-left: 5.0em"><dt><b>Allow *.</b><i>domain.com</i> | |
470 | <dd style="margin-left: 5.0em"><dt><b>Allow </b><i>ipv4-address</i> | |
471 | <dd style="margin-left: 5.0em"><dt><b>Allow </b><i>ipv4-address</i><b>/</b><i>netmask</i> | |
472 | <dd style="margin-left: 5.0em"><dt><b>Allow </b><i>ipv4-address</i><b>/</b><i>mm</i> | |
473 | <dd style="margin-left: 5.0em"><dt><b>Allow [</b><i>ipv6-address</i><b>]</b> | |
474 | <dd style="margin-left: 5.0em"><dt><b>Allow [</b><i>ipv6-address</i><b>]/</b><i>mm</i> | |
475 | <dd style="margin-left: 5.0em"><dt><b>Allow @IF(</b><i>name</i><b>)</b> | |
476 | <dd style="margin-left: 5.0em"><dt><b>Allow @LOCAL</b> | |
477 | <dd style="margin-left: 5.0em">Allows access from the named hosts, domains, addresses, or interfaces. | |
478 | The Order directive controls whether Allow lines are evaluated before or after Deny lines. | |
479 | <dt><b>AuthType None</b> | |
480 | <dd style="margin-left: 5.0em"><dt><b>AuthType Basic</b> | |
481 | <dd style="margin-left: 5.0em"><dt><b>AuthType Default</b> | |
482 | <dd style="margin-left: 5.0em"><dt><b>AuthType Negotiate</b> | |
483 | <dd style="margin-left: 5.0em">Specifies the type of authentication required. | |
484 | The value "Default" corresponds to the DefaultAuthType value. | |
485 | <dt><b>Deny all</b> | |
486 | <dd style="margin-left: 5.0em"><dt><b>Deny none</b> | |
487 | <dd style="margin-left: 5.0em"><dt><b>Deny </b><i>host.domain.com</i> | |
488 | <dd style="margin-left: 5.0em"><dt><b>Deny *.</b><i>domain.com</i> | |
489 | <dd style="margin-left: 5.0em"><dt><b>Deny </b><i>ipv4-address</i> | |
490 | <dd style="margin-left: 5.0em"><dt><b>Deny </b><i>ipv4-address</i><b>/</b><i>netmask</i> | |
491 | <dd style="margin-left: 5.0em"><dt><b>Deny </b><i>ipv4-address</i><b>/</b><i>mm</i> | |
492 | <dd style="margin-left: 5.0em"><dt><b>Deny [</b><i>ipv6-address</i><b>]</b> | |
493 | <dd style="margin-left: 5.0em"><dt><b>Deny [</b><i>ipv6-address</i><b>]/</b><i>mm</i> | |
494 | <dd style="margin-left: 5.0em"><dt><b>Deny @IF(</b><i>name</i><b>)</b> | |
495 | <dd style="margin-left: 5.0em"><dt><b>Deny @LOCAL</b> | |
496 | <dd style="margin-left: 5.0em">Denies access from the named hosts, domains, addresses, or interfaces. | |
497 | The Order directive controls whether Deny lines are evaluated before or after Allow lines. | |
498 | <dt><b>Encryption IfRequested</b> | |
499 | <dd style="margin-left: 5.0em"><dt><b>Encryption Never</b> | |
500 | <dd style="margin-left: 5.0em"><dt><b>Encryption Required</b> | |
501 | <dd style="margin-left: 5.0em">Specifies the level of encryption that is required for a particular location. | |
502 | The default value is "IfRequested". | |
503 | <dt><b>Order allow,deny</b> | |
504 | <dd style="margin-left: 5.0em">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. | |
505 | <dt><b>Order deny,allow</b> | |
506 | <dd style="margin-left: 5.0em">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. | |
507 | <dt><b>Require group </b><i>group-name </i>[ <i>group-name </i>... ] | |
508 | <dd style="margin-left: 5.0em">Specifies that an authenticated user must be a member of one of the named groups. | |
509 | <dt><b>Require user {</b><i>user-name</i>|<b>@</b><i>group-name</i>} ... | |
510 | <dd style="margin-left: 5.0em">Specifies that an authenticated user must match one of the named users or be a member of one of the named groups. | |
511 | The group name "@SYSTEM" corresponds to the list of groups defined by the SystemGroup directive in the | |
512 | <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a> | |
513 | file. | |
514 | The group name "@OWNER" corresponds to the owner of the resource, for example the person that submitted a print job. | |
515 | <dt><b>Require valid-user</b> | |
516 | <dd style="margin-left: 5.0em">Specifies that any authenticated user is acceptable. | |
517 | <dt><b>Satisfy all</b> | |
518 | <dd style="margin-left: 5.0em">Specifies that all Allow, AuthType, Deny, Order, and Require conditions must be satisfied to allow access. | |
519 | <dt><b>Satisfy any</b> | |
520 | <dd style="margin-left: 5.0em">Specifies that any a client may access a resource if either the authentication (AuthType/Require) or address (Allow/Deny/Order) conditions are satisfied. | |
521 | For example, this can be used to require authentication only for remote accesses. | |
522 | </dl> | |
523 | <h3><a name="DIRECTIVES_VALID_WITHIN_POLICY_SECTIONS">Directives Valid Within Policy Sections</a></h3> | |
524 | The following directives may be placed inside Policy sections in the <b>cupsd.conf</b> file: | |
525 | <dl class="man"> | |
526 | <dt><b>JobPrivateAccess all</b> | |
527 | <dd style="margin-left: 5.0em"><dt><b>JobPrivateAccess default</b> | |
528 | <dd style="margin-left: 5.0em"><dt><b>JobPrivateAccess </b>{<i>user</i>|<b>@</b><i>group</i>|<b>@ACL</b>|<b>@OWNER</b>|<b>@SYSTEM</b>} ... | |
529 | <dd style="margin-left: 5.0em">Specifies an access list for a job's private values. | |
530 | The "default" access list is "@OWNER @SYSTEM". | |
531 | "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. | |
532 | "@OWNER" maps to the job's owner. | |
533 | "@SYSTEM" maps to the groups listed for the SystemGroup directive in the | |
534 | <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a> | |
535 | file. | |
536 | <dt><b>JobPrivateValues all</b> | |
537 | <dd style="margin-left: 5.0em"><dt><b>JobPrivateValues default</b> | |
538 | <dd style="margin-left: 5.0em"><dt><b>JobPrivateValues none</b> | |
539 | <dd style="margin-left: 5.0em"><dt><b>JobPrivateValues </b><i>attribute-name </i>[ ... <i>attribute-name </i>] | |
540 | <dd style="margin-left: 5.0em">Specifies the list of job values to make private. | |
541 | The "default" values are "job-name", "job-originating-host-name", "job-originating-user-name", and "phone". | |
542 | <dt><b>SubscriptionPrivateAccess all</b> | |
543 | <dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateAccess default</b> | |
544 | <dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateAccess </b>{<i>user</i>|<b>@</b><i>group</i>|<b>@ACL</b>|<b>@OWNER</b>|<b>@SYSTEM</b>} ... | |
545 | <dd style="margin-left: 5.0em">Specifies an access list for a subscription's private values. | |
546 | The "default" access list is "@OWNER @SYSTEM". | |
547 | "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. | |
548 | "@OWNER" maps to the job's owner. | |
549 | "@SYSTEM" maps to the groups listed for the SystemGroup directive in the | |
550 | <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a> | |
551 | file. | |
552 | <dt><b>SubscriptionPrivateValues all</b> | |
553 | <dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateValues default</b> | |
554 | <dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateValues none</b> | |
555 | <dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateValues </b><i>attribute-name </i>[ ... <i>attribute-name </i>] | |
556 | <dd style="margin-left: 5.0em">Specifies the list of subscription values to make private. | |
557 | The "default" values are "notify-events", "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and "notify-user-data". | |
558 | </dl> | |
559 | <h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2> | |
560 | The <b>cupsd.conf</b> file format is based on the Apache HTTP Server configuration file format. | |
561 | <h2 class="title"><a name="EXAMPLES">Examples</a></h2> | |
562 | Log everything with a maximum log file size of 32 megabytes: | |
563 | <pre class="man"> | |
564 | ||
565 | AccessLogLevel all | |
566 | LogLevel debug2 | |
567 | MaxLogSize 32m | |
568 | ||
569 | </pre> | |
570 | Require authentication for accesses from outside the 10. network: | |
571 | <pre class="man"> | |
572 | ||
573 | <Location /> | |
574 | Order allow,deny | |
575 | Allow from 10./8 | |
576 | AuthType Basic | |
577 | Require valid-user | |
578 | Satisfy any | |
579 | </Location> | |
580 | </pre> | |
94436c5a | 581 | <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> |
1a18c85c MS |
582 | <a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a> |
583 | <a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a> | |
584 | <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> | |
585 | <a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a> | |
586 | <a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a> | |
587 | <a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a> | |
588 | <a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a> | |
589 | CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) | |
94436c5a | 590 | <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> |
1a18c85c | 591 | Copyright © 2007-2014 by Apple Inc. |
94436c5a MS |
592 | |
593 | </body> | |
594 | </html> |