[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 <b>cups-files.conf</b> file configures the files and directories used by the CUPS scheduler,
<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(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.
<h3><a name="DIRECTIVES">Directives</a></h3>
The following directives are understood by
<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
<dl class="man">
<dt><b>AccessLog </b><i>filename</i>
<dd style="margin-left: 5.0em"><dt><b>AccessLog </b>[ <i>filename</i> ]
<dd style="margin-left: 5.0em"><dt><b>AccessLog syslog</b>
<dd style="margin-left: 5.0em">Defines the access log filename.
The value "syslog" causes log entries to be sent to the system log daemon.
Specifying a blank filename disables access log generation.
The server name may be included in filenames using the string "%s", for example:
<pre class="man">

    AccessLog /var/log/cups/%s-access_log

</pre>
<dt><b>ConfigFilePerm </b><i>mode</i>
<dd style="margin-left: 5.0em">Specifies the permissions for all configuration files that the scheduler writes.
The default is 0644 on OS X and 0640 on all other operating systems.
<b>Note:</b> The permissions for the printers.conf file are currently masked to only allow access from the scheduler user (typically root).
This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system.
There is no way to disable this security feature.
<dt><b>DataDir </b><i>path</i>
<dd style="margin-left: 5.0em">Specifies the directory where data files can be found. The default is usually <i>/usr/share/cups</i>.
<dt><b>DocumentRoot </b><i>directory</i>
<dd style="margin-left: 5.0em">Specifies the root directory for the CUPS web interface content. The default is usually <i>/usr/share/doc/cups</i>.
<dt><b>ErrorLog </b>[ <i>filename</i> ]
<dd style="margin-left: 5.0em"><dt><b>ErrorLog syslog</b>
<dd style="margin-left: 5.0em">Defines the error log filename.
The value "syslog" causes log entries to be sent to the system log daemon.
Specifying a blank filename disables error log generation.
The server name may be included in filenames using the string "%s", for example:
<pre class="man">

    ErrorLog /var/log/cups/%s-error_log

</pre>
<dt><b>FatalErrors none</b>
<dd style="margin-left: 5.0em"><dt><b>FatalErrors all </b><i>-kind </i>[ <i>... -kind </i>]
<dd style="margin-left: 5.0em"><dt><b>FatalErrors </b><i>kind </i>[ <i>... kind </i>]
<dd style="margin-left: 5.0em">Specifies which errors are fatal, causing the scheduler to exit.
The default setting is "config".
The <i>kind</i> strings are:
<div style="margin-left: 0.0em;">
<dl class="man">
<dt><b>none</b>
<dd style="margin-left: 5.0em">No errors are fatal.
<dt><b>all</b>
<dd style="margin-left: 5.0em">All of the errors below are fatal.
<dt><b>browse</b>
<dd style="margin-left: 5.0em">Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon.
<dt><b>config</b>
<dd style="margin-left: 5.0em">Configuration file syntax errors are fatal.
<dt><b>listen</b>
<dd style="margin-left: 5.0em">Listen or Port errors are fatal, except for IPv6 failures on the loopback or "any" addresses.
<dt><b>log</b>
<dd style="margin-left: 5.0em">Log file creation or write errors are fatal.
<dt><b>permissions</b>
<dd style="margin-left: 5.0em">Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions.
</div>
<dt><b>FileDevice Yes</b>
<dd style="margin-left: 5.0em"><dt><b>FileDevice No</b>
<dd style="margin-left: 5.0em">Specifies whether the file pseudo-device can be used for new printer queues.
The URI "file:///dev/null" is always allowed.
<dt><b>FontPath </b><i>directory</i>[:<i>...</i>:<i>directory</i>]
<dd style="margin-left: 5.0em">Specifies the search path for fonts.
<b>This directive is deprecated and will no longer be supported in a future release of CUPS.</b>
<dt><b>Group </b><i>group-name-or-number</i>
<dd style="margin-left: 5.0em">Specifies the group name or ID that will be used when executing external programs.
The default group is operating system specific but is usually <i>lp</i> or <i>nobody</i>.
<dt><b>LogFilePerm </b><i>mode</i>
<dd style="margin-left: 5.0em">Specifies the permissions of all log files that the scheduler writes. The default is 0644.
<dt><b>PageLog </b>[ <i>filename</i> ]
<dd style="margin-left: 5.0em"><dt><b>PageLog syslog</b>
<dd style="margin-left: 5.0em">Defines the page log filename.
The value "syslog" causes log entries to be sent to the system log daemon.
Specifying a blank filename disables page log generation.
The server name may be included in filenames using the string "%s", for example:
<pre class="man">

    PageLog /var/log/cups/%s-page_log

</pre>
<dt><b>Printcap </b>[ <i>filename</i> ]
<dd style="margin-left: 5.0em">Defines the printcap filename that the scheduler automatically updates with the current list of available printers, which is sometimes used by legacy applications.
Specifying a blank filename disables printcap generation.
<b>This directive is deprecated and will no longer be supported in a future release of CUPS.</b>
<dt><b>RemoteRoot </b><i>username</i>
<dd style="margin-left: 5.0em">Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user.
<dt><b>RequestRoot </b><i>directory</i>
<dd style="margin-left: 5.0em">Specifies the directory that contains print jobs and other HTTP request data.
<dt><b>Sandboxing off</b>
<dd style="margin-left: 5.0em"><dt><b>Sandboxing relaxed</b>
<dd style="margin-left: 5.0em"><dt><b>Sandboxing strict</b>
<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".
This directive is currently only used on OS X.
<dt><b>ServerBin </b><i>directory</i>
<dd style="margin-left: 5.0em">Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors.
<dt><b>ServerKeychain </b><i>path</i>
<dd style="margin-left: 5.0em">Specifies the location of TLS certificates and private keys.
<dt><b>ServerRoot </b><i>directory</i>
<dd style="margin-left: 5.0em">Specifies the directory containing the server configuration files.
<dt><b>SyncOnClose Yes</b>
<dd style="margin-left: 5.0em"><dt><b>SyncOnClose No</b>
<dd style="margin-left: 5.0em">Specifies whether the scheduler calls
<b>fsync</b>(2)
after writing configuration or state files. The default is No.
<dt><b>SystemGroup </b><i>group-name </i>[ <i>... group-name</i> ]
<dd style="margin-left: 5.0em">Specifies the group(s) to use for <i>@SYSTEM</i> group authentication.
<dt><b>TempDir </b><i>directory</i>
<dd style="margin-left: 5.0em">Specifies the directory where temporary files are stored.
<dt><b>User </b><i>username</i>
<dd style="margin-left: 5.0em">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>
<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a>
<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a>
<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright &copy; 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>
291e4727 MS	13	The <b>cups-files.conf</b> file configures the files and directories used by the CUPS scheduler,
	14	<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a>
	15	It is normally located in the <i>/etc/cups</i> directory.
	16	<p>Each line in the file can be a configuration directive, a blank line, or a comment.
	17	Comment lines start with the # character.
	18	<h3><a name="DIRECTIVES">Directives</a></h3>
	19	The following directives are understood by
	20	<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
2909c66c	21	<dl class="man">
291e4727 MS	22	<dt><b>AccessLog </b><i>filename</i>
	23	<dd style="margin-left: 5.0em"><dt><b>AccessLog </b>[ <i>filename</i> ]
	24	<dd style="margin-left: 5.0em"><dt><b>AccessLog syslog</b>
	25	<dd style="margin-left: 5.0em">Defines the access log filename.
	26	The value "syslog" causes log entries to be sent to the system log daemon.
	27	Specifying a blank filename disables access log generation.
	28	The server name may be included in filenames using the string "%s", for example:
	29	<pre class="man">
	30
	31	AccessLog /var/log/cups/%s-access_log
	32
	33	</pre>
	34	<dt><b>ConfigFilePerm </b><i>mode</i>
	35	<dd style="margin-left: 5.0em">Specifies the permissions for all configuration files that the scheduler writes.
	36	The default is 0644 on OS X and 0640 on all other operating systems.
	37	<b>Note:</b> The permissions for the printers.conf file are currently masked to only allow access from the scheduler user (typically root).
	38	This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system.
	39	There is no way to disable this security feature.
	40	<dt><b>DataDir </b><i>path</i>
	41	<dd style="margin-left: 5.0em">Specifies the directory where data files can be found. The default is usually <i>/usr/share/cups</i>.
	42	<dt><b>DocumentRoot </b><i>directory</i>
	43	<dd style="margin-left: 5.0em">Specifies the root directory for the CUPS web interface content. The default is usually <i>/usr/share/doc/cups</i>.
	44	<dt><b>ErrorLog </b>[ <i>filename</i> ]
	45	<dd style="margin-left: 5.0em"><dt><b>ErrorLog syslog</b>
	46	<dd style="margin-left: 5.0em">Defines the error log filename.
	47	The value "syslog" causes log entries to be sent to the system log daemon.
	48	Specifying a blank filename disables error log generation.
	49	The server name may be included in filenames using the string "%s", for example:
	50	<pre class="man">
	51
	52	ErrorLog /var/log/cups/%s-error_log
	53
	54	</pre>
	55	<dt><b>FatalErrors none</b>
	56	<dd style="margin-left: 5.0em"><dt><b>FatalErrors all </b><i>-kind </i>[ <i>... -kind </i>]
	57	<dd style="margin-left: 5.0em"><dt><b>FatalErrors </b><i>kind </i>[ <i>... kind </i>]
	58	<dd style="margin-left: 5.0em">Specifies which errors are fatal, causing the scheduler to exit.
	59	The default setting is "config".
	60	The <i>kind</i> strings are:
	61	<div style="margin-left: 0.0em;">
	62	<dl class="man">
	63	<dt><b>none</b>
	64	<dd style="margin-left: 5.0em">No errors are fatal.
	65	<dt><b>all</b>
	66	<dd style="margin-left: 5.0em">All of the errors below are fatal.
	67	<dt><b>browse</b>
	68	<dd style="margin-left: 5.0em">Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon.
	69	<dt><b>config</b>
	70	<dd style="margin-left: 5.0em">Configuration file syntax errors are fatal.
	71	<dt><b>listen</b>
	72	<dd style="margin-left: 5.0em">Listen or Port errors are fatal, except for IPv6 failures on the loopback or "any" addresses.
	73	<dt><b>log</b>
	74	<dd style="margin-left: 5.0em">Log file creation or write errors are fatal.
	75	<dt><b>permissions</b>
	76	<dd style="margin-left: 5.0em">Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions.
	77	</div>
	78	<dt><b>FileDevice Yes</b>
	79	<dd style="margin-left: 5.0em"><dt><b>FileDevice No</b>
	80	<dd style="margin-left: 5.0em">Specifies whether the file pseudo-device can be used for new printer queues.
	81	The URI "file:///dev/null" is always allowed.
	82	<dt><b>FontPath </b><i>directory</i>[:<i>...</i>:<i>directory</i>]
	83	<dd style="margin-left: 5.0em">Specifies the search path for fonts.
	84	<b>This directive is deprecated and will no longer be supported in a future release of CUPS.</b>
	85	<dt><b>Group </b><i>group-name-or-number</i>
86	<dd style="margin-left: 5.0em">Specifies the group name or ID that will be used when executing external programs.
87	The default group is operating system specific but is usually <i>lp</i> or <i>nobody</i>.
88	<dt><b>LogFilePerm </b><i>mode</i>
89	<dd style="margin-left: 5.0em">Specifies the permissions of all log files that the scheduler writes. The default is 0644.
90	<dt><b>PageLog </b>[ <i>filename</i> ]
91	<dd style="margin-left: 5.0em"><dt><b>PageLog syslog</b>
92	<dd style="margin-left: 5.0em">Defines the page log filename.
93	The value "syslog" causes log entries to be sent to the system log daemon.
94	Specifying a blank filename disables page log generation.
95	The server name may be included in filenames using the string "%s", for example:
96	<pre class="man">
97
98	PageLog /var/log/cups/%s-page_log
99
100	</pre>
101	<dt><b>Printcap </b>[ <i>filename</i> ]
102	<dd style="margin-left: 5.0em">Defines the printcap filename that the scheduler automatically updates with the current list of available printers, which is sometimes used by legacy applications.
103	Specifying a blank filename disables printcap generation.
104	<b>This directive is deprecated and will no longer be supported in a future release of CUPS.</b>
105	<dt><b>RemoteRoot </b><i>username</i>
106	<dd style="margin-left: 5.0em">Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user.
107	<dt><b>RequestRoot </b><i>directory</i>
108	<dd style="margin-left: 5.0em">Specifies the directory that contains print jobs and other HTTP request data.
109	<dt><b>Sandboxing off</b>
110	<dd style="margin-left: 5.0em"><dt><b>Sandboxing relaxed</b>
111	<dd style="margin-left: 5.0em"><dt><b>Sandboxing strict</b>
112	<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.
113	The default is "strict".
114	This directive is currently only used on OS X.
115	<dt><b>ServerBin </b><i>directory</i>
116	<dd style="margin-left: 5.0em">Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors.
117	<dt><b>ServerKeychain </b><i>path</i>
118	<dd style="margin-left: 5.0em">Specifies the location of TLS certificates and private keys.
119	<dt><b>ServerRoot </b><i>directory</i>
120	<dd style="margin-left: 5.0em">Specifies the directory containing the server configuration files.
121	<dt><b>SyncOnClose Yes</b>
122	<dd style="margin-left: 5.0em"><dt><b>SyncOnClose No</b>
123	<dd style="margin-left: 5.0em">Specifies whether the scheduler calls
124	<b>fsync</b>(2)
125	after writing configuration or state files. The default is No.
126	<dt><b>SystemGroup </b><i>group-name </i>[ <i>... group-name</i> ]
127	<dd style="margin-left: 5.0em">Specifies the group(s) to use for <i>@SYSTEM</i> group authentication.
128	<dt><b>TempDir </b><i>directory</i>
129	<dd style="margin-left: 5.0em">Specifies the directory where temporary files are stored.
130	<dt><b>User </b><i>username</i>
131	<dd style="margin-left: 5.0em">Specifies the user name or ID that is used when running external programs.
2909c66c	132	</dl>
94436c5a	133	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
291e4727 MS	134	<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a>
	135	<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
	136	<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
	137	<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
	138	<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
	139	<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
	140	<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a>
	141	<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
	142	CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
94436c5a	143	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
291e4727	144	Copyright © 2007-2014 by Apple Inc.
94436c5a MS	145
	146	</body>
	147	</html>