man/cups-files.conf.man.in

   1 .\"
   2 .\" cups-files.conf man page for CUPS.
   3 .\"
   4 .\" Copyright 2007-2018 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 .\"#PassEnv
 157 .TP 5
 158 \fBPassEnv \fIvariable \fR[ ... \fIvariable \fR]
 159 Passes the specified environment variable(s) to child processes.
 160 Note: the standard CUPS filter and backend environment variables cannot be overridden using this directive.
 161 .\"#RemoteRoot
 162 .TP 5
 163 \fBRemoteRoot \fIusername\fR
 164 Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user.
 165 The default is "remroot".
 166 .\"#RequestRoot
 167 .TP 5
 168 \fBRequestRoot \fIdirectory\fR
 169 Specifies the directory that contains print jobs and other HTTP request data.
 170 The default is "/var/spool/cups".
 171 .\"#Sandboxing
 172 .TP 5
 173 \fBSandboxing relaxed\fR
 174 .TP 5
 175 \fBSandboxing strict\fR
 176 Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler.
 177 The default is "strict".
 178 This directive is currently only used/supported on macOS.
 179 .\"#ServerBin
 180 .TP 5
 181 \fBServerBin \fIdirectory\fR
 182 Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors.
 183 The default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the platform.
 184 .\"#ServerKeychain
 185 .TP 5
 186 \fBServerKeychain \fIpath\fR
 187 Specifies the location of TLS certificates and private keys.
 188 The default is "/Library/Keychains/System.keychain" on macOS and "/etc/cups/ssl" on all other operating systems.
 189 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.
 190 .\"#ServerRoot
 191 .TP 5
 192 \fBServerRoot \fIdirectory\fR
 193 Specifies the directory containing the server configuration files.
 194 The default is "/etc/cups".
 195 .\"#SetEnv
 196 .TP 5
 197 \fBSetEnv \fIvariable value\fR
 198 Set the specified environment variable to be passed to child processes.
 199 Note: the standard CUPS filter and backend environment variables cannot be overridden using this directive.
 200 .\"#StateDir
 201 .TP 5
 202 \fBStateDir \fIdirectory\fR
 203 Specifies the directory to use for PID and local certificate files.
 204 The default is "/var/run/cups" or "/etc/cups" depending on the platform.
 205 .\"#SyncOnClose
 206 .TP 5
 207 \fBSyncOnClose Yes\fR
 208 .TP 5
 209 \fBSyncOnClose No\fR
 210 Specifies whether the scheduler calls
 211 .BR fsync (2)
 212 after writing configuration or state files.
 213 The default is "No".
 214 .\"#SystemGroup
 215 .TP 5
 216 \fBSystemGroup \fIgroup-name \fR[ ... \fIgroup-name\fR ]
 217 Specifies the group(s) to use for \fI@SYSTEM\fR group authentication.
 218 The default contains "admin", "lpadmin", "root", "sys", and/or "system".
 219 .\"#TempDir
 220 .TP 5
 221 \fBTempDir \fIdirectory\fR
 222 Specifies the directory where short-term temporary files are stored.
 223 The default is "/var/spool/cups/tmp".
 224 .\"#User
 225 .TP 5
 226 \fBUser \fIusername\fR
 227 Specifies the user name or ID that is used when running external programs.
 228 The default is "lp".
 229 .SS DEPRECATED DIRECTIVES
 230 The following directives are deprecated and will be removed from a future version of CUPS:
 231 .\"#FileDevice
 232 .TP 5
 233 \fBFileDevice Yes\fR
 234 .TP 5
 235 \fBFileDevice No\fR
 236 Specifies whether the file pseudo-device can be used for new printer queues.
 237 The URI "file:///dev/null" is always allowed.
 238 File devices cannot be used with "raw" print queues - a PPD file is required.
 239 The specified file is overwritten for every print job.
 240 Writing to directories is not supported.
 241 .\"#FontPath
 242 .TP 5
 243 \fBFontPath \fIdirectory[:...:directoryN]\fR
 244 Specifies a colon separated list of directories where fonts can be found.
 245 On Linux the
 246 .BR font-config (1)
 247 mechanism is used instead.
 248 On macOS the Font Book application manages system-installed fonts.
 249 .\"#LPDConfigFile
 250 .TP 5
 251 \fB LPDConfigFile \fIfilename\fR
 252 Specifies the LPD service configuration file to update.
 253 .\"#Printcap
 254 .TP 5
 255 \fBPrintcap \fIfilename\fR
 256 Specifies a file that is filled with a list of local print queues.
 257 .\"#PrintcapFormat
 258 .TP 5
 259 \fBPrintcapFormat bsd\fR
 260 .TP 5
 261 \fBPrintcapFormat plist\fR
 262 .TP 5
 263 \fBPrintcapFormat solaris\fR
 264 Specifies the format to use for the Printcap file.
 265 "bsd" is the historical LPD printcap file format.
 266 "plist" is the Apple plist file format.
 267 "solaris" is the historical Solaris LPD printcap file format.
 268 .\"#SMBConfigFile
 269 .TP 5
 270 \fBSMBConfigFile \fIfilename\fR
 271 Specifies the SMB service configuration file to update.
 272 .SH SEE ALSO
 273 .BR classes.conf (5),
 274 .BR cups (1),
 275 .BR cupsd (8),
 276 .BR cupsd.conf (5),
 277 .BR mime.convs (5),
 278 .BR mime.types (5),
 279 .BR printers.conf (5),
 280 .BR subscriptions.conf (5),
 281 CUPS Online Help (http://localhost:631/help)
 282 .SH COPYRIGHT
 283 Copyright \[co] 2007-2018 by Apple Inc.