[thirdparty/cups.git] / man / cups-files.conf.man.in

.\"
.\" cups-files.conf man page for CUPS.
.\"
.\" Copyright 2007-2017 by Apple Inc.
.\" Copyright 1997-2006 by Easy Software Products.
.\"
.\" Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
.\"
.TH cups-files.conf 5 "CUPS" "21 September 2017" "Apple Inc."
.SH NAME
cups\-files.conf \- file and directory configuration file for cups
.SH DESCRIPTION
The \fBcups\-files.conf\fR file configures the files and directories used by the CUPS scheduler,
.BR cupsd (8).
It is normally located in the \fI/etc/cups\fR directory.
.LP
Each line in the file can be a configuration directive, a blank line, or a comment.
Configuration directives typically consist of a name and zero or more values separated by whitespace.
The configuration directive name and values are case-insensitive.
Comment lines start with the # character.
.SS DIRECTIVES
The following directives are understood by
.BR cupsd (8):
.\"#AccessLog
.TP 5
\fBAccessLog\fR
.TP 5
\fBAccessLog \fIfilename\fR
.TP 5
\fBAccessLog stderr\fR
.TP 5
\fBAccessLog syslog\fR
Defines the access log filename.
Specifying a blank filename disables access log generation.
The value "stderr" causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.
The value "syslog" causes log entries to be sent to the system log daemon.
The server name may be included in filenames using the string "%s", for example:
.nf

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

.fi
The default is "/var/log/cups/access_log".
.\"#CacheDir
.TP 5
\fBCacheDir \fIdirectory\fR
Specifies the directory to use for long-lived temporary (cache) files.
The default is "/var/spool/cups/cache" or "/var/cache/cups" depending on the platform.
.\"#ConfigFilePerm
.TP 5
\fBConfigFilePerm \fImode\fR
Specifies the permissions for all configuration files that the scheduler writes.
The default is "0644" on macOS and "0640" on all other operating systems.
.LP
\fBNote:\fR The permissions for the \fIprinters.conf\fR 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.
.\"#CreateSelfSignedCerts
.TP 5
\fBCreateSelfSignedCerts yes\fR
.TP 5
\fBCreateSelfSignedCerts no\fR
Specifies whether the scheduler automatically creates self-signed certificates for client connections using TLS.
The default is yes.
.\"#DataDir
.TP 5
\fBDataDir \fIpath\fR
Specifies the directory where data files can be found.
The default is usually "/usr/share/cups".
.\"#DocumentRoot
.TP 5
\fBDocumentRoot \fIdirectory\fR
Specifies the root directory for the CUPS web interface content.
The default is usually "/usr/share/doc/cups".
.\"#ErrorLog
.TP 5
\fBErrorLog\fR
.TP 5
\fBErrorLog \fIfilename\fR
.TP 5
\fBErrorLog stderr\fR
.TP 5
\fBErrorLog syslog\fR
Defines the error log filename.
Specifying a blank filename disables error log generation.
The value "stderr" causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.
The value "syslog" causes log entries to be sent to the system log daemon.
The server name may be included in filenames using the string "%s", for example:
.nf

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

.fi
The default is "/var/log/cups/error_log".
.\"#FatalErrors
.TP 5
\fBFatalErrors none\fR
.TP 5
\fBFatalErrors all \fI\-kind \fR[ ... \fI\-kind \fR]
.TP 5
\fBFatalErrors \fIkind \fR[ ... \fIkind \fR]
Specifies which errors are fatal, causing the scheduler to exit.
The default is "config".
The \fIkind\fR strings are:
.RS 5
.TP 5
.B none
No errors are fatal.
.TP 5
.B all
All of the errors below are fatal.
.TP 5
.B browse
Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon.
.TP 5
.B config
Configuration file syntax errors are fatal.
.TP 5
.B listen
Listen or Port errors are fatal, except for IPv6 failures on the loopback or "any" addresses.
.TP 5
.B log
Log file creation or write errors are fatal.
.TP 5
.B permissions
Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions.
.RE
.\"#Group
.TP 5
\fBGroup \fIgroup-name-or-number\fR
Specifies the group name or ID that will be used when executing external programs.
The default group is operating system specific but is usually "lp" or "nobody".
.\"#LogFilePerm
.TP 5
\fBLogFilePerm \fImode\fR
Specifies the permissions of all log files that the scheduler writes.
The default is "0644".
.\"#PageLog
.TP 5
\fBPageLog \fR[ \fIfilename\fR ]
.TP 5
\fBPageLog stderr\fR
.TP 5
\fBPageLog syslog\fR
Defines the page log filename.
The value "stderr" causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.
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:
.nf

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

