]> git.ipfire.org Git - thirdparty/cups.git/blob - doc/help/man-cups-files.conf.html
More man page modernization.
[thirdparty/cups.git] / doc / help / man-cups-files.conf.html
1 <!DOCTYPE HTML>
2 <html>
3 <!-- SECTION: Man Pages -->
4 <head>
5 <link rel="stylesheet" type="text/css" href="../cups-printable.css">
6 <title>cups-files.conf(5)</title>
7 </head>
8 <body>
9 <h1 class="title">cups-files.conf(5)</h1>
10 <h2 class="title"><a name="NAME">Name</a></h2>
11 cups-files.conf - file and directory configuration file for cups
12 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
13 The <i>cups-files.conf</i> file configures the files and directories used by the
14 CUPS scheduler, <i>cupsd(8)</i>. It is normally located in the
15 <i>/etc/cups</i> directory.
16 <p>Each line in the file can be a configuration directive, a blank line,
17 or a comment. Comment lines start with the # character.
18 <h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
19 The following directives are understood by <i>cupsd(8)</i>. Consult the
20 on-line help for detailed descriptions:
21 <dl class="man">
22 <dt>AccessLog filename
23 <dd style="margin-left: 5.0em"><dt>AccessLog syslog
24 <dd style="margin-left: 5.0em"><br>
25 Defines the access log filename.
26 <dt>ConfigFilePerm mode
27 <dd style="margin-left: 5.0em"><br>
28 Specifies the permissions for all configuration files that the scheduler
29 writes.
30 <dt>DataDir path
31 <dd style="margin-left: 5.0em"><br>
32 Specified the directory where data files can be found.
33 <dt>DocumentRoot directory
34 <dd style="margin-left: 5.0em"><br>
35 Specifies the root directory for the internal web server documents.
36 <dt>ErrorLog filename
37 <dd style="margin-left: 5.0em"><dt>ErrorLog syslog
38 <dd style="margin-left: 5.0em"><br>
39 Specifies the error log filename.
40 <dt>FatalErrors none
41 <dd style="margin-left: 5.0em"><dt>FatalErrors all -kind [... -kind]
42 <dd style="margin-left: 5.0em"><dt>FatalErrors kind [... kind]
43 <dd style="margin-left: 5.0em"><br>
44 Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
45 "browse", "config", "listen", "log", or "permissions".
46 <dt>FileDevice Yes
47 <dd style="margin-left: 5.0em"><dt>FileDevice No
48 <dd style="margin-left: 5.0em"><br>
49 Specifies whether the file pseudo-device can be used for new
50 printer queues.
51 <dt>FontPath directory[:directory:...]
52 <dd style="margin-left: 5.0em"><br>
53 Specifies the search path for fonts.
54 <dt>Group group-name-or-number
55 <dd style="margin-left: 5.0em"><br>
56 Specifies the group name or ID that will be used when executing
57 external programs.
58 <dt>LogFilePerm mode
59 <dd style="margin-left: 5.0em"><br>
60 Specifies the permissions for all log files that the scheduler writes.
61 <dt>PageLog filename
62 <dd style="margin-left: 5.0em"><dt>PageLog syslog
63 <dd style="margin-left: 5.0em"><br>
64 Specifies the page log filename.
65 <dt>Printcap
66 <dd style="margin-left: 5.0em"><dt>Printcap filename
67 <dd style="margin-left: 5.0em"><br>
68 Specifies the filename for a printcap file that is updated
69 automatically with a list of available printers (needed for
70 legacy applications); specifying Printcap with no filename
71 disables printcap generation.
72 <dt>RemoteRoot user-name
73 <dd style="margin-left: 5.0em"><br>
74 Specifies the username that is associated with unauthenticated root
75 accesses.
76 <dt>RequestRoot directory
77 <dd style="margin-left: 5.0em"><br>
78 Specifies the directory to store print jobs and other HTTP request
79 data.
80 <dt>Sandboxing off
81 <dd style="margin-left: 5.0em"><dt>Sandboxing relaxed
82 <dd style="margin-left: 5.0em"><dt>Sandboxing strict
83 <dd style="margin-left: 5.0em">Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler. The default is "strict". (OS X only)
84 <dt>ServerBin directory
85 <dd style="margin-left: 5.0em"><br>
86 Specifies the directory where backends, CGIs, daemons, and filters may
87 be found.
88 <dt>ServerKeychain path
89 <dd style="margin-left: 5.0em"><br>
90 Specifies the location of TLS certificates and private keys.
91 <dt>ServerRoot directory
92 <dd style="margin-left: 5.0em"><br>
93 Specifies the directory where the server configuration files can be found.
94 <dt>SyncOnClose Yes
95 <dd style="margin-left: 5.0em"><dt>SyncOnClose No
96 <dd style="margin-left: 5.0em">Specifies whether the scheduler calls <i>fsync(2)</i> after writing configuration
97 or state files. The default is No.
98 <dt>SystemGroup group-name [group-name ...]
99 <dd style="margin-left: 5.0em"><br>
100 Specifies the group(s) to use for System class authentication.
101 <dt>TempDir directory
102 <dd style="margin-left: 5.0em"><br>
103 Specifies the directory where temporary files are stored.
104 <dt>User user-name
105 <dd style="margin-left: 5.0em"><br>
106 Specifies the user name or ID that is used when running external programs.
107 </dl>
108 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
109 <i>classes.conf(5)</i>, <i>cupsd(8)</i>, <i>cupsd.conf(5)</i>, <i>mime.convs(5)</i>,
110 <i>mime.types(5)</i>, <i>printers.conf(5)</i>,
111 <i>subscriptions.conf(5)</i>,
112 <br>
113 <a href="http://localhost:631/help">http://localhost:631/help</a>
114 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
115 Copyright 2007-2014 by Apple Inc.
116
117 </body>
118 </html>