[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:
<dl class="man">
<dt>AccessLog filename
<dd style="margin-left: 5.0em"><dt>AccessLog syslog
<dd style="margin-left: 5.0em"><br>
Defines the access log filename.
<dt>ConfigFilePerm mode
<dd style="margin-left: 5.0em"><br>
Specifies the permissions for all configuration files that the scheduler
writes.
<dt>DataDir path
<dd style="margin-left: 5.0em"><br>
Specified the directory where data files can be found.
<dt>DocumentRoot directory
<dd style="margin-left: 5.0em"><br>
Specifies the root directory for the internal web server documents.
<dt>ErrorLog filename
<dd style="margin-left: 5.0em"><dt>ErrorLog syslog
<dd style="margin-left: 5.0em"><br>
Specifies the error log filename.
<dt>FatalErrors none
<dd style="margin-left: 5.0em"><dt>FatalErrors all -kind [... -kind]
<dd style="margin-left: 5.0em"><dt>FatalErrors kind [... kind]
<dd style="margin-left: 5.0em"><br>
Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
"browse", "config", "listen", "log", or "permissions".
<dt>FileDevice Yes
<dd style="margin-left: 5.0em"><dt>FileDevice No
<dd style="margin-left: 5.0em"><br>
Specifies whether the file pseudo-device can be used for new
printer queues.
<dt>FontPath directory[:directory:...]
<dd style="margin-left: 5.0em"><br>
Specifies the search path for fonts.
<dt>Group group-name-or-number
<dd style="margin-left: 5.0em"><br>
Specifies the group name or ID that will be used when executing
external programs.
<dt>LogFilePerm mode
<dd style="margin-left: 5.0em"><br>
Specifies the permissions for all log files that the scheduler writes.
<dt>PageLog filename
<dd style="margin-left: 5.0em"><dt>PageLog syslog
<dd style="margin-left: 5.0em"><br>
Specifies the page log filename.
<dt>Printcap
<dd style="margin-left: 5.0em"><dt>Printcap filename
<dd style="margin-left: 5.0em"><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.
<dt>RemoteRoot user-name
<dd style="margin-left: 5.0em"><br>
Specifies the username that is associated with unauthenticated root
accesses.
<dt>RequestRoot directory
<dd style="margin-left: 5.0em"><br>
Specifies the directory to store print jobs and other HTTP request
data.
<dt>Sandboxing off
<dd style="margin-left: 5.0em"><dt>Sandboxing relaxed
<dd style="margin-left: 5.0em"><dt>Sandboxing strict
<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)
<dt>ServerBin directory
<dd style="margin-left: 5.0em"><br>
Specifies the directory where backends, CGIs, daemons, and filters may
be found.
<dt>ServerKeychain path
<dd style="margin-left: 5.0em"><br>
Specifies the location of TLS certificates and private keys.
<dt>ServerRoot directory
<dd style="margin-left: 5.0em"><br>
Specifies the directory where the server configuration files can be found.
<dt>SyncOnClose Yes
<dd style="margin-left: 5.0em"><dt>SyncOnClose No
<dd style="margin-left: 5.0em">Specifies whether the scheduler calls <i>fsync(2)</i> after writing configuration
or state files. The default is No.
<dt>SystemGroup group-name [group-name ...]
<dd style="margin-left: 5.0em"><br>
Specifies the group(s) to use for System class authentication.
<dt>TempDir directory
<dd style="margin-left: 5.0em"><br>
Specifies the directory where temporary files are stored.
<dt>User user-name
<dd style="margin-left: 5.0em"><br>
Specifies the user name or ID that is used when running external programs.
</dl>
<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:
2909c66c MS	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>
c277f98c	25	Defines the access log filename.
2909c66c MS	26	<dt>ConfigFilePerm mode
2909c66c MS	27	<dd style="margin-left: 5.0em"><br>
c277f98c	28	Specifies the permissions for all configuration files that the scheduler
94436c5a	29	writes.
2909c66c MS	30	<dt>DataDir path
2909c66c MS	31	<dd style="margin-left: 5.0em"><br>
c277f98c	32	Specified the directory where data files can be found.
2909c66c MS	33	<dt>DocumentRoot directory
2909c66c MS	34	<dd style="margin-left: 5.0em"><br>
c277f98c	35	Specifies the root directory for the internal web server documents.
2909c66c MS	36	<dt>ErrorLog filename
	37	<dd style="margin-left: 5.0em"><dt>ErrorLog syslog
	38	<dd style="margin-left: 5.0em"><br>
