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

<!DOCTYPE HTML>
<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, <i>cupsd(8)</i>.  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 <i>cupsd(8)</i>. Consult the
on-line help for detailed descriptions:
<p style="margin-left: 5.0em; text-indent: -5.0em">AccessLog filename
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">AccessLog syslog
<br>
<br>
Defines the access log filename.
<p style="margin-left: 5.0em; text-indent: -5.0em">ConfigFilePerm mode
<br>
<br>
Specifies the permissions for all configuration files that the scheduler
writes.
<p style="margin-left: 5.0em; text-indent: -5.0em">DataDir path
<br>
<br>
Specified the directory where data files can be found.
<p style="margin-left: 5.0em; text-indent: -5.0em">DocumentRoot directory
<br>
<br>
Specifies the root directory for the internal web server documents.
<p style="margin-left: 5.0em; text-indent: -5.0em">ErrorLog filename
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">ErrorLog syslog
<br>
<br>
Specifies the error log filename.
<p style="margin-left: 5.0em; text-indent: -5.0em">FatalErrors none
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">FatalErrors all -kind [... -kind]
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">FatalErrors kind [... kind]
<br>
<br>
Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
"browse", "config", "listen", "log", or "permissions".
<p style="margin-left: 5.0em; text-indent: -5.0em">FileDevice Yes
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">FileDevice No
<br>
<br>
Specifies whether the file pseudo-device can be used for new
printer queues.
<p style="margin-left: 5.0em; text-indent: -5.0em">FontPath directory[:directory:...]
<br>
<br>
Specifies the search path for fonts.
<p style="margin-left: 5.0em; text-indent: -5.0em">Group group-name-or-number
<br>
<br>
Specifies the group name or ID that will be used when executing
external programs.
<p style="margin-left: 5.0em; text-indent: -5.0em">LogFilePerm mode
<br>
<br>
Specifies the permissions for all log files that the scheduler writes.
<p style="margin-left: 5.0em; text-indent: -5.0em">PageLog filename
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">PageLog syslog
<br>
<br>
Specifies the page log filename.
<p style="margin-left: 5.0em; text-indent: -5.0em">Printcap
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Printcap filename
<br>
<br>
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.
<p style="margin-left: 5.0em; text-indent: -5.0em">RemoteRoot user-name
<br>
<br>
Specifies the username that is associated with unauthenticated root
accesses.
<p style="margin-left: 5.0em; text-indent: -5.0em">RequestRoot directory
<br>
<br>
Specifies the directory to store print jobs and other HTTP request
data.
<p style="margin-left: 5.0em; text-indent: -5.0em">Sandboxing off
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Sandboxing relaxed
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">Sandboxing strict
<br>
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)
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerBin directory
<br>
<br>
Specifies the directory where backends, CGIs, daemons, and filters may
be found.
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerKeychain path
<br>
<br>
Specifies the location of TLS certificates and private keys.
<p style="margin-left: 5.0em; text-indent: -5.0em">ServerRoot directory
<br>
<br>
Specifies the directory where the server configuration files can be found.
<p style="margin-left: 5.0em; text-indent: -5.0em">SyncOnClose Yes
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">SyncOnClose No
<br>
Specifies whether the scheduler calls <i>fsync(2)</i> after writing configuration
or state files. The default is No.
<p style="margin-left: 5.0em; text-indent: -5.0em">SystemGroup group-name [group-name ...]
<br>
<br>
Specifies the group(s) to use for System class authentication.
<p style="margin-left: 5.0em; text-indent: -5.0em">TempDir directory
<br>
<br>
Specifies the directory where temporary files are stored.
<p style="margin-left: 5.0em; text-indent: -5.0em">User user-name
<br>
<br>
Specifies the user name or ID that is used when running external programs.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>classes.conf(5)</i>, <i>cupsd(8)</i>, <i>cupsd.conf(5)</i>, <i>mime.convs(5)</i>,
<i>mime.types(5)</i>, <i>printers.conf(5)</i>,
<i>subscriptions.conf(5)</i>,
<br>
<a href="http://localhost:631/help">http://localhost:631/help</a>
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright 2007-2014 by Apple Inc.

</body>
</html>
Commit	Line	Data
c277f98c	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>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
c277f98c	14	CUPS scheduler, <i>cupsd(8)</i>. 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>
c277f98c	19	The following directives are understood by <i>cupsd(8)</i>. Consult the
94436c5a	20	on-line help for detailed descriptions:
c277f98c MS	21	<p style="margin-left: 5.0em; text-indent: -5.0em">AccessLog filename
	22	<br>
	23	<p style="margin-left: 5.0em; text-indent: -5.0em">AccessLog syslog
	24	<br>
	25	<br>
	26	Defines the access log filename.
	27	<p style="margin-left: 5.0em; text-indent: -5.0em">ConfigFilePerm mode
	28	<br>
	29	<br>
	30	Specifies the permissions for all configuration files that the scheduler