.fi
The default is "/var/log/cups/page_log".
.\"#RemoteRoot
.TP 5
\fBRemoteRoot \fIusername\fR
Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user.
The default is "remroot".
.\"#RequestRoot
.TP 5
\fBRequestRoot \fIdirectory\fR
Specifies the directory that contains print jobs and other HTTP request data.
The default is "/var/spool/cups".
.\"#Sandboxing
.TP 5
\fBSandboxing relaxed\fR
.TP 5
\fBSandboxing strict\fR
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/supported on macOS.
.\"#ServerBin
.TP 5
\fBServerBin \fIdirectory\fR
Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors.
The default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the platform.
.\"#ServerKeychain
.TP 5
\fBServerKeychain \fIpath\fR
Specifies the location of TLS certificates and private keys.
The default is "/Library/Keychains/System.keychain" on macOS and "/etc/cups/ssl" on all other operating systems.
macOS uses its keychain database to store certificates and keys while other platforms use separate files in the specified directory, *.crt for PEM-encoded certificates and *.key for PEM-encoded private keys.
.\"#ServerRoot
.TP 5
\fBServerRoot \fIdirectory\fR
Specifies the directory containing the server configuration files.
The default is "/etc/cups".
.\"#StateDir
.TP 5
\fBStateDir \fIdirectory\fR
Specifies the directory to use for PID and local certificate files.
The default is "/var/run/cups" or "/etc/cups" depending on the platform.
.\"#SyncOnClose
.TP 5
\fBSyncOnClose Yes\fR
.TP 5
\fBSyncOnClose No\fR
Specifies whether the scheduler calls
.BR fsync (2)
after writing configuration or state files.
The default is "No".
.\"#SystemGroup
.TP 5
\fBSystemGroup \fIgroup-name \fR[ ... \fIgroup-name\fR ]
Specifies the group(s) to use for \fI@SYSTEM\fR group authentication.
The default contains "admin", "lpadmin", "root", "sys", and/or "system".
.\"#TempDir
.TP 5
\fBTempDir \fIdirectory\fR
Specifies the directory where short-term temporary files are stored.
The default is "/var/spool/cups/tmp".
.\"#User
.TP 5
\fBUser \fIusername\fR
Specifies the user name or ID that is used when running external programs.
The default is "lp".
.SS DEPRECATED DIRECTIVES
The following directives are deprecated and will be removed from a future version of CUPS:
.\"#FileDevice
.TP 5
\fBFileDevice Yes\fR
.TP 5
\fBFileDevice No\fR
Specifies whether the file pseudo-device can be used for new printer queues.
The URI "file:///dev/null" is always allowed.
File devices cannot be used with "raw" print queues - a PPD file is required.
The specified file is overwritten for every print job.
Writing to directories is not supported.
.\"#FontPath
.TP 5
\fBFontPath \fIdirectory[:...:directoryN]\fR
Specifies a colon separated list of directories where fonts can be found.
On Linux the
.BR font-config (1)
mechanism is used instead.
On macOS the Font Book application manages system-installed fonts.
.\"#LPDConfigFile
.TP 5
\fB LPDConfigFile \fIfilename\fR
Specifies the LPD service configuration file to update.
.\"#Printcap
.TP 5
\fBPrintcap \fIfilename\fR
Specifies a file that is filled with a list of local print queues.
.\"#PrintcapFormat
.TP 5
\fBPrintcapFormat bsd\fR
.TP 5
\fBPrintcapFormat plist\fR
.TP 5
\fBPrintcapFormat solaris\fR
Specifies the format to use for the Printcap file.
"bsd" is the historical LPD printcap file format.
"plist" is the Apple plist file format.
"solaris" is the historical Solaris LPD printcap file format.
.\"#SMBConfigFile
.TP 5
\fBSMBConfigFile \fIfilename\fR
Specifies the SMB service configuration file to update.
.SH SEE ALSO
.BR classes.conf (5),
.BR cups (1),
.BR cupsd (8),
.BR cupsd.conf (5),
.BR mime.convs (5),
.BR mime.types (5),
.BR printers.conf (5),
.BR subscriptions.conf (5),
CUPS Online Help (http://localhost:631/help)
.SH COPYRIGHT
Copyright \[co] 2007-2017 by Apple Inc.
Commit	Line	Data
	1	.\"
	2	.\" cups-files.conf man page for CUPS.
	3	.\"
	4	.\" Copyright 2007-2017 by Apple Inc.
	5	.\" Copyright 1997-2006 by Easy Software Products.
	6	.\"
	7	.\" Licensed under Apache License v2.0. See the file "LICENSE" for more information.
	8	.\"
	9	.TH cups-files.conf 5 "CUPS" "21 September 2017" "Apple Inc."
	10	.SH NAME
	11	cups\-files.conf \- file and directory configuration file for cups
	12	.SH DESCRIPTION
	13	The \fBcups\-files.conf\fR file configures the files and directories used by the CUPS scheduler,
	14	.BR cupsd (8).
	15	It is normally located in the \fI/etc/cups\fR directory.
	16	.LP
	17	Each line in the file can be a configuration directive, a blank line, or a comment.
	18	Configuration directives typically consist of a name and zero or more values separated by whitespace.
	19	The configuration directive name and values are case-insensitive.
	20	Comment lines start with the # character.
	21	.SS DIRECTIVES
	22	The following directives are understood by
	23	.BR cupsd (8):
	24	.\"#AccessLog
	25	.TP 5
	26	\fBAccessLog\fR
	27	.TP 5
	28	\fBAccessLog \fIfilename\fR
	29	.TP 5
	30	\fBAccessLog stderr\fR
	31	.TP 5
	32	\fBAccessLog syslog\fR
	33	Defines the access log filename.
	34	Specifying a blank filename disables access log generation.
	35	The value "stderr" causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.
	36	The value "syslog" causes log entries to be sent to the system log daemon.
	37	The server name may be included in filenames using the string "%s", for example:
	38	.nf
	39
	40	AccessLog /var/log/cups/%s-access_log
	41
	42	.fi
	43	The default is "/var/log/cups/access_log".
	44	.\"#CacheDir
	45	.TP 5
	46	\fBCacheDir \fIdirectory\fR
	47	Specifies the directory to use for long-lived temporary (cache) files.
	48	The default is "/var/spool/cups/cache" or "/var/cache/cups" depending on the platform.
	49	.\"#ConfigFilePerm
	50	.TP 5
	51	\fBConfigFilePerm \fImode\fR
	52	Specifies the permissions for all configuration files that the scheduler writes.
	53	The default is "0644" on macOS and "0640" on all other operating systems.
	54	.LP
	55	\fBNote:\fR The permissions for the \fIprinters.conf\fR file are currently masked to only allow access from the scheduler user (typically root).
	56	This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system.
	57	There is no way to disable this security feature.
	58	.\"#CreateSelfSignedCerts
	59	.TP 5
	60	\fBCreateSelfSignedCerts yes\fR
	61	.TP 5
	62	\fBCreateSelfSignedCerts no\fR
	63	Specifies whether the scheduler automatically creates self-signed certificates for client connections using TLS.
	64	The default is yes.
	65	.\"#DataDir
	66	.TP 5
	67	\fBDataDir \fIpath\fR
	68	Specifies the directory where data files can be found.
	69	The default is usually "/usr/share/cups".
	70	.\"#DocumentRoot
	71	.TP 5
	72	\fBDocumentRoot \fIdirectory\fR
	73	Specifies the root directory for the CUPS web interface content.
	74	The default is usually "/usr/share/doc/cups".
	75	.\"#ErrorLog
	76	.TP 5
	77	\fBErrorLog\fR
	78	.TP 5
	79	\fBErrorLog \fIfilename\fR
	80	.TP 5
	81	\fBErrorLog stderr\fR
	82	.TP 5
	83	\fBErrorLog syslog\fR
	84	Defines the error log filename.
	85	Specifying a blank filename disables error log generation.
	86	The value "stderr" causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.
	87	The value "syslog" causes log entries to be sent to the system log daemon.
	88	The server name may be included in filenames using the string "%s", for example:
	89	.nf
	90
	91	ErrorLog /var/log/cups/%s-error_log
	92
	93	.fi
	94	The default is "/var/log/cups/error_log".
	95	.\"#FatalErrors
	96	.TP 5
	97	\fBFatalErrors none\fR
	98	.TP 5
	99	\fBFatalErrors all \fI\-kind \fR[ ... \fI\-kind \fR]
	100	.TP 5
	101	\fBFatalErrors \fIkind \fR[ ... \fIkind \fR]
	102	Specifies which errors are fatal, causing the scheduler to exit.
	103	The default is "config".
	104	The \fIkind\fR strings are:
	105	.RS 5
	106	.TP 5
	107	.B none
	108	No errors are fatal.
	109	.TP 5
	110	.B all
	111	All of the errors below are fatal.
	112	.TP 5
	113	.B browse
	114	Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon.
	115	.TP 5
	116	.B config
	117	Configuration file syntax errors are fatal.
	118	.TP 5
	119	.B listen
	120	Listen or Port errors are fatal, except for IPv6 failures on the loopback or "any" addresses.
	121	.TP 5
	122	.B log
	123	Log file creation or write errors are fatal.
	124	.TP 5
	125	.B permissions
	126	Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions.
	127	.RE
	128	.\"#Group
	129	.TP 5
	130	\fBGroup \fIgroup-name-or-number\fR
	131	Specifies the group name or ID that will be used when executing external programs.
	132	The default group is operating system specific but is usually "lp" or "nobody".
	133	.\"#LogFilePerm
	134	.TP 5
	135	\fBLogFilePerm \fImode\fR
	136	Specifies the permissions of all log files that the scheduler writes.
	137	The default is "0644".
	138	.\"#PageLog
	139	.TP 5
	140	\fBPageLog \fR[ \fIfilename\fR ]
	141	.TP 5
	142	\fBPageLog stderr\fR
	143	.TP 5
	144	\fBPageLog syslog\fR
	145	Defines the page log filename.
	146	The value "stderr" causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background.
	147	The value "syslog" causes log entries to be sent to the system log daemon.
	148	Specifying a blank filename disables page log generation.
	149	The server name may be included in filenames using the string "%s", for example:
	150	.nf
	151
	152	PageLog /var/log/cups/%s-page_log
	153
	154	.fi
	155	The default is "/var/log/cups/page_log".
	156	.\"#RemoteRoot
	157	.TP 5
	158	\fBRemoteRoot \fIusername\fR
	159	Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user.
	160	The default is "remroot".
	161	.\"#RequestRoot
	162	.TP 5
	163	\fBRequestRoot \fIdirectory\fR
	164	Specifies the directory that contains print jobs and other HTTP request data.
	165	The default is "/var/spool/cups".
	166	.\"#Sandboxing
	167	.TP 5
	168	\fBSandboxing relaxed\fR
	169	.TP 5
	170	\fBSandboxing strict\fR
	171	Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler.
	172	The default is "strict".
	173	This directive is currently only used/supported on macOS.
	174	.\"#ServerBin
	175	.TP 5
	176	\fBServerBin \fIdirectory\fR
	177	Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors.
	178	The default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the platform.
	179	.\"#ServerKeychain
	180	.TP 5
	181	\fBServerKeychain \fIpath\fR
	182	Specifies the location of TLS certificates and private keys.
	183	The default is "/Library/Keychains/System.keychain" on macOS and "/etc/cups/ssl" on all other operating systems.
	184	macOS uses its keychain database to store certificates and keys while other platforms use separate files in the specified directory, .crt for PEM-encoded certificates and .key for PEM-encoded private keys.
	185	.\"#ServerRoot
	186	.TP 5
	187	\fBServerRoot \fIdirectory\fR
	188	Specifies the directory containing the server configuration files.
	189	The default is "/etc/cups".
	190	.\"#StateDir
	191	.TP 5
	192	\fBStateDir \fIdirectory\fR
	193	Specifies the directory to use for PID and local certificate files.
	194	The default is "/var/run/cups" or "/etc/cups" depending on the platform.
	195	.\"#SyncOnClose
	196	.TP 5
	197	\fBSyncOnClose Yes\fR
	198	.TP 5
	199	\fBSyncOnClose No\fR
	200	Specifies whether the scheduler calls
	201	.BR fsync (2)
	202	after writing configuration or state files.
	203	The default is "No".
	204	.\"#SystemGroup
	205	.TP 5
	206	\fBSystemGroup \fIgroup-name \fR[ ... \fIgroup-name\fR ]
	207	Specifies the group(s) to use for \fI@SYSTEM\fR group authentication.
	208	The default contains "admin", "lpadmin", "root", "sys", and/or "system".
	209	.\"#TempDir
	210	.TP 5
	211	\fBTempDir \fIdirectory\fR
	212	Specifies the directory where short-term temporary files are stored.
	213	The default is "/var/spool/cups/tmp".
	214	.\"#User
	215	.TP 5
	216	\fBUser \fIusername\fR
	217	Specifies the user name or ID that is used when running external programs.
	218	The default is "lp".
	219	.SS DEPRECATED DIRECTIVES
	220	The following directives are deprecated and will be removed from a future version of CUPS:
	221	.\"#FileDevice
	222	.TP 5
	223	\fBFileDevice Yes\fR
	224	.TP 5
	225	\fBFileDevice No\fR
	226	Specifies whether the file pseudo-device can be used for new printer queues.
	227	The URI "file:///dev/null" is always allowed.
	228	File devices cannot be used with "raw" print queues - a PPD file is required.
	229	The specified file is overwritten for every print job.
	230	Writing to directories is not supported.
	231	.\"#FontPath
	232	.TP 5
	233	\fBFontPath \fIdirectory[:...:directoryN]\fR
	234	Specifies a colon separated list of directories where fonts can be found.
	235	On Linux the
	236	.BR font-config (1)
	237	mechanism is used instead.
	238	On macOS the Font Book application manages system-installed fonts.
	239	.\"#LPDConfigFile
	240	.TP 5
	241	\fB LPDConfigFile \fIfilename\fR
	242	Specifies the LPD service configuration file to update.
	243	.\"#Printcap
	244	.TP 5
	245	\fBPrintcap \fIfilename\fR
	246	Specifies a file that is filled with a list of local print queues.
	247	.\"#PrintcapFormat
	248	.TP 5
	249	\fBPrintcapFormat bsd\fR
	250	.TP 5
	251	\fBPrintcapFormat plist\fR
	252	.TP 5
	253	\fBPrintcapFormat solaris\fR
	254	Specifies the format to use for the Printcap file.
	255	"bsd" is the historical LPD printcap file format.
	256	"plist" is the Apple plist file format.
	257	"solaris" is the historical Solaris LPD printcap file format.
	258	.\"#SMBConfigFile
	259	.TP 5
	260	\fBSMBConfigFile \fIfilename\fR
	261	Specifies the SMB service configuration file to update.
	262	.SH SEE ALSO
	263	.BR classes.conf (5),
	264	.BR cups (1),
	265	.BR cupsd (8),
	266	.BR cupsd.conf (5),
	267	.BR mime.convs (5),
	268	.BR mime.types (5),
	269	.BR printers.conf (5),
	270	.BR subscriptions.conf (5),
	271	CUPS Online Help (http://localhost:631/help)
	272	.SH COPYRIGHT
	273	Copyright \[co] 2007-2017 by Apple Inc.