c277f98c	39	Specifies the error log filename.
2909c66c MS	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>
c277f98c	44	Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
94436c5a	45	"browse", "config", "listen", "log", or "permissions".
2909c66c MS	46	<dt>FileDevice Yes
	47	<dd style="margin-left: 5.0em"><dt>FileDevice No
	48	<dd style="margin-left: 5.0em"><br>
c277f98c	49	Specifies whether the file pseudo-device can be used for new
94436c5a	50	printer queues.
2909c66c MS	51	<dt>FontPath directory[:directory:...]
2909c66c MS	52	<dd style="margin-left: 5.0em"><br>
c277f98c	53	Specifies the search path for fonts.
2909c66c MS	54	<dt>Group group-name-or-number
2909c66c MS	55	<dd style="margin-left: 5.0em"><br>
c277f98c	56	Specifies the group name or ID that will be used when executing
94436c5a	57	external programs.
2909c66c MS	58	<dt>LogFilePerm mode
2909c66c MS	59	<dd style="margin-left: 5.0em"><br>
c277f98c	60	Specifies the permissions for all log files that the scheduler writes.
2909c66c MS	61	<dt>PageLog filename
	62	<dd style="margin-left: 5.0em"><dt>PageLog syslog
	63	<dd style="margin-left: 5.0em"><br>
c277f98c	64	Specifies the page log filename.
2909c66c MS	65	<dt>Printcap
	66	<dd style="margin-left: 5.0em"><dt>Printcap filename
	67	<dd style="margin-left: 5.0em"><br>
c277f98c	68	Specifies the filename for a printcap file that is updated
94436c5a MS	69	automatically with a list of available printers (needed for
	70	legacy applications); specifying Printcap with no filename
	71	disables printcap generation.
2909c66c MS	72	<dt>RemoteRoot user-name
2909c66c MS	73	<dd style="margin-left: 5.0em"><br>
c277f98c	74	Specifies the username that is associated with unauthenticated root
94436c5a	75	accesses.
2909c66c MS	76	<dt>RequestRoot directory
2909c66c MS	77	<dd style="margin-left: 5.0em"><br>
c277f98c	78	Specifies the directory to store print jobs and other HTTP request
94436c5a	79	data.
2909c66c MS	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>
c277f98c	86	Specifies the directory where backends, CGIs, daemons, and filters may
8fe0183a	87	be found.
2909c66c MS	88	<dt>ServerKeychain path
2909c66c MS	89	<dd style="margin-left: 5.0em"><br>
c277f98c	90	Specifies the location of TLS certificates and private keys.
2909c66c MS	91	<dt>ServerRoot directory
2909c66c MS	92	<dd style="margin-left: 5.0em"><br>
c277f98c	93	Specifies the directory where the server configuration files can be found.
2909c66c MS	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
5ec1fd3d	97	or state files. The default is No.
2909c66c MS	98	<dt>SystemGroup group-name [group-name ...]
2909c66c MS	99	<dd style="margin-left: 5.0em"><br>
c277f98c	100	Specifies the group(s) to use for System class authentication.
2909c66c MS	101	<dt>TempDir directory
2909c66c MS	102	<dd style="margin-left: 5.0em"><br>
c277f98c	103	Specifies the directory where temporary files are stored.
2909c66c MS	104	<dt>User user-name
2909c66c MS	105	<dd style="margin-left: 5.0em"><br>
c277f98c	106	Specifies the user name or ID that is used when running external programs.
2909c66c	107	</dl>
94436c5a	108	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
c277f98c MS	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>,
94436c5a	112	<br>
c277f98c	113	<a href="http://localhost:631/help">http://localhost:631/help</a>
94436c5a	114	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
8fe0183a	115	Copyright 2007-2014 by Apple Inc.
94436c5a MS	116
	117	</body>
	118	</html>