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