[thirdparty/cups.git] / doc / help / man-cups-files.conf.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>cups-files.conf(5)</title>
</head>
<body>
<h1 class="title">cups-files.conf(5)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
cups-files.conf - file and directory configuration file for cups
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The <i>cups-files.conf</i> file configures the files and directories used by the
CUPS scheduler, <a href='man-cupsd.html?TOPIC=Man+Pages'>cupsd(8)</a>.  It is normally located in the
<i>/etc/cups</i> directory.
<p>Each line in the file can be a configuration directive, a blank line,
or a comment. Comment lines start with the # character.
<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
The following directives are understood by <a href='man-cupsd.html?TOPIC=Man+Pages'>cupsd(8)</a>. Consult the
on-line help for detailed descriptions:
<dl>
<dt>AccessLog filename
</dt>
<dd></dd>
<dt>AccessLog syslog
</dt>
<dd></dd>
<dd>Defines the access log filename.
</dd>
<dt>ConfigFilePerm mode
</dt>
<dd></dd>
<dd>Specifies the permissions for all configuration files that the scheduler
writes.
</dd>
<dt>DataDir path
</dt>
<dd></dd>
<dd>Specified the directory where data files can be found.
</dd>
<dt>DocumentRoot directory
</dt>
<dd></dd>
<dd>Specifies the root directory for the internal web server documents.
</dd>
<dt>ErrorLog filename
</dt>
<dd></dd>
<dt>ErrorLog syslog
</dt>
<dd></dd>
<dd>Specifies the error log filename.
</dd>
<dt>FatalErrors none
</dt>
<dd></dd>
<dt>FatalErrors all -kind [... -kind]
</dt>
<dd></dd>
<dt>FatalErrors kind [... kind]
</dt>
<dd></dd>
<dd>Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
"browse", "config", "listen", "log", or "permissions".
</dd>
<dt>FileDevice Yes
</dt>
<dd></dd>
<dt>FileDevice No
</dt>
<dd></dd>
<dd>Specifies whether the file pseudo-device can be used for new
printer queues.
</dd>
<dt>FontPath directory[:directory:...]
</dt>
<dd></dd>
<dd>Specifies the search path for fonts.
</dd>
<dt>Group group-name-or-number
</dt>
<dd></dd>
<dd>Specifies the group name or ID that will be used when executing
external programs.
</dd>
<dt>LogFilePerm mode
</dt>
<dd></dd>
<dd>Specifies the permissions for all log files that the scheduler writes.
</dd>
<dt>PageLog filename
</dt>
<dd></dd>
<dt>PageLog syslog
</dt>
<dd></dd>
<dd>Specifies the page log filename.
</dd>
<dt>Printcap
</dt>
<dd></dd>
<dt>Printcap filename
</dt>
<dd></dd>
<dd>Specifies the filename for a printcap file that is updated
automatically with a list of available printers (needed for
legacy applications); specifying Printcap with no filename
disables printcap generation.
</dd>
<dt>RemoteRoot user-name
</dt>
<dd></dd>
<dd>Specifies the username that is associated with unauthenticated root
accesses.
</dd>
<dt>RequestRoot directory
</dt>
<dd></dd>
<dd>Specifies the directory to store print jobs and other HTTP request
data.
</dd>
<dt>ServerBin directory
</dt>
<dd></dd>
<dd>Specifies the directory where backends, CGIs, daemons, and filters may
be found.
</dd>
<dt>ServerCertificate filename
</dt>
<dd></dd>
<dd>Specifies the encryption certificate to use.
</dd>
<dt>ServerKey filename
</dt>
<dd></dd>
<dd>Specifies the encryption key to use.
</dd>
<dt>ServerRoot directory
</dt>
<dd></dd>
<dd>Specifies the directory where the server configuration files can be found.
</dd>
<dt>SyncOnClose Yes
</dt>
<dd></dd>
<dt>SyncOnClose No
</dt>
<dd>Specifies whether the scheduler calls <i>fsync(2)</i> after writing configuration
or state files. The default is No.
</dd>
<dt>SystemGroup group-name [group-name ...]
</dt>
<dd></dd>
<dd>Specifies the group(s) to use for System class authentication.
</dd>
<dt>TempDir directory
</dt>
<dd></dd>
<dd>Specifies the directory where temporary files are stored.
</dd>
<dt>User user-name
</dt>
<dd></dd>
<dd>Specifies the user name or ID that is used when running external programs.
</dd>
</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<a href='man-classes.conf.html?TOPIC=Man+Pages'>classes.conf(5)</a>, <a href='man-cupsd.html?TOPIC=Man+Pages'>cupsd(8)</a>, <a href='man-cupsd.conf.html?TOPIC=Man+Pages'>cupsd.conf(5)</a>, <a href='man-mime.convs.html?TOPIC=Man+Pages'>mime.convs(5)</a>,
<a href='man-mime.types.html?TOPIC=Man+Pages'>mime.types(5)</a>, <a href='man-printers.conf.html?TOPIC=Man+Pages'>printers.conf(5)</a>,
<a href='man-subscriptions.conf.html?TOPIC=Man+Pages'>subscriptions.conf(5)</a>,
<br>
<a href='http://localhost:631/help'>http://localhost:631/help</a>
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright 2007-2013 by Apple Inc.