94436c5a	31	writes.
c277f98c MS	32	<p style="margin-left: 5.0em; text-indent: -5.0em">DataDir path
	33	<br>
	34	<br>
	35	Specified the directory where data files can be found.
	36	<p style="margin-left: 5.0em; text-indent: -5.0em">DocumentRoot directory
	37	<br>
	38	<br>
	39	Specifies the root directory for the internal web server documents.
	40	<p style="margin-left: 5.0em; text-indent: -5.0em">ErrorLog filename
	41	<br>
	42	<p style="margin-left: 5.0em; text-indent: -5.0em">ErrorLog syslog
	43	<br>
	44	<br>
	45	Specifies the error log filename.
	46	<p style="margin-left: 5.0em; text-indent: -5.0em">FatalErrors none
	47	<br>
	48	<p style="margin-left: 5.0em; text-indent: -5.0em">FatalErrors all -kind [... -kind]
	49	<br>
	50	<p style="margin-left: 5.0em; text-indent: -5.0em">FatalErrors kind [... kind]
	51	<br>
	52	<br>
	53	Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
94436c5a	54	"browse", "config", "listen", "log", or "permissions".
c277f98c MS	55	<p style="margin-left: 5.0em; text-indent: -5.0em">FileDevice Yes
	56	<br>
	57	<p style="margin-left: 5.0em; text-indent: -5.0em">FileDevice No
	58	<br>
	59	<br>
	60	Specifies whether the file pseudo-device can be used for new
94436c5a	61	printer queues.
c277f98c MS	62	<p style="margin-left: 5.0em; text-indent: -5.0em">FontPath directory[:directory:...]
	63	<br>
	64	<br>
	65	Specifies the search path for fonts.
	66	<p style="margin-left: 5.0em; text-indent: -5.0em">Group group-name-or-number
	67	<br>
	68	<br>
	69	Specifies the group name or ID that will be used when executing
94436c5a	70	external programs.
c277f98c MS	71	<p style="margin-left: 5.0em; text-indent: -5.0em">LogFilePerm mode
	72	<br>
	73	<br>
	74	Specifies the permissions for all log files that the scheduler writes.
	75	<p style="margin-left: 5.0em; text-indent: -5.0em">PageLog filename
	76	<br>
	77	<p style="margin-left: 5.0em; text-indent: -5.0em">PageLog syslog
	78	<br>
	79	<br>
	80	Specifies the page log filename.
	81	<p style="margin-left: 5.0em; text-indent: -5.0em">Printcap
	82	<br>
	83	<p style="margin-left: 5.0em; text-indent: -5.0em">Printcap filename
	84	<br>
	85	<br>
	86	Specifies the filename for a printcap file that is updated
94436c5a MS	87	automatically with a list of available printers (needed for
	88	legacy applications); specifying Printcap with no filename
	89	disables printcap generation.
c277f98c MS	90	<p style="margin-left: 5.0em; text-indent: -5.0em">RemoteRoot user-name
	91	<br>
	92	<br>
	93	Specifies the username that is associated with unauthenticated root
94436c5a	94	accesses.
c277f98c MS	95	<p style="margin-left: 5.0em; text-indent: -5.0em">RequestRoot directory
	96	<br>
	97	<br>
	98	Specifies the directory to store print jobs and other HTTP request
94436c5a	99	data.
c277f98c MS	100	<p style="margin-left: 5.0em; text-indent: -5.0em">Sandboxing off
	101	<br>
	102	<p style="margin-left: 5.0em; text-indent: -5.0em">Sandboxing relaxed
	103	<br>
	104	<p style="margin-left: 5.0em; text-indent: -5.0em">Sandboxing strict
	105	<br>
	106	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)
	107	<p style="margin-left: 5.0em; text-indent: -5.0em">ServerBin directory
	108	<br>
	109	<br>
	110	Specifies the directory where backends, CGIs, daemons, and filters may
8fe0183a	111	be found.
c277f98c MS	112	<p style="margin-left: 5.0em; text-indent: -5.0em">ServerKeychain path
	113	<br>
	114	<br>
	115	Specifies the location of TLS certificates and private keys.
	116	<p style="margin-left: 5.0em; text-indent: -5.0em">ServerRoot directory
	117	<br>
	118	<br>
	119	Specifies the directory where the server configuration files can be found.
	120	<p style="margin-left: 5.0em; text-indent: -5.0em">SyncOnClose Yes
	121	<br>
	122	<p style="margin-left: 5.0em; text-indent: -5.0em">SyncOnClose No
	123	<br>
	124	Specifies whether the scheduler calls <i>fsync(2)</i> after writing configuration
5ec1fd3d	125	or state files. The default is No.
c277f98c MS	126	<p style="margin-left: 5.0em; text-indent: -5.0em">SystemGroup group-name [group-name ...]
	127	<br>
	128	<br>
	129	Specifies the group(s) to use for System class authentication.
	130	<p style="margin-left: 5.0em; text-indent: -5.0em">TempDir directory
	131	<br>
	132	<br>
	133	Specifies the directory where temporary files are stored.
	134	<p style="margin-left: 5.0em; text-indent: -5.0em">User user-name
	135	<br>
	136	<br>
	137	Specifies the user name or ID that is used when running external programs.
94436c5a	138	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
c277f98c MS	139	<i>classes.conf(5)</i>, <i>cupsd(8)</i>, <i>cupsd.conf(5)</i>, <i>mime.convs(5)</i>,
	140	<i>mime.types(5)</i>, <i>printers.conf(5)</i>,
	141	<i>subscriptions.conf(5)</i>,
94436c5a	142	<br>
c277f98c	143	<a href="http://localhost:631/help">http://localhost:631/help</a>
94436c5a	144	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
8fe0183a	145	Copyright 2007-2014 by Apple Inc.
94436c5a MS	146
	147	</body>
	148	</html>