]> git.ipfire.org Git - thirdparty/cups.git/blame - man/cupsd.conf.man
projects / thirdparty / cups.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Load cups into easysw/current.
[thirdparty/cups.git] / man / cupsd.conf.man
CommitLineData
ef416fc2 1.\"
2.\" "$Id: cupsd.conf.man 4819 2005-11-04 18:39:32Z mike $"
3.\"
4.\" cupsd.conf man page for the Common UNIX Printing System (CUPS).
5.\"
6.\" Copyright 1997-2005 by Easy Software Products.
7.\"
8.\" These coded instructions, statements, and computer programs are the
9.\" property of Easy Software Products and are protected by Federal
10.\" copyright law. Distribution and use rights are outlined in the file
11.\" "LICENSE.txt" which should have been included with this file. If this
12.\" file is missing or damaged please contact Easy Software Products
13.\" at:
14.\"
15.\" Attn: CUPS Licensing Information
16.\" Easy Software Products
17.\" 44141 Airport View Drive, Suite 204
18.\" Hollywood, Maryland 20636 USA
19.\"
20.\" Voice: (301) 373-9600
21.\" EMail: cups-info@cups.org
22.\" WWW: http://www.cups.org
23.\"
24.TH cupsd.conf 5 "Common UNIX Printing System" "4 November 2005" "Easy Software Products"
25.SH NAME
26cupsd.conf \- server configuration file for cups
27.SH DESCRIPTION
28The \fIcupsd.conf\fR file configures the CUPS scheduler, \fIcupsd(8)\fR. It
29is normally located in the \fI/etc/cups\fR directory.
30.LP
31Each line in the file can be a configuration directive, a blank line,
32or a comment. Comment lines start with the # character. The
33configuration directives are intentionally similar to those used by the
34popular Apache web server software and are described below.
35.SH DIRECTIVES
36The following directives are understood by \fIcupsd\fR. Consult the CUPS
37Software Administrators Manual for a detailed description:
38.TP 5
39AccessLog
40.br
41Defines the access log filename.
42.TP 5
43Allow
44.br
45Allows access from the named hosts or addresses.
46.TP 5
47AuthClass
48.br
49Specifies the authentication class (User, Group, System)
50.TP 5
51AuthGroupName
52.br
53Specifies the authentication group.
54.TP 5
55AuthType
56.br
57Specifies the authentication type (None, Basic, Digest)
58.TP 5
59AutoPurgeJobs
60.br
61Specifies whether to purge job history data automatically when
62it is no longer required for quotas.
63.TP 5
64BrowseAddress
65.br
66Specifies a broadcast address for outgoing printer information packets.
67.TP 5
68BrowseAllow
69.br
70Allows incoming printer information packets from the named host or address.
71.TP 5
72BrowseDeny
73.br
74Denies incoming printer information packets from the named host or address.
75.TP 5
76BrowseInterval
77.br
78Specifies the maximum interval between printer information broadcasts.
79.TP 5
80BrowseOrder
81.br
82Specifies the order of printer information access control (allow,deny or deny,allow)
83.TP 5
84BrowsePoll
85.br
86Specifies a server to poll for printer information.
87.TP 5
88BrowsePort
89.br
90Specifies the port to listen to for printer information packets.
91.TP 5
92BrowseProtocols
93.br
94Specifies the protocols to use for printer browsing.
95.TP 5
96BrowseLocalProtocols
97.br
98Specifies the protocols to use for local printer browsing.
99.TP 5
100BrowseRemoteProtocols
101.br
102Specifies the protocols to use for remote printer browsing.
103.TP 5
104BrowseRelay
105.br
106Specifies that printer information packets should be relayed from one host or
107network to another.
108.TP 5
109BrowseShortNames
110.br
111Specifies whether remote printers will use short names ("printer") or not
112("printer@server"). This option is ignored if more than one remote printer
113exists with the same name.
114.TP 5
115BrowseTimeout
116.br
117Specifies the maximum interval between printer information updates before
118remote printers will be removed from the list of available printers.
119.TP 5
120Browsing
121.br
122Specifies whether or not remote printer browsing should be enabled.
123.TP 5
124Classification
125.br
126Specifies the security classification of the server.
127.TP 5
128ClassifyOverride
129.br
130Specifies whether to allow users to override the classification
131of individual print jobs.
132.TP 5
133ConfigFilePerm
134.br
135Specifies the permissions for all configuration files that the scheduler
136writes.
137.TP 5
138DataDir
139.br
140Specified the directory where data files can be found.
141.TP 5
142DefaultAuthType
143.br
144Specifies the default type of authentication to use.
145.TP 5
146DefaultCharset
147.br
148Specifies the default character set to use for text.
149.TP 5
150DefaultLanguage
151.br
152Specifies the default language to use for text and web content.
153.TP 5
154DefaultPolicy
155.br
156Specifies the default access policy to use.
157.TP 5
158Deny
159.br
160Denies access to the named host or address.
161.TP 5
162DocumentRoot
163.br
164Specifies the root directory for the internal web server documents.
165.TP 5
166Encryption
167.br
168Specifies the level of encryption that is required for a particular
169location.
170.TP 5
171ErrorLog
172.br
173Specifies the error log filename.
174.TP 5
175FileDevice
176.br
177Specifies whether the file pseudo-device can be used for new
178printer queues.
179.TP 5
180FilterLimit
181.br
182Specifies the maximum cost of filters that are run concurrently.
183.TP 5
184FilterNice
185.br
186Specifies the scheduling priority ("nice" value) of filters that
187are run to print a job.
188.TP 5
189FontPath
190.br
191Specifies the search path for fonts.
192.TP 5
193Group
194.br
195Specifies the group name or ID that will be used when executing
196external programs.
197.TP 5
198HideImplicitMembers
199.br
200Specifies whether to hide members of implicit classes.
201.TP 5
202HostNameLookups
203.br
204Specifies whether or not to do reverse lookups on client addresses.
205.TP 5
206ImplicitAnyClasses
207.br
208Specifies whether or not to create implicit classes for local and
209remote printers, e.g. "AnyPrinter" from "Printer", "Printer@server1",
210and "Printer@server2".
211.TP 5
212ImplicitClasses
213.br
214Specifies whether or not to create implicit classes from identical
215remote printers.
216.TP 5
217Include
218.br
219Includes the named file.
220.TP 5
221JobRetryInterval
222.br
223Specifies the interval between retries of jobs in seconds.
224.TP 5
225JobRetryLimit
226.br
227Specifies the number of retries that are done for jobs.
228.TP 5
229KeepAlive
230.br
231Specifies whether or not to support HTTP Keep-Alive.
232.TP 5
233KeepAliveTimeout
234.br
235Specifies the connection timeout for HTTP Keep-Alive.
236.TP 5
237<Limit operations> ... </Limit>
238.br
239Specifies the IPP operations that are being limited inside a policy.
240.TP 5
241<Limit methods> ... </Limit>
242.TP 5
243<LimitExcept methods> ... </LimitExcept>
244.br
245Specifies the HTTP methods that are being limited inside a location.
246.TP 5
247LimitRequestBody
248.br
249Specifies the maximum size of any print job request.
250.TP 5
251Listen
252.br
253Listens to the specified address and port.
254.TP 5
255<Location /path> ... </Location>
256.br
257Specifies access control for the named location.
258.TP 5
259LogFilePerm
260.br
261Specifies the permissions for all log files that the scheduler writes.
262.TP 5
263LogLevel
264.br
265Specifies the logging level (none, warn, error, info, debug, or debug2)
266.TP 5
267MaxClients
268.br
269Specifies the maximum number of simultaneous clients to support.
270.TP 5
271MaxClientsPerHost
272.br
273Specifies the maximum number of simultaneous clients to support from a
274single address.
275.TP 5
276MaxCopies
277.br
278Specifies the maximum number of copies that a user can print of each job.
279.TP 5
280MaxJobs
281.br
282Specifies the maximum number of simultaneous jobs to support.
283.TP 5
284MaxJobsPerPrinter
285.br
286Specifies the maximum number of simultaneous jobs per printer to support.
287.TP 5
288MaxJobsPerUser
289.br
290Specifies the maximum number of simultaneous jobs per user to support.
291.TP 5
292MaxLogSize
293.br
294Specifies the maximum size of the log files before they are
295rotated (0 to disable rotation)
296.TP 5
297MaxRequestSize
298.br
299Specifies the maximum request/file size in bytes (0 for no limit)
300.TP 5
301Order
302.br
303Specifies the order of HTTP access control (allow,deny or deny,allow)
304.TP 5
305PageLog
306.br
307Specifies the page log filename.
308.TP 5
309PassEnv variable [... variable]
310.br
311Passes the specified environment variable(s) to child processes.
312.TP 5
313<Policy name> ... </Policy>
314.br
315Specifies access control for the named policy.
316.TP 5
317Port
318.br
319Specifies a port number to listen to for HTTP requests.
320.TP 5
321PreserveJobFiles
322.br
323Specifies whether or not to preserve job files after they are printed.
324.TP 5
325PreserveJobHistory
326.br
327Specifies whether or not to preserve the job history after they are
328printed.
329.TP 5
330Printcap
331.br
332Specifies the filename for a printcap file that is updated automatically
333with a list of available printers (needed for legacy applications)
334.TP 5
335PrintcapFormat
336.br
337Specifies the format of the printcap file.
338.TP 5
339PrintcapGUI
340.br
341Specifies whether to generate option panel definition files on some
342operating systems.
343.TP 5
344ReloadTimeout
345.br
346Specifies the amount of time to wait for job completion before
347restarting the scheduler.
348.TP 5
349RemoteRoot
350.br
351Specifies the username that is associated with unauthenticated root
352accesses.
353.TP 5
354RequestRoot
355.br
356Specifies the directory to store print jobs and other HTTP request
357data.
358.TP 5
359Require
360.br
361Specifies that user or group authentication is required.
362.TP 5
363RIPCache
364.br
365Specifies the maximum amount of memory to use when converting images
366and PostScript files to bitmaps for a printer.
367.TP 5
368RunAsUser
369.br
370Specifies that the scheduler should run as the unpriviledged user
371set with the User directive.
372.TP 5
373Satisfy
374.br
375Specifies whether all or any limits set for a Location must be
376satisfied to allow access.
377.TP 5
378ServerAdmin
379.br
380Specifies the email address of the server administrator.
381.TP 5
382ServerBin
383.br
384Specifies the directory where backends, CGIs, daemons, and filters may
385be found.
386.TP 5
387ServerCertificate
388.br
389Specifies the encryption certificate to use.
390.TP 5
391ServerKey
392.br
393Specifies the encryption key to use.
394.TP 5
395ServerName
396.br
397Specifies the fully-qualified hostname of the server.
398.TP 5
399ServerRoot
400.br
401Specifies the directory where the server configuration files can be found.
402.TP 5
403ServerTokens
404.br
405Specifies what information is included in the Server header of HTTP
406responses.
407.TP 5
408SetEnv variable value
409.br
410Set the specified environment variable to be passed to child processes.
411.TP 5
412SSLListen
413.br
414Listens on the specified address and port for encrypted connections.
415.TP 5
416SSLPort
417.br
418Listens on the specified port for encrypted connections.
419.TP 5
420SystemGroup
421.br
422Specifies the group to use for System class authentication.
423.TP 5
424TempDir
425.br
426Specifies the directory where temporary files are stored.
427.TP 5
428Timeout
429.br
430Specifies the HTTP request timeout in seconds.
431.TP 5
432User
433.br
434Specifies the user name or ID that is used when running external programs.
435.SH SEE ALSO
436classes.conf(5), cupsd(8), mime.convs(5), mime.types(5), printers.conf(5),
437CUPS Software Administrators Manual,
438http://localhost:631/documentation.html
439.SH COPYRIGHT
440Copyright 1993-2005 by Easy Software Products, All Rights Reserved.
441.\"
442.\" End of "$Id: cupsd.conf.man 4819 2005-11-04 18:39:32Z mike $".
443.\"
Unnamed repository; edit this file 'description' to name the repository.