.\"
.\" cups-files.conf man page for CUPS.
.\"
-.\" Copyright 2007-2015 by Apple Inc.
-.\" Copyright 1997-2006 by Easy Software Products.
+.\" Copyright © 2007-2018 by Apple Inc.
+.\" Copyright © 1997-2006 by Easy Software Products.
.\"
-.\" These coded instructions, statements, and computer programs are the
-.\" property of Apple Inc. and are protected by Federal copyright
-.\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
-.\" which should have been included with this file. If this file is
-.\" file is missing or damaged, see the license at "http://www.cups.org/".
+.\" Licensed under Apache License v2.0. See the file "LICENSE" for more
+.\" information.
.\"
-.TH cups-files.conf 5 "CUPS" "3 June 2015" "Apple Inc."
+.TH cups-files.conf 5 "CUPS" "8 November 2018" "Apple Inc."
.SH NAME
cups\-files.conf \- file and directory configuration file for cups
.SH DESCRIPTION
.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 OS X and "0640" on all other operating systems.
+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
.B permissions
Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions.
.RE
-.\"#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.
.\"#Group
.TP 5
\fBGroup \fIgroup-name-or-number\fR
.fi
The default is "/var/log/cups/page_log".
+.\"#PassEnv
+.TP 5
+\fBPassEnv \fIvariable \fR[ ... \fIvariable \fR]
+Passes the specified environment variable(s) to child processes.
+Note: the standard CUPS filter and backend environment variables cannot be overridden using this directive.
.\"#RemoteRoot
.TP 5
\fBRemoteRoot \fIusername\fR
\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 OS X.
+This directive is currently only used/supported on macOS.
.\"#ServerBin
.TP 5
\fBServerBin \fIdirectory\fR
.TP 5
\fBServerKeychain \fIpath\fR
Specifies the location of TLS certificates and private keys.
-The default is "/Library/Keychains/System.keychain" on OS X and "/etc/cups/ssl" on all other operating systems.
-OS X 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.
+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".
+.\"#SetEnv
+.TP 5
+\fBSetEnv \fIvariable value\fR
+Set the specified environment variable to be passed to child processes.
+Note: the standard CUPS filter and backend environment variables cannot be overridden using this directive.
+.\"#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
.\"#TempDir
.TP 5
\fBTempDir \fIdirectory\fR
-Specifies the directory where temporary files are stored.
+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 NOTES
+The scheduler MUST be restarted manually after making changes to the \fBcups-files.conf\fR file.
+On Linux this is typically done using the
+.BR systemctl (8)
+command, while on macOS the
+.BR launchctl (8)
+command is used instead.
.SH SEE ALSO
.BR classes.conf (5),
.BR cups (1),
.BR subscriptions.conf (5),
CUPS Online Help (http://localhost:631/help)
.SH COPYRIGHT
-Copyright \[co] 2007-2015 by Apple Inc.
+Copyright \[co] 2007-2018 by Apple Inc.
projects / thirdparty / cups.git / blobdiff