</body>
</html>
Commit	Line	Data
94436c5a MS	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	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, <a href='man-cupsd.html?TOPIC=Man+Pages'>cupsd(8)</a>. It is normally located in the
ffa2ca90	15	<i>/etc/cups</i> directory.
94436c5a MS	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 <a href='man-cupsd.html?TOPIC=Man+Pages'>cupsd(8)</a>. Consult the
	20	on-line help for detailed descriptions:
	21	<dl>
	22	<dt>AccessLog filename
	23	</dt>
	24	<dd></dd>
	25	<dt>AccessLog syslog
	26	</dt>
	27	<dd></dd>
	28	<dd>Defines the access log filename.
	29	</dd>
	30	<dt>ConfigFilePerm mode
	31	</dt>
	32	<dd></dd>
	33	<dd>Specifies the permissions for all configuration files that the scheduler
	34	writes.
	35	</dd>
	36	<dt>DataDir path
	37	</dt>
	38	<dd></dd>
	39	<dd>Specified the directory where data files can be found.
	40	</dd>
	41	<dt>DocumentRoot directory
	42	</dt>
	43	<dd></dd>
	44	<dd>Specifies the root directory for the internal web server documents.
	45	</dd>
	46	<dt>ErrorLog filename
	47	</dt>
	48	<dd></dd>
	49	<dt>ErrorLog syslog
	50	</dt>
	51	<dd></dd>
	52	<dd>Specifies the error log filename.
	53	</dd>
	54	<dt>FatalErrors none
	55	</dt>
	56	<dd></dd>
	57	<dt>FatalErrors all -kind [... -kind]
	58	</dt>
	59	<dd></dd>
	60	<dt>FatalErrors kind [... kind]
	61	</dt>
	62	<dd></dd>
	63	<dd>Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
	64	"browse", "config", "listen", "log", or "permissions".
	65	</dd>
	66	<dt>FileDevice Yes
	67	</dt>
	68	<dd></dd>
	69	<dt>FileDevice No
	70	</dt>
	71	<dd></dd>
	72	<dd>Specifies whether the file pseudo-device can be used for new
	73	printer queues.
	74	</dd>
	75	<dt>FontPath directory[:directory:...]
	76	</dt>
	77	<dd></dd>
	78	<dd>Specifies the search path for fonts.
	79	</dd>
80	<dt>Group group-name-or-number
81	</dt>
82	<dd></dd>
83	<dd>Specifies the group name or ID that will be used when executing
84	external programs.
85	</dd>
86	<dt>LogFilePerm mode
87	</dt>
88	<dd></dd>
89	<dd>Specifies the permissions for all log files that the scheduler writes.
90	</dd>
91	<dt>PageLog filename
92	</dt>
93	<dd></dd>
94	<dt>PageLog syslog
95	</dt>
96	<dd></dd>
97	<dd>Specifies the page log filename.
98	</dd>
99	<dt>Printcap
100	</dt>
101	<dd></dd>
102	<dt>Printcap filename
103	</dt>
104	<dd></dd>
105	<dd>Specifies the filename for a printcap file that is updated
106	automatically with a list of available printers (needed for
107	legacy applications); specifying Printcap with no filename
108	disables printcap generation.
109	</dd>
110	<dt>RemoteRoot user-name
111	</dt>
112	<dd></dd>
113	<dd>Specifies the username that is associated with unauthenticated root
114	accesses.
115	</dd>
116	<dt>RequestRoot directory
117	</dt>
118	<dd></dd>
119	<dd>Specifies the directory to store print jobs and other HTTP request
120	data.
121	</dd>
122	<dt>ServerBin directory
123	</dt>
124	<dd></dd>
125	<dd>Specifies the directory where backends, CGIs, daemons, and filters may
126	be found.
127	</dd>
128	<dt>ServerCertificate filename
129	</dt>
130	<dd></dd>
131	<dd>Specifies the encryption certificate to use.
132	</dd>
133	<dt>ServerKey filename
134	</dt>
135	<dd></dd>
136	<dd>Specifies the encryption key to use.
137	</dd>
138	<dt>ServerRoot directory
139	</dt>
140	<dd></dd>
141	<dd>Specifies the directory where the server configuration files can be found.
142	</dd>
fde3d2df MS	143	<dt>SyncOnClose Yes
	144	</dt>
	145	<dd></dd>
	146	<dt>SyncOnClose No
	147	</dt>
	148	<dd>Specifies whether the scheduler calls <i>fsync(2)</i> after writing configuration
	149	or state files. The default is No.
	150	</dd>
94436c5a MS	151	<dt>SystemGroup group-name [group-name ...]
	152	</dt>
	153	<dd></dd>
	154	<dd>Specifies the group(s) to use for System class authentication.
	155	</dd>
	156	<dt>TempDir directory
	157	</dt>
	158	<dd></dd>
	159	<dd>Specifies the directory where temporary files are stored.
	160	</dd>
	161	<dt>User user-name
	162	</dt>
	163	<dd></dd>
	164	<dd>Specifies the user name or ID that is used when running external programs.
	165	</dd>
	166	</dl>
	167	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
	168	<a href='man-classes.conf.html?TOPIC=Man+Pages'>classes.conf(5)</a>, <a href='man-cupsd.html?TOPIC=Man+Pages'>cupsd(8)</a>, <a href='man-cupsd.conf.html?TOPIC=Man+Pages'>cupsd.conf(5)</a>, <a href='man-mime.convs.html?TOPIC=Man+Pages'>mime.convs(5)</a>,
	169	<a href='man-mime.types.html?TOPIC=Man+Pages'>mime.types(5)</a>, <a href='man-printers.conf.html?TOPIC=Man+Pages'>printers.conf(5)</a>,
	170	<a href='man-subscriptions.conf.html?TOPIC=Man+Pages'>subscriptions.conf(5)</a>,
	171	<br>
	172	<a href='http://localhost:631/help'>http://localhost:631/help</a>
	173	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
	174	Copyright 2007-2013 by Apple Inc.
	175
	176	</body>
	177	</html>